| blob | d9e5c8c266e9d52c19c48a461534169aa9c1d86e |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 5.16
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
67 ;;;; Require other packages
73 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
74 ;; the file noutline.el being loaded.
76 ;; We require noutline, which might be provided in outline.el
78 ;; Other stuff we need.
83 ;;;; Customization variables
85 ;;; Version
93 ;;; Compatibility constants
102 "Execute body without changing buffer-modified-p."
107 "Replace posix classes in regular expression."
115 ss))
116 s))
128 partial-completion-mode)))
135 ;;; The custom variables
138 "Outline-based notes management and organizer."
144 ;; FIXME: Needs a separate group...
147 Normal means, no org-mode-specific context."
152 "Options concerning startup of Org-mode."
157 "Non-nil means, entering Org-mode will switch to OVERVIEW.
158 This can also be configured on a per-file basis by adding one of
159 the following lines anywhere in the buffer:
161 #+STARTUP: fold
162 #+STARTUP: nofold
163 #+STARTUP: content"
171 "Non-nil means, entering Org-mode will set `truncate-lines'.
172 This is useful since some lines containing links can be very long and
173 uninteresting. Also tables look terrible when wrapped."
178 "Non-nil means, align all tables when visiting a file.
179 This is useful when the column width in tables is forced with <N> cookies
180 in table fields. Such tables will look correct only after the first re-align.
181 This can also be configured on a per-file basis by adding one of
182 the following lines anywhere in the buffer:
183 #+STARTUP: align
184 #+STARTUP: noalign"
189 "Non-nil means insert the first line setting Org-mode in empty files.
190 When the function `org-mode' is called interactively in an empty file, this
191 normally means that the file name does not automatically trigger Org-mode.
192 To ensure that the file will always be in Org-mode in the future, a
193 line enforcing Org-mode will be inserted into the buffer, if this option
194 has been set."
199 "Non-nil means use alternative key bindings for some keys.
200 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
201 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
202 If you want to use Org-mode together with one of these other modes,
203 or more generally if you would like to move some Org-mode commands to
204 other keys, set this variable and configure the keys with the variable
205 `org-disputed-keys'.
207 This option is only relevant at load-time of Org-mode, and must be set
208 *before* org.el is loaded. Changing it requires a restart of Emacs to
209 become effective."
223 "Keys for which Org-mode and other modes compete.
224 This is an alist, cars are the default keys, second element specifies
225 the alternative to use when `org-replace-disputed-keys' is t.
227 Keys can be specified in any syntax supported by `define-key'.
228 The value of this option takes effect only at Org-mode's startup,
229 therefore you'll have to restart Emacs to apply it after changing."
234 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
235 Or return the original if not disputed."
240 org-disputed-keys)))
242 key))
252 "Define a key, possibly translated, as returned by `org-key'."
256 "The ellipsis to use in the Org-mode outline.
257 When nil, just use the standard three dots. When a string, use that instead,
258 When a face, use the standart 3 dots, but with the specified face.
259 The change affects only Org-mode (which will then use its own display table).
260 Changing this requires executing `M-x org-mode' in a buffer to become
261 effective."
271 "Keywords in Org-mode."
276 "String to mark deadline entries.
277 A deadline is this string, followed by a time stamp. Should be a word,
278 terminated by a colon. You can insert a schedule keyword and
280 Changes become only effective after restarting Emacs."
285 "String to mark scheduled TODO entries.
286 A schedule is this string, followed by a time stamp. Should be a word,
287 terminated by a colon. You can insert a schedule keyword and
289 Changes become only effective after restarting Emacs."
294 "String used as the prefix for timestamps logging closing a TODO entry."
299 "String used as prefix for timestamps clocking work hours on an item."
304 "Entries starting with this keyword will never be exported.
305 An entry can be toggled between COMMENT and normal with
307 Changes become only effective after restarting Emacs."
312 "Entries starting with this keyword will be exported in fixed-width font.
313 Quoting applies only to the text in the entry following the headline, and does
314 not extend beyond the next headline, even if that is lower level.
315 An entry can be toggled between QUOTE and normal with
323 "Regular expression for specifying repeated events.
327 "Options concerning the general structure of Org-mode files."
332 "Options about how to make context of a location visible."
337 "Non-nil means, show full hierarchy when revealing a location.
338 Org-mode often shows locations in an org-mode file which might have
339 been invisible before. When this is set, the hierarchy of headings
340 above the exposed location is shown.
341 Turning this off for example for sparse trees makes them very compact.
342 Instead of t, this can also be an alist specifying this option for different
343 contexts. Valid contexts are
344 agenda when exposing an entry from the agenda
345 org-goto when using the command `org-goto' on key C-c C-j
346 occur-tree when using the command `org-occur' on key C-c /
347 tags-tree when constructing a sparse tree based on tags matches
348 link-search when exposing search matches associated with a link
349 mark-goto when exposing the jump goal of a mark
350 bookmark-jump when exposing a bookmark location
351 isearch when exiting from an incremental search
352 default default for all contexts not set explicitly"
372 "Non-nil means, show following heading when revealing a location.
373 Org-mode often shows locations in an org-mode file which might have
374 been invisible before. When this is set, the heading following the
375 match is shown.
376 Turning this off for example for sparse trees makes them very compact,
377 but makes it harder to edit the location of the match. In such a case,
379 Instead of t, this can also be an alist specifying this option for different
380 contexts. See `org-show-hierarchy-above' for valid contexts."
400 "Non-nil means, show all sibling heading when revealing a location.
401 Org-mode often shows locations in an org-mode file which might have
402 been invisible before. When this is set, the sibling of the current entry
403 heading are all made visible. If `org-show-hierarchy-above' is t,
404 the same happens on each level of the hierarchy above the current entry.
406 By default this is on for the isearch context, off for all other contexts.
407 Turning this off for example for sparse trees makes them very compact,
408 but makes it harder to edit the location of the match. In such a case,
410 Instead of t, this can also be an alist specifying this option for different
411 contexts. See `org-show-hierarchy-above' for valid contexts."
431 "Non-nil means, show the entry below a headline when revealing a location.
432 Org-mode often shows locations in an org-mode file which might have
433 been invisible before. When this is set, the text below the headline that is
434 exposed is also shown.
436 By default this is off for all contexts.
437 Instead of t, this can also be an alist specifying this option for different
438 contexts. See `org-show-hierarchy-above' for valid contexts."
458 "Options concerning visibility cycling in Org-mode."
463 "Names of drawers. Drawers are not opened by cycling on the headline above.
464 Drawers only open with a TAB on the drawer line itself. A drawer looks like
465 this:
466 :DRAWERNAME:
467 .....
468 :END:
470 the property API.
472 Drawers can be defined on the per-file basis with a line like:
474 #+DRAWERS: HIDDEN STATE PROPERTIES"
479 "Cycle globally if cursor is at beginning of buffer and not at a headline.
480 This makes it possible to do global cycling without having to use S-TAB or
481 C-u TAB. For this special case to work, the first line of the buffer
482 must not be a headline - it may be empty ot some other text. When used in
483 this way, `org-cycle-hook' is disables temporarily, to make sure the
484 cursor stays at the beginning of the buffer.
485 When this option is nil, don't do anything special at the beginning
486 of the buffer."
491 "Where should `org-cycle' emulate TAB.
492 nil Never
493 white Only in completely white lines
494 whitestart Only at the beginning of lines, before the first non-white char.
495 t Everywhere except in headlines
496 exc-hl-bol Everywhere except at the start of a headline
497 If TAB is used in a place where it does not emulate TAB, the current subtree
498 visibility is cycled."
505 ))
508 "Number of empty lines needed to keep an empty line between collapsed trees.
509 If you leave an empty line between the end of a subtree and the following
510 headline, this empty line is hidden when the subtree is folded.
511 Org-mode will leave (exactly) one empty line visible if the number of
512 empty lines is equal or larger to the number given in this variable.
513 So the default 2 means, at least 2 empty lines after the end of a subtree
514 are needed to produce free space between a collapsed subtree and the
515 following headline.
517 Special case: when 0, never leave empty lines in collapsed view."
522 org-cycle-hide-drawers
523 org-cycle-show-empty-lines
524 org-optimize-window-after-visibility-change)
525 "Hook that is run after `org-cycle' has changed the buffer visibility.
526 The function(s) in this hook must accept a single argument which indicates
527 the new state that was set by the most recent `org-cycle' command. The
528 argument is a symbol. After a global state change, it can have the values
529 `overview', `content', or `all'. After a local state change, it can have
530 the values `folded', `children', or `subtree'."
535 "Options concerning structure editing in Org-mode."
540 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
541 When t, `C-a' will bring back the cursor to the beginning of the
542 headline text, i.e. after the stars and after a possible TODO keyword.
543 In an item, this will be the position after the bullet.
544 When the cursor is already at that position, another `C-a' will bring
545 it to the beginning of the line.
546 `C-e' will jump to the end of the headline, ignoring the presence of tags
547 in the headline. A second `C-e' will then jump to the true end of the
548 line, after any tags.
549 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
550 and only a directly following, identical keypress will bring the cursor
551 to the special positions."
562 "Non-nil means, skip even levels and only use odd levels for the outline.
563 This has the effect that two stars are being added/taken away in
564 promotion/demotion commands. It also influences how levels are
565 handled by the exporters.
566 Changing it requires restart of `font-lock-mode' to become effective
567 for fontification also in regions already fontified.
568 You may also set this on a per-file basis by adding one of the following
569 lines to the buffer:
571 #+STARTUP: odd
572 #+STARTUP: oddeven"
578 "Non-nil means, adapt indentation when promoting and demoting.
579 When this is set and the *entire* text in an entry is indented, the
580 indentation is increased by one space in a demotion command, and
581 decreased by one in a promotion command. If any line in the entry
582 body starts at column 0, indentation is not changed at all."
588 "Should `org-insert-heading' leave a blank line before new heading/item?
589 The value is an alist, with `heading' and `plain-list-item' as car,
590 and a boolean flag as cdr."
597 "Hook being run after inserting a new heading."
603 This currently only means, they are never auto-wrapped.
604 When nil, such lines will be treated like ordinary lines.
605 See also the QUOTE keyword."
610 "Options concerning sparse trees in Org-mode."
615 "Non-nil means, highlight all matches that define a sparse tree.
616 The highlights will automatically disappear the next time the buffer is
617 changed by an edit command."
622 "Non-nil means, any change to the buffer will remove temporary highlights.
623 Such highlights are created by `org-occur' and `org-clock-display'.
624 When nil, `C-c C-c needs to be used to get rid of the highlights.
625 The highlights created by `org-preview-latex-fragment' always need
626 `C-c C-c' to be removed."
633 "Hook that is run after `org-occur' has constructed a sparse tree.
634 This can be used to recenter the window to show as much of the structure
635 as possible."
640 "Options concerning plain lists in Org-mode."
645 "Non-nil means, include plain lists into visibility cycling.
646 This means that during cycling, plain list items will *temporarily* be
647 interpreted as outline headlines with a level given by 1000+i where i is the
648 indentation of the bullet. In all other operations, plain list items are
649 not seen as headlines. For example, you cannot assign a TODO keyword to
650 such an item."
655 "The character that makes a line with leading number an ordered list item.
656 Valid values are ?. and ?\). To get both terminators, use t. While
657 ?. may look nicer, it creates the danger that a line with leading
658 number may be incorrectly interpreted as an item. ?\) therefore is
659 the safe choice."
666 "Non-nil means, automatically renumber ordered plain lists.
667 Renumbering happens when the sequence have been changed with
674 "Non-nil means, update checkbox statistics after insert and toggle.
675 When this is set, checkbox statistics is updated each time you either insert
682 "Options concerning archiving in Org-mode."
687 "The tag that marks a subtree as archived.
688 An archived subtree does not open during visibility cycling, and does
689 not contribute to the agenda listings.
690 After changing this, font-lock must be restarted in the relevant buffers to
691 get the proper fontification."
697 "Non-nil means, the agenda will skip any items located in archived trees.
698 An archived tree is a tree marked with the tag ARCHIVE."
704 "Non-nil means, `org-cycle' will open archived trees.
705 An archived tree is a tree marked with the tag ARCHIVE.
706 When nil, archived trees will stay folded. You can still open them with
707 normal outline commands like `show-all', but not with the cycling commands."
713 "Non-nil means sparse tree construction shows matches in archived trees.
714 When nil, matches in these trees are highlighted, but the trees are kept in
715 collapsed state."
721 "The location where subtrees should be archived.
722 This string consists of two parts, separated by a double-colon.
724 The first part is a file name - when omitted, archiving happens in the same
725 file. %s will be replaced by the current file name (without directory part).
726 Archiving to a different file is useful to keep archived entries from
727 contributing to the Org-mode Agenda.
729 The part after the double colon is a headline. The archived entries will be
730 filed under that headline. When omitted, the subtrees are simply filed away
731 at the end of the file, as top-level entries.
733 Here are a few examples:
735 If the current file is Projects.org, archive in file
736 Projects.org_archive, as top-level trees. This is the default.
739 Archive in the current file, under the top-level headline
743 Archive in file ~/org/archive.org (absolute path), as top-level trees.
746 Archive in file ./basement (relative path), as level 3 trees
749 You may set this option on a per-file basis by adding to the buffer a
750 line like
752 #+ARCHIVE: basement::** Finished Tasks"
757 "Non-nil means, mark entries as DONE when they are moved to the archive file.
758 This can be a string to set the keyword to use. When t, Org-mode will
759 use the first keyword in its list that means done."
767 "Non-nil means, add a time stamp to entries moved to an archive file.
768 This variable is obsolete and has no effect anymore, instead add ot remove
769 `time' from the variablle `org-archive-save-context-info'."
774 "Parts of context info that should be stored as properties when archiving.
775 When a subtree is moved to an archive file, it looses information given by
776 context, like inherited tags, the category, and possibly also the TODO
777 state (depending on the variable `org-archive-mark-done').
778 This variable can be a list of any of the following symbols:
780 time The time of archiving.
781 file The file where the entry originates.
782 itags The local tags, in the headline of the subtree.
783 ltags The tags the subtree inherits from further up the hierarchy.
784 todo The pre-archive TODO state.
785 category The category, taken from file name or #+CATEGORY lines.
787 For each symbol present in the list, a property will be created in
789 information."
801 "Options concerning imenu and speedbar in Org-mode."
806 "The maximum level for Imenu access to Org-mode headlines.
807 This also applied for speedbar access."
812 "Options concerning tables in Org-mode."
818 When nil, such lines will be treated like ordinary lines.
820 When equal to the symbol `optimized', the table editor will be optimized to
821 do the following:
822 - Automatic overwrite mode in front of whitespace in table fields.
823 This makes the structure of the table stay in tact as long as the edited
824 field does not exceed the column width.
825 - Minimize the number of realigns. Normally, the table is aligned each time
826 TAB or RET are pressed to move to another field. With optimization this
827 happens only if changes to a field might have changed the column width.
828 Optimization requires replacing the functions `self-insert-command',
829 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
830 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
831 very good at guessing when a re-align will be necessary, but you can always
834 If you would like to use the optimized version in Org-mode, but the
835 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
837 This variable can be used to turn on and off the table editor during a session,
838 but in order to toggle optimization, a restart is required.
840 See also the variable `org-table-auto-blank-field'."
848 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
849 In the optimized version, the table editor takes over all simple keys that
850 normally just insert a character. In tables, the characters are inserted
851 in a way to minimize disturbing the table structure (i.e. in overwrite mode
852 for empty fields). Outside tables, the correct binding of the keys is
853 restored.
855 The default for this option is t if the optimized version is also used in
856 Org-mode. See the variable `org-enable-table-editor' for details. Changing
857 this variable requires a restart of Emacs to become effective."
863 % END RECEIVE ORGTBL %n
865 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
866 | | |
869 @c END RECEIVE ORGTBL %n
870 @ignore
871 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
872 | | |
875 <!-- END RECEIVE ORGTBL %n -->
876 <!--
877 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
878 | | |
880 "Templates for radio tables in different major modes.
881 All occurrences of %n in a template will be replaced with the name of the
882 table, obtained by prompting the user."
889 "Settings for tables in Org-mode."
894 "The default size for newly created tables, Columns x Rows."
900 "Regular expression for recognizing numbers in table columns.
901 If a table column contains mostly numbers, it will be aligned to the
902 right. If not, it will be aligned to the left.
904 The default value of this option is a regular expression which allows
905 anything which looks remotely like a number as used in scientific
906 context. For example, all of the following will be considered a
907 number:
908 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
910 Other options offered by the customize interface are more restrictive."
928 "Fraction of numbers in a column required to make the column align right.
929 In a column all non-white fields are considered. If at least this
930 fraction of fields is matched by `org-table-number-fraction',
931 alignment to the right border applies."
936 "Behavior of tables during editing in Org-mode."
941 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
943 removal/insertion."
948 "Non-nil means, automatically blank table field when starting to type into it.
949 This only happens when typing immediately after a field motion
950 command (TAB, S-TAB or RET).
951 Only relevant when `org-enable-table-editor' is equal to `optimized'."
956 "Non-nil means, tab in the last column of a table with jump over a hline.
957 If a horizontal separator line is following the current line,
958 `org-table-next-field' can either create a new row before that line, or jump
959 over the line. When this option is nil, a new line will be created before
960 this line."
965 "Non-nil means, TAB will automatically notice a table.el table.
966 When it sees such a table, it moves point into it and - if necessary -
967 calls `table-recognize-table'."
972 "Options concerning tables in Org-mode."
977 "Should org-mode work with table refrences like B3 instead of @3$2?
978 Possible values are:
979 nil never use them
980 from accept as input, do not present for editing
981 t: accept as input and present for editing"
996 calc-angle-mode deg
997 calc-prefer-frac nil
998 calc-symbolic-mode nil
1000 calc-display-working-message t
1001 )
1002 "List with Calc mode settings for use in calc-eval for table formulas.
1003 The list must contain alternating symbols (Calc modes variables and values).
1004 Don't remove any of the default settings, just change the values. Org-mode
1005 relies on the variables to be present in the list."
1010 "Non-nil means, TAB and RET evaluate a formula in current table field.
1011 If the current field starts with an equal sign, it is assumed to be a formula
1012 which should be evaluated as described in the manual and in the documentation
1013 string of the command `org-table-eval-formula'. This feature requires the
1014 Emacs calc package.
1015 When this variable is nil, formula calculation is only available through
1021 "Non-nil means, interpret constants in formulas in tables.
1022 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1023 by the value given in `org-table-formula-constants', or by a value obtained
1024 from the `constants.el' package."
1029 "Alist with constant names and values, for use in table formulas.
1030 The car of each element is a name of a constant, without the `$' before it.
1031 The cdr is the value as a string. For example, if you'd like to use the
1032 speed of light in a formula, you would configure
1036 and then use it in an equation like `$1*$c'.
1038 Constants can also be defined on a per-file basis using a line like
1040 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1051 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1052 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1057 "Options concerning links in Org-mode."
1062 "Buffer-local version of `org-link-abbrev-alist', which see.
1067 "Alist of link abbreviations.
1068 The car of each element is a string, to be replaced at the start of a link.
1070 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1072 [[linkkey:tag][description]]
1074 If REPLACE is a string, the tag will simply be appended to create the link.
1077 REPLACE may also be a function that will be called with the tag as the
1078 only argument to create the link, which should be returned as a string.
1080 See the manual for examples."
1085 "Non-nil means, hide link part and only show description of bracket links.
1086 Bracket links are like [[link][descritpion]]. This variable sets the initial
1087 state in new org-mode buffers. The setting can then be toggled on a
1088 per-buffer basis from the Org->Hyperlinks menu."
1093 "How the path name in file links should be stored.
1094 Valid values are:
1096 relative relative to the current directory, i.e. the directory of the file
1097 into which the link is being inserted.
1098 absolute absolute path, if possible with ~ for home directory.
1099 noabbrev absolute path, no abbreviation of home directory.
1100 adaptive Use relative path for files in the current directory and sub-
1101 directories of it. For other files, use an absolute path."
1110 "Types of links that should be activated in Org-mode files.
1111 This is a list of symbols, each leading to the activation of a certain link
1112 type. In principle, it does not hurt to turn on most link types - there may
1113 be a small gain when turning off unused link types. The types are:
1115 bracket The recommended [[link][description]] or [[link]] links with hiding.
1116 angular Links in angular brackes that may contain whitespace like
1117 <bbdb:Carsten Dominik>.
1118 plain Plain links in normal text, no whitespace, like http://google.com.
1119 radio Text that is matched by a radio target, see manual for details.
1120 tag Tag settings in a headline (link to tag search).
1121 date Time stamps (link to calendar).
1123 Changing this variable requires a restart of Emacs to become effective."
1134 "Options concerning storing links in Org-mode"
1139 "Format of the description part of a link to an email or usenet message.
1140 The following %-excapes will be replaced by corresponding information:
1148 %s subject
1149 %m message-id.
1151 You may use normal field width specification between the % and the letter.
1152 This is for example useful to limit the length of the subject.
1166 It should match if the message is from the user him/herself."
1171 "Non-nil means, file links from `org-store-link' contain context.
1172 A search string will be added to the file name with :: as separator and
1173 used to find the context when the link is activated by the command
1174 `org-open-at-point'.
1176 negates this setting for the duration of the command."
1181 "Non-nil means, keep link in list for entire session.
1183 The command `org-store-link' adds a link pointing to the current
1184 location to an internal list. These links accumulate during a session.
1185 The command `org-insert-link' can be used to insert links into any
1186 Org-mode file (offering completion for all stored links). When this
1188 will be removed from the list, to make completing the unused links
1189 more efficient."
1194 "Non-nil means, `org-store-link' will create web links to Google groups.
1195 When nil, Gnus will be used for such links.
1197 negates this setting for the duration of the command."
1202 "Options concerning following links in Org-mode"
1207 "Non-nil means, on links TAB will follow the link.
1208 Needs to be set before org.el is loaded."
1213 "Non-nil means, on links RET will follow the link.
1214 Needs to be set before org.el is loaded."
1219 "Non-nil means, mouse-1 on a link will follow the link.
1220 A longer mouse click will still set point. Does not wortk on XEmacs.
1221 Needs to be set before org.el is loaded."
1226 "Number of different positions to be recorded in the ring
1227 Changing this requires a restart of Emacs to work correctly."
1235 "Setup the frame configuration for following links.
1236 When following a link with Emacs, it may often be useful to display
1237 this link in another window or frame. This variable can be used to
1238 set this up for the different types of links.
1239 For VM, use any of
1240 `vm-visit-folder'
1241 `vm-visit-folder-other-frame'
1242 For Gnus, use any of
1243 `gnus'
1244 `gnus-other-frame'
1245 For FILE, use any of
1246 `find-file'
1247 `find-file-other-window'
1248 `find-file-other-frame'
1249 For the calendar, use the variable `calendar-setup'.
1250 For BBDB, it is currently only possible to display the matches in
1251 another window."
1270 "Non-nil means, use indirect buffer to display infile links.
1271 Activating internal links (from one location in a file to another location
1272 in the same file) normally just jumps to the location. When the link is
1273 activated with a C-u prefix (or with mouse-3), the link is displayed in
1274 another window. When this option is set, the other window actually displays
1275 an indirect buffer clone of the current buffer, to avoid any visibility
1276 changes to the current buffer."
1281 "Non-nil means, `org-open-file' will open non-existing files.
1282 When nil, an error will be generated."
1287 "Function and arguments to call for following mailto links.
1288 This is a list with the first element being a lisp function, and the
1289 remaining elements being arguments to the function. In string arguments,
1290 %a will be replaced by the address, and %s will be replaced by the subject
1291 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1300 "Non-nil means, ask for confirmation before executing shell links.
1301 Shell links can be dangerous: just think about a link
1303 [[shell:rm -rf ~/*][Google Search]]
1306 but really it would remove your entire home directory.
1307 Therefore we advise against setting this variable to nil.
1308 Just change it to `y-or-n-p' of you want to confirm with a
1317 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1318 Elisp links can be dangerous: just think about a link
1323 but really it would remove your entire home directory.
1324 Therefore we advise against setting this variable to nil.
1325 Just change it to `y-or-n-p' of you want to confirm with a
1336 "Default file applications on a UNIX or GNU/Linux system.
1348 "Default file applications on a MacOS X system.
1350 for some files for which the OS does not have a good default.
1358 'mswindows-shell-execute
1361 "Default file applications on a Windows NT system.
1366 '(
1373 )
1374 "External applications for opening `file:path' items in a document.
1375 Org-mode uses system defaults for different file types, but
1376 you can use this variable to set the application for a given file
1377 extension. The entries in this list are cons cells where the car identifies
1378 files and the cdr the corresponding command. Possible values for the
1379 file identifier are
1381 `directory' Matches a directory
1382 `remote' Matches a remote file, accessible through tramp or efs.
1383 Remote files most likely should be visited through Emacs
1384 because external applications cannot handle such paths.
1385 t Default for all remaining files
1387 Possible values for the command are:
1388 `emacs' The file will be visited by the current Emacs process.
1389 `default' Use the default application for this file type.
1390 string A command to be executed by a shell; %s will be replaced
1391 by the path to the file.
1392 sexp A Lisp form which will be evaluated. The file path will
1393 be available in the Lisp variable `file'.
1394 For more examples, see the system specific constants
1395 `org-file-apps-defaults-macosx'
1396 `org-file-apps-defaults-windowsnt'
1397 `org-file-apps-defaults-gnu'."
1412 "Non-nil means, that the search for the mh-message will be extended to
1413 all folders if the message cannot be found in the folder given in the link.
1414 Searching all folders is very efficient with one of the search engines
1415 supported by MH-E, but will be slow with pick."
1420 "Options concerning interaction with remember.el."
1425 "Directory with org files.
1426 This directory will be used as default to prompt for org files.
1427 Used by the hooks for remember.el."
1432 "Default target for storing notes.
1433 Used by the hooks for remember.el. This can be a string, or nil to mean
1434 the value of `remember-data-file'.
1435 You can set this on a per-template basis with the variable
1436 `org-remember-templates'."
1440 file))
1443 "Non-nil means, `C-c C-c' stores remember note without further promts.
1444 In this case, you need `C-u C-c C-c' to get the prompts for
1445 note file and headline.
1446 When this variable is nil, `C-c C-c' give you the prompts, and
1447 `C-u C-c C-c' trigger the fasttrack."
1452 "The headline that should be the default location in the notes file.
1453 When filing remember notes, the cursor will start at that position.
1454 You can set this on a per-template basis with the variable
1455 `org-remember-templates'."
1460 "Templates for the creation of remember buffers.
1461 When nil, just let remember make the buffer.
1462 When not nil, this is a list of 5-element lists. In each entry, the first
1463 element is a the name of the template, It should be a single short word.
1464 The second element is a character, a unique key to select this template.
1465 The third element is the template. The forth element is optional and can
1466 specify a destination file for remember items created with this template.
1467 The default file is given by `org-default-notes-file'. An optional fifth
1468 element can specify the headline in that file that should be offered
1469 first when the user is asked to file the entry. The default headline is
1470 given in the variable `org-remember-default-headline'.
1472 The template specifies the structure of the remember buffer. It should have
1473 a first line starting with a star, to act as the org-mode headline.
1474 Furthermore, the following %-escapes will be replaced with content:
1476 %^{prompt} prompt the user for a string and replace this sequence with it.
1477 %t time stamp, date only
1478 %T time stamp with date and time
1479 %u, %U like the above, but inactive time stamps
1480 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1481 You may define a prompt like %^{Please specify birthday}t
1482 %n user name (taken from `user-full-name')
1483 %a annotation, normally the link created with org-store-link
1484 %i initial content, the region when remember is called with C-u.
1485 If %i is indented, the entire inserted text will be indented
1486 as well.
1488 %? After completing the template, position cursor here.
1490 Apart from these general escapes, you can access information specific to the
1491 link type that is created. For example, calling `remember' in emails or gnus
1492 will record the author and the subject of the message, which you can access
1493 with %:author and %:subject, respectively. Here is a complete list of what
1494 is recorded for each link type.
1496 Link type | Available information
1497 -------------------+------------------------------------------------------
1498 bbdb | %:type %:name %:company
1499 vm, wl, mh, rmail | %:type %:subject %:message-id
1500 | %:from %:fromname %:fromaddress
1501 | %:to %:toname %:toaddress
1503 gnus | %:group, for messages also all email fields
1504 w3, w3m | %:type %:url
1505 info | %:type %:file %:node
1506 calendar | %:type %:date"
1529 "Non-nil means, store new notes at the beginning of a file or entry.
1530 When nil, new notes will be filed to the end of a file or entry.
1531 This can also be a list with cons cells of regular expressions that
1532 are matched against file names, and values."
1542 This is list of cons cells. Each cell contains:
1543 - a specification of the files to be considered, either a list of files,
1544 or a symbol whose function or value fields will be used to retrieve
1545 a file name or a list of file names. Nil means, refile to a different
1546 heading in the current buffer.
1547 - A specification of how to find candidate refile targets. This may be
1548 any of
1550 This tag has to be present in all target headlines, inheritance will
1551 not be considered.
1553 todo keyword.
1555 headlines that are refiling targets.
1556 - a cons cell (:level . N). Any headline of level N is considered a target."
1557 ;; FIXME: what if there are a var and func with same name???
1572 "Options concerning TODO items in Org-mode."
1577 "Options concerning Progress logging in Org-mode."
1582 "List of TODO entry keyword sequences and their interpretation.
1585 Each sequence starts with a symbol, either `sequence' or `type',
1586 indicating if the keywords should be interpreted as a sequence of
1587 action steps, or as different types of TODO items. The first
1588 keywords are states requiring action - these states will select a headline
1589 for inclusion into the global TODO list Org-mode produces. If one of
1592 the last keyword is treated as the only DONE state of the sequence.
1595 additional state where no keyword is present. For details about this
1596 cycling, see the manual.
1598 TODO keywords and interpretation can also be set on a per-file basis with
1599 the special #+SEQ_TODO and #+TYP_TODO lines.
1601 For backward compatibility, this variable may also be just a list
1602 of keywords - in this case the interptetation (sequence or type) will be
1603 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1640 "Controls how TODO keywords are interpreted.
1641 This variable is in principle obsolete and is only used for
1642 backward compatibility, if the interpretation of todo keywords is
1643 not given already in `org-todo-keywords'. See that variable for
1644 more information."
1651 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1652 This variable describes if and under what circumstances the cycling
1653 mechanism for TODO keywords will be replaced by a single-key, direct
1654 selection scheme.
1656 When nil, fast selection is never used.
1658 When the symbol `prefix', it will be used when `org-todo' is called with
1659 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1660 in an agenda buffer.
1662 When t, fast selection is used by default. In this case, the prefix
1663 argument forces cycling instead.
1665 In all cases, the special interface is only used if access keys have actually
1666 been assigned by the user, i.e. if keywords in the configuration are followed
1667 by a letter in parenthesis, like TODO(t)."
1675 "Hook which is run after the state of a TODO item was changed.
1676 The new state (a string with a TODO keyword, or nil) is available in the
1677 Lisp variable `state'."
1682 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1683 When the state of an entry is changed from nothing or a DONE state to
1684 a not-done TODO state, remove a previous closing date.
1686 This can also be a list of symbols indicating under which conditions
1687 the time stamp recording the action should be annotated with a short note.
1688 Valid members of this list are
1690 done Offer to record a note when marking entries done
1691 state Offer to record a note whenever changing the TODO state
1692 of an item. This is only relevant if TODO keywords are
1693 interpreted as sequence, see variable `org-todo-interpretation'.
1694 When `state' is set, this includes tracking `done'.
1695 clock-out Offer to record a note when clocking out of an item.
1697 A separate window will then pop up and allow you to type a note.
1698 After finishing with C-c C-c, the note will be added directly after the
1699 timestamp, as a plain list item. See also the variable
1700 `org-log-note-headings'.
1702 Logging can also be configured on a per-file basis by adding one of
1703 the following lines anywhere in the buffer:
1705 #+STARTUP: logdone
1706 #+STARTUP: nologging
1707 #+STARTUP: lognotedone
1708 #+STARTUP: lognotestate
1709 #+STARTUP: lognoteclock-out
1711 You can have local logging settings for a subtree by setting the LOGGING
1712 property to one or more of these keywords."
1724 "Non-nil means, the CLOSED time stamp will contain date and time.
1725 When nil, only the date will be recorded."
1733 "Headings for notes added when clocking out or closing TODO items.
1734 The value is an alist, with the car being a symbol indicating the note
1735 context, and the cdr is the heading to be used. The heading may also be the
1736 empty string.
1737 %t in the heading will be replaced by a time stamp.
1738 %s will be replaced by the new TODO state, in double quotes.
1739 %u will be replaced by the user name.
1740 %U will be replaced by the full user name."
1746 "Heading when changing todo state (todo sequence only)"
1751 "Non-nil means, the latest state change note will be directly after heading.
1752 When nil, the notes will be orderer according to time."
1758 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1759 When nil, no note will be taken.
1760 This option can also be set with on a per-file-basis with
1762 #+STARTUP: logrepeat
1763 #+STARTUP: nologrepeat
1765 You can have local logging settings for a subtree by setting the LOGGING
1766 property to one or more of these keywords."
1772 "Should clocking info be wrapped into a drawer?
1773 When t, clocking info will always be inserted into a :CLOCK: drawer.
1774 If necessary, the drawer will be created.
1775 When nil, the drawer will not be created, but used when present.
1776 When an integer and the number of clocking entries in an item
1777 reaches or exceeds this number, a drawer will be created."
1786 "When t, the clock will be stopped when the relevant entry is marked DONE.
1787 Nil means, clock will keep running until stopped explicitly with
1788 `C-c C-x C-o', or until the clock is started in a different item."
1793 "Priorities in Org-mode."
1798 "The highest priority of TODO items. A character like ?A, ?B etc.
1799 Must have a smaller ASCII number than `org-lowest-priority'."
1804 "The lowest priority of TODO items. A character like ?A, ?B etc.
1805 Must have a larger ASCII number than `org-highest-priority'."
1810 "The default priority of TODO items.
1811 This is the priority an item get if no explicit priority is given."
1816 "Non-nil means, start with default priority when starting to cycle.
1817 When this is nil, the first step in the cycle will be (depending on the
1818 command used) one higher or lower that the default priority."
1823 "Options concerning time stamps and deadlines in Org-mode."
1828 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1829 When nil, these labeled time stamps are forces into the second line of an
1830 entry, just after the headline. When scheduling from the global TODO list,
1831 the time stamp will always be forced into the second line."
1836 "Formats for `format-time-string' which are used for time stamps.
1840 "Number of minutes to round time stamps to upon insertion.
1841 When zero, insert the time unmodified. Useful rounding numbers
1842 should be factors of 60, so for example 5, 10, 15.
1843 When this is not zero, you can still force an exact time-stamp by using
1844 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1849 "Non-nil means, overlay custom formats over all time stamps.
1850 The formats are defined through the variable `org-time-stamp-custom-formats'.
1851 To turn this on on a per-file basis, insert anywhere in the file:
1852 #+STARTUP: customtime"
1860 "Custom formats for time stamps. See `format-time-string' for the syntax.
1861 These are overlayed over the default ISO format if the variable
1862 `org-display-custom-times' is set. Time like %H:%M should be at the
1863 end of the second format."
1868 "Get the right format for a time string."
1873 f)))
1876 "Non-nil means, assume future for incomplete date input from user.
1877 This affects the following situations:
1878 1. The user gives a day, but no month.
1881 it will be considered as *this* month.
1882 2. The user gives a month but not a year.
1886 When this option is nil, the current month and year will always be used
1887 as defaults."
1892 "Non-nil means, display current interpretation of date prompt live.
1893 This display will be in an overlay, in the minibuffer."
1898 "Non-nil means, pop up a calendar when prompting for a date.
1899 In the calendar, the date can be selected with mouse-1. However, the
1900 minibuffer will also be active, and you can simply enter the date as well.
1901 When nil, only the minibuffer will be available."
1909 "The hour when your day really ends.
1910 This has influence for the following applications:
1912 the time given here, the day recognized as TODAY is actually yesterday.
1913 - When a date is read from the user and it is still before the time given
1914 here, the current date and time will be assumed to be yesterday, 23:59.
1916 FIXME:
1917 IMPORTANT: This is still a very experimental feature, it may disappear
1918 again or it may be extended to mean more things."
1923 "Non-nil means, S-down will increase the time in a time stamp.
1924 When nil, S-up will increase."
1929 "Non-nil means, make the calendar window follow timestamp changes.
1930 When a timestamp is modified and the calendar window is visible, it will be
1931 moved to the new date."
1936 "When non-nil, should be a function to create `org-clock-heading'.
1937 This is the string shown in the mode line when a clock is running.
1938 The function is called with point at the beginning of the headline."
1943 "Options concerning tags in Org-mode."
1948 "List of tags allowed in Org-mode files.
1949 When this list is nil, Org-mode will base TAG input on what is already in the
1950 buffer.
1951 The value of this variable is an alist, the car of each entry must be a
1952 keyword as a string, the cdr may be a character that is used to select
1953 that tag through the fast-tag-selection interface.
1954 See the manual for details."
1964 "Non-nil means, use fast tag selection scheme.
1965 This is a special interface to select and deselect tags with single keys.
1966 When nil, fast selection is never used.
1967 When the symbol `auto', fast selection is used if and only if selection
1968 characters for tags have been configured, either through the variable
1969 `org-tag-alist' or through a #+TAGS line in the buffer.
1970 When t, fast selection is always used and selection keys are assigned
1971 automatically if necessary."
1979 "Non-nil means, fast tag selection exits after first change.
1980 When nil, you have to press RET to exit it.
1981 During fast tag selection, you can toggle this flag with `C-c'.
1982 This variable can also have the value `expert'. In this case, the window
1983 displaying the tags menu is not even shown, until you press C-c again."
1991 "Non-nil means, fast tags selection interface will also offer TODO states.
1995 "The column to which tags should be indented in a headline.
1996 If this number is positive, it specifies the column. If it is negative,
1997 it means that the tags should be flushright to that column. For example,
1998 -80 works well for a normal 80 character screen."
2003 "Non-nil means, realign tags after pro/demotion of TODO state change.
2004 These operations change the length of a headline and therefore shift
2005 the tags around. With this options turned on, after each such operation
2006 the tags are again aligned to `org-tags-column'."
2011 "Non-nil means, tags in levels apply also for sublevels.
2012 When nil, only the tags directly given in a specific line apply there.
2013 If you turn off this option, you very likely want to turn on the
2014 companion option `org-tags-match-list-sublevels'."
2019 "Non-nil means list also sublevels of headlines matching tag search.
2020 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2021 the sublevels of a headline matching a tag search often also match
2022 the same search. Listing all of them can create very long lists.
2023 Setting this variable to nil causes subtrees of a match to be skipped.
2024 This option is off by default, because inheritance in on. If you turn
2025 inheritance off, you very likely want to turn this option on.
2027 As a special case, if the tag search is restricted to TODO items, the
2028 value of this variable is ignored and sublevels are always checked, to
2029 make sure all corresponding TODO items find their way into the list."
2041 "Options concerning properties in Org-mode."
2046 "How property key/value pairs should be formatted by `indent-line'.
2047 When `indent-line' hits a property definition, it will format the line
2048 according to this format, mainly to make sure that the values are
2049 lined-up with respect to each other."
2054 "Non-nil means, properties apply also for sublevels.
2055 This setting is only relevant during property searches, not when querying
2056 an entry with `org-entry-get'. To retrieve a property with inheritance,
2057 you need to call `org-entry-get' with the inheritance flag.
2058 Turning this on can cause significant overhead when doing a search, so
2059 this is turned off by default.
2060 When nil, only the properties directly given in the current entry count.
2061 The value may also be a list of properties that shouldhave inheritance.
2063 However, note that some special properties use inheritance under special
2064 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2066 for valid values of a property."
2074 "The default column format, if no other format has been defined.
2075 This variable can be set on the per-file basis by inserting a line
2077 #+COLUMNS: %25ITEM ....."
2082 "List of property/value pairs that can be inherited by any entry.
2083 You can set buffer-local values for this by adding lines like
2085 #+PROPERTY: NAME VALUE"
2092 "List of property/value pairs that can be inherited by any entry.
2093 Valid for the current buffer.
2097 "Options concerning agenda views in Org-mode."
2102 "Variable used by org files to set a category for agenda display.
2103 Such files should use a file variable to set it, for example
2107 or contain a special line
2109 #+CATEGORY: ELisp
2111 If the file does not specify a category, then file's base name
2116 "The files to be used for agenda display.
2120 If an entry is a directory, all files in that directory that are matched by
2121 `org-agenda-file-regexp' will be part of the file list.
2123 If the value of the variable is not a list but a single file name, then
2124 the list of agenda files is actually stored and maintained in that file, one
2125 agenda file per line."
2132 "Regular expression to match files for `org-agenda-files'.
2133 If any element in the list in that variable contains a directory instead
2134 of a normal file, all files in that directory that are matched by this
2135 regular expression will be included."
2140 "t means to just skip non-reachable files in `org-agenda-files'.
2141 Nil means to remove them, after a query, from the list."
2146 "List of extra files to be searched by `org-occur-in-agenda-files'.
2147 The files in `org-agenda-files' are always searched."
2152 "When set, remote killing from the agenda buffer needs confirmation.
2153 When t, a confirmation is always needed. When a number N, confirmation is
2154 only needed when the text to be killed contains more than N non-white lines."
2162 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2163 The command `org-calendar-goto-agenda' will be bound to this key. The
2164 default is the character `c' because then `c' can be used to switch back and
2165 forth between agenda and calendar."
2170 "Non-nil means, make the block agenda more compact.
2171 This is done by leaving out unnecessary lines."
2176 "Options concerning exporting agenda views in Org-mode."
2181 "Non-nil means, use colors in agenda views."
2186 "Alist of variable/value pairs that should be active during agenda export.
2187 This is a good place to set uptions for ps-print and for htmlize."
2195 "The style specification for exported HTML Agenda files.
2196 If this variable contains a string, it will replace the default <style>
2197 section as produced by `htmlize'.
2198 Since there are different ways of setting style information, this variable
2199 needs to contain the full HTML structure to provide a style, including the
2200 surrounding HTML tags. The style specifications should include definitions
2201 the fonts used by the agenda, here is an example:
2204 p { font-weight: normal; color: gray; }
2205 .org-agenda-structure {
2206 font-size: 110%;
2207 color: #003399;
2208 font-weight: 600;
2209 }
2210 .org-todo {
2211 color: #cc6666;Week-agenda:
2212 font-weight: bold;
2213 }
2214 .org-done {
2215 color: #339933;
2216 }
2217 .title { text-align: center; }
2218 .todo, .deadline { color: red; }
2219 .done { color: green; }
2220 </style>
2222 or, if you want to keep the style in a file,
2226 As the value of this option simply gets inserted into the HTML <head> header,
2228 <style>...</style> is required, if not present the variable will be ignored."
2234 "Options concerning agenda views in Org-mode."
2239 "Custom commands for the agenda.
2240 These commands will be offered on the splash screen displayed by the
2243 (key desc type match options files)
2245 key The key (one or more characters as a string) to be associated
2246 with the command.
2247 desc A description of the commend, when omitted or nil, a default
2248 description is built using MATCH.
2249 type The command type, any of the following symbols:
2250 todo Entries with a specific TODO keyword, in all agenda files.
2251 tags Tags match in all agenda files.
2252 tags-todo Tags match in all agenda files, TODO entries only.
2253 todo-tree Sparse tree of specific TODO keyword in *current* file.
2254 tags-tree Sparse tree with all tags matches in *current* file.
2255 occur-tree Occur sparse tree for *current* file.
2256 ... A user-defined function.
2257 match What to search for:
2258 - a single keyword for TODO keyword searches
2259 - a tags match expression for tags searches
2260 - a regular expression for occur searches
2261 options A list of option settings, similar to that in a let form, so like
2262 this: ((opt1 val1) (opt2 val2) ...)
2263 files A list of files file to write the produced agenda buffer to
2264 with the command `org-store-agenda-views'.
2267 produced. Otherwide, only the plain text is written to the file.
2269 You can also define a set of commands, to create a composite agenda buffer.
2270 In this case, an entry looks like this:
2272 (key desc (cmd1 cmd2 ...) general-options file)
2274 where
2276 desc A description string to be displayed in the dispatcher menu.
2277 cmd An agenda command, similar to the above. However, tree commands
2278 are no allowed, but instead you can get agenda and global todo list.
2279 So valid commands for a set are:
2280 (agenda)
2281 (alltodo)
2282 (stuck)
2287 Each command can carry a list of options, and another set of options can be
2288 given for the whole set of commands. Individual command options take
2289 precedence over the general options.
2291 When using several characters as key to a command, the first characters
2292 are prefix commands. For the dispatcher to display useful information, you
2293 should provide a description for the prefix, like
2295 (setq org-agenda-custom-commands
2367 "How to identify stuck projects.
2368 This is a list of four items:
2369 1. A tags/todo matcher string that is used to identify a project.
2370 The entire tree below a headline matched by this is considered one project.
2371 2. A list of TODO keywords identifying non-stuck projects.
2372 If the project subtree contains any headline with one of these todo
2373 keywords, the project is considered to be not stuck. If you specify
2375 3. A list of tags identifying non-stuck projects.
2376 If the project subtree contains any headline with one of these tags,
2378 a tag, any tag will mark the project unstuck.
2379 4. An arbitrary regular expression matching non-stuck projects.
2382 or `C-c a #' to produce the list."
2386 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2392 "Options concerning skipping parts of agenda files."
2397 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2398 When nil, the sublevels of a TODO entry are not checked, resulting in
2399 potentially much shorter TODO lists."
2405 "Non-nil means, don't show entries with a date in the global todo list.
2406 You can use this if you prefer to mark mere appointments with a TODO keyword,
2407 but don't want them to show up in the TODO list.
2408 When this is set, it also covers deadlines and scheduled items, the settings
2409 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2410 will be ignored."
2416 "Non-nil means, don't show scheduled entries in the global todo list.
2417 The idea behind this is that by scheduling it, you have already taken care
2418 of this item.
2419 See also `org-agenda-todo-ignore-with-date'."
2425 "Non-nil means, don't show near deadline entries in the global todo list.
2426 Near means closer than `org-deadline-warning-days' days.
2427 The idea behind this is that such items will appear in the agenda anyway.
2428 See also `org-agenda-todo-ignore-with-date'."
2434 "Non-nil means don't show scheduled items in agenda when they are done.
2435 This is relevant for the daily/weekly agenda, not for the TODO list. And
2436 it applies only to the actual date of the scheduling. Warnings about
2437 an item with a past scheduling dates are always turned off when the item
2438 is DONE."
2443 "Non-nil means don't show deadines when the corresponding item is done.
2444 When nil, the deadline is still shown and should give you a happy feeling.
2445 This is relevant for the daily/weekly agenda. And it applied only to the
2446 actualy date of the deadline. Warnings about approching and past-due
2447 deadlines are always turned off when the item is DONE."
2452 "Non-nil means don't don't select item by timestamp or -range if it is DONE."
2457 "Non-nil means, `org-timeline' also shows dates without an entry.
2458 When nil, only the days which actually have entries are shown.
2459 When t, all days between the first and the last date are shown.
2460 When an integer, show also empty dates, but if there is a gap of more than
2461 N days, just insert a special line indicating the size of the gap."
2470 "Options concerning initial settings in the Agenda in Org Mode."
2475 "Hook run just before displaying an agenda buffer."
2480 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2481 A longer mouse click will still set point. Does not wortk on XEmacs.
2482 Needs to be set before org.el is loaded."
2487 "The initial value of follow-mode in a newly created agenda window."
2492 "Options concerning the windows used by the Agenda in Org Mode."
2497 "How the agenda buffer should be displayed.
2498 Possible values for this option are:
2500 current-window Show agenda in the current window, keeping all other windows.
2501 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2502 other-window Use `switch-to-buffer-other-window' to display agenda.
2503 reorganize-frame Show only two windows on the current frame, the current
2504 window and the agenda.
2505 See also the variable `org-agenda-restore-windows-after-quit'."
2514 "The min and max height of the agenda window as a fraction of frame height.
2515 The value of the variable is a cons cell with two numbers between 0 and 1.
2516 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2521 "Non-nil means, restore window configuration open exiting agenda.
2522 Before the window configuration is changed for displaying the agenda,
2523 the current status is recorded. When the agenda is exited with
2524 `q' or `x' and this option is set, the old state is restored. If
2525 `org-agenda-window-setup' is `other-frame', the value of this
2526 option will be ignored.."
2531 "How should indirect tree buffers be displayed?
2532 This applies to indirect buffers created with the commands
2534 Valid values are:
2535 current-window Display in the current window
2536 other-window Just display in another window.
2537 dedicated-frame Create one new frame, and re-use it each time.
2538 new-frame Make a new frame each time. Note that in this case
2539 previously-made indirect buffers are kept, and you need to
2540 kill these buffers yourself."
2550 "Options concerning the daily/weekly agenda."
2555 "Number of days to include in overview display.
2556 Should be 1 or 7."
2561 "Non-nil means, start the overview always on the specified weekday.
2562 0 denotes Sunday, 1 denotes Monday etc.
2563 When nil, always start on the current day."
2569 "Non-nil means, `org-agenda' shows every day in the selected range.
2570 When nil, only the days which actually have entries are shown."
2575 "Format string for displaying dates in the agenda.
2576 Used by the daily/weekly agenda and by the timeline. This should be
2577 a format string understood by `format-time-string', or a function returning
2578 the formatted date as a string. The function must take a single argument,
2579 a calendar-style date list like (month day year)."
2586 "Format a date string for display in the daily/weekly agenda, or timeline.
2587 This function makes sure that dates are aligned for easy reading."
2595 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2600 "Set means weekly/daily agenda will always contain all TODO entries.
2601 The TODO entries will be listed at the top of the agenda, before
2602 the entries for specific days."
2607 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2608 When nil, only one occurence is shown, either today or the
2609 nearest into the future."
2614 "No. of days before expiration during which a deadline becomes active.
2615 This variable governs the display in sparse trees and in the agenda.
2616 When negative, it means use this number (the absolute value of it)
2617 even if a deadline has a different individual lead time specified."
2623 "No. of days to continue listing scheduled items that are not marked DONE.
2624 When an item is scheduled on a date, it shows up in the agenda on this
2625 day and will be listed until it is marked done for the number of days
2626 given here."
2631 "Options concerning the time grid in the Org-mode Agenda."
2636 "Non-nil means, show a time grid in the agenda schedule.
2637 A time grid is a set of lines for specific times (like every two hours between
2638 8:00 and 20:00). The items scheduled for a day at specific times are
2639 sorted in between these lines.
2640 For details about when the grid will be shown, and what it will look like, see
2641 the variable `org-agenda-time-grid'."
2647 "----------------"
2650 "The settings for time grid for agenda display.
2651 This is a list of three items. The first item is again a list. It contains
2652 symbols specifying conditions when the grid should be displayed:
2654 daily if the agenda shows a single day
2655 weekly if the agenda shows an entire week
2656 today show grid on current date, independent of daily/weekly display
2657 require-timed show grid only if at least one item has a time specification
2659 The second item is a string which will be places behing the grid time.
2661 The third item is a list of integers, indicating the times that should have
2662 a grid line."
2664 :type
2671 require-timed)
2673 remove-match))
2678 "Options concerning sorting in the Org-mode Agenda."
2693 "Sorting structure for the agenda items of a single day.
2694 This is a list of symbols which will be used in sequence to determine
2695 if an entry should be listed before another entry. The following
2696 symbols are recognized:
2698 time-up Put entries with time-of-day indications first, early first
2699 time-down Put entries with time-of-day indications first, late first
2700 category-keep Keep the default order of categories, corresponding to the
2701 sequence in `org-agenda-files'.
2702 category-up Sort alphabetically by category, A-Z.
2703 category-down Sort alphabetically by category, Z-A.
2704 tag-up Sort alphabetically by last tag, A-Z.
2705 tag-down Sort alphabetically by last tag, Z-A.
2706 priority-up Sort numerically by priority, high priority last.
2707 priority-down Sort numerically by priority, high priority first.
2709 The different possibilities will be tried in sequence, and testing stops
2711 '(time-up category-keep priority-down)
2712 means: Pull out all entries having a specified time of day and sort them,
2713 in order to make a time schedule for the current day the first thing in the
2714 agenda listing for the day. Of the entries without a time indication, keep
2715 the grouped in categories, don't sort the categories, but keep them in
2716 the sequence given in `org-agenda-files'. Within each category sort by
2717 priority.
2719 Leaving out `category-keep' would mean that items will be sorted across
2720 categories by priority.
2722 Instead of a single list, this can also be a set of list for specific
2723 contents, with a context symbol in the car of the list, any of
2724 `agenda', `todo', `tags' for the corresponding agenda views."
2737 "Non-nil means, items without time are considered late.
2738 This is only relevant for sorting. When t, items which have no explicit
2739 time like 15:30 will be considered as 99:01, i.e. later than any items which
2740 do have a time. When nil, the default time is before 0:00. You can use this
2741 option to decide if the schedule for today should come before or after timeless
2742 agenda entries."
2747 "Options concerning the entry prefix in the Org-mode agenda display."
2756 "Format specifications for the prefix of items in the agenda views.
2757 An alist with four entries, for the different agenda types. The keys to the
2758 sublists are `agenda', `timeline', `todo', and `tags'. The values
2759 are format strings.
2760 This format works similar to a printf format, with the following meaning:
2763 as given by the CATEGORY keyword or derived from the file name.
2764 %T the *last* tag of the item. Last because inherited tags come
2765 first in the list.
2766 %t the time-of-day specification if one applies to the entry, in the
2767 format HH:MM
2768 %s Scheduling/Deadline information, a short string
2770 All specifiers work basically like the standard `%s' of printf, but may
2771 contain two additional characters: A question mark just after the `%' and
2772 a whitespace/punctuation character just before the final letter.
2774 If the first character after `%' is a question mark, the entire field
2775 will only be included if the corresponding value applies to the
2776 current entry. This is useful for fields which should have fixed
2777 width when present, but zero width when absent. For example,
2779 day is specified, but will completely disappear in entries which do
2780 not contain a time.
2782 If there is punctuation or whitespace character just before the final
2783 format letter, this character will be appended to the field value if
2786 empty, no additional colon would be interted.
2789 - Indent the line with two space characters
2790 - Give the category in a 12 chars wide field, padded with whitespace on
2791 the right (because of `-'). Append a colon if there is a category
2792 (because of `:').
2793 - If there is a time-of-day, put it into a 12 chars wide field. If no
2794 time, don't put in an empty field, just skip it (because of '?').
2795 - Finally, put the scheduling information and append a whitespace.
2797 As another example, if you don't want the time-of-day of entries in
2798 the prefix, you could use:
2802 See also the variables `org-agenda-remove-times-when-in-prefix' and
2803 `org-agenda-remove-tags'."
2814 "The compiled version of the most recently used prefix format.
2818 "Text preceeding scheduled items in the agenda view.
2819 THis is a list with two strings. The first applies when the item is
2820 scheduled on the current day. The second applies when it has been scheduled
2821 previously, it may contain a %d to capture how many days ago the item was
2822 scheduled."
2829 "Text preceeding deadline items in the agenda view.
2830 This is a list with two strings. The first applies when the item has its
2831 deadline on the current day. The second applies when it is in the past or
2832 in the future, it may contain %d to capture how many days away the deadline
2833 is (was)."
2840 "Non-nil means, remove duplicate time specifications in agenda items.
2841 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2842 time-of-day specification in a headline or diary entry is extracted and
2843 placed into the prefix. If this option is non-nil, the original specification
2844 \(a timestamp or -range, or just a plain time(range) specification like
2845 11:30-4pm) will be removed for agenda display. This makes the agenda less
2846 cluttered.
2847 The option can be t or nil. It may also be the symbol `beg', indicating
2848 that the time should only be removed what it is located at the beginning of
2849 the headline/diary entry."
2858 "Default duration for appointments that only have a starting time.
2859 When nil, no duration is specified in such cases.
2860 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2868 "Non-nil means, remove the tags from the headline copy in the agenda.
2869 When this is the symbol `prefix', only remove tags when
2870 `org-agenda-prefix-format' contains a `%T' specifier."
2882 "Shift tags in agenda items to this column.
2883 If this number is positive, it specifies the column. If it is negative,
2884 it means that the tags should be flushright to that column. For example,
2885 -80 works well for a normal 80 character screen."
2893 "Non-nil means, highlight low and high priorities in agenda.
2894 When t, the highest priority entries are bold, lowest priority italic.
2895 This may also be an association list of priority faces. The face may be
2906 "Options for embedding LaTeX code into Org-mode"
2914 "Options for creating images from LaTeX fragments.
2915 This is a property list with the following properties:
2917 `default' means use the forground of the default face.
2919 `default' means use the background of the default face.
2920 :scale a scaling factor for the size of the images
2921 :html-foreground, :html-background, :html-scale
2922 The same numbers for HTML export.
2923 :matchers a list indicating which matchers should be used to
2924 find LaTeX fragments. Valid members of this list are:
2941 "The document header used for processing LaTeX fragments."
2946 "Options for exporting org-listings."
2951 "General options for exporting Org-mode files."
2955 ;; FIXME
2960 When this option is turned on, these strings will be exported as:
2962 Org HTML LaTeX
2963 -----+----------+--------
2965 -- – --
2966 --- — ---
2967 ... … \ldots
2984 "Terms used in export text, translated to different languages.
2985 Use the variable `org-export-default-language' to set the language,
2986 or use the +OPTION lines for a per-file setting."
2996 "The default language of HTML export, as a string.
2997 This should have an association in `org-export-language-setup'."
3002 "Non-nil means, skip all text before the first headline when exporting.
3003 When nil, that text is exported as well."
3008 "The last level which is still exported as a headline.
3009 Inferior levels will produce itemize lists when exported.
3010 Note that a numeric prefix argument to an exporter function overrides
3011 this setting.
3018 "Non-nil means, add section numbers to headlines when exporting.
3025 "Non-nil means, create a table of contents in exported files.
3026 The TOC contains headlines with levels up to`org-export-headline-levels'.
3027 When an integer, include levels up to N in the toc, this may then be
3028 different from `org-export-headline-levels', but it will not be allowed
3029 to be larger than the number of headline levels.
3030 When nil, no table of contents is made.
3033 ASCII export, and with red color in HTML output, if the option
3034 `org-export-mark-todo-in-toc' is set.
3036 In HTML output, the TOC will be clickable.
3047 "Non-nil means, mark TOC lines that contain any open TODO items."
3052 "Non-nil means, preserve all line breaks when exporting.
3053 Normally, in HTML output paragraphs will be reformatted. In ASCII
3054 export, line breaks will always be preserved, regardless of this variable.
3061 "Whether subtrees with the ARCHIVE tag should be exported.
3062 This can have three different values
3063 nil Do not export, pretend this tree is not present
3064 t Do export the entire tree
3065 headline Only export the headline, but skip the tree below it."
3074 "Non-nil means, insert author name and email into the exported file.
3076 This option can also be set with the +OPTIONS line,
3082 "Non-nil means, insert a time stamp into the exported file.
3083 The time stamp shows when the file was created.
3085 This option can also be set with the +OPTIONS line,
3091 "If nil, do not export time stamps and associated keywords."
3096 "If nil, remove timestamps from the table of contents entries."
3101 "If nil, do not export tags, just remove them from headlines.
3102 If this is the symbol `not-in-toc', tags will be removed from table of
3103 contents entries, but still be shown in the headlines of the document.
3113 "Non-nil means, export with drawers like the property drawer.
3114 When t, all drawers are exported. This may also be a list of
3115 drawer names to export."
3124 "Options for translating special ascii sequences for the export backends."
3129 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3130 If the export target supports emphasizing text, the word will be
3131 typeset in bold, italic, or underlined, respectively. Works only for
3132 single words, but you can say: I *really* *mean* *this*.
3133 Not all export backends support this.
3140 "If nil, export [1] as a footnote marker.
3141 Lines starting with [1] will be formatted as footnotes.
3149 When this option is turned on, you can use TeX-like syntax for sub- and
3151 considered as a single item - so grouping with {} is normally not
3152 needed. For example, the following things will be parsed as single
3153 sub- or superscripts.
3155 10^24 or 10^tau several digits will be considered 1 item.
3156 10^-12 or 10^-tau a leading sign with digits or a word
3157 x^2-y^3 will be read as x^2 - y^3, because items are
3158 terminated by almost any nonword/nondigit char.
3159 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3161 Still, ambiguity is possible - so when in doubt use {} to enclose the
3162 sub/superscript. If you set this variable to the symbol `{}',
3163 the braces are *required* in order to trigger interpretations as
3165 frequently in plain text.
3167 Not all export backends support this, but HTML does.
3178 When this option is turned on, these strings will be exported as:
3181 -- : –
3182 --- : —
3184 Not all export backends support this, but HTML does.
3191 "Non-nil means, interpret simple TeX-like macros when exporting.
3193 No only real TeX macros will work here, but the standard HTML entities
3194 for math can be used as macro names as well. For a list of supported
3195 names in HTML export, see the constant `org-html-entities'.
3196 Not all export backends support this.
3204 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3206 the first non-white thing on a line. It will also find the math delimiters
3208 display math.
3217 This can be used to have pre-formatted text, fragments of code etc. For
3218 example:
3219 : ;; Some Lisp examples
3220 : (while (defc cnt)
3221 : (ding))
3222 will be looking just like this in also HTML. See also the QUOTE keyword.
3223 Not all export backends support this.
3230 "Number of stacked braces for sub/superscript matching.
3231 This has to be set before loading org.el to be effective."
3236 "Options for exporting tables in Org-mode."
3242 For example:
3244 | Name | Address | Birthday |
3245 |-------------+----------+-----------|
3246 | Arthur Dent | England | 29.2.2100 |
3248 Not all export backends support this.
3255 "Non-nil means, highlight the first table line.
3256 In HTML export, this means use <th> instead of <td>.
3257 In tables created with table.el, this applies to the first table line.
3258 In Org-mode tables, all lines before the first horizontal separator
3259 line will be formatted with <th> tags."
3264 "Remove special lines and marking characters in calculating tables.
3265 This removes the special marking character column from tables that are set
3266 up for spreadsheet calculations. It also removes the entire lines
3267 marked with `!', `_', or `^'. The lines with `$' are kept, because
3268 the values of constants may be useful to have."
3273 "Non-nil means, always export tables created with table.el natively.
3274 Natively means, use the HTML code generator in table.el.
3275 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3276 the table does not use row- or column-spanning). This has the
3277 advantage, that the automatic HTML conversions for math symbols and
3278 sub/superscripts can be applied. Org-mode's HTML generator is also
3279 much faster."
3284 "Options specific for ASCII export of Org-mode files."
3289 "Characters for underlining headings in ASCII export.
3290 In the given sequence, these characters will be used for level 1, 2, ..."
3295 "Bullet characters for headlines converted to lists in ASCII export.
3296 The first character is is used for the first lest level generated in this
3297 way, and so on. If there are more levels than characters given here,
3298 the list will be repeated.
3299 Note that plain lists will keep the same bullets as the have in the
3300 Org-mode file."
3305 "Options specific for XML export of Org-mode files."
3310 "Options specific for HTML export of Org-mode files."
3315 ""
3320 "The extension for exported HTML files."
3326 html {
3327 font-family: Times, serif;
3328 font-size: 12pt;
3329 }
3330 .title { text-align: center; }
3331 .todo { color: red; }
3332 .done { color: green; }
3333 .timestamp { color: grey }
3334 .timestamp-kwd { color: CadetBlue }
3335 .tag { background-color:lightblue; font-weight:normal }
3336 .target { background-color: lavender; }
3337 pre {
3338 border: 1pt solid #AEBDCC;
3339 background-color: #F3F5F7;
3340 padding: 5pt;
3341 font-family: courier, monospace;
3342 }
3343 table { border-collapse: collapse; }
3344 td, th {
3345 vertical-align: top;
3346 <!--border: 1pt solid #ADB9CC;-->
3347 }
3348 </style>"
3349 "The default style specification for exported HTML files.
3350 Since there are different ways of setting style information, this variable
3351 needs to contain the full HTML structure to provide a style, including the
3352 surrounding HTML tags. The style specifications should include definitions
3353 for new classes todo, done, title, and deadline. For example, legal values
3354 would be:
3357 p { font-weight: normal; color: gray; }
3358 h1 { color: black; }
3359 .title { text-align: center; }
3360 .todo, .deadline { color: red; }
3361 .done { color: green; }
3362 </style>
3364 or, if you want to keep the style in a file,
3368 As the value of this option simply gets inserted into the HTML <head> header,
3375 "Format for typesetting the document title in HTML export."
3380 "The <H> level for level 1 headings in HTML export."
3385 "Non-nil means, make file links to `file.org' point to `file.html'.
3386 When org-mode is exporting an org-mode file to HTML, links to
3387 non-html files are directly put into a href tag in HTML.
3388 However, links to other Org-mode files (recognized by the
3389 extension `.org.) should become links to the corresponding html
3390 file, assuming that the linked org-mode file will also be
3391 converted to HTML.
3392 When nil, the links still point to the plain `.org' file."
3397 "Non-nil means, inline images into exported HTML pages.
3398 This is done using an <img> tag. When nil, an anchor with href is used to
3399 link to the image. If this option is `maybe', then images in links with
3400 an empty description will be inlined, while images with a description will
3401 be linked only."
3407 ;; FIXME: rename
3409 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3410 When nil, these tags will be exported as plain text and therefore
3411 not be interpreted by a browser.
3419 "The HTML tag that is used to start a table.
3420 This must be a <table> tag, but you may change the options like
3421 borders and spacing."
3426 "The opening tag for table header fields.
3427 This is customizable so that alignment options can be specified."
3432 "The opening tag for table data fields.
3433 This is customizable so that alignment options can be specified."
3438 "If non-nil, write `org-export-html-html-helper-timestamp'
3439 into the exported HTML text. Otherwise, the buffer will just be saved
3440 to a file."
3446 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3451 "Options specific for iCalendar export of Org-mode files."
3456 "The file name for the iCalendar file covering all agenda files.
3458 The file name should be absolute, the file will be overwritten without warning."
3463 "Non-nil means, export to iCalendar files should also cover TODO items."
3471 "Non-nil means, export to iCalendar files should also cover sexp entries.
3472 These are entries like in the diary, but directly in an Org-mode file."
3477 "Amount of text below headline to be included in iCalendar export.
3478 This is a number of characters that should maximally be included.
3479 Properties, scheduling and clocking lines will always be removed.
3480 The text will be inserted into the DESCRIPTION field."
3488 "Calendar name for the combined iCalendar representing all agenda files."
3493 "Font-lock settings for highlighting in Org-mode."
3498 "Non-nil means fontify only the stars in each headline.
3499 When nil, the entire headline is fontified.
3500 Changing it requires restart of `font-lock-mode' to become effective
3501 also in regions already fontified."
3506 "Non-nil means, hide the first N-1 stars in a headline.
3507 This works by using the face `org-hide' for these stars. This
3508 face is white for a light background, and black for a dark
3509 background. You may have to customize the face `org-hide' to
3510 make this work.
3511 Changing it requires restart of `font-lock-mode' to become effective
3512 also in regions already fontified.
3513 You may also set this on a per-file basis by adding one of the following
3514 lines to the buffer:
3516 #+STARTUP: hidestars
3517 #+STARTUP: showstars"
3522 "Non-nil means, change the face of a headline if it is marked DONE.
3523 Normally, only the TODO/DONE keyword indicates the state of a headline.
3524 When this is non-nil, the headline after the keyword is set to the
3525 `org-headline-done' as an additional indication."
3530 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3531 Changing this variable requires a restart of Emacs to take effect."
3536 "Non-nil mean font-lock should hide the emphasis marker characters."
3547 "Set variable and compute the emphasis regular expression."
3551 org-emphasis-alist org-emphasis-regexp-components)
3564 ;; make sure special characters appear at the right position in the class
3576 ;; Make the regexp
3584 body1
3596 body1
3604 "Components used to build the regular expression for emphasis.
3605 This is a list with 6 entries. Terminology: In an emphasis string
3609 specify what is allowed/forbidden in each part:
3611 pre Chars allowed as prematch. Beginning of line will be allowed too.
3612 post Chars allowed as postmatch. End of line will be allowed too.
3613 border The chars *forbidden* as border characters.
3615 non-shy groups here, and don't allow newline here.
3616 newline The maximum number of newlines allowed in an emphasis exp.
3618 Use customize to modify this, or restart Emacs after changing it."
3636 )
3637 "Special syntax for emphasized text.
3638 Text starting and ending with a special character will be emphasized, for
3639 example *bold*, _underlined_ and /italic/. This variable sets the marker
3640 characters, the face to be used by font-lock for highlighting in Org-mode
3641 Emacs buffers, and the HTML tags to be used for this.
3642 Use customize to modify this, or restart Emacs after changing it."
3655 ;;; The faces
3658 "Faces in Org-mode."
3663 "Make a compatible face specification.
3664 If INHERITS is an existing face and if the Emacs version supports it,
3665 just inherit the face. If not, use SPECS to define the face.
3666 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3667 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3668 to the top of the list. The `min-colors' attribute will be removed from
3669 any other entries, and any resulting duplicates will be removed entirely."
3673 ;; In Emacs 23, we use inheritance where possible.
3674 ;; We only do this in Emacs 23, because only there the outline
3675 ;; faces have been changed to the original org-mode-level-faces.
3678 ;; These do not understand the `min-colors' attribute.
3697 "Face used to hide leading stars in headlines.
3698 The forground color of this face should be equal to the background
3699 color of the frame."
3710 "Face used for level 1 headlines."
3720 "Face used for level 2 headlines."
3732 "Face used for level 3 headlines."
3744 "Face used for level 4 headlines."
3752 "Face used for level 5 headlines."
3760 "Face used for level 6 headlines."
3768 "Face used for level 7 headlines."
3776 "Face used for level 8 headlines."
3784 "Face used for special keywords."
3795 "Face used for drawers."
3799 "Face used for the value of a property."
3811 "Face for column display of entry properties."
3815 ;; Make sure that a fixed-width face is used when we have a column table.
3827 "Face for deadlines and TODO keywords."
3840 "Face for headline with the ARCHIVE tag."
3847 "Face for links."
3854 "Face for the ellipsis in folded text."
3861 "Face for links."
3868 "Face for links."
3875 "Face for links."
3880 "Face for tags."
3890 "Face for TODO keywords."
3899 "Face used for todo keywords that indicate DONE items."
3907 "Face used to indicate that a headline is DONE.
3908 This face is only used if `org-fontify-done-headline' is set. If applies
3909 to the part of the headline after the DONE keyword."
3913 "Faces for specific TODO keywords.
3914 This is a list of cons cells, with TODO keywords in the car
3915 and faces in the cdr. The face can be a symbol, or a property
3932 "Face used for tables."
3942 "Face for formulas."
3955 "Face for fixed-with text like code snippets."
3969 "Face for fixed-with text like code snippets."
3981 "Face used in agenda for captions and dates."
3990 "Face for items scheduled for a certain day."
4000 "Face for items scheduled previously, and not yet done."
4010 "Face for items scheduled previously, and not yet done."
4017 "Faces for showing deadlines in the agenda.
4018 This is a list of cons cells. The cdr of each cess is a face to be used,
4020 Each car is a fraction of the head-warning time that must have passed for
4021 this the face in the cdr to be used for display. The numbers must be
4022 given in descending order. The head-warning time is normally taken
4023 from `org-deadline-warning-days', but can also be specified in the deadline
4024 timestamp itself, like this:
4026 DEADLINE: <2007-08-13 Mon -8d>
4028 You may use d for days, w for weeks, m for months and y for years. Months
4029 and years will only be treated in an approximate fashion (30.4 days for a
4030 month and 365.24 days for a year)."
4038 ;; FIXME: this is not good
4047 "Face for showing the agenda restriction lock."
4055 "Face used for time grids."
4060 org-level-5 org-level-6 org-level-7 org-level-8
4061 ))
4064 "The number different faces to be used for headlines.
4065 Org-mode defines 8 different headline faces, so this can be at most 8.
4066 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4070 ;;; Variables for pre-computed regular expressions, all buffer local
4085 "Matches a headline and puts everything into groups:
4086 group 1: the stars
4087 group 2: The todo keyword, maybe
4088 group 3: Priority cookie
4089 group 4: True headline
4093 "Matches a headline and puts TODO state into group 2 if present.
4138 rear-nonsticky t mouse-map t fontified t)
4145 s)
4152 s)
4161 "Modified `buffer-invisibility-spec' for Emacs 21.
4162 Some ops with invisible text do not work correctly on Emacs 21. For these
4163 we turn off invisibility temporarily. Use this in a `let' form."
4167 "Make VAR local in current buffer and set it to VALUE."
4171 "Check if the current buffer is in Org-mode."
4175 "Return the last element of LIST."
4208 "Variable associated with STARTUP options for org-mode.
4209 Each element is a list of three items: The startup options as written
4210 in the #+STARTUP line, the corresponding variable, and the value to
4211 set this variable to if the option is found. An optional forth element PUSH
4215 "Precompute regular expressions for current buffer."
4230 kwds kws0 kwsa key value cat arch tags const links hw dws
4231 tail sep kws1 prio props drawers
4232 ex log)
4256 links)))
4262 props)))
4269 l var val)
4284 )))
4298 ;; Process the TODO keywords
4300 ;; Use the global values as if they had been given locally.
4311 kwsa nil
4323 kw)
4325 kws0)
4333 ;????????????????? (setq org-todo-heads (append org-todo-heads (list hw)))
4344 ;; Process the constants
4352 ;; Process the tags.
4362 tgs))
4370 ;; Compute the regular expressions and other local variables
4375 org-drawer-regexp
4379 org-not-done-keywords
4381 org-todo-regexp
4384 org-not-done-regexp
4388 org-todo-line-regexp
4392 org-complex-heading-regexp
4397 org-nl-done-regexp
4401 org-todo-line-tags-regexp
4406 org-looking-at-done-regexp
4411 org-deadline-time-regexp
4413 org-deadline-line-regexp
4415 org-scheduled-regexp
4417 org-scheduled-time-regexp
4419 org-closed-time-regexp
4421 org-keyword-time-regexp
4427 org-keyword-time-not-clock-regexp
4433 org-maybe-keyword-time-regexp
4439 org-planning-or-clock-line-re
4444 )
4452 x))
4453 list))
4455 ;;; Some variables ujsed in various places
4460 "Function to be called when `C-c C-c' is used.
4463 ;;; Foreign variables, to inform the compiler
4465 ;; XEmacs only
4470 ;; Emacs only
4473 ;; Packages that org-mode interacts with
4507 ;; FIXME: Occasionally check by commenting these, to make sure
4508 ;; no other functions uses these, forgetting to let-bind them.
4515 ;; Defined somewhere in this file, but used before definition.
4528 ;;;; Emacs/XEmacs compatibility
4530 ;; Overlay compatibility functions
4548 "Make overlay OVL display TEXT with face FACE."
4558 "Make overlay OVL display TEXT with face FACE."
4581 "Find all overlays specifying PROP at POS or point.
4582 If DELETE is non-nil, delete all those overlays."
4584 ov found)
4588 found))
4590 ;; Region compatibility
4593 "Add-hook, compatible with both Emacsen."
4602 "Is `transient-mark-mode' on and the region active?
4603 Works on both Emacs and XEmacs."
4605 nil
4610 ;; Invisibility compatibility
4613 "Add elements to `buffer-invisibility-spec'.
4614 See documentation for `buffer-invisibility-spec' for the kind of elements
4615 that can be added."
4626 "Remove elements from `buffer-invisibility-spec'."
4634 "Is ARG a member of `buffer-invisibility-spec'?"
4637 nil))
4639 ;;;; Define the Org-mode
4642 (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."))
4645 ;; We use a before-change function to check if a table might need
4646 ;; an update.
4648 "Indicates that a table might need an update.
4649 This variable is set by `org-before-change-function'.
4658 ;;;###autoload
4660 "Outline-based notes management and organizer, alias
4663 Org-mode develops organizational tasks around a NOTES file which
4664 contains information about projects as plain text. Org-mode is
4665 implemented on top of outline-mode, which is ideal to keep the content
4666 of large files well structured. It supports ToDo items, deadlines and
4667 time stamps, which magically appear in the diary listing of the Emacs
4668 calendar. Tables are easily created with a built-in table editor.
4669 Plain text URL-like links connect to websites, emails (VM), Usenet
4670 messages (Gnus), BBDB entries, and any files related to the project.
4671 For printing and sharing of notes, an Org-mode file (or a part of it)
4672 can be exported as a structured ASCII or HTML file.
4674 The following commands are available:
4678 ;; Get rid of Outline menus, they are not needed
4679 ;; Need to do this here because define-derived-mode sets up
4680 ;; the keymap so late. Still, it is a waste to call this each time
4681 ;; we switch another buffer into org-mode.
4684 ;; Assume this is Greg's port, it used easymenu
4707 org-display-table 4
4710 org-ellipsis)))
4714 ;; Calc embedded
4721 ;; Activate before-change-function
4725 ;; Check for running clock before killing a buffer
4727 ;; Paragraphs and auto-filling
4732 ;; Comment characters
4733 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4736 ;; Imenu
4740 ;; Make isearch reveal context
4743 ;; Emacs 21 and XEmacs make use of the hook
4745 ;; Emacs 22 deals with this through a special variable
4749 ;; If empty file that did not turn on org-mode automatically, make it to.
4771 "Call COMMAND interactively, but pretend prefix are was ARG."
4777 ;; works also in narrowed buffer, because we start at 1, not point-min
4781 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4791 "Add text properties to entire string, from beginning to end.
4792 PLIST may be a list of properties, PROPS are individual properties and values
4793 that will be added to PLIST. Returns the string that was modified."
4796 string)
4800 ;;;; Font-Lock stuff, including the activators
4805 (org-defkey org-mouse-map
4806 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4807 (when org-mouse-1-follows-link
4808 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4809 (when org-tab-follows-link
4810 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4811 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4812 (when org-return-follows-link
4813 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4814 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
4816 (require 'font-lock)
4819 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
4820 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
4821 (defvar org-link-re-with-space nil
4822 "Matches a link with spaces, optional angular brackets around it.")
4823 (defvar org-link-re-with-space2 nil
4824 "Matches a link with spaces, optional angular brackets around it.")
4825 (defvar org-angle-link-re nil
4826 "Matches link with angular brackets, spaces are allowed.")
4827 (defvar org-plain-link-re nil
4828 "Matches plain link, without spaces.")
4829 (defvar org-bracket-link-regexp nil
4830 "Matches a link in double brackets.")
4831 (defvar org-bracket-link-analytic-regexp nil
4832 "Regular expression used to analyze links.
4833 Here is what the match groups contain after a match:
4834 1: http:
4835 2: http
4836 3: path
4837 4: [desc]
4838 5: desc")
4839 (defvar org-any-link-re nil
4840 "Regular expression matching any link.")
4842 (defun org-make-link-regexps ()
4843 "Update the link regular expressions.
4844 This should be called after the variable `org-link-types' has changed."
4845 (setq org-link-re-with-space
4846 (concat
4849 "[^" org-non-link-chars "]*"
4851 org-link-re-with-space2
4852 (concat
4857 org-angle-link-re
4858 (concat
4861 "[^" org-non-link-chars "]*"
4863 org-plain-link-re
4864 (concat
4867 org-bracket-link-regexp
4869 org-bracket-link-analytic-regexp
4870 (concat
4877 org-any-link-re
4882 (org-make-link-regexps)
4885 "Regular expression for fast time stamp matching.")
4887 "Regular expression for fast time stamp matching.")
4888 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4889 "Regular expression matching time strings for analysis.
4890 This one does not require the space after the date.")
4891 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4892 "Regular expression matching time strings for analysis.")
4894 "Regular expression matching time stamps, with groups.")
4896 "Regular expression matching time stamps (also [..]), with groups.")
4897 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4898 "Regular expression matching a time stamp range.")
4899 (defconst org-tr-regexp-both
4900 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4901 "Regular expression matching a time stamp range.")
4904 "Regular expression matching a time stamp or time stamp range.")
4907 "Regular expression matching a time stamp or time stamp range.
4908 The time stamps may be either active or inactive.")
4910 (defvar org-emph-face nil)
4912 (defun org-do-emphasis-faces (limit)
4913 "Run through the buffer and add overlays to links."
4914 (let (rtn)
4915 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4916 (if (not (= (char-after (match-beginning 3))
4917 (char-after (match-beginning 4))))
4918 (progn
4919 (setq rtn t)
4920 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4921 'face
4922 (nth 1 (assoc (match-string 3)
4923 org-emphasis-alist)))
4924 (add-text-properties (match-beginning 2) (match-end 2)
4925 '(font-lock-multiline t))
4926 (when org-hide-emphasis-markers
4927 (add-text-properties (match-end 4) (match-beginning 5)
4928 '(invisible org-link))
4929 (add-text-properties (match-beginning 3) (match-end 3)
4930 '(invisible org-link)))))
4931 (backward-char 1))
4932 rtn))
4934 (defun org-emphasize (&optional char)
4935 "Insert or change an emphasis, i.e. a font like bold or italic.
4936 If there is an active region, change that region to a new emphasis.
4937 If there is no region, just insert the marker characters and position
4938 the cursor between them.
4939 CHAR should be either the marker character, or the first character of the
4940 HTML tag associated with that emphasis. If CHAR is a space, the means
4941 to remove the emphasis of the selected region.
4942 If char is not given (for example in an interactive call) it
4943 will be prompted for."
4944 (interactive)
4945 (let ((eal org-emphasis-alist) e det
4946 (erc org-emphasis-regexp-components)
4947 (prompt "")
4948 (string "") beg end move tag c s)
4949 (if (org-region-active-p)
4950 (setq beg (region-beginning) end (region-end)
4951 string (buffer-substring beg end))
4952 (setq move t))
4954 (while (setq e (pop eal))
4955 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4956 c (aref tag 0))
4957 (push (cons c (string-to-char (car e))) det)
4958 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4959 (substring tag 1)))))
4960 (unless char
4961 (message "%s" (concat "Emphasis marker or tag:" prompt))
4962 (setq char (read-char-exclusive)))
4963 (setq char (or (cdr (assoc char det)) char))
4964 (if (equal char ?\ )
4965 (setq s "" move nil)
4966 (unless (assoc (char-to-string char) org-emphasis-alist)
4968 (setq s (char-to-string char)))
4969 (while (and (> (length string) 1)
4970 (equal (substring string 0 1) (substring string -1))
4971 (assoc (substring string 0 1) org-emphasis-alist))
4972 (setq string (substring string 1 -1)))
4973 (setq string (concat s string s))
4974 (if beg (delete-region beg end))
4975 (unless (or (bolp)
4977 (char-to-string (char-before (point)))))
4978 (insert " "))
4980 (char-to-string (char-after (point))))
4981 (insert " ") (backward-char 1))
4982 (insert string)
4983 (and move (backward-char 1))))
4985 (defconst org-nonsticky-props
4986 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4989 (defun org-activate-plain-links (limit)
4990 "Run through the buffer and add overlays to links."
4991 (catch 'exit
4992 (let (f)
4993 (while (re-search-forward org-plain-link-re limit t)
4994 (setq f (get-text-property (match-beginning 0) 'face))
4995 (if (or (eq f 'org-tag)
4996 (and (listp f) (memq 'org-tag f)))
4997 nil
4998 (add-text-properties (match-beginning 0) (match-end 0)
4999 (list 'mouse-face 'highlight
5000 'rear-nonsticky org-nonsticky-props
5001 'keymap org-mouse-map
5002 ))
5003 (throw 'exit t))))))
5005 (defun org-activate-code (limit)
5007 (unless (get-text-property (match-beginning 1) 'face)
5008 (remove-text-properties (match-beginning 0) (match-end 0)
5009 '(display t invisible t intangible t))
5010 t)))
5012 (defun org-activate-angle-links (limit)
5013 "Run through the buffer and add overlays to links."
5014 (if (re-search-forward org-angle-link-re limit t)
5015 (progn
5016 (add-text-properties (match-beginning 0) (match-end 0)
5017 (list 'mouse-face 'highlight
5018 'rear-nonsticky org-nonsticky-props
5019 'keymap org-mouse-map
5020 ))
5021 t)))
5023 (defmacro org-maybe-intangible (props)
5024 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5025 In emacs 21, invisible text is not avoided by the command loop, so the
5026 intangible property is needed to make sure point skips this text.
5027 In Emacs 22, this is not necessary. The intangible text property has
5028 led to problems with flyspell. These problems are fixed in flyspell.el,
5029 but we still avoid setting the property in Emacs 22 and later.
5030 We use a macro so that the test can happen at compilation time."
5031 (if (< emacs-major-version 22)
5032 `(append '(intangible t) ,props)
5033 props))
5035 (defun org-activate-bracket-links (limit)
5036 "Run through the buffer and add overlays to bracketed links."
5037 (if (re-search-forward org-bracket-link-regexp limit t)
5038 (let* ((help (concat "LINK: "
5039 (org-match-string-no-properties 1)))
5040 ;; FIXME: above we should remove the escapes.
5041 ;; but that requires another match, protecting match data,
5042 ;; a lot of overhead for font-lock.
5043 (ip (org-maybe-intangible
5044 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5045 'keymap org-mouse-map 'mouse-face 'highlight
5046 'font-lock-multiline t 'help-echo help)))
5047 (vp (list 'rear-nonsticky org-nonsticky-props
5048 'keymap org-mouse-map 'mouse-face 'highlight
5049 ' font-lock-multiline t 'help-echo help)))
5050 ;; We need to remove the invisible property here. Table narrowing
5051 ;; may have made some of this invisible.
5052 (remove-text-properties (match-beginning 0) (match-end 0)
5053 '(invisible nil))
5054 (if (match-end 3)
5055 (progn
5056 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5057 (add-text-properties (match-beginning 3) (match-end 3) vp)
5058 (add-text-properties (match-end 3) (match-end 0) ip))
5059 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5060 (add-text-properties (match-beginning 1) (match-end 1) vp)
5061 (add-text-properties (match-end 1) (match-end 0) ip))
5062 t)))
5064 (defun org-activate-dates (limit)
5065 "Run through the buffer and add overlays to dates."
5066 (if (re-search-forward org-tsr-regexp-both limit t)
5067 (progn
5068 (add-text-properties (match-beginning 0) (match-end 0)
5069 (list 'mouse-face 'highlight
5070 'rear-nonsticky org-nonsticky-props
5071 'keymap org-mouse-map))
5072 (when org-display-custom-times
5073 (if (match-end 3)
5074 (org-display-custom-time (match-beginning 3) (match-end 3)))
5075 (org-display-custom-time (match-beginning 1) (match-end 1)))
5076 t)))
5078 (defvar org-target-link-regexp nil
5079 "Regular expression matching radio targets in plain text.")
5081 "Regular expression matching a link target.")
5083 "Regular expression matching a radio target.")
5084 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5085 "Regular expression matching any target.")
5087 (defun org-activate-target-links (limit)
5088 "Run through the buffer and add overlays to target matches."
5089 (when org-target-link-regexp
5090 (let ((case-fold-search t))
5091 (if (re-search-forward org-target-link-regexp limit t)
5092 (progn
5093 (add-text-properties (match-beginning 0) (match-end 0)
5094 (list 'mouse-face 'highlight
5095 'rear-nonsticky org-nonsticky-props
5096 'keymap org-mouse-map
5097 'help-echo "Radio target link"
5098 'org-linked-text t))
5099 t)))))
5101 (defun org-update-radio-target-regexp ()
5102 "Find all radio targets in this file and update the regular expression."
5103 (interactive)
5104 (when (memq 'radio org-activate-links)
5105 (setq org-target-link-regexp
5106 (org-make-target-link-regexp (org-all-targets 'radio)))
5107 (org-restart-font-lock)))
5109 (defun org-hide-wide-columns (limit)
5110 (let (s e)
5111 (setq s (text-property-any (point) (or limit (point-max))
5112 'org-cwidth t))
5113 (when s
5114 (setq e (next-single-property-change s 'org-cwidth))
5115 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5116 (goto-char e)
5117 t)))
5119 (defun org-restart-font-lock ()
5120 "Restart font-lock-mode, to force refontification."
5121 (when (and (boundp 'font-lock-mode) font-lock-mode)
5122 (font-lock-mode -1)
5123 (font-lock-mode 1)))
5125 (defun org-all-targets (&optional radio)
5126 "Return a list of all targets in this file.
5127 With optional argument RADIO, only find radio targets."
5128 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5129 rtn)
5130 (save-excursion
5131 (goto-char (point-min))
5132 (while (re-search-forward re nil t)
5133 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5134 rtn)))
5136 (defun org-make-target-link-regexp (targets)
5137 "Make regular expression matching all strings in TARGETS.
5138 The regular expression finds the targets also if there is a line break
5139 between words."
5140 (and targets
5141 (concat
5143 (mapconcat
5144 (lambda (x)
5145 (while (string-match " +" x)
5147 x)
5148 targets
5152 (defun org-activate-tags (limit)
5154 (progn
5155 (add-text-properties (match-beginning 1) (match-end 1)
5156 (list 'mouse-face 'highlight
5157 'rear-nonsticky org-nonsticky-props
5158 'keymap org-mouse-map))
5159 t)))
5161 (defun org-outline-level ()
5162 (save-excursion
5163 (looking-at outline-regexp)
5164 (if (match-beginning 1)
5165 (+ (org-get-string-indentation (match-string 1)) 1000)
5166 (1- (- (match-end 0) (match-beginning 0))))))
5168 (defvar org-font-lock-keywords nil)
5171 "Regular expression matching a property line.")
5173 (defun org-set-font-lock-defaults ()
5174 (let* ((em org-fontify-emphasized-text)
5175 (lk org-activate-links)
5176 (org-font-lock-extra-keywords
5177 (list
5178 ;; Headlines
5180 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5181 ;; Table lines
5183 (1 'org-table t))
5184 ;; Table internals
5188 ;; Drawers
5189 (list org-drawer-regexp '(0 'org-special-keyword t))
5191 ;; Properties
5192 (list org-property-re
5193 '(1 'org-special-keyword t)
5194 '(3 'org-property-value t))
5195 (if org-format-transports-properties-p
5197 ;; Links
5198 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5199 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5200 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5201 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5202 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5203 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5205 '(org-hide-wide-columns (0 nil append))
5206 ;; TODO lines
5208 '(1 (org-get-todo-face 1) t))
5209 ;; DONE
5210 (if org-fontify-done-headline
5214 '(2 'org-headline-done t))
5215 nil)
5216 ;; Priorities
5218 ;; Special keywords
5223 ;; Emphasis
5224 (if em
5225 (if (featurep 'xemacs)
5226 '(org-do-emphasis-faces (0 nil append))
5227 '(org-do-emphasis-faces)))
5228 ;; Checkboxes
5230 2 'bold prepend)
5231 (if org-provide-checkbox-statistics
5233 (0 (org-get-checkbox-statistics-face) t)))
5235 '(1 'org-archived prepend))
5236 ;; Specials
5237 '(org-do-latex-and-special-faces)
5238 ;; Code
5239 '(org-activate-code (1 'org-code t))
5240 ;; COMMENT
5243 '(1 'org-special-keyword t))
5244 '("^#.*" (0 'font-lock-comment-face t))
5245 )))
5246 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5247 ;; Now set the full font-lock-keywords
5248 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5249 (org-set-local 'font-lock-defaults
5250 '(org-font-lock-keywords t nil nil backward-paragraph))
5251 (kill-local-variable 'font-lock-keywords) nil))
5253 (defvar org-m nil)
5254 (defvar org-l nil)
5255 (defvar org-f nil)
5256 (defun org-get-level-face (n)
5257 "Get the right face for match N in font-lock matching of healdines."
5258 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5259 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5260 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5261 (cond
5262 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5263 ((eq n 2) org-f)
5264 (t (if org-level-color-stars-only nil org-f))))
5266 (defun org-get-todo-face (kwd)
5267 "Get the right face for a TODO keyword KWD.
5268 If KWD is a number, get the corresponding match group."
5269 (if (numberp kwd) (setq kwd (match-string kwd)))
5270 (or (cdr (assoc kwd org-todo-keyword-faces))
5271 (and (member kwd org-done-keywords) 'org-done)
5272 'org-todo))
5274 (defun org-unfontify-region (beg end &optional maybe_loudly)
5275 "Remove fontification and activation overlays from links."
5276 (font-lock-default-unfontify-region beg end)
5277 (let* ((buffer-undo-list t)
5278 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5279 (inhibit-modification-hooks t)
5280 deactivate-mark buffer-file-name buffer-file-truename)
5281 (remove-text-properties beg end
5282 '(mouse-face t keymap t org-linked-text t
5283 invisible t intangible t))))
5285 ;;;; Visibility cycling, including org-goto and indirect buffer
5287 ;;; Cycling
5289 (defvar org-cycle-global-status nil)
5290 (make-variable-buffer-local 'org-cycle-global-status)
5291 (defvar org-cycle-subtree-status nil)
5292 (make-variable-buffer-local 'org-cycle-subtree-status)
5294 ;;;###autoload
5295 (defun org-cycle (&optional arg)
5296 "Visibility cycling for Org-mode.
5298 - When this function is called with a prefix argument, rotate the entire
5299 buffer through 3 states (global cycling)
5300 1. OVERVIEW: Show only top-level headlines.
5301 2. CONTENTS: Show all headlines of all levels, but no body text.
5302 3. SHOW ALL: Show everything.
5304 - When point is at the beginning of a headline, rotate the subtree started
5305 by this line through 3 different states (local cycling)
5306 1. FOLDED: Only the main headline is shown.
5307 2. CHILDREN: The main headline and the direct children are shown.
5308 From this state, you can move to one of the children
5309 and zoom in further.
5310 3. SUBTREE: Show the entire subtree, including body text.
5312 - When there is a numeric prefix, go up to a heading with level ARG, do
5313 a `show-subtree' and return to the previous cursor position. If ARG
5314 is negative, go up that many levels.
5316 - When point is not at the beginning of a headline, execute
5317 `indent-relative', like TAB normally does. See the option
5318 `org-cycle-emulate-tab' for details.
5320 - Special case: if point is at the beginning of the buffer and there is
5321 no headline in line 1, this function will act as if called with prefix arg.
5322 But only if also the variable `org-cycle-global-at-bob' is t."
5323 (interactive "P")
5324 (let* ((outline-regexp
5325 (if (and (org-mode-p) org-cycle-include-plain-lists)
5327 outline-regexp))
5328 (bob-special (and org-cycle-global-at-bob (bobp)
5329 (not (looking-at outline-regexp))))
5330 (org-cycle-hook
5331 (if bob-special
5332 (delq 'org-optimize-window-after-visibility-change
5333 (copy-sequence org-cycle-hook))
5334 org-cycle-hook))
5335 (pos (point)))
5337 (if (or bob-special (equal arg '(4)))
5338 ;; special case: use global cycling
5339 (setq arg t))
5341 (cond
5343 ((org-at-table-p 'any)
5344 ;; Enter the table or move to the next field in the table
5345 (or (org-table-recognize-table.el)
5346 (progn
5347 (if arg (org-table-edit-field t)
5348 (org-table-justify-field-maybe)
5349 (call-interactively 'org-table-next-field)))))
5351 ((eq arg t) ;; Global cycling
5353 (cond
5354 ((and (eq last-command this-command)
5355 (eq org-cycle-global-status 'overview))
5356 ;; We just created the overview - now do table of contents
5357 ;; This can be slow in very large buffers, so indicate action
5358 (message "CONTENTS...")
5359 (org-content)
5360 (message "CONTENTS...done")
5361 (setq org-cycle-global-status 'contents)
5362 (run-hook-with-args 'org-cycle-hook 'contents))
5364 ((and (eq last-command this-command)
5365 (eq org-cycle-global-status 'contents))
5366 ;; We just showed the table of contents - now show everything
5367 (show-all)
5368 (message "SHOW ALL")
5369 (setq org-cycle-global-status 'all)
5370 (run-hook-with-args 'org-cycle-hook 'all))
5372 (t
5373 ;; Default action: go to overview
5374 (org-overview)
5375 (message "OVERVIEW")
5376 (setq org-cycle-global-status 'overview)
5377 (run-hook-with-args 'org-cycle-hook 'overview))))
5379 ((and org-drawers org-drawer-regexp
5380 (save-excursion
5381 (beginning-of-line 1)
5382 (looking-at org-drawer-regexp)))
5383 ;; Toggle block visibility
5384 (org-flag-drawer
5385 (not (get-char-property (match-end 0) 'invisible))))
5387 ((integerp arg)
5388 ;; Show-subtree, ARG levels up from here.
5389 (save-excursion
5390 (org-back-to-heading)
5391 (outline-up-heading (if (< arg 0) (- arg)
5392 (- (funcall outline-level) arg)))
5393 (org-show-subtree)))
5395 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5396 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5397 ;; At a heading: rotate between three different views
5398 (org-back-to-heading)
5399 (let ((goal-column 0) eoh eol eos)
5400 ;; First, some boundaries
5401 (save-excursion
5402 (org-back-to-heading)
5403 (save-excursion
5404 (beginning-of-line 2)
5405 (while (and (not (eobp)) ;; this is like `next-line'
5406 (get-char-property (1- (point)) 'invisible))
5407 (beginning-of-line 2)) (setq eol (point)))
5408 (outline-end-of-heading) (setq eoh (point))
5409 (org-end-of-subtree t)
5410 (unless (eobp)
5412 (beginning-of-line 1) ; in case this is an item
5413 )
5414 (setq eos (1- (point))))
5415 ;; Find out what to do next and set `this-command'
5416 (cond
5417 ((= eos eoh)
5418 ;; Nothing is hidden behind this heading
5419 (message "EMPTY ENTRY")
5420 (setq org-cycle-subtree-status nil)
5421 (save-excursion
5422 (goto-char eos)
5423 (outline-next-heading)
5424 (if (org-invisible-p) (org-flag-heading nil))))
5425 ((or (>= eol eos)
5427 ;; Entire subtree is hidden in one line: open it
5428 (org-show-entry)
5429 (show-children)
5430 (message "CHILDREN")
5431 (save-excursion
5432 (goto-char eos)
5433 (outline-next-heading)
5434 (if (org-invisible-p) (org-flag-heading nil)))
5435 (setq org-cycle-subtree-status 'children)
5436 (run-hook-with-args 'org-cycle-hook 'children))
5437 ((and (eq last-command this-command)
5438 (eq org-cycle-subtree-status 'children))
5439 ;; We just showed the children, now show everything.
5440 (org-show-subtree)
5441 (message "SUBTREE")
5442 (setq org-cycle-subtree-status 'subtree)
5443 (run-hook-with-args 'org-cycle-hook 'subtree))
5444 (t
5445 ;; Default action: hide the subtree.
5446 (hide-subtree)
5447 (message "FOLDED")
5448 (setq org-cycle-subtree-status 'folded)
5449 (run-hook-with-args 'org-cycle-hook 'folded)))))
5451 ;; TAB emulation
5452 (buffer-read-only (org-back-to-heading))
5454 ((org-try-cdlatex-tab))
5456 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5457 (or (not (bolp))
5458 (not (looking-at outline-regexp))))
5461 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5463 (or (and (eq org-cycle-emulate-tab 'white)
5464 (= (match-end 0) (point-at-eol)))
5465 (and (eq org-cycle-emulate-tab 'whitestart)
5466 (>= (match-end 0) pos))))
5467 t
5468 (eq org-cycle-emulate-tab t))
5471 ; (point-at-bol) (point))))
5472 ; (progn
5473 ; (beginning-of-line 1)
5477 (t (save-excursion
5478 (org-back-to-heading)
5479 (org-cycle))))))
5481 ;;;###autoload
5482 (defun org-global-cycle (&optional arg)
5483 "Cycle the global visibility. For details see `org-cycle'."
5484 (interactive "P")
5485 (let ((org-cycle-include-plain-lists
5486 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5487 (if (integerp arg)
5488 (progn
5489 (show-all)
5490 (hide-sublevels arg)
5491 (setq org-cycle-global-status 'contents))
5492 (org-cycle '(4)))))
5494 (defun org-overview ()
5495 "Switch to overview mode, shoing only top-level headlines.
5496 Really, this shows all headlines with level equal or greater than the level
5497 of the first headline in the buffer. This is important, because if the
5498 first headline is not level one, then (hide-sublevels 1) gives confusing
5499 results."
5500 (interactive)
5501 (let ((level (save-excursion
5502 (goto-char (point-min))
5503 (if (re-search-forward (concat "^" outline-regexp) nil t)
5504 (progn
5505 (goto-char (match-beginning 0))
5506 (funcall outline-level))))))
5507 (and level (hide-sublevels level))))
5509 (defun org-content (&optional arg)
5510 "Show all headlines in the buffer, like a table of contents.
5511 With numerical argument N, show content up to level N."
5512 (interactive "P")
5513 (save-excursion
5514 ;; Visit all headings and show their offspring
5515 (and (integerp arg) (org-overview))
5516 (goto-char (point-max))
5517 (catch 'exit
5518 (while (and (progn (condition-case nil
5519 (outline-previous-visible-heading 1)
5520 (error (goto-char (point-min))))
5521 t)
5522 (looking-at outline-regexp))
5523 (if (integerp arg)
5524 (show-children (1- arg))
5525 (show-branches))
5526 (if (bobp) (throw 'exit nil))))))
5529 (defun org-optimize-window-after-visibility-change (state)
5530 "Adjust the window after a change in outline visibility.
5531 This function is the default value of the hook `org-cycle-hook'."
5532 (when (get-buffer-window (current-buffer))
5533 (cond
5534 ; ((eq state 'overview) (org-first-headline-recenter 1))
5535 ; ((eq state 'overview) (org-beginning-of-line))
5536 ((eq state 'content) nil)
5537 ((eq state 'all) nil)
5538 ((eq state 'folded) nil)
5539 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5540 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5543 (defun org-cycle-show-empty-lines (state)
5544 "Show empty lines above all visible headlines.
5545 The region to be covered depends on STATE when called through
5546 `org-cycle-hook'. Lisp program can use t for STATE to get the
5547 entire buffer covered. Note that an empty line is only shown if there
5548 are at least `org-cycle-separator-lines' empty lines before the headeline."
5549 (when (> org-cycle-separator-lines 0)
5550 (save-excursion
5551 (let* ((n org-cycle-separator-lines)
5552 (re (cond
5555 (t (let ((ns (number-to-string (- n 2))))
5558 beg end)
5559 (cond
5560 ((memq state '(overview contents t))
5561 (setq beg (point-min) end (point-max)))
5562 ((memq state '(children folded))
5563 (setq beg (point) end (progn (org-end-of-subtree t t)
5564 (beginning-of-line 2)
5565 (point)))))
5566 (when beg
5567 (goto-char beg)
5568 (while (re-search-forward re end t)
5569 (if (not (get-char-property (match-end 1) 'invisible))
5570 (outline-flag-region
5571 (match-beginning 1) (match-end 1) nil)))))))
5572 ;; Never hide empty lines at the end of the file.
5573 (save-excursion
5574 (goto-char (point-max))
5575 (outline-previous-heading)
5576 (outline-end-of-heading)
5578 (= (match-end 0) (point-max)))
5579 (outline-flag-region (point) (match-end 0) nil))))
5581 (defun org-subtree-end-visible-p ()
5582 "Is the end of the current subtree visible?"
5583 (pos-visible-in-window-p
5584 (save-excursion (org-end-of-subtree t) (point))))
5586 (defun org-first-headline-recenter (&optional N)
5587 "Move cursor to the first headline and recenter the headline.
5588 Optional argument N means, put the headline into the Nth line of the window."
5589 (goto-char (point-min))
5591 (beginning-of-line)
5592 (recenter (prefix-numeric-value N))))
5594 ;;; Org-goto
5596 (defvar org-goto-window-configuration nil)
5597 (defvar org-goto-marker nil)
5598 (defvar org-goto-map
5599 (let ((map (make-sparse-keymap)))
5600 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5601 (while (setq cmd (pop cmds))
5602 (substitute-key-definition cmd cmd map global-map)))
5603 (suppress-keymap map)
5604 (org-defkey map "\C-m" 'org-goto-ret)
5605 (org-defkey map [(left)] 'org-goto-left)
5606 (org-defkey map [(right)] 'org-goto-right)
5607 (org-defkey map [(?q)] 'org-goto-quit)
5608 (org-defkey map [(control ?g)] 'org-goto-quit)
5609 (org-defkey map "\C-i" 'org-cycle)
5610 (org-defkey map [(tab)] 'org-cycle)
5611 (org-defkey map [(down)] 'outline-next-visible-heading)
5612 (org-defkey map [(up)] 'outline-previous-visible-heading)
5613 (org-defkey map "n" 'outline-next-visible-heading)
5614 (org-defkey map "p" 'outline-previous-visible-heading)
5615 (org-defkey map "f" 'outline-forward-same-level)
5616 (org-defkey map "b" 'outline-backward-same-level)
5617 (org-defkey map "u" 'outline-up-heading)
5618 (org-defkey map "/" 'org-occur)
5619 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5620 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5621 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5622 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5623 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5624 map))
5626 (defconst org-goto-help
5627 "Browse copy of buffer to find location or copy text.
5628 RET=jump to location [Q]uit and return to previous location
5629 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur"
5630 )
5632 (defun org-goto ()
5633 "Look up a different location in the current file, keeping current visibility.
5635 When you want look-up or go to a different location in a document, the
5636 fastest way is often to fold the entire buffer and then dive into the tree.
5637 This method has the disadvantage, that the previous location will be folded,
5638 which may not be what you want.
5640 This command works around this by showing a copy of the current buffer
5641 in an indirect buffer, in overview mode. You can dive into the tree in
5642 that copy, use org-occur and incremental search to find a location.
5643 When pressing RET or `Q', the command returns to the original buffer in
5644 which the visibility is still unchanged. After RET is will also jump to
5645 the location selected in the indirect buffer and expose the
5646 the headline hierarchy above."
5647 (interactive)
5648 (let* ((org-goto-start-pos (point))
5649 (selected-point
5650 (car (org-get-location (current-buffer) org-goto-help))))
5651 (if selected-point
5652 (progn
5653 (org-mark-ring-push org-goto-start-pos)
5654 (goto-char selected-point)
5655 (if (or (org-invisible-p) (org-invisible-p2))
5656 (org-show-context 'org-goto)))
5657 (message "Quit"))))
5659 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5660 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5662 (defun org-get-location (buf help)
5663 "Let the user select a location in the Org-mode buffer BUF.
5664 This function uses a recursive edit. It returns the selected position
5665 or nil."
5666 (let (org-goto-selected-point org-goto-exit-command)
5667 (save-excursion
5668 (save-window-excursion
5669 (delete-other-windows)
5670 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5671 (switch-to-buffer
5672 (condition-case nil
5673 (make-indirect-buffer (current-buffer) "*org-goto*")
5674 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5675 (with-output-to-temp-buffer "*Help*"
5676 (princ help))
5677 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5678 (setq buffer-read-only nil)
5679 (let ((org-startup-truncated t)
5680 (org-startup-folded nil)
5681 (org-startup-align-all-tables nil))
5682 (org-mode)
5683 (org-overview))
5684 (setq buffer-read-only t)
5685 (if (and (boundp 'org-goto-start-pos)
5686 (integer-or-marker-p org-goto-start-pos))
5687 (let ((org-show-hierarchy-above t)
5688 (org-show-siblings t)
5689 (org-show-following-heading t))
5690 (goto-char org-goto-start-pos)
5691 (and (org-invisible-p) (org-show-context)))
5692 (goto-char (point-min)))
5693 (org-beginning-of-line)
5694 (message "Select location and press RET")
5695 ;; now we make sure that during selection, ony very few keys work
5696 ;; and that it is impossible to switch to another window.
5697 ; (let ((gm (current-global-map))
5698 ; (overriding-local-map org-goto-map))
5699 ; (unwind-protect
5700 ; (progn
5701 ; (use-global-map org-goto-map)
5702 ; (recursive-edit))
5703 ; (use-global-map gm)))
5704 (use-local-map org-goto-map)
5705 (recursive-edit)
5706 ))
5707 (kill-buffer "*org-goto*")
5708 (cons org-goto-selected-point org-goto-exit-command)))
5710 (defun org-goto-ret (&optional arg)
5711 "Finish `org-goto' by going to the new location."
5712 (interactive "P")
5713 (setq org-goto-selected-point (point)
5714 org-goto-exit-command 'return)
5715 (throw 'exit nil))
5717 (defun org-goto-left ()
5718 "Finish `org-goto' by going to the new location."
5719 (interactive)
5720 (if (org-on-heading-p)
5721 (progn
5722 (beginning-of-line 1)
5723 (setq org-goto-selected-point (point)
5724 org-goto-exit-command 'left)
5725 (throw 'exit nil))
5726 (error "Not on a heading")))
5728 (defun org-goto-right ()
5729 "Finish `org-goto' by going to the new location."
5730 (interactive)
5731 (if (org-on-heading-p)
5732 (progn
5733 (setq org-goto-selected-point (point)
5734 org-goto-exit-command 'right)
5735 (throw 'exit nil))
5736 (error "Not on a heading")))
5738 (defun org-goto-quit ()
5739 "Finish `org-goto' without cursor motion."
5740 (interactive)
5741 (setq org-goto-selected-point nil)
5742 (setq org-goto-exit-command 'quit)
5743 (throw 'exit nil))
5745 ;;; Indirect buffer display of subtrees
5747 (defvar org-indirect-dedicated-frame nil
5748 "This is the frame being used for indirect tree display.")
5749 (defvar org-last-indirect-buffer nil)
5751 (defun org-tree-to-indirect-buffer (&optional arg)
5752 "Create indirect buffer and narrow it to current subtree.
5753 With numerical prefix ARG, go up to this level and then take that tree.
5754 If ARG is negative, go up that many levels.
5755 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5756 indirect buffer previously made with this command, to avoid proliferation of
5757 indirect buffers. However, when you call the command with a `C-u' prefix, or
5758 when `org-indirect-buffer-display' is `new-frame', the last buffer
5759 is kept so that you can work with several indirect buffers at the same time.
5760 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5761 requests that a new frame be made for the new buffer, so that the dedicated
5762 frame is not changed."
5763 (interactive "P")
5764 (let ((cbuf (current-buffer))
5765 (cwin (selected-window))
5766 (pos (point))
5767 beg end level heading ibuf)
5768 (save-excursion
5769 (org-back-to-heading t)
5770 (when (numberp arg)
5771 (setq level (org-outline-level))
5772 (if (< arg 0) (setq arg (+ level arg)))
5773 (while (> (setq level (org-outline-level)) arg)
5774 (outline-up-heading 1 t)))
5775 (setq beg (point)
5776 heading (org-get-heading))
5777 (org-end-of-subtree t) (setq end (point)))
5778 (if (and (buffer-live-p org-last-indirect-buffer)
5779 (not (eq org-indirect-buffer-display 'new-frame))
5780 (not arg))
5781 (kill-buffer org-last-indirect-buffer))
5782 (setq ibuf (org-get-indirect-buffer cbuf)
5783 org-last-indirect-buffer ibuf)
5784 (cond
5785 ((or (eq org-indirect-buffer-display 'new-frame)
5786 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5787 (select-frame (make-frame))
5788 (delete-other-windows)
5789 (switch-to-buffer ibuf)
5790 (org-set-frame-title heading))
5791 ((eq org-indirect-buffer-display 'dedicated-frame)
5792 (raise-frame
5793 (select-frame (or (and org-indirect-dedicated-frame
5794 (frame-live-p org-indirect-dedicated-frame)
5795 org-indirect-dedicated-frame)
5796 (setq org-indirect-dedicated-frame (make-frame)))))
5797 (delete-other-windows)
5798 (switch-to-buffer ibuf)
5799 (org-set-frame-title (concat "Indirect: " heading)))
5800 ((eq org-indirect-buffer-display 'current-window)
5801 (switch-to-buffer ibuf))
5802 ((eq org-indirect-buffer-display 'other-window)
5803 (pop-to-buffer ibuf))
5804 (t (error "Invalid value.")))
5805 (if (featurep 'xemacs)
5806 (save-excursion (org-mode) (turn-on-font-lock)))
5807 (narrow-to-region beg end)
5808 (show-all)
5809 (goto-char pos)
5810 (and (window-live-p cwin) (select-window cwin))))
5812 (defun org-get-indirect-buffer (&optional buffer)
5813 (setq buffer (or buffer (current-buffer)))
5814 (let ((n 1) (base (buffer-name buffer)) bname)
5815 (while (buffer-live-p
5816 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5817 (setq n (1+ n)))
5818 (condition-case nil
5819 (make-indirect-buffer buffer bname 'clone)
5820 (error (make-indirect-buffer buffer bname)))))
5822 (defun org-set-frame-title (title)
5823 "Set the title of the current frame to the string TITLE."
5824 ;; FIXME: how to name a single frame in XEmacs???
5825 (unless (featurep 'xemacs)
5826 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5828 ;;;; Structure editing
5830 ;;; Inserting headlines
5832 (defun org-insert-heading (&optional force-heading)
5833 "Insert a new heading or item with same depth at point.
5834 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5835 If point is at the beginning of a headline, insert a sibling before the
5836 current headline. If point is in the middle of a headline, split the headline
5837 at that position and make the rest of the headline part of the sibling below
5838 the current headline."
5839 (interactive "P")
5840 (if (= (buffer-size) 0)
5842 (when (or force-heading (not (org-insert-item)))
5843 (let* ((head (save-excursion
5844 (condition-case nil
5845 (progn
5846 (org-back-to-heading)
5847 (match-string 0))
5848 (error "*"))))
5849 (blank (cdr (assq 'heading org-blank-before-new-entry)))
5850 pos)
5851 (cond
5852 ((and (org-on-heading-p) (bolp)
5853 (or (bobp)
5854 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5855 (open-line (if blank 2 1)))
5856 ((and (bolp)
5857 (or (bobp)
5858 (save-excursion
5859 (backward-char 1) (not (org-invisible-p)))))
5860 nil)
5861 (t (newline (if blank 2 1))))
5862 (insert head) (just-one-space)
5863 (setq pos (point))
5864 (end-of-line 1)
5865 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5866 (run-hooks 'org-insert-heading-hook)))))
5868 (defun org-insert-heading-after-current ()
5869 "Insert a new heading with same level as current, after current subtree."
5870 (interactive)
5871 (org-back-to-heading)
5872 (org-insert-heading)
5873 (org-move-subtree-down)
5874 (end-of-line 1))
5876 (defun org-insert-todo-heading (arg)
5877 "Insert a new heading with the same level and TODO state as current heading.
5878 If the heading has no TODO state, or if the state is DONE, use the first
5879 state (TODO by default). Also with prefix arg, force first state."
5880 (interactive "P")
5881 (when (not (org-insert-item 'checkbox))
5882 (org-insert-heading)
5883 (save-excursion
5884 (org-back-to-heading)
5885 (outline-previous-heading)
5886 (looking-at org-todo-line-regexp))
5887 (if (or arg
5888 (not (match-beginning 2))
5889 (member (match-string 2) org-done-keywords))
5890 (insert (car org-todo-keywords-1) " ")
5891 (insert (match-string 2) " "))))
5893 (defun org-insert-subheading (arg)
5894 "Insert a new subheading and demote it.
5895 Works for outline headings and for plain lists alike."
5896 (interactive "P")
5897 (org-insert-heading arg)
5898 (cond
5899 ((org-on-heading-p) (org-do-demote))
5900 ((org-at-item-p) (org-indent-item 1))))
5902 (defun org-insert-todo-subheading (arg)
5903 "Insert a new subheading with TODO keyword or checkbox and demote it.
5904 Works for outline headings and for plain lists alike."
5905 (interactive "P")
5906 (org-insert-todo-heading arg)
5907 (cond
5908 ((org-on-heading-p) (org-do-demote))
5909 ((org-at-item-p) (org-indent-item 1))))
5911 ;;; Promotion and Demotion
5913 (defun org-promote-subtree ()
5914 "Promote the entire subtree.
5915 See also `org-promote'."
5916 (interactive)
5917 (save-excursion
5918 (org-map-tree 'org-promote))
5919 (org-fix-position-after-promote))
5921 (defun org-demote-subtree ()
5922 "Demote the entire subtree. See `org-demote'.
5923 See also `org-promote'."
5924 (interactive)
5925 (save-excursion
5926 (org-map-tree 'org-demote))
5927 (org-fix-position-after-promote))
5930 (defun org-do-promote ()
5931 "Promote the current heading higher up the tree.
5932 If the region is active in `transient-mark-mode', promote all headings
5933 in the region."
5934 (interactive)
5935 (save-excursion
5936 (if (org-region-active-p)
5937 (org-map-region 'org-promote (region-beginning) (region-end))
5938 (org-promote)))
5939 (org-fix-position-after-promote))
5941 (defun org-do-demote ()
5942 "Demote the current heading lower down the tree.
5943 If the region is active in `transient-mark-mode', demote all headings
5944 in the region."
5945 (interactive)
5946 (save-excursion
5947 (if (org-region-active-p)
5948 (org-map-region 'org-demote (region-beginning) (region-end))
5949 (org-demote)))
5950 (org-fix-position-after-promote))
5952 (defun org-fix-position-after-promote ()
5953 "Make sure that after pro/demotion cursor position is right."
5954 (let ((pos (point)))
5955 (when (save-excursion
5956 (beginning-of-line 1)
5957 (looking-at org-todo-line-regexp)
5958 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5959 (cond ((eobp) (insert " "))
5960 ((eolp) (insert " "))
5961 ((equal (char-after) ?\ ) (forward-char 1))))))
5963 (defun org-reduced-level (l)
5964 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5966 (defun org-get-legal-level (level &optional change)
5967 "Rectify a level change under the influence of `org-odd-levels-only'
5968 LEVEL is a current level, CHANGE is by how much the level should be
5969 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5970 even level numbers will become the next higher odd number."
5971 (if org-odd-levels-only
5972 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5973 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5974 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5975 (max 1 (+ level change))))
5977 (defun org-promote ()
5978 "Promote the current heading higher up the tree.
5979 If the region is active in `transient-mark-mode', promote all headings
5980 in the region."
5981 (org-back-to-heading t)
5982 (let* ((level (save-match-data (funcall outline-level)))
5983 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
5984 (diff (abs (- level (length up-head) -1))))
5985 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5986 (replace-match up-head nil t)
5987 ;; Fixup tag positioning
5988 (and org-auto-align-tags (org-set-tags nil t))
5989 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5991 (defun org-demote ()
5992 "Demote the current heading lower down the tree.
5993 If the region is active in `transient-mark-mode', demote all headings
5994 in the region."
5995 (org-back-to-heading t)
5996 (let* ((level (save-match-data (funcall outline-level)))
5997 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
5998 (diff (abs (- level (length down-head) -1))))
5999 (replace-match down-head nil t)
6000 ;; Fixup tag positioning
6001 (and org-auto-align-tags (org-set-tags nil t))
6002 (if org-adapt-indentation (org-fixup-indentation diff))))
6004 (defun org-map-tree (fun)
6005 "Call FUN for every heading underneath the current one."
6006 (org-back-to-heading)
6007 (let ((level (funcall outline-level)))
6008 (save-excursion
6009 (funcall fun)
6010 (while (and (progn
6011 (outline-next-heading)
6012 (> (funcall outline-level) level))
6013 (not (eobp)))
6014 (funcall fun)))))
6016 (defun org-map-region (fun beg end)
6017 "Call FUN for every heading between BEG and END."
6018 (let ((org-ignore-region t))
6019 (save-excursion
6020 (setq end (copy-marker end))
6021 (goto-char beg)
6022 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6023 (< (point) end))
6024 (funcall fun))
6025 (while (and (progn
6026 (outline-next-heading)
6027 (< (point) end))
6028 (not (eobp)))
6029 (funcall fun)))))
6031 (defun org-fixup-indentation (diff)
6032 "Change the indentation in the current entry by DIFF
6033 However, if any line in the current entry has no indentation, or if it
6034 would end up with no indentation after the change, nothing at all is done."
6035 (save-excursion
6036 (let ((end (save-excursion (outline-next-heading)
6037 (point-marker)))
6038 (prohibit (if (> diff 0)
6041 col)
6042 (unless (save-excursion (end-of-line 1)
6043 (re-search-forward prohibit end t))
6044 (while (and (< (point) end)
6046 (goto-char (match-end 0))
6047 (setq col (current-column))
6048 (if (< diff 0) (replace-match ""))
6049 (indent-to (+ diff col))))
6050 (move-marker end nil))))
6052 (defun org-convert-to-odd-levels ()
6053 "Convert an org-mode file with all levels allowed to one with odd levels.
6054 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6055 level 5 etc."
6056 (interactive)
6057 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6058 (let ((org-odd-levels-only nil) n)
6059 (save-excursion
6060 (goto-char (point-min))
6062 (setq n (- (length (match-string 0)) 2))
6063 (while (>= (setq n (1- n)) 0)
6064 (org-demote))
6065 (end-of-line 1))))))
6068 (defun org-convert-to-oddeven-levels ()
6069 "Convert an org-mode file with only odd levels to one with odd and even levels.
6070 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6071 section with an even level, conversion would destroy the structure of the file. An error
6072 is signaled in this case."
6073 (interactive)
6074 (goto-char (point-min))
6075 ;; First check if there are no even levels
6077 (org-show-context t)
6078 (error "Not all levels are odd in this file. Conversion not possible."))
6079 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6080 (let ((org-odd-levels-only nil) n)
6081 (save-excursion
6082 (goto-char (point-min))
6084 (setq n (/ (1- (length (match-string 0))) 2))
6085 (while (>= (setq n (1- n)) 0)
6086 (org-promote))
6087 (end-of-line 1))))))
6089 (defun org-tr-level (n)
6090 "Make N odd if required."
6091 (if org-odd-levels-only (1+ (/ n 2)) n))
6093 ;;; Vertical tree motion, cutting and pasting of subtrees
6095 (defun org-move-subtree-up (&optional arg)
6096 "Move the current subtree up past ARG headlines of the same level."
6097 (interactive "p")
6098 (org-move-subtree-down (- (prefix-numeric-value arg))))
6100 (defun org-move-subtree-down (&optional arg)
6101 "Move the current subtree down past ARG headlines of the same level."
6102 (interactive "p")
6103 (setq arg (prefix-numeric-value arg))
6104 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6105 'outline-get-last-sibling))
6106 (ins-point (make-marker))
6107 (cnt (abs arg))
6108 beg end txt folded)
6109 ;; Select the tree
6110 (org-back-to-heading)
6111 (setq beg (point))
6112 (save-match-data
6113 (save-excursion (outline-end-of-heading)
6114 (setq folded (org-invisible-p)))
6115 (outline-end-of-subtree))
6116 (outline-next-heading)
6117 (setq end (point))
6118 ;; Find insertion point, with error handling
6119 (goto-char beg)
6120 (while (> cnt 0)
6121 (or (and (funcall movfunc) (looking-at outline-regexp))
6122 (progn (goto-char beg)
6123 (error "Cannot move past superior level or buffer limit")))
6124 (setq cnt (1- cnt)))
6125 (if (> arg 0)
6126 ;; Moving forward - still need to move over subtree
6127 (progn (outline-end-of-subtree)
6128 (outline-next-heading)
6129 (if (not (or (looking-at (concat "^" outline-regexp))
6130 (bolp)))
6131 (newline))))
6132 (move-marker ins-point (point))
6133 (setq txt (buffer-substring beg end))
6134 (delete-region beg end)
6135 (insert txt)
6137 (goto-char ins-point)
6138 (if folded (hide-subtree))
6139 (move-marker ins-point nil)))
6141 (defvar org-subtree-clip ""
6142 "Clipboard for cut and paste of subtrees.
6143 This is actually only a copy of the kill, because we use the normal kill
6144 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6146 (defvar org-subtree-clip-folded nil
6147 "Was the last copied subtree folded?
6148 This is used to fold the tree back after pasting.")
6150 (defun org-cut-subtree (&optional n)
6151 "Cut the current subtree into the clipboard.
6152 With prefix arg N, cut this many sequential subtrees.
6153 This is a short-hand for marking the subtree and then cutting it."
6154 (interactive "p")
6155 (org-copy-subtree n 'cut))
6157 (defun org-copy-subtree (&optional n cut)
6158 "Cut the current subtree into the clipboard.
6159 With prefix arg N, cut this many sequential subtrees.
6160 This is a short-hand for marking the subtree and then copying it.
6161 If CUT is non-nil, actually cut the subtree."
6162 (interactive "p")
6163 (let (beg end folded)
6164 (if (interactive-p)
6165 (org-back-to-heading nil) ; take what looks like a subtree
6166 (org-back-to-heading t)) ; take what is really there
6167 (setq beg (point))
6168 (save-match-data
6169 (save-excursion (outline-end-of-heading)
6170 (setq folded (org-invisible-p)))
6171 (condition-case nil
6172 (outline-forward-same-level (1- n))
6173 (error nil))
6174 (org-end-of-subtree t t))
6175 (setq end (point))
6176 (goto-char beg)
6177 (when (> end beg)
6178 (setq org-subtree-clip-folded folded)
6179 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6180 (setq org-subtree-clip (current-kill 0))
6181 (message "%s: Subtree(s) with %d characters"
6182 (if cut "Cut" "Copied")
6183 (length org-subtree-clip)))))
6185 (defun org-paste-subtree (&optional level tree)
6186 "Paste the clipboard as a subtree, with modification of headline level.
6187 The entire subtree is promoted or demoted in order to match a new headline
6188 level. By default, the new level is derived from the visible headings
6189 before and after the insertion point, and taken to be the inferior headline
6190 level of the two. So if the previous visible heading is level 3 and the
6191 next is level 4 (or vice versa), level 4 will be used for insertion.
6192 This makes sure that the subtree remains an independent subtree and does
6193 not swallow low level entries.
6195 You can also force a different level, either by using a numeric prefix
6196 argument, or by inserting the heading marker by hand. For example, if the
6201 If optional TREE is given, use this text instead of the kill ring."
6202 (interactive "P")
6203 (unless (org-kill-is-subtree-p tree)
6204 (error
6205 (substitute-command-keys
6207 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6212 (old-level (if (string-match ^re txt)
6213 (- (match-end 0) (match-beginning 0) 1)
6214 -1))
6215 (force-level (cond (level (prefix-numeric-value level))
6216 ((string-match
6217 ^re_ (buffer-substring (point-at-bol) (point)))
6218 (- (match-end 1) (match-beginning 1)))
6219 (t nil)))
6220 (previous-level (save-excursion
6221 (condition-case nil
6222 (progn
6223 (outline-previous-visible-heading 1)
6224 (if (looking-at re)
6225 (- (match-end 0) (match-beginning 0) 1)
6226 1))
6227 (error 1))))
6228 (next-level (save-excursion
6229 (condition-case nil
6230 (progn
6231 (or (looking-at outline-regexp)
6232 (outline-next-visible-heading 1))
6233 (if (looking-at re)
6234 (- (match-end 0) (match-beginning 0) 1)
6235 1))
6236 (error 1))))
6237 (new-level (or force-level (max previous-level next-level)))
6238 (shift (if (or (= old-level -1)
6239 (= new-level -1)
6240 (= old-level new-level))
6241 0
6242 (- new-level old-level)))
6243 (delta (if (> shift 0) -1 1))
6244 (func (if (> shift 0) 'org-demote 'org-promote))
6245 (org-odd-levels-only nil)
6246 beg end)
6247 ;; Remove the forced level indicator
6248 (if force-level
6249 (delete-region (point-at-bol) (point)))
6250 ;; Paste
6251 (beginning-of-line 1)
6252 (setq beg (point))
6253 (insert txt)
6255 (setq end (point))
6256 (goto-char beg)
6257 ;; Shift if necessary
6258 (unless (= shift 0)
6259 (save-restriction
6260 (narrow-to-region beg end)
6261 (while (not (= shift 0))
6262 (org-map-region func (point-min) (point-max))
6263 (setq shift (+ delta shift)))
6264 (goto-char (point-min))))
6265 (when (interactive-p)
6266 (message "Clipboard pasted as level %d subtree" new-level))
6267 (if (and kill-ring
6268 (eq org-subtree-clip (current-kill 0))
6269 org-subtree-clip-folded)
6270 ;; The tree was folded before it was killed/copied
6271 (hide-subtree))))
6273 (defun org-kill-is-subtree-p (&optional txt)
6274 "Check if the current kill is an outline subtree, or a set of trees.
6275 Returns nil if kill does not start with a headline, or if the first
6276 headline level is not the largest headline level in the tree.
6277 So this will actually accept several entries of equal levels as well,
6278 which is OK for `org-paste-subtree'.
6279 If optional TXT is given, check this string instead of the current kill."
6280 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6281 (start-level (and kill
6283 (- (match-end 0) (match-beginning 0) 1)))
6284 (re (concat "^" org-outline-regexp))
6285 (start 1))
6286 (if (not start-level)
6287 (progn
6288 nil) ;; does not even start with a heading
6289 (catch 'exit
6290 (while (setq start (string-match re kill (1+ start)))
6291 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6292 (throw 'exit nil)))
6293 t))))
6295 (defun org-narrow-to-subtree ()
6296 "Narrow buffer to the current subtree."
6297 (interactive)
6298 (save-excursion
6299 (narrow-to-region
6300 (progn (org-back-to-heading) (point))
6301 (progn (org-end-of-subtree t t) (point)))))
6304 ;;; Outline Sorting
6306 (defun org-sort (with-case)
6307 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6308 Optional argument WITH-CASE means sort case-sensitively."
6309 (interactive "P")
6310 (if (org-at-table-p)
6311 (org-call-with-arg 'org-table-sort-lines with-case)
6312 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6314 (defvar org-priority-regexp) ; defined later in the file
6316 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6317 "Sort entries on a certain level of an outline tree.
6318 If there is an active region, the entries in the region are sorted.
6319 Else, if the cursor is before the first entry, sort the top-level items.
6320 Else, the children of the entry at point are sorted.
6322 Sorting can be alphabetically, numerically, and by date/time as given by
6323 the first time stamp in the entry. The command prompts for the sorting
6324 type unless it has been given to the function through the SORTING-TYPE
6325 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6326 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6327 called with point at the beginning of the record. It must return either
6328 a string or a number that should serve as the sorting key for that record.
6330 Comparing entries ignores case by default. However, with an optional argument
6331 WITH-CASE, the sorting considers case as well."
6332 (interactive "P")
6333 (let ((case-func (if with-case 'identity 'downcase))
6334 start beg end stars re re2
6335 txt what tmp plain-list-p)
6336 ;; Find beginning and end of region to sort
6337 (cond
6338 ((org-region-active-p)
6339 ;; we will sort the region
6340 (setq end (region-end)
6341 what "region")
6342 (goto-char (region-beginning))
6343 (if (not (org-on-heading-p)) (outline-next-heading))
6344 (setq start (point)))
6345 ((org-at-item-p)
6346 ;; we will sort this plain list
6347 (org-beginning-of-item-list) (setq start (point))
6348 (org-end-of-item-list) (setq end (point))
6349 (goto-char start)
6350 (setq plain-list-p t
6351 what "plain list"))
6352 ((or (org-on-heading-p)
6353 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6354 ;; we will sort the children of the current headline
6355 (org-back-to-heading)
6356 (setq start (point) end (org-end-of-subtree) what "children")
6357 (goto-char start)
6358 (show-subtree)
6359 (outline-next-heading))
6360 (t
6361 ;; we will sort the top-level entries in this file
6362 (goto-char (point-min))
6363 (or (org-on-heading-p) (outline-next-heading))
6364 (setq start (point) end (point-max) what "top-level")
6365 (goto-char start)
6366 (show-all)))
6368 (setq beg (point))
6369 (if (>= beg end) (error "Nothing to sort"))
6371 (unless plain-list-p
6373 (setq stars (match-string 1)
6374 re (concat "^" (regexp-quote stars) " +")
6375 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6376 txt (buffer-substring beg end))
6378 (if (and (not (equal stars "*")) (string-match re2 txt))
6379 (error "Region to sort contains a level above the first entry")))
6381 (unless sorting-type
6382 (message
6383 (if plain-list-p
6384 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6385 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6386 what)
6387 (setq sorting-type (read-char-exclusive))
6389 (and (= (downcase sorting-type) ?f)
6390 (setq getkey-func
6391 (completing-read "Sort using function: "
6392 obarray 'fboundp t nil nil))
6393 (setq getkey-func (intern getkey-func)))
6395 (and (= (downcase sorting-type) ?r)
6396 (setq property
6397 (completing-read "Property: "
6398 (mapcar 'list (org-buffer-property-keys t))
6399 nil t))))
6401 (message "Sorting entries...")
6403 (save-restriction
6404 (narrow-to-region start end)
6406 (let ((dcst (downcase sorting-type))
6407 (now (current-time)))
6408 (sort-subr
6409 (/= dcst sorting-type)
6410 ;; This function moves to the beginning character of the "record" to
6411 ;; be sorted.
6412 (if plain-list-p
6413 (lambda nil
6414 (if (org-at-item-p) t (goto-char (point-max))))
6415 (lambda nil
6416 (if (re-search-forward re nil t)
6417 (goto-char (match-beginning 0))
6418 (goto-char (point-max)))))
6419 ;; This function moves to the last character of the "record" being
6420 ;; sorted.
6421 (if plain-list-p
6422 'org-end-of-item
6423 (lambda nil
6424 (save-match-data
6425 (condition-case nil
6426 (outline-forward-same-level 1)
6427 (error
6428 (goto-char (point-max)))))))
6430 ;; This function returns the value that gets sorted against.
6431 (if plain-list-p
6432 (lambda nil
6434 (cond
6435 ((= dcst ?n)
6436 (string-to-number (buffer-substring (match-end 0)
6437 (point-at-eol))))
6438 ((= dcst ?a)
6439 (buffer-substring (match-end 0) (point-at-eol)))
6440 ((= dcst ?t)
6441 (if (re-search-forward org-ts-regexp
6442 (point-at-eol) t)
6443 (org-time-string-to-time (match-string 0))
6444 now))
6445 ((= dcst ?f)
6446 (if getkey-func
6447 (progn
6448 (setq tmp (funcall getkey-func))
6449 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6450 tmp)
6451 (error "Invalid key function `%s'" getkey-func)))
6452 (t (error "Invalid sorting type `%c'" sorting-type)))))
6453 (lambda nil
6454 (cond
6455 ((= dcst ?n)
6456 (if (looking-at outline-regexp)
6457 (string-to-number (buffer-substring (match-end 0)
6458 (point-at-eol)))
6459 nil))
6460 ((= dcst ?a)
6461 (funcall case-func (buffer-substring (point-at-bol)
6462 (point-at-eol))))
6463 ((= dcst ?t)
6464 (if (re-search-forward org-ts-regexp
6465 (save-excursion
6466 (forward-line 2)
6467 (point)) t)
6468 (org-time-string-to-time (match-string 0))
6469 now))
6470 ((= dcst ?p)
6471 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6472 (string-to-char (match-string 2))
6473 org-default-priority))
6474 ((= dcst ?r)
6475 (or (org-entry-get nil property) ""))
6476 ((= dcst ?f)
6477 (if getkey-func
6478 (progn
6479 (setq tmp (funcall getkey-func))
6480 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6481 tmp)
6482 (error "Invalid key function `%s'" getkey-func)))
6483 (t (error "Invalid sorting type `%c'" sorting-type)))))
6484 nil
6485 (cond
6486 ((= dcst ?a) 'string<)
6487 ((= dcst ?t) 'time-less-p)
6488 (t nil)))))
6489 (message "Sorting entries...done")))
6491 (defun org-do-sort (table what &optional with-case sorting-type)
6492 "Sort TABLE of WHAT according to SORTING-TYPE.
6493 The user will be prompted for the SORTING-TYPE if the call to this
6494 function does not specify it. WHAT is only for the prompt, to indicate
6495 what is being sorted. The sorting key will be extracted from
6496 the car of the elements of the table.
6497 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6498 (unless sorting-type
6499 (message
6500 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6501 what)
6502 (setq sorting-type (read-char-exclusive)))
6503 (let ((dcst (downcase sorting-type))
6504 extractfun comparefun)
6505 ;; Define the appropriate functions
6506 (cond
6507 ((= dcst ?n)
6508 (setq extractfun 'string-to-number
6509 comparefun (if (= dcst sorting-type) '< '>)))
6510 ((= dcst ?a)
6511 (setq extractfun (if with-case 'identity 'downcase)
6512 comparefun (if (= dcst sorting-type)
6513 'string<
6514 (lambda (a b) (and (not (string< a b))
6515 (not (string= a b)))))))
6516 ((= dcst ?t)
6517 (setq extractfun
6518 (lambda (x)
6519 (if (string-match org-ts-regexp x)
6520 (time-to-seconds
6521 (org-time-string-to-time (match-string 0 x)))
6522 0))
6523 comparefun (if (= dcst sorting-type) '< '>)))
6524 (t (error "Invalid sorting type `%c'" sorting-type)))
6526 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6527 table)
6528 (lambda (a b) (funcall comparefun (car a) (car b))))))
6530 ;;;; Plain list items, including checkboxes
6532 ;;; Plain list items
6534 (defun org-at-item-p ()
6535 "Is point in a line starting a hand-formatted item?"
6536 (let ((llt org-plain-list-ordered-item-terminator))
6537 (save-excursion
6538 (goto-char (point-at-bol))
6539 (looking-at
6540 (cond
6544 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6546 (defun org-in-item-p ()
6547 "It the cursor inside a plain list item.
6548 Does not have to be the first line."
6549 (save-excursion
6550 (condition-case nil
6551 (progn
6552 (org-beginning-of-item)
6553 (org-at-item-p)
6554 t)
6555 (error nil))))
6557 (defun org-insert-item (&optional checkbox)
6558 "Insert a new item at the current level.
6559 Return t when things worked, nil when we are not in an item."
6560 (when (save-excursion
6561 (condition-case nil
6562 (progn
6563 (org-beginning-of-item)
6564 (org-at-item-p)
6565 (if (org-invisible-p) (error "Invisible item"))
6566 t)
6567 (error nil)))
6568 (let* ((bul (match-string 0))
6570 (match-end 0)))
6571 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6572 pos)
6573 (cond
6574 ((and (org-at-item-p) (<= (point) eow))
6575 ;; before the bullet
6576 (beginning-of-line 1)
6577 (open-line (if blank 2 1)))
6578 ((<= (point) eow)
6579 (beginning-of-line 1))
6580 (t (newline (if blank 2 1))))
6581 (insert bul (if checkbox "[ ]" ""))
6582 (just-one-space)
6583 (setq pos (point))
6584 (end-of-line 1)
6585 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6586 (org-maybe-renumber-ordered-list)
6587 (and checkbox (org-update-checkbox-count-maybe))
6588 t))
6590 ;;; Checkboxes
6592 (defun org-at-item-checkbox-p ()
6593 "Is point at a line starting a plain-list item with a checklet?"
6594 (and (org-at-item-p)
6595 (save-excursion
6596 (goto-char (match-end 0))
6600 (defun org-toggle-checkbox (&optional arg)
6601 "Toggle the checkbox in the current line."
6602 (interactive "P")
6603 (catch 'exit
6604 (let (beg end status (firstnew 'unknown))
6605 (cond
6606 ((org-region-active-p)
6607 (setq beg (region-beginning) end (region-end)))
6608 ((org-on-heading-p)
6609 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6610 ((org-at-item-checkbox-p)
6611 (let ((pos (point)))
6612 (replace-match
6613 (cond (arg "[-]")
6614 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6615 (t "[ ]"))
6616 t t)
6617 (goto-char pos))
6618 (throw 'exit t))
6619 (t (error "Not at a checkbox or heading, and no active region")))
6620 (save-excursion
6621 (goto-char beg)
6622 (while (< (point) end)
6623 (when (org-at-item-checkbox-p)
6624 (setq status (equal (match-string 0) "[X]"))
6625 (when (eq firstnew 'unknown)
6626 (setq firstnew (not status)))
6627 (replace-match
6628 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6629 (beginning-of-line 2)))))
6630 (org-update-checkbox-count-maybe))
6632 (defun org-update-checkbox-count-maybe ()
6633 "Update checkbox statistics unless turned off by user."
6634 (when org-provide-checkbox-statistics
6635 (org-update-checkbox-count)))
6637 (defun org-update-checkbox-count (&optional all)
6638 "Update the checkbox statistics in the current section.
6639 This will find all statistic cookies like [57%] and [6/12] and update them
6640 with the current numbers. With optional prefix argument ALL, do this for
6641 the whole buffer."
6642 (interactive "P")
6643 (save-excursion
6644 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
6645 (beg (condition-case nil
6646 (progn (outline-back-to-heading) (point))
6647 (error (point-min))))
6648 (end (move-marker (make-marker)
6649 (progn (outline-next-heading) (point))))
6652 b1 e1 f1 c-on c-off lim (cstat 0))
6653 (when all
6654 (goto-char (point-min))
6655 (outline-next-heading)
6656 (setq beg (point) end (point-max)))
6657 (goto-char beg)
6658 (while (re-search-forward re end t)
6659 (setq cstat (1+ cstat)
6660 b1 (match-beginning 0)
6661 e1 (match-end 0)
6662 f1 (match-beginning 1)
6663 lim (cond
6664 ((org-on-heading-p) (outline-next-heading) (point))
6665 ((org-at-item-p) (org-end-of-item) (point))
6666 (t nil))
6667 c-on 0 c-off 0)
6668 (goto-char e1)
6669 (when lim
6670 (while (re-search-forward re-box lim t)
6671 (if (member (match-string 2) '("[ ]" "[-]"))
6672 (setq c-off (1+ c-off))
6673 (setq c-on (1+ c-on))))
6674 ; (delete-region b1 e1)
6675 (goto-char b1)
6676 (insert (if f1
6677 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
6678 (format "[%d/%d]" c-on (+ c-on c-off))))
6680 (replace-match ""))))
6681 (when (interactive-p)
6682 (message "Checkbox satistics updated %s (%d places)"
6683 (if all "in entire file" "in current outline entry") cstat)))))
6685 (defun org-get-checkbox-statistics-face ()
6686 "Select the face for checkbox statistics.
6687 The face will be `org-done' when all relevant boxes are checked. Otherwise
6688 it will be `org-todo'."
6689 (if (match-end 1)
6690 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
6691 (if (and (> (match-end 2) (match-beginning 2))
6692 (equal (match-string 2) (match-string 3)))
6693 'org-done
6694 'org-todo)))
6696 (defun org-get-indentation (&optional line)
6697 "Get the indentation of the current line, interpreting tabs.
6698 When LINE is given, assume it represents a line and compute its indentation."
6699 (if line
6700 (if (string-match "^ *" (org-remove-tabs line))
6701 (match-end 0))
6702 (save-excursion
6703 (beginning-of-line 1)
6705 (current-column))))
6707 (defun org-remove-tabs (s &optional width)
6708 "Replace tabulators in S with spaces.
6709 Assumes that s is a single line, starting in column 0."
6710 (setq width (or width tab-width))
6712 (setq s (replace-match
6713 (make-string
6714 (- (* width (/ (+ (match-beginning 0) width) width))
6715 (match-beginning 0)) ?\ )
6716 t t s)))
6717 s)
6719 (defun org-fix-indentation (line ind)
6720 "Fix indentation in LINE.
6721 IND is a cons cell with target and minimum indentation.
6722 If the current indenation in LINE is smaller than the minimum,
6723 leave it alone. If it is larger than ind, set it to the target."
6724 (let* ((l (org-remove-tabs line))
6725 (i (org-get-indentation l))
6726 (i1 (car ind)) (i2 (cdr ind)))
6727 (if (>= i i2) (setq l (substring line i2)))
6728 (if (> i1 0)
6729 (concat (make-string i1 ?\ ) l)
6730 l)))
6732 (defcustom org-empty-line-terminates-plain-lists nil
6733 "Non-nil means, an empty line ends all plain list levels.
6734 When nil, empty lines are part of the preceeding item."
6735 :group 'org-plain-lists
6736 :type 'boolean)
6738 (defun org-beginning-of-item ()
6739 "Go to the beginning of the current hand-formatted item.
6740 If the cursor is not in an item, throw an error."
6741 (interactive)
6742 (let ((pos (point))
6743 (limit (save-excursion
6744 (condition-case nil
6745 (progn
6746 (org-back-to-heading)
6747 (beginning-of-line 2) (point))
6748 (error (point-min)))))
6749 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
6750 ind ind1)
6751 (if (org-at-item-p)
6752 (beginning-of-line 1)
6753 (beginning-of-line 1)
6755 (setq ind (current-column))
6756 (if (catch 'exit
6757 (while t
6758 (beginning-of-line 0)
6759 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
6762 (setq ind1 ind-empty)
6764 (setq ind1 (current-column)))
6765 (if (< ind1 ind)
6766 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
6767 nil
6768 (goto-char pos)
6769 (error "Not in an item")))))
6771 (defun org-end-of-item ()
6772 "Go to the end of the current hand-formatted item.
6773 If the cursor is not in an item, throw an error."
6774 (interactive)
6775 (let* ((pos (point))
6776 ind1
6777 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
6778 (limit (save-excursion (outline-next-heading) (point)))
6779 (ind (save-excursion
6780 (org-beginning-of-item)
6782 (current-column)))
6783 (end (catch 'exit
6784 (while t
6785 (beginning-of-line 2)
6786 (if (eobp) (throw 'exit (point)))
6787 (if (>= (point) limit) (throw 'exit (point-at-bol)))
6789 (setq ind1 ind-empty)
6791 (setq ind1 (current-column)))
6792 (if (<= ind1 ind)
6793 (throw 'exit (point-at-bol)))))))
6794 (if end
6795 (goto-char end)
6796 (goto-char pos)
6797 (error "Not in an item"))))
6799 (defun org-next-item ()
6800 "Move to the beginning of the next item in the current plain list.
6801 Error if not at a plain list, or if this is the last item in the list."
6802 (interactive)
6803 (let (ind ind1 (pos (point)))
6804 (org-beginning-of-item)
6805 (setq ind (org-get-indentation))
6806 (org-end-of-item)
6807 (setq ind1 (org-get-indentation))
6808 (unless (and (org-at-item-p) (= ind ind1))
6809 (goto-char pos)
6810 (error "On last item"))))
6812 (defun org-previous-item ()
6813 "Move to the beginning of the previous item in the current plain list.
6814 Error if not at a plain list, or if this is the first item in the list."
6815 (interactive)
6816 (let (beg ind ind1 (pos (point)))
6817 (org-beginning-of-item)
6818 (setq beg (point))
6819 (setq ind (org-get-indentation))
6820 (goto-char beg)
6821 (catch 'exit
6822 (while t
6823 (beginning-of-line 0)
6825 nil
6826 (if (<= (setq ind1 (org-get-indentation)) ind)
6827 (throw 'exit t)))))
6828 (condition-case nil
6829 (if (or (not (org-at-item-p))
6830 (< ind1 (1- ind)))
6831 (error "")
6832 (org-beginning-of-item))
6833 (error (goto-char pos)
6834 (error "On first item")))))
6836 (defun org-move-item-down ()
6837 "Move the plain list item at point down, i.e. swap with following item.
6838 Subitems (items with larger indentation) are considered part of the item,
6839 so this really moves item trees."
6840 (interactive)
6841 (let (beg end ind ind1 (pos (point)) txt)
6842 (org-beginning-of-item)
6843 (setq beg (point))
6844 (setq ind (org-get-indentation))
6845 (org-end-of-item)
6846 (setq end (point))
6847 (setq ind1 (org-get-indentation))
6848 (if (and (org-at-item-p) (= ind ind1))
6849 (progn
6850 (org-end-of-item)
6851 (setq txt (buffer-substring beg end))
6852 (save-excursion
6853 (delete-region beg end))
6854 (setq pos (point))
6855 (insert txt)
6856 (goto-char pos)
6857 (org-maybe-renumber-ordered-list))
6858 (goto-char pos)
6859 (error "Cannot move this item further down"))))
6861 (defun org-move-item-up (arg)
6862 "Move the plain list item at point up, i.e. swap with previous item.
6863 Subitems (items with larger indentation) are considered part of the item,
6864 so this really moves item trees."
6865 (interactive "p")
6866 (let (beg end ind ind1 (pos (point)) txt)
6867 (org-beginning-of-item)
6868 (setq beg (point))
6869 (setq ind (org-get-indentation))
6870 (org-end-of-item)
6871 (setq end (point))
6872 (goto-char beg)
6873 (catch 'exit
6874 (while t
6875 (beginning-of-line 0)
6877 (if org-empty-line-terminates-plain-lists
6878 (progn
6879 (goto-char pos)
6880 (error "Cannot move this item further up"))
6881 nil)
6882 (if (<= (setq ind1 (org-get-indentation)) ind)
6883 (throw 'exit t)))))
6884 (condition-case nil
6885 (org-beginning-of-item)
6886 (error (goto-char beg)
6887 (error "Cannot move this item further up")))
6888 (setq ind1 (org-get-indentation))
6889 (if (and (org-at-item-p) (= ind ind1))
6890 (progn
6891 (setq txt (buffer-substring beg end))
6892 (save-excursion
6893 (delete-region beg end))
6894 (setq pos (point))
6895 (insert txt)
6896 (goto-char pos)
6897 (org-maybe-renumber-ordered-list))
6898 (goto-char pos)
6899 (error "Cannot move this item further up"))))
6901 (defun org-maybe-renumber-ordered-list ()
6902 "Renumber the ordered list at point if setup allows it.
6903 This tests the user option `org-auto-renumber-ordered-lists' before
6904 doing the renumbering."
6905 (interactive)
6906 (when (and org-auto-renumber-ordered-lists
6907 (org-at-item-p))
6908 (if (match-beginning 3)
6909 (org-renumber-ordered-list 1)
6910 (org-fix-bullet-type))))
6912 (defun org-maybe-renumber-ordered-list-safe ()
6913 (condition-case nil
6914 (save-excursion
6915 (org-maybe-renumber-ordered-list))
6916 (error nil)))
6918 (defun org-cycle-list-bullet (&optional which)
6919 "Cycle through the different itemize/enumerate bullets.
6920 This cycle the entire list level through the sequence:
6922 `-' -> `+' -> `*' -> `1.' -> `1)'
6924 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
6925 0 meand `-', 1 means `+' etc."
6926 (interactive "P")
6927 (org-preserve-lc
6928 (org-beginning-of-item-list)
6929 (org-at-item-p)
6930 (beginning-of-line 1)
6931 (let ((current (match-string 0))
6932 (prevp (eq which 'previous))
6933 new)
6934 (setq new (cond
6935 ((and (numberp which)
6936 (nth (1- which) '("-" "+" "*" "1." "1)"))))
6937 ((string-match "-" current) (if prevp "1)" "+"))
6942 ((string-match ")" current) (if prevp "1." "-"))
6943 (t (error "This should not happen"))))
6945 (org-fix-bullet-type)
6946 (org-maybe-renumber-ordered-list))))
6948 (defun org-get-string-indentation (s)
6949 "What indentation has S due to SPACE and TAB at the beginning of the string?"
6950 (let ((n -1) (i 0) (w tab-width) c)
6951 (catch 'exit
6952 (while (< (setq n (1+ n)) (length s))
6953 (setq c (aref s n))
6954 (cond ((= c ?\ ) (setq i (1+ i)))
6956 (t (throw 'exit t)))))
6957 i))
6959 (defun org-renumber-ordered-list (arg)
6960 "Renumber an ordered plain list.
6961 Cursor needs to be in the first line of an item, the line that starts
6963 (interactive "p")
6964 (unless (and (org-at-item-p)
6965 (match-beginning 3))
6966 (error "This is not an ordered list"))
6967 (let ((line (org-current-line))
6968 (col (current-column))
6969 (ind (org-get-string-indentation
6970 (buffer-substring (point-at-bol) (match-beginning 3))))
6971 ;; (term (substring (match-string 3) -1))
6972 ind1 (n (1- arg))
6973 fmt)
6974 ;; find where this list begins
6975 (org-beginning-of-item-list)
6977 (setq fmt (concat "%d" (match-string 1)))
6978 (beginning-of-line 0)
6979 ;; walk forward and replace these numbers
6980 (catch 'exit
6981 (while t
6982 (catch 'next
6983 (beginning-of-line 2)
6984 (if (eobp) (throw 'exit nil))
6987 (if (> ind1 ind) (throw 'next t))
6988 (if (< ind1 ind) (throw 'exit t))
6989 (if (not (org-at-item-p)) (throw 'exit nil))
6990 (delete-region (match-beginning 2) (match-end 2))
6991 (goto-char (match-beginning 2))
6992 (insert (format fmt (setq n (1+ n)))))))
6993 (goto-line line)
6994 (move-to-column col)))
6996 (defun org-fix-bullet-type ()
6997 "Make sure all items in this list have the same bullet as the firsst item."
6998 (interactive)
6999 (unless (org-at-item-p) (error "This is not a list"))
7000 (let ((line (org-current-line))
7001 (col (current-column))
7002 (ind (current-indentation))
7003 ind1 bullet)
7004 ;; find where this list begins
7005 (org-beginning-of-item-list)
7006 (beginning-of-line 1)
7007 ;; find out what the bullet type is
7009 (setq bullet (match-string 1))
7010 ;; walk forward and replace these numbers
7011 (beginning-of-line 0)
7012 (catch 'exit
7013 (while t
7014 (catch 'next
7015 (beginning-of-line 2)
7016 (if (eobp) (throw 'exit nil))
7019 (if (> ind1 ind) (throw 'next t))
7020 (if (< ind1 ind) (throw 'exit t))
7021 (if (not (org-at-item-p)) (throw 'exit nil))
7024 (replace-match bullet))))
7025 (goto-line line)
7026 (move-to-column col)
7027 (if (string-match "[0-9]" bullet)
7028 (org-renumber-ordered-list 1))))
7030 (defun org-beginning-of-item-list ()
7031 "Go to the beginning of the current item list.
7032 I.e. to the first item in this list."
7033 (interactive)
7034 (org-beginning-of-item)
7035 (let ((pos (point-at-bol))
7036 (ind (org-get-indentation))
7037 ind1)
7038 ;; find where this list begins
7039 (catch 'exit
7040 (while t
7041 (catch 'next
7042 (beginning-of-line 0)
7044 (throw (if (bobp) 'exit 'next) t))
7046 (if (or (< ind1 ind)
7047 (and (= ind1 ind)
7048 (not (org-at-item-p)))
7049 (bobp))
7050 (throw 'exit t)
7051 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7052 (goto-char pos)))
7055 (defun org-end-of-item-list ()
7056 "Go to the end of the current item list.
7057 I.e. to the text after the last item."
7058 (interactive)
7059 (org-beginning-of-item)
7060 (let ((pos (point-at-bol))
7061 (ind (org-get-indentation))
7062 ind1)
7063 ;; find where this list begins
7064 (catch 'exit
7065 (while t
7066 (catch 'next
7067 (beginning-of-line 2)
7069 (throw (if (eobp) 'exit 'next) t))
7071 (if (or (< ind1 ind)
7072 (and (= ind1 ind)
7073 (not (org-at-item-p)))
7074 (eobp))
7075 (progn
7076 (setq pos (point-at-bol))
7077 (throw 'exit t))))))
7078 (goto-char pos)))
7081 (defvar org-last-indent-begin-marker (make-marker))
7082 (defvar org-last-indent-end-marker (make-marker))
7084 (defun org-outdent-item (arg)
7085 "Outdent a local list item."
7086 (interactive "p")
7087 (org-indent-item (- arg)))
7089 (defun org-indent-item (arg)
7090 "Indent a local list item."
7091 (interactive "p")
7092 (unless (org-at-item-p)
7093 (error "Not on an item"))
7094 (save-excursion
7095 (let (beg end ind ind1 tmp delta ind-down ind-up)
7096 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7097 (setq beg org-last-indent-begin-marker
7098 end org-last-indent-end-marker)
7099 (org-beginning-of-item)
7100 (setq beg (move-marker org-last-indent-begin-marker (point)))
7101 (org-end-of-item)
7102 (setq end (move-marker org-last-indent-end-marker (point))))
7103 (goto-char beg)
7104 (setq tmp (org-item-indent-positions)
7105 ind (car tmp)
7106 ind-down (nth 2 tmp)
7107 ind-up (nth 1 tmp)
7108 delta (if (> arg 0)
7109 (if ind-down (- ind-down ind) 2)
7110 (if ind-up (- ind-up ind) -2)))
7111 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7112 (while (< (point) end)
7113 (beginning-of-line 1)
7115 (delete-region (point-at-bol) (point))
7116 (or (eolp) (indent-to-column (+ ind1 delta)))
7117 (beginning-of-line 2))))
7118 (org-fix-bullet-type)
7119 (org-maybe-renumber-ordered-list-safe)
7120 (save-excursion
7121 (beginning-of-line 0)
7122 (condition-case nil (org-beginning-of-item) (error nil))
7123 (org-maybe-renumber-ordered-list-safe)))
7125 (defun org-item-indent-positions ()
7126 "Return indentation for plain list items.
7127 This returns a list with three values: The current indentation, the
7128 parent indentation and the indentation a child should habe.
7129 Assumes cursor in item line."
7130 (let* ((bolpos (point-at-bol))
7131 (ind (org-get-indentation))
7132 ind-down ind-up pos)
7133 (save-excursion
7134 (org-beginning-of-item-list)
7136 (when (org-in-item-p)
7137 (org-beginning-of-item)
7138 (setq ind-up (org-get-indentation))))
7139 (setq pos (point))
7140 (save-excursion
7141 (cond
7142 ((and (condition-case nil (progn (org-previous-item) t)
7143 (error nil))
7144 (or (forward-char 1) t)
7145 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7146 (setq ind-down (org-get-indentation)))
7147 ((and (goto-char pos)
7148 (org-at-item-p))
7149 (goto-char (match-end 0))
7151 (setq ind-down (current-column)))))
7152 (list ind ind-up ind-down)))
7154 ;;; The orgstruct minor mode
7156 ;; Define a minor mode which can be used in other modes in order to
7157 ;; integrate the org-mode structure editing commands.
7159 ;; This is really a hack, because the org-mode structure commands use
7160 ;; keys which normally belong to the major mode. Here is how it
7161 ;; works: The minor mode defines all the keys necessary to operate the
7162 ;; structure commands, but wraps the commands into a function which
7163 ;; tests if the cursor is currently at a headline or a plain list
7164 ;; item. If that is the case, the structure command is used,
7165 ;; temporarily setting many Org-mode variables like regular
7166 ;; expressions for filling etc. However, when any of those keys is
7167 ;; used at a different location, function uses `key-binding' to look
7168 ;; up if the key has an associated command in another currently active
7169 ;; keymap (minor modes, major mode, global), and executes that
7170 ;; command. There might be problems if any of the keys is otherwise
7171 ;; used as a prefix key.
7173 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7174 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7175 ;; addresses this by checking explicitly for both bindings.
7177 (defvar orgstruct-mode-map (make-sparse-keymap)
7178 "Keymap for the minor `orgstruct-mode'.")
7180 (defvar org-local-vars nil
7181 "List of local variables, for use by `orgstruct-mode'")
7183 ;;;###autoload
7184 (define-minor-mode orgstruct-mode
7185 "Toggle the minor more `orgstruct-mode'.
7186 This mode is for using Org-mode structure commands in other modes.
7187 The following key behave as if Org-mode was active, if the cursor
7188 is on a headline, or on a plain list item (both in the definition
7189 of Org-mode).
7191 M-up Move entry/item up
7192 M-down Move entry/item down
7193 M-left Promote
7194 M-right Demote
7195 M-S-up Move entry/item up
7196 M-S-down Move entry/item down
7197 M-S-left Promote subtree
7198 M-S-right Demote subtree
7199 M-q Fill paragraph and items like in Org-mode
7200 C-c ^ Sort entries
7201 C-c - Cycle list bullet
7202 TAB Cycle item visibility
7203 M-RET Insert new heading/item
7204 S-M-RET Insert new TODO heading / Chekbox item
7205 C-c C-c Set tags / toggle checkbox"
7206 nil " OrgStruct" nil
7207 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7209 ;;;###autoload
7210 (defun turn-on-orgstruct ()
7211 "Unconditionally turn on `orgstruct-mode'."
7212 (orgstruct-mode 1))
7214 ;;;###autoload
7215 (defun turn-on-orgstruct++ ()
7216 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7217 In addition to setting orgstruct-mode, this also exports all indentation and
7218 autofilling variables from org-mode into the buffer. Note that turning
7219 off orgstruct-mode will *not* remove these additonal settings."
7220 (orgstruct-mode 1)
7221 (let (var val)
7222 (mapc
7223 (lambda (x)
7224 (when (string-match
7226 (symbol-name (car x)))
7227 (setq var (car x) val (nth 1 x))
7228 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7229 org-local-vars)))
7231 (defun orgstruct-error ()
7232 "Error when there is no default binding for a structure key."
7233 (interactive)
7234 (error "This key is has no function outside structure elements"))
7236 (defun orgstruct-setup ()
7237 "Setup orgstruct keymaps."
7238 (let ((nfunc 0)
7239 (bindings
7240 (list
7241 '([(meta up)] org-metaup)
7242 '([(meta down)] org-metadown)
7243 '([(meta left)] org-metaleft)
7244 '([(meta right)] org-metaright)
7245 '([(meta shift up)] org-shiftmetaup)
7246 '([(meta shift down)] org-shiftmetadown)
7247 '([(meta shift left)] org-shiftmetaleft)
7248 '([(meta shift right)] org-shiftmetaright)
7249 '([(shift up)] org-shiftup)
7250 '([(shift down)] org-shiftdown)
7251 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7252 '("\M-q" fill-paragraph)
7253 '("\C-c^" org-sort)
7254 '("\C-c-" org-cycle-list-bullet)))
7255 elt key fun cmd)
7256 (while (setq elt (pop bindings))
7257 (setq nfunc (1+ nfunc))
7258 (setq key (org-key (car elt))
7259 fun (nth 1 elt)
7260 cmd (orgstruct-make-binding fun nfunc key))
7261 (org-defkey orgstruct-mode-map key cmd))
7263 ;; Special treatment needed for TAB and RET
7264 (org-defkey orgstruct-mode-map [(tab)]
7265 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7266 (org-defkey orgstruct-mode-map "\C-i"
7267 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7269 (org-defkey orgstruct-mode-map "\M-\C-m"
7270 (orgstruct-make-binding 'org-insert-heading 105
7271 "\M-\C-m" [(meta return)]))
7272 (org-defkey orgstruct-mode-map [(meta return)]
7273 (orgstruct-make-binding 'org-insert-heading 106
7274 [(meta return)] "\M-\C-m"))
7276 (org-defkey orgstruct-mode-map [(shift meta return)]
7277 (orgstruct-make-binding 'org-insert-todo-heading 107
7278 [(meta return)] "\M-\C-m"))
7280 (unless org-local-vars
7281 (setq org-local-vars (org-get-local-variables)))
7283 t))
7285 (defun orgstruct-make-binding (fun n &rest keys)
7286 "Create a function for binding in the structure minor mode.
7287 FUN is the command to call inside a table. N is used to create a unique
7288 command name. KEYS are keys that should be checked in for a command
7289 to execute outside of tables."
7290 (eval
7291 (list 'defun
7292 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7293 '(arg)
7295 "Outside of structure, run the binding of `"
7296 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7297 "'.")
7298 '(interactive "p")
7299 (list 'if
7300 '(org-context-p 'headline 'item)
7301 (list 'org-run-like-in-org-mode (list 'quote fun))
7302 (list 'let '(orgstruct-mode)
7303 (list 'call-interactively
7304 (append '(or)
7305 (mapcar (lambda (k)
7306 (list 'key-binding k))
7307 keys)
7308 '('orgstruct-error))))))))
7310 (defun org-context-p (&rest contexts)
7311 "Check if local context is and of CONTEXTS.
7312 Possible values in the list of contexts are `table', `headline', and `item'."
7313 (let ((pos (point)))
7314 (goto-char (point-at-bol))
7315 (prog1 (or (and (memq 'table contexts)
7317 (and (memq 'headline contexts)
7319 (and (memq 'item contexts)
7321 (goto-char pos))))
7323 (defun org-get-local-variables ()
7324 "Return a list of all local variables in an org-mode buffer."
7325 (let (varlist)
7326 (with-current-buffer (get-buffer-create "*Org tmp*")
7327 (erase-buffer)
7328 (org-mode)
7329 (setq varlist (buffer-local-variables)))
7330 (kill-buffer "*Org tmp*")
7331 (delq nil
7332 (mapcar
7333 (lambda (x)
7334 (setq x
7335 (if (symbolp x)
7336 (list x)
7337 (list (car x) (list 'quote (cdr x)))))
7338 (if (string-match
7339 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7340 (symbol-name (car x)))
7341 x nil))
7342 varlist))))
7344 ;;;###autoload
7345 (defun org-run-like-in-org-mode (cmd)
7346 (unless org-local-vars
7347 (setq org-local-vars (org-get-local-variables)))
7348 (eval (list 'let org-local-vars
7349 (list 'call-interactively (list 'quote cmd)))))
7351 ;;;; Archiving
7353 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7355 (defun org-archive-subtree (&optional find-done)
7356 "Move the current subtree to the archive.
7357 The archive can be a certain top-level heading in the current file, or in
7358 a different file. The tree will be moved to that location, the subtree
7359 heading be marked DONE, and the current time will be added.
7361 When called with prefix argument FIND-DONE, find whole trees without any
7362 open TODO items and archive them (after getting confirmation from the user).
7363 If the cursor is not at a headline when this comand is called, try all level
7364 1 trees. If the cursor is on a headline, only try the direct children of
7365 this heading."
7366 (interactive "P")
7367 (if find-done
7368 (org-archive-all-done)
7369 ;; Save all relevant TODO keyword-relatex variables
7371 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7372 (tr-org-todo-keywords-1 org-todo-keywords-1)
7373 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7374 (tr-org-done-keywords org-done-keywords)
7375 (tr-org-todo-regexp org-todo-regexp)
7376 (tr-org-todo-line-regexp org-todo-line-regexp)
7377 (tr-org-odd-levels-only org-odd-levels-only)
7378 (this-buffer (current-buffer))
7379 (org-archive-location org-archive-location)
7381 ;; start of variables that will be used for saving context
7382 ;; The compiler complains about them - keep them anyway!
7383 (file (abbreviate-file-name (buffer-file-name)))
7384 (time (format-time-string
7385 (substring (cdr org-time-stamp-formats) 1 -1)
7386 (current-time)))
7387 afile heading buffer level newfile-p
7388 category todo priority
7389 ;; start of variables that will be used for savind context
7390 ltags itags prop)
7392 ;; Try to find a local archive location
7393 (save-excursion
7394 (save-restriction
7395 (widen)
7396 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7398 (setq org-archive-location prop)
7399 (if (or (re-search-backward re nil t)
7400 (re-search-forward re nil t))
7401 (setq org-archive-location (match-string 1))))))
7404 (progn
7405 (setq afile (format (match-string 1 org-archive-location)
7406 (file-name-nondirectory buffer-file-name))
7407 heading (match-string 2 org-archive-location)))
7408 (error "Invalid `org-archive-location'"))
7409 (if (> (length afile) 0)
7410 (setq newfile-p (not (file-exists-p afile))
7411 buffer (find-file-noselect afile))
7412 (setq buffer (current-buffer)))
7413 (unless buffer
7415 (if (and (> (length heading) 0)
7417 (setq level (match-end 0))
7418 (setq heading nil level 0))
7419 (save-excursion
7420 (org-back-to-heading t)
7421 ;; Get context information that will be lost by moving the tree
7422 (org-refresh-category-properties)
7423 (setq category (org-get-category)
7424 todo (and (looking-at org-todo-line-regexp)
7425 (match-string 2))
7426 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7427 ltags (org-get-tags)
7428 itags (org-delete-all ltags (org-get-tags-at)))
7429 (setq ltags (mapconcat 'identity ltags " ")
7430 itags (mapconcat 'identity itags " "))
7431 ;; We first only copy, in case something goes wrong
7432 ;; we need to protect this-command, to avoid kill-region sets it,
7433 ;; which would lead to duplication of subtrees
7434 (let (this-command) (org-copy-subtree))
7435 (set-buffer buffer)
7436 ;; Enforce org-mode for the archive buffer
7437 (if (not (org-mode-p))
7438 ;; Force the mode for future visits.
7439 (let ((org-insert-mode-line-in-empty-file t)
7440 (org-inhibit-startup t))
7441 (call-interactively 'org-mode)))
7442 (when newfile-p
7443 (goto-char (point-max))
7445 (buffer-file-name this-buffer))))
7446 ;; Force the TODO keywords of the original buffer
7447 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7448 (org-todo-keywords-1 tr-org-todo-keywords-1)
7449 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7450 (org-done-keywords tr-org-done-keywords)
7451 (org-todo-regexp tr-org-todo-regexp)
7452 (org-todo-line-regexp tr-org-todo-line-regexp)
7453 (org-odd-levels-only
7454 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7455 org-odd-levels-only
7456 tr-org-odd-levels-only)))
7457 (goto-char (point-min))
7458 (if heading
7459 (progn
7460 (if (re-search-forward
7461 (concat "^" (regexp-quote heading)
7463 nil t)
7464 (goto-char (match-end 0))
7465 ;; Heading not found, just insert it at the end
7466 (goto-char (point-max))
7469 (end-of-line 0))
7470 ;; Make the subtree visible
7471 (show-subtree)
7472 (org-end-of-subtree t)
7476 ;; No specific heading, just go to end of file.
7478 ;; Paste
7479 (org-paste-subtree (org-get-legal-level level 1))
7481 ;; Mark the entry as done
7482 (when (and org-archive-mark-done
7483 (looking-at org-todo-line-regexp)
7484 (or (not (match-end 2))
7485 (not (member (match-string 2) org-done-keywords))))
7486 (let (org-log-done)
7487 (org-todo
7488 (car (or (member org-archive-mark-done org-done-keywords)
7489 org-done-keywords)))))
7491 ;; Add the context info
7492 (when org-archive-save-context-info
7493 (let ((l org-archive-save-context-info) e n v)
7494 (while (setq e (pop l))
7495 (when (and (setq v (symbol-value e))
7497 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7498 (org-entry-put (point) n v)))))
7500 ;; Save the buffer, if it is not the same buffer.
7501 (if (not (eq this-buffer buffer)) (save-buffer))))
7502 ;; Here we are back in the original buffer. Everything seems to have
7503 ;; worked. So now cut the tree and finish up.
7504 (let (this-command) (org-cut-subtree))
7506 (message "Subtree archived %s"
7507 (if (eq this-buffer buffer)
7508 (concat "under heading: " heading)
7509 (concat "in file: " (abbreviate-file-name afile)))))))
7511 (defun org-refresh-category-properties ()
7512 "Refresh category text properties in teh buffer."
7513 (let ((def-cat (cond
7514 ((null org-category)
7515 (if buffer-file-name
7516 (file-name-sans-extension
7517 (file-name-nondirectory buffer-file-name))
7518 "???"))
7519 ((symbolp org-category) (symbol-name org-category))
7520 (t org-category)))
7521 beg end cat pos optionp)
7522 (org-unmodified
7523 (save-excursion
7524 (save-restriction
7525 (widen)
7526 (goto-char (point-min))
7527 (put-text-property (point) (point-max) 'org-category def-cat)
7528 (while (re-search-forward
7530 (setq pos (match-end 0)
7531 optionp (equal (char-after (match-beginning 0)) ?#)
7532 cat (org-trim (match-string 2)))
7533 (if optionp
7534 (setq beg (point-at-bol) end (point-max))
7535 (org-back-to-heading t)
7536 (setq beg (point) end (org-end-of-subtree t t)))
7537 (put-text-property beg end 'org-category cat)
7538 (goto-char pos)))))))
7540 (defun org-archive-all-done (&optional tag)
7541 "Archive sublevels of the current tree without open TODO items.
7542 If the cursor is not on a headline, try all level 1 trees. If
7543 it is on a headline, try all direct children.
7544 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7546 (rea (concat ".*:" org-archive-tag ":"))
7547 (begm (make-marker))
7548 (endm (make-marker))
7549 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7550 "Move subtree to archive (no open TODO items)? "))
7551 beg end (cntarch 0))
7552 (if (org-on-heading-p)
7553 (progn
7554 (setq re1 (concat "^" (regexp-quote
7555 (make-string
7556 (1+ (- (match-end 0) (match-beginning 0)))
7557 ?*))
7558 " "))
7559 (move-marker begm (point))
7560 (move-marker endm (org-end-of-subtree t)))
7561 (setq re1 "^* ")
7562 (move-marker begm (point-min))
7563 (move-marker endm (point-max)))
7564 (save-excursion
7565 (goto-char begm)
7566 (while (re-search-forward re1 endm t)
7567 (setq beg (match-beginning 0)
7568 end (save-excursion (org-end-of-subtree t) (point)))
7569 (goto-char beg)
7570 (if (re-search-forward re end t)
7571 (goto-char end)
7572 (goto-char beg)
7573 (if (and (or (not tag) (not (looking-at rea)))
7574 (y-or-n-p question))
7575 (progn
7576 (if tag
7577 (org-toggle-tag org-archive-tag 'on)
7578 (org-archive-subtree))
7579 (setq cntarch (1+ cntarch)))
7580 (goto-char end)))))
7581 (message "%d trees archived" cntarch)))
7583 (defun org-cycle-hide-drawers (state)
7584 "Re-hide all drawers after a visibility state change."
7585 (when (and (org-mode-p)
7586 (not (memq state '(overview folded))))
7587 (save-excursion
7588 (let* ((globalp (memq state '(contents all)))
7589 (beg (if globalp (point-min) (point)))
7590 (end (if globalp (point-max) (org-end-of-subtree t))))
7591 (goto-char beg)
7592 (while (re-search-forward org-drawer-regexp end t)
7593 (org-flag-drawer t))))))
7595 (defun org-flag-drawer (flag)
7596 (save-excursion
7597 (beginning-of-line 1)
7599 (let ((b (match-end 0)))
7600 (if (re-search-forward
7602 (save-excursion (outline-next-heading) (point)) t)
7603 (outline-flag-region b (point-at-eol) flag)
7604 (error ":END: line missing"))))))
7606 (defun org-cycle-hide-archived-subtrees (state)
7607 "Re-hide all archived subtrees after a visibility state change."
7608 (when (and (not org-cycle-open-archived-trees)
7609 (not (memq state '(overview folded))))
7610 (save-excursion
7611 (let* ((globalp (memq state '(contents all)))
7612 (beg (if globalp (point-min) (point)))
7613 (end (if globalp (point-max) (org-end-of-subtree t))))
7614 (org-hide-archived-subtrees beg end)
7615 (goto-char beg)
7616 (if (looking-at (concat ".*:" org-archive-tag ":"))
7617 (message (substitute-command-keys
7618 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
7620 (defun org-force-cycle-archived ()
7621 "Cycle subtree even if it is archived."
7622 (interactive)
7623 (setq this-command 'org-cycle)
7624 (let ((org-cycle-open-archived-trees t))
7625 (call-interactively 'org-cycle)))
7627 (defun org-hide-archived-subtrees (beg end)
7628 "Re-hide all archived subtrees after a visibility state change."
7629 (save-excursion
7630 (let* ((re (concat ":" org-archive-tag ":")))
7631 (goto-char beg)
7632 (while (re-search-forward re end t)
7633 (and (org-on-heading-p) (hide-subtree))
7634 (org-end-of-subtree t)))))
7636 (defun org-toggle-tag (tag &optional onoff)
7637 "Toggle the tag TAG for the current line.
7638 If ONOFF is `on' or `off', don't toggle but set to this state."
7639 (unless (org-on-heading-p t) (error "Not on headling"))
7640 (let (res current)
7641 (save-excursion
7642 (beginning-of-line)
7644 (point-at-eol) t)
7645 (progn
7646 (setq current (match-string 1))
7647 (replace-match ""))
7648 (setq current ""))
7649 (setq current (nreverse (org-split-string current ":")))
7650 (cond
7651 ((eq onoff 'on)
7652 (setq res t)
7653 (or (member tag current) (push tag current)))
7654 ((eq onoff 'off)
7655 (or (not (member tag current)) (setq current (delete tag current))))
7656 (t (if (member tag current)
7657 (setq current (delete tag current))
7658 (setq res t)
7659 (push tag current))))
7660 (end-of-line 1)
7661 (if current
7662 (progn
7663 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
7664 (org-set-tags nil t))
7665 (delete-horizontal-space))
7666 (run-hooks 'org-after-tags-change-hook))
7667 res))
7669 (defun org-toggle-archive-tag (&optional arg)
7670 "Toggle the archive tag for the current headline.
7671 With prefix ARG, check all children of current headline and offer tagging
7672 the children that do not contain any open TODO items."
7673 (interactive "P")
7674 (if arg
7675 (org-archive-all-done 'tag)
7676 (let (set)
7677 (save-excursion
7678 (org-back-to-heading t)
7679 (setq set (org-toggle-tag org-archive-tag))
7680 (when set (hide-subtree)))
7681 (and set (beginning-of-line 1))
7682 (message "Subtree %s" (if set "archived" "unarchived")))))
7685 ;;;; Tables
7687 ;;; The table editor
7689 ;; Watch out: Here we are talking about two different kind of tables.
7690 ;; Most of the code is for the tables created with the Org-mode table editor.
7691 ;; Sometimes, we talk about tables created and edited with the table.el
7692 ;; Emacs package. We call the former org-type tables, and the latter
7693 ;; table.el-type tables.
7695 (defun org-before-change-function (beg end)
7696 "Every change indicates that a table might need an update."
7697 (setq org-table-may-need-update t))
7700 "Detects an org-type table line.")
7702 "Detects an org-type table line.")
7704 "Detects a table line marked for automatic recalculation.")
7706 "Detects a table line marked for automatic recalculation.")
7708 "Detects a table line marked for automatic recalculation.")
7710 "Detects an org-type table hline.")
7712 "Detects a table-type table hline.")
7714 "Detects an org-type or table-type table.")
7716 "Searching from within a table (any type) this finds the first line
7717 outside the table.")
7719 "Searching from within a table (any type) this finds the first line
7720 outside the table.")
7722 (defvar org-table-last-highlighted-reference nil)
7723 (defvar org-table-formula-history nil)
7725 (defvar org-table-column-names nil
7726 "Alist with column names, derived from the `!' line.")
7727 (defvar org-table-column-name-regexp nil
7728 "Regular expression matching the current column names.")
7729 (defvar org-table-local-parameters nil
7730 "Alist with parameter names, derived from the `$' line.")
7731 (defvar org-table-named-field-locations nil
7732 "Alist with locations of named fields.")
7734 (defvar org-table-current-line-types nil
7735 "Table row types, non-nil only for the duration of a comand.")
7736 (defvar org-table-current-begin-line nil
7737 "Table begin line, non-nil only for the duration of a comand.")
7738 (defvar org-table-current-begin-pos nil
7739 "Table begin position, non-nil only for the duration of a comand.")
7740 (defvar org-table-dlines nil
7741 "Vector of data line line numbers in the current table.")
7742 (defvar org-table-hlines nil
7743 "Vector of hline line numbers in the current table.")
7745 (defconst org-table-range-regexp
7746 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
7747 ;; 1 2 3 4 5
7748 "Regular expression for matching ranges in formulas.")
7750 (defconst org-table-range-regexp2
7751 (concat
7755 "Match a range for reference display.")
7757 (defconst org-table-translate-regexp
7759 "Match a reference that needs translation, for reference display.")
7761 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
7763 (defun org-table-create-with-table.el ()
7764 "Use the table.el package to insert a new table.
7765 If there is already a table at point, convert between Org-mode tables
7766 and table.el tables."
7767 (interactive)
7768 (require 'table)
7769 (cond
7770 ((org-at-table.el-p)
7771 (if (y-or-n-p "Convert table to Org-mode table? ")
7772 (org-table-convert)))
7773 ((org-at-table-p)
7774 (if (y-or-n-p "Convert table to table.el table? ")
7775 (org-table-convert)))
7776 (t (call-interactively 'table-insert))))
7778 (defun org-table-create-or-convert-from-region (arg)
7779 "Convert region to table, or create an empty table.
7780 If there is an active region, convert it to a table, using the function
7781 `org-table-convert-region'. See the documentation of that function
7782 to learn how the prefix argument is interpreted to determine the field
7783 separator.
7784 If there is no such region, create an empty table with `org-table-create'."
7785 (interactive "P")
7786 (if (org-region-active-p)
7787 (org-table-convert-region (region-beginning) (region-end) arg)
7788 (org-table-create arg)))
7790 (defun org-table-create (&optional size)
7791 "Query for a size and insert a table skeleton.
7793 (interactive "P")
7794 (unless size
7795 (setq size (read-string
7796 (concat "Table size Columns x Rows [e.g. "
7797 org-table-default-size "]: ")
7798 "" nil org-table-default-size)))
7800 (let* ((pos (point))
7801 (indent (make-string (current-column) ?\ ))
7802 (split (org-split-string size " *x *"))
7803 (rows (string-to-number (nth 1 split)))
7804 (columns (string-to-number (car split)))
7805 (line (concat (apply 'concat indent "|" (make-list columns " |"))
7808 (point-at-bol) (point)))
7809 (beginning-of-line 1)
7810 (newline))
7811 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
7812 (dotimes (i rows) (insert line))
7813 (goto-char pos)
7814 (if (> rows 1)
7815 ;; Insert a hline after the first row.
7816 (progn
7817 (end-of-line 1)
7819 (goto-char pos)))
7820 (org-table-align)))
7822 (defun org-table-convert-region (beg0 end0 &optional separator)
7823 "Convert region to a table.
7824 The region goes from BEG0 to END0, but these borders will be moved
7825 slightly, to make sure a beginning of line in the first line is included.
7827 SEPARATOR specifies the field separator in the lines. It can have the
7828 following values:
7830 '(4) Use the comma as a field separator
7831 '(16) Use a TAB as field separator
7832 integer When a number, use that many spaces as field separator
7833 nil When nil, the command tries to be smart and figure out the
7834 separator in the following way:
7835 - when each line contains a TAB, assume TAB-separated material
7836 - when each line contains a comme, assume CSV material
7837 - else, assume one or more SPACE charcters as separator."
7838 (interactive "rP")
7839 (let* ((beg (min beg0 end0))
7840 (end (max beg0 end0))
7841 re)
7842 (goto-char beg)
7843 (beginning-of-line 1)
7844 (setq beg (move-marker (make-marker) (point)))
7845 (goto-char end)
7846 (if (bolp) (backward-char 1) (end-of-line 1))
7847 (setq end (move-marker (make-marker) (point)))
7848 ;; Get the right field separator
7849 (unless separator
7850 (goto-char beg)
7851 (setq separator
7852 (cond
7855 (t 1))))
7856 (setq re (cond
7859 ((integerp separator)
7861 (t (error "This should not happen"))))
7862 (goto-char beg)
7863 (while (re-search-forward re end t)
7864 (replace-match "| " t t))
7865 (goto-char beg)
7866 (insert " ")
7867 (org-table-align)))
7869 (defun org-table-import (file arg)
7870 "Import FILE as a table.
7871 The file is assumed to be tab-separated. Such files can be produced by most
7872 spreadsheet and database applications. If no tabs (at least one per line)
7873 are found, lines will be split on whitespace into fields."
7875 (or (bolp) (newline))
7876 (let ((beg (point))
7877 (pm (point-max)))
7878 (insert-file-contents file)
7879 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
7881 (defun org-table-export ()
7882 "Export table as a tab-separated file.
7883 Such a file can be imported into a spreadsheet program like Excel."
7884 (interactive)
7885 (let* ((beg (org-table-begin))
7886 (end (org-table-end))
7887 (table (buffer-substring beg end))
7888 (file (read-file-name "Export table to: "))
7889 buf)
7890 (unless (or (not (file-exists-p file))
7891 (y-or-n-p (format "Overwrite file %s? " file)))
7892 (error "Abort"))
7893 (with-current-buffer (find-file-noselect file)
7894 (setq buf (current-buffer))
7895 (erase-buffer)
7896 (fundamental-mode)
7897 (insert table)
7898 (goto-char (point-min))
7900 (replace-match "" t t)
7901 (end-of-line 1))
7902 (goto-char (point-min))
7904 (replace-match "" t t)
7905 (goto-char (min (1+ (point)) (point-max))))
7906 (goto-char (point-min))
7907 (while (re-search-forward "^-[-+]*$" nil t)
7908 (replace-match "")
7910 (delete-char 1)))
7911 (goto-char (point-min))
7914 (save-buffer))
7915 (kill-buffer buf)))
7917 (defvar org-table-aligned-begin-marker (make-marker)
7918 "Marker at the beginning of the table last aligned.
7919 Used to check if cursor still is in that table, to minimize realignment.")
7920 (defvar org-table-aligned-end-marker (make-marker)
7921 "Marker at the end of the table last aligned.
7922 Used to check if cursor still is in that table, to minimize realignment.")
7923 (defvar org-table-last-alignment nil
7924 "List of flags for flushright alignment, from the last re-alignment.
7925 This is being used to correctly align a single field after TAB or RET.")
7926 (defvar org-table-last-column-widths nil
7927 "List of max width of fields in each column.
7928 This is being used to correctly align a single field after TAB or RET.")
7929 (defvar org-table-overlay-coordinates nil
7930 "Overlay coordinates after each align of a table.")
7931 (make-variable-buffer-local 'org-table-overlay-coordinates)
7933 (defvar org-last-recalc-line nil)
7934 (defconst org-narrow-column-arrow "=>"
7935 "Used as display property in narrowed table columns.")
7937 (defun org-table-align ()
7938 "Align the table at point by aligning all vertical bars."
7939 (interactive)
7940 (let* (
7941 ;; Limits of table
7942 (beg (org-table-begin))
7943 (end (org-table-end))
7944 ;; Current cursor position
7945 (linepos (org-current-line))
7946 (colpos (org-table-current-column))
7947 (winstart (window-start))
7948 (winstartline (org-current-line (min winstart (1- (point-max)))))
7949 lines (new "") lengths l typenums ty fields maxfields i
7950 column
7951 (indent "") cnt frac
7952 rfmt hfmt
7953 (spaces '(1 . 1))
7954 (sp1 (car spaces))
7955 (sp2 (cdr spaces))
7956 (rfmt1 (concat
7957 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
7958 (hfmt1 (concat
7959 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
7960 emptystrings links dates emph narrow fmax f1 len c e)
7961 (untabify beg end)
7962 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
7963 ;; Check if we have links or dates
7964 (goto-char beg)
7965 (setq links (re-search-forward org-bracket-link-regexp end t))
7966 (goto-char beg)
7967 (setq emph (and org-hide-emphasis-markers
7968 (re-search-forward org-emph-re end t)))
7969 (goto-char beg)
7970 (setq dates (and org-display-custom-times
7971 (re-search-forward org-ts-regexp-both end t)))
7972 ;; Make sure the link properties are right
7973 (when links (goto-char beg) (while (org-activate-bracket-links end)))
7974 ;; Make sure the date properties are right
7975 (when dates (goto-char beg) (while (org-activate-dates end)))
7976 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
7978 ;; Check if we are narrowing any columns
7979 (goto-char beg)
7980 (setq narrow (and org-format-transports-properties-p
7981 (re-search-forward "<[0-9]+>" end t)))
7982 ;; Get the rows
7983 (setq lines (org-split-string
7985 ;; Store the indentation of the first line
7986 (if (string-match "^ *" (car lines))
7987 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
7988 ;; Mark the hlines by setting the corresponding element to nil
7989 ;; At the same time, we remove trailing space.
7990 (setq lines (mapcar (lambda (l)
7991 (if (string-match "^ *|-" l)
7992 nil
7994 (substring l 0 (match-beginning 0))
7995 l)))
7996 lines))
7997 ;; Get the data fields by splitting the lines.
7998 (setq fields (mapcar
7999 (lambda (l)
8000 (org-split-string l " *| *"))
8001 (delq nil (copy-sequence lines))))
8002 ;; How many fields in the longest line?
8003 (condition-case nil
8004 (setq maxfields (apply 'max (mapcar 'length fields)))
8005 (error
8006 (kill-region beg end)
8007 (org-table-create org-table-default-size)
8008 (error "Empty table - created default table")))
8009 ;; A list of empty strings to fill any short rows on output
8010 (setq emptystrings (make-list maxfields ""))
8011 ;; Check for special formatting.
8012 (setq i -1)
8013 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8014 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8015 ;; Check if there is an explicit width specified
8016 (when narrow
8017 (setq c column fmax nil)
8018 (while c
8019 (setq e (pop c))
8021 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8022 ;; Find fields that are wider than fmax, and shorten them
8023 (when fmax
8024 (loop for xx in column do
8025 (when (and (stringp xx)
8026 (> (org-string-width xx) fmax))
8027 (org-add-props xx nil
8028 'help-echo
8029 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8030 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8031 (unless (> f1 1)
8033 (match-string 0 xx)))
8034 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8035 (add-text-properties (- f1 2) f1
8036 (list 'display org-narrow-column-arrow)
8037 xx)))))
8038 ;; Get the maximum width for each column
8039 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8040 ;; Get the fraction of numbers, to decide about alignment of the column
8041 (setq cnt 0 frac 0.0)
8042 (loop for x in column do
8043 (if (equal x "")
8044 nil
8045 (setq frac ( / (+ (* frac cnt)
8046 (if (string-match org-table-number-regexp x) 1 0))
8047 (setq cnt (1+ cnt))))))
8048 (push (>= frac org-table-number-fraction) typenums))
8049 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8051 ;; Store the alignment of this table, for later editing of single fields
8052 (setq org-table-last-alignment typenums
8053 org-table-last-column-widths lengths)
8055 ;; With invisible characters, `format' does not get the field width right
8056 ;; So we need to make these fields wide by hand.
8057 (when (or links emph)
8058 (loop for i from 0 upto (1- maxfields) do
8059 (setq len (nth i lengths))
8060 (loop for j from 0 upto (1- (length fields)) do
8061 (setq c (nthcdr i (car (nthcdr j fields))))
8062 (if (and (stringp (car c))
8063 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8064 ; (string-match org-bracket-link-regexp (car c))
8065 (< (org-string-width (car c)) len))
8066 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8068 ;; Compute the formats needed for output of the table
8069 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8070 (while (setq l (pop lengths))
8071 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8072 (setq rfmt (concat rfmt (format rfmt1 ty l))
8073 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8077 (setq new (mapconcat
8078 (lambda (l)
8079 (if l (apply 'format rfmt
8080 (append (pop fields) emptystrings))
8081 hfmt))
8082 lines ""))
8083 ;; Replace the old one
8084 (delete-region beg end)
8085 (move-marker end nil)
8086 (move-marker org-table-aligned-begin-marker (point))
8087 (insert new)
8088 (move-marker org-table-aligned-end-marker (point))
8089 (when (and orgtbl-mode (not (org-mode-p)))
8090 (goto-char org-table-aligned-begin-marker)
8091 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8092 ;; Try to move to the old location
8093 (goto-line winstartline)
8094 (setq winstart (point-at-bol))
8095 (goto-line linepos)
8096 (set-window-start (selected-window) winstart 'noforce)
8097 (org-table-goto-column colpos)
8098 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8099 (setq org-table-may-need-update nil)
8100 ))
8102 (defun org-string-width (s)
8103 "Compute width of string, ignoring invisible characters.
8104 This ignores character with invisibility property `org-link', and also
8105 characters with property `org-cwidth', because these will become invisible
8106 upon the next fontification round."
8107 (let (b l)
8108 (when (or (eq t buffer-invisibility-spec)
8109 (assq 'org-link buffer-invisibility-spec))
8110 (while (setq b (text-property-any 0 (length s)
8111 'invisible 'org-link s))
8112 (setq s (concat (substring s 0 b)
8113 (substring s (or (next-single-property-change
8114 b 'invisible s) (length s)))))))
8115 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8116 (setq s (concat (substring s 0 b)
8117 (substring s (or (next-single-property-change
8118 b 'org-cwidth s) (length s))))))
8119 (setq l (string-width s) b -1)
8120 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8121 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8122 l))
8124 (defun org-table-begin (&optional table-type)
8125 "Find the beginning of the table and return its position.
8126 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8127 (save-excursion
8128 (if (not (re-search-backward
8129 (if table-type org-table-any-border-regexp
8130 org-table-border-regexp)
8131 nil t))
8132 (progn (goto-char (point-min)) (point))
8133 (goto-char (match-beginning 0))
8134 (beginning-of-line 2)
8135 (point))))
8137 (defun org-table-end (&optional table-type)
8138 "Find the end of the table and return its position.
8139 With argument TABLE-TYPE, go to the end of a table.el-type table."
8140 (save-excursion
8141 (if (not (re-search-forward
8142 (if table-type org-table-any-border-regexp
8143 org-table-border-regexp)
8144 nil t))
8145 (goto-char (point-max))
8146 (goto-char (match-beginning 0)))
8147 (point-marker)))
8149 (defun org-table-justify-field-maybe (&optional new)
8150 "Justify the current field, text to left, number to right.
8151 Optional argument NEW may specify text to replace the current field content."
8152 (cond
8153 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8154 ((org-at-table-hline-p))
8155 ((and (not new)
8156 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8157 (current-buffer)))
8158 (< (point) org-table-aligned-begin-marker)
8159 (>= (point) org-table-aligned-end-marker)))
8160 ;; This is not the same table, force a full re-align
8161 (setq org-table-may-need-update t))
8162 (t ;; realign the current field, based on previous full realign
8163 (let* ((pos (point)) s
8164 (col (org-table-current-column))
8165 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8166 l f n o e)
8167 (when (> col 0)
8170 (progn
8171 (setq s (match-string 1)
8172 o (match-string 0)
8173 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8174 e (not (= (match-beginning 2) (match-end 2))))
8175 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8176 l (if e "|" (setq org-table-may-need-update t) ""))
8177 n (format f s))
8178 (if new
8179 (if (<= (length new) l) ;; FIXME: length -> str-width?
8180 (setq n (format f new))
8181 (setq n (concat new "|") org-table-may-need-update t)))
8182 (or (equal n o)
8183 (let (org-table-may-need-update)
8184 (replace-match n t t))))
8185 (setq org-table-may-need-update t))
8186 (goto-char pos))))))
8188 (defun org-table-next-field ()
8189 "Go to the next field in the current table, creating new lines as needed.
8190 Before doing so, re-align the table if necessary."
8191 (interactive)
8192 (org-table-maybe-eval-formula)
8193 (org-table-maybe-recalculate-line)
8194 (if (and org-table-automatic-realign
8195 org-table-may-need-update)
8196 (org-table-align))
8197 (let ((end (org-table-end)))
8198 (if (org-at-table-hline-p)
8199 (end-of-line 1))
8200 (condition-case nil
8201 (progn
8202 (re-search-forward "|" end)
8204 (re-search-forward "|" end))
8205 (if (and (looking-at "-")
8206 org-table-tab-jumps-over-hlines
8208 (goto-char (match-beginning 1)))
8209 (if (looking-at "-")
8210 (progn
8211 (beginning-of-line 0)
8212 (org-table-insert-row 'below))
8213 (if (looking-at " ") (forward-char 1))))
8214 (error
8215 (org-table-insert-row 'below)))))
8217 (defun org-table-previous-field ()
8218 "Go to the previous field in the table.
8219 Before doing so, re-align the table if necessary."
8220 (interactive)
8221 (org-table-justify-field-maybe)
8222 (org-table-maybe-recalculate-line)
8223 (if (and org-table-automatic-realign
8224 org-table-may-need-update)
8225 (org-table-align))
8226 (if (org-at-table-hline-p)
8227 (end-of-line 1))
8228 (re-search-backward "|" (org-table-begin))
8229 (re-search-backward "|" (org-table-begin))
8231 (re-search-backward "|" (org-table-begin)))
8232 (if (looking-at "| ?")
8233 (goto-char (match-end 0))))
8235 (defun org-table-next-row ()
8236 "Go to the next row (same column) in the current table.
8237 Before doing so, re-align the table if necessary."
8238 (interactive)
8239 (org-table-maybe-eval-formula)
8240 (org-table-maybe-recalculate-line)
8243 (newline)
8244 (if (and org-table-automatic-realign
8245 org-table-may-need-update)
8246 (org-table-align))
8247 (let ((col (org-table-current-column)))
8248 (beginning-of-line 2)
8249 (if (or (not (org-at-table-p))
8250 (org-at-table-hline-p))
8251 (progn
8252 (beginning-of-line 0)
8253 (org-table-insert-row 'below)))
8254 (org-table-goto-column col)
8256 (if (looking-at " ") (forward-char 1)))))
8258 (defun org-table-copy-down (n)
8259 "Copy a field down in the current column.
8260 If the field at the cursor is empty, copy into it the content of the nearest
8261 non-empty field above. With argument N, use the Nth non-empty field.
8262 If the current field is not empty, it is copied down to the next row, and
8263 the cursor is moved with it. Therefore, repeating this command causes the
8264 column to be filled row-by-row.
8265 If the variable `org-table-copy-increment' is non-nil and the field is an
8266 integer or a timestamp, it will be incremented while copying. In the case of
8267 a timestamp, if the cursor is on the year, change the year. If it is on the
8268 month or the day, change that. Point will stay on the current date field
8269 in order to easily repeat the interval."
8270 (interactive "p")
8271 (let* ((colpos (org-table-current-column))
8272 (col (current-column))
8273 (field (org-table-get-field))
8275 (beg (org-table-begin))
8276 txt)
8277 (org-table-check-inside-data-field)
8278 (if non-empty
8279 (progn
8280 (setq txt (org-trim field))
8281 (org-table-next-row)
8282 (org-table-blank-field))
8283 (save-excursion
8284 (setq txt
8285 (catch 'exit
8286 (while (progn (beginning-of-line 1)
8287 (re-search-backward org-table-dataline-regexp
8288 beg t))
8289 (org-table-goto-column colpos t)
8290 (if (and (looking-at
8292 (= (setq n (1- n)) 0))
8293 (throw 'exit (match-string 1))))))))
8294 (if txt
8295 (progn
8296 (if (and org-table-copy-increment
8297 (string-match "^[0-9]+$" txt))
8298 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8299 (insert txt)
8300 (move-to-column col)
8301 (if (and org-table-copy-increment (org-at-timestamp-p t))
8302 (org-timestamp-up 1)
8303 (org-table-maybe-recalculate-line))
8304 (org-table-align)
8305 (move-to-column col))
8306 (error "No non-empty field found"))))
8308 (defun org-table-check-inside-data-field ()
8309 "Is point inside a table data field?
8310 I.e. not on a hline or before the first or after the last column?
8311 This actually throws an error, so it aborts the current command."
8312 (if (or (not (org-at-table-p))
8313 (= (org-table-current-column) 0)
8314 (org-at-table-hline-p)
8316 (error "Not in table data field")))
8318 (defvar org-table-clip nil
8319 "Clipboard for table regions.")
8321 (defun org-table-blank-field ()
8322 "Blank the current table field or active region."
8323 (interactive)
8324 (org-table-check-inside-data-field)
8325 (if (and (interactive-p) (org-region-active-p))
8326 (let (org-table-clip)
8327 (org-table-cut-region (region-beginning) (region-end)))
8328 (skip-chars-backward "^|")
8329 (backward-char 1)
8331 (let* ((pos (match-beginning 0))
8332 (match (match-string 0))
8333 (len (org-string-width match)))
8334 (replace-match (concat "|" (make-string (1- len) ?\ )))
8335 (goto-char (+ 2 pos))
8336 (substring match 1)))))
8338 (defun org-table-get-field (&optional n replace)
8339 "Return the value of the field in column N of current row.
8340 N defaults to current field.
8341 If REPLACE is a string, replace field with this value. The return value
8342 is always the old value."
8343 (and n (org-table-goto-column n))
8345 (backward-char 1)
8347 (let* ((pos (match-beginning 0))
8348 (val (buffer-substring (1+ pos) (match-end 0))))
8349 (if replace
8350 (replace-match (concat "|" replace) t t))
8351 (goto-char (min (point-at-eol) (+ 2 pos)))
8352 val)
8353 (forward-char 1) ""))
8355 (defun org-table-field-info (arg)
8356 "Show info about the current field, and highlight any reference at point."
8357 (interactive "P")
8358 (org-table-get-specials)
8359 (save-excursion
8360 (let* ((pos (point))
8361 (col (org-table-current-column))
8362 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8363 (name (car (rassoc (list (org-current-line) col)
8364 org-table-named-field-locations)))
8365 (eql (org-table-get-stored-formulas))
8366 (dline (org-table-current-dline))
8367 (ref (format "@%d$%d" dline col))
8368 (ref1 (org-table-convert-refs-to-an ref))
8369 (fequation (or (assoc name eql) (assoc ref eql)))
8370 (cequation (assoc (int-to-string col) eql))
8371 (eqn (or fequation cequation)))
8372 (goto-char pos)
8373 (condition-case nil
8374 (org-table-show-reference 'local)
8375 (error nil))
8376 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8377 dline col
8378 (if cname (concat " or $" cname) "")
8379 dline col ref1
8380 (if name (concat " or $" name) "")
8381 ;; FIXME: formula info not correct if special table line
8382 (if eqn
8383 (concat ", formula: "
8384 (org-table-formula-to-user
8385 (concat
8386 (if (string-match "^[$@]"(car eqn)) "" "$")
8387 (car eqn) "=" (cdr eqn))))
8388 "")))))
8390 (defun org-table-current-column ()
8391 "Find out which column we are in.
8392 When called interactively, column is also displayed in echo area."
8393 (interactive)
8394 (if (interactive-p) (org-table-check-inside-data-field))
8395 (save-excursion
8396 (let ((cnt 0) (pos (point)))
8397 (beginning-of-line 1)
8398 (while (search-forward "|" pos t)
8399 (setq cnt (1+ cnt)))
8400 (if (interactive-p) (message "This is table column %d" cnt))
8401 cnt)))
8403 (defun org-table-current-dline ()
8404 "Find out what table data line we are in.
8405 Only datalins count for this."
8406 (interactive)
8407 (if (interactive-p) (org-table-check-inside-data-field))
8408 (save-excursion
8409 (let ((cnt 0) (pos (point)))
8410 (goto-char (org-table-begin))
8411 (while (<= (point) pos)
8412 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8413 (beginning-of-line 2))
8414 (if (interactive-p) (message "This is table line %d" cnt))
8415 cnt)))
8417 (defun org-table-goto-column (n &optional on-delim force)
8418 "Move the cursor to the Nth column in the current table line.
8419 With optional argument ON-DELIM, stop with point before the left delimiter
8420 of the field.
8421 If there are less than N fields, just go to after the last delimiter.
8422 However, when FORCE is non-nil, create new columns if necessary."
8423 (interactive "p")
8424 (let ((pos (point-at-eol)))
8425 (beginning-of-line 1)
8426 (when (> n 0)
8427 (while (and (> (setq n (1- n)) -1)
8428 (or (search-forward "|" pos t)
8429 (and force
8430 (progn (end-of-line 1)
8431 (skip-chars-backward "^|")
8432 (insert " | "))))))
8433 ; (backward-char 2) t)))))
8434 (when (and force (not (looking-at ".*|")))
8435 (save-excursion (end-of-line 1) (insert " | ")))
8436 (if on-delim
8437 (backward-char 1)
8438 (if (looking-at " ") (forward-char 1))))))
8440 (defun org-at-table-p (&optional table-type)
8441 "Return t if the cursor is inside an org-type table.
8442 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8443 (if org-enable-table-editor
8444 (save-excursion
8445 (beginning-of-line 1)
8446 (looking-at (if table-type org-table-any-line-regexp
8447 org-table-line-regexp)))
8448 nil))
8450 (defun org-at-table.el-p ()
8451 "Return t if and only if we are at a table.el table."
8452 (and (org-at-table-p 'any)
8453 (save-excursion
8454 (goto-char (org-table-begin 'any))
8455 (looking-at org-table1-hline-regexp))))
8457 (defun org-table-recognize-table.el ()
8458 "If there is a table.el table nearby, recognize it and move into it."
8459 (if org-table-tab-recognizes-table.el
8460 (if (org-at-table.el-p)
8461 (progn
8462 (beginning-of-line 1)
8463 (if (looking-at org-table-dataline-regexp)
8464 nil
8465 (if (looking-at org-table1-hline-regexp)
8466 (progn
8467 (beginning-of-line 2)
8468 (if (looking-at org-table-any-border-regexp)
8469 (beginning-of-line -1)))))
8470 (if (re-search-forward "|" (org-table-end t) t)
8471 (progn
8472 (require 'table)
8473 (if (table--at-cell-p (point))
8474 t
8475 (message "recognizing table.el table...")
8476 (table-recognize-table)
8477 (message "recognizing table.el table...done")))
8478 (error "This should not happen..."))
8479 t)
8480 nil)
8481 nil))
8483 (defun org-at-table-hline-p ()
8484 "Return t if the cursor is inside a hline in a table."
8485 (if org-enable-table-editor
8486 (save-excursion
8487 (beginning-of-line 1)
8488 (looking-at org-table-hline-regexp))
8489 nil))
8491 (defun org-table-insert-column ()
8492 "Insert a new column into the table."
8493 (interactive)
8494 (if (not (org-at-table-p))
8495 (error "Not at a table"))
8496 (org-table-find-dataline)
8497 (let* ((col (max 1 (org-table-current-column)))
8498 (beg (org-table-begin))
8499 (end (org-table-end))
8500 ;; Current cursor position
8501 (linepos (org-current-line))
8502 (colpos col))
8503 (goto-char beg)
8504 (while (< (point) end)
8505 (if (org-at-table-hline-p)
8506 nil
8507 (org-table-goto-column col t)
8508 (insert "| "))
8509 (beginning-of-line 2))
8510 (move-marker end nil)
8511 (goto-line linepos)
8512 (org-table-goto-column colpos)
8513 (org-table-align)
8514 (org-table-fix-formulas "$" nil (1- col) 1)))
8516 (defun org-table-find-dataline ()
8517 "Find a dataline in the current table, which is needed for column commands."
8518 (if (and (org-at-table-p)
8519 (not (org-at-table-hline-p)))
8520 t
8521 (let ((col (current-column))
8522 (end (org-table-end)))
8523 (move-to-column col)
8524 (while (and (< (point) end)
8525 (or (not (= (current-column) col))
8526 (org-at-table-hline-p)))
8527 (beginning-of-line 2)
8528 (move-to-column col))
8529 (if (and (org-at-table-p)
8530 (not (org-at-table-hline-p)))
8531 t
8532 (error
8533 "Please position cursor in a data line for column operations")))))
8535 (defun org-table-delete-column ()
8536 "Delete a column from the table."
8537 (interactive)
8538 (if (not (org-at-table-p))
8539 (error "Not at a table"))
8540 (org-table-find-dataline)
8541 (org-table-check-inside-data-field)
8542 (let* ((col (org-table-current-column))
8543 (beg (org-table-begin))
8544 (end (org-table-end))
8545 ;; Current cursor position
8546 (linepos (org-current-line))
8547 (colpos col))
8548 (goto-char beg)
8549 (while (< (point) end)
8550 (if (org-at-table-hline-p)
8551 nil
8552 (org-table-goto-column col t)
8554 (replace-match "|")))
8555 (beginning-of-line 2))
8556 (move-marker end nil)
8557 (goto-line linepos)
8558 (org-table-goto-column colpos)
8559 (org-table-align)
8560 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
8561 col -1 col)))
8563 (defun org-table-move-column-right ()
8564 "Move column to the right."
8565 (interactive)
8566 (org-table-move-column nil))
8567 (defun org-table-move-column-left ()
8568 "Move column to the left."
8569 (interactive)
8570 (org-table-move-column 'left))
8572 (defun org-table-move-column (&optional left)
8573 "Move the current column to the right. With arg LEFT, move to the left."
8574 (interactive "P")
8575 (if (not (org-at-table-p))
8576 (error "Not at a table"))
8577 (org-table-find-dataline)
8578 (org-table-check-inside-data-field)
8579 (let* ((col (org-table-current-column))
8580 (col1 (if left (1- col) col))
8581 (beg (org-table-begin))
8582 (end (org-table-end))
8583 ;; Current cursor position
8584 (linepos (org-current-line))
8585 (colpos (if left (1- col) (1+ col))))
8586 (if (and left (= col 1))
8587 (error "Cannot move column further left"))
8589 (error "Cannot move column further right"))
8590 (goto-char beg)
8591 (while (< (point) end)
8592 (if (org-at-table-hline-p)
8593 nil
8594 (org-table-goto-column col1 t)
8597 (beginning-of-line 2))
8598 (move-marker end nil)
8599 (goto-line linepos)
8600 (org-table-goto-column colpos)
8601 (org-table-align)
8602 (org-table-fix-formulas
8603 "$" (list (cons (number-to-string col) (number-to-string colpos))
8604 (cons (number-to-string colpos) (number-to-string col))))))
8606 (defun org-table-move-row-down ()
8607 "Move table row down."
8608 (interactive)
8609 (org-table-move-row nil))
8610 (defun org-table-move-row-up ()
8611 "Move table row up."
8612 (interactive)
8613 (org-table-move-row 'up))
8615 (defun org-table-move-row (&optional up)
8616 "Move the current table line down. With arg UP, move it up."
8617 (interactive "P")
8618 (let* ((col (current-column))
8619 (pos (point))
8620 (hline1p (save-excursion (beginning-of-line 1)
8621 (looking-at org-table-hline-regexp)))
8622 (dline1 (org-table-current-dline))
8623 (dline2 (+ dline1 (if up -1 1)))
8624 (tonew (if up 0 2))
8625 txt hline2p)
8626 (beginning-of-line tonew)
8627 (unless (org-at-table-p)
8628 (goto-char pos)
8629 (error "Cannot move row further"))
8630 (setq hline2p (looking-at org-table-hline-regexp))
8631 (goto-char pos)
8632 (beginning-of-line 1)
8633 (setq pos (point))
8634 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
8635 (delete-region (point) (1+ (point-at-eol)))
8636 (beginning-of-line tonew)
8637 (insert txt)
8638 (beginning-of-line 0)
8639 (move-to-column col)
8640 (unless (or hline1p hline2p)
8641 (org-table-fix-formulas
8642 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
8643 (cons (number-to-string dline2) (number-to-string dline1)))))))
8645 (defun org-table-insert-row (&optional arg)
8646 "Insert a new row above the current line into the table.
8647 With prefix ARG, insert below the current line."
8648 (interactive "P")
8649 (if (not (org-at-table-p))
8650 (error "Not at a table"))
8651 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
8652 (new (org-table-clean-line line)))
8653 ;; Fix the first field if necessary
8655 (setq new (replace-match (match-string 0 line) t t new)))
8656 (beginning-of-line (if arg 2 1))
8658 (beginning-of-line 0)
8659 (re-search-forward "| ?" (point-at-eol) t)
8660 (and (or org-table-may-need-update org-table-overlay-coordinates)
8661 (org-table-align))
8662 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
8664 (defun org-table-insert-hline (&optional above)
8665 "Insert a horizontal-line below the current line into the table.
8666 With prefix ABOVE, insert above the current line."
8667 (interactive "P")
8668 (if (not (org-at-table-p))
8669 (error "Not at a table"))
8670 (let ((line (org-table-clean-line
8671 (buffer-substring (point-at-bol) (point-at-eol))))
8672 (col (current-column)))
8674 (setq line (replace-match
8675 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
8676 ?-) "|") t t line)))
8678 (beginning-of-line (if above 1 2))
8680 (beginning-of-line (if above 1 -1))
8681 (move-to-column col)
8682 (and org-table-overlay-coordinates (org-table-align))))
8684 (defun org-table-hline-and-move (&optional same-column)
8685 "Insert a hline and move to the row below that line."
8686 (interactive "P")
8687 (let ((col (org-table-current-column)))
8688 (org-table-maybe-eval-formula)
8689 (org-table-maybe-recalculate-line)
8690 (org-table-insert-hline)
8691 (end-of-line 2)
8694 (org-table-next-field))
8695 (if same-column (org-table-goto-column col))))
8697 (defun org-table-clean-line (s)
8699 In particular, this does handle wide and invisible characters."
8701 ;; It's a hline, just map the characters
8702 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
8704 (setq s (replace-match
8705 (concat "|" (make-string (org-string-width (match-string 1 s))
8706 ?\ ) "|")
8707 t t s)))
8708 s))
8710 (defun org-table-kill-row ()
8711 "Delete the current row or horizontal line from the table."
8712 (interactive)
8713 (if (not (org-at-table-p))
8714 (error "Not at a table"))
8715 (let ((col (current-column))
8716 (dline (org-table-current-dline)))
8717 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
8718 (if (not (org-at-table-p)) (beginning-of-line 0))
8719 (move-to-column col)
8720 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
8721 dline -1 dline)))
8723 (defun org-table-sort-lines (with-case &optional sorting-type)
8724 "Sort table lines according to the column at point.
8726 The position of point indicates the column to be used for
8727 sorting, and the range of lines is the range between the nearest
8728 horizontal separator lines, or the entire table of no such lines
8729 exist. If point is before the first column, you will be prompted
8730 for the sorting column. If there is an active region, the mark
8731 specifies the first line and the sorting column, while point
8732 should be in the last line to be included into the sorting.
8734 The command then prompts for the sorting type which can be
8735 alphabetically, numerically, or by time (as given in a time stamp
8736 in the field). Sorting in reverse order is also possible.
8738 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
8740 If SORTING-TYPE is specified when this function is called from a Lisp
8741 program, no prompting will take place. SORTING-TYPE must be a character,
8742 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
8743 should be done in reverse order."
8744 (interactive "P")
8745 (let* ((thisline (org-current-line))
8746 (thiscol (org-table-current-column))
8747 beg end bcol ecol tend tbeg column lns pos)
8748 (when (equal thiscol 0)
8749 (if (interactive-p)
8750 (setq thiscol
8751 (string-to-number
8752 (read-string "Use column N for sorting: ")))
8753 (setq thiscol 1))
8754 (org-table-goto-column thiscol))
8755 (org-table-check-inside-data-field)
8756 (if (org-region-active-p)
8757 (progn
8758 (setq beg (region-beginning) end (region-end))
8759 (goto-char beg)
8760 (setq column (org-table-current-column)
8761 beg (point-at-bol))
8762 (goto-char end)
8763 (setq end (point-at-bol 2)))
8764 (setq column (org-table-current-column)
8765 pos (point)
8766 tbeg (org-table-begin)
8767 tend (org-table-end))
8768 (if (re-search-backward org-table-hline-regexp tbeg t)
8769 (setq beg (point-at-bol 2))
8770 (goto-char tbeg)
8771 (setq beg (point-at-bol 1)))
8772 (goto-char pos)
8773 (if (re-search-forward org-table-hline-regexp tend t)
8774 (setq end (point-at-bol 1))
8775 (goto-char tend)
8776 (setq end (point-at-bol))))
8777 (setq beg (move-marker (make-marker) beg)
8778 end (move-marker (make-marker) end))
8779 (untabify beg end)
8780 (goto-char beg)
8781 (org-table-goto-column column)
8782 (skip-chars-backward "^|")
8783 (setq bcol (current-column))
8784 (org-table-goto-column (1+ column))
8785 (skip-chars-backward "^|")
8786 (setq ecol (1- (current-column)))
8787 (org-table-goto-column column)
8788 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
8790 (setq lns (org-do-sort lns "Table" with-case sorting-type))
8791 (delete-region beg end)
8792 (move-marker beg nil)
8793 (move-marker end nil)
8795 (goto-line thisline)
8796 (org-table-goto-column thiscol)
8797 (message "%d lines sorted, based on column %d" (length lns) column)))
8799 (defun org-table-cut-region (beg end)
8800 "Copy region in table to the clipboard and blank all relevant fields."
8801 (interactive "r")
8802 (org-table-copy-region beg end 'cut))
8804 (defun org-table-copy-region (beg end &optional cut)
8805 "Copy rectangular region in table to clipboard.
8806 A special clipboard is used which can only be accessed
8807 with `org-table-paste-rectangle'."
8808 (interactive "rP")
8809 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
8810 region cols
8811 (rpl (if cut " " nil)))
8812 (goto-char beg)
8813 (org-table-check-inside-data-field)
8814 (setq l01 (org-current-line)
8815 c01 (org-table-current-column))
8816 (goto-char end)
8817 (org-table-check-inside-data-field)
8818 (setq l02 (org-current-line)
8819 c02 (org-table-current-column))
8820 (setq l1 (min l01 l02) l2 (max l01 l02)
8821 c1 (min c01 c02) c2 (max c01 c02))
8822 (catch 'exit
8823 (while t
8824 (catch 'nextline
8825 (if (> l1 l2) (throw 'exit t))
8826 (goto-line l1)
8827 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
8828 (setq cols nil ic1 c1 ic2 c2)
8829 (while (< ic1 (1+ ic2))
8830 (push (org-table-get-field ic1 rpl) cols)
8831 (setq ic1 (1+ ic1)))
8832 (push (nreverse cols) region)
8833 (setq l1 (1+ l1)))))
8834 (setq org-table-clip (nreverse region))
8835 (if cut (org-table-align))
8836 org-table-clip))
8838 (defun org-table-paste-rectangle ()
8839 "Paste a rectangular region into a table.
8840 The upper right corner ends up in the current field. All involved fields
8841 will be overwritten. If the rectangle does not fit into the present table,
8842 the table is enlarged as needed. The process ignores horizontal separator
8843 lines."
8844 (interactive)
8845 (unless (and org-table-clip (listp org-table-clip))
8846 (error "First cut/copy a region to paste!"))
8847 (org-table-check-inside-data-field)
8848 (let* ((clip org-table-clip)
8849 (line (org-current-line))
8850 (col (org-table-current-column))
8851 (org-enable-table-editor t)
8852 (org-table-automatic-realign nil)
8853 c cols field)
8854 (while (setq cols (pop clip))
8855 (while (org-at-table-hline-p) (beginning-of-line 2))
8856 (if (not (org-at-table-p))
8857 (progn (end-of-line 0) (org-table-next-field)))
8858 (setq c col)
8859 (while (setq field (pop cols))
8860 (org-table-goto-column c nil 'force)
8861 (org-table-get-field nil field)
8862 (setq c (1+ c)))
8863 (beginning-of-line 2))
8864 (goto-line line)
8865 (org-table-goto-column col)
8866 (org-table-align)))
8868 (defun org-table-convert ()
8869 "Convert from `org-mode' table to table.el and back.
8870 Obviously, this only works within limits. When an Org-mode table is
8871 converted to table.el, all horizontal separator lines get lost, because
8872 table.el uses these as cell boundaries and has no notion of horizontal lines.
8873 A table.el table can be converted to an Org-mode table only if it does not
8874 do row or column spanning. Multiline cells will become multiple cells.
8875 Beware, Org-mode does not test if the table can be successfully converted - it
8876 blindly applies a recipe that works for simple tables."
8877 (interactive)
8878 (require 'table)
8879 (if (org-at-table.el-p)
8880 ;; convert to Org-mode table
8881 (let ((beg (move-marker (make-marker) (org-table-begin t)))
8882 (end (move-marker (make-marker) (org-table-end t))))
8883 (table-unrecognize-region beg end)
8884 (goto-char beg)
8886 (replace-match ""))
8887 (goto-char beg))
8888 (if (org-at-table-p)
8889 ;; convert to table.el table
8890 (let ((beg (move-marker (make-marker) (org-table-begin)))
8891 (end (move-marker (make-marker) (org-table-end))))
8892 ;; first, get rid of all horizontal lines
8893 (goto-char beg)
8895 (replace-match ""))
8896 ;; insert a hline before first
8897 (goto-char beg)
8898 (org-table-insert-hline 'above)
8899 (beginning-of-line -1)
8900 ;; insert a hline after each line
8901 (while (progn (beginning-of-line 3) (< (point) end))
8902 (org-table-insert-hline))
8903 (goto-char beg)
8904 (setq end (move-marker end (org-table-end)))
8905 ;; replace "+" at beginning and ending of hlines
8908 (goto-char beg)
8910 (replace-match "-+"))
8911 (goto-char beg)))))
8913 (defun org-table-wrap-region (arg)
8914 "Wrap several fields in a column like a paragraph.
8915 This is useful if you'd like to spread the contents of a field over several
8916 lines, in order to keep the table compact.
8918 If there is an active region, and both point and mark are in the same column,
8919 the text in the column is wrapped to minimum width for the given number of
8920 lines. Generally, this makes the table more compact. A prefix ARG may be
8922 formats the selected text to two lines. If the region was longer than two
8923 lines, the remaining lines remain empty. A negative prefix argument reduces
8924 the current number of lines by that amount. The wrapped text is pasted back
8925 into the table. If you formatted it to more lines than it was before, fields
8926 further down in the table get overwritten - so you might need to make space in
8927 the table first.
8929 If there is no region, the current field is split at the cursor position and
8930 the text fragment to the right of the cursor is prepended to the field one
8931 line down.
8933 If there is no region, but you specify a prefix ARG, the current field gets
8934 blank, and the content is appended to the field above."
8935 (interactive "P")
8936 (org-table-check-inside-data-field)
8937 (if (org-region-active-p)
8938 ;; There is a region: fill as a paragraph
8939 (let* ((beg (region-beginning))
8940 (cline (save-excursion (goto-char beg) (org-current-line)))
8941 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
8942 nlines)
8943 (org-table-cut-region (region-beginning) (region-end))
8944 (if (> (length (car org-table-clip)) 1)
8945 (error "Region must be limited to single column"))
8946 (setq nlines (if arg
8947 (if (< arg 1)
8948 (+ (length org-table-clip) arg)
8949 arg)
8950 (length org-table-clip)))
8951 (setq org-table-clip
8952 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
8953 nil nlines)))
8954 (goto-line cline)
8955 (org-table-goto-column ccol)
8956 (org-table-paste-rectangle))
8957 ;; No region, split the current field at point
8958 (if arg
8959 ;; combine with field above
8960 (let ((s (org-table-blank-field))
8961 (col (org-table-current-column)))
8962 (beginning-of-line 0)
8963 (while (org-at-table-hline-p) (beginning-of-line 0))
8964 (org-table-goto-column col)
8965 (skip-chars-forward "^|")
8966 (skip-chars-backward " ")
8967 (insert " " (org-trim s))
8968 (org-table-align))
8969 ;; split field
8971 (let ((s (match-string 1)))
8972 (replace-match " |")
8973 (goto-char (match-beginning 0))
8974 (org-table-next-row)
8975 (insert (org-trim s) " ")
8976 (org-table-align))))))
8978 (defvar org-field-marker nil)
8980 (defun org-table-edit-field (arg)
8981 "Edit table field in a different window.
8982 This is mainly useful for fields that contain hidden parts.
8984 it can be edited in place."
8985 (interactive "P")
8986 (if arg
8987 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
8989 (remove-text-properties b e '(org-cwidth t invisible t
8990 display t intangible t))
8991 (if (and (boundp 'font-lock-mode) font-lock-mode)
8992 (font-lock-fontify-block)))
8993 (let ((pos (move-marker (make-marker) (point)))
8994 (field (org-table-get-field))
8995 (cw (current-window-configuration))
8996 p)
8997 (org-switch-to-buffer-other-window "*Org tmp*")
8998 (erase-buffer)
9000 (let ((org-inhibit-startup t)) (org-mode))
9001 (goto-char (setq p (point-max)))
9002 (insert (org-trim field))
9003 (remove-text-properties p (point-max)
9004 '(invisible t org-cwidth t display t
9005 intangible t))
9006 (goto-char p)
9007 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9008 (org-set-local 'org-window-configuration cw)
9009 (org-set-local 'org-field-marker pos)
9010 (message "Edit and finish with C-c C-c"))))
9012 (defun org-table-finish-edit-field ()
9013 "Finish editing a table data field.
9014 Remove all newline characters, insert the result into the table, realign
9015 the table and kill the editing buffer."
9016 (let ((pos org-field-marker)
9017 (cw org-window-configuration)
9018 (cb (current-buffer))
9019 text)
9020 (goto-char (point-min))
9023 (replace-match " "))
9024 (setq text (org-trim (buffer-string)))
9025 (set-window-configuration cw)
9026 (kill-buffer cb)
9027 (select-window (get-buffer-window (marker-buffer pos)))
9028 (goto-char pos)
9029 (move-marker pos nil)
9030 (org-table-check-inside-data-field)
9031 (org-table-get-field nil text)
9032 (org-table-align)
9033 (message "New field value inserted")))
9035 (defun org-trim (s)
9036 "Remove whitespace at beginning and end of string."
9039 s)
9041 (defun org-wrap (string &optional width lines)
9042 "Wrap string to either a number of lines, or a width in characters.
9043 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9044 that costs. If there is a word longer than WIDTH, the text is actually
9045 wrapped to the length of that word.
9046 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9047 many lines, whatever width that takes.
9048 The return value is a list of lines, without newlines at the end."
9050 (maxword (apply 'max (mapcar 'org-string-width words)))
9051 w ll)
9052 (cond (width
9053 (org-do-wrap words (max maxword width)))
9054 (lines
9055 (setq w maxword)
9056 (setq ll (org-do-wrap words maxword))
9057 (if (<= (length ll) lines)
9058 ll
9059 (setq ll words)
9060 (while (> (length ll) lines)
9061 (setq w (1+ w))
9062 (setq ll (org-do-wrap words w)))
9063 ll))
9064 (t (error "Cannot wrap this")))))
9067 (defun org-do-wrap (words width)
9068 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9069 (let (lines line)
9070 (while words
9071 (setq line (pop words))
9072 (while (and words (< (+ (length line) (length (car words))) width))
9073 (setq line (concat line " " (pop words))))
9074 (setq lines (push line lines)))
9075 (nreverse lines)))
9077 (defun org-split-string (string &optional separators)
9078 "Splits STRING into substrings at SEPARATORS.
9079 No empty strings are returned if there are matches at the beginning
9080 and end of string."
9082 (start 0)
9083 notfirst
9084 (list nil))
9085 (while (and (string-match rexp string
9086 (if (and notfirst
9087 (= start (match-beginning 0))
9088 (< start (length string)))
9089 (1+ start) start))
9090 (< (match-beginning 0) (length string)))
9091 (setq notfirst t)
9092 (or (eq (match-beginning 0) 0)
9093 (and (eq (match-beginning 0) (match-end 0))
9094 (eq (match-beginning 0) start))
9095 (setq list
9096 (cons (substring string start (match-beginning 0))
9097 list)))
9098 (setq start (match-end 0)))
9099 (or (eq start (length string))
9100 (setq list
9101 (cons (substring string start)
9102 list)))
9103 (nreverse list)))
9105 (defun org-table-map-tables (function)
9106 "Apply FUNCTION to the start of all tables in the buffer."
9107 (save-excursion
9108 (save-restriction
9109 (widen)
9110 (goto-char (point-min))
9111 (while (re-search-forward org-table-any-line-regexp nil t)
9112 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9113 (beginning-of-line 1)
9114 (if (looking-at org-table-line-regexp)
9115 (save-excursion (funcall function)))
9116 (re-search-forward org-table-any-border-regexp nil 1))))
9117 (message "Mapping tables: done"))
9119 (defvar org-timecnt) ; dynamically scoped parameter
9121 (defun org-table-sum (&optional beg end nlast)
9122 "Sum numbers in region of current table column.
9123 The result will be displayed in the echo area, and will be available
9126 If there is an active region, it is interpreted as a rectangle and all
9127 numbers in that rectangle will be summed. If there is no active
9128 region and point is located in a table column, sum all numbers in that
9129 column.
9131 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9132 numbers are assumed to be times as well (in decimal hours) and the
9133 numbers are added as such.
9135 If NLAST is a number, only the NLAST fields will actually be summed."
9136 (interactive)
9137 (save-excursion
9138 (let (col (org-timecnt 0) diff h m s org-table-clip)
9139 (cond
9140 ((and beg end)) ; beg and end given explicitly
9141 ((org-region-active-p)
9142 (setq beg (region-beginning) end (region-end)))
9143 (t
9144 (setq col (org-table-current-column))
9145 (goto-char (org-table-begin))
9147 (error "No table data"))
9148 (org-table-goto-column col)
9149 (setq beg (point))
9150 (goto-char (org-table-end))
9152 (error "No table data"))
9153 (org-table-goto-column col)
9154 (setq end (point))))
9155 (let* ((items (apply 'append (org-table-copy-region beg end)))
9156 (items1 (cond ((not nlast) items)
9157 ((>= nlast (length items)) items)
9158 (t (setq items (reverse items))
9159 (setcdr (nthcdr (1- nlast) items) nil)
9160 (nreverse items))))
9161 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9162 items1)))
9163 (res (apply '+ numbers))
9164 (sres (if (= org-timecnt 0)
9165 (format "%g" res)
9166 (setq diff (* 3600 res)
9167 h (floor (/ diff 3600)) diff (mod diff 3600)
9168 m (floor (/ diff 60)) diff (mod diff 60)
9169 s diff)
9170 (format "%d:%02d:%02d" h m s))))
9171 (kill-new sres)
9172 (if (interactive-p)
9173 (message "%s"
9174 (substitute-command-keys
9176 (length numbers) sres))))
9177 sres))))
9179 (defun org-table-get-number-for-summing (s)
9180 (let (n)
9181 (if (string-match "^ *|? *" s)
9182 (setq s (replace-match "" nil nil s)))
9183 (if (string-match " *|? *$" s)
9184 (setq s (replace-match "" nil nil s)))
9185 (setq n (string-to-number s))
9186 (cond
9187 ((and (string-match "0" s)
9191 (let ((h (string-to-number (or (match-string 1 s) "0")))
9192 (m (string-to-number (or (match-string 2 s) "0")))
9193 (s (string-to-number (or (match-string 4 s) "0"))))
9194 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9195 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9196 ((equal n 0) nil)
9197 (t n))))
9199 (defun org-table-current-field-formula (&optional key noerror)
9200 "Return the formula active for the current field.
9201 Assumes that specials are in place.
9202 If KEY is given, return the key to this formula.
9204 (let* ((name (car (rassoc (list (org-current-line)
9205 (org-table-current-column))
9206 org-table-named-field-locations)))
9207 (col (org-table-current-column))
9208 (scol (int-to-string col))
9209 (ref (format "@%d$%d" (org-table-current-dline) col))
9210 (stored-list (org-table-get-stored-formulas noerror))
9211 (ass (or (assoc name stored-list)
9212 (assoc ref stored-list)
9213 (assoc scol stored-list))))
9214 (if key
9215 (car ass)
9216 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9217 (cdr ass))))))
9219 (defun org-table-get-formula (&optional equation named)
9220 "Read a formula from the minibuffer, offer stored formula as default.
9221 When NAMED is non-nil, look for a named equation."
9222 (let* ((stored-list (org-table-get-stored-formulas))
9223 (name (car (rassoc (list (org-current-line)
9224 (org-table-current-column))
9225 org-table-named-field-locations)))
9226 (ref (format "@%d$%d" (org-table-current-dline)
9227 (org-table-current-column)))
9228 (refass (assoc ref stored-list))
9229 (scol (if named
9230 (if name name ref)
9231 (int-to-string (org-table-current-column))))
9232 (dummy (and (or name refass) (not named)
9233 (not (y-or-n-p "Replace field formula with column formula? " ))
9234 (error "Abort")))
9235 (name (or name ref))
9236 (org-table-may-need-update nil)
9237 (stored (cdr (assoc scol stored-list)))
9238 (eq (cond
9239 ((and stored equation (string-match "^ *=? *$" equation))
9240 stored)
9241 ((stringp equation)
9242 equation)
9243 (t (org-table-formula-from-user
9244 (read-string
9245 (org-table-formula-to-user
9246 (format "%s formula %s%s="
9247 (if named "Field" "Column")
9248 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9249 scol))
9250 (if stored (org-table-formula-to-user stored) "")
9251 'org-table-formula-history
9252 )))))
9253 mustsave)
9255 ;; remove formula
9256 (setq stored-list (delq (assoc scol stored-list) stored-list))
9257 (org-table-store-formulas stored-list)
9258 (error "Formula removed"))
9259 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9260 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9261 (if (and name (not named))
9262 ;; We set the column equation, delete the named one.
9263 (setq stored-list (delq (assoc name stored-list) stored-list)
9264 mustsave t))
9265 (if stored
9266 (setcdr (assoc scol stored-list) eq)
9267 (setq stored-list (cons (cons scol eq) stored-list)))
9268 (if (or mustsave (not (equal stored eq)))
9269 (org-table-store-formulas stored-list))
9270 eq))
9272 (defun org-table-store-formulas (alist)
9273 "Store the list of formulas below the current table."
9274 (setq alist (sort alist 'org-table-formula-less-p))
9275 (save-excursion
9276 (goto-char (org-table-end))
9278 (progn
9279 ;; don't overwrite TBLFM, we might use text properties to store stuff
9280 (goto-char (match-beginning 2))
9281 (delete-region (match-beginning 2) (match-end 0)))
9282 (insert "#+TBLFM:"))
9283 (insert " "
9284 (mapconcat (lambda (x)
9285 (concat
9286 (if (equal (string-to-char (car x)) ?@) "" "$")
9287 (car x) "=" (cdr x)))
9288 alist "::")
9291 (defsubst org-table-formula-make-cmp-string (a)
9293 (concat
9294 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9295 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9296 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9298 (defun org-table-formula-less-p (a b)
9299 "Compare two formulas for sorting."
9300 (let ((as (org-table-formula-make-cmp-string (car a)))
9301 (bs (org-table-formula-make-cmp-string (car b))))
9302 (and as bs (string< as bs))))
9304 (defun org-table-get-stored-formulas (&optional noerror)
9305 "Return an alist with the stored formulas directly after current table."
9306 (interactive)
9307 (let (scol eq eq-alist strings string seen)
9308 (save-excursion
9309 (goto-char (org-table-end))
9311 (setq strings (org-split-string (match-string 2) " *:: *"))
9312 (while (setq string (pop strings))
9313 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9314 (setq scol (if (match-end 2)
9315 (match-string 2 string)
9316 (match-string 1 string))
9317 eq (match-string 3 string)
9318 eq-alist (cons (cons scol eq) eq-alist))
9319 (if (member scol seen)
9320 (if noerror
9321 (progn
9322 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9323 (ding)
9324 (sit-for 2))
9325 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9326 (push scol seen))))))
9327 (nreverse eq-alist)))
9329 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9330 "Modify the equations after the table structure has been edited.
9332 For all numbers larger than LIMIT, shift them by DELTA."
9333 (save-excursion
9334 (goto-char (org-table-end))
9337 (re2
9338 (when remove
9339 (if (equal key "$")
9342 s n a)
9343 (when remove
9344 (while (re-search-forward re2 (point-at-eol) t)
9345 (replace-match "")))
9346 (while (re-search-forward re (point-at-eol) t)
9347 (setq s (match-string 1) n (string-to-number s))
9348 (cond
9349 ((setq a (assoc s replace))
9350 (replace-match (concat key (cdr a)) t t))
9351 ((and limit (> n limit))
9352 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9354 (defun org-table-get-specials ()
9355 "Get the column names and local parameters for this table."
9356 (save-excursion
9357 (let ((beg (org-table-begin)) (end (org-table-end))
9358 names name fields fields1 field cnt
9359 c v l line col types dlines hlines)
9360 (setq org-table-column-names nil
9361 org-table-local-parameters nil
9362 org-table-named-field-locations nil
9363 org-table-current-begin-line nil
9364 org-table-current-begin-pos nil
9365 org-table-current-line-types nil)
9366 (goto-char beg)
9368 (setq names (org-split-string (match-string 1) " *| *")
9369 cnt 1)
9370 (while (setq name (pop names))
9371 (setq cnt (1+ cnt))
9372 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9373 (push (cons name (int-to-string cnt)) org-table-column-names))))
9374 (setq org-table-column-names (nreverse org-table-column-names))
9375 (setq org-table-column-name-regexp
9377 (goto-char beg)
9379 (setq fields (org-split-string (match-string 1) " *| *"))
9380 (while (setq field (pop fields))
9382 (push (cons (match-string 1 field) (match-string 2 field))
9383 org-table-local-parameters))))
9384 (goto-char beg)
9386 (setq c (match-string 1)
9387 fields (org-split-string (match-string 2) " *| *"))
9388 (save-excursion
9389 (beginning-of-line (if (equal c "_") 2 0))
9390 (setq line (org-current-line) col 1)
9392 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9393 (while (and fields1 (setq field (pop fields)))
9394 (setq v (pop fields1) col (1+ col))
9395 (when (and (stringp field) (stringp v)
9396 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9397 (push (cons field v) org-table-local-parameters)
9398 (push (list field line col) org-table-named-field-locations))))
9399 ;; Analyse the line types
9400 (goto-char beg)
9401 (setq org-table-current-begin-line (org-current-line)
9402 org-table-current-begin-pos (point)
9403 l org-table-current-begin-line)
9405 (push (if (match-end 1) 'hline 'dline) types)
9406 (if (match-end 1) (push l hlines) (push l dlines))
9407 (beginning-of-line 2)
9408 (setq l (1+ l)))
9409 (setq org-table-current-line-types (apply 'vector (nreverse types))
9410 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9411 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9413 (defun org-table-maybe-eval-formula ()
9415 If yes, store the formula and apply it."
9416 ;; We already know we are in a table. Get field will only return a formula
9417 ;; when appropriate. It might return a separator line, but no problem.
9418 (when org-table-formula-evaluate-inline
9419 (let* ((field (org-trim (or (org-table-get-field) "")))
9420 named eq)
9422 (setq named (equal (string-to-char field) ?:)
9423 eq (match-string 1 field))
9424 (if (or (fboundp 'calc-eval)
9425 (equal (substring eq 0 (min 2 (length eq))) "'("))
9426 (org-table-eval-formula (if named '(4) nil)
9427 (org-table-formula-from-user eq))
9428 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9430 (defvar org-recalc-commands nil
9431 "List of commands triggering the recalculation of a line.
9432 Will be filled automatically during use.")
9434 (defvar org-recalc-marks
9435 '((" " . "Unmarked: no special line, no automatic recalculation")
9436 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9437 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9438 ("!" . "Column name definition line. Reference in formula as $name.")
9439 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9440 ("_" . "Names for values in row below this one.")
9441 ("^" . "Names for values in row above this one.")))
9443 (defun org-table-rotate-recalc-marks (&optional newchar)
9444 "Rotate the recalculation mark in the first column.
9445 If in any row, the first field is not consistent with a mark,
9446 insert a new column for the markers.
9447 When there is an active region, change all the lines in the region,
9448 after prompting for the marking character.
9449 After each change, a message will be displayed indicating the meaning
9450 of the new mark."
9451 (interactive)
9452 (unless (org-at-table-p) (error "Not at a table"))
9453 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9454 (beg (org-table-begin))
9455 (end (org-table-end))
9456 (l (org-current-line))
9457 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9458 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9459 (have-col
9460 (save-excursion
9461 (goto-char beg)
9463 (col (org-table-current-column))
9464 (forcenew (car (assoc newchar org-recalc-marks)))
9465 epos new)
9466 (when l1
9467 (message "Change region to what mark? Type # * ! $ or SPC: ")
9468 (setq newchar (char-to-string (read-char-exclusive))
9469 forcenew (car (assoc newchar org-recalc-marks))))
9470 (if (and newchar (not forcenew))
9471 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9472 newchar))
9473 (if l1 (goto-line l1))
9474 (save-excursion
9475 (beginning-of-line 1)
9476 (unless (looking-at org-table-dataline-regexp)
9477 (error "Not at a table data line")))
9478 (unless have-col
9479 (org-table-goto-column 1)
9480 (org-table-insert-column)
9481 (org-table-goto-column (1+ col)))
9482 (setq epos (point-at-eol))
9483 (save-excursion
9484 (beginning-of-line 1)
9485 (org-table-get-field
9487 (concat " "
9488 (setq new (or forcenew
9489 (cadr (member (match-string 1) marks))))
9490 " ")
9491 " # ")))
9492 (if (and l1 l2)
9493 (progn
9494 (goto-line l1)
9495 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9496 (and (looking-at org-table-dataline-regexp)
9497 (org-table-get-field 1 (concat " " new " "))))
9498 (goto-line l1)))
9499 (if (not (= epos (point-at-eol))) (org-table-align))
9500 (goto-line l)
9501 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
9503 (defun org-table-maybe-recalculate-line ()
9504 "Recompute the current line if marked for it, and if we haven't just done it."
9505 (interactive)
9506 (and org-table-allow-automatic-line-recalculation
9507 (not (and (memq last-command org-recalc-commands)
9508 (equal org-last-recalc-line (org-current-line))))
9509 (save-excursion (beginning-of-line 1)
9510 (looking-at org-table-auto-recalculate-regexp))
9511 (org-table-recalculate) t))
9513 (defvar org-table-formula-debug nil
9514 "Non-nil means, debug table formulas.
9516 (make-variable-buffer-local 'org-table-formula-debug)
9518 (defvar modes)
9519 (defsubst org-set-calc-mode (var &optional value)
9520 (if (stringp var)
9521 (setq var (assoc var '(("D" calc-angle-mode deg)
9522 ("R" calc-angle-mode rad)
9523 ("F" calc-prefer-frac t)
9524 ("S" calc-symbolic-mode t)))
9525 value (nth 2 var) var (nth 1 var)))
9526 (if (memq var modes)
9527 (setcar (cdr (memq var modes)) value)
9528 (cons var (cons value modes)))
9529 modes)
9531 (defun org-table-eval-formula (&optional arg equation
9532 suppress-align suppress-const
9533 suppress-store suppress-analysis)
9534 "Replace the table field value at the cursor by the result of a calculation.
9536 This function makes use of Dave Gillespie's Calc package, in my view the
9537 most exciting program ever written for GNU Emacs. So you need to have Calc
9538 installed in order to use this function.
9540 In a table, this command replaces the value in the current field with the
9542 formula, by storing it in a special line below the table. When called
9543 with a `C-u' prefix, the current field must ba a named field, and the
9544 formula is installed as valid in only this specific field.
9546 When called with two `C-u' prefixes, insert the active equation
9547 for the field back into the current field, so that it can be
9549 to check the referenced fields.
9551 When called, the command first prompts for a formula, which is read in
9552 the minibuffer. Previously entered formulas are available through the
9553 history list, and the last used formula is offered as a default.
9554 These stored formulas are adapted correctly when moving, inserting, or
9555 deleting columns with the corresponding commands.
9557 The formula can be any algebraic expression understood by the Calc package.
9558 For details, see the Org-mode manual.
9560 This function can also be called from Lisp programs and offers
9561 additional arguments: EQUATION can be the formula to apply. If this
9562 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
9563 used to speed-up recursive calls by by-passing unnecessary aligns.
9564 SUPPRESS-CONST suppresses the interpretation of constants in the
9565 formula, assuming that this has been done already outside the function.
9566 SUPPRESS-STORE means the formula should not be stored, either because
9567 it is already stored, or because it is a modified equation that should
9568 not overwrite the stored one."
9569 (interactive "P")
9570 (org-table-check-inside-data-field)
9571 (or suppress-analysis (org-table-get-specials))
9572 (if (equal arg '(16))
9573 (let ((eq (org-table-current-field-formula)))
9574 (or eq (error "No equation active for current field"))
9575 (org-table-get-field nil eq)
9576 (org-table-align)
9577 (setq org-table-may-need-update t))
9578 (let* (fields
9579 (ndown (if (integerp arg) arg 1))
9580 (org-table-automatic-realign nil)
9581 (case-fold-search nil)
9582 (down (> ndown 1))
9583 (formula (if (and equation suppress-store)
9584 equation
9585 (org-table-get-formula equation (equal arg '(4)))))
9586 (n0 (org-table-current-column))
9587 (modes (copy-sequence org-calc-default-modes))
9588 (numbers nil) ; was a variable, now fixed default
9589 (keep-empty nil)
9590 n form form0 bw fmt x ev orig c lispp literal)
9591 ;; Parse the format string. Since we have a lot of modes, this is
9592 ;; a lot of work. However, I think calc still uses most of the time.
9593 (if (string-match ";" formula)
9594 (let ((tmp (org-split-string formula ";")))
9595 (setq formula (car tmp)
9596 fmt (concat (cdr (assoc "%" org-table-local-parameters))
9597 (nth 1 tmp)))
9599 (setq c (string-to-char (match-string 1 fmt))
9600 n (string-to-number (match-string 2 fmt)))
9601 (if (= c ?p)
9602 (setq modes (org-set-calc-mode 'calc-internal-prec n))
9603 (setq modes (org-set-calc-mode
9604 'calc-float-format
9605 (list (cdr (assoc c '((?n . float) (?f . fix)
9606 (?s . sci) (?e . eng))))
9607 n))))
9608 (setq fmt (replace-match "" t t fmt)))
9609 (if (string-match "[NT]" fmt)
9610 (setq numbers (equal (match-string 0 fmt) "N")
9611 fmt (replace-match "" t t fmt)))
9612 (if (string-match "L" fmt)
9613 (setq literal t
9614 fmt (replace-match "" t t fmt)))
9615 (if (string-match "E" fmt)
9616 (setq keep-empty t
9617 fmt (replace-match "" t t fmt)))
9618 (while (string-match "[DRFS]" fmt)
9619 (setq modes (org-set-calc-mode (match-string 0 fmt)))
9620 (setq fmt (replace-match "" t t fmt)))
9622 (setq fmt nil))))
9623 (if (and (not suppress-const) org-table-formula-use-constants)
9624 (setq formula (org-table-formula-substitute-names formula)))
9625 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
9626 (while (> ndown 0)
9627 (setq fields (org-split-string
9628 (org-no-properties
9629 (buffer-substring (point-at-bol) (point-at-eol)))
9630 " *| *"))
9631 (if (eq numbers t)
9632 (setq fields (mapcar
9633 (lambda (x) (number-to-string (string-to-number x)))
9634 fields)))
9635 (setq ndown (1- ndown))
9636 (setq form (copy-sequence formula)
9637 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
9638 (if (and lispp literal) (setq lispp 'literal))
9639 ;; Check for old vertical references
9640 (setq form (org-rewrite-old-row-references form))
9641 ;; Insert complex ranges
9642 (while (string-match org-table-range-regexp form)
9643 (setq form
9644 (replace-match
9645 (save-match-data
9646 (org-table-make-reference
9647 (org-table-get-range (match-string 0 form) nil n0)
9648 keep-empty numbers lispp))
9649 t t form)))
9650 ;; Insert simple ranges
9652 (setq form
9653 (replace-match
9654 (save-match-data
9655 (org-table-make-reference
9656 (org-sublist
9657 fields (string-to-number (match-string 1 form))
9658 (string-to-number (match-string 2 form)))
9659 keep-empty numbers lispp))
9660 t t form)))
9661 (setq form0 form)
9662 ;; Insert the references to fields in same row
9664 (setq n (string-to-number (match-string 1 form))
9665 x (nth (1- (if (= n 0) n0 n)) fields))
9667 (match-string 0 form)))
9668 (setq form (replace-match
9669 (save-match-data
9670 (org-table-make-reference x nil numbers lispp))
9671 t t form)))
9673 (if lispp
9674 (setq ev (condition-case nil
9675 (eval (eval (read form)))
9676 (error "#ERROR"))
9677 ev (if (numberp ev) (number-to-string ev) ev))
9678 (or (fboundp 'calc-eval)
9679 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
9680 (setq ev (calc-eval (cons form modes)
9681 (if numbers 'num))))
9683 (when org-table-formula-debug
9684 (with-output-to-temp-buffer "*Substitution History*"
9685 (princ (format "Substitution history of formula
9686 Orig: %s
9687 $xyz-> %s
9688 @r$c-> %s
9690 (if (listp ev)
9692 (make-string (car ev) ?\-) (nth 1 ev)))
9694 ev (or fmt "NONE")
9695 (if fmt (format fmt (string-to-number ev)) ev)))))
9696 (setq bw (get-buffer-window "*Substitution History*"))
9697 (shrink-window-if-larger-than-buffer bw)
9698 (unless (and (interactive-p) (not ndown))
9699 (unless (let (inhibit-redisplay)
9700 (y-or-n-p "Debugging Formula. Continue to next? "))
9701 (org-table-align)
9702 (error "Abort"))
9703 (delete-window bw)
9704 (message "")))
9705 (if (listp ev) (setq fmt nil ev "#ERROR"))
9706 (org-table-justify-field-maybe
9707 (if fmt (format fmt (string-to-number ev)) ev))
9709 (call-interactively 'org-return)
9710 (setq ndown 0)))
9711 (and down (org-table-maybe-recalculate-line))
9712 (or suppress-align (and org-table-may-need-update
9713 (org-table-align))))))
9715 (defun org-table-put-field-property (prop value)
9716 (save-excursion
9717 (put-text-property (progn (skip-chars-backward "^|") (point))
9718 (progn (skip-chars-forward "^|") (point))
9719 prop value)))
9721 (defun org-table-get-range (desc &optional tbeg col highlight)
9722 "Get a calc vector from a column, accorting to descriptor DESC.
9723 Optional arguments TBEG and COL can give the beginning of the table and
9724 the current column, to avoid unnecessary parsing.
9725 HIGHLIGHT means, just highlight the range."
9726 (if (not (equal (string-to-char desc) ?@))
9727 (setq desc (concat "@" desc)))
9728 (save-excursion
9729 (or tbeg (setq tbeg (org-table-begin)))
9730 (or col (setq col (org-table-current-column)))
9731 (let ((thisline (org-current-line))
9732 beg end c1 c2 r1 r2 rangep tmp)
9733 (unless (string-match org-table-range-regexp desc)
9734 (error "Invalid table range specifier `%s'" desc))
9735 (setq rangep (match-end 3)
9736 r1 (and (match-end 1) (match-string 1 desc))
9737 r2 (and (match-end 4) (match-string 4 desc))
9738 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
9739 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
9741 (and c1 (setq c1 (+ (string-to-number c1)
9742 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
9743 (and c2 (setq c2 (+ (string-to-number c2)
9744 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
9745 (if (equal r1 "") (setq r1 nil))
9746 (if (equal r2 "") (setq r2 nil))
9747 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
9748 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
9749 ; (setq r2 (or r2 r1) c2 (or c2 c1))
9750 (if (not r1) (setq r1 thisline))
9751 (if (not r2) (setq r2 thisline))
9752 (if (not c1) (setq c1 col))
9753 (if (not c2) (setq c2 col))
9754 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
9755 ;; just one field
9756 (progn
9757 (goto-line r1)
9758 (while (not (looking-at org-table-dataline-regexp))
9759 (beginning-of-line 2))
9760 (prog1 (org-trim (org-table-get-field c1))
9761 (if highlight (org-table-highlight-rectangle (point) (point)))))
9762 ;; A range, return a vector
9763 ;; First sort the numbers to get a regular ractangle
9764 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
9765 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
9766 (goto-line r1)
9767 (while (not (looking-at org-table-dataline-regexp))
9768 (beginning-of-line 2))
9769 (org-table-goto-column c1)
9770 (setq beg (point))
9771 (goto-line r2)
9772 (while (not (looking-at org-table-dataline-regexp))
9773 (beginning-of-line 0))
9774 (org-table-goto-column c2)
9775 (setq end (point))
9776 (if highlight
9777 (org-table-highlight-rectangle
9779 ;; return string representation of calc vector
9780 (mapcar 'org-trim
9781 (apply 'append (org-table-copy-region beg end)))))))
9783 (defun org-table-get-descriptor-line (desc &optional cline bline table)
9784 "Analyze descriptor DESC and retrieve the corresponding line number.
9785 The cursor is currently in line CLINE, the table begins in line BLINE,
9786 and TABLE is a vector with line types."
9787 (if (string-match "^[0-9]+$" desc)
9788 (aref org-table-dlines (string-to-number desc))
9789 (setq cline (or cline (org-current-line))
9790 bline (or bline org-table-current-begin-line)
9791 table (or table org-table-current-line-types))
9792 (if (or
9794 ;; 1 2 3 4 5 6
9795 (and (not (match-end 3)) (not (match-end 6)))
9796 (and (match-end 3) (match-end 6) (not (match-end 5))))
9797 (error "invalid row descriptor `%s'" desc))
9798 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
9799 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
9800 (odir (and (match-end 5) (match-string 5 desc)))
9801 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
9802 (i (- cline bline))
9803 (rel (and (match-end 6)
9804 (or (and (match-end 1) (not (match-end 3)))
9805 (match-end 5)))))
9806 (if (and hn (not hdir))
9807 (progn
9808 (setq i 0 hdir "+")
9809 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
9810 (if (and (not hn) on (not odir))
9811 (error "should never happen");;(aref org-table-dlines on)
9812 (if (and hn (> hn 0))
9813 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
9814 (if on
9815 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
9816 (+ bline i)))))
9818 (defun org-find-row-type (table i type backwards relative n)
9819 (let ((l (length table)))
9820 (while (> n 0)
9821 (while (and (setq i (+ i (if backwards -1 1)))
9822 (>= i 0) (< i l)
9823 (not (eq (aref table i) type))
9824 (if (and relative (eq (aref table i) 'hline))
9825 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
9826 t)))
9827 (setq n (1- n)))
9828 (if (or (< i 0) (>= i l))
9829 (error "Row descriptior leads outside table")
9830 i)))
9832 (defun org-rewrite-old-row-references (s)
9833 (if (string-match "&[-+0-9I]" s)
9834 (error "Formula contains old &row reference, please rewrite using @-syntax")
9835 s))
9837 (defun org-table-make-reference (elements keep-empty numbers lispp)
9838 "Convert list ELEMENTS to something appropriate to insert into formula.
9839 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
9840 NUMBERS indicates that everything should be converted to numbers.
9841 LISPP means to return something appropriate for a Lisp list."
9842 (if (stringp elements) ; just a single val
9843 (if lispp
9844 (if (eq lispp 'literal)
9845 elements
9846 (prin1-to-string (if numbers (string-to-number elements) elements)))
9847 (if (equal elements "") (setq elements "0"))
9848 (if numbers (number-to-string (string-to-number elements)) elements))
9849 (unless keep-empty
9850 (setq elements
9851 (delq nil
9853 elements))))
9854 (setq elements (or elements '("0")))
9855 (if lispp
9856 (mapconcat
9857 (lambda (x)
9858 (if (eq lispp 'literal)
9859 x
9860 (prin1-to-string (if numbers (string-to-number x) x))))
9861 elements " ")
9862 (concat "[" (mapconcat
9863 (lambda (x)
9864 (if numbers (number-to-string (string-to-number x)) x))
9865 elements
9866 ",") "]"))))
9868 (defun org-table-recalculate (&optional all noalign)
9869 "Recalculate the current table line by applying all stored formulas.
9870 With prefix arg ALL, do this for all lines in the table."
9871 (interactive "P")
9872 (or (memq this-command org-recalc-commands)
9873 (setq org-recalc-commands (cons this-command org-recalc-commands)))
9874 (unless (org-at-table-p) (error "Not at a table"))
9875 (if (equal all '(16))
9876 (org-table-iterate)
9877 (org-table-get-specials)
9878 (let* ((eqlist (sort (org-table-get-stored-formulas)
9879 (lambda (a b) (string< (car a) (car b)))))
9880 (inhibit-redisplay (not debug-on-error))
9881 (line-re org-table-dataline-regexp)
9882 (thisline (org-current-line))
9883 (thiscol (org-table-current-column))
9884 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
9885 ;; Insert constants in all formulas
9886 (setq eqlist
9887 (mapcar (lambda (x)
9888 (setcdr x (org-table-formula-substitute-names (cdr x)))
9889 x)
9890 eqlist))
9891 ;; Split the equation list
9892 (while (setq eq (pop eqlist))
9893 (if (<= (string-to-char (car eq)) ?9)
9894 (push eq eqlnum)
9895 (push eq eqlname)))
9896 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
9897 (if all
9898 (progn
9899 (setq end (move-marker (make-marker) (1+ (org-table-end))))
9900 (goto-char (setq beg (org-table-begin)))
9901 (if (re-search-forward org-table-calculate-mark-regexp end t)
9902 ;; This is a table with marked lines, compute selected lines
9903 (setq line-re org-table-recalculate-regexp)
9904 ;; Move forward to the first non-header line
9905 (if (and (re-search-forward org-table-dataline-regexp end t)
9906 (re-search-forward org-table-hline-regexp end t)
9907 (re-search-forward org-table-dataline-regexp end t))
9908 (setq beg (match-beginning 0))
9909 nil))) ;; just leave beg where it is
9910 (setq beg (point-at-bol)
9911 end (move-marker (make-marker) (1+ (point-at-eol)))))
9912 (goto-char beg)
9913 (and all (message "Re-applying formulas to full table..."))
9915 ;; First find the named fields, and mark them untouchanble
9916 (remove-text-properties beg end '(org-untouchable t))
9917 (while (setq eq (pop eqlname))
9918 (setq name (car eq)
9919 a (assoc name org-table-named-field-locations))
9920 (and (not a)
9922 (setq a (list name
9923 (aref org-table-dlines
9924 (string-to-number (match-string 1 name)))
9925 (string-to-number (match-string 2 name)))))
9926 (when (and a (or all (equal (nth 1 a) thisline)))
9927 (message "Re-applying formula to field: %s" name)
9928 (goto-line (nth 1 a))
9929 (org-table-goto-column (nth 2 a))
9930 (push (append a (list (cdr eq))) eqlname1)
9931 (org-table-put-field-property :org-untouchable t)))
9933 ;; Now evauluate the column formulas, but skip fields covered by
9934 ;; field formulas
9935 (goto-char beg)
9936 (while (re-search-forward line-re end t)
9937 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
9938 ;; Unprotected line, recalculate
9939 (and all (message "Re-applying formulas to full table...(line %d)"
9940 (setq cnt (1+ cnt))))
9941 (setq org-last-recalc-line (org-current-line))
9942 (setq eql eqlnum)
9943 (while (setq entry (pop eql))
9944 (goto-line org-last-recalc-line)
9945 (org-table-goto-column (string-to-number (car entry)) nil 'force)
9946 (unless (get-text-property (point) :org-untouchable)
9947 (org-table-eval-formula nil (cdr entry)
9948 'noalign 'nocst 'nostore 'noanalysis)))))
9950 ;; Now evaluate the field formulas
9951 (while (setq eq (pop eqlname1))
9952 (message "Re-applying formula to field: %s" (car eq))
9953 (goto-line (nth 1 eq))
9954 (org-table-goto-column (nth 2 eq))
9955 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
9956 'nostore 'noanalysis))
9958 (goto-line thisline)
9959 (org-table-goto-column thiscol)
9960 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
9961 (or noalign (and org-table-may-need-update (org-table-align))
9962 (and all (message "Re-applying formulas to %d lines...done" cnt)))
9964 ;; back to initial position
9965 (message "Re-applying formulas...done")
9966 (goto-line thisline)
9967 (org-table-goto-column thiscol)
9968 (or noalign (and org-table-may-need-update (org-table-align))
9969 (and all (message "Re-applying formulas...done"))))))
9971 (defun org-table-iterate (&optional arg)
9972 "Recalculate the table until it does not change anymore."
9973 (interactive "P")
9974 (let ((imax (if arg (prefix-numeric-value arg) 10))
9975 (i 0)
9976 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
9977 thistbl)
9978 (catch 'exit
9979 (while (< i imax)
9980 (setq i (1+ i))
9981 (org-table-recalculate 'all)
9982 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
9983 (if (not (string= lasttbl thistbl))
9984 (setq lasttbl thistbl)
9985 (if (> i 1)
9986 (message "Convergence after %d iterations" i)
9987 (message "Table was already stable"))
9988 (throw 'exit t)))
9989 (error "No convergence after %d iterations" i))))
9991 (defun org-table-formula-substitute-names (f)
9992 "Replace $const with values in string F."
9993 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
9994 ;; First, check for column names
9995 (while (setq start (string-match org-table-column-name-regexp f start))
9996 (setq start (1+ start))
9997 (setq a (assoc (match-string 1 f) org-table-column-names))
9998 (setq f (replace-match (concat "$" (cdr a)) t t f)))
9999 ;; Parameters and constants
10000 (setq start 0)
10002 (setq start (1+ start))
10003 (if (setq a (save-match-data
10004 (org-table-get-constant (match-string 1 f))))
10005 (setq f (replace-match
10006 (concat (if pp "(") a (if pp ")")) t t f))))
10007 (if org-table-formula-debug
10008 (put-text-property 0 (length f) :orig-formula f1 f))
10009 f))
10011 (defun org-table-get-constant (const)
10012 "Find the value for a parameter or constant in a formula.
10013 Parameters get priority."
10014 (or (cdr (assoc const org-table-local-parameters))
10015 (cdr (assoc const org-table-formula-constants-local))
10016 (cdr (assoc const org-table-formula-constants))
10017 (and (fboundp 'constants-get) (constants-get const))
10018 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10019 (org-entry-get nil (substring const 5) 'inherit))
10020 "#UNDEFINED_NAME"))
10022 (defvar org-table-fedit-map
10023 (let ((map (make-sparse-keymap)))
10024 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10025 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10026 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10027 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10028 (org-defkey map "\C-c?" 'org-table-show-reference)
10029 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10030 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10031 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10032 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10033 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10034 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10035 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10036 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10037 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10038 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10039 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10040 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10041 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10042 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10043 map))
10045 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10046 '("Edit-Formulas"
10047 ["Finish and Install" org-table-fedit-finish t]
10048 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10049 ["Abort" org-table-fedit-abort t]
10050 "--"
10051 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10052 ["Complete Lisp Symbol" lisp-complete-symbol t]
10053 "--"
10054 "Shift Reference at Point"
10055 ["Up" org-table-fedit-ref-up t]
10056 ["Down" org-table-fedit-ref-down t]
10057 ["Left" org-table-fedit-ref-left t]
10058 ["Right" org-table-fedit-ref-right t]
10059 "-"
10060 "Change Test Row for Column Formulas"
10061 ["Up" org-table-fedit-line-up t]
10062 ["Down" org-table-fedit-line-down t]
10063 "--"
10064 ["Scroll Table Window" org-table-fedit-scroll t]
10065 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10066 ["Show Table Grid" org-table-fedit-toggle-coordinates
10067 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10068 org-table-overlay-coordinates)]
10069 "--"
10070 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10071 :style toggle :selected org-table-buffer-is-an]))
10073 (defvar org-pos)
10075 (defun org-table-edit-formulas ()
10076 "Edit the formulas of the current table in a separate buffer."
10077 (interactive)
10079 (beginning-of-line 0))
10080 (unless (org-at-table-p) (error "Not at a table"))
10081 (org-table-get-specials)
10082 (let ((key (org-table-current-field-formula 'key 'noerror))
10083 (eql (sort (org-table-get-stored-formulas 'noerror)
10084 'org-table-formula-less-p))
10085 (pos (move-marker (make-marker) (point)))
10086 (startline 1)
10087 (wc (current-window-configuration))
10091 entry s type title)
10092 (org-switch-to-buffer-other-window "*Edit Formulas*")
10093 (erase-buffer)
10094 ;; Keep global-font-lock-mode from turning on font-lock-mode
10095 (let ((font-lock-global-modes '(not fundamental-mode)))
10096 (fundamental-mode))
10097 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10098 (org-set-local 'org-pos pos)
10099 (org-set-local 'org-window-configuration wc)
10100 (use-local-map org-table-fedit-map)
10101 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10102 (easy-menu-add org-table-fedit-menu)
10103 (setq startline (org-current-line))
10104 (while (setq entry (pop eql))
10105 (setq type (cond
10106 ((equal (string-to-char (car entry)) ?@) 'field)
10107 ((string-match "^[0-9]" (car entry)) 'column)
10108 (t 'named)))
10109 (when (setq title (assq type titles))
10111 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10112 (setq titles (delq title titles)))
10113 (if (equal key (car entry)) (setq startline (org-current-line)))
10114 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10116 (remove-text-properties 0 (length s) '(face nil) s)
10117 (insert s))
10118 (if (eq org-table-use-standard-references t)
10119 (org-table-fedit-toggle-ref-type))
10120 (goto-line startline)
10121 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10123 (defun org-table-fedit-post-command ()
10124 (when (not (memq this-command '(lisp-complete-symbol)))
10125 (let ((win (selected-window)))
10126 (save-excursion
10127 (condition-case nil
10128 (org-table-show-reference)
10129 (error nil))
10130 (select-window win)))))
10132 (defun org-table-formula-to-user (s)
10133 "Convert a formula from internal to user representation."
10134 (if (eq org-table-use-standard-references t)
10135 (org-table-convert-refs-to-an s)
10136 s))
10138 (defun org-table-formula-from-user (s)
10139 "Convert a formula from user to internal representation."
10140 (if org-table-use-standard-references
10141 (org-table-convert-refs-to-rc s)
10142 s))
10144 (defun org-table-convert-refs-to-rc (s)
10145 "Convert spreadsheet references from AB7 to @7$28.
10146 Works for single references, but also for entire formulas and even the
10147 full TBLFM line."
10148 (let ((start 0))
10150 (cond
10151 ((match-end 3)
10152 ;; format match, just advance
10153 (setq start (match-end 0)))
10154 ((and (> (match-beginning 0) 0)
10155 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10156 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10157 ;; 3.e5 or something like this.
10158 (setq start (match-end 0)))
10159 (t
10160 (setq start (match-beginning 0)
10161 s (replace-match
10162 (if (equal (match-string 2 s) "&")
10163 (format "$%d" (org-letters-to-number (match-string 1 s)))
10164 (format "@%d$%d"
10165 (string-to-number (match-string 2 s))
10166 (org-letters-to-number (match-string 1 s))))
10167 t t s)))))
10168 s))
10170 (defun org-table-convert-refs-to-an (s)
10171 "Convert spreadsheet references from to @7$28 to AB7.
10172 Works for single references, but also for entire formulas and even the
10173 full TBLFM line."
10175 (setq s (replace-match
10176 (format "%s%d"
10177 (org-number-to-letters
10178 (string-to-number (match-string 2 s)))
10179 (string-to-number (match-string 1 s)))
10180 t t s)))
10183 (org-number-to-letters
10184 (string-to-number (match-string 2 s))) "&")
10185 t nil s)))
10186 s)
10188 (defun org-letters-to-number (s)
10189 "Convert a base 26 number represented by letters into an integer.
10190 For example: AB -> 28."
10191 (let ((n 0))
10192 (setq s (upcase s))
10193 (while (> (length s) 0)
10194 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10195 s (substring s 1)))
10196 n))
10198 (defun org-number-to-letters (n)
10199 "Convert an integer into a base 26 number represented by letters.
10200 For example: 28 -> AB."
10201 (let ((s ""))
10202 (while (> n 0)
10203 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10204 n (/ (1- n) 26)))
10205 s))
10207 (defun org-table-fedit-convert-buffer (function)
10208 "Convert all references in this buffer, using FUNTION."
10209 (let ((line (org-current-line)))
10210 (goto-char (point-min))
10211 (while (not (eobp))
10212 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10213 (delete-region (point) (point-at-eol))
10214 (or (eobp) (forward-char 1)))
10215 (goto-line line)))
10217 (defun org-table-fedit-toggle-ref-type ()
10218 "Convert all references in the buffer from B3 to @3$2 and back."
10219 (interactive)
10220 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10221 (org-table-fedit-convert-buffer
10222 (if org-table-buffer-is-an
10223 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10224 (message "Reference type switched to %s"
10225 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10227 (defun org-table-fedit-ref-up ()
10228 "Shift the reference at point one row/hline up."
10229 (interactive)
10230 (org-table-fedit-shift-reference 'up))
10231 (defun org-table-fedit-ref-down ()
10232 "Shift the reference at point one row/hline down."
10233 (interactive)
10234 (org-table-fedit-shift-reference 'down))
10235 (defun org-table-fedit-ref-left ()
10236 "Shift the reference at point one field to the left."
10237 (interactive)
10238 (org-table-fedit-shift-reference 'left))
10239 (defun org-table-fedit-ref-right ()
10240 "Shift the reference at point one field to the right."
10241 (interactive)
10242 (org-table-fedit-shift-reference 'right))
10244 (defun org-table-fedit-shift-reference (dir)
10245 (cond
10247 (if (memq dir '(left right))
10248 (org-rematch-and-replace 1 (eq dir 'left))
10249 (error "Cannot shift reference in this direction")))
10251 ;; A B3-like reference
10252 (if (memq dir '(up down))
10253 (org-rematch-and-replace 2 (eq dir 'up))
10254 (org-rematch-and-replace 1 (eq dir 'left))))
10255 ((org-at-regexp-p
10257 ;; An internal reference
10258 (if (memq dir '(up down))
10259 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10260 (org-rematch-and-replace 5 (eq dir 'left))))))
10262 (defun org-rematch-and-replace (n &optional decr hline)
10263 "Re-match the group N, and replace it with the shifted refrence."
10264 (or (match-end n) (error "Cannot shift reference in this direction"))
10265 (goto-char (match-beginning n))
10266 (and (looking-at (regexp-quote (match-string n)))
10267 (replace-match (org-shift-refpart (match-string 0) decr hline)
10268 t t)))
10270 (defun org-shift-refpart (ref &optional decr hline)
10271 "Shift a refrence part REF.
10272 If DECR is set, decrease the references row/column, else increase.
10273 If HLINE is set, this may be a hline reference, it certainly is not
10274 a translation reference."
10275 (save-match-data
10276 (let* ((sign (string-match "^[-+]" ref)) n)
10278 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10279 (cond
10280 ((and hline (string-match "^I+" ref))
10281 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10282 (setq n (+ n (if decr -1 1)))
10283 (if (= n 0) (setq n (+ n (if decr -1 1))))
10284 (if sign
10285 (setq sign (if (< n 0) "-" "+") n (abs n))
10286 (setq n (max 1 n)))
10287 (concat sign (make-string n ?I)))
10289 ((string-match "^[0-9]+" ref)
10290 (setq n (string-to-number (concat sign ref)))
10291 (setq n (+ n (if decr -1 1)))
10292 (if sign
10293 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10294 (number-to-string (max 1 n))))
10296 ((string-match "^[a-zA-Z]+" ref)
10297 (org-number-to-letters
10298 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10300 (t (error "Cannot shift reference"))))))
10302 (defun org-table-fedit-toggle-coordinates ()
10303 "Toggle the display of coordinates in the refrenced table."
10304 (interactive)
10305 (let ((pos (marker-position org-pos)))
10306 (with-current-buffer (marker-buffer org-pos)
10307 (save-excursion
10308 (goto-char pos)
10309 (org-table-toggle-coordinate-overlays)))))
10311 (defun org-table-fedit-finish (&optional arg)
10312 "Parse the buffer for formula definitions and install them.
10313 With prefix ARG, apply the new formulas to the table."
10314 (interactive "P")
10315 (org-table-remove-rectangle-highlight)
10316 (if org-table-use-standard-references
10317 (progn
10318 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10319 (setq org-table-buffer-is-an nil)))
10320 (let ((pos org-pos) eql var form)
10321 (goto-char (point-min))
10322 (while (re-search-forward
10324 nil t)
10325 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10326 form (match-string 3))
10327 (setq form (org-trim form))
10328 (when (not (equal form ""))
10330 (setq form (replace-match " " t t form)))
10331 (when (assoc var eql)
10332 (error "Double formulas for %s" var))
10333 (push (cons var form) eql)))
10334 (setq org-pos nil)
10335 (set-window-configuration org-window-configuration)
10336 (select-window (get-buffer-window (marker-buffer pos)))
10337 (goto-char pos)
10338 (unless (org-at-table-p)
10339 (error "Lost table position - cannot install formulae"))
10340 (org-table-store-formulas eql)
10341 (move-marker pos nil)
10342 (kill-buffer "*Edit Formulas*")
10343 (if arg
10344 (org-table-recalculate 'all)
10345 (message "New formulas installed - press C-u C-c C-c to apply."))))
10347 (defun org-table-fedit-abort ()
10348 "Abort editing formulas, without installing the changes."
10349 (interactive)
10350 (org-table-remove-rectangle-highlight)
10351 (let ((pos org-pos))
10352 (set-window-configuration org-window-configuration)
10353 (select-window (get-buffer-window (marker-buffer pos)))
10354 (goto-char pos)
10355 (move-marker pos nil)
10356 (message "Formula editing aborted without installing changes")))
10358 (defun org-table-fedit-lisp-indent ()
10359 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10360 (interactive)
10361 (let ((pos (point)) beg end ind)
10362 (beginning-of-line 1)
10363 (cond
10365 (goto-char pos)
10366 (call-interactively 'lisp-indent-line))
10368 ((not (fboundp 'pp-buffer))
10369 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10370 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10371 (goto-char (- (match-end 0) 2))
10372 (setq beg (point))
10373 (setq ind (make-string (current-column) ?\ ))
10374 (condition-case nil (forward-sexp 1)
10375 (error
10376 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10377 (setq end (point))
10378 (save-restriction
10379 (narrow-to-region beg end)
10380 (if (eq last-command this-command)
10381 (progn
10382 (goto-char (point-min))
10383 (setq this-command nil)
10385 (replace-match " ")))
10386 (pp-buffer)
10387 (untabify (point-min) (point-max))
10388 (goto-char (1+ (point-min)))
10389 (while (re-search-forward "^." nil t)
10390 (beginning-of-line 1)
10391 (insert ind))
10392 (goto-char (point-max))
10393 (backward-delete-char 1)))
10394 (goto-char beg))
10395 (t nil))))
10397 (defvar org-show-positions nil)
10399 (defun org-table-show-reference (&optional local)
10400 "Show the location/value of the $ expression at point."
10401 (interactive)
10402 (org-table-remove-rectangle-highlight)
10403 (catch 'exit
10404 (let ((pos (if local (point) org-pos))
10405 (face2 'highlight)
10406 (org-inhibit-highlight-removal t)
10407 (win (selected-window))
10408 (org-show-positions nil)
10409 var name e what match dest)
10410 (if local (org-table-get-specials))
10411 (setq what (cond
10412 ((or (org-at-regexp-p org-table-range-regexp2)
10413 (org-at-regexp-p org-table-translate-regexp)
10414 (org-at-regexp-p org-table-range-regexp))
10415 (setq match
10416 (save-match-data
10417 (org-table-convert-refs-to-rc (match-string 0))))
10418 'range)
10421 ((not local) nil)
10422 (t (error "No reference at point")))
10423 match (and what (or match (match-string 0))))
10424 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10425 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10426 'secondary-selection))
10427 (org-add-hook 'before-change-functions
10428 'org-table-remove-rectangle-highlight)
10429 (if (eq what 'name) (setq var (substring match 1)))
10430 (when (eq what 'range)
10431 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10432 (setq match (org-table-formula-substitute-names match)))
10433 (unless local
10434 (save-excursion
10435 (end-of-line 1)
10437 (beginning-of-line 1)
10439 (setq dest
10440 (save-match-data
10441 (org-table-convert-refs-to-rc (match-string 1))))
10442 (org-table-add-rectangle-overlay
10443 (match-beginning 1) (match-end 1) face2))))
10444 (if (and (markerp pos) (marker-buffer pos))
10445 (if (get-buffer-window (marker-buffer pos))
10446 (select-window (get-buffer-window (marker-buffer pos)))
10447 (org-switch-to-buffer-other-window (get-buffer-window
10448 (marker-buffer pos)))))
10449 (goto-char pos)
10450 (org-table-force-dataline)
10451 (when dest
10452 (setq name (substring dest 1))
10453 (cond
10455 (setq e (assoc name org-table-named-field-locations))
10456 (goto-line (nth 1 e))
10457 (org-table-goto-column (nth 2 e)))
10459 (let ((l (string-to-number (match-string 1 dest)))
10460 (c (string-to-number (match-string 2 dest))))
10461 (goto-line (aref org-table-dlines l))
10462 (org-table-goto-column c)))
10463 (t (org-table-goto-column (string-to-number name))))
10464 (move-marker pos (point))
10465 (org-table-highlight-rectangle nil nil face2))
10466 (cond
10467 ((equal dest match))
10468 ((not match))
10469 ((eq what 'range)
10470 (condition-case nil
10471 (save-excursion
10472 (org-table-get-range match nil nil 'highlight))
10473 (error nil)))
10474 ((setq e (assoc var org-table-named-field-locations))
10475 (goto-line (nth 1 e))
10476 (org-table-goto-column (nth 2 e))
10477 (org-table-highlight-rectangle (point) (point))
10478 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10479 ((setq e (assoc var org-table-column-names))
10480 (org-table-goto-column (string-to-number (cdr e)))
10481 (org-table-highlight-rectangle (point) (point))
10482 (goto-char (org-table-begin))
10484 (org-table-end) t)
10485 (progn
10486 (goto-char (match-beginning 1))
10487 (org-table-highlight-rectangle)
10488 (message "Named column (column %s)" (cdr e)))
10489 (error "Column name not found")))
10490 ((eq what 'column)
10491 ;; column number
10492 (org-table-goto-column (string-to-number (substring match 1)))
10493 (org-table-highlight-rectangle (point) (point))
10494 (message "Column %s" (substring match 1)))
10495 ((setq e (assoc var org-table-local-parameters))
10496 (goto-char (org-table-begin))
10498 (progn
10499 (goto-char (match-beginning 1))
10500 (org-table-highlight-rectangle)
10501 (message "Local parameter."))
10502 (error "Parameter not found")))
10503 (t
10504 (cond
10505 ((not var) (error "No reference at point"))
10506 ((setq e (assoc var org-table-formula-constants-local))
10507 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10508 var (cdr e)))
10509 ((setq e (assoc var org-table-formula-constants))
10510 (message "Constant: $%s=%s in `org-table-formula-constants'."
10511 var (cdr e)))
10512 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10513 (message "Constant: $%s=%s, from `constants.el'%s."
10514 var e (format " (%s units)" constants-unit-system)))
10515 (t (error "Undefined name $%s" var)))))
10516 (goto-char pos)
10517 (when (and org-show-positions
10518 (not (memq this-command '(org-table-fedit-scroll
10519 org-table-fedit-scroll-down))))
10520 (push pos org-show-positions)
10521 (push org-table-current-begin-pos org-show-positions)
10522 (let ((min (apply 'min org-show-positions))
10523 (max (apply 'max org-show-positions)))
10524 (goto-char min) (recenter 0)
10525 (goto-char max)
10526 (or (pos-visible-in-window-p max) (recenter -1))))
10527 (select-window win))))
10529 (defun org-table-force-dataline ()
10530 "Make sure the cursor is in a dataline in a table."
10531 (unless (save-excursion
10532 (beginning-of-line 1)
10533 (looking-at org-table-dataline-regexp))
10534 (let* ((re org-table-dataline-regexp)
10535 (p1 (save-excursion (re-search-forward re nil 'move)))
10536 (p2 (save-excursion (re-search-backward re nil 'move))))
10537 (cond ((and p1 p2)
10538 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10539 p1 p2)))
10540 ((or p1 p2) (goto-char (or p1 p2)))
10541 (t (error "No table dataline around here"))))))
10543 (defun org-table-fedit-line-up ()
10544 "Move cursor one line up in the window showing the table."
10545 (interactive)
10546 (org-table-fedit-move 'previous-line))
10548 (defun org-table-fedit-line-down ()
10549 "Move cursor one line down in the window showing the table."
10550 (interactive)
10551 (org-table-fedit-move 'next-line))
10553 (defun org-table-fedit-move (command)
10554 "Move the cursor in the window shoinw the table.
10555 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
10556 (let ((org-table-allow-automatic-line-recalculation nil)
10557 (pos org-pos) (win (selected-window)) p)
10558 (select-window (get-buffer-window (marker-buffer org-pos)))
10559 (setq p (point))
10560 (call-interactively command)
10561 (while (and (org-at-table-p)
10562 (org-at-table-hline-p))
10563 (call-interactively command))
10564 (or (org-at-table-p) (goto-char p))
10565 (move-marker pos (point))
10566 (select-window win)))
10568 (defun org-table-fedit-scroll (N)
10569 (interactive "p")
10570 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
10571 (scroll-other-window N)))
10573 (defun org-table-fedit-scroll-down (N)
10574 (interactive "p")
10575 (org-table-fedit-scroll (- N)))
10577 (defvar org-table-rectangle-overlays nil)
10579 (defun org-table-add-rectangle-overlay (beg end &optional face)
10580 "Add a new overlay."
10581 (let ((ov (org-make-overlay beg end)))
10582 (org-overlay-put ov 'face (or face 'secondary-selection))
10583 (push ov org-table-rectangle-overlays)))
10585 (defun org-table-highlight-rectangle (&optional beg end face)
10586 "Highlight rectangular region in a table."
10587 (setq beg (or beg (point)) end (or end (point)))
10588 (let ((b (min beg end))
10589 (e (max beg end))
10590 l1 c1 l2 c2 tmp)
10591 (and (boundp 'org-show-positions)
10592 (setq org-show-positions (cons b (cons e org-show-positions))))
10593 (goto-char (min beg end))
10594 (setq l1 (org-current-line)
10595 c1 (org-table-current-column))
10596 (goto-char (max beg end))
10597 (setq l2 (org-current-line)
10598 c2 (org-table-current-column))
10599 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
10600 (goto-line l1)
10601 (beginning-of-line 1)
10602 (loop for line from l1 to l2 do
10603 (when (looking-at org-table-dataline-regexp)
10604 (org-table-goto-column c1)
10606 (org-table-goto-column c2)
10608 (org-table-add-rectangle-overlay beg end face))
10609 (beginning-of-line 2))
10610 (goto-char b))
10611 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
10613 (defun org-table-remove-rectangle-highlight (&rest ignore)
10614 "Remove the rectangle overlays."
10615 (unless org-inhibit-highlight-removal
10616 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
10617 (mapc 'org-delete-overlay org-table-rectangle-overlays)
10618 (setq org-table-rectangle-overlays nil)))
10620 (defvar org-table-coordinate-overlays nil
10621 "Collects the cooordinate grid overlays, so that they can be removed.")
10622 (make-variable-buffer-local 'org-table-coordinate-overlays)
10624 (defun org-table-overlay-coordinates ()
10625 "Add overlays to the table at point, to show row/column coordinates."
10626 (interactive)
10627 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10628 (setq org-table-coordinate-overlays nil)
10629 (save-excursion
10630 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
10631 (goto-char (org-table-begin))
10632 (while (org-at-table-p)
10633 (setq eol (point-at-eol))
10634 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
10635 (push ov org-table-coordinate-overlays)
10636 (setq hline (looking-at org-table-hline-regexp))
10637 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
10638 (format "%4d" (setq id (1+ id)))))
10639 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
10640 (when hline
10641 (setq ic 0)
10643 (setq beg (1+ (match-beginning 0))
10644 ic (1+ ic)
10645 s1 (concat "$" (int-to-string ic))
10646 s2 (org-number-to-letters ic)
10647 str (if (eq org-table-use-standard-references t) s2 s1))
10648 (setq ov (org-make-overlay beg (+ beg (length str))))
10649 (push ov org-table-coordinate-overlays)
10650 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
10651 (beginning-of-line 2)))))
10653 (defun org-table-toggle-coordinate-overlays ()
10654 "Toggle the display of Row/Column numbers in tables."
10655 (interactive)
10656 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
10657 (message "Row/Column number display turned %s"
10658 (if org-table-overlay-coordinates "on" "off"))
10659 (if (and (org-at-table-p) org-table-overlay-coordinates)
10660 (org-table-align))
10661 (unless org-table-overlay-coordinates
10662 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10663 (setq org-table-coordinate-overlays nil)))
10665 (defun org-table-toggle-formula-debugger ()
10666 "Toggle the formula debugger in tables."
10667 (interactive)
10668 (setq org-table-formula-debug (not org-table-formula-debug))
10669 (message "Formula debugging has been turned %s"
10670 (if org-table-formula-debug "on" "off")))
10672 ;;; The orgtbl minor mode
10674 ;; Define a minor mode which can be used in other modes in order to
10675 ;; integrate the org-mode table editor.
10677 ;; This is really a hack, because the org-mode table editor uses several
10678 ;; keys which normally belong to the major mode, for example the TAB and
10679 ;; RET keys. Here is how it works: The minor mode defines all the keys
10680 ;; necessary to operate the table editor, but wraps the commands into a
10681 ;; function which tests if the cursor is currently inside a table. If that
10682 ;; is the case, the table editor command is executed. However, when any of
10683 ;; those keys is used outside a table, the function uses `key-binding' to
10684 ;; look up if the key has an associated command in another currently active
10685 ;; keymap (minor modes, major mode, global), and executes that command.
10686 ;; There might be problems if any of the keys used by the table editor is
10687 ;; otherwise used as a prefix key.
10689 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
10690 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
10691 ;; addresses this by checking explicitly for both bindings.
10693 ;; The optimized version (see variable `orgtbl-optimized') takes over
10694 ;; all keys which are bound to `self-insert-command' in the *global map*.
10695 ;; Some modes bind other commands to simple characters, for example
10696 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
10697 ;; active, this binding is ignored inside tables and replaced with a
10698 ;; modified self-insert.
10700 (defvar orgtbl-mode nil
10701 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
10702 table editor in arbitrary modes.")
10703 (make-variable-buffer-local 'orgtbl-mode)
10705 (defvar orgtbl-mode-map (make-keymap)
10706 "Keymap for `orgtbl-mode'.")
10708 ;;;###autoload
10709 (defun turn-on-orgtbl ()
10710 "Unconditionally turn on `orgtbl-mode'."
10711 (orgtbl-mode 1))
10713 (defvar org-old-auto-fill-inhibit-regexp nil
10714 "Local variable used by `orgtbl-mode'")
10717 "Matches a line belonging to an orgtbl.")
10719 (defconst orgtbl-extra-font-lock-keywords
10720 (list (list (concat "^" orgtbl-line-start-regexp ".*")
10721 0 (quote 'org-table) 'prepend))
10722 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
10724 ;;;###autoload
10725 (defun orgtbl-mode (&optional arg)
10726 "The `org-mode' table editor as a minor mode for use in other modes."
10727 (interactive)
10728 (if (org-mode-p)
10729 ;; Exit without error, in case some hook functions calls this
10730 ;; by accident in org-mode.
10731 (message "Orgtbl-mode is not useful in org-mode, command ignored")
10732 (setq orgtbl-mode
10733 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
10734 (if orgtbl-mode
10735 (progn
10736 (and (orgtbl-setup) (defun orgtbl-setup () nil))
10737 ;; Make sure we are first in minor-mode-map-alist
10738 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
10739 (and c (setq minor-mode-map-alist
10740 (cons c (delq c minor-mode-map-alist)))))
10741 (org-set-local (quote org-table-may-need-update) t)
10742 (org-add-hook 'before-change-functions 'org-before-change-function
10743 nil 'local)
10744 (org-set-local 'org-old-auto-fill-inhibit-regexp
10745 auto-fill-inhibit-regexp)
10746 (org-set-local 'auto-fill-inhibit-regexp
10747 (if auto-fill-inhibit-regexp
10749 auto-fill-inhibit-regexp)
10750 orgtbl-line-start-regexp))
10751 (org-add-to-invisibility-spec '(org-cwidth))
10752 (when (fboundp 'font-lock-add-keywords)
10753 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
10754 (org-restart-font-lock))
10755 (easy-menu-add orgtbl-mode-menu)
10756 (run-hooks 'orgtbl-mode-hook))
10757 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
10758 (org-cleanup-narrow-column-properties)
10759 (org-remove-from-invisibility-spec '(org-cwidth))
10760 (remove-hook 'before-change-functions 'org-before-change-function t)
10761 (when (fboundp 'font-lock-remove-keywords)
10762 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
10763 (org-restart-font-lock))
10764 (easy-menu-remove orgtbl-mode-menu)
10765 (force-mode-line-update 'all))))
10767 (defun org-cleanup-narrow-column-properties ()
10768 "Remove all properties related to narrow-column invisibility."
10769 (let ((s 1))
10770 (while (setq s (text-property-any s (point-max)
10771 'display org-narrow-column-arrow))
10772 (remove-text-properties s (1+ s) '(display t)))
10773 (setq s 1)
10774 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
10775 (remove-text-properties s (1+ s) '(org-cwidth t)))
10776 (setq s 1)
10777 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
10778 (remove-text-properties s (1+ s) '(invisible t)))))
10780 ;; Install it as a minor mode.
10781 (put 'orgtbl-mode :included t)
10782 (put 'orgtbl-mode :menu-tag "Org Table Mode")
10783 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
10785 (defun orgtbl-make-binding (fun n &rest keys)
10786 "Create a function for binding in the table minor mode.
10787 FUN is the command to call inside a table. N is used to create a unique
10788 command name. KEYS are keys that should be checked in for a command
10789 to execute outside of tables."
10790 (eval
10791 (list 'defun
10792 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
10793 '(arg)
10795 "Outside of tables, run the binding of `"
10796 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
10797 "'.")
10798 '(interactive "p")
10799 (list 'if
10800 '(org-at-table-p)
10801 (list 'call-interactively (list 'quote fun))
10802 (list 'let '(orgtbl-mode)
10803 (list 'call-interactively
10804 (append '(or)
10805 (mapcar (lambda (k)
10806 (list 'key-binding k))
10807 keys)
10808 '('orgtbl-error))))))))
10810 (defun orgtbl-error ()
10811 "Error when there is no default binding for a table key."
10812 (interactive)
10813 (error "This key is has no function outside tables"))
10815 (defun orgtbl-setup ()
10816 "Setup orgtbl keymaps."
10817 (let ((nfunc 0)
10818 (bindings
10819 (list
10820 '([(meta shift left)] org-table-delete-column)
10821 '([(meta left)] org-table-move-column-left)
10822 '([(meta right)] org-table-move-column-right)
10823 '([(meta shift right)] org-table-insert-column)
10824 '([(meta shift up)] org-table-kill-row)
10825 '([(meta shift down)] org-table-insert-row)
10826 '([(meta up)] org-table-move-row-up)
10827 '([(meta down)] org-table-move-row-down)
10828 '("\C-c\C-w" org-table-cut-region)
10829 '("\C-c\M-w" org-table-copy-region)
10830 '("\C-c\C-y" org-table-paste-rectangle)
10831 '("\C-c-" org-table-insert-hline)
10832 '("\C-c}" org-table-toggle-coordinate-overlays)
10833 '("\C-c{" org-table-toggle-formula-debugger)
10834 '("\C-m" org-table-next-row)
10835 '([(shift return)] org-table-copy-down)
10836 '("\C-c\C-q" org-table-wrap-region)
10837 '("\C-c?" org-table-field-info)
10838 '("\C-c " org-table-blank-field)
10839 '("\C-c+" org-table-sum)
10840 '("\C-c=" org-table-eval-formula)
10841 '("\C-c'" org-table-edit-formulas)
10842 '("\C-c`" org-table-edit-field)
10843 '("\C-c*" org-table-recalculate)
10844 '("\C-c|" org-table-create-or-convert-from-region)
10845 '("\C-c^" org-table-sort-lines)
10846 '([(control ?#)] org-table-rotate-recalc-marks)))
10847 elt key fun cmd)
10848 (while (setq elt (pop bindings))
10849 (setq nfunc (1+ nfunc))
10850 (setq key (org-key (car elt))
10851 fun (nth 1 elt)
10852 cmd (orgtbl-make-binding fun nfunc key))
10853 (org-defkey orgtbl-mode-map key cmd))
10855 ;; Special treatment needed for TAB and RET
10856 (org-defkey orgtbl-mode-map [(return)]
10857 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
10858 (org-defkey orgtbl-mode-map "\C-m"
10859 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
10861 (org-defkey orgtbl-mode-map [(tab)]
10862 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
10863 (org-defkey orgtbl-mode-map "\C-i"
10864 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
10866 (org-defkey orgtbl-mode-map [(shift tab)]
10867 (orgtbl-make-binding 'org-table-previous-field 104
10868 [(shift tab)] [(tab)] "\C-i"))
10870 (org-defkey orgtbl-mode-map "\M-\C-m"
10871 (orgtbl-make-binding 'org-table-wrap-region 105
10872 "\M-\C-m" [(meta return)]))
10873 (org-defkey orgtbl-mode-map [(meta return)]
10874 (orgtbl-make-binding 'org-table-wrap-region 106
10875 [(meta return)] "\M-\C-m"))
10877 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
10878 (when orgtbl-optimized
10879 ;; If the user wants maximum table support, we need to hijack
10880 ;; some standard editing functions
10881 (org-remap orgtbl-mode-map
10882 'self-insert-command 'orgtbl-self-insert-command
10883 'delete-char 'org-delete-char
10884 'delete-backward-char 'org-delete-backward-char)
10885 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
10886 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
10887 '("OrgTbl"
10888 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
10889 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
10890 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
10891 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
10892 "--"
10893 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
10894 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
10895 ["Copy Field from Above"
10896 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
10897 "--"
10898 ("Column"
10899 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
10900 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
10901 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
10902 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
10903 ("Row"
10904 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
10905 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
10906 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
10907 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
10908 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
10909 "--"
10910 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
10911 ("Rectangle"
10912 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
10913 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
10914 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
10915 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
10916 "--"
10917 ("Radio tables"
10918 ["Insert table template" orgtbl-insert-radio-table
10919 (assq major-mode orgtbl-radio-table-templates)]
10920 ["Comment/uncomment table" orgtbl-toggle-comment t])
10921 "--"
10922 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
10923 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
10924 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
10925 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
10926 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
10927 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
10928 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
10929 ["Sum Column/Rectangle" org-table-sum
10930 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
10931 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
10932 ["Debug Formulas"
10933 org-table-toggle-formula-debugger :active (org-at-table-p)
10934 :keys "C-c {"
10935 :style toggle :selected org-table-formula-debug]
10936 ["Show Col/Row Numbers"
10937 org-table-toggle-coordinate-overlays :active (org-at-table-p)
10938 :keys "C-c }"
10939 :style toggle :selected org-table-overlay-coordinates]
10940 ))
10941 t))
10943 (defun orgtbl-ctrl-c-ctrl-c (arg)
10944 "If the cursor is inside a table, realign the table.
10945 It it is a table to be sent away to a receiver, do it.
10946 With prefix arg, also recompute table."
10947 (interactive "P")
10948 (let ((pos (point)) action)
10949 (save-excursion
10950 (beginning-of-line 1)
10954 (cond
10955 ((integerp action)
10956 (goto-char action)
10957 (org-table-maybe-eval-formula)
10958 (if arg
10959 (call-interactively 'org-table-recalculate)
10960 (org-table-maybe-recalculate-line))
10961 (call-interactively 'org-table-align)
10962 (orgtbl-send-table 'maybe))
10963 ((eq action 'recalc)
10964 (save-excursion
10965 (beginning-of-line 1)
10967 (if (org-at-table-p)
10968 (org-call-with-arg 'org-table-recalculate t))))
10969 (t (let (orgtbl-mode)
10970 (call-interactively (key-binding "\C-c\C-c")))))))
10972 (defun orgtbl-tab (arg)
10973 "Justification and field motion for `orgtbl-mode'."
10974 (interactive "P")
10975 (if arg (org-table-edit-field t)
10976 (org-table-justify-field-maybe)
10977 (org-table-next-field)))
10979 (defun orgtbl-ret ()
10980 "Justification and field motion for `orgtbl-mode'."
10981 (interactive)
10982 (org-table-justify-field-maybe)
10983 (org-table-next-row))
10985 (defun orgtbl-self-insert-command (N)
10986 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
10987 If the cursor is in a table looking at whitespace, the whitespace is
10988 overwritten, and the table is not marked as requiring realignment."
10989 (interactive "p")
10990 (if (and (org-at-table-p)
10991 (or
10992 (and org-table-auto-blank-field
10993 (member last-command
10994 '(orgtbl-hijacker-command-100
10995 orgtbl-hijacker-command-101
10996 orgtbl-hijacker-command-102
10997 orgtbl-hijacker-command-103
10998 orgtbl-hijacker-command-104
10999 orgtbl-hijacker-command-105))
11000 (org-table-blank-field))
11001 t)
11002 (eq N 1)
11004 (let (org-table-may-need-update)
11005 (goto-char (1- (match-end 0)))
11006 (delete-backward-char 1)
11007 (goto-char (match-beginning 0))
11008 (self-insert-command N))
11009 (setq org-table-may-need-update t)
11010 (let (orgtbl-mode)
11011 (call-interactively (key-binding (vector last-input-event))))))
11013 (defun org-force-self-insert (N)
11014 "Needed to enforce self-insert under remapping."
11015 (interactive "p")
11016 (self-insert-command N))
11019 "Regula expression matching exponentials as produced by calc.")
11021 (defvar org-table-clean-did-remove-column nil)
11023 (defun orgtbl-export (table target)
11024 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11026 org-table-last-alignment org-table-last-column-widths
11027 maxcol column)
11028 (if (not (fboundp func))
11029 (error "Cannot export orgtbl table to %s" target))
11030 (setq lines (org-table-clean-before-export lines))
11031 (setq table
11032 (mapcar
11033 (lambda (x)
11034 (if (string-match org-table-hline-regexp x)
11035 'hline
11037 lines))
11038 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11039 table)))
11040 (loop for i from (1- maxcol) downto 0 do
11041 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11042 (setq column (delq nil column))
11043 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11044 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
11045 (funcall func table nil)))
11047 (defun orgtbl-send-table (&optional maybe)
11048 "Send a tranformed version of this table to the receiver position.
11049 With argument MAYBE, fail quietly if no transformation is defined for
11050 this table."
11051 (interactive)
11052 (catch 'exit
11053 (unless (org-at-table-p) (error "Not at a table"))
11054 ;; when non-interactive, we assume align has just happened.
11055 (when (interactive-p) (org-table-align))
11056 (save-excursion
11057 (goto-char (org-table-begin))
11058 (beginning-of-line 0)
11060 (if maybe
11061 (throw 'exit nil)
11062 (error "Don't know how to transform this table."))))
11063 (let* ((name (match-string 1))
11064 beg
11065 (transform (intern (match-string 2)))
11066 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11067 (skip (plist-get params :skip))
11068 (skipcols (plist-get params :skipcols))
11069 (txt (buffer-substring-no-properties
11070 (org-table-begin) (org-table-end)))
11072 (lines (org-table-clean-before-export lines))
11073 (i0 (if org-table-clean-did-remove-column 2 1))
11074 (table (mapcar
11075 (lambda (x)
11076 (if (string-match org-table-hline-regexp x)
11077 'hline
11078 (org-remove-by-index
11080 skipcols i0)))
11081 lines))
11082 (fun (if (= i0 2) 'cdr 'identity))
11083 (org-table-last-alignment
11084 (org-remove-by-index (funcall fun org-table-last-alignment)
11085 skipcols i0))
11086 (org-table-last-column-widths
11087 (org-remove-by-index (funcall fun org-table-last-column-widths)
11088 skipcols i0)))
11090 (unless (fboundp transform)
11091 (error "No such transformation function %s" transform))
11092 (setq txt (funcall transform table params))
11093 ;; Find the insertion place
11094 (save-excursion
11095 (goto-char (point-min))
11096 (unless (re-search-forward
11098 (error "Don't know where to insert translated table"))
11099 (goto-char (match-beginning 0))
11100 (beginning-of-line 2)
11101 (setq beg (point))
11102 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11103 (error "Cannot find end of insertion region"))
11104 (beginning-of-line 1)
11105 (delete-region beg (point))
11106 (goto-char beg)
11108 (message "Table converted and installed at receiver location"))))
11110 (defun org-remove-by-index (list indices &optional i0)
11111 "Remove the elements in LIST with indices in INDICES.
11112 First element has index 0, or I0 if given."
11113 (if (not indices)
11114 list
11115 (if (integerp indices) (setq indices (list indices)))
11116 (setq i0 (1- (or i0 0)))
11117 (delq :rm (mapcar (lambda (x)
11118 (setq i0 (1+ i0))
11119 (if (memq i0 indices) :rm x))
11120 list))))
11122 (defun orgtbl-toggle-comment ()
11123 "Comment or uncomment the orgtbl at point."
11124 (interactive)
11125 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11126 (re2 (concat "^" orgtbl-line-start-regexp))
11127 (commented (save-excursion (beginning-of-line 1)
11128 (cond ((looking-at re1) t)
11129 ((looking-at re2) nil)
11130 (t (error "Not at an org table")))))
11131 (re (if commented re1 re2))
11132 beg end)
11133 (save-excursion
11134 (beginning-of-line 1)
11135 (while (looking-at re) (beginning-of-line 0))
11136 (beginning-of-line 2)
11137 (setq beg (point))
11138 (while (looking-at re) (beginning-of-line 2))
11139 (setq end (point)))
11140 (comment-region beg end (if commented '(4) nil))))
11142 (defun orgtbl-insert-radio-table ()
11143 "Insert a radio table template appropriate for this major mode."
11144 (interactive)
11145 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11146 (txt (nth 1 e))
11147 name pos)
11148 (unless e (error "No radio table setup defined for %s" major-mode))
11149 (setq name (read-string "Table name: "))
11150 (while (string-match "%n" txt)
11151 (setq txt (replace-match name t t txt)))
11153 (setq pos (point))
11154 (insert txt)
11155 (goto-char pos)))
11157 (defun org-get-param (params header i sym &optional hsym)
11158 "Get parameter value for symbol SYM.
11159 If this is a header line, actually get the value for the symbol with an
11161 If the value is a protperty list, get the element for the current column.
11162 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11163 (let ((val (plist-get params sym)))
11164 (and hsym header (setq val (or (plist-get params hsym) val)))
11165 (if (consp val) (plist-get val i) val)))
11167 (defun orgtbl-to-generic (table params)
11168 "Convert the orgtbl-mode TABLE to some other format.
11169 This generic routine can be used for many standard cases.
11170 TABLE is a list, each entry either the symbol `hline' for a horizontal
11171 separator line, or a list of fields for that line.
11172 PARAMS is a property list of parameters that can influence the conversion.
11173 For the generic converter, some parameters are obligatory: You need to
11174 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11175 :splice, you must have :tstart and :tend.
11177 Valid parameters are
11179 :tstart String to start the table. Ignored when :splice is t.
11180 :tend String to end the table. Ignored when :splice is t.
11182 :splice When set to t, return only table body lines, don't wrap
11183 them into :tstart and :tend. Default is nil.
11185 :hline String to be inserted on horizontal separation lines.
11186 May be nil to ignore hlines.
11188 :lstart String to start a new table line.
11189 :lend String to end a table line
11190 :sep Separator between two fields
11191 :lfmt Format for entire line, with enough %s to capture all fields.
11192 If this is present, :lstart, :lend, and :sep are ignored.
11193 :fmt A format to be used to wrap the field, should contain
11194 %s for the original field value. For example, to wrap
11196 This may also be a property list with column numbers and
11199 :hlstart :hlend :hlsep :hlfmt :hfmt
11200 Same as above, specific for the header lines in the table.
11201 All lines before the first hline are treated as header.
11202 If any of these is not present, the data line value is used.
11204 :efmt Use this format to print numbers with exponentials.
11205 The format should have %s twice for inserting mantissa
11207 may also be a property list with column numbers and
11208 formats. :fmt will still be applied after :efmt.
11210 In addition to this, the parameters :skip and :skipcols are always handled
11211 directly by `orgtbl-send-table'. See manual."
11212 (interactive)
11213 (let* ((p params)
11214 (splicep (plist-get p :splice))
11215 (hline (plist-get p :hline))
11216 rtn line i fm efm lfmt h)
11218 ;; Do we have a header?
11219 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11220 (setq h t))
11222 ;; Put header
11223 (unless splicep
11224 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11226 ;; Now loop over all lines
11227 (while (setq line (pop table))
11228 (if (eq line 'hline)
11229 ;; A horizontal separator line
11230 (progn (if hline (push hline rtn))
11231 (setq h nil)) ; no longer in header
11232 ;; A normal line. Convert the fields, push line onto the result list
11233 (setq i 0)
11234 (setq line
11235 (mapcar
11236 (lambda (f)
11237 (setq i (1+ i)
11238 fm (org-get-param p h i :fmt :hfmt)
11239 efm (org-get-param p h i :efmt))
11240 (if (and efm (string-match orgtbl-exp-regexp f))
11241 (setq f (format
11242 efm (match-string 1 f) (match-string 2 f))))
11243 (if fm (setq f (format fm f)))
11244 f)
11245 line))
11246 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11247 (push (apply 'format lfmt line) rtn)
11248 (push (concat
11249 (org-get-param p h i :lstart :hlstart)
11250 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11251 (org-get-param p h i :lend :hlend))
11252 rtn))))
11254 (unless splicep
11255 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11259 (defun orgtbl-to-latex (table params)
11260 "Convert the orgtbl-mode TABLE to LaTeX.
11261 TABLE is a list, each entry either the symbol `hline' for a horizontal
11262 separator line, or a list of fields for that line.
11263 PARAMS is a property list of parameters that can influence the conversion.
11264 Supports all parameters from `orgtbl-to-generic'. Most important for
11265 LaTeX are:
11267 :splice When set to t, return only table body lines, don't wrap
11268 them into a tabular environment. Default is nil.
11270 :fmt A format to be used to wrap the field, should contain %s for the
11271 original field value. For example, to wrap everything in dollars,
11275 :efmt Format for transforming numbers with exponentials. The format
11276 should have %s twice for inserting mantissa and exponent, for
11278 This may also be a property list with column numbers and formats.
11280 The general parameters :skip and :skipcols have already been applied when
11281 this function is called."
11282 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11283 org-table-last-alignment ""))
11284 (params2
11285 (list
11290 (orgtbl-to-generic table (org-combine-plists params2 params))))
11292 (defun orgtbl-to-html (table params)
11293 "Convert the orgtbl-mode TABLE to LaTeX.
11294 TABLE is a list, each entry either the symbol `hline' for a horizontal
11295 separator line, or a list of fields for that line.
11296 PARAMS is a property list of parameters that can influence the conversion.
11297 Currently this function recognizes the following parameters:
11299 :splice When set to t, return only table body lines, don't wrap
11300 them into a <table> environment. Default is nil.
11302 The general parameters :skip and :skipcols have already been applied when
11303 this function is called. The function does *not* use `orgtbl-to-generic',
11304 so you cannot specify parameters for it."
11305 (let* ((splicep (plist-get params :splice))
11306 html)
11307 ;; Just call the formatter we already have
11308 ;; We need to make text lines for it, so put the fields back together.
11309 (setq html (org-format-org-table-html
11310 (mapcar
11311 (lambda (x)
11312 (if (eq x 'hline)
11313 "|----+----|"
11314 (concat "| " (mapconcat 'identity x " | ") " |")))
11315 table)
11316 splicep))
11318 (setq html (replace-match "" t t html)))
11319 html))
11321 (defun orgtbl-to-texinfo (table params)
11322 "Convert the orgtbl-mode TABLE to TeXInfo.
11323 TABLE is a list, each entry either the symbol `hline' for a horizontal
11324 separator line, or a list of fields for that line.
11325 PARAMS is a property list of parameters that can influence the conversion.
11326 Supports all parameters from `orgtbl-to-generic'. Most important for
11327 TeXInfo are:
11329 :splice nil/t When set to t, return only table body lines, don't wrap
11330 them into a multitable environment. Default is nil.
11332 :fmt fmt A format to be used to wrap the field, should contain
11333 %s for the original field value. For example, to wrap
11335 This may also be a property list with column numbers and
11339 are computed automatically from the width of the columns
11340 under org-mode.
11342 The general parameters :skip and :skipcols have already been applied when
11343 this function is called."
11344 (let* ((total (float (apply '+ org-table-last-column-widths)))
11345 (colfrac (or (plist-get params :cf)
11346 (mapconcat
11347 (lambda (x) (format "%.3f" (/ (float x) total)))
11348 org-table-last-column-widths " ")))
11349 (params2
11350 (list
11351 :tstart (concat "@multitable @columnfractions " colfrac)
11352 :tend "@end multitable"
11353 :lstart "@item " :lend "" :sep " @tab "
11354 :hlstart "@headitem ")))
11355 (orgtbl-to-generic table (org-combine-plists params2 params))))
11357 ;;;; Link Stuff
11359 ;;; Link abbreviations
11361 (defun org-link-expand-abbrev (link)
11362 "Apply replacements as defined in `org-link-abbrev-alist."
11364 (let* ((key (match-string 1 link))
11365 (as (or (assoc key org-link-abbrev-alist-local)
11366 (assoc key org-link-abbrev-alist)))
11367 (tag (and (match-end 2) (match-string 3 link)))
11368 rpl)
11369 (if (not as)
11370 link
11371 (setq rpl (cdr as))
11372 (cond
11373 ((symbolp rpl) (funcall rpl tag))
11374 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11375 (t (concat rpl tag)))))
11376 link))
11378 ;;; Storing and inserting links
11380 (defvar org-insert-link-history nil
11381 "Minibuffer history for links inserted with `org-insert-link'.")
11383 (defvar org-stored-links nil
11384 "Contains the links stored with `org-store-link'.")
11386 (defvar org-store-link-plist nil
11387 "Plist with info about the most recently link created with `org-store-link'.")
11389 (defvar org-link-protocols nil
11390 "Link protocols added to Org-mode using `org-add-link-type'.")
11392 (defvar org-store-link-functions nil
11393 "List of functions that are called to create and store a link.
11394 Each function will be called in turn until one returns a non-nil
11395 value. Each function should check if it is responsible for creating
11396 this link (for example by looking at the major mode).
11397 If not, it must exit and return nil.
11398 If yes, it should return a non-nil value after a calling
11399 `org-store-link-props' with a list of properties and values.
11400 Special properties are:
11404 This is obligatory as well.
11405 :description Optional default description for the second pair
11406 of brackets in an Org-mode link. The user can still change
11407 this when inserting this link into an Org-mode buffer.
11409 In addition to these, any additional properties can be specified
11410 and then used in remember templates.")
11412 (defun org-add-link-type (type &optional follow publish)
11413 "Add TYPE to the list of `org-link-types'.
11414 Re-compute all regular expressions depending on `org-link-types'
11415 FOLLOW and PUBLISH are two functions. Both take the link path as
11416 an argument.
11417 FOLLOW should do whatever is necessary to follow the link, for example
11418 to find a file or display a mail message.
11420 PUBLISH takes the path and retuns the string that should be used when
11421 this document is published. FIMXE: This is actually not yet implemented."
11422 (add-to-list 'org-link-types type t)
11423 (org-make-link-regexps)
11424 (add-to-list 'org-link-protocols
11425 (list type follow publish)))
11427 (defun org-add-agenda-custom-command (entry)
11428 "Replace or add a command in `org-agenda-custom-commands'.
11429 This is mostly for hacking and trying a new command - once the command
11430 works you probably want to add it to `org-agenda-custom-commands' for good."
11431 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11432 (if ass
11433 (setcdr ass (cdr entry))
11434 (push entry org-agenda-custom-commands))))
11436 ;;;###autoload
11437 (defun org-store-link (arg)
11439 This link can later be inserted into an org-buffer with
11441 For some link types, a prefix arg is interpreted:
11442 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11443 For file links, arg negates `org-context-in-file-links'."
11444 (interactive "P")
11445 (setq org-store-link-plist nil) ; reset
11446 (let (link cpltxt desc description search txt)
11447 (cond
11449 ((run-hook-with-args-until-success 'org-store-link-functions)
11450 (setq link (plist-get org-store-link-plist :link)
11451 desc (or (plist-get org-store-link-plist :description) link)))
11453 ((eq major-mode 'bbdb-mode)
11454 (let ((name (bbdb-record-name (bbdb-current-record)))
11455 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11456 (setq cpltxt (concat "bbdb:" (or name company))
11457 link (org-make-link cpltxt))
11458 (org-store-link-props :type "bbdb" :name name :company company)))
11460 ((eq major-mode 'Info-mode)
11461 (setq link (org-make-link "info:"
11462 (file-name-nondirectory Info-current-file)
11463 ":" Info-current-node))
11464 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11465 ":" Info-current-node))
11466 (org-store-link-props :type "info" :file Info-current-file
11467 :node Info-current-node))
11469 ((eq major-mode 'calendar-mode)
11470 (let ((cd (calendar-cursor-to-date)))
11471 (setq link
11472 (format-time-string
11473 (car org-time-stamp-formats)
11474 (apply 'encode-time
11475 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11476 nil nil nil))))
11477 (org-store-link-props :type "calendar" :date cd)))
11479 ((or (eq major-mode 'vm-summary-mode)
11480 (eq major-mode 'vm-presentation-mode))
11481 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11482 (vm-follow-summary-cursor)
11483 (save-excursion
11484 (vm-select-folder-buffer)
11485 (let* ((message (car vm-message-pointer))
11486 (folder buffer-file-name)
11487 (subject (vm-su-subject message))
11488 (to (vm-get-header-contents message "To"))
11489 (from (vm-get-header-contents message "From"))
11490 (message-id (vm-su-message-id message)))
11491 (org-store-link-props :type "vm" :from from :to to :subject subject
11492 :message-id message-id)
11493 (setq message-id (org-remove-angle-brackets message-id))
11494 (setq folder (abbreviate-file-name folder))
11495 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11496 folder)
11497 (setq folder (replace-match "" t t folder)))
11498 (setq cpltxt (org-email-link-description))
11499 (setq link (org-make-link "vm:" folder "#" message-id)))))
11501 ((eq major-mode 'wl-summary-mode)
11502 (let* ((msgnum (wl-summary-message-number))
11503 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11504 msgnum 'message-id))
11505 (wl-message-entity
11506 (if (fboundp 'elmo-message-entity)
11507 (elmo-message-entity
11508 wl-summary-buffer-elmo-folder msgnum)
11509 (elmo-msgdb-overview-get-entity
11510 msgnum (wl-summary-buffer-msgdb))))
11511 (from (wl-summary-line-from))
11512 (to (elmo-message-entity-field wl-message-entity 'to))
11513 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11514 (wl-summary-line-subject))))
11515 (org-store-link-props :type "wl" :from from :to to
11516 :subject subject :message-id message-id)
11517 (setq message-id (org-remove-angle-brackets message-id))
11518 (setq cpltxt (org-email-link-description))
11519 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11520 "#" message-id))))
11522 ((or (equal major-mode 'mh-folder-mode)
11523 (equal major-mode 'mh-show-mode))
11524 (let ((from (org-mhe-get-header "From:"))
11525 (to (org-mhe-get-header "To:"))
11526 (message-id (org-mhe-get-header "Message-Id:"))
11527 (subject (org-mhe-get-header "Subject:")))
11528 (org-store-link-props :type "mh" :from from :to to
11529 :subject subject :message-id message-id)
11530 (setq cpltxt (org-email-link-description))
11531 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11532 (org-remove-angle-brackets message-id)))))
11534 ((eq major-mode 'rmail-mode)
11535 (save-excursion
11536 (save-restriction
11537 (rmail-narrow-to-non-pruned-header)
11538 (let ((folder buffer-file-name)
11539 (message-id (mail-fetch-field "message-id"))
11540 (from (mail-fetch-field "from"))
11541 (to (mail-fetch-field "to"))
11542 (subject (mail-fetch-field "subject")))
11543 (org-store-link-props
11544 :type "rmail" :from from :to to
11545 :subject subject :message-id message-id)
11546 (setq message-id (org-remove-angle-brackets message-id))
11547 (setq cpltxt (org-email-link-description))
11548 (setq link (org-make-link "rmail:" folder "#" message-id))))))
11550 ((eq major-mode 'gnus-group-mode)
11551 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
11552 (gnus-group-group-name)) ; version
11553 ((fboundp 'gnus-group-name)
11554 (gnus-group-name))
11555 (t "???"))))
11556 (unless group (error "Not on a group"))
11557 (org-store-link-props :type "gnus" :group group)
11558 (setq cpltxt (concat
11559 (if (org-xor arg org-usenet-links-prefer-google)
11560 "http://groups.google.com/groups?group="
11561 "gnus:")
11562 group)
11563 link (org-make-link cpltxt))))
11565 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
11566 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
11567 (let* ((group gnus-newsgroup-name)
11568 (article (gnus-summary-article-number))
11569 (header (gnus-summary-article-header article))
11570 (from (mail-header-from header))
11571 (message-id (mail-header-id header))
11572 (date (mail-header-date header))
11573 (subject (gnus-summary-subject-string)))
11574 (org-store-link-props :type "gnus" :from from :subject subject
11575 :message-id message-id :group group)
11576 (setq cpltxt (org-email-link-description))
11577 (if (org-xor arg org-usenet-links-prefer-google)
11578 (setq link
11579 (concat
11581 (format "http://groups.google.com/groups?as_umsgid=%s"
11582 (org-fixup-message-id-for-http message-id))))
11583 (setq link (org-make-link "gnus:" group
11584 "#" (number-to-string article))))))
11586 ((eq major-mode 'w3-mode)
11587 (setq cpltxt (url-view-url t)
11588 link (org-make-link cpltxt))
11589 (org-store-link-props :type "w3" :url (url-view-url t)))
11591 ((eq major-mode 'w3m-mode)
11592 (setq cpltxt (or w3m-current-title w3m-current-url)
11593 link (org-make-link w3m-current-url))
11594 (org-store-link-props :type "w3m" :url (url-view-url t)))
11596 ((setq search (run-hook-with-args-until-success
11597 'org-create-file-search-functions))
11598 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
11599 "::" search))
11600 (setq cpltxt (or description link)))
11602 ((eq major-mode 'image-mode)
11603 (setq cpltxt (concat "file:"
11604 (abbreviate-file-name buffer-file-name))
11605 link (org-make-link cpltxt))
11606 (org-store-link-props :type "image" :file buffer-file-name))
11608 ((eq major-mode 'dired-mode)
11609 ;; link to the file in the current line
11610 (setq cpltxt (concat "file:"
11611 (abbreviate-file-name
11612 (expand-file-name
11613 (dired-get-filename nil t))))
11614 link (org-make-link cpltxt)))
11616 ((and buffer-file-name (org-mode-p))
11617 ;; Just link to current headline
11618 (setq cpltxt (concat "file:"
11619 (abbreviate-file-name buffer-file-name)))
11620 ;; Add a context search string
11621 (when (org-xor org-context-in-file-links arg)
11622 ;; Check if we are on a target
11624 (setq cpltxt (concat cpltxt "::" (match-string 1)))
11625 (setq txt (cond
11626 ((org-on-heading-p) nil)
11627 ((org-region-active-p)
11628 (buffer-substring (region-beginning) (region-end)))
11629 (t (buffer-substring (point-at-bol) (point-at-eol)))))
11631 (setq cpltxt
11632 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11633 desc "NONE"))))
11635 (setq cpltxt (substring cpltxt 0 -2)))
11636 (setq link (org-make-link cpltxt)))
11638 ((buffer-file-name (buffer-base-buffer))
11639 ;; Just link to this file here.
11640 (setq cpltxt (concat "file:"
11641 (abbreviate-file-name
11642 (buffer-file-name (buffer-base-buffer)))))
11643 ;; Add a context string
11644 (when (org-xor org-context-in-file-links arg)
11645 (setq txt (if (org-region-active-p)
11646 (buffer-substring (region-beginning) (region-end))
11647 (buffer-substring (point-at-bol) (point-at-eol))))
11648 ;; Only use search option if there is some text.
11650 (setq cpltxt
11651 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11652 desc "NONE")))
11653 (setq link (org-make-link cpltxt)))
11655 ((interactive-p)
11656 (error "Cannot link to a buffer which is not visiting a file"))
11658 (t (setq link nil)))
11660 (if (consp link) (setq cpltxt (car link) link (cdr link)))
11661 (setq link (or link cpltxt)
11662 desc (or desc cpltxt))
11663 (if (equal desc "NONE") (setq desc nil))
11665 (if (and (interactive-p) link)
11666 (progn
11667 (setq org-stored-links
11668 (cons (list link desc) org-stored-links))
11669 (message "Stored: %s" (or desc link)))
11670 (and link (org-make-link-string link desc)))))
11672 (defun org-store-link-props (&rest plist)
11673 "Store link properties, extract names and addresses."
11674 (let (x adr)
11675 (when (setq x (plist-get plist :from))
11676 (setq adr (mail-extract-address-components x))
11677 (plist-put plist :fromname (car adr))
11678 (plist-put plist :fromaddress (nth 1 adr)))
11679 (when (setq x (plist-get plist :to))
11680 (setq adr (mail-extract-address-components x))
11681 (plist-put plist :toname (car adr))
11682 (plist-put plist :toaddress (nth 1 adr))))
11683 (let ((from (plist-get plist :from))
11684 (to (plist-get plist :to)))
11685 (when (and from to org-from-is-user-regexp)
11686 (plist-put plist :fromto
11687 (if (string-match org-from-is-user-regexp from)
11688 (concat "to %t")
11689 (concat "from %f")))))
11690 (setq org-store-link-plist plist))
11692 (defun org-email-link-description (&optional fmt)
11693 "Return the description part of an email link.
11694 This takes information from `org-store-link-plist' and formats it
11695 according to FMT (default from `org-email-link-description-format')."
11696 (setq fmt (or fmt org-email-link-description-format))
11697 (let* ((p org-store-link-plist)
11698 (to (plist-get p :toaddress))
11699 (from (plist-get p :fromaddress))
11700 (table
11701 (list
11702 (cons "%c" (plist-get p :fromto))
11703 (cons "%F" (plist-get p :from))
11704 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
11705 (cons "%T" (plist-get p :to))
11706 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
11707 (cons "%s" (plist-get p :subject))
11708 (cons "%m" (plist-get p :message-id)))))
11709 (when (string-match "%c" fmt)
11710 ;; Check if the user wrote this message
11711 (if (and org-from-is-user-regexp from to
11712 (save-match-data (string-match org-from-is-user-regexp from)))
11713 (setq fmt (replace-match "to %t" t t fmt))
11714 (setq fmt (replace-match "from %f" t t fmt))))
11715 (org-replace-escapes fmt table)))
11717 (defun org-make-org-heading-search-string (&optional string heading)
11718 "Make search string for STRING or current headline."
11719 (interactive)
11720 (let ((s (or string (org-get-heading))))
11721 (unless (and string (not heading))
11722 ;; We are using a headline, clean up garbage in there.
11723 (if (string-match org-todo-regexp s)
11724 (setq s (replace-match "" t t s)))
11726 (setq s (replace-match "" t t s)))
11727 (setq s (org-trim s))
11730 (setq s (replace-match "" t t s)))
11731 (while (string-match org-ts-regexp s)
11732 (setq s (replace-match "" t t s))))
11734 (setq s (replace-match " " t t s)))
11735 (or string (setq s (concat "*" s))) ; Add * for headlines
11738 (defun org-make-link (&rest strings)
11739 "Concatenate STRINGS."
11740 (apply 'concat strings))
11742 (defun org-make-link-string (link &optional description)
11743 "Make a link with brackets, consisting of LINK and DESCRIPTION."
11745 (error "Empty link"))
11746 (when (stringp description)
11747 ;; Remove brackets from the description, they are fatal.
11749 (setq description (replace-match "" t t description))))
11750 (when (equal (org-link-escape link) description)
11751 ;; No description needed, it is identical
11752 (setq description nil))
11753 (when (and (not description)
11754 (not (equal link (org-link-escape link))))
11755 (setq description link))
11756 (concat "[[" (org-link-escape link) "]"
11757 (if description (concat "[" description "]") "")
11758 "]"))
11760 (defconst org-link-escape-chars
11761 '((?\ . "%20")
11762 (?\[ . "%5B")
11763 (?\] . "%5d")
11774 (?\; . "%3B")
11775 (?? . "%3F")
11776 (?= . "%3D")
11777 (?+ . "%2B")
11778 )
11779 "Association list of escapes for some characters problematic in links.
11780 This is the list that is used for internal purposes.")
11782 (defconst org-link-escape-chars-browser
11783 '((?\ . "%20")) ; 32 for the SPC char
11785 "Association list of escapes for some characters problematic in links.
11786 This is the list that is used before handing over to the browser.")
11788 (defun org-link-escape (text &optional table)
11789 "Escape charaters in TEXT that are problematic for links."
11790 (setq table (or table org-link-escape-chars))
11791 (when text
11792 (let ((re (mapconcat (lambda (x) (regexp-quote
11793 (char-to-string (car x))))
11795 (while (string-match re text)
11796 (setq text
11797 (replace-match
11798 (cdr (assoc (string-to-char (match-string 0 text))
11799 table))
11800 t t text)))
11801 text)))
11803 (defun org-link-unescape (text &optional table)
11804 "Reverse the action of `org-link-escape'."
11805 (setq table (or table org-link-escape-chars))
11806 (when text
11807 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
11809 (while (string-match re text)
11810 (setq text
11811 (replace-match
11812 (char-to-string (car (rassoc (match-string 0 text) table)))
11813 t t text)))
11814 text)))
11816 (defun org-xor (a b)
11817 "Exclusive or."
11818 (if a (not b) b))
11820 (defun org-get-header (header)
11821 "Find a header field in the current buffer."
11822 (save-excursion
11823 (goto-char (point-min))
11824 (let ((case-fold-search t) s)
11825 (cond
11826 ((eq header 'from)
11828 (setq s (match-string 1)))
11830 (setq s (replace-match "" t t s)))
11831 (if (string-match "[<(].*" s)
11832 (setq s (replace-match "" t t s))))
11833 ((eq header 'message-id)
11835 (setq s (match-string 1))))
11836 ((eq header 'subject)
11838 (setq s (match-string 1)))))
11841 s)))
11844 (defun org-fixup-message-id-for-http (s)
11845 "Replace special characters in a message id, so it can be used in an http query."
11846 (while (string-match "<" s)
11847 (setq s (replace-match "%3C" t t s)))
11848 (while (string-match ">" s)
11849 (setq s (replace-match "%3E" t t s)))
11850 (while (string-match "@" s)
11851 (setq s (replace-match "%40" t t s)))
11852 s)
11854 ;;;###autoload
11855 (defun org-insert-link-global ()
11856 "Insert a link like Org-mode does.
11857 This command can be called in any mode to insert a link in Org-mode syntax."
11858 (interactive)
11859 (org-run-like-in-org-mode 'org-insert-link))
11861 (defun org-insert-link (&optional complete-file)
11862 "Insert a link. At the prompt, enter the link.
11864 Completion can be used to select a link previously stored with
11865 `org-store-link'. When the empty string is entered (i.e. if you just
11866 press RET at the prompt), the link defaults to the most recently
11867 stored link. As SPC triggers completion in the minibuffer, you need to
11868 use M-SPC or C-q SPC to force the insertion of a space character.
11870 You will also be prompted for a description, and if one is given, it will
11871 be displayed in the buffer instead of the link.
11873 If there is already a link at point, this command will allow you to edit link
11874 and description parts.
11877 selected using completion. The path to the file will be relative to
11878 the current directory if the file is in the current directory or a
11879 subdirectory. Otherwise, the link will be the absolute path as
11880 completed in the minibuffer (i.e. normally ~/path/to/file).
11883 is in the current directory or below.
11885 `org-keep-stored-link-after-insertion'."
11886 (interactive "P")
11887 (let* ((wcf (current-window-configuration))
11888 (region (if (org-region-active-p)
11889 (buffer-substring (region-beginning) (region-end))))
11890 (remove (and region (list (region-beginning) (region-end))))
11891 (desc region)
11892 tmphist ; byte-compile incorrectly complains about this
11893 link entry file)
11894 (cond
11895 ((org-in-regexp org-bracket-link-regexp 1)
11896 ;; We do have a link at point, and we are going to edit it.
11897 (setq remove (list (match-beginning 0) (match-end 0)))
11898 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
11899 (setq link (read-string "Link: "
11900 (org-link-unescape
11901 (org-match-string-no-properties 1)))))
11902 ((or (org-in-regexp org-angle-link-re)
11903 (org-in-regexp org-plain-link-re))
11904 ;; Convert to bracket link
11905 (setq remove (list (match-beginning 0) (match-end 0))
11906 link (read-string "Link: "
11907 (org-remove-angle-brackets (match-string 0)))))
11908 ((equal complete-file '(4))
11909 ;; Completing read for file names.
11910 (setq file (read-file-name "File: "))
11911 (let ((pwd (file-name-as-directory (expand-file-name ".")))
11912 (pwd1 (file-name-as-directory (abbreviate-file-name
11913 (expand-file-name ".")))))
11914 (cond
11915 ((equal complete-file '(16))
11916 (setq link (org-make-link
11917 "file:"
11918 (abbreviate-file-name (expand-file-name file)))))
11920 (setq link (org-make-link "file:" (match-string 1 file))))
11922 (expand-file-name file))
11923 (setq link (org-make-link
11924 "file:" (match-string 1 (expand-file-name file)))))
11925 (t (setq link (org-make-link "file:" file))))))
11926 (t
11927 ;; Read link, with completion for stored links.
11928 (with-output-to-temp-buffer "*Org Links*"
11930 (when org-stored-links
11932 (princ (mapconcat
11933 (lambda (x)
11934 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
11936 (let ((cw (selected-window)))
11937 (select-window (get-buffer-window "*Org Links*"))
11938 (shrink-window-if-larger-than-buffer)
11939 (setq truncate-lines t)
11940 (select-window cw))
11941 ;; Fake a link history, containing the stored links.
11942 (setq tmphist (append (mapcar 'car org-stored-links)
11943 org-insert-link-history))
11944 (unwind-protect
11945 (setq link (org-completing-read
11946 "Link: "
11947 (append
11948 (mapcar (lambda (x) (list (concat (car x) ":")))
11949 (append org-link-abbrev-alist-local org-link-abbrev-alist))
11950 (mapcar (lambda (x) (list (concat x ":")))
11951 org-link-types))
11952 nil nil nil
11953 'tmphist
11954 (or (car (car org-stored-links)))))
11955 (set-window-configuration wcf)
11956 (kill-buffer "*Org Links*"))
11957 (setq entry (assoc link org-stored-links))
11958 (or entry (push link org-insert-link-history))
11959 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
11960 (not org-keep-stored-link-after-insertion))
11961 (setq org-stored-links (delq (assoc link org-stored-links)
11962 org-stored-links)))
11963 (setq desc (or desc (nth 1 entry)))))
11965 (if (string-match org-plain-link-re link)
11966 ;; URL-like link, normalize the use of angular brackets.
11967 (setq link (org-make-link (org-remove-angle-brackets link))))
11969 ;; Check if we are linking to the current file with a search option
11970 ;; If yes, simplify the link by using only the search option.
11971 (when (and buffer-file-name
11973 (let* ((path (match-string 1 link))
11974 (case-fold-search nil)
11975 (search (match-string 2 link)))
11976 (save-match-data
11977 (if (equal (file-truename buffer-file-name) (file-truename path))
11978 ;; We are linking to this same file, with a search option
11979 (setq link search)))))
11981 ;; Check if we can/should use a relative path. If yes, simplify the link
11983 (let* ((path (match-string 1 link))
11984 (origpath path)
11985 (desc-is-link (equal link desc))
11986 (case-fold-search nil))
11987 (cond
11988 ((eq org-link-file-path-type 'absolute)
11989 (setq path (abbreviate-file-name (expand-file-name path))))
11990 ((eq org-link-file-path-type 'noabbrev)
11991 (setq path (expand-file-name path)))
11992 ((eq org-link-file-path-type 'relative)
11993 (setq path (file-relative-name path)))
11994 (t
11995 (save-match-data
11996 (if (string-match (concat "^" (regexp-quote
11997 (file-name-as-directory
11998 (expand-file-name "."))))
11999 (expand-file-name path))
12000 ;; We are linking a file with relative path name.
12001 (setq path (substring (expand-file-name path)
12002 (match-end 0)))))))
12003 (setq link (concat "file:" path))
12004 (if (equal desc origpath)
12005 (setq desc path))))
12007 (setq desc (read-string "Description: " desc))
12009 (if remove (apply 'delete-region remove))
12010 (insert (org-make-link-string link desc))))
12012 (defun org-completing-read (&rest args)
12013 (let ((minibuffer-local-completion-map
12014 (copy-keymap minibuffer-local-completion-map)))
12015 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12016 (apply 'completing-read args)))
12018 ;;; Opening/following a link
12019 (defvar org-link-search-failed nil)
12021 (defun org-next-link ()
12022 "Move forward to the next link.
12023 If the link is in hidden text, expose it."
12024 (interactive)
12025 (when (and org-link-search-failed (eq this-command last-command))
12026 (goto-char (point-min))
12027 (message "Link search wrapped back to beginning of buffer"))
12028 (setq org-link-search-failed nil)
12029 (let* ((pos (point))
12030 (ct (org-context))
12031 (a (assoc :link ct)))
12032 (if a (goto-char (nth 2 a)))
12033 (if (re-search-forward org-any-link-re nil t)
12034 (progn
12035 (goto-char (match-beginning 0))
12036 (if (org-invisible-p) (org-show-context)))
12037 (goto-char pos)
12038 (setq org-link-search-failed t)
12039 (error "No further link found"))))
12041 (defun org-previous-link ()
12042 "Move backward to the previous link.
12043 If the link is in hidden text, expose it."
12044 (interactive)
12045 (when (and org-link-search-failed (eq this-command last-command))
12046 (goto-char (point-max))
12047 (message "Link search wrapped back to end of buffer"))
12048 (setq org-link-search-failed nil)
12049 (let* ((pos (point))
12050 (ct (org-context))
12051 (a (assoc :link ct)))
12052 (if a (goto-char (nth 1 a)))
12053 (if (re-search-backward org-any-link-re nil t)
12054 (progn
12055 (goto-char (match-beginning 0))
12056 (if (org-invisible-p) (org-show-context)))
12057 (goto-char pos)
12058 (setq org-link-search-failed t)
12059 (error "No further link found"))))
12061 (defun org-find-file-at-mouse (ev)
12062 "Open file link or URL at mouse."
12063 (interactive "e")
12064 (mouse-set-point ev)
12065 (org-open-at-point 'in-emacs))
12067 (defun org-open-at-mouse (ev)
12068 "Open file link or URL at mouse."
12069 (interactive "e")
12070 (mouse-set-point ev)
12071 (org-open-at-point))
12073 (defvar org-window-config-before-follow-link nil
12074 "The window configuration before following a link.
12075 This is saved in case the need arises to restore it.")
12077 (defvar org-open-link-marker (make-marker)
12078 "Marker pointing to the location where `org-open-at-point; was called.")
12080 ;;;###autoload
12081 (defun org-open-at-point-global ()
12082 "Follow a link like Org-mode does.
12083 This command can be called in any mode to follow a link that has
12084 Org-mode syntax."
12085 (interactive)
12086 (org-run-like-in-org-mode 'org-open-at-point))
12088 (defun org-open-at-point (&optional in-emacs)
12089 "Open link at or after point.
12090 If there is no link at point, this function will search forward up to
12091 the end of the current subtree.
12092 Normally, files will be opened by an appropriate application. If the
12093 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12094 (interactive "P")
12095 (catch 'abort
12096 (move-marker org-open-link-marker (point))
12097 (setq org-window-config-before-follow-link (current-window-configuration))
12098 (org-remove-occur-highlights nil nil t)
12099 (if (org-at-timestamp-p t)
12100 (org-follow-timestamp-link)
12101 (let (type path link line search (pos (point)))
12102 (catch 'match
12103 (save-excursion
12105 (when (org-in-regexp org-bracket-link-regexp)
12106 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12108 (setq link (replace-match " " t t link)))
12109 (setq link (org-link-expand-abbrev link))
12110 (if (string-match org-link-re-with-space2 link)
12111 (setq type (match-string 1 link) path (match-string 2 link))
12112 (setq type "thisfile" path link))
12113 (throw 'match t)))
12115 (when (get-text-property (point) 'org-linked-text)
12116 (setq type "thisfile"
12117 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12118 (1+ (point)) (point))
12119 path (buffer-substring
12120 (previous-single-property-change pos 'org-linked-text)
12121 (next-single-property-change pos 'org-linked-text)))
12122 (throw 'match t))
12124 (save-excursion
12125 (when (or (org-in-regexp org-angle-link-re)
12126 (org-in-regexp org-plain-link-re))
12127 (setq type (match-string 1) path (match-string 2))
12128 (throw 'match t)))
12130 (setq type "tree-match"
12131 path (match-string 1))
12132 (throw 'match t))
12133 (save-excursion
12135 (setq type "tags"
12136 path (match-string 1))
12137 (while (string-match ":" path)
12138 (setq path (replace-match "+" t t path)))
12139 (throw 'match t))))
12140 (unless path
12141 (error "No link found"))
12142 ;; Remove any trailing spaces in path
12144 (setq path (replace-match "" t t path)))
12146 (cond
12148 ((assoc type org-link-protocols)
12149 (funcall (nth 1 (assoc type org-link-protocols)) path))
12151 ((equal type "mailto")
12152 (let ((cmd (car org-link-mailto-program))
12153 (args (cdr org-link-mailto-program)) args1
12154 (address path) (subject "") a)
12156 (setq address (match-string 1 path)
12157 subject (org-link-escape (match-string 2 path))))
12158 (while args
12159 (cond
12160 ((not (stringp (car args))) (push (pop args) args1))
12161 (t (setq a (pop args))
12162 (if (string-match "%a" a)
12163 (setq a (replace-match address t t a)))
12164 (if (string-match "%s" a)
12165 (setq a (replace-match subject t t a)))
12166 (push a args1))))
12167 (apply cmd (nreverse args1))))
12169 ((member type '("http" "https" "ftp" "news"))
12170 (browse-url (concat type ":" (org-link-escape
12171 path org-link-escape-chars-browser))))
12173 ((string= type "tags")
12174 (org-tags-view in-emacs path))
12175 ((string= type "thisfile")
12176 (if in-emacs
12177 (switch-to-buffer-other-window
12178 (org-get-buffer-for-internal-link (current-buffer)))
12179 (org-mark-ring-push))
12180 (let ((cmd `(org-link-search
12181 ,path
12182 ,(cond ((equal in-emacs '(4)) 'occur)
12183 ((equal in-emacs '(16)) 'org-occur)
12184 (t nil))
12185 ,pos)))
12186 (condition-case nil (eval cmd)
12187 (error (progn (widen) (eval cmd))))))
12189 ((string= type "tree-match")
12192 ((string= type "file")
12194 (setq line (string-to-number (match-string 1 path))
12195 path (substring path 0 (match-beginning 0)))
12197 (setq search (match-string 1 path)
12198 path (substring path 0 (match-beginning 0)))))
12199 (if (string-match "[*?{]" (file-name-nondirectory path))
12200 (dired path)
12201 (org-open-file path in-emacs line search)))
12203 ((string= type "news")
12204 (org-follow-gnus-link path))
12206 ((string= type "bbdb")
12207 (org-follow-bbdb-link path))
12209 ((string= type "info")
12210 (org-follow-info-link path))
12212 ((string= type "gnus")
12213 (let (group article)
12215 (error "Error in Gnus link"))
12216 (setq group (match-string 1 path)
12217 article (match-string 3 path))
12218 (org-follow-gnus-link group article)))
12220 ((string= type "vm")
12221 (let (folder article)
12223 (error "Error in VM link"))
12224 (setq folder (match-string 1 path)
12225 article (match-string 3 path))
12226 ;; in-emacs is the prefix arg, will be interpreted as read-only
12227 (org-follow-vm-link folder article in-emacs)))
12229 ((string= type "wl")
12230 (let (folder article)
12232 (error "Error in Wanderlust link"))
12233 (setq folder (match-string 1 path)
12234 article (match-string 3 path))
12235 (org-follow-wl-link folder article)))
12237 ((string= type "mhe")
12238 (let (folder article)
12240 (error "Error in MHE link"))
12241 (setq folder (match-string 1 path)
12242 article (match-string 3 path))
12243 (org-follow-mhe-link folder article)))
12245 ((string= type "rmail")
12246 (let (folder article)
12248 (error "Error in RMAIL link"))
12249 (setq folder (match-string 1 path)
12250 article (match-string 3 path))
12251 (org-follow-rmail-link folder article)))
12253 ((string= type "shell")
12254 (let ((cmd path))
12255 (if (or (not org-confirm-shell-link-function)
12256 (funcall org-confirm-shell-link-function
12258 (org-add-props cmd nil
12259 'face 'org-warning))))
12260 (progn
12261 (message "Executing %s" cmd)
12262 (shell-command cmd))
12263 (error "Abort"))))
12265 ((string= type "elisp")
12266 (let ((cmd path))
12267 (if (or (not org-confirm-elisp-link-function)
12268 (funcall org-confirm-elisp-link-function
12270 (org-add-props cmd nil
12271 'face 'org-warning))))
12272 (message "%s => %s" cmd (eval (read cmd)))
12273 (error "Abort"))))
12275 (t
12276 (browse-url-at-point)))))
12277 (move-marker org-open-link-marker nil)))
12279 ;;; File search
12281 (defvar org-create-file-search-functions nil
12282 "List of functions to construct the right search string for a file link.
12283 These functions are called in turn with point at the location to
12284 which the link should point.
12286 A function in the hook should first test if it would like to
12287 handle this file type, for example by checking the major-mode or
12288 the file extension. If it decides not to handle this file, it
12289 should just return nil to give other functions a chance. If it
12290 does handle the file, it must return the search string to be used
12291 when following the link. The search string will be part of the
12292 file link, given after a double colon, and `org-open-at-point'
12293 will automatically search for it. If special measures must be
12294 taken to make the search successful, another function should be
12295 added to the companion hook `org-execute-file-search-functions',
12296 which see.
12298 A function in this hook may also use `setq' to set the variable
12299 `description' to provide a suggestion for the descriptive text to
12300 be used for this link when it gets inserted into an Org-mode
12303 (defvar org-execute-file-search-functions nil
12304 "List of functions to execute a file search triggered by a link.
12306 Functions added to this hook must accept a single argument, the
12307 search string that was part of the file link, the part after the
12308 double colon. The function must first check if it would like to
12309 handle this search, for example by checking the major-mode or the
12310 file extension. If it decides not to handle this search, it
12311 should just return nil to give other functions a chance. If it
12312 does handle the search, it must return a non-nil value to keep
12313 other functions from trying.
12315 Each function can access the current prefix argument through the
12316 variable `current-prefix-argument'. Note that a single prefix is
12317 used to force opening a link in Emacs, so it may be good to only
12318 use a numeric or double prefix to guide the search function.
12320 In case this is needed, a function in this hook can also restore
12321 the window configuration before `org-open-at-point' was called using:
12323 (set-window-configuration org-window-config-before-follow-link)")
12325 (defun org-link-search (s &optional type avoid-pos)
12326 "Search for a link search option.
12327 If S is surrounded by forward slashes, it is interpreted as a
12328 regular expression. In org-mode files, this will create an `org-occur'
12329 sparse tree. In ordinary files, `occur' will be used to list matches.
12330 If the current buffer is in `dired-mode', grep will be used to search
12331 in all files. If AVOID-POS is given, ignore matches near that position."
12332 (let ((case-fold-search t)
12336 org-emphasis-alist)
12338 (pos (point))
12339 (pre "") (post "")
12340 words re0 re1 re2 re3 re4 re5 re2a reall)
12341 (cond
12342 ;; First check if there are any special
12343 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12344 ;; Now try the builtin stuff
12345 ((save-excursion
12346 (goto-char (point-min))
12347 (and
12348 (re-search-forward
12349 (concat "<<" (regexp-quote s0) ">>") nil t)
12350 (setq pos (match-beginning 0))))
12351 ;; There is an exact target for this
12352 (goto-char pos))
12354 ;; A regular expression
12355 (cond
12356 ((org-mode-p)
12357 (org-occur (match-string 1 s)))
12358 ;;((eq major-mode 'dired-mode)
12359 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12360 (t (org-do-occur (match-string 1 s)))))
12361 (t
12362 ;; A normal search strings
12363 (when (equal (string-to-char s) ?*)
12364 ;; Anchor on headlines, post may include tags.
12367 s (substring s 1)))
12368 (remove-text-properties
12369 0 (length s)
12370 '(face nil mouse-face nil keymap nil fontified nil) s)
12371 ;; Make a series of regular expressions to find a match
12378 re1 (concat pre re2 post)
12379 re3 (concat pre re4 post)
12380 re5 (concat pre ".*" re4)
12381 re2 (concat pre re2)
12382 re2a (concat pre re2a)
12383 re4 (concat pre re4)
12387 ))
12388 (cond
12389 ((eq type 'org-occur) (org-occur reall))
12390 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12391 (t (goto-char (point-min))
12392 (if (or (org-search-not-self 1 re0 nil t)
12393 (org-search-not-self 1 re1 nil t)
12394 (org-search-not-self 1 re2 nil t)
12395 (org-search-not-self 1 re2a nil t)
12396 (org-search-not-self 1 re3 nil t)
12397 (org-search-not-self 1 re4 nil t)
12398 (org-search-not-self 1 re5 nil t)
12399 )
12400 (goto-char (match-beginning 1))
12401 (goto-char pos)
12402 (error "No match")))))
12403 (t
12404 ;; Normal string-search
12405 (goto-char (point-min))
12406 (if (search-forward s nil t)
12407 (goto-char (match-beginning 0))
12408 (error "No match"))))
12409 (and (org-mode-p) (org-show-context 'link-search))))
12411 (defun org-search-not-self (group &rest args)
12412 "Execute `re-search-forward', but only accept matches that do not
12413 enclose the position of `org-open-link-marker'."
12414 (let ((m org-open-link-marker))
12415 (catch 'exit
12416 (while (apply 're-search-forward args)
12417 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12418 (goto-char (match-end group))
12419 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12420 (> (match-beginning 0) (marker-position m))
12421 (< (match-end 0) (marker-position m)))
12422 (save-match-data
12423 (or (not (org-in-regexp
12424 org-bracket-link-analytic-regexp 1))
12425 (not (match-end 4)) ; no description
12426 (and (<= (match-beginning 4) (point))
12427 (>= (match-end 4) (point))))))
12428 (throw 'exit (point))))))))
12430 (defun org-get-buffer-for-internal-link (buffer)
12431 "Return a buffer to be used for displaying the link target of internal links."
12432 (cond
12433 ((not org-display-internal-link-with-indirect-buffer)
12434 buffer)
12435 ((string-match "(Clone)$" (buffer-name buffer))
12436 (message "Buffer is already a clone, not making another one")
12437 ;; we also do not modify visibility in this case
12438 buffer)
12439 (t ; make a new indirect buffer for displaying the link
12440 (let* ((bn (buffer-name buffer))
12441 (ibn (concat bn "(Clone)"))
12442 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12443 (with-current-buffer ib (org-overview))
12444 ib))))
12446 (defun org-do-occur (regexp &optional cleanup)
12447 "Call the Emacs command `occur'.
12448 If CLEANUP is non-nil, remove the printout of the regular expression
12449 in the *Occur* buffer. This is useful if the regex is long and not useful
12450 to read."
12451 (occur regexp)
12452 (when cleanup
12453 (let ((cwin (selected-window)) win beg end)
12454 (when (setq win (get-buffer-window "*Occur*"))
12455 (select-window win))
12456 (goto-char (point-min))
12457 (when (re-search-forward "match[a-z]+" nil t)
12458 (setq beg (match-end 0))
12460 (setq end (1- (match-beginning 0)))))
12461 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12462 (goto-char (point-min))
12463 (select-window cwin))))
12465 ;;; The mark ring for links jumps
12467 (defvar org-mark-ring nil
12468 "Mark ring for positions before jumps in Org-mode.")
12469 (defvar org-mark-ring-last-goto nil
12470 "Last position in the mark ring used to go back.")
12471 ;; Fill and close the ring
12472 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12473 (loop for i from 1 to org-mark-ring-length do
12474 (push (make-marker) org-mark-ring))
12475 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12476 org-mark-ring)
12478 (defun org-mark-ring-push (&optional pos buffer)
12479 "Put the current position or POS into the mark ring and rotate it."
12480 (interactive)
12481 (setq pos (or pos (point)))
12482 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12483 (move-marker (car org-mark-ring)
12484 (or pos (point))
12485 (or buffer (current-buffer)))
12486 (message
12487 (substitute-command-keys
12490 (defun org-mark-ring-goto (&optional n)
12491 "Jump to the previous position in the mark ring.
12492 With prefix arg N, jump back that many stored positions. When
12493 called several times in succession, walk through the entire ring.
12494 Org-mode commands jumping to a different position in the current file,
12495 or to another Org-mode file, automatically push the old position
12496 onto the ring."
12497 (interactive "p")
12498 (let (p m)
12499 (if (eq last-command this-command)
12500 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12501 (setq p org-mark-ring))
12502 (setq org-mark-ring-last-goto p)
12503 (setq m (car p))
12504 (switch-to-buffer (marker-buffer m))
12505 (goto-char m)
12506 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12508 (defun org-remove-angle-brackets (s)
12509 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12510 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12511 s)
12512 (defun org-add-angle-brackets (s)
12513 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12514 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12515 s)
12517 ;;; Following specific links
12519 (defun org-follow-timestamp-link ()
12520 (cond
12521 ((org-at-date-range-p t)
12522 (let ((org-agenda-start-on-weekday)
12523 (t1 (match-string 1))
12524 (t2 (match-string 2)))
12525 (setq t1 (time-to-days (org-time-string-to-time t1))
12526 t2 (time-to-days (org-time-string-to-time t2)))
12527 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12528 ((org-at-timestamp-p t)
12529 (org-agenda-list nil (time-to-days (org-time-string-to-time
12530 (substring (match-string 1) 0 10)))
12531 1))
12532 (t (error "This should not happen"))))
12535 (defun org-follow-bbdb-link (name)
12536 "Follow a BBDB link to NAME."
12537 (require 'bbdb)
12538 (let ((inhibit-redisplay (not debug-on-error))
12539 (bbdb-electric-p nil))
12540 (catch 'exit
12541 ;; Exact match on name
12543 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12544 ;; Exact match on name
12546 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12547 ;; Partial match on name
12548 (bbdb-name name nil)
12549 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12550 ;; Partial match on company
12551 (bbdb-company name nil)
12552 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12553 ;; General match including network address and notes
12554 (bbdb name nil)
12555 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
12556 (delete-window (get-buffer-window "*BBDB*"))
12557 (error "No matching BBDB record")))))
12559 (defun org-follow-info-link (name)
12560 "Follow an info file & node link to NAME."
12563 (progn
12564 (require 'info)
12565 (if (match-string 2 name) ; If there isn't a node, choose "Top"
12566 (Info-find-node (match-string 1 name) (match-string 2 name))
12567 (Info-find-node (match-string 1 name) "Top")))
12568 (message (concat "Could not open: " name))))
12570 (defun org-follow-gnus-link (&optional group article)
12571 "Follow a Gnus link to GROUP and ARTICLE."
12572 (require 'gnus)
12573 (funcall (cdr (assq 'gnus org-link-frame-setup)))
12574 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
12575 (cond ((and group article)
12576 (gnus-group-read-group 1 nil group)
12577 (gnus-summary-goto-article (string-to-number article) nil t))
12578 (group (gnus-group-jump-to-group group))))
12580 (defun org-follow-vm-link (&optional folder article readonly)
12581 "Follow a VM link to FOLDER and ARTICLE."
12582 (require 'vm)
12583 (setq article (org-add-angle-brackets article))
12585 ;; ange-ftp or efs or tramp access
12586 (let ((user (or (match-string 1 folder) (user-login-name)))
12587 (host (match-string 2 folder))
12588 (file (match-string 3 folder)))
12589 (cond
12590 ((featurep 'tramp)
12591 ;; use tramp to access the file
12592 (if (featurep 'xemacs)
12593 (setq folder (format "[%s@%s]%s" user host file))
12594 (setq folder (format "/%s@%s:%s" user host file))))
12595 (t
12596 ;; use ange-ftp or efs
12597 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
12598 (setq folder (format "/%s@%s:%s" user host file))))))
12599 (when folder
12600 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
12601 (sit-for 0.1)
12602 (when article
12603 (vm-select-folder-buffer)
12604 (widen)
12605 (let ((case-fold-search t))
12606 (goto-char (point-min))
12607 (if (not (re-search-forward
12608 (concat "^" "message-id: *" (regexp-quote article))))
12609 (error "Could not find the specified message in this folder"))
12610 (vm-isearch-update)
12611 (vm-isearch-narrow)
12612 (vm-beginning-of-message)
12613 (vm-summarize)))))
12615 (defun org-follow-wl-link (folder article)
12616 "Follow a Wanderlust link to FOLDER and ARTICLE."
12617 (if (and (string= folder "%")
12618 article
12620 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
12621 ;; Thus, we recompose folder and article ids.
12622 (setq folder (format "%s#%s" folder (match-string 1 article))
12623 article (match-string 3 article)))
12624 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
12625 (error "No such folder: %s" folder))
12626 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
12627 (and article
12628 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
12629 (wl-summary-redisplay)))
12631 (defun org-follow-rmail-link (folder article)
12632 "Follow an RMAIL link to FOLDER and ARTICLE."
12633 (setq article (org-add-angle-brackets article))
12634 (let (message-number)
12635 (save-excursion
12636 (save-window-excursion
12637 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12638 (setq message-number
12639 (save-restriction
12640 (widen)
12641 (goto-char (point-max))
12642 (if (re-search-backward
12644 (or article "")))
12645 nil t)
12646 (rmail-what-message))))))
12647 (if message-number
12648 (progn
12649 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12650 (rmail-show-message message-number)
12651 message-number)
12652 (error "Message not found"))))
12654 ;;; mh-e integration based on planner-mode
12655 (defun org-mhe-get-message-real-folder ()
12656 "Return the name of the current message real folder, so if you use
12657 sequences, it will now work."
12658 (save-excursion
12659 (let* ((folder
12660 (if (equal major-mode 'mh-folder-mode)
12661 mh-current-folder
12662 ;; Refer to the show buffer
12663 mh-show-folder-buffer))
12664 (end-index
12665 (if (boundp 'mh-index-folder)
12666 (min (length mh-index-folder) (length folder))))
12667 )
12668 ;; a simple test on mh-index-data does not work, because
12669 ;; mh-index-data is always nil in a show buffer.
12670 (if (and (boundp 'mh-index-folder)
12671 (string= mh-index-folder (substring folder 0 end-index)))
12672 (if (equal major-mode 'mh-show-mode)
12673 (save-window-excursion
12674 (let (pop-up-frames)
12675 (when (buffer-live-p (get-buffer folder))
12676 (progn
12677 (pop-to-buffer folder)
12678 (org-mhe-get-message-folder-from-index)
12679 )
12680 )))
12681 (org-mhe-get-message-folder-from-index)
12682 )
12683 folder
12684 )
12685 )))
12687 (defun org-mhe-get-message-folder-from-index ()
12688 "Returns the name of the message folder in a index folder buffer."
12689 (save-excursion
12690 (mh-index-previous-folder)
12692 (message (match-string 1))))
12694 (defun org-mhe-get-message-folder ()
12695 "Return the name of the current message folder. Be careful if you
12696 use sequences."
12697 (save-excursion
12698 (if (equal major-mode 'mh-folder-mode)
12699 mh-current-folder
12700 ;; Refer to the show buffer
12701 mh-show-folder-buffer)))
12703 (defun org-mhe-get-message-num ()
12704 "Return the number of the current message. Be careful if you
12705 use sequences."
12706 (save-excursion
12707 (if (equal major-mode 'mh-folder-mode)
12708 (mh-get-msg-num nil)
12709 ;; Refer to the show buffer
12710 (mh-show-buffer-message-number))))
12712 (defun org-mhe-get-header (header)
12713 "Return a header of the message in folder mode. This will create a
12714 show buffer for the corresponding message. If you have a more clever
12715 idea..."
12716 (let* ((folder (org-mhe-get-message-folder))
12717 (num (org-mhe-get-message-num))
12718 (buffer (get-buffer-create (concat "show-" folder)))
12719 (header-field))
12720 (with-current-buffer buffer
12721 (mh-display-msg num folder)
12722 (if (equal major-mode 'mh-folder-mode)
12723 (mh-header-display)
12724 (mh-show-header-display))
12725 (set-buffer buffer)
12726 (setq header-field (mh-get-header-field header))
12727 (if (equal major-mode 'mh-folder-mode)
12728 (mh-show)
12729 (mh-show-show))
12730 header-field)))
12732 (defun org-follow-mhe-link (folder article)
12733 "Follow an MHE link to FOLDER and ARTICLE.
12734 If ARTICLE is nil FOLDER is shown. If the configuration variable
12735 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
12736 ARTICLE is searched in all folders. Indexed searches (swish++,
12737 namazu, and others supported by MH-E) will always search in all
12738 folders."
12739 (require 'mh-e)
12740 (require 'mh-search)
12741 (require 'mh-utils)
12742 (mh-find-path)
12743 (if (not article)
12744 (mh-visit-folder (mh-normalize-folder-name folder))
12745 (setq article (org-add-angle-brackets article))
12746 (mh-search-choose)
12747 (if (equal mh-searcher 'pick)
12748 (progn
12749 (mh-search folder (list "--message-id" article))
12750 (when (and org-mhe-search-all-folders
12751 (not (org-mhe-get-message-real-folder)))
12752 (kill-this-buffer)
12753 (mh-search "+" (list "--message-id" article))))
12754 (mh-search "+" article))
12755 (if (org-mhe-get-message-real-folder)
12756 (mh-show-msg 1)
12757 (kill-this-buffer)
12758 (error "Message not found"))))
12760 ;;; BibTeX links
12762 ;; Use the custom search meachnism to construct and use search strings for
12763 ;; file links to BibTeX database entries.
12765 (defun org-create-file-search-in-bibtex ()
12766 "Create the search string and description for a BibTeX database entry."
12767 (when (eq major-mode 'bibtex-mode)
12768 ;; yes, we want to construct this search string.
12769 ;; Make a good description for this entry, using names, year and the title
12770 ;; Put it into the `description' variable which is dynamically scoped.
12771 (let ((bibtex-autokey-names 1)
12772 (bibtex-autokey-names-stretch 1)
12773 (bibtex-autokey-name-case-convert-function 'identity)
12774 (bibtex-autokey-name-separator " & ")
12775 (bibtex-autokey-additional-names " et al.")
12776 (bibtex-autokey-year-length 4)
12777 (bibtex-autokey-name-year-separator " ")
12778 (bibtex-autokey-titlewords 3)
12779 (bibtex-autokey-titleword-separator " ")
12780 (bibtex-autokey-titleword-case-convert-function 'identity)
12781 (bibtex-autokey-titleword-length 'infty)
12782 (bibtex-autokey-year-title-separator ": "))
12783 (setq description (bibtex-generate-autokey)))
12784 ;; Now parse the entry, get the key and return it.
12785 (save-excursion
12786 (bibtex-beginning-of-entry)
12787 (cdr (assoc "=key=" (bibtex-parse-entry))))))
12789 (defun org-execute-file-search-in-bibtex (s)
12790 "Find the link search string S as a key for a database entry."
12791 (when (eq major-mode 'bibtex-mode)
12792 ;; Yes, we want to do the search in this file.
12793 ;; We construct a regexp that searches for "@entrytype{" followed by the key
12794 (goto-char (point-min))
12797 (goto-char (match-beginning 0)))
12798 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
12799 ;; Use double prefix to indicate that any web link should be browsed
12800 (let ((b (current-buffer)) (p (point)))
12801 ;; Restore the window configuration because we just use the web link
12802 (set-window-configuration org-window-config-before-follow-link)
12803 (save-excursion (set-buffer b) (goto-char p)
12804 (bibtex-url)))
12805 (recenter 0)) ; Move entry start to beginning of window
12806 ;; return t to indicate that the search is done.
12807 t))
12809 ;; Finally add the functions to the right hooks.
12810 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
12811 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
12813 ;; end of Bibtex link setup
12815 ;;; Following file links
12817 (defun org-open-file (path &optional in-emacs line search)
12818 "Open the file at PATH.
12819 First, this expands any special file name abbreviations. Then the
12820 configuration variable `org-file-apps' is checked if it contains an
12821 entry for this file type, and if yes, the corresponding command is launched.
12822 If no application is found, Emacs simply visits the file.
12823 With optional argument IN-EMACS, Emacs will visit the file.
12824 Optional LINE specifies a line to go to, optional SEARCH a string to
12825 search for. If LINE or SEARCH is given, the file will always be
12826 opened in Emacs.
12827 If the file does not exist, an error is thrown."
12828 (setq in-emacs (or in-emacs line search))
12829 (let* ((file (if (equal path "")
12830 buffer-file-name
12831 (substitute-in-file-name (expand-file-name path))))
12832 (apps (append org-file-apps (org-default-apps)))
12833 (remp (and (assq 'remote apps) (org-file-remote-p file)))
12834 (dirp (if remp nil (file-directory-p file)))
12835 (dfile (downcase file))
12836 (old-buffer (current-buffer))
12837 (old-pos (point))
12838 (old-mode major-mode)
12839 ext cmd)
12841 (setq ext (match-string 1 dfile))
12843 (setq ext (match-string 1 dfile))))
12844 (if in-emacs
12845 (setq cmd 'emacs)
12846 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
12847 (and dirp (cdr (assoc 'directory apps)))
12848 (cdr (assoc ext apps))
12849 (cdr (assoc t apps)))))
12850 (when (eq cmd 'mailcap)
12851 (require 'mailcap)
12852 (mailcap-parse-mailcaps)
12853 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
12854 (command (mailcap-mime-info mime-type)))
12855 (if (stringp command)
12856 (setq cmd command)
12857 (setq cmd 'emacs))))
12858 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
12859 (not (file-exists-p file))
12860 (not org-open-non-existing-files))
12861 (error "No such file: %s" file))
12862 (cond
12864 ;; Remove quotes around the file name - we'll use shell-quote-argument.
12866 (setq cmd (replace-match "%s" t t cmd)))
12867 (setq cmd (format cmd (shell-quote-argument file)))
12868 (save-window-excursion
12869 (start-process-shell-command cmd nil cmd)))
12870 ((or (stringp cmd)
12871 (eq cmd 'emacs))
12872 (funcall (cdr (assq 'file org-link-frame-setup)) file)
12873 (widen)
12874 (if line (goto-line line)
12875 (if search (org-link-search search))))
12876 ((consp cmd)
12877 (eval cmd))
12878 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
12879 (and (org-mode-p) (eq old-mode 'org-mode)
12880 (or (not (equal old-buffer (current-buffer)))
12881 (not (equal old-pos (point))))
12882 (org-mark-ring-push old-pos old-buffer))))
12884 (defun org-default-apps ()
12885 "Return the default applications for this operating system."
12886 (cond
12887 ((eq system-type 'darwin)
12888 org-file-apps-defaults-macosx)
12889 ((eq system-type 'windows-nt)
12890 org-file-apps-defaults-windowsnt)
12891 (t org-file-apps-defaults-gnu)))
12893 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
12894 (defun org-file-remote-p (file)
12895 "Test whether FILE specifies a location on a remote system.
12896 Return non-nil if the location is indeed remote.
12900 (cond ((fboundp 'file-remote-p)
12901 (file-remote-p file))
12902 ((fboundp 'tramp-handle-file-remote-p)
12903 (tramp-handle-file-remote-p file))
12904 ((and (boundp 'ange-ftp-name-format)
12905 (string-match (car ange-ftp-name-format) file))
12906 t)
12907 (t nil)))
12910 ;;;; Hooks for remember.el, and refiling
12912 ;;;###autoload
12913 (defun org-remember-insinuate ()
12914 "Setup remember.el for use wiht Org-mode."
12915 (require 'remember)
12916 (setq remember-annotation-functions '(org-remember-annotation))
12917 (setq remember-handler-functions '(org-remember-handler))
12918 (add-hook 'remember-mode-hook 'org-remember-apply-template))
12920 ;;;###autoload
12921 (defun org-remember-annotation ()
12922 "Return a link to the current location as an annotation for remember.el.
12923 If you are using Org-mode files as target for data storage with
12924 remember.el, then the annotations should include a link compatible with the
12925 conventions in Org-mode. This function returns such a link."
12926 (org-store-link nil))
12928 (defconst org-remember-help
12929 "Select a destination location for the note.
12930 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
12931 RET on headline -> Store as sublevel entry to current headline
12932 RET at beg-of-buf -> Append to file as level 2 headline
12933 <left>/<right> -> before/after current headline, same headings level")
12935 (defvar org-remember-previous-location nil)
12936 (defvar org-force-remember-template-char) ;; dynamically scoped
12938 (defun org-select-remember-template (&optional use-char)
12939 (when org-remember-templates
12940 (let* ((templates (mapcar (lambda (x)
12941 (if (stringp (car x))
12942 (append (list (nth 1 x) (car x)) (cddr x))
12943 (append (list (car x) "") (cdr x))))
12944 org-remember-templates))
12945 (char (or use-char
12946 (cond
12947 ((= (length templates) 1)
12948 (caar templates))
12949 ((and (boundp 'org-force-remember-template-char)
12950 org-force-remember-template-char)
12951 (if (stringp org-force-remember-template-char)
12952 (string-to-char org-force-remember-template-char)
12953 org-force-remember-template-char))
12954 (t
12955 (message "Select template: %s"
12956 (mapconcat
12957 (lambda (x)
12958 (cond
12960 (format "[%c]" (car x)))
12961 ((equal (downcase (car x))
12962 (downcase (aref (nth 1 x) 0)))
12963 (format "[%c]%s" (car x)
12964 (substring (nth 1 x) 1)))
12965 (t (format "[%c]%s" (car x) (nth 1 x)))))
12966 templates " "))
12967 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
12968 (when (equal char0 ?\C-g)
12969 (jump-to-register remember-register)
12970 (kill-buffer remember-buffer))
12971 char0))))))
12972 (cddr (assoc char templates)))))
12974 ;;;###autoload
12975 (defun org-remember-apply-template (&optional use-char skip-interactive)
12976 "Initialize *remember* buffer with template, invoke `org-mode'.
12977 This function should be placed into `remember-mode-hook' and in fact requires
12978 to be run from that hook to function properly."
12979 (unless (fboundp 'remember-finalize)
12980 (defalias 'remember-finalize 'remember-buffer))
12981 (if org-remember-templates
12982 (let* ((entry (org-select-remember-template use-char))
12983 (tpl (car entry))
12984 (plist-p (if org-store-link-plist t nil))
12985 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
12987 (nth 1 entry)
12988 org-default-notes-file))
12989 (headline (nth 2 entry))
12990 (v-c (if (or (and (eq window-system 'x)
12991 (x-cut-buffer-or-selection-value))
12992 (bound-and-true-p x-last-selected-text)
12993 (bound-and-true-p x-last-selected-text-primary))
12994 x-last-selected-text-primary
12995 (if (> (length kill-ring) 0)
12996 (current-kill 0)
12997 nil)))
12998 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
12999 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13000 (v-u (concat "[" (substring v-t 1 -1) "]"))
13001 (v-U (concat "[" (substring v-T 1 -1) "]"))
13002 ;; `initial' and `annotation' are bound in `remember'
13003 (v-i (if (boundp 'initial) initial))
13004 (v-a (if (and (boundp 'annotation) annotation)
13005 (if (equal annotation "[[]]") "" annotation)
13006 ""))
13007 (v-A (if (and v-a
13010 v-a))
13011 (v-n user-full-name)
13012 (org-startup-folded nil)
13013 org-time-was-given org-end-time-was-given x prompt char time pos)
13014 (setq org-store-link-plist
13015 (append (list :annotation v-a :initial v-i)
13016 org-store-link-plist))
13017 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13018 (erase-buffer)
13019 (insert (substitute-command-keys
13020 (format
13021 "## Filing location: Select interactively, default, or last used:
13022 ## %s to select file and header location interactively.
13026 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13027 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13028 (abbreviate-file-name (or file org-default-notes-file))
13029 (or headline "")
13030 (or (car org-remember-previous-location) "???")
13031 (or (cdr org-remember-previous-location) "???"))))
13032 (insert tpl) (goto-char (point-min))
13033 ;; Simple %-escapes
13035 (when (and initial (equal (match-string 0) "%i"))
13036 (save-match-data
13037 (let* ((lead (buffer-substring
13038 (point-at-bol) (match-beginning 0))))
13039 (setq v-i (mapconcat 'identity
13042 (replace-match
13043 (or (eval (intern (concat "v-" (match-string 1)))) "")
13044 t t))
13046 ;; %[] Insert contents of a file.
13047 (goto-char (point-min))
13049 (let ((start (match-beginning 0))
13050 (end (match-end 0))
13051 (filename (expand-file-name (match-string 1))))
13052 (goto-char start)
13053 (delete-region start end)
13054 (condition-case error
13055 (insert-file-contents filename)
13056 (error (insert (format "%%![Couldn't insert %s: %s]"
13057 filename error))))))
13058 ;; %() embedded elisp
13059 (goto-char (point-min))
13061 (goto-char (match-beginning 0))
13062 (let ((template-start (point)))
13063 (forward-char 1)
13064 (let ((result
13065 (condition-case error
13066 (eval (read (current-buffer)))
13067 (error (format "%%![Error: %s]" error)))))
13068 (delete-region template-start (point))
13069 (insert result))))
13071 ;; From the property list
13072 (when plist-p
13073 (goto-char (point-min))
13075 (and (setq x (or (plist-get org-store-link-plist
13076 (intern (match-string 1))) ""))
13077 (replace-match x t t))))
13079 ;; Turn on org-mode in the remember buffer, set local variables
13080 (org-mode)
13081 (org-set-local 'org-finish-function 'remember-finalize)
13083 (org-set-local 'org-default-notes-file file))
13085 (org-set-local 'org-remember-default-headline headline))
13086 ;; Interactive template entries
13087 (goto-char (point-min))
13089 (setq char (if (match-end 3) (match-string 3))
13090 prompt (if (match-end 2) (match-string 2)))
13091 (goto-char (match-beginning 0))
13092 (replace-match "")
13093 (cond
13094 ((member char '("G" "g"))
13095 (let* ((org-last-tags-completion-table
13096 (org-global-tags-completion-table
13097 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13098 (org-add-colon-after-tag-completion t)
13099 (ins (completing-read
13100 (if prompt (concat prompt ": ") "Tags: ")
13101 'org-tags-completion-function nil nil nil
13102 'org-tags-history)))
13103 (setq ins (mapconcat 'identity
13104 (org-split-string ins (org-re "[^[:alnum:]]+"))
13105 ":"))
13107 (or (equal (char-before) ?:) (insert ":"))
13108 (insert ins)
13109 (or (equal (char-after) ?:) (insert ":")))))
13110 (char
13111 (setq org-time-was-given (equal (upcase char) char))
13112 (setq time (org-read-date (equal (upcase char) "U") t nil
13113 prompt))
13114 (org-insert-time-stamp time org-time-was-given
13115 (member char '("u" "U"))
13116 nil nil (list org-end-time-was-given)))
13117 (t
13118 (insert (read-string
13119 (if prompt (concat prompt ": ") "Enter string"))))))
13120 (goto-char (point-min))
13122 (replace-match "")
13124 (org-mode)
13125 (org-set-local 'org-finish-function 'remember-finalize)))
13127 ;;;###autoload
13128 (defun org-remember (&optional goto org-force-remember-template-char)
13129 "Call `remember'. If this is already a remember buffer, re-apply template.
13130 If there is an active region, make sure remember uses it as initial content
13131 of the remember buffer.
13133 When called interactively with a `C-u' prefix argument GOTO, don't remember
13134 anything, just go to the file/headline where the selected templated usually
13135 stores its notes.
13137 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13138 associated with a template in `org-remember-tempates'."
13139 (interactive "P")
13140 (if (equal goto '(4))
13141 (org-go-to-remember-target)
13142 (if (eq org-finish-function 'remember-buffer)
13143 (progn
13144 (when (< (length org-remember-templates) 2)
13145 (error "No other template available"))
13146 (erase-buffer)
13147 (let ((annotation (plist-get org-store-link-plist :annotation))
13148 (initial (plist-get org-store-link-plist :initial)))
13149 (org-remember-apply-template))
13150 (message "Press C-c C-c to remember data"))
13151 (if (org-region-active-p)
13152 (remember (buffer-substring (point) (mark)))
13153 (call-interactively 'remember)))))
13155 (defun org-go-to-remember-target (&optional template-key)
13156 "Go to the target location of a remember template.
13157 The user is queried for the template."
13158 (interactive)
13159 (let* ((entry (org-select-remember-template template-key))
13160 (file (nth 1 entry))
13161 (heading (nth 2 entry))
13162 visiting)
13164 (setq file org-default-notes-file))
13166 (setq heading org-remember-default-headline))
13167 (setq visiting (org-find-base-buffer-visiting file))
13168 (if (not visiting) (find-file-noselect file))
13169 (switch-to-buffer (or visiting (get-file-buffer file)))
13170 (widen)
13171 (goto-char (point-min))
13172 (if (re-search-forward
13175 nil t)
13176 (goto-char (match-beginning 0))
13177 (error "Target headline not found: %s" heading))))
13179 (defvar org-note-abort nil) ; dynamically scoped
13181 ;;;###autoload
13182 (defun org-remember-handler ()
13183 "Store stuff from remember.el into an org file.
13184 First prompts for an org file. If the user just presses return, the value
13185 of `org-default-notes-file' is used.
13186 Then the command offers the headings tree of the selected file in order to
13187 file the text at a specific location.
13188 You can either immediately press RET to get the note appended to the
13189 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13190 find a better place. Then press RET or <left> or <right> in insert the note.
13192 Key Cursor position Note gets inserted
13193 -----------------------------------------------------------------------------
13194 RET buffer-start as level 1 heading at end of file
13195 RET on headline as sublevel of the heading at cursor
13196 RET no heading at cursor position, level taken from context.
13197 Or use prefix arg to specify level manually.
13198 <left> on headline as same level, before current heading
13199 <right> on headline as same level, after current heading
13201 So the fastest way to store the note is to press RET RET to append it to
13202 the default file. This way your current train of thought is not
13203 interrupted, in accordance with the principles of remember.el.
13204 You can also get the fast execution without prompting by using
13205 C-u C-c C-c to exit the remember buffer. See also the variable
13206 `org-remember-store-without-prompt'.
13208 Before being stored away, the function ensures that the text has a
13210 is constructed from the current date and some additional data.
13212 If the variable `org-adapt-indentation' is non-nil, the entire text is
13213 also indented so that it starts in the same column as the headline
13214 \(i.e. after the stars).
13216 See also the variable `org-reverse-note-order'."
13217 (goto-char (point-min))
13219 (replace-match ""))
13220 (goto-char (point-max))
13221 (catch 'quit
13222 (if org-note-abort (throw 'quit nil))
13223 (let* ((txt (buffer-substring (point-min) (point-max)))
13224 (fastp (org-xor (equal current-prefix-arg '(4))
13225 org-remember-store-without-prompt))
13226 (file (if fastp org-default-notes-file (org-get-org-file)))
13227 (heading org-remember-default-headline)
13228 (visiting (org-find-base-buffer-visiting file))
13229 (org-startup-folded nil)
13230 (org-startup-align-all-tables nil)
13231 (org-goto-start-pos 1)
13232 spos exitcmd level indent reversed)
13233 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13234 (setq file (car org-remember-previous-location)
13235 heading (cdr org-remember-previous-location)))
13236 (setq current-prefix-arg nil)
13237 ;; Modify text so that it becomes a nice subtree which can be inserted
13238 ;; into an org tree.
13240 first)
13241 (setq first (car lines) lines (cdr lines))
13243 ;; Is already a headline
13244 (setq indent nil)
13245 ;; We need to add a headline: Use time and first buffer line
13246 (setq lines (cons first lines)
13247 first (concat "* " (current-time-string)
13248 " (" (remember-buffer-desc) ")")
13249 indent " "))
13250 (if (and org-adapt-indentation indent)
13251 (setq lines (mapcar
13252 (lambda (x)
13254 (concat indent x) x))
13255 lines)))
13262 ;; Find the file
13263 (if (not visiting) (find-file-noselect file))
13264 (with-current-buffer (or visiting (get-file-buffer file))
13265 (unless (org-mode-p)
13266 (error "Target files for remember notes must be in Org-mode"))
13267 (save-excursion
13268 (save-restriction
13269 (widen)
13270 (and (goto-char (point-min))
13273 (setq reversed (org-notes-order-reversed-p))
13275 ;; Find the default location
13277 (goto-char (point-min))
13278 (if (re-search-forward
13281 nil t)
13282 (setq org-goto-start-pos (match-beginning 0))
13283 (when fastp
13284 (goto-char (point-max))
13285 (unless (bolp) (newline))
13287 (setq org-goto-start-pos (point-at-bol 0)))))
13289 ;; Ask the User for a location
13290 (if fastp
13291 (setq spos org-goto-start-pos
13292 exitcmd 'return)
13293 (setq spos (org-get-location (current-buffer) org-remember-help)
13294 exitcmd (cdr spos)
13295 spos (car spos)))
13296 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13297 ; not handle this note
13298 (goto-char spos)
13299 (cond ((org-on-heading-p t)
13300 (org-back-to-heading t)
13301 (setq level (funcall outline-level))
13302 (cond
13303 ((eq exitcmd 'return)
13304 ;; sublevel of current
13305 (setq org-remember-previous-location
13306 (cons (abbreviate-file-name file)
13307 (org-get-heading 'notags)))
13308 (if reversed
13309 (outline-next-heading)
13310 (org-end-of-subtree)
13311 (if (not (bolp))
13313 (beginning-of-line 2)
13314 (end-of-line 1)
13316 (org-paste-subtree (org-get-legal-level level 1) txt))
13317 ((eq exitcmd 'left)
13318 ;; before current
13319 (org-paste-subtree level txt))
13320 ((eq exitcmd 'right)
13321 ;; after current
13322 (org-end-of-subtree t)
13323 (org-paste-subtree level txt))
13324 (t (error "This should not happen"))))
13326 ((and (bobp) (not reversed))
13327 ;; Put it at the end, one level below level 1
13328 (save-restriction
13329 (widen)
13330 (goto-char (point-max))
13331 (if (not (bolp)) (newline))
13332 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13334 ((and (bobp) reversed)
13335 ;; Put it at the start, as level 1
13336 (save-restriction
13337 (widen)
13338 (goto-char (point-min))
13340 (beginning-of-line 1)
13341 (org-paste-subtree 1 txt)))
13342 (t
13343 ;; Put it right there, with automatic level determined by
13344 ;; org-paste-subtree or from prefix arg
13345 (org-paste-subtree
13346 (if (numberp current-prefix-arg) current-prefix-arg)
13347 txt)))
13348 (when remember-save-after-remembering
13349 (save-buffer)
13350 (if (not visiting) (kill-buffer (current-buffer)))))))))
13351 t) ;; return t to indicate that we took care of this note.
13353 (defun org-get-org-file ()
13354 "Read a filename, with default directory `org-directory'."
13355 (let ((default (or org-default-notes-file remember-data-file)))
13356 (read-file-name (format "File name [%s]: " default)
13357 (file-name-as-directory org-directory)
13358 default)))
13360 (defun org-notes-order-reversed-p ()
13361 "Check if the current file should receive notes in reversed order."
13362 (cond
13363 ((not org-reverse-note-order) nil)
13364 ((eq t org-reverse-note-order) t)
13365 ((not (listp org-reverse-note-order)) nil)
13366 (t (catch 'exit
13367 (let ((all org-reverse-note-order)
13368 entry)
13369 (while (setq entry (pop all))
13370 (if (string-match (car entry) buffer-file-name)
13371 (throw 'exit (cdr entry))))
13372 nil)))))
13374 ;;; Refiling
13376 (defvar org-refile-target-table nil
13377 "The list of refile targets, created by `org-refile'.")
13379 (defvar org-agenda-new-buffers nil
13380 "Buffers created to visit agenda files.")
13382 (defun org-get-refile-targets ()
13383 "Produce a table with refile targets."
13384 (let ((entries org-refile-targets)
13385 org-agenda-new-files targets txt re files f desc descre)
13386 (while (setq entry (pop entries))
13387 (setq files (car entry) desc (cdr entry))
13388 (cond
13389 ((null files) (setq files (list (current-buffer))))
13390 ((eq files 'org-agenda-files)
13391 (setq files (org-agenda-files 'unrestricted)))
13392 ((and (symbolp files) (fboundp files))
13393 (setq files (funcall files)))
13394 ((and (symbolp files) (boundp files))
13395 (setq files (symbol-value files))))
13396 (if (stringp files) (setq files (list files)))
13397 (cond
13398 ((eq (car desc) :tag)
13400 ((eq (car desc) :todo)
13402 ((eq (car desc) :regexp)
13403 (setq descre (cdr desc)))
13404 ((eq (car desc) :level)
13406 (if org-odd-levels-only
13407 (1- (* 2 (cdr desc)))
13408 (cdr desc)))
13410 (t (error "Bad refiling target description %s" desc)))
13411 (while (setq f (pop files))
13412 (save-excursion
13413 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13414 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13415 (save-excursion
13416 (save-restriction
13417 (widen)
13418 (goto-char (point-min))
13419 (while (re-search-forward descre nil t)
13420 (goto-char (point-at-bol))
13421 (when (looking-at org-complex-heading-regexp)
13422 (setq txt (match-string 4)
13423 re (concat "^" (regexp-quote
13424 (buffer-substring (match-beginning 1)
13425 (match-end 4)))))
13427 (regexp-quote
13428 (match-string 5)))))
13430 (push (list txt f re (point)) targets))
13431 (goto-char (point-at-eol))))))))
13432 (org-release-buffers org-agenda-new-buffers)
13433 (nreverse targets)))
13435 (defun org-refile (&optional reversed-or-update)
13436 "Move the entry at point to another heading.
13437 The list of target headings is compiled using the information in
13438 `org-refile-targets', which see. This list is created upon first use, and
13439 you can update it by calling this command with a double prefix (`C-u C-u').
13441 At the target location, the entry is filed as a subitem of the target heading.
13442 Depending on `org-reverse-note-order', the new subitem will either be the
13443 first of the last subitem. A single C-u prefix will toggle the value of this
13444 variable for the duration of the command."
13445 (interactive "P")
13446 (if (equal reversed-or-update '(16))
13447 (progn
13448 (setq org-refile-target-table (org-get-refile-targets))
13449 (message "Refile targets updated (%d targets)"
13450 (length org-refile-target-table)))
13451 (when (or (not org-refile-target-table)
13452 (and (= (length org-refile-targets) 1)
13453 (not (caar org-refile-targets))))
13454 (setq org-refile-target-table (org-get-refile-targets)))
13455 (unless org-refile-target-table
13456 (error "No refile targets"))
13457 (let* ((cbuf (current-buffer))
13458 (filename (buffer-file-name (buffer-base-buffer cbuf)))
13459 (fname (and filename (file-truename filename)))
13460 (tbl (mapcar
13461 (lambda (x)
13462 (if (not (equal fname (file-truename (nth 1 x))))
13463 (cons (concat (car x) " (" (file-name-nondirectory
13464 (nth 1 x)) ")")
13465 (cdr x))
13466 x))
13467 org-refile-target-table))
13468 (completion-ignore-case t)
13469 pos it nbuf file re level reversed)
13470 (when (setq it (completing-read "Refile to: " tbl
13471 nil t nil 'org-refile-history))
13472 (setq it (assoc it tbl)
13473 file (nth 1 it)
13474 re (nth 2 it))
13475 (org-copy-special)
13476 (save-excursion
13477 (set-buffer (setq nbuf (or (find-buffer-visiting file)
13478 (find-file-noselect file))))
13479 (setq reversed (org-notes-order-reversed-p))
13480 (if (equal reversed-or-update '(16)) (setq reversed (not reversed)))
13481 (save-excursion
13482 (save-restriction
13483 (widen)
13484 (goto-char (point-min))
13485 (unless (re-search-forward re nil t)
13486 (error "Cannot find target location - try again with `C-u' prefix."))
13487 (goto-char (match-beginning 0))
13488 (looking-at outline-regexp)
13489 (setq level (org-get-legal-level (funcall outline-level) 1))
13490 (goto-char (or (save-excursion
13491 (if reversed
13492 (outline-next-heading)
13493 (outline-get-next-sibling)))
13494 (point-max)))
13495 (org-paste-subtree level))))
13496 (org-cut-special)
13499 ;;;; Dynamic blocks
13501 (defun org-find-dblock (name)
13502 "Find the first dynamic block with name NAME in the buffer.
13503 If not found, stay at current position and return nil."
13504 (let (pos)
13505 (save-excursion
13506 (goto-char (point-min))
13508 nil t)
13509 (match-beginning 0))))
13510 (if pos (goto-char pos))
13511 pos))
13513 (defconst org-dblock-start-re
13515 "Matches the startline of a dynamic block, with parameters.")
13518 "Matches the end of a dyhamic block.")
13520 (defun org-create-dblock (plist)
13521 "Create a dynamic block section, with parameters taken from PLIST.
13522 PLIST must containe a :name entry which is used as name of the block."
13523 (unless (bolp) (newline))
13524 (let ((name (plist-get plist :name)))
13525 (insert "#+BEGIN: " name)
13526 (while plist
13527 (if (eq (car plist) :name)
13528 (setq plist (cddr plist))
13529 (insert " " (prin1-to-string (pop plist)))))
13531 (beginning-of-line -2)))
13533 (defun org-prepare-dblock ()
13534 "Prepare dynamic block for refresh.
13535 This empties the block, puts the cursor at the insert position and returns
13536 the property list including an extra property :name with the block name."
13537 (unless (looking-at org-dblock-start-re)
13538 (error "Not at a dynamic block"))
13539 (let* ((begdel (1+ (match-end 0)))
13540 (name (org-no-properties (match-string 1)))
13541 (params (append (list :name name)
13542 (read (concat "(" (match-string 3) ")")))))
13543 (unless (re-search-forward org-dblock-end-re nil t)
13544 (error "Dynamic block not terminated"))
13545 (delete-region begdel (match-beginning 0))
13546 (goto-char begdel)
13547 (open-line 1)
13548 params))
13550 (defun org-map-dblocks (&optional command)
13551 "Apply COMMAND to all dynamic blocks in the current buffer.
13552 If COMMAND is not given, use `org-update-dblock'."
13553 (let ((cmd (or command 'org-update-dblock))
13554 pos)
13555 (save-excursion
13556 (goto-char (point-min))
13557 (while (re-search-forward org-dblock-start-re nil t)
13558 (goto-char (setq pos (match-beginning 0)))
13559 (condition-case nil
13560 (funcall cmd)
13561 (error (message "Error during update of dynamic block")))
13562 (goto-char pos)
13563 (unless (re-search-forward org-dblock-end-re nil t)
13564 (error "Dynamic block not terminated"))))))
13566 (defun org-dblock-update (&optional arg)
13567 "User command for updating dynamic blocks.
13568 Update the dynamic block at point. With prefix ARG, update all dynamic
13569 blocks in the buffer."
13570 (interactive "P")
13571 (if arg
13572 (org-update-all-dblocks)
13573 (or (looking-at org-dblock-start-re)
13574 (org-beginning-of-dblock))
13575 (org-update-dblock)))
13577 (defun org-update-dblock ()
13578 "Update the dynamic block at point
13579 This means to empty the block, parse for parameters and then call
13580 the correct writing function."
13581 (save-window-excursion
13582 (let* ((pos (point))
13583 (line (org-current-line))
13584 (params (org-prepare-dblock))
13585 (name (plist-get params :name))
13586 (cmd (intern (concat "org-dblock-write:" name))))
13587 (message "Updating dynamic block `%s' at line %d..." name line)
13588 (funcall cmd params)
13589 (message "Updating dynamic block `%s' at line %d...done" name line)
13590 (goto-char pos))))
13592 (defun org-beginning-of-dblock ()
13593 "Find the beginning of the dynamic block at point.
13594 Error if there is no scuh block at point."
13595 (let ((pos (point))
13596 beg)
13597 (end-of-line 1)
13598 (if (and (re-search-backward org-dblock-start-re nil t)
13599 (setq beg (match-beginning 0))
13600 (re-search-forward org-dblock-end-re nil t)
13601 (> (match-end 0) pos))
13602 (goto-char beg)
13603 (goto-char pos)
13604 (error "Not in a dynamic block"))))
13606 (defun org-update-all-dblocks ()
13607 "Update all dynamic blocks in the buffer.
13608 This function can be used in a hook."
13609 (when (org-mode-p)
13610 (org-map-dblocks 'org-update-dblock)))
13613 ;;;; Completion
13615 (defconst org-additional-option-like-keywords
13616 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
13617 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
13618 "BEGIN_EXAMPLE" "END_EXAMPLE"))
13620 (defun org-complete (&optional arg)
13621 "Perform completion on word at point.
13622 At the beginning of a headline, this completes TODO keywords as given in
13623 `org-todo-keywords'.
13624 If the current word is preceded by a backslash, completes the TeX symbols
13625 that are supported for HTML support.
13627 setting file options.
13629 At all other locations, this simply calls the value of
13630 `org-completion-fallback-command'."
13631 (interactive "P")
13632 (org-without-partial-completion
13633 (catch 'exit
13634 (let* ((end (point))
13635 (beg1 (save-excursion
13636 (skip-chars-backward (org-re "[:alnum:]_@"))
13637 (point)))
13638 (beg (save-excursion
13639 (skip-chars-backward "a-zA-Z0-9_:$")
13640 (point)))
13641 (confirm (lambda (x) (stringp (car x))))
13642 (searchhead (equal (char-before beg) ?*))
13643 (tag (and (equal (char-before beg1) ?:)
13644 (equal (char-after (point-at-bol)) ?*)))
13645 (prop (and (equal (char-before beg1) ?:)
13646 (not (equal (char-after (point-at-bol)) ?*))))
13648 (link (equal (char-before beg) ?\[))
13649 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
13650 beg)
13651 "#+"))
13653 (buffer-substring (point-at-bol) (point))))
13654 (completion-ignore-case opt)
13655 (type nil)
13656 (tbl nil)
13657 (table (cond
13658 (opt
13659 (setq type :opt)
13660 (append
13661 (mapcar
13662 (lambda (x)
13664 (cons (match-string 2 x) (match-string 1 x)))
13666 (mapcar 'list org-additional-option-like-keywords)))
13667 (startup
13668 (setq type :startup)
13669 org-startup-options)
13670 (link (append org-link-abbrev-alist-local
13671 org-link-abbrev-alist))
13672 (texp
13673 (setq type :tex)
13674 org-html-entities)
13676 (buffer-substring (point-at-bol) beg))
13677 (setq type :todo)
13678 (mapcar 'list org-todo-keywords-1))
13679 (searchhead
13680 (setq type :searchhead)
13681 (save-excursion
13682 (goto-char (point-min))
13683 (while (re-search-forward org-todo-line-regexp nil t)
13684 (push (list
13685 (org-make-org-heading-search-string
13686 (match-string 3) t))
13687 tbl)))
13688 tbl)
13689 (tag (setq type :tag beg beg1)
13690 (or org-tag-alist (org-get-buffer-tags)))
13691 (prop (setq type :prop beg beg1)
13692 (mapcar 'list (org-buffer-property-keys)))
13693 (t (progn
13694 (call-interactively org-completion-fallback-command)
13695 (throw 'exit nil)))))
13696 (pattern (buffer-substring-no-properties beg end))
13697 (completion (try-completion pattern table confirm)))
13698 (cond ((eq completion t)
13699 (if (not (assoc (upcase pattern) table))
13700 (message "Already complete")
13701 (if (equal type :opt)
13702 (insert (substring (cdr (assoc (upcase pattern) table))
13703 (length pattern)))
13704 (if (memq type '(:tag :prop)) (insert ":")))))
13705 ((null completion)
13707 (ding))
13708 ((not (string= pattern completion))
13709 (delete-region beg end)
13710 (if (string-match " +$" completion)
13711 (setq completion (replace-match "" t t completion)))
13712 (insert completion)
13713 (if (get-buffer-window "*Completions*")
13714 (delete-window (get-buffer-window "*Completions*")))
13715 (if (assoc completion table)
13716 (if (eq type :todo) (insert " ")
13717 (if (memq type '(:tag :prop)) (insert ":"))))
13718 (if (and (equal type :opt) (assoc completion table))
13719 (message "%s" (substitute-command-keys
13721 (t
13722 (message "Making completion list...")
13723 (let ((list (sort (all-completions pattern table confirm)
13724 'string<)))
13725 (with-output-to-temp-buffer "*Completions*"
13726 (condition-case nil
13727 ;; Protection needed for XEmacs and emacs 21
13728 (display-completion-list list pattern)
13729 (error (display-completion-list list)))))
13730 (message "Making completion list...%s" "done")))))))
13732 ;;;; TODO, DEADLINE, Comments
13734 (defun org-toggle-comment ()
13735 "Change the COMMENT state of an entry."
13736 (interactive)
13737 (save-excursion
13738 (org-back-to-heading)
13739 (let (case-fold-search)
13740 (if (looking-at (concat outline-regexp
13742 (replace-match "" t t nil 1)
13743 (if (looking-at outline-regexp)
13744 (progn
13745 (goto-char (match-end 0))
13746 (insert org-comment-string " ")))))))
13748 (defvar org-last-todo-state-is-todo nil
13749 "This is non-nil when the last TODO state change led to a TODO state.
13750 If the last change removed the TODO tag or switched to DONE, then
13751 this is nil.")
13753 (defvar org-setting-tags nil) ; dynamically skiped
13755 ;; FIXME: better place
13756 (defun org-property-or-variable-value (var &optional inherit)
13757 "Check if there is a property fixing the value of VAR.
13758 If yes, return this value. If not, return the current value of the variable."
13759 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13761 (read prop)
13762 (symbol-value var))))
13764 (defun org-parse-local-options (string var)
13765 "Parse STRING for startup setting relevant for variable VAR."
13766 (let ((rtn (symbol-value var))
13767 e opts)
13768 (save-match-data
13770 rtn
13771 (setq opts (delq nil (mapcar (lambda (x)
13772 (setq e (assoc x org-startup-options))
13773 (if (eq (nth 1 e) var) e nil))
13775 (if (not opts)
13776 rtn
13777 (setq rtn nil)
13778 (while (setq e (pop opts))
13779 (if (not (nth 3 e))
13780 (setq rtn (nth 2 e))
13781 (if (not (listp rtn)) (setq rtn nil))
13782 (push (nth 2 e) rtn)))
13783 rtn)))))
13785 (defvar org-blocker-hook nil
13786 "Hook for functions that are allowed to block a state change.
13788 Each function gets as its single argument a property list, see
13789 `org-trigger-hook' for more information about this list.
13791 If any of the functions in this hook returns nil, the state change
13792 is blocked.")
13794 (defvar org-trigger-hook nil
13795 "Hook for functions that are triggered by a state change.
13797 Each function gets as its single argument a property list with at least
13798 the following elements:
13800 (:type type-of-change :position pos-at-entry-start
13801 :from old-state :to new-state)
13803 Depending on the type, more properties may be present.
13805 This mechanism is currently implemented for:
13807 TODO state changes
13808 ------------------
13809 :type todo-state-change
13810 :from previous state (keyword as a string), or nil
13811 :to new state (keyword as a string), or nil")
13814 (defun org-todo (&optional arg)
13815 "Change the TODO state of an item.
13816 The state of an item is given by a keyword at the start of the heading,
13817 like
13818 *** TODO Write paper
13819 *** DONE Call mom
13821 The different keywords are specified in the variable `org-todo-keywords'.
13823 So for this example: when the item starts with TODO, it is changed to DONE.
13824 When it starts with DONE, the DONE is removed. And when neither TODO nor
13825 DONE are present, add TODO at the beginning of the heading.
13827 With C-u prefix arg, use completion to determine the new state.
13828 With numeric prefix arg, switch to that state.
13830 For calling through lisp, arg is also interpreted in the following way:
13831 'none -> empty state
13833 'done -> switch to DONE
13834 'nextset -> switch to the next set of keywords
13835 'previousset -> switch to the previous set of keywords
13837 really is a member of `org-todo-keywords'."
13838 (interactive "P")
13839 (save-excursion
13840 (catch 'exit
13841 (org-back-to-heading)
13842 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
13843 (or (looking-at (concat " +" org-todo-regexp " *"))
13844 (looking-at " *"))
13845 (let* ((match-data (match-data))
13846 (startpos (point-at-bol))
13847 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
13848 (org-log-done (org-parse-local-options logging 'org-log-done))
13849 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
13850 (this (match-string 1))
13851 (hl-pos (match-beginning 0))
13852 (head (org-get-todo-sequence-head this))
13853 (ass (assoc head org-todo-kwd-alist))
13854 (interpret (nth 1 ass))
13855 (done-word (nth 3 ass))
13856 (final-done-word (nth 4 ass))
13857 (last-state (or this ""))
13858 (completion-ignore-case t)
13859 (member (member this org-todo-keywords-1))
13860 (tail (cdr member))
13861 (state (cond
13862 ((and org-todo-key-trigger
13863 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
13864 (and (not arg) org-use-fast-todo-selection
13865 (not (eq org-use-fast-todo-selection 'prefix)))))
13866 ;; Use fast selection
13867 (org-fast-todo-selection))
13868 ((and (equal arg '(4))
13869 (or (not org-use-fast-todo-selection)
13870 (not org-todo-key-trigger)))
13871 ;; Read a state with completion
13872 (completing-read "State: " (mapcar (lambda(x) (list x))
13873 org-todo-keywords-1)
13874 nil t))
13875 ((eq arg 'right)
13876 (if this
13877 (if tail (car tail) nil)
13878 (car org-todo-keywords-1)))
13879 ((eq arg 'left)
13880 (if (equal member org-todo-keywords-1)
13881 nil
13882 (if this
13883 (nth (- (length org-todo-keywords-1) (length tail) 2)
13884 org-todo-keywords-1)
13885 (org-last org-todo-keywords-1))))
13886 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
13887 (setq arg nil))) ; hack to fall back to cycling
13888 (arg
13889 ;; user or caller requests a specific state
13890 (cond
13891 ((equal arg "") nil)
13892 ((eq arg 'none) nil)
13893 ((eq arg 'done) (or done-word (car org-done-keywords)))
13894 ((eq arg 'nextset)
13895 (or (car (cdr (member head org-todo-heads)))
13896 (car org-todo-heads)))
13897 ((eq arg 'previousset)
13898 (let ((org-todo-heads (reverse org-todo-heads)))
13899 (or (car (cdr (member head org-todo-heads)))
13900 (car org-todo-heads))))
13901 ((car (member arg org-todo-keywords-1)))
13902 ((nth (1- (prefix-numeric-value arg))
13903 org-todo-keywords-1))))
13904 ((null member) (or head (car org-todo-keywords-1)))
13905 ((equal this final-done-word) nil) ;; -> make empty
13906 ((null tail) nil) ;; -> first entry
13907 ((eq interpret 'sequence)
13908 (car tail))
13909 ((memq interpret '(type priority))
13910 (if (eq this-command last-command)
13911 (car tail)
13912 (if (> (length tail) 0)
13913 (or done-word (car org-done-keywords))
13914 nil)))
13915 (t nil)))
13916 (next (if state (concat " " state " ") " "))
13917 (change-plist (list :type 'todo-state-change :from this :to state
13918 :position startpos))
13919 dostates)
13920 (when org-blocker-hook
13921 (unless (save-excursion
13922 (save-match-data
13923 (run-hook-with-args-until-failure
13924 'org-blocker-hook change-plist)))
13925 (if (interactive-p)
13926 (error "TODO state change from %s to %s blocked" this state)
13927 ;; fail silently
13928 (message "TODO state change from %s to %s blocked" this state)
13929 (throw 'exit nil))))
13930 (store-match-data match-data)
13931 (replace-match next t t)
13932 (unless (pos-visible-in-window-p hl-pos)
13933 (message "TODO state changed to %s" (org-trim next)))
13934 (unless head
13935 (setq head (org-get-todo-sequence-head state)
13936 ass (assoc head org-todo-kwd-alist)
13937 interpret (nth 1 ass)
13938 done-word (nth 3 ass)
13939 final-done-word (nth 4 ass)))
13940 (when (memq arg '(nextset previousset))
13941 (message "Keyword-Set %d/%d: %s"
13942 (- (length org-todo-sets) -1
13943 (length (memq (assoc state org-todo-sets) org-todo-sets)))
13944 (length org-todo-sets)
13945 (mapconcat 'identity (assoc state org-todo-sets) " ")))
13946 (setq org-last-todo-state-is-todo
13947 (not (member state org-done-keywords)))
13948 (when (and org-log-done (not (memq arg '(nextset previousset))))
13949 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
13950 (or (not org-todo-log-states)
13951 (member state org-todo-log-states))))
13953 (cond
13954 ((and state (member state org-not-done-keywords)
13955 (not (member this org-not-done-keywords)))
13956 ;; This is now a todo state and was not one before
13957 ;; Remove any CLOSED timestamp, and possibly log the state change
13958 (org-add-planning-info nil nil 'closed)
13959 (and dostates (org-add-log-maybe 'state state 'findpos)))
13960 ((and state dostates)
13961 ;; This is a non-nil state, and we need to log it
13962 (org-add-log-maybe 'state state 'findpos))
13963 ((and (member state org-done-keywords)
13964 (not (member this org-done-keywords)))
13965 ;; It is now done, and it was not done before
13966 (org-add-planning-info 'closed (org-current-time))
13967 (org-add-log-maybe 'done state 'findpos))))
13968 ;; Fixup tag positioning
13969 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
13970 (run-hooks 'org-after-todo-state-change-hook)
13971 (and (member state org-done-keywords) (org-auto-repeat-maybe))
13972 (if (and arg (not (member state org-done-keywords)))
13973 (setq head (org-get-todo-sequence-head state)))
13974 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
13975 ;; Fixup cursor location if close to the keyword
13976 (if (and (outline-on-heading-p)
13977 (not (bolp))
13978 (save-excursion (beginning-of-line 1)
13979 (looking-at org-todo-line-regexp))
13980 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
13981 (progn
13982 (goto-char (or (match-end 2) (match-end 1)))
13983 (just-one-space)))
13984 (when org-trigger-hook
13985 (save-excursion
13986 (run-hook-with-args 'org-trigger-hook change-plist)))))))
13988 (defun org-get-todo-sequence-head (kwd)
13989 "Return the head of the TODO sequence to which KWD belongs.
13990 If KWD is not set, check if there is a text property remembering the
13991 right sequence."
13992 (let (p)
13993 (cond
13994 ((not kwd)
13995 (or (get-text-property (point-at-bol) 'org-todo-head)
13996 (progn
13997 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13998 nil (point-at-eol)))
13999 (get-text-property p 'org-todo-head))))
14000 ((not (member kwd org-todo-keywords-1))
14001 (car org-todo-keywords-1))
14002 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14004 (defun org-fast-todo-selection ()
14005 "Fast TODO keyword selection with single keys.
14006 Returns the new TODO keyword, or nil if no state change should occur."
14007 (let* ((fulltable org-todo-key-alist)
14008 (done-keywords org-done-keywords) ;; needed for the faces.
14009 (maxlen (apply 'max (mapcar
14010 (lambda (x)
14011 (if (stringp (car x)) (string-width (car x)) 0))
14012 fulltable)))
14013 (expert nil)
14014 (fwidth (+ maxlen 3 1 3))
14015 (ncol (/ (- (window-width) 4) fwidth))
14016 tg cnt e c tbl
14017 groups ingroup)
14018 (save-window-excursion
14019 (if expert
14020 (set-buffer (get-buffer-create " *Org todo*"))
14021 ; (delete-other-windows)
14022 ; (split-window-vertically)
14023 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14024 (erase-buffer)
14025 (org-set-local 'org-done-keywords done-keywords)
14026 (setq tbl fulltable cnt 0)
14027 (while (setq e (pop tbl))
14028 (cond
14029 ((equal e '(:startgroup))
14030 (push '() groups) (setq ingroup t)
14031 (when (not (= cnt 0))
14032 (setq cnt 0)
14034 (insert "{ "))
14035 ((equal e '(:endgroup))
14036 (setq ingroup nil cnt 0)
14038 (t
14039 (setq tg (car e) c (cdr e))
14040 (if ingroup (push tg (car groups)))
14041 (setq tg (org-add-props tg nil 'face
14042 (org-get-todo-face tg)))
14043 (if (and (= cnt 0) (not ingroup)) (insert " "))
14044 (insert "[" c "] " tg (make-string
14045 (- fwidth 4 (length tg)) ?\ ))
14046 (when (= (setq cnt (1+ cnt)) ncol)
14048 (if ingroup (insert " "))
14049 (setq cnt 0)))))
14051 (goto-char (point-min))
14052 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14053 (fit-window-to-buffer))
14054 (message "[a-z..]:Set [SPC]:clear")
14055 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14056 (cond
14057 ((or (= c ?\C-g)
14058 (and (= c ?q) (not (rassoc c fulltable))))
14059 (setq quit-flag t))
14060 ((= c ?\ ) nil)
14061 ((setq e (rassoc c fulltable) tg (car e))
14062 tg)
14063 (t (setq quit-flag t))))))
14065 (defun org-get-repeat ()
14066 "Check if tere is a deadline/schedule with repeater in this entry."
14067 (save-match-data
14068 (save-excursion
14069 (org-back-to-heading t)
14070 (if (re-search-forward
14071 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14072 (match-string 1)))))
14074 (defvar org-last-changed-timestamp)
14075 (defvar org-log-post-message)
14076 (defun org-auto-repeat-maybe ()
14077 "Check if the current headline contains a repeated deadline/schedule.
14078 If yes, set TODO state back to what it was and change the base date
14079 of repeating deadline/scheduled time stamps to new date.
14080 This function should be run in the `org-after-todo-state-change-hook'."
14081 ;; last-state is dynamically scoped into this function
14082 (let* ((repeat (org-get-repeat))
14083 (aa (assoc last-state org-todo-kwd-alist))
14084 (interpret (nth 1 aa))
14085 (head (nth 2 aa))
14086 (done-word (nth 3 aa))
14087 (whata '(("d" . day) ("m" . month) ("y" . year)))
14088 (msg "Entry repeats: ")
14089 (org-log-done)
14090 re type n what ts)
14091 (when repeat
14092 (org-todo (if (eq interpret 'type) last-state head))
14093 (when (and org-log-repeat
14094 (not (memq 'org-add-log-note
14095 (default-value 'post-command-hook))))
14096 ;; Make sure a note is taken
14097 (let ((org-log-done '(done)))
14098 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
14099 'findpos)))
14100 (org-back-to-heading t)
14101 (org-add-planning-info nil nil 'closed)
14104 (while (re-search-forward
14105 re (save-excursion (outline-next-heading) (point)) t)
14106 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
14107 ts (match-string (if (match-end 2) 2 4)))
14109 (setq n (string-to-number (match-string 1 ts))
14110 what (match-string 2 ts))
14111 (if (equal what "w") (setq n (* n 7) what "d"))
14112 (org-timestamp-change n (cdr (assoc what whata))))
14113 (setq msg (concat msg type org-last-changed-timestamp " ")))
14114 (setq org-log-post-message msg)
14115 (message msg))))
14117 (defun org-show-todo-tree (arg)
14118 "Make a compact tree which shows all headlines marked with TODO.
14119 The tree will show the lines where the regexp matches, and all higher
14120 headlines above the match.
14122 With a numeric prefix N, construct a sparse tree for the Nth element
14123 of `org-todo-keywords-1'."
14124 (interactive "P")
14125 (let ((case-fold-search nil)
14126 (kwd-re
14127 (cond ((null arg) org-not-done-regexp)
14128 ((equal arg '(4))
14129 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14130 (mapcar 'list org-todo-keywords-1))))
14134 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14135 (regexp-quote (nth (1- (prefix-numeric-value arg))
14136 org-todo-keywords-1)))
14137 (t (error "Invalid prefix argument: %s" arg)))))
14138 (message "%d TODO entries found"
14139 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14141 (defun org-deadline (&optional remove)
14143 With argument REMOVE, remove any deadline from the item."
14144 (interactive "P")
14145 (if remove
14146 (progn
14147 (org-add-planning-info nil nil 'deadline)
14148 (message "Item no longer has a deadline."))
14149 (org-add-planning-info 'deadline nil 'closed)))
14151 (defun org-schedule (&optional remove)
14152 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14153 With argument REMOVE, remove any scheduling date from the item."
14154 (interactive "P")
14155 (if remove
14156 (progn
14157 (org-add-planning-info nil nil 'scheduled)
14158 (message "Item is no longer scheduled."))
14159 (org-add-planning-info 'scheduled nil 'closed)))
14161 (defun org-add-planning-info (what &optional time &rest remove)
14162 "Insert new timestamp with keyword in the line directly after the headline.
14163 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14164 If non is given, the user is prompted for a date.
14165 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14166 be removed."
14167 (interactive)
14168 (let (org-time-was-given org-end-time-was-given)
14169 (when what (setq time (or time (org-read-date nil 'to-time))))
14170 (when (and org-insert-labeled-timestamps-at-point
14171 (member what '(scheduled deadline)))
14172 (insert
14173 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14174 (org-insert-time-stamp time org-time-was-given
14175 nil nil nil (list org-end-time-was-given))
14176 (setq what nil))
14177 (save-excursion
14178 (save-restriction
14179 (let (col list elt ts buffer-invisibility-spec)
14180 (org-back-to-heading t)
14182 (goto-char (match-end 1))
14183 (setq col (current-column))
14184 (goto-char (match-end 0))
14186 (if (and (not (looking-at outline-regexp))
14189 (not (equal (match-string 1) org-clock-string)))
14190 (narrow-to-region (match-beginning 0) (match-end 0))
14192 (backward-char 1)
14193 (narrow-to-region (point) (point))
14194 (indent-to-column col))
14195 ;; Check if we have to remove something.
14196 (setq list (cons what remove))
14197 (while list
14198 (setq elt (pop list))
14199 (goto-char (point-min))
14200 (when (or (and (eq elt 'scheduled)
14201 (re-search-forward org-scheduled-time-regexp nil t))
14202 (and (eq elt 'deadline)
14203 (re-search-forward org-deadline-time-regexp nil t))
14204 (and (eq elt 'closed)
14205 (re-search-forward org-closed-time-regexp nil t)))
14206 (replace-match "")
14207 (if (looking-at "--+<[^>]+>") (replace-match ""))
14208 (if (looking-at " +") (replace-match ""))))
14209 (goto-char (point-max))
14210 (when what
14211 (insert
14212 (if (not (equal (char-before) ?\ )) " " "")
14213 (cond ((eq what 'scheduled) org-scheduled-string)
14214 ((eq what 'deadline) org-deadline-string)
14215 ((eq what 'closed) org-closed-string))
14216 " ")
14217 (setq ts (org-insert-time-stamp
14218 time
14219 (or org-time-was-given
14220 (and (eq what 'closed) org-log-done-with-time))
14221 (eq what 'closed)
14222 nil nil (list org-end-time-was-given)))
14223 (end-of-line 1))
14224 (goto-char (point-min))
14225 (widen)
14227 (replace-match ""))
14228 ts)))))
14230 (defvar org-log-note-marker (make-marker))
14231 (defvar org-log-note-purpose nil)
14232 (defvar org-log-note-state nil)
14233 (defvar org-log-note-window-configuration nil)
14234 (defvar org-log-note-return-to (make-marker))
14235 (defvar org-log-post-message nil
14236 "Message to be displayed after a log note has been stored.
14237 The auto-repeater uses this.")
14239 (defun org-add-log-maybe (&optional purpose state findpos)
14240 "Set up the post command hook to take a note."
14241 (save-excursion
14242 (when (and (listp org-log-done)
14243 (memq purpose org-log-done))
14244 (when findpos
14245 (org-back-to-heading t)
14249 (goto-char (match-end 0))
14250 (unless org-log-states-order-reversed
14252 (org-skip-over-state-notes)
14254 (move-marker org-log-note-marker (point))
14255 (setq org-log-note-purpose purpose)
14256 (setq org-log-note-state state)
14257 (add-hook 'post-command-hook 'org-add-log-note 'append))))
14259 (defun org-skip-over-state-notes ()
14260 "Skip past the list of State notes in an entry."
14263 (condition-case nil
14264 (org-next-item)
14265 (error (org-end-of-item)))))
14267 (defun org-add-log-note (&optional purpose)
14268 "Pop up a window for taking a note, and add this note later at point."
14269 (remove-hook 'post-command-hook 'org-add-log-note)
14270 (setq org-log-note-window-configuration (current-window-configuration))
14271 (delete-other-windows)
14272 (move-marker org-log-note-return-to (point))
14273 (switch-to-buffer (marker-buffer org-log-note-marker))
14274 (goto-char org-log-note-marker)
14275 (org-switch-to-buffer-other-window "*Org Note*")
14276 (erase-buffer)
14277 (let ((org-inhibit-startup t)) (org-mode))
14278 (insert (format "# Insert note for %s.
14280 (cond
14281 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14282 ((eq org-log-note-purpose 'done) "closed todo item")
14283 ((eq org-log-note-purpose 'state)
14285 (t (error "This should not happen")))))
14286 (org-set-local 'org-finish-function 'org-store-log-note))
14288 (defun org-store-log-note ()
14289 "Finish taking a log note, and insert it to where it belongs."
14290 (let ((txt (buffer-string))
14291 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14292 lines ind)
14293 (kill-buffer (current-buffer))
14295 (setq txt (replace-match "" t t txt)))
14297 (setq txt (replace-match "" t t txt)))
14300 (setq note
14301 (org-replace-escapes
14302 note
14303 (list (cons "%u" (user-login-name))
14304 (cons "%U" user-full-name)
14305 (cons "%t" (format-time-string
14306 (org-time-stamp-format 'long 'inactive)
14307 (current-time)))
14308 (cons "%s" (if org-log-note-state
14310 "")))))
14312 (push note lines))
14313 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14314 (when lines
14315 (save-excursion
14316 (set-buffer (marker-buffer org-log-note-marker))
14317 (save-excursion
14318 (goto-char org-log-note-marker)
14319 (move-marker org-log-note-marker nil)
14320 (end-of-line 1)
14322 (indent-relative nil)
14323 (insert "- " (pop lines))
14324 (org-indent-line-function)
14325 (beginning-of-line 1)
14327 (setq ind (concat (match-string 0) " "))
14328 (end-of-line 1)
14330 (set-window-configuration org-log-note-window-configuration)
14331 (with-current-buffer (marker-buffer org-log-note-return-to)
14332 (goto-char org-log-note-return-to))
14333 (move-marker org-log-note-return-to nil)
14334 (and org-log-post-message (message org-log-post-message)))
14336 ;; FIXME: what else would be useful?
14337 ;; - priority
14338 ;; - date
14340 (defun org-sparse-tree (&optional arg)
14341 "Create a sparse tree, prompt for the details.
14342 This command can create sparse trees. You first need to select the type
14343 of match used to create the tree:
14345 t Show entries with a specific TODO keyword.
14346 T Show entries selected by a tags match.
14347 p Enter a property name and its value (both with completion on existing
14348 names/values) and show entries with that property.
14349 r Show entries matching a regular expression"
14350 (interactive "P")
14351 (let (ans kwd value)
14352 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines")
14353 (setq ans (read-char-exclusive))
14354 (cond
14355 ((equal ans ?d)
14356 (call-interactively 'org-check-deadlines))
14357 ((equal ans ?t)
14358 (org-show-todo-tree '(4)))
14359 ((equal ans ?T)
14360 (call-interactively 'org-tags-sparse-tree))
14361 ((member ans '(?p ?P))
14362 (setq kwd (completing-read "Property: "
14363 (mapcar 'list (org-buffer-property-keys))))
14364 (setq value (completing-read "Value: "
14365 (mapcar 'list (org-property-values kwd))))
14368 (org-tags-sparse-tree arg (concat kwd "=" value)))
14369 ((member ans '(?r ?R ?/))
14370 (call-interactively 'org-occur))
14373 (defvar org-occur-highlights nil)
14374 (make-variable-buffer-local 'org-occur-highlights)
14376 (defun org-occur (regexp &optional keep-previous callback)
14377 "Make a compact tree which shows all matches of REGEXP.
14378 The tree will show the lines where the regexp matches, and all higher
14379 headlines above the match. It will also show the heading after the match,
14380 to make sure editing the matching entry is easy.
14381 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
14382 call to `org-occur' will be kept, to allow stacking of calls to this
14383 command.
14384 If CALLBACK is non-nil, it is a function which is called to confirm
14385 that the match should indeed be shown."
14387 (or keep-previous (org-remove-occur-highlights nil nil t))
14388 (let ((cnt 0))
14389 (save-excursion
14390 (goto-char (point-min))
14391 (if (or (not keep-previous) ; do not want to keep
14392 (not org-occur-highlights)) ; no previous matches
14393 ;; hide everything
14394 (org-overview))
14395 (while (re-search-forward regexp nil t)
14396 (when (or (not callback)
14397 (save-match-data (funcall callback)))
14398 (setq cnt (1+ cnt))
14399 (when org-highlight-sparse-tree-matches
14400 (org-highlight-new-match (match-beginning 0) (match-end 0)))
14401 (org-show-context 'occur-tree))))
14402 (when org-remove-highlights-with-change
14403 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
14404 nil 'local))
14405 (unless org-sparse-tree-open-archived-trees
14406 (org-hide-archived-subtrees (point-min) (point-max)))
14407 (run-hooks 'org-occur-hook)
14408 (if (interactive-p)
14409 (message "%d match(es) for regexp %s" cnt regexp))
14410 cnt))
14412 (defun org-show-context (&optional key)
14413 "Make sure point and context and visible.
14414 How much context is shown depends upon the variables
14415 `org-show-hierarchy-above', `org-show-following-heading'. and
14416 `org-show-siblings'."
14417 (let ((heading-p (org-on-heading-p t))
14418 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
14419 (following-p (org-get-alist-option org-show-following-heading key))
14420 (entry-p (org-get-alist-option org-show-entry-below key))
14421 (siblings-p (org-get-alist-option org-show-siblings key)))
14422 (catch 'exit
14423 ;; Show heading or entry text
14424 (if (and heading-p (not entry-p))
14425 (org-flag-heading nil) ; only show the heading
14426 (and (or entry-p (org-invisible-p) (org-invisible-p2))
14427 (org-show-hidden-entry))) ; show entire entry
14428 (when following-p
14429 ;; Show next sibling, or heading below text
14430 (save-excursion
14431 (and (if heading-p (org-goto-sibling) (outline-next-heading))
14432 (org-flag-heading nil))))
14433 (when siblings-p (org-show-siblings))
14434 (when hierarchy-p
14435 ;; show all higher headings, possibly with siblings
14436 (save-excursion
14437 (while (and (condition-case nil
14438 (progn (org-up-heading-all 1) t)
14439 (error nil))
14440 (not (bobp)))
14441 (org-flag-heading nil)
14442 (when siblings-p (org-show-siblings))))))))
14444 (defun org-reveal (&optional siblings)
14445 "Show current entry, hierarchy above it, and the following headline.
14446 This can be used to show a consistent set of context around locations
14447 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14448 not t for the search context.
14450 With optional argument SIBLINGS, on each level of the hierarchy all
14451 siblings are shown. This repairs the tree structure to what it would
14452 look like when opened with hierarchical calls to `org-cycle'."
14453 (interactive "P")
14454 (let ((org-show-hierarchy-above t)
14455 (org-show-following-heading t)
14456 (org-show-siblings (if siblings t org-show-siblings)))
14457 (org-show-context nil)))
14459 (defun org-highlight-new-match (beg end)
14460 "Highlight from BEG to END and mark the highlight is an occur headline."
14461 (let ((ov (org-make-overlay beg end)))
14462 (org-overlay-put ov 'face 'secondary-selection)
14463 (push ov org-occur-highlights)))
14465 (defun org-remove-occur-highlights (&optional beg end noremove)
14466 "Remove the occur highlights from the buffer.
14467 BEG and END are ignored. If NOREMOVE is nil, remove this function
14468 from the `before-change-functions' in the current buffer."
14469 (interactive)
14470 (unless org-inhibit-highlight-removal
14471 (mapc 'org-delete-overlay org-occur-highlights)
14472 (setq org-occur-highlights nil)
14473 (unless noremove
14474 (remove-hook 'before-change-functions
14475 'org-remove-occur-highlights 'local))))
14477 ;;;; Priorities
14480 "Regular expression matching the priority indicator.")
14482 (defvar org-remove-priority-next-time nil)
14484 (defun org-priority-up ()
14485 "Increase the priority of the current item."
14486 (interactive)
14487 (org-priority 'up))
14489 (defun org-priority-down ()
14490 "Decrease the priority of the current item."
14491 (interactive)
14492 (org-priority 'down))
14494 (defun org-priority (&optional action)
14495 "Change the priority of an item by ARG.
14496 ACTION can be `set', `up', `down', or a character."
14497 (interactive)
14498 (setq action (or action 'set))
14499 (let (current new news have remove)
14500 (save-excursion
14501 (org-back-to-heading)
14502 (if (looking-at org-priority-regexp)
14503 (setq current (string-to-char (match-string 2))
14504 have t)
14505 (setq current org-default-priority))
14506 (cond
14507 ((or (eq action 'set) (integerp action))
14508 (if (integerp action)
14509 (setq new action)
14510 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
14511 (setq new (read-char-exclusive)))
14512 (if (and (= (upcase org-highest-priority) org-highest-priority)
14513 (= (upcase org-lowest-priority) org-lowest-priority))
14514 (setq new (upcase new)))
14515 (cond ((equal new ?\ ) (setq remove t))
14516 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14517 (error "Priority must be between `%c' and `%c'"
14518 org-highest-priority org-lowest-priority))))
14519 ((eq action 'up)
14520 (if (and (not have) (eq last-command this-command))
14521 (setq new org-lowest-priority)
14522 (setq new (if (and org-priority-start-cycle-with-default (not have))
14523 org-default-priority (1- current)))))
14524 ((eq action 'down)
14525 (if (and (not have) (eq last-command this-command))
14526 (setq new org-highest-priority)
14527 (setq new (if (and org-priority-start-cycle-with-default (not have))
14528 org-default-priority (1+ current)))))
14529 (t (error "Invalid action")))
14530 (if (or (< (upcase new) org-highest-priority)
14531 (> (upcase new) org-lowest-priority))
14532 (setq remove t))
14533 (setq news (format "%c" new))
14534 (if have
14535 (if remove
14536 (replace-match "" t t nil 1)
14537 (replace-match news t t nil 2))
14538 (if remove
14539 (error "No priority cookie found in line")
14540 (looking-at org-todo-line-regexp)
14541 (if (match-end 2)
14542 (progn
14543 (goto-char (match-end 2))
14544 (insert " [#" news "]"))
14545 (goto-char (match-beginning 3))
14546 (insert "[#" news "] ")))))
14547 (org-preserve-lc (org-set-tags nil 'align))
14548 (if remove
14549 (message "Priority removed")
14550 (message "Priority of current item set to %s" news))))
14553 (defun org-get-priority (s)
14554 "Find priority cookie and return priority."
14555 (save-match-data
14556 (if (not (string-match org-priority-regexp s))
14557 (* 1000 (- org-lowest-priority org-default-priority))
14558 (* 1000 (- org-lowest-priority
14559 (string-to-char (match-string 2 s)))))))
14561 ;;;; Tags
14563 (defun org-scan-tags (action matcher &optional todo-only)
14564 "Scan headline tags with inheritance and produce output ACTION.
14565 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
14566 evaluated, testing if a given set of tags qualifies a headline for
14567 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
14568 are included in the output."
14571 (org-re
14573 (props (list 'face nil
14574 'done-face 'org-done
14575 'undone-face nil
14576 'mouse-face 'highlight
14577 'org-not-done-regexp org-not-done-regexp
14578 'org-todo-regexp org-todo-regexp
14579 'keymap org-agenda-keymap
14580 'help-echo
14581 (format "mouse-2 or RET jump to org file %s"
14582 (abbreviate-file-name
14583 (or (buffer-file-name (buffer-base-buffer))
14584 (buffer-name (buffer-base-buffer)))))))
14585 (case-fold-search nil)
14586 lspos
14587 tags tags-list tags-alist (llast 0) rtn level category i txt
14588 todo marker entry priority)
14589 (save-excursion
14590 (goto-char (point-min))
14591 (when (eq action 'sparse-tree)
14592 (org-overview)
14593 (org-remove-occur-highlights))
14594 (while (re-search-forward re nil t)
14595 (catch :skip
14596 (setq todo (if (match-end 1) (match-string 2))
14597 tags (if (match-end 4) (match-string 4)))
14598 (goto-char (setq lspos (1+ (match-beginning 0))))
14599 (setq level (org-reduced-level (funcall outline-level))
14600 category (org-get-category))
14601 (setq i llast llast level)
14602 ;; remove tag lists from same and sublevels
14603 (while (>= i level)
14604 (when (setq entry (assoc i tags-alist))
14605 (setq tags-alist (delete entry tags-alist)))
14606 (setq i (1- i)))
14607 ;; add the nex tags
14608 (when tags
14609 (setq tags (mapcar 'downcase (org-split-string tags ":"))
14610 tags-alist
14611 (cons (cons level tags) tags-alist)))
14612 ;; compile tags for current headline
14613 (setq tags-list
14614 (if org-use-tag-inheritance
14615 (apply 'append (mapcar 'cdr tags-alist))
14616 tags))
14617 (when (and (or (not todo-only) (member todo org-not-done-keywords))
14618 (eval matcher)
14619 (or (not org-agenda-skip-archived-trees)
14620 (not (member org-archive-tag tags-list))))
14621 (and (eq action 'agenda) (org-agenda-skip))
14622 ;; list this headline
14624 (if (eq action 'sparse-tree)
14625 (progn
14626 (and org-highlight-sparse-tree-matches
14627 (org-get-heading) (match-end 0)
14628 (org-highlight-new-match
14629 (match-beginning 0) (match-beginning 1)))
14630 (org-show-context 'tags-tree))
14631 (setq txt (org-format-agenda-item
14632 ""
14633 (concat
14634 (if org-tags-match-list-sublevels
14635 (make-string (1- level) ?.) "")
14636 (org-get-heading))
14637 category tags-list)
14638 priority (org-get-priority txt))
14639 (goto-char lspos)
14640 (setq marker (org-agenda-new-marker))
14641 (org-add-props txt props
14642 'org-marker marker 'org-hd-marker marker 'org-category category
14643 'priority priority 'type "tagsmatch")
14644 (push txt rtn))
14645 ;; if we are to skip sublevels, jump to end of subtree
14646 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
14647 (when (and (eq action 'sparse-tree)
14648 (not org-sparse-tree-open-archived-trees))
14649 (org-hide-archived-subtrees (point-min) (point-max)))
14650 (nreverse rtn)))
14652 (defvar todo-only) ;; dynamically scoped
14654 (defun org-tags-sparse-tree (&optional todo-only match)
14655 "Create a sparse tree according to tags string MATCH.
14656 MATCH can contain positive and negative selection of tags, like
14658 If optional argument TODO_ONLY is non-nil, only select lines that are
14659 also TODO lines."
14660 (interactive "P")
14661 (org-prepare-agenda-buffers (list (current-buffer)))
14662 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14664 (defvar org-cached-props nil)
14665 (defun org-cached-entry-get (pom property)
14666 (if (or (eq t org-use-property-inheritance)
14667 (member property org-use-property-inheritance))
14668 ;; Caching is not possible, check it directly
14669 (org-entry-get pom property 'inherit)
14670 ;; Get all properties, so that we can do complicated checks easily
14671 (cdr (assoc property (or org-cached-props
14672 (setq org-cached-props
14673 (org-entry-properties pom)))))))
14675 (defun org-global-tags-completion-table (&optional files)
14676 "Return the list of all tags in all agenda buffer/files."
14677 (save-excursion
14678 (org-uniquify
14679 (apply 'append
14680 (mapcar
14681 (lambda (file)
14682 (set-buffer (find-file-noselect file))
14683 (org-get-buffer-tags))
14684 (if (and files (car files))
14685 files
14686 (org-agenda-files)))))))
14688 (defun org-make-tags-matcher (match)
14689 "Create the TAGS//TODO matcher form for the selection string MATCH."
14690 ;; todo-only is scoped dynamically into this function, and the function
14691 ;; may change it it the matcher asksk for it.
14692 (unless match
14693 ;; Get a new match request, with completion
14694 (let ((org-last-tags-completion-table
14695 (org-global-tags-completion-table)))
14696 (setq match (completing-read
14697 "Match: " 'org-tags-completion-function nil nil nil
14698 'org-tags-history))))
14700 ;; Parse the string and create a lisp form
14701 (let ((match0 match)
14702 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
14703 minus tag mm
14704 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14705 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
14706 (if (string-match "/+" match)
14707 ;; match contains also a todo-matching request
14708 (progn
14709 (setq tagsmatch (substring match 0 (match-beginning 0))
14710 todomatch (substring match (match-end 0)))
14711 (if (string-match "^!" todomatch)
14712 (setq todo-only t todomatch (substring todomatch 1)))
14714 (setq todomatch nil)))
14715 ;; only matching tags
14716 (setq tagsmatch match todomatch nil))
14718 ;; Make the tags matcher
14720 (setq tagsmatcher t)
14721 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14722 (while (setq term (pop orterms))
14724 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14725 (while (string-match re term)
14726 (setq minus (and (match-end 1)
14727 (equal (match-string 1 term) "-"))
14728 tag (match-string 2 term)
14729 re-p (equal (string-to-char tag) ?{)
14730 level-p (match-end 3)
14731 prop-p (match-end 4)
14732 mm (cond
14733 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14734 (level-p `(= level ,(string-to-number
14735 (match-string 3 term))))
14736 (prop-p
14737 (setq pn (match-string 4 term)
14738 pv (match-string 5 term)
14739 cat-p (equal pn "CATEGORY")
14740 re-p (equal (string-to-char pv) ?{)
14741 pv (substring pv 1 -1))
14742 (if (equal pn "CATEGORY")
14743 (setq gv '(get-text-property (point) 'org-category))
14744 (setq gv `(org-cached-entry-get nil ,pn)))
14745 (if re-p
14746 `(string-match ,pv (or ,gv ""))
14747 `(equal ,pv ,gv)))
14748 (t `(member ,(downcase tag) tags-list)))
14749 mm (if minus (list 'not mm) mm)
14750 term (substring term (match-end 0)))
14751 (push mm tagsmatcher))
14752 (push (if (> (length tagsmatcher) 1)
14753 (cons 'and tagsmatcher)
14754 (car tagsmatcher))
14755 orlist)
14756 (setq tagsmatcher nil))
14757 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14758 (setq tagsmatcher
14759 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14761 ;; Make the todo matcher
14763 (setq todomatcher t)
14764 (setq orterms (org-split-string todomatch "|") orlist nil)
14765 (while (setq term (pop orterms))
14766 (while (string-match re term)
14767 (setq minus (and (match-end 1)
14768 (equal (match-string 1 term) "-"))
14769 kwd (match-string 2 term)
14770 re-p (equal (string-to-char kwd) ?{)
14771 term (substring term (match-end 0))
14772 mm (if re-p
14773 `(string-match ,(substring kwd 1 -1) todo)
14774 (list 'equal 'todo kwd))
14775 mm (if minus (list 'not mm) mm))
14776 (push mm todomatcher))
14777 (push (if (> (length todomatcher) 1)
14778 (cons 'and todomatcher)
14779 (car todomatcher))
14780 orlist)
14781 (setq todomatcher nil))
14782 (setq todomatcher (if (> (length orlist) 1)
14783 (cons 'or orlist) (car orlist))))
14785 ;; Return the string and lisp forms of the matcher
14786 (setq matcher (if todomatcher
14787 (list 'and tagsmatcher todomatcher)
14788 tagsmatcher))
14789 (cons match0 matcher)))
14791 (defun org-match-any-p (re list)
14792 "Does re match any element of list?"
14793 (setq list (mapcar (lambda (x) (string-match re x)) list))
14794 (delq nil list))
14796 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
14797 (defvar org-tags-overlay (org-make-overlay 1 1))
14798 (org-detach-overlay org-tags-overlay)
14800 (defun org-align-tags-here (to-col)
14801 ;; Assumes that this is a headline
14802 (let ((pos (point)) (col (current-column)) tags)
14803 (beginning-of-line 1)
14805 (< pos (match-beginning 2)))
14806 (progn
14807 (setq tags (match-string 2))
14808 (goto-char (match-beginning 1))
14809 (insert " ")
14810 (delete-region (point) (1+ (match-end 0)))
14811 (backward-char 1)
14812 (move-to-column
14813 (max (1+ (current-column))
14814 (1+ col)
14815 (if (> to-col 0)
14816 to-col
14817 (- (abs to-col) (length tags))))
14818 t)
14819 (insert tags)
14820 (move-to-column (min (current-column) col) t))
14821 (goto-char pos))))
14823 (defun org-set-tags (&optional arg just-align)
14824 "Set the tags for the current headline.
14825 With prefix ARG, realign all tags in headings in the current buffer."
14826 (interactive "P")
14827 (let* ((re (concat "^" outline-regexp))
14828 (current (org-get-tags-string))
14829 (col (current-column))
14830 (org-setting-tags t)
14831 table current-tags inherited-tags ; computed below when needed
14832 tags p0 c0 c1 rpl)
14833 (if arg
14834 (save-excursion
14835 (goto-char (point-min))
14836 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14837 (while (re-search-forward re nil t)
14838 (org-set-tags nil t)
14839 (end-of-line 1)))
14840 (message "All tags realigned to column %d" org-tags-column))
14841 (if just-align
14842 (setq tags current)
14843 ;; Get a new set of tags from the user
14844 (save-excursion
14845 (setq table (or org-tag-alist (org-get-buffer-tags))
14846 org-last-tags-completion-table table
14847 current-tags (org-split-string current ":")
14848 inherited-tags (nreverse
14849 (nthcdr (length current-tags)
14850 (nreverse (org-get-tags-at))))
14851 tags
14852 (if (or (eq t org-use-fast-tag-selection)
14853 (and org-use-fast-tag-selection
14854 (delq nil (mapcar 'cdr table))))
14855 (org-fast-tag-selection
14856 current-tags inherited-tags table
14857 (if org-fast-tag-selection-include-todo org-todo-key-alist))
14858 (let ((org-add-colon-after-tag-completion t))
14859 (org-trim
14860 (org-without-partial-completion
14861 (completing-read "Tags: " 'org-tags-completion-function
14862 nil nil current 'org-tags-history)))))))
14863 (while (string-match "[-+&]+" tags)
14864 ;; No boolean logic, just a list
14865 (setq tags (replace-match ":" t t tags))))
14868 (setq tags "")
14869 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14870 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14872 ;; Insert new tags at the correct column
14873 (beginning-of-line 1)
14874 (cond
14875 ((and (equal current "") (equal tags "")))
14876 ((re-search-forward
14878 (point-at-eol) t)
14879 (if (equal tags "")
14880 (setq rpl "")
14881 (goto-char (match-beginning 0))
14882 (setq c0 (current-column) p0 (point)
14883 c1 (max (1+ c0) (if (> org-tags-column 0)
14884 org-tags-column
14885 (- (- org-tags-column) (length tags))))
14886 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14887 (replace-match rpl t t)
14888 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
14889 tags)
14890 (t (error "Tags alignment failed")))
14891 (move-to-column col)
14892 (unless just-align
14893 (run-hooks 'org-after-tags-change-hook)))))
14895 (defun org-change-tag-in-region (beg end tag off)
14896 "Add or remove TAG for each entry in the region.
14897 This works in the agenda, and also in an org-mode buffer."
14898 (interactive
14899 (list (region-beginning) (region-end)
14900 (let ((org-last-tags-completion-table
14901 (if (org-mode-p)
14902 (org-get-buffer-tags)
14903 (org-global-tags-completion-table))))
14904 (completing-read
14905 "Tag: " 'org-tags-completion-function nil nil nil
14906 'org-tags-history))
14907 (progn
14908 (message "[s]et or [r]emove? ")
14909 (equal (read-char-exclusive) ?r))))
14910 (if (fboundp 'deactivate-mark) (deactivate-mark))
14911 (let ((agendap (equal major-mode 'org-agenda-mode))
14912 l1 l2 m buf pos newhead (cnt 0))
14913 (goto-char end)
14914 (setq l2 (1- (org-current-line)))
14915 (goto-char beg)
14916 (setq l1 (org-current-line))
14917 (loop for l from l1 to l2 do
14918 (goto-line l)
14919 (setq m (get-text-property (point) 'org-hd-marker))
14920 (when (or (and (org-mode-p) (org-on-heading-p))
14921 (and agendap m))
14922 (setq buf (if agendap (marker-buffer m) (current-buffer))
14923 pos (if agendap m (point)))
14924 (with-current-buffer buf
14925 (save-excursion
14926 (save-restriction
14927 (goto-char pos)
14928 (setq cnt (1+ cnt))
14929 (org-toggle-tag tag (if off 'off 'on))
14930 (setq newhead (org-get-heading)))))
14931 (and agendap (org-agenda-change-all-lines newhead m))))
14932 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14934 (defun org-tags-completion-function (string predicate &optional flag)
14935 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14936 (confirm (lambda (x) (stringp (car x)))))
14938 (setq s1 (match-string 1 string)
14939 s2 (match-string 2 string))
14940 (setq s1 "" s2 string))
14941 (cond
14942 ((eq flag nil)
14943 ;; try completion
14944 (setq rtn (try-completion s2 ctable confirm))
14945 (if (stringp rtn)
14946 (setq rtn
14947 (concat s1 s2 (substring rtn (length s2))
14948 (if (and org-add-colon-after-tag-completion
14949 (assoc rtn ctable))
14950 ":" ""))))
14951 rtn)
14952 ((eq flag t)
14953 ;; all-completions
14954 (all-completions s2 ctable confirm)
14955 )
14956 ((eq flag 'lambda)
14957 ;; exact match?
14958 (assoc s2 ctable)))
14959 ))
14961 (defun org-fast-tag-insert (kwd tags face &optional end)
14962 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
14963 (insert (format "%-12s" (concat kwd ":"))
14964 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14965 (or end "")))
14967 (defun org-fast-tag-show-exit (flag)
14968 (save-excursion
14969 (goto-line 3)
14971 (replace-match ""))
14972 (when flag
14973 (end-of-line 1)
14974 (move-to-column (- (window-width) 19) t)
14975 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14977 (defun org-set-current-tags-overlay (current prefix)
14978 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14979 (if (featurep 'xemacs)
14980 (org-overlay-display org-tags-overlay (concat prefix s)
14981 'secondary-selection)
14982 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14983 (org-overlay-display org-tags-overlay (concat prefix s)))))
14985 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14986 "Fast tag selection with single keys.
14987 CURRENT is the current list of tags in the headline, INHERITED is the
14988 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14989 possibly with grouping information. TODO-TABLE is a similar table with
14990 TODO keywords, should these have keys assigned to them.
14991 If the keys are nil, a-z are automatically assigned.
14992 Returns the new tags string, or nil to not change the current settings."
14993 (let* ((fulltable (append table todo-table))
14994 (maxlen (apply 'max (mapcar
14995 (lambda (x)
14996 (if (stringp (car x)) (string-width (car x)) 0))
14997 fulltable)))
14998 (buf (current-buffer))
14999 (expert (eq org-fast-tag-selection-single-key 'expert))
15000 (buffer-tags nil)
15001 (fwidth (+ maxlen 3 1 3))
15002 (ncol (/ (- (window-width) 4) fwidth))
15003 (i-face 'org-done)
15004 (c-face 'org-todo)
15005 tg cnt e c char c1 c2 ntable tbl rtn
15006 ov-start ov-end ov-prefix
15007 (exit-after-next org-fast-tag-selection-single-key)
15008 (done-keywords org-done-keywords)
15009 groups ingroup)
15010 (save-excursion
15011 (beginning-of-line 1)
15012 (if (looking-at
15014 (setq ov-start (match-beginning 1)
15015 ov-end (match-end 1)
15016 ov-prefix "")
15017 (setq ov-start (1- (point-at-eol))
15018 ov-end (1+ ov-start))
15020 (setq ov-prefix
15021 (concat
15022 (buffer-substring (1- (point)) (point))
15023 (if (> (current-column) org-tags-column)
15024 " "
15025 (make-string (- org-tags-column (current-column)) ?\ ))))))
15026 (org-move-overlay org-tags-overlay ov-start ov-end)
15027 (save-window-excursion
15028 (if expert
15029 (set-buffer (get-buffer-create " *Org tags*"))
15030 (delete-other-windows)
15031 (split-window-vertically)
15032 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15033 (erase-buffer)
15034 (org-set-local 'org-done-keywords done-keywords)
15037 (org-fast-tag-show-exit exit-after-next)
15038 (org-set-current-tags-overlay current ov-prefix)
15039 (setq tbl fulltable char ?a cnt 0)
15040 (while (setq e (pop tbl))
15041 (cond
15042 ((equal e '(:startgroup))
15043 (push '() groups) (setq ingroup t)
15044 (when (not (= cnt 0))
15045 (setq cnt 0)
15047 (insert "{ "))
15048 ((equal e '(:endgroup))
15049 (setq ingroup nil cnt 0)
15051 (t
15052 (setq tg (car e) c2 nil)
15053 (if (cdr e)
15054 (setq c (cdr e))
15055 ;; automatically assign a character.
15056 (setq c1 (string-to-char
15057 (downcase (substring
15058 tg (if (= (string-to-char tg) ?@) 1 0)))))
15059 (if (or (rassoc c1 ntable) (rassoc c1 table))
15060 (while (or (rassoc char ntable) (rassoc char table))
15061 (setq char (1+ char)))
15062 (setq c2 c1))
15063 (setq c (or c2 char)))
15064 (if ingroup (push tg (car groups)))
15065 (setq tg (org-add-props tg nil 'face
15066 (cond
15067 ((not (assoc tg table))
15068 (org-get-todo-face tg))
15069 ((member tg current) c-face)
15070 ((member tg inherited) i-face)
15071 (t nil))))
15072 (if (and (= cnt 0) (not ingroup)) (insert " "))
15073 (insert "[" c "] " tg (make-string
15074 (- fwidth 4 (length tg)) ?\ ))
15075 (push (cons tg c) ntable)
15076 (when (= (setq cnt (1+ cnt)) ncol)
15078 (if ingroup (insert " "))
15079 (setq cnt 0)))))
15080 (setq ntable (nreverse ntable))
15082 (goto-char (point-min))
15083 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15084 (fit-window-to-buffer))
15085 (setq rtn
15086 (catch 'exit
15087 (while t
15088 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15089 (if groups " [!] no groups" " [!]groups")
15090 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15091 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15092 (cond
15094 ((= c ?!)
15095 (setq groups (not groups))
15096 (goto-char (point-min))
15097 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15098 ((= c ?\C-c)
15099 (if (not expert)
15100 (org-fast-tag-show-exit
15101 (setq exit-after-next (not exit-after-next)))
15102 (setq expert nil)
15103 (delete-other-windows)
15104 (split-window-vertically)
15105 (org-switch-to-buffer-other-window " *Org tags*")
15106 (and (fboundp 'fit-window-to-buffer)
15107 (fit-window-to-buffer))))
15108 ((or (= c ?\C-g)
15109 (and (= c ?q) (not (rassoc c ntable))))
15110 (org-detach-overlay org-tags-overlay)
15111 (setq quit-flag t))
15112 ((= c ?\ )
15113 (setq current nil)
15114 (if exit-after-next (setq exit-after-next 'now)))
15116 (condition-case nil
15117 (setq tg (completing-read
15118 "Tag: "
15119 (or buffer-tags
15120 (with-current-buffer buf
15121 (org-get-buffer-tags)))))
15122 (quit (setq tg "")))
15124 (add-to-list 'buffer-tags (list tg))
15125 (if (member tg current)
15126 (setq current (delete tg current))
15127 (push tg current)))
15128 (if exit-after-next (setq exit-after-next 'now)))
15129 ((setq e (rassoc c todo-table) tg (car e))
15130 (with-current-buffer buf
15131 (save-excursion (org-todo tg)))
15132 (if exit-after-next (setq exit-after-next 'now)))
15133 ((setq e (rassoc c ntable) tg (car e))
15134 (if (member tg current)
15135 (setq current (delete tg current))
15136 (loop for g in groups do
15137 (if (member tg g)
15138 (mapc (lambda (x)
15139 (setq current (delete x current)))
15140 g)))
15141 (push tg current))
15142 (if exit-after-next (setq exit-after-next 'now))))
15144 ;; Create a sorted list
15145 (setq current
15146 (sort current
15147 (lambda (a b)
15148 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15149 (if (eq exit-after-next 'now) (throw 'exit t))
15150 (goto-char (point-min))
15151 (beginning-of-line 2)
15152 (delete-region (point) (point-at-eol))
15153 (org-fast-tag-insert "Current" current c-face)
15154 (org-set-current-tags-overlay current ov-prefix)
15155 (while (re-search-forward
15157 (setq tg (match-string 1))
15158 (add-text-properties
15159 (match-beginning 1) (match-end 1)
15160 (list 'face
15161 (cond
15162 ((member tg current) c-face)
15163 ((member tg inherited) i-face)
15164 (t (get-text-property (match-beginning 1) 'face))))))
15165 (goto-char (point-min)))))
15166 (org-detach-overlay org-tags-overlay)
15167 (if rtn
15168 (mapconcat 'identity current ":")
15169 nil))))
15171 (defun org-get-tags-string ()
15172 "Get the TAGS string in the current headline."
15173 (unless (org-on-heading-p t)
15174 (error "Not on a heading"))
15175 (save-excursion
15176 (beginning-of-line 1)
15178 (org-match-string-no-properties 1)
15179 "")))
15181 (defun org-get-tags ()
15182 "Get the list of tags specified in the current headline."
15183 (org-split-string (org-get-tags-string) ":"))
15185 (defun org-get-buffer-tags ()
15186 "Get a table of all tags used in the buffer, for completion."
15187 (let (tags)
15188 (save-excursion
15189 (goto-char (point-min))
15190 (while (re-search-forward
15192 (when (equal (char-after (point-at-bol 0)) ?*)
15193 (mapc (lambda (x) (add-to-list 'tags x))
15194 (org-split-string (org-match-string-no-properties 1) ":")))))
15195 (mapcar 'list tags)))
15198 ;;;; Properties
15200 ;;; Setting and retrieving properties
15202 (defconst org-special-properties
15203 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15204 "TIMESTAMP" "TIMESTAMP_IA")
15205 "The special properties valid in Org-mode.
15207 These are properties that are not defined in the property drawer,
15208 but in some other way.")
15210 (defconst org-default-properties
15211 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15212 "LOCATION" "LOGGING" "COLUMNS")
15213 "Some properties that are used by Org-mode for various purposes.
15214 Being in this list makes sure that they are offered for completion.")
15217 "Regular expression matching the first line of a property drawer.")
15220 "Regular expression matching the first line of a property drawer.")
15222 (defun org-property-action ()
15223 "Do an action on properties."
15224 (interactive)
15225 (let (c)
15226 (org-at-property-p)
15227 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15228 (setq c (read-char-exclusive))
15229 (cond
15230 ((equal c ?s)
15231 (call-interactively 'org-set-property))
15232 ((equal c ?d)
15233 (call-interactively 'org-delete-property))
15234 ((equal c ?D)
15235 (call-interactively 'org-delete-property-globally))
15236 ((equal c ?c)
15237 (call-interactively 'org-compute-property-at-point))
15238 (t (error "No such property action %c" c)))))
15240 (defun org-at-property-p ()
15241 "Is the cursor in a property line?"
15242 ;; FIXME: Does not check if we are actually in the drawer.
15243 ;; FIXME: also returns true on any drawers.....
15244 ;; This is used by C-c C-c for property action.
15245 (save-excursion
15246 (beginning-of-line 1)
15249 (defmacro org-with-point-at (pom &rest body)
15250 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15251 (declare (indent 1) (debug t))
15252 `(save-excursion
15253 (if (markerp pom) (set-buffer (marker-buffer pom)))
15254 (save-excursion
15255 (goto-char (or pom (point)))
15256 ,@body)))
15258 (defun org-get-property-block (&optional beg end force)
15259 "Return the (beg . end) range of the body of the property drawer.
15260 BEG and END can be beginning and end of subtree, if not given
15261 they will be found.
15262 If the drawer does not exist and FORCE is non-nil, create the drawer."
15263 (catch 'exit
15264 (save-excursion
15265 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15266 (end (or end (progn (outline-next-heading) (point)))))
15267 (goto-char beg)
15268 (if (re-search-forward org-property-start-re end t)
15269 (setq beg (1+ (match-end 0)))
15270 (if force
15271 (save-excursion
15272 (org-insert-property-drawer)
15273 (setq end (progn (outline-next-heading) (point))))
15274 (throw 'exit nil))
15275 (goto-char beg)
15276 (if (re-search-forward org-property-start-re end t)
15277 (setq beg (1+ (match-end 0)))))
15278 (if (re-search-forward org-property-end-re end t)
15279 (setq end (match-beginning 0))
15280 (or force (throw 'exit nil))
15281 (goto-char beg)
15282 (setq end beg)
15283 (org-indent-line-function)
15285 (cons beg end)))))
15287 (defun org-entry-properties (&optional pom which)
15288 "Get all properties of the entry at point-or-marker POM.
15289 This includes the TODO keyword, the tags, time strings for deadline,
15290 scheduled, and clocking, and any additional properties defined in the
15291 entry. The return value is an alist, keys may occur multiple times
15292 if the property key was used several times.
15293 POM may also be nil, in which case the current entry is used.
15294 If WHICH is nil or `all', get all properties. If WHICH is
15295 `special' or `standard', only get that subclass."
15296 (setq which (or which 'all))
15297 (org-with-point-at pom
15298 (let ((clockstr (substring org-clock-string 0 -1))
15299 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15300 beg end range props sum-props key value string)
15301 (save-excursion
15302 (when (condition-case nil (org-back-to-heading t) (error nil))
15303 (setq beg (point))
15304 (setq sum-props (get-text-property (point) 'org-summaries))
15305 (outline-next-heading)
15306 (setq end (point))
15307 (when (memq which '(all special))
15308 ;; Get the special properties, like TODO and tags
15309 (goto-char beg)
15310 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15311 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15312 (when (looking-at org-priority-regexp)
15313 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15314 (when (and (setq value (org-get-tags-string))
15316 (push (cons "TAGS" value) props))
15317 (when (setq value (org-get-tags-at))
15318 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15319 props))
15320 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15321 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15322 string (if (equal key clockstr)
15323 (org-no-properties
15324 (org-trim
15325 (buffer-substring
15326 (match-beginning 3) (goto-char (point-at-eol)))))
15327 (substring (org-match-string-no-properties 3) 1 -1)))
15328 (unless key
15329 (if (= (char-after (match-beginning 3)) ?\[)
15330 (setq key "TIMESTAMP_IA")
15331 (setq key "TIMESTAMP")))
15332 (when (or (equal key clockstr) (not (assoc key props)))
15333 (push (cons key string) props)))
15335 )
15337 (when (memq which '(all standard))
15338 ;; Get the standard properties, like :PORP: ...
15339 (setq range (org-get-property-block beg end))
15340 (when range
15341 (goto-char (car range))
15342 (while (re-search-forward
15344 (cdr range) t)
15345 (setq key (org-match-string-no-properties 1)
15346 value (org-trim (or (org-match-string-no-properties 2) "")))
15347 (unless (member key excluded)
15348 (push (cons key (or value "")) props)))))
15349 (append sum-props (nreverse props)))))))
15351 (defun org-entry-get (pom property &optional inherit)
15352 "Get value of PROPERTY for entry at point-or-marker POM.
15353 If INHERIT is non-nil and the entry does not have the property,
15354 then also check higher levels of the hierarchy.
15355 If the property is present but empty, the return value is the empty string.
15356 If the property is not present at all, nil is returned."
15357 (org-with-point-at pom
15358 (if inherit
15359 (org-entry-get-with-inheritance property)
15360 (if (member property org-special-properties)
15361 ;; We need a special property. Use brute force, get all properties.
15362 (cdr (assoc property (org-entry-properties nil 'special)))
15363 (let ((range (org-get-property-block)))
15364 (if (and range
15365 (goto-char (car range))
15366 (re-search-forward
15368 (cdr range) t))
15369 ;; Found the property, return it.
15370 (if (match-end 1)
15371 (org-match-string-no-properties 1)
15372 "")))))))
15374 (defun org-entry-delete (pom property)
15375 "Delete the property PROPERTY from entry at point-or-marker POM."
15376 (org-with-point-at pom
15377 (if (member property org-special-properties)
15378 nil ; cannot delete these properties.
15379 (let ((range (org-get-property-block)))
15380 (if (and range
15381 (goto-char (car range))
15382 (re-search-forward
15384 (cdr range) t))
15385 (progn
15386 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15387 t)
15388 nil)))))
15390 ;; Multi-values properties are properties that contain multiple values
15391 ;; These values are assumed to be single words, separated by whitespace.
15392 (defun org-entry-add-to-multivalued-property (pom property value)
15393 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15394 (let* ((old (org-entry-get pom property))
15396 (unless (member value values)
15397 (setq values (cons value values))
15398 (org-entry-put pom property
15399 (mapconcat 'identity values " ")))))
15401 (defun org-entry-remove-from-multivalued-property (pom property value)
15402 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15403 (let* ((old (org-entry-get pom property))
15405 (when (member value values)
15406 (setq values (delete value values))
15407 (org-entry-put pom property
15408 (mapconcat 'identity values " ")))))
15410 (defun org-entry-member-in-multivalued-property (pom property value)
15411 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15412 (let* ((old (org-entry-get pom property))
15414 (member value values)))
15416 (defvar org-entry-property-inherited-from (make-marker))
15418 (defun org-entry-get-with-inheritance (property)
15419 "Get entry property, and search higher levels if not present."
15420 (let (tmp)
15421 (save-excursion
15422 (save-restriction
15423 (widen)
15424 (catch 'ex
15425 (while t
15426 (when (setq tmp (org-entry-get nil property))
15427 (org-back-to-heading t)
15428 (move-marker org-entry-property-inherited-from (point))
15429 (throw 'ex tmp))
15430 (or (org-up-heading-safe) (throw 'ex nil)))))
15431 (or tmp (cdr (assoc property org-local-properties))
15432 (cdr (assoc property org-global-properties))))))
15434 (defun org-entry-put (pom property value)
15435 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15436 (org-with-point-at pom
15437 (org-back-to-heading t)
15438 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15439 range)
15440 (cond
15441 ((equal property "TODO")
15443 (not (member value org-todo-keywords-1)))
15445 (if (or (not value)
15447 (setq value 'none))
15448 (org-todo value)
15449 (org-set-tags nil 'align))
15450 ((equal property "PRIORITY")
15452 (string-to-char value) ?\ ))
15453 (org-set-tags nil 'align))
15454 ((equal property "SCHEDULED")
15455 (if (re-search-forward org-scheduled-time-regexp end t)
15456 (cond
15457 ((eq value 'earlier) (org-timestamp-change -1 'day))
15458 ((eq value 'later) (org-timestamp-change 1 'day))
15459 (t (call-interactively 'org-schedule)))
15460 (call-interactively 'org-schedule)))
15461 ((equal property "DEADLINE")
15462 (if (re-search-forward org-deadline-time-regexp end t)
15463 (cond
15464 ((eq value 'earlier) (org-timestamp-change -1 'day))
15465 ((eq value 'later) (org-timestamp-change 1 'day))
15466 (t (call-interactively 'org-deadline)))
15467 (call-interactively 'org-deadline)))
15468 ((member property org-special-properties)
15469 (error "The %s property can not yet be set with `org-entry-put'"
15470 property))
15471 (t ; a non-special property
15472 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15473 (setq range (org-get-property-block beg end 'force))
15474 (goto-char (car range))
15475 (if (re-search-forward
15477 (progn
15478 (delete-region (match-beginning 1) (match-end 1))
15479 (goto-char (match-beginning 1)))
15480 (goto-char (cdr range))
15482 (backward-char 1)
15483 (org-indent-line-function)
15484 (insert ":" property ":"))
15485 (and value (insert " " value))
15486 (org-indent-line-function)))))))
15488 (defun org-buffer-property-keys (&optional include-specials include-defaults)
15489 "Get all property keys in the current buffer.
15490 With INCLUDE-SPECIALS, also list the special properties that relect things
15491 like tags and TODO state.
15492 With INCLUDE-DEFAULTS, also include properties that has special meaning
15493 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING."
15494 (let (rtn range)
15495 (save-excursion
15496 (save-restriction
15497 (widen)
15498 (goto-char (point-min))
15499 (while (re-search-forward org-property-start-re nil t)
15500 (setq range (org-get-property-block))
15501 (goto-char (car range))
15502 (while (re-search-forward
15504 (cdr range) t)
15505 (add-to-list 'rtn (org-match-string-no-properties 1)))
15506 (outline-next-heading))))
15508 (when include-specials
15509 (setq rtn (append org-special-properties rtn)))
15511 (when include-defaults
15512 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
15514 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15516 (defun org-property-values (key)
15517 "Return a list of all values of property KEY."
15518 (save-excursion
15519 (save-restriction
15520 (widen)
15521 (goto-char (point-min))
15523 values)
15524 (while (re-search-forward re nil t)
15525 (add-to-list 'values (org-trim (match-string 1))))
15526 (delete "" values)))))
15528 (defun org-insert-property-drawer ()
15529 "Insert a property drawer into the current entry."
15530 (interactive)
15531 (org-back-to-heading t)
15532 (looking-at outline-regexp)
15533 (let ((indent (- (match-end 0)(match-beginning 0)))
15534 (beg (point))
15536 end hiddenp)
15537 (outline-next-heading)
15538 (setq end (point))
15539 (goto-char beg)
15540 (while (re-search-forward re end t))
15541 (setq hiddenp (org-invisible-p))
15542 (end-of-line 1)
15544 (org-skip-over-state-notes)
15546 (if (eq (char-before) ?*) (forward-char 1))
15548 (beginning-of-line 0)
15549 (indent-to-column indent)
15550 (beginning-of-line 2)
15551 (indent-to-column indent)
15552 (beginning-of-line 0)
15553 (if hiddenp
15554 (save-excursion
15555 (org-back-to-heading t)
15556 (hide-entry))
15557 (org-flag-drawer t))))
15559 (defun org-set-property (property value)
15560 "In the current entry, set PROPERTY to VALUE.
15561 When called interactively, this will prompt for a property name, offering
15562 completion on existing and default properties. And then it will prompt
15563 for a value, offering competion either on allowed values (via an inherited
15564 xxx_ALL property) or on existing values in other instances of this property
15565 in the current file."
15566 (interactive
15567 (let* ((prop (completing-read
15568 "Property: " (mapcar 'list (org-buffer-property-keys nil t))))
15569 (cur (org-entry-get nil prop))
15570 (allowed (org-property-get-allowed-values nil prop 'table))
15571 (existing (mapcar 'list (org-property-values prop)))
15572 (val (if allowed
15573 (completing-read "Value: " allowed nil 'req-match)
15574 (completing-read
15576 (concat "[" cur "]") "")
15577 ": ")
15578 existing nil nil "" nil cur))))
15579 (list prop (if (equal val "") cur val))))
15580 (unless (equal (org-entry-get nil property) value)
15581 (org-entry-put nil property value)))
15583 (defun org-delete-property (property)
15584 "In the current entry, delete PROPERTY."
15585 (interactive
15586 (let* ((prop (completing-read
15587 "Property: " (org-entry-properties nil 'standard))))
15588 (list prop)))
15589 (message (concat "Property " property
15590 (if (org-entry-delete nil property)
15591 " deleted"
15592 " was not present in the entry"))))
15594 (defun org-delete-property-globally (property)
15595 "Remove PROPERTY globally, from all entries."
15596 (interactive
15597 (let* ((prop (completing-read
15598 "Globally remove property: "
15599 (mapcar 'list (org-buffer-property-keys)))))
15600 (list prop)))
15601 (save-excursion
15602 (save-restriction
15603 (widen)
15604 (goto-char (point-min))
15605 (let ((cnt 0))
15606 (while (re-search-forward
15608 nil t)
15609 (setq cnt (1+ cnt))
15610 (replace-match ""))
15613 (defvar org-columns-current-fmt-compiled) ; defined below
15615 (defun org-compute-property-at-point ()
15616 "Compute the property at point.
15617 This looks for an enclosing column format, extracts the operator and
15618 then applies it to the proerty in the column format's scope."
15619 (interactive)
15620 (unless (org-at-property-p)
15621 (error "Not at a property"))
15622 (let ((prop (org-match-string-no-properties 2)))
15623 (org-columns-get-format-and-top-level)
15624 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15625 (error "No operator defined for property %s" prop))
15626 (org-columns-compute prop)))
15628 (defun org-property-get-allowed-values (pom property &optional table)
15629 "Get allowed values for the property PROPERTY.
15630 When TABLE is non-nil, return an alist that can directly be used for
15631 completion."
15632 (let (vals)
15633 (cond
15634 ((equal property "TODO")
15635 (setq vals (org-with-point-at pom
15636 (append org-todo-keywords-1 '("")))))
15637 ((equal property "PRIORITY")
15638 (let ((n org-lowest-priority))
15639 (while (>= n org-highest-priority)
15640 (push (char-to-string n) vals)
15641 (setq n (1- n)))))
15642 ((member property org-special-properties))
15643 (t
15644 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15647 (setq vals (car (read-from-string (concat "(" vals ")"))))
15648 (setq vals (mapcar (lambda (x)
15649 (cond ((stringp x) x)
15650 ((numberp x) (number-to-string x))
15651 ((symbolp x) (symbol-name x))
15652 (t "???")))
15653 vals)))))
15654 (if table (mapcar 'list vals) vals)))
15656 (defun org-property-previous-allowed-value (&optional previous)
15657 "Switch to the next allowed value for this property."
15658 (interactive)
15659 (org-property-next-allowed-value t))
15661 (defun org-property-next-allowed-value (&optional previous)
15662 "Switch to the next allowed value for this property."
15663 (interactive)
15664 (unless (org-at-property-p)
15665 (error "Not at a property"))
15666 (let* ((key (match-string 2))
15667 (value (match-string 3))
15668 (allowed (or (org-property-get-allowed-values (point) key)
15669 (and (member value '("[ ]" "[-]" "[X]"))
15670 '("[ ]" "[X]"))))
15671 nval)
15672 (unless allowed
15673 (error "Allowed values for this property have not been defined"))
15674 (if previous (setq allowed (reverse allowed)))
15675 (if (member value allowed)
15676 (setq nval (car (cdr (member value allowed)))))
15677 (setq nval (or nval (car allowed)))
15678 (if (equal nval value)
15679 (error "Only one allowed value for this property"))
15680 (org-at-property-p)
15681 (replace-match (concat " :" key ": " nval) t t)
15682 (org-indent-line-function)
15683 (beginning-of-line 1)
15686 (defun org-find-entry-with-id (ident)
15687 "Locate the entry that contains the ID property with exact value IDENT.
15688 IDENT can be a string, a symbol or a number, this function will search for
15689 the string representation of it.
15690 Return the position where this entry starts, or nil if there is no such entry."
15691 (let ((id (cond
15692 ((stringp ident) ident)
15693 ((symbol-name ident) (symbol-name ident))
15694 ((numberp ident) (number-to-string ident))
15695 (t (error "IDENT %s must be a string, symbol or number" ident))))
15696 (case-fold-search nil))
15697 (save-excursion
15698 (save-restriction
15699 (goto-char (point-min))
15700 (when (re-search-forward
15702 nil t)
15703 (org-back-to-heading)
15704 (point))))))
15706 ;;; Column View
15708 (defvar org-columns-overlays nil
15709 "Holds the list of current column overlays.")
15711 (defvar org-columns-current-fmt nil
15712 "Local variable, holds the currently active column format.")
15713 (defvar org-columns-current-fmt-compiled nil
15714 "Local variable, holds the currently active column format.
15715 This is the compiled version of the format.")
15716 (defvar org-columns-current-widths nil
15717 "Loval variable, holds the currently widths of fields.")
15718 (defvar org-columns-current-maxwidths nil
15719 "Loval variable, holds the currently active maximum column widths.")
15720 (defvar org-columns-begin-marker (make-marker)
15721 "Points to the position where last a column creation command was called.")
15722 (defvar org-columns-top-level-marker (make-marker)
15723 "Points to the position where current columns region starts.")
15725 (defvar org-columns-map (make-sparse-keymap)
15726 "The keymap valid in column display.")
15728 (defun org-columns-content ()
15729 "Switch to contents view while in columns view."
15730 (interactive)
15731 (org-overview)
15732 (org-content))
15734 (org-defkey org-columns-map "c" 'org-columns-content)
15735 (org-defkey org-columns-map "o" 'org-overview)
15736 (org-defkey org-columns-map "e" 'org-columns-edit-value)
15737 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
15738 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
15739 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
15740 (org-defkey org-columns-map "v" 'org-columns-show-value)
15741 (org-defkey org-columns-map "q" 'org-columns-quit)
15742 (org-defkey org-columns-map "r" 'org-columns-redo)
15743 (org-defkey org-columns-map [left] 'backward-char)
15744 (org-defkey org-columns-map "\M-b" 'backward-char)
15745 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
15746 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
15747 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
15748 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
15749 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
15750 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
15751 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
15752 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
15753 (org-defkey org-columns-map "<" 'org-columns-narrow)
15754 (org-defkey org-columns-map ">" 'org-columns-widen)
15755 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
15756 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
15757 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
15758 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
15760 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
15761 '("Column"
15762 ["Edit property" org-columns-edit-value t]
15763 ["Next allowed value" org-columns-next-allowed-value t]
15764 ["Previous allowed value" org-columns-previous-allowed-value t]
15765 ["Show full value" org-columns-show-value t]
15766 ["Edit allowed values" org-columns-edit-allowed t]
15767 "--"
15768 ["Edit column attributes" org-columns-edit-attributes t]
15769 ["Increase column width" org-columns-widen t]
15770 ["Decrease column width" org-columns-narrow t]
15771 "--"
15772 ["Move column right" org-columns-move-right t]
15773 ["Move column left" org-columns-move-left t]
15774 ["Add column" org-columns-new t]
15775 ["Delete column" org-columns-delete t]
15776 "--"
15777 ["CONTENTS" org-columns-content t]
15778 ["OVERVIEW" org-overview t]
15779 ["Refresh columns display" org-columns-redo t]
15780 "--"
15781 ["Open link" org-columns-open-link t]
15782 "--"
15783 ["Quit" org-columns-quit t]))
15785 (defun org-columns-new-overlay (beg end &optional string face)
15786 "Create a new column overlay and add it to the list."
15787 (let ((ov (org-make-overlay beg end)))
15788 (org-overlay-put ov 'face (or face 'secondary-selection))
15789 (org-overlay-display ov string face)
15790 (push ov org-columns-overlays)
15791 ov))
15793 (defun org-columns-display-here (&optional props)
15794 "Overlay the current line with column display."
15795 (interactive)
15796 (let* ((fmt org-columns-current-fmt-compiled)
15797 (beg (point-at-bol))
15798 (level-face (save-excursion
15799 (beginning-of-line 1)
15801 (org-get-level-face 2))))
15802 (color (list :foreground
15803 (face-attribute (or level-face 'default) :foreground)))
15804 props pom property ass width f string ov column val modval)
15805 ;; Check if the entry is in another buffer.
15806 (unless props
15807 (if (eq major-mode 'org-agenda-mode)
15808 (setq pom (or (get-text-property (point) 'org-hd-marker)
15809 (get-text-property (point) 'org-marker))
15810 props (if pom (org-entry-properties pom) nil))
15811 (setq props (org-entry-properties nil))))
15812 ;; Walk the format
15813 (while (setq column (pop fmt))
15814 (setq property (car column)
15815 ass (if (equal property "ITEM")
15816 (cons "ITEM"
15817 (save-match-data
15818 (org-no-properties
15819 (org-remove-tabs
15820 (buffer-substring-no-properties
15821 (point-at-bol) (point-at-eol))))))
15822 (assoc property props))
15823 width (or (cdr (assoc property org-columns-current-maxwidths))
15824 (nth 2 column)
15825 (length property))
15826 f (format "%%-%d.%ds | " width width)
15827 val (or (cdr ass) "")
15828 modval (if (equal property "ITEM")
15829 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
15830 string (format f (or modval val)))
15831 ;; Create the overlay
15832 (org-unmodified
15833 (setq ov (org-columns-new-overlay
15834 beg (setq beg (1+ beg)) string
15835 (list color 'org-column)))
15836 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
15837 (org-overlay-put ov 'keymap org-columns-map)
15838 (org-overlay-put ov 'org-columns-key property)
15839 (org-overlay-put ov 'org-columns-value (cdr ass))
15840 (org-overlay-put ov 'org-columns-value-modified modval)
15841 (org-overlay-put ov 'org-columns-pom pom)
15842 (org-overlay-put ov 'org-columns-format f))
15843 (if (or (not (char-after beg))
15845 (let ((inhibit-read-only t))
15846 (save-excursion
15847 (goto-char beg)
15848 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
15849 ;; Make the rest of the line disappear.
15850 (org-unmodified
15851 (setq ov (org-columns-new-overlay beg (point-at-eol)))
15852 (org-overlay-put ov 'invisible t)
15853 (org-overlay-put ov 'keymap org-columns-map)
15854 (org-overlay-put ov 'intangible t)
15855 (push ov org-columns-overlays)
15856 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
15857 (org-overlay-put ov 'keymap org-columns-map)
15858 (push ov org-columns-overlays)
15859 (let ((inhibit-read-only t))
15860 (put-text-property (max (point-min) (1- (point-at-bol)))
15861 (min (point-max) (1+ (point-at-eol)))
15862 'read-only "Type `e' to edit property")))))
15864 (defvar org-previous-header-line-format nil
15865 "The header line format before column view was turned on.")
15866 (defvar org-columns-inhibit-recalculation nil
15867 "Inhibit recomputing of columns on column view startup.")
15870 (defvar header-line-format)
15871 (defun org-columns-display-here-title ()
15872 "Overlay the newline before the current line with the table title."
15873 (interactive)
15874 (let ((fmt org-columns-current-fmt-compiled)
15875 string (title "")
15876 property width f column str widths)
15877 (while (setq column (pop fmt))
15878 (setq property (car column)
15879 str (or (nth 1 column) property)
15880 width (or (cdr (assoc property org-columns-current-maxwidths))
15881 (nth 2 column)
15882 (length str))
15883 widths (push width widths)
15884 f (format "%%-%d.%ds | " width width)
15885 string (format f str)
15886 title (concat title string)))
15887 (setq title (concat
15888 (org-add-props " " nil 'display '(space :align-to 0))
15889 (org-add-props title nil 'face '(:weight bold :underline t))))
15890 (org-set-local 'org-previous-header-line-format header-line-format)
15891 (org-set-local 'org-columns-current-widths (nreverse widths))
15892 (setq header-line-format title)))
15894 (defun org-columns-remove-overlays ()
15895 "Remove all currently active column overlays."
15896 (interactive)
15897 (when (marker-buffer org-columns-begin-marker)
15898 (with-current-buffer (marker-buffer org-columns-begin-marker)
15899 (when (local-variable-p 'org-previous-header-line-format)
15900 (setq header-line-format org-previous-header-line-format)
15901 (kill-local-variable 'org-previous-header-line-format))
15902 (move-marker org-columns-begin-marker nil)
15903 (move-marker org-columns-top-level-marker nil)
15904 (org-unmodified
15905 (mapc 'org-delete-overlay org-columns-overlays)
15906 (setq org-columns-overlays nil)
15907 (let ((inhibit-read-only t))
15908 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
15910 (defun org-columns-cleanup-item (item fmt)
15911 "Remove from ITEM what is a column in the format FMT."
15912 (if (not org-complex-heading-regexp)
15913 item
15914 (when (string-match org-complex-heading-regexp item)
15915 (concat
15916 (org-add-props (concat (match-string 1 item) " ") nil
15917 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
15918 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
15919 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
15920 " " (match-string 4 item)
15921 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
15923 (defun org-columns-show-value ()
15924 "Show the full value of the property."
15925 (interactive)
15926 (let ((value (get-char-property (point) 'org-columns-value)))
15927 (message "Value is: %s" (or value ""))))
15929 (defun org-columns-quit ()
15930 "Remove the column overlays and in this way exit column editing."
15931 (interactive)
15932 (org-unmodified
15933 (org-columns-remove-overlays)
15934 (let ((inhibit-read-only t))
15935 (remove-text-properties (point-min) (point-max) '(read-only t))))
15936 (when (eq major-mode 'org-agenda-mode)
15937 (message
15938 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
15940 (defun org-columns-check-computed ()
15941 "Check if this column value is computed.
15942 If yes, throw an error indicating that changing it does not make sense."
15943 (let ((val (get-char-property (point) 'org-columns-value)))
15944 (when (and (stringp val)
15945 (get-char-property 0 'org-computed val))
15946 (error "This value is computed from the entry's children"))))
15948 (defun org-columns-todo (&optional arg)
15949 "Change the TODO state during column view."
15950 (interactive "P")
15951 (org-columns-edit-value "TODO"))
15953 (defun org-columns-set-tags-or-toggle (&optional arg)
15954 "Toggle checkbox at point, or set tags for current headline."
15955 (interactive "P")
15957 (get-char-property (point) 'org-columns-value))
15958 (org-columns-next-allowed-value)
15959 (org-columns-edit-value "TAGS")))
15961 (defun org-columns-edit-value (&optional key)
15962 "Edit the value of the property at point in column view.
15963 Where possible, use the standard interface for changing this line."
15964 (interactive)
15965 (org-columns-check-computed)
15966 (let* ((external-key key)
15967 (col (current-column))
15968 (key (or key (get-char-property (point) 'org-columns-key)))
15969 (value (get-char-property (point) 'org-columns-value))
15970 (bol (point-at-bol)) (eol (point-at-eol))
15971 (pom (or (get-text-property bol 'org-hd-marker)
15972 (point))) ; keep despite of compiler waring
15973 (line-overlays
15974 (delq nil (mapcar (lambda (x)
15975 (and (eq (overlay-buffer x) (current-buffer))
15976 (>= (overlay-start x) bol)
15977 (<= (overlay-start x) eol)
15978 x))
15979 org-columns-overlays)))
15980 nval eval allowed)
15981 (cond
15982 ((equal key "ITEM")
15983 (setq eval '(org-with-point-at pom
15984 (org-edit-headline))))
15985 ((equal key "TODO")
15986 (setq eval '(org-with-point-at pom
15987 (let ((current-prefix-arg
15988 (if external-key current-prefix-arg '(4))))
15989 (call-interactively 'org-todo)))))
15990 ((equal key "PRIORITY")
15991 (setq eval '(org-with-point-at pom
15992 (call-interactively 'org-priority))))
15993 ((equal key "TAGS")
15994 (setq eval '(org-with-point-at pom
15995 (let ((org-fast-tag-selection-single-key
15996 (if (eq org-fast-tag-selection-single-key 'expert)
15997 t org-fast-tag-selection-single-key)))
15998 (call-interactively 'org-set-tags)))))
15999 ((equal key "DEADLINE")
16000 (setq eval '(org-with-point-at pom
16001 (call-interactively 'org-deadline))))
16002 ((equal key "SCHEDULED")
16003 (setq eval '(org-with-point-at pom
16004 (call-interactively 'org-schedule))))
16005 (t
16006 (setq allowed (org-property-get-allowed-values pom key 'table))
16007 (if allowed
16008 (setq nval (completing-read "Value: " allowed nil t))
16009 (setq nval (read-string "Edit: " value)))
16010 (setq nval (org-trim nval))
16011 (when (not (equal nval value))
16012 (setq eval '(org-entry-put pom key nval)))))
16013 (when eval
16014 (let ((inhibit-read-only t))
16015 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16016 (unwind-protect
16017 (progn
16018 (setq org-columns-overlays
16019 (org-delete-all line-overlays org-columns-overlays))
16020 (mapc 'org-delete-overlay line-overlays)
16021 (org-columns-eval eval))
16022 (org-columns-display-here))))
16023 (move-to-column col)
16024 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
16025 (org-columns-update key))))
16027 (defun org-edit-headline () ; FIXME: this is not columns specific
16028 "Edit the current headline, the part without TODO keyword, TAGS."
16029 (org-back-to-heading)
16030 (when (looking-at org-todo-line-regexp)
16031 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16032 (txt (match-string 3))
16033 (post "")
16034 txt2)
16036 (setq post (match-string 0 txt)
16037 txt (substring txt 0 (match-beginning 0))))
16038 (setq txt2 (read-string "Edit: " txt))
16039 (when (not (equal txt txt2))
16040 (beginning-of-line 1)
16041 (insert pre txt2 post)
16042 (delete-region (point) (point-at-eol))
16043 (org-set-tags nil t)))))
16045 (defun org-columns-edit-allowed ()
16046 "Edit the list of allowed values for the current property."
16047 (interactive)
16048 (let* ((key (get-char-property (point) 'org-columns-key))
16049 (key1 (concat key "_ALL"))
16050 (allowed (org-entry-get (point) key1 t))
16051 nval)
16052 ;; FIXME: Cover editing TODO, TAGS etc inbiffer settings.????
16053 (setq nval (read-string "Allowed: " allowed))
16054 (org-entry-put
16055 (cond ((marker-position org-entry-property-inherited-from)
16056 org-entry-property-inherited-from)
16057 ((marker-position org-columns-top-level-marker)
16058 org-columns-top-level-marker))
16059 key1 nval)))
16061 (defmacro org-no-warnings (&rest body)
16062 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16064 (defun org-columns-eval (form)
16065 (let (hidep)
16066 (save-excursion
16067 (beginning-of-line 1)
16068 ;; `next-line' is needed here, because it skips invisible line.
16069 ;; FIXME: RMS says this should be wrapped into `with-no-warnings'
16070 ;; but I don't know how to do this and keep the code XEmacs compatible.
16071 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16072 (setq hidep (org-on-heading-p 1)))
16073 (eval form)
16074 (and hidep (hide-entry))))
16076 (defun org-columns-previous-allowed-value ()
16077 "Switch to the previous allowed value for this column."
16078 (interactive)
16079 (org-columns-next-allowed-value t))
16081 (defun org-columns-next-allowed-value (&optional previous)
16082 "Switch to the next allowed value for this column."
16083 (interactive)
16084 (org-columns-check-computed)
16085 (let* ((col (current-column))
16086 (key (get-char-property (point) 'org-columns-key))
16087 (value (get-char-property (point) 'org-columns-value))
16088 (bol (point-at-bol)) (eol (point-at-eol))
16089 (pom (or (get-text-property bol 'org-hd-marker)
16090 (point))) ; keep despite of compiler waring
16091 (line-overlays
16092 (delq nil (mapcar (lambda (x)
16093 (and (eq (overlay-buffer x) (current-buffer))
16094 (>= (overlay-start x) bol)
16095 (<= (overlay-start x) eol)
16096 x))
16097 org-columns-overlays)))
16098 (allowed (or (org-property-get-allowed-values pom key)
16099 (and (equal
16100 (nth 4 (assoc key org-columns-current-fmt-compiled))
16101 'checkbox) '("[ ]" "[X]"))))
16102 nval)
16103 (when (equal key "ITEM")
16104 (error "Cannot edit item headline from here"))
16105 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16106 (error "Allowed values for this property have not been defined"))
16107 (if (member key '("SCHEDULED" "DEADLINE"))
16108 (setq nval (if previous 'earlier 'later))
16109 (if previous (setq allowed (reverse allowed)))
16110 (if (member value allowed)
16111 (setq nval (car (cdr (member value allowed)))))
16112 (setq nval (or nval (car allowed)))
16113 (if (equal nval value)
16114 (error "Only one allowed value for this property")))
16115 (let ((inhibit-read-only t))
16116 (remove-text-properties (1- bol) eol '(read-only t))
16117 (unwind-protect
16118 (progn
16119 (setq org-columns-overlays
16120 (org-delete-all line-overlays org-columns-overlays))
16121 (mapc 'org-delete-overlay line-overlays)
16122 (org-columns-eval '(org-entry-put pom key nval)))
16123 (org-columns-display-here)))
16124 (move-to-column col)
16125 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
16126 (org-columns-update key))))
16128 (defun org-verify-version (task)
16129 (cond
16130 ((eq task 'columns)
16131 (if (or (featurep 'xemacs)
16132 (< emacs-major-version 22))
16133 (error "Emacs 22 is required for the columns feature")))))
16135 (defun org-columns-open-link (&optional arg)
16136 (interactive "P")
16137 (let ((key (get-char-property (point) 'org-columns-key))
16138 (value (get-char-property (point) 'org-columns-value)))
16139 (org-open-link-from-string arg)))
16141 (defun org-open-link-from-string (s &optional arg)
16142 "Open a link in the string S, as if it was in Org-mode."
16143 (interactive)
16144 (with-temp-buffer
16145 (let ((org-inhibit-startup t))
16146 (org-mode)
16147 (insert s)
16148 (goto-char (point-min))
16149 (org-open-at-point arg))))
16151 (defun org-columns-get-format-and-top-level ()
16152 (let (fmt)
16153 (when (condition-case nil (org-back-to-heading) (error nil))
16154 (move-marker org-entry-property-inherited-from nil)
16155 (setq fmt (org-entry-get nil "COLUMNS" t)))
16156 (setq fmt (or fmt org-columns-default-format))
16157 (org-set-local 'org-columns-current-fmt fmt)
16158 (org-columns-compile-format fmt)
16159 (if (marker-position org-entry-property-inherited-from)
16160 (move-marker org-columns-top-level-marker
16161 org-entry-property-inherited-from)
16162 (move-marker org-columns-top-level-marker (point)))
16163 fmt))
16165 (defun org-columns ()
16166 "Turn on column view on an org-mode file."
16167 (interactive)
16168 (org-verify-version 'columns)
16169 (org-columns-remove-overlays)
16170 (move-marker org-columns-begin-marker (point))
16171 (let (beg end fmt cache maxwidths)
16172 (setq fmt (org-columns-get-format-and-top-level))
16173 (save-excursion
16174 (goto-char org-columns-top-level-marker)
16175 (setq beg (point))
16176 (unless org-columns-inhibit-recalculation
16177 (org-columns-compute-all))
16178 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16179 (point-max)))
16180 (goto-char beg)
16181 ;; Get and cache the properties
16182 (while (re-search-forward (concat "^" outline-regexp) end t)
16183 (push (cons (org-current-line) (org-entry-properties)) cache))
16184 (when cache
16185 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16186 (org-set-local 'org-columns-current-maxwidths maxwidths)
16187 (org-columns-display-here-title)
16188 (mapc (lambda (x)
16189 (goto-line (car x))
16190 (org-columns-display-here (cdr x)))
16191 cache)))))
16193 (defun org-columns-new (&optional prop title width op fmt)
16194 "Insert a new column, to the leeft o the current column."
16195 (interactive)
16196 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16197 cell)
16198 (setq prop (completing-read
16199 "Property: " (mapcar 'list (org-buffer-property-keys t))
16200 nil nil prop))
16201 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16202 (setq width (read-string "Column width: " (if width (number-to-string width))))
16204 (setq width (string-to-number width))
16205 (setq width nil))
16206 (setq fmt (completing-read "Summary [none]: "
16207 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox"))
16208 nil t))
16210 (setq fmt (intern fmt))
16211 (setq fmt nil))
16212 (if (eq fmt 'none) (setq fmt nil))
16213 (if editp
16214 (progn
16215 (setcar editp prop)
16216 (setcdr editp (list title width nil fmt)))
16217 (setq cell (nthcdr (1- (current-column))
16218 org-columns-current-fmt-compiled))
16219 (setcdr cell (cons (list prop title width nil fmt)
16220 (cdr cell))))
16221 (org-columns-store-format)
16222 (org-columns-redo)))
16224 (defun org-columns-delete ()
16225 "Delete the column at point from columns view."
16226 (interactive)
16227 (let* ((n (current-column))
16228 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16229 (when (y-or-n-p
16231 (setq org-columns-current-fmt-compiled
16232 (delq (nth n org-columns-current-fmt-compiled)
16233 org-columns-current-fmt-compiled))
16234 (org-columns-store-format)
16235 (org-columns-redo)
16236 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16237 (backward-char 1)))))
16239 (defun org-columns-edit-attributes ()
16240 "Edit the attributes of the current column."
16241 (interactive)
16242 (let* ((n (current-column))
16243 (info (nth n org-columns-current-fmt-compiled)))
16244 (apply 'org-columns-new info)))
16246 (defun org-columns-widen (arg)
16247 "Make the column wider by ARG characters."
16248 (interactive "p")
16249 (let* ((n (current-column))
16250 (entry (nth n org-columns-current-fmt-compiled))
16251 (width (or (nth 2 entry)
16252 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16253 (setq width (max 1 (+ width arg)))
16254 (setcar (nthcdr 2 entry) width)
16255 (org-columns-store-format)
16256 (org-columns-redo)))
16258 (defun org-columns-narrow (arg)
16259 "Make the column nrrower by ARG characters."
16260 (interactive "p")
16261 (org-columns-widen (- arg)))
16263 (defun org-columns-move-right ()
16264 "Swap this column with the one to the right."
16265 (interactive)
16266 (let* ((n (current-column))
16267 (cell (nthcdr n org-columns-current-fmt-compiled))
16268 e)
16269 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16270 (error "Cannot shift this column further to the right"))
16271 (setq e (car cell))
16272 (setcar cell (car (cdr cell)))
16273 (setcdr cell (cons e (cdr (cdr cell))))
16274 (org-columns-store-format)
16275 (org-columns-redo)
16276 (forward-char 1)))
16278 (defun org-columns-move-left ()
16279 "Swap this column with the one to the left."
16280 (interactive)
16281 (let* ((n (current-column)))
16282 (when (= n 0)
16283 (error "Cannot shift this column further to the left"))
16284 (backward-char 1)
16285 (org-columns-move-right)
16286 (backward-char 1)))
16288 (defun org-columns-store-format ()
16289 "Store the text version of the current columns format in appropriate place.
16290 This is either in the COLUMNS property of the node starting the current column
16291 display, or in the #+COLUMNS line of the current buffer."
16292 (let (fmt (cnt 0))
16293 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16294 (org-set-local 'org-columns-current-fmt fmt)
16295 (if (marker-position org-columns-top-level-marker)
16296 (save-excursion
16297 (goto-char org-columns-top-level-marker)
16298 (if (and (org-at-heading-p)
16299 (org-entry-get nil "COLUMNS"))
16300 (org-entry-put nil "COLUMNS" fmt)
16301 (goto-char (point-min))
16302 ;; Overwrite all #+COLUMNS lines....
16304 (setq cnt (1+ cnt))
16305 (replace-match (concat "#+COLUMNS: " fmt) t t))
16306 (unless (> cnt 0)
16307 (goto-char (point-min))
16308 (or (org-on-heading-p t) (outline-next-heading))
16309 (let ((inhibit-read-only t))
16311 (org-set-local 'org-columns-default-format fmt))))))
16313 (defvar org-overriding-columns-format nil
16314 "When set, overrides any other definition.")
16315 (defvar org-agenda-view-columns-initially nil
16316 "When set, switch to columns view immediately after creating the agenda.")
16318 (defun org-agenda-columns ()
16319 "Turn on column view in the agenda."
16320 (interactive)
16321 (org-verify-version 'columns)
16322 (org-columns-remove-overlays)
16323 (move-marker org-columns-begin-marker (point))
16324 (let (fmt cache maxwidths m)
16325 (cond
16326 ((and (local-variable-p 'org-overriding-columns-format)
16327 org-overriding-columns-format)
16328 (setq fmt org-overriding-columns-format))
16329 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
16330 (setq fmt (org-entry-get m "COLUMNS" t)))
16331 ((and (boundp 'org-columns-current-fmt)
16332 (local-variable-p 'org-columns-current-fmt)
16333 org-columns-current-fmt)
16334 (setq fmt org-columns-current-fmt))
16335 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
16336 (setq m (get-text-property m 'org-hd-marker))
16337 (setq fmt (org-entry-get m "COLUMNS" t))))
16338 (setq fmt (or fmt org-columns-default-format))
16339 (org-set-local 'org-columns-current-fmt fmt)
16340 (org-columns-compile-format fmt)
16341 (save-excursion
16342 ;; Get and cache the properties
16343 (goto-char (point-min))
16344 (while (not (eobp))
16345 (when (setq m (or (get-text-property (point) 'org-hd-marker)
16346 (get-text-property (point) 'org-marker)))
16347 (push (cons (org-current-line) (org-entry-properties m)) cache))
16348 (beginning-of-line 2))
16349 (when cache
16350 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16351 (org-set-local 'org-columns-current-maxwidths maxwidths)
16352 (org-columns-display-here-title)
16353 (mapc (lambda (x)
16354 (goto-line (car x))
16355 (org-columns-display-here (cdr x)))
16356 cache)))))
16358 (defun org-columns-get-autowidth-alist (s cache)
16359 "Derive the maximum column widths from the format and the cache."
16360 (let ((start 0) rtn)
16362 (push (cons (match-string 1 s) 1) rtn)
16363 (setq start (match-end 0)))
16364 (mapc (lambda (x)
16365 (setcdr x (apply 'max
16366 (mapcar
16367 (lambda (y)
16368 (length (or (cdr (assoc (car x) (cdr y))) " ")))
16369 cache))))
16370 rtn)
16371 rtn))
16373 (defun org-columns-compute-all ()
16374 "Compute all columns that have operators defined."
16375 (org-unmodified
16376 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
16377 (let ((columns org-columns-current-fmt-compiled) col)
16378 (while (setq col (pop columns))
16379 (when (nth 3 col)
16380 (save-excursion
16381 (org-columns-compute (car col)))))))
16383 (defun org-columns-update (property)
16384 "Recompute PROPERTY, and update the columns display for it."
16385 (org-columns-compute property)
16386 (let (fmt val pos)
16387 (save-excursion
16388 (mapc (lambda (ov)
16389 (when (equal (org-overlay-get ov 'org-columns-key) property)
16390 (setq pos (org-overlay-start ov))
16391 (goto-char pos)
16392 (when (setq val (cdr (assoc property
16393 (get-text-property
16394 (point-at-bol) 'org-summaries))))
16395 (setq fmt (org-overlay-get ov 'org-columns-format))
16396 (org-overlay-put ov 'org-columns-value val)
16397 (org-overlay-put ov 'display (format fmt val)))))
16398 org-columns-overlays))))
16400 (defun org-columns-compute (property)
16401 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
16402 (interactive)
16403 (let* ((re (concat "^" outline-regexp))
16404 (lmax 30) ; Does anyone use deeper levels???
16405 (lsum (make-vector lmax 0))
16406 (lflag (make-vector lmax nil))
16407 (level 0)
16408 (ass (assoc property org-columns-current-fmt-compiled))
16409 (format (nth 4 ass))
16410 (printf (nth 5 ass))
16411 (beg org-columns-top-level-marker)
16412 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
16413 (save-excursion
16414 ;; Find the region to compute
16415 (goto-char beg)
16416 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
16417 (goto-char end)
16418 ;; Walk the tree from the back and do the computations
16419 (while (re-search-backward re beg t)
16420 (setq sumpos (match-beginning 0)
16421 last-level level
16422 level (org-outline-level)
16423 val (org-entry-get nil property)
16425 (cond
16426 ((< level last-level)
16427 ;; put the sum of lower levels here as a property
16428 (setq sum (aref lsum last-level) ; current sum
16429 flag (aref lflag last-level) ; any valid entries from children?
16430 str (org-column-number-to-string sum format printf)
16431 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
16432 useval (if flag str1 (if valflag val ""))
16433 sum-alist (get-text-property sumpos 'org-summaries))
16434 (if (assoc property sum-alist)
16435 (setcdr (assoc property sum-alist) useval)
16436 (push (cons property useval) sum-alist)
16437 (org-unmodified
16438 (add-text-properties sumpos (1+ sumpos)
16439 (list 'org-summaries sum-alist))))
16440 (when val
16441 (org-entry-put nil property (if flag str val)))
16442 ;; add current to current level accumulator
16443 (when (or flag valflag)
16444 ;; FIXME: is this ok?????????
16445 (aset lsum level (+ (aref lsum level)
16446 (if flag sum (org-column-string-to-number
16447 (if flag str val) format))))
16448 (aset lflag level t))
16449 ;; clear accumulators for deeper levels
16450 (loop for l from (1+ level) to (1- lmax) do
16451 (aset lsum l 0)
16452 (aset lflag l nil)))
16453 ((>= level last-level)
16454 ;; add what we have here to the accumulator for this level
16455 (aset lsum level (+ (aref lsum level)
16456 (org-column-string-to-number (or val "0") format)))
16457 (and valflag (aset lflag level t)))
16458 (t (error "This should not happen")))))))
16460 (defun org-columns-redo ()
16461 "Construct the column display again."
16462 (interactive)
16463 (message "Recomputing columns...")
16464 (save-excursion
16465 (if (marker-position org-columns-begin-marker)
16466 (goto-char org-columns-begin-marker))
16467 (org-columns-remove-overlays)
16468 (if (org-mode-p)
16469 (call-interactively 'org-columns)
16470 (call-interactively 'org-agenda-columns)))
16471 (message "Recomputing columns...done"))
16473 (defun org-columns-not-in-agenda ()
16474 (if (eq major-mode 'org-agenda-mode)
16475 (error "This command is only allowed in Org-mode buffers")))
16478 (defun org-string-to-number (s)
16479 "Convert string to number, and interpret hh:mm:ss."
16480 (if (not (string-match ":" s))
16481 (string-to-number s)
16482 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16483 (while l
16484 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16485 sum)))
16487 (defun org-column-number-to-string (n fmt printf)
16488 "Convert a computed column number to a string value, according to FMT."
16489 (cond
16490 ((eq fmt 'add_times)
16491 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
16492 (format "%d:%02d" h m)))
16493 ((eq fmt 'checkbox)
16494 (cond ((= n (floor n)) "[X]")
16495 ((> n 1.) "[-]")
16496 (t "[ ]")))
16497 (printf (format printf n))
16498 ((eq fmt 'currency)
16499 (format "%.2f" n))
16500 (t (number-to-string n))))
16502 (defun org-column-string-to-number (s fmt)
16503 "Convert a column value to a number that can be used for column computing."
16504 (cond
16505 ((string-match ":" s)
16506 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16507 (while l
16508 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16509 sum))
16510 ((eq fmt 'checkbox)
16511 (if (equal s "[X]") 1. 0.000001))
16512 (t (string-to-number s))))
16514 (defun org-columns-uncompile-format (cfmt)
16515 "Turn the compiled columns format back into a string representation."
16516 (let ((rtn "") e s prop title op width fmt printf)
16517 (while (setq e (pop cfmt))
16518 (setq prop (car e)
16519 title (nth 1 e)
16520 width (nth 2 e)
16521 op (nth 3 e)
16522 fmt (nth 4 e)
16523 printf (nth 5 e))
16524 (cond
16525 ((eq fmt 'add_times) (setq op ":"))
16526 ((eq fmt 'checkbox) (setq op "X"))
16527 ((eq fmt 'add_numbers) (setq op "+"))
16528 ((eq fmt 'currency) (setq op "$")))
16529 (if (and op printf) (setq op (concat op ";" printf)))
16530 (if (equal title prop) (setq title nil))
16531 (setq s (concat "%" (if width (number-to-string width))
16532 prop
16533 (if title (concat "(" title ")"))
16534 (if op (concat "{" op "}"))))
16535 (setq rtn (concat rtn " " s)))
16536 (org-trim rtn)))
16538 (defun org-columns-compile-format (fmt)
16539 "Turn a column format string into an alist of specifications.
16540 The alist has one entry for each column in the format. The elements of
16541 that list are:
16542 property the property
16543 title the title field for the columns
16544 width the column width in characters, can be nil for automatic
16545 operator the operator if any
16546 format the output format for computed results, derived from operator
16547 printf a printf format for computed values"
16548 (let ((start 0) width prop title op f printf)
16549 (setq org-columns-current-fmt-compiled nil)
16550 (while (string-match
16551 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
16552 fmt start)
16553 (setq start (match-end 0)
16554 width (match-string 1 fmt)
16555 prop (match-string 2 fmt)
16556 title (or (match-string 3 fmt) prop)
16557 op (match-string 4 fmt)
16558 f nil
16559 printf nil)
16560 (if width (setq width (string-to-number width)))
16561 (when (and op (string-match ";" op))
16562 (setq printf (substring op (match-end 0))
16563 op (substring op 0 (match-beginning 0))))
16564 (cond
16565 ((equal op "+") (setq f 'add_numbers))
16566 ((equal op "$") (setq f 'currency))
16567 ((equal op ":") (setq f 'add_times))
16568 ((equal op "X") (setq f 'checkbox)))
16569 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
16570 (setq org-columns-current-fmt-compiled
16571 (nreverse org-columns-current-fmt-compiled))))
16574 ;;; Dynamic block for Column view
16576 (defun org-columns-capture-view ()
16577 "Get the column view of the current buffer and return it as a list.
16578 The list will contains the title row and all other rows. Each row is
16579 a list of fields."
16580 (save-excursion
16581 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
16582 (n (length title)) row tbl)
16583 (goto-char (point-min))
16585 (when (get-char-property (match-beginning 0) 'org-columns-key)
16586 (setq row nil)
16587 (loop for i from 0 to (1- n) do
16588 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
16589 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
16590 "")
16591 row))
16592 (setq row (nreverse row))
16593 (push row tbl)))
16594 (append (list title 'hline) (nreverse tbl)))))
16596 (defun org-dblock-write:columnview (params)
16597 "Write the column view table.
16598 PARAMS is a property list of parameters:
16600 :width enforce same column widths with <N> specifiers.
16601 :id the :ID: property of the entry where the columns view
16602 should be built, as a string. When `local', call locally.
16603 When `global' call column view with the cursor at the beginning
16604 of the buffer (usually this means that the whole buffer switches
16605 to column view).
16606 :hlines When t, insert a hline before each item. When a number, insert
16607 a hline before each level <= that number.
16608 :vlines When t, make each column a colgroup to enforce vertical lines."
16609 (let ((pos (move-marker (make-marker) (point)))
16610 (hlines (plist-get params :hlines))
16611 (vlines (plist-get params :vlines))
16612 tbl id idpos nfields tmp)
16613 (save-excursion
16614 (save-restriction
16615 (when (setq id (plist-get params :id))
16616 (cond ((not id) nil)
16617 ((eq id 'global) (goto-char (point-min)))
16618 ((eq id 'local) nil)
16619 ((setq idpos (org-find-entry-with-id id))
16620 (goto-char idpos))
16621 (t (error "Cannot find entry with :ID: %s" id))))
16622 (org-columns)
16623 (setq tbl (org-columns-capture-view))
16624 (setq nfields (length (car tbl)))
16625 (org-columns-quit)))
16626 (goto-char pos)
16627 (move-marker pos nil)
16628 (when tbl
16629 (when (plist-get params :hlines)
16630 (setq tmp nil)
16631 (while tbl
16632 (if (eq (car tbl) 'hline)
16633 (push (pop tbl) tmp)
16635 (if (and (not (eq (car tmp) 'hline))
16636 (or (eq hlines t)
16637 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
16638 (push 'hline tmp)))
16639 (push (pop tbl) tmp)))
16640 (setq tbl (nreverse tmp)))
16641 (when vlines
16642 (setq tbl (mapcar (lambda (x)
16643 (if (eq 'hline x) x (cons "" x)))
16644 tbl))
16645 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
16646 (setq pos (point))
16647 (insert (org-listtable-to-string tbl))
16648 (when (plist-get params :width)
16650 org-columns-current-widths "|")))
16651 (goto-char pos)
16652 (org-table-align))))
16654 (defun org-listtable-to-string (tbl)
16655 "Convert a listtable TBL to a string that contains the Org-mode table.
16656 The table still need to be alligned. The resulting string has no leading
16657 and tailing newline characters."
16658 (mapconcat
16659 (lambda (x)
16660 (cond
16661 ((listp x)
16662 (concat "|" (mapconcat 'identity x "|") "|"))
16663 ((eq x 'hline) "|-|")
16664 (t (error "Garbage in listtable: %s" x))))
16667 (defun org-insert-columns-dblock ()
16668 "Create a dynamic block capturing a column view table."
16669 (interactive)
16670 (let ((defaults '(:name "columnview" :hlines 1))
16671 (id (completing-read
16672 "Capture columns (local, global, entry with :ID: property) [local]: "
16673 (append '(("global") ("local"))
16674 (mapcar 'list (org-property-values "ID"))))))
16675 (if (equal id "") (setq id 'local))
16676 (if (equal id "global") (setq id 'global))
16677 (setq defaults (append defaults (list :id id)))
16678 (org-create-dblock defaults)
16679 (org-update-dblock)))
16681 ;;;; Timestamps
16683 (defvar org-last-changed-timestamp nil)
16684 (defvar org-time-was-given) ; dynamically scoped parameter
16685 (defvar org-end-time-was-given) ; dynamically scoped parameter
16686 (defvar org-ts-what) ; dynamically scoped parameter
16688 (defun org-time-stamp (arg)
16689 "Prompt for a date/time and insert a time stamp.
16690 If the user specifies a time like HH:MM, or if this command is called
16691 with a prefix argument, the time stamp will contain date and time.
16692 Otherwise, only the date will be included. All parts of a date not
16693 specified by the user will be filled in from the current date/time.
16694 So if you press just return without typing anything, the time stamp
16695 will represent the current date/time. If there is already a timestamp
16696 at the cursor, it will be modified."
16697 (interactive "P")
16698 (let* ((ts nil)
16699 (default-time
16700 ;; Default time is either today, or, when entering a range,
16701 ;; the range start.
16702 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16703 (save-excursion
16704 (re-search-backward
16706 (- (point) 20) t)))
16707 (apply 'encode-time (org-parse-time-string (match-string 1)))
16708 (current-time)))
16709 (default-input (and ts (org-get-compact-tod ts)))
16710 org-time-was-given org-end-time-was-given time)
16711 (cond
16712 ((and (org-at-timestamp-p)
16713 (eq last-command 'org-time-stamp)
16714 (eq this-command 'org-time-stamp))
16715 (insert "--")
16716 (setq time (let ((this-command this-command))
16717 (org-read-date arg 'totime nil nil default-time default-input)))
16718 (org-insert-time-stamp time (or org-time-was-given arg)))
16719 ((org-at-timestamp-p)
16720 (setq time (let ((this-command this-command))
16721 (org-read-date arg 'totime nil nil default-time default-input)))
16722 (when (org-at-timestamp-p) ; just to get the match data
16723 (replace-match "")
16724 (setq org-last-changed-timestamp
16725 (org-insert-time-stamp
16726 time (or org-time-was-given arg)
16727 nil nil nil (list org-end-time-was-given))))
16728 (message "Timestamp updated"))
16729 (t
16730 (setq time (let ((this-command this-command))
16731 (org-read-date arg 'totime nil nil default-time default-input)))
16732 (org-insert-time-stamp time (or org-time-was-given arg)
16733 nil nil nil (list org-end-time-was-given))))))
16735 ;; FIXME: can we use this for something else????
16736 ;; like computing time differences?????
16737 (defun org-get-compact-tod (s)
16738 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16739 (let* ((t1 (match-string 1 s))
16740 (h1 (string-to-number (match-string 2 s)))
16741 (m1 (string-to-number (match-string 3 s)))
16742 (t2 (and (match-end 4) (match-string 5 s)))
16743 (h2 (and t2 (string-to-number (match-string 6 s))))
16744 (m2 (and t2 (string-to-number (match-string 7 s))))
16745 dh dm)
16746 (if (not t2)
16747 t1
16748 (setq dh (- h2 h1) dm (- m2 m1))
16749 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16750 (concat t1 "+" (number-to-string dh)
16751 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16753 (defun org-time-stamp-inactive (&optional arg)
16754 "Insert an inactive time stamp.
16755 An inactive time stamp is enclosed in square brackets instead of angle
16756 brackets. It is inactive in the sense that it does not trigger agenda entries,
16757 does not link to the calendar and cannot be changed with the S-cursor keys.
16758 So these are more for recording a certain time/date."
16759 (interactive "P")
16760 (let (org-time-was-given org-end-time-was-given time)
16761 (setq time (org-read-date arg 'totime))
16762 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
16763 nil nil (list org-end-time-was-given))))
16765 (defvar org-date-ovl (org-make-overlay 1 1))
16766 (org-overlay-put org-date-ovl 'face 'org-warning)
16767 (org-detach-overlay org-date-ovl)
16769 (defvar org-ans1) ; dynamically scoped parameter
16770 (defvar org-ans2) ; dynamically scoped parameter
16772 (defvar org-plain-time-of-day-regexp) ; defined below
16774 (defvar org-read-date-overlay nil)
16775 (defvar org-dcst nil) ; dynamically scoped
16777 (defun org-read-date (&optional with-time to-time from-string prompt
16778 default-time default-input)
16779 "Read a date, possibly a time, and make things smooth for the user.
16780 The prompt will suggest to enter an ISO date, but you can also enter anything
16781 which will at least partially be understood by `parse-time-string'.
16782 Unrecognized parts of the date will default to the current day, month, year,
16783 hour and minute. If this command is called to replace a timestamp at point,
16784 of to enter the second timestamp of a range, the default time is taken from the
16785 existing stamp. For example,
16786 3-2-5 --> 2003-02-05
16787 feb 15 --> currentyear-02-15
16788 sep 12 9 --> 2009-09-12
16789 12:45 --> today 12:45
16790 22 sept 0:34 --> currentyear-09-22 0:34
16791 12 --> currentyear-currentmonth-12
16792 Fri --> nearest Friday (today or later)
16793 etc.
16795 Furthermore you can specify a relative date by giving, as the *first* thing
16796 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
16797 change in days weeks, months, years.
16798 With a single plus or minus, the date is relative to today. With a double
16799 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16800 +4d --> four days from today
16801 +4 --> same as above
16802 +2w --> two weeks from today
16803 ++5 --> five days from default date
16805 The function understands only English month and weekday abbreviations,
16806 but this can be configured with the variables `parse-time-months' and
16807 `parse-time-weekdays'.
16809 While prompting, a calendar is popped up - you can also select the
16810 date with the mouse (button 1). The calendar shows a period of three
16811 months. To scroll it to other months, use the keys `>' and `<'.
16812 If you don't like the calendar, turn it off with
16813 \(setq org-read-date-popup-calendar nil)
16815 With optional argument TO-TIME, the date will immediately be converted
16816 to an internal time.
16817 With an optional argument WITH-TIME, the prompt will suggest to also
16818 insert a time. Note that when WITH-TIME is not set, you can still
16819 enter a time, and this function will inform the calling routine about
16820 this change. The calling routine may then choose to change the format
16821 used to insert the time stamp into the buffer to include the time.
16822 With optional argument FROM-STRING, read from this string instead from
16823 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16824 the time/date that is used for everything that is not specified by the
16825 user."
16826 (require 'parse-time)
16827 (let* ((org-time-stamp-rounding-minutes
16828 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
16829 (org-dcst org-display-custom-times)
16830 (ct (org-current-time))
16831 (def (or default-time ct))
16832 (defdecode (decode-time def))
16833 (dummy (progn
16834 (when (< (nth 2 defdecode) org-extend-today-until)
16835 (setcar (nthcdr 2 defdecode) -1)
16836 (setcar (nthcdr 1 defdecode) 59)
16837 (setq def (apply 'encode-time defdecode)
16838 defdecode (decode-time def)))))
16839 (calendar-move-hook nil)
16840 (view-diary-entries-initially nil)
16841 (view-calendar-holidays-initially nil)
16842 (timestr (format-time-string
16843 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
16844 (prompt (concat (if prompt (concat prompt " ") "")
16845 (format "Date+time [%s]: " timestr)))
16846 ans (org-ans0 "") org-ans1 org-ans2 final)
16848 (cond
16849 (from-string (setq ans from-string))
16850 (org-read-date-popup-calendar
16851 (save-excursion
16852 (save-window-excursion
16853 (calendar)
16854 (calendar-forward-day (- (time-to-days def)
16855 (calendar-absolute-from-gregorian
16856 (calendar-current-date))))
16857 (org-eval-in-calendar nil t)
16858 (let* ((old-map (current-local-map))
16859 (map (copy-keymap calendar-mode-map))
16860 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
16861 (org-defkey map (kbd "RET") 'org-calendar-select)
16862 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
16863 'org-calendar-select-mouse)
16901 ;; org-ans0: from prompt
16902 ;; org-ans1: from mouse click
16903 ;; org-ans2: from calendar motion
16931 "Display the currrent date prompt interpretation in the minibuffer."
16947 org-time-stamp-custom-formats
16948 org-time-stamp-formats))
16957 org-end-time-was-given
16964 "Analyze the combined answer of the date prompt."
16965 ;; FIXME: cleanup and comment
16967 hour minute second wday pm h2 m2 tl wday1)
16975 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
16985 t nil ans)))
16986 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16987 ;; If there is a time with am/pm, and *no* time without it, we convert
16988 ;; so that matching will be successful.
17002 t t ans))))
17004 ;; Check if a time range is given as a duration
17005 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17013 ;; Check if there is a time range
17047 ;; Weekday was given, but no day, so pick that day in the week
17048 ;; on or after the derived date.
17062 "Check string S for special relative date string.
17063 TODAY and DEFAULT are internal times, for today and for a default.
17064 Return shift list (N what def-flag)
17066 N is the number if WHATs to shift
17067 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17068 the DEFAULT date rather than TODAY."
17077 ?+))
17084 delta)
17094 "Eval FORM in the calendar window and return to current window.
17095 Also, store the cursor date in variable org-ans2."
17106 ; ;; Update the prompt to show new default date
17107 ; (save-excursion
17108 ; (goto-char (point-min))
17109 ; (when (and org-ans2
17110 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17111 ; (get-text-property (match-end 0) 'field))
17112 ; (let ((inhibit-read-only t))
17113 ; (replace-match (concat "[" org-ans2 "]") t t)
17114 ; (add-text-properties (point-min) (1+ (match-end 0))
17115 ; (text-properties-at (1+ (point-min)))))))))
17118 "Return to `org-read-date' with the date currently selected.
17119 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17128 "Insert a date stamp for the date given by the internal TIME.
17129 WITH-HM means, use the stamp format that includes the time of the day.
17130 INACTIVE means use square brackets instead of angular ones, so that the
17131 stamp will not contribute to the agenda.
17132 PRE and POST are optional strings to be inserted before and after the
17133 stamp.
17134 The command returns the inserted time stamp."
17136 stamp)
17153 stamp))
17156 "Toggle the use of custom time stamp formats."
17177 "Overlay modified time stamp format over timestamp between BED and END."
17204 "Translate all timestamps in STRING to custom format.
17205 But do this only if the variable `org-display-custom-times' is set."
17210 t1 with-hm inactive tf time str beg end)
17219 org-time-stamp-custom-formats)
17228 string)
17231 "Set 0 instead of nil for the first 6 elements of time.
17232 Don't touch the rest."
17237 "Difference between TIMESTAMP-STRING and now in days."
17242 "Is the time in TIMESTAMP-STRING close to the current date?"
17248 "Get the deadline lead time appropriate for timestring TS."
17251 ;; 0 or negative, enforce this value no matter what
17254 ;; lead time is specified.
17259 ;; go for the default.
17263 "Return to `org-read-date' with the date currently selected.
17264 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17274 "Check if there are any deadlines due or past due.
17275 A deadline is considered due if it happens within `org-deadline-warning-days'
17276 days from today's date. If the deadline appears in an entry marked DONE,
17277 it is not shown. The prefix arg NDAYS can be used to test that many
17292 org-warn-days)))
17295 "Evaluate a time range by computing the difference between start and end.
17296 Normally the result is just printed in the echo area, but with prefix arg
17297 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17298 If the time range is actually in a table, the result is inserted into the
17299 next column.
17300 For time difference computation, a year is assumed to be exactly 365
17301 days in order to avoid rounding problems."
17321 ;; (ys (floor (* 365 24 60 60)))
17329 y d h m align)
17332 y 0
17337 y 0
17375 "Convert a time stamp to an absolute day number.
17376 If there is a specifyer for a cyclic time stamp, get the closest date to
17377 DAYNR."
17381 daynr
17389 "Return the time corresponding to date D.
17390 D may be an absolute day number, or a calendar-type list (month day year)."
17395 "List of holidays, for Diary display in Org-mode."
17403 "Process a SEXP diary ENTRY for DATE."
17423 "Get iCalendar entries from diary entries in buffer FROMBUF.
17424 This uses the icalendar.el library."
17427 temporary-file-directory))
17430 buf rtn b e)
17446 rtn))
17449 "Find the date closest to CURRENT that is consistent with START and CHANGE."
17450 ;; Make the proper lists from the dates
17453 dn dw sday cday n1 n2
17454 d m y y1 y2 date1 date2 nmonths nm ny m2)
17459 current
17483 ;; approx number of month between the tow dates
17485 ;; How often does dn fit in there?
17508 "Turn any specification of DATE into a gregorian date for the calendar."
17518 "Parse the standard Org-mode time string.
17519 This should be a lot faster than the normal `parse-time-string'.
17520 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17521 hour and minute fields will be nil if not given."
17531 nil nil nil)
17535 "Increase the date item at the cursor by one.
17536 If the cursor is on the year, change the year. If it is on the month or
17537 the day, change that.
17538 With prefix ARG, change by that many units."
17543 "Decrease the date item at the cursor by one.
17544 If the cursor is on the year, change the year. If it is on the month or
17545 the day, change that.
17546 With prefix ARG, change by that many units."
17551 "Increase the date in the time stamp by one day.
17552 With prefix ARG, change that many days."
17560 "Decrease the date in the time stamp by one day.
17561 With prefix ARG, change that many days."
17574 "Determine if the cursor is in or at a timestamp."
17600 ans))
17603 ""
17615 "Change the date in the time stamp at point.
17616 The date will be changed by N times WHAT. WHAT can be `day', `month',
17617 `year', `minute', `second'. If WHAT is not given, the cursor position
17618 in the timestamp determines what will be changed."
17620 with-hm inactive
17621 org-ts-what
17622 extra
17623 ts time time0)
17629 org-display-custom-times
17639 ts)
17667 ;; Try to recenter the calendar window, if any
17673 ;; FIXME: does not yet work for lead times
17675 "Change the different parts of the lead-time and repeat fields in timestamp."
17677 ng h m new)
17678 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17699 new
17701 s))
17704 "If the calendar is visible, recenter it to DATE."
17715 "Go to the Emacs calendar at the current date.
17716 If there is a time stamp in the current line, go to that date.
17717 A prefix ARG can be used to force the current date."
17736 "Return a list (month day year) of date at point in calendar."
17742 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17743 If there is already a time stamp at the cursor position, update it."
17751 ;; Make appt aware of appointments from the agenda
17752 ;;;###autoload
17754 "Activate appointments found in `org-agenda-files'.
17755 When prefixed, prompt for a regular expression and use it as a
17756 filter: only add entries if they match this regular expression.
17758 FILTER can be a string. In this case, use this string as a
17759 regular expression to filter results.
17761 FILTER can also be an alist, with the car of each cell being
17762 either 'headline or 'category. For example:
17767 will only add headlines containing IMPORTANT or headlines
17777 ;; Get all entries which may contain an appt
17782 file today
17785 ;; Map thru entries and find if they pass thru the filter
17798 ;; FIXME Shall we remove text-properties for the appt text?
17799 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
17810 ;;; The clock for measuring work time.
17835 "Start the clock on the current item.
17836 If necessary, clock-out of the currently active clock."
17866 "Find the location where the next clock line should be inserted."
17872 first last)
17876 ;; we seem to have a CLOCK drawer, so go there.
17879 ;; Lets count the CLOCK lines
17887 ;; Wrap current entries into a new drawer
17905 ;; Planning info, skip to after it
17917 "Stop the currently running clock.
17918 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
17957 "Cancel the running clock be removing the start timestamp."
17971 "Go to the currently clocked-in entry."
17988 "Sum the times for each subtree.
17989 Puts the resulting times in minutes as a text property on each headline."
17993 org-clock-string
17999 ts te dt
18000 time)
18007 ;; Two time stamps
18019 ;; A naket time
18036 "Show subtree times in the entire buffer.
18037 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18038 in the echo area."
18055 ;; Arrange to remove the overlays upon next change.
18065 "Put an overlays on the current line, displaying TIME.
18066 If LEVEL is given, prefix time with a corresponding number of stars.
18067 This creates a new overlay and stores it in `org-clock-overlays', so that it
18068 will be easy to remove."
18072 ov tx)
18091 "Remove the occur highlights from the buffer.
18092 BEG and END are ignored. If NOREMOVE is nil, remove this function
18093 from the `before-change-functions' in the current buffer."
18103 "Clock out if the current entry contains the running clock.
18104 This is used to stop the clock after a TODO entry is marked DONE,
18105 and is only done if the variable `org-clock-out-when-done' is not nil."
18111 org-clock-marker))
18112 ;; Clock out, but don't accept a logging message for this.
18116 org-log-done)))
18123 "Check if the current buffer contains the running clock.
18124 If yes, offer to stop it and to save the buffer with the changes."
18133 "Create a table containing a report about clocked time.
18134 If the cursor is inside an existing clocktable block, then the table
18135 will be updated. If not, a new clocktable will be inserted.
18136 When called with a prefix argument, move to the first clock table in the
18137 buffer and update it."
18148 "Check if the cursor is in a clocktable."
18156 start))))
18159 "If this is a CLOCK line, update it and return t.
18160 Otherwise, return nil."
18169 ts te h m s)
18171 nil
18185 t)))))
18188 "Return two times bordering a special time range.
18189 Key is a symbol specifying the range and can be one of `today', `yesterday',
18190 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18191 A week starts Monday 0:00 and ends Sunday 24:00.
18192 The range is determined relative to TIME. TIME defaults to the current time.
18193 The return value is a cons cell with two internal times like the ones
18194 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18195 the returned times will be formatted strings."
18200 s1 m1 h1 d1 month1 y1 diff ts te fm)
18230 "Write the standard clocktable."
18235 ipos time h m p level hlc hdl maxlevel
18236 ts te cc block beg end pos scope tbl tostring multifile)
18255 ;; Get the right scope
18278 file)
18288 org-clock-file-total-minutes)))))))
18299 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
18318 "Clock summary at ["
18322 "]."
18335 "|"
18336 "*Total time*| "
18359 x))
18360 lines)
18363 ;; FIXME: I don't think anybody uses this, ask David
18365 "Return an internal list with clocking information.
18366 This list has one entry for each CLOCK interval.
18367 FIXME: describe the elements."
18371 rtn beg end next cont level title total closedp leafp
18372 clockpos titlepos h m donep)
18397 total title titlepos level leafp)
18398 rtn)
18402 ;;;; Agenda, and Diary Integration
18404 ;;; Define the Org-agenda-mode
18418 "Mode for time-sorted view on action items in Org-mode files.
18420 The following commands are available:
18426 org-agenda-pending-undo-list nil)
18428 ;; Keep global-font-lock-mode from turning on font-lock-mode
18436 ;; Make sure properties are removed when copying text
18441 buffer-substring-filters)))
18444 org-agenda-show-log nil))
18451 "Restricted to single file"
18463 org-agenda-mode-map global-map)
18561 "--"
18568 "--"
18572 "--"
18577 "--"
18582 "--"
18587 "--"
18604 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
18608 "--"
18610 "--"
18620 "--"
18622 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
18626 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
18630 "--"
18632 "--"
18635 ))
18637 ;;; Agenda undo
18649 "Execute BODY if there is no `org-protected' text property at point."
18655 "Execute BODY while recording undo information in two buffers."
18663 _c1 _c2)
18664 ,@_body
18671 ;; make sure there are undo boundaries
18674 ;; remember which buffer to undo
18676 org-agenda-undo-list)))))
18679 "Undo a remote editing step in the agenda.
18680 This undoes changes both in the agenda buffer and in the remote buffer
18681 that have been changed along."
18687 org-agenda-pending-undo-list org-agenda-undo-list))
18691 buf line cmd rembuf)
18713 "Verify that a real change occurred between the undo lists L1 and L2."
18718 ;;; Agenda dispatch
18726 ;;;###autoload
18728 "Dispatch agenda commands to collect entries to the agenda buffer.
18729 Prompts for a command to execute. Any prefix arg will be passed
18730 on to the selected command. The default selections are:
18732 a Call `org-agenda-list' to display the agenda for current day or week.
18733 t Call `org-todo-list' to display the global todo list.
18734 T Call `org-todo-list' to display the global todo list, select only
18735 entries with a specific TODO keyword (the user gets a prompt).
18736 m Call `org-tags-view' to display headlines with tags matching
18737 a condition (the user is prompted for the condition).
18738 M Like `m', but select only TODO entries, no ordinary headlines.
18739 L Create a timeline for the current buffer.
18740 e Export views to associated files.
18742 More commands can be added by configuring the variable
18743 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
18744 searches can be pre-defined in this way.
18746 If the current buffer is in Org-mode and visiting a file, you can also
18747 first press `<' once to indicate that the agenda should be temporarily
18749 Pressing `<' twice means to restrict to the current subtree or region
18750 \(if active)."
18755 ;; normalize different versions
18761 nil)
18765 org-agenda-custom-commands)))
18768 entry key type match lprops ans)
18769 ;; Turn off restriction unless there is an overriding one
18775 ;; Delete old local properties
18777 ;; Remember where this call originated
18783 ;; Estabish the restriction, if any
18800 ;; For example the todo list should not need it (but does...)
18814 current-prefix-arg)))
18857 "The user interface for selecting an agenda command."
18864 restriction second-time
18865 c entry key type match prefixes rmheader header-end custom1 desc)
18872 "
18873 Press key for an agenda command: < Buffer,subtree/region restriction
18874 -------------------------------- > Remove restriction
18875 a Agenda for current week or day e Export agenda views
18876 t List of all TODO entries T Entries with special TODO kwd
18877 m Match a TAGS query M Like m, but only TODO entries
18878 L Timeline for current buffer # List stuck projects (!=configure)
18879 / Multi-occur C Configure custom agenda commands
18884 header start)
18888 header)))
18940 prefix-descriptions))
18942 prefixes))
18953 " (restriction lock active)"
18966 prefixes nil
18972 nil
18974 custom))))
18991 nil)
19007 match ;; The byte compiler incorrectly complains about this. Keep it!
19008 cmd type lprops)
19039 ;;;###autoload
19041 "Run an agenda command in batch mode and send the result to STDOUT.
19042 If CMD-KEY is a string of length 1, it is used as a key in
19043 `org-agenda-custom-commands' and triggers this command. If it is a
19044 longer string is is used as a tags/todo match string.
19045 Paramters are alternating variable names and values that will be bound
19046 before running the agenda command."
19060 string))
19064 ;;;###autoload
19066 "Run an agenda command in batch mode and send the result to STDOUT.
19067 If CMD-KEY is a string of length 1, it is used as a key in
19068 `org-agenda-custom-commands' and triggers this command. If it is a
19069 longer string is is used as a tags/todo match string.
19070 Paramters are alternating variable names and values that will be bound
19071 before running the agenda command.
19073 The output gives a line for each selected agenda item. Each
19074 item is a list of comma-separated values, like this:
19076 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19078 category The category of the item
19079 head The headline, without TODO kwd, TAGS and PRIORITY
19080 type The type of the agenda entry, can be
19081 todo selected in TODO match
19082 tagsmatch selected in tags match
19083 diary imported from diary
19084 deadline a deadline on given date
19085 scheduled scheduled on given date
19086 timestamp entry has timestamp on given date
19087 closed entry was closed on given date
19088 upcoming-deadline warning about deadline
19089 past-scheduled forwarded scheduled item
19090 block entry has date block including g. date
19091 todo The todo keyword, if any
19092 tags All tags including inherited ones, separated by colons
19093 date The relevant date, like 2007-2-14
19094 time The time, like 15:00-16:50
19095 extra Sting with extra planning info
19096 priority-l The priority letter if any was given
19097 priority-n The computed numerical priority
19098 agenda-day The day in the agenda where this is listed"
19110 line)
19120 priority-letter priority agenda-day)
19125 "Make sure all properties on an agenda item have a canonical form,
19126 so the the export commands caneasily use it."
19153 props)
19167 ;;;###autoload
19172 ;; FIXME, why is this a macro?????
19173 ;;;###autoload
19175 "Run all custom agenda commands that have a file argument."
19179 pars cmd thiscmdkey files opts)
19202 "Write the current buffer (an agenda view) as a file.
19203 Depending on the extension of the file name, plain text (.txt),
19204 HTML (.html or .htm) or Postscript (.ps) is produced.
19205 If NOSETTINGS is given, do not scope the settings of
19206 `org-agenda-exporter-settings' into the export commands. This is used when
19207 the settings have already been scoped and we do not wish to overrule other,
19208 higher priority settings."
19224 ;; replace <style> section with org-agenda-export-html-style
19245 "Inhibit read-only for BODY."
19249 "Make sure current buffer is in org-mode. Error if not."
19252 major-mode)))
19255 "Fit the window to the buffer size."
19259 nil
19263 ;;; Agenda file list
19266 "Get the list of agenda files.
19267 Optional UNRESTRICTED means return the full list even if a restriction
19268 is currently in place."
19280 files)))
19286 files))
19290 "Edit the list of agenda files.
19291 Depending on setup, this either uses customize to edit the variable
19292 `org-agenda-files', or it visits the file that is holding the list. In the
19293 latter case, the buffer is set up in a way that saving it automatically kills
19294 the buffer and restores the previous window configuration."
19313 "Set new value for the agenda file list and save it correcly."
19324 "Read the list of agenda files from a file."
19331 ;;;###autoload
19333 "Cycle through the files in `org-agenda-files'.
19334 If the current buffer visits an agenda file, find the next one in the list.
19335 If the current buffer does not, find the first agenda file."
19340 file)
19352 "Move/add the current file to the top of the agenda file list.
19353 If the file is not present in the list, it is added to the front. If it is
19354 present, it is moved there. With optional argument TO-END, add/move to the
19355 end of the list."
19362 x had)
19375 "Remove current file from the list of files in variable `org-agenda-files'.
19376 These are the files which are being checked for agenda entries.
19377 Optional argument FILE means, use this file instead of the current."
19387 nil x))
19400 "Make sure FILE exists. If not, ask user what to do."
19411 ;;; Agenda prepare and finalize
19456 "Finishing touch for the agenda buffer, called just before displaying it."
19468 org-overriding-columns-format)
19470 org-overriding-columns-format))
19472 org-agenda-view-columns-initially)
19479 "Make highest priority lines bold, and lowest italic."
19486 b e p ov h l)
19490 org-highest-priority)
19492 org-lowest-priority)
19497 ov 'face
19505 "Create buffers for all agenda files, protect archived trees and comments."
19512 bmp file re)
19542 "Function to be called at each match during agenda construction.
19543 If this function returns nil, the current match should not be skipped.
19544 Otherwise, the function must return a position from where the search
19545 should be continued.
19546 This may also be a Lisp form, it will be evaluated.
19547 Never set this variable using `setq' or so, because then it will apply
19548 to all future agenda commands. Instead, bind it with `let' to scope
19549 it dynamically into the agenda-constructing command. A good way to set
19553 "Throw to `:skip' in places that should be skipped.
19554 Also moves point to the end of the skipped region, so that search can
19555 continue from there."
19581 "Return a new agenda marker.
19582 Org-mode keeps a list of these markers and resets them when they are
19583 no longer in use."
19587 m))
19590 "Reset markers created by `org-agenda'. But only if they are old enough."
19593 org-agenda-last-marker-time)
19599 "Get a buffer visiting FILE. If the buffer needs to be created, add
19600 it to the list of buffers which might be released later."
19603 buf ; just return it
19604 ;; Make a new buffer and remember it
19607 buf)))
19610 "Release all buffers in list, asking the user for confirmation when needed.
19611 When a buffer is unmodified, it is just killed. When modified, it is saved
19612 \(if the user agrees) and then killed."
19617 file
19623 "Get the category applying to position POS."
19626 ;;; Agenda timeline
19631 "Show a time-sorted view of the entries in the current org file.
19632 Only entries with a time stamp of today or later will be listed. With
19634 under the current date.
19635 If the buffer contains an active region, only check the region for
19636 dates."
19649 t doclosed ; always include today
19650 org-timeline-show-empty-dates))
19655 args
19656 s e rtn d emptyp)
19662 ;; Remove past dates from the list of dates.
19665 day-numbers))))
19682 dopast
19683 past)
19691 date args)))
19714 "Return a list of all relevant day numbers from BEG to END buffer positions.
19715 If NO-RANGES is non-nil, include only the start and end dates of a range,
19716 not every single day in the range. If FORCE-TODAY is non-nil, make
19717 sure that TODAY is included in the list. If INACTIVE is non-nil, also
19718 inactive time stamps (those in square brackets) are included.
19719 When EMPTY is non-nil, also include days without any entries."
19721 dates dates1 date day day1 day2 ts1 ts2)
19751 dates)))
19753 ;;; Agenda Daily/Weekly
19764 ;;;###autoload
19766 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
19767 The view will be for the current day or week, but from the overview buffer
19768 you will be able to go to other days/weeks.
19771 all unfinished TODO items will also be shown, before the agenda.
19772 This feature is considered obsolete, please use the TODO list or a block
19773 agenda instead.
19775 With a numeric prefix argument in an interactive call, the agenda will
19776 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
19777 the number of days. NDAYS defaults to `org-agenda-ndays'.
19779 START-DAY defaults to TODAY, or to the most recent match for the weekday
19780 given in `org-agenda-start-on-weekday'."
19791 ;; Convert to an absolute day number
19799 org-agenda-start-on-weekday nil))
19808 sd
19817 s e rtn rtnall file date d start-pos end-pos todayp nd)
19820 ;; Make the list of days
19822 nd ndays)
19835 rtnall nil)
19863 rtnall nil)
19869 file date
19872 file date
19896 rtnall nd todayp))
19919 ;;; Agenda TODO list
19924 ;;;###autoload
19926 "Show all TODO entries from all agenda file in a single list.
19927 The prefix arg can be used to select a specific TODO keyword and limit
19929 for a keyword. A numeric prefix directly selects the Nth keyword in
19930 `org-todo-keywords-1'."
19944 rtn rtnall files file pos)
19954 rtnall nil)
19978 kwds))
19989 ;;; Agenda tags match
19991 ;;;###autoload
19993 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
19994 The prefix arg TODO-ONLY limits the search to TODO entries."
20001 rtn rtnall files file pos matcher
20002 buffer)
20010 rtnall nil)
20018 ;; If file does not exist, merror message to agenda
20029 org-agenda-restrict-end)
20054 ;;; Agenda Finding stuck projects
20057 "Regular expression used in skipping subtrees for the agenda.
20058 This is basically a temporary global variable that can be set and then
20065 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20066 If yes, it returns the end position of this tree, causing agenda commands
20067 to skip this subtree. This is a function that can be put into
20068 `org-agenda-skip-function' for the duration of a command."
20070 skip)
20076 "Skip entry if any of CONDITIONS is true.
20077 See `org-agenda-skip-if for details."
20081 "Skip entry if any of CONDITIONS is true.
20082 See `org-agenda-skip-if for details."
20086 "Checks current entity for CONDITIONS.
20087 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20088 the entry, i.e. the text before the next heading is checked.
20090 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20091 from different tests. Valid conditions are:
20093 scheduled Check if there is a scheduled cookie
20094 notscheduled Check if there is no scheduled cookie
20095 deadline Check if there is a deadline
20096 notdeadline Check if there is no deadline
20097 regexp Check if regexp matches
20098 notregexp Check if regexp does not match.
20100 The regexp is taken from the conditions list, it must com right after the
20101 `regexp' of `notregexp' element.
20103 If any of these conditions is met, this function returns the end point of
20104 the entity, causing the search to continue from there. This is a function
20105 that can be put into `org-agenda-skip-function' for the duration of a command."
20129 end)))
20131 ;;;###autoload
20133 "Create agenda view for projects that are stuck.
20134 Stuck projects are project that have no next actions. For the definitions
20135 of what a project is and how to check if it stuck, customize the variable
20136 `org-stuck-projects'.
20137 MATCH is being ignored."
20140 ;; FIXME: we could have used org-agenda-skip-if here.
20148 org-done-keywords-for-agenda
20150 todo))
20167 gen-re)))))
20178 ;;; Diary integration
20183 "Get the (Emacs Calendar) diary entries for DATE."
20191 entries
20203 ;; No entries
20205 ;; Omit the date and other unnecessary stuff
20207 ;; Add prefix to each line and extend the text properties
20219 ;; Extend the text properties to the beginning of the line
20222 entries)))))
20225 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
20226 This gets rid of the date, the underline under the date, and
20227 the dummy entry installed by `org-mode' to ensure non-empty diary for each
20228 date. It also removes lines that contain only whitespace."
20245 ;; Make sure entries from the diary have the right text properties.
20248 ;; We can rely on the hook, nothing to do
20249 nil
20250 ;; Hook not avaiable, must use advice to make this work
20252 "Make the position visible."
20255 buffer-file-name)
20259 "Add text properties to string, allowing org-mode to act on it."
20262 'keymap org-agenda-keymap
20267 'org-agenda-diary-link t
20271 "Add a dummy entry to the diary.
20272 Needed to avoid empty dates which mess up holiday display."
20273 ;; Catch the error if dealing with the new add-to-diary-alist
20280 ;;;###autoload
20282 "Return diary information from org-files.
20284 It accesses org files and extracts information from those files to be
20285 listed in the diary. The function accepts arguments specifying what
20286 items should be listed. The following arguments are allowed:
20288 :timestamp List the headlines of items containing a date stamp or
20289 date range matching the selected date. Deadlines will
20290 also be listed, on the expiration day.
20292 :sexp List entries resulting from diary-like sexps.
20294 :deadline List any deadlines past due, or due within
20295 `org-deadline-warning-days'. The listing occurs only
20296 in the diary for *today*, not at any other date. If
20297 an entry is marked DONE, it is no longer listed.
20299 :scheduled List all items which are scheduled for the given date.
20300 The diary for *today* also contains items which were
20301 scheduled earlier and are not yet marked DONE.
20303 :todo List all TODO items from the org-file. This may be a
20304 long list - so this is not turned on by default.
20305 Like deadlines, these entries only show up in the
20306 diary for *today*, not at any other date.
20308 The call in the diary file should look like this:
20310 &%%(org-diary) ~/path/to/some/orgfile.org
20312 Use a separate line for each org file to check. Or, if you omit the file name,
20313 all files listed in `org-agenda-files' will be checked automatically:
20315 &%%(org-diary)
20317 If you don't give any arguments (as in the example above), the default
20318 arguments (:deadline :scheduled :timestamp :sexp) are used.
20319 So the example above may also be written as
20321 &%%(org-diary :deadline :timestamp :sexp :scheduled)
20323 The function expects the lisp variables `entry' and `date' to be provided
20324 by the caller, because this is how the calendar works. Don't use this
20325 function from a program - use `org-agenda-get-day-entries' instead."
20333 file rtn results)
20335 ;; If this is called during org-agenda, don't return any entries to
20336 ;; the calendar. Org Agenda will list these entries itself.
20344 ;;; Agenda entry finders
20347 "Does the work for `org-diary' and `org-agenda'.
20348 FILE is the path to a file to be checked for entries. DATE is date like
20349 the one returned by `calendar-current-date'. ARGS are symbols indicating
20350 which kind of entries should be extracted. For details about these, see
20351 the documentation of `org-diary'."
20358 arg results rtn)
20360 ;; If file does not exist, make sure an error message ends up in diary
20370 org-agenda-restrict-end)
20372 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
20396 results))))
20398 ;; FIXME: this works only if the cursor is *not* at the
20399 ;; beginning of the entry
20400 ;(defun org-entry-is-done-p ()
20401 ; "Is the current entry marked DONE?"
20402 ; (save-excursion
20403 ; (and (re-search-backward "[\r\n]\\*+ " nil t)
20404 ; (looking-at org-nl-done-regexp))))
20420 "Is the cursor inside a date range?"
20435 nil)))
20438 "Return the TODO information for agenda display."
20441 'org-not-done-regexp org-not-done-regexp
20442 'org-todo-regexp org-todo-regexp
20444 'keymap org-agenda-keymap
20445 'help-echo
20448 ;; FIXME: get rid of the \n at some point but watch out
20452 org-todo-regexp
20456 org-not-done-regexp)
20458 marker priority category tags
20459 ee txt beg end)
20498 "Return the date stamp information for agenda display."
20500 'org-not-done-regexp org-not-done-regexp
20501 'org-todo-regexp org-todo-regexp
20503 'keymap org-agenda-keymap
20504 'help-echo
20512 "<%Y-%m-%d"
20526 marker hdmarker deadlinep scheduledp donep tmp priority category
20527 ee txt timestr tags b0 b3 e3 head)
20545 b0)
20552 ;; substring should only run to end of time stamp
20564 nil head category tags timestr nil
20565 remove-re)))
20578 "Return the sexp information for agenda display."
20582 'keymap org-agenda-keymap
20583 'help-echo
20587 marker category ee txt tags entry result beg b sexp sexp-entry)
20619 "Return the logged TODO entries for agenda display."
20621 'org-not-done-regexp org-not-done-regexp
20622 'org-todo-regexp org-todo-regexp
20623 'keymap org-agenda-keymap
20624 'help-echo
20636 marker hdmarker priority category tags closedp
20637 ee txt timestr)
20646 ;; donep (org-entry-is-done-p)
20647 )
20649 ;; substring should only run to end of time stamp
20673 "Return the deadline information for agenda display."
20675 'org-not-done-regexp org-not-done-regexp
20676 'org-todo-regexp org-todo-regexp
20677 'keymap org-agenda-keymap
20678 'help-echo
20684 d2 diff dfrac wdays pos pos1 category tags
20685 ee txt head face s upcomingp donep timestr)
20697 ;; When to show a deadline in the calendar:
20698 ;; If the expiration is within wdays warning time.
20699 ;; Past-due deadlines are only shown on the current date
20727 diff))
20728 head category tags timestr))))
20737 'org-category category
20746 "Return the face to displaying a deadline item.
20747 FRACTION is what fraction of the head-warning time has passed."
20754 "Return the scheduled information for agenda display."
20756 'org-todo-regexp org-todo-regexp
20759 'keymap org-agenda-keymap
20760 'help-echo
20766 d2 diff pos pos1 category tags
20767 ee txt head pastschedp donep face timestr s)
20777 ;; When to show a scheduled item in the calendar:
20778 ;; If it is on or past the date.
20806 head category tags timestr))))
20810 'org-scheduled-previously
20813 'undone-face face
20825 "Return the date-range information for agenda display."
20827 'org-not-done-regexp org-not-done-regexp
20828 'org-todo-regexp org-todo-regexp
20830 'keymap org-agenda-keymap
20831 'help-echo
20836 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
20837 donep head)
20849 ;; Only allow days between the limits, because the normal
20850 ;; date stamps will catch the limits.
20867 head category tags
20876 ;; Sort the entries by expiration date.
20879 ;;; Agenda presentation and sorting
20889 "Regular expression to match a plain time or time range.
20890 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
20891 groups carry important information:
20892 0 the full match
20893 1 the first time, range or not
20901 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
20902 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
20903 groups carry important information:
20904 0 the full match
20905 7 hours of duration
20914 "Regular expression to match a timestamp time or time range.
20915 After a match, the following groups carry important information:
20916 0 the full match
20917 1 date plus weekday, for backreferencing to make sure both times on same day
20918 2 the first time, range or not
20922 "A flag, set by `org-compile-prefix-format'.
20925 "A flag, set by `org-compile-prefix-format'.
20929 noprefix remove-re)
20930 "Format TXT to be inserted into the agenda buffer.
20931 In particular, it adds the prefix and corresponding text properties. EXTRA
20932 must be a string and replaces the `%s' specifier in the prefix format.
20933 CATEGORY (string, symbol or nil) may be used to overrule the default
20934 category taken from local variable or file name. It will replace the `%c'
20935 specifier in the format. DOTIME, when non-nil, indicates that a
20936 time-of-day should be extracted from TXT for sorting of this entry, and for
20937 the `%t' specifier in the format. When DOTIME is a string, this string is
20938 searched for a time before TXT is. NOPREFIX is a flag and indicates that
20939 only the correctly processes TXT should be returned - this is used by
20940 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
20941 Any match of REMOVE-RE will be removed from TXT."
20943 ;; Diary entries sometimes have extra whitespace at the beginning
20946 org-category
20952 time ; time and tag are needed for the eval of the prefix format
20955 stamp plain s0 s1 s2 rtn srp)
20957 ;; Extract starting and ending time and move them to prefix
20965 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
20966 ;; them, we might want to remove them there to avoid duplication.
20967 ;; The user can turn this off with a variable.
20973 t))
20975 ;; Normalize the time(s) to 24 hour
20983 org-agenda-default-appointment-duration))
20984 h)
20989 txt)
20990 ;; Tags are in the string
20993 org-prefix-has-tag))
20998 t t txt))))
21004 ;; Create the final string
21007 ;; Prepare the variables needed in the eval of the compiled format
21013 ;; Evaluate the compiled format
21016 ;; And finally add the text properties
21019 'org-highest-priority org-highest-priority
21020 'org-lowest-priority org-lowest-priority
21022 'time-of-day time-of-day
21023 'txt txt
21024 'time time
21025 'extra extra
21040 list)))
21045 new time)
21047 ;; don't show empty grid
21053 nil string "" nil
21055 new)
21063 "Compile the prefix format into a Lisp form that can be evaluated.
21064 The resulting form is returned and stored in the variable
21065 `org-prefix-format-compiled'."
21069 org-agenda-prefix-format)
21074 varform vars var e c f opt)
21076 s start)
21089 ""
21099 ;; the old format
21107 "Check string S for a time of day.
21108 If found, return it as a military time number between 0 and 2400.
21109 If not found, return nil.
21110 The optional STRING argument forces conversion into a 5 character wide string
21111 HH:MM."
21133 "Sort and concatenate the agenda items."
21136 list
21155 x))
21156 x)))
21159 "Compare the priorities of string A and B."
21167 "Compare the string values of categories of strings A and B."
21175 "Compare the string values of categories of strings A and B."
21185 "Compare the time-of-day values of strings A and B."
21194 "Predicate for sorting agenda entries."
21195 ;; The following variables will be used when the form is evaluated.
21196 ;; So even though the compiler complains, keep them.
21210 ;;; Agenda restriction lock
21228 "Set restriction lock for agenda, to current subtree or file.
21229 Restriction will be the file if TYPE is `file', or if type is the
21230 universal prefix '(4), or if the cursor is before the first headline
21231 in the file. Otherwise, restriction will be to the current subtree."
21263 "Remove the agenda restriction lock."
21277 "If there is any window showing the agenda view, update it."
21286 org-agenda-overriding-restriction)
21289 ;;; Agenda commands
21292 "Check if agenda buffer is of allowed type.
21293 If ERROR is non-nil, throw an error, otherwise just return nil."
21295 t
21298 nil)))
21301 "Exit agenda by removing the window or the buffer."
21308 ;; Maybe restore the pre-agenda window configuration.
21311 org-pre-agenda-window-conf
21315 "Exit agenda by removing the window or the buffer.
21316 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
21317 Org-mode buffers visited directly by the user will not be touched."
21331 "Save all Org-mode buffers without user confirmation."
21338 "Rebuild Agenda.
21339 When this is the global TODO list, a prefix argument will be interpreted."
21348 org-agenda-pending-undo-list nil)
21354 "Jump to DATE in agenda."
21359 "Go to today."
21385 "Go forward in time by thee current span.
21386 With prefix ARG, go forward that many times the current span."
21393 greg2 nd)
21415 "Go backward in time by the current span.
21416 With prefix ARG, go backward that many times the current span."
21421 "Switch to daily view for agenda."
21426 "Switch to daily view for agenda."
21431 "Switch to daily view for agenda."
21435 "Switch to daily view for agenda."
21442 "Change the agenda view to SPAN.
21443 SPAN may be `day', `week', `month', `year'."
21448 org-starting-day))
21459 "Compute starting date and number of days for agenda.
21460 SPAN may be `day', `week', `month', `year'. The return value
21461 is a cons cell with the starting date and the number of days,
21462 so that the date SD will be in that range."
21464 nd)
21481 sd)))
21487 sd))))
21490 ;; FIXME: does not work if user makes date format that starts with a blank
21492 "Jump to the next line indicating a date in agenda buffer."
21504 "Jump to the previous line indicating a date in agenda buffer."
21511 ;; Initialize the highlight
21516 "Highlight a region with overlay."
21521 "Detach overlay INDEX."
21524 ;; FIXME this is currently not used.
21533 "Toggle follow mode in an agenda buffer."
21541 "Toggle log mode in an agenda buffer."
21551 "Toggle diary inclusion in an agenda buffer."
21561 "Toggle time grid in an agenda buffer."
21571 "Set the mode name to indicate all the small mode settings."
21590 "Show the priority of the current item.
21591 This priority is composed of the main priority given with the [#A] cookies,
21592 and by additional input from the age of a schedules or deadline entry."
21598 "Show the tags applicable to the current item."
21607 "Go to the Org-mode file which contains the item at point."
21625 "Normal hook run after an item has been shown from the agenda.
21629 "Kill the entry or subtree belonging to the current agenda entry."
21662 "Kill the entry or subtree belonging to the current agenda entry."
21680 "Remove all lines in the agenda that correspond to a given subtree.
21681 The subtree is the one in buffer BUF, starting at BEG and ending at END.
21682 If this information is not given, the function uses the tree at point."
21705 "Follow the link in the current line, if any."
21714 "Get a variable from a referenced buffer and install it here."
21721 "Go to the Org-mode file which contains the item at point."
21738 "Go to the Org-mode file which contains the item at the mouse click."
21744 "Display the Org-mode file which contains the item at point."
21751 "Display the Org-mode file which contains the item at point and recenter."
21759 "Display the Org-mode file which contains the item at the mouse click."
21765 "Check if the entry is a diary link and abort if yes."
21773 "Show the subtree corresponding to the current entry in an indirect buffer.
21774 This calls the command `org-tree-to-indirect-buffer' from the original
21775 Org-mode buffer.
21776 With numerical prefix arg ARG, go up to this level and then take that tree.
21777 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
21778 dedicated frame)."
21791 "Marker pointing to the headline that last changed its TODO state
21795 "Switch TODO entry to next sequence."
21800 "Switch TODO entry to previous sequence."
21805 "Cycle TODO state of line at point, also in Org-mode file.
21806 This changes the line at point, all other lines in the agenda referring to
21807 the same tree node, and the headline of the tree node in the Org-mode file."
21817 newhead)
21838 "Change all lines in the agenda buffer which match HDMARKER.
21839 The new content of the line will be NEWHEAD (as modified by
21840 `org-format-agenda-item'). HDMARKER is checked with
21841 `equal' against all `org-hd-marker' text properties in the file.
21842 If FIXFACE is non-nil, the face of each item is modified acording to
21843 the new TODO state."
21845 props m pl undone-face done-face finish new dotime cat tags)
21875 undone-face done-face))))
21883 "Align all tags in agenda items to `org-agenda-tags-column'."
21896 org-agenda-tags-column))
21904 "Increase the priority of line at point, also in Org-mode file."
21909 "Decrease the priority of line at point, also in Org-mode file."
21914 "Set the priority of line at point, also in Org-mode file.
21915 This changes the line at point, all other lines in the agenda referring to
21916 the same tree node, and the headline of the tree node in the Org-mode file."
21925 newhead)
21941 "Get a list of all headline tags applicable at POS.
21942 POS defaults to point. If tags are inherited, the list contains
21943 the targets in the same sequence as the headlines appear, i.e.
21944 the tags of the current headline come last."
21959 tags)))
21963 tags)))
21965 ;; FIXME: should fix the tags property of the agenda line.
21967 "Set tags for the current headline."
21978 newhead)
21996 "Toggle the archive tag for the current entry."
22005 newhead)
22021 "Change the date of this item to one day later."
22040 "Change the date of this item to one day earlier."
22045 "Show new date stamp via text properties."
22046 ;; We use text properties to make this undoable
22055 ;; Use `duplicable' property to trigger undo recording
22070 "Change the date of this item. Date is prompted for, with default today.
22071 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22072 be used to request time specification in the time stamp."
22090 "Schedule the item at point."
22099 ts)
22109 "Schedule the item at point."
22118 ts)
22128 "Return the heading of the current entry, without the stars."
22138 "Start the clock on the currently selected item."
22151 "Stop the currently running clock."
22159 "Cancel the currently running clock."
22167 "Make a diary entry, like the `i' command from the calendar.
22168 All the standard commands work: block, weekly etc."
22184 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
22193 ;; We implement this by hacking the `calendar-cursor-to-date' function
22194 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
22210 "Execute a calendar command from the agenda, with the date associated to
22211 the cursor position."
22220 ;; the following 3 vars are needed in the calendar
22234 "Display the phases of the moon for the 3 months around the cursor date."
22239 "Display the holidays for the 3 months around the cursor date."
22244 "Display sunrise and sunset for the cursor date.
22245 Latitude and longitude can be specified with the variables
22246 `calendar-latitude' and `calendar-longitude'. When called with prefix
22247 argument, latitude and longitude will be prompted for."
22256 "Open the Emacs calendar with the date at the cursor."
22269 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
22270 This is a command that has to be installed in `calendar-mode-map'."
22274 nil))
22280 date s)
22306 ;;;; Embedded LaTeX
22321 "Toggle the minor `org-cdlatex-mode'.
22322 This mode supports entering LaTeX environment and math in LaTeX fragments
22323 in Org-mode.
22325 nil " OCDL" nil
22330 "Always return t in org-mode buffers.
22331 This is because we want to insert math symbols without dollars even outside
22332 the LaTeX math segments. If Orgmode thinks that point is actually inside
22333 en embedded LaTeX fragement, let texmathp do its job.
22350 "Unconditionally turn on `org-cdlatex-mode'."
22354 "Test if point is inside a LaTeX fragment.
22356 sequence appearing also before point.
22357 Even though the matchers for math are configurable, this function assumes
22359 delimiters are skipped when they have been removed by customization.
22360 The return value is nil, or a cons cell with the delimiter and
22361 and the position of this delimiter.
22363 This function does a reasonably good job, but can locally be fooled by
22364 for example currency specifications. For example it will assume being in
22366 fragments that are properly closed, but during editing, we have to live
22367 with the uncertainty caused by missing closing delimiters. This function
22368 looks only before point, not after."
22387 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
22391 ;; count $$
22399 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
22400 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
22401 - inside a LaTeX fragment, or
22402 - after the first word in a line, where an abbreviation expansion could
22403 insert a LaTeX environment."
22416 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
22417 Revert to the normal definition outside of these fragments."
22425 "Execute `cdlatex-math-modify' in LaTeX fragments.
22426 Revert to the normal definition outside of these fragments."
22438 "Remove all overlays with LaTeX fragment images in current buffer."
22443 "Preview the LaTeX fragment at point, or all locally or globally.
22444 If the cursor is in a LaTeX fragment, create the image and overlay
22445 it over the source code. If there is no fragment at point, display
22446 all fragments in the current text, from one headline to the next. With
22447 prefix SUBTREE, display all fragments in the current subtree. With a
22448 double prefix `C-u C-u', or when the cursor is before the first headline,
22449 display all fragments in the buffer.
22479 buffer-file-name)))
22485 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
22486 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
22487 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
22494 "Replace LaTeX fragments with links to an image, and produce images."
22503 m n block linkfile movefile ov)
22504 ;; Check if there are old images files with this prefix, and remove them
22508 todir 'full
22510 ;; Check the different regular expressions
22530 txt movefile opt forbuffer)
22538 ov 'end-glyph
22541 ov 'display
22548 ;; This function borrows from Ganesh Swami's latex2png.el
22552 temporary-file-directory))
22581 "-D" dpi
22582 ;;"-x" scale "-y" scale
22584 "-o" pngfile
22585 dvifile)
22588 ;; Use the requested file name and clean up
22592 pngfile))))
22595 "Return an rgb color specification for dvipng."
22601 "Return string to be used as color value for an RGB component."
22604 ;;;; Exporting
22606 ;;; Variables, constants, and parameter plists
22662 "Return the property list with default settings for the export variables."
22666 rtn))
22669 "Return the property list with file-local settings for export."
22674 p key val text options)
22707 o)
22711 options)
22715 p)))
22721 val)))
22722 dir))
22729 rtn line level)
22734 ;; Beginning of a COMMENT subtree. Skip it.
22740 ;; an ordinary comment line
22741 )
22747 ;; a special table line that should be removed
22748 )
22755 \[v] limit export to visible part of outline tree
22757 \[a] export as ASCII
22759 \[h] export as HTML
22760 \[H] export as HTML to temporary buffer
22761 \[R] export region as HTML
22762 \[b] export as HTML and browse immediately
22763 \[x] export as XOXO
22765 \[l] export as LaTeX
22766 \[L] export as LaTeX to temporary buffer
22768 \[i] export current file as iCalendar file
22769 \[I] export all agenda files as iCalendar files
22770 \[c] export agenda files into combined iCalendar file
22772 \[F] publish current file
22773 \[P] publish current project
22774 \[X] publish... (project will be prompted for)
22794 r1 r2 ass)
23097 )
23098 "Entities for TeX->HTML translation.
23102 The list contains HTML entities for Latin-1, Greek and other symbols.
23103 It is supplemented by a number of commonly used TeX macros with appropriate
23106 ;;; General functions for all backends
23109 "Cleanup a buffer STRING so that links can be created safely."
23127 a b xx
23128 rtn p)
23132 ;; Remove license-to-kill stuff
23140 ;; Get the correct stuff before the first headline
23151 ;; Get rid of archived trees
23163 ;; Get rid of drawers
23168 'identity
23176 ;; Find targets in comments and move them out of comments,
23177 ;; but mark them as targets that should be invisible
23182 ;; Protect backend specific stuff, throw away the others.
23187 fmt)
23218 ;; Protect quoted subtrees
23226 ;; Protect verbatim elements
23233 ;; Remove subtrees that are commented
23239 ;; Remove special table lines
23251 ;; Specific LaTeX stuff
23259 ;; Specific HTML stuff
23261 ;; Convert LaTeX fragments to images
23266 org-current-export-file)))
23270 ;; Remove or replace comments
23279 ;; Find matches for radio targets and turn them into internal links
23286 ;; Find all links that contain a newline and put them into a single line
23288 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
23294 ;; Normalize links: Convert angle and plain links into bracket links
23295 ;; Expand link abbreviations
23302 ;; added 'org-link face to links
23318 "]"
23326 ;; Find multiline emphasis and put them into single line
23340 rtn))
23343 "Get a title for the current document, from looking at the buffer."
23349 ;; Mark the line so that it will not be exported as normal text.
23353 ;; Return the title string
23357 "Return subtree title and exclude it from export."
23363 ;; This is a subtree, we take the title from the first heading
23370 title))
23373 "Take link text and make a safe target out of it."
23377 'identity
23383 "Get the minimum level in LINES."
23391 ;; Variable holding the vector with section numbers
23395 "Initialize the vector for the section numbers."
23412 "Return a string with the current section number.
23413 When LEVEL is non-nil, increase section numbers on that level."
23435 string))
23437 ;;; ASCII export
23445 "Export the outline as a pretty ASCII file.
23446 If there is an active region, export only the region.
23447 The prefix ARG specifies how many levels of the outline should become
23448 underlined headlines. The default is 3."
23477 filename))
23493 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
23502 region
23503 :for-ascii t
23504 :skip-before-1st-heading
23507 :verbatim-multiline t
23508 :archived-trees
23512 thetoc have-headings first-heading-pos
23513 table-open table-buffer)
23531 ;; create local variables for all options, to make sure all called
23532 ;; functions get the correct information
23536 org-export-plist-vars)
23539 org-export-headline-levels))
23542 umax))
23544 ;; File header
23548 org-export-author-info)
23570 line)
23571 ;; This is a headline
23577 todo
23581 org-done-keywords)))
23582 ; TODO, not DONE
23586 line lines level))))
23593 t t txt)))
23598 txt))
23613 thetoc)
23615 ))))
23616 lines)
23621 ;; Remove the quoted HTML tags.
23623 ;; Remove targets
23626 ;; Replace internal links
23630 t nil line)))
23635 ;; a Headline
23644 ;; New table starts
23646 ;; Accumulate lines
23667 ;; insert the table of contents
23679 ;; Convert whitespace place holders
23689 ;; remove display and invisible chars
23705 "Do extra work for ASCII export"
23715 "Search the subtree below LINE for any TODO entries."
23718 line lv todo)
23726 org-done-keywords))))
23727 ; TODO, not DONE
23732 "Handle quoted HTML for ASCII export."
23735 ;; We just remove the tags for now.
23737 line)
23740 "Insert the string S centered and underline it with character UNDERLINE."
23749 "Insert a new level in ASCII export."
23755 org-export-ascii-bullets))
23757 ;; find the indentation of the next non-empty line
23778 "Create a copy of the visible part of the current buffer, and export it.
23779 The copy is created in a temporary buffer and removed after use.
23780 TYPE is the final key (as a string) that also select the export command in
23781 the `C-c C-e' export dispatcher.
23782 As a special case, if the you type SPC at the prompt, the temporary
23783 org-mode file will not be removed but presented to you so that you can
23784 continue to use it. The prefix arg ARG is passed through to the exporting
23785 command."
23788 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
23790 current-prefix-arg))
23805 s e)
23806 ;; Need to hack the drawers here.
23822 ;; Copy all comment lines to the end, to make sure #+ settings are
23823 ;; still available for the second export step. Kind of a hack, but
23824 ;; does do the trick.
23845 s))
23850 s))
23852 ;;; HTML export
23855 "Return a string with current options as keyword options.
23856 Does include HTML export options as well as TODO and CATEGORY stuff."
23858 "#+TITLE: %s
23859 #+AUTHOR: %s
23860 #+EMAIL: %s
23861 #+LANGUAGE: %s
23862 #+TEXT: Some descriptive text to be emitted. Several lines OK.
23863 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s TeX:%s LaTeX:%s skip:%s d:%s tags:%s
23864 #+CATEGORY: %s
23865 #+SEQ_TODO: %s
23866 #+TYP_TODO: %s
23867 #+PRIORITIES: %c %c %c
23868 #+DRAWERS: %s
23869 #+STARTUP: %s %s %s %s %s
23870 #+TAGS: %s
23871 #+ARCHIVE: %s
23872 #+LINK: %s
23873 "
23875 org-export-headline-levels
23876 org-export-with-section-numbers
23877 org-export-with-toc
23878 org-export-preserve-breaks
23879 org-export-html-expand
23880 org-export-with-fixed-width
23881 org-export-with-tables
23882 org-export-with-sub-superscripts
23883 org-export-with-special-strings
23884 org-export-with-footnotes
23885 org-export-with-emphasize
23886 org-export-with-TeX-macros
23887 org-export-with-LaTeX-fragments
23888 org-export-skip-text-before-1st-heading
23889 org-export-with-drawers
23890 org-export-with-tags
23892 "TODO FEEDBACK VERIFY DONE"
23893 "Me Jason Marie DONE"
23894 org-highest-priority org-lowest-priority org-default-priority
23913 org-archive-location
23914 "org file:~/org/%s.org"
23915 ))
23918 "Insert into the buffer a template with information for exporting."
23927 "Toggle the fixed-width export.
23928 If there is no active region, the QUOTE keyword at the current headline is
23929 inserted or removed. When present, it causes the text between this headline
23930 and the next to be exported as fixed-width text, and unmodified.
23931 If there is an active region, this command adds or removes a colon as the
23932 first character of this line. If the first character of a line is a colon,
23933 this line is also exported in fixed-width font."
23942 off)
23972 "Export the outline as HTML and immediately open it with a browser.
23973 If there is an active region, export only the region.
23974 The prefix ARG specifies how many levels of the outline should become
23975 headlines. The default is 3. Lower levels will become bulleted lists."
23981 "Call `org-export-as-html', may be used in batch processing as
23982 emacs --batch
23983 --load=$HOME/lib/emacs/org.el
23985 --visit=MyFile --funcall org-export-as-html-batch"
23989 "Call `org-exort-as-html` with output to a temporary buffer.
23990 No file is created. The prefix ARG is passed through to `org-export-as-html'."
23996 "Assume the current region has org-mode syntax, and convert it to HTML.
23997 This can be used in any buffer. For example, you could write an
23998 itemized list in org-mode syntax in an HTML buffer and then use this
23999 command to convert it."
24019 "Convert region from BEG to END in org-mode buffer to HTML.
24020 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24021 contents, and only produce the region of converted text, useful for
24022 cut-and-paste operations.
24023 If BUFFER is a buffer or a string, use/create that buffer as a target
24024 of the converted HTML. If BUFFER is the symbol `string', return the
24025 produced HTML as a string and leave not buffer behind. For example,
24026 a Lisp program could call this function in the following way:
24028 (setq html (org-export-region-as-html beg end t 'string))
24030 When called interactively, the output buffer is selected, and shown
24031 in a window. A non-interactive call will only retunr the buffer."
24036 rtn)
24041 nil nil nil
24042 buffer body-only))
24046 rtn)))
24050 to-buffer body-only)
24051 "Export the outline as a pretty HTML file.
24052 If there is an active region, export only the region. The prefix
24053 ARG specifies how many levels of the outline should become
24054 headlines. The default is 3. Lower levels will become bulleted
24055 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24056 EXT-PLIST is a property list with external parameters overriding
24057 org-mode's default settings, but still inferior to file-local
24058 settings. When TO-BUFFER is non-nil, create a buffer with that
24059 name and export to that buffer. If TO-BUFFER is the symbol `string',
24060 don't leave any buffer behind but just return the resulting HTML as
24061 a string. When BODY-ONLY is set, don't produce the file header and footer,
24062 simply return the content of <body>...</body>, without even
24063 the body tags themselves."
24066 ;; Make sure we have a file name when we need it.
24072 buffer-file-name))
24081 ext-plist
24086 valid thetoc have-headings first-heading-pos
24095 ;; The following two are dynamically scoped into other
24096 ;; routines below.
24113 default-directory))
24147 buffer-file-coding-system))
24149 coding-system))
24151 coding-system))
24163 region
24164 :emph-multiline t
24165 :for-html t
24166 :skip-before-1st-heading
24169 :archived-trees
24171 :add-text
24173 :LaTeX-fragments
24176 table-open type
24177 table-buffer table-orig-buffer
24178 ind start-is-num starter didclose
24179 rpl path desc descp desc1 desc2 link
24180 )
24199 ;; Get the language-dependent settings
24203 ;; Switch to the output buffer
24213 ;; create local variables for all options, to make sure all called
24214 ;; functions get the correct information
24218 org-export-plist-vars)
24220 org-export-headline-levels))
24223 umax))
24225 ;; File header
24231 <head>
24232 <title>%s</title>
24237 %s
24238 </head><body>
24239 "
24252 org-export-html-toplevel-hlevel
24254 org-export-html-toplevel-hlevel)
24255 thetoc)
24260 ;; This is a headline
24269 todo
24273 org-done-keywords)))
24274 ; TODO, not DONE
24278 line lines level))))
24303 ;; Check for targets
24308 t t line))
24311 target-alist))
24322 )))
24323 line)
24324 lines))
24336 ;; end of quote section?
24340 ;; inside a quote section?
24345 ;; verbatim lines
24359 ;; Protected HTML
24373 ;; Horizontal line
24378 ;; make targets to anchors
24386 t t line)))
24390 ; (concat "@<i>" (match-string 1 line) "@</i> ")
24391 t t line)))
24397 t t line)))))
24401 ;; replace "&" by "&", "<" and ">" by "<" and ">"
24402 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
24403 ;; Also handle sub_superscripts and checkboxes
24407 ;; Format the links
24417 ;; Make an image out of the description if that is so wanted
24423 ;; FIXME: do we need to unescape here somewhere?
24433 ;; standard URL, just check if we need to inline an image
24441 ;; standard URL
24445 ;; FILE link
24448 thefile file-is-image-p search)
24456 t))
24465 ;; make sure this is can be used as target search
24490 ;; TODO items
24498 org-done-keywords)
24503 ;; Does this contain a reference to a footnote?
24515 t t line))))))
24519 ;; This is a headline
24527 ;; Close any local lists before inserting a new header line
24533 in-local-list nil))
24537 head-count)
24538 ;; QUOTES
24546 ;; New table starts
24548 ;; Accumulate lines
24560 ;; Normal lines
24563 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
24564 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
24567 line)
24574 ;; empty line. Pretend indentation is large.
24576 0
24592 ;; Start new (level of) list
24599 ;; continue current list
24603 ;; we did close a list, normal text follows: need <p>
24609 "<b>[X]</b>"
24611 t t line))))
24613 ;; Empty lines start a new paragraph. If hand-formatted lists
24614 ;; are not fully interpreted, lines starting with "-", "+", "*"
24615 ;; also start a new paragraph.
24618 ;; Is this the start of a footnote?
24624 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
24626 ;; Check if the line break needs to be conserved
24635 ;; Properly close all local lists and other lists
24638 ;; Close any local lists before inserting a new header line
24644 in-local-list nil))
24647 head-count)
24678 ;; insert the table of contents
24695 ;; remove empty paragraphs and lists
24702 ;; Convert whitespace place holders
24723 "Format a table for ascii export."
24727 ;; Table made by table.el - test for spanning
24728 lines
24730 ;; A normal org table
24731 ;; Get rid of hlines at beginning and end
24737 ;; Check if the table has a marking column. If yes remove the
24738 ;; column and the special lines
24740 ;; Get rid of the vertical lines except for grouping
24742 rtn line vl1 start)
24764 vl))
24767 "Find out which HTML converter to use and return the HTML code."
24771 ;; A normal org table
24773 ;; Table made by table.el - test for spanning
24777 nil))
24778 lines)))
24784 hlines))))
24787 ;; We can use my own converter with HTML conversions
24789 ;; Need to use the code generator in table.el, with the original text.
24793 "Format a table into HTML."
24794 ;; Get rid of hlines at beginning and end
24800 ;; Check if the table has a marking column. If yes remove the
24801 ;; column and the special lines
24809 tbopen line fields html gr colgropen)
24821 ;; ignore this line
24823 ;; Break the line into fields
24841 html)))
24846 ;; Put in col tags with the alignment (unfortuntely often ignored...)
24862 html)
24868 "Check if the table has a marking column.
24869 If yes remove the column and the special lines."
24875 lines))
24890 nil)
24892 lines)))
24906 nil)
24911 ;; remove the first column
24913 lines))))
24916 "Format a table generated by table.el into HTML.
24917 This conversion does *not* use `table-generate-source' from table.el.
24918 This has the advantage that Org-mode's HTML conversions can be used.
24919 But it has the disadvantage, that no cell- or row-spanning is allowed."
24922 fields html empty)
24932 html
24934 html
24935 "<tr>"
24948 ;; Ignore this line
24950 ;; Break the line into fields and store the fields
24956 field-buffer))
24959 html))
24962 "Format a table into html, using `table-generate-source' from table.el.
24963 This has the advantage that cell- or row-spanning is allowed.
24964 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
24979 "Format time stamps in string S, or remove them."
24984 ;; never export CLOCK
24999 ;; Line break if line started and ended with time stamp stuff
25001 s
25005 r))))
25008 ;; convert & to &, < to < and > to >
25017 s)
25020 "Remove tags and time staps from lines going into the toc."
25029 t t s)))
25030 s)
25033 "Prepare STRING for HTML export. Applies all active conversions.
25034 If there are links in the string, don't modify these."
25037 m s l res)
25048 "Apply all active conversions to translate special ASCII to HTML."
25069 t t s))
25071 s)
25074 "Create a regular expression which will match a balanced sexp.
25075 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25076 as single character strings.
25077 The regexp returned will match the entire expression including the
25078 delimiters. It will also define a single group which contains the
25079 match except for the outermost delimiters. The maximum depth of
25080 stacked delimiters is N. Escaping delimiters is not possible."
25116 "Convert special characters in STRING to HTML."
25118 e a re rpl start)
25125 string))
25128 "Convert sub- and superscripts in STRING to HTML."
25144 t t string)))))
25147 string))
25150 "Apply emphasis."
25157 rpl
25163 org-emphasis-alist))
25168 string))
25172 "Insert <p>, but first close previous paragraph if any."
25177 "Close paragraph if there is one open."
25182 "Close <li> if necessary."
25188 "Insert a new level in HTML export.
25189 When TITLE is nil, just close all open levels."
25199 ;; If title is nil, this means this function is called to close
25200 ;; all levels, so the rest is done only if title is given
25212 t t title)))
25228 level level head-count title level))
25233 "Terminate one level in HTML export."
25239 ;;; iCalendar export
25241 ;;;###autoload
25243 "Export current file as an iCalendar file.
25244 The iCalendar file will be located in the same directory as the Org-mode
25245 file, but with extension `.ics'."
25249 ;;;###autoload
25251 "Export all files in `org-agenda-files' to iCalendar .ics files.
25252 Each iCalendar file will be located in the same directory as the Org-mode
25253 file, but with extension `.ics'."
25257 ;;;###autoload
25259 "Export all files in `org-agenda-files' to a single combined iCalendar file.
25260 The file is stored under the name `org-combined-agenda-icalendar-file'."
25265 "Create iCalendar files for all elements of FILES.
25266 If COMBINE is non-nil, combine all calendar entries into a single large
25267 file and store it under the name `org-combined-agenda-icalendar-file'."
25272 org-export-publishing-directory)))
25273 file ical-file ical-buffer category started org-agenda-new-buffers)
25279 org-combined-agenda-icalendar-file
25312 "Hook run after an iCalendar file has been saved.
25313 The iCalendar buffer is still current when this hook is run.
25314 A good way to use this is to tell a desktop calenndar application to re-read
25318 "Print iCalendar entries for the current Org-mode file to `standard-output'.
25319 When COMBINE is non nil, add the category to each line."
25326 scheduledp deadlinep tmp pri category entry location summary desc
25336 inc t
25343 t org-icalendar-include-body)
25353 pos)
25358 ts)
25361 ;; donep (org-entry-is-done-p)
25362 ))
25381 t t summary)))
25388 %s
25389 %s%s
25390 SUMMARY:%s%s%s
25391 CATEGORIES:%s
25395 rrule summary
25400 category)))))
25405 ;; Get all the literal sexps
25431 )
25438 t org-icalendar-include-body)
25444 t t hd)))
25454 %s
25455 SUMMARY:%s%s%s
25456 CATEGORIES:%s
25457 SEQUENCE:1
25458 PRIORITY:%d
25459 STATUS:%s
25461 dts
25467 category pri status)))))))))
25470 "Take out stuff and quote what needs to be quoted.
25471 When IS-BODY is non-nil, assume that this is the body of an item, clean up
25472 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
25473 characters."
25475 nil
25494 s))
25497 "Clean-up description string."
25503 "Start an iCalendar file by inserting the header."
25509 VERSION:2.0
25510 X-WR-CALNAME:%s
25511 PRODID:-//%s//Emacs with Org-mode//EN
25512 X-WR-TIMEZONE:%s
25516 "Finish an iCalendar file by inserting the END statement."
25520 "Take a time string S and convert it to iCalendar format.
25521 KEYWORD is added in front, to make a complete line like DTSTART....
25522 When INC is non-nil, increase the hour by two (if time string contains
25523 a time), or the day by one (if it does not contain a time)."
25525 t2 fmt have-time time)
25541 ;;; XOXO export
25549 "Export the org buffer as XOXO.
25550 The XOXO buffer is named *xoxo-<source buffer name>*"
25552 ;; A quickie abstraction
25554 ;; Output everything as XOXO
25567 ;; Check the output buffer is empty.
25569 ;; Kick off the output
25586 ;; Handle level rendering
25603 )
25607 ;; And output the new li
25613 ;; Finally finish off the ol
25619 ;; Finish the buffer off and clean it up.
25624 )))
25627 ;;;; Key bindings
25629 ;; Make `C-c C-x' a prefix key
25632 ;; TAB key with modifiers
25639 ;; The following line is necessary under Suse GNU/Linux
25645 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
25646 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
25647 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
25649 ;; Cursor keys with modifiers
25650 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
25651 (org-defkey org-mode-map [(meta right)] 'org-metaright)
25652 (org-defkey org-mode-map [(meta up)] 'org-metaup)
25653 (org-defkey org-mode-map [(meta down)] 'org-metadown)
25655 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
25656 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
25657 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
25658 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
25660 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
25661 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
25662 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
25663 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
25665 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
25666 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
25668 ;;; Extra keys for tty access.
25669 ;; We only set them when really needed because otherwise the
25670 ;; menus don't show the simple keys
25672 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
25673 (not window-system))
25674 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
25675 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
25676 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
25677 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
25678 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
25679 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
25680 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
25681 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
25682 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
25683 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
25684 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
25685 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
25686 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
25687 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
25688 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
25689 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
25690 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
25691 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
25692 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
25693 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
25694 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
25695 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
25697 ;; All the other keys
25699 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
25700 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
25701 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
25702 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
25703 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
25704 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
25705 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
25706 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
25707 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
25708 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
25709 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
25710 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
25711 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
25712 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
25713 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
25715 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
25716 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
25717 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
25718 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
25719 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
25720 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
25721 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
25722 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
25723 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
25724 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
25725 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
25726 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
25727 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
25728 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
25729 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
25730 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
25731 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
25733 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
25734 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
25735 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
25736 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25737 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
25738 (org-defkey org-mode-map "\C-c^" 'org-sort)
25739 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
25740 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
25741 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
25742 (org-defkey org-mode-map "\C-m" 'org-return)
25743 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
25744 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
25745 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
25746 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
25747 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
25748 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
25749 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
25750 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
25751 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
25752 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
25753 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
25754 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
25755 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
25756 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
25757 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
25758 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
25760 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
25761 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
25762 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
25763 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
25765 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
25766 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
25767 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
25768 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
25769 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
25770 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
25771 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
25772 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
25773 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
25774 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
25775 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
25776 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
25778 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
25780 (when (featurep 'xemacs)
25781 (org-defkey org-mode-map 'button3 'popup-mode-menu))
25783 (defsubst org-table-p () (org-at-table-p))
25785 (defun org-self-insert-command (N)
25786 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
25787 If the cursor is in a table looking at whitespace, the whitespace is
25788 overwritten, and the table is not marked as requiring realignment."
25789 (interactive "p")
25790 (if (and (org-table-p)
25791 (progn
25792 ;; check if we blank the field, and if that triggers align
25793 (and org-table-auto-blank-field
25794 (member last-command
25795 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
25797 ;; got extra space, this field does not determine column width
25798 (let (org-table-may-need-update) (org-table-blank-field))
25799 ;; no extra space, this field may determine column width
25800 (org-table-blank-field)))
25801 t)
25802 (eq N 1)
25804 (let (org-table-may-need-update)
25805 (goto-char (1- (match-end 0)))
25806 (delete-backward-char 1)
25807 (goto-char (match-beginning 0))
25808 (self-insert-command N))
25809 (setq org-table-may-need-update t)
25810 (self-insert-command N)
25811 (org-fix-tags-on-the-fly)))
25813 (defun org-fix-tags-on-the-fly ()
25814 (when (and (equal (char-after (point-at-bol)) ?*)
25815 (org-on-heading-p))
25816 (org-align-tags-here org-tags-column)))
25818 (defun org-delete-backward-char (N)
25819 "Like `delete-backward-char', insert whitespace at field end in tables.
25820 When deleting backwards, in tables this function will insert whitespace in
25822 still be marked for re-alignment if the field did fill the entire column,
25823 because, in this case the deletion might narrow the column."
25824 (interactive "p")
25825 (if (and (org-table-p)
25826 (eq N 1)
25827 (string-match "|" (buffer-substring (point-at-bol) (point)))
25828 (looking-at ".*?|"))
25829 (let ((pos (point))
25831 (c org-table-may-need-update))
25832 (backward-delete-char N)
25833 (skip-chars-forward "^|")
25834 (insert " ")
25835 (goto-char (1- pos))
25836 ;; noalign: if there were two spaces at the end, this field
25837 ;; does not determine the width of the column.
25838 (if noalign (setq org-table-may-need-update c)))
25839 (backward-delete-char N)
25840 (org-fix-tags-on-the-fly)))
25842 (defun org-delete-char (N)
25843 "Like `delete-char', but insert whitespace at field end in tables.
25844 When deleting characters, in tables this function will insert whitespace in
25846 still be marked for re-alignment if the field did fill the entire column,
25847 because, in this case the deletion might narrow the column."
25848 (interactive "p")
25849 (if (and (org-table-p)
25850 (not (bolp))
25851 (not (= (char-after) ?|))
25852 (eq N 1))
25853 (if (looking-at ".*?|")
25854 (let ((pos (point))
25856 (c org-table-may-need-update))
25857 (replace-match (concat
25858 (substring (match-string 0) 1 -1)
25859 " |"))
25860 (goto-char pos)
25861 ;; noalign: if there were two spaces at the end, this field
25862 ;; does not determine the width of the column.
25863 (if noalign (setq org-table-may-need-update c)))
25864 (delete-char N))
25865 (delete-char N)
25866 (org-fix-tags-on-the-fly)))
25868 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
25869 (put 'org-self-insert-command 'delete-selection t)
25870 (put 'orgtbl-self-insert-command 'delete-selection t)
25871 (put 'org-delete-char 'delete-selection 'supersede)
25872 (put 'org-delete-backward-char 'delete-selection 'supersede)
25874 ;; Make `flyspell-mode' delay after some commands
25875 (put 'org-self-insert-command 'flyspell-delayed t)
25876 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
25877 (put 'org-delete-char 'flyspell-delayed t)
25878 (put 'org-delete-backward-char 'flyspell-delayed t)
25880 ;; Make pabbrev-mode expand after org-mode commands
25881 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
25882 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
25884 ;; How to do this: Measure non-white length of current string
25885 ;; If equal to column width, we should realign.
25887 (defun org-remap (map &rest commands)
25888 "In MAP, remap the functions given in COMMANDS.
25889 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
25890 (let (new old)
25891 (while commands
25892 (setq old (pop commands) new (pop commands))
25893 (if (fboundp 'command-remapping)
25894 (org-defkey map (vector 'remap old) new)
25895 (substitute-key-definition old new map global-map)))))
25897 (when (eq org-enable-table-editor 'optimized)
25898 ;; If the user wants maximum table support, we need to hijack
25899 ;; some standard editing functions
25900 (org-remap org-mode-map
25901 'self-insert-command 'org-self-insert-command
25902 'delete-char 'org-delete-char
25903 'delete-backward-char 'org-delete-backward-char)
25904 (org-defkey org-mode-map "|" 'org-force-self-insert))
25906 (defun org-shiftcursor-error ()
25907 "Throw an error because Shift-Cursor command was applied in wrong context."
25908 (error "This command is active in special context like tables, headlines or timestamps"))
25910 (defun org-shifttab (&optional arg)
25911 "Global visibility cycling or move to previous table field.
25912 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
25913 on context.
25914 See the individual commands for more information."
25915 (interactive "P")
25916 (cond
25917 ((org-at-table-p) (call-interactively 'org-table-previous-field))
25918 (arg (message "Content view to level: ")
25919 (org-content (prefix-numeric-value arg))
25920 (setq org-cycle-global-status 'overview))
25921 (t (call-interactively 'org-global-cycle))))
25923 (defun org-shiftmetaleft ()
25924 "Promote subtree or delete table column.
25925 Calls `org-promote-subtree', `org-outdent-item',
25926 or `org-table-delete-column', depending on context.
25927 See the individual commands for more information."
25928 (interactive)
25929 (cond
25930 ((org-at-table-p) (call-interactively 'org-table-delete-column))
25931 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
25932 ((org-at-item-p) (call-interactively 'org-outdent-item))
25933 (t (org-shiftcursor-error))))
25935 (defun org-shiftmetaright ()
25936 "Demote subtree or insert table column.
25937 Calls `org-demote-subtree', `org-indent-item',
25938 or `org-table-insert-column', depending on context.
25939 See the individual commands for more information."
25940 (interactive)
25941 (cond
25942 ((org-at-table-p) (call-interactively 'org-table-insert-column))
25943 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
25944 ((org-at-item-p) (call-interactively 'org-indent-item))
25945 (t (org-shiftcursor-error))))
25947 (defun org-shiftmetaup (&optional arg)
25948 "Move subtree up or kill table row.
25949 Calls `org-move-subtree-up' or `org-table-kill-row' or
25950 `org-move-item-up' depending on context. See the individual commands
25951 for more information."
25952 (interactive "P")
25953 (cond
25954 ((org-at-table-p) (call-interactively 'org-table-kill-row))
25955 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
25956 ((org-at-item-p) (call-interactively 'org-move-item-up))
25957 (t (org-shiftcursor-error))))
25958 (defun org-shiftmetadown (&optional arg)
25959 "Move subtree down or insert table row.
25960 Calls `org-move-subtree-down' or `org-table-insert-row' or
25961 `org-move-item-down', depending on context. See the individual
25962 commands for more information."
25963 (interactive "P")
25964 (cond
25965 ((org-at-table-p) (call-interactively 'org-table-insert-row))
25966 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
25967 ((org-at-item-p) (call-interactively 'org-move-item-down))
25968 (t (org-shiftcursor-error))))
25970 (defun org-metaleft (&optional arg)
25971 "Promote heading or move table column to left.
25972 Calls `org-do-promote' or `org-table-move-column', depending on context.
25973 With no specific context, calls the Emacs default `backward-word'.
25974 See the individual commands for more information."
25975 (interactive "P")
25976 (cond
25977 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
25978 ((or (org-on-heading-p) (org-region-active-p))
25979 (call-interactively 'org-do-promote))
25980 ((org-at-item-p) (call-interactively 'org-outdent-item))
25981 (t (call-interactively 'backward-word))))
25983 (defun org-metaright (&optional arg)
25984 "Demote subtree or move table column to right.
25985 Calls `org-do-demote' or `org-table-move-column', depending on context.
25986 With no specific context, calls the Emacs default `forward-word'.
25987 See the individual commands for more information."
25988 (interactive "P")
25989 (cond
25990 ((org-at-table-p) (call-interactively 'org-table-move-column))
25991 ((or (org-on-heading-p) (org-region-active-p))
25992 (call-interactively 'org-do-demote))
25993 ((org-at-item-p) (call-interactively 'org-indent-item))
25994 (t (call-interactively 'forward-word))))
25996 (defun org-metaup (&optional arg)
25997 "Move subtree up or move table row up.
25998 Calls `org-move-subtree-up' or `org-table-move-row' or
25999 `org-move-item-up', depending on context. See the individual commands
26000 for more information."
26001 (interactive "P")
26002 (cond
26003 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26004 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26005 ((org-at-item-p) (call-interactively 'org-move-item-up))
26006 (t (transpose-lines 1) (beginning-of-line -1))))
26008 (defun org-metadown (&optional arg)
26009 "Move subtree down or move table row down.
26010 Calls `org-move-subtree-down' or `org-table-move-row' or
26011 `org-move-item-down', depending on context. See the individual
26012 commands for more information."
26013 (interactive "P")
26014 (cond
26015 ((org-at-table-p) (call-interactively 'org-table-move-row))
26016 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26017 ((org-at-item-p) (call-interactively 'org-move-item-down))
26018 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26020 (defun org-shiftup (&optional arg)
26021 "Increase item in timestamp or increase priority of current headline.
26022 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26023 depending on context. See the individual commands for more information."
26024 (interactive "P")
26025 (cond
26026 ((org-at-timestamp-p t)
26027 (call-interactively (if org-edit-timestamp-down-means-later
26028 'org-timestamp-down 'org-timestamp-up)))
26029 ((org-on-heading-p) (call-interactively 'org-priority-up))
26030 ((org-at-item-p) (call-interactively 'org-previous-item))
26031 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26033 (defun org-shiftdown (&optional arg)
26034 "Decrease item in timestamp or decrease priority of current headline.
26035 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26036 depending on context. See the individual commands for more information."
26037 (interactive "P")
26038 (cond
26039 ((org-at-timestamp-p t)
26040 (call-interactively (if org-edit-timestamp-down-means-later
26041 'org-timestamp-up 'org-timestamp-down)))
26042 ((org-on-heading-p) (call-interactively 'org-priority-down))
26043 (t (call-interactively 'org-next-item))))
26045 (defun org-shiftright ()
26046 "Next TODO keyword or timestamp one day later, depending on context."
26047 (interactive)
26048 (cond
26049 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26050 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26051 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26052 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26053 (t (org-shiftcursor-error))))
26055 (defun org-shiftleft ()
26056 "Previous TODO keyword or timestamp one day earlier, depending on context."
26057 (interactive)
26058 (cond
26059 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26060 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26061 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26062 ((org-at-property-p)
26063 (call-interactively 'org-property-previous-allowed-value))
26064 (t (org-shiftcursor-error))))
26066 (defun org-shiftcontrolright ()
26067 "Switch to next TODO set."
26068 (interactive)
26069 (cond
26070 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26071 (t (org-shiftcursor-error))))
26073 (defun org-shiftcontrolleft ()
26074 "Switch to previous TODO set."
26075 (interactive)
26076 (cond
26077 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26078 (t (org-shiftcursor-error))))
26080 (defun org-ctrl-c-ret ()
26081 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26082 (interactive)
26083 (cond
26084 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26085 (t (call-interactively 'org-insert-heading))))
26087 (defun org-copy-special ()
26088 "Copy region in table or copy current subtree.
26089 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26090 See the individual commands for more information."
26091 (interactive)
26092 (call-interactively
26093 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26095 (defun org-cut-special ()
26096 "Cut region in table or cut current subtree.
26097 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26098 See the individual commands for more information."
26099 (interactive)
26100 (call-interactively
26101 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26103 (defun org-paste-special (arg)
26104 "Paste rectangular region into table, or past subtree relative to level.
26105 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26106 See the individual commands for more information."
26107 (interactive "P")
26108 (if (org-at-table-p)
26109 (org-table-paste-rectangle)
26110 (org-paste-subtree arg)))
26112 (defun org-ctrl-c-ctrl-c (&optional arg)
26113 "Set tags in headline, or update according to changed information at point.
26115 This command does many different things, depending on context:
26117 - If the cursor is in a headline, prompt for tags and insert them
26118 into the current line, aligned to `org-tags-column'. When called
26119 with prefix arg, realign all tags in the current buffer.
26121 - If the cursor is in one of the special #+KEYWORD lines, this
26122 triggers scanning the buffer for these lines and updating the
26123 information.
26125 - If the cursor is inside a table, realign the table. This command
26126 works even if the automatic table editor has been turned off.
26128 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26129 the entire table.
26131 - If the cursor is a the beginning of a dynamic block, update it.
26133 - If the cursor is inside a table created by the table.el package,
26134 activate that table.
26136 - If the current buffer is a remember buffer, close note and file it.
26137 with a prefix argument, file it without further interaction to the default
26138 location.
26140 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26141 links in this buffer.
26143 - If the cursor is on a numbered item in a plain list, renumber the
26144 ordered list.
26146 - If the cursor is on a checkbox, toggle it."
26147 (interactive "P")
26148 (let ((org-enable-table-editor t))
26149 (cond
26150 ((or org-clock-overlays
26151 org-occur-highlights
26152 org-latex-fragment-image-overlays)
26153 (org-remove-clock-overlays)
26154 (org-remove-occur-highlights)
26155 (org-remove-latex-fragment-image-overlays)
26156 (message "Temporary highlights/overlays removed from current buffer"))
26157 ((and (local-variable-p 'org-finish-function (current-buffer))
26158 (fboundp org-finish-function))
26159 (funcall org-finish-function))
26160 ((org-at-property-p)
26161 (call-interactively 'org-property-action))
26162 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
26163 ((org-on-heading-p) (call-interactively 'org-set-tags))
26164 ((org-at-table.el-p)
26165 (require 'table)
26166 (beginning-of-line 1)
26167 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
26168 (call-interactively 'table-recognize-table))
26169 ((org-at-table-p)
26170 (org-table-maybe-eval-formula)
26171 (if arg
26172 (call-interactively 'org-table-recalculate)
26173 (org-table-maybe-recalculate-line))
26174 (call-interactively 'org-table-align))
26175 ((org-at-item-checkbox-p)
26176 (call-interactively 'org-toggle-checkbox))
26177 ((org-at-item-p)
26178 (call-interactively 'org-maybe-renumber-ordered-list))
26180 ;; Dynamic block
26181 (beginning-of-line 1)
26182 (org-update-dblock))
26184 (cond
26185 ((equal (match-string 1) "TBLFM")
26186 ;; Recalculate the table before this line
26187 (save-excursion
26188 (beginning-of-line 1)
26190 (if (org-at-table-p)
26191 (org-call-with-arg 'org-table-recalculate t))))
26192 (t
26193 (call-interactively 'org-mode-restart))))
26194 (t (error "C-c C-c can do nothing useful at this location.")))))
26196 (defun org-mode-restart ()
26197 "Restart Org-mode, to scan again for special lines.
26198 Also updates the keyword regular expressions."
26199 (interactive)
26200 (let ((org-inhibit-startup t)) (org-mode))
26201 (message "Org-mode restarted to refresh keyword and special line setup"))
26203 (defun org-kill-note-or-show-branches ()
26204 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
26205 (interactive)
26206 (if (not org-finish-function)
26207 (call-interactively 'show-branches)
26208 (let ((org-note-abort t))
26209 (funcall org-finish-function))))
26211 (defun org-return ()
26212 "Goto next table row or insert a newline.
26213 Calls `org-table-next-row' or `newline', depending on context.
26214 See the individual commands for more information."
26215 (interactive)
26216 (cond
26217 ((bobp) (newline))
26218 ((org-at-table-p)
26219 (org-table-justify-field-maybe)
26220 (call-interactively 'org-table-next-row))
26221 (t (newline))))
26224 (defun org-ctrl-c-minus ()
26225 "Insert separator line in table or modify bullet type in list.
26226 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
26227 depending on context."
26228 (interactive)
26229 (cond
26230 ((org-at-table-p)
26231 (call-interactively 'org-table-insert-hline))
26232 ((org-on-heading-p)
26233 ;; Convert to item
26234 (save-excursion
26235 (beginning-of-line 1)
26237 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
26238 ((org-in-item-p)
26239 (call-interactively 'org-cycle-list-bullet))
26240 (t (error "`C-c -' does have no function here."))))
26242 (defun org-meta-return (&optional arg)
26243 "Insert a new heading or wrap a region in a table.
26244 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
26245 See the individual commands for more information."
26246 (interactive "P")
26247 (cond
26248 ((org-at-table-p)
26249 (call-interactively 'org-table-wrap-region))
26250 (t (call-interactively 'org-insert-heading))))
26252 ;;; Menu entries
26254 ;; Define the Org-mode menus
26255 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
26256 '("Tbl"
26257 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
26258 ["Next Field" org-cycle (org-at-table-p)]
26259 ["Previous Field" org-shifttab (org-at-table-p)]
26260 ["Next Row" org-return (org-at-table-p)]
26261 "--"
26262 ["Blank Field" org-table-blank-field (org-at-table-p)]
26263 ["Edit Field" org-table-edit-field (org-at-table-p)]
26264 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
26265 "--"
26266 ("Column"
26267 ["Move Column Left" org-metaleft (org-at-table-p)]
26268 ["Move Column Right" org-metaright (org-at-table-p)]
26269 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
26270 ["Insert Column" org-shiftmetaright (org-at-table-p)])
26271 ("Row"
26272 ["Move Row Up" org-metaup (org-at-table-p)]
26273 ["Move Row Down" org-metadown (org-at-table-p)]
26274 ["Delete Row" org-shiftmetaup (org-at-table-p)]
26275 ["Insert Row" org-shiftmetadown (org-at-table-p)]
26276 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
26277 "--"
26278 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
26279 ("Rectangle"
26280 ["Copy Rectangle" org-copy-special (org-at-table-p)]
26281 ["Cut Rectangle" org-cut-special (org-at-table-p)]
26282 ["Paste Rectangle" org-paste-special (org-at-table-p)]
26283 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
26284 "--"
26285 ("Calculate"
26286 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
26287 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
26288 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
26289 "--"
26290 ["Recalculate line" org-table-recalculate (org-at-table-p)]
26291 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
26292 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
26293 "--"
26294 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
26295 "--"
26296 ["Sum Column/Rectangle" org-table-sum
26297 (or (org-at-table-p) (org-region-active-p))]
26298 ["Which Column?" org-table-current-column (org-at-table-p)])
26299 ["Debug Formulas"
26300 org-table-toggle-formula-debugger
26301 :style toggle :selected org-table-formula-debug]
26302 ["Show Col/Row Numbers"
26303 org-table-toggle-coordinate-overlays
26304 :style toggle :selected org-table-overlay-coordinates]
26305 "--"
26306 ["Create" org-table-create (and (not (org-at-table-p))
26307 org-enable-table-editor)]
26308 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
26309 ["Import from File" org-table-import (not (org-at-table-p))]
26310 ["Export to File" org-table-export (org-at-table-p)]
26311 "--"
26312 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
26314 (easy-menu-define org-org-menu org-mode-map "Org menu"
26315 '("Org"
26316 ("Show/Hide"
26317 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
26318 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
26319 ["Sparse Tree" org-occur t]
26320 ["Reveal Context" org-reveal t]
26321 ["Show All" show-all t]
26322 "--"
26323 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
26324 "--"
26325 ["New Heading" org-insert-heading t]
26326 ("Navigate Headings"
26327 ["Up" outline-up-heading t]
26328 ["Next" outline-next-visible-heading t]
26329 ["Previous" outline-previous-visible-heading t]
26330 ["Next Same Level" outline-forward-same-level t]
26331 ["Previous Same Level" outline-backward-same-level t]
26332 "--"
26333 ["Jump" org-goto t])
26334 ("Edit Structure"
26335 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
26336 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
26337 "--"
26338 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
26339 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
26340 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
26341 "--"
26342 ["Promote Heading" org-metaleft (not (org-at-table-p))]
26343 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
26344 ["Demote Heading" org-metaright (not (org-at-table-p))]
26345 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
26346 "--"
26347 ["Sort Region/Children" org-sort (not (org-at-table-p))]
26348 "--"
26349 ["Convert to odd levels" org-convert-to-odd-levels t]
26350 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
26351 ("Editing"
26352 ["Emphasis..." org-emphasize t])
26353 ("Archive"
26354 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
26355 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
26356 ; :active t :keys "C-u C-c C-x C-a"]
26357 ["Sparse trees open ARCHIVE trees"
26358 (setq org-sparse-tree-open-archived-trees
26359 (not org-sparse-tree-open-archived-trees))
26360 :style toggle :selected org-sparse-tree-open-archived-trees]
26361 ["Cycling opens ARCHIVE trees"
26362 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
26363 :style toggle :selected org-cycle-open-archived-trees]
26364 ["Agenda includes ARCHIVE trees"
26365 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
26366 :style toggle :selected (not org-agenda-skip-archived-trees)]
26367 "--"
26368 ["Move Subtree to Archive" org-advertized-archive-subtree t]
26369 ; ["Check and Move Children" (org-archive-subtree '(4))
26370 ; :active t :keys "C-u C-c C-x C-s"]
26371 )
26372 "--"
26373 ("TODO Lists"
26374 ["TODO/DONE/-" org-todo t]
26375 ("Select keyword"
26376 ["Next keyword" org-shiftright (org-on-heading-p)]
26377 ["Previous keyword" org-shiftleft (org-on-heading-p)]
26378 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
26379 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
26380 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
26381 ["Show TODO Tree" org-show-todo-tree t]
26382 ["Global TODO list" org-todo-list t]
26383 "--"
26384 ["Set Priority" org-priority t]
26385 ["Priority Up" org-shiftup t]
26386 ["Priority Down" org-shiftdown t])
26387 ("TAGS and Properties"
26388 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
26389 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
26390 "--"
26391 ["Set property" 'org-set-property t]
26392 ["Column view of properties" org-columns t]
26393 ["Insert Column View DBlock" org-insert-columns-dblock t])
26394 ("Dates and Scheduling"
26395 ["Timestamp" org-time-stamp t]
26396 ["Timestamp (inactive)" org-time-stamp-inactive t]
26397 ("Change Date"
26398 ["1 Day Later" org-shiftright t]
26399 ["1 Day Earlier" org-shiftleft t]
26400 ["1 ... Later" org-shiftup t]
26401 ["1 ... Earlier" org-shiftdown t])
26402 ["Compute Time Range" org-evaluate-time-range t]
26403 ["Schedule Item" org-schedule t]
26404 ["Deadline" org-deadline t]
26405 "--"
26406 ["Custom time format" org-toggle-time-stamp-overlays
26407 :style radio :selected org-display-custom-times]
26408 "--"
26409 ["Goto Calendar" org-goto-calendar t]
26410 ["Date from Calendar" org-date-from-calendar t])
26411 ("Logging work"
26412 ["Clock in" org-clock-in t]
26413 ["Clock out" org-clock-out t]
26414 ["Clock cancel" org-clock-cancel t]
26415 ["Goto running clock" org-clock-goto t]
26416 ["Display times" org-clock-display t]
26417 ["Create clock table" org-clock-report t]
26418 "--"
26419 ["Record DONE time"
26420 (progn (setq org-log-done (not org-log-done))
26421 (message "Switching to %s will %s record a timestamp"
26422 (car org-done-keywords)
26423 (if org-log-done "automatically" "not")))
26424 :style toggle :selected org-log-done])
26425 "--"
26426 ["Agenda Command..." org-agenda t]
26427 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
26428 ("File List for Agenda")
26429 ("Special views current file"
26430 ["TODO Tree" org-show-todo-tree t]
26431 ["Check Deadlines" org-check-deadlines t]
26432 ["Timeline" org-timeline t]
26433 ["Tags Tree" org-tags-sparse-tree t])
26434 "--"
26435 ("Hyperlinks"
26436 ["Store Link (Global)" org-store-link t]
26437 ["Insert Link" org-insert-link t]
26438 ["Follow Link" org-open-at-point t]
26439 "--"
26440 ["Next link" org-next-link t]
26441 ["Previous link" org-previous-link t]
26442 "--"
26443 ["Descriptive Links"
26444 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
26445 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
26446 ["Literal Links"
26447 (progn
26448 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
26449 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
26450 "--"
26451 ["Export/Publish..." org-export t]
26452 ("LaTeX"
26453 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
26454 :selected org-cdlatex-mode]
26455 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
26456 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
26457 ["Modify math symbol" org-cdlatex-math-modify
26458 (org-inside-LaTeX-fragment-p)]
26459 ["Export LaTeX fragments as images"
26460 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
26461 :style toggle :selected org-export-with-LaTeX-fragments])
26462 "--"
26463 ("Documentation"
26464 ["Show Version" org-version t]
26465 ["Info Documentation" org-info t])
26466 ("Customize"
26467 ["Browse Org Group" org-customize t]
26468 "--"
26469 ["Expand This Menu" org-create-customize-menu
26470 (fboundp 'customize-menu-create)])
26471 "--"
26472 ["Refresh setup" org-mode-restart t]
26473 ))
26475 (defun org-info (&optional node)
26476 "Read documentation for Org-mode in the info system.
26477 With optional NODE, go directly to that node."
26478 (interactive)
26479 (require 'info)
26480 (Info-goto-node (format "(org)%s" (or node ""))))
26482 (defun org-install-agenda-files-menu ()
26483 (let ((bl (buffer-list)))
26484 (save-excursion
26485 (while bl
26486 (set-buffer (pop bl))
26487 (if (org-mode-p) (setq bl nil)))
26488 (when (org-mode-p)
26489 (easy-menu-change
26490 '("Org") "File List for Agenda"
26491 (append
26492 (list
26493 ["Edit File List" (org-edit-agenda-file-list) t]
26494 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
26495 ["Remove Current File from List" org-remove-file t]
26496 ["Cycle through agenda files" org-cycle-agenda-files t]
26497 ["Occur in all agenda files" org-occur-in-agenda-files t]
26498 "--")
26499 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
26501 ;;;; Documentation
26503 (defun org-customize ()
26504 "Call the customize function with org as argument."
26505 (interactive)
26506 (customize-browse 'org))
26508 (defun org-create-customize-menu ()
26509 "Create a full customization menu for Org-mode, insert it into the menu."
26510 (interactive)
26511 (if (fboundp 'customize-menu-create)
26512 (progn
26513 (easy-menu-change
26514 '("Org") "Customize"
26515 `(["Browse Org group" org-customize t]
26516 "--"
26517 ,(customize-menu-create 'org)
26518 ["Set" Custom-set t]
26519 ["Save" Custom-save t]
26520 ["Reset to Current" Custom-reset-current t]
26521 ["Reset to Saved" Custom-reset-saved t]
26522 ["Reset to Standard Settings" Custom-reset-standard t]))
26524 (error "Cannot expand menu (outdated version of cus-edit.el)")))
26526 ;;;; Miscellaneous stuff
26529 ;;; Generally useful functions
26531 (defun org-context ()
26532 "Return a list of contexts of the current cursor position.
26533 If several contexts apply, all are returned.
26534 Each context entry is a list with a symbol naming the context, and
26535 two positions indicating start and end of the context. Possible
26536 contexts are:
26538 :headline anywhere in a headline
26539 :headline-stars on the leading stars in a headline
26540 :todo-keyword on a TODO keyword (including DONE) in a headline
26541 :tags on the TAGS in a headline
26542 :priority on the priority cookie in a headline
26543 :item on the first line of a plain list item
26544 :item-bullet on the bullet/number of a plain list item
26545 :checkbox on the checkbox in a plain list item
26546 :table in an org-mode table
26547 :table-special on a special filed in a table
26548 :table-table in a table.el table
26549 :link on a hyperlink
26550 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
26551 :target on a <<target>>
26552 :radio-target on a <<<radio-target>>>
26553 :latex-fragment on a LaTeX fragment
26554 :latex-preview on a LaTeX fragment with overlayed preview image
26556 This function expects the position to be visible because it uses font-lock
26557 faces as a help to recognize the following contexts: :table-special, :link,
26558 and :keyword."
26559 (let* ((f (get-text-property (point) 'face))
26560 (faces (if (listp f) f (list f)))
26561 (p (point)) clist o)
26562 ;; First the large context
26563 (cond
26564 ((org-on-heading-p t)
26565 (push (list :headline (point-at-bol) (point-at-eol)) clist)
26566 (when (progn
26567 (beginning-of-line 1)
26568 (looking-at org-todo-line-tags-regexp))
26569 (push (org-point-in-group p 1 :headline-stars) clist)
26570 (push (org-point-in-group p 2 :todo-keyword) clist)
26571 (push (org-point-in-group p 4 :tags) clist))
26572 (goto-char p)
26575 (push (org-point-in-group p 0 :priority) clist)))
26577 ((org-at-item-p)
26578 (push (org-point-in-group p 2 :item-bullet) clist)
26579 (push (list :item (point-at-bol)
26580 (save-excursion (org-end-of-item) (point)))
26581 clist)
26582 (and (org-at-item-checkbox-p)
26583 (push (org-point-in-group p 0 :checkbox) clist)))
26585 ((org-at-table-p)
26586 (push (list :table (org-table-begin) (org-table-end)) clist)
26587 (if (memq 'org-formula faces)
26588 (push (list :table-special
26589 (previous-single-property-change p 'face)
26590 (next-single-property-change p 'face)) clist)))
26591 ((org-at-table-p 'any)
26592 (push (list :table-table) clist)))
26593 (goto-char p)
26595 ;; Now the small context
26596 (cond
26597 ((org-at-timestamp-p)
26598 (push (org-point-in-group p 0 :timestamp) clist))
26599 ((memq 'org-link faces)
26600 (push (list :link
26601 (previous-single-property-change p 'face)
26602 (next-single-property-change p 'face)) clist))
26603 ((memq 'org-special-keyword faces)
26604 (push (list :keyword
26605 (previous-single-property-change p 'face)
26606 (next-single-property-change p 'face)) clist))
26607 ((org-on-target-p)
26608 (push (org-point-in-group p 0 :target) clist)
26609 (goto-char (1- (match-beginning 0)))
26610 (if (looking-at org-radio-target-regexp)
26611 (push (org-point-in-group p 0 :radio-target) clist))
26612 (goto-char p))
26613 ((setq o (car (delq nil
26614 (mapcar
26615 (lambda (x)
26616 (if (memq x org-latex-fragment-image-overlays) x))
26617 (org-overlays-at (point))))))
26618 (push (list :latex-fragment
26619 (org-overlay-start o) (org-overlay-end o)) clist)
26620 (push (list :latex-preview
26621 (org-overlay-start o) (org-overlay-end o)) clist))
26622 ((org-inside-LaTeX-fragment-p)
26623 ;; FIXME: positions wrong.
26624 (push (list :latex-fragment (point) (point)) clist)))
26626 (setq clist (nreverse (delq nil clist)))
26627 clist))
26629 ;; FIXME: Compare with at-regexp-p Do we need both?
26630 (defun org-in-regexp (re &optional nlines visually)
26631 "Check if point is inside a match of regexp.
26632 Normally only the current line is checked, but you can include NLINES extra
26633 lines both before and after point into the search.
26634 If VISUALLY is set, require that the cursor is not after the match but
26635 really on, so that the block visually is on the match."
26636 (catch 'exit
26637 (let ((pos (point))
26638 (eol (point-at-eol (+ 1 (or nlines 0))))
26639 (inc (if visually 1 0)))
26640 (save-excursion
26641 (beginning-of-line (- 1 (or nlines 0)))
26642 (while (re-search-forward re eol t)
26643 (if (and (<= (match-beginning 0) pos)
26644 (>= (+ inc (match-end 0)) pos))
26645 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
26647 (defun org-at-regexp-p (regexp)
26648 "Is point inside a match of REGEXP in the current line?"
26649 (catch 'exit
26650 (save-excursion
26651 (let ((pos (point)) (end (point-at-eol)))
26652 (beginning-of-line 1)
26653 (while (re-search-forward regexp end t)
26654 (if (and (<= (match-beginning 0) pos)
26655 (>= (match-end 0) pos))
26656 (throw 'exit t)))
26657 nil))))
26659 (defun org-occur-in-agenda-files (regexp &optional nlines)
26660 "Call `multi-occur' with buffers for all agenda files."
26662 (let* ((files (org-agenda-files))
26663 (tnames (mapcar 'file-truename files))
26664 (extra org-agenda-multi-occur-extra-files)
26665 f)
26666 (while (setq f (pop extra))
26667 (unless (member (file-truename f) tnames)
26668 (add-to-list 'files f 'append)
26669 (add-to-list 'tnames (file-truename f) 'append)))
26670 (multi-occur
26671 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
26672 regexp)))
26674 (defun org-uniquify (list)
26675 "Remove duplicate elements from LIST."
26676 (let (res)
26677 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
26678 res))
26680 (defun org-delete-all (elts list)
26681 "Remove all elements in ELTS from LIST."
26682 (while elts
26683 (setq list (delete (pop elts) list)))
26684 list)
26686 (defun org-point-in-group (point group &optional context)
26687 "Check if POINT is in match-group GROUP.
26688 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
26689 match. If the match group does ot exist or point is not inside it,
26690 return nil."
26691 (and (match-beginning group)
26692 (>= point (match-beginning group))
26693 (<= point (match-end group))
26694 (if context
26695 (list context (match-beginning group) (match-end group))
26696 t)))
26698 (defun org-switch-to-buffer-other-window (&rest args)
26699 "Switch to buffer in a second window on the current frame.
26700 In particular, do not allow pop-up frames."
26701 (let (pop-up-frames special-display-buffer-names special-display-regexps
26702 special-display-function)
26703 (apply 'switch-to-buffer-other-window args)))
26705 (defun org-combine-plists (&rest plists)
26706 "Create a single property list from all plists in PLISTS.
26707 The process starts by copying the first list, and then setting properties
26708 from the other lists. Settings in the last list are the most significant
26709 ones and overrule settings in the other lists."
26710 (let ((rtn (copy-sequence (pop plists)))
26711 p v ls)
26712 (while plists
26713 (setq ls (pop plists))
26714 (while ls
26715 (setq p (pop ls) v (pop ls))
26716 (setq rtn (plist-put rtn p v))))
26717 rtn))
26719 (defun org-move-line-down (arg)
26720 "Move the current line down. With prefix argument, move it past ARG lines."
26721 (interactive "p")
26722 (let ((col (current-column))
26723 beg end pos)
26724 (beginning-of-line 1) (setq beg (point))
26725 (beginning-of-line 2) (setq end (point))
26726 (beginning-of-line (+ 1 arg))
26727 (setq pos (move-marker (make-marker) (point)))
26728 (insert (delete-and-extract-region beg end))
26729 (goto-char pos)
26730 (move-to-column col)))
26732 (defun org-move-line-up (arg)
26733 "Move the current line up. With prefix argument, move it past ARG lines."
26734 (interactive "p")
26735 (let ((col (current-column))
26736 beg end pos)
26737 (beginning-of-line 1) (setq beg (point))
26738 (beginning-of-line 2) (setq end (point))
26739 (beginning-of-line (- arg))
26740 (setq pos (move-marker (make-marker) (point)))
26741 (insert (delete-and-extract-region beg end))
26742 (goto-char pos)
26743 (move-to-column col)))
26745 (defun org-replace-escapes (string table)
26746 "Replace %-escapes in STRING with values in TABLE.
26748 The sequences in STRING may contain normal field width and padding information,
26750 so values can contain further %-escapes if they are define later in TABLE."
26751 (let ((case-fold-search nil)
26752 e re rpl)
26753 (while (setq e (pop table))
26754 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
26755 (while (string-match re string)
26756 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
26757 (cdr e)))
26758 (setq string (replace-match rpl t t string))))
26759 string))
26762 (defun org-sublist (list start end)
26763 "Return a section of LIST, from START to END.
26764 Counting starts at 1."
26765 (let (rtn (c start))
26766 (setq list (nthcdr (1- start) list))
26767 (while (and list (<= c end))
26768 (push (pop list) rtn)
26769 (setq c (1+ c)))
26770 (nreverse rtn)))
26772 (defun org-find-base-buffer-visiting (file)
26773 "Like `find-buffer-visiting' but alway return the base buffer and
26774 not an indirect buffer"
26775 (let ((buf (find-buffer-visiting file)))
26776 (if buf
26777 (or (buffer-base-buffer buf) buf)
26778 nil)))
26780 (defun org-image-file-name-regexp ()
26781 "Return regexp matching the file names of images."
26782 (if (fboundp 'image-file-name-regexp)
26783 (image-file-name-regexp)
26784 (let ((image-file-name-extensions
26785 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
26786 "xbm" "xpm" "pbm" "pgm" "ppm")))
26788 (regexp-opt (nconc (mapcar 'upcase
26789 image-file-name-extensions)
26790 image-file-name-extensions)
26791 t)
26794 (defun org-file-image-p (file)
26795 "Return non-nil if FILE is an image."
26796 (save-match-data
26797 (string-match (org-image-file-name-regexp) file)))
26799 ;;; Paragraph filling stuff.
26800 ;; We want this to be just right, so use the full arsenal.
26802 (defun org-indent-line-function ()
26803 "Indent line like previous, but further if previous was headline or item."
26804 (interactive)
26805 (let* ((pos (point))
26806 (itemp (org-at-item-p))
26807 column bpos bcol tpos tcol bullet btype bullet-type)
26808 ;; Find the previous relevant line
26809 (beginning-of-line 1)
26810 (cond
26811 ((looking-at "#") (setq column 0))
26813 (t
26814 (beginning-of-line 0)
26816 (beginning-of-line 0))
26817 (cond
26819 (goto-char (match-end 0))
26820 (setq column (current-column)))
26821 ((org-in-item-p)
26822 (org-beginning-of-item)
26825 (setq bpos (match-beginning 1) tpos (match-end 0)
26826 bcol (progn (goto-char bpos) (current-column))
26827 tcol (progn (goto-char tpos) (current-column))
26828 bullet (match-string 1)
26829 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
26830 (if (not itemp)
26831 (setq column tcol)
26832 (goto-char pos)
26833 (beginning-of-line 1)
26835 (progn
26837 (setq bullet (match-string 1)
26838 btype (if (string-match "[0-9]" bullet) "n" bullet))
26839 (setq column (if (equal btype bullet-type) bcol tcol)))
26840 (setq column (org-get-indentation)))))
26841 (t (setq column (org-get-indentation))))))
26842 (goto-char pos)
26843 (if (<= (current-column) (current-indentation))
26844 (indent-line-to column)
26845 (save-excursion (indent-line-to column)))
26846 (setq column (current-column))
26847 (beginning-of-line 1)
26848 (if (looking-at
26851 (match-string 2) (match-string 3)))
26852 t nil))
26853 (move-to-column column)))
26855 (defun org-set-autofill-regexps ()
26856 (interactive)
26857 ;; In the paragraph separator we include headlines, because filling
26858 ;; text in a line directly attached to a headline would otherwise
26859 ;; fill the headline as well.
26862 ;; The paragraph starter includes hand-formatted lists.
26863 (org-set-local 'paragraph-start
26865 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
26866 ;; But only if the user has not turned off tables or fixed-width regions
26867 (org-set-local
26868 'auto-fill-inhibit-regexp
26871 (if (or org-enable-table-editor org-enable-fixed-width-editor)
26872 (concat
26874 (if org-enable-table-editor "|" "")
26875 (if org-enable-fixed-width-editor ":" "")
26876 "]"))))
26877 ;; We use our own fill-paragraph function, to make sure that tables
26878 ;; and fixed-width regions are not wrapped. That function will pass
26879 ;; through to `fill-paragraph' when appropriate.
26880 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
26881 ; Adaptive filling: To get full control, first make sure that
26882 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
26884 (org-set-local 'adaptive-fill-function
26885 'org-adaptive-fill-function))
26887 (defun org-fill-paragraph (&optional justify)
26888 "Re-align a table, pass through to fill-paragraph if no table."
26889 (let ((table-p (org-at-table-p))
26890 (table.el-p (org-at-table.el-p)))
26891 (cond ((and (equal (char-after (point-at-bol)) ?*)
26892 (save-excursion (goto-char (point-at-bol))
26893 (looking-at outline-regexp)))
26894 t) ; skip headlines
26895 (table.el-p t) ; skip table.el tables
26896 (table-p (org-table-align) t) ; align org-mode tables
26897 (t nil)))) ; call paragraph-fill
26899 ;; For reference, this is the default value of adaptive-fill-regexp
26902 (defun org-adaptive-fill-function ()
26903 "Return a fill prefix for org-mode files.
26904 In particular, this makes sure hanging paragraphs for hand-formatted lists
26905 work correctly."
26907 (match-string 0))
26909 (save-excursion
26910 (goto-char (match-end 0))
26911 (make-string (current-column) ?\ )))
26912 (t nil)))
26914 ;;;; Functions extending outline functionality
26916 (defun org-beginning-of-line (&optional arg)
26917 "Go to the beginning of the current line. If that is invisible, continue
26918 to a visible line beginning. This makes the function of C-a more intuitive.
26919 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
26920 first attempt, and only move to after the tags when the cursor is already
26921 beyond the end of the headline."
26922 (interactive "P")
26923 (let ((pos (point)))
26924 (beginning-of-line 1)
26925 (if (bobp)
26926 nil
26927 (backward-char 1)
26928 (if (org-invisible-p)
26929 (while (and (not (bobp)) (org-invisible-p))
26930 (backward-char 1)
26931 (beginning-of-line 1))
26932 (forward-char 1)))
26933 (when org-special-ctrl-a/e
26934 (cond
26935 ((and (looking-at org-todo-line-regexp)
26936 (= (char-after (match-end 1)) ?\ ))
26937 (goto-char
26938 (if (eq org-special-ctrl-a/e t)
26939 (cond ((> pos (match-beginning 3)) (match-beginning 3))
26940 ((= pos (point)) (match-beginning 3))
26941 (t (point)))
26942 (cond ((> pos (point)) (point))
26943 ((not (eq last-command this-command)) (point))
26944 (t (match-beginning 3))))))
26945 ((org-at-item-p)
26946 (goto-char
26947 (if (eq org-special-ctrl-a/e t)
26948 (cond ((> pos (match-end 4)) (match-end 4))
26949 ((= pos (point)) (match-end 4))
26950 (t (point)))
26951 (cond ((> pos (point)) (point))
26952 ((not (eq last-command this-command)) (point))
26953 (t (match-end 4))))))))))
26955 (defun org-end-of-line (&optional arg)
26956 "Go to the end of the line.
26957 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
26958 first attempt, and only move to after the tags when the cursor is already
26959 beyond the end of the headline."
26960 (interactive "P")
26961 (if (or (not org-special-ctrl-a/e)
26962 (not (org-on-heading-p)))
26963 (end-of-line arg)
26964 (let ((pos (point)))
26965 (beginning-of-line 1)
26967 (if (eq org-special-ctrl-a/e t)
26968 (if (or (< pos (match-beginning 1))
26969 (= pos (match-end 0)))
26970 (goto-char (match-beginning 1))
26971 (goto-char (match-end 0)))
26972 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
26973 (goto-char (match-end 0))
26974 (goto-char (match-beginning 1))))
26975 (end-of-line arg)))))
26977 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
26978 (define-key org-mode-map "\C-e" 'org-end-of-line)
26980 (defun org-invisible-p ()
26981 "Check if point is at a character currently not visible."
26982 ;; Early versions of noutline don't have `outline-invisible-p'.
26983 (if (fboundp 'outline-invisible-p)
26984 (outline-invisible-p)
26985 (get-char-property (point) 'invisible)))
26987 (defun org-invisible-p2 ()
26988 "Check if point is at a character currently not visible."
26989 (save-excursion
26990 (if (and (eolp) (not (bobp))) (backward-char 1))
26991 ;; Early versions of noutline don't have `outline-invisible-p'.
26992 (if (fboundp 'outline-invisible-p)
26993 (outline-invisible-p)
26994 (get-char-property (point) 'invisible))))
26996 (defalias 'org-back-to-heading 'outline-back-to-heading)
26997 (defalias 'org-on-heading-p 'outline-on-heading-p)
26998 (defalias 'org-at-heading-p 'outline-on-heading-p)
26999 (defun org-at-heading-or-item-p ()
27000 (or (org-on-heading-p) (org-at-item-p)))
27002 (defun org-on-target-p ()
27003 (or (org-in-regexp org-radio-target-regexp)
27004 (org-in-regexp org-target-regexp)))
27006 (defun org-up-heading-all (arg)
27007 "Move to the heading line of which the present line is a subheading.
27008 This function considers both visible and invisible heading lines.
27009 With argument, move up ARG levels."
27010 (if (fboundp 'outline-up-heading-all)
27011 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27012 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27014 (defun org-up-heading-safe ()
27015 "Move to the heading line of which the present line is a subheading.
27016 This version will not throw an error. It will return the level of the
27017 headline found, or nil if no higher level is found."
27018 (let ((pos (point)) start-level level
27019 (re (concat "^" outline-regexp)))
27020 (catch 'exit
27021 (outline-back-to-heading t)
27022 (setq start-level (funcall outline-level))
27023 (if (equal start-level 1) (throw 'exit nil))
27024 (while (re-search-backward re nil t)
27025 (setq level (funcall outline-level))
27026 (if (< level start-level) (throw 'exit level)))
27027 nil)))
27029 (defun org-goto-sibling (&optional previous)
27030 "Goto the next sibling, even if it is invisible.
27031 When PREVIOUS is set, go to the previous sibling instead. Returns t
27032 when a sibling was found. When none is found, return nil and don't
27033 move point."
27034 (let ((fun (if previous 're-search-backward 're-search-forward))
27035 (pos (point))
27036 (re (concat "^" outline-regexp))
27037 level l)
27038 (when (condition-case nil (org-back-to-heading t) (error nil))
27039 (setq level (funcall outline-level))
27040 (catch 'exit
27041 (or previous (forward-char 1))
27042 (while (funcall fun re nil t)
27043 (setq l (funcall outline-level))
27044 (when (< l level) (goto-char pos) (throw 'exit nil))
27045 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27046 (goto-char pos)
27047 nil))))
27049 (defun org-show-siblings ()
27050 "Show all siblings of the current headline."
27051 (save-excursion
27052 (while (org-goto-sibling) (org-flag-heading nil)))
27053 (save-excursion
27054 (while (org-goto-sibling 'previous)
27055 (org-flag-heading nil))))
27057 (defun org-show-hidden-entry ()
27058 "Show an entry where even the heading is hidden."
27059 (save-excursion
27060 (org-show-entry)))
27062 (defun org-flag-heading (flag &optional entry)
27063 "Flag the current heading. FLAG non-nil means make invisible.
27064 When ENTRY is non-nil, show the entire entry."
27065 (save-excursion
27066 (org-back-to-heading t)
27067 ;; Check if we should show the entire entry
27068 (if entry
27069 (progn
27070 (org-show-entry)
27071 (save-excursion
27072 (and (outline-next-heading)
27073 (org-flag-heading nil))))
27074 (outline-flag-region (max (point-min) (1- (point)))
27075 (save-excursion (outline-end-of-heading) (point))
27076 flag))))
27078 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27079 ;; This is an exact copy of the original function, but it uses
27080 ;; `org-back-to-heading', to make it work also in invisible
27081 ;; trees. And is uses an invisible-OK argument.
27082 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
27083 (org-back-to-heading invisible-OK)
27084 (let ((first t)
27085 (level (funcall outline-level)))
27086 (while (and (not (eobp))
27087 (or first (> (funcall outline-level) level)))
27088 (setq first nil)
27089 (outline-next-heading))
27090 (unless to-heading
27092 (progn
27093 ;; Go to end of line before heading
27094 (forward-char -1)
27096 ;; leave blank line before heading
27097 (forward-char -1))))))
27098 (point))
27100 (defun org-show-subtree ()
27101 "Show everything after this heading at deeper levels."
27102 (outline-flag-region
27103 (point)
27104 (save-excursion
27105 (outline-end-of-subtree) (outline-next-heading) (point))
27106 nil))
27108 (defun org-show-entry ()
27109 "Show the body directly following this heading.
27110 Show the heading too, if it is currently invisible."
27111 (interactive)
27112 (save-excursion
27113 (condition-case nil
27114 (progn
27115 (org-back-to-heading t)
27116 (outline-flag-region
27117 (max (point-min) (1- (point)))
27118 (save-excursion
27119 (re-search-forward
27121 (or (match-beginning 1) (point-max)))
27122 nil))
27123 (error nil))))
27125 (defun org-make-options-regexp (kwds)
27126 "Make a regular expression for keyword lines."
27127 (concat
27128 "^"
27134 ;; Make isearch reveal the necessary context
27135 (defun org-isearch-end ()
27136 "Reveal context after isearch exits."
27137 (when isearch-success ; only if search was successful
27138 (if (featurep 'xemacs)
27139 ;; Under XEmacs, the hook is run in the correct place,
27140 ;; we directly show the context.
27141 (org-show-context 'isearch)
27142 ;; In Emacs the hook runs *before* restoring the overlays.
27143 ;; So we have to use a one-time post-command-hook to do this.
27144 ;; (Emacs 22 has a special variable, see function `org-mode')
27145 (unless (and (boundp 'isearch-mode-end-hook-quit)
27146 isearch-mode-end-hook-quit)
27147 ;; Only when the isearch was not quitted.
27148 (org-add-hook 'post-command-hook 'org-isearch-post-command
27149 'append 'local)))))
27151 (defun org-isearch-post-command ()
27152 "Remove self from hook, and show context."
27153 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
27154 (org-show-context 'isearch))
27157 ;;;; Integration with and fixes for other packages
27159 ;;; Imenu support
27161 (defvar org-imenu-markers nil
27162 "All markers currently used by Imenu.")
27163 (make-variable-buffer-local 'org-imenu-markers)
27165 (defun org-imenu-new-marker (&optional pos)
27166 "Return a new marker for use by Imenu, and remember the marker."
27167 (let ((m (make-marker)))
27168 (move-marker m (or pos (point)))
27169 (push m org-imenu-markers)
27170 m))
27172 (defun org-imenu-get-tree ()
27173 "Produce the index for Imenu."
27174 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
27175 (setq org-imenu-markers nil)
27176 (let* ((n org-imenu-depth)
27177 (re (concat "^" outline-regexp))
27178 (subs (make-vector (1+ n) nil))
27179 (last-level 0)
27180 m tree level head)
27181 (save-excursion
27182 (save-restriction
27183 (widen)
27184 (goto-char (point-max))
27185 (while (re-search-backward re nil t)
27186 (setq level (org-reduced-level (funcall outline-level)))
27187 (when (<= level n)
27188 (looking-at org-complex-heading-regexp)
27189 (setq head (org-match-string-no-properties 4)
27190 m (org-imenu-new-marker))
27191 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
27192 (if (>= level last-level)
27193 (push (cons head m) (aref subs level))
27194 (push (cons head (aref subs (1+ level))) (aref subs level))
27195 (loop for i from (1+ level) to n do (aset subs i nil)))
27196 (setq last-level level)))))
27197 (aref subs 1)))
27199 (eval-after-load "imenu"
27200 '(progn
27201 (add-hook 'imenu-after-jump-hook
27202 (lambda () (org-show-context 'org-goto)))))
27204 ;; Speedbar support
27206 (defun org-speedbar-set-agenda-restriction ()
27207 "Restrict future agenda commands to the location at point in speedbar.
27209 (interactive)
27210 (let (p m tp np dir txt w)
27211 (cond
27212 ((setq p (text-property-any (point-at-bol) (point-at-eol)
27213 'org-imenu t))
27214 (setq m (get-text-property p 'org-imenu-marker))
27215 (save-excursion
27216 (save-restriction
27217 (set-buffer (marker-buffer m))
27218 (goto-char m)
27219 (org-agenda-set-restriction-lock 'subtree))))
27220 ((setq p (text-property-any (point-at-bol) (point-at-eol)
27221 'speedbar-function 'speedbar-find-file))
27222 (setq tp (previous-single-property-change
27223 (1+ p) 'speedbar-function)
27224 np (next-single-property-change
27225 tp 'speedbar-function)
27226 dir (speedbar-line-directory)
27227 txt (buffer-substring-no-properties (or tp (point-min))
27228 (or np (point-max))))
27229 (save-excursion
27230 (save-restriction
27231 (set-buffer (find-file-noselect
27232 (let ((default-directory dir))
27233 (expand-file-name txt))))
27234 (unless (org-mode-p)
27235 (error "Cannot restrict to non-Org-mode file"))
27236 (org-agenda-set-restriction-lock 'file))))
27237 (t (error "Don't know how to restrict Org-mode's agenda")))
27238 (org-move-overlay org-speedbar-restriction-lock-overlay
27239 (point-at-bol) (point-at-eol))
27240 (setq current-prefix-arg nil)
27241 (org-agenda-maybe-redo)))
27243 (eval-after-load "speedbar"
27244 '(progn
27245 (speedbar-add-supported-extension ".org")
27246 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
27247 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
27248 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
27249 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)))
27251 ;;; Fixes and Hacks
27253 ;; Make flyspell not check words in links, to not mess up our keymap
27254 (defun org-mode-flyspell-verify ()
27255 "Don't let flyspell put overlays at active buttons."
27256 (not (get-text-property (point) 'keymap)))
27258 ;; Make `bookmark-jump' show the jump location if it was hidden.
27259 (eval-after-load "bookmark"
27260 '(if (boundp 'bookmark-after-jump-hook)
27261 ;; We can use the hook
27262 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
27263 ;; Hook not available, use advice
27264 (defadvice bookmark-jump (after org-make-visible activate)
27265 "Make the position visible."
27266 (org-bookmark-jump-unhide))))
27268 (defun org-bookmark-jump-unhide ()
27269 "Unhide the current position, to show the bookmark location."
27270 (and (org-mode-p)
27271 (or (org-invisible-p)
27272 (save-excursion (goto-char (max (point-min) (1- (point))))
27273 (org-invisible-p)))
27274 (org-show-context 'bookmark-jump)))
27276 ;; Fix a bug in htmlize where there are text properties (face nil)
27277 (eval-after-load "htmlize"
27278 '(progn
27279 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
27280 "Make sure there are no nil faces"
27281 (setq ad-return-value (delq nil ad-return-value)))))
27283 ;; Make session.el ignore our circular variable
27284 (eval-after-load "session"
27285 '(add-to-list 'session-globals-exclude 'org-mark-ring))
27287 ;;;; Experimental code
27289 (defun org-closed-in-range ()
27290 "Sparse tree of items closed in a certain time range.
27291 Still experimental, may disappear in the future."
27292 (interactive)
27293 ;; Get the time interval from the user.
27294 (let* ((time1 (time-to-seconds
27295 (org-read-date nil 'to-time nil "Starting date: ")))
27296 (time2 (time-to-seconds
27297 (org-read-date nil 'to-time nil "End date:")))
27298 ;; callback function
27299 (callback (lambda ()
27300 (let ((time
27301 (time-to-seconds
27302 (apply 'encode-time
27303 (org-parse-time-string
27304 (match-string 1))))))
27305 ;; check if time in interval
27306 (and (>= time time1) (<= time time2))))))
27307 ;; make tree, check each match with the callback
27310 ;; FIXME: this needs a much better algorithm
27311 (defun org-assign-fast-keys (alist)
27312 "Assign fast keys to a keyword-key alist.
27313 Respect keys that are already there."
27314 (let (new e k c c1 c2 (char ?a))
27315 (while (setq e (pop alist))
27316 (cond
27317 ((equal e '(:startgroup)) (push e new))
27318 ((equal e '(:endgroup)) (push e new))
27319 (t
27320 (setq k (car e) c2 nil)
27321 (if (cdr e)
27322 (setq c (cdr e))
27323 ;; automatically assign a character.
27324 (setq c1 (string-to-char
27325 (downcase (substring
27326 k (if (= (string-to-char k) ?@) 1 0)))))
27327 (if (or (rassoc c1 new) (rassoc c1 alist))
27328 (while (or (rassoc char new) (rassoc char alist))
27329 (setq char (1+ char)))
27330 (setq c2 c1))
27331 (setq c (or c2 char)))
27332 (push (cons k c) new))))
27333 (nreverse new)))
27336 (defcustom org-highlight-latex-fragments-and-specials nil
27337 "Non-nil means, fontify what is treated specially by the exporters."
27338 :group 'org-font-lock
27339 :type 'boolean)
27341 (defvar org-latex-and-specials-regexp nil
27342 "Regular expression for highlighting export special stuff.")
27344 (defun org-compute-latex-and-specials-regexp ()
27345 "Compute regular expression for stuff treated specially by exporters."
27346 (if (not org-highlight-latex-fragments-and-specials)
27347 (org-set-local 'org-latex-and-specials-regexp nil)
27348 (let*
27349 ((matchers (plist-get org-format-latex-options :matchers))
27350 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
27351 org-latex-regexps)))
27352 (options (org-combine-plists (org-default-export-plist)
27353 (org-infile-export-plist)))
27354 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
27355 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
27356 (org-export-with-TeX-macros (plist-get options :TeX-macros))
27357 (org-export-html-expand (plist-get options :expand-quoted-html))
27358 (org-export-with-special-strings (plist-get options :special-strings))
27359 (re-sub
27360 (cond
27361 ((equal org-export-with-sub-superscripts '{})
27362 (list org-match-substring-with-braces-regexp))
27363 (org-export-with-sub-superscripts
27364 (list org-match-substring-regexp))
27365 (t nil)))
27366 (re-latex
27367 (if org-export-with-LaTeX-fragments
27368 (mapcar (lambda (x) (nth 1 x)) latexs)))
27369 (re-macros
27370 (if org-export-with-TeX-macros
27372 (regexp-opt
27373 (append (mapcar 'car org-html-entities)
27374 (if (boundp 'org-latex-entities)
27375 org-latex-entities nil))
27376 'words))) ; FIXME
27377 ))
27379 (re-special (if org-export-with-special-strings
27380 (mapcar (lambda (x) (car x))
27381 org-export-html-special-string-regexps)))
27382 (re-rest
27383 (delq nil
27384 (list
27386 ))))
27387 (org-set-local
27388 'org-latex-and-specials-regexp
27391 (defface org-latex-and-export-specials
27392 (let ((font (cond ((assq :inherit custom-face-attributes)
27393 '(:inherit underline))
27394 (t '(:underline t)))))
27395 `((((class grayscale) (background light))
27396 (:foreground "DimGray" ,@font))
27397 (((class grayscale) (background dark))
27398 (:foreground "LightGray" ,@font))
27399 (((class color) (background light))
27400 (:foreground "SaddleBrown"))
27401 (((class color) (background dark))
27402 (:foreground "burlywood"))
27403 (t (,@font))))
27404 "Face used to highlight math latex and other special exporter stuff."
27405 :group 'org-faces)
27407 (defun org-do-latex-and-special-faces (limit)
27408 "Run through the buffer and add overlays to links."
27409 (when org-latex-and-specials-regexp
27410 (let (rtn d)
27411 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
27412 limit t))
27413 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0)) 'face))
27414 '(org-code org-verbatim underline)))
27415 (progn
27416 (setq rtn t
27417 d (cond ((member (char-after (1+ (match-beginning 0))) '(?_ ?^)) 1)
27418 (t 0)))
27419 (font-lock-prepend-text-property
27420 (+ d (match-beginning 0)) (match-end 0)
27421 'face 'org-latex-and-export-specials)
27422 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
27423 '(font-lock-multiline t)))))
27424 rtn)))
27427 (defun org-find-first-timestamp (keyword inactive end)
27428 "Return location of first timestamp matching KEYWORD and INACTIVE.
27429 KEYWORD may be any of the timestamp keywords, or nil.
27430 INACTIVE means it should be an inactive timestamp.
27431 If there is no such time stamp, return nil."
27432 (catch 'exit
27433 (let (key ia)
27434 (setq inactive (and inactive t))
27435 (while (re-search-forward org-maybe-keyword-time-regexp end t)
27436 (setq key (and (match-end 1) (substring (match-string 1) 0 -1)
27437 (equal (char-after (match-beginning 3)) ?\[)))
27438 (when (and (equal keyword key)
27439 (equal inactive ia))
27440 (throw 'exit (match-beginning 3)))))))
27443 ;;;; Finish up
27445 (provide 'org)
27447 (run-hooks 'org-load-hook)
27449 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
27450 ;;; org.el ends here