| blob | 0d2f0a5980d1302f7c11571ca36d8d873465a63d |
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, 2008 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.18a
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 "Return the value of symbol VAR if it is bound, else nil."
106 "Execute body without changing buffer-modified-p."
111 "Replace posix classes in regular expression."
119 ss))
120 s))
132 partial-completion-mode)))
139 ;;; The custom variables
142 "Outline-based notes management and organizer."
148 ;; FIXME: Needs a separate group...
151 Normal means, no org-mode-specific context."
156 "Options concerning startup of Org-mode."
161 "Non-nil means, entering Org-mode will switch to OVERVIEW.
162 This can also be configured on a per-file basis by adding one of
163 the following lines anywhere in the buffer:
165 #+STARTUP: fold
166 #+STARTUP: nofold
167 #+STARTUP: content"
175 "Non-nil means, entering Org-mode will set `truncate-lines'.
176 This is useful since some lines containing links can be very long and
177 uninteresting. Also tables look terrible when wrapped."
182 "Non-nil means, align all tables when visiting a file.
183 This is useful when the column width in tables is forced with <N> cookies
184 in table fields. Such tables will look correct only after the first re-align.
185 This can also be configured on a per-file basis by adding one of
186 the following lines anywhere in the buffer:
187 #+STARTUP: align
188 #+STARTUP: noalign"
193 "Non-nil means insert the first line setting Org-mode in empty files.
194 When the function `org-mode' is called interactively in an empty file, this
195 normally means that the file name does not automatically trigger Org-mode.
196 To ensure that the file will always be in Org-mode in the future, a
197 line enforcing Org-mode will be inserted into the buffer, if this option
198 has been set."
203 "Non-nil means use alternative key bindings for some keys.
204 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
205 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
206 If you want to use Org-mode together with one of these other modes,
207 or more generally if you would like to move some Org-mode commands to
208 other keys, set this variable and configure the keys with the variable
209 `org-disputed-keys'.
211 This option is only relevant at load-time of Org-mode, and must be set
212 *before* org.el is loaded. Changing it requires a restart of Emacs to
213 become effective."
227 "Keys for which Org-mode and other modes compete.
228 This is an alist, cars are the default keys, second element specifies
229 the alternative to use when `org-replace-disputed-keys' is t.
231 Keys can be specified in any syntax supported by `define-key'.
232 The value of this option takes effect only at Org-mode's startup,
233 therefore you'll have to restart Emacs to apply it after changing."
238 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
239 Or return the original if not disputed."
244 org-disputed-keys)))
246 key))
256 "Define a key, possibly translated, as returned by `org-key'."
260 "The ellipsis to use in the Org-mode outline.
261 When nil, just use the standard three dots. When a string, use that instead,
262 When a face, use the standart 3 dots, but with the specified face.
263 The change affects only Org-mode (which will then use its own display table).
264 Changing this requires executing `M-x org-mode' in a buffer to become
265 effective."
275 "Keywords in Org-mode."
280 "String to mark deadline entries.
281 A deadline is this string, followed by a time stamp. Should be a word,
282 terminated by a colon. You can insert a schedule keyword and
284 Changes become only effective after restarting Emacs."
289 "String to mark scheduled TODO entries.
290 A schedule is this string, followed by a time stamp. Should be a word,
291 terminated by a colon. You can insert a schedule keyword and
293 Changes become only effective after restarting Emacs."
298 "String used as the prefix for timestamps logging closing a TODO entry."
303 "String used as prefix for timestamps clocking work hours on an item."
308 "Entries starting with this keyword will never be exported.
309 An entry can be toggled between COMMENT and normal with
311 Changes become only effective after restarting Emacs."
316 "Entries starting with this keyword will be exported in fixed-width font.
317 Quoting applies only to the text in the entry following the headline, and does
318 not extend beyond the next headline, even if that is lower level.
319 An entry can be toggled between QUOTE and normal with
327 "Regular expression for specifying repeated events.
331 "Options concerning the general structure of Org-mode files."
336 "Options about how to make context of a location visible."
360 "Non-nil means, show full hierarchy when revealing a location.
361 Org-mode often shows locations in an org-mode file which might have
362 been invisible before. When this is set, the hierarchy of headings
363 above the exposed location is shown.
364 Turning this off for example for sparse trees makes them very compact.
365 Instead of t, this can also be an alist specifying this option for different
366 contexts. Valid contexts are
367 agenda when exposing an entry from the agenda
368 org-goto when using the command `org-goto' on key C-c C-j
369 occur-tree when using the command `org-occur' on key C-c /
370 tags-tree when constructing a sparse tree based on tags matches
371 link-search when exposing search matches associated with a link
372 mark-goto when exposing the jump goal of a mark
373 bookmark-jump when exposing a bookmark location
374 isearch when exiting from an incremental search
375 default default for all contexts not set explicitly"
380 "Non-nil means, show following heading when revealing a location.
381 Org-mode often shows locations in an org-mode file which might have
382 been invisible before. When this is set, the heading following the
383 match is shown.
384 Turning this off for example for sparse trees makes them very compact,
385 but makes it harder to edit the location of the match. In such a case,
387 Instead of t, this can also be an alist specifying this option for different
388 contexts. See `org-show-hierarchy-above' for valid contexts."
393 "Non-nil means, show all sibling heading when revealing a location.
394 Org-mode often shows locations in an org-mode file which might have
395 been invisible before. When this is set, the sibling of the current entry
396 heading are all made visible. If `org-show-hierarchy-above' is t,
397 the same happens on each level of the hierarchy above the current entry.
399 By default this is on for the isearch context, off for all other contexts.
400 Turning this off for example for sparse trees makes them very compact,
401 but makes it harder to edit the location of the match. In such a case,
403 Instead of t, this can also be an alist specifying this option for different
404 contexts. See `org-show-hierarchy-above' for valid contexts."
409 "Non-nil means, show the entry below a headline when revealing a location.
410 Org-mode often shows locations in an org-mode file which might have
411 been invisible before. When this is set, the text below the headline that is
412 exposed is also shown.
414 By default this is off for all contexts.
415 Instead of t, this can also be an alist specifying this option for different
416 contexts. See `org-show-hierarchy-above' for valid contexts."
421 "Options concerning visibility cycling in Org-mode."
426 "Names of drawers. Drawers are not opened by cycling on the headline above.
427 Drawers only open with a TAB on the drawer line itself. A drawer looks like
428 this:
429 :DRAWERNAME:
430 .....
431 :END:
433 the property API.
435 Drawers can be defined on the per-file basis with a line like:
437 #+DRAWERS: HIDDEN STATE PROPERTIES"
442 "Cycle globally if cursor is at beginning of buffer and not at a headline.
443 This makes it possible to do global cycling without having to use S-TAB or
444 C-u TAB. For this special case to work, the first line of the buffer
445 must not be a headline - it may be empty ot some other text. When used in
446 this way, `org-cycle-hook' is disables temporarily, to make sure the
447 cursor stays at the beginning of the buffer.
448 When this option is nil, don't do anything special at the beginning
449 of the buffer."
454 "Where should `org-cycle' emulate TAB.
455 nil Never
456 white Only in completely white lines
457 whitestart Only at the beginning of lines, before the first non-white char.
458 t Everywhere except in headlines
459 exc-hl-bol Everywhere except at the start of a headline
460 If TAB is used in a place where it does not emulate TAB, the current subtree
461 visibility is cycled."
468 ))
471 "Number of empty lines needed to keep an empty line between collapsed trees.
472 If you leave an empty line between the end of a subtree and the following
473 headline, this empty line is hidden when the subtree is folded.
474 Org-mode will leave (exactly) one empty line visible if the number of
475 empty lines is equal or larger to the number given in this variable.
476 So the default 2 means, at least 2 empty lines after the end of a subtree
477 are needed to produce free space between a collapsed subtree and the
478 following headline.
480 Special case: when 0, never leave empty lines in collapsed view."
485 org-cycle-hide-drawers
486 org-cycle-show-empty-lines
487 org-optimize-window-after-visibility-change)
488 "Hook that is run after `org-cycle' has changed the buffer visibility.
489 The function(s) in this hook must accept a single argument which indicates
490 the new state that was set by the most recent `org-cycle' command. The
491 argument is a symbol. After a global state change, it can have the values
492 `overview', `content', or `all'. After a local state change, it can have
493 the values `folded', `children', or `subtree'."
498 "Options concerning structure editing in Org-mode."
503 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
504 When t, `C-a' will bring back the cursor to the beginning of the
505 headline text, i.e. after the stars and after a possible TODO keyword.
506 In an item, this will be the position after the bullet.
507 When the cursor is already at that position, another `C-a' will bring
508 it to the beginning of the line.
509 `C-e' will jump to the end of the headline, ignoring the presence of tags
510 in the headline. A second `C-e' will then jump to the true end of the
511 line, after any tags.
512 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
513 and only a directly following, identical keypress will bring the cursor
514 to the special positions."
525 "Non-nil means, skip even levels and only use odd levels for the outline.
526 This has the effect that two stars are being added/taken away in
527 promotion/demotion commands. It also influences how levels are
528 handled by the exporters.
529 Changing it requires restart of `font-lock-mode' to become effective
530 for fontification also in regions already fontified.
531 You may also set this on a per-file basis by adding one of the following
532 lines to the buffer:
534 #+STARTUP: odd
535 #+STARTUP: oddeven"
541 "Non-nil means, adapt indentation when promoting and demoting.
542 When this is set and the *entire* text in an entry is indented, the
543 indentation is increased by one space in a demotion command, and
544 decreased by one in a promotion command. If any line in the entry
545 body starts at column 0, indentation is not changed at all."
551 "Should `org-insert-heading' leave a blank line before new heading/item?
552 The value is an alist, with `heading' and `plain-list-item' as car,
553 and a boolean flag as cdr."
560 "Hook being run after inserting a new heading."
566 This currently only means, they are never auto-wrapped.
567 When nil, such lines will be treated like ordinary lines.
568 See also the QUOTE keyword."
573 "Options concerning sparse trees in Org-mode."
578 "Non-nil means, highlight all matches that define a sparse tree.
579 The highlights will automatically disappear the next time the buffer is
580 changed by an edit command."
585 "Non-nil means, any change to the buffer will remove temporary highlights.
586 Such highlights are created by `org-occur' and `org-clock-display'.
587 When nil, `C-c C-c needs to be used to get rid of the highlights.
588 The highlights created by `org-preview-latex-fragment' always need
589 `C-c C-c' to be removed."
596 "Hook that is run after `org-occur' has constructed a sparse tree.
597 This can be used to recenter the window to show as much of the structure
598 as possible."
603 "Options concerning plain lists in Org-mode."
608 "Non-nil means, include plain lists into visibility cycling.
609 This means that during cycling, plain list items will *temporarily* be
610 interpreted as outline headlines with a level given by 1000+i where i is the
611 indentation of the bullet. In all other operations, plain list items are
612 not seen as headlines. For example, you cannot assign a TODO keyword to
613 such an item."
618 "The character that makes a line with leading number an ordered list item.
619 Valid values are ?. and ?\). To get both terminators, use t. While
620 ?. may look nicer, it creates the danger that a line with leading
621 number may be incorrectly interpreted as an item. ?\) therefore is
622 the safe choice."
629 "Non-nil means, automatically renumber ordered plain lists.
630 Renumbering happens when the sequence have been changed with
637 "Non-nil means, update checkbox statistics after insert and toggle.
638 When this is set, checkbox statistics is updated each time you either insert
645 "Options concerning archiving in Org-mode."
650 "The tag that marks a subtree as archived.
651 An archived subtree does not open during visibility cycling, and does
652 not contribute to the agenda listings.
653 After changing this, font-lock must be restarted in the relevant buffers to
654 get the proper fontification."
660 "Non-nil means, the agenda will skip any items located in archived trees.
661 An archived tree is a tree marked with the tag ARCHIVE."
667 "Non-nil means, `org-cycle' will open archived trees.
668 An archived tree is a tree marked with the tag ARCHIVE.
669 When nil, archived trees will stay folded. You can still open them with
670 normal outline commands like `show-all', but not with the cycling commands."
676 "Non-nil means sparse tree construction shows matches in archived trees.
677 When nil, matches in these trees are highlighted, but the trees are kept in
678 collapsed state."
684 "The location where subtrees should be archived.
685 This string consists of two parts, separated by a double-colon.
687 The first part is a file name - when omitted, archiving happens in the same
688 file. %s will be replaced by the current file name (without directory part).
689 Archiving to a different file is useful to keep archived entries from
690 contributing to the Org-mode Agenda.
692 The part after the double colon is a headline. The archived entries will be
693 filed under that headline. When omitted, the subtrees are simply filed away
694 at the end of the file, as top-level entries.
696 Here are a few examples:
698 If the current file is Projects.org, archive in file
699 Projects.org_archive, as top-level trees. This is the default.
702 Archive in the current file, under the top-level headline
706 Archive in file ~/org/archive.org (absolute path), as top-level trees.
709 Archive in file ./basement (relative path), as level 3 trees
712 You may set this option on a per-file basis by adding to the buffer a
713 line like
715 #+ARCHIVE: basement::** Finished Tasks"
720 "Non-nil means, mark entries as DONE when they are moved to the archive file.
721 This can be a string to set the keyword to use. When t, Org-mode will
722 use the first keyword in its list that means done."
730 "Non-nil means, add a time stamp to entries moved to an archive file.
731 This variable is obsolete and has no effect anymore, instead add ot remove
732 `time' from the variablle `org-archive-save-context-info'."
737 "Parts of context info that should be stored as properties when archiving.
738 When a subtree is moved to an archive file, it looses information given by
739 context, like inherited tags, the category, and possibly also the TODO
740 state (depending on the variable `org-archive-mark-done').
741 This variable can be a list of any of the following symbols:
743 time The time of archiving.
744 file The file where the entry originates.
745 itags The local tags, in the headline of the subtree.
746 ltags The tags the subtree inherits from further up the hierarchy.
747 todo The pre-archive TODO state.
748 category The category, taken from file name or #+CATEGORY lines.
750 For each symbol present in the list, a property will be created in
752 information."
764 "Options concerning imenu and speedbar in Org-mode."
769 "The maximum level for Imenu access to Org-mode headlines.
770 This also applied for speedbar access."
775 "Options concerning tables in Org-mode."
781 When nil, such lines will be treated like ordinary lines.
783 When equal to the symbol `optimized', the table editor will be optimized to
784 do the following:
785 - Automatic overwrite mode in front of whitespace in table fields.
786 This makes the structure of the table stay in tact as long as the edited
787 field does not exceed the column width.
788 - Minimize the number of realigns. Normally, the table is aligned each time
789 TAB or RET are pressed to move to another field. With optimization this
790 happens only if changes to a field might have changed the column width.
791 Optimization requires replacing the functions `self-insert-command',
792 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
793 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
794 very good at guessing when a re-align will be necessary, but you can always
797 If you would like to use the optimized version in Org-mode, but the
798 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
800 This variable can be used to turn on and off the table editor during a session,
801 but in order to toggle optimization, a restart is required.
803 See also the variable `org-table-auto-blank-field'."
811 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
812 In the optimized version, the table editor takes over all simple keys that
813 normally just insert a character. In tables, the characters are inserted
814 in a way to minimize disturbing the table structure (i.e. in overwrite mode
815 for empty fields). Outside tables, the correct binding of the keys is
816 restored.
818 The default for this option is t if the optimized version is also used in
819 Org-mode. See the variable `org-enable-table-editor' for details. Changing
820 this variable requires a restart of Emacs to become effective."
826 % END RECEIVE ORGTBL %n
828 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
829 | | |
832 @c END RECEIVE ORGTBL %n
833 @ignore
834 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
835 | | |
838 <!-- END RECEIVE ORGTBL %n -->
839 <!--
840 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
841 | | |
843 "Templates for radio tables in different major modes.
844 All occurrences of %n in a template will be replaced with the name of the
845 table, obtained by prompting the user."
852 "Settings for tables in Org-mode."
857 "The default size for newly created tables, Columns x Rows."
863 "Regular expression for recognizing numbers in table columns.
864 If a table column contains mostly numbers, it will be aligned to the
865 right. If not, it will be aligned to the left.
867 The default value of this option is a regular expression which allows
868 anything which looks remotely like a number as used in scientific
869 context. For example, all of the following will be considered a
870 number:
871 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
873 Other options offered by the customize interface are more restrictive."
891 "Fraction of numbers in a column required to make the column align right.
892 In a column all non-white fields are considered. If at least this
893 fraction of fields is matched by `org-table-number-fraction',
894 alignment to the right border applies."
899 "Behavior of tables during editing in Org-mode."
904 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
906 removal/insertion."
911 "Non-nil means, automatically blank table field when starting to type into it.
912 This only happens when typing immediately after a field motion
913 command (TAB, S-TAB or RET).
914 Only relevant when `org-enable-table-editor' is equal to `optimized'."
919 "Non-nil means, tab in the last column of a table with jump over a hline.
920 If a horizontal separator line is following the current line,
921 `org-table-next-field' can either create a new row before that line, or jump
922 over the line. When this option is nil, a new line will be created before
923 this line."
928 "Non-nil means, TAB will automatically notice a table.el table.
929 When it sees such a table, it moves point into it and - if necessary -
930 calls `table-recognize-table'."
935 "Options concerning tables in Org-mode."
940 "Should org-mode work with table refrences like B3 instead of @3$2?
941 Possible values are:
942 nil never use them
943 from accept as input, do not present for editing
944 t: accept as input and present for editing"
959 calc-angle-mode deg
960 calc-prefer-frac nil
961 calc-symbolic-mode nil
963 calc-display-working-message t
964 )
965 "List with Calc mode settings for use in calc-eval for table formulas.
966 The list must contain alternating symbols (Calc modes variables and values).
967 Don't remove any of the default settings, just change the values. Org-mode
968 relies on the variables to be present in the list."
973 "Non-nil means, TAB and RET evaluate a formula in current table field.
974 If the current field starts with an equal sign, it is assumed to be a formula
975 which should be evaluated as described in the manual and in the documentation
976 string of the command `org-table-eval-formula'. This feature requires the
977 Emacs calc package.
978 When this variable is nil, formula calculation is only available through
984 "Non-nil means, interpret constants in formulas in tables.
985 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
986 by the value given in `org-table-formula-constants', or by a value obtained
987 from the `constants.el' package."
992 "Alist with constant names and values, for use in table formulas.
993 The car of each element is a name of a constant, without the `$' before it.
994 The cdr is the value as a string. For example, if you'd like to use the
995 speed of light in a formula, you would configure
999 and then use it in an equation like `$1*$c'.
1001 Constants can also be defined on a per-file basis using a line like
1003 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1014 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1015 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1020 "Options concerning links in Org-mode."
1025 "Buffer-local version of `org-link-abbrev-alist', which see.
1030 "Alist of link abbreviations.
1031 The car of each element is a string, to be replaced at the start of a link.
1033 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1035 [[linkkey:tag][description]]
1037 If REPLACE is a string, the tag will simply be appended to create the link.
1040 REPLACE may also be a function that will be called with the tag as the
1041 only argument to create the link, which should be returned as a string.
1043 See the manual for examples."
1048 "Non-nil means, hide link part and only show description of bracket links.
1049 Bracket links are like [[link][descritpion]]. This variable sets the initial
1050 state in new org-mode buffers. The setting can then be toggled on a
1051 per-buffer basis from the Org->Hyperlinks menu."
1056 "How the path name in file links should be stored.
1057 Valid values are:
1059 relative relative to the current directory, i.e. the directory of the file
1060 into which the link is being inserted.
1061 absolute absolute path, if possible with ~ for home directory.
1062 noabbrev absolute path, no abbreviation of home directory.
1063 adaptive Use relative path for files in the current directory and sub-
1064 directories of it. For other files, use an absolute path."
1073 "Types of links that should be activated in Org-mode files.
1074 This is a list of symbols, each leading to the activation of a certain link
1075 type. In principle, it does not hurt to turn on most link types - there may
1076 be a small gain when turning off unused link types. The types are:
1078 bracket The recommended [[link][description]] or [[link]] links with hiding.
1079 angular Links in angular brackes that may contain whitespace like
1080 <bbdb:Carsten Dominik>.
1081 plain Plain links in normal text, no whitespace, like http://google.com.
1082 radio Text that is matched by a radio target, see manual for details.
1083 tag Tag settings in a headline (link to tag search).
1084 date Time stamps (link to calendar).
1086 Changing this variable requires a restart of Emacs to become effective."
1097 "Options concerning storing links in Org-mode"
1102 "Format of the description part of a link to an email or usenet message.
1103 The following %-excapes will be replaced by corresponding information:
1111 %s subject
1112 %m message-id.
1114 You may use normal field width specification between the % and the letter.
1115 This is for example useful to limit the length of the subject.
1129 It should match if the message is from the user him/herself."
1134 "Non-nil means, file links from `org-store-link' contain context.
1135 A search string will be added to the file name with :: as separator and
1136 used to find the context when the link is activated by the command
1137 `org-open-at-point'.
1139 negates this setting for the duration of the command."
1144 "Non-nil means, keep link in list for entire session.
1146 The command `org-store-link' adds a link pointing to the current
1147 location to an internal list. These links accumulate during a session.
1148 The command `org-insert-link' can be used to insert links into any
1149 Org-mode file (offering completion for all stored links). When this
1151 will be removed from the list, to make completing the unused links
1152 more efficient."
1157 "Non-nil means, `org-store-link' will create web links to Google groups.
1158 When nil, Gnus will be used for such links.
1160 negates this setting for the duration of the command."
1165 "Options concerning following links in Org-mode"
1170 "Non-nil means, on links TAB will follow the link.
1171 Needs to be set before org.el is loaded."
1176 "Non-nil means, on links RET will follow the link.
1177 Needs to be set before org.el is loaded."
1182 "Non-nil means, mouse-1 on a link will follow the link.
1183 A longer mouse click will still set point. Does not wortk on XEmacs.
1184 Needs to be set before org.el is loaded."
1189 "Number of different positions to be recorded in the ring
1190 Changing this requires a restart of Emacs to work correctly."
1198 "Setup the frame configuration for following links.
1199 When following a link with Emacs, it may often be useful to display
1200 this link in another window or frame. This variable can be used to
1201 set this up for the different types of links.
1202 For VM, use any of
1203 `vm-visit-folder'
1204 `vm-visit-folder-other-frame'
1205 For Gnus, use any of
1206 `gnus'
1207 `gnus-other-frame'
1208 For FILE, use any of
1209 `find-file'
1210 `find-file-other-window'
1211 `find-file-other-frame'
1212 For the calendar, use the variable `calendar-setup'.
1213 For BBDB, it is currently only possible to display the matches in
1214 another window."
1233 "Non-nil means, use indirect buffer to display infile links.
1234 Activating internal links (from one location in a file to another location
1235 in the same file) normally just jumps to the location. When the link is
1236 activated with a C-u prefix (or with mouse-3), the link is displayed in
1237 another window. When this option is set, the other window actually displays
1238 an indirect buffer clone of the current buffer, to avoid any visibility
1239 changes to the current buffer."
1244 "Non-nil means, `org-open-file' will open non-existing files.
1245 When nil, an error will be generated."
1250 "Function and arguments to call for following mailto links.
1251 This is a list with the first element being a lisp function, and the
1252 remaining elements being arguments to the function. In string arguments,
1253 %a will be replaced by the address, and %s will be replaced by the subject
1254 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1263 "Non-nil means, ask for confirmation before executing shell links.
1264 Shell links can be dangerous: just think about a link
1266 [[shell:rm -rf ~/*][Google Search]]
1269 but really it would remove your entire home directory.
1270 Therefore we advise against setting this variable to nil.
1271 Just change it to `y-or-n-p' of you want to confirm with a
1280 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1281 Elisp links can be dangerous: just think about a link
1286 but really it would remove your entire home directory.
1287 Therefore we advise against setting this variable to nil.
1288 Just change it to `y-or-n-p' of you want to confirm with a
1299 "Default file applications on a UNIX or GNU/Linux system.
1311 "Default file applications on a MacOS X system.
1313 for some files for which the OS does not have a good default.
1321 'mswindows-shell-execute
1324 "Default file applications on a Windows NT system.
1329 '(
1336 )
1337 "External applications for opening `file:path' items in a document.
1338 Org-mode uses system defaults for different file types, but
1339 you can use this variable to set the application for a given file
1340 extension. The entries in this list are cons cells where the car identifies
1341 files and the cdr the corresponding command. Possible values for the
1342 file identifier are
1344 `directory' Matches a directory
1345 `remote' Matches a remote file, accessible through tramp or efs.
1346 Remote files most likely should be visited through Emacs
1347 because external applications cannot handle such paths.
1348 t Default for all remaining files
1350 Possible values for the command are:
1351 `emacs' The file will be visited by the current Emacs process.
1352 `default' Use the default application for this file type.
1353 string A command to be executed by a shell; %s will be replaced
1354 by the path to the file.
1355 sexp A Lisp form which will be evaluated. The file path will
1356 be available in the Lisp variable `file'.
1357 For more examples, see the system specific constants
1358 `org-file-apps-defaults-macosx'
1359 `org-file-apps-defaults-windowsnt'
1360 `org-file-apps-defaults-gnu'."
1375 "Non-nil means, that the search for the mh-message will be extended to
1376 all folders if the message cannot be found in the folder given in the link.
1377 Searching all folders is very efficient with one of the search engines
1378 supported by MH-E, but will be slow with pick."
1383 "Options concerning interaction with remember.el."
1388 "Directory with org files.
1389 This directory will be used as default to prompt for org files.
1390 Used by the hooks for remember.el."
1395 "Default target for storing notes.
1396 Used by the hooks for remember.el. This can be a string, or nil to mean
1397 the value of `remember-data-file'.
1398 You can set this on a per-template basis with the variable
1399 `org-remember-templates'."
1403 file))
1406 "Non-nil means, `C-c C-c' stores remember note without further promts.
1407 In this case, you need `C-u C-c C-c' to get the prompts for
1408 note file and headline.
1409 When this variable is nil, `C-c C-c' give you the prompts, and
1410 `C-u C-c C-c' trigger the fasttrack."
1415 "The headline that should be the default location in the notes file.
1416 When filing remember notes, the cursor will start at that position.
1417 You can set this on a per-template basis with the variable
1418 `org-remember-templates'."
1423 "Templates for the creation of remember buffers.
1424 When nil, just let remember make the buffer.
1425 When not nil, this is a list of 5-element lists. In each entry, the first
1426 element is a the name of the template, It should be a single short word.
1427 The second element is a character, a unique key to select this template.
1428 The third element is the template. The forth element is optional and can
1429 specify a destination file for remember items created with this template.
1430 The default file is given by `org-default-notes-file'. An optional fifth
1431 element can specify the headline in that file that should be offered
1432 first when the user is asked to file the entry. The default headline is
1433 given in the variable `org-remember-default-headline'.
1435 The template specifies the structure of the remember buffer. It should have
1436 a first line starting with a star, to act as the org-mode headline.
1437 Furthermore, the following %-escapes will be replaced with content:
1439 %^{prompt} Prompt the user for a string and replace this sequence with it.
1440 A default value and a completion table ca be specified like this:
1441 %^{prompt|default|completion2|completion3|...}
1442 %t time stamp, date only
1443 %T time stamp with date and time
1444 %u, %U like the above, but inactive time stamps
1445 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1446 You may define a prompt like %^{Please specify birthday}t
1447 %n user name (taken from `user-full-name')
1448 %a annotation, normally the link created with org-store-link
1449 %i initial content, the region when remember is called with C-u.
1450 If %i is indented, the entire inserted text will be indented
1451 as well.
1452 %c content of the clipboard, or current kill ring head
1453 %^g prompt for tags, with completion on tags in target file
1454 %^G prompt for tags, with completion all tags in all agenda files
1455 %:keyword specific information for certain link types, see below
1456 %[pathname] insert the contents of the file given by `pathname'
1457 %(sexp) evaluate elisp `(sexp)' and replace with the result
1458 %! Store this note immediately after filling the template
1460 %? After completing the template, position cursor here.
1462 Apart from these general escapes, you can access information specific to the
1463 link type that is created. For example, calling `remember' in emails or gnus
1464 will record the author and the subject of the message, which you can access
1465 with %:author and %:subject, respectively. Here is a complete list of what
1466 is recorded for each link type.
1468 Link type | Available information
1469 -------------------+------------------------------------------------------
1470 bbdb | %:type %:name %:company
1471 vm, wl, mh, rmail | %:type %:subject %:message-id
1472 | %:from %:fromname %:fromaddress
1473 | %:to %:toname %:toaddress
1475 gnus | %:group, for messages also all email fields
1476 w3, w3m | %:type %:url
1477 info | %:type %:file %:node
1478 calendar | %:type %:date"
1501 "Non-nil means, store new notes at the beginning of a file or entry.
1502 When nil, new notes will be filed to the end of a file or entry.
1503 This can also be a list with cons cells of regular expressions that
1504 are matched against file names, and values."
1514 This is list of cons cells. Each cell contains:
1515 - a specification of the files to be considered, either a list of files,
1516 or a symbol whose function or value fields will be used to retrieve
1517 a file name or a list of file names. Nil means, refile to a different
1518 heading in the current buffer.
1519 - A specification of how to find candidate refile targets. This may be
1520 any of
1522 This tag has to be present in all target headlines, inheritance will
1523 not be considered.
1525 todo keyword.
1527 headlines that are refiling targets.
1528 - a cons cell (:level . N). Any headline of level N is considered a target.
1529 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1530 ;; FIXME: what if there are a var and func with same name???
1546 "Non-nil means, provide refile targets as paths.
1547 So a level 3 headline will be available as level1/level2/level3.
1548 When the value is `file', also include the file name (without directory)
1549 into the path. When `full-file-path', include the full file path."
1558 "Options concerning TODO items in Org-mode."
1563 "Options concerning Progress logging in Org-mode."
1568 "List of TODO entry keyword sequences and their interpretation.
1571 Each sequence starts with a symbol, either `sequence' or `type',
1572 indicating if the keywords should be interpreted as a sequence of
1573 action steps, or as different types of TODO items. The first
1574 keywords are states requiring action - these states will select a headline
1575 for inclusion into the global TODO list Org-mode produces. If one of
1578 the last keyword is treated as the only DONE state of the sequence.
1581 additional state where no keyword is present. For details about this
1582 cycling, see the manual.
1584 TODO keywords and interpretation can also be set on a per-file basis with
1585 the special #+SEQ_TODO and #+TYP_TODO lines.
1587 For backward compatibility, this variable may also be just a list
1588 of keywords - in this case the interptetation (sequence or type) will be
1589 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1626 "Controls how TODO keywords are interpreted.
1627 This variable is in principle obsolete and is only used for
1628 backward compatibility, if the interpretation of todo keywords is
1629 not given already in `org-todo-keywords'. See that variable for
1630 more information."
1637 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1638 This variable describes if and under what circumstances the cycling
1639 mechanism for TODO keywords will be replaced by a single-key, direct
1640 selection scheme.
1642 When nil, fast selection is never used.
1644 When the symbol `prefix', it will be used when `org-todo' is called with
1645 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1646 in an agenda buffer.
1648 When t, fast selection is used by default. In this case, the prefix
1649 argument forces cycling instead.
1651 In all cases, the special interface is only used if access keys have actually
1652 been assigned by the user, i.e. if keywords in the configuration are followed
1653 by a letter in parenthesis, like TODO(t)."
1661 "Hook which is run after the state of a TODO item was changed.
1662 The new state (a string with a TODO keyword, or nil) is available in the
1663 Lisp variable `state'."
1668 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1669 When the state of an entry is changed from nothing or a DONE state to
1670 a not-done TODO state, remove a previous closing date.
1672 This can also be a list of symbols indicating under which conditions
1673 the time stamp recording the action should be annotated with a short note.
1674 Valid members of this list are
1676 done Offer to record a note when marking entries done
1677 state Offer to record a note whenever changing the TODO state
1678 of an item. This is only relevant if TODO keywords are
1679 interpreted as sequence, see variable `org-todo-interpretation'.
1680 When `state' is set, this includes tracking `done'.
1681 clock-out Offer to record a note when clocking out of an item.
1683 A separate window will then pop up and allow you to type a note.
1684 After finishing with C-c C-c, the note will be added directly after the
1685 timestamp, as a plain list item. See also the variable
1686 `org-log-note-headings'.
1688 Logging can also be configured on a per-file basis by adding one of
1689 the following lines anywhere in the buffer:
1691 #+STARTUP: logdone
1692 #+STARTUP: nologging
1693 #+STARTUP: lognotedone
1694 #+STARTUP: lognotestate
1695 #+STARTUP: lognoteclock-out
1697 You can have local logging settings for a subtree by setting the LOGGING
1698 property to one or more of these keywords."
1710 "Non-nil means, the CLOSED time stamp will contain date and time.
1711 When nil, only the date will be recorded."
1719 "Headings for notes added when clocking out or closing TODO items.
1720 The value is an alist, with the car being a symbol indicating the note
1721 context, and the cdr is the heading to be used. The heading may also be the
1722 empty string.
1723 %t in the heading will be replaced by a time stamp.
1724 %s will be replaced by the new TODO state, in double quotes.
1725 %u will be replaced by the user name.
1726 %U will be replaced by the full user name."
1732 "Heading when changing todo state (todo sequence only)"
1737 "Non-nil means, the latest state change note will be directly after heading.
1738 When nil, the notes will be orderer according to time."
1744 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1745 When nil, no note will be taken.
1746 This option can also be set with on a per-file-basis with
1748 #+STARTUP: logrepeat
1749 #+STARTUP: nologrepeat
1751 You can have local logging settings for a subtree by setting the LOGGING
1752 property to one or more of these keywords."
1758 "Should clocking info be wrapped into a drawer?
1759 When t, clocking info will always be inserted into a :CLOCK: drawer.
1760 If necessary, the drawer will be created.
1761 When nil, the drawer will not be created, but used when present.
1762 When an integer and the number of clocking entries in an item
1763 reaches or exceeds this number, a drawer will be created."
1772 "When t, the clock will be stopped when the relevant entry is marked DONE.
1773 Nil means, clock will keep running until stopped explicitly with
1774 `C-c C-x C-o', or until the clock is started in a different item."
1779 "Set task to a special todo state while clocking it.
1780 The value should be the state to which the entry should be switched."
1788 "Priorities in Org-mode."
1793 "The highest priority of TODO items. A character like ?A, ?B etc.
1794 Must have a smaller ASCII number than `org-lowest-priority'."
1799 "The lowest priority of TODO items. A character like ?A, ?B etc.
1800 Must have a larger ASCII number than `org-highest-priority'."
1805 "The default priority of TODO items.
1806 This is the priority an item get if no explicit priority is given."
1811 "Non-nil means, start with default priority when starting to cycle.
1812 When this is nil, the first step in the cycle will be (depending on the
1813 command used) one higher or lower that the default priority."
1818 "Options concerning time stamps and deadlines in Org-mode."
1823 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1824 When nil, these labeled time stamps are forces into the second line of an
1825 entry, just after the headline. When scheduling from the global TODO list,
1826 the time stamp will always be forced into the second line."
1831 "Formats for `format-time-string' which are used for time stamps.
1835 "Number of minutes to round time stamps to upon insertion.
1836 When zero, insert the time unmodified. Useful rounding numbers
1837 should be factors of 60, so for example 5, 10, 15.
1838 When this is not zero, you can still force an exact time-stamp by using
1839 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1844 "Non-nil means, overlay custom formats over all time stamps.
1845 The formats are defined through the variable `org-time-stamp-custom-formats'.
1846 To turn this on on a per-file basis, insert anywhere in the file:
1847 #+STARTUP: customtime"
1855 "Custom formats for time stamps. See `format-time-string' for the syntax.
1856 These are overlayed over the default ISO format if the variable
1857 `org-display-custom-times' is set. Time like %H:%M should be at the
1858 end of the second format."
1863 "Get the right format for a time string."
1868 f)))
1871 "Non-nil means, assume future for incomplete date input from user.
1872 This affects the following situations:
1873 1. The user gives a day, but no month.
1876 it will be considered as *this* month.
1877 2. The user gives a month but not a year.
1881 When this option is nil, the current month and year will always be used
1882 as defaults."
1887 "Non-nil means, display current interpretation of date prompt live.
1888 This display will be in an overlay, in the minibuffer."
1893 "Non-nil means, pop up a calendar when prompting for a date.
1894 In the calendar, the date can be selected with mouse-1. However, the
1895 minibuffer will also be active, and you can simply enter the date as well.
1896 When nil, only the minibuffer will be available."
1904 "The hour when your day really ends.
1905 This has influence for the following applications:
1907 the time given here, the day recognized as TODAY is actually yesterday.
1908 - When a date is read from the user and it is still before the time given
1909 here, the current date and time will be assumed to be yesterday, 23:59.
1911 FIXME:
1912 IMPORTANT: This is still a very experimental feature, it may disappear
1913 again or it may be extended to mean more things."
1918 "Non-nil means, S-down will increase the time in a time stamp.
1919 When nil, S-up will increase."
1924 "Non-nil means, make the calendar window follow timestamp changes.
1925 When a timestamp is modified and the calendar window is visible, it will be
1926 moved to the new date."
1931 "When non-nil, should be a function to create `org-clock-heading'.
1932 This is the string shown in the mode line when a clock is running.
1933 The function is called with point at the beginning of the headline."
1938 "Options concerning tags in Org-mode."
1943 "List of tags allowed in Org-mode files.
1944 When this list is nil, Org-mode will base TAG input on what is already in the
1945 buffer.
1946 The value of this variable is an alist, the car of each entry must be a
1947 keyword as a string, the cdr may be a character that is used to select
1948 that tag through the fast-tag-selection interface.
1949 See the manual for details."
1959 "Non-nil means, use fast tag selection scheme.
1960 This is a special interface to select and deselect tags with single keys.
1961 When nil, fast selection is never used.
1962 When the symbol `auto', fast selection is used if and only if selection
1963 characters for tags have been configured, either through the variable
1964 `org-tag-alist' or through a #+TAGS line in the buffer.
1965 When t, fast selection is always used and selection keys are assigned
1966 automatically if necessary."
1974 "Non-nil means, fast tag selection exits after first change.
1975 When nil, you have to press RET to exit it.
1976 During fast tag selection, you can toggle this flag with `C-c'.
1977 This variable can also have the value `expert'. In this case, the window
1978 displaying the tags menu is not even shown, until you press C-c again."
1986 "Non-nil means, fast tags selection interface will also offer TODO states.
1990 "The column to which tags should be indented in a headline.
1991 If this number is positive, it specifies the column. If it is negative,
1992 it means that the tags should be flushright to that column. For example,
1993 -80 works well for a normal 80 character screen."
1998 "Non-nil means, realign tags after pro/demotion of TODO state change.
1999 These operations change the length of a headline and therefore shift
2000 the tags around. With this options turned on, after each such operation
2001 the tags are again aligned to `org-tags-column'."
2006 "Non-nil means, tags in levels apply also for sublevels.
2007 When nil, only the tags directly given in a specific line apply there.
2008 If you turn off this option, you very likely want to turn on the
2009 companion option `org-tags-match-list-sublevels'."
2014 "Non-nil means list also sublevels of headlines matching tag search.
2015 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2016 the sublevels of a headline matching a tag search often also match
2017 the same search. Listing all of them can create very long lists.
2018 Setting this variable to nil causes subtrees of a match to be skipped.
2019 This option is off by default, because inheritance in on. If you turn
2020 inheritance off, you very likely want to turn this option on.
2022 As a special case, if the tag search is restricted to TODO items, the
2023 value of this variable is ignored and sublevels are always checked, to
2024 make sure all corresponding TODO items find their way into the list."
2036 "Options concerning properties in Org-mode."
2041 "How property key/value pairs should be formatted by `indent-line'.
2042 When `indent-line' hits a property definition, it will format the line
2043 according to this format, mainly to make sure that the values are
2044 lined-up with respect to each other."
2049 "Non-nil means, properties apply also for sublevels.
2050 This setting is only relevant during property searches, not when querying
2051 an entry with `org-entry-get'. To retrieve a property with inheritance,
2052 you need to call `org-entry-get' with the inheritance flag.
2053 Turning this on can cause significant overhead when doing a search, so
2054 this is turned off by default.
2055 When nil, only the properties directly given in the current entry count.
2056 The value may also be a list of properties that shouldhave inheritance.
2058 However, note that some special properties use inheritance under special
2059 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2061 for valid values of a property."
2069 "The default column format, if no other format has been defined.
2070 This variable can be set on the per-file basis by inserting a line
2072 #+COLUMNS: %25ITEM ....."
2077 "List of property/value pairs that can be inherited by any entry.
2078 You can set buffer-local values for this by adding lines like
2080 #+PROPERTY: NAME VALUE"
2087 "List of property/value pairs that can be inherited by any entry.
2088 Valid for the current buffer.
2092 "Options concerning agenda views in Org-mode."
2097 "Variable used by org files to set a category for agenda display.
2098 Such files should use a file variable to set it, for example
2102 or contain a special line
2104 #+CATEGORY: ELisp
2106 If the file does not specify a category, then file's base name
2111 "The files to be used for agenda display.
2115 If an entry is a directory, all files in that directory that are matched by
2116 `org-agenda-file-regexp' will be part of the file list.
2118 If the value of the variable is not a list but a single file name, then
2119 the list of agenda files is actually stored and maintained in that file, one
2120 agenda file per line."
2127 "Regular expression to match files for `org-agenda-files'.
2128 If any element in the list in that variable contains a directory instead
2129 of a normal file, all files in that directory that are matched by this
2130 regular expression will be included."
2135 "t means to just skip non-reachable files in `org-agenda-files'.
2136 Nil means to remove them, after a query, from the list."
2141 "List of extra files to be searched by `org-occur-in-agenda-files'.
2142 The files in `org-agenda-files' are always searched."
2147 "When set, remote killing from the agenda buffer needs confirmation.
2148 When t, a confirmation is always needed. When a number N, confirmation is
2149 only needed when the text to be killed contains more than N non-white lines."
2157 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2158 The command `org-calendar-goto-agenda' will be bound to this key. The
2159 default is the character `c' because then `c' can be used to switch back and
2160 forth between agenda and calendar."
2165 "Non-nil means, make the block agenda more compact.
2166 This is done by leaving out unnecessary lines."
2171 "Options concerning exporting agenda views in Org-mode."
2176 "Non-nil means, use colors in agenda views."
2181 "Alist of variable/value pairs that should be active during agenda export.
2182 This is a good place to set uptions for ps-print and for htmlize."
2190 "The style specification for exported HTML Agenda files.
2191 If this variable contains a string, it will replace the default <style>
2192 section as produced by `htmlize'.
2193 Since there are different ways of setting style information, this variable
2194 needs to contain the full HTML structure to provide a style, including the
2195 surrounding HTML tags. The style specifications should include definitions
2196 the fonts used by the agenda, here is an example:
2199 p { font-weight: normal; color: gray; }
2200 .org-agenda-structure {
2201 font-size: 110%;
2202 color: #003399;
2203 font-weight: 600;
2204 }
2205 .org-todo {
2206 color: #cc6666;Week-agenda:
2207 font-weight: bold;
2208 }
2209 .org-done {
2210 color: #339933;
2211 }
2212 .title { text-align: center; }
2213 .todo, .deadline { color: red; }
2214 .done { color: green; }
2215 </style>
2217 or, if you want to keep the style in a file,
2221 As the value of this option simply gets inserted into the HTML <head> header,
2223 <style>...</style> is required, if not present the variable will be ignored."
2229 "Options concerning agenda views in Org-mode."
2234 "Custom commands for the agenda.
2235 These commands will be offered on the splash screen displayed by the
2238 (key desc type match options files)
2240 key The key (one or more characters as a string) to be associated
2241 with the command.
2242 desc A description of the commend, when omitted or nil, a default
2243 description is built using MATCH.
2244 type The command type, any of the following symbols:
2245 todo Entries with a specific TODO keyword, in all agenda files.
2246 tags Tags match in all agenda files.
2247 tags-todo Tags match in all agenda files, TODO entries only.
2248 todo-tree Sparse tree of specific TODO keyword in *current* file.
2249 tags-tree Sparse tree with all tags matches in *current* file.
2250 occur-tree Occur sparse tree for *current* file.
2251 ... A user-defined function.
2252 match What to search for:
2253 - a single keyword for TODO keyword searches
2254 - a tags match expression for tags searches
2255 - a regular expression for occur searches
2256 options A list of option settings, similar to that in a let form, so like
2257 this: ((opt1 val1) (opt2 val2) ...)
2258 files A list of files file to write the produced agenda buffer to
2259 with the command `org-store-agenda-views'.
2262 produced. Otherwide, only the plain text is written to the file.
2264 You can also define a set of commands, to create a composite agenda buffer.
2265 In this case, an entry looks like this:
2267 (key desc (cmd1 cmd2 ...) general-options file)
2269 where
2271 desc A description string to be displayed in the dispatcher menu.
2272 cmd An agenda command, similar to the above. However, tree commands
2273 are no allowed, but instead you can get agenda and global todo list.
2274 So valid commands for a set are:
2275 (agenda)
2276 (alltodo)
2277 (stuck)
2282 Each command can carry a list of options, and another set of options can be
2283 given for the whole set of commands. Individual command options take
2284 precedence over the general options.
2286 When using several characters as key to a command, the first characters
2287 are prefix commands. For the dispatcher to display useful information, you
2288 should provide a description for the prefix, like
2290 (setq org-agenda-custom-commands
2362 "How to identify stuck projects.
2363 This is a list of four items:
2364 1. A tags/todo matcher string that is used to identify a project.
2365 The entire tree below a headline matched by this is considered one project.
2366 2. A list of TODO keywords identifying non-stuck projects.
2367 If the project subtree contains any headline with one of these todo
2368 keywords, the project is considered to be not stuck. If you specify
2370 3. A list of tags identifying non-stuck projects.
2371 If the project subtree contains any headline with one of these tags,
2373 a tag, any tag will mark the project unstuck.
2374 4. An arbitrary regular expression matching non-stuck projects.
2377 or `C-c a #' to produce the list."
2381 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2387 "Options concerning skipping parts of agenda files."
2392 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2393 When nil, the sublevels of a TODO entry are not checked, resulting in
2394 potentially much shorter TODO lists."
2400 "Non-nil means, don't show entries with a date in the global todo list.
2401 You can use this if you prefer to mark mere appointments with a TODO keyword,
2402 but don't want them to show up in the TODO list.
2403 When this is set, it also covers deadlines and scheduled items, the settings
2404 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2405 will be ignored."
2411 "Non-nil means, don't show scheduled entries in the global todo list.
2412 The idea behind this is that by scheduling it, you have already taken care
2413 of this item.
2414 See also `org-agenda-todo-ignore-with-date'."
2420 "Non-nil means, don't show near deadline entries in the global todo list.
2421 Near means closer than `org-deadline-warning-days' days.
2422 The idea behind this is that such items will appear in the agenda anyway.
2423 See also `org-agenda-todo-ignore-with-date'."
2429 "Non-nil means don't show scheduled items in agenda when they are done.
2430 This is relevant for the daily/weekly agenda, not for the TODO list. And
2431 it applies only to the actual date of the scheduling. Warnings about
2432 an item with a past scheduling dates are always turned off when the item
2433 is DONE."
2438 "Non-nil means don't show deadines when the corresponding item is done.
2439 When nil, the deadline is still shown and should give you a happy feeling.
2440 This is relevant for the daily/weekly agenda. And it applied only to the
2441 actualy date of the deadline. Warnings about approching and past-due
2442 deadlines are always turned off when the item is DONE."
2447 "Non-nil means don't don't select item by timestamp or -range if it is DONE."
2452 "Non-nil means, `org-timeline' also shows dates without an entry.
2453 When nil, only the days which actually have entries are shown.
2454 When t, all days between the first and the last date are shown.
2455 When an integer, show also empty dates, but if there is a gap of more than
2456 N days, just insert a special line indicating the size of the gap."
2465 "Options concerning initial settings in the Agenda in Org Mode."
2470 "Hook run just before displaying an agenda buffer."
2475 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2476 A longer mouse click will still set point. Does not wortk on XEmacs.
2477 Needs to be set before org.el is loaded."
2482 "The initial value of follow-mode in a newly created agenda window."
2487 "Options concerning the windows used by the Agenda in Org Mode."
2492 "How the agenda buffer should be displayed.
2493 Possible values for this option are:
2495 current-window Show agenda in the current window, keeping all other windows.
2496 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2497 other-window Use `switch-to-buffer-other-window' to display agenda.
2498 reorganize-frame Show only two windows on the current frame, the current
2499 window and the agenda.
2500 See also the variable `org-agenda-restore-windows-after-quit'."
2509 "The min and max height of the agenda window as a fraction of frame height.
2510 The value of the variable is a cons cell with two numbers between 0 and 1.
2511 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2516 "Non-nil means, restore window configuration open exiting agenda.
2517 Before the window configuration is changed for displaying the agenda,
2518 the current status is recorded. When the agenda is exited with
2519 `q' or `x' and this option is set, the old state is restored. If
2520 `org-agenda-window-setup' is `other-frame', the value of this
2521 option will be ignored.."
2526 "How should indirect tree buffers be displayed?
2527 This applies to indirect buffers created with the commands
2529 Valid values are:
2530 current-window Display in the current window
2531 other-window Just display in another window.
2532 dedicated-frame Create one new frame, and re-use it each time.
2533 new-frame Make a new frame each time. Note that in this case
2534 previously-made indirect buffers are kept, and you need to
2535 kill these buffers yourself."
2545 "Options concerning the daily/weekly agenda."
2550 "Number of days to include in overview display.
2551 Should be 1 or 7."
2556 "Non-nil means, start the overview always on the specified weekday.
2557 0 denotes Sunday, 1 denotes Monday etc.
2558 When nil, always start on the current day."
2564 "Non-nil means, `org-agenda' shows every day in the selected range.
2565 When nil, only the days which actually have entries are shown."
2570 "Format string for displaying dates in the agenda.
2571 Used by the daily/weekly agenda and by the timeline. This should be
2572 a format string understood by `format-time-string', or a function returning
2573 the formatted date as a string. The function must take a single argument,
2574 a calendar-style date list like (month day year)."
2581 "Format a date string for display in the daily/weekly agenda, or timeline.
2582 This function makes sure that dates are aligned for easy reading."
2590 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2595 "Set means weekly/daily agenda will always contain all TODO entries.
2596 The TODO entries will be listed at the top of the agenda, before
2597 the entries for specific days."
2602 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2603 When nil, only one occurence is shown, either today or the
2604 nearest into the future."
2609 "No. of days before expiration during which a deadline becomes active.
2610 This variable governs the display in sparse trees and in the agenda.
2611 When negative, it means use this number (the absolute value of it)
2612 even if a deadline has a different individual lead time specified."
2618 "No. of days to continue listing scheduled items that are not marked DONE.
2619 When an item is scheduled on a date, it shows up in the agenda on this
2620 day and will be listed until it is marked done for the number of days
2621 given here."
2626 "Options concerning the time grid in the Org-mode Agenda."
2631 "Non-nil means, show a time grid in the agenda schedule.
2632 A time grid is a set of lines for specific times (like every two hours between
2633 8:00 and 20:00). The items scheduled for a day at specific times are
2634 sorted in between these lines.
2635 For details about when the grid will be shown, and what it will look like, see
2636 the variable `org-agenda-time-grid'."
2642 "----------------"
2645 "The settings for time grid for agenda display.
2646 This is a list of three items. The first item is again a list. It contains
2647 symbols specifying conditions when the grid should be displayed:
2649 daily if the agenda shows a single day
2650 weekly if the agenda shows an entire week
2651 today show grid on current date, independent of daily/weekly display
2652 require-timed show grid only if at least one item has a time specification
2654 The second item is a string which will be places behing the grid time.
2656 The third item is a list of integers, indicating the times that should have
2657 a grid line."
2659 :type
2666 require-timed)
2668 remove-match))
2673 "Options concerning sorting in the Org-mode Agenda."
2689 "Sorting structure for the agenda items of a single day.
2690 This is a list of symbols which will be used in sequence to determine
2691 if an entry should be listed before another entry. The following
2692 symbols are recognized:
2694 time-up Put entries with time-of-day indications first, early first
2695 time-down Put entries with time-of-day indications first, late first
2696 category-keep Keep the default order of categories, corresponding to the
2697 sequence in `org-agenda-files'.
2698 category-up Sort alphabetically by category, A-Z.
2699 category-down Sort alphabetically by category, Z-A.
2700 tag-up Sort alphabetically by last tag, A-Z.
2701 tag-down Sort alphabetically by last tag, Z-A.
2702 priority-up Sort numerically by priority, high priority last.
2703 priority-down Sort numerically by priority, high priority first.
2705 The different possibilities will be tried in sequence, and testing stops
2707 '(time-up category-keep priority-down)
2708 means: Pull out all entries having a specified time of day and sort them,
2709 in order to make a time schedule for the current day the first thing in the
2710 agenda listing for the day. Of the entries without a time indication, keep
2711 the grouped in categories, don't sort the categories, but keep them in
2712 the sequence given in `org-agenda-files'. Within each category sort by
2713 priority.
2715 Leaving out `category-keep' would mean that items will be sorted across
2716 categories by priority.
2718 Instead of a single list, this can also be a set of list for specific
2719 contents, with a context symbol in the car of the list, any of
2720 `agenda', `todo', `tags' for the corresponding agenda views."
2733 "Non-nil means, items without time are considered late.
2734 This is only relevant for sorting. When t, items which have no explicit
2735 time like 15:30 will be considered as 99:01, i.e. later than any items which
2736 do have a time. When nil, the default time is before 0:00. You can use this
2737 option to decide if the schedule for today should come before or after timeless
2738 agenda entries."
2743 "Options concerning the entry prefix in the Org-mode agenda display."
2752 "Format specifications for the prefix of items in the agenda views.
2753 An alist with four entries, for the different agenda types. The keys to the
2754 sublists are `agenda', `timeline', `todo', and `tags'. The values
2755 are format strings.
2756 This format works similar to a printf format, with the following meaning:
2759 as given by the CATEGORY keyword or derived from the file name.
2760 %T the *last* tag of the item. Last because inherited tags come
2761 first in the list.
2762 %t the time-of-day specification if one applies to the entry, in the
2763 format HH:MM
2764 %s Scheduling/Deadline information, a short string
2766 All specifiers work basically like the standard `%s' of printf, but may
2767 contain two additional characters: A question mark just after the `%' and
2768 a whitespace/punctuation character just before the final letter.
2770 If the first character after `%' is a question mark, the entire field
2771 will only be included if the corresponding value applies to the
2772 current entry. This is useful for fields which should have fixed
2773 width when present, but zero width when absent. For example,
2775 day is specified, but will completely disappear in entries which do
2776 not contain a time.
2778 If there is punctuation or whitespace character just before the final
2779 format letter, this character will be appended to the field value if
2782 empty, no additional colon would be interted.
2785 - Indent the line with two space characters
2786 - Give the category in a 12 chars wide field, padded with whitespace on
2787 the right (because of `-'). Append a colon if there is a category
2788 (because of `:').
2789 - If there is a time-of-day, put it into a 12 chars wide field. If no
2790 time, don't put in an empty field, just skip it (because of '?').
2791 - Finally, put the scheduling information and append a whitespace.
2793 As another example, if you don't want the time-of-day of entries in
2794 the prefix, you could use:
2798 See also the variables `org-agenda-remove-times-when-in-prefix' and
2799 `org-agenda-remove-tags'."
2810 "The compiled version of the most recently used prefix format.
2814 "Text preceeding scheduled items in the agenda view.
2815 THis is a list with two strings. The first applies when the item is
2816 scheduled on the current day. The second applies when it has been scheduled
2817 previously, it may contain a %d to capture how many days ago the item was
2818 scheduled."
2825 "Text preceeding deadline items in the agenda view.
2826 This is a list with two strings. The first applies when the item has its
2827 deadline on the current day. The second applies when it is in the past or
2828 in the future, it may contain %d to capture how many days away the deadline
2829 is (was)."
2836 "Non-nil means, remove duplicate time specifications in agenda items.
2837 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2838 time-of-day specification in a headline or diary entry is extracted and
2839 placed into the prefix. If this option is non-nil, the original specification
2840 \(a timestamp or -range, or just a plain time(range) specification like
2841 11:30-4pm) will be removed for agenda display. This makes the agenda less
2842 cluttered.
2843 The option can be t or nil. It may also be the symbol `beg', indicating
2844 that the time should only be removed what it is located at the beginning of
2845 the headline/diary entry."
2854 "Default duration for appointments that only have a starting time.
2855 When nil, no duration is specified in such cases.
2856 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2864 "Non-nil means, remove the tags from the headline copy in the agenda.
2865 When this is the symbol `prefix', only remove tags when
2866 `org-agenda-prefix-format' contains a `%T' specifier."
2878 "Shift tags in agenda items to this column.
2879 If this number is positive, it specifies the column. If it is negative,
2880 it means that the tags should be flushright to that column. For example,
2881 -80 works well for a normal 80 character screen."
2889 "Non-nil means, highlight low and high priorities in agenda.
2890 When t, the highest priority entries are bold, lowest priority italic.
2891 This may also be an association list of priority faces. The face may be
2902 "Options for embedding LaTeX code into Org-mode"
2910 "Options for creating images from LaTeX fragments.
2911 This is a property list with the following properties:
2913 `default' means use the forground of the default face.
2915 `default' means use the background of the default face.
2916 :scale a scaling factor for the size of the images
2917 :html-foreground, :html-background, :html-scale
2918 The same numbers for HTML export.
2919 :matchers a list indicating which matchers should be used to
2920 find LaTeX fragments. Valid members of this list are:
2937 "The document header used for processing LaTeX fragments."
2942 "Options for exporting org-listings."
2947 "General options for exporting Org-mode files."
2951 ;; FIXME
2956 When this option is turned on, these strings will be exported as:
2958 Org HTML LaTeX
2959 -----+----------+--------
2961 -- – --
2962 --- — ---
2963 ... … \ldots
2980 "Terms used in export text, translated to different languages.
2981 Use the variable `org-export-default-language' to set the language,
2982 or use the +OPTION lines for a per-file setting."
2992 "The default language of HTML export, as a string.
2993 This should have an association in `org-export-language-setup'."
2998 "Non-nil means, skip all text before the first headline when exporting.
2999 When nil, that text is exported as well."
3004 "The last level which is still exported as a headline.
3005 Inferior levels will produce itemize lists when exported.
3006 Note that a numeric prefix argument to an exporter function overrides
3007 this setting.
3014 "Non-nil means, add section numbers to headlines when exporting.
3021 "Non-nil means, create a table of contents in exported files.
3022 The TOC contains headlines with levels up to`org-export-headline-levels'.
3023 When an integer, include levels up to N in the toc, this may then be
3024 different from `org-export-headline-levels', but it will not be allowed
3025 to be larger than the number of headline levels.
3026 When nil, no table of contents is made.
3029 ASCII export, and with red color in HTML output, if the option
3030 `org-export-mark-todo-in-toc' is set.
3032 In HTML output, the TOC will be clickable.
3043 "Non-nil means, mark TOC lines that contain any open TODO items."
3048 "Non-nil means, preserve all line breaks when exporting.
3049 Normally, in HTML output paragraphs will be reformatted. In ASCII
3050 export, line breaks will always be preserved, regardless of this variable.
3057 "Whether subtrees with the ARCHIVE tag should be exported.
3058 This can have three different values
3059 nil Do not export, pretend this tree is not present
3060 t Do export the entire tree
3061 headline Only export the headline, but skip the tree below it."
3070 "Non-nil means, insert author name and email into the exported file.
3072 This option can also be set with the +OPTIONS line,
3078 "Non-nil means, insert a time stamp into the exported file.
3079 The time stamp shows when the file was created.
3081 This option can also be set with the +OPTIONS line,
3087 "If nil, do not export time stamps and associated keywords."
3092 "If nil, remove timestamps from the table of contents entries."
3097 "If nil, do not export tags, just remove them from headlines.
3098 If this is the symbol `not-in-toc', tags will be removed from table of
3099 contents entries, but still be shown in the headlines of the document.
3109 "Non-nil means, export with drawers like the property drawer.
3110 When t, all drawers are exported. This may also be a list of
3111 drawer names to export."
3120 "Options for translating special ascii sequences for the export backends."
3125 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3126 If the export target supports emphasizing text, the word will be
3127 typeset in bold, italic, or underlined, respectively. Works only for
3128 single words, but you can say: I *really* *mean* *this*.
3129 Not all export backends support this.
3136 "If nil, export [1] as a footnote marker.
3137 Lines starting with [1] will be formatted as footnotes.
3145 When this option is turned on, you can use TeX-like syntax for sub- and
3147 considered as a single item - so grouping with {} is normally not
3148 needed. For example, the following things will be parsed as single
3149 sub- or superscripts.
3151 10^24 or 10^tau several digits will be considered 1 item.
3152 10^-12 or 10^-tau a leading sign with digits or a word
3153 x^2-y^3 will be read as x^2 - y^3, because items are
3154 terminated by almost any nonword/nondigit char.
3155 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3157 Still, ambiguity is possible - so when in doubt use {} to enclose the
3158 sub/superscript. If you set this variable to the symbol `{}',
3159 the braces are *required* in order to trigger interpretations as
3161 frequently in plain text.
3163 Not all export backends support this, but HTML does.
3174 When this option is turned on, these strings will be exported as:
3177 -- : –
3178 --- : —
3180 Not all export backends support this, but HTML does.
3187 "Non-nil means, interpret simple TeX-like macros when exporting.
3189 No only real TeX macros will work here, but the standard HTML entities
3190 for math can be used as macro names as well. For a list of supported
3191 names in HTML export, see the constant `org-html-entities'.
3192 Not all export backends support this.
3200 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3202 the first non-white thing on a line. It will also find the math delimiters
3204 display math.
3213 This can be used to have pre-formatted text, fragments of code etc. For
3214 example:
3215 : ;; Some Lisp examples
3216 : (while (defc cnt)
3217 : (ding))
3218 will be looking just like this in also HTML. See also the QUOTE keyword.
3219 Not all export backends support this.
3226 "Number of stacked braces for sub/superscript matching.
3227 This has to be set before loading org.el to be effective."
3232 "Options for exporting tables in Org-mode."
3238 For example:
3240 | Name | Address | Birthday |
3241 |-------------+----------+-----------|
3242 | Arthur Dent | England | 29.2.2100 |
3244 Not all export backends support this.
3251 "Non-nil means, highlight the first table line.
3252 In HTML export, this means use <th> instead of <td>.
3253 In tables created with table.el, this applies to the first table line.
3254 In Org-mode tables, all lines before the first horizontal separator
3255 line will be formatted with <th> tags."
3260 "Remove special lines and marking characters in calculating tables.
3261 This removes the special marking character column from tables that are set
3262 up for spreadsheet calculations. It also removes the entire lines
3263 marked with `!', `_', or `^'. The lines with `$' are kept, because
3264 the values of constants may be useful to have."
3269 "Non-nil means, always export tables created with table.el natively.
3270 Natively means, use the HTML code generator in table.el.
3271 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3272 the table does not use row- or column-spanning). This has the
3273 advantage, that the automatic HTML conversions for math symbols and
3274 sub/superscripts can be applied. Org-mode's HTML generator is also
3275 much faster."
3280 "Options specific for ASCII export of Org-mode files."
3285 "Characters for underlining headings in ASCII export.
3286 In the given sequence, these characters will be used for level 1, 2, ..."
3291 "Bullet characters for headlines converted to lists in ASCII export.
3292 The first character is is used for the first lest level generated in this
3293 way, and so on. If there are more levels than characters given here,
3294 the list will be repeated.
3295 Note that plain lists will keep the same bullets as the have in the
3296 Org-mode file."
3301 "Options specific for XML export of Org-mode files."
3306 "Options specific for HTML export of Org-mode files."
3311 ""
3316 "The extension for exported HTML files."
3322 html {
3323 font-family: Times, serif;
3324 font-size: 12pt;
3325 }
3326 .title { text-align: center; }
3327 .todo { color: red; }
3328 .done { color: green; }
3329 .timestamp { color: grey }
3330 .timestamp-kwd { color: CadetBlue }
3331 .tag { background-color:lightblue; font-weight:normal }
3332 .target { background-color: lavender; }
3333 pre {
3334 border: 1pt solid #AEBDCC;
3335 background-color: #F3F5F7;
3336 padding: 5pt;
3337 font-family: courier, monospace;
3338 }
3339 table { border-collapse: collapse; }
3340 td, th {
3341 vertical-align: top;
3342 <!--border: 1pt solid #ADB9CC;-->
3343 }
3344 </style>"
3345 "The default style specification for exported HTML files.
3346 Since there are different ways of setting style information, this variable
3347 needs to contain the full HTML structure to provide a style, including the
3348 surrounding HTML tags. The style specifications should include definitions
3349 for new classes todo, done, title, and deadline. For example, legal values
3350 would be:
3353 p { font-weight: normal; color: gray; }
3354 h1 { color: black; }
3355 .title { text-align: center; }
3356 .todo, .deadline { color: red; }
3357 .done { color: green; }
3358 </style>
3360 or, if you want to keep the style in a file,
3364 As the value of this option simply gets inserted into the HTML <head> header,
3371 "Format for typesetting the document title in HTML export."
3376 "The <H> level for level 1 headings in HTML export."
3381 "Non-nil means, make file links to `file.org' point to `file.html'.
3382 When org-mode is exporting an org-mode file to HTML, links to
3383 non-html files are directly put into a href tag in HTML.
3384 However, links to other Org-mode files (recognized by the
3385 extension `.org.) should become links to the corresponding html
3386 file, assuming that the linked org-mode file will also be
3387 converted to HTML.
3388 When nil, the links still point to the plain `.org' file."
3393 "Non-nil means, inline images into exported HTML pages.
3394 This is done using an <img> tag. When nil, an anchor with href is used to
3395 link to the image. If this option is `maybe', then images in links with
3396 an empty description will be inlined, while images with a description will
3397 be linked only."
3403 ;; FIXME: rename
3405 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3406 When nil, these tags will be exported as plain text and therefore
3407 not be interpreted by a browser.
3415 "The HTML tag that is used to start a table.
3416 This must be a <table> tag, but you may change the options like
3417 borders and spacing."
3422 "The opening tag for table header fields.
3423 This is customizable so that alignment options can be specified."
3428 "The opening tag for table data fields.
3429 This is customizable so that alignment options can be specified."
3434 "If non-nil, write `org-export-html-html-helper-timestamp'
3435 into the exported HTML text. Otherwise, the buffer will just be saved
3436 to a file."
3442 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3447 "Options specific for iCalendar export of Org-mode files."
3452 "The file name for the iCalendar file covering all agenda files.
3454 The file name should be absolute, the file will be overwritten without warning."
3459 "Non-nil means, export to iCalendar files should also cover TODO items."
3467 "Non-nil means, export to iCalendar files should also cover sexp entries.
3468 These are entries like in the diary, but directly in an Org-mode file."
3473 "Amount of text below headline to be included in iCalendar export.
3474 This is a number of characters that should maximally be included.
3475 Properties, scheduling and clocking lines will always be removed.
3476 The text will be inserted into the DESCRIPTION field."
3484 "Calendar name for the combined iCalendar representing all agenda files."
3489 "Font-lock settings for highlighting in Org-mode."
3494 "Non-nil means fontify only the stars in each headline.
3495 When nil, the entire headline is fontified.
3496 Changing it requires restart of `font-lock-mode' to become effective
3497 also in regions already fontified."
3502 "Non-nil means, hide the first N-1 stars in a headline.
3503 This works by using the face `org-hide' for these stars. This
3504 face is white for a light background, and black for a dark
3505 background. You may have to customize the face `org-hide' to
3506 make this work.
3507 Changing it requires restart of `font-lock-mode' to become effective
3508 also in regions already fontified.
3509 You may also set this on a per-file basis by adding one of the following
3510 lines to the buffer:
3512 #+STARTUP: hidestars
3513 #+STARTUP: showstars"
3518 "Non-nil means, change the face of a headline if it is marked DONE.
3519 Normally, only the TODO/DONE keyword indicates the state of a headline.
3520 When this is non-nil, the headline after the keyword is set to the
3521 `org-headline-done' as an additional indication."
3526 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3527 Changing this variable requires a restart of Emacs to take effect."
3532 "Non-nil means, fontify what is treated specially by the exporters."
3537 "Non-nil mean font-lock should hide the emphasis marker characters."
3548 "Set variable and compute the emphasis regular expression."
3552 org-emphasis-alist org-emphasis-regexp-components)
3565 ;; make sure special characters appear at the right position in the class
3577 ;; Make the regexp
3585 body1
3597 body1
3605 "Components used to build the regular expression for emphasis.
3606 This is a list with 6 entries. Terminology: In an emphasis string
3610 specify what is allowed/forbidden in each part:
3612 pre Chars allowed as prematch. Beginning of line will be allowed too.
3613 post Chars allowed as postmatch. End of line will be allowed too.
3614 border The chars *forbidden* as border characters.
3616 non-shy groups here, and don't allow newline here.
3617 newline The maximum number of newlines allowed in an emphasis exp.
3619 Use customize to modify this, or restart Emacs after changing it."
3637 )
3638 "Special syntax for emphasized text.
3639 Text starting and ending with a special character will be emphasized, for
3640 example *bold*, _underlined_ and /italic/. This variable sets the marker
3641 characters, the face to be used by font-lock for highlighting in Org-mode
3642 Emacs buffers, and the HTML tags to be used for this.
3643 Use customize to modify this, or restart Emacs after changing it."
3656 ;;; The faces
3659 "Faces in Org-mode."
3664 "Make a compatible face specification.
3665 If INHERITS is an existing face and if the Emacs version supports it,
3666 just inherit the face. If not, use SPECS to define the face.
3667 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3668 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3669 to the top of the list. The `min-colors' attribute will be removed from
3670 any other entries, and any resulting duplicates will be removed entirely."
3674 ;; In Emacs 23, we use inheritance where possible.
3675 ;; We only do this in Emacs 23, because only there the outline
3676 ;; faces have been changed to the original org-mode-level-faces.
3679 ;; These do not understand the `min-colors' attribute.
3698 "Face used to hide leading stars in headlines.
3699 The forground color of this face should be equal to the background
3700 color of the frame."
3711 "Face used for level 1 headlines."
3721 "Face used for level 2 headlines."
3733 "Face used for level 3 headlines."
3745 "Face used for level 4 headlines."
3753 "Face used for level 5 headlines."
3761 "Face used for level 6 headlines."
3769 "Face used for level 7 headlines."
3777 "Face used for level 8 headlines."
3785 "Face used for special keywords."
3796 "Face used for drawers."
3800 "Face used for the value of a property."
3812 "Face for column display of entry properties."
3816 ;; Make sure that a fixed-width face is used when we have a column table.
3828 "Face for deadlines and TODO keywords."
3841 "Face for headline with the ARCHIVE tag."
3848 "Face for links."
3855 "Face for the ellipsis in folded text."
3862 "Face for links."
3869 "Face for links."
3876 "Face for links."
3881 "Face for tags."
3891 "Face for TODO keywords."
3900 "Face used for todo keywords that indicate DONE items."
3908 "Face used to indicate that a headline is DONE.
3909 This face is only used if `org-fontify-done-headline' is set. If applies
3910 to the part of the headline after the DONE keyword."
3914 "Faces for specific TODO keywords.
3915 This is a list of cons cells, with TODO keywords in the car
3916 and faces in the cdr. The face can be a symbol, or a property
3933 "Face used for tables."
3943 "Face for formulas."
3956 "Face for fixed-with text like code snippets."
3970 "Face for fixed-with text like code snippets."
3982 "Face used in agenda for captions and dates."
3991 "Face for items scheduled for a certain day."
4001 "Face for items scheduled previously, and not yet done."
4011 "Face for items scheduled previously, and not yet done."
4018 "Faces for showing deadlines in the agenda.
4019 This is a list of cons cells. The cdr of each cess is a face to be used,
4021 Each car is a fraction of the head-warning time that must have passed for
4022 this the face in the cdr to be used for display. The numbers must be
4023 given in descending order. The head-warning time is normally taken
4024 from `org-deadline-warning-days', but can also be specified in the deadline
4025 timestamp itself, like this:
4027 DEADLINE: <2007-08-13 Mon -8d>
4029 You may use d for days, w for weeks, m for months and y for years. Months
4030 and years will only be treated in an approximate fashion (30.4 days for a
4031 month and 365.24 days for a year)."
4039 ;; FIXME: this is not a good face yet.
4048 "Face for showing the agenda restriction lock."
4056 "Face used for time grids."
4061 org-level-5 org-level-6 org-level-7 org-level-8
4062 ))
4065 "The number different faces to be used for headlines.
4066 Org-mode defines 8 different headline faces, so this can be at most 8.
4067 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4071 ;;; Functions and variables from ther packages
4072 ;; Declared here to avoid compiler warnings
4078 ;; XEmacs only
4084 ;; Emacs only
4087 ;; Various packages
4088 ;; FIXME: get the argument lists for the UNKNOWN stuff
4144 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4145 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4174 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4185 ;; backward compatibility to old version of wl
4188 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4201 ;;; Variables for pre-computed regular expressions, all buffer local
4216 "Matches a headline and puts everything into groups:
4217 group 1: the stars
4218 group 2: The todo keyword, maybe
4219 group 3: Priority cookie
4220 group 4: True headline
4224 "Matches a headline and puts TODO state into group 2 if present.
4269 rear-nonsticky t mouse-map t fontified t)
4276 s)
4283 s)
4292 "Modified `buffer-invisibility-spec' for Emacs 21.
4293 Some ops with invisible text do not work correctly on Emacs 21. For these
4294 we turn off invisibility temporarily. Use this in a `let' form."
4298 "Make VAR local in current buffer and set it to VALUE."
4302 "Check if the current buffer is in Org-mode."
4306 "Return the last element of LIST."
4339 "Variable associated with STARTUP options for org-mode.
4340 Each element is a list of three items: The startup options as written
4341 in the #+STARTUP line, the corresponding variable, and the value to
4342 set this variable to if the option is found. An optional forth element PUSH
4346 "Precompute regular expressions for current buffer."
4361 kwds kws0 kwsa key value cat arch tags const links hw dws
4362 tail sep kws1 prio props drawers
4363 ex log)
4387 links)))
4393 props)))
4400 l var val)
4415 )))
4429 ;; Process the TODO keywords
4431 ;; Use the global values as if they had been given locally.
4442 kwsa nil
4454 kw)
4456 kws0)
4473 ;; Process the constants
4481 ;; Process the tags.
4491 tgs))
4499 ;; Compute the regular expressions and other local variables
4504 org-drawer-regexp
4508 org-not-done-keywords
4510 org-todo-regexp
4513 org-not-done-regexp
4517 org-todo-line-regexp
4521 org-complex-heading-regexp
4526 org-nl-done-regexp
4530 org-todo-line-tags-regexp
4535 org-looking-at-done-regexp
4540 org-deadline-time-regexp
4542 org-deadline-line-regexp
4544 org-scheduled-regexp
4546 org-scheduled-time-regexp
4548 org-closed-time-regexp
4550 org-keyword-time-regexp
4556 org-keyword-time-not-clock-regexp
4562 org-maybe-keyword-time-regexp
4568 org-planning-or-clock-line-re
4573 )
4581 x))
4582 list))
4584 ;; FIXME: this could be done much better, using second characters etc.
4586 "Assign fast keys to a keyword-key alist.
4587 Respect keys that are already there."
4597 ;; automatically assign a character.
4609 ;;; Some variables ujsed in various places
4614 "Function to be called when `C-c C-c' is used.
4618 ;; FIXME: Occasionally check by commenting these, to make sure
4619 ;; no other functions uses these, forgetting to let-bind them.
4626 ;; Defined somewhere in this file, but used before definition.
4639 ;;;; Emacs/XEmacs compatibility
4641 ;; Overlay compatibility functions
4659 "Make overlay OVL display TEXT with face FACE."
4669 "Make overlay OVL display TEXT with face FACE."
4692 "Find all overlays specifying PROP at POS or point.
4693 If DELETE is non-nil, delete all those overlays."
4695 ov found)
4699 found))
4701 ;; Region compatibility
4704 "Add-hook, compatible with both Emacsen."
4713 "Is `transient-mark-mode' on and the region active?
4714 Works on both Emacs and XEmacs."
4716 nil
4723 ;; Invisibility compatibility
4726 "Add elements to `buffer-invisibility-spec'.
4727 See documentation for `buffer-invisibility-spec' for the kind of elements
4728 that can be added."
4739 "Remove elements from `buffer-invisibility-spec'."
4747 "Is ARG a member of `buffer-invisibility-spec'?"
4750 nil))
4752 ;;;; Define the Org-mode
4755 (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."))
4758 ;; We use a before-change function to check if a table might need
4759 ;; an update.
4761 "Indicates that a table might need an update.
4762 This variable is set by `org-before-change-function'.
4771 ;;;###autoload
4773 "Outline-based notes management and organizer, alias
4776 Org-mode develops organizational tasks around a NOTES file which
4777 contains information about projects as plain text. Org-mode is
4778 implemented on top of outline-mode, which is ideal to keep the content
4779 of large files well structured. It supports ToDo items, deadlines and
4780 time stamps, which magically appear in the diary listing of the Emacs
4781 calendar. Tables are easily created with a built-in table editor.
4782 Plain text URL-like links connect to websites, emails (VM), Usenet
4783 messages (Gnus), BBDB entries, and any files related to the project.
4784 For printing and sharing of notes, an Org-mode file (or a part of it)
4785 can be exported as a structured ASCII or HTML file.
4787 The following commands are available:
4791 ;; Get rid of Outline menus, they are not needed
4792 ;; Need to do this here because define-derived-mode sets up
4793 ;; the keymap so late. Still, it is a waste to call this each time
4794 ;; we switch another buffer into org-mode.
4797 ;; Assume this is Greg's port, it used easymenu
4820 org-display-table 4
4823 org-ellipsis)))
4827 ;; Calc embedded
4834 ;; Activate before-change-function
4838 ;; Check for running clock before killing a buffer
4840 ;; Paragraphs and auto-filling
4845 ;; Comment characters
4846 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4849 ;; Imenu
4853 ;; Make isearch reveal context
4856 ;; Emacs 21 and XEmacs make use of the hook
4858 ;; Emacs 22 deals with this through a special variable
4862 ;; If empty file that did not turn on org-mode automatically, make it to.
4884 "Call COMMAND interactively, but pretend prefix are was ARG."
4890 ;; works also in narrowed buffer, because we start at 1, not point-min
4894 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4904 "Add text properties to entire string, from beginning to end.
4905 PLIST may be a list of properties, PROPS are individual properties and values
4906 that will be added to PLIST. Returns the string that was modified."
4909 string)
4913 ;;;; Font-Lock stuff, including the activators
4918 (org-defkey org-mouse-map
4919 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4920 (when org-mouse-1-follows-link
4921 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4922 (when org-tab-follows-link
4923 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4924 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4925 (when org-return-follows-link
4926 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4927 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
4929 (require 'font-lock)
4932 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
4933 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
4934 (defvar org-link-re-with-space nil
4935 "Matches a link with spaces, optional angular brackets around it.")
4936 (defvar org-link-re-with-space2 nil
4937 "Matches a link with spaces, optional angular brackets around it.")
4938 (defvar org-angle-link-re nil
4939 "Matches link with angular brackets, spaces are allowed.")
4940 (defvar org-plain-link-re nil
4941 "Matches plain link, without spaces.")
4942 (defvar org-bracket-link-regexp nil
4943 "Matches a link in double brackets.")
4944 (defvar org-bracket-link-analytic-regexp nil
4945 "Regular expression used to analyze links.
4946 Here is what the match groups contain after a match:
4947 1: http:
4948 2: http
4949 3: path
4950 4: [desc]
4951 5: desc")
4952 (defvar org-any-link-re nil
4953 "Regular expression matching any link.")
4955 (defun org-make-link-regexps ()
4956 "Update the link regular expressions.
4957 This should be called after the variable `org-link-types' has changed."
4958 (setq org-link-re-with-space
4959 (concat
4962 "[^" org-non-link-chars "]*"
4964 org-link-re-with-space2
4965 (concat
4970 org-angle-link-re
4971 (concat
4974 "[^" org-non-link-chars "]*"
4976 org-plain-link-re
4977 (concat
4980 org-bracket-link-regexp
4982 org-bracket-link-analytic-regexp
4983 (concat
4990 org-any-link-re
4995 (org-make-link-regexps)
4998 "Regular expression for fast time stamp matching.")
5000 "Regular expression for fast time stamp matching.")
5001 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5002 "Regular expression matching time strings for analysis.
5003 This one does not require the space after the date.")
5004 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5005 "Regular expression matching time strings for analysis.")
5007 "Regular expression matching time stamps, with groups.")
5009 "Regular expression matching time stamps (also [..]), with groups.")
5010 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5011 "Regular expression matching a time stamp range.")
5012 (defconst org-tr-regexp-both
5013 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5014 "Regular expression matching a time stamp range.")
5017 "Regular expression matching a time stamp or time stamp range.")
5020 "Regular expression matching a time stamp or time stamp range.
5021 The time stamps may be either active or inactive.")
5023 (defvar org-emph-face nil)
5025 (defun org-do-emphasis-faces (limit)
5026 "Run through the buffer and add overlays to links."
5027 (let (rtn)
5028 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5029 (if (not (= (char-after (match-beginning 3))
5030 (char-after (match-beginning 4))))
5031 (progn
5032 (setq rtn t)
5033 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5034 'face
5035 (nth 1 (assoc (match-string 3)
5036 org-emphasis-alist)))
5037 (add-text-properties (match-beginning 2) (match-end 2)
5038 '(font-lock-multiline t))
5039 (when org-hide-emphasis-markers
5040 (add-text-properties (match-end 4) (match-beginning 5)
5041 '(invisible org-link))
5042 (add-text-properties (match-beginning 3) (match-end 3)
5043 '(invisible org-link)))))
5044 (backward-char 1))
5045 rtn))
5047 (defun org-emphasize (&optional char)
5048 "Insert or change an emphasis, i.e. a font like bold or italic.
5049 If there is an active region, change that region to a new emphasis.
5050 If there is no region, just insert the marker characters and position
5051 the cursor between them.
5052 CHAR should be either the marker character, or the first character of the
5053 HTML tag associated with that emphasis. If CHAR is a space, the means
5054 to remove the emphasis of the selected region.
5055 If char is not given (for example in an interactive call) it
5056 will be prompted for."
5057 (interactive)
5058 (let ((eal org-emphasis-alist) e det
5059 (erc org-emphasis-regexp-components)
5060 (prompt "")
5061 (string "") beg end move tag c s)
5062 (if (org-region-active-p)
5063 (setq beg (region-beginning) end (region-end)
5064 string (buffer-substring beg end))
5065 (setq move t))
5067 (while (setq e (pop eal))
5068 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5069 c (aref tag 0))
5070 (push (cons c (string-to-char (car e))) det)
5071 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5072 (substring tag 1)))))
5073 (unless char
5074 (message "%s" (concat "Emphasis marker or tag:" prompt))
5075 (setq char (read-char-exclusive)))
5076 (setq char (or (cdr (assoc char det)) char))
5077 (if (equal char ?\ )
5078 (setq s "" move nil)
5079 (unless (assoc (char-to-string char) org-emphasis-alist)
5081 (setq s (char-to-string char)))
5082 (while (and (> (length string) 1)
5083 (equal (substring string 0 1) (substring string -1))
5084 (assoc (substring string 0 1) org-emphasis-alist))
5085 (setq string (substring string 1 -1)))
5086 (setq string (concat s string s))
5087 (if beg (delete-region beg end))
5088 (unless (or (bolp)
5090 (char-to-string (char-before (point)))))
5091 (insert " "))
5093 (char-to-string (char-after (point))))
5094 (insert " ") (backward-char 1))
5095 (insert string)
5096 (and move (backward-char 1))))
5098 (defconst org-nonsticky-props
5099 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5102 (defun org-activate-plain-links (limit)
5103 "Run through the buffer and add overlays to links."
5104 (catch 'exit
5105 (let (f)
5106 (while (re-search-forward org-plain-link-re limit t)
5107 (setq f (get-text-property (match-beginning 0) 'face))
5108 (if (or (eq f 'org-tag)
5109 (and (listp f) (memq 'org-tag f)))
5110 nil
5111 (add-text-properties (match-beginning 0) (match-end 0)
5112 (list 'mouse-face 'highlight
5113 'rear-nonsticky org-nonsticky-props
5114 'keymap org-mouse-map
5115 ))
5116 (throw 'exit t))))))
5118 (defun org-activate-code (limit)
5120 (unless (get-text-property (match-beginning 1) 'face)
5121 (remove-text-properties (match-beginning 0) (match-end 0)
5122 '(display t invisible t intangible t))
5123 t)))
5125 (defun org-activate-angle-links (limit)
5126 "Run through the buffer and add overlays to links."
5127 (if (re-search-forward org-angle-link-re limit t)
5128 (progn
5129 (add-text-properties (match-beginning 0) (match-end 0)
5130 (list 'mouse-face 'highlight
5131 'rear-nonsticky org-nonsticky-props
5132 'keymap org-mouse-map
5133 ))
5134 t)))
5136 (defmacro org-maybe-intangible (props)
5137 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5138 In emacs 21, invisible text is not avoided by the command loop, so the
5139 intangible property is needed to make sure point skips this text.
5140 In Emacs 22, this is not necessary. The intangible text property has
5141 led to problems with flyspell. These problems are fixed in flyspell.el,
5142 but we still avoid setting the property in Emacs 22 and later.
5143 We use a macro so that the test can happen at compilation time."
5144 (if (< emacs-major-version 22)
5145 `(append '(intangible t) ,props)
5146 props))
5148 (defun org-activate-bracket-links (limit)
5149 "Run through the buffer and add overlays to bracketed links."
5150 (if (re-search-forward org-bracket-link-regexp limit t)
5151 (let* ((help (concat "LINK: "
5152 (org-match-string-no-properties 1)))
5153 ;; FIXME: above we should remove the escapes.
5154 ;; but that requires another match, protecting match data,
5155 ;; a lot of overhead for font-lock.
5156 (ip (org-maybe-intangible
5157 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5158 'keymap org-mouse-map 'mouse-face 'highlight
5159 'font-lock-multiline t 'help-echo help)))
5160 (vp (list 'rear-nonsticky org-nonsticky-props
5161 'keymap org-mouse-map 'mouse-face 'highlight
5162 ' font-lock-multiline t 'help-echo help)))
5163 ;; We need to remove the invisible property here. Table narrowing
5164 ;; may have made some of this invisible.
5165 (remove-text-properties (match-beginning 0) (match-end 0)
5166 '(invisible nil))
5167 (if (match-end 3)
5168 (progn
5169 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5170 (add-text-properties (match-beginning 3) (match-end 3) vp)
5171 (add-text-properties (match-end 3) (match-end 0) ip))
5172 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5173 (add-text-properties (match-beginning 1) (match-end 1) vp)
5174 (add-text-properties (match-end 1) (match-end 0) ip))
5175 t)))
5177 (defun org-activate-dates (limit)
5178 "Run through the buffer and add overlays to dates."
5179 (if (re-search-forward org-tsr-regexp-both limit t)
5180 (progn
5181 (add-text-properties (match-beginning 0) (match-end 0)
5182 (list 'mouse-face 'highlight
5183 'rear-nonsticky org-nonsticky-props
5184 'keymap org-mouse-map))
5185 (when org-display-custom-times
5186 (if (match-end 3)
5187 (org-display-custom-time (match-beginning 3) (match-end 3)))
5188 (org-display-custom-time (match-beginning 1) (match-end 1)))
5189 t)))
5191 (defvar org-target-link-regexp nil
5192 "Regular expression matching radio targets in plain text.")
5194 "Regular expression matching a link target.")
5196 "Regular expression matching a radio target.")
5197 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5198 "Regular expression matching any target.")
5200 (defun org-activate-target-links (limit)
5201 "Run through the buffer and add overlays to target matches."
5202 (when org-target-link-regexp
5203 (let ((case-fold-search t))
5204 (if (re-search-forward org-target-link-regexp limit t)
5205 (progn
5206 (add-text-properties (match-beginning 0) (match-end 0)
5207 (list 'mouse-face 'highlight
5208 'rear-nonsticky org-nonsticky-props
5209 'keymap org-mouse-map
5210 'help-echo "Radio target link"
5211 'org-linked-text t))
5212 t)))))
5214 (defun org-update-radio-target-regexp ()
5215 "Find all radio targets in this file and update the regular expression."
5216 (interactive)
5217 (when (memq 'radio org-activate-links)
5218 (setq org-target-link-regexp
5219 (org-make-target-link-regexp (org-all-targets 'radio)))
5220 (org-restart-font-lock)))
5222 (defun org-hide-wide-columns (limit)
5223 (let (s e)
5224 (setq s (text-property-any (point) (or limit (point-max))
5225 'org-cwidth t))
5226 (when s
5227 (setq e (next-single-property-change s 'org-cwidth))
5228 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5229 (goto-char e)
5230 t)))
5232 (defvar org-latex-and-specials-regexp nil
5233 "Regular expression for highlighting export special stuff.")
5234 (defvar org-match-substring-regexp)
5235 (defvar org-match-substring-with-braces-regexp)
5236 (defvar org-export-html-special-string-regexps)
5238 (defun org-compute-latex-and-specials-regexp ()
5239 "Compute regular expression for stuff treated specially by exporters."
5240 (if (not org-highlight-latex-fragments-and-specials)
5241 (org-set-local 'org-latex-and-specials-regexp nil)
5242 (let*
5243 ((matchers (plist-get org-format-latex-options :matchers))
5244 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5245 org-latex-regexps)))
5246 (options (org-combine-plists (org-default-export-plist)
5247 (org-infile-export-plist)))
5248 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5249 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5250 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5251 (org-export-html-expand (plist-get options :expand-quoted-html))
5252 (org-export-with-special-strings (plist-get options :special-strings))
5253 (re-sub
5254 (cond
5255 ((equal org-export-with-sub-superscripts '{})
5256 (list org-match-substring-with-braces-regexp))
5257 (org-export-with-sub-superscripts
5258 (list org-match-substring-regexp))
5259 (t nil)))
5260 (re-latex
5261 (if org-export-with-LaTeX-fragments
5262 (mapcar (lambda (x) (nth 1 x)) latexs)))
5263 (re-macros
5264 (if org-export-with-TeX-macros
5266 (regexp-opt
5267 (append (mapcar 'car org-html-entities)
5268 (if (boundp 'org-latex-entities)
5269 org-latex-entities nil))
5270 'words))) ; FIXME
5271 ))
5273 (re-special (if org-export-with-special-strings
5274 (mapcar (lambda (x) (car x))
5275 org-export-html-special-string-regexps)))
5276 (re-rest
5277 (delq nil
5278 (list
5280 ))))
5281 (org-set-local
5282 'org-latex-and-specials-regexp
5283 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5286 (defface org-latex-and-export-specials
5287 (let ((font (cond ((assq :inherit custom-face-attributes)
5288 '(:inherit underline))
5289 (t '(:underline t)))))
5290 `((((class grayscale) (background light))
5291 (:foreground "DimGray" ,@font))
5292 (((class grayscale) (background dark))
5293 (:foreground "LightGray" ,@font))
5294 (((class color) (background light))
5295 (:foreground "SaddleBrown"))
5296 (((class color) (background dark))
5297 (:foreground "burlywood"))
5298 (t (,@font))))
5299 "Face used to highlight math latex and other special exporter stuff."
5300 :group 'org-faces)
5302 (defun org-do-latex-and-special-faces (limit)
5303 "Run through the buffer and add overlays to links."
5304 (when org-latex-and-specials-regexp
5305 (let (rtn d)
5306 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5307 limit t))
5308 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5309 'face))
5310 '(org-code org-verbatim underline)))
5311 (progn
5312 (setq rtn t
5313 d (cond ((member (char-after (1+ (match-beginning 0)))
5314 '(?_ ?^)) 1)
5315 (t 0)))
5316 (font-lock-prepend-text-property
5317 (+ d (match-beginning 0)) (match-end 0)
5318 'face 'org-latex-and-export-specials)
5319 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5320 '(font-lock-multiline t)))))
5321 rtn)))
5323 (defun org-restart-font-lock ()
5324 "Restart font-lock-mode, to force refontification."
5325 (when (and (boundp 'font-lock-mode) font-lock-mode)
5326 (font-lock-mode -1)
5327 (font-lock-mode 1)))
5329 (defun org-all-targets (&optional radio)
5330 "Return a list of all targets in this file.
5331 With optional argument RADIO, only find radio targets."
5332 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5333 rtn)
5334 (save-excursion
5335 (goto-char (point-min))
5336 (while (re-search-forward re nil t)
5337 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5338 rtn)))
5340 (defun org-make-target-link-regexp (targets)
5341 "Make regular expression matching all strings in TARGETS.
5342 The regular expression finds the targets also if there is a line break
5343 between words."
5344 (and targets
5345 (concat
5347 (mapconcat
5348 (lambda (x)
5349 (while (string-match " +" x)
5351 x)
5352 targets
5356 (defun org-activate-tags (limit)
5358 (progn
5359 (add-text-properties (match-beginning 1) (match-end 1)
5360 (list 'mouse-face 'highlight
5361 'rear-nonsticky org-nonsticky-props
5362 'keymap org-mouse-map))
5363 t)))
5365 (defun org-outline-level ()
5366 (save-excursion
5367 (looking-at outline-regexp)
5368 (if (match-beginning 1)
5369 (+ (org-get-string-indentation (match-string 1)) 1000)
5370 (1- (- (match-end 0) (match-beginning 0))))))
5372 (defvar org-font-lock-keywords nil)
5375 "Regular expression matching a property line.")
5377 (defun org-set-font-lock-defaults ()
5378 (let* ((em org-fontify-emphasized-text)
5379 (lk org-activate-links)
5380 (org-font-lock-extra-keywords
5381 (list
5382 ;; Headlines
5384 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5385 ;; Table lines
5387 (1 'org-table t))
5388 ;; Table internals
5392 ;; Drawers
5393 (list org-drawer-regexp '(0 'org-special-keyword t))
5395 ;; Properties
5396 (list org-property-re
5397 '(1 'org-special-keyword t)
5398 '(3 'org-property-value t))
5399 (if org-format-transports-properties-p
5401 ;; Links
5402 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5403 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5404 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5405 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5406 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5407 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5409 '(org-hide-wide-columns (0 nil append))
5410 ;; TODO lines
5412 '(1 (org-get-todo-face 1) t))
5413 ;; DONE
5414 (if org-fontify-done-headline
5418 '(2 'org-headline-done t))
5419 nil)
5420 ;; Priorities
5422 ;; Special keywords
5427 ;; Emphasis
5428 (if em
5429 (if (featurep 'xemacs)
5430 '(org-do-emphasis-faces (0 nil append))
5431 '(org-do-emphasis-faces)))
5432 ;; Checkboxes
5434 2 'bold prepend)
5435 (if org-provide-checkbox-statistics
5437 (0 (org-get-checkbox-statistics-face) t)))
5439 '(1 'org-archived prepend))
5440 ;; Specials
5441 '(org-do-latex-and-special-faces)
5442 ;; Code
5443 '(org-activate-code (1 'org-code t))
5444 ;; COMMENT
5447 '(1 'org-special-keyword t))
5448 '("^#.*" (0 'font-lock-comment-face t))
5449 )))
5450 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5451 ;; Now set the full font-lock-keywords
5452 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5453 (org-set-local 'font-lock-defaults
5454 '(org-font-lock-keywords t nil nil backward-paragraph))
5455 (kill-local-variable 'font-lock-keywords) nil))
5457 (defvar org-m nil)
5458 (defvar org-l nil)
5459 (defvar org-f nil)
5460 (defun org-get-level-face (n)
5461 "Get the right face for match N in font-lock matching of healdines."
5462 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5463 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5464 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5465 (cond
5466 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5467 ((eq n 2) org-f)
5468 (t (if org-level-color-stars-only nil org-f))))
5470 (defun org-get-todo-face (kwd)
5471 "Get the right face for a TODO keyword KWD.
5472 If KWD is a number, get the corresponding match group."
5473 (if (numberp kwd) (setq kwd (match-string kwd)))
5474 (or (cdr (assoc kwd org-todo-keyword-faces))
5475 (and (member kwd org-done-keywords) 'org-done)
5476 'org-todo))
5478 (defun org-unfontify-region (beg end &optional maybe_loudly)
5479 "Remove fontification and activation overlays from links."
5480 (font-lock-default-unfontify-region beg end)
5481 (let* ((buffer-undo-list t)
5482 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5483 (inhibit-modification-hooks t)
5484 deactivate-mark buffer-file-name buffer-file-truename)
5485 (remove-text-properties beg end
5486 '(mouse-face t keymap t org-linked-text t
5487 invisible t intangible t))))
5489 ;;;; Visibility cycling, including org-goto and indirect buffer
5491 ;;; Cycling
5493 (defvar org-cycle-global-status nil)
5494 (make-variable-buffer-local 'org-cycle-global-status)
5495 (defvar org-cycle-subtree-status nil)
5496 (make-variable-buffer-local 'org-cycle-subtree-status)
5498 ;;;###autoload
5499 (defun org-cycle (&optional arg)
5500 "Visibility cycling for Org-mode.
5502 - When this function is called with a prefix argument, rotate the entire
5503 buffer through 3 states (global cycling)
5504 1. OVERVIEW: Show only top-level headlines.
5505 2. CONTENTS: Show all headlines of all levels, but no body text.
5506 3. SHOW ALL: Show everything.
5508 - When point is at the beginning of a headline, rotate the subtree started
5509 by this line through 3 different states (local cycling)
5510 1. FOLDED: Only the main headline is shown.
5511 2. CHILDREN: The main headline and the direct children are shown.
5512 From this state, you can move to one of the children
5513 and zoom in further.
5514 3. SUBTREE: Show the entire subtree, including body text.
5516 - When there is a numeric prefix, go up to a heading with level ARG, do
5517 a `show-subtree' and return to the previous cursor position. If ARG
5518 is negative, go up that many levels.
5520 - When point is not at the beginning of a headline, execute
5521 `indent-relative', like TAB normally does. See the option
5522 `org-cycle-emulate-tab' for details.
5524 - Special case: if point is at the beginning of the buffer and there is
5525 no headline in line 1, this function will act as if called with prefix arg.
5526 But only if also the variable `org-cycle-global-at-bob' is t."
5527 (interactive "P")
5528 (let* ((outline-regexp
5529 (if (and (org-mode-p) org-cycle-include-plain-lists)
5531 outline-regexp))
5532 (bob-special (and org-cycle-global-at-bob (bobp)
5533 (not (looking-at outline-regexp))))
5534 (org-cycle-hook
5535 (if bob-special
5536 (delq 'org-optimize-window-after-visibility-change
5537 (copy-sequence org-cycle-hook))
5538 org-cycle-hook))
5539 (pos (point)))
5541 (if (or bob-special (equal arg '(4)))
5542 ;; special case: use global cycling
5543 (setq arg t))
5545 (cond
5547 ((org-at-table-p 'any)
5548 ;; Enter the table or move to the next field in the table
5549 (or (org-table-recognize-table.el)
5550 (progn
5551 (if arg (org-table-edit-field t)
5552 (org-table-justify-field-maybe)
5553 (call-interactively 'org-table-next-field)))))
5555 ((eq arg t) ;; Global cycling
5557 (cond
5558 ((and (eq last-command this-command)
5559 (eq org-cycle-global-status 'overview))
5560 ;; We just created the overview - now do table of contents
5561 ;; This can be slow in very large buffers, so indicate action
5562 (message "CONTENTS...")
5563 (org-content)
5564 (message "CONTENTS...done")
5565 (setq org-cycle-global-status 'contents)
5566 (run-hook-with-args 'org-cycle-hook 'contents))
5568 ((and (eq last-command this-command)
5569 (eq org-cycle-global-status 'contents))
5570 ;; We just showed the table of contents - now show everything
5571 (show-all)
5572 (message "SHOW ALL")
5573 (setq org-cycle-global-status 'all)
5574 (run-hook-with-args 'org-cycle-hook 'all))
5576 (t
5577 ;; Default action: go to overview
5578 (org-overview)
5579 (message "OVERVIEW")
5580 (setq org-cycle-global-status 'overview)
5581 (run-hook-with-args 'org-cycle-hook 'overview))))
5583 ((and org-drawers org-drawer-regexp
5584 (save-excursion
5585 (beginning-of-line 1)
5586 (looking-at org-drawer-regexp)))
5587 ;; Toggle block visibility
5588 (org-flag-drawer
5589 (not (get-char-property (match-end 0) 'invisible))))
5591 ((integerp arg)
5592 ;; Show-subtree, ARG levels up from here.
5593 (save-excursion
5594 (org-back-to-heading)
5595 (outline-up-heading (if (< arg 0) (- arg)
5596 (- (funcall outline-level) arg)))
5597 (org-show-subtree)))
5599 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5600 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5601 ;; At a heading: rotate between three different views
5602 (org-back-to-heading)
5603 (let ((goal-column 0) eoh eol eos)
5604 ;; First, some boundaries
5605 (save-excursion
5606 (org-back-to-heading)
5607 (save-excursion
5608 (beginning-of-line 2)
5609 (while (and (not (eobp)) ;; this is like `next-line'
5610 (get-char-property (1- (point)) 'invisible))
5611 (beginning-of-line 2)) (setq eol (point)))
5612 (outline-end-of-heading) (setq eoh (point))
5613 (org-end-of-subtree t)
5614 (unless (eobp)
5616 (beginning-of-line 1) ; in case this is an item
5617 )
5618 (setq eos (1- (point))))
5619 ;; Find out what to do next and set `this-command'
5620 (cond
5621 ((= eos eoh)
5622 ;; Nothing is hidden behind this heading
5623 (message "EMPTY ENTRY")
5624 (setq org-cycle-subtree-status nil)
5625 (save-excursion
5626 (goto-char eos)
5627 (outline-next-heading)
5628 (if (org-invisible-p) (org-flag-heading nil))))
5629 ((or (>= eol eos)
5631 ;; Entire subtree is hidden in one line: open it
5632 (org-show-entry)
5633 (show-children)
5634 (message "CHILDREN")
5635 (save-excursion
5636 (goto-char eos)
5637 (outline-next-heading)
5638 (if (org-invisible-p) (org-flag-heading nil)))
5639 (setq org-cycle-subtree-status 'children)
5640 (run-hook-with-args 'org-cycle-hook 'children))
5641 ((and (eq last-command this-command)
5642 (eq org-cycle-subtree-status 'children))
5643 ;; We just showed the children, now show everything.
5644 (org-show-subtree)
5645 (message "SUBTREE")
5646 (setq org-cycle-subtree-status 'subtree)
5647 (run-hook-with-args 'org-cycle-hook 'subtree))
5648 (t
5649 ;; Default action: hide the subtree.
5650 (hide-subtree)
5651 (message "FOLDED")
5652 (setq org-cycle-subtree-status 'folded)
5653 (run-hook-with-args 'org-cycle-hook 'folded)))))
5655 ;; TAB emulation
5656 (buffer-read-only (org-back-to-heading))
5658 ((org-try-cdlatex-tab))
5660 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5661 (or (not (bolp))
5662 (not (looking-at outline-regexp))))
5665 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5667 (or (and (eq org-cycle-emulate-tab 'white)
5668 (= (match-end 0) (point-at-eol)))
5669 (and (eq org-cycle-emulate-tab 'whitestart)
5670 (>= (match-end 0) pos))))
5671 t
5672 (eq org-cycle-emulate-tab t))
5675 ; (point-at-bol) (point))))
5676 ; (progn
5677 ; (beginning-of-line 1)
5681 (t (save-excursion
5682 (org-back-to-heading)
5683 (org-cycle))))))
5685 ;;;###autoload
5686 (defun org-global-cycle (&optional arg)
5687 "Cycle the global visibility. For details see `org-cycle'."
5688 (interactive "P")
5689 (let ((org-cycle-include-plain-lists
5690 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5691 (if (integerp arg)
5692 (progn
5693 (show-all)
5694 (hide-sublevels arg)
5695 (setq org-cycle-global-status 'contents))
5696 (org-cycle '(4)))))
5698 (defun org-overview ()
5699 "Switch to overview mode, shoing only top-level headlines.
5700 Really, this shows all headlines with level equal or greater than the level
5701 of the first headline in the buffer. This is important, because if the
5702 first headline is not level one, then (hide-sublevels 1) gives confusing
5703 results."
5704 (interactive)
5705 (let ((level (save-excursion
5706 (goto-char (point-min))
5707 (if (re-search-forward (concat "^" outline-regexp) nil t)
5708 (progn
5709 (goto-char (match-beginning 0))
5710 (funcall outline-level))))))
5711 (and level (hide-sublevels level))))
5713 (defun org-content (&optional arg)
5714 "Show all headlines in the buffer, like a table of contents.
5715 With numerical argument N, show content up to level N."
5716 (interactive "P")
5717 (save-excursion
5718 ;; Visit all headings and show their offspring
5719 (and (integerp arg) (org-overview))
5720 (goto-char (point-max))
5721 (catch 'exit
5722 (while (and (progn (condition-case nil
5723 (outline-previous-visible-heading 1)
5724 (error (goto-char (point-min))))
5725 t)
5726 (looking-at outline-regexp))
5727 (if (integerp arg)
5728 (show-children (1- arg))
5729 (show-branches))
5730 (if (bobp) (throw 'exit nil))))))
5733 (defun org-optimize-window-after-visibility-change (state)
5734 "Adjust the window after a change in outline visibility.
5735 This function is the default value of the hook `org-cycle-hook'."
5736 (when (get-buffer-window (current-buffer))
5737 (cond
5738 ; ((eq state 'overview) (org-first-headline-recenter 1))
5739 ; ((eq state 'overview) (org-beginning-of-line))
5740 ((eq state 'content) nil)
5741 ((eq state 'all) nil)
5742 ((eq state 'folded) nil)
5743 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5744 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5746 (defun org-compact-display-after-subtree-move ()
5747 (let (beg end)
5748 (save-excursion
5749 (if (org-up-heading-safe)
5750 (progn
5751 (hide-subtree)
5752 (show-entry)
5753 (show-children)
5754 (org-cycle-show-empty-lines 'children)
5755 (org-cycle-hide-drawers 'children))
5756 (org-overview)))))
5758 (defun org-cycle-show-empty-lines (state)
5759 "Show empty lines above all visible headlines.
5760 The region to be covered depends on STATE when called through
5761 `org-cycle-hook'. Lisp program can use t for STATE to get the
5762 entire buffer covered. Note that an empty line is only shown if there
5763 are at least `org-cycle-separator-lines' empty lines before the headeline."
5764 (when (> org-cycle-separator-lines 0)
5765 (save-excursion
5766 (let* ((n org-cycle-separator-lines)
5767 (re (cond
5770 (t (let ((ns (number-to-string (- n 2))))
5773 beg end)
5774 (cond
5775 ((memq state '(overview contents t))
5776 (setq beg (point-min) end (point-max)))
5777 ((memq state '(children folded))
5778 (setq beg (point) end (progn (org-end-of-subtree t t)
5779 (beginning-of-line 2)
5780 (point)))))
5781 (when beg
5782 (goto-char beg)
5783 (while (re-search-forward re end t)
5784 (if (not (get-char-property (match-end 1) 'invisible))
5785 (outline-flag-region
5786 (match-beginning 1) (match-end 1) nil)))))))
5787 ;; Never hide empty lines at the end of the file.
5788 (save-excursion
5789 (goto-char (point-max))
5790 (outline-previous-heading)
5791 (outline-end-of-heading)
5793 (= (match-end 0) (point-max)))
5794 (outline-flag-region (point) (match-end 0) nil))))
5796 (defun org-subtree-end-visible-p ()
5797 "Is the end of the current subtree visible?"
5798 (pos-visible-in-window-p
5799 (save-excursion (org-end-of-subtree t) (point))))
5801 (defun org-first-headline-recenter (&optional N)
5802 "Move cursor to the first headline and recenter the headline.
5803 Optional argument N means, put the headline into the Nth line of the window."
5804 (goto-char (point-min))
5806 (beginning-of-line)
5807 (recenter (prefix-numeric-value N))))
5809 ;;; Org-goto
5811 (defvar org-goto-window-configuration nil)
5812 (defvar org-goto-marker nil)
5813 (defvar org-goto-map
5814 (let ((map (make-sparse-keymap)))
5815 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5816 (while (setq cmd (pop cmds))
5817 (substitute-key-definition cmd cmd map global-map)))
5818 (suppress-keymap map)
5819 (org-defkey map "\C-m" 'org-goto-ret)
5820 (org-defkey map [(left)] 'org-goto-left)
5821 (org-defkey map [(right)] 'org-goto-right)
5822 (org-defkey map [(?q)] 'org-goto-quit)
5823 (org-defkey map [(control ?g)] 'org-goto-quit)
5824 (org-defkey map "\C-i" 'org-cycle)
5825 (org-defkey map [(tab)] 'org-cycle)
5826 (org-defkey map [(down)] 'outline-next-visible-heading)
5827 (org-defkey map [(up)] 'outline-previous-visible-heading)
5828 (org-defkey map "n" 'outline-next-visible-heading)
5829 (org-defkey map "p" 'outline-previous-visible-heading)
5830 (org-defkey map "f" 'outline-forward-same-level)
5831 (org-defkey map "b" 'outline-backward-same-level)
5832 (org-defkey map "u" 'outline-up-heading)
5833 (org-defkey map "/" 'org-occur)
5834 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5835 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5836 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5837 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5838 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5839 map))
5841 (defconst org-goto-help
5842 "Browse copy of buffer to find location or copy text.
5843 RET=jump to location [Q]uit and return to previous location
5844 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur"
5845 )
5847 (defvar org-goto-start-pos) ; dynamically scoped parameter
5849 (defun org-goto ()
5850 "Look up a different location in the current file, keeping current visibility.
5852 When you want look-up or go to a different location in a document, the
5853 fastest way is often to fold the entire buffer and then dive into the tree.
5854 This method has the disadvantage, that the previous location will be folded,
5855 which may not be what you want.
5857 This command works around this by showing a copy of the current buffer
5858 in an indirect buffer, in overview mode. You can dive into the tree in
5859 that copy, use org-occur and incremental search to find a location.
5860 When pressing RET or `Q', the command returns to the original buffer in
5861 which the visibility is still unchanged. After RET is will also jump to
5862 the location selected in the indirect buffer and expose the
5863 the headline hierarchy above."
5864 (interactive)
5865 (let* ((org-goto-start-pos (point))
5866 (selected-point
5867 (car (org-get-location (current-buffer) org-goto-help))))
5868 (if selected-point
5869 (progn
5870 (org-mark-ring-push org-goto-start-pos)
5871 (goto-char selected-point)
5872 (if (or (org-invisible-p) (org-invisible-p2))
5873 (org-show-context 'org-goto)))
5874 (message "Quit"))))
5876 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5877 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5879 (defun org-get-location (buf help)
5880 "Let the user select a location in the Org-mode buffer BUF.
5881 This function uses a recursive edit. It returns the selected position
5882 or nil."
5883 (let (org-goto-selected-point org-goto-exit-command)
5884 (save-excursion
5885 (save-window-excursion
5886 (delete-other-windows)
5887 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5888 (switch-to-buffer
5889 (condition-case nil
5890 (make-indirect-buffer (current-buffer) "*org-goto*")
5891 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5892 (with-output-to-temp-buffer "*Help*"
5893 (princ help))
5894 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5895 (setq buffer-read-only nil)
5896 (let ((org-startup-truncated t)
5897 (org-startup-folded nil)
5898 (org-startup-align-all-tables nil))
5899 (org-mode)
5900 (org-overview))
5901 (setq buffer-read-only t)
5902 (if (and (boundp 'org-goto-start-pos)
5903 (integer-or-marker-p org-goto-start-pos))
5904 (let ((org-show-hierarchy-above t)
5905 (org-show-siblings t)
5906 (org-show-following-heading t))
5907 (goto-char org-goto-start-pos)
5908 (and (org-invisible-p) (org-show-context)))
5909 (goto-char (point-min)))
5910 (org-beginning-of-line)
5911 (message "Select location and press RET")
5912 ;; now we make sure that during selection, ony very few keys work
5913 ;; and that it is impossible to switch to another window.
5914 ; (let ((gm (current-global-map))
5915 ; (overriding-local-map org-goto-map))
5916 ; (unwind-protect
5917 ; (progn
5918 ; (use-global-map org-goto-map)
5919 ; (recursive-edit))
5920 ; (use-global-map gm)))
5921 (use-local-map org-goto-map)
5922 (recursive-edit)
5923 ))
5924 (kill-buffer "*org-goto*")
5925 (cons org-goto-selected-point org-goto-exit-command)))
5927 (defun org-goto-ret (&optional arg)
5928 "Finish `org-goto' by going to the new location."
5929 (interactive "P")
5930 (setq org-goto-selected-point (point)
5931 org-goto-exit-command 'return)
5932 (throw 'exit nil))
5934 (defun org-goto-left ()
5935 "Finish `org-goto' by going to the new location."
5936 (interactive)
5937 (if (org-on-heading-p)
5938 (progn
5939 (beginning-of-line 1)
5940 (setq org-goto-selected-point (point)
5941 org-goto-exit-command 'left)
5942 (throw 'exit nil))
5943 (error "Not on a heading")))
5945 (defun org-goto-right ()
5946 "Finish `org-goto' by going to the new location."
5947 (interactive)
5948 (if (org-on-heading-p)
5949 (progn
5950 (setq org-goto-selected-point (point)
5951 org-goto-exit-command 'right)
5952 (throw 'exit nil))
5953 (error "Not on a heading")))
5955 (defun org-goto-quit ()
5956 "Finish `org-goto' without cursor motion."
5957 (interactive)
5958 (setq org-goto-selected-point nil)
5959 (setq org-goto-exit-command 'quit)
5960 (throw 'exit nil))
5962 ;;; Indirect buffer display of subtrees
5964 (defvar org-indirect-dedicated-frame nil
5965 "This is the frame being used for indirect tree display.")
5966 (defvar org-last-indirect-buffer nil)
5968 (defun org-tree-to-indirect-buffer (&optional arg)
5969 "Create indirect buffer and narrow it to current subtree.
5970 With numerical prefix ARG, go up to this level and then take that tree.
5971 If ARG is negative, go up that many levels.
5972 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5973 indirect buffer previously made with this command, to avoid proliferation of
5974 indirect buffers. However, when you call the command with a `C-u' prefix, or
5975 when `org-indirect-buffer-display' is `new-frame', the last buffer
5976 is kept so that you can work with several indirect buffers at the same time.
5977 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5978 requests that a new frame be made for the new buffer, so that the dedicated
5979 frame is not changed."
5980 (interactive "P")
5981 (let ((cbuf (current-buffer))
5982 (cwin (selected-window))
5983 (pos (point))
5984 beg end level heading ibuf)
5985 (save-excursion
5986 (org-back-to-heading t)
5987 (when (numberp arg)
5988 (setq level (org-outline-level))
5989 (if (< arg 0) (setq arg (+ level arg)))
5990 (while (> (setq level (org-outline-level)) arg)
5991 (outline-up-heading 1 t)))
5992 (setq beg (point)
5993 heading (org-get-heading))
5994 (org-end-of-subtree t) (setq end (point)))
5995 (if (and (buffer-live-p org-last-indirect-buffer)
5996 (not (eq org-indirect-buffer-display 'new-frame))
5997 (not arg))
5998 (kill-buffer org-last-indirect-buffer))
5999 (setq ibuf (org-get-indirect-buffer cbuf)
6000 org-last-indirect-buffer ibuf)
6001 (cond
6002 ((or (eq org-indirect-buffer-display 'new-frame)
6003 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6004 (select-frame (make-frame))
6005 (delete-other-windows)
6006 (switch-to-buffer ibuf)
6007 (org-set-frame-title heading))
6008 ((eq org-indirect-buffer-display 'dedicated-frame)
6009 (raise-frame
6010 (select-frame (or (and org-indirect-dedicated-frame
6011 (frame-live-p org-indirect-dedicated-frame)
6012 org-indirect-dedicated-frame)
6013 (setq org-indirect-dedicated-frame (make-frame)))))
6014 (delete-other-windows)
6015 (switch-to-buffer ibuf)
6016 (org-set-frame-title (concat "Indirect: " heading)))
6017 ((eq org-indirect-buffer-display 'current-window)
6018 (switch-to-buffer ibuf))
6019 ((eq org-indirect-buffer-display 'other-window)
6020 (pop-to-buffer ibuf))
6021 (t (error "Invalid value.")))
6022 (if (featurep 'xemacs)
6023 (save-excursion (org-mode) (turn-on-font-lock)))
6024 (narrow-to-region beg end)
6025 (show-all)
6026 (goto-char pos)
6027 (and (window-live-p cwin) (select-window cwin))))
6029 (defun org-get-indirect-buffer (&optional buffer)
6030 (setq buffer (or buffer (current-buffer)))
6031 (let ((n 1) (base (buffer-name buffer)) bname)
6032 (while (buffer-live-p
6033 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6034 (setq n (1+ n)))
6035 (condition-case nil
6036 (make-indirect-buffer buffer bname 'clone)
6037 (error (make-indirect-buffer buffer bname)))))
6039 (defun org-set-frame-title (title)
6040 "Set the title of the current frame to the string TITLE."
6041 ;; FIXME: how to name a single frame in XEmacs???
6042 (unless (featurep 'xemacs)
6043 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6045 ;;;; Structure editing
6047 ;;; Inserting headlines
6049 (defun org-insert-heading (&optional force-heading)
6050 "Insert a new heading or item with same depth at point.
6051 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6052 If point is at the beginning of a headline, insert a sibling before the
6053 current headline. If point is in the middle of a headline, split the headline
6054 at that position and make the rest of the headline part of the sibling below
6055 the current headline."
6056 (interactive "P")
6057 (if (= (buffer-size) 0)
6059 (when (or force-heading (not (org-insert-item)))
6060 (let* ((head (save-excursion
6061 (condition-case nil
6062 (progn
6063 (org-back-to-heading)
6064 (match-string 0))
6065 (error "*"))))
6066 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6067 pos)
6068 (cond
6069 ((and (org-on-heading-p) (bolp)
6070 (or (bobp)
6071 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6072 (open-line (if blank 2 1)))
6073 ((and (bolp)
6074 (or (bobp)
6075 (save-excursion
6076 (backward-char 1) (not (org-invisible-p)))))
6077 nil)
6078 (t (newline (if blank 2 1))))
6079 (insert head) (just-one-space)
6080 (setq pos (point))
6081 (end-of-line 1)
6082 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6083 (run-hooks 'org-insert-heading-hook)))))
6085 (defun org-insert-heading-after-current ()
6086 "Insert a new heading with same level as current, after current subtree."
6087 (interactive)
6088 (org-back-to-heading)
6089 (org-insert-heading)
6090 (org-move-subtree-down)
6091 (end-of-line 1))
6093 (defun org-insert-todo-heading (arg)
6094 "Insert a new heading with the same level and TODO state as current heading.
6095 If the heading has no TODO state, or if the state is DONE, use the first
6096 state (TODO by default). Also with prefix arg, force first state."
6097 (interactive "P")
6098 (when (not (org-insert-item 'checkbox))
6099 (org-insert-heading)
6100 (save-excursion
6101 (org-back-to-heading)
6102 (outline-previous-heading)
6103 (looking-at org-todo-line-regexp))
6104 (if (or arg
6105 (not (match-beginning 2))
6106 (member (match-string 2) org-done-keywords))
6107 (insert (car org-todo-keywords-1) " ")
6108 (insert (match-string 2) " "))))
6110 (defun org-insert-subheading (arg)
6111 "Insert a new subheading and demote it.
6112 Works for outline headings and for plain lists alike."
6113 (interactive "P")
6114 (org-insert-heading arg)
6115 (cond
6116 ((org-on-heading-p) (org-do-demote))
6117 ((org-at-item-p) (org-indent-item 1))))
6119 (defun org-insert-todo-subheading (arg)
6120 "Insert a new subheading with TODO keyword or checkbox and demote it.
6121 Works for outline headings and for plain lists alike."
6122 (interactive "P")
6123 (org-insert-todo-heading arg)
6124 (cond
6125 ((org-on-heading-p) (org-do-demote))
6126 ((org-at-item-p) (org-indent-item 1))))
6128 ;;; Promotion and Demotion
6130 (defun org-promote-subtree ()
6131 "Promote the entire subtree.
6132 See also `org-promote'."
6133 (interactive)
6134 (save-excursion
6135 (org-map-tree 'org-promote))
6136 (org-fix-position-after-promote))
6138 (defun org-demote-subtree ()
6139 "Demote the entire subtree. See `org-demote'.
6140 See also `org-promote'."
6141 (interactive)
6142 (save-excursion
6143 (org-map-tree 'org-demote))
6144 (org-fix-position-after-promote))
6147 (defun org-do-promote ()
6148 "Promote the current heading higher up the tree.
6149 If the region is active in `transient-mark-mode', promote all headings
6150 in the region."
6151 (interactive)
6152 (save-excursion
6153 (if (org-region-active-p)
6154 (org-map-region 'org-promote (region-beginning) (region-end))
6155 (org-promote)))
6156 (org-fix-position-after-promote))
6158 (defun org-do-demote ()
6159 "Demote the current heading lower down the tree.
6160 If the region is active in `transient-mark-mode', demote all headings
6161 in the region."
6162 (interactive)
6163 (save-excursion
6164 (if (org-region-active-p)
6165 (org-map-region 'org-demote (region-beginning) (region-end))
6166 (org-demote)))
6167 (org-fix-position-after-promote))
6169 (defun org-fix-position-after-promote ()
6170 "Make sure that after pro/demotion cursor position is right."
6171 (let ((pos (point)))
6172 (when (save-excursion
6173 (beginning-of-line 1)
6174 (looking-at org-todo-line-regexp)
6175 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6176 (cond ((eobp) (insert " "))
6177 ((eolp) (insert " "))
6178 ((equal (char-after) ?\ ) (forward-char 1))))))
6180 (defun org-reduced-level (l)
6181 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6183 (defun org-get-legal-level (level &optional change)
6184 "Rectify a level change under the influence of `org-odd-levels-only'
6185 LEVEL is a current level, CHANGE is by how much the level should be
6186 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6187 even level numbers will become the next higher odd number."
6188 (if org-odd-levels-only
6189 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6190 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6191 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6192 (max 1 (+ level change))))
6194 (defun org-promote ()
6195 "Promote the current heading higher up the tree.
6196 If the region is active in `transient-mark-mode', promote all headings
6197 in the region."
6198 (org-back-to-heading t)
6199 (let* ((level (save-match-data (funcall outline-level)))
6200 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6201 (diff (abs (- level (length up-head) -1))))
6202 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6203 (replace-match up-head nil t)
6204 ;; Fixup tag positioning
6205 (and org-auto-align-tags (org-set-tags nil t))
6206 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6208 (defun org-demote ()
6209 "Demote the current heading lower down the tree.
6210 If the region is active in `transient-mark-mode', demote all headings
6211 in the region."
6212 (org-back-to-heading t)
6213 (let* ((level (save-match-data (funcall outline-level)))
6214 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6215 (diff (abs (- level (length down-head) -1))))
6216 (replace-match down-head nil t)
6217 ;; Fixup tag positioning
6218 (and org-auto-align-tags (org-set-tags nil t))
6219 (if org-adapt-indentation (org-fixup-indentation diff))))
6221 (defun org-map-tree (fun)
6222 "Call FUN for every heading underneath the current one."
6223 (org-back-to-heading)
6224 (let ((level (funcall outline-level)))
6225 (save-excursion
6226 (funcall fun)
6227 (while (and (progn
6228 (outline-next-heading)
6229 (> (funcall outline-level) level))
6230 (not (eobp)))
6231 (funcall fun)))))
6233 (defun org-map-region (fun beg end)
6234 "Call FUN for every heading between BEG and END."
6235 (let ((org-ignore-region t))
6236 (save-excursion
6237 (setq end (copy-marker end))
6238 (goto-char beg)
6239 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6240 (< (point) end))
6241 (funcall fun))
6242 (while (and (progn
6243 (outline-next-heading)
6244 (< (point) end))
6245 (not (eobp)))
6246 (funcall fun)))))
6248 (defun org-fixup-indentation (diff)
6249 "Change the indentation in the current entry by DIFF
6250 However, if any line in the current entry has no indentation, or if it
6251 would end up with no indentation after the change, nothing at all is done."
6252 (save-excursion
6253 (let ((end (save-excursion (outline-next-heading)
6254 (point-marker)))
6255 (prohibit (if (> diff 0)
6258 col)
6259 (unless (save-excursion (end-of-line 1)
6260 (re-search-forward prohibit end t))
6261 (while (and (< (point) end)
6263 (goto-char (match-end 0))
6264 (setq col (current-column))
6265 (if (< diff 0) (replace-match ""))
6266 (indent-to (+ diff col))))
6267 (move-marker end nil))))
6269 (defun org-convert-to-odd-levels ()
6270 "Convert an org-mode file with all levels allowed to one with odd levels.
6271 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6272 level 5 etc."
6273 (interactive)
6274 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6275 (let ((org-odd-levels-only nil) n)
6276 (save-excursion
6277 (goto-char (point-min))
6279 (setq n (- (length (match-string 0)) 2))
6280 (while (>= (setq n (1- n)) 0)
6281 (org-demote))
6282 (end-of-line 1))))))
6285 (defun org-convert-to-oddeven-levels ()
6286 "Convert an org-mode file with only odd levels to one with odd and even levels.
6287 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6288 section with an even level, conversion would destroy the structure of the file. An error
6289 is signaled in this case."
6290 (interactive)
6291 (goto-char (point-min))
6292 ;; First check if there are no even levels
6294 (org-show-context t)
6295 (error "Not all levels are odd in this file. Conversion not possible."))
6296 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6297 (let ((org-odd-levels-only nil) n)
6298 (save-excursion
6299 (goto-char (point-min))
6301 (setq n (/ (1- (length (match-string 0))) 2))
6302 (while (>= (setq n (1- n)) 0)
6303 (org-promote))
6304 (end-of-line 1))))))
6306 (defun org-tr-level (n)
6307 "Make N odd if required."
6308 (if org-odd-levels-only (1+ (/ n 2)) n))
6310 ;;; Vertical tree motion, cutting and pasting of subtrees
6312 (defun org-move-subtree-up (&optional arg)
6313 "Move the current subtree up past ARG headlines of the same level."
6314 (interactive "p")
6315 (org-move-subtree-down (- (prefix-numeric-value arg))))
6317 (defun org-move-subtree-down (&optional arg)
6318 "Move the current subtree down past ARG headlines of the same level."
6319 (interactive "p")
6320 (setq arg (prefix-numeric-value arg))
6321 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6322 'outline-get-last-sibling))
6323 (ins-point (make-marker))
6324 (cnt (abs arg))
6325 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6326 ;; Select the tree
6327 (org-back-to-heading)
6328 (setq beg0 (point))
6329 (save-excursion
6330 (setq ne-beg (org-back-over-empty-lines))
6331 (setq beg (point)))
6332 (save-match-data
6333 (save-excursion (outline-end-of-heading)
6334 (setq folded (org-invisible-p)))
6335 (outline-end-of-subtree))
6336 (outline-next-heading)
6337 (setq ne-end (org-back-over-empty-lines))
6338 (setq end (point))
6339 (goto-char beg0)
6340 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6341 ;; include less whitespace
6342 (save-excursion
6343 (goto-char beg)
6344 (forward-line (- ne-beg ne-end))
6345 (setq beg (point))))
6346 ;; Find insertion point, with error handling
6347 (while (> cnt 0)
6348 (or (and (funcall movfunc) (looking-at outline-regexp))
6349 (progn (goto-char beg0)
6350 (error "Cannot move past superior level or buffer limit")))
6351 (setq cnt (1- cnt)))
6352 (if (> arg 0)
6353 ;; Moving forward - still need to move over subtree
6354 (progn (org-end-of-subtree t t)
6355 (save-excursion
6356 (org-back-over-empty-lines)
6357 (or (bolp) (newline)))))
6358 (setq ne-ins (org-back-over-empty-lines))
6359 (move-marker ins-point (point))
6360 (setq txt (buffer-substring beg end))
6361 (delete-region beg end)
6362 (outline-flag-region (1- beg) beg nil)
6363 (outline-flag-region (1- (point)) (point) nil)
6364 (insert txt)
6366 (setq ins-end (point))
6367 (goto-char ins-point)
6368 (org-skip-whitespace)
6369 (when (and (< arg 0)
6370 (org-first-sibling-p)
6371 (> ne-ins ne-beg))
6372 ;; Move whitespace back to beginning
6373 (save-excursion
6374 (goto-char ins-end)
6375 (let ((kill-whole-line t))
6376 (kill-line (- ne-ins ne-beg)) (point)))
6378 (move-marker ins-point nil)
6379 (org-compact-display-after-subtree-move)
6380 (unless folded
6381 (org-show-entry)
6382 (show-children)
6383 (org-cycle-hide-drawers 'children))))
6385 (defvar org-subtree-clip ""
6386 "Clipboard for cut and paste of subtrees.
6387 This is actually only a copy of the kill, because we use the normal kill
6388 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6390 (defvar org-subtree-clip-folded nil
6391 "Was the last copied subtree folded?
6392 This is used to fold the tree back after pasting.")
6394 (defun org-cut-subtree (&optional n)
6395 "Cut the current subtree into the clipboard.
6396 With prefix arg N, cut this many sequential subtrees.
6397 This is a short-hand for marking the subtree and then cutting it."
6398 (interactive "p")
6399 (org-copy-subtree n 'cut))
6401 (defun org-copy-subtree (&optional n cut)
6402 "Cut the current subtree into the clipboard.
6403 With prefix arg N, cut this many sequential subtrees.
6404 This is a short-hand for marking the subtree and then copying it.
6405 If CUT is non-nil, actually cut the subtree."
6406 (interactive "p")
6407 (let (beg end folded (beg0 (point)))
6408 (if (interactive-p)
6409 (org-back-to-heading nil) ; take what looks like a subtree
6410 (org-back-to-heading t)) ; take what is really there
6411 (org-back-over-empty-lines)
6412 (setq beg (point))
6414 (save-match-data
6415 (save-excursion (outline-end-of-heading)
6416 (setq folded (org-invisible-p)))
6417 (condition-case nil
6418 (outline-forward-same-level (1- n))
6419 (error nil))
6420 (org-end-of-subtree t t))
6421 (org-back-over-empty-lines)
6422 (setq end (point))
6423 (goto-char beg0)
6424 (when (> end beg)
6425 (setq org-subtree-clip-folded folded)
6426 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6427 (setq org-subtree-clip (current-kill 0))
6428 (message "%s: Subtree(s) with %d characters"
6429 (if cut "Cut" "Copied")
6430 (length org-subtree-clip)))))
6432 (defun org-paste-subtree (&optional level tree)
6433 "Paste the clipboard as a subtree, with modification of headline level.
6434 The entire subtree is promoted or demoted in order to match a new headline
6435 level. By default, the new level is derived from the visible headings
6436 before and after the insertion point, and taken to be the inferior headline
6437 level of the two. So if the previous visible heading is level 3 and the
6438 next is level 4 (or vice versa), level 4 will be used for insertion.
6439 This makes sure that the subtree remains an independent subtree and does
6440 not swallow low level entries.
6442 You can also force a different level, either by using a numeric prefix
6443 argument, or by inserting the heading marker by hand. For example, if the
6448 If optional TREE is given, use this text instead of the kill ring."
6449 (interactive "P")
6450 (unless (org-kill-is-subtree-p tree)
6451 (error "%s"
6452 (substitute-command-keys
6454 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6459 (old-level (if (string-match ^re txt)
6460 (- (match-end 0) (match-beginning 0) 1)
6461 -1))
6462 (force-level (cond (level (prefix-numeric-value level))
6463 ((string-match
6464 ^re_ (buffer-substring (point-at-bol) (point)))
6465 (- (match-end 1) (match-beginning 1)))
6466 (t nil)))
6467 (previous-level (save-excursion
6468 (condition-case nil
6469 (progn
6470 (outline-previous-visible-heading 1)
6471 (if (looking-at re)
6472 (- (match-end 0) (match-beginning 0) 1)
6473 1))
6474 (error 1))))
6475 (next-level (save-excursion
6476 (condition-case nil
6477 (progn
6478 (or (looking-at outline-regexp)
6479 (outline-next-visible-heading 1))
6480 (if (looking-at re)
6481 (- (match-end 0) (match-beginning 0) 1)
6482 1))
6483 (error 1))))
6484 (new-level (or force-level (max previous-level next-level)))
6485 (shift (if (or (= old-level -1)
6486 (= new-level -1)
6487 (= old-level new-level))
6488 0
6489 (- new-level old-level)))
6490 (delta (if (> shift 0) -1 1))
6491 (func (if (> shift 0) 'org-demote 'org-promote))
6492 (org-odd-levels-only nil)
6493 beg end)
6494 ;; Remove the forced level indicator
6495 (if force-level
6496 (delete-region (point-at-bol) (point)))
6497 ;; Paste
6498 (beginning-of-line 1)
6499 (org-back-over-empty-lines) ;; FIXME: correct fix????
6500 (setq beg (point))
6501 (insert-before-markers txt) ;; FIXME: correct fix????
6503 (setq end (point))
6504 (goto-char beg)
6506 (setq beg (point))
6507 ;; Shift if necessary
6508 (unless (= shift 0)
6509 (save-restriction
6510 (narrow-to-region beg end)
6511 (while (not (= shift 0))
6512 (org-map-region func (point-min) (point-max))
6513 (setq shift (+ delta shift)))
6514 (goto-char (point-min))))
6515 (when (interactive-p)
6516 (message "Clipboard pasted as level %d subtree" new-level))
6517 (if (and kill-ring
6518 (eq org-subtree-clip (current-kill 0))
6519 org-subtree-clip-folded)
6520 ;; The tree was folded before it was killed/copied
6521 (hide-subtree))))
6523 (defun org-kill-is-subtree-p (&optional txt)
6524 "Check if the current kill is an outline subtree, or a set of trees.
6525 Returns nil if kill does not start with a headline, or if the first
6526 headline level is not the largest headline level in the tree.
6527 So this will actually accept several entries of equal levels as well,
6528 which is OK for `org-paste-subtree'.
6529 If optional TXT is given, check this string instead of the current kill."
6530 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6531 (start-level (and kill
6534 kill)
6535 (- (match-end 2) (match-beginning 2) 1)))
6536 (re (concat "^" org-outline-regexp))
6537 (start (1+ (match-beginning 2))))
6538 (if (not start-level)
6539 (progn
6540 nil) ;; does not even start with a heading
6541 (catch 'exit
6542 (while (setq start (string-match re kill (1+ start)))
6543 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6544 (throw 'exit nil)))
6545 t))))
6547 (defun org-narrow-to-subtree ()
6548 "Narrow buffer to the current subtree."
6549 (interactive)
6550 (save-excursion
6551 (narrow-to-region
6552 (progn (org-back-to-heading) (point))
6553 (progn (org-end-of-subtree t t) (point)))))
6556 ;;; Outline Sorting
6558 (defun org-sort (with-case)
6559 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6560 Optional argument WITH-CASE means sort case-sensitively."
6561 (interactive "P")
6562 (if (org-at-table-p)
6563 (org-call-with-arg 'org-table-sort-lines with-case)
6564 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6566 (defvar org-priority-regexp) ; defined later in the file
6568 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6569 "Sort entries on a certain level of an outline tree.
6570 If there is an active region, the entries in the region are sorted.
6571 Else, if the cursor is before the first entry, sort the top-level items.
6572 Else, the children of the entry at point are sorted.
6574 Sorting can be alphabetically, numerically, and by date/time as given by
6575 the first time stamp in the entry. The command prompts for the sorting
6576 type unless it has been given to the function through the SORTING-TYPE
6577 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6578 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6579 called with point at the beginning of the record. It must return either
6580 a string or a number that should serve as the sorting key for that record.
6582 Comparing entries ignores case by default. However, with an optional argument
6583 WITH-CASE, the sorting considers case as well."
6584 (interactive "P")
6585 (let ((case-func (if with-case 'identity 'downcase))
6586 start beg end stars re re2
6587 txt what tmp plain-list-p)
6588 ;; Find beginning and end of region to sort
6589 (cond
6590 ((org-region-active-p)
6591 ;; we will sort the region
6592 (setq end (region-end)
6593 what "region")
6594 (goto-char (region-beginning))
6595 (if (not (org-on-heading-p)) (outline-next-heading))
6596 (setq start (point)))
6597 ((org-at-item-p)
6598 ;; we will sort this plain list
6599 (org-beginning-of-item-list) (setq start (point))
6600 (org-end-of-item-list) (setq end (point))
6601 (goto-char start)
6602 (setq plain-list-p t
6603 what "plain list"))
6604 ((or (org-on-heading-p)
6605 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6606 ;; we will sort the children of the current headline
6607 (org-back-to-heading)
6608 (setq start (point)
6609 end (progn (org-end-of-subtree t t)
6610 (org-back-over-empty-lines)
6611 (point))
6612 what "children")
6613 (goto-char start)
6614 (show-subtree)
6615 (outline-next-heading))
6616 (t
6617 ;; we will sort the top-level entries in this file
6618 (goto-char (point-min))
6619 (or (org-on-heading-p) (outline-next-heading))
6620 (setq start (point) end (point-max) what "top-level")
6621 (goto-char start)
6622 (show-all)))
6624 (setq beg (point))
6625 (if (>= beg end) (error "Nothing to sort"))
6627 (unless plain-list-p
6629 (setq stars (match-string 1)
6630 re (concat "^" (regexp-quote stars) " +")
6631 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6632 txt (buffer-substring beg end))
6634 (if (and (not (equal stars "*")) (string-match re2 txt))
6635 (error "Region to sort contains a level above the first entry")))
6637 (unless sorting-type
6638 (message
6639 (if plain-list-p
6640 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6641 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6642 what)
6643 (setq sorting-type (read-char-exclusive))
6645 (and (= (downcase sorting-type) ?f)
6646 (setq getkey-func
6647 (completing-read "Sort using function: "
6648 obarray 'fboundp t nil nil))
6649 (setq getkey-func (intern getkey-func)))
6651 (and (= (downcase sorting-type) ?r)
6652 (setq property
6653 (completing-read "Property: "
6654 (mapcar 'list (org-buffer-property-keys t))
6655 nil t))))
6657 (message "Sorting entries...")
6659 (save-restriction
6660 (narrow-to-region start end)
6662 (let ((dcst (downcase sorting-type))
6663 (now (current-time)))
6664 (sort-subr
6665 (/= dcst sorting-type)
6666 ;; This function moves to the beginning character of the "record" to
6667 ;; be sorted.
6668 (if plain-list-p
6669 (lambda nil
6670 (if (org-at-item-p) t (goto-char (point-max))))
6671 (lambda nil
6672 (if (re-search-forward re nil t)
6673 (goto-char (match-beginning 0))
6674 (goto-char (point-max)))))
6675 ;; This function moves to the last character of the "record" being
6676 ;; sorted.
6677 (if plain-list-p
6678 'org-end-of-item
6679 (lambda nil
6680 (save-match-data
6681 (condition-case nil
6682 (outline-forward-same-level 1)
6683 (error
6684 (goto-char (point-max)))))))
6686 ;; This function returns the value that gets sorted against.
6687 (if plain-list-p
6688 (lambda nil
6690 (cond
6691 ((= dcst ?n)
6692 (string-to-number (buffer-substring (match-end 0)
6693 (point-at-eol))))
6694 ((= dcst ?a)
6695 (buffer-substring (match-end 0) (point-at-eol)))
6696 ((= dcst ?t)
6697 (if (re-search-forward org-ts-regexp
6698 (point-at-eol) t)
6699 (org-time-string-to-time (match-string 0))
6700 now))
6701 ((= dcst ?f)
6702 (if getkey-func
6703 (progn
6704 (setq tmp (funcall getkey-func))
6705 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6706 tmp)
6707 (error "Invalid key function `%s'" getkey-func)))
6708 (t (error "Invalid sorting type `%c'" sorting-type)))))
6709 (lambda nil
6710 (cond
6711 ((= dcst ?n)
6712 (if (looking-at outline-regexp)
6713 (string-to-number (buffer-substring (match-end 0)
6714 (point-at-eol)))
6715 nil))
6716 ((= dcst ?a)
6717 (funcall case-func (buffer-substring (point-at-bol)
6718 (point-at-eol))))
6719 ((= dcst ?t)
6720 (if (re-search-forward org-ts-regexp
6721 (save-excursion
6722 (forward-line 2)
6723 (point)) t)
6724 (org-time-string-to-time (match-string 0))
6725 now))
6726 ((= dcst ?p)
6727 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6728 (string-to-char (match-string 2))
6729 org-default-priority))
6730 ((= dcst ?r)
6731 (or (org-entry-get nil property) ""))
6732 ((= dcst ?f)
6733 (if getkey-func
6734 (progn
6735 (setq tmp (funcall getkey-func))
6736 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6737 tmp)
6738 (error "Invalid key function `%s'" getkey-func)))
6739 (t (error "Invalid sorting type `%c'" sorting-type)))))
6740 nil
6741 (cond
6742 ((= dcst ?a) 'string<)
6743 ((= dcst ?t) 'time-less-p)
6744 (t nil)))))
6745 (message "Sorting entries...done")))
6747 (defun org-do-sort (table what &optional with-case sorting-type)
6748 "Sort TABLE of WHAT according to SORTING-TYPE.
6749 The user will be prompted for the SORTING-TYPE if the call to this
6750 function does not specify it. WHAT is only for the prompt, to indicate
6751 what is being sorted. The sorting key will be extracted from
6752 the car of the elements of the table.
6753 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6754 (unless sorting-type
6755 (message
6756 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6757 what)
6758 (setq sorting-type (read-char-exclusive)))
6759 (let ((dcst (downcase sorting-type))
6760 extractfun comparefun)
6761 ;; Define the appropriate functions
6762 (cond
6763 ((= dcst ?n)
6764 (setq extractfun 'string-to-number
6765 comparefun (if (= dcst sorting-type) '< '>)))
6766 ((= dcst ?a)
6767 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6768 (lambda(x) (downcase (org-sort-remove-invisible x))))
6769 comparefun (if (= dcst sorting-type)
6770 'string<
6771 (lambda (a b) (and (not (string< a b))
6772 (not (string= a b)))))))
6773 ((= dcst ?t)
6774 (setq extractfun
6775 (lambda (x)
6776 (if (string-match org-ts-regexp x)
6777 (time-to-seconds
6778 (org-time-string-to-time (match-string 0 x)))
6779 0))
6780 comparefun (if (= dcst sorting-type) '< '>)))
6781 (t (error "Invalid sorting type `%c'" sorting-type)))
6783 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6784 table)
6785 (lambda (a b) (funcall comparefun (car a) (car b))))))
6787 ;;;; Plain list items, including checkboxes
6789 ;;; Plain list items
6791 (defun org-at-item-p ()
6792 "Is point in a line starting a hand-formatted item?"
6793 (let ((llt org-plain-list-ordered-item-terminator))
6794 (save-excursion
6795 (goto-char (point-at-bol))
6796 (looking-at
6797 (cond
6801 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6803 (defun org-in-item-p ()
6804 "It the cursor inside a plain list item.
6805 Does not have to be the first line."
6806 (save-excursion
6807 (condition-case nil
6808 (progn
6809 (org-beginning-of-item)
6810 (org-at-item-p)
6811 t)
6812 (error nil))))
6814 (defun org-insert-item (&optional checkbox)
6815 "Insert a new item at the current level.
6816 Return t when things worked, nil when we are not in an item."
6817 (when (save-excursion
6818 (condition-case nil
6819 (progn
6820 (org-beginning-of-item)
6821 (org-at-item-p)
6822 (if (org-invisible-p) (error "Invisible item"))
6823 t)
6824 (error nil)))
6825 (let* ((bul (match-string 0))
6827 (match-end 0)))
6828 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6829 pos)
6830 (cond
6831 ((and (org-at-item-p) (<= (point) eow))
6832 ;; before the bullet
6833 (beginning-of-line 1)
6834 (open-line (if blank 2 1)))
6835 ((<= (point) eow)
6836 (beginning-of-line 1))
6837 (t (newline (if blank 2 1))))
6838 (insert bul (if checkbox "[ ]" ""))
6839 (just-one-space)
6840 (setq pos (point))
6841 (end-of-line 1)
6842 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6843 (org-maybe-renumber-ordered-list)
6844 (and checkbox (org-update-checkbox-count-maybe))
6845 t))
6847 ;;; Checkboxes
6849 (defun org-at-item-checkbox-p ()
6850 "Is point at a line starting a plain-list item with a checklet?"
6851 (and (org-at-item-p)
6852 (save-excursion
6853 (goto-char (match-end 0))
6857 (defun org-toggle-checkbox (&optional arg)
6858 "Toggle the checkbox in the current line."
6859 (interactive "P")
6860 (catch 'exit
6861 (let (beg end status (firstnew 'unknown))
6862 (cond
6863 ((org-region-active-p)
6864 (setq beg (region-beginning) end (region-end)))
6865 ((org-on-heading-p)
6866 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6867 ((org-at-item-checkbox-p)
6868 (let ((pos (point)))
6869 (replace-match
6870 (cond (arg "[-]")
6871 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6872 (t "[ ]"))
6873 t t)
6874 (goto-char pos))
6875 (throw 'exit t))
6876 (t (error "Not at a checkbox or heading, and no active region")))
6877 (save-excursion
6878 (goto-char beg)
6879 (while (< (point) end)
6880 (when (org-at-item-checkbox-p)
6881 (setq status (equal (match-string 0) "[X]"))
6882 (when (eq firstnew 'unknown)
6883 (setq firstnew (not status)))
6884 (replace-match
6885 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6886 (beginning-of-line 2)))))
6887 (org-update-checkbox-count-maybe))
6889 (defun org-update-checkbox-count-maybe ()
6890 "Update checkbox statistics unless turned off by user."
6891 (when org-provide-checkbox-statistics
6892 (org-update-checkbox-count)))
6894 (defun org-update-checkbox-count (&optional all)
6895 "Update the checkbox statistics in the current section.
6896 This will find all statistic cookies like [57%] and [6/12] and update them
6897 with the current numbers. With optional prefix argument ALL, do this for
6898 the whole buffer."
6899 (interactive "P")
6900 (save-excursion
6901 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
6902 (beg (condition-case nil
6903 (progn (outline-back-to-heading) (point))
6904 (error (point-min))))
6905 (end (move-marker (make-marker)
6906 (progn (outline-next-heading) (point))))
6909 b1 e1 f1 c-on c-off lim (cstat 0))
6910 (when all
6911 (goto-char (point-min))
6912 (outline-next-heading)
6913 (setq beg (point) end (point-max)))
6914 (goto-char beg)
6915 (while (re-search-forward re end t)
6916 (setq cstat (1+ cstat)
6917 b1 (match-beginning 0)
6918 e1 (match-end 0)
6919 f1 (match-beginning 1)
6920 lim (cond
6921 ((org-on-heading-p) (outline-next-heading) (point))
6922 ((org-at-item-p) (org-end-of-item) (point))
6923 (t nil))
6924 c-on 0 c-off 0)
6925 (goto-char e1)
6926 (when lim
6927 (while (re-search-forward re-box lim t)
6928 (if (member (match-string 2) '("[ ]" "[-]"))
6929 (setq c-off (1+ c-off))
6930 (setq c-on (1+ c-on))))
6931 ; (delete-region b1 e1)
6932 (goto-char b1)
6933 (insert (if f1
6934 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
6935 (format "[%d/%d]" c-on (+ c-on c-off))))
6937 (replace-match ""))))
6938 (when (interactive-p)
6939 (message "Checkbox satistics updated %s (%d places)"
6940 (if all "in entire file" "in current outline entry") cstat)))))
6942 (defun org-get-checkbox-statistics-face ()
6943 "Select the face for checkbox statistics.
6944 The face will be `org-done' when all relevant boxes are checked. Otherwise
6945 it will be `org-todo'."
6946 (if (match-end 1)
6947 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
6948 (if (and (> (match-end 2) (match-beginning 2))
6949 (equal (match-string 2) (match-string 3)))
6950 'org-done
6951 'org-todo)))
6953 (defun org-get-indentation (&optional line)
6954 "Get the indentation of the current line, interpreting tabs.
6955 When LINE is given, assume it represents a line and compute its indentation."
6956 (if line
6957 (if (string-match "^ *" (org-remove-tabs line))
6958 (match-end 0))
6959 (save-excursion
6960 (beginning-of-line 1)
6962 (current-column))))
6964 (defun org-remove-tabs (s &optional width)
6965 "Replace tabulators in S with spaces.
6966 Assumes that s is a single line, starting in column 0."
6967 (setq width (or width tab-width))
6969 (setq s (replace-match
6970 (make-string
6971 (- (* width (/ (+ (match-beginning 0) width) width))
6972 (match-beginning 0)) ?\ )
6973 t t s)))
6974 s)
6976 (defun org-fix-indentation (line ind)
6977 "Fix indentation in LINE.
6978 IND is a cons cell with target and minimum indentation.
6979 If the current indenation in LINE is smaller than the minimum,
6980 leave it alone. If it is larger than ind, set it to the target."
6981 (let* ((l (org-remove-tabs line))
6982 (i (org-get-indentation l))
6983 (i1 (car ind)) (i2 (cdr ind)))
6984 (if (>= i i2) (setq l (substring line i2)))
6985 (if (> i1 0)
6986 (concat (make-string i1 ?\ ) l)
6987 l)))
6989 (defcustom org-empty-line-terminates-plain-lists nil
6990 "Non-nil means, an empty line ends all plain list levels.
6991 When nil, empty lines are part of the preceeding item."
6992 :group 'org-plain-lists
6993 :type 'boolean)
6995 (defun org-beginning-of-item ()
6996 "Go to the beginning of the current hand-formatted item.
6997 If the cursor is not in an item, throw an error."
6998 (interactive)
6999 (let ((pos (point))
7000 (limit (save-excursion
7001 (condition-case nil
7002 (progn
7003 (org-back-to-heading)
7004 (beginning-of-line 2) (point))
7005 (error (point-min)))))
7006 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7007 ind ind1)
7008 (if (org-at-item-p)
7009 (beginning-of-line 1)
7010 (beginning-of-line 1)
7012 (setq ind (current-column))
7013 (if (catch 'exit
7014 (while t
7015 (beginning-of-line 0)
7016 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7019 (setq ind1 ind-empty)
7021 (setq ind1 (current-column)))
7022 (if (< ind1 ind)
7023 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7024 nil
7025 (goto-char pos)
7026 (error "Not in an item")))))
7028 (defun org-end-of-item ()
7029 "Go to the end of the current hand-formatted item.
7030 If the cursor is not in an item, throw an error."
7031 (interactive)
7032 (let* ((pos (point))
7033 ind1
7034 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7035 (limit (save-excursion (outline-next-heading) (point)))
7036 (ind (save-excursion
7037 (org-beginning-of-item)
7039 (current-column)))
7040 (end (catch 'exit
7041 (while t
7042 (beginning-of-line 2)
7043 (if (eobp) (throw 'exit (point)))
7044 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7046 (setq ind1 ind-empty)
7048 (setq ind1 (current-column)))
7049 (if (<= ind1 ind)
7050 (throw 'exit (point-at-bol)))))))
7051 (if end
7052 (goto-char end)
7053 (goto-char pos)
7054 (error "Not in an item"))))
7056 (defun org-next-item ()
7057 "Move to the beginning of the next item in the current plain list.
7058 Error if not at a plain list, or if this is the last item in the list."
7059 (interactive)
7060 (let (ind ind1 (pos (point)))
7061 (org-beginning-of-item)
7062 (setq ind (org-get-indentation))
7063 (org-end-of-item)
7064 (setq ind1 (org-get-indentation))
7065 (unless (and (org-at-item-p) (= ind ind1))
7066 (goto-char pos)
7067 (error "On last item"))))
7069 (defun org-previous-item ()
7070 "Move to the beginning of the previous item in the current plain list.
7071 Error if not at a plain list, or if this is the first item in the list."
7072 (interactive)
7073 (let (beg ind ind1 (pos (point)))
7074 (org-beginning-of-item)
7075 (setq beg (point))
7076 (setq ind (org-get-indentation))
7077 (goto-char beg)
7078 (catch 'exit
7079 (while t
7080 (beginning-of-line 0)
7082 nil
7083 (if (<= (setq ind1 (org-get-indentation)) ind)
7084 (throw 'exit t)))))
7085 (condition-case nil
7086 (if (or (not (org-at-item-p))
7087 (< ind1 (1- ind)))
7088 (error "")
7089 (org-beginning-of-item))
7090 (error (goto-char pos)
7091 (error "On first item")))))
7093 (defun org-first-list-item-p ()
7094 "Is this heading the item in a plain list?"
7095 (unless (org-at-item-p)
7096 (error "Not at a plain list item"))
7097 (org-beginning-of-item)
7098 (= (point) (save-excursion (org-beginning-of-item-list))))
7100 (defun org-move-item-down ()
7101 "Move the plain list item at point down, i.e. swap with following item.
7102 Subitems (items with larger indentation) are considered part of the item,
7103 so this really moves item trees."
7104 (interactive)
7105 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7106 (org-beginning-of-item)
7107 (setq beg0 (point))
7108 (save-excursion
7109 (setq ne-beg (org-back-over-empty-lines))
7110 (setq beg (point)))
7111 (goto-char beg0)
7112 (setq ind (org-get-indentation))
7113 (org-end-of-item)
7114 (setq end0 (point))
7115 (setq ind1 (org-get-indentation))
7116 (setq ne-end (org-back-over-empty-lines))
7117 (setq end (point))
7118 (goto-char beg0)
7119 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7120 ;; include less whitespace
7121 (save-excursion
7122 (goto-char beg)
7123 (forward-line (- ne-beg ne-end))
7124 (setq beg (point))))
7125 (goto-char end0)
7126 (if (and (org-at-item-p) (= ind ind1))
7127 (progn
7128 (org-end-of-item)
7129 (org-back-over-empty-lines)
7130 (setq txt (buffer-substring beg end))
7131 (save-excursion
7132 (delete-region beg end))
7133 (setq pos (point))
7134 (insert txt)
7135 (goto-char pos) (org-skip-whitespace)
7136 (org-maybe-renumber-ordered-list))
7137 (goto-char pos)
7138 (error "Cannot move this item further down"))))
7140 (defun org-move-item-up (arg)
7141 "Move the plain list item at point up, i.e. swap with previous item.
7142 Subitems (items with larger indentation) are considered part of the item,
7143 so this really moves item trees."
7144 (interactive "p")
7145 (let (beg beg0 end end0 ind ind1 (pos (point)) txt
7146 ne-beg ne-end ne-ins ins-end)
7147 (org-beginning-of-item)
7148 (setq beg0 (point))
7149 (setq ind (org-get-indentation))
7150 (save-excursion
7151 (setq ne-beg (org-back-over-empty-lines))
7152 (setq beg (point)))
7153 (goto-char beg0)
7154 (org-end-of-item)
7155 (setq ne-end (org-back-over-empty-lines))
7156 (setq end (point))
7157 (goto-char beg0)
7158 (catch 'exit
7159 (while t
7160 (beginning-of-line 0)
7162 (if org-empty-line-terminates-plain-lists
7163 (progn
7164 (goto-char pos)
7165 (error "Cannot move this item further up"))
7166 nil)
7167 (if (<= (setq ind1 (org-get-indentation)) ind)
7168 (throw 'exit t)))))
7169 (condition-case nil
7170 (org-beginning-of-item)
7171 (error (goto-char beg)
7172 (error "Cannot move this item further up")))
7173 (setq ind1 (org-get-indentation))
7174 (if (and (org-at-item-p) (= ind ind1))
7175 (progn
7176 (setq ne-ins (org-back-over-empty-lines))
7177 (setq txt (buffer-substring beg end))
7178 (save-excursion
7179 (delete-region beg end))
7180 (setq pos (point))
7181 (insert txt)
7182 (setq ins-end (point))
7183 (goto-char pos) (org-skip-whitespace)
7185 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7186 ;; Move whitespace back to beginning
7187 (save-excursion
7188 (goto-char ins-end)
7189 (let ((kill-whole-line t))
7190 (kill-line (- ne-ins ne-beg)) (point)))
7193 (org-maybe-renumber-ordered-list))
7194 (goto-char pos)
7195 (error "Cannot move this item further up"))))
7197 (defun org-maybe-renumber-ordered-list ()
7198 "Renumber the ordered list at point if setup allows it.
7199 This tests the user option `org-auto-renumber-ordered-lists' before
7200 doing the renumbering."
7201 (interactive)
7202 (when (and org-auto-renumber-ordered-lists
7203 (org-at-item-p))
7204 (if (match-beginning 3)
7205 (org-renumber-ordered-list 1)
7206 (org-fix-bullet-type))))
7208 (defun org-maybe-renumber-ordered-list-safe ()
7209 (condition-case nil
7210 (save-excursion
7211 (org-maybe-renumber-ordered-list))
7212 (error nil)))
7214 (defun org-cycle-list-bullet (&optional which)
7215 "Cycle through the different itemize/enumerate bullets.
7216 This cycle the entire list level through the sequence:
7218 `-' -> `+' -> `*' -> `1.' -> `1)'
7220 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7221 0 meand `-', 1 means `+' etc."
7222 (interactive "P")
7223 (org-preserve-lc
7224 (org-beginning-of-item-list)
7225 (org-at-item-p)
7226 (beginning-of-line 1)
7227 (let ((current (match-string 0))
7228 (prevp (eq which 'previous))
7229 new)
7230 (setq new (cond
7231 ((and (numberp which)
7232 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7233 ((string-match "-" current) (if prevp "1)" "+"))
7238 ((string-match ")" current) (if prevp "1." "-"))
7239 (t (error "This should not happen"))))
7241 (org-fix-bullet-type)
7242 (org-maybe-renumber-ordered-list))))
7244 (defun org-get-string-indentation (s)
7245 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7246 (let ((n -1) (i 0) (w tab-width) c)
7247 (catch 'exit
7248 (while (< (setq n (1+ n)) (length s))
7249 (setq c (aref s n))
7250 (cond ((= c ?\ ) (setq i (1+ i)))
7252 (t (throw 'exit t)))))
7253 i))
7255 (defun org-renumber-ordered-list (arg)
7256 "Renumber an ordered plain list.
7257 Cursor needs to be in the first line of an item, the line that starts
7259 (interactive "p")
7260 (unless (and (org-at-item-p)
7261 (match-beginning 3))
7262 (error "This is not an ordered list"))
7263 (let ((line (org-current-line))
7264 (col (current-column))
7265 (ind (org-get-string-indentation
7266 (buffer-substring (point-at-bol) (match-beginning 3))))
7267 ;; (term (substring (match-string 3) -1))
7268 ind1 (n (1- arg))
7269 fmt)
7270 ;; find where this list begins
7271 (org-beginning-of-item-list)
7273 (setq fmt (concat "%d" (match-string 1)))
7274 (beginning-of-line 0)
7275 ;; walk forward and replace these numbers
7276 (catch 'exit
7277 (while t
7278 (catch 'next
7279 (beginning-of-line 2)
7280 (if (eobp) (throw 'exit nil))
7283 (if (> ind1 ind) (throw 'next t))
7284 (if (< ind1 ind) (throw 'exit t))
7285 (if (not (org-at-item-p)) (throw 'exit nil))
7286 (delete-region (match-beginning 2) (match-end 2))
7287 (goto-char (match-beginning 2))
7288 (insert (format fmt (setq n (1+ n)))))))
7289 (goto-line line)
7290 (move-to-column col)))
7292 (defun org-fix-bullet-type ()
7293 "Make sure all items in this list have the same bullet as the firsst item."
7294 (interactive)
7295 (unless (org-at-item-p) (error "This is not a list"))
7296 (let ((line (org-current-line))
7297 (col (current-column))
7298 (ind (current-indentation))
7299 ind1 bullet)
7300 ;; find where this list begins
7301 (org-beginning-of-item-list)
7302 (beginning-of-line 1)
7303 ;; find out what the bullet type is
7305 (setq bullet (match-string 1))
7306 ;; walk forward and replace these numbers
7307 (beginning-of-line 0)
7308 (catch 'exit
7309 (while t
7310 (catch 'next
7311 (beginning-of-line 2)
7312 (if (eobp) (throw 'exit nil))
7315 (if (> ind1 ind) (throw 'next t))
7316 (if (< ind1 ind) (throw 'exit t))
7317 (if (not (org-at-item-p)) (throw 'exit nil))
7320 (replace-match bullet))))
7321 (goto-line line)
7322 (move-to-column col)
7323 (if (string-match "[0-9]" bullet)
7324 (org-renumber-ordered-list 1))))
7326 (defun org-beginning-of-item-list ()
7327 "Go to the beginning of the current item list.
7328 I.e. to the first item in this list."
7329 (interactive)
7330 (org-beginning-of-item)
7331 (let ((pos (point-at-bol))
7332 (ind (org-get-indentation))
7333 ind1)
7334 ;; find where this list begins
7335 (catch 'exit
7336 (while t
7337 (catch 'next
7338 (beginning-of-line 0)
7340 (throw (if (bobp) 'exit 'next) t))
7342 (if (or (< ind1 ind)
7343 (and (= ind1 ind)
7344 (not (org-at-item-p)))
7345 (bobp))
7346 (throw 'exit t)
7347 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7348 (goto-char pos)))
7351 (defun org-end-of-item-list ()
7352 "Go to the end of the current item list.
7353 I.e. to the text after the last item."
7354 (interactive)
7355 (org-beginning-of-item)
7356 (let ((pos (point-at-bol))
7357 (ind (org-get-indentation))
7358 ind1)
7359 ;; find where this list begins
7360 (catch 'exit
7361 (while t
7362 (catch 'next
7363 (beginning-of-line 2)
7365 (throw (if (eobp) 'exit 'next) t))
7367 (if (or (< ind1 ind)
7368 (and (= ind1 ind)
7369 (not (org-at-item-p)))
7370 (eobp))
7371 (progn
7372 (setq pos (point-at-bol))
7373 (throw 'exit t))))))
7374 (goto-char pos)))
7377 (defvar org-last-indent-begin-marker (make-marker))
7378 (defvar org-last-indent-end-marker (make-marker))
7380 (defun org-outdent-item (arg)
7381 "Outdent a local list item."
7382 (interactive "p")
7383 (org-indent-item (- arg)))
7385 (defun org-indent-item (arg)
7386 "Indent a local list item."
7387 (interactive "p")
7388 (unless (org-at-item-p)
7389 (error "Not on an item"))
7390 (save-excursion
7391 (let (beg end ind ind1 tmp delta ind-down ind-up)
7392 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7393 (setq beg org-last-indent-begin-marker
7394 end org-last-indent-end-marker)
7395 (org-beginning-of-item)
7396 (setq beg (move-marker org-last-indent-begin-marker (point)))
7397 (org-end-of-item)
7398 (setq end (move-marker org-last-indent-end-marker (point))))
7399 (goto-char beg)
7400 (setq tmp (org-item-indent-positions)
7401 ind (car tmp)
7402 ind-down (nth 2 tmp)
7403 ind-up (nth 1 tmp)
7404 delta (if (> arg 0)
7405 (if ind-down (- ind-down ind) 2)
7406 (if ind-up (- ind-up ind) -2)))
7407 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7408 (while (< (point) end)
7409 (beginning-of-line 1)
7411 (delete-region (point-at-bol) (point))
7412 (or (eolp) (indent-to-column (+ ind1 delta)))
7413 (beginning-of-line 2))))
7414 (org-fix-bullet-type)
7415 (org-maybe-renumber-ordered-list-safe)
7416 (save-excursion
7417 (beginning-of-line 0)
7418 (condition-case nil (org-beginning-of-item) (error nil))
7419 (org-maybe-renumber-ordered-list-safe)))
7421 (defun org-item-indent-positions ()
7422 "Return indentation for plain list items.
7423 This returns a list with three values: The current indentation, the
7424 parent indentation and the indentation a child should habe.
7425 Assumes cursor in item line."
7426 (let* ((bolpos (point-at-bol))
7427 (ind (org-get-indentation))
7428 ind-down ind-up pos)
7429 (save-excursion
7430 (org-beginning-of-item-list)
7432 (when (org-in-item-p)
7433 (org-beginning-of-item)
7434 (setq ind-up (org-get-indentation))))
7435 (setq pos (point))
7436 (save-excursion
7437 (cond
7438 ((and (condition-case nil (progn (org-previous-item) t)
7439 (error nil))
7440 (or (forward-char 1) t)
7441 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7442 (setq ind-down (org-get-indentation)))
7443 ((and (goto-char pos)
7444 (org-at-item-p))
7445 (goto-char (match-end 0))
7447 (setq ind-down (current-column)))))
7448 (list ind ind-up ind-down)))
7450 ;;; The orgstruct minor mode
7452 ;; Define a minor mode which can be used in other modes in order to
7453 ;; integrate the org-mode structure editing commands.
7455 ;; This is really a hack, because the org-mode structure commands use
7456 ;; keys which normally belong to the major mode. Here is how it
7457 ;; works: The minor mode defines all the keys necessary to operate the
7458 ;; structure commands, but wraps the commands into a function which
7459 ;; tests if the cursor is currently at a headline or a plain list
7460 ;; item. If that is the case, the structure command is used,
7461 ;; temporarily setting many Org-mode variables like regular
7462 ;; expressions for filling etc. However, when any of those keys is
7463 ;; used at a different location, function uses `key-binding' to look
7464 ;; up if the key has an associated command in another currently active
7465 ;; keymap (minor modes, major mode, global), and executes that
7466 ;; command. There might be problems if any of the keys is otherwise
7467 ;; used as a prefix key.
7469 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7470 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7471 ;; addresses this by checking explicitly for both bindings.
7473 (defvar orgstruct-mode-map (make-sparse-keymap)
7474 "Keymap for the minor `orgstruct-mode'.")
7476 (defvar org-local-vars nil
7477 "List of local variables, for use by `orgstruct-mode'")
7479 ;;;###autoload
7480 (define-minor-mode orgstruct-mode
7481 "Toggle the minor more `orgstruct-mode'.
7482 This mode is for using Org-mode structure commands in other modes.
7483 The following key behave as if Org-mode was active, if the cursor
7484 is on a headline, or on a plain list item (both in the definition
7485 of Org-mode).
7487 M-up Move entry/item up
7488 M-down Move entry/item down
7489 M-left Promote
7490 M-right Demote
7491 M-S-up Move entry/item up
7492 M-S-down Move entry/item down
7493 M-S-left Promote subtree
7494 M-S-right Demote subtree
7495 M-q Fill paragraph and items like in Org-mode
7496 C-c ^ Sort entries
7497 C-c - Cycle list bullet
7498 TAB Cycle item visibility
7499 M-RET Insert new heading/item
7500 S-M-RET Insert new TODO heading / Chekbox item
7501 C-c C-c Set tags / toggle checkbox"
7502 nil " OrgStruct" nil
7503 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7505 ;;;###autoload
7506 (defun turn-on-orgstruct ()
7507 "Unconditionally turn on `orgstruct-mode'."
7508 (orgstruct-mode 1))
7510 ;;;###autoload
7511 (defun turn-on-orgstruct++ ()
7512 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7513 In addition to setting orgstruct-mode, this also exports all indentation and
7514 autofilling variables from org-mode into the buffer. Note that turning
7515 off orgstruct-mode will *not* remove these additonal settings."
7516 (orgstruct-mode 1)
7517 (let (var val)
7518 (mapc
7519 (lambda (x)
7520 (when (string-match
7522 (symbol-name (car x)))
7523 (setq var (car x) val (nth 1 x))
7524 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7525 org-local-vars)))
7527 (defun orgstruct-error ()
7528 "Error when there is no default binding for a structure key."
7529 (interactive)
7530 (error "This key has no function outside structure elements"))
7532 (defun orgstruct-setup ()
7533 "Setup orgstruct keymaps."
7534 (let ((nfunc 0)
7535 (bindings
7536 (list
7537 '([(meta up)] org-metaup)
7538 '([(meta down)] org-metadown)
7539 '([(meta left)] org-metaleft)
7540 '([(meta right)] org-metaright)
7541 '([(meta shift up)] org-shiftmetaup)
7542 '([(meta shift down)] org-shiftmetadown)
7543 '([(meta shift left)] org-shiftmetaleft)
7544 '([(meta shift right)] org-shiftmetaright)
7545 '([(shift up)] org-shiftup)
7546 '([(shift down)] org-shiftdown)
7547 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7548 '("\M-q" fill-paragraph)
7549 '("\C-c^" org-sort)
7550 '("\C-c-" org-cycle-list-bullet)))
7551 elt key fun cmd)
7552 (while (setq elt (pop bindings))
7553 (setq nfunc (1+ nfunc))
7554 (setq key (org-key (car elt))
7555 fun (nth 1 elt)
7556 cmd (orgstruct-make-binding fun nfunc key))
7557 (org-defkey orgstruct-mode-map key cmd))
7559 ;; Special treatment needed for TAB and RET
7560 (org-defkey orgstruct-mode-map [(tab)]
7561 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7562 (org-defkey orgstruct-mode-map "\C-i"
7563 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7565 (org-defkey orgstruct-mode-map "\M-\C-m"
7566 (orgstruct-make-binding 'org-insert-heading 105
7567 "\M-\C-m" [(meta return)]))
7568 (org-defkey orgstruct-mode-map [(meta return)]
7569 (orgstruct-make-binding 'org-insert-heading 106
7570 [(meta return)] "\M-\C-m"))
7572 (org-defkey orgstruct-mode-map [(shift meta return)]
7573 (orgstruct-make-binding 'org-insert-todo-heading 107
7574 [(meta return)] "\M-\C-m"))
7576 (unless org-local-vars
7577 (setq org-local-vars (org-get-local-variables)))
7579 t))
7581 (defun orgstruct-make-binding (fun n &rest keys)
7582 "Create a function for binding in the structure minor mode.
7583 FUN is the command to call inside a table. N is used to create a unique
7584 command name. KEYS are keys that should be checked in for a command
7585 to execute outside of tables."
7586 (eval
7587 (list 'defun
7588 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7589 '(arg)
7591 "Outside of structure, run the binding of `"
7592 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7593 "'.")
7594 '(interactive "p")
7595 (list 'if
7596 '(org-context-p 'headline 'item)
7597 (list 'org-run-like-in-org-mode (list 'quote fun))
7598 (list 'let '(orgstruct-mode)
7599 (list 'call-interactively
7600 (append '(or)
7601 (mapcar (lambda (k)
7602 (list 'key-binding k))
7603 keys)
7604 '('orgstruct-error))))))))
7606 (defun org-context-p (&rest contexts)
7607 "Check if local context is and of CONTEXTS.
7608 Possible values in the list of contexts are `table', `headline', and `item'."
7609 (let ((pos (point)))
7610 (goto-char (point-at-bol))
7611 (prog1 (or (and (memq 'table contexts)
7613 (and (memq 'headline contexts)
7615 (and (memq 'item contexts)
7617 (goto-char pos))))
7619 (defun org-get-local-variables ()
7620 "Return a list of all local variables in an org-mode buffer."
7621 (let (varlist)
7622 (with-current-buffer (get-buffer-create "*Org tmp*")
7623 (erase-buffer)
7624 (org-mode)
7625 (setq varlist (buffer-local-variables)))
7626 (kill-buffer "*Org tmp*")
7627 (delq nil
7628 (mapcar
7629 (lambda (x)
7630 (setq x
7631 (if (symbolp x)
7632 (list x)
7633 (list (car x) (list 'quote (cdr x)))))
7634 (if (string-match
7635 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7636 (symbol-name (car x)))
7637 x nil))
7638 varlist))))
7640 ;;;###autoload
7641 (defun org-run-like-in-org-mode (cmd)
7642 (unless org-local-vars
7643 (setq org-local-vars (org-get-local-variables)))
7644 (eval (list 'let org-local-vars
7645 (list 'call-interactively (list 'quote cmd)))))
7647 ;;;; Archiving
7649 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7651 (defun org-archive-subtree (&optional find-done)
7652 "Move the current subtree to the archive.
7653 The archive can be a certain top-level heading in the current file, or in
7654 a different file. The tree will be moved to that location, the subtree
7655 heading be marked DONE, and the current time will be added.
7657 When called with prefix argument FIND-DONE, find whole trees without any
7658 open TODO items and archive them (after getting confirmation from the user).
7659 If the cursor is not at a headline when this comand is called, try all level
7660 1 trees. If the cursor is on a headline, only try the direct children of
7661 this heading."
7662 (interactive "P")
7663 (if find-done
7664 (org-archive-all-done)
7665 ;; Save all relevant TODO keyword-relatex variables
7667 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7668 (tr-org-todo-keywords-1 org-todo-keywords-1)
7669 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7670 (tr-org-done-keywords org-done-keywords)
7671 (tr-org-todo-regexp org-todo-regexp)
7672 (tr-org-todo-line-regexp org-todo-line-regexp)
7673 (tr-org-odd-levels-only org-odd-levels-only)
7674 (this-buffer (current-buffer))
7675 (org-archive-location org-archive-location)
7677 ;; start of variables that will be used for saving context
7678 ;; The compiler complains about them - keep them anyway!
7679 (file (abbreviate-file-name (buffer-file-name)))
7680 (time (format-time-string
7681 (substring (cdr org-time-stamp-formats) 1 -1)
7682 (current-time)))
7683 afile heading buffer level newfile-p
7684 category todo priority
7685 ;; start of variables that will be used for savind context
7686 ltags itags prop)
7688 ;; Try to find a local archive location
7689 (save-excursion
7690 (save-restriction
7691 (widen)
7692 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7694 (setq org-archive-location prop)
7695 (if (or (re-search-backward re nil t)
7696 (re-search-forward re nil t))
7697 (setq org-archive-location (match-string 1))))))
7700 (progn
7701 (setq afile (format (match-string 1 org-archive-location)
7702 (file-name-nondirectory buffer-file-name))
7703 heading (match-string 2 org-archive-location)))
7704 (error "Invalid `org-archive-location'"))
7705 (if (> (length afile) 0)
7706 (setq newfile-p (not (file-exists-p afile))
7707 buffer (find-file-noselect afile))
7708 (setq buffer (current-buffer)))
7709 (unless buffer
7711 (if (and (> (length heading) 0)
7713 (setq level (match-end 0))
7714 (setq heading nil level 0))
7715 (save-excursion
7716 (org-back-to-heading t)
7717 ;; Get context information that will be lost by moving the tree
7718 (org-refresh-category-properties)
7719 (setq category (org-get-category)
7720 todo (and (looking-at org-todo-line-regexp)
7721 (match-string 2))
7722 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7723 ltags (org-get-tags)
7724 itags (org-delete-all ltags (org-get-tags-at)))
7725 (setq ltags (mapconcat 'identity ltags " ")
7726 itags (mapconcat 'identity itags " "))
7727 ;; We first only copy, in case something goes wrong
7728 ;; we need to protect this-command, to avoid kill-region sets it,
7729 ;; which would lead to duplication of subtrees
7730 (let (this-command) (org-copy-subtree))
7731 (set-buffer buffer)
7732 ;; Enforce org-mode for the archive buffer
7733 (if (not (org-mode-p))
7734 ;; Force the mode for future visits.
7735 (let ((org-insert-mode-line-in-empty-file t)
7736 (org-inhibit-startup t))
7737 (call-interactively 'org-mode)))
7738 (when newfile-p
7739 (goto-char (point-max))
7741 (buffer-file-name this-buffer))))
7742 ;; Force the TODO keywords of the original buffer
7743 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7744 (org-todo-keywords-1 tr-org-todo-keywords-1)
7745 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7746 (org-done-keywords tr-org-done-keywords)
7747 (org-todo-regexp tr-org-todo-regexp)
7748 (org-todo-line-regexp tr-org-todo-line-regexp)
7749 (org-odd-levels-only
7750 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7751 org-odd-levels-only
7752 tr-org-odd-levels-only)))
7753 (goto-char (point-min))
7754 (if heading
7755 (progn
7756 (if (re-search-forward
7757 (concat "^" (regexp-quote heading)
7759 nil t)
7760 (goto-char (match-end 0))
7761 ;; Heading not found, just insert it at the end
7762 (goto-char (point-max))
7765 (end-of-line 0))
7766 ;; Make the subtree visible
7767 (show-subtree)
7768 (org-end-of-subtree t)
7772 ;; No specific heading, just go to end of file.
7774 ;; Paste
7775 (org-paste-subtree (org-get-legal-level level 1))
7777 ;; Mark the entry as done
7778 (when (and org-archive-mark-done
7779 (looking-at org-todo-line-regexp)
7780 (or (not (match-end 2))
7781 (not (member (match-string 2) org-done-keywords))))
7782 (let (org-log-done)
7783 (org-todo
7784 (car (or (member org-archive-mark-done org-done-keywords)
7785 org-done-keywords)))))
7787 ;; Add the context info
7788 (when org-archive-save-context-info
7789 (let ((l org-archive-save-context-info) e n v)
7790 (while (setq e (pop l))
7791 (when (and (setq v (symbol-value e))
7793 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7794 (org-entry-put (point) n v)))))
7796 ;; Save the buffer, if it is not the same buffer.
7797 (if (not (eq this-buffer buffer)) (save-buffer))))
7798 ;; Here we are back in the original buffer. Everything seems to have
7799 ;; worked. So now cut the tree and finish up.
7800 (let (this-command) (org-cut-subtree))
7802 (message "Subtree archived %s"
7803 (if (eq this-buffer buffer)
7804 (concat "under heading: " heading)
7805 (concat "in file: " (abbreviate-file-name afile)))))))
7807 (defun org-refresh-category-properties ()
7808 "Refresh category text properties in teh buffer."
7809 (let ((def-cat (cond
7810 ((null org-category)
7811 (if buffer-file-name
7812 (file-name-sans-extension
7813 (file-name-nondirectory buffer-file-name))
7814 "???"))
7815 ((symbolp org-category) (symbol-name org-category))
7816 (t org-category)))
7817 beg end cat pos optionp)
7818 (org-unmodified
7819 (save-excursion
7820 (save-restriction
7821 (widen)
7822 (goto-char (point-min))
7823 (put-text-property (point) (point-max) 'org-category def-cat)
7824 (while (re-search-forward
7826 (setq pos (match-end 0)
7827 optionp (equal (char-after (match-beginning 0)) ?#)
7828 cat (org-trim (match-string 2)))
7829 (if optionp
7830 (setq beg (point-at-bol) end (point-max))
7831 (org-back-to-heading t)
7832 (setq beg (point) end (org-end-of-subtree t t)))
7833 (put-text-property beg end 'org-category cat)
7834 (goto-char pos)))))))
7836 (defun org-archive-all-done (&optional tag)
7837 "Archive sublevels of the current tree without open TODO items.
7838 If the cursor is not on a headline, try all level 1 trees. If
7839 it is on a headline, try all direct children.
7840 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7842 (rea (concat ".*:" org-archive-tag ":"))
7843 (begm (make-marker))
7844 (endm (make-marker))
7845 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7846 "Move subtree to archive (no open TODO items)? "))
7847 beg end (cntarch 0))
7848 (if (org-on-heading-p)
7849 (progn
7850 (setq re1 (concat "^" (regexp-quote
7851 (make-string
7852 (1+ (- (match-end 0) (match-beginning 0)))
7853 ?*))
7854 " "))
7855 (move-marker begm (point))
7856 (move-marker endm (org-end-of-subtree t)))
7857 (setq re1 "^* ")
7858 (move-marker begm (point-min))
7859 (move-marker endm (point-max)))
7860 (save-excursion
7861 (goto-char begm)
7862 (while (re-search-forward re1 endm t)
7863 (setq beg (match-beginning 0)
7864 end (save-excursion (org-end-of-subtree t) (point)))
7865 (goto-char beg)
7866 (if (re-search-forward re end t)
7867 (goto-char end)
7868 (goto-char beg)
7869 (if (and (or (not tag) (not (looking-at rea)))
7870 (y-or-n-p question))
7871 (progn
7872 (if tag
7873 (org-toggle-tag org-archive-tag 'on)
7874 (org-archive-subtree))
7875 (setq cntarch (1+ cntarch)))
7876 (goto-char end)))))
7877 (message "%d trees archived" cntarch)))
7879 (defun org-cycle-hide-drawers (state)
7880 "Re-hide all drawers after a visibility state change."
7881 (when (and (org-mode-p)
7882 (not (memq state '(overview folded))))
7883 (save-excursion
7884 (let* ((globalp (memq state '(contents all)))
7885 (beg (if globalp (point-min) (point)))
7886 (end (if globalp (point-max) (org-end-of-subtree t))))
7887 (goto-char beg)
7888 (while (re-search-forward org-drawer-regexp end t)
7889 (org-flag-drawer t))))))
7891 (defun org-flag-drawer (flag)
7892 (save-excursion
7893 (beginning-of-line 1)
7895 (let ((b (match-end 0)))
7896 (if (re-search-forward
7898 (save-excursion (outline-next-heading) (point)) t)
7899 (outline-flag-region b (point-at-eol) flag)
7900 (error ":END: line missing"))))))
7902 (defun org-cycle-hide-archived-subtrees (state)
7903 "Re-hide all archived subtrees after a visibility state change."
7904 (when (and (not org-cycle-open-archived-trees)
7905 (not (memq state '(overview folded))))
7906 (save-excursion
7907 (let* ((globalp (memq state '(contents all)))
7908 (beg (if globalp (point-min) (point)))
7909 (end (if globalp (point-max) (org-end-of-subtree t))))
7910 (org-hide-archived-subtrees beg end)
7911 (goto-char beg)
7912 (if (looking-at (concat ".*:" org-archive-tag ":"))
7913 (message "%s" (substitute-command-keys
7914 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
7916 (defun org-force-cycle-archived ()
7917 "Cycle subtree even if it is archived."
7918 (interactive)
7919 (setq this-command 'org-cycle)
7920 (let ((org-cycle-open-archived-trees t))
7921 (call-interactively 'org-cycle)))
7923 (defun org-hide-archived-subtrees (beg end)
7924 "Re-hide all archived subtrees after a visibility state change."
7925 (save-excursion
7926 (let* ((re (concat ":" org-archive-tag ":")))
7927 (goto-char beg)
7928 (while (re-search-forward re end t)
7929 (and (org-on-heading-p) (hide-subtree))
7930 (org-end-of-subtree t)))))
7932 (defun org-toggle-tag (tag &optional onoff)
7933 "Toggle the tag TAG for the current line.
7934 If ONOFF is `on' or `off', don't toggle but set to this state."
7935 (unless (org-on-heading-p t) (error "Not on headling"))
7936 (let (res current)
7937 (save-excursion
7938 (beginning-of-line)
7940 (point-at-eol) t)
7941 (progn
7942 (setq current (match-string 1))
7943 (replace-match ""))
7944 (setq current ""))
7945 (setq current (nreverse (org-split-string current ":")))
7946 (cond
7947 ((eq onoff 'on)
7948 (setq res t)
7949 (or (member tag current) (push tag current)))
7950 ((eq onoff 'off)
7951 (or (not (member tag current)) (setq current (delete tag current))))
7952 (t (if (member tag current)
7953 (setq current (delete tag current))
7954 (setq res t)
7955 (push tag current))))
7956 (end-of-line 1)
7957 (if current
7958 (progn
7959 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
7960 (org-set-tags nil t))
7961 (delete-horizontal-space))
7962 (run-hooks 'org-after-tags-change-hook))
7963 res))
7965 (defun org-toggle-archive-tag (&optional arg)
7966 "Toggle the archive tag for the current headline.
7967 With prefix ARG, check all children of current headline and offer tagging
7968 the children that do not contain any open TODO items."
7969 (interactive "P")
7970 (if arg
7971 (org-archive-all-done 'tag)
7972 (let (set)
7973 (save-excursion
7974 (org-back-to-heading t)
7975 (setq set (org-toggle-tag org-archive-tag))
7976 (when set (hide-subtree)))
7977 (and set (beginning-of-line 1))
7978 (message "Subtree %s" (if set "archived" "unarchived")))))
7981 ;;;; Tables
7983 ;;; The table editor
7985 ;; Watch out: Here we are talking about two different kind of tables.
7986 ;; Most of the code is for the tables created with the Org-mode table editor.
7987 ;; Sometimes, we talk about tables created and edited with the table.el
7988 ;; Emacs package. We call the former org-type tables, and the latter
7989 ;; table.el-type tables.
7991 (defun org-before-change-function (beg end)
7992 "Every change indicates that a table might need an update."
7993 (setq org-table-may-need-update t))
7996 "Detects an org-type table line.")
7998 "Detects an org-type table line.")
8000 "Detects a table line marked for automatic recalculation.")
8002 "Detects a table line marked for automatic recalculation.")
8004 "Detects a table line marked for automatic recalculation.")
8006 "Detects an org-type table hline.")
8008 "Detects a table-type table hline.")
8010 "Detects an org-type or table-type table.")
8012 "Searching from within a table (any type) this finds the first line
8013 outside the table.")
8015 "Searching from within a table (any type) this finds the first line
8016 outside the table.")
8018 (defvar org-table-last-highlighted-reference nil)
8019 (defvar org-table-formula-history nil)
8021 (defvar org-table-column-names nil
8022 "Alist with column names, derived from the `!' line.")
8023 (defvar org-table-column-name-regexp nil
8024 "Regular expression matching the current column names.")
8025 (defvar org-table-local-parameters nil
8026 "Alist with parameter names, derived from the `$' line.")
8027 (defvar org-table-named-field-locations nil
8028 "Alist with locations of named fields.")
8030 (defvar org-table-current-line-types nil
8031 "Table row types, non-nil only for the duration of a comand.")
8032 (defvar org-table-current-begin-line nil
8033 "Table begin line, non-nil only for the duration of a comand.")
8034 (defvar org-table-current-begin-pos nil
8035 "Table begin position, non-nil only for the duration of a comand.")
8036 (defvar org-table-dlines nil
8037 "Vector of data line line numbers in the current table.")
8038 (defvar org-table-hlines nil
8039 "Vector of hline line numbers in the current table.")
8041 (defconst org-table-range-regexp
8042 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8043 ;; 1 2 3 4 5
8044 "Regular expression for matching ranges in formulas.")
8046 (defconst org-table-range-regexp2
8047 (concat
8051 "Match a range for reference display.")
8053 (defconst org-table-translate-regexp
8055 "Match a reference that needs translation, for reference display.")
8057 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8059 (defun org-table-create-with-table.el ()
8060 "Use the table.el package to insert a new table.
8061 If there is already a table at point, convert between Org-mode tables
8062 and table.el tables."
8063 (interactive)
8064 (require 'table)
8065 (cond
8066 ((org-at-table.el-p)
8067 (if (y-or-n-p "Convert table to Org-mode table? ")
8068 (org-table-convert)))
8069 ((org-at-table-p)
8070 (if (y-or-n-p "Convert table to table.el table? ")
8071 (org-table-convert)))
8072 (t (call-interactively 'table-insert))))
8074 (defun org-table-create-or-convert-from-region (arg)
8075 "Convert region to table, or create an empty table.
8076 If there is an active region, convert it to a table, using the function
8077 `org-table-convert-region'. See the documentation of that function
8078 to learn how the prefix argument is interpreted to determine the field
8079 separator.
8080 If there is no such region, create an empty table with `org-table-create'."
8081 (interactive "P")
8082 (if (org-region-active-p)
8083 (org-table-convert-region (region-beginning) (region-end) arg)
8084 (org-table-create arg)))
8086 (defun org-table-create (&optional size)
8087 "Query for a size and insert a table skeleton.
8089 (interactive "P")
8090 (unless size
8091 (setq size (read-string
8092 (concat "Table size Columns x Rows [e.g. "
8093 org-table-default-size "]: ")
8094 "" nil org-table-default-size)))
8096 (let* ((pos (point))
8097 (indent (make-string (current-column) ?\ ))
8098 (split (org-split-string size " *x *"))
8099 (rows (string-to-number (nth 1 split)))
8100 (columns (string-to-number (car split)))
8101 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8104 (point-at-bol) (point)))
8105 (beginning-of-line 1)
8106 (newline))
8107 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8108 (dotimes (i rows) (insert line))
8109 (goto-char pos)
8110 (if (> rows 1)
8111 ;; Insert a hline after the first row.
8112 (progn
8113 (end-of-line 1)
8115 (goto-char pos)))
8116 (org-table-align)))
8118 (defun org-table-convert-region (beg0 end0 &optional separator)
8119 "Convert region to a table.
8120 The region goes from BEG0 to END0, but these borders will be moved
8121 slightly, to make sure a beginning of line in the first line is included.
8123 SEPARATOR specifies the field separator in the lines. It can have the
8124 following values:
8126 '(4) Use the comma as a field separator
8127 '(16) Use a TAB as field separator
8128 integer When a number, use that many spaces as field separator
8129 nil When nil, the command tries to be smart and figure out the
8130 separator in the following way:
8131 - when each line contains a TAB, assume TAB-separated material
8132 - when each line contains a comme, assume CSV material
8133 - else, assume one or more SPACE charcters as separator."
8134 (interactive "rP")
8135 (let* ((beg (min beg0 end0))
8136 (end (max beg0 end0))
8137 re)
8138 (goto-char beg)
8139 (beginning-of-line 1)
8140 (setq beg (move-marker (make-marker) (point)))
8141 (goto-char end)
8142 (if (bolp) (backward-char 1) (end-of-line 1))
8143 (setq end (move-marker (make-marker) (point)))
8144 ;; Get the right field separator
8145 (unless separator
8146 (goto-char beg)
8147 (setq separator
8148 (cond
8151 (t 1))))
8152 (setq re (cond
8155 ((integerp separator)
8157 (t (error "This should not happen"))))
8158 (goto-char beg)
8159 (while (re-search-forward re end t)
8160 (replace-match "| " t t))
8161 (goto-char beg)
8162 (insert " ")
8163 (org-table-align)))
8165 (defun org-table-import (file arg)
8166 "Import FILE as a table.
8167 The file is assumed to be tab-separated. Such files can be produced by most
8168 spreadsheet and database applications. If no tabs (at least one per line)
8169 are found, lines will be split on whitespace into fields."
8171 (or (bolp) (newline))
8172 (let ((beg (point))
8173 (pm (point-max)))
8174 (insert-file-contents file)
8175 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8177 (defun org-table-export ()
8178 "Export table as a tab-separated file.
8179 Such a file can be imported into a spreadsheet program like Excel."
8180 (interactive)
8181 (let* ((beg (org-table-begin))
8182 (end (org-table-end))
8183 (table (buffer-substring beg end))
8184 (file (read-file-name "Export table to: "))
8185 buf)
8186 (unless (or (not (file-exists-p file))
8187 (y-or-n-p (format "Overwrite file %s? " file)))
8188 (error "Abort"))
8189 (with-current-buffer (find-file-noselect file)
8190 (setq buf (current-buffer))
8191 (erase-buffer)
8192 (fundamental-mode)
8193 (insert table)
8194 (goto-char (point-min))
8196 (replace-match "" t t)
8197 (end-of-line 1))
8198 (goto-char (point-min))
8200 (replace-match "" t t)
8201 (goto-char (min (1+ (point)) (point-max))))
8202 (goto-char (point-min))
8203 (while (re-search-forward "^-[-+]*$" nil t)
8204 (replace-match "")
8206 (delete-char 1)))
8207 (goto-char (point-min))
8210 (save-buffer))
8211 (kill-buffer buf)))
8213 (defvar org-table-aligned-begin-marker (make-marker)
8214 "Marker at the beginning of the table last aligned.
8215 Used to check if cursor still is in that table, to minimize realignment.")
8216 (defvar org-table-aligned-end-marker (make-marker)
8217 "Marker at the end of the table last aligned.
8218 Used to check if cursor still is in that table, to minimize realignment.")
8219 (defvar org-table-last-alignment nil
8220 "List of flags for flushright alignment, from the last re-alignment.
8221 This is being used to correctly align a single field after TAB or RET.")
8222 (defvar org-table-last-column-widths nil
8223 "List of max width of fields in each column.
8224 This is being used to correctly align a single field after TAB or RET.")
8225 (defvar org-table-overlay-coordinates nil
8226 "Overlay coordinates after each align of a table.")
8227 (make-variable-buffer-local 'org-table-overlay-coordinates)
8229 (defvar org-last-recalc-line nil)
8230 (defconst org-narrow-column-arrow "=>"
8231 "Used as display property in narrowed table columns.")
8233 (defun org-table-align ()
8234 "Align the table at point by aligning all vertical bars."
8235 (interactive)
8236 (let* (
8237 ;; Limits of table
8238 (beg (org-table-begin))
8239 (end (org-table-end))
8240 ;; Current cursor position
8241 (linepos (org-current-line))
8242 (colpos (org-table-current-column))
8243 (winstart (window-start))
8244 (winstartline (org-current-line (min winstart (1- (point-max)))))
8245 lines (new "") lengths l typenums ty fields maxfields i
8246 column
8247 (indent "") cnt frac
8248 rfmt hfmt
8249 (spaces '(1 . 1))
8250 (sp1 (car spaces))
8251 (sp2 (cdr spaces))
8252 (rfmt1 (concat
8253 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8254 (hfmt1 (concat
8255 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8256 emptystrings links dates emph narrow fmax f1 len c e)
8257 (untabify beg end)
8258 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8259 ;; Check if we have links or dates
8260 (goto-char beg)
8261 (setq links (re-search-forward org-bracket-link-regexp end t))
8262 (goto-char beg)
8263 (setq emph (and org-hide-emphasis-markers
8264 (re-search-forward org-emph-re end t)))
8265 (goto-char beg)
8266 (setq dates (and org-display-custom-times
8267 (re-search-forward org-ts-regexp-both end t)))
8268 ;; Make sure the link properties are right
8269 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8270 ;; Make sure the date properties are right
8271 (when dates (goto-char beg) (while (org-activate-dates end)))
8272 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8274 ;; Check if we are narrowing any columns
8275 (goto-char beg)
8276 (setq narrow (and org-format-transports-properties-p
8277 (re-search-forward "<[0-9]+>" end t)))
8278 ;; Get the rows
8279 (setq lines (org-split-string
8281 ;; Store the indentation of the first line
8282 (if (string-match "^ *" (car lines))
8283 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8284 ;; Mark the hlines by setting the corresponding element to nil
8285 ;; At the same time, we remove trailing space.
8286 (setq lines (mapcar (lambda (l)
8287 (if (string-match "^ *|-" l)
8288 nil
8290 (substring l 0 (match-beginning 0))
8291 l)))
8292 lines))
8293 ;; Get the data fields by splitting the lines.
8294 (setq fields (mapcar
8295 (lambda (l)
8296 (org-split-string l " *| *"))
8297 (delq nil (copy-sequence lines))))
8298 ;; How many fields in the longest line?
8299 (condition-case nil
8300 (setq maxfields (apply 'max (mapcar 'length fields)))
8301 (error
8302 (kill-region beg end)
8303 (org-table-create org-table-default-size)
8304 (error "Empty table - created default table")))
8305 ;; A list of empty strings to fill any short rows on output
8306 (setq emptystrings (make-list maxfields ""))
8307 ;; Check for special formatting.
8308 (setq i -1)
8309 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8310 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8311 ;; Check if there is an explicit width specified
8312 (when narrow
8313 (setq c column fmax nil)
8314 (while c
8315 (setq e (pop c))
8317 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8318 ;; Find fields that are wider than fmax, and shorten them
8319 (when fmax
8320 (loop for xx in column do
8321 (when (and (stringp xx)
8322 (> (org-string-width xx) fmax))
8323 (org-add-props xx nil
8324 'help-echo
8325 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8326 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8327 (unless (> f1 1)
8329 (match-string 0 xx)))
8330 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8331 (add-text-properties (- f1 2) f1
8332 (list 'display org-narrow-column-arrow)
8333 xx)))))
8334 ;; Get the maximum width for each column
8335 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8336 ;; Get the fraction of numbers, to decide about alignment of the column
8337 (setq cnt 0 frac 0.0)
8338 (loop for x in column do
8339 (if (equal x "")
8340 nil
8341 (setq frac ( / (+ (* frac cnt)
8342 (if (string-match org-table-number-regexp x) 1 0))
8343 (setq cnt (1+ cnt))))))
8344 (push (>= frac org-table-number-fraction) typenums))
8345 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8347 ;; Store the alignment of this table, for later editing of single fields
8348 (setq org-table-last-alignment typenums
8349 org-table-last-column-widths lengths)
8351 ;; With invisible characters, `format' does not get the field width right
8352 ;; So we need to make these fields wide by hand.
8353 (when (or links emph)
8354 (loop for i from 0 upto (1- maxfields) do
8355 (setq len (nth i lengths))
8356 (loop for j from 0 upto (1- (length fields)) do
8357 (setq c (nthcdr i (car (nthcdr j fields))))
8358 (if (and (stringp (car c))
8359 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8360 ; (string-match org-bracket-link-regexp (car c))
8361 (< (org-string-width (car c)) len))
8362 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8364 ;; Compute the formats needed for output of the table
8365 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8366 (while (setq l (pop lengths))
8367 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8368 (setq rfmt (concat rfmt (format rfmt1 ty l))
8369 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8373 (setq new (mapconcat
8374 (lambda (l)
8375 (if l (apply 'format rfmt
8376 (append (pop fields) emptystrings))
8377 hfmt))
8378 lines ""))
8379 ;; Replace the old one
8380 (delete-region beg end)
8381 (move-marker end nil)
8382 (move-marker org-table-aligned-begin-marker (point))
8383 (insert new)
8384 (move-marker org-table-aligned-end-marker (point))
8385 (when (and orgtbl-mode (not (org-mode-p)))
8386 (goto-char org-table-aligned-begin-marker)
8387 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8388 ;; Try to move to the old location
8389 (goto-line winstartline)
8390 (setq winstart (point-at-bol))
8391 (goto-line linepos)
8392 (set-window-start (selected-window) winstart 'noforce)
8393 (org-table-goto-column colpos)
8394 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8395 (setq org-table-may-need-update nil)
8396 ))
8398 (defun org-string-width (s)
8399 "Compute width of string, ignoring invisible characters.
8400 This ignores character with invisibility property `org-link', and also
8401 characters with property `org-cwidth', because these will become invisible
8402 upon the next fontification round."
8403 (let (b l)
8404 (when (or (eq t buffer-invisibility-spec)
8405 (assq 'org-link buffer-invisibility-spec))
8406 (while (setq b (text-property-any 0 (length s)
8407 'invisible 'org-link s))
8408 (setq s (concat (substring s 0 b)
8409 (substring s (or (next-single-property-change
8410 b 'invisible s) (length s)))))))
8411 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8412 (setq s (concat (substring s 0 b)
8413 (substring s (or (next-single-property-change
8414 b 'org-cwidth s) (length s))))))
8415 (setq l (string-width s) b -1)
8416 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8417 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8418 l))
8420 (defun org-table-begin (&optional table-type)
8421 "Find the beginning of the table and return its position.
8422 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8423 (save-excursion
8424 (if (not (re-search-backward
8425 (if table-type org-table-any-border-regexp
8426 org-table-border-regexp)
8427 nil t))
8428 (progn (goto-char (point-min)) (point))
8429 (goto-char (match-beginning 0))
8430 (beginning-of-line 2)
8431 (point))))
8433 (defun org-table-end (&optional table-type)
8434 "Find the end of the table and return its position.
8435 With argument TABLE-TYPE, go to the end of a table.el-type table."
8436 (save-excursion
8437 (if (not (re-search-forward
8438 (if table-type org-table-any-border-regexp
8439 org-table-border-regexp)
8440 nil t))
8441 (goto-char (point-max))
8442 (goto-char (match-beginning 0)))
8443 (point-marker)))
8445 (defun org-table-justify-field-maybe (&optional new)
8446 "Justify the current field, text to left, number to right.
8447 Optional argument NEW may specify text to replace the current field content."
8448 (cond
8449 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8450 ((org-at-table-hline-p))
8451 ((and (not new)
8452 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8453 (current-buffer)))
8454 (< (point) org-table-aligned-begin-marker)
8455 (>= (point) org-table-aligned-end-marker)))
8456 ;; This is not the same table, force a full re-align
8457 (setq org-table-may-need-update t))
8458 (t ;; realign the current field, based on previous full realign
8459 (let* ((pos (point)) s
8460 (col (org-table-current-column))
8461 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8462 l f n o e)
8463 (when (> col 0)
8466 (progn
8467 (setq s (match-string 1)
8468 o (match-string 0)
8469 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8470 e (not (= (match-beginning 2) (match-end 2))))
8471 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8472 l (if e "|" (setq org-table-may-need-update t) ""))
8473 n (format f s))
8474 (if new
8475 (if (<= (length new) l) ;; FIXME: length -> str-width?
8476 (setq n (format f new))
8477 (setq n (concat new "|") org-table-may-need-update t)))
8478 (or (equal n o)
8479 (let (org-table-may-need-update)
8480 (replace-match n t t))))
8481 (setq org-table-may-need-update t))
8482 (goto-char pos))))))
8484 (defun org-table-next-field ()
8485 "Go to the next field in the current table, creating new lines as needed.
8486 Before doing so, re-align the table if necessary."
8487 (interactive)
8488 (org-table-maybe-eval-formula)
8489 (org-table-maybe-recalculate-line)
8490 (if (and org-table-automatic-realign
8491 org-table-may-need-update)
8492 (org-table-align))
8493 (let ((end (org-table-end)))
8494 (if (org-at-table-hline-p)
8495 (end-of-line 1))
8496 (condition-case nil
8497 (progn
8498 (re-search-forward "|" end)
8500 (re-search-forward "|" end))
8501 (if (and (looking-at "-")
8502 org-table-tab-jumps-over-hlines
8504 (goto-char (match-beginning 1)))
8505 (if (looking-at "-")
8506 (progn
8507 (beginning-of-line 0)
8508 (org-table-insert-row 'below))
8509 (if (looking-at " ") (forward-char 1))))
8510 (error
8511 (org-table-insert-row 'below)))))
8513 (defun org-table-previous-field ()
8514 "Go to the previous field in the table.
8515 Before doing so, re-align the table if necessary."
8516 (interactive)
8517 (org-table-justify-field-maybe)
8518 (org-table-maybe-recalculate-line)
8519 (if (and org-table-automatic-realign
8520 org-table-may-need-update)
8521 (org-table-align))
8522 (if (org-at-table-hline-p)
8523 (end-of-line 1))
8524 (re-search-backward "|" (org-table-begin))
8525 (re-search-backward "|" (org-table-begin))
8527 (re-search-backward "|" (org-table-begin)))
8528 (if (looking-at "| ?")
8529 (goto-char (match-end 0))))
8531 (defun org-table-next-row ()
8532 "Go to the next row (same column) in the current table.
8533 Before doing so, re-align the table if necessary."
8534 (interactive)
8535 (org-table-maybe-eval-formula)
8536 (org-table-maybe-recalculate-line)
8539 (newline)
8540 (if (and org-table-automatic-realign
8541 org-table-may-need-update)
8542 (org-table-align))
8543 (let ((col (org-table-current-column)))
8544 (beginning-of-line 2)
8545 (if (or (not (org-at-table-p))
8546 (org-at-table-hline-p))
8547 (progn
8548 (beginning-of-line 0)
8549 (org-table-insert-row 'below)))
8550 (org-table-goto-column col)
8552 (if (looking-at " ") (forward-char 1)))))
8554 (defun org-table-copy-down (n)
8555 "Copy a field down in the current column.
8556 If the field at the cursor is empty, copy into it the content of the nearest
8557 non-empty field above. With argument N, use the Nth non-empty field.
8558 If the current field is not empty, it is copied down to the next row, and
8559 the cursor is moved with it. Therefore, repeating this command causes the
8560 column to be filled row-by-row.
8561 If the variable `org-table-copy-increment' is non-nil and the field is an
8562 integer or a timestamp, it will be incremented while copying. In the case of
8563 a timestamp, if the cursor is on the year, change the year. If it is on the
8564 month or the day, change that. Point will stay on the current date field
8565 in order to easily repeat the interval."
8566 (interactive "p")
8567 (let* ((colpos (org-table-current-column))
8568 (col (current-column))
8569 (field (org-table-get-field))
8571 (beg (org-table-begin))
8572 txt)
8573 (org-table-check-inside-data-field)
8574 (if non-empty
8575 (progn
8576 (setq txt (org-trim field))
8577 (org-table-next-row)
8578 (org-table-blank-field))
8579 (save-excursion
8580 (setq txt
8581 (catch 'exit
8582 (while (progn (beginning-of-line 1)
8583 (re-search-backward org-table-dataline-regexp
8584 beg t))
8585 (org-table-goto-column colpos t)
8586 (if (and (looking-at
8588 (= (setq n (1- n)) 0))
8589 (throw 'exit (match-string 1))))))))
8590 (if txt
8591 (progn
8592 (if (and org-table-copy-increment
8593 (string-match "^[0-9]+$" txt))
8594 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8595 (insert txt)
8596 (move-to-column col)
8597 (if (and org-table-copy-increment (org-at-timestamp-p t))
8598 (org-timestamp-up 1)
8599 (org-table-maybe-recalculate-line))
8600 (org-table-align)
8601 (move-to-column col))
8602 (error "No non-empty field found"))))
8604 (defun org-table-check-inside-data-field ()
8605 "Is point inside a table data field?
8606 I.e. not on a hline or before the first or after the last column?
8607 This actually throws an error, so it aborts the current command."
8608 (if (or (not (org-at-table-p))
8609 (= (org-table-current-column) 0)
8610 (org-at-table-hline-p)
8612 (error "Not in table data field")))
8614 (defvar org-table-clip nil
8615 "Clipboard for table regions.")
8617 (defun org-table-blank-field ()
8618 "Blank the current table field or active region."
8619 (interactive)
8620 (org-table-check-inside-data-field)
8621 (if (and (interactive-p) (org-region-active-p))
8622 (let (org-table-clip)
8623 (org-table-cut-region (region-beginning) (region-end)))
8624 (skip-chars-backward "^|")
8625 (backward-char 1)
8627 (let* ((pos (match-beginning 0))
8628 (match (match-string 0))
8629 (len (org-string-width match)))
8630 (replace-match (concat "|" (make-string (1- len) ?\ )))
8631 (goto-char (+ 2 pos))
8632 (substring match 1)))))
8634 (defun org-table-get-field (&optional n replace)
8635 "Return the value of the field in column N of current row.
8636 N defaults to current field.
8637 If REPLACE is a string, replace field with this value. The return value
8638 is always the old value."
8639 (and n (org-table-goto-column n))
8641 (backward-char 1)
8643 (let* ((pos (match-beginning 0))
8644 (val (buffer-substring (1+ pos) (match-end 0))))
8645 (if replace
8646 (replace-match (concat "|" replace) t t))
8647 (goto-char (min (point-at-eol) (+ 2 pos)))
8648 val)
8649 (forward-char 1) ""))
8651 (defun org-table-field-info (arg)
8652 "Show info about the current field, and highlight any reference at point."
8653 (interactive "P")
8654 (org-table-get-specials)
8655 (save-excursion
8656 (let* ((pos (point))
8657 (col (org-table-current-column))
8658 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8659 (name (car (rassoc (list (org-current-line) col)
8660 org-table-named-field-locations)))
8661 (eql (org-table-get-stored-formulas))
8662 (dline (org-table-current-dline))
8663 (ref (format "@%d$%d" dline col))
8664 (ref1 (org-table-convert-refs-to-an ref))
8665 (fequation (or (assoc name eql) (assoc ref eql)))
8666 (cequation (assoc (int-to-string col) eql))
8667 (eqn (or fequation cequation)))
8668 (goto-char pos)
8669 (condition-case nil
8670 (org-table-show-reference 'local)
8671 (error nil))
8672 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8673 dline col
8674 (if cname (concat " or $" cname) "")
8675 dline col ref1
8676 (if name (concat " or $" name) "")
8677 ;; FIXME: formula info not correct if special table line
8678 (if eqn
8679 (concat ", formula: "
8680 (org-table-formula-to-user
8681 (concat
8682 (if (string-match "^[$@]"(car eqn)) "" "$")
8683 (car eqn) "=" (cdr eqn))))
8684 "")))))
8686 (defun org-table-current-column ()
8687 "Find out which column we are in.
8688 When called interactively, column is also displayed in echo area."
8689 (interactive)
8690 (if (interactive-p) (org-table-check-inside-data-field))
8691 (save-excursion
8692 (let ((cnt 0) (pos (point)))
8693 (beginning-of-line 1)
8694 (while (search-forward "|" pos t)
8695 (setq cnt (1+ cnt)))
8696 (if (interactive-p) (message "This is table column %d" cnt))
8697 cnt)))
8699 (defun org-table-current-dline ()
8700 "Find out what table data line we are in.
8701 Only datalins count for this."
8702 (interactive)
8703 (if (interactive-p) (org-table-check-inside-data-field))
8704 (save-excursion
8705 (let ((cnt 0) (pos (point)))
8706 (goto-char (org-table-begin))
8707 (while (<= (point) pos)
8708 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8709 (beginning-of-line 2))
8710 (if (interactive-p) (message "This is table line %d" cnt))
8711 cnt)))
8713 (defun org-table-goto-column (n &optional on-delim force)
8714 "Move the cursor to the Nth column in the current table line.
8715 With optional argument ON-DELIM, stop with point before the left delimiter
8716 of the field.
8717 If there are less than N fields, just go to after the last delimiter.
8718 However, when FORCE is non-nil, create new columns if necessary."
8719 (interactive "p")
8720 (let ((pos (point-at-eol)))
8721 (beginning-of-line 1)
8722 (when (> n 0)
8723 (while (and (> (setq n (1- n)) -1)
8724 (or (search-forward "|" pos t)
8725 (and force
8726 (progn (end-of-line 1)
8727 (skip-chars-backward "^|")
8728 (insert " | "))))))
8729 ; (backward-char 2) t)))))
8730 (when (and force (not (looking-at ".*|")))
8731 (save-excursion (end-of-line 1) (insert " | ")))
8732 (if on-delim
8733 (backward-char 1)
8734 (if (looking-at " ") (forward-char 1))))))
8736 (defun org-at-table-p (&optional table-type)
8737 "Return t if the cursor is inside an org-type table.
8738 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8739 (if org-enable-table-editor
8740 (save-excursion
8741 (beginning-of-line 1)
8742 (looking-at (if table-type org-table-any-line-regexp
8743 org-table-line-regexp)))
8744 nil))
8746 (defun org-at-table.el-p ()
8747 "Return t if and only if we are at a table.el table."
8748 (and (org-at-table-p 'any)
8749 (save-excursion
8750 (goto-char (org-table-begin 'any))
8751 (looking-at org-table1-hline-regexp))))
8753 (defun org-table-recognize-table.el ()
8754 "If there is a table.el table nearby, recognize it and move into it."
8755 (if org-table-tab-recognizes-table.el
8756 (if (org-at-table.el-p)
8757 (progn
8758 (beginning-of-line 1)
8759 (if (looking-at org-table-dataline-regexp)
8760 nil
8761 (if (looking-at org-table1-hline-regexp)
8762 (progn
8763 (beginning-of-line 2)
8764 (if (looking-at org-table-any-border-regexp)
8765 (beginning-of-line -1)))))
8766 (if (re-search-forward "|" (org-table-end t) t)
8767 (progn
8768 (require 'table)
8769 (if (table--at-cell-p (point))
8770 t
8771 (message "recognizing table.el table...")
8772 (table-recognize-table)
8773 (message "recognizing table.el table...done")))
8774 (error "This should not happen..."))
8775 t)
8776 nil)
8777 nil))
8779 (defun org-at-table-hline-p ()
8780 "Return t if the cursor is inside a hline in a table."
8781 (if org-enable-table-editor
8782 (save-excursion
8783 (beginning-of-line 1)
8784 (looking-at org-table-hline-regexp))
8785 nil))
8787 (defun org-table-insert-column ()
8788 "Insert a new column into the table."
8789 (interactive)
8790 (if (not (org-at-table-p))
8791 (error "Not at a table"))
8792 (org-table-find-dataline)
8793 (let* ((col (max 1 (org-table-current-column)))
8794 (beg (org-table-begin))
8795 (end (org-table-end))
8796 ;; Current cursor position
8797 (linepos (org-current-line))
8798 (colpos col))
8799 (goto-char beg)
8800 (while (< (point) end)
8801 (if (org-at-table-hline-p)
8802 nil
8803 (org-table-goto-column col t)
8804 (insert "| "))
8805 (beginning-of-line 2))
8806 (move-marker end nil)
8807 (goto-line linepos)
8808 (org-table-goto-column colpos)
8809 (org-table-align)
8810 (org-table-fix-formulas "$" nil (1- col) 1)))
8812 (defun org-table-find-dataline ()
8813 "Find a dataline in the current table, which is needed for column commands."
8814 (if (and (org-at-table-p)
8815 (not (org-at-table-hline-p)))
8816 t
8817 (let ((col (current-column))
8818 (end (org-table-end)))
8819 (move-to-column col)
8820 (while (and (< (point) end)
8821 (or (not (= (current-column) col))
8822 (org-at-table-hline-p)))
8823 (beginning-of-line 2)
8824 (move-to-column col))
8825 (if (and (org-at-table-p)
8826 (not (org-at-table-hline-p)))
8827 t
8828 (error
8829 "Please position cursor in a data line for column operations")))))
8831 (defun org-table-delete-column ()
8832 "Delete a column from the table."
8833 (interactive)
8834 (if (not (org-at-table-p))
8835 (error "Not at a table"))
8836 (org-table-find-dataline)
8837 (org-table-check-inside-data-field)
8838 (let* ((col (org-table-current-column))
8839 (beg (org-table-begin))
8840 (end (org-table-end))
8841 ;; Current cursor position
8842 (linepos (org-current-line))
8843 (colpos col))
8844 (goto-char beg)
8845 (while (< (point) end)
8846 (if (org-at-table-hline-p)
8847 nil
8848 (org-table-goto-column col t)
8850 (replace-match "|")))
8851 (beginning-of-line 2))
8852 (move-marker end nil)
8853 (goto-line linepos)
8854 (org-table-goto-column colpos)
8855 (org-table-align)
8856 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
8857 col -1 col)))
8859 (defun org-table-move-column-right ()
8860 "Move column to the right."
8861 (interactive)
8862 (org-table-move-column nil))
8863 (defun org-table-move-column-left ()
8864 "Move column to the left."
8865 (interactive)
8866 (org-table-move-column 'left))
8868 (defun org-table-move-column (&optional left)
8869 "Move the current column to the right. With arg LEFT, move to the left."
8870 (interactive "P")
8871 (if (not (org-at-table-p))
8872 (error "Not at a table"))
8873 (org-table-find-dataline)
8874 (org-table-check-inside-data-field)
8875 (let* ((col (org-table-current-column))
8876 (col1 (if left (1- col) col))
8877 (beg (org-table-begin))
8878 (end (org-table-end))
8879 ;; Current cursor position
8880 (linepos (org-current-line))
8881 (colpos (if left (1- col) (1+ col))))
8882 (if (and left (= col 1))
8883 (error "Cannot move column further left"))
8885 (error "Cannot move column further right"))
8886 (goto-char beg)
8887 (while (< (point) end)
8888 (if (org-at-table-hline-p)
8889 nil
8890 (org-table-goto-column col1 t)
8893 (beginning-of-line 2))
8894 (move-marker end nil)
8895 (goto-line linepos)
8896 (org-table-goto-column colpos)
8897 (org-table-align)
8898 (org-table-fix-formulas
8899 "$" (list (cons (number-to-string col) (number-to-string colpos))
8900 (cons (number-to-string colpos) (number-to-string col))))))
8902 (defun org-table-move-row-down ()
8903 "Move table row down."
8904 (interactive)
8905 (org-table-move-row nil))
8906 (defun org-table-move-row-up ()
8907 "Move table row up."
8908 (interactive)
8909 (org-table-move-row 'up))
8911 (defun org-table-move-row (&optional up)
8912 "Move the current table line down. With arg UP, move it up."
8913 (interactive "P")
8914 (let* ((col (current-column))
8915 (pos (point))
8916 (hline1p (save-excursion (beginning-of-line 1)
8917 (looking-at org-table-hline-regexp)))
8918 (dline1 (org-table-current-dline))
8919 (dline2 (+ dline1 (if up -1 1)))
8920 (tonew (if up 0 2))
8921 txt hline2p)
8922 (beginning-of-line tonew)
8923 (unless (org-at-table-p)
8924 (goto-char pos)
8925 (error "Cannot move row further"))
8926 (setq hline2p (looking-at org-table-hline-regexp))
8927 (goto-char pos)
8928 (beginning-of-line 1)
8929 (setq pos (point))
8930 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
8931 (delete-region (point) (1+ (point-at-eol)))
8932 (beginning-of-line tonew)
8933 (insert txt)
8934 (beginning-of-line 0)
8935 (move-to-column col)
8936 (unless (or hline1p hline2p)
8937 (org-table-fix-formulas
8938 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
8939 (cons (number-to-string dline2) (number-to-string dline1)))))))
8941 (defun org-table-insert-row (&optional arg)
8942 "Insert a new row above the current line into the table.
8943 With prefix ARG, insert below the current line."
8944 (interactive "P")
8945 (if (not (org-at-table-p))
8946 (error "Not at a table"))
8947 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
8948 (new (org-table-clean-line line)))
8949 ;; Fix the first field if necessary
8951 (setq new (replace-match (match-string 0 line) t t new)))
8952 (beginning-of-line (if arg 2 1))
8954 (beginning-of-line 0)
8955 (re-search-forward "| ?" (point-at-eol) t)
8956 (and (or org-table-may-need-update org-table-overlay-coordinates)
8957 (org-table-align))
8958 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
8960 (defun org-table-insert-hline (&optional above)
8961 "Insert a horizontal-line below the current line into the table.
8962 With prefix ABOVE, insert above the current line."
8963 (interactive "P")
8964 (if (not (org-at-table-p))
8965 (error "Not at a table"))
8966 (let ((line (org-table-clean-line
8967 (buffer-substring (point-at-bol) (point-at-eol))))
8968 (col (current-column)))
8970 (setq line (replace-match
8971 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
8972 ?-) "|") t t line)))
8974 (beginning-of-line (if above 1 2))
8976 (beginning-of-line (if above 1 -1))
8977 (move-to-column col)
8978 (and org-table-overlay-coordinates (org-table-align))))
8980 (defun org-table-hline-and-move (&optional same-column)
8981 "Insert a hline and move to the row below that line."
8982 (interactive "P")
8983 (let ((col (org-table-current-column)))
8984 (org-table-maybe-eval-formula)
8985 (org-table-maybe-recalculate-line)
8986 (org-table-insert-hline)
8987 (end-of-line 2)
8990 (org-table-next-field))
8991 (if same-column (org-table-goto-column col))))
8993 (defun org-table-clean-line (s)
8995 In particular, this does handle wide and invisible characters."
8997 ;; It's a hline, just map the characters
8998 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9000 (setq s (replace-match
9001 (concat "|" (make-string (org-string-width (match-string 1 s))
9002 ?\ ) "|")
9003 t t s)))
9004 s))
9006 (defun org-table-kill-row ()
9007 "Delete the current row or horizontal line from the table."
9008 (interactive)
9009 (if (not (org-at-table-p))
9010 (error "Not at a table"))
9011 (let ((col (current-column))
9012 (dline (org-table-current-dline)))
9013 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9014 (if (not (org-at-table-p)) (beginning-of-line 0))
9015 (move-to-column col)
9016 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9017 dline -1 dline)))
9019 (defun org-table-sort-lines (with-case &optional sorting-type)
9020 "Sort table lines according to the column at point.
9022 The position of point indicates the column to be used for
9023 sorting, and the range of lines is the range between the nearest
9024 horizontal separator lines, or the entire table of no such lines
9025 exist. If point is before the first column, you will be prompted
9026 for the sorting column. If there is an active region, the mark
9027 specifies the first line and the sorting column, while point
9028 should be in the last line to be included into the sorting.
9030 The command then prompts for the sorting type which can be
9031 alphabetically, numerically, or by time (as given in a time stamp
9032 in the field). Sorting in reverse order is also possible.
9034 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9036 If SORTING-TYPE is specified when this function is called from a Lisp
9037 program, no prompting will take place. SORTING-TYPE must be a character,
9038 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9039 should be done in reverse order."
9040 (interactive "P")
9041 (let* ((thisline (org-current-line))
9042 (thiscol (org-table-current-column))
9043 beg end bcol ecol tend tbeg column lns pos)
9044 (when (equal thiscol 0)
9045 (if (interactive-p)
9046 (setq thiscol
9047 (string-to-number
9048 (read-string "Use column N for sorting: ")))
9049 (setq thiscol 1))
9050 (org-table-goto-column thiscol))
9051 (org-table-check-inside-data-field)
9052 (if (org-region-active-p)
9053 (progn
9054 (setq beg (region-beginning) end (region-end))
9055 (goto-char beg)
9056 (setq column (org-table-current-column)
9057 beg (point-at-bol))
9058 (goto-char end)
9059 (setq end (point-at-bol 2)))
9060 (setq column (org-table-current-column)
9061 pos (point)
9062 tbeg (org-table-begin)
9063 tend (org-table-end))
9064 (if (re-search-backward org-table-hline-regexp tbeg t)
9065 (setq beg (point-at-bol 2))
9066 (goto-char tbeg)
9067 (setq beg (point-at-bol 1)))
9068 (goto-char pos)
9069 (if (re-search-forward org-table-hline-regexp tend t)
9070 (setq end (point-at-bol 1))
9071 (goto-char tend)
9072 (setq end (point-at-bol))))
9073 (setq beg (move-marker (make-marker) beg)
9074 end (move-marker (make-marker) end))
9075 (untabify beg end)
9076 (goto-char beg)
9077 (org-table-goto-column column)
9078 (skip-chars-backward "^|")
9079 (setq bcol (current-column))
9080 (org-table-goto-column (1+ column))
9081 (skip-chars-backward "^|")
9082 (setq ecol (1- (current-column)))
9083 (org-table-goto-column column)
9084 (setq lns (mapcar (lambda(x) (cons
9085 (org-sort-remove-invisible
9086 (nth (1- column)
9088 x))
9090 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9091 (delete-region beg end)
9092 (move-marker beg nil)
9093 (move-marker end nil)
9095 (goto-line thisline)
9096 (org-table-goto-column thiscol)
9097 (message "%d lines sorted, based on column %d" (length lns) column)))
9099 ;; FIXME: maybe we will not need this? Table sorting is broken....
9100 (defun org-sort-remove-invisible (s)
9101 (remove-text-properties 0 (length s) org-rm-props s)
9102 (while (string-match org-bracket-link-regexp s)
9103 (setq s (replace-match (if (match-end 2)
9104 (match-string 3 s)
9105 (match-string 1 s)) t t s)))
9106 s)
9108 (defun org-table-cut-region (beg end)
9109 "Copy region in table to the clipboard and blank all relevant fields."
9110 (interactive "r")
9111 (org-table-copy-region beg end 'cut))
9113 (defun org-table-copy-region (beg end &optional cut)
9114 "Copy rectangular region in table to clipboard.
9115 A special clipboard is used which can only be accessed
9116 with `org-table-paste-rectangle'."
9117 (interactive "rP")
9118 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9119 region cols
9120 (rpl (if cut " " nil)))
9121 (goto-char beg)
9122 (org-table-check-inside-data-field)
9123 (setq l01 (org-current-line)
9124 c01 (org-table-current-column))
9125 (goto-char end)
9126 (org-table-check-inside-data-field)
9127 (setq l02 (org-current-line)
9128 c02 (org-table-current-column))
9129 (setq l1 (min l01 l02) l2 (max l01 l02)
9130 c1 (min c01 c02) c2 (max c01 c02))
9131 (catch 'exit
9132 (while t
9133 (catch 'nextline
9134 (if (> l1 l2) (throw 'exit t))
9135 (goto-line l1)
9136 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9137 (setq cols nil ic1 c1 ic2 c2)
9138 (while (< ic1 (1+ ic2))
9139 (push (org-table-get-field ic1 rpl) cols)
9140 (setq ic1 (1+ ic1)))
9141 (push (nreverse cols) region)
9142 (setq l1 (1+ l1)))))
9143 (setq org-table-clip (nreverse region))
9144 (if cut (org-table-align))
9145 org-table-clip))
9147 (defun org-table-paste-rectangle ()
9148 "Paste a rectangular region into a table.
9149 The upper right corner ends up in the current field. All involved fields
9150 will be overwritten. If the rectangle does not fit into the present table,
9151 the table is enlarged as needed. The process ignores horizontal separator
9152 lines."
9153 (interactive)
9154 (unless (and org-table-clip (listp org-table-clip))
9155 (error "First cut/copy a region to paste!"))
9156 (org-table-check-inside-data-field)
9157 (let* ((clip org-table-clip)
9158 (line (org-current-line))
9159 (col (org-table-current-column))
9160 (org-enable-table-editor t)
9161 (org-table-automatic-realign nil)
9162 c cols field)
9163 (while (setq cols (pop clip))
9164 (while (org-at-table-hline-p) (beginning-of-line 2))
9165 (if (not (org-at-table-p))
9166 (progn (end-of-line 0) (org-table-next-field)))
9167 (setq c col)
9168 (while (setq field (pop cols))
9169 (org-table-goto-column c nil 'force)
9170 (org-table-get-field nil field)
9171 (setq c (1+ c)))
9172 (beginning-of-line 2))
9173 (goto-line line)
9174 (org-table-goto-column col)
9175 (org-table-align)))
9177 (defun org-table-convert ()
9178 "Convert from `org-mode' table to table.el and back.
9179 Obviously, this only works within limits. When an Org-mode table is
9180 converted to table.el, all horizontal separator lines get lost, because
9181 table.el uses these as cell boundaries and has no notion of horizontal lines.
9182 A table.el table can be converted to an Org-mode table only if it does not
9183 do row or column spanning. Multiline cells will become multiple cells.
9184 Beware, Org-mode does not test if the table can be successfully converted - it
9185 blindly applies a recipe that works for simple tables."
9186 (interactive)
9187 (require 'table)
9188 (if (org-at-table.el-p)
9189 ;; convert to Org-mode table
9190 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9191 (end (move-marker (make-marker) (org-table-end t))))
9192 (table-unrecognize-region beg end)
9193 (goto-char beg)
9195 (replace-match ""))
9196 (goto-char beg))
9197 (if (org-at-table-p)
9198 ;; convert to table.el table
9199 (let ((beg (move-marker (make-marker) (org-table-begin)))
9200 (end (move-marker (make-marker) (org-table-end))))
9201 ;; first, get rid of all horizontal lines
9202 (goto-char beg)
9204 (replace-match ""))
9205 ;; insert a hline before first
9206 (goto-char beg)
9207 (org-table-insert-hline 'above)
9208 (beginning-of-line -1)
9209 ;; insert a hline after each line
9210 (while (progn (beginning-of-line 3) (< (point) end))
9211 (org-table-insert-hline))
9212 (goto-char beg)
9213 (setq end (move-marker end (org-table-end)))
9214 ;; replace "+" at beginning and ending of hlines
9217 (goto-char beg)
9219 (replace-match "-+"))
9220 (goto-char beg)))))
9222 (defun org-table-wrap-region (arg)
9223 "Wrap several fields in a column like a paragraph.
9224 This is useful if you'd like to spread the contents of a field over several
9225 lines, in order to keep the table compact.
9227 If there is an active region, and both point and mark are in the same column,
9228 the text in the column is wrapped to minimum width for the given number of
9229 lines. Generally, this makes the table more compact. A prefix ARG may be
9231 formats the selected text to two lines. If the region was longer than two
9232 lines, the remaining lines remain empty. A negative prefix argument reduces
9233 the current number of lines by that amount. The wrapped text is pasted back
9234 into the table. If you formatted it to more lines than it was before, fields
9235 further down in the table get overwritten - so you might need to make space in
9236 the table first.
9238 If there is no region, the current field is split at the cursor position and
9239 the text fragment to the right of the cursor is prepended to the field one
9240 line down.
9242 If there is no region, but you specify a prefix ARG, the current field gets
9243 blank, and the content is appended to the field above."
9244 (interactive "P")
9245 (org-table-check-inside-data-field)
9246 (if (org-region-active-p)
9247 ;; There is a region: fill as a paragraph
9248 (let* ((beg (region-beginning))
9249 (cline (save-excursion (goto-char beg) (org-current-line)))
9250 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9251 nlines)
9252 (org-table-cut-region (region-beginning) (region-end))
9253 (if (> (length (car org-table-clip)) 1)
9254 (error "Region must be limited to single column"))
9255 (setq nlines (if arg
9256 (if (< arg 1)
9257 (+ (length org-table-clip) arg)
9258 arg)
9259 (length org-table-clip)))
9260 (setq org-table-clip
9261 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9262 nil nlines)))
9263 (goto-line cline)
9264 (org-table-goto-column ccol)
9265 (org-table-paste-rectangle))
9266 ;; No region, split the current field at point
9267 (if arg
9268 ;; combine with field above
9269 (let ((s (org-table-blank-field))
9270 (col (org-table-current-column)))
9271 (beginning-of-line 0)
9272 (while (org-at-table-hline-p) (beginning-of-line 0))
9273 (org-table-goto-column col)
9274 (skip-chars-forward "^|")
9275 (skip-chars-backward " ")
9276 (insert " " (org-trim s))
9277 (org-table-align))
9278 ;; split field
9280 (let ((s (match-string 1)))
9281 (replace-match " |")
9282 (goto-char (match-beginning 0))
9283 (org-table-next-row)
9284 (insert (org-trim s) " ")
9285 (org-table-align))))))
9287 (defvar org-field-marker nil)
9289 (defun org-table-edit-field (arg)
9290 "Edit table field in a different window.
9291 This is mainly useful for fields that contain hidden parts.
9293 it can be edited in place."
9294 (interactive "P")
9295 (if arg
9296 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9298 (remove-text-properties b e '(org-cwidth t invisible t
9299 display t intangible t))
9300 (if (and (boundp 'font-lock-mode) font-lock-mode)
9301 (font-lock-fontify-block)))
9302 (let ((pos (move-marker (make-marker) (point)))
9303 (field (org-table-get-field))
9304 (cw (current-window-configuration))
9305 p)
9306 (org-switch-to-buffer-other-window "*Org tmp*")
9307 (erase-buffer)
9309 (let ((org-inhibit-startup t)) (org-mode))
9310 (goto-char (setq p (point-max)))
9311 (insert (org-trim field))
9312 (remove-text-properties p (point-max)
9313 '(invisible t org-cwidth t display t
9314 intangible t))
9315 (goto-char p)
9316 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9317 (org-set-local 'org-window-configuration cw)
9318 (org-set-local 'org-field-marker pos)
9319 (message "Edit and finish with C-c C-c"))))
9321 (defun org-table-finish-edit-field ()
9322 "Finish editing a table data field.
9323 Remove all newline characters, insert the result into the table, realign
9324 the table and kill the editing buffer."
9325 (let ((pos org-field-marker)
9326 (cw org-window-configuration)
9327 (cb (current-buffer))
9328 text)
9329 (goto-char (point-min))
9332 (replace-match " "))
9333 (setq text (org-trim (buffer-string)))
9334 (set-window-configuration cw)
9335 (kill-buffer cb)
9336 (select-window (get-buffer-window (marker-buffer pos)))
9337 (goto-char pos)
9338 (move-marker pos nil)
9339 (org-table-check-inside-data-field)
9340 (org-table-get-field nil text)
9341 (org-table-align)
9342 (message "New field value inserted")))
9344 (defun org-trim (s)
9345 "Remove whitespace at beginning and end of string."
9348 s)
9350 (defun org-wrap (string &optional width lines)
9351 "Wrap string to either a number of lines, or a width in characters.
9352 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9353 that costs. If there is a word longer than WIDTH, the text is actually
9354 wrapped to the length of that word.
9355 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9356 many lines, whatever width that takes.
9357 The return value is a list of lines, without newlines at the end."
9359 (maxword (apply 'max (mapcar 'org-string-width words)))
9360 w ll)
9361 (cond (width
9362 (org-do-wrap words (max maxword width)))
9363 (lines
9364 (setq w maxword)
9365 (setq ll (org-do-wrap words maxword))
9366 (if (<= (length ll) lines)
9367 ll
9368 (setq ll words)
9369 (while (> (length ll) lines)
9370 (setq w (1+ w))
9371 (setq ll (org-do-wrap words w)))
9372 ll))
9373 (t (error "Cannot wrap this")))))
9376 (defun org-do-wrap (words width)
9377 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9378 (let (lines line)
9379 (while words
9380 (setq line (pop words))
9381 (while (and words (< (+ (length line) (length (car words))) width))
9382 (setq line (concat line " " (pop words))))
9383 (setq lines (push line lines)))
9384 (nreverse lines)))
9386 (defun org-split-string (string &optional separators)
9387 "Splits STRING into substrings at SEPARATORS.
9388 No empty strings are returned if there are matches at the beginning
9389 and end of string."
9391 (start 0)
9392 notfirst
9393 (list nil))
9394 (while (and (string-match rexp string
9395 (if (and notfirst
9396 (= start (match-beginning 0))
9397 (< start (length string)))
9398 (1+ start) start))
9399 (< (match-beginning 0) (length string)))
9400 (setq notfirst t)
9401 (or (eq (match-beginning 0) 0)
9402 (and (eq (match-beginning 0) (match-end 0))
9403 (eq (match-beginning 0) start))
9404 (setq list
9405 (cons (substring string start (match-beginning 0))
9406 list)))
9407 (setq start (match-end 0)))
9408 (or (eq start (length string))
9409 (setq list
9410 (cons (substring string start)
9411 list)))
9412 (nreverse list)))
9414 (defun org-table-map-tables (function)
9415 "Apply FUNCTION to the start of all tables in the buffer."
9416 (save-excursion
9417 (save-restriction
9418 (widen)
9419 (goto-char (point-min))
9420 (while (re-search-forward org-table-any-line-regexp nil t)
9421 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9422 (beginning-of-line 1)
9423 (if (looking-at org-table-line-regexp)
9424 (save-excursion (funcall function)))
9425 (re-search-forward org-table-any-border-regexp nil 1))))
9426 (message "Mapping tables: done"))
9428 (defvar org-timecnt) ; dynamically scoped parameter
9430 (defun org-table-sum (&optional beg end nlast)
9431 "Sum numbers in region of current table column.
9432 The result will be displayed in the echo area, and will be available
9435 If there is an active region, it is interpreted as a rectangle and all
9436 numbers in that rectangle will be summed. If there is no active
9437 region and point is located in a table column, sum all numbers in that
9438 column.
9440 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9441 numbers are assumed to be times as well (in decimal hours) and the
9442 numbers are added as such.
9444 If NLAST is a number, only the NLAST fields will actually be summed."
9445 (interactive)
9446 (save-excursion
9447 (let (col (org-timecnt 0) diff h m s org-table-clip)
9448 (cond
9449 ((and beg end)) ; beg and end given explicitly
9450 ((org-region-active-p)
9451 (setq beg (region-beginning) end (region-end)))
9452 (t
9453 (setq col (org-table-current-column))
9454 (goto-char (org-table-begin))
9456 (error "No table data"))
9457 (org-table-goto-column col)
9458 (setq beg (point))
9459 (goto-char (org-table-end))
9461 (error "No table data"))
9462 (org-table-goto-column col)
9463 (setq end (point))))
9464 (let* ((items (apply 'append (org-table-copy-region beg end)))
9465 (items1 (cond ((not nlast) items)
9466 ((>= nlast (length items)) items)
9467 (t (setq items (reverse items))
9468 (setcdr (nthcdr (1- nlast) items) nil)
9469 (nreverse items))))
9470 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9471 items1)))
9472 (res (apply '+ numbers))
9473 (sres (if (= org-timecnt 0)
9474 (format "%g" res)
9475 (setq diff (* 3600 res)
9476 h (floor (/ diff 3600)) diff (mod diff 3600)
9477 m (floor (/ diff 60)) diff (mod diff 60)
9478 s diff)
9479 (format "%d:%02d:%02d" h m s))))
9480 (kill-new sres)
9481 (if (interactive-p)
9482 (message "%s"
9483 (substitute-command-keys
9485 (length numbers) sres))))
9486 sres))))
9488 (defun org-table-get-number-for-summing (s)
9489 (let (n)
9490 (if (string-match "^ *|? *" s)
9491 (setq s (replace-match "" nil nil s)))
9492 (if (string-match " *|? *$" s)
9493 (setq s (replace-match "" nil nil s)))
9494 (setq n (string-to-number s))
9495 (cond
9496 ((and (string-match "0" s)
9500 (let ((h (string-to-number (or (match-string 1 s) "0")))
9501 (m (string-to-number (or (match-string 2 s) "0")))
9502 (s (string-to-number (or (match-string 4 s) "0"))))
9503 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9504 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9505 ((equal n 0) nil)
9506 (t n))))
9508 (defun org-table-current-field-formula (&optional key noerror)
9509 "Return the formula active for the current field.
9510 Assumes that specials are in place.
9511 If KEY is given, return the key to this formula.
9513 (let* ((name (car (rassoc (list (org-current-line)
9514 (org-table-current-column))
9515 org-table-named-field-locations)))
9516 (col (org-table-current-column))
9517 (scol (int-to-string col))
9518 (ref (format "@%d$%d" (org-table-current-dline) col))
9519 (stored-list (org-table-get-stored-formulas noerror))
9520 (ass (or (assoc name stored-list)
9521 (assoc ref stored-list)
9522 (assoc scol stored-list))))
9523 (if key
9524 (car ass)
9525 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9526 (cdr ass))))))
9528 (defun org-table-get-formula (&optional equation named)
9529 "Read a formula from the minibuffer, offer stored formula as default.
9530 When NAMED is non-nil, look for a named equation."
9531 (let* ((stored-list (org-table-get-stored-formulas))
9532 (name (car (rassoc (list (org-current-line)
9533 (org-table-current-column))
9534 org-table-named-field-locations)))
9535 (ref (format "@%d$%d" (org-table-current-dline)
9536 (org-table-current-column)))
9537 (refass (assoc ref stored-list))
9538 (scol (if named
9539 (if name name ref)
9540 (int-to-string (org-table-current-column))))
9541 (dummy (and (or name refass) (not named)
9542 (not (y-or-n-p "Replace field formula with column formula? " ))
9543 (error "Abort")))
9544 (name (or name ref))
9545 (org-table-may-need-update nil)
9546 (stored (cdr (assoc scol stored-list)))
9547 (eq (cond
9548 ((and stored equation (string-match "^ *=? *$" equation))
9549 stored)
9550 ((stringp equation)
9551 equation)
9552 (t (org-table-formula-from-user
9553 (read-string
9554 (org-table-formula-to-user
9555 (format "%s formula %s%s="
9556 (if named "Field" "Column")
9557 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9558 scol))
9559 (if stored (org-table-formula-to-user stored) "")
9560 'org-table-formula-history
9561 )))))
9562 mustsave)
9564 ;; remove formula
9565 (setq stored-list (delq (assoc scol stored-list) stored-list))
9566 (org-table-store-formulas stored-list)
9567 (error "Formula removed"))
9568 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9569 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9570 (if (and name (not named))
9571 ;; We set the column equation, delete the named one.
9572 (setq stored-list (delq (assoc name stored-list) stored-list)
9573 mustsave t))
9574 (if stored
9575 (setcdr (assoc scol stored-list) eq)
9576 (setq stored-list (cons (cons scol eq) stored-list)))
9577 (if (or mustsave (not (equal stored eq)))
9578 (org-table-store-formulas stored-list))
9579 eq))
9581 (defun org-table-store-formulas (alist)
9582 "Store the list of formulas below the current table."
9583 (setq alist (sort alist 'org-table-formula-less-p))
9584 (save-excursion
9585 (goto-char (org-table-end))
9587 (progn
9588 ;; don't overwrite TBLFM, we might use text properties to store stuff
9589 (goto-char (match-beginning 2))
9590 (delete-region (match-beginning 2) (match-end 0)))
9591 (insert "#+TBLFM:"))
9592 (insert " "
9593 (mapconcat (lambda (x)
9594 (concat
9595 (if (equal (string-to-char (car x)) ?@) "" "$")
9596 (car x) "=" (cdr x)))
9597 alist "::")
9600 (defsubst org-table-formula-make-cmp-string (a)
9602 (concat
9603 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9604 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9605 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9607 (defun org-table-formula-less-p (a b)
9608 "Compare two formulas for sorting."
9609 (let ((as (org-table-formula-make-cmp-string (car a)))
9610 (bs (org-table-formula-make-cmp-string (car b))))
9611 (and as bs (string< as bs))))
9613 (defun org-table-get-stored-formulas (&optional noerror)
9614 "Return an alist with the stored formulas directly after current table."
9615 (interactive)
9616 (let (scol eq eq-alist strings string seen)
9617 (save-excursion
9618 (goto-char (org-table-end))
9620 (setq strings (org-split-string (match-string 2) " *:: *"))
9621 (while (setq string (pop strings))
9622 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9623 (setq scol (if (match-end 2)
9624 (match-string 2 string)
9625 (match-string 1 string))
9626 eq (match-string 3 string)
9627 eq-alist (cons (cons scol eq) eq-alist))
9628 (if (member scol seen)
9629 (if noerror
9630 (progn
9631 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9632 (ding)
9633 (sit-for 2))
9634 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9635 (push scol seen))))))
9636 (nreverse eq-alist)))
9638 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9639 "Modify the equations after the table structure has been edited.
9641 For all numbers larger than LIMIT, shift them by DELTA."
9642 (save-excursion
9643 (goto-char (org-table-end))
9646 (re2
9647 (when remove
9648 (if (equal key "$")
9651 s n a)
9652 (when remove
9653 (while (re-search-forward re2 (point-at-eol) t)
9654 (replace-match "")))
9655 (while (re-search-forward re (point-at-eol) t)
9656 (setq s (match-string 1) n (string-to-number s))
9657 (cond
9658 ((setq a (assoc s replace))
9659 (replace-match (concat key (cdr a)) t t))
9660 ((and limit (> n limit))
9661 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9663 (defun org-table-get-specials ()
9664 "Get the column names and local parameters for this table."
9665 (save-excursion
9666 (let ((beg (org-table-begin)) (end (org-table-end))
9667 names name fields fields1 field cnt
9668 c v l line col types dlines hlines)
9669 (setq org-table-column-names nil
9670 org-table-local-parameters nil
9671 org-table-named-field-locations nil
9672 org-table-current-begin-line nil
9673 org-table-current-begin-pos nil
9674 org-table-current-line-types nil)
9675 (goto-char beg)
9677 (setq names (org-split-string (match-string 1) " *| *")
9678 cnt 1)
9679 (while (setq name (pop names))
9680 (setq cnt (1+ cnt))
9681 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9682 (push (cons name (int-to-string cnt)) org-table-column-names))))
9683 (setq org-table-column-names (nreverse org-table-column-names))
9684 (setq org-table-column-name-regexp
9686 (goto-char beg)
9688 (setq fields (org-split-string (match-string 1) " *| *"))
9689 (while (setq field (pop fields))
9691 (push (cons (match-string 1 field) (match-string 2 field))
9692 org-table-local-parameters))))
9693 (goto-char beg)
9695 (setq c (match-string 1)
9696 fields (org-split-string (match-string 2) " *| *"))
9697 (save-excursion
9698 (beginning-of-line (if (equal c "_") 2 0))
9699 (setq line (org-current-line) col 1)
9701 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9702 (while (and fields1 (setq field (pop fields)))
9703 (setq v (pop fields1) col (1+ col))
9704 (when (and (stringp field) (stringp v)
9705 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9706 (push (cons field v) org-table-local-parameters)
9707 (push (list field line col) org-table-named-field-locations))))
9708 ;; Analyse the line types
9709 (goto-char beg)
9710 (setq org-table-current-begin-line (org-current-line)
9711 org-table-current-begin-pos (point)
9712 l org-table-current-begin-line)
9714 (push (if (match-end 1) 'hline 'dline) types)
9715 (if (match-end 1) (push l hlines) (push l dlines))
9716 (beginning-of-line 2)
9717 (setq l (1+ l)))
9718 (setq org-table-current-line-types (apply 'vector (nreverse types))
9719 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9720 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9722 (defun org-table-maybe-eval-formula ()
9724 If yes, store the formula and apply it."
9725 ;; We already know we are in a table. Get field will only return a formula
9726 ;; when appropriate. It might return a separator line, but no problem.
9727 (when org-table-formula-evaluate-inline
9728 (let* ((field (org-trim (or (org-table-get-field) "")))
9729 named eq)
9731 (setq named (equal (string-to-char field) ?:)
9732 eq (match-string 1 field))
9733 (if (or (fboundp 'calc-eval)
9734 (equal (substring eq 0 (min 2 (length eq))) "'("))
9735 (org-table-eval-formula (if named '(4) nil)
9736 (org-table-formula-from-user eq))
9737 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9739 (defvar org-recalc-commands nil
9740 "List of commands triggering the recalculation of a line.
9741 Will be filled automatically during use.")
9743 (defvar org-recalc-marks
9744 '((" " . "Unmarked: no special line, no automatic recalculation")
9745 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9746 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9747 ("!" . "Column name definition line. Reference in formula as $name.")
9748 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9749 ("_" . "Names for values in row below this one.")
9750 ("^" . "Names for values in row above this one.")))
9752 (defun org-table-rotate-recalc-marks (&optional newchar)
9753 "Rotate the recalculation mark in the first column.
9754 If in any row, the first field is not consistent with a mark,
9755 insert a new column for the markers.
9756 When there is an active region, change all the lines in the region,
9757 after prompting for the marking character.
9758 After each change, a message will be displayed indicating the meaning
9759 of the new mark."
9760 (interactive)
9761 (unless (org-at-table-p) (error "Not at a table"))
9762 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9763 (beg (org-table-begin))
9764 (end (org-table-end))
9765 (l (org-current-line))
9766 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9767 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9768 (have-col
9769 (save-excursion
9770 (goto-char beg)
9772 (col (org-table-current-column))
9773 (forcenew (car (assoc newchar org-recalc-marks)))
9774 epos new)
9775 (when l1
9776 (message "Change region to what mark? Type # * ! $ or SPC: ")
9777 (setq newchar (char-to-string (read-char-exclusive))
9778 forcenew (car (assoc newchar org-recalc-marks))))
9779 (if (and newchar (not forcenew))
9780 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9781 newchar))
9782 (if l1 (goto-line l1))
9783 (save-excursion
9784 (beginning-of-line 1)
9785 (unless (looking-at org-table-dataline-regexp)
9786 (error "Not at a table data line")))
9787 (unless have-col
9788 (org-table-goto-column 1)
9789 (org-table-insert-column)
9790 (org-table-goto-column (1+ col)))
9791 (setq epos (point-at-eol))
9792 (save-excursion
9793 (beginning-of-line 1)
9794 (org-table-get-field
9796 (concat " "
9797 (setq new (or forcenew
9798 (cadr (member (match-string 1) marks))))
9799 " ")
9800 " # ")))
9801 (if (and l1 l2)
9802 (progn
9803 (goto-line l1)
9804 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9805 (and (looking-at org-table-dataline-regexp)
9806 (org-table-get-field 1 (concat " " new " "))))
9807 (goto-line l1)))
9808 (if (not (= epos (point-at-eol))) (org-table-align))
9809 (goto-line l)
9810 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
9812 (defun org-table-maybe-recalculate-line ()
9813 "Recompute the current line if marked for it, and if we haven't just done it."
9814 (interactive)
9815 (and org-table-allow-automatic-line-recalculation
9816 (not (and (memq last-command org-recalc-commands)
9817 (equal org-last-recalc-line (org-current-line))))
9818 (save-excursion (beginning-of-line 1)
9819 (looking-at org-table-auto-recalculate-regexp))
9820 (org-table-recalculate) t))
9822 (defvar org-table-formula-debug nil
9823 "Non-nil means, debug table formulas.
9825 (make-variable-buffer-local 'org-table-formula-debug)
9827 (defvar modes)
9828 (defsubst org-set-calc-mode (var &optional value)
9829 (if (stringp var)
9830 (setq var (assoc var '(("D" calc-angle-mode deg)
9831 ("R" calc-angle-mode rad)
9832 ("F" calc-prefer-frac t)
9833 ("S" calc-symbolic-mode t)))
9834 value (nth 2 var) var (nth 1 var)))
9835 (if (memq var modes)
9836 (setcar (cdr (memq var modes)) value)
9837 (cons var (cons value modes)))
9838 modes)
9840 (defun org-table-eval-formula (&optional arg equation
9841 suppress-align suppress-const
9842 suppress-store suppress-analysis)
9843 "Replace the table field value at the cursor by the result of a calculation.
9845 This function makes use of Dave Gillespie's Calc package, in my view the
9846 most exciting program ever written for GNU Emacs. So you need to have Calc
9847 installed in order to use this function.
9849 In a table, this command replaces the value in the current field with the
9851 formula, by storing it in a special line below the table. When called
9852 with a `C-u' prefix, the current field must ba a named field, and the
9853 formula is installed as valid in only this specific field.
9855 When called with two `C-u' prefixes, insert the active equation
9856 for the field back into the current field, so that it can be
9858 to check the referenced fields.
9860 When called, the command first prompts for a formula, which is read in
9861 the minibuffer. Previously entered formulas are available through the
9862 history list, and the last used formula is offered as a default.
9863 These stored formulas are adapted correctly when moving, inserting, or
9864 deleting columns with the corresponding commands.
9866 The formula can be any algebraic expression understood by the Calc package.
9867 For details, see the Org-mode manual.
9869 This function can also be called from Lisp programs and offers
9870 additional arguments: EQUATION can be the formula to apply. If this
9871 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
9872 used to speed-up recursive calls by by-passing unnecessary aligns.
9873 SUPPRESS-CONST suppresses the interpretation of constants in the
9874 formula, assuming that this has been done already outside the function.
9875 SUPPRESS-STORE means the formula should not be stored, either because
9876 it is already stored, or because it is a modified equation that should
9877 not overwrite the stored one."
9878 (interactive "P")
9879 (org-table-check-inside-data-field)
9880 (or suppress-analysis (org-table-get-specials))
9881 (if (equal arg '(16))
9882 (let ((eq (org-table-current-field-formula)))
9883 (or eq (error "No equation active for current field"))
9884 (org-table-get-field nil eq)
9885 (org-table-align)
9886 (setq org-table-may-need-update t))
9887 (let* (fields
9888 (ndown (if (integerp arg) arg 1))
9889 (org-table-automatic-realign nil)
9890 (case-fold-search nil)
9891 (down (> ndown 1))
9892 (formula (if (and equation suppress-store)
9893 equation
9894 (org-table-get-formula equation (equal arg '(4)))))
9895 (n0 (org-table-current-column))
9896 (modes (copy-sequence org-calc-default-modes))
9897 (numbers nil) ; was a variable, now fixed default
9898 (keep-empty nil)
9899 n form form0 bw fmt x ev orig c lispp literal)
9900 ;; Parse the format string. Since we have a lot of modes, this is
9901 ;; a lot of work. However, I think calc still uses most of the time.
9902 (if (string-match ";" formula)
9903 (let ((tmp (org-split-string formula ";")))
9904 (setq formula (car tmp)
9905 fmt (concat (cdr (assoc "%" org-table-local-parameters))
9906 (nth 1 tmp)))
9908 (setq c (string-to-char (match-string 1 fmt))
9909 n (string-to-number (match-string 2 fmt)))
9910 (if (= c ?p)
9911 (setq modes (org-set-calc-mode 'calc-internal-prec n))
9912 (setq modes (org-set-calc-mode
9913 'calc-float-format
9914 (list (cdr (assoc c '((?n . float) (?f . fix)
9915 (?s . sci) (?e . eng))))
9916 n))))
9917 (setq fmt (replace-match "" t t fmt)))
9918 (if (string-match "[NT]" fmt)
9919 (setq numbers (equal (match-string 0 fmt) "N")
9920 fmt (replace-match "" t t fmt)))
9921 (if (string-match "L" fmt)
9922 (setq literal t
9923 fmt (replace-match "" t t fmt)))
9924 (if (string-match "E" fmt)
9925 (setq keep-empty t
9926 fmt (replace-match "" t t fmt)))
9927 (while (string-match "[DRFS]" fmt)
9928 (setq modes (org-set-calc-mode (match-string 0 fmt)))
9929 (setq fmt (replace-match "" t t fmt)))
9931 (setq fmt nil))))
9932 (if (and (not suppress-const) org-table-formula-use-constants)
9933 (setq formula (org-table-formula-substitute-names formula)))
9934 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
9935 (while (> ndown 0)
9936 (setq fields (org-split-string
9937 (org-no-properties
9938 (buffer-substring (point-at-bol) (point-at-eol)))
9939 " *| *"))
9940 (if (eq numbers t)
9941 (setq fields (mapcar
9942 (lambda (x) (number-to-string (string-to-number x)))
9943 fields)))
9944 (setq ndown (1- ndown))
9945 (setq form (copy-sequence formula)
9946 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
9947 (if (and lispp literal) (setq lispp 'literal))
9948 ;; Check for old vertical references
9949 (setq form (org-rewrite-old-row-references form))
9950 ;; Insert complex ranges
9951 (while (string-match org-table-range-regexp form)
9952 (setq form
9953 (replace-match
9954 (save-match-data
9955 (org-table-make-reference
9956 (org-table-get-range (match-string 0 form) nil n0)
9957 keep-empty numbers lispp))
9958 t t form)))
9959 ;; Insert simple ranges
9961 (setq form
9962 (replace-match
9963 (save-match-data
9964 (org-table-make-reference
9965 (org-sublist
9966 fields (string-to-number (match-string 1 form))
9967 (string-to-number (match-string 2 form)))
9968 keep-empty numbers lispp))
9969 t t form)))
9970 (setq form0 form)
9971 ;; Insert the references to fields in same row
9973 (setq n (string-to-number (match-string 1 form))
9974 x (nth (1- (if (= n 0) n0 n)) fields))
9976 (match-string 0 form)))
9977 (setq form (replace-match
9978 (save-match-data
9979 (org-table-make-reference x nil numbers lispp))
9980 t t form)))
9982 (if lispp
9983 (setq ev (condition-case nil
9984 (eval (eval (read form)))
9985 (error "#ERROR"))
9986 ev (if (numberp ev) (number-to-string ev) ev))
9987 (or (fboundp 'calc-eval)
9988 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
9989 (setq ev (calc-eval (cons form modes)
9990 (if numbers 'num))))
9992 (when org-table-formula-debug
9993 (with-output-to-temp-buffer "*Substitution History*"
9994 (princ (format "Substitution history of formula
9995 Orig: %s
9996 $xyz-> %s
9997 @r$c-> %s
9999 (if (listp ev)
10001 (make-string (car ev) ?\-) (nth 1 ev)))
10003 ev (or fmt "NONE")
10004 (if fmt (format fmt (string-to-number ev)) ev)))))
10005 (setq bw (get-buffer-window "*Substitution History*"))
10006 (shrink-window-if-larger-than-buffer bw)
10007 (unless (and (interactive-p) (not ndown))
10008 (unless (let (inhibit-redisplay)
10009 (y-or-n-p "Debugging Formula. Continue to next? "))
10010 (org-table-align)
10011 (error "Abort"))
10012 (delete-window bw)
10013 (message "")))
10014 (if (listp ev) (setq fmt nil ev "#ERROR"))
10015 (org-table-justify-field-maybe
10016 (if fmt (format fmt (string-to-number ev)) ev))
10018 (call-interactively 'org-return)
10019 (setq ndown 0)))
10020 (and down (org-table-maybe-recalculate-line))
10021 (or suppress-align (and org-table-may-need-update
10022 (org-table-align))))))
10024 (defun org-table-put-field-property (prop value)
10025 (save-excursion
10026 (put-text-property (progn (skip-chars-backward "^|") (point))
10027 (progn (skip-chars-forward "^|") (point))
10028 prop value)))
10030 (defun org-table-get-range (desc &optional tbeg col highlight)
10031 "Get a calc vector from a column, accorting to descriptor DESC.
10032 Optional arguments TBEG and COL can give the beginning of the table and
10033 the current column, to avoid unnecessary parsing.
10034 HIGHLIGHT means, just highlight the range."
10035 (if (not (equal (string-to-char desc) ?@))
10036 (setq desc (concat "@" desc)))
10037 (save-excursion
10038 (or tbeg (setq tbeg (org-table-begin)))
10039 (or col (setq col (org-table-current-column)))
10040 (let ((thisline (org-current-line))
10041 beg end c1 c2 r1 r2 rangep tmp)
10042 (unless (string-match org-table-range-regexp desc)
10043 (error "Invalid table range specifier `%s'" desc))
10044 (setq rangep (match-end 3)
10045 r1 (and (match-end 1) (match-string 1 desc))
10046 r2 (and (match-end 4) (match-string 4 desc))
10047 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10048 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10050 (and c1 (setq c1 (+ (string-to-number c1)
10051 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10052 (and c2 (setq c2 (+ (string-to-number c2)
10053 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10054 (if (equal r1 "") (setq r1 nil))
10055 (if (equal r2 "") (setq r2 nil))
10056 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10057 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10058 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10059 (if (not r1) (setq r1 thisline))
10060 (if (not r2) (setq r2 thisline))
10061 (if (not c1) (setq c1 col))
10062 (if (not c2) (setq c2 col))
10063 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10064 ;; just one field
10065 (progn
10066 (goto-line r1)
10067 (while (not (looking-at org-table-dataline-regexp))
10068 (beginning-of-line 2))
10069 (prog1 (org-trim (org-table-get-field c1))
10070 (if highlight (org-table-highlight-rectangle (point) (point)))))
10071 ;; A range, return a vector
10072 ;; First sort the numbers to get a regular ractangle
10073 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10074 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10075 (goto-line r1)
10076 (while (not (looking-at org-table-dataline-regexp))
10077 (beginning-of-line 2))
10078 (org-table-goto-column c1)
10079 (setq beg (point))
10080 (goto-line r2)
10081 (while (not (looking-at org-table-dataline-regexp))
10082 (beginning-of-line 0))
10083 (org-table-goto-column c2)
10084 (setq end (point))
10085 (if highlight
10086 (org-table-highlight-rectangle
10088 ;; return string representation of calc vector
10089 (mapcar 'org-trim
10090 (apply 'append (org-table-copy-region beg end)))))))
10092 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10093 "Analyze descriptor DESC and retrieve the corresponding line number.
10094 The cursor is currently in line CLINE, the table begins in line BLINE,
10095 and TABLE is a vector with line types."
10096 (if (string-match "^[0-9]+$" desc)
10097 (aref org-table-dlines (string-to-number desc))
10098 (setq cline (or cline (org-current-line))
10099 bline (or bline org-table-current-begin-line)
10100 table (or table org-table-current-line-types))
10101 (if (or
10103 ;; 1 2 3 4 5 6
10104 (and (not (match-end 3)) (not (match-end 6)))
10105 (and (match-end 3) (match-end 6) (not (match-end 5))))
10106 (error "invalid row descriptor `%s'" desc))
10107 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10108 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10109 (odir (and (match-end 5) (match-string 5 desc)))
10110 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10111 (i (- cline bline))
10112 (rel (and (match-end 6)
10113 (or (and (match-end 1) (not (match-end 3)))
10114 (match-end 5)))))
10115 (if (and hn (not hdir))
10116 (progn
10117 (setq i 0 hdir "+")
10118 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10119 (if (and (not hn) on (not odir))
10120 (error "should never happen");;(aref org-table-dlines on)
10121 (if (and hn (> hn 0))
10122 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10123 (if on
10124 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10125 (+ bline i)))))
10127 (defun org-find-row-type (table i type backwards relative n)
10128 (let ((l (length table)))
10129 (while (> n 0)
10130 (while (and (setq i (+ i (if backwards -1 1)))
10131 (>= i 0) (< i l)
10132 (not (eq (aref table i) type))
10133 (if (and relative (eq (aref table i) 'hline))
10134 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10135 t)))
10136 (setq n (1- n)))
10137 (if (or (< i 0) (>= i l))
10138 (error "Row descriptior leads outside table")
10139 i)))
10141 (defun org-rewrite-old-row-references (s)
10142 (if (string-match "&[-+0-9I]" s)
10143 (error "Formula contains old &row reference, please rewrite using @-syntax")
10144 s))
10146 (defun org-table-make-reference (elements keep-empty numbers lispp)
10147 "Convert list ELEMENTS to something appropriate to insert into formula.
10148 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10149 NUMBERS indicates that everything should be converted to numbers.
10150 LISPP means to return something appropriate for a Lisp list."
10151 (if (stringp elements) ; just a single val
10152 (if lispp
10153 (if (eq lispp 'literal)
10154 elements
10155 (prin1-to-string (if numbers (string-to-number elements) elements)))
10156 (if (equal elements "") (setq elements "0"))
10157 (if numbers (number-to-string (string-to-number elements)) elements))
10158 (unless keep-empty
10159 (setq elements
10160 (delq nil
10162 elements))))
10163 (setq elements (or elements '("0")))
10164 (if lispp
10165 (mapconcat
10166 (lambda (x)
10167 (if (eq lispp 'literal)
10168 x
10169 (prin1-to-string (if numbers (string-to-number x) x))))
10170 elements " ")
10171 (concat "[" (mapconcat
10172 (lambda (x)
10173 (if numbers (number-to-string (string-to-number x)) x))
10174 elements
10175 ",") "]"))))
10177 (defun org-table-recalculate (&optional all noalign)
10178 "Recalculate the current table line by applying all stored formulas.
10179 With prefix arg ALL, do this for all lines in the table."
10180 (interactive "P")
10181 (or (memq this-command org-recalc-commands)
10182 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10183 (unless (org-at-table-p) (error "Not at a table"))
10184 (if (equal all '(16))
10185 (org-table-iterate)
10186 (org-table-get-specials)
10187 (let* ((eqlist (sort (org-table-get-stored-formulas)
10188 (lambda (a b) (string< (car a) (car b)))))
10189 (inhibit-redisplay (not debug-on-error))
10190 (line-re org-table-dataline-regexp)
10191 (thisline (org-current-line))
10192 (thiscol (org-table-current-column))
10193 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10194 ;; Insert constants in all formulas
10195 (setq eqlist
10196 (mapcar (lambda (x)
10197 (setcdr x (org-table-formula-substitute-names (cdr x)))
10198 x)
10199 eqlist))
10200 ;; Split the equation list
10201 (while (setq eq (pop eqlist))
10202 (if (<= (string-to-char (car eq)) ?9)
10203 (push eq eqlnum)
10204 (push eq eqlname)))
10205 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10206 (if all
10207 (progn
10208 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10209 (goto-char (setq beg (org-table-begin)))
10210 (if (re-search-forward org-table-calculate-mark-regexp end t)
10211 ;; This is a table with marked lines, compute selected lines
10212 (setq line-re org-table-recalculate-regexp)
10213 ;; Move forward to the first non-header line
10214 (if (and (re-search-forward org-table-dataline-regexp end t)
10215 (re-search-forward org-table-hline-regexp end t)
10216 (re-search-forward org-table-dataline-regexp end t))
10217 (setq beg (match-beginning 0))
10218 nil))) ;; just leave beg where it is
10219 (setq beg (point-at-bol)
10220 end (move-marker (make-marker) (1+ (point-at-eol)))))
10221 (goto-char beg)
10222 (and all (message "Re-applying formulas to full table..."))
10224 ;; First find the named fields, and mark them untouchanble
10225 (remove-text-properties beg end '(org-untouchable t))
10226 (while (setq eq (pop eqlname))
10227 (setq name (car eq)
10228 a (assoc name org-table-named-field-locations))
10229 (and (not a)
10231 (setq a (list name
10232 (aref org-table-dlines
10233 (string-to-number (match-string 1 name)))
10234 (string-to-number (match-string 2 name)))))
10235 (when (and a (or all (equal (nth 1 a) thisline)))
10236 (message "Re-applying formula to field: %s" name)
10237 (goto-line (nth 1 a))
10238 (org-table-goto-column (nth 2 a))
10239 (push (append a (list (cdr eq))) eqlname1)
10240 (org-table-put-field-property :org-untouchable t)))
10242 ;; Now evauluate the column formulas, but skip fields covered by
10243 ;; field formulas
10244 (goto-char beg)
10245 (while (re-search-forward line-re end t)
10246 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10247 ;; Unprotected line, recalculate
10248 (and all (message "Re-applying formulas to full table...(line %d)"
10249 (setq cnt (1+ cnt))))
10250 (setq org-last-recalc-line (org-current-line))
10251 (setq eql eqlnum)
10252 (while (setq entry (pop eql))
10253 (goto-line org-last-recalc-line)
10254 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10255 (unless (get-text-property (point) :org-untouchable)
10256 (org-table-eval-formula nil (cdr entry)
10257 'noalign 'nocst 'nostore 'noanalysis)))))
10259 ;; Now evaluate the field formulas
10260 (while (setq eq (pop eqlname1))
10261 (message "Re-applying formula to field: %s" (car eq))
10262 (goto-line (nth 1 eq))
10263 (org-table-goto-column (nth 2 eq))
10264 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10265 'nostore 'noanalysis))
10267 (goto-line thisline)
10268 (org-table-goto-column thiscol)
10269 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10270 (or noalign (and org-table-may-need-update (org-table-align))
10271 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10273 ;; back to initial position
10274 (message "Re-applying formulas...done")
10275 (goto-line thisline)
10276 (org-table-goto-column thiscol)
10277 (or noalign (and org-table-may-need-update (org-table-align))
10278 (and all (message "Re-applying formulas...done"))))))
10280 (defun org-table-iterate (&optional arg)
10281 "Recalculate the table until it does not change anymore."
10282 (interactive "P")
10283 (let ((imax (if arg (prefix-numeric-value arg) 10))
10284 (i 0)
10285 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10286 thistbl)
10287 (catch 'exit
10288 (while (< i imax)
10289 (setq i (1+ i))
10290 (org-table-recalculate 'all)
10291 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10292 (if (not (string= lasttbl thistbl))
10293 (setq lasttbl thistbl)
10294 (if (> i 1)
10295 (message "Convergence after %d iterations" i)
10296 (message "Table was already stable"))
10297 (throw 'exit t)))
10298 (error "No convergence after %d iterations" i))))
10300 (defun org-table-formula-substitute-names (f)
10301 "Replace $const with values in string F."
10302 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10303 ;; First, check for column names
10304 (while (setq start (string-match org-table-column-name-regexp f start))
10305 (setq start (1+ start))
10306 (setq a (assoc (match-string 1 f) org-table-column-names))
10307 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10308 ;; Parameters and constants
10309 (setq start 0)
10311 (setq start (1+ start))
10312 (if (setq a (save-match-data
10313 (org-table-get-constant (match-string 1 f))))
10314 (setq f (replace-match
10315 (concat (if pp "(") a (if pp ")")) t t f))))
10316 (if org-table-formula-debug
10317 (put-text-property 0 (length f) :orig-formula f1 f))
10318 f))
10320 (defun org-table-get-constant (const)
10321 "Find the value for a parameter or constant in a formula.
10322 Parameters get priority."
10323 (or (cdr (assoc const org-table-local-parameters))
10324 (cdr (assoc const org-table-formula-constants-local))
10325 (cdr (assoc const org-table-formula-constants))
10326 (and (fboundp 'constants-get) (constants-get const))
10327 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10328 (org-entry-get nil (substring const 5) 'inherit))
10329 "#UNDEFINED_NAME"))
10331 (defvar org-table-fedit-map
10332 (let ((map (make-sparse-keymap)))
10333 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10334 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10335 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10336 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10337 (org-defkey map "\C-c?" 'org-table-show-reference)
10338 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10339 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10340 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10341 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10342 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10343 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10344 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10345 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10346 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10347 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10348 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10349 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10350 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10351 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10352 map))
10354 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10355 '("Edit-Formulas"
10356 ["Finish and Install" org-table-fedit-finish t]
10357 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10358 ["Abort" org-table-fedit-abort t]
10359 "--"
10360 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10361 ["Complete Lisp Symbol" lisp-complete-symbol t]
10362 "--"
10363 "Shift Reference at Point"
10364 ["Up" org-table-fedit-ref-up t]
10365 ["Down" org-table-fedit-ref-down t]
10366 ["Left" org-table-fedit-ref-left t]
10367 ["Right" org-table-fedit-ref-right t]
10368 "-"
10369 "Change Test Row for Column Formulas"
10370 ["Up" org-table-fedit-line-up t]
10371 ["Down" org-table-fedit-line-down t]
10372 "--"
10373 ["Scroll Table Window" org-table-fedit-scroll t]
10374 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10375 ["Show Table Grid" org-table-fedit-toggle-coordinates
10376 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10377 org-table-overlay-coordinates)]
10378 "--"
10379 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10380 :style toggle :selected org-table-buffer-is-an]))
10382 (defvar org-pos)
10384 (defun org-table-edit-formulas ()
10385 "Edit the formulas of the current table in a separate buffer."
10386 (interactive)
10388 (beginning-of-line 0))
10389 (unless (org-at-table-p) (error "Not at a table"))
10390 (org-table-get-specials)
10391 (let ((key (org-table-current-field-formula 'key 'noerror))
10392 (eql (sort (org-table-get-stored-formulas 'noerror)
10393 'org-table-formula-less-p))
10394 (pos (move-marker (make-marker) (point)))
10395 (startline 1)
10396 (wc (current-window-configuration))
10400 entry s type title)
10401 (org-switch-to-buffer-other-window "*Edit Formulas*")
10402 (erase-buffer)
10403 ;; Keep global-font-lock-mode from turning on font-lock-mode
10404 (let ((font-lock-global-modes '(not fundamental-mode)))
10405 (fundamental-mode))
10406 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10407 (org-set-local 'org-pos pos)
10408 (org-set-local 'org-window-configuration wc)
10409 (use-local-map org-table-fedit-map)
10410 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10411 (easy-menu-add org-table-fedit-menu)
10412 (setq startline (org-current-line))
10413 (while (setq entry (pop eql))
10414 (setq type (cond
10415 ((equal (string-to-char (car entry)) ?@) 'field)
10416 ((string-match "^[0-9]" (car entry)) 'column)
10417 (t 'named)))
10418 (when (setq title (assq type titles))
10420 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10421 (setq titles (delq title titles)))
10422 (if (equal key (car entry)) (setq startline (org-current-line)))
10423 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10425 (remove-text-properties 0 (length s) '(face nil) s)
10426 (insert s))
10427 (if (eq org-table-use-standard-references t)
10428 (org-table-fedit-toggle-ref-type))
10429 (goto-line startline)
10430 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10432 (defun org-table-fedit-post-command ()
10433 (when (not (memq this-command '(lisp-complete-symbol)))
10434 (let ((win (selected-window)))
10435 (save-excursion
10436 (condition-case nil
10437 (org-table-show-reference)
10438 (error nil))
10439 (select-window win)))))
10441 (defun org-table-formula-to-user (s)
10442 "Convert a formula from internal to user representation."
10443 (if (eq org-table-use-standard-references t)
10444 (org-table-convert-refs-to-an s)
10445 s))
10447 (defun org-table-formula-from-user (s)
10448 "Convert a formula from user to internal representation."
10449 (if org-table-use-standard-references
10450 (org-table-convert-refs-to-rc s)
10451 s))
10453 (defun org-table-convert-refs-to-rc (s)
10454 "Convert spreadsheet references from AB7 to @7$28.
10455 Works for single references, but also for entire formulas and even the
10456 full TBLFM line."
10457 (let ((start 0))
10459 (cond
10460 ((match-end 3)
10461 ;; format match, just advance
10462 (setq start (match-end 0)))
10463 ((and (> (match-beginning 0) 0)
10464 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10465 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10466 ;; 3.e5 or something like this.
10467 (setq start (match-end 0)))
10468 (t
10469 (setq start (match-beginning 0)
10470 s (replace-match
10471 (if (equal (match-string 2 s) "&")
10472 (format "$%d" (org-letters-to-number (match-string 1 s)))
10473 (format "@%d$%d"
10474 (string-to-number (match-string 2 s))
10475 (org-letters-to-number (match-string 1 s))))
10476 t t s)))))
10477 s))
10479 (defun org-table-convert-refs-to-an (s)
10480 "Convert spreadsheet references from to @7$28 to AB7.
10481 Works for single references, but also for entire formulas and even the
10482 full TBLFM line."
10484 (setq s (replace-match
10485 (format "%s%d"
10486 (org-number-to-letters
10487 (string-to-number (match-string 2 s)))
10488 (string-to-number (match-string 1 s)))
10489 t t s)))
10492 (org-number-to-letters
10493 (string-to-number (match-string 2 s))) "&")
10494 t nil s)))
10495 s)
10497 (defun org-letters-to-number (s)
10498 "Convert a base 26 number represented by letters into an integer.
10499 For example: AB -> 28."
10500 (let ((n 0))
10501 (setq s (upcase s))
10502 (while (> (length s) 0)
10503 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10504 s (substring s 1)))
10505 n))
10507 (defun org-number-to-letters (n)
10508 "Convert an integer into a base 26 number represented by letters.
10509 For example: 28 -> AB."
10510 (let ((s ""))
10511 (while (> n 0)
10512 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10513 n (/ (1- n) 26)))
10514 s))
10516 (defun org-table-fedit-convert-buffer (function)
10517 "Convert all references in this buffer, using FUNTION."
10518 (let ((line (org-current-line)))
10519 (goto-char (point-min))
10520 (while (not (eobp))
10521 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10522 (delete-region (point) (point-at-eol))
10523 (or (eobp) (forward-char 1)))
10524 (goto-line line)))
10526 (defun org-table-fedit-toggle-ref-type ()
10527 "Convert all references in the buffer from B3 to @3$2 and back."
10528 (interactive)
10529 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10530 (org-table-fedit-convert-buffer
10531 (if org-table-buffer-is-an
10532 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10533 (message "Reference type switched to %s"
10534 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10536 (defun org-table-fedit-ref-up ()
10537 "Shift the reference at point one row/hline up."
10538 (interactive)
10539 (org-table-fedit-shift-reference 'up))
10540 (defun org-table-fedit-ref-down ()
10541 "Shift the reference at point one row/hline down."
10542 (interactive)
10543 (org-table-fedit-shift-reference 'down))
10544 (defun org-table-fedit-ref-left ()
10545 "Shift the reference at point one field to the left."
10546 (interactive)
10547 (org-table-fedit-shift-reference 'left))
10548 (defun org-table-fedit-ref-right ()
10549 "Shift the reference at point one field to the right."
10550 (interactive)
10551 (org-table-fedit-shift-reference 'right))
10553 (defun org-table-fedit-shift-reference (dir)
10554 (cond
10556 (if (memq dir '(left right))
10557 (org-rematch-and-replace 1 (eq dir 'left))
10558 (error "Cannot shift reference in this direction")))
10560 ;; A B3-like reference
10561 (if (memq dir '(up down))
10562 (org-rematch-and-replace 2 (eq dir 'up))
10563 (org-rematch-and-replace 1 (eq dir 'left))))
10564 ((org-at-regexp-p
10566 ;; An internal reference
10567 (if (memq dir '(up down))
10568 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10569 (org-rematch-and-replace 5 (eq dir 'left))))))
10571 (defun org-rematch-and-replace (n &optional decr hline)
10572 "Re-match the group N, and replace it with the shifted refrence."
10573 (or (match-end n) (error "Cannot shift reference in this direction"))
10574 (goto-char (match-beginning n))
10575 (and (looking-at (regexp-quote (match-string n)))
10576 (replace-match (org-shift-refpart (match-string 0) decr hline)
10577 t t)))
10579 (defun org-shift-refpart (ref &optional decr hline)
10580 "Shift a refrence part REF.
10581 If DECR is set, decrease the references row/column, else increase.
10582 If HLINE is set, this may be a hline reference, it certainly is not
10583 a translation reference."
10584 (save-match-data
10585 (let* ((sign (string-match "^[-+]" ref)) n)
10587 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10588 (cond
10589 ((and hline (string-match "^I+" ref))
10590 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10591 (setq n (+ n (if decr -1 1)))
10592 (if (= n 0) (setq n (+ n (if decr -1 1))))
10593 (if sign
10594 (setq sign (if (< n 0) "-" "+") n (abs n))
10595 (setq n (max 1 n)))
10596 (concat sign (make-string n ?I)))
10598 ((string-match "^[0-9]+" ref)
10599 (setq n (string-to-number (concat sign ref)))
10600 (setq n (+ n (if decr -1 1)))
10601 (if sign
10602 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10603 (number-to-string (max 1 n))))
10605 ((string-match "^[a-zA-Z]+" ref)
10606 (org-number-to-letters
10607 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10609 (t (error "Cannot shift reference"))))))
10611 (defun org-table-fedit-toggle-coordinates ()
10612 "Toggle the display of coordinates in the refrenced table."
10613 (interactive)
10614 (let ((pos (marker-position org-pos)))
10615 (with-current-buffer (marker-buffer org-pos)
10616 (save-excursion
10617 (goto-char pos)
10618 (org-table-toggle-coordinate-overlays)))))
10620 (defun org-table-fedit-finish (&optional arg)
10621 "Parse the buffer for formula definitions and install them.
10622 With prefix ARG, apply the new formulas to the table."
10623 (interactive "P")
10624 (org-table-remove-rectangle-highlight)
10625 (if org-table-use-standard-references
10626 (progn
10627 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10628 (setq org-table-buffer-is-an nil)))
10629 (let ((pos org-pos) eql var form)
10630 (goto-char (point-min))
10631 (while (re-search-forward
10633 nil t)
10634 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10635 form (match-string 3))
10636 (setq form (org-trim form))
10637 (when (not (equal form ""))
10639 (setq form (replace-match " " t t form)))
10640 (when (assoc var eql)
10641 (error "Double formulas for %s" var))
10642 (push (cons var form) eql)))
10643 (setq org-pos nil)
10644 (set-window-configuration org-window-configuration)
10645 (select-window (get-buffer-window (marker-buffer pos)))
10646 (goto-char pos)
10647 (unless (org-at-table-p)
10648 (error "Lost table position - cannot install formulae"))
10649 (org-table-store-formulas eql)
10650 (move-marker pos nil)
10651 (kill-buffer "*Edit Formulas*")
10652 (if arg
10653 (org-table-recalculate 'all)
10654 (message "New formulas installed - press C-u C-c C-c to apply."))))
10656 (defun org-table-fedit-abort ()
10657 "Abort editing formulas, without installing the changes."
10658 (interactive)
10659 (org-table-remove-rectangle-highlight)
10660 (let ((pos org-pos))
10661 (set-window-configuration org-window-configuration)
10662 (select-window (get-buffer-window (marker-buffer pos)))
10663 (goto-char pos)
10664 (move-marker pos nil)
10665 (message "Formula editing aborted without installing changes")))
10667 (defun org-table-fedit-lisp-indent ()
10668 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10669 (interactive)
10670 (let ((pos (point)) beg end ind)
10671 (beginning-of-line 1)
10672 (cond
10674 (goto-char pos)
10675 (call-interactively 'lisp-indent-line))
10677 ((not (fboundp 'pp-buffer))
10678 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10679 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10680 (goto-char (- (match-end 0) 2))
10681 (setq beg (point))
10682 (setq ind (make-string (current-column) ?\ ))
10683 (condition-case nil (forward-sexp 1)
10684 (error
10685 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10686 (setq end (point))
10687 (save-restriction
10688 (narrow-to-region beg end)
10689 (if (eq last-command this-command)
10690 (progn
10691 (goto-char (point-min))
10692 (setq this-command nil)
10694 (replace-match " ")))
10695 (pp-buffer)
10696 (untabify (point-min) (point-max))
10697 (goto-char (1+ (point-min)))
10698 (while (re-search-forward "^." nil t)
10699 (beginning-of-line 1)
10700 (insert ind))
10701 (goto-char (point-max))
10702 (backward-delete-char 1)))
10703 (goto-char beg))
10704 (t nil))))
10706 (defvar org-show-positions nil)
10708 (defun org-table-show-reference (&optional local)
10709 "Show the location/value of the $ expression at point."
10710 (interactive)
10711 (org-table-remove-rectangle-highlight)
10712 (catch 'exit
10713 (let ((pos (if local (point) org-pos))
10714 (face2 'highlight)
10715 (org-inhibit-highlight-removal t)
10716 (win (selected-window))
10717 (org-show-positions nil)
10718 var name e what match dest)
10719 (if local (org-table-get-specials))
10720 (setq what (cond
10721 ((or (org-at-regexp-p org-table-range-regexp2)
10722 (org-at-regexp-p org-table-translate-regexp)
10723 (org-at-regexp-p org-table-range-regexp))
10724 (setq match
10725 (save-match-data
10726 (org-table-convert-refs-to-rc (match-string 0))))
10727 'range)
10730 ((not local) nil)
10731 (t (error "No reference at point")))
10732 match (and what (or match (match-string 0))))
10733 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10734 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10735 'secondary-selection))
10736 (org-add-hook 'before-change-functions
10737 'org-table-remove-rectangle-highlight)
10738 (if (eq what 'name) (setq var (substring match 1)))
10739 (when (eq what 'range)
10740 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10741 (setq match (org-table-formula-substitute-names match)))
10742 (unless local
10743 (save-excursion
10744 (end-of-line 1)
10746 (beginning-of-line 1)
10748 (setq dest
10749 (save-match-data
10750 (org-table-convert-refs-to-rc (match-string 1))))
10751 (org-table-add-rectangle-overlay
10752 (match-beginning 1) (match-end 1) face2))))
10753 (if (and (markerp pos) (marker-buffer pos))
10754 (if (get-buffer-window (marker-buffer pos))
10755 (select-window (get-buffer-window (marker-buffer pos)))
10756 (org-switch-to-buffer-other-window (get-buffer-window
10757 (marker-buffer pos)))))
10758 (goto-char pos)
10759 (org-table-force-dataline)
10760 (when dest
10761 (setq name (substring dest 1))
10762 (cond
10764 (setq e (assoc name org-table-named-field-locations))
10765 (goto-line (nth 1 e))
10766 (org-table-goto-column (nth 2 e)))
10768 (let ((l (string-to-number (match-string 1 dest)))
10769 (c (string-to-number (match-string 2 dest))))
10770 (goto-line (aref org-table-dlines l))
10771 (org-table-goto-column c)))
10772 (t (org-table-goto-column (string-to-number name))))
10773 (move-marker pos (point))
10774 (org-table-highlight-rectangle nil nil face2))
10775 (cond
10776 ((equal dest match))
10777 ((not match))
10778 ((eq what 'range)
10779 (condition-case nil
10780 (save-excursion
10781 (org-table-get-range match nil nil 'highlight))
10782 (error nil)))
10783 ((setq e (assoc var org-table-named-field-locations))
10784 (goto-line (nth 1 e))
10785 (org-table-goto-column (nth 2 e))
10786 (org-table-highlight-rectangle (point) (point))
10787 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10788 ((setq e (assoc var org-table-column-names))
10789 (org-table-goto-column (string-to-number (cdr e)))
10790 (org-table-highlight-rectangle (point) (point))
10791 (goto-char (org-table-begin))
10793 (org-table-end) t)
10794 (progn
10795 (goto-char (match-beginning 1))
10796 (org-table-highlight-rectangle)
10797 (message "Named column (column %s)" (cdr e)))
10798 (error "Column name not found")))
10799 ((eq what 'column)
10800 ;; column number
10801 (org-table-goto-column (string-to-number (substring match 1)))
10802 (org-table-highlight-rectangle (point) (point))
10803 (message "Column %s" (substring match 1)))
10804 ((setq e (assoc var org-table-local-parameters))
10805 (goto-char (org-table-begin))
10807 (progn
10808 (goto-char (match-beginning 1))
10809 (org-table-highlight-rectangle)
10810 (message "Local parameter."))
10811 (error "Parameter not found")))
10812 (t
10813 (cond
10814 ((not var) (error "No reference at point"))
10815 ((setq e (assoc var org-table-formula-constants-local))
10816 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10817 var (cdr e)))
10818 ((setq e (assoc var org-table-formula-constants))
10819 (message "Constant: $%s=%s in `org-table-formula-constants'."
10820 var (cdr e)))
10821 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10822 (message "Constant: $%s=%s, from `constants.el'%s."
10823 var e (format " (%s units)" constants-unit-system)))
10824 (t (error "Undefined name $%s" var)))))
10825 (goto-char pos)
10826 (when (and org-show-positions
10827 (not (memq this-command '(org-table-fedit-scroll
10828 org-table-fedit-scroll-down))))
10829 (push pos org-show-positions)
10830 (push org-table-current-begin-pos org-show-positions)
10831 (let ((min (apply 'min org-show-positions))
10832 (max (apply 'max org-show-positions)))
10833 (goto-char min) (recenter 0)
10834 (goto-char max)
10835 (or (pos-visible-in-window-p max) (recenter -1))))
10836 (select-window win))))
10838 (defun org-table-force-dataline ()
10839 "Make sure the cursor is in a dataline in a table."
10840 (unless (save-excursion
10841 (beginning-of-line 1)
10842 (looking-at org-table-dataline-regexp))
10843 (let* ((re org-table-dataline-regexp)
10844 (p1 (save-excursion (re-search-forward re nil 'move)))
10845 (p2 (save-excursion (re-search-backward re nil 'move))))
10846 (cond ((and p1 p2)
10847 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10848 p1 p2)))
10849 ((or p1 p2) (goto-char (or p1 p2)))
10850 (t (error "No table dataline around here"))))))
10852 (defun org-table-fedit-line-up ()
10853 "Move cursor one line up in the window showing the table."
10854 (interactive)
10855 (org-table-fedit-move 'previous-line))
10857 (defun org-table-fedit-line-down ()
10858 "Move cursor one line down in the window showing the table."
10859 (interactive)
10860 (org-table-fedit-move 'next-line))
10862 (defun org-table-fedit-move (command)
10863 "Move the cursor in the window shoinw the table.
10864 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
10865 (let ((org-table-allow-automatic-line-recalculation nil)
10866 (pos org-pos) (win (selected-window)) p)
10867 (select-window (get-buffer-window (marker-buffer org-pos)))
10868 (setq p (point))
10869 (call-interactively command)
10870 (while (and (org-at-table-p)
10871 (org-at-table-hline-p))
10872 (call-interactively command))
10873 (or (org-at-table-p) (goto-char p))
10874 (move-marker pos (point))
10875 (select-window win)))
10877 (defun org-table-fedit-scroll (N)
10878 (interactive "p")
10879 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
10880 (scroll-other-window N)))
10882 (defun org-table-fedit-scroll-down (N)
10883 (interactive "p")
10884 (org-table-fedit-scroll (- N)))
10886 (defvar org-table-rectangle-overlays nil)
10888 (defun org-table-add-rectangle-overlay (beg end &optional face)
10889 "Add a new overlay."
10890 (let ((ov (org-make-overlay beg end)))
10891 (org-overlay-put ov 'face (or face 'secondary-selection))
10892 (push ov org-table-rectangle-overlays)))
10894 (defun org-table-highlight-rectangle (&optional beg end face)
10895 "Highlight rectangular region in a table."
10896 (setq beg (or beg (point)) end (or end (point)))
10897 (let ((b (min beg end))
10898 (e (max beg end))
10899 l1 c1 l2 c2 tmp)
10900 (and (boundp 'org-show-positions)
10901 (setq org-show-positions (cons b (cons e org-show-positions))))
10902 (goto-char (min beg end))
10903 (setq l1 (org-current-line)
10904 c1 (org-table-current-column))
10905 (goto-char (max beg end))
10906 (setq l2 (org-current-line)
10907 c2 (org-table-current-column))
10908 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
10909 (goto-line l1)
10910 (beginning-of-line 1)
10911 (loop for line from l1 to l2 do
10912 (when (looking-at org-table-dataline-regexp)
10913 (org-table-goto-column c1)
10915 (org-table-goto-column c2)
10917 (org-table-add-rectangle-overlay beg end face))
10918 (beginning-of-line 2))
10919 (goto-char b))
10920 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
10922 (defun org-table-remove-rectangle-highlight (&rest ignore)
10923 "Remove the rectangle overlays."
10924 (unless org-inhibit-highlight-removal
10925 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
10926 (mapc 'org-delete-overlay org-table-rectangle-overlays)
10927 (setq org-table-rectangle-overlays nil)))
10929 (defvar org-table-coordinate-overlays nil
10930 "Collects the cooordinate grid overlays, so that they can be removed.")
10931 (make-variable-buffer-local 'org-table-coordinate-overlays)
10933 (defun org-table-overlay-coordinates ()
10934 "Add overlays to the table at point, to show row/column coordinates."
10935 (interactive)
10936 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10937 (setq org-table-coordinate-overlays nil)
10938 (save-excursion
10939 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
10940 (goto-char (org-table-begin))
10941 (while (org-at-table-p)
10942 (setq eol (point-at-eol))
10943 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
10944 (push ov org-table-coordinate-overlays)
10945 (setq hline (looking-at org-table-hline-regexp))
10946 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
10947 (format "%4d" (setq id (1+ id)))))
10948 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
10949 (when hline
10950 (setq ic 0)
10952 (setq beg (1+ (match-beginning 0))
10953 ic (1+ ic)
10954 s1 (concat "$" (int-to-string ic))
10955 s2 (org-number-to-letters ic)
10956 str (if (eq org-table-use-standard-references t) s2 s1))
10957 (setq ov (org-make-overlay beg (+ beg (length str))))
10958 (push ov org-table-coordinate-overlays)
10959 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
10960 (beginning-of-line 2)))))
10962 (defun org-table-toggle-coordinate-overlays ()
10963 "Toggle the display of Row/Column numbers in tables."
10964 (interactive)
10965 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
10966 (message "Row/Column number display turned %s"
10967 (if org-table-overlay-coordinates "on" "off"))
10968 (if (and (org-at-table-p) org-table-overlay-coordinates)
10969 (org-table-align))
10970 (unless org-table-overlay-coordinates
10971 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10972 (setq org-table-coordinate-overlays nil)))
10974 (defun org-table-toggle-formula-debugger ()
10975 "Toggle the formula debugger in tables."
10976 (interactive)
10977 (setq org-table-formula-debug (not org-table-formula-debug))
10978 (message "Formula debugging has been turned %s"
10979 (if org-table-formula-debug "on" "off")))
10981 ;;; The orgtbl minor mode
10983 ;; Define a minor mode which can be used in other modes in order to
10984 ;; integrate the org-mode table editor.
10986 ;; This is really a hack, because the org-mode table editor uses several
10987 ;; keys which normally belong to the major mode, for example the TAB and
10988 ;; RET keys. Here is how it works: The minor mode defines all the keys
10989 ;; necessary to operate the table editor, but wraps the commands into a
10990 ;; function which tests if the cursor is currently inside a table. If that
10991 ;; is the case, the table editor command is executed. However, when any of
10992 ;; those keys is used outside a table, the function uses `key-binding' to
10993 ;; look up if the key has an associated command in another currently active
10994 ;; keymap (minor modes, major mode, global), and executes that command.
10995 ;; There might be problems if any of the keys used by the table editor is
10996 ;; otherwise used as a prefix key.
10998 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
10999 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11000 ;; addresses this by checking explicitly for both bindings.
11002 ;; The optimized version (see variable `orgtbl-optimized') takes over
11003 ;; all keys which are bound to `self-insert-command' in the *global map*.
11004 ;; Some modes bind other commands to simple characters, for example
11005 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11006 ;; active, this binding is ignored inside tables and replaced with a
11007 ;; modified self-insert.
11009 (defvar orgtbl-mode nil
11010 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11011 table editor in arbitrary modes.")
11012 (make-variable-buffer-local 'orgtbl-mode)
11014 (defvar orgtbl-mode-map (make-keymap)
11015 "Keymap for `orgtbl-mode'.")
11017 ;;;###autoload
11018 (defun turn-on-orgtbl ()
11019 "Unconditionally turn on `orgtbl-mode'."
11020 (orgtbl-mode 1))
11022 (defvar org-old-auto-fill-inhibit-regexp nil
11023 "Local variable used by `orgtbl-mode'")
11026 "Matches a line belonging to an orgtbl.")
11028 (defconst orgtbl-extra-font-lock-keywords
11029 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11030 0 (quote 'org-table) 'prepend))
11031 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11033 ;;;###autoload
11034 (defun orgtbl-mode (&optional arg)
11035 "The `org-mode' table editor as a minor mode for use in other modes."
11036 (interactive)
11037 (if (org-mode-p)
11038 ;; Exit without error, in case some hook functions calls this
11039 ;; by accident in org-mode.
11040 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11041 (setq orgtbl-mode
11042 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11043 (if orgtbl-mode
11044 (progn
11045 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11046 ;; Make sure we are first in minor-mode-map-alist
11047 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11048 (and c (setq minor-mode-map-alist
11049 (cons c (delq c minor-mode-map-alist)))))
11050 (org-set-local (quote org-table-may-need-update) t)
11051 (org-add-hook 'before-change-functions 'org-before-change-function
11052 nil 'local)
11053 (org-set-local 'org-old-auto-fill-inhibit-regexp
11054 auto-fill-inhibit-regexp)
11055 (org-set-local 'auto-fill-inhibit-regexp
11056 (if auto-fill-inhibit-regexp
11058 auto-fill-inhibit-regexp)
11059 orgtbl-line-start-regexp))
11060 (org-add-to-invisibility-spec '(org-cwidth))
11061 (when (fboundp 'font-lock-add-keywords)
11062 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11063 (org-restart-font-lock))
11064 (easy-menu-add orgtbl-mode-menu)
11065 (run-hooks 'orgtbl-mode-hook))
11066 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11067 (org-cleanup-narrow-column-properties)
11068 (org-remove-from-invisibility-spec '(org-cwidth))
11069 (remove-hook 'before-change-functions 'org-before-change-function t)
11070 (when (fboundp 'font-lock-remove-keywords)
11071 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11072 (org-restart-font-lock))
11073 (easy-menu-remove orgtbl-mode-menu)
11074 (force-mode-line-update 'all))))
11076 (defun org-cleanup-narrow-column-properties ()
11077 "Remove all properties related to narrow-column invisibility."
11078 (let ((s 1))
11079 (while (setq s (text-property-any s (point-max)
11080 'display org-narrow-column-arrow))
11081 (remove-text-properties s (1+ s) '(display t)))
11082 (setq s 1)
11083 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11084 (remove-text-properties s (1+ s) '(org-cwidth t)))
11085 (setq s 1)
11086 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11087 (remove-text-properties s (1+ s) '(invisible t)))))
11089 ;; Install it as a minor mode.
11090 (put 'orgtbl-mode :included t)
11091 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11092 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11094 (defun orgtbl-make-binding (fun n &rest keys)
11095 "Create a function for binding in the table minor mode.
11096 FUN is the command to call inside a table. N is used to create a unique
11097 command name. KEYS are keys that should be checked in for a command
11098 to execute outside of tables."
11099 (eval
11100 (list 'defun
11101 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11102 '(arg)
11104 "Outside of tables, run the binding of `"
11105 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11106 "'.")
11107 '(interactive "p")
11108 (list 'if
11109 '(org-at-table-p)
11110 (list 'call-interactively (list 'quote fun))
11111 (list 'let '(orgtbl-mode)
11112 (list 'call-interactively
11113 (append '(or)
11114 (mapcar (lambda (k)
11115 (list 'key-binding k))
11116 keys)
11117 '('orgtbl-error))))))))
11119 (defun orgtbl-error ()
11120 "Error when there is no default binding for a table key."
11121 (interactive)
11122 (error "This key has no function outside tables"))
11124 (defun orgtbl-setup ()
11125 "Setup orgtbl keymaps."
11126 (let ((nfunc 0)
11127 (bindings
11128 (list
11129 '([(meta shift left)] org-table-delete-column)
11130 '([(meta left)] org-table-move-column-left)
11131 '([(meta right)] org-table-move-column-right)
11132 '([(meta shift right)] org-table-insert-column)
11133 '([(meta shift up)] org-table-kill-row)
11134 '([(meta shift down)] org-table-insert-row)
11135 '([(meta up)] org-table-move-row-up)
11136 '([(meta down)] org-table-move-row-down)
11137 '("\C-c\C-w" org-table-cut-region)
11138 '("\C-c\M-w" org-table-copy-region)
11139 '("\C-c\C-y" org-table-paste-rectangle)
11140 '("\C-c-" org-table-insert-hline)
11141 '("\C-c}" org-table-toggle-coordinate-overlays)
11142 '("\C-c{" org-table-toggle-formula-debugger)
11143 '("\C-m" org-table-next-row)
11144 '([(shift return)] org-table-copy-down)
11145 '("\C-c\C-q" org-table-wrap-region)
11146 '("\C-c?" org-table-field-info)
11147 '("\C-c " org-table-blank-field)
11148 '("\C-c+" org-table-sum)
11149 '("\C-c=" org-table-eval-formula)
11150 '("\C-c'" org-table-edit-formulas)
11151 '("\C-c`" org-table-edit-field)
11152 '("\C-c*" org-table-recalculate)
11153 '("\C-c|" org-table-create-or-convert-from-region)
11154 '("\C-c^" org-table-sort-lines)
11155 '([(control ?#)] org-table-rotate-recalc-marks)))
11156 elt key fun cmd)
11157 (while (setq elt (pop bindings))
11158 (setq nfunc (1+ nfunc))
11159 (setq key (org-key (car elt))
11160 fun (nth 1 elt)
11161 cmd (orgtbl-make-binding fun nfunc key))
11162 (org-defkey orgtbl-mode-map key cmd))
11164 ;; Special treatment needed for TAB and RET
11165 (org-defkey orgtbl-mode-map [(return)]
11166 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11167 (org-defkey orgtbl-mode-map "\C-m"
11168 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11170 (org-defkey orgtbl-mode-map [(tab)]
11171 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11172 (org-defkey orgtbl-mode-map "\C-i"
11173 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11175 (org-defkey orgtbl-mode-map [(shift tab)]
11176 (orgtbl-make-binding 'org-table-previous-field 104
11177 [(shift tab)] [(tab)] "\C-i"))
11179 (org-defkey orgtbl-mode-map "\M-\C-m"
11180 (orgtbl-make-binding 'org-table-wrap-region 105
11181 "\M-\C-m" [(meta return)]))
11182 (org-defkey orgtbl-mode-map [(meta return)]
11183 (orgtbl-make-binding 'org-table-wrap-region 106
11184 [(meta return)] "\M-\C-m"))
11186 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11187 (when orgtbl-optimized
11188 ;; If the user wants maximum table support, we need to hijack
11189 ;; some standard editing functions
11190 (org-remap orgtbl-mode-map
11191 'self-insert-command 'orgtbl-self-insert-command
11192 'delete-char 'org-delete-char
11193 'delete-backward-char 'org-delete-backward-char)
11194 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11195 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11196 '("OrgTbl"
11197 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11198 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11199 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11200 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11201 "--"
11202 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11203 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11204 ["Copy Field from Above"
11205 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11206 "--"
11207 ("Column"
11208 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11209 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11210 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11211 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11212 ("Row"
11213 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11214 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11215 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11216 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11217 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11218 "--"
11219 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11220 ("Rectangle"
11221 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11222 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11223 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11224 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11225 "--"
11226 ("Radio tables"
11227 ["Insert table template" orgtbl-insert-radio-table
11228 (assq major-mode orgtbl-radio-table-templates)]
11229 ["Comment/uncomment table" orgtbl-toggle-comment t])
11230 "--"
11231 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11232 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11233 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11234 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11235 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11236 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11237 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11238 ["Sum Column/Rectangle" org-table-sum
11239 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11240 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11241 ["Debug Formulas"
11242 org-table-toggle-formula-debugger :active (org-at-table-p)
11243 :keys "C-c {"
11244 :style toggle :selected org-table-formula-debug]
11245 ["Show Col/Row Numbers"
11246 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11247 :keys "C-c }"
11248 :style toggle :selected org-table-overlay-coordinates]
11249 ))
11250 t))
11252 (defun orgtbl-ctrl-c-ctrl-c (arg)
11253 "If the cursor is inside a table, realign the table.
11254 It it is a table to be sent away to a receiver, do it.
11255 With prefix arg, also recompute table."
11256 (interactive "P")
11257 (let ((pos (point)) action)
11258 (save-excursion
11259 (beginning-of-line 1)
11263 (cond
11264 ((integerp action)
11265 (goto-char action)
11266 (org-table-maybe-eval-formula)
11267 (if arg
11268 (call-interactively 'org-table-recalculate)
11269 (org-table-maybe-recalculate-line))
11270 (call-interactively 'org-table-align)
11271 (orgtbl-send-table 'maybe))
11272 ((eq action 'recalc)
11273 (save-excursion
11274 (beginning-of-line 1)
11276 (if (org-at-table-p)
11277 (org-call-with-arg 'org-table-recalculate t))))
11278 (t (let (orgtbl-mode)
11279 (call-interactively (key-binding "\C-c\C-c")))))))
11281 (defun orgtbl-tab (arg)
11282 "Justification and field motion for `orgtbl-mode'."
11283 (interactive "P")
11284 (if arg (org-table-edit-field t)
11285 (org-table-justify-field-maybe)
11286 (org-table-next-field)))
11288 (defun orgtbl-ret ()
11289 "Justification and field motion for `orgtbl-mode'."
11290 (interactive)
11291 (org-table-justify-field-maybe)
11292 (org-table-next-row))
11294 (defun orgtbl-self-insert-command (N)
11295 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11296 If the cursor is in a table looking at whitespace, the whitespace is
11297 overwritten, and the table is not marked as requiring realignment."
11298 (interactive "p")
11299 (if (and (org-at-table-p)
11300 (or
11301 (and org-table-auto-blank-field
11302 (member last-command
11303 '(orgtbl-hijacker-command-100
11304 orgtbl-hijacker-command-101
11305 orgtbl-hijacker-command-102
11306 orgtbl-hijacker-command-103
11307 orgtbl-hijacker-command-104
11308 orgtbl-hijacker-command-105))
11309 (org-table-blank-field))
11310 t)
11311 (eq N 1)
11313 (let (org-table-may-need-update)
11314 (goto-char (1- (match-end 0)))
11315 (delete-backward-char 1)
11316 (goto-char (match-beginning 0))
11317 (self-insert-command N))
11318 (setq org-table-may-need-update t)
11319 (let (orgtbl-mode)
11320 (call-interactively (key-binding (vector last-input-event))))))
11322 (defun org-force-self-insert (N)
11323 "Needed to enforce self-insert under remapping."
11324 (interactive "p")
11325 (self-insert-command N))
11328 "Regula expression matching exponentials as produced by calc.")
11330 (defvar org-table-clean-did-remove-column nil)
11332 (defun orgtbl-export (table target)
11333 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11335 org-table-last-alignment org-table-last-column-widths
11336 maxcol column)
11337 (if (not (fboundp func))
11338 (error "Cannot export orgtbl table to %s" target))
11339 (setq lines (org-table-clean-before-export lines))
11340 (setq table
11341 (mapcar
11342 (lambda (x)
11343 (if (string-match org-table-hline-regexp x)
11344 'hline
11346 lines))
11347 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11348 table)))
11349 (loop for i from (1- maxcol) downto 0 do
11350 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11351 (setq column (delq nil column))
11352 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11353 (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))
11354 (funcall func table nil)))
11356 (defun orgtbl-send-table (&optional maybe)
11357 "Send a tranformed version of this table to the receiver position.
11358 With argument MAYBE, fail quietly if no transformation is defined for
11359 this table."
11360 (interactive)
11361 (catch 'exit
11362 (unless (org-at-table-p) (error "Not at a table"))
11363 ;; when non-interactive, we assume align has just happened.
11364 (when (interactive-p) (org-table-align))
11365 (save-excursion
11366 (goto-char (org-table-begin))
11367 (beginning-of-line 0)
11369 (if maybe
11370 (throw 'exit nil)
11371 (error "Don't know how to transform this table."))))
11372 (let* ((name (match-string 1))
11373 beg
11374 (transform (intern (match-string 2)))
11375 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11376 (skip (plist-get params :skip))
11377 (skipcols (plist-get params :skipcols))
11378 (txt (buffer-substring-no-properties
11379 (org-table-begin) (org-table-end)))
11381 (lines (org-table-clean-before-export lines))
11382 (i0 (if org-table-clean-did-remove-column 2 1))
11383 (table (mapcar
11384 (lambda (x)
11385 (if (string-match org-table-hline-regexp x)
11386 'hline
11387 (org-remove-by-index
11389 skipcols i0)))
11390 lines))
11391 (fun (if (= i0 2) 'cdr 'identity))
11392 (org-table-last-alignment
11393 (org-remove-by-index (funcall fun org-table-last-alignment)
11394 skipcols i0))
11395 (org-table-last-column-widths
11396 (org-remove-by-index (funcall fun org-table-last-column-widths)
11397 skipcols i0)))
11399 (unless (fboundp transform)
11400 (error "No such transformation function %s" transform))
11401 (setq txt (funcall transform table params))
11402 ;; Find the insertion place
11403 (save-excursion
11404 (goto-char (point-min))
11405 (unless (re-search-forward
11407 (error "Don't know where to insert translated table"))
11408 (goto-char (match-beginning 0))
11409 (beginning-of-line 2)
11410 (setq beg (point))
11411 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11412 (error "Cannot find end of insertion region"))
11413 (beginning-of-line 1)
11414 (delete-region beg (point))
11415 (goto-char beg)
11417 (message "Table converted and installed at receiver location"))))
11419 (defun org-remove-by-index (list indices &optional i0)
11420 "Remove the elements in LIST with indices in INDICES.
11421 First element has index 0, or I0 if given."
11422 (if (not indices)
11423 list
11424 (if (integerp indices) (setq indices (list indices)))
11425 (setq i0 (1- (or i0 0)))
11426 (delq :rm (mapcar (lambda (x)
11427 (setq i0 (1+ i0))
11428 (if (memq i0 indices) :rm x))
11429 list))))
11431 (defun orgtbl-toggle-comment ()
11432 "Comment or uncomment the orgtbl at point."
11433 (interactive)
11434 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11435 (re2 (concat "^" orgtbl-line-start-regexp))
11436 (commented (save-excursion (beginning-of-line 1)
11437 (cond ((looking-at re1) t)
11438 ((looking-at re2) nil)
11439 (t (error "Not at an org table")))))
11440 (re (if commented re1 re2))
11441 beg end)
11442 (save-excursion
11443 (beginning-of-line 1)
11444 (while (looking-at re) (beginning-of-line 0))
11445 (beginning-of-line 2)
11446 (setq beg (point))
11447 (while (looking-at re) (beginning-of-line 2))
11448 (setq end (point)))
11449 (comment-region beg end (if commented '(4) nil))))
11451 (defun orgtbl-insert-radio-table ()
11452 "Insert a radio table template appropriate for this major mode."
11453 (interactive)
11454 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11455 (txt (nth 1 e))
11456 name pos)
11457 (unless e (error "No radio table setup defined for %s" major-mode))
11458 (setq name (read-string "Table name: "))
11459 (while (string-match "%n" txt)
11460 (setq txt (replace-match name t t txt)))
11462 (setq pos (point))
11463 (insert txt)
11464 (goto-char pos)))
11466 (defun org-get-param (params header i sym &optional hsym)
11467 "Get parameter value for symbol SYM.
11468 If this is a header line, actually get the value for the symbol with an
11470 If the value is a protperty list, get the element for the current column.
11471 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11472 (let ((val (plist-get params sym)))
11473 (and hsym header (setq val (or (plist-get params hsym) val)))
11474 (if (consp val) (plist-get val i) val)))
11476 (defun orgtbl-to-generic (table params)
11477 "Convert the orgtbl-mode TABLE to some other format.
11478 This generic routine can be used for many standard cases.
11479 TABLE is a list, each entry either the symbol `hline' for a horizontal
11480 separator line, or a list of fields for that line.
11481 PARAMS is a property list of parameters that can influence the conversion.
11482 For the generic converter, some parameters are obligatory: You need to
11483 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11484 :splice, you must have :tstart and :tend.
11486 Valid parameters are
11488 :tstart String to start the table. Ignored when :splice is t.
11489 :tend String to end the table. Ignored when :splice is t.
11491 :splice When set to t, return only table body lines, don't wrap
11492 them into :tstart and :tend. Default is nil.
11494 :hline String to be inserted on horizontal separation lines.
11495 May be nil to ignore hlines.
11497 :lstart String to start a new table line.
11498 :lend String to end a table line
11499 :sep Separator between two fields
11500 :lfmt Format for entire line, with enough %s to capture all fields.
11501 If this is present, :lstart, :lend, and :sep are ignored.
11502 :fmt A format to be used to wrap the field, should contain
11503 %s for the original field value. For example, to wrap
11505 This may also be a property list with column numbers and
11508 :hlstart :hlend :hlsep :hlfmt :hfmt
11509 Same as above, specific for the header lines in the table.
11510 All lines before the first hline are treated as header.
11511 If any of these is not present, the data line value is used.
11513 :efmt Use this format to print numbers with exponentials.
11514 The format should have %s twice for inserting mantissa
11516 may also be a property list with column numbers and
11517 formats. :fmt will still be applied after :efmt.
11519 In addition to this, the parameters :skip and :skipcols are always handled
11520 directly by `orgtbl-send-table'. See manual."
11521 (interactive)
11522 (let* ((p params)
11523 (splicep (plist-get p :splice))
11524 (hline (plist-get p :hline))
11525 rtn line i fm efm lfmt h)
11527 ;; Do we have a header?
11528 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11529 (setq h t))
11531 ;; Put header
11532 (unless splicep
11533 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11535 ;; Now loop over all lines
11536 (while (setq line (pop table))
11537 (if (eq line 'hline)
11538 ;; A horizontal separator line
11539 (progn (if hline (push hline rtn))
11540 (setq h nil)) ; no longer in header
11541 ;; A normal line. Convert the fields, push line onto the result list
11542 (setq i 0)
11543 (setq line
11544 (mapcar
11545 (lambda (f)
11546 (setq i (1+ i)
11547 fm (org-get-param p h i :fmt :hfmt)
11548 efm (org-get-param p h i :efmt))
11549 (if (and efm (string-match orgtbl-exp-regexp f))
11550 (setq f (format
11551 efm (match-string 1 f) (match-string 2 f))))
11552 (if fm (setq f (format fm f)))
11553 f)
11554 line))
11555 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11556 (push (apply 'format lfmt line) rtn)
11557 (push (concat
11558 (org-get-param p h i :lstart :hlstart)
11559 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11560 (org-get-param p h i :lend :hlend))
11561 rtn))))
11563 (unless splicep
11564 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11568 (defun orgtbl-to-latex (table params)
11569 "Convert the orgtbl-mode TABLE to LaTeX.
11570 TABLE is a list, each entry either the symbol `hline' for a horizontal
11571 separator line, or a list of fields for that line.
11572 PARAMS is a property list of parameters that can influence the conversion.
11573 Supports all parameters from `orgtbl-to-generic'. Most important for
11574 LaTeX are:
11576 :splice When set to t, return only table body lines, don't wrap
11577 them into a tabular environment. Default is nil.
11579 :fmt A format to be used to wrap the field, should contain %s for the
11580 original field value. For example, to wrap everything in dollars,
11584 :efmt Format for transforming numbers with exponentials. The format
11585 should have %s twice for inserting mantissa and exponent, for
11587 This may also be a property list with column numbers and formats.
11589 The general parameters :skip and :skipcols have already been applied when
11590 this function is called."
11591 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11592 org-table-last-alignment ""))
11593 (params2
11594 (list
11599 (orgtbl-to-generic table (org-combine-plists params2 params))))
11601 (defun orgtbl-to-html (table params)
11602 "Convert the orgtbl-mode TABLE to LaTeX.
11603 TABLE is a list, each entry either the symbol `hline' for a horizontal
11604 separator line, or a list of fields for that line.
11605 PARAMS is a property list of parameters that can influence the conversion.
11606 Currently this function recognizes the following parameters:
11608 :splice When set to t, return only table body lines, don't wrap
11609 them into a <table> environment. Default is nil.
11611 The general parameters :skip and :skipcols have already been applied when
11612 this function is called. The function does *not* use `orgtbl-to-generic',
11613 so you cannot specify parameters for it."
11614 (let* ((splicep (plist-get params :splice))
11615 html)
11616 ;; Just call the formatter we already have
11617 ;; We need to make text lines for it, so put the fields back together.
11618 (setq html (org-format-org-table-html
11619 (mapcar
11620 (lambda (x)
11621 (if (eq x 'hline)
11622 "|----+----|"
11623 (concat "| " (mapconcat 'identity x " | ") " |")))
11624 table)
11625 splicep))
11627 (setq html (replace-match "" t t html)))
11628 html))
11630 (defun orgtbl-to-texinfo (table params)
11631 "Convert the orgtbl-mode TABLE to TeXInfo.
11632 TABLE is a list, each entry either the symbol `hline' for a horizontal
11633 separator line, or a list of fields for that line.
11634 PARAMS is a property list of parameters that can influence the conversion.
11635 Supports all parameters from `orgtbl-to-generic'. Most important for
11636 TeXInfo are:
11638 :splice nil/t When set to t, return only table body lines, don't wrap
11639 them into a multitable environment. Default is nil.
11641 :fmt fmt A format to be used to wrap the field, should contain
11642 %s for the original field value. For example, to wrap
11644 This may also be a property list with column numbers and
11648 are computed automatically from the width of the columns
11649 under org-mode.
11651 The general parameters :skip and :skipcols have already been applied when
11652 this function is called."
11653 (let* ((total (float (apply '+ org-table-last-column-widths)))
11654 (colfrac (or (plist-get params :cf)
11655 (mapconcat
11656 (lambda (x) (format "%.3f" (/ (float x) total)))
11657 org-table-last-column-widths " ")))
11658 (params2
11659 (list
11660 :tstart (concat "@multitable @columnfractions " colfrac)
11661 :tend "@end multitable"
11662 :lstart "@item " :lend "" :sep " @tab "
11663 :hlstart "@headitem ")))
11664 (orgtbl-to-generic table (org-combine-plists params2 params))))
11666 ;;;; Link Stuff
11668 ;;; Link abbreviations
11670 (defun org-link-expand-abbrev (link)
11671 "Apply replacements as defined in `org-link-abbrev-alist."
11673 (let* ((key (match-string 1 link))
11674 (as (or (assoc key org-link-abbrev-alist-local)
11675 (assoc key org-link-abbrev-alist)))
11676 (tag (and (match-end 2) (match-string 3 link)))
11677 rpl)
11678 (if (not as)
11679 link
11680 (setq rpl (cdr as))
11681 (cond
11682 ((symbolp rpl) (funcall rpl tag))
11683 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11684 (t (concat rpl tag)))))
11685 link))
11687 ;;; Storing and inserting links
11689 (defvar org-insert-link-history nil
11690 "Minibuffer history for links inserted with `org-insert-link'.")
11692 (defvar org-stored-links nil
11693 "Contains the links stored with `org-store-link'.")
11695 (defvar org-store-link-plist nil
11696 "Plist with info about the most recently link created with `org-store-link'.")
11698 (defvar org-link-protocols nil
11699 "Link protocols added to Org-mode using `org-add-link-type'.")
11701 (defvar org-store-link-functions nil
11702 "List of functions that are called to create and store a link.
11703 Each function will be called in turn until one returns a non-nil
11704 value. Each function should check if it is responsible for creating
11705 this link (for example by looking at the major mode).
11706 If not, it must exit and return nil.
11707 If yes, it should return a non-nil value after a calling
11708 `org-store-link-props' with a list of properties and values.
11709 Special properties are:
11713 This is obligatory as well.
11714 :description Optional default description for the second pair
11715 of brackets in an Org-mode link. The user can still change
11716 this when inserting this link into an Org-mode buffer.
11718 In addition to these, any additional properties can be specified
11719 and then used in remember templates.")
11721 (defun org-add-link-type (type &optional follow publish)
11722 "Add TYPE to the list of `org-link-types'.
11723 Re-compute all regular expressions depending on `org-link-types'
11724 FOLLOW and PUBLISH are two functions. Both take the link path as
11725 an argument.
11726 FOLLOW should do whatever is necessary to follow the link, for example
11727 to find a file or display a mail message.
11729 PUBLISH takes the path and retuns the string that should be used when
11730 this document is published. FIMXE: This is actually not yet implemented."
11731 (add-to-list 'org-link-types type t)
11732 (org-make-link-regexps)
11733 (add-to-list 'org-link-protocols
11734 (list type follow publish)))
11736 (defun org-add-agenda-custom-command (entry)
11737 "Replace or add a command in `org-agenda-custom-commands'.
11738 This is mostly for hacking and trying a new command - once the command
11739 works you probably want to add it to `org-agenda-custom-commands' for good."
11740 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11741 (if ass
11742 (setcdr ass (cdr entry))
11743 (push entry org-agenda-custom-commands))))
11745 ;;;###autoload
11746 (defun org-store-link (arg)
11748 This link can later be inserted into an org-buffer with
11750 For some link types, a prefix arg is interpreted:
11751 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11752 For file links, arg negates `org-context-in-file-links'."
11753 (interactive "P")
11754 (setq org-store-link-plist nil) ; reset
11755 (let (link cpltxt desc description search txt)
11756 (cond
11758 ((run-hook-with-args-until-success 'org-store-link-functions)
11759 (setq link (plist-get org-store-link-plist :link)
11760 desc (or (plist-get org-store-link-plist :description) link)))
11762 ((eq major-mode 'bbdb-mode)
11763 (let ((name (bbdb-record-name (bbdb-current-record)))
11764 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11765 (setq cpltxt (concat "bbdb:" (or name company))
11766 link (org-make-link cpltxt))
11767 (org-store-link-props :type "bbdb" :name name :company company)))
11769 ((eq major-mode 'Info-mode)
11770 (setq link (org-make-link "info:"
11771 (file-name-nondirectory Info-current-file)
11772 ":" Info-current-node))
11773 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11774 ":" Info-current-node))
11775 (org-store-link-props :type "info" :file Info-current-file
11776 :node Info-current-node))
11778 ((eq major-mode 'calendar-mode)
11779 (let ((cd (calendar-cursor-to-date)))
11780 (setq link
11781 (format-time-string
11782 (car org-time-stamp-formats)
11783 (apply 'encode-time
11784 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11785 nil nil nil))))
11786 (org-store-link-props :type "calendar" :date cd)))
11788 ((or (eq major-mode 'vm-summary-mode)
11789 (eq major-mode 'vm-presentation-mode))
11790 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11791 (vm-follow-summary-cursor)
11792 (save-excursion
11793 (vm-select-folder-buffer)
11794 (let* ((message (car vm-message-pointer))
11795 (folder buffer-file-name)
11796 (subject (vm-su-subject message))
11797 (to (vm-get-header-contents message "To"))
11798 (from (vm-get-header-contents message "From"))
11799 (message-id (vm-su-message-id message)))
11800 (org-store-link-props :type "vm" :from from :to to :subject subject
11801 :message-id message-id)
11802 (setq message-id (org-remove-angle-brackets message-id))
11803 (setq folder (abbreviate-file-name folder))
11804 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11805 folder)
11806 (setq folder (replace-match "" t t folder)))
11807 (setq cpltxt (org-email-link-description))
11808 (setq link (org-make-link "vm:" folder "#" message-id)))))
11810 ((eq major-mode 'wl-summary-mode)
11811 (let* ((msgnum (wl-summary-message-number))
11812 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11813 msgnum 'message-id))
11814 (wl-message-entity
11815 (if (fboundp 'elmo-message-entity)
11816 (elmo-message-entity
11817 wl-summary-buffer-elmo-folder msgnum)
11818 (elmo-msgdb-overview-get-entity
11819 msgnum (wl-summary-buffer-msgdb))))
11820 (from (wl-summary-line-from))
11821 (to (car (elmo-message-entity-field wl-message-entity 'to)))
11822 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11823 (wl-summary-line-subject))))
11824 (org-store-link-props :type "wl" :from from :to to
11825 :subject subject :message-id message-id)
11826 (setq message-id (org-remove-angle-brackets message-id))
11827 (setq cpltxt (org-email-link-description))
11828 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11829 "#" message-id))))
11831 ((or (equal major-mode 'mh-folder-mode)
11832 (equal major-mode 'mh-show-mode))
11833 (let ((from (org-mhe-get-header "From:"))
11834 (to (org-mhe-get-header "To:"))
11835 (message-id (org-mhe-get-header "Message-Id:"))
11836 (subject (org-mhe-get-header "Subject:")))
11837 (org-store-link-props :type "mh" :from from :to to
11838 :subject subject :message-id message-id)
11839 (setq cpltxt (org-email-link-description))
11840 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11841 (org-remove-angle-brackets message-id)))))
11843 ((eq major-mode 'rmail-mode)
11844 (save-excursion
11845 (save-restriction
11846 (rmail-narrow-to-non-pruned-header)
11847 (let ((folder buffer-file-name)
11848 (message-id (mail-fetch-field "message-id"))
11849 (from (mail-fetch-field "from"))
11850 (to (mail-fetch-field "to"))
11851 (subject (mail-fetch-field "subject")))
11852 (org-store-link-props
11853 :type "rmail" :from from :to to
11854 :subject subject :message-id message-id)
11855 (setq message-id (org-remove-angle-brackets message-id))
11856 (setq cpltxt (org-email-link-description))
11857 (setq link (org-make-link "rmail:" folder "#" message-id))))))
11859 ((eq major-mode 'gnus-group-mode)
11860 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
11861 (gnus-group-group-name)) ; version
11862 ((fboundp 'gnus-group-name)
11863 (gnus-group-name))
11864 (t "???"))))
11865 (unless group (error "Not on a group"))
11866 (org-store-link-props :type "gnus" :group group)
11867 (setq cpltxt (concat
11868 (if (org-xor arg org-usenet-links-prefer-google)
11869 "http://groups.google.com/groups?group="
11870 "gnus:")
11871 group)
11872 link (org-make-link cpltxt))))
11874 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
11875 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
11876 (let* ((group gnus-newsgroup-name)
11877 (article (gnus-summary-article-number))
11878 (header (gnus-summary-article-header article))
11879 (from (mail-header-from header))
11880 (message-id (mail-header-id header))
11881 (date (mail-header-date header))
11882 (subject (gnus-summary-subject-string)))
11883 (org-store-link-props :type "gnus" :from from :subject subject
11884 :message-id message-id :group group)
11885 (setq cpltxt (org-email-link-description))
11886 (if (org-xor arg org-usenet-links-prefer-google)
11887 (setq link
11888 (concat
11890 (format "http://groups.google.com/groups?as_umsgid=%s"
11891 (org-fixup-message-id-for-http message-id))))
11892 (setq link (org-make-link "gnus:" group
11893 "#" (number-to-string article))))))
11895 ((eq major-mode 'w3-mode)
11896 (setq cpltxt (url-view-url t)
11897 link (org-make-link cpltxt))
11898 (org-store-link-props :type "w3" :url (url-view-url t)))
11900 ((eq major-mode 'w3m-mode)
11901 (setq cpltxt (or w3m-current-title w3m-current-url)
11902 link (org-make-link w3m-current-url))
11903 (org-store-link-props :type "w3m" :url (url-view-url t)))
11905 ((setq search (run-hook-with-args-until-success
11906 'org-create-file-search-functions))
11907 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
11908 "::" search))
11909 (setq cpltxt (or description link)))
11911 ((eq major-mode 'image-mode)
11912 (setq cpltxt (concat "file:"
11913 (abbreviate-file-name buffer-file-name))
11914 link (org-make-link cpltxt))
11915 (org-store-link-props :type "image" :file buffer-file-name))
11917 ((eq major-mode 'dired-mode)
11918 ;; link to the file in the current line
11919 (setq cpltxt (concat "file:"
11920 (abbreviate-file-name
11921 (expand-file-name
11922 (dired-get-filename nil t))))
11923 link (org-make-link cpltxt)))
11925 ((and buffer-file-name (org-mode-p))
11926 ;; Just link to current headline
11927 (setq cpltxt (concat "file:"
11928 (abbreviate-file-name buffer-file-name)))
11929 ;; Add a context search string
11930 (when (org-xor org-context-in-file-links arg)
11931 ;; Check if we are on a target
11933 (setq cpltxt (concat cpltxt "::" (match-string 1)))
11934 (setq txt (cond
11935 ((org-on-heading-p) nil)
11936 ((org-region-active-p)
11937 (buffer-substring (region-beginning) (region-end)))
11938 (t (buffer-substring (point-at-bol) (point-at-eol)))))
11940 (setq cpltxt
11941 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11942 desc "NONE"))))
11944 (setq cpltxt (substring cpltxt 0 -2)))
11945 (setq link (org-make-link cpltxt)))
11947 ((buffer-file-name (buffer-base-buffer))
11948 ;; Just link to this file here.
11949 (setq cpltxt (concat "file:"
11950 (abbreviate-file-name
11951 (buffer-file-name (buffer-base-buffer)))))
11952 ;; Add a context string
11953 (when (org-xor org-context-in-file-links arg)
11954 (setq txt (if (org-region-active-p)
11955 (buffer-substring (region-beginning) (region-end))
11956 (buffer-substring (point-at-bol) (point-at-eol))))
11957 ;; Only use search option if there is some text.
11959 (setq cpltxt
11960 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11961 desc "NONE")))
11962 (setq link (org-make-link cpltxt)))
11964 ((interactive-p)
11965 (error "Cannot link to a buffer which is not visiting a file"))
11967 (t (setq link nil)))
11969 (if (consp link) (setq cpltxt (car link) link (cdr link)))
11970 (setq link (or link cpltxt)
11971 desc (or desc cpltxt))
11972 (if (equal desc "NONE") (setq desc nil))
11974 (if (and (interactive-p) link)
11975 (progn
11976 (setq org-stored-links
11977 (cons (list link desc) org-stored-links))
11978 (message "Stored: %s" (or desc link)))
11979 (and link (org-make-link-string link desc)))))
11981 (defun org-store-link-props (&rest plist)
11982 "Store link properties, extract names and addresses."
11983 (let (x adr)
11984 (when (setq x (plist-get plist :from))
11985 (setq adr (mail-extract-address-components x))
11986 (plist-put plist :fromname (car adr))
11987 (plist-put plist :fromaddress (nth 1 adr)))
11988 (when (setq x (plist-get plist :to))
11989 (setq adr (mail-extract-address-components x))
11990 (plist-put plist :toname (car adr))
11991 (plist-put plist :toaddress (nth 1 adr))))
11992 (let ((from (plist-get plist :from))
11993 (to (plist-get plist :to)))
11994 (when (and from to org-from-is-user-regexp)
11995 (plist-put plist :fromto
11996 (if (string-match org-from-is-user-regexp from)
11997 (concat "to %t")
11998 (concat "from %f")))))
11999 (setq org-store-link-plist plist))
12001 (defun org-email-link-description (&optional fmt)
12002 "Return the description part of an email link.
12003 This takes information from `org-store-link-plist' and formats it
12004 according to FMT (default from `org-email-link-description-format')."
12005 (setq fmt (or fmt org-email-link-description-format))
12006 (let* ((p org-store-link-plist)
12007 (to (plist-get p :toaddress))
12008 (from (plist-get p :fromaddress))
12009 (table
12010 (list
12011 (cons "%c" (plist-get p :fromto))
12012 (cons "%F" (plist-get p :from))
12013 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12014 (cons "%T" (plist-get p :to))
12015 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12016 (cons "%s" (plist-get p :subject))
12017 (cons "%m" (plist-get p :message-id)))))
12018 (when (string-match "%c" fmt)
12019 ;; Check if the user wrote this message
12020 (if (and org-from-is-user-regexp from to
12021 (save-match-data (string-match org-from-is-user-regexp from)))
12022 (setq fmt (replace-match "to %t" t t fmt))
12023 (setq fmt (replace-match "from %f" t t fmt))))
12024 (org-replace-escapes fmt table)))
12026 (defun org-make-org-heading-search-string (&optional string heading)
12027 "Make search string for STRING or current headline."
12028 (interactive)
12029 (let ((s (or string (org-get-heading))))
12030 (unless (and string (not heading))
12031 ;; We are using a headline, clean up garbage in there.
12032 (if (string-match org-todo-regexp s)
12033 (setq s (replace-match "" t t s)))
12035 (setq s (replace-match "" t t s)))
12036 (setq s (org-trim s))
12039 (setq s (replace-match "" t t s)))
12040 (while (string-match org-ts-regexp s)
12041 (setq s (replace-match "" t t s))))
12043 (setq s (replace-match " " t t s)))
12044 (or string (setq s (concat "*" s))) ; Add * for headlines
12047 (defun org-make-link (&rest strings)
12048 "Concatenate STRINGS."
12049 (apply 'concat strings))
12051 (defun org-make-link-string (link &optional description)
12052 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12054 (error "Empty link"))
12055 (when (stringp description)
12056 ;; Remove brackets from the description, they are fatal.
12058 (setq description (replace-match "{" t t description)))
12060 (setq description (replace-match "}" t t description))))
12061 (when (equal (org-link-escape link) description)
12062 ;; No description needed, it is identical
12063 (setq description nil))
12064 (when (and (not description)
12065 (not (equal link (org-link-escape link))))
12066 (setq description link))
12067 (concat "[[" (org-link-escape link) "]"
12068 (if description (concat "[" description "]") "")
12069 "]"))
12071 (defconst org-link-escape-chars
12072 '((?\ . "%20")
12073 (?\[ . "%5B")
12074 (?\] . "%5D")
12085 (?\; . "%3B")
12086 (?? . "%3F")
12087 (?= . "%3D")
12088 (?+ . "%2B")
12089 )
12090 "Association list of escapes for some characters problematic in links.
12091 This is the list that is used for internal purposes.")
12093 (defconst org-link-escape-chars-browser
12094 '((?\ . "%20")) ; 32 for the SPC char
12095 "Association list of escapes for some characters problematic in links.
12096 This is the list that is used before handing over to the browser.")
12098 (defun org-link-escape (text &optional table)
12099 "Escape charaters in TEXT that are problematic for links."
12100 (setq table (or table org-link-escape-chars))
12101 (when text
12102 (let ((re (mapconcat (lambda (x) (regexp-quote
12103 (char-to-string (car x))))
12105 (while (string-match re text)
12106 (setq text
12107 (replace-match
12108 (cdr (assoc (string-to-char (match-string 0 text))
12109 table))
12110 t t text)))
12111 text)))
12113 (defun org-link-unescape (text &optional table)
12114 "Reverse the action of `org-link-escape'."
12115 (setq table (or table org-link-escape-chars))
12116 (when text
12117 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12119 (while (string-match re text)
12120 (setq text
12121 (replace-match
12122 (char-to-string (car (rassoc (match-string 0 text) table)))
12123 t t text)))
12124 text)))
12126 (defun org-xor (a b)
12127 "Exclusive or."
12128 (if a (not b) b))
12130 (defun org-get-header (header)
12131 "Find a header field in the current buffer."
12132 (save-excursion
12133 (goto-char (point-min))
12134 (let ((case-fold-search t) s)
12135 (cond
12136 ((eq header 'from)
12138 (setq s (match-string 1)))
12140 (setq s (replace-match "" t t s)))
12141 (if (string-match "[<(].*" s)
12142 (setq s (replace-match "" t t s))))
12143 ((eq header 'message-id)
12145 (setq s (match-string 1))))
12146 ((eq header 'subject)
12148 (setq s (match-string 1)))))
12151 s)))
12154 (defun org-fixup-message-id-for-http (s)
12155 "Replace special characters in a message id, so it can be used in an http query."
12156 (while (string-match "<" s)
12157 (setq s (replace-match "%3C" t t s)))
12158 (while (string-match ">" s)
12159 (setq s (replace-match "%3E" t t s)))
12160 (while (string-match "@" s)
12161 (setq s (replace-match "%40" t t s)))
12162 s)
12164 ;;;###autoload
12165 (defun org-insert-link-global ()
12166 "Insert a link like Org-mode does.
12167 This command can be called in any mode to insert a link in Org-mode syntax."
12168 (interactive)
12169 (org-run-like-in-org-mode 'org-insert-link))
12171 (defun org-insert-link (&optional complete-file)
12172 "Insert a link. At the prompt, enter the link.
12174 Completion can be used to select a link previously stored with
12175 `org-store-link'. When the empty string is entered (i.e. if you just
12176 press RET at the prompt), the link defaults to the most recently
12177 stored link. As SPC triggers completion in the minibuffer, you need to
12178 use M-SPC or C-q SPC to force the insertion of a space character.
12180 You will also be prompted for a description, and if one is given, it will
12181 be displayed in the buffer instead of the link.
12183 If there is already a link at point, this command will allow you to edit link
12184 and description parts.
12187 selected using completion. The path to the file will be relative to
12188 the current directory if the file is in the current directory or a
12189 subdirectory. Otherwise, the link will be the absolute path as
12190 completed in the minibuffer (i.e. normally ~/path/to/file).
12193 is in the current directory or below.
12195 `org-keep-stored-link-after-insertion'."
12196 (interactive "P")
12197 (let* ((wcf (current-window-configuration))
12198 (region (if (org-region-active-p)
12199 (buffer-substring (region-beginning) (region-end))))
12200 (remove (and region (list (region-beginning) (region-end))))
12201 (desc region)
12202 tmphist ; byte-compile incorrectly complains about this
12203 link entry file)
12204 (cond
12205 ((org-in-regexp org-bracket-link-regexp 1)
12206 ;; We do have a link at point, and we are going to edit it.
12207 (setq remove (list (match-beginning 0) (match-end 0)))
12208 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12209 (setq link (read-string "Link: "
12210 (org-link-unescape
12211 (org-match-string-no-properties 1)))))
12212 ((or (org-in-regexp org-angle-link-re)
12213 (org-in-regexp org-plain-link-re))
12214 ;; Convert to bracket link
12215 (setq remove (list (match-beginning 0) (match-end 0))
12216 link (read-string "Link: "
12217 (org-remove-angle-brackets (match-string 0)))))
12218 ((equal complete-file '(4))
12219 ;; Completing read for file names.
12220 (setq file (read-file-name "File: "))
12221 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12222 (pwd1 (file-name-as-directory (abbreviate-file-name
12223 (expand-file-name ".")))))
12224 (cond
12225 ((equal complete-file '(16))
12226 (setq link (org-make-link
12227 "file:"
12228 (abbreviate-file-name (expand-file-name file)))))
12230 (setq link (org-make-link "file:" (match-string 1 file))))
12232 (expand-file-name file))
12233 (setq link (org-make-link
12234 "file:" (match-string 1 (expand-file-name file)))))
12235 (t (setq link (org-make-link "file:" file))))))
12236 (t
12237 ;; Read link, with completion for stored links.
12238 (with-output-to-temp-buffer "*Org Links*"
12240 (when org-stored-links
12242 (princ (mapconcat
12243 (lambda (x)
12244 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12246 (let ((cw (selected-window)))
12247 (select-window (get-buffer-window "*Org Links*"))
12248 (shrink-window-if-larger-than-buffer)
12249 (setq truncate-lines t)
12250 (select-window cw))
12251 ;; Fake a link history, containing the stored links.
12252 (setq tmphist (append (mapcar 'car org-stored-links)
12253 org-insert-link-history))
12254 (unwind-protect
12255 (setq link (org-completing-read
12256 "Link: "
12257 (append
12258 (mapcar (lambda (x) (list (concat (car x) ":")))
12259 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12260 (mapcar (lambda (x) (list (concat x ":")))
12261 org-link-types))
12262 nil nil nil
12263 'tmphist
12264 (or (car (car org-stored-links)))))
12265 (set-window-configuration wcf)
12266 (kill-buffer "*Org Links*"))
12267 (setq entry (assoc link org-stored-links))
12268 (or entry (push link org-insert-link-history))
12269 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12270 (not org-keep-stored-link-after-insertion))
12271 (setq org-stored-links (delq (assoc link org-stored-links)
12272 org-stored-links)))
12273 (setq desc (or desc (nth 1 entry)))))
12275 (if (string-match org-plain-link-re link)
12276 ;; URL-like link, normalize the use of angular brackets.
12277 (setq link (org-make-link (org-remove-angle-brackets link))))
12279 ;; Check if we are linking to the current file with a search option
12280 ;; If yes, simplify the link by using only the search option.
12281 (when (and buffer-file-name
12283 (let* ((path (match-string 1 link))
12284 (case-fold-search nil)
12285 (search (match-string 2 link)))
12286 (save-match-data
12287 (if (equal (file-truename buffer-file-name) (file-truename path))
12288 ;; We are linking to this same file, with a search option
12289 (setq link search)))))
12291 ;; Check if we can/should use a relative path. If yes, simplify the link
12293 (let* ((path (match-string 1 link))
12294 (origpath path)
12295 (desc-is-link (equal link desc))
12296 (case-fold-search nil))
12297 (cond
12298 ((eq org-link-file-path-type 'absolute)
12299 (setq path (abbreviate-file-name (expand-file-name path))))
12300 ((eq org-link-file-path-type 'noabbrev)
12301 (setq path (expand-file-name path)))
12302 ((eq org-link-file-path-type 'relative)
12303 (setq path (file-relative-name path)))
12304 (t
12305 (save-match-data
12306 (if (string-match (concat "^" (regexp-quote
12307 (file-name-as-directory
12308 (expand-file-name "."))))
12309 (expand-file-name path))
12310 ;; We are linking a file with relative path name.
12311 (setq path (substring (expand-file-name path)
12312 (match-end 0)))))))
12313 (setq link (concat "file:" path))
12314 (if (equal desc origpath)
12315 (setq desc path))))
12317 (setq desc (read-string "Description: " desc))
12319 (if remove (apply 'delete-region remove))
12320 (insert (org-make-link-string link desc))))
12322 (defun org-completing-read (&rest args)
12323 (let ((minibuffer-local-completion-map
12324 (copy-keymap minibuffer-local-completion-map)))
12325 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12326 (apply 'completing-read args)))
12328 ;;; Opening/following a link
12329 (defvar org-link-search-failed nil)
12331 (defun org-next-link ()
12332 "Move forward to the next link.
12333 If the link is in hidden text, expose it."
12334 (interactive)
12335 (when (and org-link-search-failed (eq this-command last-command))
12336 (goto-char (point-min))
12337 (message "Link search wrapped back to beginning of buffer"))
12338 (setq org-link-search-failed nil)
12339 (let* ((pos (point))
12340 (ct (org-context))
12341 (a (assoc :link ct)))
12342 (if a (goto-char (nth 2 a)))
12343 (if (re-search-forward org-any-link-re nil t)
12344 (progn
12345 (goto-char (match-beginning 0))
12346 (if (org-invisible-p) (org-show-context)))
12347 (goto-char pos)
12348 (setq org-link-search-failed t)
12349 (error "No further link found"))))
12351 (defun org-previous-link ()
12352 "Move backward to the previous link.
12353 If the link is in hidden text, expose it."
12354 (interactive)
12355 (when (and org-link-search-failed (eq this-command last-command))
12356 (goto-char (point-max))
12357 (message "Link search wrapped back to end of buffer"))
12358 (setq org-link-search-failed nil)
12359 (let* ((pos (point))
12360 (ct (org-context))
12361 (a (assoc :link ct)))
12362 (if a (goto-char (nth 1 a)))
12363 (if (re-search-backward org-any-link-re nil t)
12364 (progn
12365 (goto-char (match-beginning 0))
12366 (if (org-invisible-p) (org-show-context)))
12367 (goto-char pos)
12368 (setq org-link-search-failed t)
12369 (error "No further link found"))))
12371 (defun org-find-file-at-mouse (ev)
12372 "Open file link or URL at mouse."
12373 (interactive "e")
12374 (mouse-set-point ev)
12375 (org-open-at-point 'in-emacs))
12377 (defun org-open-at-mouse (ev)
12378 "Open file link or URL at mouse."
12379 (interactive "e")
12380 (mouse-set-point ev)
12381 (org-open-at-point))
12383 (defvar org-window-config-before-follow-link nil
12384 "The window configuration before following a link.
12385 This is saved in case the need arises to restore it.")
12387 (defvar org-open-link-marker (make-marker)
12388 "Marker pointing to the location where `org-open-at-point; was called.")
12390 ;;;###autoload
12391 (defun org-open-at-point-global ()
12392 "Follow a link like Org-mode does.
12393 This command can be called in any mode to follow a link that has
12394 Org-mode syntax."
12395 (interactive)
12396 (org-run-like-in-org-mode 'org-open-at-point))
12398 (defun org-open-at-point (&optional in-emacs)
12399 "Open link at or after point.
12400 If there is no link at point, this function will search forward up to
12401 the end of the current subtree.
12402 Normally, files will be opened by an appropriate application. If the
12403 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12404 (interactive "P")
12405 (catch 'abort
12406 (move-marker org-open-link-marker (point))
12407 (setq org-window-config-before-follow-link (current-window-configuration))
12408 (org-remove-occur-highlights nil nil t)
12409 (if (org-at-timestamp-p t)
12410 (org-follow-timestamp-link)
12411 (let (type path link line search (pos (point)))
12412 (catch 'match
12413 (save-excursion
12415 (when (org-in-regexp org-bracket-link-regexp)
12416 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12418 (setq link (replace-match " " t t link)))
12419 (setq link (org-link-expand-abbrev link))
12420 (if (string-match org-link-re-with-space2 link)
12421 (setq type (match-string 1 link) path (match-string 2 link))
12422 (setq type "thisfile" path link))
12423 (throw 'match t)))
12425 (when (get-text-property (point) 'org-linked-text)
12426 (setq type "thisfile"
12427 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12428 (1+ (point)) (point))
12429 path (buffer-substring
12430 (previous-single-property-change pos 'org-linked-text)
12431 (next-single-property-change pos 'org-linked-text)))
12432 (throw 'match t))
12434 (save-excursion
12435 (when (or (org-in-regexp org-angle-link-re)
12436 (org-in-regexp org-plain-link-re))
12437 (setq type (match-string 1) path (match-string 2))
12438 (throw 'match t)))
12440 (setq type "tree-match"
12441 path (match-string 1))
12442 (throw 'match t))
12443 (save-excursion
12445 (setq type "tags"
12446 path (match-string 1))
12447 (while (string-match ":" path)
12448 (setq path (replace-match "+" t t path)))
12449 (throw 'match t))))
12450 (unless path
12451 (error "No link found"))
12452 ;; Remove any trailing spaces in path
12454 (setq path (replace-match "" t t path)))
12456 (cond
12458 ((assoc type org-link-protocols)
12459 (funcall (nth 1 (assoc type org-link-protocols)) path))
12461 ((equal type "mailto")
12462 (let ((cmd (car org-link-mailto-program))
12463 (args (cdr org-link-mailto-program)) args1
12464 (address path) (subject "") a)
12466 (setq address (match-string 1 path)
12467 subject (org-link-escape (match-string 2 path))))
12468 (while args
12469 (cond
12470 ((not (stringp (car args))) (push (pop args) args1))
12471 (t (setq a (pop args))
12472 (if (string-match "%a" a)
12473 (setq a (replace-match address t t a)))
12474 (if (string-match "%s" a)
12475 (setq a (replace-match subject t t a)))
12476 (push a args1))))
12477 (apply cmd (nreverse args1))))
12479 ((member type '("http" "https" "ftp" "news"))
12480 (browse-url (concat type ":" (org-link-escape
12481 path org-link-escape-chars-browser))))
12483 ((string= type "tags")
12484 (org-tags-view in-emacs path))
12485 ((string= type "thisfile")
12486 (if in-emacs
12487 (switch-to-buffer-other-window
12488 (org-get-buffer-for-internal-link (current-buffer)))
12489 (org-mark-ring-push))
12490 (let ((cmd `(org-link-search
12491 ,path
12492 ,(cond ((equal in-emacs '(4)) 'occur)
12493 ((equal in-emacs '(16)) 'org-occur)
12494 (t nil))
12495 ,pos)))
12496 (condition-case nil (eval cmd)
12497 (error (progn (widen) (eval cmd))))))
12499 ((string= type "tree-match")
12502 ((string= type "file")
12504 (setq line (string-to-number (match-string 1 path))
12505 path (substring path 0 (match-beginning 0)))
12507 (setq search (match-string 1 path)
12508 path (substring path 0 (match-beginning 0)))))
12509 (if (string-match "[*?{]" (file-name-nondirectory path))
12510 (dired path)
12511 (org-open-file path in-emacs line search)))
12513 ((string= type "news")
12514 (org-follow-gnus-link path))
12516 ((string= type "bbdb")
12517 (org-follow-bbdb-link path))
12519 ((string= type "info")
12520 (org-follow-info-link path))
12522 ((string= type "gnus")
12523 (let (group article)
12525 (error "Error in Gnus link"))
12526 (setq group (match-string 1 path)
12527 article (match-string 3 path))
12528 (org-follow-gnus-link group article)))
12530 ((string= type "vm")
12531 (let (folder article)
12533 (error "Error in VM link"))
12534 (setq folder (match-string 1 path)
12535 article (match-string 3 path))
12536 ;; in-emacs is the prefix arg, will be interpreted as read-only
12537 (org-follow-vm-link folder article in-emacs)))
12539 ((string= type "wl")
12540 (let (folder article)
12542 (error "Error in Wanderlust link"))
12543 (setq folder (match-string 1 path)
12544 article (match-string 3 path))
12545 (org-follow-wl-link folder article)))
12547 ((string= type "mhe")
12548 (let (folder article)
12550 (error "Error in MHE link"))
12551 (setq folder (match-string 1 path)
12552 article (match-string 3 path))
12553 (org-follow-mhe-link folder article)))
12555 ((string= type "rmail")
12556 (let (folder article)
12558 (error "Error in RMAIL link"))
12559 (setq folder (match-string 1 path)
12560 article (match-string 3 path))
12561 (org-follow-rmail-link folder article)))
12563 ((string= type "shell")
12564 (let ((cmd path))
12565 (if (or (not org-confirm-shell-link-function)
12566 (funcall org-confirm-shell-link-function
12568 (org-add-props cmd nil
12569 'face 'org-warning))))
12570 (progn
12571 (message "Executing %s" cmd)
12572 (shell-command cmd))
12573 (error "Abort"))))
12575 ((string= type "elisp")
12576 (let ((cmd path))
12577 (if (or (not org-confirm-elisp-link-function)
12578 (funcall org-confirm-elisp-link-function
12580 (org-add-props cmd nil
12581 'face 'org-warning))))
12582 (message "%s => %s" cmd (eval (read cmd)))
12583 (error "Abort"))))
12585 (t
12586 (browse-url-at-point)))))
12587 (move-marker org-open-link-marker nil)))
12589 ;;; File search
12591 (defvar org-create-file-search-functions nil
12592 "List of functions to construct the right search string for a file link.
12593 These functions are called in turn with point at the location to
12594 which the link should point.
12596 A function in the hook should first test if it would like to
12597 handle this file type, for example by checking the major-mode or
12598 the file extension. If it decides not to handle this file, it
12599 should just return nil to give other functions a chance. If it
12600 does handle the file, it must return the search string to be used
12601 when following the link. The search string will be part of the
12602 file link, given after a double colon, and `org-open-at-point'
12603 will automatically search for it. If special measures must be
12604 taken to make the search successful, another function should be
12605 added to the companion hook `org-execute-file-search-functions',
12606 which see.
12608 A function in this hook may also use `setq' to set the variable
12609 `description' to provide a suggestion for the descriptive text to
12610 be used for this link when it gets inserted into an Org-mode
12613 (defvar org-execute-file-search-functions nil
12614 "List of functions to execute a file search triggered by a link.
12616 Functions added to this hook must accept a single argument, the
12617 search string that was part of the file link, the part after the
12618 double colon. The function must first check if it would like to
12619 handle this search, for example by checking the major-mode or the
12620 file extension. If it decides not to handle this search, it
12621 should just return nil to give other functions a chance. If it
12622 does handle the search, it must return a non-nil value to keep
12623 other functions from trying.
12625 Each function can access the current prefix argument through the
12626 variable `current-prefix-argument'. Note that a single prefix is
12627 used to force opening a link in Emacs, so it may be good to only
12628 use a numeric or double prefix to guide the search function.
12630 In case this is needed, a function in this hook can also restore
12631 the window configuration before `org-open-at-point' was called using:
12633 (set-window-configuration org-window-config-before-follow-link)")
12635 (defun org-link-search (s &optional type avoid-pos)
12636 "Search for a link search option.
12637 If S is surrounded by forward slashes, it is interpreted as a
12638 regular expression. In org-mode files, this will create an `org-occur'
12639 sparse tree. In ordinary files, `occur' will be used to list matches.
12640 If the current buffer is in `dired-mode', grep will be used to search
12641 in all files. If AVOID-POS is given, ignore matches near that position."
12642 (let ((case-fold-search t)
12646 org-emphasis-alist)
12648 (pos (point))
12649 (pre "") (post "")
12650 words re0 re1 re2 re3 re4 re5 re2a reall)
12651 (cond
12652 ;; First check if there are any special
12653 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12654 ;; Now try the builtin stuff
12655 ((save-excursion
12656 (goto-char (point-min))
12657 (and
12658 (re-search-forward
12659 (concat "<<" (regexp-quote s0) ">>") nil t)
12660 (setq pos (match-beginning 0))))
12661 ;; There is an exact target for this
12662 (goto-char pos))
12664 ;; A regular expression
12665 (cond
12666 ((org-mode-p)
12667 (org-occur (match-string 1 s)))
12668 ;;((eq major-mode 'dired-mode)
12669 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12670 (t (org-do-occur (match-string 1 s)))))
12671 (t
12672 ;; A normal search strings
12673 (when (equal (string-to-char s) ?*)
12674 ;; Anchor on headlines, post may include tags.
12677 s (substring s 1)))
12678 (remove-text-properties
12679 0 (length s)
12680 '(face nil mouse-face nil keymap nil fontified nil) s)
12681 ;; Make a series of regular expressions to find a match
12688 re1 (concat pre re2 post)
12689 re3 (concat pre re4 post)
12690 re5 (concat pre ".*" re4)
12691 re2 (concat pre re2)
12692 re2a (concat pre re2a)
12693 re4 (concat pre re4)
12697 ))
12698 (cond
12699 ((eq type 'org-occur) (org-occur reall))
12700 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12701 (t (goto-char (point-min))
12702 (if (or (org-search-not-self 1 re0 nil t)
12703 (org-search-not-self 1 re1 nil t)
12704 (org-search-not-self 1 re2 nil t)
12705 (org-search-not-self 1 re2a nil t)
12706 (org-search-not-self 1 re3 nil t)
12707 (org-search-not-self 1 re4 nil t)
12708 (org-search-not-self 1 re5 nil t)
12709 )
12710 (goto-char (match-beginning 1))
12711 (goto-char pos)
12712 (error "No match")))))
12713 (t
12714 ;; Normal string-search
12715 (goto-char (point-min))
12716 (if (search-forward s nil t)
12717 (goto-char (match-beginning 0))
12718 (error "No match"))))
12719 (and (org-mode-p) (org-show-context 'link-search))))
12721 (defun org-search-not-self (group &rest args)
12722 "Execute `re-search-forward', but only accept matches that do not
12723 enclose the position of `org-open-link-marker'."
12724 (let ((m org-open-link-marker))
12725 (catch 'exit
12726 (while (apply 're-search-forward args)
12727 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12728 (goto-char (match-end group))
12729 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12730 (> (match-beginning 0) (marker-position m))
12731 (< (match-end 0) (marker-position m)))
12732 (save-match-data
12733 (or (not (org-in-regexp
12734 org-bracket-link-analytic-regexp 1))
12735 (not (match-end 4)) ; no description
12736 (and (<= (match-beginning 4) (point))
12737 (>= (match-end 4) (point))))))
12738 (throw 'exit (point))))))))
12740 (defun org-get-buffer-for-internal-link (buffer)
12741 "Return a buffer to be used for displaying the link target of internal links."
12742 (cond
12743 ((not org-display-internal-link-with-indirect-buffer)
12744 buffer)
12745 ((string-match "(Clone)$" (buffer-name buffer))
12746 (message "Buffer is already a clone, not making another one")
12747 ;; we also do not modify visibility in this case
12748 buffer)
12749 (t ; make a new indirect buffer for displaying the link
12750 (let* ((bn (buffer-name buffer))
12751 (ibn (concat bn "(Clone)"))
12752 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12753 (with-current-buffer ib (org-overview))
12754 ib))))
12756 (defun org-do-occur (regexp &optional cleanup)
12757 "Call the Emacs command `occur'.
12758 If CLEANUP is non-nil, remove the printout of the regular expression
12759 in the *Occur* buffer. This is useful if the regex is long and not useful
12760 to read."
12761 (occur regexp)
12762 (when cleanup
12763 (let ((cwin (selected-window)) win beg end)
12764 (when (setq win (get-buffer-window "*Occur*"))
12765 (select-window win))
12766 (goto-char (point-min))
12767 (when (re-search-forward "match[a-z]+" nil t)
12768 (setq beg (match-end 0))
12770 (setq end (1- (match-beginning 0)))))
12771 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12772 (goto-char (point-min))
12773 (select-window cwin))))
12775 ;;; The mark ring for links jumps
12777 (defvar org-mark-ring nil
12778 "Mark ring for positions before jumps in Org-mode.")
12779 (defvar org-mark-ring-last-goto nil
12780 "Last position in the mark ring used to go back.")
12781 ;; Fill and close the ring
12782 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12783 (loop for i from 1 to org-mark-ring-length do
12784 (push (make-marker) org-mark-ring))
12785 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12786 org-mark-ring)
12788 (defun org-mark-ring-push (&optional pos buffer)
12789 "Put the current position or POS into the mark ring and rotate it."
12790 (interactive)
12791 (setq pos (or pos (point)))
12792 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12793 (move-marker (car org-mark-ring)
12794 (or pos (point))
12795 (or buffer (current-buffer)))
12796 (message "%s"
12797 (substitute-command-keys
12800 (defun org-mark-ring-goto (&optional n)
12801 "Jump to the previous position in the mark ring.
12802 With prefix arg N, jump back that many stored positions. When
12803 called several times in succession, walk through the entire ring.
12804 Org-mode commands jumping to a different position in the current file,
12805 or to another Org-mode file, automatically push the old position
12806 onto the ring."
12807 (interactive "p")
12808 (let (p m)
12809 (if (eq last-command this-command)
12810 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12811 (setq p org-mark-ring))
12812 (setq org-mark-ring-last-goto p)
12813 (setq m (car p))
12814 (switch-to-buffer (marker-buffer m))
12815 (goto-char m)
12816 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12818 (defun org-remove-angle-brackets (s)
12819 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12820 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12821 s)
12822 (defun org-add-angle-brackets (s)
12823 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12824 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12825 s)
12827 ;;; Following specific links
12829 (defun org-follow-timestamp-link ()
12830 (cond
12831 ((org-at-date-range-p t)
12832 (let ((org-agenda-start-on-weekday)
12833 (t1 (match-string 1))
12834 (t2 (match-string 2)))
12835 (setq t1 (time-to-days (org-time-string-to-time t1))
12836 t2 (time-to-days (org-time-string-to-time t2)))
12837 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12838 ((org-at-timestamp-p t)
12839 (org-agenda-list nil (time-to-days (org-time-string-to-time
12840 (substring (match-string 1) 0 10)))
12841 1))
12842 (t (error "This should not happen"))))
12845 (defun org-follow-bbdb-link (name)
12846 "Follow a BBDB link to NAME."
12847 (require 'bbdb)
12848 (let ((inhibit-redisplay (not debug-on-error))
12849 (bbdb-electric-p nil))
12850 (catch 'exit
12851 ;; Exact match on name
12853 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12854 ;; Exact match on name
12856 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12857 ;; Partial match on name
12858 (bbdb-name name nil)
12859 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12860 ;; Partial match on company
12861 (bbdb-company name nil)
12862 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12863 ;; General match including network address and notes
12864 (bbdb name nil)
12865 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
12866 (delete-window (get-buffer-window "*BBDB*"))
12867 (error "No matching BBDB record")))))
12869 (defun org-follow-info-link (name)
12870 "Follow an info file & node link to NAME."
12873 (progn
12874 (require 'info)
12875 (if (match-string 2 name) ; If there isn't a node, choose "Top"
12876 (Info-find-node (match-string 1 name) (match-string 2 name))
12877 (Info-find-node (match-string 1 name) "Top")))
12878 (message "Could not open: %s" name)))
12880 (defun org-follow-gnus-link (&optional group article)
12881 "Follow a Gnus link to GROUP and ARTICLE."
12882 (require 'gnus)
12883 (funcall (cdr (assq 'gnus org-link-frame-setup)))
12884 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
12885 (cond ((and group article)
12886 (gnus-group-read-group 1 nil group)
12887 (gnus-summary-goto-article (string-to-number article) nil t))
12888 (group (gnus-group-jump-to-group group))))
12890 (defun org-follow-vm-link (&optional folder article readonly)
12891 "Follow a VM link to FOLDER and ARTICLE."
12892 (require 'vm)
12893 (setq article (org-add-angle-brackets article))
12895 ;; ange-ftp or efs or tramp access
12896 (let ((user (or (match-string 1 folder) (user-login-name)))
12897 (host (match-string 2 folder))
12898 (file (match-string 3 folder)))
12899 (cond
12900 ((featurep 'tramp)
12901 ;; use tramp to access the file
12902 (if (featurep 'xemacs)
12903 (setq folder (format "[%s@%s]%s" user host file))
12904 (setq folder (format "/%s@%s:%s" user host file))))
12905 (t
12906 ;; use ange-ftp or efs
12907 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
12908 (setq folder (format "/%s@%s:%s" user host file))))))
12909 (when folder
12910 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
12911 (sit-for 0.1)
12912 (when article
12913 (vm-select-folder-buffer)
12914 (widen)
12915 (let ((case-fold-search t))
12916 (goto-char (point-min))
12917 (if (not (re-search-forward
12918 (concat "^" "message-id: *" (regexp-quote article))))
12919 (error "Could not find the specified message in this folder"))
12920 (vm-isearch-update)
12921 (vm-isearch-narrow)
12922 (vm-beginning-of-message)
12923 (vm-summarize)))))
12925 (defun org-follow-wl-link (folder article)
12926 "Follow a Wanderlust link to FOLDER and ARTICLE."
12927 (if (and (string= folder "%")
12928 article
12930 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
12931 ;; Thus, we recompose folder and article ids.
12932 (setq folder (format "%s#%s" folder (match-string 1 article))
12933 article (match-string 3 article)))
12934 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
12935 (error "No such folder: %s" folder))
12936 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
12937 (and article
12938 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
12939 (wl-summary-redisplay)))
12941 (defun org-follow-rmail-link (folder article)
12942 "Follow an RMAIL link to FOLDER and ARTICLE."
12943 (setq article (org-add-angle-brackets article))
12944 (let (message-number)
12945 (save-excursion
12946 (save-window-excursion
12947 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12948 (setq message-number
12949 (save-restriction
12950 (widen)
12951 (goto-char (point-max))
12952 (if (re-search-backward
12954 (or article "")))
12955 nil t)
12956 (rmail-what-message))))))
12957 (if message-number
12958 (progn
12959 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12960 (rmail-show-message message-number)
12961 message-number)
12962 (error "Message not found"))))
12964 ;;; mh-e integration based on planner-mode
12965 (defun org-mhe-get-message-real-folder ()
12966 "Return the name of the current message real folder, so if you use
12967 sequences, it will now work."
12968 (save-excursion
12969 (let* ((folder
12970 (if (equal major-mode 'mh-folder-mode)
12971 mh-current-folder
12972 ;; Refer to the show buffer
12973 mh-show-folder-buffer))
12974 (end-index
12975 (if (boundp 'mh-index-folder)
12976 (min (length mh-index-folder) (length folder))))
12977 )
12978 ;; a simple test on mh-index-data does not work, because
12979 ;; mh-index-data is always nil in a show buffer.
12980 (if (and (boundp 'mh-index-folder)
12981 (string= mh-index-folder (substring folder 0 end-index)))
12982 (if (equal major-mode 'mh-show-mode)
12983 (save-window-excursion
12984 (let (pop-up-frames)
12985 (when (buffer-live-p (get-buffer folder))
12986 (progn
12987 (pop-to-buffer folder)
12988 (org-mhe-get-message-folder-from-index)
12989 )
12990 )))
12991 (org-mhe-get-message-folder-from-index)
12992 )
12993 folder
12994 )
12995 )))
12997 (defun org-mhe-get-message-folder-from-index ()
12998 "Returns the name of the message folder in a index folder buffer."
12999 (save-excursion
13000 (mh-index-previous-folder)
13002 (message "%s" (match-string 1))))
13004 (defun org-mhe-get-message-folder ()
13005 "Return the name of the current message folder. Be careful if you
13006 use sequences."
13007 (save-excursion
13008 (if (equal major-mode 'mh-folder-mode)
13009 mh-current-folder
13010 ;; Refer to the show buffer
13011 mh-show-folder-buffer)))
13013 (defun org-mhe-get-message-num ()
13014 "Return the number of the current message. Be careful if you
13015 use sequences."
13016 (save-excursion
13017 (if (equal major-mode 'mh-folder-mode)
13018 (mh-get-msg-num nil)
13019 ;; Refer to the show buffer
13020 (mh-show-buffer-message-number))))
13022 (defun org-mhe-get-header (header)
13023 "Return a header of the message in folder mode. This will create a
13024 show buffer for the corresponding message. If you have a more clever
13025 idea..."
13026 (let* ((folder (org-mhe-get-message-folder))
13027 (num (org-mhe-get-message-num))
13028 (buffer (get-buffer-create (concat "show-" folder)))
13029 (header-field))
13030 (with-current-buffer buffer
13031 (mh-display-msg num folder)
13032 (if (equal major-mode 'mh-folder-mode)
13033 (mh-header-display)
13034 (mh-show-header-display))
13035 (set-buffer buffer)
13036 (setq header-field (mh-get-header-field header))
13037 (if (equal major-mode 'mh-folder-mode)
13038 (mh-show)
13039 (mh-show-show))
13040 header-field)))
13042 (defun org-follow-mhe-link (folder article)
13043 "Follow an MHE link to FOLDER and ARTICLE.
13044 If ARTICLE is nil FOLDER is shown. If the configuration variable
13045 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13046 ARTICLE is searched in all folders. Indexed searches (swish++,
13047 namazu, and others supported by MH-E) will always search in all
13048 folders."
13049 (require 'mh-e)
13050 (require 'mh-search)
13051 (require 'mh-utils)
13052 (mh-find-path)
13053 (if (not article)
13054 (mh-visit-folder (mh-normalize-folder-name folder))
13055 (setq article (org-add-angle-brackets article))
13056 (mh-search-choose)
13057 (if (equal mh-searcher 'pick)
13058 (progn
13059 (mh-search folder (list "--message-id" article))
13060 (when (and org-mhe-search-all-folders
13061 (not (org-mhe-get-message-real-folder)))
13062 (kill-this-buffer)
13063 (mh-search "+" (list "--message-id" article))))
13064 (mh-search "+" article))
13065 (if (org-mhe-get-message-real-folder)
13066 (mh-show-msg 1)
13067 (kill-this-buffer)
13068 (error "Message not found"))))
13070 ;;; BibTeX links
13072 ;; Use the custom search meachnism to construct and use search strings for
13073 ;; file links to BibTeX database entries.
13075 (defun org-create-file-search-in-bibtex ()
13076 "Create the search string and description for a BibTeX database entry."
13077 (when (eq major-mode 'bibtex-mode)
13078 ;; yes, we want to construct this search string.
13079 ;; Make a good description for this entry, using names, year and the title
13080 ;; Put it into the `description' variable which is dynamically scoped.
13081 (let ((bibtex-autokey-names 1)
13082 (bibtex-autokey-names-stretch 1)
13083 (bibtex-autokey-name-case-convert-function 'identity)
13084 (bibtex-autokey-name-separator " & ")
13085 (bibtex-autokey-additional-names " et al.")
13086 (bibtex-autokey-year-length 4)
13087 (bibtex-autokey-name-year-separator " ")
13088 (bibtex-autokey-titlewords 3)
13089 (bibtex-autokey-titleword-separator " ")
13090 (bibtex-autokey-titleword-case-convert-function 'identity)
13091 (bibtex-autokey-titleword-length 'infty)
13092 (bibtex-autokey-year-title-separator ": "))
13093 (setq description (bibtex-generate-autokey)))
13094 ;; Now parse the entry, get the key and return it.
13095 (save-excursion
13096 (bibtex-beginning-of-entry)
13097 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13099 (defun org-execute-file-search-in-bibtex (s)
13100 "Find the link search string S as a key for a database entry."
13101 (when (eq major-mode 'bibtex-mode)
13102 ;; Yes, we want to do the search in this file.
13103 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13104 (goto-char (point-min))
13107 (goto-char (match-beginning 0)))
13108 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13109 ;; Use double prefix to indicate that any web link should be browsed
13110 (let ((b (current-buffer)) (p (point)))
13111 ;; Restore the window configuration because we just use the web link
13112 (set-window-configuration org-window-config-before-follow-link)
13113 (save-excursion (set-buffer b) (goto-char p)
13114 (bibtex-url)))
13115 (recenter 0)) ; Move entry start to beginning of window
13116 ;; return t to indicate that the search is done.
13117 t))
13119 ;; Finally add the functions to the right hooks.
13120 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13121 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13123 ;; end of Bibtex link setup
13125 ;;; Following file links
13127 (defun org-open-file (path &optional in-emacs line search)
13128 "Open the file at PATH.
13129 First, this expands any special file name abbreviations. Then the
13130 configuration variable `org-file-apps' is checked if it contains an
13131 entry for this file type, and if yes, the corresponding command is launched.
13132 If no application is found, Emacs simply visits the file.
13133 With optional argument IN-EMACS, Emacs will visit the file.
13134 Optional LINE specifies a line to go to, optional SEARCH a string to
13135 search for. If LINE or SEARCH is given, the file will always be
13136 opened in Emacs.
13137 If the file does not exist, an error is thrown."
13138 (setq in-emacs (or in-emacs line search))
13139 (let* ((file (if (equal path "")
13140 buffer-file-name
13141 (substitute-in-file-name (expand-file-name path))))
13142 (apps (append org-file-apps (org-default-apps)))
13143 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13144 (dirp (if remp nil (file-directory-p file)))
13145 (dfile (downcase file))
13146 (old-buffer (current-buffer))
13147 (old-pos (point))
13148 (old-mode major-mode)
13149 ext cmd)
13151 (setq ext (match-string 1 dfile))
13153 (setq ext (match-string 1 dfile))))
13154 (if in-emacs
13155 (setq cmd 'emacs)
13156 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13157 (and dirp (cdr (assoc 'directory apps)))
13158 (cdr (assoc ext apps))
13159 (cdr (assoc t apps)))))
13160 (when (eq cmd 'mailcap)
13161 (require 'mailcap)
13162 (mailcap-parse-mailcaps)
13163 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13164 (command (mailcap-mime-info mime-type)))
13165 (if (stringp command)
13166 (setq cmd command)
13167 (setq cmd 'emacs))))
13168 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13169 (not (file-exists-p file))
13170 (not org-open-non-existing-files))
13171 (error "No such file: %s" file))
13172 (cond
13174 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13176 (setq cmd (replace-match "%s" t t cmd)))
13177 (while (string-match "%s" cmd)
13178 (setq cmd (replace-match (shell-quote-argument file) t t cmd)))
13179 (save-window-excursion
13180 (start-process-shell-command cmd nil cmd)))
13181 ((or (stringp cmd)
13182 (eq cmd 'emacs))
13183 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13184 (widen)
13185 (if line (goto-line line)
13186 (if search (org-link-search search))))
13187 ((consp cmd)
13188 (eval cmd))
13189 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13190 (and (org-mode-p) (eq old-mode 'org-mode)
13191 (or (not (equal old-buffer (current-buffer)))
13192 (not (equal old-pos (point))))
13193 (org-mark-ring-push old-pos old-buffer))))
13195 (defun org-default-apps ()
13196 "Return the default applications for this operating system."
13197 (cond
13198 ((eq system-type 'darwin)
13199 org-file-apps-defaults-macosx)
13200 ((eq system-type 'windows-nt)
13201 org-file-apps-defaults-windowsnt)
13202 (t org-file-apps-defaults-gnu)))
13204 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13205 (defun org-file-remote-p (file)
13206 "Test whether FILE specifies a location on a remote system.
13207 Return non-nil if the location is indeed remote.
13211 (cond ((fboundp 'file-remote-p)
13212 (file-remote-p file))
13213 ((fboundp 'tramp-handle-file-remote-p)
13214 (tramp-handle-file-remote-p file))
13215 ((and (boundp 'ange-ftp-name-format)
13216 (string-match (car ange-ftp-name-format) file))
13217 t)
13218 (t nil)))
13221 ;;;; Hooks for remember.el, and refiling
13223 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13224 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13226 ;;;###autoload
13227 (defun org-remember-insinuate ()
13228 "Setup remember.el for use wiht Org-mode."
13229 (require 'remember)
13230 (setq remember-annotation-functions '(org-remember-annotation))
13231 (setq remember-handler-functions '(org-remember-handler))
13232 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13234 ;;;###autoload
13235 (defun org-remember-annotation ()
13236 "Return a link to the current location as an annotation for remember.el.
13237 If you are using Org-mode files as target for data storage with
13238 remember.el, then the annotations should include a link compatible with the
13239 conventions in Org-mode. This function returns such a link."
13240 (org-store-link nil))
13242 (defconst org-remember-help
13243 "Select a destination location for the note.
13244 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13245 RET on headline -> Store as sublevel entry to current headline
13246 RET at beg-of-buf -> Append to file as level 2 headline
13247 <left>/<right> -> before/after current headline, same headings level")
13249 (defvar org-remember-previous-location nil)
13250 (defvar org-force-remember-template-char) ;; dynamically scoped
13252 (defun org-select-remember-template (&optional use-char)
13253 (when org-remember-templates
13254 (let* ((templates (mapcar (lambda (x)
13255 (if (stringp (car x))
13256 (append (list (nth 1 x) (car x)) (cddr x))
13257 (append (list (car x) "") (cdr x))))
13258 org-remember-templates))
13259 (char (or use-char
13260 (cond
13261 ((= (length templates) 1)
13262 (caar templates))
13263 ((and (boundp 'org-force-remember-template-char)
13264 org-force-remember-template-char)
13265 (if (stringp org-force-remember-template-char)
13266 (string-to-char org-force-remember-template-char)
13267 org-force-remember-template-char))
13268 (t
13269 (message "Select template: %s"
13270 (mapconcat
13271 (lambda (x)
13272 (cond
13274 (format "[%c]" (car x)))
13275 ((equal (downcase (car x))
13276 (downcase (aref (nth 1 x) 0)))
13277 (format "[%c]%s" (car x)
13278 (substring (nth 1 x) 1)))
13279 (t (format "[%c]%s" (car x) (nth 1 x)))))
13280 templates " "))
13281 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13282 (when (equal char0 ?\C-g)
13283 (jump-to-register remember-register)
13284 (kill-buffer remember-buffer))
13285 char0))))))
13286 (cddr (assoc char templates)))))
13288 (defvar x-last-selected-text)
13289 (defvar x-last-selected-text-primary)
13291 ;;;###autoload
13292 (defun org-remember-apply-template (&optional use-char skip-interactive)
13293 "Initialize *remember* buffer with template, invoke `org-mode'.
13294 This function should be placed into `remember-mode-hook' and in fact requires
13295 to be run from that hook to function properly."
13296 (unless (fboundp 'remember-finalize)
13297 (defalias 'remember-finalize 'remember-buffer))
13298 (if org-remember-templates
13299 (let* ((entry (org-select-remember-template use-char))
13300 (tpl (car entry))
13301 (plist-p (if org-store-link-plist t nil))
13302 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13304 (nth 1 entry)
13305 org-default-notes-file))
13306 (headline (nth 2 entry))
13307 (v-c (or (and (eq window-system 'x)
13308 (fboundp 'x-cut-buffer-or-selection-value)
13309 (x-cut-buffer-or-selection-value))
13310 (org-bound-and-true-p x-last-selected-text)
13311 (org-bound-and-true-p x-last-selected-text-primary)
13312 (and (> (length kill-ring) 0) (current-kill 0))))
13313 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13314 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13315 (v-u (concat "[" (substring v-t 1 -1) "]"))
13316 (v-U (concat "[" (substring v-T 1 -1) "]"))
13317 ;; `initial' and `annotation' are bound in `remember'
13318 (v-i (if (boundp 'initial) initial))
13319 (v-a (if (and (boundp 'annotation) annotation)
13320 (if (equal annotation "[[]]") "" annotation)
13321 ""))
13322 (v-A (if (and v-a
13325 v-a))
13326 (v-n user-full-name)
13327 (org-startup-folded nil)
13328 org-time-was-given org-end-time-was-given x
13329 prompt completions char time pos default histvar)
13330 (setq org-store-link-plist
13331 (append (list :annotation v-a :initial v-i)
13332 org-store-link-plist))
13333 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13334 (erase-buffer)
13335 (insert (substitute-command-keys
13336 (format
13337 "## Filing location: Select interactively, default, or last used:
13338 ## %s to select file and header location interactively.
13342 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13343 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13344 (abbreviate-file-name (or file org-default-notes-file))
13345 (or headline "")
13346 (or (car org-remember-previous-location) "???")
13347 (or (cdr org-remember-previous-location) "???"))))
13348 (insert tpl) (goto-char (point-min))
13349 ;; Simple %-escapes
13351 (when (and initial (equal (match-string 0) "%i"))
13352 (save-match-data
13353 (let* ((lead (buffer-substring
13354 (point-at-bol) (match-beginning 0))))
13355 (setq v-i (mapconcat 'identity
13358 (replace-match
13359 (or (eval (intern (concat "v-" (match-string 1)))) "")
13360 t t))
13362 ;; %[] Insert contents of a file.
13363 (goto-char (point-min))
13365 (let ((start (match-beginning 0))
13366 (end (match-end 0))
13367 (filename (expand-file-name (match-string 1))))
13368 (goto-char start)
13369 (delete-region start end)
13370 (condition-case error
13371 (insert-file-contents filename)
13372 (error (insert (format "%%![Couldn't insert %s: %s]"
13373 filename error))))))
13374 ;; %() embedded elisp
13375 (goto-char (point-min))
13377 (goto-char (match-beginning 0))
13378 (let ((template-start (point)))
13379 (forward-char 1)
13380 (let ((result
13381 (condition-case error
13382 (eval (read (current-buffer)))
13383 (error (format "%%![Error: %s]" error)))))
13384 (delete-region template-start (point))
13385 (insert result))))
13387 ;; From the property list
13388 (when plist-p
13389 (goto-char (point-min))
13391 (and (setq x (or (plist-get org-store-link-plist
13392 (intern (match-string 1))) ""))
13393 (replace-match x t t))))
13395 ;; Turn on org-mode in the remember buffer, set local variables
13396 (org-mode)
13397 (org-set-local 'org-finish-function 'remember-finalize)
13399 (org-set-local 'org-default-notes-file file))
13401 (org-set-local 'org-remember-default-headline headline))
13402 ;; Interactive template entries
13403 (goto-char (point-min))
13405 (setq char (if (match-end 3) (match-string 3))
13406 prompt (if (match-end 2) (match-string 2)))
13407 (goto-char (match-beginning 0))
13408 (replace-match "")
13409 (setq completions nil default nil)
13410 (when prompt
13411 (setq completions (org-split-string prompt "|")
13412 prompt (pop completions)
13413 default (car completions)
13414 histvar (intern (concat
13415 "org-remember-template-prompt-history::"
13416 (or prompt "")))
13417 completions (mapcar 'list completions)))
13418 (cond
13419 ((member char '("G" "g"))
13420 (let* ((org-last-tags-completion-table
13421 (org-global-tags-completion-table
13422 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13423 (org-add-colon-after-tag-completion t)
13424 (ins (completing-read
13425 (if prompt (concat prompt ": ") "Tags: ")
13426 'org-tags-completion-function nil nil nil
13427 'org-tags-history)))
13428 (setq ins (mapconcat 'identity
13429 (org-split-string ins (org-re "[^[:alnum:]]+"))
13430 ":"))
13432 (or (equal (char-before) ?:) (insert ":"))
13433 (insert ins)
13434 (or (equal (char-after) ?:) (insert ":")))))
13435 (char
13436 (setq org-time-was-given (equal (upcase char) char))
13437 (setq time (org-read-date (equal (upcase char) "U") t nil
13438 prompt))
13439 (org-insert-time-stamp time org-time-was-given
13440 (member char '("u" "U"))
13441 nil nil (list org-end-time-was-given)))
13442 (t
13443 (insert (org-completing-read
13444 (concat (if prompt prompt "Enter string")
13445 (if default (concat " [" default "]"))
13446 ": ")
13447 completions nil nil nil histvar default)))))
13448 (goto-char (point-min))
13450 (replace-match "")
13452 (org-mode)
13453 (org-set-local 'org-finish-function 'remember-finalize))
13454 (when (save-excursion
13455 (goto-char (point-min))
13456 (re-search-forward "%!" nil t))
13457 (replace-match "")
13458 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13460 (defun org-remember-finish-immediately ()
13461 "File remember note immediately.
13462 This should be run in `post-command-hook' and will remove itself
13463 from that hook."
13464 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13465 (when org-finish-function
13466 (funcall org-finish-function)))
13469 ;;;###autoload
13470 (defun org-remember (&optional goto org-force-remember-template-char)
13471 "Call `remember'. If this is already a remember buffer, re-apply template.
13472 If there is an active region, make sure remember uses it as initial content
13473 of the remember buffer.
13475 When called interactively with a `C-u' prefix argument GOTO, don't remember
13476 anything, just go to the file/headline where the selected templated usually
13477 stores its notes. With a double prefix arg `C-u C-u', got to the last
13478 note stored by remember.
13480 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13481 associated with a template in `org-remember-tempates'."
13482 (interactive "P")
13483 (cond
13484 ((equal goto '(4)) (org-go-to-remember-target))
13485 ((equal goto '(16)) (org-remember-goto-last-stored))
13486 (t
13487 (if (memq org-finish-function '(remember-buffer remember-finalize))
13488 (progn
13489 (when (< (length org-remember-templates) 2)
13490 (error "No other template available"))
13491 (erase-buffer)
13492 (let ((annotation (plist-get org-store-link-plist :annotation))
13493 (initial (plist-get org-store-link-plist :initial)))
13494 (org-remember-apply-template))
13495 (message "Press C-c C-c to remember data"))
13496 (if (org-region-active-p)
13497 (remember (buffer-substring (point) (mark)))
13498 (call-interactively 'remember))))))
13500 (defun org-remember-goto-last-stored ()
13501 "Go to the location where the last remember note was stored."
13502 (interactive)
13503 (bookmark-jump "org-remember-last-stored")
13504 (message "This is the last note stored by remember"))
13506 (defun org-go-to-remember-target (&optional template-key)
13507 "Go to the target location of a remember template.
13508 The user is queried for the template."
13509 (interactive)
13510 (let* ((entry (org-select-remember-template template-key))
13511 (file (nth 1 entry))
13512 (heading (nth 2 entry))
13513 visiting)
13515 (setq file org-default-notes-file))
13517 (setq heading org-remember-default-headline))
13518 (setq visiting (org-find-base-buffer-visiting file))
13519 (if (not visiting) (find-file-noselect file))
13520 (switch-to-buffer (or visiting (get-file-buffer file)))
13521 (widen)
13522 (goto-char (point-min))
13523 (if (re-search-forward
13526 nil t)
13527 (goto-char (match-beginning 0))
13528 (error "Target headline not found: %s" heading))))
13530 (defvar org-note-abort nil) ; dynamically scoped
13532 ;;;###autoload
13533 (defun org-remember-handler ()
13534 "Store stuff from remember.el into an org file.
13535 First prompts for an org file. If the user just presses return, the value
13536 of `org-default-notes-file' is used.
13537 Then the command offers the headings tree of the selected file in order to
13538 file the text at a specific location.
13539 You can either immediately press RET to get the note appended to the
13540 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13541 find a better place. Then press RET or <left> or <right> in insert the note.
13543 Key Cursor position Note gets inserted
13544 -----------------------------------------------------------------------------
13545 RET buffer-start as level 1 heading at end of file
13546 RET on headline as sublevel of the heading at cursor
13547 RET no heading at cursor position, level taken from context.
13548 Or use prefix arg to specify level manually.
13549 <left> on headline as same level, before current heading
13550 <right> on headline as same level, after current heading
13552 So the fastest way to store the note is to press RET RET to append it to
13553 the default file. This way your current train of thought is not
13554 interrupted, in accordance with the principles of remember.el.
13555 You can also get the fast execution without prompting by using
13556 C-u C-c C-c to exit the remember buffer. See also the variable
13557 `org-remember-store-without-prompt'.
13559 Before being stored away, the function ensures that the text has a
13561 is constructed from the current date and some additional data.
13563 If the variable `org-adapt-indentation' is non-nil, the entire text is
13564 also indented so that it starts in the same column as the headline
13565 \(i.e. after the stars).
13567 See also the variable `org-reverse-note-order'."
13568 (goto-char (point-min))
13570 (replace-match ""))
13571 (goto-char (point-max))
13572 (beginning-of-line 1)
13574 (delete-region (1- (point)) (point-max))
13575 (beginning-of-line 1))
13576 (catch 'quit
13577 (if org-note-abort (throw 'quit nil))
13578 (let* ((txt (buffer-substring (point-min) (point-max)))
13579 (fastp (org-xor (equal current-prefix-arg '(4))
13580 org-remember-store-without-prompt))
13581 (file (if fastp org-default-notes-file (org-get-org-file)))
13582 (heading org-remember-default-headline)
13583 (visiting (org-find-base-buffer-visiting file))
13584 (org-startup-folded nil)
13585 (org-startup-align-all-tables nil)
13586 (org-goto-start-pos 1)
13587 spos exitcmd level indent reversed)
13588 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13589 (setq file (car org-remember-previous-location)
13590 heading (cdr org-remember-previous-location)))
13591 (setq current-prefix-arg nil)
13593 (setq txt (replace-match "" t t txt)))
13594 ;; Modify text so that it becomes a nice subtree which can be inserted
13595 ;; into an org tree.
13597 first)
13598 (setq first (car lines) lines (cdr lines))
13600 ;; Is already a headline
13601 (setq indent nil)
13602 ;; We need to add a headline: Use time and first buffer line
13603 (setq lines (cons first lines)
13604 first (concat "* " (current-time-string)
13605 " (" (remember-buffer-desc) ")")
13606 indent " "))
13607 (if (and org-adapt-indentation indent)
13608 (setq lines (mapcar
13609 (lambda (x)
13611 (concat indent x) x))
13612 lines)))
13619 ;; Find the file
13620 (if (not visiting) (find-file-noselect file))
13621 (with-current-buffer (or visiting (get-file-buffer file))
13622 (unless (org-mode-p)
13623 (error "Target files for remember notes must be in Org-mode"))
13624 (save-excursion
13625 (save-restriction
13626 (widen)
13627 (and (goto-char (point-min))
13630 (setq reversed (org-notes-order-reversed-p))
13632 ;; Find the default location
13634 (goto-char (point-min))
13635 (if (re-search-forward
13638 nil t)
13639 (setq org-goto-start-pos (match-beginning 0))
13640 (when fastp
13641 (goto-char (point-max))
13642 (unless (bolp) (newline))
13644 (setq org-goto-start-pos (point-at-bol 0)))))
13646 ;; Ask the User for a location
13647 (if fastp
13648 (setq spos org-goto-start-pos
13649 exitcmd 'return)
13650 (setq spos (org-get-location (current-buffer) org-remember-help)
13651 exitcmd (cdr spos)
13652 spos (car spos)))
13653 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13654 ; not handle this note
13655 (goto-char spos)
13656 (cond ((org-on-heading-p t)
13657 (org-back-to-heading t)
13658 (setq level (funcall outline-level))
13659 (cond
13660 ((eq exitcmd 'return)
13661 ;; sublevel of current
13662 (setq org-remember-previous-location
13663 (cons (abbreviate-file-name file)
13664 (org-get-heading 'notags)))
13665 (if reversed
13666 (outline-next-heading)
13667 (org-end-of-subtree)
13668 (if (not (bolp))
13670 (beginning-of-line 2)
13671 (end-of-line 1)
13673 (bookmark-set "org-remember-last-stored")
13674 (org-paste-subtree (org-get-legal-level level 1) txt))
13675 ((eq exitcmd 'left)
13676 ;; before current
13677 (bookmark-set "org-remember-last-stored")
13678 (org-paste-subtree level txt))
13679 ((eq exitcmd 'right)
13680 ;; after current
13681 (org-end-of-subtree t)
13682 (bookmark-set "org-remember-last-stored")
13683 (org-paste-subtree level txt))
13684 (t (error "This should not happen"))))
13686 ((and (bobp) (not reversed))
13687 ;; Put it at the end, one level below level 1
13688 (save-restriction
13689 (widen)
13690 (goto-char (point-max))
13691 (if (not (bolp)) (newline))
13692 (bookmark-set "org-remember-last-stored")
13693 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13695 ((and (bobp) reversed)
13696 ;; Put it at the start, as level 1
13697 (save-restriction
13698 (widen)
13699 (goto-char (point-min))
13701 (beginning-of-line 1)
13702 (bookmark-set "org-remember-last-stored")
13703 (org-paste-subtree 1 txt)))
13704 (t
13705 ;; Put it right there, with automatic level determined by
13706 ;; org-paste-subtree or from prefix arg
13707 (bookmark-set "org-remember-last-stored")
13708 (org-paste-subtree
13709 (if (numberp current-prefix-arg) current-prefix-arg)
13710 txt)))
13711 (when remember-save-after-remembering
13712 (save-buffer)
13713 (if (not visiting) (kill-buffer (current-buffer)))))))))
13715 t) ;; return t to indicate that we took care of this note.
13717 (defun org-get-org-file ()
13718 "Read a filename, with default directory `org-directory'."
13719 (let ((default (or org-default-notes-file remember-data-file)))
13720 (read-file-name (format "File name [%s]: " default)
13721 (file-name-as-directory org-directory)
13722 default)))
13724 (defun org-notes-order-reversed-p ()
13725 "Check if the current file should receive notes in reversed order."
13726 (cond
13727 ((not org-reverse-note-order) nil)
13728 ((eq t org-reverse-note-order) t)
13729 ((not (listp org-reverse-note-order)) nil)
13730 (t (catch 'exit
13731 (let ((all org-reverse-note-order)
13732 entry)
13733 (while (setq entry (pop all))
13734 (if (string-match (car entry) buffer-file-name)
13735 (throw 'exit (cdr entry))))
13736 nil)))))
13738 ;;; Refiling
13740 (defvar org-refile-target-table nil
13741 "The list of refile targets, created by `org-refile'.")
13743 (defvar org-agenda-new-buffers nil
13744 "Buffers created to visit agenda files.")
13746 (defun org-get-refile-targets ()
13747 "Produce a table with refile targets."
13748 (let ((entries org-refile-targets)
13749 org-agenda-new-files targets txt re files f desc descre)
13750 (while (setq entry (pop entries))
13751 (setq files (car entry) desc (cdr entry))
13752 (cond
13753 ((null files) (setq files (list (current-buffer))))
13754 ((eq files 'org-agenda-files)
13755 (setq files (org-agenda-files 'unrestricted)))
13756 ((and (symbolp files) (fboundp files))
13757 (setq files (funcall files)))
13758 ((and (symbolp files) (boundp files))
13759 (setq files (symbol-value files))))
13760 (if (stringp files) (setq files (list files)))
13761 (cond
13762 ((eq (car desc) :tag)
13764 ((eq (car desc) :todo)
13766 ((eq (car desc) :regexp)
13767 (setq descre (cdr desc)))
13768 ((eq (car desc) :level)
13770 (if org-odd-levels-only
13771 (1- (* 2 (cdr desc)))
13772 (cdr desc)))
13774 ((eq (car desc) :maxlevel)
13776 (if org-odd-levels-only
13777 (1- (* 2 (cdr desc)))
13778 (cdr desc)))
13780 (t (error "Bad refiling target description %s" desc)))
13781 (while (setq f (pop files))
13782 (save-excursion
13783 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13784 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13785 (save-excursion
13786 (save-restriction
13787 (widen)
13788 (goto-char (point-min))
13789 (while (re-search-forward descre nil t)
13790 (goto-char (point-at-bol))
13791 (when (looking-at org-complex-heading-regexp)
13792 (setq txt (match-string 4)
13793 re (concat "^" (regexp-quote
13794 (buffer-substring (match-beginning 1)
13795 (match-end 4)))))
13797 (regexp-quote
13798 (match-string 5)))))
13800 (when org-refile-use-outline-path
13801 (setq txt (mapconcat 'identity
13802 (append
13803 (if (eq org-refile-use-outline-path 'file)
13804 (list (file-name-nondirectory
13805 (buffer-file-name (buffer-base-buffer))))
13806 (if (eq org-refile-use-outline-path 'full-file-path)
13807 (list (buffer-file-name (buffer-base-buffer)))))
13808 (org-get-outline-path)
13809 (list txt))
13810 "/")))
13811 (push (list txt f re (point)) targets))
13812 (goto-char (point-at-eol))))))))
13813 (org-release-buffers org-agenda-new-buffers)
13814 (nreverse targets)))
13816 (defun org-get-outline-path ()
13817 (let (rtn)
13818 (save-excursion
13819 (while (org-up-heading-safe)
13820 (when (looking-at org-complex-heading-regexp)
13821 (push (org-match-string-no-properties 4) rtn)))
13822 rtn)))
13824 (defvar org-refile-history nil
13825 "History for refiling operations.")
13827 (defun org-refile (&optional reversed-or-update)
13828 "Move the entry at point to another heading.
13829 The list of target headings is compiled using the information in
13830 `org-refile-targets', which see. This list is created upon first use, and
13831 you can update it by calling this command with a double prefix (`C-u C-u').
13833 At the target location, the entry is filed as a subitem of the target heading.
13834 Depending on `org-reverse-note-order', the new subitem will either be the
13835 first of the last subitem. A single C-u prefix will toggle the value of this
13836 variable for the duration of the command."
13837 (interactive "P")
13838 (if (equal reversed-or-update '(16))
13839 (progn
13840 (setq org-refile-target-table (org-get-refile-targets))
13841 (message "Refile targets updated (%d targets)"
13842 (length org-refile-target-table)))
13843 (when (or (not org-refile-target-table)
13844 (and (= (length org-refile-targets) 1)
13845 (not (caar org-refile-targets))))
13846 (setq org-refile-target-table (org-get-refile-targets)))
13847 (unless org-refile-target-table
13848 (error "No refile targets"))
13849 (let* ((cbuf (current-buffer))
13850 (filename (buffer-file-name (buffer-base-buffer cbuf)))
13851 (fname (and filename (file-truename filename)))
13852 (tbl (mapcar
13853 (lambda (x)
13854 (if (not (equal fname (file-truename (nth 1 x))))
13855 (cons (concat (car x) " (" (file-name-nondirectory
13856 (nth 1 x)) ")")
13857 (cdr x))
13858 x))
13859 org-refile-target-table))
13860 (completion-ignore-case t)
13861 pos it nbuf file re level reversed)
13862 (when (setq it (completing-read "Refile to: " tbl
13863 nil t nil 'org-refile-history))
13864 (setq it (assoc it tbl)
13865 file (nth 1 it)
13866 re (nth 2 it))
13867 (org-copy-special)
13868 (save-excursion
13869 (set-buffer (setq nbuf (or (find-buffer-visiting file)
13870 (find-file-noselect file))))
13871 (setq reversed (org-notes-order-reversed-p))
13872 (if (equal reversed-or-update '(16)) (setq reversed (not reversed)))
13873 (save-excursion
13874 (save-restriction
13875 (widen)
13876 (goto-char (point-min))
13877 (unless (re-search-forward re nil t)
13878 (error "Cannot find target location - try again with `C-u' prefix."))
13879 (goto-char (match-beginning 0))
13880 (looking-at outline-regexp)
13881 (setq level (org-get-legal-level (funcall outline-level) 1))
13882 (goto-char (or (save-excursion
13883 (if reversed
13884 (outline-next-heading)
13885 (outline-get-next-sibling)))
13886 (point-max)))
13887 (org-paste-subtree level))))
13888 (org-cut-special)
13891 ;;;; Dynamic blocks
13893 (defun org-find-dblock (name)
13894 "Find the first dynamic block with name NAME in the buffer.
13895 If not found, stay at current position and return nil."
13896 (let (pos)
13897 (save-excursion
13898 (goto-char (point-min))
13900 nil t)
13901 (match-beginning 0))))
13902 (if pos (goto-char pos))
13903 pos))
13905 (defconst org-dblock-start-re
13907 "Matches the startline of a dynamic block, with parameters.")
13910 "Matches the end of a dyhamic block.")
13912 (defun org-create-dblock (plist)
13913 "Create a dynamic block section, with parameters taken from PLIST.
13914 PLIST must containe a :name entry which is used as name of the block."
13915 (unless (bolp) (newline))
13916 (let ((name (plist-get plist :name)))
13917 (insert "#+BEGIN: " name)
13918 (while plist
13919 (if (eq (car plist) :name)
13920 (setq plist (cddr plist))
13921 (insert " " (prin1-to-string (pop plist)))))
13923 (beginning-of-line -2)))
13925 (defun org-prepare-dblock ()
13926 "Prepare dynamic block for refresh.
13927 This empties the block, puts the cursor at the insert position and returns
13928 the property list including an extra property :name with the block name."
13929 (unless (looking-at org-dblock-start-re)
13930 (error "Not at a dynamic block"))
13931 (let* ((begdel (1+ (match-end 0)))
13932 (name (org-no-properties (match-string 1)))
13933 (params (append (list :name name)
13934 (read (concat "(" (match-string 3) ")")))))
13935 (unless (re-search-forward org-dblock-end-re nil t)
13936 (error "Dynamic block not terminated"))
13937 (delete-region begdel (match-beginning 0))
13938 (goto-char begdel)
13939 (open-line 1)
13940 params))
13942 (defun org-map-dblocks (&optional command)
13943 "Apply COMMAND to all dynamic blocks in the current buffer.
13944 If COMMAND is not given, use `org-update-dblock'."
13945 (let ((cmd (or command 'org-update-dblock))
13946 pos)
13947 (save-excursion
13948 (goto-char (point-min))
13949 (while (re-search-forward org-dblock-start-re nil t)
13950 (goto-char (setq pos (match-beginning 0)))
13951 (condition-case nil
13952 (funcall cmd)
13953 (error (message "Error during update of dynamic block")))
13954 (goto-char pos)
13955 (unless (re-search-forward org-dblock-end-re nil t)
13956 (error "Dynamic block not terminated"))))))
13958 (defun org-dblock-update (&optional arg)
13959 "User command for updating dynamic blocks.
13960 Update the dynamic block at point. With prefix ARG, update all dynamic
13961 blocks in the buffer."
13962 (interactive "P")
13963 (if arg
13964 (org-update-all-dblocks)
13965 (or (looking-at org-dblock-start-re)
13966 (org-beginning-of-dblock))
13967 (org-update-dblock)))
13969 (defun org-update-dblock ()
13970 "Update the dynamic block at point
13971 This means to empty the block, parse for parameters and then call
13972 the correct writing function."
13973 (save-window-excursion
13974 (let* ((pos (point))
13975 (line (org-current-line))
13976 (params (org-prepare-dblock))
13977 (name (plist-get params :name))
13978 (cmd (intern (concat "org-dblock-write:" name))))
13979 (message "Updating dynamic block `%s' at line %d..." name line)
13980 (funcall cmd params)
13981 (message "Updating dynamic block `%s' at line %d...done" name line)
13982 (goto-char pos))))
13984 (defun org-beginning-of-dblock ()
13985 "Find the beginning of the dynamic block at point.
13986 Error if there is no scuh block at point."
13987 (let ((pos (point))
13988 beg)
13989 (end-of-line 1)
13990 (if (and (re-search-backward org-dblock-start-re nil t)
13991 (setq beg (match-beginning 0))
13992 (re-search-forward org-dblock-end-re nil t)
13993 (> (match-end 0) pos))
13994 (goto-char beg)
13995 (goto-char pos)
13996 (error "Not in a dynamic block"))))
13998 (defun org-update-all-dblocks ()
13999 "Update all dynamic blocks in the buffer.
14000 This function can be used in a hook."
14001 (when (org-mode-p)
14002 (org-map-dblocks 'org-update-dblock)))
14005 ;;;; Completion
14007 (defconst org-additional-option-like-keywords
14008 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14009 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14010 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14012 (defun org-complete (&optional arg)
14013 "Perform completion on word at point.
14014 At the beginning of a headline, this completes TODO keywords as given in
14015 `org-todo-keywords'.
14016 If the current word is preceded by a backslash, completes the TeX symbols
14017 that are supported for HTML support.
14019 setting file options.
14021 At all other locations, this simply calls the value of
14022 `org-completion-fallback-command'."
14023 (interactive "P")
14024 (org-without-partial-completion
14025 (catch 'exit
14026 (let* ((end (point))
14027 (beg1 (save-excursion
14028 (skip-chars-backward (org-re "[:alnum:]_@"))
14029 (point)))
14030 (beg (save-excursion
14031 (skip-chars-backward "a-zA-Z0-9_:$")
14032 (point)))
14033 (confirm (lambda (x) (stringp (car x))))
14034 (searchhead (equal (char-before beg) ?*))
14035 (tag (and (equal (char-before beg1) ?:)
14036 (equal (char-after (point-at-bol)) ?*)))
14037 (prop (and (equal (char-before beg1) ?:)
14038 (not (equal (char-after (point-at-bol)) ?*))))
14040 (link (equal (char-before beg) ?\[))
14041 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14042 beg)
14043 "#+"))
14045 (buffer-substring (point-at-bol) (point))))
14046 (completion-ignore-case opt)
14047 (type nil)
14048 (tbl nil)
14049 (table (cond
14050 (opt
14051 (setq type :opt)
14052 (append
14053 (mapcar
14054 (lambda (x)
14056 (cons (match-string 2 x) (match-string 1 x)))
14058 (mapcar 'list org-additional-option-like-keywords)))
14059 (startup
14060 (setq type :startup)
14061 org-startup-options)
14062 (link (append org-link-abbrev-alist-local
14063 org-link-abbrev-alist))
14064 (texp
14065 (setq type :tex)
14066 org-html-entities)
14068 (buffer-substring (point-at-bol) beg))
14069 (setq type :todo)
14070 (mapcar 'list org-todo-keywords-1))
14071 (searchhead
14072 (setq type :searchhead)
14073 (save-excursion
14074 (goto-char (point-min))
14075 (while (re-search-forward org-todo-line-regexp nil t)
14076 (push (list
14077 (org-make-org-heading-search-string
14078 (match-string 3) t))
14079 tbl)))
14080 tbl)
14081 (tag (setq type :tag beg beg1)
14082 (or org-tag-alist (org-get-buffer-tags)))
14083 (prop (setq type :prop beg beg1)
14084 (mapcar 'list (org-buffer-property-keys)))
14085 (t (progn
14086 (call-interactively org-completion-fallback-command)
14087 (throw 'exit nil)))))
14088 (pattern (buffer-substring-no-properties beg end))
14089 (completion (try-completion pattern table confirm)))
14090 (cond ((eq completion t)
14091 (if (not (assoc (upcase pattern) table))
14092 (message "Already complete")
14093 (if (equal type :opt)
14094 (insert (substring (cdr (assoc (upcase pattern) table))
14095 (length pattern)))
14096 (if (memq type '(:tag :prop)) (insert ":")))))
14097 ((null completion)
14099 (ding))
14100 ((not (string= pattern completion))
14101 (delete-region beg end)
14102 (if (string-match " +$" completion)
14103 (setq completion (replace-match "" t t completion)))
14104 (insert completion)
14105 (if (get-buffer-window "*Completions*")
14106 (delete-window (get-buffer-window "*Completions*")))
14107 (if (assoc completion table)
14108 (if (eq type :todo) (insert " ")
14109 (if (memq type '(:tag :prop)) (insert ":"))))
14110 (if (and (equal type :opt) (assoc completion table))
14111 (message "%s" (substitute-command-keys
14113 (t
14114 (message "Making completion list...")
14115 (let ((list (sort (all-completions pattern table confirm)
14116 'string<)))
14117 (with-output-to-temp-buffer "*Completions*"
14118 (condition-case nil
14119 ;; Protection needed for XEmacs and emacs 21
14120 (display-completion-list list pattern)
14121 (error (display-completion-list list)))))
14122 (message "Making completion list...%s" "done")))))))
14124 ;;;; TODO, DEADLINE, Comments
14126 (defun org-toggle-comment ()
14127 "Change the COMMENT state of an entry."
14128 (interactive)
14129 (save-excursion
14130 (org-back-to-heading)
14131 (let (case-fold-search)
14132 (if (looking-at (concat outline-regexp
14134 (replace-match "" t t nil 1)
14135 (if (looking-at outline-regexp)
14136 (progn
14137 (goto-char (match-end 0))
14138 (insert org-comment-string " ")))))))
14140 (defvar org-last-todo-state-is-todo nil
14141 "This is non-nil when the last TODO state change led to a TODO state.
14142 If the last change removed the TODO tag or switched to DONE, then
14143 this is nil.")
14145 (defvar org-setting-tags nil) ; dynamically skiped
14147 ;; FIXME: better place
14148 (defun org-property-or-variable-value (var &optional inherit)
14149 "Check if there is a property fixing the value of VAR.
14150 If yes, return this value. If not, return the current value of the variable."
14151 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14153 (read prop)
14154 (symbol-value var))))
14156 (defun org-parse-local-options (string var)
14157 "Parse STRING for startup setting relevant for variable VAR."
14158 (let ((rtn (symbol-value var))
14159 e opts)
14160 (save-match-data
14162 rtn
14163 (setq opts (delq nil (mapcar (lambda (x)
14164 (setq e (assoc x org-startup-options))
14165 (if (eq (nth 1 e) var) e nil))
14167 (if (not opts)
14168 rtn
14169 (setq rtn nil)
14170 (while (setq e (pop opts))
14171 (if (not (nth 3 e))
14172 (setq rtn (nth 2 e))
14173 (if (not (listp rtn)) (setq rtn nil))
14174 (push (nth 2 e) rtn)))
14175 rtn)))))
14177 (defvar org-blocker-hook nil
14178 "Hook for functions that are allowed to block a state change.
14180 Each function gets as its single argument a property list, see
14181 `org-trigger-hook' for more information about this list.
14183 If any of the functions in this hook returns nil, the state change
14184 is blocked.")
14186 (defvar org-trigger-hook nil
14187 "Hook for functions that are triggered by a state change.
14189 Each function gets as its single argument a property list with at least
14190 the following elements:
14192 (:type type-of-change :position pos-at-entry-start
14193 :from old-state :to new-state)
14195 Depending on the type, more properties may be present.
14197 This mechanism is currently implemented for:
14199 TODO state changes
14200 ------------------
14201 :type todo-state-change
14202 :from previous state (keyword as a string), or nil
14203 :to new state (keyword as a string), or nil")
14206 (defun org-todo (&optional arg)
14207 "Change the TODO state of an item.
14208 The state of an item is given by a keyword at the start of the heading,
14209 like
14210 *** TODO Write paper
14211 *** DONE Call mom
14213 The different keywords are specified in the variable `org-todo-keywords'.
14215 So for this example: when the item starts with TODO, it is changed to DONE.
14216 When it starts with DONE, the DONE is removed. And when neither TODO nor
14217 DONE are present, add TODO at the beginning of the heading.
14219 With C-u prefix arg, use completion to determine the new state.
14220 With numeric prefix arg, switch to that state.
14222 For calling through lisp, arg is also interpreted in the following way:
14223 'none -> empty state
14225 'done -> switch to DONE
14226 'nextset -> switch to the next set of keywords
14227 'previousset -> switch to the previous set of keywords
14229 really is a member of `org-todo-keywords'."
14230 (interactive "P")
14231 (save-excursion
14232 (catch 'exit
14233 (org-back-to-heading)
14234 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14235 (or (looking-at (concat " +" org-todo-regexp " *"))
14236 (looking-at " *"))
14237 (let* ((match-data (match-data))
14238 (startpos (point-at-bol))
14239 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14240 (org-log-done (org-parse-local-options logging 'org-log-done))
14241 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
14242 (this (match-string 1))
14243 (hl-pos (match-beginning 0))
14244 (head (org-get-todo-sequence-head this))
14245 (ass (assoc head org-todo-kwd-alist))
14246 (interpret (nth 1 ass))
14247 (done-word (nth 3 ass))
14248 (final-done-word (nth 4 ass))
14249 (last-state (or this ""))
14250 (completion-ignore-case t)
14251 (member (member this org-todo-keywords-1))
14252 (tail (cdr member))
14253 (state (cond
14254 ((and org-todo-key-trigger
14255 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14256 (and (not arg) org-use-fast-todo-selection
14257 (not (eq org-use-fast-todo-selection 'prefix)))))
14258 ;; Use fast selection
14259 (org-fast-todo-selection))
14260 ((and (equal arg '(4))
14261 (or (not org-use-fast-todo-selection)
14262 (not org-todo-key-trigger)))
14263 ;; Read a state with completion
14264 (completing-read "State: " (mapcar (lambda(x) (list x))
14265 org-todo-keywords-1)
14266 nil t))
14267 ((eq arg 'right)
14268 (if this
14269 (if tail (car tail) nil)
14270 (car org-todo-keywords-1)))
14271 ((eq arg 'left)
14272 (if (equal member org-todo-keywords-1)
14273 nil
14274 (if this
14275 (nth (- (length org-todo-keywords-1) (length tail) 2)
14276 org-todo-keywords-1)
14277 (org-last org-todo-keywords-1))))
14278 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14279 (setq arg nil))) ; hack to fall back to cycling
14280 (arg
14281 ;; user or caller requests a specific state
14282 (cond
14283 ((equal arg "") nil)
14284 ((eq arg 'none) nil)
14285 ((eq arg 'done) (or done-word (car org-done-keywords)))
14286 ((eq arg 'nextset)
14287 (or (car (cdr (member head org-todo-heads)))
14288 (car org-todo-heads)))
14289 ((eq arg 'previousset)
14290 (let ((org-todo-heads (reverse org-todo-heads)))
14291 (or (car (cdr (member head org-todo-heads)))
14292 (car org-todo-heads))))
14293 ((car (member arg org-todo-keywords-1)))
14294 ((nth (1- (prefix-numeric-value arg))
14295 org-todo-keywords-1))))
14296 ((null member) (or head (car org-todo-keywords-1)))
14297 ((equal this final-done-word) nil) ;; -> make empty
14298 ((null tail) nil) ;; -> first entry
14299 ((eq interpret 'sequence)
14300 (car tail))
14301 ((memq interpret '(type priority))
14302 (if (eq this-command last-command)
14303 (car tail)
14304 (if (> (length tail) 0)
14305 (or done-word (car org-done-keywords))
14306 nil)))
14307 (t nil)))
14308 (next (if state (concat " " state " ") " "))
14309 (change-plist (list :type 'todo-state-change :from this :to state
14310 :position startpos))
14311 dostates)
14312 (when org-blocker-hook
14313 (unless (save-excursion
14314 (save-match-data
14315 (run-hook-with-args-until-failure
14316 'org-blocker-hook change-plist)))
14317 (if (interactive-p)
14318 (error "TODO state change from %s to %s blocked" this state)
14319 ;; fail silently
14320 (message "TODO state change from %s to %s blocked" this state)
14321 (throw 'exit nil))))
14322 (store-match-data match-data)
14323 (replace-match next t t)
14324 (unless (pos-visible-in-window-p hl-pos)
14325 (message "TODO state changed to %s" (org-trim next)))
14326 (unless head
14327 (setq head (org-get-todo-sequence-head state)
14328 ass (assoc head org-todo-kwd-alist)
14329 interpret (nth 1 ass)
14330 done-word (nth 3 ass)
14331 final-done-word (nth 4 ass)))
14332 (when (memq arg '(nextset previousset))
14333 (message "Keyword-Set %d/%d: %s"
14334 (- (length org-todo-sets) -1
14335 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14336 (length org-todo-sets)
14337 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14338 (setq org-last-todo-state-is-todo
14339 (not (member state org-done-keywords)))
14340 (when (and org-log-done (not (memq arg '(nextset previousset))))
14341 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
14342 (or (not org-todo-log-states)
14343 (member state org-todo-log-states))))
14345 (cond
14346 ((and state (member state org-not-done-keywords)
14347 (not (member this org-not-done-keywords)))
14348 ;; This is now a todo state and was not one before
14349 ;; Remove any CLOSED timestamp, and possibly log the state change
14350 (org-add-planning-info nil nil 'closed)
14351 (and dostates (org-add-log-maybe 'state state 'findpos)))
14352 ((and state dostates)
14353 ;; This is a non-nil state, and we need to log it
14354 (org-add-log-maybe 'state state 'findpos))
14355 ((and (member state org-done-keywords)
14356 (not (member this org-done-keywords)))
14357 ;; It is now done, and it was not done before
14358 (org-add-planning-info 'closed (org-current-time))
14359 (org-add-log-maybe 'done state 'findpos))))
14360 ;; Fixup tag positioning
14361 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14362 (run-hooks 'org-after-todo-state-change-hook)
14363 (and (member state org-done-keywords) (org-auto-repeat-maybe))
14364 (if (and arg (not (member state org-done-keywords)))
14365 (setq head (org-get-todo-sequence-head state)))
14366 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14367 ;; Fixup cursor location if close to the keyword
14368 (if (and (outline-on-heading-p)
14369 (not (bolp))
14370 (save-excursion (beginning-of-line 1)
14371 (looking-at org-todo-line-regexp))
14372 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14373 (progn
14374 (goto-char (or (match-end 2) (match-end 1)))
14375 (just-one-space)))
14376 (when org-trigger-hook
14377 (save-excursion
14378 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14380 (defun org-get-todo-sequence-head (kwd)
14381 "Return the head of the TODO sequence to which KWD belongs.
14382 If KWD is not set, check if there is a text property remembering the
14383 right sequence."
14384 (let (p)
14385 (cond
14386 ((not kwd)
14387 (or (get-text-property (point-at-bol) 'org-todo-head)
14388 (progn
14389 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14390 nil (point-at-eol)))
14391 (get-text-property p 'org-todo-head))))
14392 ((not (member kwd org-todo-keywords-1))
14393 (car org-todo-keywords-1))
14394 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14396 (defun org-fast-todo-selection ()
14397 "Fast TODO keyword selection with single keys.
14398 Returns the new TODO keyword, or nil if no state change should occur."
14399 (let* ((fulltable org-todo-key-alist)
14400 (done-keywords org-done-keywords) ;; needed for the faces.
14401 (maxlen (apply 'max (mapcar
14402 (lambda (x)
14403 (if (stringp (car x)) (string-width (car x)) 0))
14404 fulltable)))
14405 (expert nil)
14406 (fwidth (+ maxlen 3 1 3))
14407 (ncol (/ (- (window-width) 4) fwidth))
14408 tg cnt e c tbl
14409 groups ingroup)
14410 (save-window-excursion
14411 (if expert
14412 (set-buffer (get-buffer-create " *Org todo*"))
14413 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14414 (erase-buffer)
14415 (org-set-local 'org-done-keywords done-keywords)
14416 (setq tbl fulltable cnt 0)
14417 (while (setq e (pop tbl))
14418 (cond
14419 ((equal e '(:startgroup))
14420 (push '() groups) (setq ingroup t)
14421 (when (not (= cnt 0))
14422 (setq cnt 0)
14424 (insert "{ "))
14425 ((equal e '(:endgroup))
14426 (setq ingroup nil cnt 0)
14428 (t
14429 (setq tg (car e) c (cdr e))
14430 (if ingroup (push tg (car groups)))
14431 (setq tg (org-add-props tg nil 'face
14432 (org-get-todo-face tg)))
14433 (if (and (= cnt 0) (not ingroup)) (insert " "))
14434 (insert "[" c "] " tg (make-string
14435 (- fwidth 4 (length tg)) ?\ ))
14436 (when (= (setq cnt (1+ cnt)) ncol)
14438 (if ingroup (insert " "))
14439 (setq cnt 0)))))
14441 (goto-char (point-min))
14442 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14443 (fit-window-to-buffer))
14444 (message "[a-z..]:Set [SPC]:clear")
14445 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14446 (cond
14447 ((or (= c ?\C-g)
14448 (and (= c ?q) (not (rassoc c fulltable))))
14449 (setq quit-flag t))
14450 ((= c ?\ ) nil)
14451 ((setq e (rassoc c fulltable) tg (car e))
14452 tg)
14453 (t (setq quit-flag t))))))
14455 (defun org-get-repeat ()
14456 "Check if tere is a deadline/schedule with repeater in this entry."
14457 (save-match-data
14458 (save-excursion
14459 (org-back-to-heading t)
14460 (if (re-search-forward
14461 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14462 (match-string 1)))))
14464 (defvar org-last-changed-timestamp)
14465 (defvar org-log-post-message)
14466 (defun org-auto-repeat-maybe ()
14467 "Check if the current headline contains a repeated deadline/schedule.
14468 If yes, set TODO state back to what it was and change the base date
14469 of repeating deadline/scheduled time stamps to new date.
14470 This function should be run in the `org-after-todo-state-change-hook'."
14471 ;; last-state is dynamically scoped into this function
14472 (let* ((repeat (org-get-repeat))
14473 (aa (assoc last-state org-todo-kwd-alist))
14474 (interpret (nth 1 aa))
14475 (head (nth 2 aa))
14476 (done-word (nth 3 aa))
14477 (whata '(("d" . day) ("m" . month) ("y" . year)))
14478 (msg "Entry repeats: ")
14479 (org-log-done)
14480 re type n what ts)
14481 (when repeat
14482 (org-todo (if (eq interpret 'type) last-state head))
14483 (when (and org-log-repeat
14484 (not (memq 'org-add-log-note
14485 (default-value 'post-command-hook))))
14486 ;; Make sure a note is taken
14487 (let ((org-log-done '(done)))
14488 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
14489 'findpos)))
14490 (org-back-to-heading t)
14491 (org-add-planning-info nil nil 'closed)
14494 (while (re-search-forward
14495 re (save-excursion (outline-next-heading) (point)) t)
14496 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
14497 ts (match-string (if (match-end 2) 2 4)))
14499 (setq n (string-to-number (match-string 1 ts))
14500 what (match-string 2 ts))
14501 (if (equal what "w") (setq n (* n 7) what "d"))
14502 (org-timestamp-change n (cdr (assoc what whata))))
14503 (setq msg (concat msg type org-last-changed-timestamp " ")))
14504 (setq org-log-post-message msg)
14505 (message "%s" msg))))
14507 (defun org-show-todo-tree (arg)
14508 "Make a compact tree which shows all headlines marked with TODO.
14509 The tree will show the lines where the regexp matches, and all higher
14510 headlines above the match.
14512 With a numeric prefix N, construct a sparse tree for the Nth element
14513 of `org-todo-keywords-1'."
14514 (interactive "P")
14515 (let ((case-fold-search nil)
14516 (kwd-re
14517 (cond ((null arg) org-not-done-regexp)
14518 ((equal arg '(4))
14519 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14520 (mapcar 'list org-todo-keywords-1))))
14524 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14525 (regexp-quote (nth (1- (prefix-numeric-value arg))
14526 org-todo-keywords-1)))
14527 (t (error "Invalid prefix argument: %s" arg)))))
14528 (message "%d TODO entries found"
14529 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14531 (defun org-deadline (&optional remove)
14533 With argument REMOVE, remove any deadline from the item."
14534 (interactive "P")
14535 (if remove
14536 (progn
14537 (org-add-planning-info nil nil 'deadline)
14538 (message "Item no longer has a deadline."))
14539 (org-add-planning-info 'deadline nil 'closed)))
14541 (defun org-schedule (&optional remove)
14542 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14543 With argument REMOVE, remove any scheduling date from the item."
14544 (interactive "P")
14545 (if remove
14546 (progn
14547 (org-add-planning-info nil nil 'scheduled)
14548 (message "Item is no longer scheduled."))
14549 (org-add-planning-info 'scheduled nil 'closed)))
14551 (defun org-add-planning-info (what &optional time &rest remove)
14552 "Insert new timestamp with keyword in the line directly after the headline.
14553 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14554 If non is given, the user is prompted for a date.
14555 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14556 be removed."
14557 (interactive)
14558 (let (org-time-was-given org-end-time-was-given)
14559 (when what (setq time (or time (org-read-date nil 'to-time))))
14560 (when (and org-insert-labeled-timestamps-at-point
14561 (member what '(scheduled deadline)))
14562 (insert
14563 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14564 (org-insert-time-stamp time org-time-was-given
14565 nil nil nil (list org-end-time-was-given))
14566 (setq what nil))
14567 (save-excursion
14568 (save-restriction
14569 (let (col list elt ts buffer-invisibility-spec)
14570 (org-back-to-heading t)
14572 (goto-char (match-end 1))
14573 (setq col (current-column))
14574 (goto-char (match-end 0))
14576 (if (and (not (looking-at outline-regexp))
14579 (not (equal (match-string 1) org-clock-string)))
14580 (narrow-to-region (match-beginning 0) (match-end 0))
14582 (backward-char 1)
14583 (narrow-to-region (point) (point))
14584 (indent-to-column col))
14585 ;; Check if we have to remove something.
14586 (setq list (cons what remove))
14587 (while list
14588 (setq elt (pop list))
14589 (goto-char (point-min))
14590 (when (or (and (eq elt 'scheduled)
14591 (re-search-forward org-scheduled-time-regexp nil t))
14592 (and (eq elt 'deadline)
14593 (re-search-forward org-deadline-time-regexp nil t))
14594 (and (eq elt 'closed)
14595 (re-search-forward org-closed-time-regexp nil t)))
14596 (replace-match "")
14597 (if (looking-at "--+<[^>]+>") (replace-match ""))
14598 (if (looking-at " +") (replace-match ""))))
14599 (goto-char (point-max))
14600 (when what
14601 (insert
14602 (if (not (equal (char-before) ?\ )) " " "")
14603 (cond ((eq what 'scheduled) org-scheduled-string)
14604 ((eq what 'deadline) org-deadline-string)
14605 ((eq what 'closed) org-closed-string))
14606 " ")
14607 (setq ts (org-insert-time-stamp
14608 time
14609 (or org-time-was-given
14610 (and (eq what 'closed) org-log-done-with-time))
14611 (eq what 'closed)
14612 nil nil (list org-end-time-was-given)))
14613 (end-of-line 1))
14614 (goto-char (point-min))
14615 (widen)
14617 (replace-match ""))
14618 ts)))))
14620 (defvar org-log-note-marker (make-marker))
14621 (defvar org-log-note-purpose nil)
14622 (defvar org-log-note-state nil)
14623 (defvar org-log-note-window-configuration nil)
14624 (defvar org-log-note-return-to (make-marker))
14625 (defvar org-log-post-message nil
14626 "Message to be displayed after a log note has been stored.
14627 The auto-repeater uses this.")
14629 (defun org-add-log-maybe (&optional purpose state findpos)
14630 "Set up the post command hook to take a note."
14631 (save-excursion
14632 (when (and (listp org-log-done)
14633 (memq purpose org-log-done))
14634 (when findpos
14635 (org-back-to-heading t)
14639 (goto-char (match-end 0))
14640 (unless org-log-states-order-reversed
14642 (org-skip-over-state-notes)
14644 (move-marker org-log-note-marker (point))
14645 (setq org-log-note-purpose purpose)
14646 (setq org-log-note-state state)
14647 (add-hook 'post-command-hook 'org-add-log-note 'append))))
14649 (defun org-skip-over-state-notes ()
14650 "Skip past the list of State notes in an entry."
14653 (condition-case nil
14654 (org-next-item)
14655 (error (org-end-of-item)))))
14657 (defun org-add-log-note (&optional purpose)
14658 "Pop up a window for taking a note, and add this note later at point."
14659 (remove-hook 'post-command-hook 'org-add-log-note)
14660 (setq org-log-note-window-configuration (current-window-configuration))
14661 (delete-other-windows)
14662 (move-marker org-log-note-return-to (point))
14663 (switch-to-buffer (marker-buffer org-log-note-marker))
14664 (goto-char org-log-note-marker)
14665 (org-switch-to-buffer-other-window "*Org Note*")
14666 (erase-buffer)
14667 (let ((org-inhibit-startup t)) (org-mode))
14668 (insert (format "# Insert note for %s.
14670 (cond
14671 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14672 ((eq org-log-note-purpose 'done) "closed todo item")
14673 ((eq org-log-note-purpose 'state)
14675 (t (error "This should not happen")))))
14676 (org-set-local 'org-finish-function 'org-store-log-note))
14678 (defun org-store-log-note ()
14679 "Finish taking a log note, and insert it to where it belongs."
14680 (let ((txt (buffer-string))
14681 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14682 lines ind)
14683 (kill-buffer (current-buffer))
14685 (setq txt (replace-match "" t t txt)))
14687 (setq txt (replace-match "" t t txt)))
14690 (setq note
14691 (org-replace-escapes
14692 note
14693 (list (cons "%u" (user-login-name))
14694 (cons "%U" user-full-name)
14695 (cons "%t" (format-time-string
14696 (org-time-stamp-format 'long 'inactive)
14697 (current-time)))
14698 (cons "%s" (if org-log-note-state
14700 "")))))
14702 (push note lines))
14703 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14704 (when lines
14705 (save-excursion
14706 (set-buffer (marker-buffer org-log-note-marker))
14707 (save-excursion
14708 (goto-char org-log-note-marker)
14709 (move-marker org-log-note-marker nil)
14710 (end-of-line 1)
14712 (indent-relative nil)
14713 (insert "- " (pop lines))
14714 (org-indent-line-function)
14715 (beginning-of-line 1)
14717 (setq ind (concat (match-string 0) " "))
14718 (end-of-line 1)
14720 (set-window-configuration org-log-note-window-configuration)
14721 (with-current-buffer (marker-buffer org-log-note-return-to)
14722 (goto-char org-log-note-return-to))
14723 (move-marker org-log-note-return-to nil)
14724 (and org-log-post-message (message "%s" org-log-post-message)))
14726 ;; FIXME: what else would be useful?
14727 ;; - priority
14728 ;; - date
14730 (defun org-sparse-tree (&optional arg)
14731 "Create a sparse tree, prompt for the details.
14732 This command can create sparse trees. You first need to select the type
14733 of match used to create the tree:
14735 t Show entries with a specific TODO keyword.
14736 T Show entries selected by a tags match.
14737 p Enter a property name and its value (both with completion on existing
14738 names/values) and show entries with that property.
14739 r Show entries matching a regular expression
14740 d Show deadlines due within `org-deadline-warning-days'."
14741 (interactive "P")
14742 (let (ans kwd value)
14743 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
14744 (setq ans (read-char-exclusive))
14745 (cond
14746 ((equal ans ?d)
14747 (call-interactively 'org-check-deadlines))
14748 ((equal ans ?b)
14749 (call-interactively 'org-check-before-date))
14750 ((equal ans ?t)
14751 (org-show-todo-tree '(4)))
14752 ((equal ans ?T)
14753 (call-interactively 'org-tags-sparse-tree))
14754 ((member ans '(?p ?P))
14755 (setq kwd (completing-read "Property: "
14756 (mapcar 'list (org-buffer-property-keys))))
14757 (setq value (completing-read "Value: "
14758 (mapcar 'list (org-property-values kwd))))
14761 (org-tags-sparse-tree arg (concat kwd "=" value)))
14762 ((member ans '(?r ?R ?/))
14763 (call-interactively 'org-occur))
14766 (defvar org-occur-highlights nil)
14767 (make-variable-buffer-local 'org-occur-highlights)
14769 (defun org-occur (regexp &optional keep-previous callback)
14770 "Make a compact tree which shows all matches of REGEXP.
14771 The tree will show the lines where the regexp matches, and all higher
14772 headlines above the match. It will also show the heading after the match,
14773 to make sure editing the matching entry is easy.
14774 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
14775 call to `org-occur' will be kept, to allow stacking of calls to this
14776 command.
14777 If CALLBACK is non-nil, it is a function which is called to confirm
14778 that the match should indeed be shown."
14780 (or keep-previous (org-remove-occur-highlights nil nil t))
14781 (let ((cnt 0))
14782 (save-excursion
14783 (goto-char (point-min))
14784 (if (or (not keep-previous) ; do not want to keep
14785 (not org-occur-highlights)) ; no previous matches
14786 ;; hide everything
14787 (org-overview))
14788 (while (re-search-forward regexp nil t)
14789 (when (or (not callback)
14790 (save-match-data (funcall callback)))
14791 (setq cnt (1+ cnt))
14792 (when org-highlight-sparse-tree-matches
14793 (org-highlight-new-match (match-beginning 0) (match-end 0)))
14794 (org-show-context 'occur-tree))))
14795 (when org-remove-highlights-with-change
14796 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
14797 nil 'local))
14798 (unless org-sparse-tree-open-archived-trees
14799 (org-hide-archived-subtrees (point-min) (point-max)))
14800 (run-hooks 'org-occur-hook)
14801 (if (interactive-p)
14802 (message "%d match(es) for regexp %s" cnt regexp))
14803 cnt))
14805 (defun org-show-context (&optional key)
14806 "Make sure point and context and visible.
14807 How much context is shown depends upon the variables
14808 `org-show-hierarchy-above', `org-show-following-heading'. and
14809 `org-show-siblings'."
14810 (let ((heading-p (org-on-heading-p t))
14811 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
14812 (following-p (org-get-alist-option org-show-following-heading key))
14813 (entry-p (org-get-alist-option org-show-entry-below key))
14814 (siblings-p (org-get-alist-option org-show-siblings key)))
14815 (catch 'exit
14816 ;; Show heading or entry text
14817 (if (and heading-p (not entry-p))
14818 (org-flag-heading nil) ; only show the heading
14819 (and (or entry-p (org-invisible-p) (org-invisible-p2))
14820 (org-show-hidden-entry))) ; show entire entry
14821 (when following-p
14822 ;; Show next sibling, or heading below text
14823 (save-excursion
14824 (and (if heading-p (org-goto-sibling) (outline-next-heading))
14825 (org-flag-heading nil))))
14826 (when siblings-p (org-show-siblings))
14827 (when hierarchy-p
14828 ;; show all higher headings, possibly with siblings
14829 (save-excursion
14830 (while (and (condition-case nil
14831 (progn (org-up-heading-all 1) t)
14832 (error nil))
14833 (not (bobp)))
14834 (org-flag-heading nil)
14835 (when siblings-p (org-show-siblings))))))))
14837 (defun org-reveal (&optional siblings)
14838 "Show current entry, hierarchy above it, and the following headline.
14839 This can be used to show a consistent set of context around locations
14840 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14841 not t for the search context.
14843 With optional argument SIBLINGS, on each level of the hierarchy all
14844 siblings are shown. This repairs the tree structure to what it would
14845 look like when opened with hierarchical calls to `org-cycle'."
14846 (interactive "P")
14847 (let ((org-show-hierarchy-above t)
14848 (org-show-following-heading t)
14849 (org-show-siblings (if siblings t org-show-siblings)))
14850 (org-show-context nil)))
14852 (defun org-highlight-new-match (beg end)
14853 "Highlight from BEG to END and mark the highlight is an occur headline."
14854 (let ((ov (org-make-overlay beg end)))
14855 (org-overlay-put ov 'face 'secondary-selection)
14856 (push ov org-occur-highlights)))
14858 (defun org-remove-occur-highlights (&optional beg end noremove)
14859 "Remove the occur highlights from the buffer.
14860 BEG and END are ignored. If NOREMOVE is nil, remove this function
14861 from the `before-change-functions' in the current buffer."
14862 (interactive)
14863 (unless org-inhibit-highlight-removal
14864 (mapc 'org-delete-overlay org-occur-highlights)
14865 (setq org-occur-highlights nil)
14866 (unless noremove
14867 (remove-hook 'before-change-functions
14868 'org-remove-occur-highlights 'local))))
14870 ;;;; Priorities
14873 "Regular expression matching the priority indicator.")
14875 (defvar org-remove-priority-next-time nil)
14877 (defun org-priority-up ()
14878 "Increase the priority of the current item."
14879 (interactive)
14880 (org-priority 'up))
14882 (defun org-priority-down ()
14883 "Decrease the priority of the current item."
14884 (interactive)
14885 (org-priority 'down))
14887 (defun org-priority (&optional action)
14888 "Change the priority of an item by ARG.
14889 ACTION can be `set', `up', `down', or a character."
14890 (interactive)
14891 (setq action (or action 'set))
14892 (let (current new news have remove)
14893 (save-excursion
14894 (org-back-to-heading)
14895 (if (looking-at org-priority-regexp)
14896 (setq current (string-to-char (match-string 2))
14897 have t)
14898 (setq current org-default-priority))
14899 (cond
14900 ((or (eq action 'set) (integerp action))
14901 (if (integerp action)
14902 (setq new action)
14903 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
14904 (setq new (read-char-exclusive)))
14905 (if (and (= (upcase org-highest-priority) org-highest-priority)
14906 (= (upcase org-lowest-priority) org-lowest-priority))
14907 (setq new (upcase new)))
14908 (cond ((equal new ?\ ) (setq remove t))
14909 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14910 (error "Priority must be between `%c' and `%c'"
14911 org-highest-priority org-lowest-priority))))
14912 ((eq action 'up)
14913 (if (and (not have) (eq last-command this-command))
14914 (setq new org-lowest-priority)
14915 (setq new (if (and org-priority-start-cycle-with-default (not have))
14916 org-default-priority (1- current)))))
14917 ((eq action 'down)
14918 (if (and (not have) (eq last-command this-command))
14919 (setq new org-highest-priority)
14920 (setq new (if (and org-priority-start-cycle-with-default (not have))
14921 org-default-priority (1+ current)))))
14922 (t (error "Invalid action")))
14923 (if (or (< (upcase new) org-highest-priority)
14924 (> (upcase new) org-lowest-priority))
14925 (setq remove t))
14926 (setq news (format "%c" new))
14927 (if have
14928 (if remove
14929 (replace-match "" t t nil 1)
14930 (replace-match news t t nil 2))
14931 (if remove
14932 (error "No priority cookie found in line")
14933 (looking-at org-todo-line-regexp)
14934 (if (match-end 2)
14935 (progn
14936 (goto-char (match-end 2))
14937 (insert " [#" news "]"))
14938 (goto-char (match-beginning 3))
14939 (insert "[#" news "] ")))))
14940 (org-preserve-lc (org-set-tags nil 'align))
14941 (if remove
14942 (message "Priority removed")
14943 (message "Priority of current item set to %s" news))))
14946 (defun org-get-priority (s)
14947 "Find priority cookie and return priority."
14948 (save-match-data
14949 (if (not (string-match org-priority-regexp s))
14950 (* 1000 (- org-lowest-priority org-default-priority))
14951 (* 1000 (- org-lowest-priority
14952 (string-to-char (match-string 2 s)))))))
14954 ;;;; Tags
14956 (defun org-scan-tags (action matcher &optional todo-only)
14957 "Scan headline tags with inheritance and produce output ACTION.
14958 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
14959 evaluated, testing if a given set of tags qualifies a headline for
14960 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
14961 are included in the output."
14964 (org-re
14966 (props (list 'face nil
14967 'done-face 'org-done
14968 'undone-face nil
14969 'mouse-face 'highlight
14970 'org-not-done-regexp org-not-done-regexp
14971 'org-todo-regexp org-todo-regexp
14972 'keymap org-agenda-keymap
14973 'help-echo
14974 (format "mouse-2 or RET jump to org file %s"
14975 (abbreviate-file-name
14976 (or (buffer-file-name (buffer-base-buffer))
14977 (buffer-name (buffer-base-buffer)))))))
14978 (case-fold-search nil)
14979 lspos
14980 tags tags-list tags-alist (llast 0) rtn level category i txt
14981 todo marker entry priority)
14982 (save-excursion
14983 (goto-char (point-min))
14984 (when (eq action 'sparse-tree)
14985 (org-overview)
14986 (org-remove-occur-highlights))
14987 (while (re-search-forward re nil t)
14988 (catch :skip
14989 (setq todo (if (match-end 1) (match-string 2))
14990 tags (if (match-end 4) (match-string 4)))
14991 (goto-char (setq lspos (1+ (match-beginning 0))))
14992 (setq level (org-reduced-level (funcall outline-level))
14993 category (org-get-category))
14994 (setq i llast llast level)
14995 ;; remove tag lists from same and sublevels
14996 (while (>= i level)
14997 (when (setq entry (assoc i tags-alist))
14998 (setq tags-alist (delete entry tags-alist)))
14999 (setq i (1- i)))
15000 ;; add the nex tags
15001 (when tags
15002 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15003 tags-alist
15004 (cons (cons level tags) tags-alist)))
15005 ;; compile tags for current headline
15006 (setq tags-list
15007 (if org-use-tag-inheritance
15008 (apply 'append (mapcar 'cdr tags-alist))
15009 tags))
15010 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15011 (eval matcher)
15012 (or (not org-agenda-skip-archived-trees)
15013 (not (member org-archive-tag tags-list))))
15014 (and (eq action 'agenda) (org-agenda-skip))
15015 ;; list this headline
15017 (if (eq action 'sparse-tree)
15018 (progn
15019 (and org-highlight-sparse-tree-matches
15020 (org-get-heading) (match-end 0)
15021 (org-highlight-new-match
15022 (match-beginning 0) (match-beginning 1)))
15023 (org-show-context 'tags-tree))
15024 (setq txt (org-format-agenda-item
15025 ""
15026 (concat
15027 (if org-tags-match-list-sublevels
15028 (make-string (1- level) ?.) "")
15029 (org-get-heading))
15030 category tags-list)
15031 priority (org-get-priority txt))
15032 (goto-char lspos)
15033 (setq marker (org-agenda-new-marker))
15034 (org-add-props txt props
15035 'org-marker marker 'org-hd-marker marker 'org-category category
15036 'priority priority 'type "tagsmatch")
15037 (push txt rtn))
15038 ;; if we are to skip sublevels, jump to end of subtree
15039 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15040 (when (and (eq action 'sparse-tree)
15041 (not org-sparse-tree-open-archived-trees))
15042 (org-hide-archived-subtrees (point-min) (point-max)))
15043 (nreverse rtn)))
15045 (defvar todo-only) ;; dynamically scoped
15047 (defun org-tags-sparse-tree (&optional todo-only match)
15048 "Create a sparse tree according to tags string MATCH.
15049 MATCH can contain positive and negative selection of tags, like
15051 If optional argument TODO_ONLY is non-nil, only select lines that are
15052 also TODO lines."
15053 (interactive "P")
15054 (org-prepare-agenda-buffers (list (current-buffer)))
15055 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15057 (defvar org-cached-props nil)
15058 (defun org-cached-entry-get (pom property)
15059 (if (or (eq t org-use-property-inheritance)
15060 (member property org-use-property-inheritance))
15061 ;; Caching is not possible, check it directly
15062 (org-entry-get pom property 'inherit)
15063 ;; Get all properties, so that we can do complicated checks easily
15064 (cdr (assoc property (or org-cached-props
15065 (setq org-cached-props
15066 (org-entry-properties pom)))))))
15068 (defun org-global-tags-completion-table (&optional files)
15069 "Return the list of all tags in all agenda buffer/files."
15070 (save-excursion
15071 (org-uniquify
15072 (apply 'append
15073 (mapcar
15074 (lambda (file)
15075 (set-buffer (find-file-noselect file))
15076 (org-get-buffer-tags))
15077 (if (and files (car files))
15078 files
15079 (org-agenda-files)))))))
15081 (defun org-make-tags-matcher (match)
15082 "Create the TAGS//TODO matcher form for the selection string MATCH."
15083 ;; todo-only is scoped dynamically into this function, and the function
15084 ;; may change it it the matcher asksk for it.
15085 (unless match
15086 ;; Get a new match request, with completion
15087 (let ((org-last-tags-completion-table
15088 (org-global-tags-completion-table)))
15089 (setq match (completing-read
15090 "Match: " 'org-tags-completion-function nil nil
15091 org-agenda-query-string
15092 'org-tags-history))))
15094 ;; Parse the string and create a lisp form
15095 (let ((match0 match)
15096 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
15097 minus tag mm
15098 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15099 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15100 (if (string-match "/+" match)
15101 ;; match contains also a todo-matching request
15102 (progn
15103 (setq tagsmatch (substring match 0 (match-beginning 0))
15104 todomatch (substring match (match-end 0)))
15105 (if (string-match "^!" todomatch)
15106 (setq todo-only t todomatch (substring todomatch 1)))
15108 (setq todomatch nil)))
15109 ;; only matching tags
15110 (setq tagsmatch match todomatch nil))
15112 ;; Make the tags matcher
15114 (setq tagsmatcher t)
15115 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15116 (while (setq term (pop orterms))
15118 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15119 (while (string-match re term)
15120 (setq minus (and (match-end 1)
15121 (equal (match-string 1 term) "-"))
15122 tag (match-string 2 term)
15123 re-p (equal (string-to-char tag) ?{)
15124 level-p (match-end 3)
15125 prop-p (match-end 4)
15126 mm (cond
15127 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15128 (level-p `(= level ,(string-to-number
15129 (match-string 3 term))))
15130 (prop-p
15131 (setq pn (match-string 4 term)
15132 pv (match-string 5 term)
15133 cat-p (equal pn "CATEGORY")
15134 re-p (equal (string-to-char pv) ?{)
15135 pv (substring pv 1 -1))
15136 (if (equal pn "CATEGORY")
15137 (setq gv '(get-text-property (point) 'org-category))
15138 (setq gv `(org-cached-entry-get nil ,pn)))
15139 (if re-p
15140 `(string-match ,pv (or ,gv ""))
15141 `(equal ,pv ,gv)))
15142 (t `(member ,(downcase tag) tags-list)))
15143 mm (if minus (list 'not mm) mm)
15144 term (substring term (match-end 0)))
15145 (push mm tagsmatcher))
15146 (push (if (> (length tagsmatcher) 1)
15147 (cons 'and tagsmatcher)
15148 (car tagsmatcher))
15149 orlist)
15150 (setq tagsmatcher nil))
15151 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15152 (setq tagsmatcher
15153 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15155 ;; Make the todo matcher
15157 (setq todomatcher t)
15158 (setq orterms (org-split-string todomatch "|") orlist nil)
15159 (while (setq term (pop orterms))
15160 (while (string-match re term)
15161 (setq minus (and (match-end 1)
15162 (equal (match-string 1 term) "-"))
15163 kwd (match-string 2 term)
15164 re-p (equal (string-to-char kwd) ?{)
15165 term (substring term (match-end 0))
15166 mm (if re-p
15167 `(string-match ,(substring kwd 1 -1) todo)
15168 (list 'equal 'todo kwd))
15169 mm (if minus (list 'not mm) mm))
15170 (push mm todomatcher))
15171 (push (if (> (length todomatcher) 1)
15172 (cons 'and todomatcher)
15173 (car todomatcher))
15174 orlist)
15175 (setq todomatcher nil))
15176 (setq todomatcher (if (> (length orlist) 1)
15177 (cons 'or orlist) (car orlist))))
15179 ;; Return the string and lisp forms of the matcher
15180 (setq matcher (if todomatcher
15181 (list 'and tagsmatcher todomatcher)
15182 tagsmatcher))
15183 (cons match0 matcher)))
15185 (defun org-match-any-p (re list)
15186 "Does re match any element of list?"
15187 (setq list (mapcar (lambda (x) (string-match re x)) list))
15188 (delq nil list))
15190 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15191 (defvar org-tags-overlay (org-make-overlay 1 1))
15192 (org-detach-overlay org-tags-overlay)
15194 (defun org-align-tags-here (to-col)
15195 ;; Assumes that this is a headline
15196 (let ((pos (point)) (col (current-column)) tags)
15197 (beginning-of-line 1)
15199 (< pos (match-beginning 2)))
15200 (progn
15201 (setq tags (match-string 2))
15202 (goto-char (match-beginning 1))
15203 (insert " ")
15204 (delete-region (point) (1+ (match-end 0)))
15205 (backward-char 1)
15206 (move-to-column
15207 (max (1+ (current-column))
15208 (1+ col)
15209 (if (> to-col 0)
15210 to-col
15211 (- (abs to-col) (length tags))))
15212 t)
15213 (insert tags)
15214 (move-to-column (min (current-column) col) t))
15215 (goto-char pos))))
15217 (defun org-set-tags (&optional arg just-align)
15218 "Set the tags for the current headline.
15219 With prefix ARG, realign all tags in headings in the current buffer."
15220 (interactive "P")
15221 (let* ((re (concat "^" outline-regexp))
15222 (current (org-get-tags-string))
15223 (col (current-column))
15224 (org-setting-tags t)
15225 table current-tags inherited-tags ; computed below when needed
15226 tags p0 c0 c1 rpl)
15227 (if arg
15228 (save-excursion
15229 (goto-char (point-min))
15230 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15231 (while (re-search-forward re nil t)
15232 (org-set-tags nil t)
15233 (end-of-line 1)))
15234 (message "All tags realigned to column %d" org-tags-column))
15235 (if just-align
15236 (setq tags current)
15237 ;; Get a new set of tags from the user
15238 (save-excursion
15239 (setq table (or org-tag-alist (org-get-buffer-tags))
15240 org-last-tags-completion-table table
15241 current-tags (org-split-string current ":")
15242 inherited-tags (nreverse
15243 (nthcdr (length current-tags)
15244 (nreverse (org-get-tags-at))))
15245 tags
15246 (if (or (eq t org-use-fast-tag-selection)
15247 (and org-use-fast-tag-selection
15248 (delq nil (mapcar 'cdr table))))
15249 (org-fast-tag-selection
15250 current-tags inherited-tags table
15251 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15252 (let ((org-add-colon-after-tag-completion t))
15253 (org-trim
15254 (org-without-partial-completion
15255 (completing-read "Tags: " 'org-tags-completion-function
15256 nil nil current 'org-tags-history)))))))
15257 (while (string-match "[-+&]+" tags)
15258 ;; No boolean logic, just a list
15259 (setq tags (replace-match ":" t t tags))))
15262 (setq tags "")
15263 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15264 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15266 ;; Insert new tags at the correct column
15267 (beginning-of-line 1)
15268 (cond
15269 ((and (equal current "") (equal tags "")))
15270 ((re-search-forward
15272 (point-at-eol) t)
15273 (if (equal tags "")
15274 (setq rpl "")
15275 (goto-char (match-beginning 0))
15276 (setq c0 (current-column) p0 (point)
15277 c1 (max (1+ c0) (if (> org-tags-column 0)
15278 org-tags-column
15279 (- (- org-tags-column) (length tags))))
15280 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15281 (replace-match rpl t t)
15282 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
15283 tags)
15284 (t (error "Tags alignment failed")))
15285 (move-to-column col)
15286 (unless just-align
15287 (run-hooks 'org-after-tags-change-hook)))))
15289 (defun org-change-tag-in-region (beg end tag off)
15290 "Add or remove TAG for each entry in the region.
15291 This works in the agenda, and also in an org-mode buffer."
15292 (interactive
15293 (list (region-beginning) (region-end)
15294 (let ((org-last-tags-completion-table
15295 (if (org-mode-p)
15296 (org-get-buffer-tags)
15297 (org-global-tags-completion-table))))
15298 (completing-read
15299 "Tag: " 'org-tags-completion-function nil nil nil
15300 'org-tags-history))
15301 (progn
15302 (message "[s]et or [r]emove? ")
15303 (equal (read-char-exclusive) ?r))))
15304 (if (fboundp 'deactivate-mark) (deactivate-mark))
15305 (let ((agendap (equal major-mode 'org-agenda-mode))
15306 l1 l2 m buf pos newhead (cnt 0))
15307 (goto-char end)
15308 (setq l2 (1- (org-current-line)))
15309 (goto-char beg)
15310 (setq l1 (org-current-line))
15311 (loop for l from l1 to l2 do
15312 (goto-line l)
15313 (setq m (get-text-property (point) 'org-hd-marker))
15314 (when (or (and (org-mode-p) (org-on-heading-p))
15315 (and agendap m))
15316 (setq buf (if agendap (marker-buffer m) (current-buffer))
15317 pos (if agendap m (point)))
15318 (with-current-buffer buf
15319 (save-excursion
15320 (save-restriction
15321 (goto-char pos)
15322 (setq cnt (1+ cnt))
15323 (org-toggle-tag tag (if off 'off 'on))
15324 (setq newhead (org-get-heading)))))
15325 (and agendap (org-agenda-change-all-lines newhead m))))
15326 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15328 (defun org-tags-completion-function (string predicate &optional flag)
15329 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15330 (confirm (lambda (x) (stringp (car x)))))
15332 (setq s1 (match-string 1 string)
15333 s2 (match-string 2 string))
15334 (setq s1 "" s2 string))
15335 (cond
15336 ((eq flag nil)
15337 ;; try completion
15338 (setq rtn (try-completion s2 ctable confirm))
15339 (if (stringp rtn)
15340 (setq rtn
15341 (concat s1 s2 (substring rtn (length s2))
15342 (if (and org-add-colon-after-tag-completion
15343 (assoc rtn ctable))
15344 ":" ""))))
15345 rtn)
15346 ((eq flag t)
15347 ;; all-completions
15348 (all-completions s2 ctable confirm)
15349 )
15350 ((eq flag 'lambda)
15351 ;; exact match?
15352 (assoc s2 ctable)))
15353 ))
15355 (defun org-fast-tag-insert (kwd tags face &optional end)
15356 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15357 (insert (format "%-12s" (concat kwd ":"))
15358 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15359 (or end "")))
15361 (defun org-fast-tag-show-exit (flag)
15362 (save-excursion
15363 (goto-line 3)
15365 (replace-match ""))
15366 (when flag
15367 (end-of-line 1)
15368 (move-to-column (- (window-width) 19) t)
15369 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15371 (defun org-set-current-tags-overlay (current prefix)
15372 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15373 (if (featurep 'xemacs)
15374 (org-overlay-display org-tags-overlay (concat prefix s)
15375 'secondary-selection)
15376 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15377 (org-overlay-display org-tags-overlay (concat prefix s)))))
15379 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15380 "Fast tag selection with single keys.
15381 CURRENT is the current list of tags in the headline, INHERITED is the
15382 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15383 possibly with grouping information. TODO-TABLE is a similar table with
15384 TODO keywords, should these have keys assigned to them.
15385 If the keys are nil, a-z are automatically assigned.
15386 Returns the new tags string, or nil to not change the current settings."
15387 (let* ((fulltable (append table todo-table))
15388 (maxlen (apply 'max (mapcar
15389 (lambda (x)
15390 (if (stringp (car x)) (string-width (car x)) 0))
15391 fulltable)))
15392 (buf (current-buffer))
15393 (expert (eq org-fast-tag-selection-single-key 'expert))
15394 (buffer-tags nil)
15395 (fwidth (+ maxlen 3 1 3))
15396 (ncol (/ (- (window-width) 4) fwidth))
15397 (i-face 'org-done)
15398 (c-face 'org-todo)
15399 tg cnt e c char c1 c2 ntable tbl rtn
15400 ov-start ov-end ov-prefix
15401 (exit-after-next org-fast-tag-selection-single-key)
15402 (done-keywords org-done-keywords)
15403 groups ingroup)
15404 (save-excursion
15405 (beginning-of-line 1)
15406 (if (looking-at
15408 (setq ov-start (match-beginning 1)
15409 ov-end (match-end 1)
15410 ov-prefix "")
15411 (setq ov-start (1- (point-at-eol))
15412 ov-end (1+ ov-start))
15414 (setq ov-prefix
15415 (concat
15416 (buffer-substring (1- (point)) (point))
15417 (if (> (current-column) org-tags-column)
15418 " "
15419 (make-string (- org-tags-column (current-column)) ?\ ))))))
15420 (org-move-overlay org-tags-overlay ov-start ov-end)
15421 (save-window-excursion
15422 (if expert
15423 (set-buffer (get-buffer-create " *Org tags*"))
15424 (delete-other-windows)
15425 (split-window-vertically)
15426 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15427 (erase-buffer)
15428 (org-set-local 'org-done-keywords done-keywords)
15431 (org-fast-tag-show-exit exit-after-next)
15432 (org-set-current-tags-overlay current ov-prefix)
15433 (setq tbl fulltable char ?a cnt 0)
15434 (while (setq e (pop tbl))
15435 (cond
15436 ((equal e '(:startgroup))
15437 (push '() groups) (setq ingroup t)
15438 (when (not (= cnt 0))
15439 (setq cnt 0)
15441 (insert "{ "))
15442 ((equal e '(:endgroup))
15443 (setq ingroup nil cnt 0)
15445 (t
15446 (setq tg (car e) c2 nil)
15447 (if (cdr e)
15448 (setq c (cdr e))
15449 ;; automatically assign a character.
15450 (setq c1 (string-to-char
15451 (downcase (substring
15452 tg (if (= (string-to-char tg) ?@) 1 0)))))
15453 (if (or (rassoc c1 ntable) (rassoc c1 table))
15454 (while (or (rassoc char ntable) (rassoc char table))
15455 (setq char (1+ char)))
15456 (setq c2 c1))
15457 (setq c (or c2 char)))
15458 (if ingroup (push tg (car groups)))
15459 (setq tg (org-add-props tg nil 'face
15460 (cond
15461 ((not (assoc tg table))
15462 (org-get-todo-face tg))
15463 ((member tg current) c-face)
15464 ((member tg inherited) i-face)
15465 (t nil))))
15466 (if (and (= cnt 0) (not ingroup)) (insert " "))
15467 (insert "[" c "] " tg (make-string
15468 (- fwidth 4 (length tg)) ?\ ))
15469 (push (cons tg c) ntable)
15470 (when (= (setq cnt (1+ cnt)) ncol)
15472 (if ingroup (insert " "))
15473 (setq cnt 0)))))
15474 (setq ntable (nreverse ntable))
15476 (goto-char (point-min))
15477 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15478 (fit-window-to-buffer))
15479 (setq rtn
15480 (catch 'exit
15481 (while t
15482 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15483 (if groups " [!] no groups" " [!]groups")
15484 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15485 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15486 (cond
15488 ((= c ?!)
15489 (setq groups (not groups))
15490 (goto-char (point-min))
15491 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15492 ((= c ?\C-c)
15493 (if (not expert)
15494 (org-fast-tag-show-exit
15495 (setq exit-after-next (not exit-after-next)))
15496 (setq expert nil)
15497 (delete-other-windows)
15498 (split-window-vertically)
15499 (org-switch-to-buffer-other-window " *Org tags*")
15500 (and (fboundp 'fit-window-to-buffer)
15501 (fit-window-to-buffer))))
15502 ((or (= c ?\C-g)
15503 (and (= c ?q) (not (rassoc c ntable))))
15504 (org-detach-overlay org-tags-overlay)
15505 (setq quit-flag t))
15506 ((= c ?\ )
15507 (setq current nil)
15508 (if exit-after-next (setq exit-after-next 'now)))
15510 (condition-case nil
15511 (setq tg (completing-read
15512 "Tag: "
15513 (or buffer-tags
15514 (with-current-buffer buf
15515 (org-get-buffer-tags)))))
15516 (quit (setq tg "")))
15518 (add-to-list 'buffer-tags (list tg))
15519 (if (member tg current)
15520 (setq current (delete tg current))
15521 (push tg current)))
15522 (if exit-after-next (setq exit-after-next 'now)))
15523 ((setq e (rassoc c todo-table) tg (car e))
15524 (with-current-buffer buf
15525 (save-excursion (org-todo tg)))
15526 (if exit-after-next (setq exit-after-next 'now)))
15527 ((setq e (rassoc c ntable) tg (car e))
15528 (if (member tg current)
15529 (setq current (delete tg current))
15530 (loop for g in groups do
15531 (if (member tg g)
15532 (mapc (lambda (x)
15533 (setq current (delete x current)))
15534 g)))
15535 (push tg current))
15536 (if exit-after-next (setq exit-after-next 'now))))
15538 ;; Create a sorted list
15539 (setq current
15540 (sort current
15541 (lambda (a b)
15542 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15543 (if (eq exit-after-next 'now) (throw 'exit t))
15544 (goto-char (point-min))
15545 (beginning-of-line 2)
15546 (delete-region (point) (point-at-eol))
15547 (org-fast-tag-insert "Current" current c-face)
15548 (org-set-current-tags-overlay current ov-prefix)
15549 (while (re-search-forward
15551 (setq tg (match-string 1))
15552 (add-text-properties
15553 (match-beginning 1) (match-end 1)
15554 (list 'face
15555 (cond
15556 ((member tg current) c-face)
15557 ((member tg inherited) i-face)
15558 (t (get-text-property (match-beginning 1) 'face))))))
15559 (goto-char (point-min)))))
15560 (org-detach-overlay org-tags-overlay)
15561 (if rtn
15562 (mapconcat 'identity current ":")
15563 nil))))
15565 (defun org-get-tags-string ()
15566 "Get the TAGS string in the current headline."
15567 (unless (org-on-heading-p t)
15568 (error "Not on a heading"))
15569 (save-excursion
15570 (beginning-of-line 1)
15572 (org-match-string-no-properties 1)
15573 "")))
15575 (defun org-get-tags ()
15576 "Get the list of tags specified in the current headline."
15577 (org-split-string (org-get-tags-string) ":"))
15579 (defun org-get-buffer-tags ()
15580 "Get a table of all tags used in the buffer, for completion."
15581 (let (tags)
15582 (save-excursion
15583 (goto-char (point-min))
15584 (while (re-search-forward
15586 (when (equal (char-after (point-at-bol 0)) ?*)
15587 (mapc (lambda (x) (add-to-list 'tags x))
15588 (org-split-string (org-match-string-no-properties 1) ":")))))
15589 (mapcar 'list tags)))
15592 ;;;; Properties
15594 ;;; Setting and retrieving properties
15596 (defconst org-special-properties
15597 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15598 "TIMESTAMP" "TIMESTAMP_IA")
15599 "The special properties valid in Org-mode.
15601 These are properties that are not defined in the property drawer,
15602 but in some other way.")
15604 (defconst org-default-properties
15605 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15606 "LOCATION" "LOGGING" "COLUMNS")
15607 "Some properties that are used by Org-mode for various purposes.
15608 Being in this list makes sure that they are offered for completion.")
15611 "Regular expression matching the first line of a property drawer.")
15614 "Regular expression matching the first line of a property drawer.")
15616 (defun org-property-action ()
15617 "Do an action on properties."
15618 (interactive)
15619 (let (c)
15620 (org-at-property-p)
15621 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15622 (setq c (read-char-exclusive))
15623 (cond
15624 ((equal c ?s)
15625 (call-interactively 'org-set-property))
15626 ((equal c ?d)
15627 (call-interactively 'org-delete-property))
15628 ((equal c ?D)
15629 (call-interactively 'org-delete-property-globally))
15630 ((equal c ?c)
15631 (call-interactively 'org-compute-property-at-point))
15632 (t (error "No such property action %c" c)))))
15634 (defun org-at-property-p ()
15635 "Is the cursor in a property line?"
15636 ;; FIXME: Does not check if we are actually in the drawer.
15637 ;; FIXME: also returns true on any drawers.....
15638 ;; This is used by C-c C-c for property action.
15639 (save-excursion
15640 (beginning-of-line 1)
15643 (defmacro org-with-point-at (pom &rest body)
15644 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15645 (declare (indent 1) (debug t))
15646 `(save-excursion
15647 (if (markerp pom) (set-buffer (marker-buffer pom)))
15648 (save-excursion
15649 (goto-char (or pom (point)))
15650 ,@body)))
15652 (defun org-get-property-block (&optional beg end force)
15653 "Return the (beg . end) range of the body of the property drawer.
15654 BEG and END can be beginning and end of subtree, if not given
15655 they will be found.
15656 If the drawer does not exist and FORCE is non-nil, create the drawer."
15657 (catch 'exit
15658 (save-excursion
15659 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15660 (end (or end (progn (outline-next-heading) (point)))))
15661 (goto-char beg)
15662 (if (re-search-forward org-property-start-re end t)
15663 (setq beg (1+ (match-end 0)))
15664 (if force
15665 (save-excursion
15666 (org-insert-property-drawer)
15667 (setq end (progn (outline-next-heading) (point))))
15668 (throw 'exit nil))
15669 (goto-char beg)
15670 (if (re-search-forward org-property-start-re end t)
15671 (setq beg (1+ (match-end 0)))))
15672 (if (re-search-forward org-property-end-re end t)
15673 (setq end (match-beginning 0))
15674 (or force (throw 'exit nil))
15675 (goto-char beg)
15676 (setq end beg)
15677 (org-indent-line-function)
15679 (cons beg end)))))
15681 (defun org-entry-properties (&optional pom which)
15682 "Get all properties of the entry at point-or-marker POM.
15683 This includes the TODO keyword, the tags, time strings for deadline,
15684 scheduled, and clocking, and any additional properties defined in the
15685 entry. The return value is an alist, keys may occur multiple times
15686 if the property key was used several times.
15687 POM may also be nil, in which case the current entry is used.
15688 If WHICH is nil or `all', get all properties. If WHICH is
15689 `special' or `standard', only get that subclass."
15690 (setq which (or which 'all))
15691 (org-with-point-at pom
15692 (let ((clockstr (substring org-clock-string 0 -1))
15693 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15694 beg end range props sum-props key value string)
15695 (save-excursion
15696 (when (condition-case nil (org-back-to-heading t) (error nil))
15697 (setq beg (point))
15698 (setq sum-props (get-text-property (point) 'org-summaries))
15699 (outline-next-heading)
15700 (setq end (point))
15701 (when (memq which '(all special))
15702 ;; Get the special properties, like TODO and tags
15703 (goto-char beg)
15704 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15705 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15706 (when (looking-at org-priority-regexp)
15707 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15708 (when (and (setq value (org-get-tags-string))
15710 (push (cons "TAGS" value) props))
15711 (when (setq value (org-get-tags-at))
15712 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15713 props))
15714 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15715 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15716 string (if (equal key clockstr)
15717 (org-no-properties
15718 (org-trim
15719 (buffer-substring
15720 (match-beginning 3) (goto-char (point-at-eol)))))
15721 (substring (org-match-string-no-properties 3) 1 -1)))
15722 (unless key
15723 (if (= (char-after (match-beginning 3)) ?\[)
15724 (setq key "TIMESTAMP_IA")
15725 (setq key "TIMESTAMP")))
15726 (when (or (equal key clockstr) (not (assoc key props)))
15727 (push (cons key string) props)))
15729 )
15731 (when (memq which '(all standard))
15732 ;; Get the standard properties, like :PORP: ...
15733 (setq range (org-get-property-block beg end))
15734 (when range
15735 (goto-char (car range))
15736 (while (re-search-forward
15738 (cdr range) t)
15739 (setq key (org-match-string-no-properties 1)
15740 value (org-trim (or (org-match-string-no-properties 2) "")))
15741 (unless (member key excluded)
15742 (push (cons key (or value "")) props)))))
15743 (append sum-props (nreverse props)))))))
15745 (defun org-entry-get (pom property &optional inherit)
15746 "Get value of PROPERTY for entry at point-or-marker POM.
15747 If INHERIT is non-nil and the entry does not have the property,
15748 then also check higher levels of the hierarchy.
15749 If the property is present but empty, the return value is the empty string.
15750 If the property is not present at all, nil is returned."
15751 (org-with-point-at pom
15752 (if inherit
15753 (org-entry-get-with-inheritance property)
15754 (if (member property org-special-properties)
15755 ;; We need a special property. Use brute force, get all properties.
15756 (cdr (assoc property (org-entry-properties nil 'special)))
15757 (let ((range (org-get-property-block)))
15758 (if (and range
15759 (goto-char (car range))
15760 (re-search-forward
15762 (cdr range) t))
15763 ;; Found the property, return it.
15764 (if (match-end 1)
15765 (org-match-string-no-properties 1)
15766 "")))))))
15768 (defun org-entry-delete (pom property)
15769 "Delete the property PROPERTY from entry at point-or-marker POM."
15770 (org-with-point-at pom
15771 (if (member property org-special-properties)
15772 nil ; cannot delete these properties.
15773 (let ((range (org-get-property-block)))
15774 (if (and range
15775 (goto-char (car range))
15776 (re-search-forward
15778 (cdr range) t))
15779 (progn
15780 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15781 t)
15782 nil)))))
15784 ;; Multi-values properties are properties that contain multiple values
15785 ;; These values are assumed to be single words, separated by whitespace.
15786 (defun org-entry-add-to-multivalued-property (pom property value)
15787 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15788 (let* ((old (org-entry-get pom property))
15790 (unless (member value values)
15791 (setq values (cons value values))
15792 (org-entry-put pom property
15793 (mapconcat 'identity values " ")))))
15795 (defun org-entry-remove-from-multivalued-property (pom property value)
15796 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15797 (let* ((old (org-entry-get pom property))
15799 (when (member value values)
15800 (setq values (delete value values))
15801 (org-entry-put pom property
15802 (mapconcat 'identity values " ")))))
15804 (defun org-entry-member-in-multivalued-property (pom property value)
15805 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15806 (let* ((old (org-entry-get pom property))
15808 (member value values)))
15810 (defvar org-entry-property-inherited-from (make-marker))
15812 (defun org-entry-get-with-inheritance (property)
15813 "Get entry property, and search higher levels if not present."
15814 (let (tmp)
15815 (save-excursion
15816 (save-restriction
15817 (widen)
15818 (catch 'ex
15819 (while t
15820 (when (setq tmp (org-entry-get nil property))
15821 (org-back-to-heading t)
15822 (move-marker org-entry-property-inherited-from (point))
15823 (throw 'ex tmp))
15824 (or (org-up-heading-safe) (throw 'ex nil)))))
15825 (or tmp (cdr (assoc property org-local-properties))
15826 (cdr (assoc property org-global-properties))))))
15828 (defun org-entry-put (pom property value)
15829 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15830 (org-with-point-at pom
15831 (org-back-to-heading t)
15832 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15833 range)
15834 (cond
15835 ((equal property "TODO")
15837 (not (member value org-todo-keywords-1)))
15839 (if (or (not value)
15841 (setq value 'none))
15842 (org-todo value)
15843 (org-set-tags nil 'align))
15844 ((equal property "PRIORITY")
15846 (string-to-char value) ?\ ))
15847 (org-set-tags nil 'align))
15848 ((equal property "SCHEDULED")
15849 (if (re-search-forward org-scheduled-time-regexp end t)
15850 (cond
15851 ((eq value 'earlier) (org-timestamp-change -1 'day))
15852 ((eq value 'later) (org-timestamp-change 1 'day))
15853 (t (call-interactively 'org-schedule)))
15854 (call-interactively 'org-schedule)))
15855 ((equal property "DEADLINE")
15856 (if (re-search-forward org-deadline-time-regexp end t)
15857 (cond
15858 ((eq value 'earlier) (org-timestamp-change -1 'day))
15859 ((eq value 'later) (org-timestamp-change 1 'day))
15860 (t (call-interactively 'org-deadline)))
15861 (call-interactively 'org-deadline)))
15862 ((member property org-special-properties)
15863 (error "The %s property can not yet be set with `org-entry-put'"
15864 property))
15865 (t ; a non-special property
15866 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15867 (setq range (org-get-property-block beg end 'force))
15868 (goto-char (car range))
15869 (if (re-search-forward
15871 (progn
15872 (delete-region (match-beginning 1) (match-end 1))
15873 (goto-char (match-beginning 1)))
15874 (goto-char (cdr range))
15876 (backward-char 1)
15877 (org-indent-line-function)
15878 (insert ":" property ":"))
15879 (and value (insert " " value))
15880 (org-indent-line-function)))))))
15882 (defun org-buffer-property-keys (&optional include-specials include-defaults)
15883 "Get all property keys in the current buffer.
15884 With INCLUDE-SPECIALS, also list the special properties that relect things
15885 like tags and TODO state.
15886 With INCLUDE-DEFAULTS, also include properties that has special meaning
15887 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING."
15888 (let (rtn range)
15889 (save-excursion
15890 (save-restriction
15891 (widen)
15892 (goto-char (point-min))
15893 (while (re-search-forward org-property-start-re nil t)
15894 (setq range (org-get-property-block))
15895 (goto-char (car range))
15896 (while (re-search-forward
15898 (cdr range) t)
15899 (add-to-list 'rtn (org-match-string-no-properties 1)))
15900 (outline-next-heading))))
15902 (when include-specials
15903 (setq rtn (append org-special-properties rtn)))
15905 (when include-defaults
15906 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
15908 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15910 (defun org-property-values (key)
15911 "Return a list of all values of property KEY."
15912 (save-excursion
15913 (save-restriction
15914 (widen)
15915 (goto-char (point-min))
15917 values)
15918 (while (re-search-forward re nil t)
15919 (add-to-list 'values (org-trim (match-string 1))))
15920 (delete "" values)))))
15922 (defun org-insert-property-drawer ()
15923 "Insert a property drawer into the current entry."
15924 (interactive)
15925 (org-back-to-heading t)
15926 (looking-at outline-regexp)
15927 (let ((indent (- (match-end 0)(match-beginning 0)))
15928 (beg (point))
15930 end hiddenp)
15931 (outline-next-heading)
15932 (setq end (point))
15933 (goto-char beg)
15934 (while (re-search-forward re end t))
15935 (setq hiddenp (org-invisible-p))
15936 (end-of-line 1)
15938 (org-skip-over-state-notes)
15940 (if (eq (char-before) ?*) (forward-char 1))
15942 (beginning-of-line 0)
15943 (indent-to-column indent)
15944 (beginning-of-line 2)
15945 (indent-to-column indent)
15946 (beginning-of-line 0)
15947 (if hiddenp
15948 (save-excursion
15949 (org-back-to-heading t)
15950 (hide-entry))
15951 (org-flag-drawer t))))
15953 (defun org-set-property (property value)
15954 "In the current entry, set PROPERTY to VALUE.
15955 When called interactively, this will prompt for a property name, offering
15956 completion on existing and default properties. And then it will prompt
15957 for a value, offering competion either on allowed values (via an inherited
15958 xxx_ALL property) or on existing values in other instances of this property
15959 in the current file."
15960 (interactive
15961 (let* ((prop (completing-read
15962 "Property: " (mapcar 'list (org-buffer-property-keys nil t))))
15963 (cur (org-entry-get nil prop))
15964 (allowed (org-property-get-allowed-values nil prop 'table))
15965 (existing (mapcar 'list (org-property-values prop)))
15966 (val (if allowed
15967 (completing-read "Value: " allowed nil 'req-match)
15968 (completing-read
15970 (concat "[" cur "]") "")
15971 ": ")
15972 existing nil nil "" nil cur))))
15973 (list prop (if (equal val "") cur val))))
15974 (unless (equal (org-entry-get nil property) value)
15975 (org-entry-put nil property value)))
15977 (defun org-delete-property (property)
15978 "In the current entry, delete PROPERTY."
15979 (interactive
15980 (let* ((prop (completing-read
15981 "Property: " (org-entry-properties nil 'standard))))
15982 (list prop)))
15983 (message "Property %s %s" property
15984 (if (org-entry-delete nil property)
15985 "deleted"
15986 "was not present in the entry")))
15988 (defun org-delete-property-globally (property)
15989 "Remove PROPERTY globally, from all entries."
15990 (interactive
15991 (let* ((prop (completing-read
15992 "Globally remove property: "
15993 (mapcar 'list (org-buffer-property-keys)))))
15994 (list prop)))
15995 (save-excursion
15996 (save-restriction
15997 (widen)
15998 (goto-char (point-min))
15999 (let ((cnt 0))
16000 (while (re-search-forward
16002 nil t)
16003 (setq cnt (1+ cnt))
16004 (replace-match ""))
16007 (defvar org-columns-current-fmt-compiled) ; defined below
16009 (defun org-compute-property-at-point ()
16010 "Compute the property at point.
16011 This looks for an enclosing column format, extracts the operator and
16012 then applies it to the proerty in the column format's scope."
16013 (interactive)
16014 (unless (org-at-property-p)
16015 (error "Not at a property"))
16016 (let ((prop (org-match-string-no-properties 2)))
16017 (org-columns-get-format-and-top-level)
16018 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16019 (error "No operator defined for property %s" prop))
16020 (org-columns-compute prop)))
16022 (defun org-property-get-allowed-values (pom property &optional table)
16023 "Get allowed values for the property PROPERTY.
16024 When TABLE is non-nil, return an alist that can directly be used for
16025 completion."
16026 (let (vals)
16027 (cond
16028 ((equal property "TODO")
16029 (setq vals (org-with-point-at pom
16030 (append org-todo-keywords-1 '("")))))
16031 ((equal property "PRIORITY")
16032 (let ((n org-lowest-priority))
16033 (while (>= n org-highest-priority)
16034 (push (char-to-string n) vals)
16035 (setq n (1- n)))))
16036 ((member property org-special-properties))
16037 (t
16038 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16041 (setq vals (car (read-from-string (concat "(" vals ")"))))
16042 (setq vals (mapcar (lambda (x)
16043 (cond ((stringp x) x)
16044 ((numberp x) (number-to-string x))
16045 ((symbolp x) (symbol-name x))
16046 (t "???")))
16047 vals)))))
16048 (if table (mapcar 'list vals) vals)))
16050 (defun org-property-previous-allowed-value (&optional previous)
16051 "Switch to the next allowed value for this property."
16052 (interactive)
16053 (org-property-next-allowed-value t))
16055 (defun org-property-next-allowed-value (&optional previous)
16056 "Switch to the next allowed value for this property."
16057 (interactive)
16058 (unless (org-at-property-p)
16059 (error "Not at a property"))
16060 (let* ((key (match-string 2))
16061 (value (match-string 3))
16062 (allowed (or (org-property-get-allowed-values (point) key)
16063 (and (member value '("[ ]" "[-]" "[X]"))
16064 '("[ ]" "[X]"))))
16065 nval)
16066 (unless allowed
16067 (error "Allowed values for this property have not been defined"))
16068 (if previous (setq allowed (reverse allowed)))
16069 (if (member value allowed)
16070 (setq nval (car (cdr (member value allowed)))))
16071 (setq nval (or nval (car allowed)))
16072 (if (equal nval value)
16073 (error "Only one allowed value for this property"))
16074 (org-at-property-p)
16075 (replace-match (concat " :" key ": " nval) t t)
16076 (org-indent-line-function)
16077 (beginning-of-line 1)
16080 (defun org-find-entry-with-id (ident)
16081 "Locate the entry that contains the ID property with exact value IDENT.
16082 IDENT can be a string, a symbol or a number, this function will search for
16083 the string representation of it.
16084 Return the position where this entry starts, or nil if there is no such entry."
16085 (let ((id (cond
16086 ((stringp ident) ident)
16087 ((symbol-name ident) (symbol-name ident))
16088 ((numberp ident) (number-to-string ident))
16089 (t (error "IDENT %s must be a string, symbol or number" ident))))
16090 (case-fold-search nil))
16091 (save-excursion
16092 (save-restriction
16093 (goto-char (point-min))
16094 (when (re-search-forward
16096 nil t)
16097 (org-back-to-heading)
16098 (point))))))
16100 ;;; Column View
16102 (defvar org-columns-overlays nil
16103 "Holds the list of current column overlays.")
16105 (defvar org-columns-current-fmt nil
16106 "Local variable, holds the currently active column format.")
16107 (defvar org-columns-current-fmt-compiled nil
16108 "Local variable, holds the currently active column format.
16109 This is the compiled version of the format.")
16110 (defvar org-columns-current-widths nil
16111 "Loval variable, holds the currently widths of fields.")
16112 (defvar org-columns-current-maxwidths nil
16113 "Loval variable, holds the currently active maximum column widths.")
16114 (defvar org-columns-begin-marker (make-marker)
16115 "Points to the position where last a column creation command was called.")
16116 (defvar org-columns-top-level-marker (make-marker)
16117 "Points to the position where current columns region starts.")
16119 (defvar org-columns-map (make-sparse-keymap)
16120 "The keymap valid in column display.")
16122 (defun org-columns-content ()
16123 "Switch to contents view while in columns view."
16124 (interactive)
16125 (org-overview)
16126 (org-content))
16128 (org-defkey org-columns-map "c" 'org-columns-content)
16129 (org-defkey org-columns-map "o" 'org-overview)
16130 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16131 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16132 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16133 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16134 (org-defkey org-columns-map "v" 'org-columns-show-value)
16135 (org-defkey org-columns-map "q" 'org-columns-quit)
16136 (org-defkey org-columns-map "r" 'org-columns-redo)
16137 (org-defkey org-columns-map [left] 'backward-char)
16138 (org-defkey org-columns-map "\M-b" 'backward-char)
16139 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16140 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16141 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16142 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16143 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16144 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16145 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16146 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16147 (org-defkey org-columns-map "<" 'org-columns-narrow)
16148 (org-defkey org-columns-map ">" 'org-columns-widen)
16149 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16150 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16151 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16152 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16154 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16155 '("Column"
16156 ["Edit property" org-columns-edit-value t]
16157 ["Next allowed value" org-columns-next-allowed-value t]
16158 ["Previous allowed value" org-columns-previous-allowed-value t]
16159 ["Show full value" org-columns-show-value t]
16160 ["Edit allowed values" org-columns-edit-allowed t]
16161 "--"
16162 ["Edit column attributes" org-columns-edit-attributes t]
16163 ["Increase column width" org-columns-widen t]
16164 ["Decrease column width" org-columns-narrow t]
16165 "--"
16166 ["Move column right" org-columns-move-right t]
16167 ["Move column left" org-columns-move-left t]
16168 ["Add column" org-columns-new t]
16169 ["Delete column" org-columns-delete t]
16170 "--"
16171 ["CONTENTS" org-columns-content t]
16172 ["OVERVIEW" org-overview t]
16173 ["Refresh columns display" org-columns-redo t]
16174 "--"
16175 ["Open link" org-columns-open-link t]
16176 "--"
16177 ["Quit" org-columns-quit t]))
16179 (defun org-columns-new-overlay (beg end &optional string face)
16180 "Create a new column overlay and add it to the list."
16181 (let ((ov (org-make-overlay beg end)))
16182 (org-overlay-put ov 'face (or face 'secondary-selection))
16183 (org-overlay-display ov string face)
16184 (push ov org-columns-overlays)
16185 ov))
16187 (defun org-columns-display-here (&optional props)
16188 "Overlay the current line with column display."
16189 (interactive)
16190 (let* ((fmt org-columns-current-fmt-compiled)
16191 (beg (point-at-bol))
16192 (level-face (save-excursion
16193 (beginning-of-line 1)
16195 (org-get-level-face 2))))
16196 (color (list :foreground
16197 (face-attribute (or level-face 'default) :foreground)))
16198 props pom property ass width f string ov column val modval)
16199 ;; Check if the entry is in another buffer.
16200 (unless props
16201 (if (eq major-mode 'org-agenda-mode)
16202 (setq pom (or (get-text-property (point) 'org-hd-marker)
16203 (get-text-property (point) 'org-marker))
16204 props (if pom (org-entry-properties pom) nil))
16205 (setq props (org-entry-properties nil))))
16206 ;; Walk the format
16207 (while (setq column (pop fmt))
16208 (setq property (car column)
16209 ass (if (equal property "ITEM")
16210 (cons "ITEM"
16211 (save-match-data
16212 (org-no-properties
16213 (org-remove-tabs
16214 (buffer-substring-no-properties
16215 (point-at-bol) (point-at-eol))))))
16216 (assoc property props))
16217 width (or (cdr (assoc property org-columns-current-maxwidths))
16218 (nth 2 column)
16219 (length property))
16220 f (format "%%-%d.%ds | " width width)
16221 val (or (cdr ass) "")
16222 modval (if (equal property "ITEM")
16223 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16224 string (format f (or modval val)))
16225 ;; Create the overlay
16226 (org-unmodified
16227 (setq ov (org-columns-new-overlay
16228 beg (setq beg (1+ beg)) string
16229 (list color 'org-column)))
16230 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16231 (org-overlay-put ov 'keymap org-columns-map)
16232 (org-overlay-put ov 'org-columns-key property)
16233 (org-overlay-put ov 'org-columns-value (cdr ass))
16234 (org-overlay-put ov 'org-columns-value-modified modval)
16235 (org-overlay-put ov 'org-columns-pom pom)
16236 (org-overlay-put ov 'org-columns-format f))
16237 (if (or (not (char-after beg))
16239 (let ((inhibit-read-only t))
16240 (save-excursion
16241 (goto-char beg)
16242 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16243 ;; Make the rest of the line disappear.
16244 (org-unmodified
16245 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16246 (org-overlay-put ov 'invisible t)
16247 (org-overlay-put ov 'keymap org-columns-map)
16248 (org-overlay-put ov 'intangible t)
16249 (push ov org-columns-overlays)
16250 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16251 (org-overlay-put ov 'keymap org-columns-map)
16252 (push ov org-columns-overlays)
16253 (let ((inhibit-read-only t))
16254 (put-text-property (max (point-min) (1- (point-at-bol)))
16255 (min (point-max) (1+ (point-at-eol)))
16256 'read-only "Type `e' to edit property")))))
16258 (defvar org-previous-header-line-format nil
16259 "The header line format before column view was turned on.")
16260 (defvar org-columns-inhibit-recalculation nil
16261 "Inhibit recomputing of columns on column view startup.")
16264 (defvar header-line-format)
16265 (defun org-columns-display-here-title ()
16266 "Overlay the newline before the current line with the table title."
16267 (interactive)
16268 (let ((fmt org-columns-current-fmt-compiled)
16269 string (title "")
16270 property width f column str widths)
16271 (while (setq column (pop fmt))
16272 (setq property (car column)
16273 str (or (nth 1 column) property)
16274 width (or (cdr (assoc property org-columns-current-maxwidths))
16275 (nth 2 column)
16276 (length str))
16277 widths (push width widths)
16278 f (format "%%-%d.%ds | " width width)
16279 string (format f str)
16280 title (concat title string)))
16281 (setq title (concat
16282 (org-add-props " " nil 'display '(space :align-to 0))
16283 (org-add-props title nil 'face '(:weight bold :underline t))))
16284 (org-set-local 'org-previous-header-line-format header-line-format)
16285 (org-set-local 'org-columns-current-widths (nreverse widths))
16286 (setq header-line-format title)))
16288 (defun org-columns-remove-overlays ()
16289 "Remove all currently active column overlays."
16290 (interactive)
16291 (when (marker-buffer org-columns-begin-marker)
16292 (with-current-buffer (marker-buffer org-columns-begin-marker)
16293 (when (local-variable-p 'org-previous-header-line-format)
16294 (setq header-line-format org-previous-header-line-format)
16295 (kill-local-variable 'org-previous-header-line-format))
16296 (move-marker org-columns-begin-marker nil)
16297 (move-marker org-columns-top-level-marker nil)
16298 (org-unmodified
16299 (mapc 'org-delete-overlay org-columns-overlays)
16300 (setq org-columns-overlays nil)
16301 (let ((inhibit-read-only t))
16302 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16304 (defun org-columns-cleanup-item (item fmt)
16305 "Remove from ITEM what is a column in the format FMT."
16306 (if (not org-complex-heading-regexp)
16307 item
16308 (when (string-match org-complex-heading-regexp item)
16309 (concat
16310 (org-add-props (concat (match-string 1 item) " ") nil
16311 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16312 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16313 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16314 " " (match-string 4 item)
16315 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16317 (defun org-columns-show-value ()
16318 "Show the full value of the property."
16319 (interactive)
16320 (let ((value (get-char-property (point) 'org-columns-value)))
16321 (message "Value is: %s" (or value ""))))
16323 (defun org-columns-quit ()
16324 "Remove the column overlays and in this way exit column editing."
16325 (interactive)
16326 (org-unmodified
16327 (org-columns-remove-overlays)
16328 (let ((inhibit-read-only t))
16329 (remove-text-properties (point-min) (point-max) '(read-only t))))
16330 (when (eq major-mode 'org-agenda-mode)
16331 (message
16332 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16334 (defun org-columns-check-computed ()
16335 "Check if this column value is computed.
16336 If yes, throw an error indicating that changing it does not make sense."
16337 (let ((val (get-char-property (point) 'org-columns-value)))
16338 (when (and (stringp val)
16339 (get-char-property 0 'org-computed val))
16340 (error "This value is computed from the entry's children"))))
16342 (defun org-columns-todo (&optional arg)
16343 "Change the TODO state during column view."
16344 (interactive "P")
16345 (org-columns-edit-value "TODO"))
16347 (defun org-columns-set-tags-or-toggle (&optional arg)
16348 "Toggle checkbox at point, or set tags for current headline."
16349 (interactive "P")
16351 (get-char-property (point) 'org-columns-value))
16352 (org-columns-next-allowed-value)
16353 (org-columns-edit-value "TAGS")))
16355 (defun org-columns-edit-value (&optional key)
16356 "Edit the value of the property at point in column view.
16357 Where possible, use the standard interface for changing this line."
16358 (interactive)
16359 (org-columns-check-computed)
16360 (let* ((external-key key)
16361 (col (current-column))
16362 (key (or key (get-char-property (point) 'org-columns-key)))
16363 (value (get-char-property (point) 'org-columns-value))
16364 (bol (point-at-bol)) (eol (point-at-eol))
16365 (pom (or (get-text-property bol 'org-hd-marker)
16366 (point))) ; keep despite of compiler waring
16367 (line-overlays
16368 (delq nil (mapcar (lambda (x)
16369 (and (eq (overlay-buffer x) (current-buffer))
16370 (>= (overlay-start x) bol)
16371 (<= (overlay-start x) eol)
16372 x))
16373 org-columns-overlays)))
16374 nval eval allowed)
16375 (cond
16376 ((equal key "ITEM")
16377 (setq eval '(org-with-point-at pom
16378 (org-edit-headline))))
16379 ((equal key "TODO")
16380 (setq eval '(org-with-point-at pom
16381 (let ((current-prefix-arg
16382 (if external-key current-prefix-arg '(4))))
16383 (call-interactively 'org-todo)))))
16384 ((equal key "PRIORITY")
16385 (setq eval '(org-with-point-at pom
16386 (call-interactively 'org-priority))))
16387 ((equal key "TAGS")
16388 (setq eval '(org-with-point-at pom
16389 (let ((org-fast-tag-selection-single-key
16390 (if (eq org-fast-tag-selection-single-key 'expert)
16391 t org-fast-tag-selection-single-key)))
16392 (call-interactively 'org-set-tags)))))
16393 ((equal key "DEADLINE")
16394 (setq eval '(org-with-point-at pom
16395 (call-interactively 'org-deadline))))
16396 ((equal key "SCHEDULED")
16397 (setq eval '(org-with-point-at pom
16398 (call-interactively 'org-schedule))))
16399 (t
16400 (setq allowed (org-property-get-allowed-values pom key 'table))
16401 (if allowed
16402 (setq nval (completing-read "Value: " allowed nil t))
16403 (setq nval (read-string "Edit: " value)))
16404 (setq nval (org-trim nval))
16405 (when (not (equal nval value))
16406 (setq eval '(org-entry-put pom key nval)))))
16407 (when eval
16408 (let ((inhibit-read-only t))
16409 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16410 (unwind-protect
16411 (progn
16412 (setq org-columns-overlays
16413 (org-delete-all line-overlays org-columns-overlays))
16414 (mapc 'org-delete-overlay line-overlays)
16415 (org-columns-eval eval))
16416 (org-columns-display-here))))
16417 (move-to-column col)
16418 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
16419 (org-columns-update key))))
16421 (defun org-edit-headline () ; FIXME: this is not columns specific
16422 "Edit the current headline, the part without TODO keyword, TAGS."
16423 (org-back-to-heading)
16424 (when (looking-at org-todo-line-regexp)
16425 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16426 (txt (match-string 3))
16427 (post "")
16428 txt2)
16430 (setq post (match-string 0 txt)
16431 txt (substring txt 0 (match-beginning 0))))
16432 (setq txt2 (read-string "Edit: " txt))
16433 (when (not (equal txt txt2))
16434 (beginning-of-line 1)
16435 (insert pre txt2 post)
16436 (delete-region (point) (point-at-eol))
16437 (org-set-tags nil t)))))
16439 (defun org-columns-edit-allowed ()
16440 "Edit the list of allowed values for the current property."
16441 (interactive)
16442 (let* ((key (get-char-property (point) 'org-columns-key))
16443 (key1 (concat key "_ALL"))
16444 (allowed (org-entry-get (point) key1 t))
16445 nval)
16446 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16447 (setq nval (read-string "Allowed: " allowed))
16448 (org-entry-put
16449 (cond ((marker-position org-entry-property-inherited-from)
16450 org-entry-property-inherited-from)
16451 ((marker-position org-columns-top-level-marker)
16452 org-columns-top-level-marker))
16453 key1 nval)))
16455 (defmacro org-no-warnings (&rest body)
16456 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16458 (defun org-columns-eval (form)
16459 (let (hidep)
16460 (save-excursion
16461 (beginning-of-line 1)
16462 ;; `next-line' is needed here, because it skips invisible line.
16463 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16464 (setq hidep (org-on-heading-p 1)))
16465 (eval form)
16466 (and hidep (hide-entry))))
16468 (defun org-columns-previous-allowed-value ()
16469 "Switch to the previous allowed value for this column."
16470 (interactive)
16471 (org-columns-next-allowed-value t))
16473 (defun org-columns-next-allowed-value (&optional previous)
16474 "Switch to the next allowed value for this column."
16475 (interactive)
16476 (org-columns-check-computed)
16477 (let* ((col (current-column))
16478 (key (get-char-property (point) 'org-columns-key))
16479 (value (get-char-property (point) 'org-columns-value))
16480 (bol (point-at-bol)) (eol (point-at-eol))
16481 (pom (or (get-text-property bol 'org-hd-marker)
16482 (point))) ; keep despite of compiler waring
16483 (line-overlays
16484 (delq nil (mapcar (lambda (x)
16485 (and (eq (overlay-buffer x) (current-buffer))
16486 (>= (overlay-start x) bol)
16487 (<= (overlay-start x) eol)
16488 x))
16489 org-columns-overlays)))
16490 (allowed (or (org-property-get-allowed-values pom key)
16491 (and (equal
16492 (nth 4 (assoc key org-columns-current-fmt-compiled))
16493 'checkbox) '("[ ]" "[X]"))))
16494 nval)
16495 (when (equal key "ITEM")
16496 (error "Cannot edit item headline from here"))
16497 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16498 (error "Allowed values for this property have not been defined"))
16499 (if (member key '("SCHEDULED" "DEADLINE"))
16500 (setq nval (if previous 'earlier 'later))
16501 (if previous (setq allowed (reverse allowed)))
16502 (if (member value allowed)
16503 (setq nval (car (cdr (member value allowed)))))
16504 (setq nval (or nval (car allowed)))
16505 (if (equal nval value)
16506 (error "Only one allowed value for this property")))
16507 (let ((inhibit-read-only t))
16508 (remove-text-properties (1- bol) eol '(read-only t))
16509 (unwind-protect
16510 (progn
16511 (setq org-columns-overlays
16512 (org-delete-all line-overlays org-columns-overlays))
16513 (mapc 'org-delete-overlay line-overlays)
16514 (org-columns-eval '(org-entry-put pom key nval)))
16515 (org-columns-display-here)))
16516 (move-to-column col)
16517 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
16518 (org-columns-update key))))
16520 (defun org-verify-version (task)
16521 (cond
16522 ((eq task 'columns)
16523 (if (or (featurep 'xemacs)
16524 (< emacs-major-version 22))
16525 (error "Emacs 22 is required for the columns feature")))))
16527 (defun org-columns-open-link (&optional arg)
16528 (interactive "P")
16529 (let ((key (get-char-property (point) 'org-columns-key))
16530 (value (get-char-property (point) 'org-columns-value)))
16531 (org-open-link-from-string arg)))
16533 (defun org-open-link-from-string (s &optional arg)
16534 "Open a link in the string S, as if it was in Org-mode."
16535 (interactive)
16536 (with-temp-buffer
16537 (let ((org-inhibit-startup t))
16538 (org-mode)
16539 (insert s)
16540 (goto-char (point-min))
16541 (org-open-at-point arg))))
16543 (defun org-columns-get-format-and-top-level ()
16544 (let (fmt)
16545 (when (condition-case nil (org-back-to-heading) (error nil))
16546 (move-marker org-entry-property-inherited-from nil)
16547 (setq fmt (org-entry-get nil "COLUMNS" t)))
16548 (setq fmt (or fmt org-columns-default-format))
16549 (org-set-local 'org-columns-current-fmt fmt)
16550 (org-columns-compile-format fmt)
16551 (if (marker-position org-entry-property-inherited-from)
16552 (move-marker org-columns-top-level-marker
16553 org-entry-property-inherited-from)
16554 (move-marker org-columns-top-level-marker (point)))
16555 fmt))
16557 (defun org-columns ()
16558 "Turn on column view on an org-mode file."
16559 (interactive)
16560 (org-verify-version 'columns)
16561 (org-columns-remove-overlays)
16562 (move-marker org-columns-begin-marker (point))
16563 (let (beg end fmt cache maxwidths)
16564 (setq fmt (org-columns-get-format-and-top-level))
16565 (save-excursion
16566 (goto-char org-columns-top-level-marker)
16567 (setq beg (point))
16568 (unless org-columns-inhibit-recalculation
16569 (org-columns-compute-all))
16570 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16571 (point-max)))
16572 (goto-char beg)
16573 ;; Get and cache the properties
16574 (while (re-search-forward (concat "^" outline-regexp) end t)
16575 (push (cons (org-current-line) (org-entry-properties)) cache))
16576 (when cache
16577 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16578 (org-set-local 'org-columns-current-maxwidths maxwidths)
16579 (org-columns-display-here-title)
16580 (mapc (lambda (x)
16581 (goto-line (car x))
16582 (org-columns-display-here (cdr x)))
16583 cache)))))
16585 (defun org-columns-new (&optional prop title width op fmt)
16586 "Insert a new column, to the leeft o the current column."
16587 (interactive)
16588 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16589 cell)
16590 (setq prop (completing-read
16591 "Property: " (mapcar 'list (org-buffer-property-keys t))
16592 nil nil prop))
16593 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16594 (setq width (read-string "Column width: " (if width (number-to-string width))))
16596 (setq width (string-to-number width))
16597 (setq width nil))
16598 (setq fmt (completing-read "Summary [none]: "
16599 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox"))
16600 nil t))
16602 (setq fmt (intern fmt))
16603 (setq fmt nil))
16604 (if (eq fmt 'none) (setq fmt nil))
16605 (if editp
16606 (progn
16607 (setcar editp prop)
16608 (setcdr editp (list title width nil fmt)))
16609 (setq cell (nthcdr (1- (current-column))
16610 org-columns-current-fmt-compiled))
16611 (setcdr cell (cons (list prop title width nil fmt)
16612 (cdr cell))))
16613 (org-columns-store-format)
16614 (org-columns-redo)))
16616 (defun org-columns-delete ()
16617 "Delete the column at point from columns view."
16618 (interactive)
16619 (let* ((n (current-column))
16620 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16621 (when (y-or-n-p
16623 (setq org-columns-current-fmt-compiled
16624 (delq (nth n org-columns-current-fmt-compiled)
16625 org-columns-current-fmt-compiled))
16626 (org-columns-store-format)
16627 (org-columns-redo)
16628 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16629 (backward-char 1)))))
16631 (defun org-columns-edit-attributes ()
16632 "Edit the attributes of the current column."
16633 (interactive)
16634 (let* ((n (current-column))
16635 (info (nth n org-columns-current-fmt-compiled)))
16636 (apply 'org-columns-new info)))
16638 (defun org-columns-widen (arg)
16639 "Make the column wider by ARG characters."
16640 (interactive "p")
16641 (let* ((n (current-column))
16642 (entry (nth n org-columns-current-fmt-compiled))
16643 (width (or (nth 2 entry)
16644 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16645 (setq width (max 1 (+ width arg)))
16646 (setcar (nthcdr 2 entry) width)
16647 (org-columns-store-format)
16648 (org-columns-redo)))
16650 (defun org-columns-narrow (arg)
16651 "Make the column nrrower by ARG characters."
16652 (interactive "p")
16653 (org-columns-widen (- arg)))
16655 (defun org-columns-move-right ()
16656 "Swap this column with the one to the right."
16657 (interactive)
16658 (let* ((n (current-column))
16659 (cell (nthcdr n org-columns-current-fmt-compiled))
16660 e)
16661 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16662 (error "Cannot shift this column further to the right"))
16663 (setq e (car cell))
16664 (setcar cell (car (cdr cell)))
16665 (setcdr cell (cons e (cdr (cdr cell))))
16666 (org-columns-store-format)
16667 (org-columns-redo)
16668 (forward-char 1)))
16670 (defun org-columns-move-left ()
16671 "Swap this column with the one to the left."
16672 (interactive)
16673 (let* ((n (current-column)))
16674 (when (= n 0)
16675 (error "Cannot shift this column further to the left"))
16676 (backward-char 1)
16677 (org-columns-move-right)
16678 (backward-char 1)))
16680 (defun org-columns-store-format ()
16681 "Store the text version of the current columns format in appropriate place.
16682 This is either in the COLUMNS property of the node starting the current column
16683 display, or in the #+COLUMNS line of the current buffer."
16684 (let (fmt (cnt 0))
16685 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16686 (org-set-local 'org-columns-current-fmt fmt)
16687 (if (marker-position org-columns-top-level-marker)
16688 (save-excursion
16689 (goto-char org-columns-top-level-marker)
16690 (if (and (org-at-heading-p)
16691 (org-entry-get nil "COLUMNS"))
16692 (org-entry-put nil "COLUMNS" fmt)
16693 (goto-char (point-min))
16694 ;; Overwrite all #+COLUMNS lines....
16696 (setq cnt (1+ cnt))
16697 (replace-match (concat "#+COLUMNS: " fmt) t t))
16698 (unless (> cnt 0)
16699 (goto-char (point-min))
16700 (or (org-on-heading-p t) (outline-next-heading))
16701 (let ((inhibit-read-only t))
16703 (org-set-local 'org-columns-default-format fmt))))))
16705 (defvar org-overriding-columns-format nil
16706 "When set, overrides any other definition.")
16707 (defvar org-agenda-view-columns-initially nil
16708 "When set, switch to columns view immediately after creating the agenda.")
16710 (defun org-agenda-columns ()
16711 "Turn on column view in the agenda."
16712 (interactive)
16713 (org-verify-version 'columns)
16714 (org-columns-remove-overlays)
16715 (move-marker org-columns-begin-marker (point))
16716 (let (fmt cache maxwidths m)
16717 (cond
16718 ((and (local-variable-p 'org-overriding-columns-format)
16719 org-overriding-columns-format)
16720 (setq fmt org-overriding-columns-format))
16721 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
16722 (setq fmt (org-entry-get m "COLUMNS" t)))
16723 ((and (boundp 'org-columns-current-fmt)
16724 (local-variable-p 'org-columns-current-fmt)
16725 org-columns-current-fmt)
16726 (setq fmt org-columns-current-fmt))
16727 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
16728 (setq m (get-text-property m 'org-hd-marker))
16729 (setq fmt (org-entry-get m "COLUMNS" t))))
16730 (setq fmt (or fmt org-columns-default-format))
16731 (org-set-local 'org-columns-current-fmt fmt)
16732 (org-columns-compile-format fmt)
16733 (save-excursion
16734 ;; Get and cache the properties
16735 (goto-char (point-min))
16736 (while (not (eobp))
16737 (when (setq m (or (get-text-property (point) 'org-hd-marker)
16738 (get-text-property (point) 'org-marker)))
16739 (push (cons (org-current-line) (org-entry-properties m)) cache))
16740 (beginning-of-line 2))
16741 (when cache
16742 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16743 (org-set-local 'org-columns-current-maxwidths maxwidths)
16744 (org-columns-display-here-title)
16745 (mapc (lambda (x)
16746 (goto-line (car x))
16747 (org-columns-display-here (cdr x)))
16748 cache)))))
16750 (defun org-columns-get-autowidth-alist (s cache)
16751 "Derive the maximum column widths from the format and the cache."
16752 (let ((start 0) rtn)
16754 (push (cons (match-string 1 s) 1) rtn)
16755 (setq start (match-end 0)))
16756 (mapc (lambda (x)
16757 (setcdr x (apply 'max
16758 (mapcar
16759 (lambda (y)
16760 (length (or (cdr (assoc (car x) (cdr y))) " ")))
16761 cache))))
16762 rtn)
16763 rtn))
16765 (defun org-columns-compute-all ()
16766 "Compute all columns that have operators defined."
16767 (org-unmodified
16768 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
16769 (let ((columns org-columns-current-fmt-compiled) col)
16770 (while (setq col (pop columns))
16771 (when (nth 3 col)
16772 (save-excursion
16773 (org-columns-compute (car col)))))))
16775 (defun org-columns-update (property)
16776 "Recompute PROPERTY, and update the columns display for it."
16777 (org-columns-compute property)
16778 (let (fmt val pos)
16779 (save-excursion
16780 (mapc (lambda (ov)
16781 (when (equal (org-overlay-get ov 'org-columns-key) property)
16782 (setq pos (org-overlay-start ov))
16783 (goto-char pos)
16784 (when (setq val (cdr (assoc property
16785 (get-text-property
16786 (point-at-bol) 'org-summaries))))
16787 (setq fmt (org-overlay-get ov 'org-columns-format))
16788 (org-overlay-put ov 'org-columns-value val)
16789 (org-overlay-put ov 'display (format fmt val)))))
16790 org-columns-overlays))))
16792 (defun org-columns-compute (property)
16793 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
16794 (interactive)
16795 (let* ((re (concat "^" outline-regexp))
16796 (lmax 30) ; Does anyone use deeper levels???
16797 (lsum (make-vector lmax 0))
16798 (lflag (make-vector lmax nil))
16799 (level 0)
16800 (ass (assoc property org-columns-current-fmt-compiled))
16801 (format (nth 4 ass))
16802 (printf (nth 5 ass))
16803 (beg org-columns-top-level-marker)
16804 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
16805 (save-excursion
16806 ;; Find the region to compute
16807 (goto-char beg)
16808 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
16809 (goto-char end)
16810 ;; Walk the tree from the back and do the computations
16811 (while (re-search-backward re beg t)
16812 (setq sumpos (match-beginning 0)
16813 last-level level
16814 level (org-outline-level)
16815 val (org-entry-get nil property)
16817 (cond
16818 ((< level last-level)
16819 ;; put the sum of lower levels here as a property
16820 (setq sum (aref lsum last-level) ; current sum
16821 flag (aref lflag last-level) ; any valid entries from children?
16822 str (org-column-number-to-string sum format printf)
16823 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
16824 useval (if flag str1 (if valflag val ""))
16825 sum-alist (get-text-property sumpos 'org-summaries))
16826 (if (assoc property sum-alist)
16827 (setcdr (assoc property sum-alist) useval)
16828 (push (cons property useval) sum-alist)
16829 (org-unmodified
16830 (add-text-properties sumpos (1+ sumpos)
16831 (list 'org-summaries sum-alist))))
16832 (when val
16833 (org-entry-put nil property (if flag str val)))
16834 ;; add current to current level accumulator
16835 (when (or flag valflag)
16836 (aset lsum level (+ (aref lsum level)
16837 (if flag sum (org-column-string-to-number
16838 (if flag str val) format))))
16839 (aset lflag level t))
16840 ;; clear accumulators for deeper levels
16841 (loop for l from (1+ level) to (1- lmax) do
16842 (aset lsum l 0)
16843 (aset lflag l nil)))
16844 ((>= level last-level)
16845 ;; add what we have here to the accumulator for this level
16846 (aset lsum level (+ (aref lsum level)
16847 (org-column-string-to-number (or val "0") format)))
16848 (and valflag (aset lflag level t)))
16849 (t (error "This should not happen")))))))
16851 (defun org-columns-redo ()
16852 "Construct the column display again."
16853 (interactive)
16854 (message "Recomputing columns...")
16855 (save-excursion
16856 (if (marker-position org-columns-begin-marker)
16857 (goto-char org-columns-begin-marker))
16858 (org-columns-remove-overlays)
16859 (if (org-mode-p)
16860 (call-interactively 'org-columns)
16861 (call-interactively 'org-agenda-columns)))
16862 (message "Recomputing columns...done"))
16864 (defun org-columns-not-in-agenda ()
16865 (if (eq major-mode 'org-agenda-mode)
16866 (error "This command is only allowed in Org-mode buffers")))
16869 (defun org-string-to-number (s)
16870 "Convert string to number, and interpret hh:mm:ss."
16871 (if (not (string-match ":" s))
16872 (string-to-number s)
16873 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16874 (while l
16875 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16876 sum)))
16878 (defun org-column-number-to-string (n fmt printf)
16879 "Convert a computed column number to a string value, according to FMT."
16880 (cond
16881 ((eq fmt 'add_times)
16882 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
16883 (format "%d:%02d" h m)))
16884 ((eq fmt 'checkbox)
16885 (cond ((= n (floor n)) "[X]")
16886 ((> n 1.) "[-]")
16887 (t "[ ]")))
16888 (printf (format printf n))
16889 ((eq fmt 'currency)
16890 (format "%.2f" n))
16891 (t (number-to-string n))))
16893 (defun org-column-string-to-number (s fmt)
16894 "Convert a column value to a number that can be used for column computing."
16895 (cond
16896 ((string-match ":" s)
16897 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16898 (while l
16899 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16900 sum))
16901 ((eq fmt 'checkbox)
16902 (if (equal s "[X]") 1. 0.000001))
16903 (t (string-to-number s))))
16905 (defun org-columns-uncompile-format (cfmt)
16906 "Turn the compiled columns format back into a string representation."
16907 (let ((rtn "") e s prop title op width fmt printf)
16908 (while (setq e (pop cfmt))
16909 (setq prop (car e)
16910 title (nth 1 e)
16911 width (nth 2 e)
16912 op (nth 3 e)
16913 fmt (nth 4 e)
16914 printf (nth 5 e))
16915 (cond
16916 ((eq fmt 'add_times) (setq op ":"))
16917 ((eq fmt 'checkbox) (setq op "X"))
16918 ((eq fmt 'add_numbers) (setq op "+"))
16919 ((eq fmt 'currency) (setq op "$")))
16920 (if (and op printf) (setq op (concat op ";" printf)))
16921 (if (equal title prop) (setq title nil))
16922 (setq s (concat "%" (if width (number-to-string width))
16923 prop
16924 (if title (concat "(" title ")"))
16925 (if op (concat "{" op "}"))))
16926 (setq rtn (concat rtn " " s)))
16927 (org-trim rtn)))
16929 (defun org-columns-compile-format (fmt)
16930 "Turn a column format string into an alist of specifications.
16931 The alist has one entry for each column in the format. The elements of
16932 that list are:
16933 property the property
16934 title the title field for the columns
16935 width the column width in characters, can be nil for automatic
16936 operator the operator if any
16937 format the output format for computed results, derived from operator
16938 printf a printf format for computed values"
16939 (let ((start 0) width prop title op f printf)
16940 (setq org-columns-current-fmt-compiled nil)
16941 (while (string-match
16942 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
16943 fmt start)
16944 (setq start (match-end 0)
16945 width (match-string 1 fmt)
16946 prop (match-string 2 fmt)
16947 title (or (match-string 3 fmt) prop)
16948 op (match-string 4 fmt)
16949 f nil
16950 printf nil)
16951 (if width (setq width (string-to-number width)))
16952 (when (and op (string-match ";" op))
16953 (setq printf (substring op (match-end 0))
16954 op (substring op 0 (match-beginning 0))))
16955 (cond
16956 ((equal op "+") (setq f 'add_numbers))
16957 ((equal op "$") (setq f 'currency))
16958 ((equal op ":") (setq f 'add_times))
16959 ((equal op "X") (setq f 'checkbox)))
16960 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
16961 (setq org-columns-current-fmt-compiled
16962 (nreverse org-columns-current-fmt-compiled))))
16965 ;;; Dynamic block for Column view
16967 (defun org-columns-capture-view ()
16968 "Get the column view of the current buffer and return it as a list.
16969 The list will contains the title row and all other rows. Each row is
16970 a list of fields."
16971 (save-excursion
16972 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
16973 (n (length title)) row tbl)
16974 (goto-char (point-min))
16976 (when (get-char-property (match-beginning 0) 'org-columns-key)
16977 (setq row nil)
16978 (loop for i from 0 to (1- n) do
16979 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
16980 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
16981 "")
16982 row))
16983 (setq row (nreverse row))
16984 (push row tbl)))
16985 (append (list title 'hline) (nreverse tbl)))))
16987 (defun org-dblock-write:columnview (params)
16988 "Write the column view table.
16989 PARAMS is a property list of parameters:
16991 :width enforce same column widths with <N> specifiers.
16992 :id the :ID: property of the entry where the columns view
16993 should be built, as a string. When `local', call locally.
16994 When `global' call column view with the cursor at the beginning
16995 of the buffer (usually this means that the whole buffer switches
16996 to column view).
16997 :hlines When t, insert a hline before each item. When a number, insert
16998 a hline before each level <= that number.
16999 :vlines When t, make each column a colgroup to enforce vertical lines."
17000 (let ((pos (move-marker (make-marker) (point)))
17001 (hlines (plist-get params :hlines))
17002 (vlines (plist-get params :vlines))
17003 tbl id idpos nfields tmp)
17004 (save-excursion
17005 (save-restriction
17006 (when (setq id (plist-get params :id))
17007 (cond ((not id) nil)
17008 ((eq id 'global) (goto-char (point-min)))
17009 ((eq id 'local) nil)
17010 ((setq idpos (org-find-entry-with-id id))
17011 (goto-char idpos))
17012 (t (error "Cannot find entry with :ID: %s" id))))
17013 (org-columns)
17014 (setq tbl (org-columns-capture-view))
17015 (setq nfields (length (car tbl)))
17016 (org-columns-quit)))
17017 (goto-char pos)
17018 (move-marker pos nil)
17019 (when tbl
17020 (when (plist-get params :hlines)
17021 (setq tmp nil)
17022 (while tbl
17023 (if (eq (car tbl) 'hline)
17024 (push (pop tbl) tmp)
17026 (if (and (not (eq (car tmp) 'hline))
17027 (or (eq hlines t)
17028 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17029 (push 'hline tmp)))
17030 (push (pop tbl) tmp)))
17031 (setq tbl (nreverse tmp)))
17032 (when vlines
17033 (setq tbl (mapcar (lambda (x)
17034 (if (eq 'hline x) x (cons "" x)))
17035 tbl))
17036 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17037 (setq pos (point))
17038 (insert (org-listtable-to-string tbl))
17039 (when (plist-get params :width)
17041 org-columns-current-widths "|")))
17042 (goto-char pos)
17043 (org-table-align))))
17045 (defun org-listtable-to-string (tbl)
17046 "Convert a listtable TBL to a string that contains the Org-mode table.
17047 The table still need to be alligned. The resulting string has no leading
17048 and tailing newline characters."
17049 (mapconcat
17050 (lambda (x)
17051 (cond
17052 ((listp x)
17053 (concat "|" (mapconcat 'identity x "|") "|"))
17054 ((eq x 'hline) "|-|")
17055 (t (error "Garbage in listtable: %s" x))))
17058 (defun org-insert-columns-dblock ()
17059 "Create a dynamic block capturing a column view table."
17060 (interactive)
17061 (let ((defaults '(:name "columnview" :hlines 1))
17062 (id (completing-read
17063 "Capture columns (local, global, entry with :ID: property) [local]: "
17064 (append '(("global") ("local"))
17065 (mapcar 'list (org-property-values "ID"))))))
17066 (if (equal id "") (setq id 'local))
17067 (if (equal id "global") (setq id 'global))
17068 (setq defaults (append defaults (list :id id)))
17069 (org-create-dblock defaults)
17070 (org-update-dblock)))
17072 ;;;; Timestamps
17074 (defvar org-last-changed-timestamp nil)
17075 (defvar org-time-was-given) ; dynamically scoped parameter
17076 (defvar org-end-time-was-given) ; dynamically scoped parameter
17077 (defvar org-ts-what) ; dynamically scoped parameter
17079 (defun org-time-stamp (arg)
17080 "Prompt for a date/time and insert a time stamp.
17081 If the user specifies a time like HH:MM, or if this command is called
17082 with a prefix argument, the time stamp will contain date and time.
17083 Otherwise, only the date will be included. All parts of a date not
17084 specified by the user will be filled in from the current date/time.
17085 So if you press just return without typing anything, the time stamp
17086 will represent the current date/time. If there is already a timestamp
17087 at the cursor, it will be modified."
17088 (interactive "P")
17089 (let* ((ts nil)
17090 (default-time
17091 ;; Default time is either today, or, when entering a range,
17092 ;; the range start.
17093 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17094 (save-excursion
17095 (re-search-backward
17097 (- (point) 20) t)))
17098 (apply 'encode-time (org-parse-time-string (match-string 1)))
17099 (current-time)))
17100 (default-input (and ts (org-get-compact-tod ts)))
17101 org-time-was-given org-end-time-was-given time)
17102 (cond
17103 ((and (org-at-timestamp-p)
17104 (eq last-command 'org-time-stamp)
17105 (eq this-command 'org-time-stamp))
17106 (insert "--")
17107 (setq time (let ((this-command this-command))
17108 (org-read-date arg 'totime nil nil default-time default-input)))
17109 (org-insert-time-stamp time (or org-time-was-given arg)))
17110 ((org-at-timestamp-p)
17111 (setq time (let ((this-command this-command))
17112 (org-read-date arg 'totime nil nil default-time default-input)))
17113 (when (org-at-timestamp-p) ; just to get the match data
17114 (replace-match "")
17115 (setq org-last-changed-timestamp
17116 (org-insert-time-stamp
17117 time (or org-time-was-given arg)
17118 nil nil nil (list org-end-time-was-given))))
17119 (message "Timestamp updated"))
17120 (t
17121 (setq time (let ((this-command this-command))
17122 (org-read-date arg 'totime nil nil default-time default-input)))
17123 (org-insert-time-stamp time (or org-time-was-given arg)
17124 nil nil nil (list org-end-time-was-given))))))
17126 ;; FIXME: can we use this for something else????
17127 ;; like computing time differences?????
17128 (defun org-get-compact-tod (s)
17129 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17130 (let* ((t1 (match-string 1 s))
17131 (h1 (string-to-number (match-string 2 s)))
17132 (m1 (string-to-number (match-string 3 s)))
17133 (t2 (and (match-end 4) (match-string 5 s)))
17134 (h2 (and t2 (string-to-number (match-string 6 s))))
17135 (m2 (and t2 (string-to-number (match-string 7 s))))
17136 dh dm)
17137 (if (not t2)
17138 t1
17139 (setq dh (- h2 h1) dm (- m2 m1))
17140 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17141 (concat t1 "+" (number-to-string dh)
17142 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17144 (defun org-time-stamp-inactive (&optional arg)
17145 "Insert an inactive time stamp.
17146 An inactive time stamp is enclosed in square brackets instead of angle
17147 brackets. It is inactive in the sense that it does not trigger agenda entries,
17148 does not link to the calendar and cannot be changed with the S-cursor keys.
17149 So these are more for recording a certain time/date."
17150 (interactive "P")
17151 (let (org-time-was-given org-end-time-was-given time)
17152 (setq time (org-read-date arg 'totime))
17153 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17154 nil nil (list org-end-time-was-given))))
17156 (defvar org-date-ovl (org-make-overlay 1 1))
17157 (org-overlay-put org-date-ovl 'face 'org-warning)
17158 (org-detach-overlay org-date-ovl)
17160 (defvar org-ans1) ; dynamically scoped parameter
17161 (defvar org-ans2) ; dynamically scoped parameter
17163 (defvar org-plain-time-of-day-regexp) ; defined below
17165 (defvar org-read-date-overlay nil)
17166 (defvar org-dcst nil) ; dynamically scoped
17168 (defun org-read-date (&optional with-time to-time from-string prompt
17169 default-time default-input)
17170 "Read a date, possibly a time, and make things smooth for the user.
17171 The prompt will suggest to enter an ISO date, but you can also enter anything
17172 which will at least partially be understood by `parse-time-string'.
17173 Unrecognized parts of the date will default to the current day, month, year,
17174 hour and minute. If this command is called to replace a timestamp at point,
17175 of to enter the second timestamp of a range, the default time is taken from the
17176 existing stamp. For example,
17177 3-2-5 --> 2003-02-05
17178 feb 15 --> currentyear-02-15
17179 sep 12 9 --> 2009-09-12
17180 12:45 --> today 12:45
17181 22 sept 0:34 --> currentyear-09-22 0:34
17182 12 --> currentyear-currentmonth-12
17183 Fri --> nearest Friday (today or later)
17184 etc.
17186 Furthermore you can specify a relative date by giving, as the *first* thing
17187 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17188 change in days weeks, months, years.
17189 With a single plus or minus, the date is relative to today. With a double
17190 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17191 +4d --> four days from today
17192 +4 --> same as above
17193 +2w --> two weeks from today
17194 ++5 --> five days from default date
17196 The function understands only English month and weekday abbreviations,
17197 but this can be configured with the variables `parse-time-months' and
17198 `parse-time-weekdays'.
17200 While prompting, a calendar is popped up - you can also select the
17201 date with the mouse (button 1). The calendar shows a period of three
17202 months. To scroll it to other months, use the keys `>' and `<'.
17203 If you don't like the calendar, turn it off with
17204 \(setq org-read-date-popup-calendar nil)
17206 With optional argument TO-TIME, the date will immediately be converted
17207 to an internal time.
17208 With an optional argument WITH-TIME, the prompt will suggest to also
17209 insert a time. Note that when WITH-TIME is not set, you can still
17210 enter a time, and this function will inform the calling routine about
17211 this change. The calling routine may then choose to change the format
17212 used to insert the time stamp into the buffer to include the time.
17213 With optional argument FROM-STRING, read from this string instead from
17214 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17215 the time/date that is used for everything that is not specified by the
17216 user."
17217 (require 'parse-time)
17218 (let* ((org-time-stamp-rounding-minutes
17219 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17220 (org-dcst org-display-custom-times)
17221 (ct (org-current-time))
17222 (def (or default-time ct))
17223 (defdecode (decode-time def))
17224 (dummy (progn
17225 (when (< (nth 2 defdecode) org-extend-today-until)
17226 (setcar (nthcdr 2 defdecode) -1)
17227 (setcar (nthcdr 1 defdecode) 59)
17228 (setq def (apply 'encode-time defdecode)
17229 defdecode (decode-time def)))))
17230 (calendar-move-hook nil)
17231 (view-diary-entries-initially nil)
17232 (view-calendar-holidays-initially nil)
17233 (timestr (format-time-string
17234 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17235 (prompt (concat (if prompt (concat prompt " ") "")
17236 (format "Date+time [%s]: " timestr)))
17237 ans (org-ans0 "") org-ans1 org-ans2 final)
17239 (cond
17240 (from-string (setq ans from-string))
17241 (org-read-date-popup-calendar
17242 (save-excursion
17243 (save-window-excursion
17244 (calendar)
17245 (calendar-forward-day (- (time-to-days def)
17246 (calendar-absolute-from-gregorian
17247 (calendar-current-date))))
17248 (org-eval-in-calendar nil t)
17249 (let* ((old-map (current-local-map))
17250 (map (copy-keymap calendar-mode-map))
17251 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17252 (org-defkey map (kbd "RET") 'org-calendar-select)
17253 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17254 'org-calendar-select-mouse)
17292 ;; org-ans0: from prompt
17293 ;; org-ans1: from mouse click
17294 ;; org-ans2: from calendar motion
17322 "Display the currrent date prompt interpretation in the minibuffer."
17338 org-time-stamp-custom-formats
17339 org-time-stamp-formats))
17348 org-end-time-was-given
17355 "Analyze the combined answer of the date prompt."
17356 ;; FIXME: cleanup and comment
17358 hour minute second wday pm h2 m2 tl wday1)
17366 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17376 t nil ans)))
17377 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17378 ;; If there is a time with am/pm, and *no* time without it, we convert
17379 ;; so that matching will be successful.
17393 t t ans))))
17395 ;; Check if a time range is given as a duration
17396 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17404 ;; Check if there is a time range
17438 ;; Weekday was given, but no day, so pick that day in the week
17439 ;; on or after the derived date.
17453 "Check string S for special relative date string.
17454 TODAY and DEFAULT are internal times, for today and for a default.
17455 Return shift list (N what def-flag)
17457 N is the number if WHATs to shift
17458 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17459 the DEFAULT date rather than TODAY."
17468 ?+))
17475 delta)
17485 "Eval FORM in the calendar window and return to current window.
17486 Also, store the cursor date in variable org-ans2."
17497 ; ;; Update the prompt to show new default date
17498 ; (save-excursion
17499 ; (goto-char (point-min))
17500 ; (when (and org-ans2
17501 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17502 ; (get-text-property (match-end 0) 'field))
17503 ; (let ((inhibit-read-only t))
17504 ; (replace-match (concat "[" org-ans2 "]") t t)
17505 ; (add-text-properties (point-min) (1+ (match-end 0))
17506 ; (text-properties-at (1+ (point-min)))))))))
17509 "Return to `org-read-date' with the date currently selected.
17510 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17519 "Insert a date stamp for the date given by the internal TIME.
17520 WITH-HM means, use the stamp format that includes the time of the day.
17521 INACTIVE means use square brackets instead of angular ones, so that the
17522 stamp will not contribute to the agenda.
17523 PRE and POST are optional strings to be inserted before and after the
17524 stamp.
17525 The command returns the inserted time stamp."
17527 stamp)
17544 stamp))
17547 "Toggle the use of custom time stamp formats."
17568 "Overlay modified time stamp format over timestamp between BED and END."
17595 "Translate all timestamps in STRING to custom format.
17596 But do this only if the variable `org-display-custom-times' is set."
17601 t1 with-hm inactive tf time str beg end)
17610 org-time-stamp-custom-formats)
17619 string)
17622 "Set 0 instead of nil for the first 6 elements of time.
17623 Don't touch the rest."
17628 "Difference between TIMESTAMP-STRING and now in days."
17633 "Is the time in TIMESTAMP-STRING close to the current date?"
17639 "Get the deadline lead time appropriate for timestring TS."
17642 ;; 0 or negative, enforce this value no matter what
17645 ;; lead time is specified.
17650 ;; go for the default.
17654 "Return to `org-read-date' with the date currently selected.
17655 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17665 "Check if there are any deadlines due or past due.
17666 A deadline is considered due if it happens within `org-deadline-warning-days'
17667 days from today's date. If the deadline appears in an entry marked DONE,
17668 it is not shown. The prefix arg NDAYS can be used to test that many
17683 org-warn-days)))
17686 "Check if there are deadlines or scheduled entries before DATE."
17700 "Evaluate a time range by computing the difference between start and end.
17701 Normally the result is just printed in the echo area, but with prefix arg
17702 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17703 If the time range is actually in a table, the result is inserted into the
17704 next column.
17705 For time difference computation, a year is assumed to be exactly 365
17706 days in order to avoid rounding problems."
17726 ;; (ys (floor (* 365 24 60 60)))
17734 y d h m align)
17737 y 0
17742 y 0
17780 "Convert a time stamp to an absolute day number.
17781 If there is a specifyer for a cyclic time stamp, get the closest date to
17782 DAYNR."
17786 daynr
17794 "Return the time corresponding to date D.
17795 D may be an absolute day number, or a calendar-type list (month day year)."
17800 "List of holidays, for Diary display in Org-mode."
17808 "Process a SEXP diary ENTRY for DATE."
17828 "Get iCalendar entries from diary entries in buffer FROMBUF.
17829 This uses the icalendar.el library."
17832 temporary-file-directory))
17835 buf rtn b e)
17851 rtn))
17854 "Find the date closest to CURRENT that is consistent with START and CHANGE."
17855 ;; Make the proper lists from the dates
17858 dn dw sday cday n1 n2
17859 d m y y1 y2 date1 date2 nmonths nm ny m2)
17864 current
17888 ;; approx number of month between the tow dates
17890 ;; How often does dn fit in there?
17913 "Turn any specification of DATE into a gregorian date for the calendar."
17923 "Parse the standard Org-mode time string.
17924 This should be a lot faster than the normal `parse-time-string'.
17925 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17926 hour and minute fields will be nil if not given."
17936 nil nil nil)
17940 "Increase the date item at the cursor by one.
17941 If the cursor is on the year, change the year. If it is on the month or
17942 the day, change that.
17943 With prefix ARG, change by that many units."
17948 "Decrease the date item at the cursor by one.
17949 If the cursor is on the year, change the year. If it is on the month or
17950 the day, change that.
17951 With prefix ARG, change by that many units."
17956 "Increase the date in the time stamp by one day.
17957 With prefix ARG, change that many days."
17965 "Decrease the date in the time stamp by one day.
17966 With prefix ARG, change that many days."
17979 "Determine if the cursor is in or at a timestamp."
18005 ans))
18008 ""
18020 "Change the date in the time stamp at point.
18021 The date will be changed by N times WHAT. WHAT can be `day', `month',
18022 `year', `minute', `second'. If WHAT is not given, the cursor position
18023 in the timestamp determines what will be changed."
18025 with-hm inactive
18026 org-ts-what
18027 extra
18028 ts time time0)
18034 org-display-custom-times
18044 ts)
18072 ;; Try to recenter the calendar window, if any
18078 ;; FIXME: does not yet work for lead times
18080 "Change the different parts of the lead-time and repeat fields in timestamp."
18082 ng h m new)
18083 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18104 new
18106 s))
18109 "If the calendar is visible, recenter it to DATE."
18120 "Go to the Emacs calendar at the current date.
18121 If there is a time stamp in the current line, go to that date.
18122 A prefix ARG can be used to force the current date."
18141 "Return a list (month day year) of date at point in calendar."
18147 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18148 If there is already a time stamp at the cursor position, update it."
18156 ;; Make appt aware of appointments from the agenda
18157 ;;;###autoload
18159 "Activate appointments found in `org-agenda-files'.
18160 When prefixed, prompt for a regular expression and use it as a
18161 filter: only add entries if they match this regular expression.
18163 FILTER can be a string. In this case, use this string as a
18164 regular expression to filter results.
18166 FILTER can also be an alist, with the car of each cell being
18167 either 'headline or 'category. For example:
18172 will only add headlines containing IMPORTANT or headlines
18183 ;; Get all entries which may contain an appt
18188 file today
18191 ;; Map thru entries and find if they pass thru the filter
18204 ;; FIXME: Shall we remove text-properties for the appt text?
18205 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18217 ;;; The clock for measuring work time.
18242 "Start the clock on the current item.
18243 If necessary, clock-out of the currently active clock."
18251 org-clock-in-switch-to-state
18278 "Find the location where the next clock line should be inserted."
18284 first last)
18288 ;; we seem to have a CLOCK drawer, so go there.
18291 ;; Lets count the CLOCK lines
18299 ;; Wrap current entries into a new drawer
18317 ;; Planning info, skip to after it
18329 "Stop the currently running clock.
18330 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18369 "Cancel the running clock be removing the start timestamp."
18383 "Go to the currently clocked-in entry."
18400 "Sum the times for each subtree.
18401 Puts the resulting times in minutes as a text property on each headline."
18405 org-clock-string
18411 ts te dt
18412 time)
18419 ;; Two time stamps
18431 ;; A naket time
18448 "Show subtree times in the entire buffer.
18449 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18450 in the echo area."
18467 ;; Arrange to remove the overlays upon next change.
18477 "Put an overlays on the current line, displaying TIME.
18478 If LEVEL is given, prefix time with a corresponding number of stars.
18479 This creates a new overlay and stores it in `org-clock-overlays', so that it
18480 will be easy to remove."
18484 ov tx)
18503 "Remove the occur highlights from the buffer.
18504 BEG and END are ignored. If NOREMOVE is nil, remove this function
18505 from the `before-change-functions' in the current buffer."
18515 "Clock out if the current entry contains the running clock.
18516 This is used to stop the clock after a TODO entry is marked DONE,
18517 and is only done if the variable `org-clock-out-when-done' is not nil."
18523 org-clock-marker))
18524 ;; Clock out, but don't accept a logging message for this.
18528 org-log-done)))
18535 "Check if the current buffer contains the running clock.
18536 If yes, offer to stop it and to save the buffer with the changes."
18545 "Create a table containing a report about clocked time.
18546 If the cursor is inside an existing clocktable block, then the table
18547 will be updated. If not, a new clocktable will be inserted.
18548 When called with a prefix argument, move to the first clock table in the
18549 buffer and update it."
18560 "Check if the cursor is in a clocktable."
18568 start))))
18571 "If this is a CLOCK line, update it and return t.
18572 Otherwise, return nil."
18581 ts te h m s)
18583 nil
18597 t)))))
18600 "Return two times bordering a special time range.
18601 Key is a symbol specifying the range and can be one of `today', `yesterday',
18602 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18603 A week starts Monday 0:00 and ends Sunday 24:00.
18604 The range is determined relative to TIME. TIME defaults to the current time.
18605 The return value is a cons cell with two internal times like the ones
18606 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18607 the returned times will be formatted strings."
18612 s1 m1 h1 d1 month1 y1 diff ts te fm)
18642 "Write the standard clocktable."
18647 ipos time h m p level hlc hdl maxlevel
18648 ts te cc block beg end pos scope tbl tostring multifile)
18667 ;; Get the right scope
18690 file)
18700 org-clock-file-total-minutes)))))))
18711 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
18730 "Clock summary at ["
18734 "]."
18747 "|"
18748 "*Total time*| "
18771 x))
18772 lines)
18775 ;; FIXME: I don't think anybody uses this, ask David
18777 "Return an internal list with clocking information.
18778 This list has one entry for each CLOCK interval.
18779 FIXME: describe the elements."
18783 rtn beg end next cont level title total closedp leafp
18784 clockpos titlepos h m donep)
18809 total title titlepos level leafp)
18810 rtn)
18814 ;;;; Agenda, and Diary Integration
18816 ;;; Define the Org-agenda-mode
18831 "Mode for time-sorted view on action items in Org-mode files.
18833 The following commands are available:
18839 org-agenda-pending-undo-list nil)
18841 ;; Keep global-font-lock-mode from turning on font-lock-mode
18849 ;; Make sure properties are removed when copying text
18854 buffer-substring-filters)))
18857 org-agenda-show-log nil))
18864 "Restricted to single file"
18876 org-agenda-mode-map global-map)
18978 "--"
18985 "--"
18989 "--"
18994 "--"
18999 "--"
19004 "--"
19021 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19025 "--"
19027 "--"
19037 "--"
19039 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19043 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19047 "--"
19049 "--"
19052 ))
19054 ;;; Agenda undo
19066 "Execute BODY if there is no `org-protected' text property at point."
19072 "Execute BODY while recording undo information in two buffers."
19080 _c1 _c2)
19081 ,@_body
19088 ;; make sure there are undo boundaries
19091 ;; remember which buffer to undo
19093 org-agenda-undo-list)))))
19096 "Undo a remote editing step in the agenda.
19097 This undoes changes both in the agenda buffer and in the remote buffer
19098 that have been changed along."
19104 org-agenda-pending-undo-list org-agenda-undo-list))
19108 buf line cmd rembuf)
19130 "Verify that a real change occurred between the undo lists L1 and L2."
19135 ;;; Agenda dispatch
19143 ;;;###autoload
19145 "Dispatch agenda commands to collect entries to the agenda buffer.
19146 Prompts for a command to execute. Any prefix arg will be passed
19147 on to the selected command. The default selections are:
19149 a Call `org-agenda-list' to display the agenda for current day or week.
19150 t Call `org-todo-list' to display the global todo list.
19151 T Call `org-todo-list' to display the global todo list, select only
19152 entries with a specific TODO keyword (the user gets a prompt).
19153 m Call `org-tags-view' to display headlines with tags matching
19154 a condition (the user is prompted for the condition).
19155 M Like `m', but select only TODO entries, no ordinary headlines.
19156 L Create a timeline for the current buffer.
19157 e Export views to associated files.
19159 More commands can be added by configuring the variable
19160 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19161 searches can be pre-defined in this way.
19163 If the current buffer is in Org-mode and visiting a file, you can also
19164 first press `<' once to indicate that the agenda should be temporarily
19166 Pressing `<' twice means to restrict to the current subtree or region
19167 \(if active)."
19173 ;; normalize different versions
19179 nil)
19183 org-agenda-custom-commands)))
19186 entry key type match lprops ans)
19187 ;; Turn off restriction unless there is an overriding one
19193 ;; Delete old local properties
19195 ;; Remember where this call originated
19201 ;; Estabish the restriction, if any
19218 ;; For example the todo list should not need it (but does...)
19232 current-prefix-arg)))
19284 cmds)))
19287 "The user interface for selecting an agenda command."
19294 restriction second-time
19295 c entry key type match prefixes rmheader header-end custom1 desc)
19302 "
19303 Press key for an agenda command: < Buffer,subtree/region restriction
19304 -------------------------------- > Remove restriction
19305 a Agenda for current week or day e Export agenda views
19306 t List of all TODO entries T Entries with special TODO kwd
19307 m Match a TAGS query M Like m, but only TODO entries
19308 L Timeline for current buffer # List stuck projects (!=configure)
19309 / Multi-occur C Configure custom agenda commands
19314 header start)
19318 header)))
19370 prefix-descriptions))
19372 prefixes))
19383 " (restriction lock active)"
19396 prefixes nil
19402 nil
19404 custom))))
19421 nil)
19441 match ;; The byte compiler incorrectly complains about this. Keep it!
19442 cmd type lprops)
19473 ;;;###autoload
19475 "Run an agenda command in batch mode and send the result to STDOUT.
19476 If CMD-KEY is a string of length 1, it is used as a key in
19477 `org-agenda-custom-commands' and triggers this command. If it is a
19478 longer string is is used as a tags/todo match string.
19479 Paramters are alternating variable names and values that will be bound
19480 before running the agenda command."
19494 string))
19498 ;;;###autoload
19500 "Run an agenda command in batch mode and send the result to STDOUT.
19501 If CMD-KEY is a string of length 1, it is used as a key in
19502 `org-agenda-custom-commands' and triggers this command. If it is a
19503 longer string is is used as a tags/todo match string.
19504 Paramters are alternating variable names and values that will be bound
19505 before running the agenda command.
19507 The output gives a line for each selected agenda item. Each
19508 item is a list of comma-separated values, like this:
19510 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19512 category The category of the item
19513 head The headline, without TODO kwd, TAGS and PRIORITY
19514 type The type of the agenda entry, can be
19515 todo selected in TODO match
19516 tagsmatch selected in tags match
19517 diary imported from diary
19518 deadline a deadline on given date
19519 scheduled scheduled on given date
19520 timestamp entry has timestamp on given date
19521 closed entry was closed on given date
19522 upcoming-deadline warning about deadline
19523 past-scheduled forwarded scheduled item
19524 block entry has date block including g. date
19525 todo The todo keyword, if any
19526 tags All tags including inherited ones, separated by colons
19527 date The relevant date, like 2007-2-14
19528 time The time, like 15:00-16:50
19529 extra Sting with extra planning info
19530 priority-l The priority letter if any was given
19531 priority-n The computed numerical priority
19532 agenda-day The day in the agenda where this is listed"
19544 line)
19554 priority-letter priority agenda-day)
19559 "Make sure all properties on an agenda item have a canonical form,
19560 so the the export commands caneasily use it."
19587 props)
19601 ;;;###autoload
19606 ;; FIXME, why is this a macro?????
19607 ;;;###autoload
19609 "Run all custom agenda commands that have a file argument."
19613 pars cmd thiscmdkey files opts)
19636 "Write the current buffer (an agenda view) as a file.
19637 Depending on the extension of the file name, plain text (.txt),
19638 HTML (.html or .htm) or Postscript (.ps) is produced.
19639 If NOSETTINGS is given, do not scope the settings of
19640 `org-agenda-exporter-settings' into the export commands. This is used when
19641 the settings have already been scoped and we do not wish to overrule other,
19642 higher priority settings."
19658 ;; replace <style> section with org-agenda-export-html-style
19679 "Inhibit read-only for BODY."
19683 "Make sure current buffer is in org-mode. Error if not."
19686 major-mode)))
19689 "Fit the window to the buffer size."
19693 nil
19697 ;;; Agenda file list
19700 "Get the list of agenda files.
19701 Optional UNRESTRICTED means return the full list even if a restriction
19702 is currently in place."
19713 org-agenda-file-regexp)
19715 files)))
19721 files))
19725 "Edit the list of agenda files.
19726 Depending on setup, this either uses customize to edit the variable
19727 `org-agenda-files', or it visits the file that is holding the list. In the
19728 latter case, the buffer is set up in a way that saving it automatically kills
19729 the buffer and restores the previous window configuration."
19748 "Set new value for the agenda file list and save it correcly."
19759 "Read the list of agenda files from a file."
19766 ;;;###autoload
19768 "Cycle through the files in `org-agenda-files'.
19769 If the current buffer visits an agenda file, find the next one in the list.
19770 If the current buffer does not, find the first agenda file."
19775 file)
19787 "Move/add the current file to the top of the agenda file list.
19788 If the file is not present in the list, it is added to the front. If it is
19789 present, it is moved there. With optional argument TO-END, add/move to the
19790 end of the list."
19797 x had)
19810 "Remove current file from the list of files in variable `org-agenda-files'.
19811 These are the files which are being checked for agenda entries.
19812 Optional argument FILE means, use this file instead of the current."
19822 nil x))
19835 "Make sure FILE exists. If not, ask user what to do."
19846 ;;; Agenda prepare and finalize
19891 "Finishing touch for the agenda buffer, called just before displaying it."
19903 org-overriding-columns-format)
19905 org-overriding-columns-format))
19907 org-agenda-view-columns-initially)
19914 "Make highest priority lines bold, and lowest italic."
19921 b e p ov h l)
19925 org-highest-priority)
19927 org-lowest-priority)
19932 ov 'face
19940 "Create buffers for all agenda files, protect archived trees and comments."
19947 bmp file re)
19977 "Function to be called at each match during agenda construction.
19978 If this function returns nil, the current match should not be skipped.
19979 Otherwise, the function must return a position from where the search
19980 should be continued.
19981 This may also be a Lisp form, it will be evaluated.
19982 Never set this variable using `setq' or so, because then it will apply
19983 to all future agenda commands. Instead, bind it with `let' to scope
19984 it dynamically into the agenda-constructing command. A good way to set
19988 "Throw to `:skip' in places that should be skipped.
19989 Also moves point to the end of the skipped region, so that search can
19990 continue from there."
20016 "Return a new agenda marker.
20017 Org-mode keeps a list of these markers and resets them when they are
20018 no longer in use."
20022 m))
20025 "Reset markers created by `org-agenda'. But only if they are old enough."
20028 org-agenda-last-marker-time)
20034 "Get a buffer visiting FILE. If the buffer needs to be created, add
20035 it to the list of buffers which might be released later."
20038 buf ; just return it
20039 ;; Make a new buffer and remember it
20042 buf)))
20045 "Release all buffers in list, asking the user for confirmation when needed.
20046 When a buffer is unmodified, it is just killed. When modified, it is saved
20047 \(if the user agrees) and then killed."
20052 file
20058 "Get the category applying to position POS."
20061 ;;; Agenda timeline
20066 "Show a time-sorted view of the entries in the current org file.
20067 Only entries with a time stamp of today or later will be listed. With
20069 under the current date.
20070 If the buffer contains an active region, only check the region for
20071 dates."
20084 t doclosed ; always include today
20085 org-timeline-show-empty-dates))
20090 args
20091 s e rtn d emptyp)
20097 ;; Remove past dates from the list of dates.
20100 day-numbers))))
20117 dopast
20118 past)
20126 date args)))
20149 "Return a list of all relevant day numbers from BEG to END buffer positions.
20150 If NO-RANGES is non-nil, include only the start and end dates of a range,
20151 not every single day in the range. If FORCE-TODAY is non-nil, make
20152 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20153 inactive time stamps (those in square brackets) are included.
20154 When EMPTY is non-nil, also include days without any entries."
20156 dates dates1 date day day1 day2 ts1 ts2)
20186 dates)))
20188 ;;; Agenda Daily/Weekly
20199 ;;;###autoload
20201 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20202 The view will be for the current day or week, but from the overview buffer
20203 you will be able to go to other days/weeks.
20206 all unfinished TODO items will also be shown, before the agenda.
20207 This feature is considered obsolete, please use the TODO list or a block
20208 agenda instead.
20210 With a numeric prefix argument in an interactive call, the agenda will
20211 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20212 the number of days. NDAYS defaults to `org-agenda-ndays'.
20214 START-DAY defaults to TODAY, or to the most recent match for the weekday
20215 given in `org-agenda-start-on-weekday'."
20226 ;; Convert to an absolute day number
20234 org-agenda-start-on-weekday nil))
20243 sd
20252 s e rtn rtnall file date d start-pos end-pos todayp nd)
20255 ;; Make the list of days
20257 nd ndays)
20270 rtnall nil)
20298 rtnall nil)
20304 file date
20307 file date
20331 rtnall nd todayp))
20354 ;;; Agenda TODO list
20359 ;;;###autoload
20361 "Show all TODO entries from all agenda file in a single list.
20362 The prefix arg can be used to select a specific TODO keyword and limit
20364 for a keyword. A numeric prefix directly selects the Nth keyword in
20365 `org-todo-keywords-1'."
20379 rtn rtnall files file pos)
20389 rtnall nil)
20413 kwds))
20424 ;;; Agenda tags match
20426 ;;;###autoload
20428 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20429 The prefix arg TODO-ONLY limits the search to TODO entries."
20436 rtn rtnall files file pos matcher
20437 buffer)
20446 rtnall nil)
20454 ;; If file does not exist, merror message to agenda
20465 org-agenda-restrict-end)
20490 ;;; Agenda interactive query manipulation
20493 "Non-nil means, query manipulation exits after first change.
20494 When nil, you have to press RET to exit it.
20495 During query selection, you can toggle this flag with `C-c'.
20496 This variable can also have the value `expert'. In this case, the window
20497 displaying the tags menu is not even shown, until you press C-c again."
20505 "Fast query manipulation with single keys.
20506 CURRENT is the current query string, OP is the initial
20508 corresponding keys, possibly with grouping information.
20509 TODO-TABLE is a similar table with TODO keywords, should these
20510 have keys assigned to them. If the keys are nil, a-z are
20511 automatically assigned. Returns the new query string, or nil to
20512 not change the current one."
20517 fulltable)))
20523 tbl char cnt e groups ingroup
20524 tg c2 c c1 ntable rtn)
20553 ;; automatically assign a character.
20623 ;; operators
20628 ;; todos
20633 ;; tags
20668 current))
20671 "Apply an operator to a query string and a tag.
20672 CURRENT is the current query string, OP is the operator, GROUPS is a
20673 list of lists of tags that are mutually exclusive. KIND is 'tag for a
20674 regular tag, or 'todo for a TODO keyword, and TAG is the tag or
20675 keyword string."
20676 ;; If this tag is already in query string, remove it.
20679 ;; When using AND, also remove mutually exclusive tags.
20686 g))))
20687 ;; Decompose current query into q1 (tags) and q2 (TODOs).
20694 ;; It's a TODO; when using AND, drop all other TODOs.
20701 "Return alist of all TODO keywords and their fast keys, in all FILES."
20710 alist k)))))
20711 alist))
20716 ;; if this is not a keyword (:startgroup, etc), ignore it
20718 ;; if keyword already exists, replace char if it's null
20721 ;; if char already exists, prepend keyword but drop char
20725 ;; else, prepend COPY of entry
20728 alist)
20731 "Activate query manipulation with OP as initial operator."
20733 org-tag-alist
20740 "Activate query manipulation, to clear a tag from the string."
20745 "Activate query manipulation, initially using the AND (+) operator."
20750 "Activate query manipulation, initially using the OR (|) operator."
20755 "Activate query manipulation, initially using the NOT (-) operator."
20759 ;;; Agenda Finding stuck projects
20762 "Regular expression used in skipping subtrees for the agenda.
20763 This is basically a temporary global variable that can be set and then
20770 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20771 If yes, it returns the end position of this tree, causing agenda commands
20772 to skip this subtree. This is a function that can be put into
20773 `org-agenda-skip-function' for the duration of a command."
20775 skip)
20781 "Skip entry if any of CONDITIONS is true.
20782 See `org-agenda-skip-if' for details."
20786 "Skip entry if any of CONDITIONS is true.
20787 See `org-agenda-skip-if' for details."
20791 "Checks current entity for CONDITIONS.
20792 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20793 the entry, i.e. the text before the next heading is checked.
20795 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20796 from different tests. Valid conditions are:
20798 scheduled Check if there is a scheduled cookie
20799 notscheduled Check if there is no scheduled cookie
20800 deadline Check if there is a deadline
20801 notdeadline Check if there is no deadline
20802 regexp Check if regexp matches
20803 notregexp Check if regexp does not match.
20805 The regexp is taken from the conditions list, it must come right after
20806 the `regexp' or `notregexp' element.
20808 If any of these conditions is met, this function returns the end point of
20809 the entity, causing the search to continue from there. This is a function
20810 that can be put into `org-agenda-skip-function' for the duration of a command."
20834 end)))
20836 ;;;###autoload
20838 "Create agenda view for projects that are stuck.
20839 Stuck projects are project that have no next actions. For the definitions
20840 of what a project is and how to check if it stuck, customize the variable
20841 `org-stuck-projects'.
20842 MATCH is being ignored."
20845 ;; FIXME: we could have used org-agenda-skip-if here.
20853 org-done-keywords-for-agenda
20855 todo))
20872 gen-re)))))
20883 ;;; Diary integration
20888 "Get the (Emacs Calendar) diary entries for DATE."
20896 entries
20908 ;; No entries
20910 ;; Omit the date and other unnecessary stuff
20912 ;; Add prefix to each line and extend the text properties
20924 ;; Extend the text properties to the beginning of the line
20927 entries)))))
20930 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
20931 This gets rid of the date, the underline under the date, and
20932 the dummy entry installed by `org-mode' to ensure non-empty diary for each
20933 date. It also removes lines that contain only whitespace."
20950 ;; Make sure entries from the diary have the right text properties.
20953 ;; We can rely on the hook, nothing to do
20954 nil
20955 ;; Hook not avaiable, must use advice to make this work
20957 "Make the position visible."
20960 buffer-file-name)
20964 "Add text properties to string, allowing org-mode to act on it."
20967 'keymap org-agenda-keymap
20972 'org-agenda-diary-link t
20976 "Add a dummy entry to the diary.
20977 Needed to avoid empty dates which mess up holiday display."
20978 ;; Catch the error if dealing with the new add-to-diary-alist
20985 ;;;###autoload
20987 "Return diary information from org-files.
20989 It accesses org files and extracts information from those files to be
20990 listed in the diary. The function accepts arguments specifying what
20991 items should be listed. The following arguments are allowed:
20993 :timestamp List the headlines of items containing a date stamp or
20994 date range matching the selected date. Deadlines will
20995 also be listed, on the expiration day.
20997 :sexp List entries resulting from diary-like sexps.
20999 :deadline List any deadlines past due, or due within
21000 `org-deadline-warning-days'. The listing occurs only
21001 in the diary for *today*, not at any other date. If
21002 an entry is marked DONE, it is no longer listed.
21004 :scheduled List all items which are scheduled for the given date.
21005 The diary for *today* also contains items which were
21006 scheduled earlier and are not yet marked DONE.
21008 :todo List all TODO items from the org-file. This may be a
21009 long list - so this is not turned on by default.
21010 Like deadlines, these entries only show up in the
21011 diary for *today*, not at any other date.
21013 The call in the diary file should look like this:
21015 &%%(org-diary) ~/path/to/some/orgfile.org
21017 Use a separate line for each org file to check. Or, if you omit the file name,
21018 all files listed in `org-agenda-files' will be checked automatically:
21020 &%%(org-diary)
21022 If you don't give any arguments (as in the example above), the default
21023 arguments (:deadline :scheduled :timestamp :sexp) are used.
21024 So the example above may also be written as
21026 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21028 The function expects the lisp variables `entry' and `date' to be provided
21029 by the caller, because this is how the calendar works. Don't use this
21030 function from a program - use `org-agenda-get-day-entries' instead."
21038 file rtn results)
21040 ;; If this is called during org-agenda, don't return any entries to
21041 ;; the calendar. Org Agenda will list these entries itself.
21049 ;;; Agenda entry finders
21052 "Does the work for `org-diary' and `org-agenda'.
21053 FILE is the path to a file to be checked for entries. DATE is date like
21054 the one returned by `calendar-current-date'. ARGS are symbols indicating
21055 which kind of entries should be extracted. For details about these, see
21056 the documentation of `org-diary'."
21063 arg results rtn)
21065 ;; If file does not exist, make sure an error message ends up in diary
21075 org-agenda-restrict-end)
21077 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21101 results))))
21117 "Is the cursor inside a date range?"
21132 nil)))
21135 "Return the TODO information for agenda display."
21138 'org-not-done-regexp org-not-done-regexp
21139 'org-todo-regexp org-todo-regexp
21141 'keymap org-agenda-keymap
21142 'help-echo
21145 ;; FIXME: get rid of the \n at some point but watch out
21149 org-todo-regexp
21153 org-not-done-regexp)
21155 marker priority category tags
21156 ee txt beg end)
21195 "Return the date stamp information for agenda display."
21197 'org-not-done-regexp org-not-done-regexp
21198 'org-todo-regexp org-todo-regexp
21200 'keymap org-agenda-keymap
21201 'help-echo
21209 "<%Y-%m-%d"
21223 marker hdmarker deadlinep scheduledp donep tmp priority category
21224 ee txt timestr tags b0 b3 e3 head)
21242 b0)
21249 ;; substring should only run to end of time stamp
21261 nil head category tags timestr nil
21262 remove-re)))
21275 "Return the sexp information for agenda display."
21279 'keymap org-agenda-keymap
21280 'help-echo
21284 marker category ee txt tags entry result beg b sexp sexp-entry)
21316 "Return the logged TODO entries for agenda display."
21318 'org-not-done-regexp org-not-done-regexp
21319 'org-todo-regexp org-todo-regexp
21320 'keymap org-agenda-keymap
21321 'help-echo
21333 marker hdmarker priority category tags closedp
21334 ee txt timestr)
21343 ;; donep (org-entry-is-done-p)
21344 )
21346 ;; substring should only run to end of time stamp
21370 "Return the deadline information for agenda display."
21372 'org-not-done-regexp org-not-done-regexp
21373 'org-todo-regexp org-todo-regexp
21374 'keymap org-agenda-keymap
21375 'help-echo
21381 d2 diff dfrac wdays pos pos1 category tags
21382 ee txt head face s upcomingp donep timestr)
21394 ;; When to show a deadline in the calendar:
21395 ;; If the expiration is within wdays warning time.
21396 ;; Past-due deadlines are only shown on the current date
21424 diff))
21425 head category tags timestr))))
21434 'org-category category
21443 "Return the face to displaying a deadline item.
21444 FRACTION is what fraction of the head-warning time has passed."
21451 "Return the scheduled information for agenda display."
21453 'org-todo-regexp org-todo-regexp
21456 'keymap org-agenda-keymap
21457 'help-echo
21463 d2 diff pos pos1 category tags
21464 ee txt head pastschedp donep face timestr s)
21474 ;; When to show a scheduled item in the calendar:
21475 ;; If it is on or past the date.
21503 head category tags timestr))))
21507 'org-scheduled-previously
21510 'undone-face face
21522 "Return the date-range information for agenda display."
21524 'org-not-done-regexp org-not-done-regexp
21525 'org-todo-regexp org-todo-regexp
21527 'keymap org-agenda-keymap
21528 'help-echo
21533 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21534 donep head)
21546 ;; Only allow days between the limits, because the normal
21547 ;; date stamps will catch the limits.
21564 head category tags
21573 ;; Sort the entries by expiration date.
21576 ;;; Agenda presentation and sorting
21586 "Regular expression to match a plain time or time range.
21587 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21588 groups carry important information:
21589 0 the full match
21590 1 the first time, range or not
21598 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21599 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21600 groups carry important information:
21601 0 the full match
21602 7 hours of duration
21611 "Regular expression to match a timestamp time or time range.
21612 After a match, the following groups carry important information:
21613 0 the full match
21614 1 date plus weekday, for backreferencing to make sure both times on same day
21615 2 the first time, range or not
21619 "A flag, set by `org-compile-prefix-format'.
21622 "A flag, set by `org-compile-prefix-format'.
21626 noprefix remove-re)
21627 "Format TXT to be inserted into the agenda buffer.
21628 In particular, it adds the prefix and corresponding text properties. EXTRA
21629 must be a string and replaces the `%s' specifier in the prefix format.
21630 CATEGORY (string, symbol or nil) may be used to overrule the default
21631 category taken from local variable or file name. It will replace the `%c'
21632 specifier in the format. DOTIME, when non-nil, indicates that a
21633 time-of-day should be extracted from TXT for sorting of this entry, and for
21634 the `%t' specifier in the format. When DOTIME is a string, this string is
21635 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21636 only the correctly processes TXT should be returned - this is used by
21637 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21638 Any match of REMOVE-RE will be removed from TXT."
21640 ;; Diary entries sometimes have extra whitespace at the beginning
21643 org-category
21649 time ; time and tag are needed for the eval of the prefix format
21652 stamp plain s0 s1 s2 rtn srp)
21654 ;; Extract starting and ending time and move them to prefix
21662 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21663 ;; them, we might want to remove them there to avoid duplication.
21664 ;; The user can turn this off with a variable.
21670 t))
21672 ;; Normalize the time(s) to 24 hour
21680 org-agenda-default-appointment-duration))
21681 h)
21686 txt)
21687 ;; Tags are in the string
21690 org-prefix-has-tag))
21695 t t txt))))
21701 ;; Create the final string
21704 ;; Prepare the variables needed in the eval of the compiled format
21710 ;; Evaluate the compiled format
21713 ;; And finally add the text properties
21716 'org-highest-priority org-highest-priority
21717 'org-lowest-priority org-lowest-priority
21719 'time-of-day time-of-day
21720 'txt txt
21721 'time time
21722 'extra extra
21737 list)))
21742 new time)
21744 ;; don't show empty grid
21750 nil string "" nil
21752 new)
21760 "Compile the prefix format into a Lisp form that can be evaluated.
21761 The resulting form is returned and stored in the variable
21762 `org-prefix-format-compiled'."
21766 org-agenda-prefix-format)
21771 varform vars var e c f opt)
21773 s start)
21786 ""
21796 ;; the old format
21804 "Check string S for a time of day.
21805 If found, return it as a military time number between 0 and 2400.
21806 If not found, return nil.
21807 The optional STRING argument forces conversion into a 5 character wide string
21808 HH:MM."
21830 "Sort and concatenate the agenda items."
21833 list
21852 x))
21853 x)))
21856 "Compare the priorities of string A and B."
21864 "Compare the string values of categories of strings A and B."
21872 "Compare the string values of categories of strings A and B."
21882 "Compare the time-of-day values of strings A and B."
21891 "Predicate for sorting agenda entries."
21892 ;; The following variables will be used when the form is evaluated.
21893 ;; So even though the compiler complains, keep them.
21907 ;;; Agenda restriction lock
21925 "Set restriction lock for agenda, to current subtree or file.
21926 Restriction will be the file if TYPE is `file', or if type is the
21927 universal prefix '(4), or if the cursor is before the first headline
21928 in the file. Otherwise, restriction will be to the current subtree."
21960 "Remove the agenda restriction lock."
21974 "If there is any window showing the agenda view, update it."
21983 org-agenda-overriding-restriction)
21986 ;;; Agenda commands
21989 "Check if agenda buffer is of allowed type.
21990 If ERROR is non-nil, throw an error, otherwise just return nil."
21992 t
21995 nil)))
21998 "Exit agenda by removing the window or the buffer."
22005 ;; Maybe restore the pre-agenda window configuration.
22008 org-pre-agenda-window-conf
22012 "Exit agenda by removing the window or the buffer.
22013 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22014 Org-mode buffers visited directly by the user will not be touched."
22028 "Save all Org-mode buffers without user confirmation."
22035 "Rebuild Agenda.
22036 When this is the global TODO list, a prefix argument will be interpreted."
22045 org-agenda-pending-undo-list nil)
22051 "Jump to DATE in agenda."
22056 "Go to today."
22082 "Go forward in time by thee current span.
22083 With prefix ARG, go forward that many times the current span."
22090 greg2 nd)
22112 "Go backward in time by the current span.
22113 With prefix ARG, go backward that many times the current span."
22118 "Switch to daily view for agenda."
22123 "Switch to daily view for agenda."
22128 "Switch to daily view for agenda."
22132 "Switch to daily view for agenda."
22139 "Change the agenda view to SPAN.
22140 SPAN may be `day', `week', `month', `year'."
22145 org-starting-day))
22156 "Compute starting date and number of days for agenda.
22157 SPAN may be `day', `week', `month', `year'. The return value
22158 is a cons cell with the starting date and the number of days,
22159 so that the date SD will be in that range."
22161 nd)
22178 sd)))
22184 sd))))
22187 ;; FIXME: does not work if user makes date format that starts with a blank
22189 "Jump to the next line indicating a date in agenda buffer."
22201 "Jump to the previous line indicating a date in agenda buffer."
22208 ;; Initialize the highlight
22213 "Highlight a region with overlay."
22218 "Detach overlay INDEX."
22221 ;; FIXME this is currently not used.
22230 "Toggle follow mode in an agenda buffer."
22238 "Toggle log mode in an agenda buffer."
22248 "Toggle diary inclusion in an agenda buffer."
22258 "Toggle time grid in an agenda buffer."
22268 "Set the mode name to indicate all the small mode settings."
22287 "Show the priority of the current item.
22288 This priority is composed of the main priority given with the [#A] cookies,
22289 and by additional input from the age of a schedules or deadline entry."
22295 "Show the tags applicable to the current item."
22304 "Go to the Org-mode file which contains the item at point."
22322 "Normal hook run after an item has been shown from the agenda.
22326 "Kill the entry or subtree belonging to the current agenda entry."
22359 "Kill the entry or subtree belonging to the current agenda entry."
22377 "Remove all lines in the agenda that correspond to a given subtree.
22378 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22379 If this information is not given, the function uses the tree at point."
22402 "Follow the link in the current line, if any."
22411 "Get a variable from a referenced buffer and install it here."
22418 "Go to the Org-mode file which contains the item at point."
22435 "Go to the Org-mode file which contains the item at the mouse click."
22441 "Display the Org-mode file which contains the item at point."
22448 "Display the Org-mode file which contains the item at point and recenter."
22456 "Display the Org-mode file which contains the item at the mouse click."
22462 "Check if the entry is a diary link and abort if yes."
22470 "Show the subtree corresponding to the current entry in an indirect buffer.
22471 This calls the command `org-tree-to-indirect-buffer' from the original
22472 Org-mode buffer.
22473 With numerical prefix arg ARG, go up to this level and then take that tree.
22474 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22475 dedicated frame)."
22488 "Marker pointing to the headline that last changed its TODO state
22492 "Switch TODO entry to next sequence."
22497 "Switch TODO entry to previous sequence."
22502 "Cycle TODO state of line at point, also in Org-mode file.
22503 This changes the line at point, all other lines in the agenda referring to
22504 the same tree node, and the headline of the tree node in the Org-mode file."
22514 newhead)
22535 "Change all lines in the agenda buffer which match HDMARKER.
22536 The new content of the line will be NEWHEAD (as modified by
22537 `org-format-agenda-item'). HDMARKER is checked with
22538 `equal' against all `org-hd-marker' text properties in the file.
22539 If FIXFACE is non-nil, the face of each item is modified acording to
22540 the new TODO state."
22542 props m pl undone-face done-face finish new dotime cat tags)
22572 undone-face done-face))))
22580 "Align all tags in agenda items to `org-agenda-tags-column'."
22593 org-agenda-tags-column))
22601 "Increase the priority of line at point, also in Org-mode file."
22606 "Decrease the priority of line at point, also in Org-mode file."
22611 "Set the priority of line at point, also in Org-mode file.
22612 This changes the line at point, all other lines in the agenda referring to
22613 the same tree node, and the headline of the tree node in the Org-mode file."
22622 newhead)
22638 "Get a list of all headline tags applicable at POS.
22639 POS defaults to point. If tags are inherited, the list contains
22640 the targets in the same sequence as the headlines appear, i.e.
22641 the tags of the current headline come last."
22656 tags)))
22660 tags)))
22662 ;; FIXME: should fix the tags property of the agenda line.
22664 "Set tags for the current headline."
22675 newhead)
22693 "Toggle the archive tag for the current entry."
22702 newhead)
22718 "Change the date of this item to one day later."
22737 "Change the date of this item to one day earlier."
22742 "Show new date stamp via text properties."
22743 ;; We use text properties to make this undoable
22752 ;; Use `duplicable' property to trigger undo recording
22767 "Change the date of this item. Date is prompted for, with default today.
22768 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22769 be used to request time specification in the time stamp."
22787 "Schedule the item at point."
22796 ts)
22806 "Schedule the item at point."
22815 ts)
22825 "Return the heading of the current entry, without the stars."
22835 "Start the clock on the currently selected item."
22848 "Stop the currently running clock."
22856 "Cancel the currently running clock."
22864 "Make a diary entry, like the `i' command from the calendar.
22865 All the standard commands work: block, weekly etc."
22881 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
22890 ;; We implement this by hacking the `calendar-cursor-to-date' function
22891 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
22907 "Execute a calendar command from the agenda, with the date associated to
22908 the cursor position."
22917 ;; the following 3 vars are needed in the calendar
22931 "Display the phases of the moon for the 3 months around the cursor date."
22936 "Display the holidays for the 3 months around the cursor date."
22941 "Display sunrise and sunset for the cursor date.
22942 Latitude and longitude can be specified with the variables
22943 `calendar-latitude' and `calendar-longitude'. When called with prefix
22944 argument, latitude and longitude will be prompted for."
22953 "Open the Emacs calendar with the date at the cursor."
22966 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
22967 This is a command that has to be installed in `calendar-mode-map'."
22971 nil))
22977 date s)
23003 ;;;; Embedded LaTeX
23018 "Toggle the minor `org-cdlatex-mode'.
23019 This mode supports entering LaTeX environment and math in LaTeX fragments
23020 in Org-mode.
23022 nil " OCDL" nil
23027 "Always return t in org-mode buffers.
23028 This is because we want to insert math symbols without dollars even outside
23029 the LaTeX math segments. If Orgmode thinks that point is actually inside
23030 en embedded LaTeX fragement, let texmathp do its job.
23047 "Unconditionally turn on `org-cdlatex-mode'."
23051 "Test if point is inside a LaTeX fragment.
23053 sequence appearing also before point.
23054 Even though the matchers for math are configurable, this function assumes
23056 delimiters are skipped when they have been removed by customization.
23057 The return value is nil, or a cons cell with the delimiter and
23058 and the position of this delimiter.
23060 This function does a reasonably good job, but can locally be fooled by
23061 for example currency specifications. For example it will assume being in
23063 fragments that are properly closed, but during editing, we have to live
23064 with the uncertainty caused by missing closing delimiters. This function
23065 looks only before point, not after."
23084 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23088 ;; count $$
23096 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23097 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23098 - inside a LaTeX fragment, or
23099 - after the first word in a line, where an abbreviation expansion could
23100 insert a LaTeX environment."
23113 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23114 Revert to the normal definition outside of these fragments."
23122 "Execute `cdlatex-math-modify' in LaTeX fragments.
23123 Revert to the normal definition outside of these fragments."
23135 "Remove all overlays with LaTeX fragment images in current buffer."
23140 "Preview the LaTeX fragment at point, or all locally or globally.
23141 If the cursor is in a LaTeX fragment, create the image and overlay
23142 it over the source code. If there is no fragment at point, display
23143 all fragments in the current text, from one headline to the next. With
23144 prefix SUBTREE, display all fragments in the current subtree. With a
23145 double prefix `C-u C-u', or when the cursor is before the first headline,
23146 display all fragments in the buffer.
23176 buffer-file-name)))
23182 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23183 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23184 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23191 "Replace LaTeX fragments with links to an image, and produce images."
23200 m n block linkfile movefile ov)
23201 ;; Check if there are old images files with this prefix, and remove them
23205 todir 'full
23207 ;; Check the different regular expressions
23227 txt movefile opt forbuffer)
23235 ov 'end-glyph
23238 ov 'display
23245 ;; This function borrows from Ganesh Swami's latex2png.el
23249 temporary-file-directory))
23278 "-D" dpi
23279 ;;"-x" scale "-y" scale
23281 "-o" pngfile
23282 dvifile)
23285 ;; Use the requested file name and clean up
23289 pngfile))))
23292 "Return an rgb color specification for dvipng."
23298 "Return string to be used as color value for an RGB component."
23301 ;;;; Exporting
23303 ;;; Variables, constants, and parameter plists
23359 "Return the property list with default settings for the export variables."
23363 rtn))
23366 "Return the property list with file-local settings for export."
23373 p key val text options)
23406 o)
23410 options)
23414 p))))
23420 val)))
23421 dir))
23428 rtn line level)
23433 ;; Beginning of a COMMENT subtree. Skip it.
23439 ;; an ordinary comment line
23440 )
23446 ;; a special table line that should be removed
23447 )
23454 \[v] limit export to visible part of outline tree
23456 \[a] export as ASCII
23458 \[h] export as HTML
23459 \[H] export as HTML to temporary buffer
23460 \[R] export region as HTML
23461 \[b] export as HTML and browse immediately
23462 \[x] export as XOXO
23464 \[l] export as LaTeX
23465 \[L] export as LaTeX to temporary buffer
23467 \[i] export current file as iCalendar file
23468 \[I] export all agenda files as iCalendar files
23469 \[c] export agenda files into combined iCalendar file
23471 \[F] publish current file
23472 \[P] publish current project
23473 \[X] publish... (project will be prompted for)
23493 r1 r2 ass)
23796 )
23797 "Entities for TeX->HTML translation.
23801 The list contains HTML entities for Latin-1, Greek and other symbols.
23802 It is supplemented by a number of commonly used TeX macros with appropriate
23805 ;;; General functions for all backends
23808 "Cleanup a buffer STRING so that links can be created safely."
23826 a b xx
23827 rtn p)
23831 ;; Remove license-to-kill stuff
23839 ;; Get the correct stuff before the first headline
23850 ;; Get rid of archived trees
23862 ;; Get rid of drawers
23867 'identity
23875 ;; Find targets in comments and move them out of comments,
23876 ;; but mark them as targets that should be invisible
23881 ;; Protect backend specific stuff, throw away the others.
23886 fmt)
23917 ;; Protect quoted subtrees
23925 ;; Protect verbatim elements
23932 ;; Remove subtrees that are commented
23938 ;; Remove special table lines
23950 ;; Specific LaTeX stuff
23958 ;; Specific HTML stuff
23960 ;; Convert LaTeX fragments to images
23965 org-current-export-file)))
23969 ;; Remove or replace comments
23978 ;; Find matches for radio targets and turn them into internal links
23985 ;; Find all links that contain a newline and put them into a single line
23987 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
23993 ;; Normalize links: Convert angle and plain links into bracket links
23994 ;; Expand link abbreviations
24001 ;; added 'org-link face to links
24017 "]"
24025 ;; Find multiline emphasis and put them into single line
24039 rtn))
24042 "Get a title for the current document, from looking at the buffer."
24048 ;; Mark the line so that it will not be exported as normal text.
24052 ;; Return the title string
24056 "Return subtree title and exclude it from export."
24062 ;; This is a subtree, we take the title from the first heading
24069 title))
24072 "Take link text and make a safe target out of it."
24076 'identity
24082 "Get the minimum level in LINES."
24090 ;; Variable holding the vector with section numbers
24094 "Initialize the vector for the section numbers."
24111 "Return a string with the current section number.
24112 When LEVEL is non-nil, increase section numbers on that level."
24134 string))
24136 ;;; ASCII export
24144 "Export the outline as a pretty ASCII file.
24145 If there is an active region, export only the region.
24146 The prefix ARG specifies how many levels of the outline should become
24147 underlined headlines. The default is 3."
24176 filename))
24192 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24201 region
24202 :for-ascii t
24203 :skip-before-1st-heading
24206 :verbatim-multiline t
24207 :archived-trees
24211 thetoc have-headings first-heading-pos
24212 table-open table-buffer)
24230 ;; create local variables for all options, to make sure all called
24231 ;; functions get the correct information
24235 org-export-plist-vars)
24238 org-export-headline-levels))
24241 umax))
24243 ;; File header
24247 org-export-author-info)
24269 line)
24270 ;; This is a headline
24276 todo
24280 org-done-keywords)))
24281 ; TODO, not DONE
24285 line lines level))))
24292 t t txt)))
24297 txt))
24312 thetoc)
24314 ))))
24315 lines)
24320 ;; Remove the quoted HTML tags.
24322 ;; Remove targets
24325 ;; Replace internal links
24329 t nil line)))
24334 ;; a Headline
24343 ;; New table starts
24345 ;; Accumulate lines
24366 ;; insert the table of contents
24378 ;; Convert whitespace place holders
24388 ;; remove display and invisible chars
24404 "Do extra work for ASCII export"
24414 "Search the subtree below LINE for any TODO entries."
24417 line lv todo)
24425 org-done-keywords))))
24426 ; TODO, not DONE
24431 "Handle quoted HTML for ASCII export."
24434 ;; We just remove the tags for now.
24436 line)
24439 "Insert the string S centered and underline it with character UNDERLINE."
24448 "Insert a new level in ASCII export."
24454 org-export-ascii-bullets))
24456 ;; find the indentation of the next non-empty line
24477 "Create a copy of the visible part of the current buffer, and export it.
24478 The copy is created in a temporary buffer and removed after use.
24479 TYPE is the final key (as a string) that also select the export command in
24480 the `C-c C-e' export dispatcher.
24481 As a special case, if the you type SPC at the prompt, the temporary
24482 org-mode file will not be removed but presented to you so that you can
24483 continue to use it. The prefix arg ARG is passed through to the exporting
24484 command."
24487 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24489 current-prefix-arg))
24504 s e)
24505 ;; Need to hack the drawers here.
24521 ;; Copy all comment lines to the end, to make sure #+ settings are
24522 ;; still available for the second export step. Kind of a hack, but
24523 ;; does do the trick.
24544 s))
24549 s))
24551 ;;; HTML export
24554 "Return a string with current options as keyword options.
24555 Does include HTML export options as well as TODO and CATEGORY stuff."
24557 "#+TITLE: %s
24558 #+AUTHOR: %s
24559 #+EMAIL: %s
24560 #+LANGUAGE: %s
24561 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24562 #+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
24563 #+CATEGORY: %s
24564 #+SEQ_TODO: %s
24565 #+TYP_TODO: %s
24566 #+PRIORITIES: %c %c %c
24567 #+DRAWERS: %s
24568 #+STARTUP: %s %s %s %s %s
24569 #+TAGS: %s
24570 #+ARCHIVE: %s
24571 #+LINK: %s
24572 "
24574 org-export-headline-levels
24575 org-export-with-section-numbers
24576 org-export-with-toc
24577 org-export-preserve-breaks
24578 org-export-html-expand
24579 org-export-with-fixed-width
24580 org-export-with-tables
24581 org-export-with-sub-superscripts
24582 org-export-with-special-strings
24583 org-export-with-footnotes
24584 org-export-with-emphasize
24585 org-export-with-TeX-macros
24586 org-export-with-LaTeX-fragments
24587 org-export-skip-text-before-1st-heading
24588 org-export-with-drawers
24589 org-export-with-tags
24591 "TODO FEEDBACK VERIFY DONE"
24592 "Me Jason Marie DONE"
24593 org-highest-priority org-lowest-priority org-default-priority
24612 org-archive-location
24613 "org file:~/org/%s.org"
24614 ))
24617 "Insert into the buffer a template with information for exporting."
24626 "Toggle the fixed-width export.
24627 If there is no active region, the QUOTE keyword at the current headline is
24628 inserted or removed. When present, it causes the text between this headline
24629 and the next to be exported as fixed-width text, and unmodified.
24630 If there is an active region, this command adds or removes a colon as the
24631 first character of this line. If the first character of a line is a colon,
24632 this line is also exported in fixed-width font."
24641 off)
24671 "Export the outline as HTML and immediately open it with a browser.
24672 If there is an active region, export only the region.
24673 The prefix ARG specifies how many levels of the outline should become
24674 headlines. The default is 3. Lower levels will become bulleted lists."
24680 "Call `org-export-as-html', may be used in batch processing as
24681 emacs --batch
24682 --load=$HOME/lib/emacs/org.el
24684 --visit=MyFile --funcall org-export-as-html-batch"
24688 "Call `org-exort-as-html` with output to a temporary buffer.
24689 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24695 "Assume the current region has org-mode syntax, and convert it to HTML.
24696 This can be used in any buffer. For example, you could write an
24697 itemized list in org-mode syntax in an HTML buffer and then use this
24698 command to convert it."
24718 "Convert region from BEG to END in org-mode buffer to HTML.
24719 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24720 contents, and only produce the region of converted text, useful for
24721 cut-and-paste operations.
24722 If BUFFER is a buffer or a string, use/create that buffer as a target
24723 of the converted HTML. If BUFFER is the symbol `string', return the
24724 produced HTML as a string and leave not buffer behind. For example,
24725 a Lisp program could call this function in the following way:
24727 (setq html (org-export-region-as-html beg end t 'string))
24729 When called interactively, the output buffer is selected, and shown
24730 in a window. A non-interactive call will only retunr the buffer."
24735 rtn)
24740 nil nil nil
24741 buffer body-only))
24745 rtn)))
24749 to-buffer body-only)
24750 "Export the outline as a pretty HTML file.
24751 If there is an active region, export only the region. The prefix
24752 ARG specifies how many levels of the outline should become
24753 headlines. The default is 3. Lower levels will become bulleted
24754 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24755 EXT-PLIST is a property list with external parameters overriding
24756 org-mode's default settings, but still inferior to file-local
24757 settings. When TO-BUFFER is non-nil, create a buffer with that
24758 name and export to that buffer. If TO-BUFFER is the symbol `string',
24759 don't leave any buffer behind but just return the resulting HTML as
24760 a string. When BODY-ONLY is set, don't produce the file header and footer,
24761 simply return the content of <body>...</body>, without even
24762 the body tags themselves."
24765 ;; Make sure we have a file name when we need it.
24771 buffer-file-name))
24780 ext-plist
24785 valid thetoc have-headings first-heading-pos
24794 ;; The following two are dynamically scoped into other
24795 ;; routines below.
24814 default-directory))
24848 buffer-file-coding-system))
24850 coding-system))
24852 coding-system))
24864 region
24865 :emph-multiline t
24866 :for-html t
24867 :skip-before-1st-heading
24870 :archived-trees
24872 :add-text
24874 :LaTeX-fragments
24877 table-open type
24878 table-buffer table-orig-buffer
24879 ind start-is-num starter didclose
24880 rpl path desc descp desc1 desc2 link
24881 )
24900 ;; Get the language-dependent settings
24904 ;; Switch to the output buffer
24914 ;; create local variables for all options, to make sure all called
24915 ;; functions get the correct information
24919 org-export-plist-vars)
24921 org-export-headline-levels))
24924 umax))
24926 ;; File header
24932 <head>
24933 <title>%s</title>
24938 %s
24939 </head><body>
24940 "
24953 org-export-html-toplevel-hlevel
24955 org-export-html-toplevel-hlevel)
24956 thetoc)
24961 ;; This is a headline
24970 todo
24974 org-done-keywords)))
24975 ; TODO, not DONE
24979 line lines level))))
25004 ;; Check for targets
25009 t t line))
25012 target-alist))
25023 )))
25024 line)
25025 lines))
25037 ;; end of quote section?
25041 ;; inside a quote section?
25046 ;; verbatim lines
25060 ;; Protected HTML
25075 ;; Horizontal line
25080 ;; make targets to anchors
25088 t t line)))
25092 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25093 t t line)))
25099 t t line)))))
25103 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25104 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25105 ;; Also handle sub_superscripts and checkboxes
25109 ;; Format the links
25119 ;; Make an image out of the description if that is so wanted
25125 ;; FIXME: do we need to unescape here somewhere?
25135 ;; standard URL, just check if we need to inline an image
25143 ;; standard URL
25147 ;; FILE link
25150 thefile file-is-image-p search)
25158 t))
25167 ;; make sure this is can be used as target search
25192 ;; TODO items
25200 org-done-keywords)
25205 ;; Does this contain a reference to a footnote?
25217 t t line))))))
25221 ;; This is a headline
25229 ;; Close any local lists before inserting a new header line
25235 in-local-list nil))
25239 head-count)
25240 ;; QUOTES
25248 ;; New table starts
25250 ;; Accumulate lines
25262 ;; Normal lines
25265 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25266 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25269 line)
25276 ;; empty line. Pretend indentation is large.
25278 0
25294 ;; Start new (level of) list
25301 ;; continue current list
25305 ;; we did close a list, normal text follows: need <p>
25311 "<b>[X]</b>"
25313 t t line))))
25315 ;; Empty lines start a new paragraph. If hand-formatted lists
25316 ;; are not fully interpreted, lines starting with "-", "+", "*"
25317 ;; also start a new paragraph.
25320 ;; Is this the start of a footnote?
25326 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25328 ;; Check if the line break needs to be conserved
25337 ;; Properly close all local lists and other lists
25340 ;; Close any local lists before inserting a new header line
25346 in-local-list nil))
25349 head-count)
25380 ;; insert the table of contents
25397 ;; remove empty paragraphs and lists
25404 ;; Convert whitespace place holders
25425 "Format a table for ascii export."
25429 ;; Table made by table.el - test for spanning
25430 lines
25432 ;; A normal org table
25433 ;; Get rid of hlines at beginning and end
25439 ;; Check if the table has a marking column. If yes remove the
25440 ;; column and the special lines
25442 ;; Get rid of the vertical lines except for grouping
25444 rtn line vl1 start)
25466 vl))
25469 "Find out which HTML converter to use and return the HTML code."
25473 ;; A normal org table
25475 ;; Table made by table.el - test for spanning
25479 nil))
25480 lines)))
25486 hlines))))
25489 ;; We can use my own converter with HTML conversions
25491 ;; Need to use the code generator in table.el, with the original text.
25495 "Format a table into HTML."
25496 ;; Get rid of hlines at beginning and end
25502 ;; Check if the table has a marking column. If yes remove the
25503 ;; column and the special lines
25511 tbopen line fields html gr colgropen)
25523 ;; ignore this line
25525 ;; Break the line into fields
25543 html)))
25548 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25564 html)
25570 "Check if the table has a marking column.
25571 If yes remove the column and the special lines."
25577 lines))
25592 nil)
25594 lines)))
25608 nil)
25613 ;; remove the first column
25615 lines))))
25618 "Format a table generated by table.el into HTML.
25619 This conversion does *not* use `table-generate-source' from table.el.
25620 This has the advantage that Org-mode's HTML conversions can be used.
25621 But it has the disadvantage, that no cell- or row-spanning is allowed."
25624 fields html empty)
25634 html
25636 html
25637 "<tr>"
25650 ;; Ignore this line
25652 ;; Break the line into fields and store the fields
25658 field-buffer))
25661 html))
25664 "Format a table into html, using `table-generate-source' from table.el.
25665 This has the advantage that cell- or row-spanning is allowed.
25666 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25681 "Format time stamps in string S, or remove them."
25686 ;; never export CLOCK
25701 ;; Line break if line started and ended with time stamp stuff
25703 s
25707 r))))
25710 ;; convert & to &, < to < and > to >
25719 s)
25722 "Remove tags and time staps from lines going into the toc."
25731 t t s)))
25732 s)
25735 "Prepare STRING for HTML export. Applies all active conversions.
25736 If there are links in the string, don't modify these."
25739 m s l res)
25750 "Apply all active conversions to translate special ASCII to HTML."
25771 t t s))
25773 s)
25776 "Create a regular expression which will match a balanced sexp.
25777 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25778 as single character strings.
25779 The regexp returned will match the entire expression including the
25780 delimiters. It will also define a single group which contains the
25781 match except for the outermost delimiters. The maximum depth of
25782 stacked delimiters is N. Escaping delimiters is not possible."
25818 "Convert special characters in STRING to HTML."
25820 e a re rpl start)
25827 string))
25830 "Convert sub- and superscripts in STRING to HTML."
25846 t t string)))))
25849 string))
25852 "Apply emphasis."
25859 rpl
25865 org-emphasis-alist))
25870 string))
25874 "Insert <p>, but first close previous paragraph if any."
25879 "Close paragraph if there is one open."
25884 "Close <li> if necessary."
25890 "Insert a new level in HTML export.
25891 When TITLE is nil, just close all open levels."
25901 ;; If title is nil, this means this function is called to close
25902 ;; all levels, so the rest is done only if title is given
25914 t t title)))
25930 level level head-count title level))
25935 "Terminate one level in HTML export."
25941 ;;; iCalendar export
25943 ;;;###autoload
25945 "Export current file as an iCalendar file.
25946 The iCalendar file will be located in the same directory as the Org-mode
25947 file, but with extension `.ics'."
25951 ;;;###autoload
25953 "Export all files in `org-agenda-files' to iCalendar .ics files.
25954 Each iCalendar file will be located in the same directory as the Org-mode
25955 file, but with extension `.ics'."
25959 ;;;###autoload
25961 "Export all files in `org-agenda-files' to a single combined iCalendar file.
25962 The file is stored under the name `org-combined-agenda-icalendar-file'."
25967 "Create iCalendar files for all elements of FILES.
25968 If COMBINE is non-nil, combine all calendar entries into a single large
25969 file and store it under the name `org-combined-agenda-icalendar-file'."
25974 org-export-publishing-directory)))
25975 file ical-file ical-buffer category started org-agenda-new-buffers)
25981 org-combined-agenda-icalendar-file
26014 "Hook run after an iCalendar file has been saved.
26015 The iCalendar buffer is still current when this hook is run.
26016 A good way to use this is to tell a desktop calenndar application to re-read
26020 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26021 When COMBINE is non nil, add the category to each line."
26028 scheduledp deadlinep tmp pri category entry location summary desc
26038 inc t
26045 t org-icalendar-include-body)
26055 pos)
26060 ts)
26063 ;; donep (org-entry-is-done-p)
26064 ))
26083 t t summary)))
26090 %s
26091 %s%s
26092 SUMMARY:%s%s%s
26093 CATEGORIES:%s
26097 rrule summary
26102 category)))))
26107 ;; Get all the literal sexps
26133 )
26140 t org-icalendar-include-body)
26146 t t hd)))
26156 %s
26157 SUMMARY:%s%s%s
26158 CATEGORIES:%s
26159 SEQUENCE:1
26160 PRIORITY:%d
26161 STATUS:%s
26163 dts
26169 category pri status)))))))))
26172 "Take out stuff and quote what needs to be quoted.
26173 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26174 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26175 characters."
26177 nil
26196 s))
26199 "Clean-up description string."
26205 "Start an iCalendar file by inserting the header."
26211 VERSION:2.0
26212 X-WR-CALNAME:%s
26213 PRODID:-//%s//Emacs with Org-mode//EN
26214 X-WR-TIMEZONE:%s
26218 "Finish an iCalendar file by inserting the END statement."
26222 "Take a time string S and convert it to iCalendar format.
26223 KEYWORD is added in front, to make a complete line like DTSTART....
26224 When INC is non-nil, increase the hour by two (if time string contains
26225 a time), or the day by one (if it does not contain a time)."
26227 t2 fmt have-time time)
26243 ;;; XOXO export
26251 "Export the org buffer as XOXO.
26252 The XOXO buffer is named *xoxo-<source buffer name>*"
26254 ;; A quickie abstraction
26256 ;; Output everything as XOXO
26270 ;; Check the output buffer is empty.
26272 ;; Kick off the output
26289 ;; Handle level rendering
26306 )
26310 ;; And output the new li
26316 ;; Finally finish off the ol
26323 ;; Finish the buffer off and clean it up.
26328 )))
26331 ;;;; Key bindings
26333 ;; Make `C-c C-x' a prefix key
26336 ;; TAB key with modifiers
26343 ;; The following line is necessary under Suse GNU/Linux
26349 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26350 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26351 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26353 ;; Cursor keys with modifiers
26354 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26355 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26356 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26357 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26359 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26360 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26361 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26362 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26364 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26365 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26366 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26367 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26369 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26370 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26372 ;;; Extra keys for tty access.
26373 ;; We only set them when really needed because otherwise the
26374 ;; menus don't show the simple keys
26376 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26377 (not window-system))
26378 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26379 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26380 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26381 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26382 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26383 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26384 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26385 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26386 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26387 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26388 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26389 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26390 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26391 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26392 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26393 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26394 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26395 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26396 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26397 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26398 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26399 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26401 ;; All the other keys
26403 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26404 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26405 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26406 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26407 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26408 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26409 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26410 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26411 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26412 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26413 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26414 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26415 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26416 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26417 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26419 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26420 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26421 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26422 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26423 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26424 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26425 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26426 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26427 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26428 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26429 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26430 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26431 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26432 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26433 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26434 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26435 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26437 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26438 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26439 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26440 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26441 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26442 (org-defkey org-mode-map "\C-c^" 'org-sort)
26443 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26444 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26445 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26446 (org-defkey org-mode-map "\C-m" 'org-return)
26447 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26448 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26449 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26450 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26451 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26452 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26453 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26454 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26455 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26456 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26457 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26458 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26459 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26460 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26461 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26462 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26463 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26465 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26466 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26467 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26468 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26470 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26471 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26472 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26473 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26474 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26475 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26476 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26477 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26478 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26479 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26480 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26481 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26483 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26485 (when (featurep 'xemacs)
26486 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26488 (defsubst org-table-p () (org-at-table-p))
26490 (defun org-self-insert-command (N)
26491 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26492 If the cursor is in a table looking at whitespace, the whitespace is
26493 overwritten, and the table is not marked as requiring realignment."
26494 (interactive "p")
26495 (if (and (org-table-p)
26496 (progn
26497 ;; check if we blank the field, and if that triggers align
26498 (and org-table-auto-blank-field
26499 (member last-command
26500 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26502 ;; got extra space, this field does not determine column width
26503 (let (org-table-may-need-update) (org-table-blank-field))
26504 ;; no extra space, this field may determine column width
26505 (org-table-blank-field)))
26506 t)
26507 (eq N 1)
26509 (let (org-table-may-need-update)
26510 (goto-char (1- (match-end 0)))
26511 (delete-backward-char 1)
26512 (goto-char (match-beginning 0))
26513 (self-insert-command N))
26514 (setq org-table-may-need-update t)
26515 (self-insert-command N)
26516 (org-fix-tags-on-the-fly)))
26518 (defun org-fix-tags-on-the-fly ()
26519 (when (and (equal (char-after (point-at-bol)) ?*)
26520 (org-on-heading-p))
26521 (org-align-tags-here org-tags-column)))
26523 (defun org-delete-backward-char (N)
26524 "Like `delete-backward-char', insert whitespace at field end in tables.
26525 When deleting backwards, in tables this function will insert whitespace in
26527 still be marked for re-alignment if the field did fill the entire column,
26528 because, in this case the deletion might narrow the column."
26529 (interactive "p")
26530 (if (and (org-table-p)
26531 (eq N 1)
26532 (string-match "|" (buffer-substring (point-at-bol) (point)))
26533 (looking-at ".*?|"))
26534 (let ((pos (point))
26536 (c org-table-may-need-update))
26537 (backward-delete-char N)
26538 (skip-chars-forward "^|")
26539 (insert " ")
26540 (goto-char (1- pos))
26541 ;; noalign: if there were two spaces at the end, this field
26542 ;; does not determine the width of the column.
26543 (if noalign (setq org-table-may-need-update c)))
26544 (backward-delete-char N)
26545 (org-fix-tags-on-the-fly)))
26547 (defun org-delete-char (N)
26548 "Like `delete-char', but insert whitespace at field end in tables.
26549 When deleting characters, in tables this function will insert whitespace in
26551 still be marked for re-alignment if the field did fill the entire column,
26552 because, in this case the deletion might narrow the column."
26553 (interactive "p")
26554 (if (and (org-table-p)
26555 (not (bolp))
26556 (not (= (char-after) ?|))
26557 (eq N 1))
26558 (if (looking-at ".*?|")
26559 (let ((pos (point))
26561 (c org-table-may-need-update))
26562 (replace-match (concat
26563 (substring (match-string 0) 1 -1)
26564 " |"))
26565 (goto-char pos)
26566 ;; noalign: if there were two spaces at the end, this field
26567 ;; does not determine the width of the column.
26568 (if noalign (setq org-table-may-need-update c)))
26569 (delete-char N))
26570 (delete-char N)
26571 (org-fix-tags-on-the-fly)))
26573 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26574 (put 'org-self-insert-command 'delete-selection t)
26575 (put 'orgtbl-self-insert-command 'delete-selection t)
26576 (put 'org-delete-char 'delete-selection 'supersede)
26577 (put 'org-delete-backward-char 'delete-selection 'supersede)
26579 ;; Make `flyspell-mode' delay after some commands
26580 (put 'org-self-insert-command 'flyspell-delayed t)
26581 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26582 (put 'org-delete-char 'flyspell-delayed t)
26583 (put 'org-delete-backward-char 'flyspell-delayed t)
26585 ;; Make pabbrev-mode expand after org-mode commands
26586 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26587 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26589 ;; How to do this: Measure non-white length of current string
26590 ;; If equal to column width, we should realign.
26592 (defun org-remap (map &rest commands)
26593 "In MAP, remap the functions given in COMMANDS.
26594 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26595 (let (new old)
26596 (while commands
26597 (setq old (pop commands) new (pop commands))
26598 (if (fboundp 'command-remapping)
26599 (org-defkey map (vector 'remap old) new)
26600 (substitute-key-definition old new map global-map)))))
26602 (when (eq org-enable-table-editor 'optimized)
26603 ;; If the user wants maximum table support, we need to hijack
26604 ;; some standard editing functions
26605 (org-remap org-mode-map
26606 'self-insert-command 'org-self-insert-command
26607 'delete-char 'org-delete-char
26608 'delete-backward-char 'org-delete-backward-char)
26609 (org-defkey org-mode-map "|" 'org-force-self-insert))
26611 (defun org-shiftcursor-error ()
26612 "Throw an error because Shift-Cursor command was applied in wrong context."
26613 (error "This command is active in special context like tables, headlines or timestamps"))
26615 (defun org-shifttab (&optional arg)
26616 "Global visibility cycling or move to previous table field.
26617 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26618 on context.
26619 See the individual commands for more information."
26620 (interactive "P")
26621 (cond
26622 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26623 (arg (message "Content view to level: ")
26624 (org-content (prefix-numeric-value arg))
26625 (setq org-cycle-global-status 'overview))
26626 (t (call-interactively 'org-global-cycle))))
26628 (defun org-shiftmetaleft ()
26629 "Promote subtree or delete table column.
26630 Calls `org-promote-subtree', `org-outdent-item',
26631 or `org-table-delete-column', depending on context.
26632 See the individual commands for more information."
26633 (interactive)
26634 (cond
26635 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26636 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26637 ((org-at-item-p) (call-interactively 'org-outdent-item))
26638 (t (org-shiftcursor-error))))
26640 (defun org-shiftmetaright ()
26641 "Demote subtree or insert table column.
26642 Calls `org-demote-subtree', `org-indent-item',
26643 or `org-table-insert-column', depending on context.
26644 See the individual commands for more information."
26645 (interactive)
26646 (cond
26647 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26648 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26649 ((org-at-item-p) (call-interactively 'org-indent-item))
26650 (t (org-shiftcursor-error))))
26652 (defun org-shiftmetaup (&optional arg)
26653 "Move subtree up or kill table row.
26654 Calls `org-move-subtree-up' or `org-table-kill-row' or
26655 `org-move-item-up' depending on context. See the individual commands
26656 for more information."
26657 (interactive "P")
26658 (cond
26659 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26660 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26661 ((org-at-item-p) (call-interactively 'org-move-item-up))
26662 (t (org-shiftcursor-error))))
26663 (defun org-shiftmetadown (&optional arg)
26664 "Move subtree down or insert table row.
26665 Calls `org-move-subtree-down' or `org-table-insert-row' or
26666 `org-move-item-down', depending on context. See the individual
26667 commands for more information."
26668 (interactive "P")
26669 (cond
26670 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26671 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26672 ((org-at-item-p) (call-interactively 'org-move-item-down))
26673 (t (org-shiftcursor-error))))
26675 (defun org-metaleft (&optional arg)
26676 "Promote heading or move table column to left.
26677 Calls `org-do-promote' or `org-table-move-column', depending on context.
26678 With no specific context, calls the Emacs default `backward-word'.
26679 See the individual commands for more information."
26680 (interactive "P")
26681 (cond
26682 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26683 ((or (org-on-heading-p) (org-region-active-p))
26684 (call-interactively 'org-do-promote))
26685 ((org-at-item-p) (call-interactively 'org-outdent-item))
26686 (t (call-interactively 'backward-word))))
26688 (defun org-metaright (&optional arg)
26689 "Demote subtree or move table column to right.
26690 Calls `org-do-demote' or `org-table-move-column', depending on context.
26691 With no specific context, calls the Emacs default `forward-word'.
26692 See the individual commands for more information."
26693 (interactive "P")
26694 (cond
26695 ((org-at-table-p) (call-interactively 'org-table-move-column))
26696 ((or (org-on-heading-p) (org-region-active-p))
26697 (call-interactively 'org-do-demote))
26698 ((org-at-item-p) (call-interactively 'org-indent-item))
26699 (t (call-interactively 'forward-word))))
26701 (defun org-metaup (&optional arg)
26702 "Move subtree up or move table row up.
26703 Calls `org-move-subtree-up' or `org-table-move-row' or
26704 `org-move-item-up', depending on context. See the individual commands
26705 for more information."
26706 (interactive "P")
26707 (cond
26708 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26709 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26710 ((org-at-item-p) (call-interactively 'org-move-item-up))
26711 (t (transpose-lines 1) (beginning-of-line -1))))
26713 (defun org-metadown (&optional arg)
26714 "Move subtree down or move table row down.
26715 Calls `org-move-subtree-down' or `org-table-move-row' or
26716 `org-move-item-down', depending on context. See the individual
26717 commands for more information."
26718 (interactive "P")
26719 (cond
26720 ((org-at-table-p) (call-interactively 'org-table-move-row))
26721 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26722 ((org-at-item-p) (call-interactively 'org-move-item-down))
26723 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26725 (defun org-shiftup (&optional arg)
26726 "Increase item in timestamp or increase priority of current headline.
26727 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26728 depending on context. See the individual commands for more information."
26729 (interactive "P")
26730 (cond
26731 ((org-at-timestamp-p t)
26732 (call-interactively (if org-edit-timestamp-down-means-later
26733 'org-timestamp-down 'org-timestamp-up)))
26734 ((org-on-heading-p) (call-interactively 'org-priority-up))
26735 ((org-at-item-p) (call-interactively 'org-previous-item))
26736 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26738 (defun org-shiftdown (&optional arg)
26739 "Decrease item in timestamp or decrease priority of current headline.
26740 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26741 depending on context. See the individual commands for more information."
26742 (interactive "P")
26743 (cond
26744 ((org-at-timestamp-p t)
26745 (call-interactively (if org-edit-timestamp-down-means-later
26746 'org-timestamp-up 'org-timestamp-down)))
26747 ((org-on-heading-p) (call-interactively 'org-priority-down))
26748 (t (call-interactively 'org-next-item))))
26750 (defun org-shiftright ()
26751 "Next TODO keyword or timestamp one day later, depending on context."
26752 (interactive)
26753 (cond
26754 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26755 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26756 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26757 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26758 (t (org-shiftcursor-error))))
26760 (defun org-shiftleft ()
26761 "Previous TODO keyword or timestamp one day earlier, depending on context."
26762 (interactive)
26763 (cond
26764 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26765 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26766 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26767 ((org-at-property-p)
26768 (call-interactively 'org-property-previous-allowed-value))
26769 (t (org-shiftcursor-error))))
26771 (defun org-shiftcontrolright ()
26772 "Switch to next TODO set."
26773 (interactive)
26774 (cond
26775 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26776 (t (org-shiftcursor-error))))
26778 (defun org-shiftcontrolleft ()
26779 "Switch to previous TODO set."
26780 (interactive)
26781 (cond
26782 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26783 (t (org-shiftcursor-error))))
26785 (defun org-ctrl-c-ret ()
26786 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26787 (interactive)
26788 (cond
26789 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26790 (t (call-interactively 'org-insert-heading))))
26792 (defun org-copy-special ()
26793 "Copy region in table or copy current subtree.
26794 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26795 See the individual commands for more information."
26796 (interactive)
26797 (call-interactively
26798 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26800 (defun org-cut-special ()
26801 "Cut region in table or cut current subtree.
26802 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26803 See the individual commands for more information."
26804 (interactive)
26805 (call-interactively
26806 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26808 (defun org-paste-special (arg)
26809 "Paste rectangular region into table, or past subtree relative to level.
26810 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26811 See the individual commands for more information."
26812 (interactive "P")
26813 (if (org-at-table-p)
26814 (org-table-paste-rectangle)
26815 (org-paste-subtree arg)))
26817 (defun org-ctrl-c-ctrl-c (&optional arg)
26818 "Set tags in headline, or update according to changed information at point.
26820 This command does many different things, depending on context:
26822 - If the cursor is in a headline, prompt for tags and insert them
26823 into the current line, aligned to `org-tags-column'. When called
26824 with prefix arg, realign all tags in the current buffer.
26826 - If the cursor is in one of the special #+KEYWORD lines, this
26827 triggers scanning the buffer for these lines and updating the
26828 information.
26830 - If the cursor is inside a table, realign the table. This command
26831 works even if the automatic table editor has been turned off.
26833 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26834 the entire table.
26836 - If the cursor is a the beginning of a dynamic block, update it.
26838 - If the cursor is inside a table created by the table.el package,
26839 activate that table.
26841 - If the current buffer is a remember buffer, close note and file it.
26842 with a prefix argument, file it without further interaction to the default
26843 location.
26845 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26846 links in this buffer.
26848 - If the cursor is on a numbered item in a plain list, renumber the
26849 ordered list.
26851 - If the cursor is on a checkbox, toggle it."
26852 (interactive "P")
26853 (let ((org-enable-table-editor t))
26854 (cond
26855 ((or org-clock-overlays
26856 org-occur-highlights
26857 org-latex-fragment-image-overlays)
26858 (org-remove-clock-overlays)
26859 (org-remove-occur-highlights)
26860 (org-remove-latex-fragment-image-overlays)
26861 (message "Temporary highlights/overlays removed from current buffer"))
26862 ((and (local-variable-p 'org-finish-function (current-buffer))
26863 (fboundp org-finish-function))
26864 (funcall org-finish-function))
26865 ((org-at-property-p)
26866 (call-interactively 'org-property-action))
26867 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
26868 ((org-on-heading-p) (call-interactively 'org-set-tags))
26869 ((org-at-table.el-p)
26870 (require 'table)
26871 (beginning-of-line 1)
26872 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
26873 (call-interactively 'table-recognize-table))
26874 ((org-at-table-p)
26875 (org-table-maybe-eval-formula)
26876 (if arg
26877 (call-interactively 'org-table-recalculate)
26878 (org-table-maybe-recalculate-line))
26879 (call-interactively 'org-table-align))
26880 ((org-at-item-checkbox-p)
26881 (call-interactively 'org-toggle-checkbox))
26882 ((org-at-item-p)
26883 (call-interactively 'org-maybe-renumber-ordered-list))
26885 ;; Dynamic block
26886 (beginning-of-line 1)
26887 (org-update-dblock))
26889 (cond
26890 ((equal (match-string 1) "TBLFM")
26891 ;; Recalculate the table before this line
26892 (save-excursion
26893 (beginning-of-line 1)
26895 (if (org-at-table-p)
26896 (org-call-with-arg 'org-table-recalculate t))))
26897 (t
26898 (call-interactively 'org-mode-restart))))
26899 (t (error "C-c C-c can do nothing useful at this location.")))))
26901 (defun org-mode-restart ()
26902 "Restart Org-mode, to scan again for special lines.
26903 Also updates the keyword regular expressions."
26904 (interactive)
26905 (let ((org-inhibit-startup t)) (org-mode))
26906 (message "Org-mode restarted to refresh keyword and special line setup"))
26908 (defun org-kill-note-or-show-branches ()
26909 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
26910 (interactive)
26911 (if (not org-finish-function)
26912 (call-interactively 'show-branches)
26913 (let ((org-note-abort t))
26914 (funcall org-finish-function))))
26916 (defun org-return (&optional indent)
26917 "Goto next table row or insert a newline.
26918 Calls `org-table-next-row' or `newline', depending on context.
26919 See the individual commands for more information."
26920 (interactive)
26921 (cond
26922 ((bobp) (if indent (newline-and-indent) (newline)))
26923 ((org-at-table-p)
26924 (org-table-justify-field-maybe)
26925 (call-interactively 'org-table-next-row))
26926 (t (if indent (newline-and-indent) (newline)))))
26928 (defun org-return-indent ()
26929 (interactive)
26930 "Goto next table row or insert a newline and indent.
26931 Calls `org-table-next-row' or `newline-and-indent', depending on
26932 context. See the individual commands for more information."
26933 (org-return t))
26935 (defun org-ctrl-c-minus ()
26936 "Insert separator line in table or modify bullet type in list.
26937 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
26938 depending on context."
26939 (interactive)
26940 (cond
26941 ((org-at-table-p)
26942 (call-interactively 'org-table-insert-hline))
26943 ((org-on-heading-p)
26944 ;; Convert to item
26945 (save-excursion
26946 (beginning-of-line 1)
26948 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
26949 ((org-in-item-p)
26950 (call-interactively 'org-cycle-list-bullet))
26951 (t (error "`C-c -' does have no function here."))))
26953 (defun org-meta-return (&optional arg)
26954 "Insert a new heading or wrap a region in a table.
26955 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
26956 See the individual commands for more information."
26957 (interactive "P")
26958 (cond
26959 ((org-at-table-p)
26960 (call-interactively 'org-table-wrap-region))
26961 (t (call-interactively 'org-insert-heading))))
26963 ;;; Menu entries
26965 ;; Define the Org-mode menus
26966 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
26967 '("Tbl"
26968 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
26969 ["Next Field" org-cycle (org-at-table-p)]
26970 ["Previous Field" org-shifttab (org-at-table-p)]
26971 ["Next Row" org-return (org-at-table-p)]
26972 "--"
26973 ["Blank Field" org-table-blank-field (org-at-table-p)]
26974 ["Edit Field" org-table-edit-field (org-at-table-p)]
26975 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
26976 "--"
26977 ("Column"
26978 ["Move Column Left" org-metaleft (org-at-table-p)]
26979 ["Move Column Right" org-metaright (org-at-table-p)]
26980 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
26981 ["Insert Column" org-shiftmetaright (org-at-table-p)])
26982 ("Row"
26983 ["Move Row Up" org-metaup (org-at-table-p)]
26984 ["Move Row Down" org-metadown (org-at-table-p)]
26985 ["Delete Row" org-shiftmetaup (org-at-table-p)]
26986 ["Insert Row" org-shiftmetadown (org-at-table-p)]
26987 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
26988 "--"
26989 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
26990 ("Rectangle"
26991 ["Copy Rectangle" org-copy-special (org-at-table-p)]
26992 ["Cut Rectangle" org-cut-special (org-at-table-p)]
26993 ["Paste Rectangle" org-paste-special (org-at-table-p)]
26994 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
26995 "--"
26996 ("Calculate"
26997 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
26998 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
26999 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27000 "--"
27001 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27002 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27003 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27004 "--"
27005 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27006 "--"
27007 ["Sum Column/Rectangle" org-table-sum
27008 (or (org-at-table-p) (org-region-active-p))]
27009 ["Which Column?" org-table-current-column (org-at-table-p)])
27010 ["Debug Formulas"
27011 org-table-toggle-formula-debugger
27012 :style toggle :selected org-table-formula-debug]
27013 ["Show Col/Row Numbers"
27014 org-table-toggle-coordinate-overlays
27015 :style toggle :selected org-table-overlay-coordinates]
27016 "--"
27017 ["Create" org-table-create (and (not (org-at-table-p))
27018 org-enable-table-editor)]
27019 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27020 ["Import from File" org-table-import (not (org-at-table-p))]
27021 ["Export to File" org-table-export (org-at-table-p)]
27022 "--"
27023 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27025 (easy-menu-define org-org-menu org-mode-map "Org menu"
27026 '("Org"
27027 ("Show/Hide"
27028 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27029 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27030 ["Sparse Tree" org-occur t]
27031 ["Reveal Context" org-reveal t]
27032 ["Show All" show-all t]
27033 "--"
27034 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27035 "--"
27036 ["New Heading" org-insert-heading t]
27037 ("Navigate Headings"
27038 ["Up" outline-up-heading t]
27039 ["Next" outline-next-visible-heading t]
27040 ["Previous" outline-previous-visible-heading t]
27041 ["Next Same Level" outline-forward-same-level t]
27042 ["Previous Same Level" outline-backward-same-level t]
27043 "--"
27044 ["Jump" org-goto t])
27045 ("Edit Structure"
27046 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27047 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27048 "--"
27049 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27050 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27051 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27052 "--"
27053 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27054 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27055 ["Demote Heading" org-metaright (not (org-at-table-p))]
27056 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27057 "--"
27058 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27059 "--"
27060 ["Convert to odd levels" org-convert-to-odd-levels t]
27061 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27062 ("Editing"
27063 ["Emphasis..." org-emphasize t])
27064 ("Archive"
27065 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27066 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27067 ; :active t :keys "C-u C-c C-x C-a"]
27068 ["Sparse trees open ARCHIVE trees"
27069 (setq org-sparse-tree-open-archived-trees
27070 (not org-sparse-tree-open-archived-trees))
27071 :style toggle :selected org-sparse-tree-open-archived-trees]
27072 ["Cycling opens ARCHIVE trees"
27073 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27074 :style toggle :selected org-cycle-open-archived-trees]
27075 ["Agenda includes ARCHIVE trees"
27076 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27077 :style toggle :selected (not org-agenda-skip-archived-trees)]
27078 "--"
27079 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27080 ; ["Check and Move Children" (org-archive-subtree '(4))
27081 ; :active t :keys "C-u C-c C-x C-s"]
27082 )
27083 "--"
27084 ("TODO Lists"
27085 ["TODO/DONE/-" org-todo t]
27086 ("Select keyword"
27087 ["Next keyword" org-shiftright (org-on-heading-p)]
27088 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27089 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27090 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27091 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27092 ["Show TODO Tree" org-show-todo-tree t]
27093 ["Global TODO list" org-todo-list t]
27094 "--"
27095 ["Set Priority" org-priority t]
27096 ["Priority Up" org-shiftup t]
27097 ["Priority Down" org-shiftdown t])
27098 ("TAGS and Properties"
27099 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27100 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27101 "--"
27102 ["Set property" 'org-set-property t]
27103 ["Column view of properties" org-columns t]
27104 ["Insert Column View DBlock" org-insert-columns-dblock t])
27105 ("Dates and Scheduling"
27106 ["Timestamp" org-time-stamp t]
27107 ["Timestamp (inactive)" org-time-stamp-inactive t]
27108 ("Change Date"
27109 ["1 Day Later" org-shiftright t]
27110 ["1 Day Earlier" org-shiftleft t]
27111 ["1 ... Later" org-shiftup t]
27112 ["1 ... Earlier" org-shiftdown t])
27113 ["Compute Time Range" org-evaluate-time-range t]
27114 ["Schedule Item" org-schedule t]
27115 ["Deadline" org-deadline t]
27116 "--"
27117 ["Custom time format" org-toggle-time-stamp-overlays
27118 :style radio :selected org-display-custom-times]
27119 "--"
27120 ["Goto Calendar" org-goto-calendar t]
27121 ["Date from Calendar" org-date-from-calendar t])
27122 ("Logging work"
27123 ["Clock in" org-clock-in t]
27124 ["Clock out" org-clock-out t]
27125 ["Clock cancel" org-clock-cancel t]
27126 ["Goto running clock" org-clock-goto t]
27127 ["Display times" org-clock-display t]
27128 ["Create clock table" org-clock-report t]
27129 "--"
27130 ["Record DONE time"
27131 (progn (setq org-log-done (not org-log-done))
27132 (message "Switching to %s will %s record a timestamp"
27133 (car org-done-keywords)
27134 (if org-log-done "automatically" "not")))
27135 :style toggle :selected org-log-done])
27136 "--"
27137 ["Agenda Command..." org-agenda t]
27138 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27139 ("File List for Agenda")
27140 ("Special views current file"
27141 ["TODO Tree" org-show-todo-tree t]
27142 ["Check Deadlines" org-check-deadlines t]
27143 ["Timeline" org-timeline t]
27144 ["Tags Tree" org-tags-sparse-tree t])
27145 "--"
27146 ("Hyperlinks"
27147 ["Store Link (Global)" org-store-link t]
27148 ["Insert Link" org-insert-link t]
27149 ["Follow Link" org-open-at-point t]
27150 "--"
27151 ["Next link" org-next-link t]
27152 ["Previous link" org-previous-link t]
27153 "--"
27154 ["Descriptive Links"
27155 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27156 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27157 ["Literal Links"
27158 (progn
27159 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27160 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27161 "--"
27162 ["Export/Publish..." org-export t]
27163 ("LaTeX"
27164 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27165 :selected org-cdlatex-mode]
27166 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27167 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27168 ["Modify math symbol" org-cdlatex-math-modify
27169 (org-inside-LaTeX-fragment-p)]
27170 ["Export LaTeX fragments as images"
27171 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27172 :style toggle :selected org-export-with-LaTeX-fragments])
27173 "--"
27174 ("Documentation"
27175 ["Show Version" org-version t]
27176 ["Info Documentation" org-info t])
27177 ("Customize"
27178 ["Browse Org Group" org-customize t]
27179 "--"
27180 ["Expand This Menu" org-create-customize-menu
27181 (fboundp 'customize-menu-create)])
27182 "--"
27183 ["Refresh setup" org-mode-restart t]
27184 ))
27186 (defun org-info (&optional node)
27187 "Read documentation for Org-mode in the info system.
27188 With optional NODE, go directly to that node."
27189 (interactive)
27190 (require 'info)
27191 (Info-goto-node (format "(org)%s" (or node ""))))
27193 (defun org-install-agenda-files-menu ()
27194 (let ((bl (buffer-list)))
27195 (save-excursion
27196 (while bl
27197 (set-buffer (pop bl))
27198 (if (org-mode-p) (setq bl nil)))
27199 (when (org-mode-p)
27200 (easy-menu-change
27201 '("Org") "File List for Agenda"
27202 (append
27203 (list
27204 ["Edit File List" (org-edit-agenda-file-list) t]
27205 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27206 ["Remove Current File from List" org-remove-file t]
27207 ["Cycle through agenda files" org-cycle-agenda-files t]
27208 ["Occur in all agenda files" org-occur-in-agenda-files t]
27209 "--")
27210 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27212 ;;;; Documentation
27214 (defun org-customize ()
27215 "Call the customize function with org as argument."
27216 (interactive)
27217 (customize-browse 'org))
27219 (defun org-create-customize-menu ()
27220 "Create a full customization menu for Org-mode, insert it into the menu."
27221 (interactive)
27222 (if (fboundp 'customize-menu-create)
27223 (progn
27224 (easy-menu-change
27225 '("Org") "Customize"
27226 `(["Browse Org group" org-customize t]
27227 "--"
27228 ,(customize-menu-create 'org)
27229 ["Set" Custom-set t]
27230 ["Save" Custom-save t]
27231 ["Reset to Current" Custom-reset-current t]
27232 ["Reset to Saved" Custom-reset-saved t]
27233 ["Reset to Standard Settings" Custom-reset-standard t]))
27235 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27237 ;;;; Miscellaneous stuff
27240 ;;; Generally useful functions
27242 (defun org-context ()
27243 "Return a list of contexts of the current cursor position.
27244 If several contexts apply, all are returned.
27245 Each context entry is a list with a symbol naming the context, and
27246 two positions indicating start and end of the context. Possible
27247 contexts are:
27249 :headline anywhere in a headline
27250 :headline-stars on the leading stars in a headline
27251 :todo-keyword on a TODO keyword (including DONE) in a headline
27252 :tags on the TAGS in a headline
27253 :priority on the priority cookie in a headline
27254 :item on the first line of a plain list item
27255 :item-bullet on the bullet/number of a plain list item
27256 :checkbox on the checkbox in a plain list item
27257 :table in an org-mode table
27258 :table-special on a special filed in a table
27259 :table-table in a table.el table
27260 :link on a hyperlink
27261 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27262 :target on a <<target>>
27263 :radio-target on a <<<radio-target>>>
27264 :latex-fragment on a LaTeX fragment
27265 :latex-preview on a LaTeX fragment with overlayed preview image
27267 This function expects the position to be visible because it uses font-lock
27268 faces as a help to recognize the following contexts: :table-special, :link,
27269 and :keyword."
27270 (let* ((f (get-text-property (point) 'face))
27271 (faces (if (listp f) f (list f)))
27272 (p (point)) clist o)
27273 ;; First the large context
27274 (cond
27275 ((org-on-heading-p t)
27276 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27277 (when (progn
27278 (beginning-of-line 1)
27279 (looking-at org-todo-line-tags-regexp))
27280 (push (org-point-in-group p 1 :headline-stars) clist)
27281 (push (org-point-in-group p 2 :todo-keyword) clist)
27282 (push (org-point-in-group p 4 :tags) clist))
27283 (goto-char p)
27286 (push (org-point-in-group p 0 :priority) clist)))
27288 ((org-at-item-p)
27289 (push (org-point-in-group p 2 :item-bullet) clist)
27290 (push (list :item (point-at-bol)
27291 (save-excursion (org-end-of-item) (point)))
27292 clist)
27293 (and (org-at-item-checkbox-p)
27294 (push (org-point-in-group p 0 :checkbox) clist)))
27296 ((org-at-table-p)
27297 (push (list :table (org-table-begin) (org-table-end)) clist)
27298 (if (memq 'org-formula faces)
27299 (push (list :table-special
27300 (previous-single-property-change p 'face)
27301 (next-single-property-change p 'face)) clist)))
27302 ((org-at-table-p 'any)
27303 (push (list :table-table) clist)))
27304 (goto-char p)
27306 ;; Now the small context
27307 (cond
27308 ((org-at-timestamp-p)
27309 (push (org-point-in-group p 0 :timestamp) clist))
27310 ((memq 'org-link faces)
27311 (push (list :link
27312 (previous-single-property-change p 'face)
27313 (next-single-property-change p 'face)) clist))
27314 ((memq 'org-special-keyword faces)
27315 (push (list :keyword
27316 (previous-single-property-change p 'face)
27317 (next-single-property-change p 'face)) clist))
27318 ((org-on-target-p)
27319 (push (org-point-in-group p 0 :target) clist)
27320 (goto-char (1- (match-beginning 0)))
27321 (if (looking-at org-radio-target-regexp)
27322 (push (org-point-in-group p 0 :radio-target) clist))
27323 (goto-char p))
27324 ((setq o (car (delq nil
27325 (mapcar
27326 (lambda (x)
27327 (if (memq x org-latex-fragment-image-overlays) x))
27328 (org-overlays-at (point))))))
27329 (push (list :latex-fragment
27330 (org-overlay-start o) (org-overlay-end o)) clist)
27331 (push (list :latex-preview
27332 (org-overlay-start o) (org-overlay-end o)) clist))
27333 ((org-inside-LaTeX-fragment-p)
27334 ;; FIXME: positions wrong.
27335 (push (list :latex-fragment (point) (point)) clist)))
27337 (setq clist (nreverse (delq nil clist)))
27338 clist))
27340 ;; FIXME: Compare with at-regexp-p Do we need both?
27341 (defun org-in-regexp (re &optional nlines visually)
27342 "Check if point is inside a match of regexp.
27343 Normally only the current line is checked, but you can include NLINES extra
27344 lines both before and after point into the search.
27345 If VISUALLY is set, require that the cursor is not after the match but
27346 really on, so that the block visually is on the match."
27347 (catch 'exit
27348 (let ((pos (point))
27349 (eol (point-at-eol (+ 1 (or nlines 0))))
27350 (inc (if visually 1 0)))
27351 (save-excursion
27352 (beginning-of-line (- 1 (or nlines 0)))
27353 (while (re-search-forward re eol t)
27354 (if (and (<= (match-beginning 0) pos)
27355 (>= (+ inc (match-end 0)) pos))
27356 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27358 (defun org-at-regexp-p (regexp)
27359 "Is point inside a match of REGEXP in the current line?"
27360 (catch 'exit
27361 (save-excursion
27362 (let ((pos (point)) (end (point-at-eol)))
27363 (beginning-of-line 1)
27364 (while (re-search-forward regexp end t)
27365 (if (and (<= (match-beginning 0) pos)
27366 (>= (match-end 0) pos))
27367 (throw 'exit t)))
27368 nil))))
27370 (defun org-occur-in-agenda-files (regexp &optional nlines)
27371 "Call `multi-occur' with buffers for all agenda files."
27373 (let* ((files (org-agenda-files))
27374 (tnames (mapcar 'file-truename files))
27375 (extra org-agenda-multi-occur-extra-files)
27376 f)
27377 (while (setq f (pop extra))
27378 (unless (member (file-truename f) tnames)
27379 (add-to-list 'files f 'append)
27380 (add-to-list 'tnames (file-truename f) 'append)))
27381 (multi-occur
27382 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27383 regexp)))
27385 (defun org-uniquify (list)
27386 "Remove duplicate elements from LIST."
27387 (let (res)
27388 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27389 res))
27391 (defun org-delete-all (elts list)
27392 "Remove all elements in ELTS from LIST."
27393 (while elts
27394 (setq list (delete (pop elts) list)))
27395 list)
27397 (defun org-back-over-empty-lines ()
27398 "Move backwards over witespace, to the beginning of the first empty line.
27399 Returns the number o empty lines passed."
27400 (let ((pos (point)))
27402 (beginning-of-line 2)
27403 (count-lines (point) pos)))
27405 (defun org-skip-whitespace ()
27408 (defun org-point-in-group (point group &optional context)
27409 "Check if POINT is in match-group GROUP.
27410 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27411 match. If the match group does ot exist or point is not inside it,
27412 return nil."
27413 (and (match-beginning group)
27414 (>= point (match-beginning group))
27415 (<= point (match-end group))
27416 (if context
27417 (list context (match-beginning group) (match-end group))
27418 t)))
27420 (defun org-switch-to-buffer-other-window (&rest args)
27421 "Switch to buffer in a second window on the current frame.
27422 In particular, do not allow pop-up frames."
27423 (let (pop-up-frames special-display-buffer-names special-display-regexps
27424 special-display-function)
27425 (apply 'switch-to-buffer-other-window args)))
27427 (defun org-combine-plists (&rest plists)
27428 "Create a single property list from all plists in PLISTS.
27429 The process starts by copying the first list, and then setting properties
27430 from the other lists. Settings in the last list are the most significant
27431 ones and overrule settings in the other lists."
27432 (let ((rtn (copy-sequence (pop plists)))
27433 p v ls)
27434 (while plists
27435 (setq ls (pop plists))
27436 (while ls
27437 (setq p (pop ls) v (pop ls))
27438 (setq rtn (plist-put rtn p v))))
27439 rtn))
27441 (defun org-move-line-down (arg)
27442 "Move the current line down. With prefix argument, move it past ARG lines."
27443 (interactive "p")
27444 (let ((col (current-column))
27445 beg end pos)
27446 (beginning-of-line 1) (setq beg (point))
27447 (beginning-of-line 2) (setq end (point))
27448 (beginning-of-line (+ 1 arg))
27449 (setq pos (move-marker (make-marker) (point)))
27450 (insert (delete-and-extract-region beg end))
27451 (goto-char pos)
27452 (move-to-column col)))
27454 (defun org-move-line-up (arg)
27455 "Move the current line up. With prefix argument, move it past ARG lines."
27456 (interactive "p")
27457 (let ((col (current-column))
27458 beg end pos)
27459 (beginning-of-line 1) (setq beg (point))
27460 (beginning-of-line 2) (setq end (point))
27461 (beginning-of-line (- arg))
27462 (setq pos (move-marker (make-marker) (point)))
27463 (insert (delete-and-extract-region beg end))
27464 (goto-char pos)
27465 (move-to-column col)))
27467 (defun org-replace-escapes (string table)
27468 "Replace %-escapes in STRING with values in TABLE.
27470 The sequences in STRING may contain normal field width and padding information,
27472 so values can contain further %-escapes if they are define later in TABLE."
27473 (let ((case-fold-search nil)
27474 e re rpl)
27475 (while (setq e (pop table))
27476 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27477 (while (string-match re string)
27478 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27479 (cdr e)))
27480 (setq string (replace-match rpl t t string))))
27481 string))
27484 (defun org-sublist (list start end)
27485 "Return a section of LIST, from START to END.
27486 Counting starts at 1."
27487 (let (rtn (c start))
27488 (setq list (nthcdr (1- start) list))
27489 (while (and list (<= c end))
27490 (push (pop list) rtn)
27491 (setq c (1+ c)))
27492 (nreverse rtn)))
27494 (defun org-find-base-buffer-visiting (file)
27495 "Like `find-buffer-visiting' but alway return the base buffer and
27496 not an indirect buffer"
27497 (let ((buf (find-buffer-visiting file)))
27498 (if buf
27499 (or (buffer-base-buffer buf) buf)
27500 nil)))
27502 (defun org-image-file-name-regexp ()
27503 "Return regexp matching the file names of images."
27504 (if (fboundp 'image-file-name-regexp)
27505 (image-file-name-regexp)
27506 (let ((image-file-name-extensions
27507 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27508 "xbm" "xpm" "pbm" "pgm" "ppm")))
27510 (regexp-opt (nconc (mapcar 'upcase
27511 image-file-name-extensions)
27512 image-file-name-extensions)
27513 t)
27516 (defun org-file-image-p (file)
27517 "Return non-nil if FILE is an image."
27518 (save-match-data
27519 (string-match (org-image-file-name-regexp) file)))
27521 ;;; Paragraph filling stuff.
27522 ;; We want this to be just right, so use the full arsenal.
27524 (defun org-indent-line-function ()
27525 "Indent line like previous, but further if previous was headline or item."
27526 (interactive)
27527 (let* ((pos (point))
27528 (itemp (org-at-item-p))
27529 column bpos bcol tpos tcol bullet btype bullet-type)
27530 ;; Find the previous relevant line
27531 (beginning-of-line 1)
27532 (cond
27533 ((looking-at "#") (setq column 0))
27535 (t
27536 (beginning-of-line 0)
27538 (beginning-of-line 0))
27539 (cond
27541 (goto-char (match-end 0))
27542 (setq column (current-column)))
27543 ((org-in-item-p)
27544 (org-beginning-of-item)
27547 (setq bpos (match-beginning 1) tpos (match-end 0)
27548 bcol (progn (goto-char bpos) (current-column))
27549 tcol (progn (goto-char tpos) (current-column))
27550 bullet (match-string 1)
27551 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27552 (if (not itemp)
27553 (setq column tcol)
27554 (goto-char pos)
27555 (beginning-of-line 1)
27557 (progn
27559 (setq bullet (match-string 1)
27560 btype (if (string-match "[0-9]" bullet) "n" bullet))
27561 (setq column (if (equal btype bullet-type) bcol tcol)))
27562 (setq column (org-get-indentation)))))
27563 (t (setq column (org-get-indentation))))))
27564 (goto-char pos)
27565 (if (<= (current-column) (current-indentation))
27566 (indent-line-to column)
27567 (save-excursion (indent-line-to column)))
27568 (setq column (current-column))
27569 (beginning-of-line 1)
27570 (if (looking-at
27573 (match-string 2) (match-string 3)))
27574 t nil))
27575 (move-to-column column)))
27577 (defun org-set-autofill-regexps ()
27578 (interactive)
27579 ;; In the paragraph separator we include headlines, because filling
27580 ;; text in a line directly attached to a headline would otherwise
27581 ;; fill the headline as well.
27584 ;; The paragraph starter includes hand-formatted lists.
27585 (org-set-local 'paragraph-start
27587 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27588 ;; But only if the user has not turned off tables or fixed-width regions
27589 (org-set-local
27590 'auto-fill-inhibit-regexp
27593 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27594 (concat
27596 (if org-enable-table-editor "|" "")
27597 (if org-enable-fixed-width-editor ":" "")
27598 "]"))))
27599 ;; We use our own fill-paragraph function, to make sure that tables
27600 ;; and fixed-width regions are not wrapped. That function will pass
27601 ;; through to `fill-paragraph' when appropriate.
27602 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27603 ; Adaptive filling: To get full control, first make sure that
27604 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27606 (org-set-local 'adaptive-fill-function
27607 'org-adaptive-fill-function))
27609 (defun org-fill-paragraph (&optional justify)
27610 "Re-align a table, pass through to fill-paragraph if no table."
27611 (let ((table-p (org-at-table-p))
27612 (table.el-p (org-at-table.el-p)))
27613 (cond ((and (equal (char-after (point-at-bol)) ?*)
27614 (save-excursion (goto-char (point-at-bol))
27615 (looking-at outline-regexp)))
27616 t) ; skip headlines
27617 (table.el-p t) ; skip table.el tables
27618 (table-p (org-table-align) t) ; align org-mode tables
27619 (t nil)))) ; call paragraph-fill
27621 ;; For reference, this is the default value of adaptive-fill-regexp
27624 (defun org-adaptive-fill-function ()
27625 "Return a fill prefix for org-mode files.
27626 In particular, this makes sure hanging paragraphs for hand-formatted lists
27627 work correctly."
27629 (match-string 0))
27631 (save-excursion
27632 (goto-char (match-end 0))
27633 (make-string (current-column) ?\ )))
27634 (t nil)))
27636 ;;;; Functions extending outline functionality
27638 (defun org-beginning-of-line (&optional arg)
27639 "Go to the beginning of the current line. If that is invisible, continue
27640 to a visible line beginning. This makes the function of C-a more intuitive.
27641 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27642 first attempt, and only move to after the tags when the cursor is already
27643 beyond the end of the headline."
27644 (interactive "P")
27645 (let ((pos (point)))
27646 (beginning-of-line 1)
27647 (if (bobp)
27648 nil
27649 (backward-char 1)
27650 (if (org-invisible-p)
27651 (while (and (not (bobp)) (org-invisible-p))
27652 (backward-char 1)
27653 (beginning-of-line 1))
27654 (forward-char 1)))
27655 (when org-special-ctrl-a/e
27656 (cond
27657 ((and (looking-at org-todo-line-regexp)
27658 (= (char-after (match-end 1)) ?\ ))
27659 (goto-char
27660 (if (eq org-special-ctrl-a/e t)
27661 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27662 ((= pos (point)) (match-beginning 3))
27663 (t (point)))
27664 (cond ((> pos (point)) (point))
27665 ((not (eq last-command this-command)) (point))
27666 (t (match-beginning 3))))))
27667 ((org-at-item-p)
27668 (goto-char
27669 (if (eq org-special-ctrl-a/e t)
27670 (cond ((> pos (match-end 4)) (match-end 4))
27671 ((= pos (point)) (match-end 4))
27672 (t (point)))
27673 (cond ((> pos (point)) (point))
27674 ((not (eq last-command this-command)) (point))
27675 (t (match-end 4))))))))))
27677 (defun org-end-of-line (&optional arg)
27678 "Go to the end of the line.
27679 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27680 first attempt, and only move to after the tags when the cursor is already
27681 beyond the end of the headline."
27682 (interactive "P")
27683 (if (or (not org-special-ctrl-a/e)
27684 (not (org-on-heading-p)))
27685 (end-of-line arg)
27686 (let ((pos (point)))
27687 (beginning-of-line 1)
27689 (if (eq org-special-ctrl-a/e t)
27690 (if (or (< pos (match-beginning 1))
27691 (= pos (match-end 0)))
27692 (goto-char (match-beginning 1))
27693 (goto-char (match-end 0)))
27694 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27695 (goto-char (match-end 0))
27696 (goto-char (match-beginning 1))))
27697 (end-of-line arg)))))
27699 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27700 (define-key org-mode-map "\C-e" 'org-end-of-line)
27702 (defun org-invisible-p ()
27703 "Check if point is at a character currently not visible."
27704 ;; Early versions of noutline don't have `outline-invisible-p'.
27705 (if (fboundp 'outline-invisible-p)
27706 (outline-invisible-p)
27707 (get-char-property (point) 'invisible)))
27709 (defun org-invisible-p2 ()
27710 "Check if point is at a character currently not visible."
27711 (save-excursion
27712 (if (and (eolp) (not (bobp))) (backward-char 1))
27713 ;; Early versions of noutline don't have `outline-invisible-p'.
27714 (if (fboundp 'outline-invisible-p)
27715 (outline-invisible-p)
27716 (get-char-property (point) 'invisible))))
27718 (defalias 'org-back-to-heading 'outline-back-to-heading)
27719 (defalias 'org-on-heading-p 'outline-on-heading-p)
27720 (defalias 'org-at-heading-p 'outline-on-heading-p)
27721 (defun org-at-heading-or-item-p ()
27722 (or (org-on-heading-p) (org-at-item-p)))
27724 (defun org-on-target-p ()
27725 (or (org-in-regexp org-radio-target-regexp)
27726 (org-in-regexp org-target-regexp)))
27728 (defun org-up-heading-all (arg)
27729 "Move to the heading line of which the present line is a subheading.
27730 This function considers both visible and invisible heading lines.
27731 With argument, move up ARG levels."
27732 (if (fboundp 'outline-up-heading-all)
27733 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27734 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27736 (defun org-up-heading-safe ()
27737 "Move to the heading line of which the present line is a subheading.
27738 This version will not throw an error. It will return the level of the
27739 headline found, or nil if no higher level is found."
27740 (let ((pos (point)) start-level level
27741 (re (concat "^" outline-regexp)))
27742 (catch 'exit
27743 (outline-back-to-heading t)
27744 (setq start-level (funcall outline-level))
27745 (if (equal start-level 1) (throw 'exit nil))
27746 (while (re-search-backward re nil t)
27747 (setq level (funcall outline-level))
27748 (if (< level start-level) (throw 'exit level)))
27749 nil)))
27751 (defun org-first-sibling-p ()
27752 "Is this heading the first child of its parents?"
27753 (interactive)
27754 (let ((re (concat "^" outline-regexp))
27755 level l)
27756 (unless (org-at-heading-p t)
27757 (error "Not at a heading"))
27758 (setq level (funcall outline-level))
27759 (save-excursion
27760 (if (not (re-search-backward re nil t))
27761 t
27762 (setq l (funcall outline-level))
27763 (< l level)))))
27765 (defun org-goto-sibling (&optional previous)
27766 "Goto the next sibling, even if it is invisible.
27767 When PREVIOUS is set, go to the previous sibling instead. Returns t
27768 when a sibling was found. When none is found, return nil and don't
27769 move point."
27770 (let ((fun (if previous 're-search-backward 're-search-forward))
27771 (pos (point))
27772 (re (concat "^" outline-regexp))
27773 level l)
27774 (when (condition-case nil (org-back-to-heading t) (error nil))
27775 (setq level (funcall outline-level))
27776 (catch 'exit
27777 (or previous (forward-char 1))
27778 (while (funcall fun re nil t)
27779 (setq l (funcall outline-level))
27780 (when (< l level) (goto-char pos) (throw 'exit nil))
27781 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27782 (goto-char pos)
27783 nil))))
27785 (defun org-show-siblings ()
27786 "Show all siblings of the current headline."
27787 (save-excursion
27788 (while (org-goto-sibling) (org-flag-heading nil)))
27789 (save-excursion
27790 (while (org-goto-sibling 'previous)
27791 (org-flag-heading nil))))
27793 (defun org-show-hidden-entry ()
27794 "Show an entry where even the heading is hidden."
27795 (save-excursion
27796 (org-show-entry)))
27798 (defun org-flag-heading (flag &optional entry)
27799 "Flag the current heading. FLAG non-nil means make invisible.
27800 When ENTRY is non-nil, show the entire entry."
27801 (save-excursion
27802 (org-back-to-heading t)
27803 ;; Check if we should show the entire entry
27804 (if entry
27805 (progn
27806 (org-show-entry)
27807 (save-excursion
27808 (and (outline-next-heading)
27809 (org-flag-heading nil))))
27810 (outline-flag-region (max (point-min) (1- (point)))
27811 (save-excursion (outline-end-of-heading) (point))
27812 flag))))
27814 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27815 ;; This is an exact copy of the original function, but it uses
27816 ;; `org-back-to-heading', to make it work also in invisible
27817 ;; trees. And is uses an invisible-OK argument.
27818 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
27819 (org-back-to-heading invisible-OK)
27820 (let ((first t)
27821 (level (funcall outline-level)))
27822 (while (and (not (eobp))
27823 (or first (> (funcall outline-level) level)))
27824 (setq first nil)
27825 (outline-next-heading))
27826 (unless to-heading
27828 (progn
27829 ;; Go to end of line before heading
27830 (forward-char -1)
27832 ;; leave blank line before heading
27833 (forward-char -1))))))
27834 (point))
27836 (defun org-show-subtree ()
27837 "Show everything after this heading at deeper levels."
27838 (outline-flag-region
27839 (point)
27840 (save-excursion
27841 (outline-end-of-subtree) (outline-next-heading) (point))
27842 nil))
27844 (defun org-show-entry ()
27845 "Show the body directly following this heading.
27846 Show the heading too, if it is currently invisible."
27847 (interactive)
27848 (save-excursion
27849 (condition-case nil
27850 (progn
27851 (org-back-to-heading t)
27852 (outline-flag-region
27853 (max (point-min) (1- (point)))
27854 (save-excursion
27855 (re-search-forward
27857 (or (match-beginning 1) (point-max)))
27858 nil))
27859 (error nil))))
27861 (defun org-make-options-regexp (kwds)
27862 "Make a regular expression for keyword lines."
27863 (concat
27864 "^"
27870 ;; Make isearch reveal the necessary context
27871 (defun org-isearch-end ()
27872 "Reveal context after isearch exits."
27873 (when isearch-success ; only if search was successful
27874 (if (featurep 'xemacs)
27875 ;; Under XEmacs, the hook is run in the correct place,
27876 ;; we directly show the context.
27877 (org-show-context 'isearch)
27878 ;; In Emacs the hook runs *before* restoring the overlays.
27879 ;; So we have to use a one-time post-command-hook to do this.
27880 ;; (Emacs 22 has a special variable, see function `org-mode')
27881 (unless (and (boundp 'isearch-mode-end-hook-quit)
27882 isearch-mode-end-hook-quit)
27883 ;; Only when the isearch was not quitted.
27884 (org-add-hook 'post-command-hook 'org-isearch-post-command
27885 'append 'local)))))
27887 (defun org-isearch-post-command ()
27888 "Remove self from hook, and show context."
27889 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
27890 (org-show-context 'isearch))
27893 ;;;; Integration with and fixes for other packages
27895 ;;; Imenu support
27897 (defvar org-imenu-markers nil
27898 "All markers currently used by Imenu.")
27899 (make-variable-buffer-local 'org-imenu-markers)
27901 (defun org-imenu-new-marker (&optional pos)
27902 "Return a new marker for use by Imenu, and remember the marker."
27903 (let ((m (make-marker)))
27904 (move-marker m (or pos (point)))
27905 (push m org-imenu-markers)
27906 m))
27908 (defun org-imenu-get-tree ()
27909 "Produce the index for Imenu."
27910 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
27911 (setq org-imenu-markers nil)
27912 (let* ((n org-imenu-depth)
27913 (re (concat "^" outline-regexp))
27914 (subs (make-vector (1+ n) nil))
27915 (last-level 0)
27916 m tree level head)
27917 (save-excursion
27918 (save-restriction
27919 (widen)
27920 (goto-char (point-max))
27921 (while (re-search-backward re nil t)
27922 (setq level (org-reduced-level (funcall outline-level)))
27923 (when (<= level n)
27924 (looking-at org-complex-heading-regexp)
27925 (setq head (org-match-string-no-properties 4)
27926 m (org-imenu-new-marker))
27927 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
27928 (if (>= level last-level)
27929 (push (cons head m) (aref subs level))
27930 (push (cons head (aref subs (1+ level))) (aref subs level))
27931 (loop for i from (1+ level) to n do (aset subs i nil)))
27932 (setq last-level level)))))
27933 (aref subs 1)))
27935 (eval-after-load "imenu"
27936 '(progn
27937 (add-hook 'imenu-after-jump-hook
27938 (lambda () (org-show-context 'org-goto)))))
27940 ;; Speedbar support
27942 (defun org-speedbar-set-agenda-restriction ()
27943 "Restrict future agenda commands to the location at point in speedbar.
27945 (interactive)
27946 (let (p m tp np dir txt w)
27947 (cond
27948 ((setq p (text-property-any (point-at-bol) (point-at-eol)
27949 'org-imenu t))
27950 (setq m (get-text-property p 'org-imenu-marker))
27951 (save-excursion
27952 (save-restriction
27953 (set-buffer (marker-buffer m))
27954 (goto-char m)
27955 (org-agenda-set-restriction-lock 'subtree))))
27956 ((setq p (text-property-any (point-at-bol) (point-at-eol)
27957 'speedbar-function 'speedbar-find-file))
27958 (setq tp (previous-single-property-change
27959 (1+ p) 'speedbar-function)
27960 np (next-single-property-change
27961 tp 'speedbar-function)
27962 dir (speedbar-line-directory)
27963 txt (buffer-substring-no-properties (or tp (point-min))
27964 (or np (point-max))))
27965 (save-excursion
27966 (save-restriction
27967 (set-buffer (find-file-noselect
27968 (let ((default-directory dir))
27969 (expand-file-name txt))))
27970 (unless (org-mode-p)
27971 (error "Cannot restrict to non-Org-mode file"))
27972 (org-agenda-set-restriction-lock 'file))))
27973 (t (error "Don't know how to restrict Org-mode's agenda")))
27974 (org-move-overlay org-speedbar-restriction-lock-overlay
27975 (point-at-bol) (point-at-eol))
27976 (setq current-prefix-arg nil)
27977 (org-agenda-maybe-redo)))
27979 (eval-after-load "speedbar"
27980 '(progn
27981 (speedbar-add-supported-extension ".org")
27982 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
27983 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
27984 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
27985 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27986 (add-hook 'speedbar-visiting-tag-hook
27987 (lambda () (org-show-context 'org-goto)))))
27990 ;;; Fixes and Hacks
27992 ;; Make flyspell not check words in links, to not mess up our keymap
27993 (defun org-mode-flyspell-verify ()
27994 "Don't let flyspell put overlays at active buttons."
27995 (not (get-text-property (point) 'keymap)))
27997 ;; Make `bookmark-jump' show the jump location if it was hidden.
27998 (eval-after-load "bookmark"
27999 '(if (boundp 'bookmark-after-jump-hook)
28000 ;; We can use the hook
28001 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28002 ;; Hook not available, use advice
28003 (defadvice bookmark-jump (after org-make-visible activate)
28004 "Make the position visible."
28005 (org-bookmark-jump-unhide))))
28007 (defun org-bookmark-jump-unhide ()
28008 "Unhide the current position, to show the bookmark location."
28009 (and (org-mode-p)
28010 (or (org-invisible-p)
28011 (save-excursion (goto-char (max (point-min) (1- (point))))
28012 (org-invisible-p)))
28013 (org-show-context 'bookmark-jump)))
28015 ;; Fix a bug in htmlize where there are text properties (face nil)
28016 (eval-after-load "htmlize"
28017 '(progn
28018 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28019 "Make sure there are no nil faces"
28020 (setq ad-return-value (delq nil ad-return-value)))))
28022 ;; Make session.el ignore our circular variable
28023 (eval-after-load "session"
28024 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28026 ;;;; Experimental code
28028 (defun org-closed-in-range ()
28029 "Sparse tree of items closed in a certain time range.
28030 Still experimental, may disappear in the future."
28031 (interactive)
28032 ;; Get the time interval from the user.
28033 (let* ((time1 (time-to-seconds
28034 (org-read-date nil 'to-time nil "Starting date: ")))
28035 (time2 (time-to-seconds
28036 (org-read-date nil 'to-time nil "End date:")))
28037 ;; callback function
28038 (callback (lambda ()
28039 (let ((time
28040 (time-to-seconds
28041 (apply 'encode-time
28042 (org-parse-time-string
28043 (match-string 1))))))
28044 ;; check if time in interval
28045 (and (>= time time1) (<= time time2))))))
28046 ;; make tree, check each match with the callback
28049 ;;;; Finish up
28051 (provide 'org)
28053 (run-hooks 'org-load-hook)
28055 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28056 ;;; org.el ends here