| blob | 71d8dee75f3c0873e3f4a191382140544450a37a |
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.19a
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 "Non-nil means, use refile to file a remember note.
1416 This is only used when the interactive mode for selecting a filing
1417 location is used (see the variable `org-remember-store-without-prompt').
1418 When nil, the `org-goto' interface is used."
1423 "The headline that should be the default location in the notes file.
1424 When filing remember notes, the cursor will start at that position.
1425 You can set this on a per-template basis with the variable
1426 `org-remember-templates'."
1431 "Templates for the creation of remember buffers.
1432 When nil, just let remember make the buffer.
1433 When not nil, this is a list of 5-element lists. In each entry, the first
1434 element is the name of the template, which should be a single short word.
1435 The second element is a character, a unique key to select this template.
1436 The third element is the template. The fourth element is optional and can
1437 specify a destination file for remember items created with this template.
1438 The default file is given by `org-default-notes-file'. An optional fifth
1439 element can specify the headline in that file that should be offered
1440 first when the user is asked to file the entry. The default headline is
1441 given in the variable `org-remember-default-headline'.
1443 The template specifies the structure of the remember buffer. It should have
1444 a first line starting with a star, to act as the org-mode headline.
1445 Furthermore, the following %-escapes will be replaced with content:
1447 %^{prompt} Prompt the user for a string and replace this sequence with it.
1448 A default value and a completion table ca be specified like this:
1449 %^{prompt|default|completion2|completion3|...}
1450 %t time stamp, date only
1451 %T time stamp with date and time
1452 %u, %U like the above, but inactive time stamps
1453 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1454 You may define a prompt like %^{Please specify birthday}t
1455 %n user name (taken from `user-full-name')
1456 %a annotation, normally the link created with org-store-link
1457 %i initial content, the region when remember is called with C-u.
1458 If %i is indented, the entire inserted text will be indented
1459 as well.
1460 %c content of the clipboard, or current kill ring head
1461 %^g prompt for tags, with completion on tags in target file
1462 %^G prompt for tags, with completion all tags in all agenda files
1463 %:keyword specific information for certain link types, see below
1464 %[pathname] insert the contents of the file given by `pathname'
1465 %(sexp) evaluate elisp `(sexp)' and replace with the result
1466 %! Store this note immediately after filling the template
1468 %? After completing the template, position cursor here.
1470 Apart from these general escapes, you can access information specific to the
1471 link type that is created. For example, calling `remember' in emails or gnus
1472 will record the author and the subject of the message, which you can access
1473 with %:author and %:subject, respectively. Here is a complete list of what
1474 is recorded for each link type.
1476 Link type | Available information
1477 -------------------+------------------------------------------------------
1478 bbdb | %:type %:name %:company
1479 vm, wl, mh, rmail | %:type %:subject %:message-id
1480 | %:from %:fromname %:fromaddress
1481 | %:to %:toname %:toaddress
1483 gnus | %:group, for messages also all email fields
1484 w3, w3m | %:type %:url
1485 info | %:type %:file %:node
1486 calendar | %:type %:date"
1509 "Non-nil means, store new notes at the beginning of a file or entry.
1510 When nil, new notes will be filed to the end of a file or entry.
1511 This can also be a list with cons cells of regular expressions that
1512 are matched against file names, and values."
1522 This is list of cons cells. Each cell contains:
1523 - a specification of the files to be considered, either a list of files,
1524 or a symbol whose function or value fields will be used to retrieve
1525 a file name or a list of file names. Nil means, refile to a different
1526 heading in the current buffer.
1527 - A specification of how to find candidate refile targets. This may be
1528 any of
1530 This tag has to be present in all target headlines, inheritance will
1531 not be considered.
1533 todo keyword.
1535 headlines that are refiling targets.
1536 - a cons cell (:level . N). Any headline of level N is considered a target.
1537 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1538 ;; FIXME: what if there are a var and func with same name???
1554 "Non-nil means, provide refile targets as paths.
1555 So a level 3 headline will be available as level1/level2/level3.
1556 When the value is `file', also include the file name (without directory)
1557 into the path. When `full-file-path', include the full file path."
1566 "Options concerning TODO items in Org-mode."
1571 "Options concerning Progress logging in Org-mode."
1576 "List of TODO entry keyword sequences and their interpretation.
1579 Each sequence starts with a symbol, either `sequence' or `type',
1580 indicating if the keywords should be interpreted as a sequence of
1581 action steps, or as different types of TODO items. The first
1582 keywords are states requiring action - these states will select a headline
1583 for inclusion into the global TODO list Org-mode produces. If one of
1586 the last keyword is treated as the only DONE state of the sequence.
1589 additional state where no keyword is present. For details about this
1590 cycling, see the manual.
1592 TODO keywords and interpretation can also be set on a per-file basis with
1593 the special #+SEQ_TODO and #+TYP_TODO lines.
1595 For backward compatibility, this variable may also be just a list
1596 of keywords - in this case the interptetation (sequence or type) will be
1597 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1634 "Controls how TODO keywords are interpreted.
1635 This variable is in principle obsolete and is only used for
1636 backward compatibility, if the interpretation of todo keywords is
1637 not given already in `org-todo-keywords'. See that variable for
1638 more information."
1645 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1646 This variable describes if and under what circumstances the cycling
1647 mechanism for TODO keywords will be replaced by a single-key, direct
1648 selection scheme.
1650 When nil, fast selection is never used.
1652 When the symbol `prefix', it will be used when `org-todo' is called with
1653 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1654 in an agenda buffer.
1656 When t, fast selection is used by default. In this case, the prefix
1657 argument forces cycling instead.
1659 In all cases, the special interface is only used if access keys have actually
1660 been assigned by the user, i.e. if keywords in the configuration are followed
1661 by a letter in parenthesis, like TODO(t)."
1669 "Hook which is run after the state of a TODO item was changed.
1670 The new state (a string with a TODO keyword, or nil) is available in the
1671 Lisp variable `state'."
1676 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1677 When the state of an entry is changed from nothing or a DONE state to
1678 a not-done TODO state, remove a previous closing date.
1680 This can also be a list of symbols indicating under which conditions
1681 the time stamp recording the action should be annotated with a short note.
1682 Valid members of this list are
1684 done Offer to record a note when marking entries done
1685 state Offer to record a note whenever changing the TODO state
1686 of an item. This is only relevant if TODO keywords are
1687 interpreted as sequence, see variable `org-todo-interpretation'.
1688 When `state' is set, this includes tracking `done'.
1689 clock-out Offer to record a note when clocking out of an item.
1691 A separate window will then pop up and allow you to type a note.
1692 After finishing with C-c C-c, the note will be added directly after the
1693 timestamp, as a plain list item. See also the variable
1694 `org-log-note-headings'.
1696 Logging can also be configured on a per-file basis by adding one of
1697 the following lines anywhere in the buffer:
1699 #+STARTUP: logdone
1700 #+STARTUP: nologging
1701 #+STARTUP: lognotedone
1702 #+STARTUP: lognotestate
1703 #+STARTUP: lognoteclock-out
1705 You can have local logging settings for a subtree by setting the LOGGING
1706 property to one or more of these keywords."
1718 "Non-nil means, the CLOSED time stamp will contain date and time.
1719 When nil, only the date will be recorded."
1727 "Headings for notes added when clocking out or closing TODO items.
1728 The value is an alist, with the car being a symbol indicating the note
1729 context, and the cdr is the heading to be used. The heading may also be the
1730 empty string.
1731 %t in the heading will be replaced by a time stamp.
1732 %s will be replaced by the new TODO state, in double quotes.
1733 %u will be replaced by the user name.
1734 %U will be replaced by the full user name."
1740 "Heading when changing todo state (todo sequence only)"
1745 "Non-nil means, the latest state change note will be directly after heading.
1746 When nil, the notes will be orderer according to time."
1752 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1753 When nil, no note will be taken.
1754 This option can also be set with on a per-file-basis with
1756 #+STARTUP: logrepeat
1757 #+STARTUP: nologrepeat
1759 You can have local logging settings for a subtree by setting the LOGGING
1760 property to one or more of these keywords."
1766 "Should clocking info be wrapped into a drawer?
1767 When t, clocking info will always be inserted into a :CLOCK: drawer.
1768 If necessary, the drawer will be created.
1769 When nil, the drawer will not be created, but used when present.
1770 When an integer and the number of clocking entries in an item
1771 reaches or exceeds this number, a drawer will be created."
1780 "When t, the clock will be stopped when the relevant entry is marked DONE.
1781 Nil means, clock will keep running until stopped explicitly with
1782 `C-c C-x C-o', or until the clock is started in a different item."
1787 "Set task to a special todo state while clocking it.
1788 The value should be the state to which the entry should be switched."
1796 "Priorities in Org-mode."
1801 "The highest priority of TODO items. A character like ?A, ?B etc.
1802 Must have a smaller ASCII number than `org-lowest-priority'."
1807 "The lowest priority of TODO items. A character like ?A, ?B etc.
1808 Must have a larger ASCII number than `org-highest-priority'."
1813 "The default priority of TODO items.
1814 This is the priority an item get if no explicit priority is given."
1819 "Non-nil means, start with default priority when starting to cycle.
1820 When this is nil, the first step in the cycle will be (depending on the
1821 command used) one higher or lower that the default priority."
1826 "Options concerning time stamps and deadlines in Org-mode."
1831 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1832 When nil, these labeled time stamps are forces into the second line of an
1833 entry, just after the headline. When scheduling from the global TODO list,
1834 the time stamp will always be forced into the second line."
1839 "Formats for `format-time-string' which are used for time stamps.
1843 "Number of minutes to round time stamps to upon insertion.
1844 When zero, insert the time unmodified. Useful rounding numbers
1845 should be factors of 60, so for example 5, 10, 15.
1846 When this is not zero, you can still force an exact time-stamp by using
1847 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1852 "Non-nil means, overlay custom formats over all time stamps.
1853 The formats are defined through the variable `org-time-stamp-custom-formats'.
1854 To turn this on on a per-file basis, insert anywhere in the file:
1855 #+STARTUP: customtime"
1863 "Custom formats for time stamps. See `format-time-string' for the syntax.
1864 These are overlayed over the default ISO format if the variable
1865 `org-display-custom-times' is set. Time like %H:%M should be at the
1866 end of the second format."
1871 "Get the right format for a time string."
1876 f)))
1879 "Non-nil means, assume future for incomplete date input from user.
1880 This affects the following situations:
1881 1. The user gives a day, but no month.
1884 it will be considered as *this* month.
1885 2. The user gives a month but not a year.
1889 When this option is nil, the current month and year will always be used
1890 as defaults."
1895 "Non-nil means, display current interpretation of date prompt live.
1896 This display will be in an overlay, in the minibuffer."
1901 "Non-nil means, pop up a calendar when prompting for a date.
1902 In the calendar, the date can be selected with mouse-1. However, the
1903 minibuffer will also be active, and you can simply enter the date as well.
1904 When nil, only the minibuffer will be available."
1912 "The hour when your day really ends.
1913 This has influence for the following applications:
1915 the time given here, the day recognized as TODAY is actually yesterday.
1916 - When a date is read from the user and it is still before the time given
1917 here, the current date and time will be assumed to be yesterday, 23:59.
1919 FIXME:
1920 IMPORTANT: This is still a very experimental feature, it may disappear
1921 again or it may be extended to mean more things."
1926 "Non-nil means, S-down will increase the time in a time stamp.
1927 When nil, S-up will increase."
1932 "Non-nil means, make the calendar window follow timestamp changes.
1933 When a timestamp is modified and the calendar window is visible, it will be
1934 moved to the new date."
1939 "When non-nil, should be a function to create `org-clock-heading'.
1940 This is the string shown in the mode line when a clock is running.
1941 The function is called with point at the beginning of the headline."
1946 "Options concerning tags in Org-mode."
1951 "List of tags allowed in Org-mode files.
1952 When this list is nil, Org-mode will base TAG input on what is already in the
1953 buffer.
1954 The value of this variable is an alist, the car of each entry must be a
1955 keyword as a string, the cdr may be a character that is used to select
1956 that tag through the fast-tag-selection interface.
1957 See the manual for details."
1967 "Non-nil means, use fast tag selection scheme.
1968 This is a special interface to select and deselect tags with single keys.
1969 When nil, fast selection is never used.
1970 When the symbol `auto', fast selection is used if and only if selection
1971 characters for tags have been configured, either through the variable
1972 `org-tag-alist' or through a #+TAGS line in the buffer.
1973 When t, fast selection is always used and selection keys are assigned
1974 automatically if necessary."
1982 "Non-nil means, fast tag selection exits after first change.
1983 When nil, you have to press RET to exit it.
1984 During fast tag selection, you can toggle this flag with `C-c'.
1985 This variable can also have the value `expert'. In this case, the window
1986 displaying the tags menu is not even shown, until you press C-c again."
1994 "Non-nil means, fast tags selection interface will also offer TODO states.
1998 "The column to which tags should be indented in a headline.
1999 If this number is positive, it specifies the column. If it is negative,
2000 it means that the tags should be flushright to that column. For example,
2001 -80 works well for a normal 80 character screen."
2006 "Non-nil means, realign tags after pro/demotion of TODO state change.
2007 These operations change the length of a headline and therefore shift
2008 the tags around. With this options turned on, after each such operation
2009 the tags are again aligned to `org-tags-column'."
2014 "Non-nil means, tags in levels apply also for sublevels.
2015 When nil, only the tags directly given in a specific line apply there.
2016 If you turn off this option, you very likely want to turn on the
2017 companion option `org-tags-match-list-sublevels'."
2022 "Non-nil means list also sublevels of headlines matching tag search.
2023 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2024 the sublevels of a headline matching a tag search often also match
2025 the same search. Listing all of them can create very long lists.
2026 Setting this variable to nil causes subtrees of a match to be skipped.
2027 This option is off by default, because inheritance in on. If you turn
2028 inheritance off, you very likely want to turn this option on.
2030 As a special case, if the tag search is restricted to TODO items, the
2031 value of this variable is ignored and sublevels are always checked, to
2032 make sure all corresponding TODO items find their way into the list."
2044 "Options concerning properties in Org-mode."
2049 "How property key/value pairs should be formatted by `indent-line'.
2050 When `indent-line' hits a property definition, it will format the line
2051 according to this format, mainly to make sure that the values are
2052 lined-up with respect to each other."
2057 "Non-nil means, properties apply also for sublevels.
2058 This setting is only relevant during property searches, not when querying
2059 an entry with `org-entry-get'. To retrieve a property with inheritance,
2060 you need to call `org-entry-get' with the inheritance flag.
2061 Turning this on can cause significant overhead when doing a search, so
2062 this is turned off by default.
2063 When nil, only the properties directly given in the current entry count.
2064 The value may also be a list of properties that shouldhave inheritance.
2066 However, note that some special properties use inheritance under special
2067 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2069 for valid values of a property."
2077 "The default column format, if no other format has been defined.
2078 This variable can be set on the per-file basis by inserting a line
2080 #+COLUMNS: %25ITEM ....."
2085 "List of property/value pairs that can be inherited by any entry.
2086 You can set buffer-local values for this by adding lines like
2088 #+PROPERTY: NAME VALUE"
2095 "List of property/value pairs that can be inherited by any entry.
2096 Valid for the current buffer.
2100 "Options concerning agenda views in Org-mode."
2105 "Variable used by org files to set a category for agenda display.
2106 Such files should use a file variable to set it, for example
2110 or contain a special line
2112 #+CATEGORY: ELisp
2114 If the file does not specify a category, then file's base name
2119 "The files to be used for agenda display.
2123 If an entry is a directory, all files in that directory that are matched by
2124 `org-agenda-file-regexp' will be part of the file list.
2126 If the value of the variable is not a list but a single file name, then
2127 the list of agenda files is actually stored and maintained in that file, one
2128 agenda file per line."
2135 "Regular expression to match files for `org-agenda-files'.
2136 If any element in the list in that variable contains a directory instead
2137 of a normal file, all files in that directory that are matched by this
2138 regular expression will be included."
2143 "t means to just skip non-reachable files in `org-agenda-files'.
2144 Nil means to remove them, after a query, from the list."
2149 "List of extra files to be searched by `org-occur-in-agenda-files'.
2150 The files in `org-agenda-files' are always searched."
2155 "When set, remote killing from the agenda buffer needs confirmation.
2156 When t, a confirmation is always needed. When a number N, confirmation is
2157 only needed when the text to be killed contains more than N non-white lines."
2165 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2166 The command `org-calendar-goto-agenda' will be bound to this key. The
2167 default is the character `c' because then `c' can be used to switch back and
2168 forth between agenda and calendar."
2173 "Non-nil means, make the block agenda more compact.
2174 This is done by leaving out unnecessary lines."
2179 "Options concerning exporting agenda views in Org-mode."
2184 "Non-nil means, use colors in agenda views."
2189 "Alist of variable/value pairs that should be active during agenda export.
2190 This is a good place to set uptions for ps-print and for htmlize."
2198 "The style specification for exported HTML Agenda files.
2199 If this variable contains a string, it will replace the default <style>
2200 section as produced by `htmlize'.
2201 Since there are different ways of setting style information, this variable
2202 needs to contain the full HTML structure to provide a style, including the
2203 surrounding HTML tags. The style specifications should include definitions
2204 the fonts used by the agenda, here is an example:
2207 p { font-weight: normal; color: gray; }
2208 .org-agenda-structure {
2209 font-size: 110%;
2210 color: #003399;
2211 font-weight: 600;
2212 }
2213 .org-todo {
2214 color: #cc6666;Week-agenda:
2215 font-weight: bold;
2216 }
2217 .org-done {
2218 color: #339933;
2219 }
2220 .title { text-align: center; }
2221 .todo, .deadline { color: red; }
2222 .done { color: green; }
2223 </style>
2225 or, if you want to keep the style in a file,
2229 As the value of this option simply gets inserted into the HTML <head> header,
2231 <style>...</style> is required, if not present the variable will be ignored."
2237 "Options concerning agenda views in Org-mode."
2242 "Custom commands for the agenda.
2243 These commands will be offered on the splash screen displayed by the
2246 (key desc type match options files)
2248 key The key (one or more characters as a string) to be associated
2249 with the command.
2250 desc A description of the commend, when omitted or nil, a default
2251 description is built using MATCH.
2252 type The command type, any of the following symbols:
2253 todo Entries with a specific TODO keyword, in all agenda files.
2254 tags Tags match in all agenda files.
2255 tags-todo Tags match in all agenda files, TODO entries only.
2256 todo-tree Sparse tree of specific TODO keyword in *current* file.
2257 tags-tree Sparse tree with all tags matches in *current* file.
2258 occur-tree Occur sparse tree for *current* file.
2259 ... A user-defined function.
2260 match What to search for:
2261 - a single keyword for TODO keyword searches
2262 - a tags match expression for tags searches
2263 - a regular expression for occur searches
2264 options A list of option settings, similar to that in a let form, so like
2265 this: ((opt1 val1) (opt2 val2) ...)
2266 files A list of files file to write the produced agenda buffer to
2267 with the command `org-store-agenda-views'.
2270 produced. Otherwide, only the plain text is written to the file.
2272 You can also define a set of commands, to create a composite agenda buffer.
2273 In this case, an entry looks like this:
2275 (key desc (cmd1 cmd2 ...) general-options file)
2277 where
2279 desc A description string to be displayed in the dispatcher menu.
2280 cmd An agenda command, similar to the above. However, tree commands
2281 are no allowed, but instead you can get agenda and global todo list.
2282 So valid commands for a set are:
2283 (agenda)
2284 (alltodo)
2285 (stuck)
2290 Each command can carry a list of options, and another set of options can be
2291 given for the whole set of commands. Individual command options take
2292 precedence over the general options.
2294 When using several characters as key to a command, the first characters
2295 are prefix commands. For the dispatcher to display useful information, you
2296 should provide a description for the prefix, like
2298 (setq org-agenda-custom-commands
2370 "How to identify stuck projects.
2371 This is a list of four items:
2372 1. A tags/todo matcher string that is used to identify a project.
2373 The entire tree below a headline matched by this is considered one project.
2374 2. A list of TODO keywords identifying non-stuck projects.
2375 If the project subtree contains any headline with one of these todo
2376 keywords, the project is considered to be not stuck. If you specify
2378 3. A list of tags identifying non-stuck projects.
2379 If the project subtree contains any headline with one of these tags,
2381 a tag, any tag will mark the project unstuck.
2382 4. An arbitrary regular expression matching non-stuck projects.
2385 or `C-c a #' to produce the list."
2389 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2395 "Options concerning skipping parts of agenda files."
2400 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2401 When nil, the sublevels of a TODO entry are not checked, resulting in
2402 potentially much shorter TODO lists."
2408 "Non-nil means, don't show entries with a date in the global todo list.
2409 You can use this if you prefer to mark mere appointments with a TODO keyword,
2410 but don't want them to show up in the TODO list.
2411 When this is set, it also covers deadlines and scheduled items, the settings
2412 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2413 will be ignored."
2419 "Non-nil means, don't show scheduled entries in the global todo list.
2420 The idea behind this is that by scheduling it, you have already taken care
2421 of this item.
2422 See also `org-agenda-todo-ignore-with-date'."
2428 "Non-nil means, don't show near deadline entries in the global todo list.
2429 Near means closer than `org-deadline-warning-days' days.
2430 The idea behind this is that such items will appear in the agenda anyway.
2431 See also `org-agenda-todo-ignore-with-date'."
2437 "Non-nil means don't show scheduled items in agenda when they are done.
2438 This is relevant for the daily/weekly agenda, not for the TODO list. And
2439 it applies only to the actual date of the scheduling. Warnings about
2440 an item with a past scheduling dates are always turned off when the item
2441 is DONE."
2446 "Non-nil means don't show deadines when the corresponding item is done.
2447 When nil, the deadline is still shown and should give you a happy feeling.
2448 This is relevant for the daily/weekly agenda. And it applied only to the
2449 actualy date of the deadline. Warnings about approching and past-due
2450 deadlines are always turned off when the item is DONE."
2455 "Non-nil means don't select item by timestamp or -range if it is DONE."
2460 "Non-nil means, `org-timeline' also shows dates without an entry.
2461 When nil, only the days which actually have entries are shown.
2462 When t, all days between the first and the last date are shown.
2463 When an integer, show also empty dates, but if there is a gap of more than
2464 N days, just insert a special line indicating the size of the gap."
2473 "Options concerning initial settings in the Agenda in Org Mode."
2478 "Hook run just before displaying an agenda buffer."
2483 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2484 A longer mouse click will still set point. Does not wortk on XEmacs.
2485 Needs to be set before org.el is loaded."
2490 "The initial value of follow-mode in a newly created agenda window."
2495 "Options concerning the windows used by the Agenda in Org Mode."
2500 "How the agenda buffer should be displayed.
2501 Possible values for this option are:
2503 current-window Show agenda in the current window, keeping all other windows.
2504 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2505 other-window Use `switch-to-buffer-other-window' to display agenda.
2506 reorganize-frame Show only two windows on the current frame, the current
2507 window and the agenda.
2508 See also the variable `org-agenda-restore-windows-after-quit'."
2517 "The min and max height of the agenda window as a fraction of frame height.
2518 The value of the variable is a cons cell with two numbers between 0 and 1.
2519 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2524 "Non-nil means, restore window configuration open exiting agenda.
2525 Before the window configuration is changed for displaying the agenda,
2526 the current status is recorded. When the agenda is exited with
2527 `q' or `x' and this option is set, the old state is restored. If
2528 `org-agenda-window-setup' is `other-frame', the value of this
2529 option will be ignored.."
2534 "How should indirect tree buffers be displayed?
2535 This applies to indirect buffers created with the commands
2537 Valid values are:
2538 current-window Display in the current window
2539 other-window Just display in another window.
2540 dedicated-frame Create one new frame, and re-use it each time.
2541 new-frame Make a new frame each time. Note that in this case
2542 previously-made indirect buffers are kept, and you need to
2543 kill these buffers yourself."
2553 "Options concerning the daily/weekly agenda."
2558 "Number of days to include in overview display.
2559 Should be 1 or 7."
2564 "Non-nil means, start the overview always on the specified weekday.
2565 0 denotes Sunday, 1 denotes Monday etc.
2566 When nil, always start on the current day."
2572 "Non-nil means, `org-agenda' shows every day in the selected range.
2573 When nil, only the days which actually have entries are shown."
2578 "Format string for displaying dates in the agenda.
2579 Used by the daily/weekly agenda and by the timeline. This should be
2580 a format string understood by `format-time-string', or a function returning
2581 the formatted date as a string. The function must take a single argument,
2582 a calendar-style date list like (month day year)."
2589 "Format a date string for display in the daily/weekly agenda, or timeline.
2590 This function makes sure that dates are aligned for easy reading."
2598 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2603 "Set means weekly/daily agenda will always contain all TODO entries.
2604 The TODO entries will be listed at the top of the agenda, before
2605 the entries for specific days."
2610 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2611 When nil, only one occurence is shown, either today or the
2612 nearest into the future."
2617 "No. of days before expiration during which a deadline becomes active.
2618 This variable governs the display in sparse trees and in the agenda.
2619 When negative, it means use this number (the absolute value of it)
2620 even if a deadline has a different individual lead time specified."
2626 "No. of days to continue listing scheduled items that are not marked DONE.
2627 When an item is scheduled on a date, it shows up in the agenda on this
2628 day and will be listed until it is marked done for the number of days
2629 given here."
2634 "Options concerning the time grid in the Org-mode Agenda."
2639 "Non-nil means, show a time grid in the agenda schedule.
2640 A time grid is a set of lines for specific times (like every two hours between
2641 8:00 and 20:00). The items scheduled for a day at specific times are
2642 sorted in between these lines.
2643 For details about when the grid will be shown, and what it will look like, see
2644 the variable `org-agenda-time-grid'."
2650 "----------------"
2653 "The settings for time grid for agenda display.
2654 This is a list of three items. The first item is again a list. It contains
2655 symbols specifying conditions when the grid should be displayed:
2657 daily if the agenda shows a single day
2658 weekly if the agenda shows an entire week
2659 today show grid on current date, independent of daily/weekly display
2660 require-timed show grid only if at least one item has a time specification
2662 The second item is a string which will be places behing the grid time.
2664 The third item is a list of integers, indicating the times that should have
2665 a grid line."
2667 :type
2674 require-timed)
2676 remove-match))
2681 "Options concerning sorting in the Org-mode Agenda."
2697 "Sorting structure for the agenda items of a single day.
2698 This is a list of symbols which will be used in sequence to determine
2699 if an entry should be listed before another entry. The following
2700 symbols are recognized:
2702 time-up Put entries with time-of-day indications first, early first
2703 time-down Put entries with time-of-day indications first, late first
2704 category-keep Keep the default order of categories, corresponding to the
2705 sequence in `org-agenda-files'.
2706 category-up Sort alphabetically by category, A-Z.
2707 category-down Sort alphabetically by category, Z-A.
2708 tag-up Sort alphabetically by last tag, A-Z.
2709 tag-down Sort alphabetically by last tag, Z-A.
2710 priority-up Sort numerically by priority, high priority last.
2711 priority-down Sort numerically by priority, high priority first.
2713 The different possibilities will be tried in sequence, and testing stops
2715 '(time-up category-keep priority-down)
2716 means: Pull out all entries having a specified time of day and sort them,
2717 in order to make a time schedule for the current day the first thing in the
2718 agenda listing for the day. Of the entries without a time indication, keep
2719 the grouped in categories, don't sort the categories, but keep them in
2720 the sequence given in `org-agenda-files'. Within each category sort by
2721 priority.
2723 Leaving out `category-keep' would mean that items will be sorted across
2724 categories by priority.
2726 Instead of a single list, this can also be a set of list for specific
2727 contents, with a context symbol in the car of the list, any of
2728 `agenda', `todo', `tags' for the corresponding agenda views."
2741 "Non-nil means, items without time are considered late.
2742 This is only relevant for sorting. When t, items which have no explicit
2743 time like 15:30 will be considered as 99:01, i.e. later than any items which
2744 do have a time. When nil, the default time is before 0:00. You can use this
2745 option to decide if the schedule for today should come before or after timeless
2746 agenda entries."
2751 "Options concerning the entry prefix in the Org-mode agenda display."
2760 "Format specifications for the prefix of items in the agenda views.
2761 An alist with four entries, for the different agenda types. The keys to the
2762 sublists are `agenda', `timeline', `todo', and `tags'. The values
2763 are format strings.
2764 This format works similar to a printf format, with the following meaning:
2767 as given by the CATEGORY keyword or derived from the file name.
2768 %T the *last* tag of the item. Last because inherited tags come
2769 first in the list.
2770 %t the time-of-day specification if one applies to the entry, in the
2771 format HH:MM
2772 %s Scheduling/Deadline information, a short string
2774 All specifiers work basically like the standard `%s' of printf, but may
2775 contain two additional characters: A question mark just after the `%' and
2776 a whitespace/punctuation character just before the final letter.
2778 If the first character after `%' is a question mark, the entire field
2779 will only be included if the corresponding value applies to the
2780 current entry. This is useful for fields which should have fixed
2781 width when present, but zero width when absent. For example,
2783 day is specified, but will completely disappear in entries which do
2784 not contain a time.
2786 If there is punctuation or whitespace character just before the final
2787 format letter, this character will be appended to the field value if
2790 empty, no additional colon would be interted.
2793 - Indent the line with two space characters
2794 - Give the category in a 12 chars wide field, padded with whitespace on
2795 the right (because of `-'). Append a colon if there is a category
2796 (because of `:').
2797 - If there is a time-of-day, put it into a 12 chars wide field. If no
2798 time, don't put in an empty field, just skip it (because of '?').
2799 - Finally, put the scheduling information and append a whitespace.
2801 As another example, if you don't want the time-of-day of entries in
2802 the prefix, you could use:
2806 See also the variables `org-agenda-remove-times-when-in-prefix' and
2807 `org-agenda-remove-tags'."
2818 "The compiled version of the most recently used prefix format.
2822 "Format for the TODO keyword in agenda lines.
2824 to occupy a fixed space in the agenda display."
2829 "Text preceeding scheduled items in the agenda view.
2830 This is a list with two strings. The first applies when the item is
2831 scheduled on the current day. The second applies when it has been scheduled
2832 previously, it may contain a %d to capture how many days ago the item was
2833 scheduled."
2840 "Text preceeding deadline items in the agenda view.
2841 This is a list with two strings. The first applies when the item has its
2842 deadline on the current day. The second applies when it is in the past or
2843 in the future, it may contain %d to capture how many days away the deadline
2844 is (was)."
2851 "Non-nil means, remove duplicate time specifications in agenda items.
2852 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2853 time-of-day specification in a headline or diary entry is extracted and
2854 placed into the prefix. If this option is non-nil, the original specification
2855 \(a timestamp or -range, or just a plain time(range) specification like
2856 11:30-4pm) will be removed for agenda display. This makes the agenda less
2857 cluttered.
2858 The option can be t or nil. It may also be the symbol `beg', indicating
2859 that the time should only be removed what it is located at the beginning of
2860 the headline/diary entry."
2869 "Default duration for appointments that only have a starting time.
2870 When nil, no duration is specified in such cases.
2871 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2879 "Non-nil means, remove the tags from the headline copy in the agenda.
2880 When this is the symbol `prefix', only remove tags when
2881 `org-agenda-prefix-format' contains a `%T' specifier."
2893 "Shift tags in agenda items to this column.
2894 If this number is positive, it specifies the column. If it is negative,
2895 it means that the tags should be flushright to that column. For example,
2896 -80 works well for a normal 80 character screen."
2904 "Non-nil means, highlight low and high priorities in agenda.
2905 When t, the highest priority entries are bold, lowest priority italic.
2906 This may also be an association list of priority faces. The face may be
2917 "Options for embedding LaTeX code into Org-mode"
2925 "Options for creating images from LaTeX fragments.
2926 This is a property list with the following properties:
2928 `default' means use the forground of the default face.
2930 `default' means use the background of the default face.
2931 :scale a scaling factor for the size of the images
2932 :html-foreground, :html-background, :html-scale
2933 The same numbers for HTML export.
2934 :matchers a list indicating which matchers should be used to
2935 find LaTeX fragments. Valid members of this list are:
2952 "The document header used for processing LaTeX fragments."
2957 "Options for exporting org-listings."
2962 "General options for exporting Org-mode files."
2966 ;; FIXME
2971 When this option is turned on, these strings will be exported as:
2973 Org HTML LaTeX
2974 -----+----------+--------
2976 -- – --
2977 --- — ---
2978 ... … \ldots
2995 "Terms used in export text, translated to different languages.
2996 Use the variable `org-export-default-language' to set the language,
2997 or use the +OPTION lines for a per-file setting."
3007 "The default language of HTML export, as a string.
3008 This should have an association in `org-export-language-setup'."
3013 "Non-nil means, skip all text before the first headline when exporting.
3014 When nil, that text is exported as well."
3019 "The last level which is still exported as a headline.
3020 Inferior levels will produce itemize lists when exported.
3021 Note that a numeric prefix argument to an exporter function overrides
3022 this setting.
3029 "Non-nil means, add section numbers to headlines when exporting.
3036 "Non-nil means, create a table of contents in exported files.
3037 The TOC contains headlines with levels up to`org-export-headline-levels'.
3038 When an integer, include levels up to N in the toc, this may then be
3039 different from `org-export-headline-levels', but it will not be allowed
3040 to be larger than the number of headline levels.
3041 When nil, no table of contents is made.
3044 ASCII export, and with red color in HTML output, if the option
3045 `org-export-mark-todo-in-toc' is set.
3047 In HTML output, the TOC will be clickable.
3058 "Non-nil means, mark TOC lines that contain any open TODO items."
3063 "Non-nil means, preserve all line breaks when exporting.
3064 Normally, in HTML output paragraphs will be reformatted. In ASCII
3065 export, line breaks will always be preserved, regardless of this variable.
3072 "Whether subtrees with the ARCHIVE tag should be exported.
3073 This can have three different values
3074 nil Do not export, pretend this tree is not present
3075 t Do export the entire tree
3076 headline Only export the headline, but skip the tree below it."
3085 "Non-nil means, insert author name and email into the exported file.
3087 This option can also be set with the +OPTIONS line,
3093 "Non-nil means, insert a time stamp into the exported file.
3094 The time stamp shows when the file was created.
3096 This option can also be set with the +OPTIONS line,
3102 "If nil, do not export time stamps and associated keywords."
3107 "If nil, remove timestamps from the table of contents entries."
3112 "If nil, do not export tags, just remove them from headlines.
3113 If this is the symbol `not-in-toc', tags will be removed from table of
3114 contents entries, but still be shown in the headlines of the document.
3124 "Non-nil means, export with drawers like the property drawer.
3125 When t, all drawers are exported. This may also be a list of
3126 drawer names to export."
3135 "Options for translating special ascii sequences for the export backends."
3140 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3141 If the export target supports emphasizing text, the word will be
3142 typeset in bold, italic, or underlined, respectively. Works only for
3143 single words, but you can say: I *really* *mean* *this*.
3144 Not all export backends support this.
3151 "If nil, export [1] as a footnote marker.
3152 Lines starting with [1] will be formatted as footnotes.
3160 When this option is turned on, you can use TeX-like syntax for sub- and
3162 considered as a single item - so grouping with {} is normally not
3163 needed. For example, the following things will be parsed as single
3164 sub- or superscripts.
3166 10^24 or 10^tau several digits will be considered 1 item.
3167 10^-12 or 10^-tau a leading sign with digits or a word
3168 x^2-y^3 will be read as x^2 - y^3, because items are
3169 terminated by almost any nonword/nondigit char.
3170 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3172 Still, ambiguity is possible - so when in doubt use {} to enclose the
3173 sub/superscript. If you set this variable to the symbol `{}',
3174 the braces are *required* in order to trigger interpretations as
3176 frequently in plain text.
3178 Not all export backends support this, but HTML does.
3189 When this option is turned on, these strings will be exported as:
3192 -- : –
3193 --- : —
3195 Not all export backends support this, but HTML does.
3202 "Non-nil means, interpret simple TeX-like macros when exporting.
3204 No only real TeX macros will work here, but the standard HTML entities
3205 for math can be used as macro names as well. For a list of supported
3206 names in HTML export, see the constant `org-html-entities'.
3207 Not all export backends support this.
3215 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3217 the first non-white thing on a line. It will also find the math delimiters
3219 display math.
3228 This can be used to have pre-formatted text, fragments of code etc. For
3229 example:
3230 : ;; Some Lisp examples
3231 : (while (defc cnt)
3232 : (ding))
3233 will be looking just like this in also HTML. See also the QUOTE keyword.
3234 Not all export backends support this.
3241 "Number of stacked braces for sub/superscript matching.
3242 This has to be set before loading org.el to be effective."
3247 "Options for exporting tables in Org-mode."
3253 For example:
3255 | Name | Address | Birthday |
3256 |-------------+----------+-----------|
3257 | Arthur Dent | England | 29.2.2100 |
3259 Not all export backends support this.
3266 "Non-nil means, highlight the first table line.
3267 In HTML export, this means use <th> instead of <td>.
3268 In tables created with table.el, this applies to the first table line.
3269 In Org-mode tables, all lines before the first horizontal separator
3270 line will be formatted with <th> tags."
3275 "Remove special lines and marking characters in calculating tables.
3276 This removes the special marking character column from tables that are set
3277 up for spreadsheet calculations. It also removes the entire lines
3278 marked with `!', `_', or `^'. The lines with `$' are kept, because
3279 the values of constants may be useful to have."
3284 "Non-nil means, always export tables created with table.el natively.
3285 Natively means, use the HTML code generator in table.el.
3286 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3287 the table does not use row- or column-spanning). This has the
3288 advantage, that the automatic HTML conversions for math symbols and
3289 sub/superscripts can be applied. Org-mode's HTML generator is also
3290 much faster."
3295 "Options specific for ASCII export of Org-mode files."
3300 "Characters for underlining headings in ASCII export.
3301 In the given sequence, these characters will be used for level 1, 2, ..."
3306 "Bullet characters for headlines converted to lists in ASCII export.
3307 The first character is used for the first lest level generated in this
3308 way, and so on. If there are more levels than characters given here,
3309 the list will be repeated.
3310 Note that plain lists will keep the same bullets as the have in the
3311 Org-mode file."
3316 "Options specific for XML export of Org-mode files."
3321 "Options specific for HTML export of Org-mode files."
3326 ""
3331 "The extension for exported HTML files."
3337 html {
3338 font-family: Times, serif;
3339 font-size: 12pt;
3340 }
3341 .title { text-align: center; }
3342 .todo { color: red; }
3343 .done { color: green; }
3344 .timestamp { color: grey }
3345 .timestamp-kwd { color: CadetBlue }
3346 .tag { background-color:lightblue; font-weight:normal }
3347 .target { background-color: lavender; }
3348 pre {
3349 border: 1pt solid #AEBDCC;
3350 background-color: #F3F5F7;
3351 padding: 5pt;
3352 font-family: courier, monospace;
3353 }
3354 table { border-collapse: collapse; }
3355 td, th {
3356 vertical-align: top;
3357 <!--border: 1pt solid #ADB9CC;-->
3358 }
3359 </style>"
3360 "The default style specification for exported HTML files.
3361 Since there are different ways of setting style information, this variable
3362 needs to contain the full HTML structure to provide a style, including the
3363 surrounding HTML tags. The style specifications should include definitions
3364 for new classes todo, done, title, and deadline. For example, valid values
3365 would be:
3368 p { font-weight: normal; color: gray; }
3369 h1 { color: black; }
3370 .title { text-align: center; }
3371 .todo, .deadline { color: red; }
3372 .done { color: green; }
3373 </style>
3375 or, if you want to keep the style in a file,
3379 As the value of this option simply gets inserted into the HTML <head> header,
3386 "Format for typesetting the document title in HTML export."
3391 "The <H> level for level 1 headings in HTML export."
3396 "Non-nil means, make file links to `file.org' point to `file.html'.
3397 When org-mode is exporting an org-mode file to HTML, links to
3398 non-html files are directly put into a href tag in HTML.
3399 However, links to other Org-mode files (recognized by the
3400 extension `.org.) should become links to the corresponding html
3401 file, assuming that the linked org-mode file will also be
3402 converted to HTML.
3403 When nil, the links still point to the plain `.org' file."
3408 "Non-nil means, inline images into exported HTML pages.
3409 This is done using an <img> tag. When nil, an anchor with href is used to
3410 link to the image. If this option is `maybe', then images in links with
3411 an empty description will be inlined, while images with a description will
3412 be linked only."
3418 ;; FIXME: rename
3420 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3421 When nil, these tags will be exported as plain text and therefore
3422 not be interpreted by a browser.
3430 "The HTML tag that is used to start a table.
3431 This must be a <table> tag, but you may change the options like
3432 borders and spacing."
3437 "The opening tag for table header fields.
3438 This is customizable so that alignment options can be specified."
3443 "The opening tag for table data fields.
3444 This is customizable so that alignment options can be specified."
3449 "If non-nil, write `org-export-html-html-helper-timestamp'
3450 into the exported HTML text. Otherwise, the buffer will just be saved
3451 to a file."
3457 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3462 "Options specific for iCalendar export of Org-mode files."
3467 "The file name for the iCalendar file covering all agenda files.
3469 The file name should be absolute, the file will be overwritten without warning."
3474 "Non-nil means, export to iCalendar files should also cover TODO items."
3482 "Non-nil means, export to iCalendar files should also cover sexp entries.
3483 These are entries like in the diary, but directly in an Org-mode file."
3488 "Amount of text below headline to be included in iCalendar export.
3489 This is a number of characters that should maximally be included.
3490 Properties, scheduling and clocking lines will always be removed.
3491 The text will be inserted into the DESCRIPTION field."
3499 "Calendar name for the combined iCalendar representing all agenda files."
3504 "Font-lock settings for highlighting in Org-mode."
3509 "Non-nil means fontify only the stars in each headline.
3510 When nil, the entire headline is fontified.
3511 Changing it requires restart of `font-lock-mode' to become effective
3512 also in regions already fontified."
3517 "Non-nil means, hide the first N-1 stars in a headline.
3518 This works by using the face `org-hide' for these stars. This
3519 face is white for a light background, and black for a dark
3520 background. You may have to customize the face `org-hide' to
3521 make this work.
3522 Changing it requires restart of `font-lock-mode' to become effective
3523 also in regions already fontified.
3524 You may also set this on a per-file basis by adding one of the following
3525 lines to the buffer:
3527 #+STARTUP: hidestars
3528 #+STARTUP: showstars"
3533 "Non-nil means, change the face of a headline if it is marked DONE.
3534 Normally, only the TODO/DONE keyword indicates the state of a headline.
3535 When this is non-nil, the headline after the keyword is set to the
3536 `org-headline-done' as an additional indication."
3541 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3542 Changing this variable requires a restart of Emacs to take effect."
3547 "Non-nil means, fontify what is treated specially by the exporters."
3552 "Non-nil mean font-lock should hide the emphasis marker characters."
3563 "Set variable and compute the emphasis regular expression."
3567 org-emphasis-alist org-emphasis-regexp-components)
3580 ;; make sure special characters appear at the right position in the class
3592 ;; Make the regexp
3600 body1
3612 body1
3620 "Components used to build the regular expression for emphasis.
3621 This is a list with 6 entries. Terminology: In an emphasis string
3625 specify what is allowed/forbidden in each part:
3627 pre Chars allowed as prematch. Beginning of line will be allowed too.
3628 post Chars allowed as postmatch. End of line will be allowed too.
3629 border The chars *forbidden* as border characters.
3631 non-shy groups here, and don't allow newline here.
3632 newline The maximum number of newlines allowed in an emphasis exp.
3634 Use customize to modify this, or restart Emacs after changing it."
3652 )
3653 "Special syntax for emphasized text.
3654 Text starting and ending with a special character will be emphasized, for
3655 example *bold*, _underlined_ and /italic/. This variable sets the marker
3656 characters, the face to be used by font-lock for highlighting in Org-mode
3657 Emacs buffers, and the HTML tags to be used for this.
3658 Use customize to modify this, or restart Emacs after changing it."
3671 ;;; The faces
3674 "Faces in Org-mode."
3679 "Make a compatible face specification.
3680 If INHERITS is an existing face and if the Emacs version supports it,
3681 just inherit the face. If not, use SPECS to define the face.
3682 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3683 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3684 to the top of the list. The `min-colors' attribute will be removed from
3685 any other entries, and any resulting duplicates will be removed entirely."
3689 ;; In Emacs 23, we use inheritance where possible.
3690 ;; We only do this in Emacs 23, because only there the outline
3691 ;; faces have been changed to the original org-mode-level-faces.
3694 ;; These do not understand the `min-colors' attribute.
3713 "Face used to hide leading stars in headlines.
3714 The forground color of this face should be equal to the background
3715 color of the frame."
3726 "Face used for level 1 headlines."
3736 "Face used for level 2 headlines."
3748 "Face used for level 3 headlines."
3760 "Face used for level 4 headlines."
3768 "Face used for level 5 headlines."
3776 "Face used for level 6 headlines."
3784 "Face used for level 7 headlines."
3792 "Face used for level 8 headlines."
3800 "Face used for special keywords."
3811 "Face used for drawers."
3815 "Face used for the value of a property."
3827 "Face for column display of entry properties."
3831 ;; Make sure that a fixed-width face is used when we have a column table.
3843 "Face for deadlines and TODO keywords."
3856 "Face for headline with the ARCHIVE tag."
3863 "Face for links."
3870 "Face for the ellipsis in folded text."
3877 "Face for links."
3884 "Face for links."
3891 "Face for links."
3896 "Face for tags."
3906 "Face for TODO keywords."
3915 "Face used for todo keywords that indicate DONE items."
3923 "Face used to indicate that a headline is DONE.
3924 This face is only used if `org-fontify-done-headline' is set. If applies
3925 to the part of the headline after the DONE keyword."
3929 "Faces for specific TODO keywords.
3930 This is a list of cons cells, with TODO keywords in the car
3931 and faces in the cdr. The face can be a symbol, or a property
3948 "Face used for tables."
3958 "Face for formulas."
3971 "Face for fixed-with text like code snippets."
3985 "Face for fixed-with text like code snippets."
3997 "Face used in agenda for captions and dates."
4006 "Face for items scheduled for a certain day."
4016 "Face for items scheduled previously, and not yet done."
4026 "Face for items scheduled previously, and not yet done."
4033 "Faces for showing deadlines in the agenda.
4034 This is a list of cons cells. The cdr of each cell is a face to be used,
4036 Each car is a fraction of the head-warning time that must have passed for
4037 this the face in the cdr to be used for display. The numbers must be
4038 given in descending order. The head-warning time is normally taken
4039 from `org-deadline-warning-days', but can also be specified in the deadline
4040 timestamp itself, like this:
4042 DEADLINE: <2007-08-13 Mon -8d>
4044 You may use d for days, w for weeks, m for months and y for years. Months
4045 and years will only be treated in an approximate fashion (30.4 days for a
4046 month and 365.24 days for a year)."
4054 ;; FIXME: this is not a good face yet.
4063 "Face for showing the agenda restriction lock."
4071 "Face used for time grids."
4076 org-level-5 org-level-6 org-level-7 org-level-8
4077 ))
4080 "The number different faces to be used for headlines.
4081 Org-mode defines 8 different headline faces, so this can be at most 8.
4082 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4086 ;;; Functions and variables from ther packages
4087 ;; Declared here to avoid compiler warnings
4093 ;; XEmacs only
4099 ;; Emacs only
4102 ;; Various packages
4103 ;; FIXME: get the argument lists for the UNKNOWN stuff
4143 ;; backward compatibility to old version of elmo
4159 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4160 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4189 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4200 ;; backward compatibility to old version of wl
4203 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4216 ;;; Variables for pre-computed regular expressions, all buffer local
4231 "Matches a headline and puts everything into groups:
4232 group 1: the stars
4233 group 2: The todo keyword, maybe
4234 group 3: Priority cookie
4235 group 4: True headline
4239 "Matches a headline and puts TODO state into group 2 if present.
4284 rear-nonsticky t mouse-map t fontified t)
4291 s)
4298 s)
4307 "Modified `buffer-invisibility-spec' for Emacs 21.
4308 Some ops with invisible text do not work correctly on Emacs 21. For these
4309 we turn off invisibility temporarily. Use this in a `let' form."
4313 "Make VAR local in current buffer and set it to VALUE."
4317 "Check if the current buffer is in Org-mode."
4321 "Return the last element of LIST."
4354 "Variable associated with STARTUP options for org-mode.
4355 Each element is a list of three items: The startup options as written
4356 in the #+STARTUP line, the corresponding variable, and the value to
4357 set this variable to if the option is found. An optional forth element PUSH
4361 "Precompute regular expressions for current buffer."
4376 kwds kws0 kwsa key value cat arch tags const links hw dws
4377 tail sep kws1 prio props drawers
4378 ex log)
4402 links)))
4408 props)))
4415 l var val)
4430 )))
4444 ;; Process the TODO keywords
4446 ;; Use the global values as if they had been given locally.
4457 kwsa nil
4469 kw)
4471 kws0)
4488 ;; Process the constants
4496 ;; Process the tags.
4506 tgs))
4514 ;; Compute the regular expressions and other local variables
4519 org-drawer-regexp
4523 org-not-done-keywords
4525 org-todo-regexp
4528 org-not-done-regexp
4532 org-todo-line-regexp
4536 org-complex-heading-regexp
4541 org-nl-done-regexp
4545 org-todo-line-tags-regexp
4550 org-looking-at-done-regexp
4555 org-deadline-time-regexp
4557 org-deadline-line-regexp
4559 org-scheduled-regexp
4561 org-scheduled-time-regexp
4563 org-closed-time-regexp
4565 org-keyword-time-regexp
4571 org-keyword-time-not-clock-regexp
4577 org-maybe-keyword-time-regexp
4583 org-planning-or-clock-line-re
4588 )
4596 x))
4597 list))
4599 ;; FIXME: this could be done much better, using second characters etc.
4601 "Assign fast keys to a keyword-key alist.
4602 Respect keys that are already there."
4612 ;; automatically assign a character.
4624 ;;; Some variables ujsed in various places
4629 "Function to be called when `C-c C-c' is used.
4633 ;; FIXME: Occasionally check by commenting these, to make sure
4634 ;; no other functions uses these, forgetting to let-bind them.
4641 ;; Defined somewhere in this file, but used before definition.
4654 ;;;; Emacs/XEmacs compatibility
4656 ;; Overlay compatibility functions
4674 "Make overlay OVL display TEXT with face FACE."
4684 "Make overlay OVL display TEXT with face FACE."
4707 "Find all overlays specifying PROP at POS or point.
4708 If DELETE is non-nil, delete all those overlays."
4710 ov found)
4714 found))
4716 ;; Region compatibility
4719 "Add-hook, compatible with both Emacsen."
4728 "Is `transient-mark-mode' on and the region active?
4729 Works on both Emacs and XEmacs."
4731 nil
4738 ;; Invisibility compatibility
4741 "Add elements to `buffer-invisibility-spec'.
4742 See documentation for `buffer-invisibility-spec' for the kind of elements
4743 that can be added."
4754 "Remove elements from `buffer-invisibility-spec'."
4762 "Is ARG a member of `buffer-invisibility-spec'?"
4765 nil))
4767 ;;;; Define the Org-mode
4770 (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."))
4773 ;; We use a before-change function to check if a table might need
4774 ;; an update.
4776 "Indicates that a table might need an update.
4777 This variable is set by `org-before-change-function'.
4786 ;;;###autoload
4788 "Outline-based notes management and organizer, alias
4791 Org-mode develops organizational tasks around a NOTES file which
4792 contains information about projects as plain text. Org-mode is
4793 implemented on top of outline-mode, which is ideal to keep the content
4794 of large files well structured. It supports ToDo items, deadlines and
4795 time stamps, which magically appear in the diary listing of the Emacs
4796 calendar. Tables are easily created with a built-in table editor.
4797 Plain text URL-like links connect to websites, emails (VM), Usenet
4798 messages (Gnus), BBDB entries, and any files related to the project.
4799 For printing and sharing of notes, an Org-mode file (or a part of it)
4800 can be exported as a structured ASCII or HTML file.
4802 The following commands are available:
4806 ;; Get rid of Outline menus, they are not needed
4807 ;; Need to do this here because define-derived-mode sets up
4808 ;; the keymap so late. Still, it is a waste to call this each time
4809 ;; we switch another buffer into org-mode.
4812 ;; Assume this is Greg's port, it used easymenu
4835 org-display-table 4
4838 org-ellipsis)))
4842 ;; Calc embedded
4849 ;; Activate before-change-function
4853 ;; Check for running clock before killing a buffer
4855 ;; Paragraphs and auto-filling
4860 ;; Comment characters
4861 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4864 ;; Imenu
4868 ;; Make isearch reveal context
4871 ;; Emacs 21 and XEmacs make use of the hook
4873 ;; Emacs 22 deals with this through a special variable
4877 ;; If empty file that did not turn on org-mode automatically, make it to.
4899 "Call COMMAND interactively, but pretend prefix are was ARG."
4905 ;; works also in narrowed buffer, because we start at 1, not point-min
4909 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4919 "Add text properties to entire string, from beginning to end.
4920 PLIST may be a list of properties, PROPS are individual properties and values
4921 that will be added to PLIST. Returns the string that was modified."
4924 string)
4928 ;;;; Font-Lock stuff, including the activators
4933 (org-defkey org-mouse-map
4934 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4935 (when org-mouse-1-follows-link
4936 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4937 (when org-tab-follows-link
4938 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4939 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4940 (when org-return-follows-link
4941 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4942 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
4944 (require 'font-lock)
4947 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
4948 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
4949 (defvar org-link-re-with-space nil
4950 "Matches a link with spaces, optional angular brackets around it.")
4951 (defvar org-link-re-with-space2 nil
4952 "Matches a link with spaces, optional angular brackets around it.")
4953 (defvar org-angle-link-re nil
4954 "Matches link with angular brackets, spaces are allowed.")
4955 (defvar org-plain-link-re nil
4956 "Matches plain link, without spaces.")
4957 (defvar org-bracket-link-regexp nil
4958 "Matches a link in double brackets.")
4959 (defvar org-bracket-link-analytic-regexp nil
4960 "Regular expression used to analyze links.
4961 Here is what the match groups contain after a match:
4962 1: http:
4963 2: http
4964 3: path
4965 4: [desc]
4966 5: desc")
4967 (defvar org-any-link-re nil
4968 "Regular expression matching any link.")
4970 (defun org-make-link-regexps ()
4971 "Update the link regular expressions.
4972 This should be called after the variable `org-link-types' has changed."
4973 (setq org-link-re-with-space
4974 (concat
4977 "[^" org-non-link-chars "]*"
4979 org-link-re-with-space2
4980 (concat
4985 org-angle-link-re
4986 (concat
4989 "[^" org-non-link-chars "]*"
4991 org-plain-link-re
4992 (concat
4995 org-bracket-link-regexp
4997 org-bracket-link-analytic-regexp
4998 (concat
5005 org-any-link-re
5010 (org-make-link-regexps)
5013 "Regular expression for fast time stamp matching.")
5015 "Regular expression for fast time stamp matching.")
5016 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5017 "Regular expression matching time strings for analysis.
5018 This one does not require the space after the date.")
5019 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5020 "Regular expression matching time strings for analysis.")
5022 "Regular expression matching time stamps, with groups.")
5024 "Regular expression matching time stamps (also [..]), with groups.")
5025 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5026 "Regular expression matching a time stamp range.")
5027 (defconst org-tr-regexp-both
5028 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5029 "Regular expression matching a time stamp range.")
5032 "Regular expression matching a time stamp or time stamp range.")
5035 "Regular expression matching a time stamp or time stamp range.
5036 The time stamps may be either active or inactive.")
5038 (defvar org-emph-face nil)
5040 (defun org-do-emphasis-faces (limit)
5041 "Run through the buffer and add overlays to links."
5042 (let (rtn)
5043 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5044 (if (not (= (char-after (match-beginning 3))
5045 (char-after (match-beginning 4))))
5046 (progn
5047 (setq rtn t)
5048 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5049 'face
5050 (nth 1 (assoc (match-string 3)
5051 org-emphasis-alist)))
5052 (add-text-properties (match-beginning 2) (match-end 2)
5053 '(font-lock-multiline t))
5054 (when org-hide-emphasis-markers
5055 (add-text-properties (match-end 4) (match-beginning 5)
5056 '(invisible org-link))
5057 (add-text-properties (match-beginning 3) (match-end 3)
5058 '(invisible org-link)))))
5059 (backward-char 1))
5060 rtn))
5062 (defun org-emphasize (&optional char)
5063 "Insert or change an emphasis, i.e. a font like bold or italic.
5064 If there is an active region, change that region to a new emphasis.
5065 If there is no region, just insert the marker characters and position
5066 the cursor between them.
5067 CHAR should be either the marker character, or the first character of the
5068 HTML tag associated with that emphasis. If CHAR is a space, the means
5069 to remove the emphasis of the selected region.
5070 If char is not given (for example in an interactive call) it
5071 will be prompted for."
5072 (interactive)
5073 (let ((eal org-emphasis-alist) e det
5074 (erc org-emphasis-regexp-components)
5075 (prompt "")
5076 (string "") beg end move tag c s)
5077 (if (org-region-active-p)
5078 (setq beg (region-beginning) end (region-end)
5079 string (buffer-substring beg end))
5080 (setq move t))
5082 (while (setq e (pop eal))
5083 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5084 c (aref tag 0))
5085 (push (cons c (string-to-char (car e))) det)
5086 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5087 (substring tag 1)))))
5088 (unless char
5089 (message "%s" (concat "Emphasis marker or tag:" prompt))
5090 (setq char (read-char-exclusive)))
5091 (setq char (or (cdr (assoc char det)) char))
5092 (if (equal char ?\ )
5093 (setq s "" move nil)
5094 (unless (assoc (char-to-string char) org-emphasis-alist)
5096 (setq s (char-to-string char)))
5097 (while (and (> (length string) 1)
5098 (equal (substring string 0 1) (substring string -1))
5099 (assoc (substring string 0 1) org-emphasis-alist))
5100 (setq string (substring string 1 -1)))
5101 (setq string (concat s string s))
5102 (if beg (delete-region beg end))
5103 (unless (or (bolp)
5105 (char-to-string (char-before (point)))))
5106 (insert " "))
5108 (char-to-string (char-after (point))))
5109 (insert " ") (backward-char 1))
5110 (insert string)
5111 (and move (backward-char 1))))
5113 (defconst org-nonsticky-props
5114 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5117 (defun org-activate-plain-links (limit)
5118 "Run through the buffer and add overlays to links."
5119 (catch 'exit
5120 (let (f)
5121 (while (re-search-forward org-plain-link-re limit t)
5122 (setq f (get-text-property (match-beginning 0) 'face))
5123 (if (or (eq f 'org-tag)
5124 (and (listp f) (memq 'org-tag f)))
5125 nil
5126 (add-text-properties (match-beginning 0) (match-end 0)
5127 (list 'mouse-face 'highlight
5128 'rear-nonsticky org-nonsticky-props
5129 'keymap org-mouse-map
5130 ))
5131 (throw 'exit t))))))
5133 (defun org-activate-code (limit)
5135 (unless (get-text-property (match-beginning 1) 'face)
5136 (remove-text-properties (match-beginning 0) (match-end 0)
5137 '(display t invisible t intangible t))
5138 t)))
5140 (defun org-activate-angle-links (limit)
5141 "Run through the buffer and add overlays to links."
5142 (if (re-search-forward org-angle-link-re limit t)
5143 (progn
5144 (add-text-properties (match-beginning 0) (match-end 0)
5145 (list 'mouse-face 'highlight
5146 'rear-nonsticky org-nonsticky-props
5147 'keymap org-mouse-map
5148 ))
5149 t)))
5151 (defmacro org-maybe-intangible (props)
5152 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5153 In emacs 21, invisible text is not avoided by the command loop, so the
5154 intangible property is needed to make sure point skips this text.
5155 In Emacs 22, this is not necessary. The intangible text property has
5156 led to problems with flyspell. These problems are fixed in flyspell.el,
5157 but we still avoid setting the property in Emacs 22 and later.
5158 We use a macro so that the test can happen at compilation time."
5159 (if (< emacs-major-version 22)
5160 `(append '(intangible t) ,props)
5161 props))
5163 (defun org-activate-bracket-links (limit)
5164 "Run through the buffer and add overlays to bracketed links."
5165 (if (re-search-forward org-bracket-link-regexp limit t)
5166 (let* ((help (concat "LINK: "
5167 (org-match-string-no-properties 1)))
5168 ;; FIXME: above we should remove the escapes.
5169 ;; but that requires another match, protecting match data,
5170 ;; a lot of overhead for font-lock.
5171 (ip (org-maybe-intangible
5172 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5173 'keymap org-mouse-map 'mouse-face 'highlight
5174 'font-lock-multiline t 'help-echo help)))
5175 (vp (list 'rear-nonsticky org-nonsticky-props
5176 'keymap org-mouse-map 'mouse-face 'highlight
5177 ' font-lock-multiline t 'help-echo help)))
5178 ;; We need to remove the invisible property here. Table narrowing
5179 ;; may have made some of this invisible.
5180 (remove-text-properties (match-beginning 0) (match-end 0)
5181 '(invisible nil))
5182 (if (match-end 3)
5183 (progn
5184 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5185 (add-text-properties (match-beginning 3) (match-end 3) vp)
5186 (add-text-properties (match-end 3) (match-end 0) ip))
5187 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5188 (add-text-properties (match-beginning 1) (match-end 1) vp)
5189 (add-text-properties (match-end 1) (match-end 0) ip))
5190 t)))
5192 (defun org-activate-dates (limit)
5193 "Run through the buffer and add overlays to dates."
5194 (if (re-search-forward org-tsr-regexp-both limit t)
5195 (progn
5196 (add-text-properties (match-beginning 0) (match-end 0)
5197 (list 'mouse-face 'highlight
5198 'rear-nonsticky org-nonsticky-props
5199 'keymap org-mouse-map))
5200 (when org-display-custom-times
5201 (if (match-end 3)
5202 (org-display-custom-time (match-beginning 3) (match-end 3)))
5203 (org-display-custom-time (match-beginning 1) (match-end 1)))
5204 t)))
5206 (defvar org-target-link-regexp nil
5207 "Regular expression matching radio targets in plain text.")
5209 "Regular expression matching a link target.")
5211 "Regular expression matching a radio target.")
5212 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5213 "Regular expression matching any target.")
5215 (defun org-activate-target-links (limit)
5216 "Run through the buffer and add overlays to target matches."
5217 (when org-target-link-regexp
5218 (let ((case-fold-search t))
5219 (if (re-search-forward org-target-link-regexp limit t)
5220 (progn
5221 (add-text-properties (match-beginning 0) (match-end 0)
5222 (list 'mouse-face 'highlight
5223 'rear-nonsticky org-nonsticky-props
5224 'keymap org-mouse-map
5225 'help-echo "Radio target link"
5226 'org-linked-text t))
5227 t)))))
5229 (defun org-update-radio-target-regexp ()
5230 "Find all radio targets in this file and update the regular expression."
5231 (interactive)
5232 (when (memq 'radio org-activate-links)
5233 (setq org-target-link-regexp
5234 (org-make-target-link-regexp (org-all-targets 'radio)))
5235 (org-restart-font-lock)))
5237 (defun org-hide-wide-columns (limit)
5238 (let (s e)
5239 (setq s (text-property-any (point) (or limit (point-max))
5240 'org-cwidth t))
5241 (when s
5242 (setq e (next-single-property-change s 'org-cwidth))
5243 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5244 (goto-char e)
5245 t)))
5247 (defvar org-latex-and-specials-regexp nil
5248 "Regular expression for highlighting export special stuff.")
5249 (defvar org-match-substring-regexp)
5250 (defvar org-match-substring-with-braces-regexp)
5251 (defvar org-export-html-special-string-regexps)
5253 (defun org-compute-latex-and-specials-regexp ()
5254 "Compute regular expression for stuff treated specially by exporters."
5255 (if (not org-highlight-latex-fragments-and-specials)
5256 (org-set-local 'org-latex-and-specials-regexp nil)
5257 (let*
5258 ((matchers (plist-get org-format-latex-options :matchers))
5259 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5260 org-latex-regexps)))
5261 (options (org-combine-plists (org-default-export-plist)
5262 (org-infile-export-plist)))
5263 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5264 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5265 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5266 (org-export-html-expand (plist-get options :expand-quoted-html))
5267 (org-export-with-special-strings (plist-get options :special-strings))
5268 (re-sub
5269 (cond
5270 ((equal org-export-with-sub-superscripts '{})
5271 (list org-match-substring-with-braces-regexp))
5272 (org-export-with-sub-superscripts
5273 (list org-match-substring-regexp))
5274 (t nil)))
5275 (re-latex
5276 (if org-export-with-LaTeX-fragments
5277 (mapcar (lambda (x) (nth 1 x)) latexs)))
5278 (re-macros
5279 (if org-export-with-TeX-macros
5281 (regexp-opt
5282 (append (mapcar 'car org-html-entities)
5283 (if (boundp 'org-latex-entities)
5284 org-latex-entities nil))
5285 'words))) ; FIXME
5286 ))
5288 (re-special (if org-export-with-special-strings
5289 (mapcar (lambda (x) (car x))
5290 org-export-html-special-string-regexps)))
5291 (re-rest
5292 (delq nil
5293 (list
5295 ))))
5296 (org-set-local
5297 'org-latex-and-specials-regexp
5298 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5301 (defface org-latex-and-export-specials
5302 (let ((font (cond ((assq :inherit custom-face-attributes)
5303 '(:inherit underline))
5304 (t '(:underline t)))))
5305 `((((class grayscale) (background light))
5306 (:foreground "DimGray" ,@font))
5307 (((class grayscale) (background dark))
5308 (:foreground "LightGray" ,@font))
5309 (((class color) (background light))
5310 (:foreground "SaddleBrown"))
5311 (((class color) (background dark))
5312 (:foreground "burlywood"))
5313 (t (,@font))))
5314 "Face used to highlight math latex and other special exporter stuff."
5315 :group 'org-faces)
5317 (defun org-do-latex-and-special-faces (limit)
5318 "Run through the buffer and add overlays to links."
5319 (when org-latex-and-specials-regexp
5320 (let (rtn d)
5321 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5322 limit t))
5323 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5324 'face))
5325 '(org-code org-verbatim underline)))
5326 (progn
5327 (setq rtn t
5328 d (cond ((member (char-after (1+ (match-beginning 0)))
5329 '(?_ ?^)) 1)
5330 (t 0)))
5331 (font-lock-prepend-text-property
5332 (+ d (match-beginning 0)) (match-end 0)
5333 'face 'org-latex-and-export-specials)
5334 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5335 '(font-lock-multiline t)))))
5336 rtn)))
5338 (defun org-restart-font-lock ()
5339 "Restart font-lock-mode, to force refontification."
5340 (when (and (boundp 'font-lock-mode) font-lock-mode)
5341 (font-lock-mode -1)
5342 (font-lock-mode 1)))
5344 (defun org-all-targets (&optional radio)
5345 "Return a list of all targets in this file.
5346 With optional argument RADIO, only find radio targets."
5347 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5348 rtn)
5349 (save-excursion
5350 (goto-char (point-min))
5351 (while (re-search-forward re nil t)
5352 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5353 rtn)))
5355 (defun org-make-target-link-regexp (targets)
5356 "Make regular expression matching all strings in TARGETS.
5357 The regular expression finds the targets also if there is a line break
5358 between words."
5359 (and targets
5360 (concat
5362 (mapconcat
5363 (lambda (x)
5364 (while (string-match " +" x)
5366 x)
5367 targets
5371 (defun org-activate-tags (limit)
5373 (progn
5374 (add-text-properties (match-beginning 1) (match-end 1)
5375 (list 'mouse-face 'highlight
5376 'rear-nonsticky org-nonsticky-props
5377 'keymap org-mouse-map))
5378 t)))
5380 (defun org-outline-level ()
5381 (save-excursion
5382 (looking-at outline-regexp)
5383 (if (match-beginning 1)
5384 (+ (org-get-string-indentation (match-string 1)) 1000)
5385 (1- (- (match-end 0) (match-beginning 0))))))
5387 (defvar org-font-lock-keywords nil)
5390 "Regular expression matching a property line.")
5392 (defun org-set-font-lock-defaults ()
5393 (let* ((em org-fontify-emphasized-text)
5394 (lk org-activate-links)
5395 (org-font-lock-extra-keywords
5396 (list
5397 ;; Headlines
5399 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5400 ;; Table lines
5402 (1 'org-table t))
5403 ;; Table internals
5407 ;; Drawers
5408 (list org-drawer-regexp '(0 'org-special-keyword t))
5410 ;; Properties
5411 (list org-property-re
5412 '(1 'org-special-keyword t)
5413 '(3 'org-property-value t))
5414 (if org-format-transports-properties-p
5416 ;; Links
5417 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5418 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5419 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5420 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5421 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5422 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5424 '(org-hide-wide-columns (0 nil append))
5425 ;; TODO lines
5427 '(1 (org-get-todo-face 1) t))
5428 ;; DONE
5429 (if org-fontify-done-headline
5433 '(2 'org-headline-done t))
5434 nil)
5435 ;; Priorities
5437 ;; Special keywords
5442 ;; Emphasis
5443 (if em
5444 (if (featurep 'xemacs)
5445 '(org-do-emphasis-faces (0 nil append))
5446 '(org-do-emphasis-faces)))
5447 ;; Checkboxes
5449 2 'bold prepend)
5450 (if org-provide-checkbox-statistics
5452 (0 (org-get-checkbox-statistics-face) t)))
5454 '(1 'org-archived prepend))
5455 ;; Specials
5456 '(org-do-latex-and-special-faces)
5457 ;; Code
5458 '(org-activate-code (1 'org-code t))
5459 ;; COMMENT
5462 '(1 'org-special-keyword t))
5463 '("^#.*" (0 'font-lock-comment-face t))
5464 )))
5465 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5466 ;; Now set the full font-lock-keywords
5467 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5468 (org-set-local 'font-lock-defaults
5469 '(org-font-lock-keywords t nil nil backward-paragraph))
5470 (kill-local-variable 'font-lock-keywords) nil))
5472 (defvar org-m nil)
5473 (defvar org-l nil)
5474 (defvar org-f nil)
5475 (defun org-get-level-face (n)
5476 "Get the right face for match N in font-lock matching of healdines."
5477 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5478 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5479 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5480 (cond
5481 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5482 ((eq n 2) org-f)
5483 (t (if org-level-color-stars-only nil org-f))))
5485 (defun org-get-todo-face (kwd)
5486 "Get the right face for a TODO keyword KWD.
5487 If KWD is a number, get the corresponding match group."
5488 (if (numberp kwd) (setq kwd (match-string kwd)))
5489 (or (cdr (assoc kwd org-todo-keyword-faces))
5490 (and (member kwd org-done-keywords) 'org-done)
5491 'org-todo))
5493 (defun org-unfontify-region (beg end &optional maybe_loudly)
5494 "Remove fontification and activation overlays from links."
5495 (font-lock-default-unfontify-region beg end)
5496 (let* ((buffer-undo-list t)
5497 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5498 (inhibit-modification-hooks t)
5499 deactivate-mark buffer-file-name buffer-file-truename)
5500 (remove-text-properties beg end
5501 '(mouse-face t keymap t org-linked-text t
5502 invisible t intangible t))))
5504 ;;;; Visibility cycling, including org-goto and indirect buffer
5506 ;;; Cycling
5508 (defvar org-cycle-global-status nil)
5509 (make-variable-buffer-local 'org-cycle-global-status)
5510 (defvar org-cycle-subtree-status nil)
5511 (make-variable-buffer-local 'org-cycle-subtree-status)
5513 ;;;###autoload
5514 (defun org-cycle (&optional arg)
5515 "Visibility cycling for Org-mode.
5517 - When this function is called with a prefix argument, rotate the entire
5518 buffer through 3 states (global cycling)
5519 1. OVERVIEW: Show only top-level headlines.
5520 2. CONTENTS: Show all headlines of all levels, but no body text.
5521 3. SHOW ALL: Show everything.
5523 - When point is at the beginning of a headline, rotate the subtree started
5524 by this line through 3 different states (local cycling)
5525 1. FOLDED: Only the main headline is shown.
5526 2. CHILDREN: The main headline and the direct children are shown.
5527 From this state, you can move to one of the children
5528 and zoom in further.
5529 3. SUBTREE: Show the entire subtree, including body text.
5531 - When there is a numeric prefix, go up to a heading with level ARG, do
5532 a `show-subtree' and return to the previous cursor position. If ARG
5533 is negative, go up that many levels.
5535 - When point is not at the beginning of a headline, execute
5536 `indent-relative', like TAB normally does. See the option
5537 `org-cycle-emulate-tab' for details.
5539 - Special case: if point is at the beginning of the buffer and there is
5540 no headline in line 1, this function will act as if called with prefix arg.
5541 But only if also the variable `org-cycle-global-at-bob' is t."
5542 (interactive "P")
5543 (let* ((outline-regexp
5544 (if (and (org-mode-p) org-cycle-include-plain-lists)
5546 outline-regexp))
5547 (bob-special (and org-cycle-global-at-bob (bobp)
5548 (not (looking-at outline-regexp))))
5549 (org-cycle-hook
5550 (if bob-special
5551 (delq 'org-optimize-window-after-visibility-change
5552 (copy-sequence org-cycle-hook))
5553 org-cycle-hook))
5554 (pos (point)))
5556 (if (or bob-special (equal arg '(4)))
5557 ;; special case: use global cycling
5558 (setq arg t))
5560 (cond
5562 ((org-at-table-p 'any)
5563 ;; Enter the table or move to the next field in the table
5564 (or (org-table-recognize-table.el)
5565 (progn
5566 (if arg (org-table-edit-field t)
5567 (org-table-justify-field-maybe)
5568 (call-interactively 'org-table-next-field)))))
5570 ((eq arg t) ;; Global cycling
5572 (cond
5573 ((and (eq last-command this-command)
5574 (eq org-cycle-global-status 'overview))
5575 ;; We just created the overview - now do table of contents
5576 ;; This can be slow in very large buffers, so indicate action
5577 (message "CONTENTS...")
5578 (org-content)
5579 (message "CONTENTS...done")
5580 (setq org-cycle-global-status 'contents)
5581 (run-hook-with-args 'org-cycle-hook 'contents))
5583 ((and (eq last-command this-command)
5584 (eq org-cycle-global-status 'contents))
5585 ;; We just showed the table of contents - now show everything
5586 (show-all)
5587 (message "SHOW ALL")
5588 (setq org-cycle-global-status 'all)
5589 (run-hook-with-args 'org-cycle-hook 'all))
5591 (t
5592 ;; Default action: go to overview
5593 (org-overview)
5594 (message "OVERVIEW")
5595 (setq org-cycle-global-status 'overview)
5596 (run-hook-with-args 'org-cycle-hook 'overview))))
5598 ((and org-drawers org-drawer-regexp
5599 (save-excursion
5600 (beginning-of-line 1)
5601 (looking-at org-drawer-regexp)))
5602 ;; Toggle block visibility
5603 (org-flag-drawer
5604 (not (get-char-property (match-end 0) 'invisible))))
5606 ((integerp arg)
5607 ;; Show-subtree, ARG levels up from here.
5608 (save-excursion
5609 (org-back-to-heading)
5610 (outline-up-heading (if (< arg 0) (- arg)
5611 (- (funcall outline-level) arg)))
5612 (org-show-subtree)))
5614 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5615 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5616 ;; At a heading: rotate between three different views
5617 (org-back-to-heading)
5618 (let ((goal-column 0) eoh eol eos)
5619 ;; First, some boundaries
5620 (save-excursion
5621 (org-back-to-heading)
5622 (save-excursion
5623 (beginning-of-line 2)
5624 (while (and (not (eobp)) ;; this is like `next-line'
5625 (get-char-property (1- (point)) 'invisible))
5626 (beginning-of-line 2)) (setq eol (point)))
5627 (outline-end-of-heading) (setq eoh (point))
5628 (org-end-of-subtree t)
5629 (unless (eobp)
5631 (beginning-of-line 1) ; in case this is an item
5632 )
5633 (setq eos (1- (point))))
5634 ;; Find out what to do next and set `this-command'
5635 (cond
5636 ((= eos eoh)
5637 ;; Nothing is hidden behind this heading
5638 (message "EMPTY ENTRY")
5639 (setq org-cycle-subtree-status nil)
5640 (save-excursion
5641 (goto-char eos)
5642 (outline-next-heading)
5643 (if (org-invisible-p) (org-flag-heading nil))))
5644 ((or (>= eol eos)
5646 ;; Entire subtree is hidden in one line: open it
5647 (org-show-entry)
5648 (show-children)
5649 (message "CHILDREN")
5650 (save-excursion
5651 (goto-char eos)
5652 (outline-next-heading)
5653 (if (org-invisible-p) (org-flag-heading nil)))
5654 (setq org-cycle-subtree-status 'children)
5655 (run-hook-with-args 'org-cycle-hook 'children))
5656 ((and (eq last-command this-command)
5657 (eq org-cycle-subtree-status 'children))
5658 ;; We just showed the children, now show everything.
5659 (org-show-subtree)
5660 (message "SUBTREE")
5661 (setq org-cycle-subtree-status 'subtree)
5662 (run-hook-with-args 'org-cycle-hook 'subtree))
5663 (t
5664 ;; Default action: hide the subtree.
5665 (hide-subtree)
5666 (message "FOLDED")
5667 (setq org-cycle-subtree-status 'folded)
5668 (run-hook-with-args 'org-cycle-hook 'folded)))))
5670 ;; TAB emulation
5671 (buffer-read-only (org-back-to-heading))
5673 ((org-try-cdlatex-tab))
5675 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5676 (or (not (bolp))
5677 (not (looking-at outline-regexp))))
5680 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5682 (or (and (eq org-cycle-emulate-tab 'white)
5683 (= (match-end 0) (point-at-eol)))
5684 (and (eq org-cycle-emulate-tab 'whitestart)
5685 (>= (match-end 0) pos))))
5686 t
5687 (eq org-cycle-emulate-tab t))
5690 ; (point-at-bol) (point))))
5691 ; (progn
5692 ; (beginning-of-line 1)
5696 (t (save-excursion
5697 (org-back-to-heading)
5698 (org-cycle))))))
5700 ;;;###autoload
5701 (defun org-global-cycle (&optional arg)
5702 "Cycle the global visibility. For details see `org-cycle'."
5703 (interactive "P")
5704 (let ((org-cycle-include-plain-lists
5705 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5706 (if (integerp arg)
5707 (progn
5708 (show-all)
5709 (hide-sublevels arg)
5710 (setq org-cycle-global-status 'contents))
5711 (org-cycle '(4)))))
5713 (defun org-overview ()
5714 "Switch to overview mode, shoing only top-level headlines.
5715 Really, this shows all headlines with level equal or greater than the level
5716 of the first headline in the buffer. This is important, because if the
5717 first headline is not level one, then (hide-sublevels 1) gives confusing
5718 results."
5719 (interactive)
5720 (let ((level (save-excursion
5721 (goto-char (point-min))
5722 (if (re-search-forward (concat "^" outline-regexp) nil t)
5723 (progn
5724 (goto-char (match-beginning 0))
5725 (funcall outline-level))))))
5726 (and level (hide-sublevels level))))
5728 (defun org-content (&optional arg)
5729 "Show all headlines in the buffer, like a table of contents.
5730 With numerical argument N, show content up to level N."
5731 (interactive "P")
5732 (save-excursion
5733 ;; Visit all headings and show their offspring
5734 (and (integerp arg) (org-overview))
5735 (goto-char (point-max))
5736 (catch 'exit
5737 (while (and (progn (condition-case nil
5738 (outline-previous-visible-heading 1)
5739 (error (goto-char (point-min))))
5740 t)
5741 (looking-at outline-regexp))
5742 (if (integerp arg)
5743 (show-children (1- arg))
5744 (show-branches))
5745 (if (bobp) (throw 'exit nil))))))
5748 (defun org-optimize-window-after-visibility-change (state)
5749 "Adjust the window after a change in outline visibility.
5750 This function is the default value of the hook `org-cycle-hook'."
5751 (when (get-buffer-window (current-buffer))
5752 (cond
5753 ; ((eq state 'overview) (org-first-headline-recenter 1))
5754 ; ((eq state 'overview) (org-beginning-of-line))
5755 ((eq state 'content) nil)
5756 ((eq state 'all) nil)
5757 ((eq state 'folded) nil)
5758 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5759 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5761 (defun org-compact-display-after-subtree-move ()
5762 (let (beg end)
5763 (save-excursion
5764 (if (org-up-heading-safe)
5765 (progn
5766 (hide-subtree)
5767 (show-entry)
5768 (show-children)
5769 (org-cycle-show-empty-lines 'children)
5770 (org-cycle-hide-drawers 'children))
5771 (org-overview)))))
5773 (defun org-cycle-show-empty-lines (state)
5774 "Show empty lines above all visible headlines.
5775 The region to be covered depends on STATE when called through
5776 `org-cycle-hook'. Lisp program can use t for STATE to get the
5777 entire buffer covered. Note that an empty line is only shown if there
5778 are at least `org-cycle-separator-lines' empty lines before the headeline."
5779 (when (> org-cycle-separator-lines 0)
5780 (save-excursion
5781 (let* ((n org-cycle-separator-lines)
5782 (re (cond
5785 (t (let ((ns (number-to-string (- n 2))))
5788 beg end)
5789 (cond
5790 ((memq state '(overview contents t))
5791 (setq beg (point-min) end (point-max)))
5792 ((memq state '(children folded))
5793 (setq beg (point) end (progn (org-end-of-subtree t t)
5794 (beginning-of-line 2)
5795 (point)))))
5796 (when beg
5797 (goto-char beg)
5798 (while (re-search-forward re end t)
5799 (if (not (get-char-property (match-end 1) 'invisible))
5800 (outline-flag-region
5801 (match-beginning 1) (match-end 1) nil)))))))
5802 ;; Never hide empty lines at the end of the file.
5803 (save-excursion
5804 (goto-char (point-max))
5805 (outline-previous-heading)
5806 (outline-end-of-heading)
5808 (= (match-end 0) (point-max)))
5809 (outline-flag-region (point) (match-end 0) nil))))
5811 (defun org-subtree-end-visible-p ()
5812 "Is the end of the current subtree visible?"
5813 (pos-visible-in-window-p
5814 (save-excursion (org-end-of-subtree t) (point))))
5816 (defun org-first-headline-recenter (&optional N)
5817 "Move cursor to the first headline and recenter the headline.
5818 Optional argument N means, put the headline into the Nth line of the window."
5819 (goto-char (point-min))
5821 (beginning-of-line)
5822 (recenter (prefix-numeric-value N))))
5824 ;;; Org-goto
5826 (defvar org-goto-window-configuration nil)
5827 (defvar org-goto-marker nil)
5828 (defvar org-goto-map
5829 (let ((map (make-sparse-keymap)))
5830 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5831 (while (setq cmd (pop cmds))
5832 (substitute-key-definition cmd cmd map global-map)))
5833 (suppress-keymap map)
5834 (org-defkey map "\C-m" 'org-goto-ret)
5835 (org-defkey map [(left)] 'org-goto-left)
5836 (org-defkey map [(right)] 'org-goto-right)
5837 (org-defkey map [(?q)] 'org-goto-quit)
5838 (org-defkey map [(control ?g)] 'org-goto-quit)
5839 (org-defkey map "\C-i" 'org-cycle)
5840 (org-defkey map [(tab)] 'org-cycle)
5841 (org-defkey map [(down)] 'outline-next-visible-heading)
5842 (org-defkey map [(up)] 'outline-previous-visible-heading)
5843 (org-defkey map "n" 'outline-next-visible-heading)
5844 (org-defkey map "p" 'outline-previous-visible-heading)
5845 (org-defkey map "f" 'outline-forward-same-level)
5846 (org-defkey map "b" 'outline-backward-same-level)
5847 (org-defkey map "u" 'outline-up-heading)
5848 (org-defkey map "/" 'org-occur)
5849 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5850 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5851 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5852 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5853 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5854 map))
5856 (defconst org-goto-help
5857 "Browse copy of buffer to find location or copy text.
5858 RET=jump to location [Q]uit and return to previous location
5859 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur"
5860 )
5862 (defvar org-goto-start-pos) ; dynamically scoped parameter
5864 (defun org-goto ()
5865 "Look up a different location in the current file, keeping current visibility.
5867 When you want look-up or go to a different location in a document, the
5868 fastest way is often to fold the entire buffer and then dive into the tree.
5869 This method has the disadvantage, that the previous location will be folded,
5870 which may not be what you want.
5872 This command works around this by showing a copy of the current buffer
5873 in an indirect buffer, in overview mode. You can dive into the tree in
5874 that copy, use org-occur and incremental search to find a location.
5875 When pressing RET or `Q', the command returns to the original buffer in
5876 which the visibility is still unchanged. After RET is will also jump to
5877 the location selected in the indirect buffer and expose the
5878 the headline hierarchy above."
5879 (interactive)
5880 (let* ((org-goto-start-pos (point))
5881 (selected-point
5882 (car (org-get-location (current-buffer) org-goto-help))))
5883 (if selected-point
5884 (progn
5885 (org-mark-ring-push org-goto-start-pos)
5886 (goto-char selected-point)
5887 (if (or (org-invisible-p) (org-invisible-p2))
5888 (org-show-context 'org-goto)))
5889 (message "Quit"))))
5891 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5892 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5894 (defun org-get-location (buf help)
5895 "Let the user select a location in the Org-mode buffer BUF.
5896 This function uses a recursive edit. It returns the selected position
5897 or nil."
5898 (let (org-goto-selected-point org-goto-exit-command)
5899 (save-excursion
5900 (save-window-excursion
5901 (delete-other-windows)
5902 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5903 (switch-to-buffer
5904 (condition-case nil
5905 (make-indirect-buffer (current-buffer) "*org-goto*")
5906 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5907 (with-output-to-temp-buffer "*Help*"
5908 (princ help))
5909 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5910 (setq buffer-read-only nil)
5911 (let ((org-startup-truncated t)
5912 (org-startup-folded nil)
5913 (org-startup-align-all-tables nil))
5914 (org-mode)
5915 (org-overview))
5916 (setq buffer-read-only t)
5917 (if (and (boundp 'org-goto-start-pos)
5918 (integer-or-marker-p org-goto-start-pos))
5919 (let ((org-show-hierarchy-above t)
5920 (org-show-siblings t)
5921 (org-show-following-heading t))
5922 (goto-char org-goto-start-pos)
5923 (and (org-invisible-p) (org-show-context)))
5924 (goto-char (point-min)))
5925 (org-beginning-of-line)
5926 (message "Select location and press RET")
5927 ;; now we make sure that during selection, ony very few keys work
5928 ;; and that it is impossible to switch to another window.
5929 ; (let ((gm (current-global-map))
5930 ; (overriding-local-map org-goto-map))
5931 ; (unwind-protect
5932 ; (progn
5933 ; (use-global-map org-goto-map)
5934 ; (recursive-edit))
5935 ; (use-global-map gm)))
5936 (use-local-map org-goto-map)
5937 (recursive-edit)
5938 ))
5939 (kill-buffer "*org-goto*")
5940 (cons org-goto-selected-point org-goto-exit-command)))
5942 (defun org-goto-ret (&optional arg)
5943 "Finish `org-goto' by going to the new location."
5944 (interactive "P")
5945 (setq org-goto-selected-point (point)
5946 org-goto-exit-command 'return)
5947 (throw 'exit nil))
5949 (defun org-goto-left ()
5950 "Finish `org-goto' by going to the new location."
5951 (interactive)
5952 (if (org-on-heading-p)
5953 (progn
5954 (beginning-of-line 1)
5955 (setq org-goto-selected-point (point)
5956 org-goto-exit-command 'left)
5957 (throw 'exit nil))
5958 (error "Not on a heading")))
5960 (defun org-goto-right ()
5961 "Finish `org-goto' by going to the new location."
5962 (interactive)
5963 (if (org-on-heading-p)
5964 (progn
5965 (setq org-goto-selected-point (point)
5966 org-goto-exit-command 'right)
5967 (throw 'exit nil))
5968 (error "Not on a heading")))
5970 (defun org-goto-quit ()
5971 "Finish `org-goto' without cursor motion."
5972 (interactive)
5973 (setq org-goto-selected-point nil)
5974 (setq org-goto-exit-command 'quit)
5975 (throw 'exit nil))
5977 ;;; Indirect buffer display of subtrees
5979 (defvar org-indirect-dedicated-frame nil
5980 "This is the frame being used for indirect tree display.")
5981 (defvar org-last-indirect-buffer nil)
5983 (defun org-tree-to-indirect-buffer (&optional arg)
5984 "Create indirect buffer and narrow it to current subtree.
5985 With numerical prefix ARG, go up to this level and then take that tree.
5986 If ARG is negative, go up that many levels.
5987 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5988 indirect buffer previously made with this command, to avoid proliferation of
5989 indirect buffers. However, when you call the command with a `C-u' prefix, or
5990 when `org-indirect-buffer-display' is `new-frame', the last buffer
5991 is kept so that you can work with several indirect buffers at the same time.
5992 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5993 requests that a new frame be made for the new buffer, so that the dedicated
5994 frame is not changed."
5995 (interactive "P")
5996 (let ((cbuf (current-buffer))
5997 (cwin (selected-window))
5998 (pos (point))
5999 beg end level heading ibuf)
6000 (save-excursion
6001 (org-back-to-heading t)
6002 (when (numberp arg)
6003 (setq level (org-outline-level))
6004 (if (< arg 0) (setq arg (+ level arg)))
6005 (while (> (setq level (org-outline-level)) arg)
6006 (outline-up-heading 1 t)))
6007 (setq beg (point)
6008 heading (org-get-heading))
6009 (org-end-of-subtree t) (setq end (point)))
6010 (if (and (buffer-live-p org-last-indirect-buffer)
6011 (not (eq org-indirect-buffer-display 'new-frame))
6012 (not arg))
6013 (kill-buffer org-last-indirect-buffer))
6014 (setq ibuf (org-get-indirect-buffer cbuf)
6015 org-last-indirect-buffer ibuf)
6016 (cond
6017 ((or (eq org-indirect-buffer-display 'new-frame)
6018 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6019 (select-frame (make-frame))
6020 (delete-other-windows)
6021 (switch-to-buffer ibuf)
6022 (org-set-frame-title heading))
6023 ((eq org-indirect-buffer-display 'dedicated-frame)
6024 (raise-frame
6025 (select-frame (or (and org-indirect-dedicated-frame
6026 (frame-live-p org-indirect-dedicated-frame)
6027 org-indirect-dedicated-frame)
6028 (setq org-indirect-dedicated-frame (make-frame)))))
6029 (delete-other-windows)
6030 (switch-to-buffer ibuf)
6031 (org-set-frame-title (concat "Indirect: " heading)))
6032 ((eq org-indirect-buffer-display 'current-window)
6033 (switch-to-buffer ibuf))
6034 ((eq org-indirect-buffer-display 'other-window)
6035 (pop-to-buffer ibuf))
6036 (t (error "Invalid value.")))
6037 (if (featurep 'xemacs)
6038 (save-excursion (org-mode) (turn-on-font-lock)))
6039 (narrow-to-region beg end)
6040 (show-all)
6041 (goto-char pos)
6042 (and (window-live-p cwin) (select-window cwin))))
6044 (defun org-get-indirect-buffer (&optional buffer)
6045 (setq buffer (or buffer (current-buffer)))
6046 (let ((n 1) (base (buffer-name buffer)) bname)
6047 (while (buffer-live-p
6048 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6049 (setq n (1+ n)))
6050 (condition-case nil
6051 (make-indirect-buffer buffer bname 'clone)
6052 (error (make-indirect-buffer buffer bname)))))
6054 (defun org-set-frame-title (title)
6055 "Set the title of the current frame to the string TITLE."
6056 ;; FIXME: how to name a single frame in XEmacs???
6057 (unless (featurep 'xemacs)
6058 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6060 ;;;; Structure editing
6062 ;;; Inserting headlines
6064 (defun org-insert-heading (&optional force-heading)
6065 "Insert a new heading or item with same depth at point.
6066 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6067 If point is at the beginning of a headline, insert a sibling before the
6068 current headline. If point is in the middle of a headline, split the headline
6069 at that position and make the rest of the headline part of the sibling below
6070 the current headline."
6071 (interactive "P")
6072 (if (= (buffer-size) 0)
6074 (when (or force-heading (not (org-insert-item)))
6075 (let* ((head (save-excursion
6076 (condition-case nil
6077 (progn
6078 (org-back-to-heading)
6079 (match-string 0))
6080 (error "*"))))
6081 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6082 pos)
6083 (cond
6084 ((and (org-on-heading-p) (bolp)
6085 (or (bobp)
6086 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6087 (open-line (if blank 2 1)))
6088 ((and (bolp)
6089 (or (bobp)
6090 (save-excursion
6091 (backward-char 1) (not (org-invisible-p)))))
6092 nil)
6093 (t (newline (if blank 2 1))))
6094 (insert head) (just-one-space)
6095 (setq pos (point))
6096 (end-of-line 1)
6097 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6098 (run-hooks 'org-insert-heading-hook)))))
6100 (defun org-insert-heading-after-current ()
6101 "Insert a new heading with same level as current, after current subtree."
6102 (interactive)
6103 (org-back-to-heading)
6104 (org-insert-heading)
6105 (org-move-subtree-down)
6106 (end-of-line 1))
6108 (defun org-insert-todo-heading (arg)
6109 "Insert a new heading with the same level and TODO state as current heading.
6110 If the heading has no TODO state, or if the state is DONE, use the first
6111 state (TODO by default). Also with prefix arg, force first state."
6112 (interactive "P")
6113 (when (not (org-insert-item 'checkbox))
6114 (org-insert-heading)
6115 (save-excursion
6116 (org-back-to-heading)
6117 (outline-previous-heading)
6118 (looking-at org-todo-line-regexp))
6119 (if (or arg
6120 (not (match-beginning 2))
6121 (member (match-string 2) org-done-keywords))
6122 (insert (car org-todo-keywords-1) " ")
6123 (insert (match-string 2) " "))))
6125 (defun org-insert-subheading (arg)
6126 "Insert a new subheading and demote it.
6127 Works for outline headings and for plain lists alike."
6128 (interactive "P")
6129 (org-insert-heading arg)
6130 (cond
6131 ((org-on-heading-p) (org-do-demote))
6132 ((org-at-item-p) (org-indent-item 1))))
6134 (defun org-insert-todo-subheading (arg)
6135 "Insert a new subheading with TODO keyword or checkbox and demote it.
6136 Works for outline headings and for plain lists alike."
6137 (interactive "P")
6138 (org-insert-todo-heading arg)
6139 (cond
6140 ((org-on-heading-p) (org-do-demote))
6141 ((org-at-item-p) (org-indent-item 1))))
6143 ;;; Promotion and Demotion
6145 (defun org-promote-subtree ()
6146 "Promote the entire subtree.
6147 See also `org-promote'."
6148 (interactive)
6149 (save-excursion
6150 (org-map-tree 'org-promote))
6151 (org-fix-position-after-promote))
6153 (defun org-demote-subtree ()
6154 "Demote the entire subtree. See `org-demote'.
6155 See also `org-promote'."
6156 (interactive)
6157 (save-excursion
6158 (org-map-tree 'org-demote))
6159 (org-fix-position-after-promote))
6162 (defun org-do-promote ()
6163 "Promote the current heading higher up the tree.
6164 If the region is active in `transient-mark-mode', promote all headings
6165 in the region."
6166 (interactive)
6167 (save-excursion
6168 (if (org-region-active-p)
6169 (org-map-region 'org-promote (region-beginning) (region-end))
6170 (org-promote)))
6171 (org-fix-position-after-promote))
6173 (defun org-do-demote ()
6174 "Demote the current heading lower down the tree.
6175 If the region is active in `transient-mark-mode', demote all headings
6176 in the region."
6177 (interactive)
6178 (save-excursion
6179 (if (org-region-active-p)
6180 (org-map-region 'org-demote (region-beginning) (region-end))
6181 (org-demote)))
6182 (org-fix-position-after-promote))
6184 (defun org-fix-position-after-promote ()
6185 "Make sure that after pro/demotion cursor position is right."
6186 (let ((pos (point)))
6187 (when (save-excursion
6188 (beginning-of-line 1)
6189 (looking-at org-todo-line-regexp)
6190 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6191 (cond ((eobp) (insert " "))
6192 ((eolp) (insert " "))
6193 ((equal (char-after) ?\ ) (forward-char 1))))))
6195 (defun org-reduced-level (l)
6196 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6198 (defun org-get-valid-level (level &optional change)
6199 "Rectify a level change under the influence of `org-odd-levels-only'
6200 LEVEL is a current level, CHANGE is by how much the level should be
6201 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6202 even level numbers will become the next higher odd number."
6203 (if org-odd-levels-only
6204 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6205 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6206 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6207 (max 1 (+ level change))))
6209 (define-obsolete-function-alias 'org-get-legal-level
6210 'org-get-valid-level "23.1")
6212 (defun org-promote ()
6213 "Promote the current heading higher up the tree.
6214 If the region is active in `transient-mark-mode', promote all headings
6215 in the region."
6216 (org-back-to-heading t)
6217 (let* ((level (save-match-data (funcall outline-level)))
6218 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6219 (diff (abs (- level (length up-head) -1))))
6220 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6221 (replace-match up-head nil t)
6222 ;; Fixup tag positioning
6223 (and org-auto-align-tags (org-set-tags nil t))
6224 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6226 (defun org-demote ()
6227 "Demote the current heading lower down the tree.
6228 If the region is active in `transient-mark-mode', demote all headings
6229 in the region."
6230 (org-back-to-heading t)
6231 (let* ((level (save-match-data (funcall outline-level)))
6232 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6233 (diff (abs (- level (length down-head) -1))))
6234 (replace-match down-head nil t)
6235 ;; Fixup tag positioning
6236 (and org-auto-align-tags (org-set-tags nil t))
6237 (if org-adapt-indentation (org-fixup-indentation diff))))
6239 (defun org-map-tree (fun)
6240 "Call FUN for every heading underneath the current one."
6241 (org-back-to-heading)
6242 (let ((level (funcall outline-level)))
6243 (save-excursion
6244 (funcall fun)
6245 (while (and (progn
6246 (outline-next-heading)
6247 (> (funcall outline-level) level))
6248 (not (eobp)))
6249 (funcall fun)))))
6251 (defun org-map-region (fun beg end)
6252 "Call FUN for every heading between BEG and END."
6253 (let ((org-ignore-region t))
6254 (save-excursion
6255 (setq end (copy-marker end))
6256 (goto-char beg)
6257 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6258 (< (point) end))
6259 (funcall fun))
6260 (while (and (progn
6261 (outline-next-heading)
6262 (< (point) end))
6263 (not (eobp)))
6264 (funcall fun)))))
6266 (defun org-fixup-indentation (diff)
6267 "Change the indentation in the current entry by DIFF
6268 However, if any line in the current entry has no indentation, or if it
6269 would end up with no indentation after the change, nothing at all is done."
6270 (save-excursion
6271 (let ((end (save-excursion (outline-next-heading)
6272 (point-marker)))
6273 (prohibit (if (> diff 0)
6276 col)
6277 (unless (save-excursion (end-of-line 1)
6278 (re-search-forward prohibit end t))
6279 (while (and (< (point) end)
6281 (goto-char (match-end 0))
6282 (setq col (current-column))
6283 (if (< diff 0) (replace-match ""))
6284 (indent-to (+ diff col))))
6285 (move-marker end nil))))
6287 (defun org-convert-to-odd-levels ()
6288 "Convert an org-mode file with all levels allowed to one with odd levels.
6289 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6290 level 5 etc."
6291 (interactive)
6292 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6293 (let ((org-odd-levels-only nil) n)
6294 (save-excursion
6295 (goto-char (point-min))
6297 (setq n (- (length (match-string 0)) 2))
6298 (while (>= (setq n (1- n)) 0)
6299 (org-demote))
6300 (end-of-line 1))))))
6303 (defun org-convert-to-oddeven-levels ()
6304 "Convert an org-mode file with only odd levels to one with odd and even levels.
6305 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6306 section with an even level, conversion would destroy the structure of the file. An error
6307 is signaled in this case."
6308 (interactive)
6309 (goto-char (point-min))
6310 ;; First check if there are no even levels
6312 (org-show-context t)
6313 (error "Not all levels are odd in this file. Conversion not possible."))
6314 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6315 (let ((org-odd-levels-only nil) n)
6316 (save-excursion
6317 (goto-char (point-min))
6319 (setq n (/ (1- (length (match-string 0))) 2))
6320 (while (>= (setq n (1- n)) 0)
6321 (org-promote))
6322 (end-of-line 1))))))
6324 (defun org-tr-level (n)
6325 "Make N odd if required."
6326 (if org-odd-levels-only (1+ (/ n 2)) n))
6328 ;;; Vertical tree motion, cutting and pasting of subtrees
6330 (defun org-move-subtree-up (&optional arg)
6331 "Move the current subtree up past ARG headlines of the same level."
6332 (interactive "p")
6333 (org-move-subtree-down (- (prefix-numeric-value arg))))
6335 (defun org-move-subtree-down (&optional arg)
6336 "Move the current subtree down past ARG headlines of the same level."
6337 (interactive "p")
6338 (setq arg (prefix-numeric-value arg))
6339 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6340 'outline-get-last-sibling))
6341 (ins-point (make-marker))
6342 (cnt (abs arg))
6343 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6344 ;; Select the tree
6345 (org-back-to-heading)
6346 (setq beg0 (point))
6347 (save-excursion
6348 (setq ne-beg (org-back-over-empty-lines))
6349 (setq beg (point)))
6350 (save-match-data
6351 (save-excursion (outline-end-of-heading)
6352 (setq folded (org-invisible-p)))
6353 (outline-end-of-subtree))
6354 (outline-next-heading)
6355 (setq ne-end (org-back-over-empty-lines))
6356 (setq end (point))
6357 (goto-char beg0)
6358 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6359 ;; include less whitespace
6360 (save-excursion
6361 (goto-char beg)
6362 (forward-line (- ne-beg ne-end))
6363 (setq beg (point))))
6364 ;; Find insertion point, with error handling
6365 (while (> cnt 0)
6366 (or (and (funcall movfunc) (looking-at outline-regexp))
6367 (progn (goto-char beg0)
6368 (error "Cannot move past superior level or buffer limit")))
6369 (setq cnt (1- cnt)))
6370 (if (> arg 0)
6371 ;; Moving forward - still need to move over subtree
6372 (progn (org-end-of-subtree t t)
6373 (save-excursion
6374 (org-back-over-empty-lines)
6375 (or (bolp) (newline)))))
6376 (setq ne-ins (org-back-over-empty-lines))
6377 (move-marker ins-point (point))
6378 (setq txt (buffer-substring beg end))
6379 (delete-region beg end)
6380 (outline-flag-region (1- beg) beg nil)
6381 (outline-flag-region (1- (point)) (point) nil)
6382 (insert txt)
6384 (setq ins-end (point))
6385 (goto-char ins-point)
6386 (org-skip-whitespace)
6387 (when (and (< arg 0)
6388 (org-first-sibling-p)
6389 (> ne-ins ne-beg))
6390 ;; Move whitespace back to beginning
6391 (save-excursion
6392 (goto-char ins-end)
6393 (let ((kill-whole-line t))
6394 (kill-line (- ne-ins ne-beg)) (point)))
6396 (move-marker ins-point nil)
6397 (org-compact-display-after-subtree-move)
6398 (unless folded
6399 (org-show-entry)
6400 (show-children)
6401 (org-cycle-hide-drawers 'children))))
6403 (defvar org-subtree-clip ""
6404 "Clipboard for cut and paste of subtrees.
6405 This is actually only a copy of the kill, because we use the normal kill
6406 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6408 (defvar org-subtree-clip-folded nil
6409 "Was the last copied subtree folded?
6410 This is used to fold the tree back after pasting.")
6412 (defun org-cut-subtree (&optional n)
6413 "Cut the current subtree into the clipboard.
6414 With prefix arg N, cut this many sequential subtrees.
6415 This is a short-hand for marking the subtree and then cutting it."
6416 (interactive "p")
6417 (org-copy-subtree n 'cut))
6419 (defun org-copy-subtree (&optional n cut)
6420 "Cut the current subtree into the clipboard.
6421 With prefix arg N, cut this many sequential subtrees.
6422 This is a short-hand for marking the subtree and then copying it.
6423 If CUT is non-nil, actually cut the subtree."
6424 (interactive "p")
6425 (let (beg end folded (beg0 (point)))
6426 (if (interactive-p)
6427 (org-back-to-heading nil) ; take what looks like a subtree
6428 (org-back-to-heading t)) ; take what is really there
6429 (org-back-over-empty-lines)
6430 (setq beg (point))
6432 (save-match-data
6433 (save-excursion (outline-end-of-heading)
6434 (setq folded (org-invisible-p)))
6435 (condition-case nil
6436 (outline-forward-same-level (1- n))
6437 (error nil))
6438 (org-end-of-subtree t t))
6439 (org-back-over-empty-lines)
6440 (setq end (point))
6441 (goto-char beg0)
6442 (when (> end beg)
6443 (setq org-subtree-clip-folded folded)
6444 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6445 (setq org-subtree-clip (current-kill 0))
6446 (message "%s: Subtree(s) with %d characters"
6447 (if cut "Cut" "Copied")
6448 (length org-subtree-clip)))))
6450 (defun org-paste-subtree (&optional level tree)
6451 "Paste the clipboard as a subtree, with modification of headline level.
6452 The entire subtree is promoted or demoted in order to match a new headline
6453 level. By default, the new level is derived from the visible headings
6454 before and after the insertion point, and taken to be the inferior headline
6455 level of the two. So if the previous visible heading is level 3 and the
6456 next is level 4 (or vice versa), level 4 will be used for insertion.
6457 This makes sure that the subtree remains an independent subtree and does
6458 not swallow low level entries.
6460 You can also force a different level, either by using a numeric prefix
6461 argument, or by inserting the heading marker by hand. For example, if the
6466 If optional TREE is given, use this text instead of the kill ring."
6467 (interactive "P")
6468 (unless (org-kill-is-subtree-p tree)
6469 (error "%s"
6470 (substitute-command-keys
6472 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6477 (old-level (if (string-match ^re txt)
6478 (- (match-end 0) (match-beginning 0) 1)
6479 -1))
6480 (force-level (cond (level (prefix-numeric-value level))
6481 ((string-match
6482 ^re_ (buffer-substring (point-at-bol) (point)))
6483 (- (match-end 1) (match-beginning 1)))
6484 (t nil)))
6485 (previous-level (save-excursion
6486 (condition-case nil
6487 (progn
6488 (outline-previous-visible-heading 1)
6489 (if (looking-at re)
6490 (- (match-end 0) (match-beginning 0) 1)
6491 1))
6492 (error 1))))
6493 (next-level (save-excursion
6494 (condition-case nil
6495 (progn
6496 (or (looking-at outline-regexp)
6497 (outline-next-visible-heading 1))
6498 (if (looking-at re)
6499 (- (match-end 0) (match-beginning 0) 1)
6500 1))
6501 (error 1))))
6502 (new-level (or force-level (max previous-level next-level)))
6503 (shift (if (or (= old-level -1)
6504 (= new-level -1)
6505 (= old-level new-level))
6506 0
6507 (- new-level old-level)))
6508 (delta (if (> shift 0) -1 1))
6509 (func (if (> shift 0) 'org-demote 'org-promote))
6510 (org-odd-levels-only nil)
6511 beg end)
6512 ;; Remove the forced level indicator
6513 (if force-level
6514 (delete-region (point-at-bol) (point)))
6515 ;; Paste
6516 (beginning-of-line 1)
6517 (org-back-over-empty-lines) ;; FIXME: correct fix????
6518 (setq beg (point))
6519 (insert-before-markers txt) ;; FIXME: correct fix????
6521 (setq end (point))
6522 (goto-char beg)
6524 (setq beg (point))
6525 ;; Shift if necessary
6526 (unless (= shift 0)
6527 (save-restriction
6528 (narrow-to-region beg end)
6529 (while (not (= shift 0))
6530 (org-map-region func (point-min) (point-max))
6531 (setq shift (+ delta shift)))
6532 (goto-char (point-min))))
6533 (when (interactive-p)
6534 (message "Clipboard pasted as level %d subtree" new-level))
6535 (if (and kill-ring
6536 (eq org-subtree-clip (current-kill 0))
6537 org-subtree-clip-folded)
6538 ;; The tree was folded before it was killed/copied
6539 (hide-subtree))))
6541 (defun org-kill-is-subtree-p (&optional txt)
6542 "Check if the current kill is an outline subtree, or a set of trees.
6543 Returns nil if kill does not start with a headline, or if the first
6544 headline level is not the largest headline level in the tree.
6545 So this will actually accept several entries of equal levels as well,
6546 which is OK for `org-paste-subtree'.
6547 If optional TXT is given, check this string instead of the current kill."
6548 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6549 (start-level (and kill
6552 kill)
6553 (- (match-end 2) (match-beginning 2) 1)))
6554 (re (concat "^" org-outline-regexp))
6555 (start (1+ (match-beginning 2))))
6556 (if (not start-level)
6557 (progn
6558 nil) ;; does not even start with a heading
6559 (catch 'exit
6560 (while (setq start (string-match re kill (1+ start)))
6561 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6562 (throw 'exit nil)))
6563 t))))
6565 (defun org-narrow-to-subtree ()
6566 "Narrow buffer to the current subtree."
6567 (interactive)
6568 (save-excursion
6569 (narrow-to-region
6570 (progn (org-back-to-heading) (point))
6571 (progn (org-end-of-subtree t t) (point)))))
6574 ;;; Outline Sorting
6576 (defun org-sort (with-case)
6577 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6578 Optional argument WITH-CASE means sort case-sensitively."
6579 (interactive "P")
6580 (if (org-at-table-p)
6581 (org-call-with-arg 'org-table-sort-lines with-case)
6582 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6584 (defvar org-priority-regexp) ; defined later in the file
6586 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6587 "Sort entries on a certain level of an outline tree.
6588 If there is an active region, the entries in the region are sorted.
6589 Else, if the cursor is before the first entry, sort the top-level items.
6590 Else, the children of the entry at point are sorted.
6592 Sorting can be alphabetically, numerically, and by date/time as given by
6593 the first time stamp in the entry. The command prompts for the sorting
6594 type unless it has been given to the function through the SORTING-TYPE
6595 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6596 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6597 called with point at the beginning of the record. It must return either
6598 a string or a number that should serve as the sorting key for that record.
6600 Comparing entries ignores case by default. However, with an optional argument
6601 WITH-CASE, the sorting considers case as well."
6602 (interactive "P")
6603 (let ((case-func (if with-case 'identity 'downcase))
6604 start beg end stars re re2
6605 txt what tmp plain-list-p)
6606 ;; Find beginning and end of region to sort
6607 (cond
6608 ((org-region-active-p)
6609 ;; we will sort the region
6610 (setq end (region-end)
6611 what "region")
6612 (goto-char (region-beginning))
6613 (if (not (org-on-heading-p)) (outline-next-heading))
6614 (setq start (point)))
6615 ((org-at-item-p)
6616 ;; we will sort this plain list
6617 (org-beginning-of-item-list) (setq start (point))
6618 (org-end-of-item-list) (setq end (point))
6619 (goto-char start)
6620 (setq plain-list-p t
6621 what "plain list"))
6622 ((or (org-on-heading-p)
6623 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6624 ;; we will sort the children of the current headline
6625 (org-back-to-heading)
6626 (setq start (point)
6627 end (progn (org-end-of-subtree t t)
6628 (org-back-over-empty-lines)
6629 (point))
6630 what "children")
6631 (goto-char start)
6632 (show-subtree)
6633 (outline-next-heading))
6634 (t
6635 ;; we will sort the top-level entries in this file
6636 (goto-char (point-min))
6637 (or (org-on-heading-p) (outline-next-heading))
6638 (setq start (point) end (point-max) what "top-level")
6639 (goto-char start)
6640 (show-all)))
6642 (setq beg (point))
6643 (if (>= beg end) (error "Nothing to sort"))
6645 (unless plain-list-p
6647 (setq stars (match-string 1)
6648 re (concat "^" (regexp-quote stars) " +")
6649 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6650 txt (buffer-substring beg end))
6652 (if (and (not (equal stars "*")) (string-match re2 txt))
6653 (error "Region to sort contains a level above the first entry")))
6655 (unless sorting-type
6656 (message
6657 (if plain-list-p
6658 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6659 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6660 what)
6661 (setq sorting-type (read-char-exclusive))
6663 (and (= (downcase sorting-type) ?f)
6664 (setq getkey-func
6665 (completing-read "Sort using function: "
6666 obarray 'fboundp t nil nil))
6667 (setq getkey-func (intern getkey-func)))
6669 (and (= (downcase sorting-type) ?r)
6670 (setq property
6671 (completing-read "Property: "
6672 (mapcar 'list (org-buffer-property-keys t))
6673 nil t))))
6675 (message "Sorting entries...")
6677 (save-restriction
6678 (narrow-to-region start end)
6680 (let ((dcst (downcase sorting-type))
6681 (now (current-time)))
6682 (sort-subr
6683 (/= dcst sorting-type)
6684 ;; This function moves to the beginning character of the "record" to
6685 ;; be sorted.
6686 (if plain-list-p
6687 (lambda nil
6688 (if (org-at-item-p) t (goto-char (point-max))))
6689 (lambda nil
6690 (if (re-search-forward re nil t)
6691 (goto-char (match-beginning 0))
6692 (goto-char (point-max)))))
6693 ;; This function moves to the last character of the "record" being
6694 ;; sorted.
6695 (if plain-list-p
6696 'org-end-of-item
6697 (lambda nil
6698 (save-match-data
6699 (condition-case nil
6700 (outline-forward-same-level 1)
6701 (error
6702 (goto-char (point-max)))))))
6704 ;; This function returns the value that gets sorted against.
6705 (if plain-list-p
6706 (lambda nil
6708 (cond
6709 ((= dcst ?n)
6710 (string-to-number (buffer-substring (match-end 0)
6711 (point-at-eol))))
6712 ((= dcst ?a)
6713 (buffer-substring (match-end 0) (point-at-eol)))
6714 ((= dcst ?t)
6715 (if (re-search-forward org-ts-regexp
6716 (point-at-eol) t)
6717 (org-time-string-to-time (match-string 0))
6718 now))
6719 ((= dcst ?f)
6720 (if getkey-func
6721 (progn
6722 (setq tmp (funcall getkey-func))
6723 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6724 tmp)
6725 (error "Invalid key function `%s'" getkey-func)))
6726 (t (error "Invalid sorting type `%c'" sorting-type)))))
6727 (lambda nil
6728 (cond
6729 ((= dcst ?n)
6730 (if (looking-at outline-regexp)
6731 (string-to-number (buffer-substring (match-end 0)
6732 (point-at-eol)))
6733 nil))
6734 ((= dcst ?a)
6735 (funcall case-func (buffer-substring (point-at-bol)
6736 (point-at-eol))))
6737 ((= dcst ?t)
6738 (if (re-search-forward org-ts-regexp
6739 (save-excursion
6740 (forward-line 2)
6741 (point)) t)
6742 (org-time-string-to-time (match-string 0))
6743 now))
6744 ((= dcst ?p)
6745 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6746 (string-to-char (match-string 2))
6747 org-default-priority))
6748 ((= dcst ?r)
6749 (or (org-entry-get nil property) ""))
6750 ((= dcst ?f)
6751 (if getkey-func
6752 (progn
6753 (setq tmp (funcall getkey-func))
6754 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6755 tmp)
6756 (error "Invalid key function `%s'" getkey-func)))
6757 (t (error "Invalid sorting type `%c'" sorting-type)))))
6758 nil
6759 (cond
6760 ((= dcst ?a) 'string<)
6761 ((= dcst ?t) 'time-less-p)
6762 (t nil)))))
6763 (message "Sorting entries...done")))
6765 (defun org-do-sort (table what &optional with-case sorting-type)
6766 "Sort TABLE of WHAT according to SORTING-TYPE.
6767 The user will be prompted for the SORTING-TYPE if the call to this
6768 function does not specify it. WHAT is only for the prompt, to indicate
6769 what is being sorted. The sorting key will be extracted from
6770 the car of the elements of the table.
6771 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6772 (unless sorting-type
6773 (message
6774 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6775 what)
6776 (setq sorting-type (read-char-exclusive)))
6777 (let ((dcst (downcase sorting-type))
6778 extractfun comparefun)
6779 ;; Define the appropriate functions
6780 (cond
6781 ((= dcst ?n)
6782 (setq extractfun 'string-to-number
6783 comparefun (if (= dcst sorting-type) '< '>)))
6784 ((= dcst ?a)
6785 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6786 (lambda(x) (downcase (org-sort-remove-invisible x))))
6787 comparefun (if (= dcst sorting-type)
6788 'string<
6789 (lambda (a b) (and (not (string< a b))
6790 (not (string= a b)))))))
6791 ((= dcst ?t)
6792 (setq extractfun
6793 (lambda (x)
6794 (if (string-match org-ts-regexp x)
6795 (time-to-seconds
6796 (org-time-string-to-time (match-string 0 x)))
6797 0))
6798 comparefun (if (= dcst sorting-type) '< '>)))
6799 (t (error "Invalid sorting type `%c'" sorting-type)))
6801 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6802 table)
6803 (lambda (a b) (funcall comparefun (car a) (car b))))))
6805 ;;;; Plain list items, including checkboxes
6807 ;;; Plain list items
6809 (defun org-at-item-p ()
6810 "Is point in a line starting a hand-formatted item?"
6811 (let ((llt org-plain-list-ordered-item-terminator))
6812 (save-excursion
6813 (goto-char (point-at-bol))
6814 (looking-at
6815 (cond
6819 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6821 (defun org-in-item-p ()
6822 "It the cursor inside a plain list item.
6823 Does not have to be the first line."
6824 (save-excursion
6825 (condition-case nil
6826 (progn
6827 (org-beginning-of-item)
6828 (org-at-item-p)
6829 t)
6830 (error nil))))
6832 (defun org-insert-item (&optional checkbox)
6833 "Insert a new item at the current level.
6834 Return t when things worked, nil when we are not in an item."
6835 (when (save-excursion
6836 (condition-case nil
6837 (progn
6838 (org-beginning-of-item)
6839 (org-at-item-p)
6840 (if (org-invisible-p) (error "Invisible item"))
6841 t)
6842 (error nil)))
6843 (let* ((bul (match-string 0))
6845 (match-end 0)))
6846 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6847 pos)
6848 (cond
6849 ((and (org-at-item-p) (<= (point) eow))
6850 ;; before the bullet
6851 (beginning-of-line 1)
6852 (open-line (if blank 2 1)))
6853 ((<= (point) eow)
6854 (beginning-of-line 1))
6855 (t (newline (if blank 2 1))))
6856 (insert bul (if checkbox "[ ]" ""))
6857 (just-one-space)
6858 (setq pos (point))
6859 (end-of-line 1)
6860 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6861 (org-maybe-renumber-ordered-list)
6862 (and checkbox (org-update-checkbox-count-maybe))
6863 t))
6865 ;;; Checkboxes
6867 (defun org-at-item-checkbox-p ()
6868 "Is point at a line starting a plain-list item with a checklet?"
6869 (and (org-at-item-p)
6870 (save-excursion
6871 (goto-char (match-end 0))
6875 (defun org-toggle-checkbox (&optional arg)
6876 "Toggle the checkbox in the current line."
6877 (interactive "P")
6878 (catch 'exit
6879 (let (beg end status (firstnew 'unknown))
6880 (cond
6881 ((org-region-active-p)
6882 (setq beg (region-beginning) end (region-end)))
6883 ((org-on-heading-p)
6884 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6885 ((org-at-item-checkbox-p)
6886 (let ((pos (point)))
6887 (replace-match
6888 (cond (arg "[-]")
6889 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6890 (t "[ ]"))
6891 t t)
6892 (goto-char pos))
6893 (throw 'exit t))
6894 (t (error "Not at a checkbox or heading, and no active region")))
6895 (save-excursion
6896 (goto-char beg)
6897 (while (< (point) end)
6898 (when (org-at-item-checkbox-p)
6899 (setq status (equal (match-string 0) "[X]"))
6900 (when (eq firstnew 'unknown)
6901 (setq firstnew (not status)))
6902 (replace-match
6903 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6904 (beginning-of-line 2)))))
6905 (org-update-checkbox-count-maybe))
6907 (defun org-update-checkbox-count-maybe ()
6908 "Update checkbox statistics unless turned off by user."
6909 (when org-provide-checkbox-statistics
6910 (org-update-checkbox-count)))
6912 (defun org-update-checkbox-count (&optional all)
6913 "Update the checkbox statistics in the current section.
6914 This will find all statistic cookies like [57%] and [6/12] and update them
6915 with the current numbers. With optional prefix argument ALL, do this for
6916 the whole buffer."
6917 (interactive "P")
6918 (save-excursion
6919 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
6920 (beg (condition-case nil
6921 (progn (outline-back-to-heading) (point))
6922 (error (point-min))))
6923 (end (move-marker (make-marker)
6924 (progn (outline-next-heading) (point))))
6927 b1 e1 f1 c-on c-off lim (cstat 0))
6928 (when all
6929 (goto-char (point-min))
6930 (outline-next-heading)
6931 (setq beg (point) end (point-max)))
6932 (goto-char beg)
6933 (while (re-search-forward re end t)
6934 (setq cstat (1+ cstat)
6935 b1 (match-beginning 0)
6936 e1 (match-end 0)
6937 f1 (match-beginning 1)
6938 lim (cond
6939 ((org-on-heading-p) (outline-next-heading) (point))
6940 ((org-at-item-p) (org-end-of-item) (point))
6941 (t nil))
6942 c-on 0 c-off 0)
6943 (goto-char e1)
6944 (when lim
6945 (while (re-search-forward re-box lim t)
6946 (if (member (match-string 2) '("[ ]" "[-]"))
6947 (setq c-off (1+ c-off))
6948 (setq c-on (1+ c-on))))
6949 ; (delete-region b1 e1)
6950 (goto-char b1)
6951 (insert (if f1
6952 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
6953 (format "[%d/%d]" c-on (+ c-on c-off))))
6955 (replace-match ""))))
6956 (when (interactive-p)
6957 (message "Checkbox satistics updated %s (%d places)"
6958 (if all "in entire file" "in current outline entry") cstat)))))
6960 (defun org-get-checkbox-statistics-face ()
6961 "Select the face for checkbox statistics.
6962 The face will be `org-done' when all relevant boxes are checked. Otherwise
6963 it will be `org-todo'."
6964 (if (match-end 1)
6965 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
6966 (if (and (> (match-end 2) (match-beginning 2))
6967 (equal (match-string 2) (match-string 3)))
6968 'org-done
6969 'org-todo)))
6971 (defun org-get-indentation (&optional line)
6972 "Get the indentation of the current line, interpreting tabs.
6973 When LINE is given, assume it represents a line and compute its indentation."
6974 (if line
6975 (if (string-match "^ *" (org-remove-tabs line))
6976 (match-end 0))
6977 (save-excursion
6978 (beginning-of-line 1)
6980 (current-column))))
6982 (defun org-remove-tabs (s &optional width)
6983 "Replace tabulators in S with spaces.
6984 Assumes that s is a single line, starting in column 0."
6985 (setq width (or width tab-width))
6987 (setq s (replace-match
6988 (make-string
6989 (- (* width (/ (+ (match-beginning 0) width) width))
6990 (match-beginning 0)) ?\ )
6991 t t s)))
6992 s)
6994 (defun org-fix-indentation (line ind)
6995 "Fix indentation in LINE.
6996 IND is a cons cell with target and minimum indentation.
6997 If the current indenation in LINE is smaller than the minimum,
6998 leave it alone. If it is larger than ind, set it to the target."
6999 (let* ((l (org-remove-tabs line))
7000 (i (org-get-indentation l))
7001 (i1 (car ind)) (i2 (cdr ind)))
7002 (if (>= i i2) (setq l (substring line i2)))
7003 (if (> i1 0)
7004 (concat (make-string i1 ?\ ) l)
7005 l)))
7007 (defcustom org-empty-line-terminates-plain-lists nil
7008 "Non-nil means, an empty line ends all plain list levels.
7009 When nil, empty lines are part of the preceeding item."
7010 :group 'org-plain-lists
7011 :type 'boolean)
7013 (defun org-beginning-of-item ()
7014 "Go to the beginning of the current hand-formatted item.
7015 If the cursor is not in an item, throw an error."
7016 (interactive)
7017 (let ((pos (point))
7018 (limit (save-excursion
7019 (condition-case nil
7020 (progn
7021 (org-back-to-heading)
7022 (beginning-of-line 2) (point))
7023 (error (point-min)))))
7024 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7025 ind ind1)
7026 (if (org-at-item-p)
7027 (beginning-of-line 1)
7028 (beginning-of-line 1)
7030 (setq ind (current-column))
7031 (if (catch 'exit
7032 (while t
7033 (beginning-of-line 0)
7034 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7037 (setq ind1 ind-empty)
7039 (setq ind1 (current-column)))
7040 (if (< ind1 ind)
7041 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7042 nil
7043 (goto-char pos)
7044 (error "Not in an item")))))
7046 (defun org-end-of-item ()
7047 "Go to the end of the current hand-formatted item.
7048 If the cursor is not in an item, throw an error."
7049 (interactive)
7050 (let* ((pos (point))
7051 ind1
7052 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7053 (limit (save-excursion (outline-next-heading) (point)))
7054 (ind (save-excursion
7055 (org-beginning-of-item)
7057 (current-column)))
7058 (end (catch 'exit
7059 (while t
7060 (beginning-of-line 2)
7061 (if (eobp) (throw 'exit (point)))
7062 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7064 (setq ind1 ind-empty)
7066 (setq ind1 (current-column)))
7067 (if (<= ind1 ind)
7068 (throw 'exit (point-at-bol)))))))
7069 (if end
7070 (goto-char end)
7071 (goto-char pos)
7072 (error "Not in an item"))))
7074 (defun org-next-item ()
7075 "Move to the beginning of the next item in the current plain list.
7076 Error if not at a plain list, or if this is the last item in the list."
7077 (interactive)
7078 (let (ind ind1 (pos (point)))
7079 (org-beginning-of-item)
7080 (setq ind (org-get-indentation))
7081 (org-end-of-item)
7082 (setq ind1 (org-get-indentation))
7083 (unless (and (org-at-item-p) (= ind ind1))
7084 (goto-char pos)
7085 (error "On last item"))))
7087 (defun org-previous-item ()
7088 "Move to the beginning of the previous item in the current plain list.
7089 Error if not at a plain list, or if this is the first item in the list."
7090 (interactive)
7091 (let (beg ind ind1 (pos (point)))
7092 (org-beginning-of-item)
7093 (setq beg (point))
7094 (setq ind (org-get-indentation))
7095 (goto-char beg)
7096 (catch 'exit
7097 (while t
7098 (beginning-of-line 0)
7100 nil
7101 (if (<= (setq ind1 (org-get-indentation)) ind)
7102 (throw 'exit t)))))
7103 (condition-case nil
7104 (if (or (not (org-at-item-p))
7105 (< ind1 (1- ind)))
7106 (error "")
7107 (org-beginning-of-item))
7108 (error (goto-char pos)
7109 (error "On first item")))))
7111 (defun org-first-list-item-p ()
7112 "Is this heading the item in a plain list?"
7113 (unless (org-at-item-p)
7114 (error "Not at a plain list item"))
7115 (org-beginning-of-item)
7116 (= (point) (save-excursion (org-beginning-of-item-list))))
7118 (defun org-move-item-down ()
7119 "Move the plain list item at point down, i.e. swap with following item.
7120 Subitems (items with larger indentation) are considered part of the item,
7121 so this really moves item trees."
7122 (interactive)
7123 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7124 (org-beginning-of-item)
7125 (setq beg0 (point))
7126 (save-excursion
7127 (setq ne-beg (org-back-over-empty-lines))
7128 (setq beg (point)))
7129 (goto-char beg0)
7130 (setq ind (org-get-indentation))
7131 (org-end-of-item)
7132 (setq end0 (point))
7133 (setq ind1 (org-get-indentation))
7134 (setq ne-end (org-back-over-empty-lines))
7135 (setq end (point))
7136 (goto-char beg0)
7137 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7138 ;; include less whitespace
7139 (save-excursion
7140 (goto-char beg)
7141 (forward-line (- ne-beg ne-end))
7142 (setq beg (point))))
7143 (goto-char end0)
7144 (if (and (org-at-item-p) (= ind ind1))
7145 (progn
7146 (org-end-of-item)
7147 (org-back-over-empty-lines)
7148 (setq txt (buffer-substring beg end))
7149 (save-excursion
7150 (delete-region beg end))
7151 (setq pos (point))
7152 (insert txt)
7153 (goto-char pos) (org-skip-whitespace)
7154 (org-maybe-renumber-ordered-list))
7155 (goto-char pos)
7156 (error "Cannot move this item further down"))))
7158 (defun org-move-item-up (arg)
7159 "Move the plain list item at point up, i.e. swap with previous item.
7160 Subitems (items with larger indentation) are considered part of the item,
7161 so this really moves item trees."
7162 (interactive "p")
7163 (let (beg beg0 end end0 ind ind1 (pos (point)) txt
7164 ne-beg ne-end ne-ins ins-end)
7165 (org-beginning-of-item)
7166 (setq beg0 (point))
7167 (setq ind (org-get-indentation))
7168 (save-excursion
7169 (setq ne-beg (org-back-over-empty-lines))
7170 (setq beg (point)))
7171 (goto-char beg0)
7172 (org-end-of-item)
7173 (setq ne-end (org-back-over-empty-lines))
7174 (setq end (point))
7175 (goto-char beg0)
7176 (catch 'exit
7177 (while t
7178 (beginning-of-line 0)
7180 (if org-empty-line-terminates-plain-lists
7181 (progn
7182 (goto-char pos)
7183 (error "Cannot move this item further up"))
7184 nil)
7185 (if (<= (setq ind1 (org-get-indentation)) ind)
7186 (throw 'exit t)))))
7187 (condition-case nil
7188 (org-beginning-of-item)
7189 (error (goto-char beg)
7190 (error "Cannot move this item further up")))
7191 (setq ind1 (org-get-indentation))
7192 (if (and (org-at-item-p) (= ind ind1))
7193 (progn
7194 (setq ne-ins (org-back-over-empty-lines))
7195 (setq txt (buffer-substring beg end))
7196 (save-excursion
7197 (delete-region beg end))
7198 (setq pos (point))
7199 (insert txt)
7200 (setq ins-end (point))
7201 (goto-char pos) (org-skip-whitespace)
7203 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7204 ;; Move whitespace back to beginning
7205 (save-excursion
7206 (goto-char ins-end)
7207 (let ((kill-whole-line t))
7208 (kill-line (- ne-ins ne-beg)) (point)))
7211 (org-maybe-renumber-ordered-list))
7212 (goto-char pos)
7213 (error "Cannot move this item further up"))))
7215 (defun org-maybe-renumber-ordered-list ()
7216 "Renumber the ordered list at point if setup allows it.
7217 This tests the user option `org-auto-renumber-ordered-lists' before
7218 doing the renumbering."
7219 (interactive)
7220 (when (and org-auto-renumber-ordered-lists
7221 (org-at-item-p))
7222 (if (match-beginning 3)
7223 (org-renumber-ordered-list 1)
7224 (org-fix-bullet-type))))
7226 (defun org-maybe-renumber-ordered-list-safe ()
7227 (condition-case nil
7228 (save-excursion
7229 (org-maybe-renumber-ordered-list))
7230 (error nil)))
7232 (defun org-cycle-list-bullet (&optional which)
7233 "Cycle through the different itemize/enumerate bullets.
7234 This cycle the entire list level through the sequence:
7236 `-' -> `+' -> `*' -> `1.' -> `1)'
7238 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7239 0 meand `-', 1 means `+' etc."
7240 (interactive "P")
7241 (org-preserve-lc
7242 (org-beginning-of-item-list)
7243 (org-at-item-p)
7244 (beginning-of-line 1)
7245 (let ((current (match-string 0))
7246 (prevp (eq which 'previous))
7247 new)
7248 (setq new (cond
7249 ((and (numberp which)
7250 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7251 ((string-match "-" current) (if prevp "1)" "+"))
7256 ((string-match ")" current) (if prevp "1." "-"))
7257 (t (error "This should not happen"))))
7259 (org-fix-bullet-type)
7260 (org-maybe-renumber-ordered-list))))
7262 (defun org-get-string-indentation (s)
7263 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7264 (let ((n -1) (i 0) (w tab-width) c)
7265 (catch 'exit
7266 (while (< (setq n (1+ n)) (length s))
7267 (setq c (aref s n))
7268 (cond ((= c ?\ ) (setq i (1+ i)))
7270 (t (throw 'exit t)))))
7271 i))
7273 (defun org-renumber-ordered-list (arg)
7274 "Renumber an ordered plain list.
7275 Cursor needs to be in the first line of an item, the line that starts
7277 (interactive "p")
7278 (unless (and (org-at-item-p)
7279 (match-beginning 3))
7280 (error "This is not an ordered list"))
7281 (let ((line (org-current-line))
7282 (col (current-column))
7283 (ind (org-get-string-indentation
7284 (buffer-substring (point-at-bol) (match-beginning 3))))
7285 ;; (term (substring (match-string 3) -1))
7286 ind1 (n (1- arg))
7287 fmt)
7288 ;; find where this list begins
7289 (org-beginning-of-item-list)
7291 (setq fmt (concat "%d" (match-string 1)))
7292 (beginning-of-line 0)
7293 ;; walk forward and replace these numbers
7294 (catch 'exit
7295 (while t
7296 (catch 'next
7297 (beginning-of-line 2)
7298 (if (eobp) (throw 'exit nil))
7301 (if (> ind1 ind) (throw 'next t))
7302 (if (< ind1 ind) (throw 'exit t))
7303 (if (not (org-at-item-p)) (throw 'exit nil))
7304 (delete-region (match-beginning 2) (match-end 2))
7305 (goto-char (match-beginning 2))
7306 (insert (format fmt (setq n (1+ n)))))))
7307 (goto-line line)
7308 (move-to-column col)))
7310 (defun org-fix-bullet-type ()
7311 "Make sure all items in this list have the same bullet as the firsst item."
7312 (interactive)
7313 (unless (org-at-item-p) (error "This is not a list"))
7314 (let ((line (org-current-line))
7315 (col (current-column))
7316 (ind (current-indentation))
7317 ind1 bullet)
7318 ;; find where this list begins
7319 (org-beginning-of-item-list)
7320 (beginning-of-line 1)
7321 ;; find out what the bullet type is
7323 (setq bullet (match-string 1))
7324 ;; walk forward and replace these numbers
7325 (beginning-of-line 0)
7326 (catch 'exit
7327 (while t
7328 (catch 'next
7329 (beginning-of-line 2)
7330 (if (eobp) (throw 'exit nil))
7333 (if (> ind1 ind) (throw 'next t))
7334 (if (< ind1 ind) (throw 'exit t))
7335 (if (not (org-at-item-p)) (throw 'exit nil))
7338 (replace-match bullet))))
7339 (goto-line line)
7340 (move-to-column col)
7341 (if (string-match "[0-9]" bullet)
7342 (org-renumber-ordered-list 1))))
7344 (defun org-beginning-of-item-list ()
7345 "Go to the beginning of the current item list.
7346 I.e. to the first item in this list."
7347 (interactive)
7348 (org-beginning-of-item)
7349 (let ((pos (point-at-bol))
7350 (ind (org-get-indentation))
7351 ind1)
7352 ;; find where this list begins
7353 (catch 'exit
7354 (while t
7355 (catch 'next
7356 (beginning-of-line 0)
7358 (throw (if (bobp) 'exit 'next) t))
7360 (if (or (< ind1 ind)
7361 (and (= ind1 ind)
7362 (not (org-at-item-p)))
7363 (bobp))
7364 (throw 'exit t)
7365 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7366 (goto-char pos)))
7369 (defun org-end-of-item-list ()
7370 "Go to the end of the current item list.
7371 I.e. to the text after the last item."
7372 (interactive)
7373 (org-beginning-of-item)
7374 (let ((pos (point-at-bol))
7375 (ind (org-get-indentation))
7376 ind1)
7377 ;; find where this list begins
7378 (catch 'exit
7379 (while t
7380 (catch 'next
7381 (beginning-of-line 2)
7383 (throw (if (eobp) 'exit 'next) t))
7385 (if (or (< ind1 ind)
7386 (and (= ind1 ind)
7387 (not (org-at-item-p)))
7388 (eobp))
7389 (progn
7390 (setq pos (point-at-bol))
7391 (throw 'exit t))))))
7392 (goto-char pos)))
7395 (defvar org-last-indent-begin-marker (make-marker))
7396 (defvar org-last-indent-end-marker (make-marker))
7398 (defun org-outdent-item (arg)
7399 "Outdent a local list item."
7400 (interactive "p")
7401 (org-indent-item (- arg)))
7403 (defun org-indent-item (arg)
7404 "Indent a local list item."
7405 (interactive "p")
7406 (unless (org-at-item-p)
7407 (error "Not on an item"))
7408 (save-excursion
7409 (let (beg end ind ind1 tmp delta ind-down ind-up)
7410 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7411 (setq beg org-last-indent-begin-marker
7412 end org-last-indent-end-marker)
7413 (org-beginning-of-item)
7414 (setq beg (move-marker org-last-indent-begin-marker (point)))
7415 (org-end-of-item)
7416 (setq end (move-marker org-last-indent-end-marker (point))))
7417 (goto-char beg)
7418 (setq tmp (org-item-indent-positions)
7419 ind (car tmp)
7420 ind-down (nth 2 tmp)
7421 ind-up (nth 1 tmp)
7422 delta (if (> arg 0)
7423 (if ind-down (- ind-down ind) 2)
7424 (if ind-up (- ind-up ind) -2)))
7425 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7426 (while (< (point) end)
7427 (beginning-of-line 1)
7429 (delete-region (point-at-bol) (point))
7430 (or (eolp) (indent-to-column (+ ind1 delta)))
7431 (beginning-of-line 2))))
7432 (org-fix-bullet-type)
7433 (org-maybe-renumber-ordered-list-safe)
7434 (save-excursion
7435 (beginning-of-line 0)
7436 (condition-case nil (org-beginning-of-item) (error nil))
7437 (org-maybe-renumber-ordered-list-safe)))
7439 (defun org-item-indent-positions ()
7440 "Return indentation for plain list items.
7441 This returns a list with three values: The current indentation, the
7442 parent indentation and the indentation a child should habe.
7443 Assumes cursor in item line."
7444 (let* ((bolpos (point-at-bol))
7445 (ind (org-get-indentation))
7446 ind-down ind-up pos)
7447 (save-excursion
7448 (org-beginning-of-item-list)
7450 (when (org-in-item-p)
7451 (org-beginning-of-item)
7452 (setq ind-up (org-get-indentation))))
7453 (setq pos (point))
7454 (save-excursion
7455 (cond
7456 ((and (condition-case nil (progn (org-previous-item) t)
7457 (error nil))
7458 (or (forward-char 1) t)
7459 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7460 (setq ind-down (org-get-indentation)))
7461 ((and (goto-char pos)
7462 (org-at-item-p))
7463 (goto-char (match-end 0))
7465 (setq ind-down (current-column)))))
7466 (list ind ind-up ind-down)))
7468 ;;; The orgstruct minor mode
7470 ;; Define a minor mode which can be used in other modes in order to
7471 ;; integrate the org-mode structure editing commands.
7473 ;; This is really a hack, because the org-mode structure commands use
7474 ;; keys which normally belong to the major mode. Here is how it
7475 ;; works: The minor mode defines all the keys necessary to operate the
7476 ;; structure commands, but wraps the commands into a function which
7477 ;; tests if the cursor is currently at a headline or a plain list
7478 ;; item. If that is the case, the structure command is used,
7479 ;; temporarily setting many Org-mode variables like regular
7480 ;; expressions for filling etc. However, when any of those keys is
7481 ;; used at a different location, function uses `key-binding' to look
7482 ;; up if the key has an associated command in another currently active
7483 ;; keymap (minor modes, major mode, global), and executes that
7484 ;; command. There might be problems if any of the keys is otherwise
7485 ;; used as a prefix key.
7487 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7488 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7489 ;; addresses this by checking explicitly for both bindings.
7491 (defvar orgstruct-mode-map (make-sparse-keymap)
7492 "Keymap for the minor `orgstruct-mode'.")
7494 (defvar org-local-vars nil
7495 "List of local variables, for use by `orgstruct-mode'")
7497 ;;;###autoload
7498 (define-minor-mode orgstruct-mode
7499 "Toggle the minor more `orgstruct-mode'.
7500 This mode is for using Org-mode structure commands in other modes.
7501 The following key behave as if Org-mode was active, if the cursor
7502 is on a headline, or on a plain list item (both in the definition
7503 of Org-mode).
7505 M-up Move entry/item up
7506 M-down Move entry/item down
7507 M-left Promote
7508 M-right Demote
7509 M-S-up Move entry/item up
7510 M-S-down Move entry/item down
7511 M-S-left Promote subtree
7512 M-S-right Demote subtree
7513 M-q Fill paragraph and items like in Org-mode
7514 C-c ^ Sort entries
7515 C-c - Cycle list bullet
7516 TAB Cycle item visibility
7517 M-RET Insert new heading/item
7518 S-M-RET Insert new TODO heading / Chekbox item
7519 C-c C-c Set tags / toggle checkbox"
7520 nil " OrgStruct" nil
7521 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7523 ;;;###autoload
7524 (defun turn-on-orgstruct ()
7525 "Unconditionally turn on `orgstruct-mode'."
7526 (orgstruct-mode 1))
7528 ;;;###autoload
7529 (defun turn-on-orgstruct++ ()
7530 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7531 In addition to setting orgstruct-mode, this also exports all indentation and
7532 autofilling variables from org-mode into the buffer. Note that turning
7533 off orgstruct-mode will *not* remove these additional settings."
7534 (orgstruct-mode 1)
7535 (let (var val)
7536 (mapc
7537 (lambda (x)
7538 (when (string-match
7540 (symbol-name (car x)))
7541 (setq var (car x) val (nth 1 x))
7542 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7543 org-local-vars)))
7545 (defun orgstruct-error ()
7546 "Error when there is no default binding for a structure key."
7547 (interactive)
7548 (error "This key has no function outside structure elements"))
7550 (defun orgstruct-setup ()
7551 "Setup orgstruct keymaps."
7552 (let ((nfunc 0)
7553 (bindings
7554 (list
7555 '([(meta up)] org-metaup)
7556 '([(meta down)] org-metadown)
7557 '([(meta left)] org-metaleft)
7558 '([(meta right)] org-metaright)
7559 '([(meta shift up)] org-shiftmetaup)
7560 '([(meta shift down)] org-shiftmetadown)
7561 '([(meta shift left)] org-shiftmetaleft)
7562 '([(meta shift right)] org-shiftmetaright)
7563 '([(shift up)] org-shiftup)
7564 '([(shift down)] org-shiftdown)
7565 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7566 '("\M-q" fill-paragraph)
7567 '("\C-c^" org-sort)
7568 '("\C-c-" org-cycle-list-bullet)))
7569 elt key fun cmd)
7570 (while (setq elt (pop bindings))
7571 (setq nfunc (1+ nfunc))
7572 (setq key (org-key (car elt))
7573 fun (nth 1 elt)
7574 cmd (orgstruct-make-binding fun nfunc key))
7575 (org-defkey orgstruct-mode-map key cmd))
7577 ;; Special treatment needed for TAB and RET
7578 (org-defkey orgstruct-mode-map [(tab)]
7579 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7580 (org-defkey orgstruct-mode-map "\C-i"
7581 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7583 (org-defkey orgstruct-mode-map "\M-\C-m"
7584 (orgstruct-make-binding 'org-insert-heading 105
7585 "\M-\C-m" [(meta return)]))
7586 (org-defkey orgstruct-mode-map [(meta return)]
7587 (orgstruct-make-binding 'org-insert-heading 106
7588 [(meta return)] "\M-\C-m"))
7590 (org-defkey orgstruct-mode-map [(shift meta return)]
7591 (orgstruct-make-binding 'org-insert-todo-heading 107
7592 [(meta return)] "\M-\C-m"))
7594 (unless org-local-vars
7595 (setq org-local-vars (org-get-local-variables)))
7597 t))
7599 (defun orgstruct-make-binding (fun n &rest keys)
7600 "Create a function for binding in the structure minor mode.
7601 FUN is the command to call inside a table. N is used to create a unique
7602 command name. KEYS are keys that should be checked in for a command
7603 to execute outside of tables."
7604 (eval
7605 (list 'defun
7606 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7607 '(arg)
7609 "Outside of structure, run the binding of `"
7610 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7611 "'.")
7612 '(interactive "p")
7613 (list 'if
7614 '(org-context-p 'headline 'item)
7615 (list 'org-run-like-in-org-mode (list 'quote fun))
7616 (list 'let '(orgstruct-mode)
7617 (list 'call-interactively
7618 (append '(or)
7619 (mapcar (lambda (k)
7620 (list 'key-binding k))
7621 keys)
7622 '('orgstruct-error))))))))
7624 (defun org-context-p (&rest contexts)
7625 "Check if local context is and of CONTEXTS.
7626 Possible values in the list of contexts are `table', `headline', and `item'."
7627 (let ((pos (point)))
7628 (goto-char (point-at-bol))
7629 (prog1 (or (and (memq 'table contexts)
7631 (and (memq 'headline contexts)
7633 (and (memq 'item contexts)
7635 (goto-char pos))))
7637 (defun org-get-local-variables ()
7638 "Return a list of all local variables in an org-mode buffer."
7639 (let (varlist)
7640 (with-current-buffer (get-buffer-create "*Org tmp*")
7641 (erase-buffer)
7642 (org-mode)
7643 (setq varlist (buffer-local-variables)))
7644 (kill-buffer "*Org tmp*")
7645 (delq nil
7646 (mapcar
7647 (lambda (x)
7648 (setq x
7649 (if (symbolp x)
7650 (list x)
7651 (list (car x) (list 'quote (cdr x)))))
7652 (if (string-match
7653 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7654 (symbol-name (car x)))
7655 x nil))
7656 varlist))))
7658 ;;;###autoload
7659 (defun org-run-like-in-org-mode (cmd)
7660 (unless org-local-vars
7661 (setq org-local-vars (org-get-local-variables)))
7662 (eval (list 'let org-local-vars
7663 (list 'call-interactively (list 'quote cmd)))))
7665 ;;;; Archiving
7667 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7669 (defun org-archive-subtree (&optional find-done)
7670 "Move the current subtree to the archive.
7671 The archive can be a certain top-level heading in the current file, or in
7672 a different file. The tree will be moved to that location, the subtree
7673 heading be marked DONE, and the current time will be added.
7675 When called with prefix argument FIND-DONE, find whole trees without any
7676 open TODO items and archive them (after getting confirmation from the user).
7677 If the cursor is not at a headline when this comand is called, try all level
7678 1 trees. If the cursor is on a headline, only try the direct children of
7679 this heading."
7680 (interactive "P")
7681 (if find-done
7682 (org-archive-all-done)
7683 ;; Save all relevant TODO keyword-relatex variables
7685 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7686 (tr-org-todo-keywords-1 org-todo-keywords-1)
7687 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7688 (tr-org-done-keywords org-done-keywords)
7689 (tr-org-todo-regexp org-todo-regexp)
7690 (tr-org-todo-line-regexp org-todo-line-regexp)
7691 (tr-org-odd-levels-only org-odd-levels-only)
7692 (this-buffer (current-buffer))
7693 (org-archive-location org-archive-location)
7695 ;; start of variables that will be used for saving context
7696 ;; The compiler complains about them - keep them anyway!
7697 (file (abbreviate-file-name (buffer-file-name)))
7698 (time (format-time-string
7699 (substring (cdr org-time-stamp-formats) 1 -1)
7700 (current-time)))
7701 afile heading buffer level newfile-p
7702 category todo priority
7703 ;; start of variables that will be used for savind context
7704 ltags itags prop)
7706 ;; Try to find a local archive location
7707 (save-excursion
7708 (save-restriction
7709 (widen)
7710 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7712 (setq org-archive-location prop)
7713 (if (or (re-search-backward re nil t)
7714 (re-search-forward re nil t))
7715 (setq org-archive-location (match-string 1))))))
7718 (progn
7719 (setq afile (format (match-string 1 org-archive-location)
7720 (file-name-nondirectory buffer-file-name))
7721 heading (match-string 2 org-archive-location)))
7722 (error "Invalid `org-archive-location'"))
7723 (if (> (length afile) 0)
7724 (setq newfile-p (not (file-exists-p afile))
7725 buffer (find-file-noselect afile))
7726 (setq buffer (current-buffer)))
7727 (unless buffer
7729 (if (and (> (length heading) 0)
7731 (setq level (match-end 0))
7732 (setq heading nil level 0))
7733 (save-excursion
7734 (org-back-to-heading t)
7735 ;; Get context information that will be lost by moving the tree
7736 (org-refresh-category-properties)
7737 (setq category (org-get-category)
7738 todo (and (looking-at org-todo-line-regexp)
7739 (match-string 2))
7740 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7741 ltags (org-get-tags)
7742 itags (org-delete-all ltags (org-get-tags-at)))
7743 (setq ltags (mapconcat 'identity ltags " ")
7744 itags (mapconcat 'identity itags " "))
7745 ;; We first only copy, in case something goes wrong
7746 ;; we need to protect this-command, to avoid kill-region sets it,
7747 ;; which would lead to duplication of subtrees
7748 (let (this-command) (org-copy-subtree))
7749 (set-buffer buffer)
7750 ;; Enforce org-mode for the archive buffer
7751 (if (not (org-mode-p))
7752 ;; Force the mode for future visits.
7753 (let ((org-insert-mode-line-in-empty-file t)
7754 (org-inhibit-startup t))
7755 (call-interactively 'org-mode)))
7756 (when newfile-p
7757 (goto-char (point-max))
7759 (buffer-file-name this-buffer))))
7760 ;; Force the TODO keywords of the original buffer
7761 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7762 (org-todo-keywords-1 tr-org-todo-keywords-1)
7763 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7764 (org-done-keywords tr-org-done-keywords)
7765 (org-todo-regexp tr-org-todo-regexp)
7766 (org-todo-line-regexp tr-org-todo-line-regexp)
7767 (org-odd-levels-only
7768 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7769 org-odd-levels-only
7770 tr-org-odd-levels-only)))
7771 (goto-char (point-min))
7772 (if heading
7773 (progn
7774 (if (re-search-forward
7775 (concat "^" (regexp-quote heading)
7777 nil t)
7778 (goto-char (match-end 0))
7779 ;; Heading not found, just insert it at the end
7780 (goto-char (point-max))
7783 (end-of-line 0))
7784 ;; Make the subtree visible
7785 (show-subtree)
7786 (org-end-of-subtree t)
7790 ;; No specific heading, just go to end of file.
7792 ;; Paste
7793 (org-paste-subtree (org-get-valid-level level 1))
7795 ;; Mark the entry as done
7796 (when (and org-archive-mark-done
7797 (looking-at org-todo-line-regexp)
7798 (or (not (match-end 2))
7799 (not (member (match-string 2) org-done-keywords))))
7800 (let (org-log-done)
7801 (org-todo
7802 (car (or (member org-archive-mark-done org-done-keywords)
7803 org-done-keywords)))))
7805 ;; Add the context info
7806 (when org-archive-save-context-info
7807 (let ((l org-archive-save-context-info) e n v)
7808 (while (setq e (pop l))
7809 (when (and (setq v (symbol-value e))
7811 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7812 (org-entry-put (point) n v)))))
7814 ;; Save the buffer, if it is not the same buffer.
7815 (if (not (eq this-buffer buffer)) (save-buffer))))
7816 ;; Here we are back in the original buffer. Everything seems to have
7817 ;; worked. So now cut the tree and finish up.
7818 (let (this-command) (org-cut-subtree))
7820 (message "Subtree archived %s"
7821 (if (eq this-buffer buffer)
7822 (concat "under heading: " heading)
7823 (concat "in file: " (abbreviate-file-name afile)))))))
7825 (defun org-refresh-category-properties ()
7826 "Refresh category text properties in teh buffer."
7827 (let ((def-cat (cond
7828 ((null org-category)
7829 (if buffer-file-name
7830 (file-name-sans-extension
7831 (file-name-nondirectory buffer-file-name))
7832 "???"))
7833 ((symbolp org-category) (symbol-name org-category))
7834 (t org-category)))
7835 beg end cat pos optionp)
7836 (org-unmodified
7837 (save-excursion
7838 (save-restriction
7839 (widen)
7840 (goto-char (point-min))
7841 (put-text-property (point) (point-max) 'org-category def-cat)
7842 (while (re-search-forward
7844 (setq pos (match-end 0)
7845 optionp (equal (char-after (match-beginning 0)) ?#)
7846 cat (org-trim (match-string 2)))
7847 (if optionp
7848 (setq beg (point-at-bol) end (point-max))
7849 (org-back-to-heading t)
7850 (setq beg (point) end (org-end-of-subtree t t)))
7851 (put-text-property beg end 'org-category cat)
7852 (goto-char pos)))))))
7854 (defun org-archive-all-done (&optional tag)
7855 "Archive sublevels of the current tree without open TODO items.
7856 If the cursor is not on a headline, try all level 1 trees. If
7857 it is on a headline, try all direct children.
7858 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7860 (rea (concat ".*:" org-archive-tag ":"))
7861 (begm (make-marker))
7862 (endm (make-marker))
7863 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7864 "Move subtree to archive (no open TODO items)? "))
7865 beg end (cntarch 0))
7866 (if (org-on-heading-p)
7867 (progn
7868 (setq re1 (concat "^" (regexp-quote
7869 (make-string
7870 (1+ (- (match-end 0) (match-beginning 0)))
7871 ?*))
7872 " "))
7873 (move-marker begm (point))
7874 (move-marker endm (org-end-of-subtree t)))
7875 (setq re1 "^* ")
7876 (move-marker begm (point-min))
7877 (move-marker endm (point-max)))
7878 (save-excursion
7879 (goto-char begm)
7880 (while (re-search-forward re1 endm t)
7881 (setq beg (match-beginning 0)
7882 end (save-excursion (org-end-of-subtree t) (point)))
7883 (goto-char beg)
7884 (if (re-search-forward re end t)
7885 (goto-char end)
7886 (goto-char beg)
7887 (if (and (or (not tag) (not (looking-at rea)))
7888 (y-or-n-p question))
7889 (progn
7890 (if tag
7891 (org-toggle-tag org-archive-tag 'on)
7892 (org-archive-subtree))
7893 (setq cntarch (1+ cntarch)))
7894 (goto-char end)))))
7895 (message "%d trees archived" cntarch)))
7897 (defun org-cycle-hide-drawers (state)
7898 "Re-hide all drawers after a visibility state change."
7899 (when (and (org-mode-p)
7900 (not (memq state '(overview folded))))
7901 (save-excursion
7902 (let* ((globalp (memq state '(contents all)))
7903 (beg (if globalp (point-min) (point)))
7904 (end (if globalp (point-max) (org-end-of-subtree t))))
7905 (goto-char beg)
7906 (while (re-search-forward org-drawer-regexp end t)
7907 (org-flag-drawer t))))))
7909 (defun org-flag-drawer (flag)
7910 (save-excursion
7911 (beginning-of-line 1)
7913 (let ((b (match-end 0))
7914 (outline-regexp org-outline-regexp))
7915 (if (re-search-forward
7917 (save-excursion (outline-next-heading) (point)) t)
7918 (outline-flag-region b (point-at-eol) flag)
7919 (error ":END: line missing"))))))
7921 (defun org-cycle-hide-archived-subtrees (state)
7922 "Re-hide all archived subtrees after a visibility state change."
7923 (when (and (not org-cycle-open-archived-trees)
7924 (not (memq state '(overview folded))))
7925 (save-excursion
7926 (let* ((globalp (memq state '(contents all)))
7927 (beg (if globalp (point-min) (point)))
7928 (end (if globalp (point-max) (org-end-of-subtree t))))
7929 (org-hide-archived-subtrees beg end)
7930 (goto-char beg)
7931 (if (looking-at (concat ".*:" org-archive-tag ":"))
7932 (message "%s" (substitute-command-keys
7933 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
7935 (defun org-force-cycle-archived ()
7936 "Cycle subtree even if it is archived."
7937 (interactive)
7938 (setq this-command 'org-cycle)
7939 (let ((org-cycle-open-archived-trees t))
7940 (call-interactively 'org-cycle)))
7942 (defun org-hide-archived-subtrees (beg end)
7943 "Re-hide all archived subtrees after a visibility state change."
7944 (save-excursion
7945 (let* ((re (concat ":" org-archive-tag ":")))
7946 (goto-char beg)
7947 (while (re-search-forward re end t)
7948 (and (org-on-heading-p) (hide-subtree))
7949 (org-end-of-subtree t)))))
7951 (defun org-toggle-tag (tag &optional onoff)
7952 "Toggle the tag TAG for the current line.
7953 If ONOFF is `on' or `off', don't toggle but set to this state."
7954 (unless (org-on-heading-p t) (error "Not on headling"))
7955 (let (res current)
7956 (save-excursion
7957 (beginning-of-line)
7959 (point-at-eol) t)
7960 (progn
7961 (setq current (match-string 1))
7962 (replace-match ""))
7963 (setq current ""))
7964 (setq current (nreverse (org-split-string current ":")))
7965 (cond
7966 ((eq onoff 'on)
7967 (setq res t)
7968 (or (member tag current) (push tag current)))
7969 ((eq onoff 'off)
7970 (or (not (member tag current)) (setq current (delete tag current))))
7971 (t (if (member tag current)
7972 (setq current (delete tag current))
7973 (setq res t)
7974 (push tag current))))
7975 (end-of-line 1)
7976 (if current
7977 (progn
7978 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
7979 (org-set-tags nil t))
7980 (delete-horizontal-space))
7981 (run-hooks 'org-after-tags-change-hook))
7982 res))
7984 (defun org-toggle-archive-tag (&optional arg)
7985 "Toggle the archive tag for the current headline.
7986 With prefix ARG, check all children of current headline and offer tagging
7987 the children that do not contain any open TODO items."
7988 (interactive "P")
7989 (if arg
7990 (org-archive-all-done 'tag)
7991 (let (set)
7992 (save-excursion
7993 (org-back-to-heading t)
7994 (setq set (org-toggle-tag org-archive-tag))
7995 (when set (hide-subtree)))
7996 (and set (beginning-of-line 1))
7997 (message "Subtree %s" (if set "archived" "unarchived")))))
8000 ;;;; Tables
8002 ;;; The table editor
8004 ;; Watch out: Here we are talking about two different kind of tables.
8005 ;; Most of the code is for the tables created with the Org-mode table editor.
8006 ;; Sometimes, we talk about tables created and edited with the table.el
8007 ;; Emacs package. We call the former org-type tables, and the latter
8008 ;; table.el-type tables.
8010 (defun org-before-change-function (beg end)
8011 "Every change indicates that a table might need an update."
8012 (setq org-table-may-need-update t))
8015 "Detects an org-type table line.")
8017 "Detects an org-type table line.")
8019 "Detects a table line marked for automatic recalculation.")
8021 "Detects a table line marked for automatic recalculation.")
8023 "Detects a table line marked for automatic recalculation.")
8025 "Detects an org-type table hline.")
8027 "Detects a table-type table hline.")
8029 "Detects an org-type or table-type table.")
8031 "Searching from within a table (any type) this finds the first line
8032 outside the table.")
8034 "Searching from within a table (any type) this finds the first line
8035 outside the table.")
8037 (defvar org-table-last-highlighted-reference nil)
8038 (defvar org-table-formula-history nil)
8040 (defvar org-table-column-names nil
8041 "Alist with column names, derived from the `!' line.")
8042 (defvar org-table-column-name-regexp nil
8043 "Regular expression matching the current column names.")
8044 (defvar org-table-local-parameters nil
8045 "Alist with parameter names, derived from the `$' line.")
8046 (defvar org-table-named-field-locations nil
8047 "Alist with locations of named fields.")
8049 (defvar org-table-current-line-types nil
8050 "Table row types, non-nil only for the duration of a comand.")
8051 (defvar org-table-current-begin-line nil
8052 "Table begin line, non-nil only for the duration of a comand.")
8053 (defvar org-table-current-begin-pos nil
8054 "Table begin position, non-nil only for the duration of a comand.")
8055 (defvar org-table-dlines nil
8056 "Vector of data line line numbers in the current table.")
8057 (defvar org-table-hlines nil
8058 "Vector of hline line numbers in the current table.")
8060 (defconst org-table-range-regexp
8061 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8062 ;; 1 2 3 4 5
8063 "Regular expression for matching ranges in formulas.")
8065 (defconst org-table-range-regexp2
8066 (concat
8070 "Match a range for reference display.")
8072 (defconst org-table-translate-regexp
8074 "Match a reference that needs translation, for reference display.")
8076 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8078 (defun org-table-create-with-table.el ()
8079 "Use the table.el package to insert a new table.
8080 If there is already a table at point, convert between Org-mode tables
8081 and table.el tables."
8082 (interactive)
8083 (require 'table)
8084 (cond
8085 ((org-at-table.el-p)
8086 (if (y-or-n-p "Convert table to Org-mode table? ")
8087 (org-table-convert)))
8088 ((org-at-table-p)
8089 (if (y-or-n-p "Convert table to table.el table? ")
8090 (org-table-convert)))
8091 (t (call-interactively 'table-insert))))
8093 (defun org-table-create-or-convert-from-region (arg)
8094 "Convert region to table, or create an empty table.
8095 If there is an active region, convert it to a table, using the function
8096 `org-table-convert-region'. See the documentation of that function
8097 to learn how the prefix argument is interpreted to determine the field
8098 separator.
8099 If there is no such region, create an empty table with `org-table-create'."
8100 (interactive "P")
8101 (if (org-region-active-p)
8102 (org-table-convert-region (region-beginning) (region-end) arg)
8103 (org-table-create arg)))
8105 (defun org-table-create (&optional size)
8106 "Query for a size and insert a table skeleton.
8108 (interactive "P")
8109 (unless size
8110 (setq size (read-string
8111 (concat "Table size Columns x Rows [e.g. "
8112 org-table-default-size "]: ")
8113 "" nil org-table-default-size)))
8115 (let* ((pos (point))
8116 (indent (make-string (current-column) ?\ ))
8117 (split (org-split-string size " *x *"))
8118 (rows (string-to-number (nth 1 split)))
8119 (columns (string-to-number (car split)))
8120 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8123 (point-at-bol) (point)))
8124 (beginning-of-line 1)
8125 (newline))
8126 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8127 (dotimes (i rows) (insert line))
8128 (goto-char pos)
8129 (if (> rows 1)
8130 ;; Insert a hline after the first row.
8131 (progn
8132 (end-of-line 1)
8134 (goto-char pos)))
8135 (org-table-align)))
8137 (defun org-table-convert-region (beg0 end0 &optional separator)
8138 "Convert region to a table.
8139 The region goes from BEG0 to END0, but these borders will be moved
8140 slightly, to make sure a beginning of line in the first line is included.
8142 SEPARATOR specifies the field separator in the lines. It can have the
8143 following values:
8145 '(4) Use the comma as a field separator
8146 '(16) Use a TAB as field separator
8147 integer When a number, use that many spaces as field separator
8148 nil When nil, the command tries to be smart and figure out the
8149 separator in the following way:
8150 - when each line contains a TAB, assume TAB-separated material
8151 - when each line contains a comme, assume CSV material
8152 - else, assume one or more SPACE charcters as separator."
8153 (interactive "rP")
8154 (let* ((beg (min beg0 end0))
8155 (end (max beg0 end0))
8156 re)
8157 (goto-char beg)
8158 (beginning-of-line 1)
8159 (setq beg (move-marker (make-marker) (point)))
8160 (goto-char end)
8161 (if (bolp) (backward-char 1) (end-of-line 1))
8162 (setq end (move-marker (make-marker) (point)))
8163 ;; Get the right field separator
8164 (unless separator
8165 (goto-char beg)
8166 (setq separator
8167 (cond
8170 (t 1))))
8171 (setq re (cond
8174 ((integerp separator)
8176 (t (error "This should not happen"))))
8177 (goto-char beg)
8178 (while (re-search-forward re end t)
8179 (replace-match "| " t t))
8180 (goto-char beg)
8181 (insert " ")
8182 (org-table-align)))
8184 (defun org-table-import (file arg)
8185 "Import FILE as a table.
8186 The file is assumed to be tab-separated. Such files can be produced by most
8187 spreadsheet and database applications. If no tabs (at least one per line)
8188 are found, lines will be split on whitespace into fields."
8190 (or (bolp) (newline))
8191 (let ((beg (point))
8192 (pm (point-max)))
8193 (insert-file-contents file)
8194 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8196 (defun org-table-export ()
8197 "Export table as a tab-separated file.
8198 Such a file can be imported into a spreadsheet program like Excel."
8199 (interactive)
8200 (let* ((beg (org-table-begin))
8201 (end (org-table-end))
8202 (table (buffer-substring beg end))
8203 (file (read-file-name "Export table to: "))
8204 buf)
8205 (unless (or (not (file-exists-p file))
8206 (y-or-n-p (format "Overwrite file %s? " file)))
8207 (error "Abort"))
8208 (with-current-buffer (find-file-noselect file)
8209 (setq buf (current-buffer))
8210 (erase-buffer)
8211 (fundamental-mode)
8212 (insert table)
8213 (goto-char (point-min))
8215 (replace-match "" t t)
8216 (end-of-line 1))
8217 (goto-char (point-min))
8219 (replace-match "" t t)
8220 (goto-char (min (1+ (point)) (point-max))))
8221 (goto-char (point-min))
8222 (while (re-search-forward "^-[-+]*$" nil t)
8223 (replace-match "")
8225 (delete-char 1)))
8226 (goto-char (point-min))
8229 (save-buffer))
8230 (kill-buffer buf)))
8232 (defvar org-table-aligned-begin-marker (make-marker)
8233 "Marker at the beginning of the table last aligned.
8234 Used to check if cursor still is in that table, to minimize realignment.")
8235 (defvar org-table-aligned-end-marker (make-marker)
8236 "Marker at the end of the table last aligned.
8237 Used to check if cursor still is in that table, to minimize realignment.")
8238 (defvar org-table-last-alignment nil
8239 "List of flags for flushright alignment, from the last re-alignment.
8240 This is being used to correctly align a single field after TAB or RET.")
8241 (defvar org-table-last-column-widths nil
8242 "List of max width of fields in each column.
8243 This is being used to correctly align a single field after TAB or RET.")
8244 (defvar org-table-overlay-coordinates nil
8245 "Overlay coordinates after each align of a table.")
8246 (make-variable-buffer-local 'org-table-overlay-coordinates)
8248 (defvar org-last-recalc-line nil)
8249 (defconst org-narrow-column-arrow "=>"
8250 "Used as display property in narrowed table columns.")
8252 (defun org-table-align ()
8253 "Align the table at point by aligning all vertical bars."
8254 (interactive)
8255 (let* (
8256 ;; Limits of table
8257 (beg (org-table-begin))
8258 (end (org-table-end))
8259 ;; Current cursor position
8260 (linepos (org-current-line))
8261 (colpos (org-table-current-column))
8262 (winstart (window-start))
8263 (winstartline (org-current-line (min winstart (1- (point-max)))))
8264 lines (new "") lengths l typenums ty fields maxfields i
8265 column
8266 (indent "") cnt frac
8267 rfmt hfmt
8268 (spaces '(1 . 1))
8269 (sp1 (car spaces))
8270 (sp2 (cdr spaces))
8271 (rfmt1 (concat
8272 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8273 (hfmt1 (concat
8274 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8275 emptystrings links dates emph narrow fmax f1 len c e)
8276 (untabify beg end)
8277 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8278 ;; Check if we have links or dates
8279 (goto-char beg)
8280 (setq links (re-search-forward org-bracket-link-regexp end t))
8281 (goto-char beg)
8282 (setq emph (and org-hide-emphasis-markers
8283 (re-search-forward org-emph-re end t)))
8284 (goto-char beg)
8285 (setq dates (and org-display-custom-times
8286 (re-search-forward org-ts-regexp-both end t)))
8287 ;; Make sure the link properties are right
8288 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8289 ;; Make sure the date properties are right
8290 (when dates (goto-char beg) (while (org-activate-dates end)))
8291 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8293 ;; Check if we are narrowing any columns
8294 (goto-char beg)
8295 (setq narrow (and org-format-transports-properties-p
8296 (re-search-forward "<[0-9]+>" end t)))
8297 ;; Get the rows
8298 (setq lines (org-split-string
8300 ;; Store the indentation of the first line
8301 (if (string-match "^ *" (car lines))
8302 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8303 ;; Mark the hlines by setting the corresponding element to nil
8304 ;; At the same time, we remove trailing space.
8305 (setq lines (mapcar (lambda (l)
8306 (if (string-match "^ *|-" l)
8307 nil
8309 (substring l 0 (match-beginning 0))
8310 l)))
8311 lines))
8312 ;; Get the data fields by splitting the lines.
8313 (setq fields (mapcar
8314 (lambda (l)
8315 (org-split-string l " *| *"))
8316 (delq nil (copy-sequence lines))))
8317 ;; How many fields in the longest line?
8318 (condition-case nil
8319 (setq maxfields (apply 'max (mapcar 'length fields)))
8320 (error
8321 (kill-region beg end)
8322 (org-table-create org-table-default-size)
8323 (error "Empty table - created default table")))
8324 ;; A list of empty strings to fill any short rows on output
8325 (setq emptystrings (make-list maxfields ""))
8326 ;; Check for special formatting.
8327 (setq i -1)
8328 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8329 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8330 ;; Check if there is an explicit width specified
8331 (when narrow
8332 (setq c column fmax nil)
8333 (while c
8334 (setq e (pop c))
8336 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8337 ;; Find fields that are wider than fmax, and shorten them
8338 (when fmax
8339 (loop for xx in column do
8340 (when (and (stringp xx)
8341 (> (org-string-width xx) fmax))
8342 (org-add-props xx nil
8343 'help-echo
8344 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8345 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8346 (unless (> f1 1)
8348 (match-string 0 xx)))
8349 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8350 (add-text-properties (- f1 2) f1
8351 (list 'display org-narrow-column-arrow)
8352 xx)))))
8353 ;; Get the maximum width for each column
8354 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8355 ;; Get the fraction of numbers, to decide about alignment of the column
8356 (setq cnt 0 frac 0.0)
8357 (loop for x in column do
8358 (if (equal x "")
8359 nil
8360 (setq frac ( / (+ (* frac cnt)
8361 (if (string-match org-table-number-regexp x) 1 0))
8362 (setq cnt (1+ cnt))))))
8363 (push (>= frac org-table-number-fraction) typenums))
8364 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8366 ;; Store the alignment of this table, for later editing of single fields
8367 (setq org-table-last-alignment typenums
8368 org-table-last-column-widths lengths)
8370 ;; With invisible characters, `format' does not get the field width right
8371 ;; So we need to make these fields wide by hand.
8372 (when (or links emph)
8373 (loop for i from 0 upto (1- maxfields) do
8374 (setq len (nth i lengths))
8375 (loop for j from 0 upto (1- (length fields)) do
8376 (setq c (nthcdr i (car (nthcdr j fields))))
8377 (if (and (stringp (car c))
8378 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8379 ; (string-match org-bracket-link-regexp (car c))
8380 (< (org-string-width (car c)) len))
8381 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8383 ;; Compute the formats needed for output of the table
8384 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8385 (while (setq l (pop lengths))
8386 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8387 (setq rfmt (concat rfmt (format rfmt1 ty l))
8388 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8392 (setq new (mapconcat
8393 (lambda (l)
8394 (if l (apply 'format rfmt
8395 (append (pop fields) emptystrings))
8396 hfmt))
8397 lines ""))
8398 ;; Replace the old one
8399 (delete-region beg end)
8400 (move-marker end nil)
8401 (move-marker org-table-aligned-begin-marker (point))
8402 (insert new)
8403 (move-marker org-table-aligned-end-marker (point))
8404 (when (and orgtbl-mode (not (org-mode-p)))
8405 (goto-char org-table-aligned-begin-marker)
8406 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8407 ;; Try to move to the old location
8408 (goto-line winstartline)
8409 (setq winstart (point-at-bol))
8410 (goto-line linepos)
8411 (set-window-start (selected-window) winstart 'noforce)
8412 (org-table-goto-column colpos)
8413 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8414 (setq org-table-may-need-update nil)
8415 ))
8417 (defun org-string-width (s)
8418 "Compute width of string, ignoring invisible characters.
8419 This ignores character with invisibility property `org-link', and also
8420 characters with property `org-cwidth', because these will become invisible
8421 upon the next fontification round."
8422 (let (b l)
8423 (when (or (eq t buffer-invisibility-spec)
8424 (assq 'org-link buffer-invisibility-spec))
8425 (while (setq b (text-property-any 0 (length s)
8426 'invisible 'org-link s))
8427 (setq s (concat (substring s 0 b)
8428 (substring s (or (next-single-property-change
8429 b 'invisible s) (length s)))))))
8430 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8431 (setq s (concat (substring s 0 b)
8432 (substring s (or (next-single-property-change
8433 b 'org-cwidth s) (length s))))))
8434 (setq l (string-width s) b -1)
8435 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8436 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8437 l))
8439 (defun org-table-begin (&optional table-type)
8440 "Find the beginning of the table and return its position.
8441 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8442 (save-excursion
8443 (if (not (re-search-backward
8444 (if table-type org-table-any-border-regexp
8445 org-table-border-regexp)
8446 nil t))
8447 (progn (goto-char (point-min)) (point))
8448 (goto-char (match-beginning 0))
8449 (beginning-of-line 2)
8450 (point))))
8452 (defun org-table-end (&optional table-type)
8453 "Find the end of the table and return its position.
8454 With argument TABLE-TYPE, go to the end of a table.el-type table."
8455 (save-excursion
8456 (if (not (re-search-forward
8457 (if table-type org-table-any-border-regexp
8458 org-table-border-regexp)
8459 nil t))
8460 (goto-char (point-max))
8461 (goto-char (match-beginning 0)))
8462 (point-marker)))
8464 (defun org-table-justify-field-maybe (&optional new)
8465 "Justify the current field, text to left, number to right.
8466 Optional argument NEW may specify text to replace the current field content."
8467 (cond
8468 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8469 ((org-at-table-hline-p))
8470 ((and (not new)
8471 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8472 (current-buffer)))
8473 (< (point) org-table-aligned-begin-marker)
8474 (>= (point) org-table-aligned-end-marker)))
8475 ;; This is not the same table, force a full re-align
8476 (setq org-table-may-need-update t))
8477 (t ;; realign the current field, based on previous full realign
8478 (let* ((pos (point)) s
8479 (col (org-table-current-column))
8480 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8481 l f n o e)
8482 (when (> col 0)
8485 (progn
8486 (setq s (match-string 1)
8487 o (match-string 0)
8488 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8489 e (not (= (match-beginning 2) (match-end 2))))
8490 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8491 l (if e "|" (setq org-table-may-need-update t) ""))
8492 n (format f s))
8493 (if new
8494 (if (<= (length new) l) ;; FIXME: length -> str-width?
8495 (setq n (format f new))
8496 (setq n (concat new "|") org-table-may-need-update t)))
8497 (or (equal n o)
8498 (let (org-table-may-need-update)
8499 (replace-match n t t))))
8500 (setq org-table-may-need-update t))
8501 (goto-char pos))))))
8503 (defun org-table-next-field ()
8504 "Go to the next field in the current table, creating new lines as needed.
8505 Before doing so, re-align the table if necessary."
8506 (interactive)
8507 (org-table-maybe-eval-formula)
8508 (org-table-maybe-recalculate-line)
8509 (if (and org-table-automatic-realign
8510 org-table-may-need-update)
8511 (org-table-align))
8512 (let ((end (org-table-end)))
8513 (if (org-at-table-hline-p)
8514 (end-of-line 1))
8515 (condition-case nil
8516 (progn
8517 (re-search-forward "|" end)
8519 (re-search-forward "|" end))
8520 (if (and (looking-at "-")
8521 org-table-tab-jumps-over-hlines
8523 (goto-char (match-beginning 1)))
8524 (if (looking-at "-")
8525 (progn
8526 (beginning-of-line 0)
8527 (org-table-insert-row 'below))
8528 (if (looking-at " ") (forward-char 1))))
8529 (error
8530 (org-table-insert-row 'below)))))
8532 (defun org-table-previous-field ()
8533 "Go to the previous field in the table.
8534 Before doing so, re-align the table if necessary."
8535 (interactive)
8536 (org-table-justify-field-maybe)
8537 (org-table-maybe-recalculate-line)
8538 (if (and org-table-automatic-realign
8539 org-table-may-need-update)
8540 (org-table-align))
8541 (if (org-at-table-hline-p)
8542 (end-of-line 1))
8543 (re-search-backward "|" (org-table-begin))
8544 (re-search-backward "|" (org-table-begin))
8546 (re-search-backward "|" (org-table-begin)))
8547 (if (looking-at "| ?")
8548 (goto-char (match-end 0))))
8550 (defun org-table-next-row ()
8551 "Go to the next row (same column) in the current table.
8552 Before doing so, re-align the table if necessary."
8553 (interactive)
8554 (org-table-maybe-eval-formula)
8555 (org-table-maybe-recalculate-line)
8558 (newline)
8559 (if (and org-table-automatic-realign
8560 org-table-may-need-update)
8561 (org-table-align))
8562 (let ((col (org-table-current-column)))
8563 (beginning-of-line 2)
8564 (if (or (not (org-at-table-p))
8565 (org-at-table-hline-p))
8566 (progn
8567 (beginning-of-line 0)
8568 (org-table-insert-row 'below)))
8569 (org-table-goto-column col)
8571 (if (looking-at " ") (forward-char 1)))))
8573 (defun org-table-copy-down (n)
8574 "Copy a field down in the current column.
8575 If the field at the cursor is empty, copy into it the content of the nearest
8576 non-empty field above. With argument N, use the Nth non-empty field.
8577 If the current field is not empty, it is copied down to the next row, and
8578 the cursor is moved with it. Therefore, repeating this command causes the
8579 column to be filled row-by-row.
8580 If the variable `org-table-copy-increment' is non-nil and the field is an
8581 integer or a timestamp, it will be incremented while copying. In the case of
8582 a timestamp, if the cursor is on the year, change the year. If it is on the
8583 month or the day, change that. Point will stay on the current date field
8584 in order to easily repeat the interval."
8585 (interactive "p")
8586 (let* ((colpos (org-table-current-column))
8587 (col (current-column))
8588 (field (org-table-get-field))
8590 (beg (org-table-begin))
8591 txt)
8592 (org-table-check-inside-data-field)
8593 (if non-empty
8594 (progn
8595 (setq txt (org-trim field))
8596 (org-table-next-row)
8597 (org-table-blank-field))
8598 (save-excursion
8599 (setq txt
8600 (catch 'exit
8601 (while (progn (beginning-of-line 1)
8602 (re-search-backward org-table-dataline-regexp
8603 beg t))
8604 (org-table-goto-column colpos t)
8605 (if (and (looking-at
8607 (= (setq n (1- n)) 0))
8608 (throw 'exit (match-string 1))))))))
8609 (if txt
8610 (progn
8611 (if (and org-table-copy-increment
8612 (string-match "^[0-9]+$" txt))
8613 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8614 (insert txt)
8615 (move-to-column col)
8616 (if (and org-table-copy-increment (org-at-timestamp-p t))
8617 (org-timestamp-up 1)
8618 (org-table-maybe-recalculate-line))
8619 (org-table-align)
8620 (move-to-column col))
8621 (error "No non-empty field found"))))
8623 (defun org-table-check-inside-data-field ()
8624 "Is point inside a table data field?
8625 I.e. not on a hline or before the first or after the last column?
8626 This actually throws an error, so it aborts the current command."
8627 (if (or (not (org-at-table-p))
8628 (= (org-table-current-column) 0)
8629 (org-at-table-hline-p)
8631 (error "Not in table data field")))
8633 (defvar org-table-clip nil
8634 "Clipboard for table regions.")
8636 (defun org-table-blank-field ()
8637 "Blank the current table field or active region."
8638 (interactive)
8639 (org-table-check-inside-data-field)
8640 (if (and (interactive-p) (org-region-active-p))
8641 (let (org-table-clip)
8642 (org-table-cut-region (region-beginning) (region-end)))
8643 (skip-chars-backward "^|")
8644 (backward-char 1)
8646 (let* ((pos (match-beginning 0))
8647 (match (match-string 0))
8648 (len (org-string-width match)))
8649 (replace-match (concat "|" (make-string (1- len) ?\ )))
8650 (goto-char (+ 2 pos))
8651 (substring match 1)))))
8653 (defun org-table-get-field (&optional n replace)
8654 "Return the value of the field in column N of current row.
8655 N defaults to current field.
8656 If REPLACE is a string, replace field with this value. The return value
8657 is always the old value."
8658 (and n (org-table-goto-column n))
8660 (backward-char 1)
8662 (let* ((pos (match-beginning 0))
8663 (val (buffer-substring (1+ pos) (match-end 0))))
8664 (if replace
8665 (replace-match (concat "|" replace) t t))
8666 (goto-char (min (point-at-eol) (+ 2 pos)))
8667 val)
8668 (forward-char 1) ""))
8670 (defun org-table-field-info (arg)
8671 "Show info about the current field, and highlight any reference at point."
8672 (interactive "P")
8673 (org-table-get-specials)
8674 (save-excursion
8675 (let* ((pos (point))
8676 (col (org-table-current-column))
8677 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8678 (name (car (rassoc (list (org-current-line) col)
8679 org-table-named-field-locations)))
8680 (eql (org-table-get-stored-formulas))
8681 (dline (org-table-current-dline))
8682 (ref (format "@%d$%d" dline col))
8683 (ref1 (org-table-convert-refs-to-an ref))
8684 (fequation (or (assoc name eql) (assoc ref eql)))
8685 (cequation (assoc (int-to-string col) eql))
8686 (eqn (or fequation cequation)))
8687 (goto-char pos)
8688 (condition-case nil
8689 (org-table-show-reference 'local)
8690 (error nil))
8691 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8692 dline col
8693 (if cname (concat " or $" cname) "")
8694 dline col ref1
8695 (if name (concat " or $" name) "")
8696 ;; FIXME: formula info not correct if special table line
8697 (if eqn
8698 (concat ", formula: "
8699 (org-table-formula-to-user
8700 (concat
8701 (if (string-match "^[$@]"(car eqn)) "" "$")
8702 (car eqn) "=" (cdr eqn))))
8703 "")))))
8705 (defun org-table-current-column ()
8706 "Find out which column we are in.
8707 When called interactively, column is also displayed in echo area."
8708 (interactive)
8709 (if (interactive-p) (org-table-check-inside-data-field))
8710 (save-excursion
8711 (let ((cnt 0) (pos (point)))
8712 (beginning-of-line 1)
8713 (while (search-forward "|" pos t)
8714 (setq cnt (1+ cnt)))
8715 (if (interactive-p) (message "This is table column %d" cnt))
8716 cnt)))
8718 (defun org-table-current-dline ()
8719 "Find out what table data line we are in.
8720 Only datalins count for this."
8721 (interactive)
8722 (if (interactive-p) (org-table-check-inside-data-field))
8723 (save-excursion
8724 (let ((cnt 0) (pos (point)))
8725 (goto-char (org-table-begin))
8726 (while (<= (point) pos)
8727 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8728 (beginning-of-line 2))
8729 (if (interactive-p) (message "This is table line %d" cnt))
8730 cnt)))
8732 (defun org-table-goto-column (n &optional on-delim force)
8733 "Move the cursor to the Nth column in the current table line.
8734 With optional argument ON-DELIM, stop with point before the left delimiter
8735 of the field.
8736 If there are less than N fields, just go to after the last delimiter.
8737 However, when FORCE is non-nil, create new columns if necessary."
8738 (interactive "p")
8739 (let ((pos (point-at-eol)))
8740 (beginning-of-line 1)
8741 (when (> n 0)
8742 (while (and (> (setq n (1- n)) -1)
8743 (or (search-forward "|" pos t)
8744 (and force
8745 (progn (end-of-line 1)
8746 (skip-chars-backward "^|")
8747 (insert " | "))))))
8748 ; (backward-char 2) t)))))
8749 (when (and force (not (looking-at ".*|")))
8750 (save-excursion (end-of-line 1) (insert " | ")))
8751 (if on-delim
8752 (backward-char 1)
8753 (if (looking-at " ") (forward-char 1))))))
8755 (defun org-at-table-p (&optional table-type)
8756 "Return t if the cursor is inside an org-type table.
8757 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8758 (if org-enable-table-editor
8759 (save-excursion
8760 (beginning-of-line 1)
8761 (looking-at (if table-type org-table-any-line-regexp
8762 org-table-line-regexp)))
8763 nil))
8765 (defun org-at-table.el-p ()
8766 "Return t if and only if we are at a table.el table."
8767 (and (org-at-table-p 'any)
8768 (save-excursion
8769 (goto-char (org-table-begin 'any))
8770 (looking-at org-table1-hline-regexp))))
8772 (defun org-table-recognize-table.el ()
8773 "If there is a table.el table nearby, recognize it and move into it."
8774 (if org-table-tab-recognizes-table.el
8775 (if (org-at-table.el-p)
8776 (progn
8777 (beginning-of-line 1)
8778 (if (looking-at org-table-dataline-regexp)
8779 nil
8780 (if (looking-at org-table1-hline-regexp)
8781 (progn
8782 (beginning-of-line 2)
8783 (if (looking-at org-table-any-border-regexp)
8784 (beginning-of-line -1)))))
8785 (if (re-search-forward "|" (org-table-end t) t)
8786 (progn
8787 (require 'table)
8788 (if (table--at-cell-p (point))
8789 t
8790 (message "recognizing table.el table...")
8791 (table-recognize-table)
8792 (message "recognizing table.el table...done")))
8793 (error "This should not happen..."))
8794 t)
8795 nil)
8796 nil))
8798 (defun org-at-table-hline-p ()
8799 "Return t if the cursor is inside a hline in a table."
8800 (if org-enable-table-editor
8801 (save-excursion
8802 (beginning-of-line 1)
8803 (looking-at org-table-hline-regexp))
8804 nil))
8806 (defun org-table-insert-column ()
8807 "Insert a new column into the table."
8808 (interactive)
8809 (if (not (org-at-table-p))
8810 (error "Not at a table"))
8811 (org-table-find-dataline)
8812 (let* ((col (max 1 (org-table-current-column)))
8813 (beg (org-table-begin))
8814 (end (org-table-end))
8815 ;; Current cursor position
8816 (linepos (org-current-line))
8817 (colpos col))
8818 (goto-char beg)
8819 (while (< (point) end)
8820 (if (org-at-table-hline-p)
8821 nil
8822 (org-table-goto-column col t)
8823 (insert "| "))
8824 (beginning-of-line 2))
8825 (move-marker end nil)
8826 (goto-line linepos)
8827 (org-table-goto-column colpos)
8828 (org-table-align)
8829 (org-table-fix-formulas "$" nil (1- col) 1)))
8831 (defun org-table-find-dataline ()
8832 "Find a dataline in the current table, which is needed for column commands."
8833 (if (and (org-at-table-p)
8834 (not (org-at-table-hline-p)))
8835 t
8836 (let ((col (current-column))
8837 (end (org-table-end)))
8838 (move-to-column col)
8839 (while (and (< (point) end)
8840 (or (not (= (current-column) col))
8841 (org-at-table-hline-p)))
8842 (beginning-of-line 2)
8843 (move-to-column col))
8844 (if (and (org-at-table-p)
8845 (not (org-at-table-hline-p)))
8846 t
8847 (error
8848 "Please position cursor in a data line for column operations")))))
8850 (defun org-table-delete-column ()
8851 "Delete a column from the table."
8852 (interactive)
8853 (if (not (org-at-table-p))
8854 (error "Not at a table"))
8855 (org-table-find-dataline)
8856 (org-table-check-inside-data-field)
8857 (let* ((col (org-table-current-column))
8858 (beg (org-table-begin))
8859 (end (org-table-end))
8860 ;; Current cursor position
8861 (linepos (org-current-line))
8862 (colpos col))
8863 (goto-char beg)
8864 (while (< (point) end)
8865 (if (org-at-table-hline-p)
8866 nil
8867 (org-table-goto-column col t)
8869 (replace-match "|")))
8870 (beginning-of-line 2))
8871 (move-marker end nil)
8872 (goto-line linepos)
8873 (org-table-goto-column colpos)
8874 (org-table-align)
8875 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
8876 col -1 col)))
8878 (defun org-table-move-column-right ()
8879 "Move column to the right."
8880 (interactive)
8881 (org-table-move-column nil))
8882 (defun org-table-move-column-left ()
8883 "Move column to the left."
8884 (interactive)
8885 (org-table-move-column 'left))
8887 (defun org-table-move-column (&optional left)
8888 "Move the current column to the right. With arg LEFT, move to the left."
8889 (interactive "P")
8890 (if (not (org-at-table-p))
8891 (error "Not at a table"))
8892 (org-table-find-dataline)
8893 (org-table-check-inside-data-field)
8894 (let* ((col (org-table-current-column))
8895 (col1 (if left (1- col) col))
8896 (beg (org-table-begin))
8897 (end (org-table-end))
8898 ;; Current cursor position
8899 (linepos (org-current-line))
8900 (colpos (if left (1- col) (1+ col))))
8901 (if (and left (= col 1))
8902 (error "Cannot move column further left"))
8904 (error "Cannot move column further right"))
8905 (goto-char beg)
8906 (while (< (point) end)
8907 (if (org-at-table-hline-p)
8908 nil
8909 (org-table-goto-column col1 t)
8912 (beginning-of-line 2))
8913 (move-marker end nil)
8914 (goto-line linepos)
8915 (org-table-goto-column colpos)
8916 (org-table-align)
8917 (org-table-fix-formulas
8918 "$" (list (cons (number-to-string col) (number-to-string colpos))
8919 (cons (number-to-string colpos) (number-to-string col))))))
8921 (defun org-table-move-row-down ()
8922 "Move table row down."
8923 (interactive)
8924 (org-table-move-row nil))
8925 (defun org-table-move-row-up ()
8926 "Move table row up."
8927 (interactive)
8928 (org-table-move-row 'up))
8930 (defun org-table-move-row (&optional up)
8931 "Move the current table line down. With arg UP, move it up."
8932 (interactive "P")
8933 (let* ((col (current-column))
8934 (pos (point))
8935 (hline1p (save-excursion (beginning-of-line 1)
8936 (looking-at org-table-hline-regexp)))
8937 (dline1 (org-table-current-dline))
8938 (dline2 (+ dline1 (if up -1 1)))
8939 (tonew (if up 0 2))
8940 txt hline2p)
8941 (beginning-of-line tonew)
8942 (unless (org-at-table-p)
8943 (goto-char pos)
8944 (error "Cannot move row further"))
8945 (setq hline2p (looking-at org-table-hline-regexp))
8946 (goto-char pos)
8947 (beginning-of-line 1)
8948 (setq pos (point))
8949 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
8950 (delete-region (point) (1+ (point-at-eol)))
8951 (beginning-of-line tonew)
8952 (insert txt)
8953 (beginning-of-line 0)
8954 (move-to-column col)
8955 (unless (or hline1p hline2p)
8956 (org-table-fix-formulas
8957 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
8958 (cons (number-to-string dline2) (number-to-string dline1)))))))
8960 (defun org-table-insert-row (&optional arg)
8961 "Insert a new row above the current line into the table.
8962 With prefix ARG, insert below the current line."
8963 (interactive "P")
8964 (if (not (org-at-table-p))
8965 (error "Not at a table"))
8966 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
8967 (new (org-table-clean-line line)))
8968 ;; Fix the first field if necessary
8970 (setq new (replace-match (match-string 0 line) t t new)))
8971 (beginning-of-line (if arg 2 1))
8973 (beginning-of-line 0)
8974 (re-search-forward "| ?" (point-at-eol) t)
8975 (and (or org-table-may-need-update org-table-overlay-coordinates)
8976 (org-table-align))
8977 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
8979 (defun org-table-insert-hline (&optional above)
8980 "Insert a horizontal-line below the current line into the table.
8981 With prefix ABOVE, insert above the current line."
8982 (interactive "P")
8983 (if (not (org-at-table-p))
8984 (error "Not at a table"))
8985 (let ((line (org-table-clean-line
8986 (buffer-substring (point-at-bol) (point-at-eol))))
8987 (col (current-column)))
8989 (setq line (replace-match
8990 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
8991 ?-) "|") t t line)))
8993 (beginning-of-line (if above 1 2))
8995 (beginning-of-line (if above 1 -1))
8996 (move-to-column col)
8997 (and org-table-overlay-coordinates (org-table-align))))
8999 (defun org-table-hline-and-move (&optional same-column)
9000 "Insert a hline and move to the row below that line."
9001 (interactive "P")
9002 (let ((col (org-table-current-column)))
9003 (org-table-maybe-eval-formula)
9004 (org-table-maybe-recalculate-line)
9005 (org-table-insert-hline)
9006 (end-of-line 2)
9009 (org-table-next-field))
9010 (if same-column (org-table-goto-column col))))
9012 (defun org-table-clean-line (s)
9014 In particular, this does handle wide and invisible characters."
9016 ;; It's a hline, just map the characters
9017 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9019 (setq s (replace-match
9020 (concat "|" (make-string (org-string-width (match-string 1 s))
9021 ?\ ) "|")
9022 t t s)))
9023 s))
9025 (defun org-table-kill-row ()
9026 "Delete the current row or horizontal line from the table."
9027 (interactive)
9028 (if (not (org-at-table-p))
9029 (error "Not at a table"))
9030 (let ((col (current-column))
9031 (dline (org-table-current-dline)))
9032 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9033 (if (not (org-at-table-p)) (beginning-of-line 0))
9034 (move-to-column col)
9035 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9036 dline -1 dline)))
9038 (defun org-table-sort-lines (with-case &optional sorting-type)
9039 "Sort table lines according to the column at point.
9041 The position of point indicates the column to be used for
9042 sorting, and the range of lines is the range between the nearest
9043 horizontal separator lines, or the entire table of no such lines
9044 exist. If point is before the first column, you will be prompted
9045 for the sorting column. If there is an active region, the mark
9046 specifies the first line and the sorting column, while point
9047 should be in the last line to be included into the sorting.
9049 The command then prompts for the sorting type which can be
9050 alphabetically, numerically, or by time (as given in a time stamp
9051 in the field). Sorting in reverse order is also possible.
9053 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9055 If SORTING-TYPE is specified when this function is called from a Lisp
9056 program, no prompting will take place. SORTING-TYPE must be a character,
9057 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9058 should be done in reverse order."
9059 (interactive "P")
9060 (let* ((thisline (org-current-line))
9061 (thiscol (org-table-current-column))
9062 beg end bcol ecol tend tbeg column lns pos)
9063 (when (equal thiscol 0)
9064 (if (interactive-p)
9065 (setq thiscol
9066 (string-to-number
9067 (read-string "Use column N for sorting: ")))
9068 (setq thiscol 1))
9069 (org-table-goto-column thiscol))
9070 (org-table-check-inside-data-field)
9071 (if (org-region-active-p)
9072 (progn
9073 (setq beg (region-beginning) end (region-end))
9074 (goto-char beg)
9075 (setq column (org-table-current-column)
9076 beg (point-at-bol))
9077 (goto-char end)
9078 (setq end (point-at-bol 2)))
9079 (setq column (org-table-current-column)
9080 pos (point)
9081 tbeg (org-table-begin)
9082 tend (org-table-end))
9083 (if (re-search-backward org-table-hline-regexp tbeg t)
9084 (setq beg (point-at-bol 2))
9085 (goto-char tbeg)
9086 (setq beg (point-at-bol 1)))
9087 (goto-char pos)
9088 (if (re-search-forward org-table-hline-regexp tend t)
9089 (setq end (point-at-bol 1))
9090 (goto-char tend)
9091 (setq end (point-at-bol))))
9092 (setq beg (move-marker (make-marker) beg)
9093 end (move-marker (make-marker) end))
9094 (untabify beg end)
9095 (goto-char beg)
9096 (org-table-goto-column column)
9097 (skip-chars-backward "^|")
9098 (setq bcol (current-column))
9099 (org-table-goto-column (1+ column))
9100 (skip-chars-backward "^|")
9101 (setq ecol (1- (current-column)))
9102 (org-table-goto-column column)
9103 (setq lns (mapcar (lambda(x) (cons
9104 (org-sort-remove-invisible
9105 (nth (1- column)
9107 x))
9109 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9110 (delete-region beg end)
9111 (move-marker beg nil)
9112 (move-marker end nil)
9114 (goto-line thisline)
9115 (org-table-goto-column thiscol)
9116 (message "%d lines sorted, based on column %d" (length lns) column)))
9118 ;; FIXME: maybe we will not need this? Table sorting is broken....
9119 (defun org-sort-remove-invisible (s)
9120 (remove-text-properties 0 (length s) org-rm-props s)
9121 (while (string-match org-bracket-link-regexp s)
9122 (setq s (replace-match (if (match-end 2)
9123 (match-string 3 s)
9124 (match-string 1 s)) t t s)))
9125 s)
9127 (defun org-table-cut-region (beg end)
9128 "Copy region in table to the clipboard and blank all relevant fields."
9129 (interactive "r")
9130 (org-table-copy-region beg end 'cut))
9132 (defun org-table-copy-region (beg end &optional cut)
9133 "Copy rectangular region in table to clipboard.
9134 A special clipboard is used which can only be accessed
9135 with `org-table-paste-rectangle'."
9136 (interactive "rP")
9137 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9138 region cols
9139 (rpl (if cut " " nil)))
9140 (goto-char beg)
9141 (org-table-check-inside-data-field)
9142 (setq l01 (org-current-line)
9143 c01 (org-table-current-column))
9144 (goto-char end)
9145 (org-table-check-inside-data-field)
9146 (setq l02 (org-current-line)
9147 c02 (org-table-current-column))
9148 (setq l1 (min l01 l02) l2 (max l01 l02)
9149 c1 (min c01 c02) c2 (max c01 c02))
9150 (catch 'exit
9151 (while t
9152 (catch 'nextline
9153 (if (> l1 l2) (throw 'exit t))
9154 (goto-line l1)
9155 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9156 (setq cols nil ic1 c1 ic2 c2)
9157 (while (< ic1 (1+ ic2))
9158 (push (org-table-get-field ic1 rpl) cols)
9159 (setq ic1 (1+ ic1)))
9160 (push (nreverse cols) region)
9161 (setq l1 (1+ l1)))))
9162 (setq org-table-clip (nreverse region))
9163 (if cut (org-table-align))
9164 org-table-clip))
9166 (defun org-table-paste-rectangle ()
9167 "Paste a rectangular region into a table.
9168 The upper right corner ends up in the current field. All involved fields
9169 will be overwritten. If the rectangle does not fit into the present table,
9170 the table is enlarged as needed. The process ignores horizontal separator
9171 lines."
9172 (interactive)
9173 (unless (and org-table-clip (listp org-table-clip))
9174 (error "First cut/copy a region to paste!"))
9175 (org-table-check-inside-data-field)
9176 (let* ((clip org-table-clip)
9177 (line (org-current-line))
9178 (col (org-table-current-column))
9179 (org-enable-table-editor t)
9180 (org-table-automatic-realign nil)
9181 c cols field)
9182 (while (setq cols (pop clip))
9183 (while (org-at-table-hline-p) (beginning-of-line 2))
9184 (if (not (org-at-table-p))
9185 (progn (end-of-line 0) (org-table-next-field)))
9186 (setq c col)
9187 (while (setq field (pop cols))
9188 (org-table-goto-column c nil 'force)
9189 (org-table-get-field nil field)
9190 (setq c (1+ c)))
9191 (beginning-of-line 2))
9192 (goto-line line)
9193 (org-table-goto-column col)
9194 (org-table-align)))
9196 (defun org-table-convert ()
9197 "Convert from `org-mode' table to table.el and back.
9198 Obviously, this only works within limits. When an Org-mode table is
9199 converted to table.el, all horizontal separator lines get lost, because
9200 table.el uses these as cell boundaries and has no notion of horizontal lines.
9201 A table.el table can be converted to an Org-mode table only if it does not
9202 do row or column spanning. Multiline cells will become multiple cells.
9203 Beware, Org-mode does not test if the table can be successfully converted - it
9204 blindly applies a recipe that works for simple tables."
9205 (interactive)
9206 (require 'table)
9207 (if (org-at-table.el-p)
9208 ;; convert to Org-mode table
9209 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9210 (end (move-marker (make-marker) (org-table-end t))))
9211 (table-unrecognize-region beg end)
9212 (goto-char beg)
9214 (replace-match ""))
9215 (goto-char beg))
9216 (if (org-at-table-p)
9217 ;; convert to table.el table
9218 (let ((beg (move-marker (make-marker) (org-table-begin)))
9219 (end (move-marker (make-marker) (org-table-end))))
9220 ;; first, get rid of all horizontal lines
9221 (goto-char beg)
9223 (replace-match ""))
9224 ;; insert a hline before first
9225 (goto-char beg)
9226 (org-table-insert-hline 'above)
9227 (beginning-of-line -1)
9228 ;; insert a hline after each line
9229 (while (progn (beginning-of-line 3) (< (point) end))
9230 (org-table-insert-hline))
9231 (goto-char beg)
9232 (setq end (move-marker end (org-table-end)))
9233 ;; replace "+" at beginning and ending of hlines
9236 (goto-char beg)
9238 (replace-match "-+"))
9239 (goto-char beg)))))
9241 (defun org-table-wrap-region (arg)
9242 "Wrap several fields in a column like a paragraph.
9243 This is useful if you'd like to spread the contents of a field over several
9244 lines, in order to keep the table compact.
9246 If there is an active region, and both point and mark are in the same column,
9247 the text in the column is wrapped to minimum width for the given number of
9248 lines. Generally, this makes the table more compact. A prefix ARG may be
9250 formats the selected text to two lines. If the region was longer than two
9251 lines, the remaining lines remain empty. A negative prefix argument reduces
9252 the current number of lines by that amount. The wrapped text is pasted back
9253 into the table. If you formatted it to more lines than it was before, fields
9254 further down in the table get overwritten - so you might need to make space in
9255 the table first.
9257 If there is no region, the current field is split at the cursor position and
9258 the text fragment to the right of the cursor is prepended to the field one
9259 line down.
9261 If there is no region, but you specify a prefix ARG, the current field gets
9262 blank, and the content is appended to the field above."
9263 (interactive "P")
9264 (org-table-check-inside-data-field)
9265 (if (org-region-active-p)
9266 ;; There is a region: fill as a paragraph
9267 (let* ((beg (region-beginning))
9268 (cline (save-excursion (goto-char beg) (org-current-line)))
9269 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9270 nlines)
9271 (org-table-cut-region (region-beginning) (region-end))
9272 (if (> (length (car org-table-clip)) 1)
9273 (error "Region must be limited to single column"))
9274 (setq nlines (if arg
9275 (if (< arg 1)
9276 (+ (length org-table-clip) arg)
9277 arg)
9278 (length org-table-clip)))
9279 (setq org-table-clip
9280 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9281 nil nlines)))
9282 (goto-line cline)
9283 (org-table-goto-column ccol)
9284 (org-table-paste-rectangle))
9285 ;; No region, split the current field at point
9286 (if arg
9287 ;; combine with field above
9288 (let ((s (org-table-blank-field))
9289 (col (org-table-current-column)))
9290 (beginning-of-line 0)
9291 (while (org-at-table-hline-p) (beginning-of-line 0))
9292 (org-table-goto-column col)
9293 (skip-chars-forward "^|")
9294 (skip-chars-backward " ")
9295 (insert " " (org-trim s))
9296 (org-table-align))
9297 ;; split field
9299 (let ((s (match-string 1)))
9300 (replace-match " |")
9301 (goto-char (match-beginning 0))
9302 (org-table-next-row)
9303 (insert (org-trim s) " ")
9304 (org-table-align))))))
9306 (defvar org-field-marker nil)
9308 (defun org-table-edit-field (arg)
9309 "Edit table field in a different window.
9310 This is mainly useful for fields that contain hidden parts.
9312 it can be edited in place."
9313 (interactive "P")
9314 (if arg
9315 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9317 (remove-text-properties b e '(org-cwidth t invisible t
9318 display t intangible t))
9319 (if (and (boundp 'font-lock-mode) font-lock-mode)
9320 (font-lock-fontify-block)))
9321 (let ((pos (move-marker (make-marker) (point)))
9322 (field (org-table-get-field))
9323 (cw (current-window-configuration))
9324 p)
9325 (org-switch-to-buffer-other-window "*Org tmp*")
9326 (erase-buffer)
9328 (let ((org-inhibit-startup t)) (org-mode))
9329 (goto-char (setq p (point-max)))
9330 (insert (org-trim field))
9331 (remove-text-properties p (point-max)
9332 '(invisible t org-cwidth t display t
9333 intangible t))
9334 (goto-char p)
9335 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9336 (org-set-local 'org-window-configuration cw)
9337 (org-set-local 'org-field-marker pos)
9338 (message "Edit and finish with C-c C-c"))))
9340 (defun org-table-finish-edit-field ()
9341 "Finish editing a table data field.
9342 Remove all newline characters, insert the result into the table, realign
9343 the table and kill the editing buffer."
9344 (let ((pos org-field-marker)
9345 (cw org-window-configuration)
9346 (cb (current-buffer))
9347 text)
9348 (goto-char (point-min))
9351 (replace-match " "))
9352 (setq text (org-trim (buffer-string)))
9353 (set-window-configuration cw)
9354 (kill-buffer cb)
9355 (select-window (get-buffer-window (marker-buffer pos)))
9356 (goto-char pos)
9357 (move-marker pos nil)
9358 (org-table-check-inside-data-field)
9359 (org-table-get-field nil text)
9360 (org-table-align)
9361 (message "New field value inserted")))
9363 (defun org-trim (s)
9364 "Remove whitespace at beginning and end of string."
9367 s)
9369 (defun org-wrap (string &optional width lines)
9370 "Wrap string to either a number of lines, or a width in characters.
9371 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9372 that costs. If there is a word longer than WIDTH, the text is actually
9373 wrapped to the length of that word.
9374 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9375 many lines, whatever width that takes.
9376 The return value is a list of lines, without newlines at the end."
9378 (maxword (apply 'max (mapcar 'org-string-width words)))
9379 w ll)
9380 (cond (width
9381 (org-do-wrap words (max maxword width)))
9382 (lines
9383 (setq w maxword)
9384 (setq ll (org-do-wrap words maxword))
9385 (if (<= (length ll) lines)
9386 ll
9387 (setq ll words)
9388 (while (> (length ll) lines)
9389 (setq w (1+ w))
9390 (setq ll (org-do-wrap words w)))
9391 ll))
9392 (t (error "Cannot wrap this")))))
9395 (defun org-do-wrap (words width)
9396 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9397 (let (lines line)
9398 (while words
9399 (setq line (pop words))
9400 (while (and words (< (+ (length line) (length (car words))) width))
9401 (setq line (concat line " " (pop words))))
9402 (setq lines (push line lines)))
9403 (nreverse lines)))
9405 (defun org-split-string (string &optional separators)
9406 "Splits STRING into substrings at SEPARATORS.
9407 No empty strings are returned if there are matches at the beginning
9408 and end of string."
9410 (start 0)
9411 notfirst
9412 (list nil))
9413 (while (and (string-match rexp string
9414 (if (and notfirst
9415 (= start (match-beginning 0))
9416 (< start (length string)))
9417 (1+ start) start))
9418 (< (match-beginning 0) (length string)))
9419 (setq notfirst t)
9420 (or (eq (match-beginning 0) 0)
9421 (and (eq (match-beginning 0) (match-end 0))
9422 (eq (match-beginning 0) start))
9423 (setq list
9424 (cons (substring string start (match-beginning 0))
9425 list)))
9426 (setq start (match-end 0)))
9427 (or (eq start (length string))
9428 (setq list
9429 (cons (substring string start)
9430 list)))
9431 (nreverse list)))
9433 (defun org-table-map-tables (function)
9434 "Apply FUNCTION to the start of all tables in the buffer."
9435 (save-excursion
9436 (save-restriction
9437 (widen)
9438 (goto-char (point-min))
9439 (while (re-search-forward org-table-any-line-regexp nil t)
9440 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9441 (beginning-of-line 1)
9442 (if (looking-at org-table-line-regexp)
9443 (save-excursion (funcall function)))
9444 (re-search-forward org-table-any-border-regexp nil 1))))
9445 (message "Mapping tables: done"))
9447 (defvar org-timecnt) ; dynamically scoped parameter
9449 (defun org-table-sum (&optional beg end nlast)
9450 "Sum numbers in region of current table column.
9451 The result will be displayed in the echo area, and will be available
9454 If there is an active region, it is interpreted as a rectangle and all
9455 numbers in that rectangle will be summed. If there is no active
9456 region and point is located in a table column, sum all numbers in that
9457 column.
9459 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9460 numbers are assumed to be times as well (in decimal hours) and the
9461 numbers are added as such.
9463 If NLAST is a number, only the NLAST fields will actually be summed."
9464 (interactive)
9465 (save-excursion
9466 (let (col (org-timecnt 0) diff h m s org-table-clip)
9467 (cond
9468 ((and beg end)) ; beg and end given explicitly
9469 ((org-region-active-p)
9470 (setq beg (region-beginning) end (region-end)))
9471 (t
9472 (setq col (org-table-current-column))
9473 (goto-char (org-table-begin))
9475 (error "No table data"))
9476 (org-table-goto-column col)
9477 (setq beg (point))
9478 (goto-char (org-table-end))
9480 (error "No table data"))
9481 (org-table-goto-column col)
9482 (setq end (point))))
9483 (let* ((items (apply 'append (org-table-copy-region beg end)))
9484 (items1 (cond ((not nlast) items)
9485 ((>= nlast (length items)) items)
9486 (t (setq items (reverse items))
9487 (setcdr (nthcdr (1- nlast) items) nil)
9488 (nreverse items))))
9489 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9490 items1)))
9491 (res (apply '+ numbers))
9492 (sres (if (= org-timecnt 0)
9493 (format "%g" res)
9494 (setq diff (* 3600 res)
9495 h (floor (/ diff 3600)) diff (mod diff 3600)
9496 m (floor (/ diff 60)) diff (mod diff 60)
9497 s diff)
9498 (format "%d:%02d:%02d" h m s))))
9499 (kill-new sres)
9500 (if (interactive-p)
9501 (message "%s"
9502 (substitute-command-keys
9504 (length numbers) sres))))
9505 sres))))
9507 (defun org-table-get-number-for-summing (s)
9508 (let (n)
9509 (if (string-match "^ *|? *" s)
9510 (setq s (replace-match "" nil nil s)))
9511 (if (string-match " *|? *$" s)
9512 (setq s (replace-match "" nil nil s)))
9513 (setq n (string-to-number s))
9514 (cond
9515 ((and (string-match "0" s)
9519 (let ((h (string-to-number (or (match-string 1 s) "0")))
9520 (m (string-to-number (or (match-string 2 s) "0")))
9521 (s (string-to-number (or (match-string 4 s) "0"))))
9522 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9523 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9524 ((equal n 0) nil)
9525 (t n))))
9527 (defun org-table-current-field-formula (&optional key noerror)
9528 "Return the formula active for the current field.
9529 Assumes that specials are in place.
9530 If KEY is given, return the key to this formula.
9532 (let* ((name (car (rassoc (list (org-current-line)
9533 (org-table-current-column))
9534 org-table-named-field-locations)))
9535 (col (org-table-current-column))
9536 (scol (int-to-string col))
9537 (ref (format "@%d$%d" (org-table-current-dline) col))
9538 (stored-list (org-table-get-stored-formulas noerror))
9539 (ass (or (assoc name stored-list)
9540 (assoc ref stored-list)
9541 (assoc scol stored-list))))
9542 (if key
9543 (car ass)
9544 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9545 (cdr ass))))))
9547 (defun org-table-get-formula (&optional equation named)
9548 "Read a formula from the minibuffer, offer stored formula as default.
9549 When NAMED is non-nil, look for a named equation."
9550 (let* ((stored-list (org-table-get-stored-formulas))
9551 (name (car (rassoc (list (org-current-line)
9552 (org-table-current-column))
9553 org-table-named-field-locations)))
9554 (ref (format "@%d$%d" (org-table-current-dline)
9555 (org-table-current-column)))
9556 (refass (assoc ref stored-list))
9557 (scol (if named
9558 (if name name ref)
9559 (int-to-string (org-table-current-column))))
9560 (dummy (and (or name refass) (not named)
9561 (not (y-or-n-p "Replace field formula with column formula? " ))
9562 (error "Abort")))
9563 (name (or name ref))
9564 (org-table-may-need-update nil)
9565 (stored (cdr (assoc scol stored-list)))
9566 (eq (cond
9567 ((and stored equation (string-match "^ *=? *$" equation))
9568 stored)
9569 ((stringp equation)
9570 equation)
9571 (t (org-table-formula-from-user
9572 (read-string
9573 (org-table-formula-to-user
9574 (format "%s formula %s%s="
9575 (if named "Field" "Column")
9576 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9577 scol))
9578 (if stored (org-table-formula-to-user stored) "")
9579 'org-table-formula-history
9580 )))))
9581 mustsave)
9583 ;; remove formula
9584 (setq stored-list (delq (assoc scol stored-list) stored-list))
9585 (org-table-store-formulas stored-list)
9586 (error "Formula removed"))
9587 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9588 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9589 (if (and name (not named))
9590 ;; We set the column equation, delete the named one.
9591 (setq stored-list (delq (assoc name stored-list) stored-list)
9592 mustsave t))
9593 (if stored
9594 (setcdr (assoc scol stored-list) eq)
9595 (setq stored-list (cons (cons scol eq) stored-list)))
9596 (if (or mustsave (not (equal stored eq)))
9597 (org-table-store-formulas stored-list))
9598 eq))
9600 (defun org-table-store-formulas (alist)
9601 "Store the list of formulas below the current table."
9602 (setq alist (sort alist 'org-table-formula-less-p))
9603 (save-excursion
9604 (goto-char (org-table-end))
9606 (progn
9607 ;; don't overwrite TBLFM, we might use text properties to store stuff
9608 (goto-char (match-beginning 2))
9609 (delete-region (match-beginning 2) (match-end 0)))
9610 (insert "#+TBLFM:"))
9611 (insert " "
9612 (mapconcat (lambda (x)
9613 (concat
9614 (if (equal (string-to-char (car x)) ?@) "" "$")
9615 (car x) "=" (cdr x)))
9616 alist "::")
9619 (defsubst org-table-formula-make-cmp-string (a)
9621 (concat
9622 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9623 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9624 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9626 (defun org-table-formula-less-p (a b)
9627 "Compare two formulas for sorting."
9628 (let ((as (org-table-formula-make-cmp-string (car a)))
9629 (bs (org-table-formula-make-cmp-string (car b))))
9630 (and as bs (string< as bs))))
9632 (defun org-table-get-stored-formulas (&optional noerror)
9633 "Return an alist with the stored formulas directly after current table."
9634 (interactive)
9635 (let (scol eq eq-alist strings string seen)
9636 (save-excursion
9637 (goto-char (org-table-end))
9639 (setq strings (org-split-string (match-string 2) " *:: *"))
9640 (while (setq string (pop strings))
9641 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9642 (setq scol (if (match-end 2)
9643 (match-string 2 string)
9644 (match-string 1 string))
9645 eq (match-string 3 string)
9646 eq-alist (cons (cons scol eq) eq-alist))
9647 (if (member scol seen)
9648 (if noerror
9649 (progn
9650 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9651 (ding)
9652 (sit-for 2))
9653 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9654 (push scol seen))))))
9655 (nreverse eq-alist)))
9657 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9658 "Modify the equations after the table structure has been edited.
9660 For all numbers larger than LIMIT, shift them by DELTA."
9661 (save-excursion
9662 (goto-char (org-table-end))
9665 (re2
9666 (when remove
9667 (if (equal key "$")
9670 s n a)
9671 (when remove
9672 (while (re-search-forward re2 (point-at-eol) t)
9673 (replace-match "")))
9674 (while (re-search-forward re (point-at-eol) t)
9675 (setq s (match-string 1) n (string-to-number s))
9676 (cond
9677 ((setq a (assoc s replace))
9678 (replace-match (concat key (cdr a)) t t))
9679 ((and limit (> n limit))
9680 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9682 (defun org-table-get-specials ()
9683 "Get the column names and local parameters for this table."
9684 (save-excursion
9685 (let ((beg (org-table-begin)) (end (org-table-end))
9686 names name fields fields1 field cnt
9687 c v l line col types dlines hlines)
9688 (setq org-table-column-names nil
9689 org-table-local-parameters nil
9690 org-table-named-field-locations nil
9691 org-table-current-begin-line nil
9692 org-table-current-begin-pos nil
9693 org-table-current-line-types nil)
9694 (goto-char beg)
9696 (setq names (org-split-string (match-string 1) " *| *")
9697 cnt 1)
9698 (while (setq name (pop names))
9699 (setq cnt (1+ cnt))
9700 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9701 (push (cons name (int-to-string cnt)) org-table-column-names))))
9702 (setq org-table-column-names (nreverse org-table-column-names))
9703 (setq org-table-column-name-regexp
9705 (goto-char beg)
9707 (setq fields (org-split-string (match-string 1) " *| *"))
9708 (while (setq field (pop fields))
9710 (push (cons (match-string 1 field) (match-string 2 field))
9711 org-table-local-parameters))))
9712 (goto-char beg)
9714 (setq c (match-string 1)
9715 fields (org-split-string (match-string 2) " *| *"))
9716 (save-excursion
9717 (beginning-of-line (if (equal c "_") 2 0))
9718 (setq line (org-current-line) col 1)
9720 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9721 (while (and fields1 (setq field (pop fields)))
9722 (setq v (pop fields1) col (1+ col))
9723 (when (and (stringp field) (stringp v)
9724 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9725 (push (cons field v) org-table-local-parameters)
9726 (push (list field line col) org-table-named-field-locations))))
9727 ;; Analyse the line types
9728 (goto-char beg)
9729 (setq org-table-current-begin-line (org-current-line)
9730 org-table-current-begin-pos (point)
9731 l org-table-current-begin-line)
9733 (push (if (match-end 1) 'hline 'dline) types)
9734 (if (match-end 1) (push l hlines) (push l dlines))
9735 (beginning-of-line 2)
9736 (setq l (1+ l)))
9737 (setq org-table-current-line-types (apply 'vector (nreverse types))
9738 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9739 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9741 (defun org-table-maybe-eval-formula ()
9743 If yes, store the formula and apply it."
9744 ;; We already know we are in a table. Get field will only return a formula
9745 ;; when appropriate. It might return a separator line, but no problem.
9746 (when org-table-formula-evaluate-inline
9747 (let* ((field (org-trim (or (org-table-get-field) "")))
9748 named eq)
9750 (setq named (equal (string-to-char field) ?:)
9751 eq (match-string 1 field))
9752 (if (or (fboundp 'calc-eval)
9753 (equal (substring eq 0 (min 2 (length eq))) "'("))
9754 (org-table-eval-formula (if named '(4) nil)
9755 (org-table-formula-from-user eq))
9756 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9758 (defvar org-recalc-commands nil
9759 "List of commands triggering the recalculation of a line.
9760 Will be filled automatically during use.")
9762 (defvar org-recalc-marks
9763 '((" " . "Unmarked: no special line, no automatic recalculation")
9764 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9765 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9766 ("!" . "Column name definition line. Reference in formula as $name.")
9767 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9768 ("_" . "Names for values in row below this one.")
9769 ("^" . "Names for values in row above this one.")))
9771 (defun org-table-rotate-recalc-marks (&optional newchar)
9772 "Rotate the recalculation mark in the first column.
9773 If in any row, the first field is not consistent with a mark,
9774 insert a new column for the markers.
9775 When there is an active region, change all the lines in the region,
9776 after prompting for the marking character.
9777 After each change, a message will be displayed indicating the meaning
9778 of the new mark."
9779 (interactive)
9780 (unless (org-at-table-p) (error "Not at a table"))
9781 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9782 (beg (org-table-begin))
9783 (end (org-table-end))
9784 (l (org-current-line))
9785 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9786 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9787 (have-col
9788 (save-excursion
9789 (goto-char beg)
9791 (col (org-table-current-column))
9792 (forcenew (car (assoc newchar org-recalc-marks)))
9793 epos new)
9794 (when l1
9795 (message "Change region to what mark? Type # * ! $ or SPC: ")
9796 (setq newchar (char-to-string (read-char-exclusive))
9797 forcenew (car (assoc newchar org-recalc-marks))))
9798 (if (and newchar (not forcenew))
9799 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9800 newchar))
9801 (if l1 (goto-line l1))
9802 (save-excursion
9803 (beginning-of-line 1)
9804 (unless (looking-at org-table-dataline-regexp)
9805 (error "Not at a table data line")))
9806 (unless have-col
9807 (org-table-goto-column 1)
9808 (org-table-insert-column)
9809 (org-table-goto-column (1+ col)))
9810 (setq epos (point-at-eol))
9811 (save-excursion
9812 (beginning-of-line 1)
9813 (org-table-get-field
9815 (concat " "
9816 (setq new (or forcenew
9817 (cadr (member (match-string 1) marks))))
9818 " ")
9819 " # ")))
9820 (if (and l1 l2)
9821 (progn
9822 (goto-line l1)
9823 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9824 (and (looking-at org-table-dataline-regexp)
9825 (org-table-get-field 1 (concat " " new " "))))
9826 (goto-line l1)))
9827 (if (not (= epos (point-at-eol))) (org-table-align))
9828 (goto-line l)
9829 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
9831 (defun org-table-maybe-recalculate-line ()
9832 "Recompute the current line if marked for it, and if we haven't just done it."
9833 (interactive)
9834 (and org-table-allow-automatic-line-recalculation
9835 (not (and (memq last-command org-recalc-commands)
9836 (equal org-last-recalc-line (org-current-line))))
9837 (save-excursion (beginning-of-line 1)
9838 (looking-at org-table-auto-recalculate-regexp))
9839 (org-table-recalculate) t))
9841 (defvar org-table-formula-debug nil
9842 "Non-nil means, debug table formulas.
9844 (make-variable-buffer-local 'org-table-formula-debug)
9846 (defvar modes)
9847 (defsubst org-set-calc-mode (var &optional value)
9848 (if (stringp var)
9849 (setq var (assoc var '(("D" calc-angle-mode deg)
9850 ("R" calc-angle-mode rad)
9851 ("F" calc-prefer-frac t)
9852 ("S" calc-symbolic-mode t)))
9853 value (nth 2 var) var (nth 1 var)))
9854 (if (memq var modes)
9855 (setcar (cdr (memq var modes)) value)
9856 (cons var (cons value modes)))
9857 modes)
9859 (defun org-table-eval-formula (&optional arg equation
9860 suppress-align suppress-const
9861 suppress-store suppress-analysis)
9862 "Replace the table field value at the cursor by the result of a calculation.
9864 This function makes use of Dave Gillespie's Calc package, in my view the
9865 most exciting program ever written for GNU Emacs. So you need to have Calc
9866 installed in order to use this function.
9868 In a table, this command replaces the value in the current field with the
9870 formula, by storing it in a special line below the table. When called
9871 with a `C-u' prefix, the current field must ba a named field, and the
9872 formula is installed as valid in only this specific field.
9874 When called with two `C-u' prefixes, insert the active equation
9875 for the field back into the current field, so that it can be
9877 to check the referenced fields.
9879 When called, the command first prompts for a formula, which is read in
9880 the minibuffer. Previously entered formulas are available through the
9881 history list, and the last used formula is offered as a default.
9882 These stored formulas are adapted correctly when moving, inserting, or
9883 deleting columns with the corresponding commands.
9885 The formula can be any algebraic expression understood by the Calc package.
9886 For details, see the Org-mode manual.
9888 This function can also be called from Lisp programs and offers
9889 additional arguments: EQUATION can be the formula to apply. If this
9890 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
9891 used to speed-up recursive calls by by-passing unnecessary aligns.
9892 SUPPRESS-CONST suppresses the interpretation of constants in the
9893 formula, assuming that this has been done already outside the function.
9894 SUPPRESS-STORE means the formula should not be stored, either because
9895 it is already stored, or because it is a modified equation that should
9896 not overwrite the stored one."
9897 (interactive "P")
9898 (org-table-check-inside-data-field)
9899 (or suppress-analysis (org-table-get-specials))
9900 (if (equal arg '(16))
9901 (let ((eq (org-table-current-field-formula)))
9902 (or eq (error "No equation active for current field"))
9903 (org-table-get-field nil eq)
9904 (org-table-align)
9905 (setq org-table-may-need-update t))
9906 (let* (fields
9907 (ndown (if (integerp arg) arg 1))
9908 (org-table-automatic-realign nil)
9909 (case-fold-search nil)
9910 (down (> ndown 1))
9911 (formula (if (and equation suppress-store)
9912 equation
9913 (org-table-get-formula equation (equal arg '(4)))))
9914 (n0 (org-table-current-column))
9915 (modes (copy-sequence org-calc-default-modes))
9916 (numbers nil) ; was a variable, now fixed default
9917 (keep-empty nil)
9918 n form form0 bw fmt x ev orig c lispp literal)
9919 ;; Parse the format string. Since we have a lot of modes, this is
9920 ;; a lot of work. However, I think calc still uses most of the time.
9921 (if (string-match ";" formula)
9922 (let ((tmp (org-split-string formula ";")))
9923 (setq formula (car tmp)
9924 fmt (concat (cdr (assoc "%" org-table-local-parameters))
9925 (nth 1 tmp)))
9927 (setq c (string-to-char (match-string 1 fmt))
9928 n (string-to-number (match-string 2 fmt)))
9929 (if (= c ?p)
9930 (setq modes (org-set-calc-mode 'calc-internal-prec n))
9931 (setq modes (org-set-calc-mode
9932 'calc-float-format
9933 (list (cdr (assoc c '((?n . float) (?f . fix)
9934 (?s . sci) (?e . eng))))
9935 n))))
9936 (setq fmt (replace-match "" t t fmt)))
9937 (if (string-match "[NT]" fmt)
9938 (setq numbers (equal (match-string 0 fmt) "N")
9939 fmt (replace-match "" t t fmt)))
9940 (if (string-match "L" fmt)
9941 (setq literal t
9942 fmt (replace-match "" t t fmt)))
9943 (if (string-match "E" fmt)
9944 (setq keep-empty t
9945 fmt (replace-match "" t t fmt)))
9946 (while (string-match "[DRFS]" fmt)
9947 (setq modes (org-set-calc-mode (match-string 0 fmt)))
9948 (setq fmt (replace-match "" t t fmt)))
9950 (setq fmt nil))))
9951 (if (and (not suppress-const) org-table-formula-use-constants)
9952 (setq formula (org-table-formula-substitute-names formula)))
9953 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
9954 (while (> ndown 0)
9955 (setq fields (org-split-string
9956 (org-no-properties
9957 (buffer-substring (point-at-bol) (point-at-eol)))
9958 " *| *"))
9959 (if (eq numbers t)
9960 (setq fields (mapcar
9961 (lambda (x) (number-to-string (string-to-number x)))
9962 fields)))
9963 (setq ndown (1- ndown))
9964 (setq form (copy-sequence formula)
9965 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
9966 (if (and lispp literal) (setq lispp 'literal))
9967 ;; Check for old vertical references
9968 (setq form (org-rewrite-old-row-references form))
9969 ;; Insert complex ranges
9970 (while (string-match org-table-range-regexp form)
9971 (setq form
9972 (replace-match
9973 (save-match-data
9974 (org-table-make-reference
9975 (org-table-get-range (match-string 0 form) nil n0)
9976 keep-empty numbers lispp))
9977 t t form)))
9978 ;; Insert simple ranges
9980 (setq form
9981 (replace-match
9982 (save-match-data
9983 (org-table-make-reference
9984 (org-sublist
9985 fields (string-to-number (match-string 1 form))
9986 (string-to-number (match-string 2 form)))
9987 keep-empty numbers lispp))
9988 t t form)))
9989 (setq form0 form)
9990 ;; Insert the references to fields in same row
9992 (setq n (string-to-number (match-string 1 form))
9993 x (nth (1- (if (= n 0) n0 n)) fields))
9995 (match-string 0 form)))
9996 (setq form (replace-match
9997 (save-match-data
9998 (org-table-make-reference x nil numbers lispp))
9999 t t form)))
10001 (if lispp
10002 (setq ev (condition-case nil
10003 (eval (eval (read form)))
10004 (error "#ERROR"))
10005 ev (if (numberp ev) (number-to-string ev) ev))
10006 (or (fboundp 'calc-eval)
10007 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10008 (setq ev (calc-eval (cons form modes)
10009 (if numbers 'num))))
10011 (when org-table-formula-debug
10012 (with-output-to-temp-buffer "*Substitution History*"
10013 (princ (format "Substitution history of formula
10014 Orig: %s
10015 $xyz-> %s
10016 @r$c-> %s
10018 (if (listp ev)
10020 (make-string (car ev) ?\-) (nth 1 ev)))
10022 ev (or fmt "NONE")
10023 (if fmt (format fmt (string-to-number ev)) ev)))))
10024 (setq bw (get-buffer-window "*Substitution History*"))
10025 (shrink-window-if-larger-than-buffer bw)
10026 (unless (and (interactive-p) (not ndown))
10027 (unless (let (inhibit-redisplay)
10028 (y-or-n-p "Debugging Formula. Continue to next? "))
10029 (org-table-align)
10030 (error "Abort"))
10031 (delete-window bw)
10032 (message "")))
10033 (if (listp ev) (setq fmt nil ev "#ERROR"))
10034 (org-table-justify-field-maybe
10035 (if fmt (format fmt (string-to-number ev)) ev))
10037 (call-interactively 'org-return)
10038 (setq ndown 0)))
10039 (and down (org-table-maybe-recalculate-line))
10040 (or suppress-align (and org-table-may-need-update
10041 (org-table-align))))))
10043 (defun org-table-put-field-property (prop value)
10044 (save-excursion
10045 (put-text-property (progn (skip-chars-backward "^|") (point))
10046 (progn (skip-chars-forward "^|") (point))
10047 prop value)))
10049 (defun org-table-get-range (desc &optional tbeg col highlight)
10050 "Get a calc vector from a column, accorting to descriptor DESC.
10051 Optional arguments TBEG and COL can give the beginning of the table and
10052 the current column, to avoid unnecessary parsing.
10053 HIGHLIGHT means, just highlight the range."
10054 (if (not (equal (string-to-char desc) ?@))
10055 (setq desc (concat "@" desc)))
10056 (save-excursion
10057 (or tbeg (setq tbeg (org-table-begin)))
10058 (or col (setq col (org-table-current-column)))
10059 (let ((thisline (org-current-line))
10060 beg end c1 c2 r1 r2 rangep tmp)
10061 (unless (string-match org-table-range-regexp desc)
10062 (error "Invalid table range specifier `%s'" desc))
10063 (setq rangep (match-end 3)
10064 r1 (and (match-end 1) (match-string 1 desc))
10065 r2 (and (match-end 4) (match-string 4 desc))
10066 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10067 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10069 (and c1 (setq c1 (+ (string-to-number c1)
10070 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10071 (and c2 (setq c2 (+ (string-to-number c2)
10072 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10073 (if (equal r1 "") (setq r1 nil))
10074 (if (equal r2 "") (setq r2 nil))
10075 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10076 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10077 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10078 (if (not r1) (setq r1 thisline))
10079 (if (not r2) (setq r2 thisline))
10080 (if (not c1) (setq c1 col))
10081 (if (not c2) (setq c2 col))
10082 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10083 ;; just one field
10084 (progn
10085 (goto-line r1)
10086 (while (not (looking-at org-table-dataline-regexp))
10087 (beginning-of-line 2))
10088 (prog1 (org-trim (org-table-get-field c1))
10089 (if highlight (org-table-highlight-rectangle (point) (point)))))
10090 ;; A range, return a vector
10091 ;; First sort the numbers to get a regular ractangle
10092 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10093 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10094 (goto-line r1)
10095 (while (not (looking-at org-table-dataline-regexp))
10096 (beginning-of-line 2))
10097 (org-table-goto-column c1)
10098 (setq beg (point))
10099 (goto-line r2)
10100 (while (not (looking-at org-table-dataline-regexp))
10101 (beginning-of-line 0))
10102 (org-table-goto-column c2)
10103 (setq end (point))
10104 (if highlight
10105 (org-table-highlight-rectangle
10107 ;; return string representation of calc vector
10108 (mapcar 'org-trim
10109 (apply 'append (org-table-copy-region beg end)))))))
10111 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10112 "Analyze descriptor DESC and retrieve the corresponding line number.
10113 The cursor is currently in line CLINE, the table begins in line BLINE,
10114 and TABLE is a vector with line types."
10115 (if (string-match "^[0-9]+$" desc)
10116 (aref org-table-dlines (string-to-number desc))
10117 (setq cline (or cline (org-current-line))
10118 bline (or bline org-table-current-begin-line)
10119 table (or table org-table-current-line-types))
10120 (if (or
10122 ;; 1 2 3 4 5 6
10123 (and (not (match-end 3)) (not (match-end 6)))
10124 (and (match-end 3) (match-end 6) (not (match-end 5))))
10125 (error "invalid row descriptor `%s'" desc))
10126 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10127 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10128 (odir (and (match-end 5) (match-string 5 desc)))
10129 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10130 (i (- cline bline))
10131 (rel (and (match-end 6)
10132 (or (and (match-end 1) (not (match-end 3)))
10133 (match-end 5)))))
10134 (if (and hn (not hdir))
10135 (progn
10136 (setq i 0 hdir "+")
10137 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10138 (if (and (not hn) on (not odir))
10139 (error "should never happen");;(aref org-table-dlines on)
10140 (if (and hn (> hn 0))
10141 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10142 (if on
10143 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10144 (+ bline i)))))
10146 (defun org-find-row-type (table i type backwards relative n)
10147 (let ((l (length table)))
10148 (while (> n 0)
10149 (while (and (setq i (+ i (if backwards -1 1)))
10150 (>= i 0) (< i l)
10151 (not (eq (aref table i) type))
10152 (if (and relative (eq (aref table i) 'hline))
10153 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10154 t)))
10155 (setq n (1- n)))
10156 (if (or (< i 0) (>= i l))
10157 (error "Row descriptior leads outside table")
10158 i)))
10160 (defun org-rewrite-old-row-references (s)
10161 (if (string-match "&[-+0-9I]" s)
10162 (error "Formula contains old &row reference, please rewrite using @-syntax")
10163 s))
10165 (defun org-table-make-reference (elements keep-empty numbers lispp)
10166 "Convert list ELEMENTS to something appropriate to insert into formula.
10167 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10168 NUMBERS indicates that everything should be converted to numbers.
10169 LISPP means to return something appropriate for a Lisp list."
10170 (if (stringp elements) ; just a single val
10171 (if lispp
10172 (if (eq lispp 'literal)
10173 elements
10174 (prin1-to-string (if numbers (string-to-number elements) elements)))
10175 (if (equal elements "") (setq elements "0"))
10176 (if numbers (number-to-string (string-to-number elements)) elements))
10177 (unless keep-empty
10178 (setq elements
10179 (delq nil
10181 elements))))
10182 (setq elements (or elements '("0")))
10183 (if lispp
10184 (mapconcat
10185 (lambda (x)
10186 (if (eq lispp 'literal)
10187 x
10188 (prin1-to-string (if numbers (string-to-number x) x))))
10189 elements " ")
10190 (concat "[" (mapconcat
10191 (lambda (x)
10192 (if numbers (number-to-string (string-to-number x)) x))
10193 elements
10194 ",") "]"))))
10196 (defun org-table-recalculate (&optional all noalign)
10197 "Recalculate the current table line by applying all stored formulas.
10198 With prefix arg ALL, do this for all lines in the table."
10199 (interactive "P")
10200 (or (memq this-command org-recalc-commands)
10201 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10202 (unless (org-at-table-p) (error "Not at a table"))
10203 (if (equal all '(16))
10204 (org-table-iterate)
10205 (org-table-get-specials)
10206 (let* ((eqlist (sort (org-table-get-stored-formulas)
10207 (lambda (a b) (string< (car a) (car b)))))
10208 (inhibit-redisplay (not debug-on-error))
10209 (line-re org-table-dataline-regexp)
10210 (thisline (org-current-line))
10211 (thiscol (org-table-current-column))
10212 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10213 ;; Insert constants in all formulas
10214 (setq eqlist
10215 (mapcar (lambda (x)
10216 (setcdr x (org-table-formula-substitute-names (cdr x)))
10217 x)
10218 eqlist))
10219 ;; Split the equation list
10220 (while (setq eq (pop eqlist))
10221 (if (<= (string-to-char (car eq)) ?9)
10222 (push eq eqlnum)
10223 (push eq eqlname)))
10224 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10225 (if all
10226 (progn
10227 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10228 (goto-char (setq beg (org-table-begin)))
10229 (if (re-search-forward org-table-calculate-mark-regexp end t)
10230 ;; This is a table with marked lines, compute selected lines
10231 (setq line-re org-table-recalculate-regexp)
10232 ;; Move forward to the first non-header line
10233 (if (and (re-search-forward org-table-dataline-regexp end t)
10234 (re-search-forward org-table-hline-regexp end t)
10235 (re-search-forward org-table-dataline-regexp end t))
10236 (setq beg (match-beginning 0))
10237 nil))) ;; just leave beg where it is
10238 (setq beg (point-at-bol)
10239 end (move-marker (make-marker) (1+ (point-at-eol)))))
10240 (goto-char beg)
10241 (and all (message "Re-applying formulas to full table..."))
10243 ;; First find the named fields, and mark them untouchanble
10244 (remove-text-properties beg end '(org-untouchable t))
10245 (while (setq eq (pop eqlname))
10246 (setq name (car eq)
10247 a (assoc name org-table-named-field-locations))
10248 (and (not a)
10250 (setq a (list name
10251 (aref org-table-dlines
10252 (string-to-number (match-string 1 name)))
10253 (string-to-number (match-string 2 name)))))
10254 (when (and a (or all (equal (nth 1 a) thisline)))
10255 (message "Re-applying formula to field: %s" name)
10256 (goto-line (nth 1 a))
10257 (org-table-goto-column (nth 2 a))
10258 (push (append a (list (cdr eq))) eqlname1)
10259 (org-table-put-field-property :org-untouchable t)))
10261 ;; Now evauluate the column formulas, but skip fields covered by
10262 ;; field formulas
10263 (goto-char beg)
10264 (while (re-search-forward line-re end t)
10265 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10266 ;; Unprotected line, recalculate
10267 (and all (message "Re-applying formulas to full table...(line %d)"
10268 (setq cnt (1+ cnt))))
10269 (setq org-last-recalc-line (org-current-line))
10270 (setq eql eqlnum)
10271 (while (setq entry (pop eql))
10272 (goto-line org-last-recalc-line)
10273 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10274 (unless (get-text-property (point) :org-untouchable)
10275 (org-table-eval-formula nil (cdr entry)
10276 'noalign 'nocst 'nostore 'noanalysis)))))
10278 ;; Now evaluate the field formulas
10279 (while (setq eq (pop eqlname1))
10280 (message "Re-applying formula to field: %s" (car eq))
10281 (goto-line (nth 1 eq))
10282 (org-table-goto-column (nth 2 eq))
10283 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10284 'nostore 'noanalysis))
10286 (goto-line thisline)
10287 (org-table-goto-column thiscol)
10288 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10289 (or noalign (and org-table-may-need-update (org-table-align))
10290 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10292 ;; back to initial position
10293 (message "Re-applying formulas...done")
10294 (goto-line thisline)
10295 (org-table-goto-column thiscol)
10296 (or noalign (and org-table-may-need-update (org-table-align))
10297 (and all (message "Re-applying formulas...done"))))))
10299 (defun org-table-iterate (&optional arg)
10300 "Recalculate the table until it does not change anymore."
10301 (interactive "P")
10302 (let ((imax (if arg (prefix-numeric-value arg) 10))
10303 (i 0)
10304 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10305 thistbl)
10306 (catch 'exit
10307 (while (< i imax)
10308 (setq i (1+ i))
10309 (org-table-recalculate 'all)
10310 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10311 (if (not (string= lasttbl thistbl))
10312 (setq lasttbl thistbl)
10313 (if (> i 1)
10314 (message "Convergence after %d iterations" i)
10315 (message "Table was already stable"))
10316 (throw 'exit t)))
10317 (error "No convergence after %d iterations" i))))
10319 (defun org-table-formula-substitute-names (f)
10320 "Replace $const with values in string F."
10321 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10322 ;; First, check for column names
10323 (while (setq start (string-match org-table-column-name-regexp f start))
10324 (setq start (1+ start))
10325 (setq a (assoc (match-string 1 f) org-table-column-names))
10326 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10327 ;; Parameters and constants
10328 (setq start 0)
10330 (setq start (1+ start))
10331 (if (setq a (save-match-data
10332 (org-table-get-constant (match-string 1 f))))
10333 (setq f (replace-match
10334 (concat (if pp "(") a (if pp ")")) t t f))))
10335 (if org-table-formula-debug
10336 (put-text-property 0 (length f) :orig-formula f1 f))
10337 f))
10339 (defun org-table-get-constant (const)
10340 "Find the value for a parameter or constant in a formula.
10341 Parameters get priority."
10342 (or (cdr (assoc const org-table-local-parameters))
10343 (cdr (assoc const org-table-formula-constants-local))
10344 (cdr (assoc const org-table-formula-constants))
10345 (and (fboundp 'constants-get) (constants-get const))
10346 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10347 (org-entry-get nil (substring const 5) 'inherit))
10348 "#UNDEFINED_NAME"))
10350 (defvar org-table-fedit-map
10351 (let ((map (make-sparse-keymap)))
10352 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10353 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10354 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10355 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10356 (org-defkey map "\C-c?" 'org-table-show-reference)
10357 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10358 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10359 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10360 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10361 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10362 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10363 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10364 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10365 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10366 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10367 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10368 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10369 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10370 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10371 map))
10373 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10374 '("Edit-Formulas"
10375 ["Finish and Install" org-table-fedit-finish t]
10376 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10377 ["Abort" org-table-fedit-abort t]
10378 "--"
10379 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10380 ["Complete Lisp Symbol" lisp-complete-symbol t]
10381 "--"
10382 "Shift Reference at Point"
10383 ["Up" org-table-fedit-ref-up t]
10384 ["Down" org-table-fedit-ref-down t]
10385 ["Left" org-table-fedit-ref-left t]
10386 ["Right" org-table-fedit-ref-right t]
10387 "-"
10388 "Change Test Row for Column Formulas"
10389 ["Up" org-table-fedit-line-up t]
10390 ["Down" org-table-fedit-line-down t]
10391 "--"
10392 ["Scroll Table Window" org-table-fedit-scroll t]
10393 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10394 ["Show Table Grid" org-table-fedit-toggle-coordinates
10395 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10396 org-table-overlay-coordinates)]
10397 "--"
10398 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10399 :style toggle :selected org-table-buffer-is-an]))
10401 (defvar org-pos)
10403 (defun org-table-edit-formulas ()
10404 "Edit the formulas of the current table in a separate buffer."
10405 (interactive)
10407 (beginning-of-line 0))
10408 (unless (org-at-table-p) (error "Not at a table"))
10409 (org-table-get-specials)
10410 (let ((key (org-table-current-field-formula 'key 'noerror))
10411 (eql (sort (org-table-get-stored-formulas 'noerror)
10412 'org-table-formula-less-p))
10413 (pos (move-marker (make-marker) (point)))
10414 (startline 1)
10415 (wc (current-window-configuration))
10419 entry s type title)
10420 (org-switch-to-buffer-other-window "*Edit Formulas*")
10421 (erase-buffer)
10422 ;; Keep global-font-lock-mode from turning on font-lock-mode
10423 (let ((font-lock-global-modes '(not fundamental-mode)))
10424 (fundamental-mode))
10425 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10426 (org-set-local 'org-pos pos)
10427 (org-set-local 'org-window-configuration wc)
10428 (use-local-map org-table-fedit-map)
10429 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10430 (easy-menu-add org-table-fedit-menu)
10431 (setq startline (org-current-line))
10432 (while (setq entry (pop eql))
10433 (setq type (cond
10434 ((equal (string-to-char (car entry)) ?@) 'field)
10435 ((string-match "^[0-9]" (car entry)) 'column)
10436 (t 'named)))
10437 (when (setq title (assq type titles))
10439 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10440 (setq titles (delq title titles)))
10441 (if (equal key (car entry)) (setq startline (org-current-line)))
10442 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10444 (remove-text-properties 0 (length s) '(face nil) s)
10445 (insert s))
10446 (if (eq org-table-use-standard-references t)
10447 (org-table-fedit-toggle-ref-type))
10448 (goto-line startline)
10449 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10451 (defun org-table-fedit-post-command ()
10452 (when (not (memq this-command '(lisp-complete-symbol)))
10453 (let ((win (selected-window)))
10454 (save-excursion
10455 (condition-case nil
10456 (org-table-show-reference)
10457 (error nil))
10458 (select-window win)))))
10460 (defun org-table-formula-to-user (s)
10461 "Convert a formula from internal to user representation."
10462 (if (eq org-table-use-standard-references t)
10463 (org-table-convert-refs-to-an s)
10464 s))
10466 (defun org-table-formula-from-user (s)
10467 "Convert a formula from user to internal representation."
10468 (if org-table-use-standard-references
10469 (org-table-convert-refs-to-rc s)
10470 s))
10472 (defun org-table-convert-refs-to-rc (s)
10473 "Convert spreadsheet references from AB7 to @7$28.
10474 Works for single references, but also for entire formulas and even the
10475 full TBLFM line."
10476 (let ((start 0))
10478 (cond
10479 ((match-end 3)
10480 ;; format match, just advance
10481 (setq start (match-end 0)))
10482 ((and (> (match-beginning 0) 0)
10483 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10484 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10485 ;; 3.e5 or something like this.
10486 (setq start (match-end 0)))
10487 (t
10488 (setq start (match-beginning 0)
10489 s (replace-match
10490 (if (equal (match-string 2 s) "&")
10491 (format "$%d" (org-letters-to-number (match-string 1 s)))
10492 (format "@%d$%d"
10493 (string-to-number (match-string 2 s))
10494 (org-letters-to-number (match-string 1 s))))
10495 t t s)))))
10496 s))
10498 (defun org-table-convert-refs-to-an (s)
10499 "Convert spreadsheet references from to @7$28 to AB7.
10500 Works for single references, but also for entire formulas and even the
10501 full TBLFM line."
10503 (setq s (replace-match
10504 (format "%s%d"
10505 (org-number-to-letters
10506 (string-to-number (match-string 2 s)))
10507 (string-to-number (match-string 1 s)))
10508 t t s)))
10511 (org-number-to-letters
10512 (string-to-number (match-string 2 s))) "&")
10513 t nil s)))
10514 s)
10516 (defun org-letters-to-number (s)
10517 "Convert a base 26 number represented by letters into an integer.
10518 For example: AB -> 28."
10519 (let ((n 0))
10520 (setq s (upcase s))
10521 (while (> (length s) 0)
10522 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10523 s (substring s 1)))
10524 n))
10526 (defun org-number-to-letters (n)
10527 "Convert an integer into a base 26 number represented by letters.
10528 For example: 28 -> AB."
10529 (let ((s ""))
10530 (while (> n 0)
10531 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10532 n (/ (1- n) 26)))
10533 s))
10535 (defun org-table-fedit-convert-buffer (function)
10536 "Convert all references in this buffer, using FUNTION."
10537 (let ((line (org-current-line)))
10538 (goto-char (point-min))
10539 (while (not (eobp))
10540 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10541 (delete-region (point) (point-at-eol))
10542 (or (eobp) (forward-char 1)))
10543 (goto-line line)))
10545 (defun org-table-fedit-toggle-ref-type ()
10546 "Convert all references in the buffer from B3 to @3$2 and back."
10547 (interactive)
10548 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10549 (org-table-fedit-convert-buffer
10550 (if org-table-buffer-is-an
10551 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10552 (message "Reference type switched to %s"
10553 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10555 (defun org-table-fedit-ref-up ()
10556 "Shift the reference at point one row/hline up."
10557 (interactive)
10558 (org-table-fedit-shift-reference 'up))
10559 (defun org-table-fedit-ref-down ()
10560 "Shift the reference at point one row/hline down."
10561 (interactive)
10562 (org-table-fedit-shift-reference 'down))
10563 (defun org-table-fedit-ref-left ()
10564 "Shift the reference at point one field to the left."
10565 (interactive)
10566 (org-table-fedit-shift-reference 'left))
10567 (defun org-table-fedit-ref-right ()
10568 "Shift the reference at point one field to the right."
10569 (interactive)
10570 (org-table-fedit-shift-reference 'right))
10572 (defun org-table-fedit-shift-reference (dir)
10573 (cond
10575 (if (memq dir '(left right))
10576 (org-rematch-and-replace 1 (eq dir 'left))
10577 (error "Cannot shift reference in this direction")))
10579 ;; A B3-like reference
10580 (if (memq dir '(up down))
10581 (org-rematch-and-replace 2 (eq dir 'up))
10582 (org-rematch-and-replace 1 (eq dir 'left))))
10583 ((org-at-regexp-p
10585 ;; An internal reference
10586 (if (memq dir '(up down))
10587 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10588 (org-rematch-and-replace 5 (eq dir 'left))))))
10590 (defun org-rematch-and-replace (n &optional decr hline)
10591 "Re-match the group N, and replace it with the shifted refrence."
10592 (or (match-end n) (error "Cannot shift reference in this direction"))
10593 (goto-char (match-beginning n))
10594 (and (looking-at (regexp-quote (match-string n)))
10595 (replace-match (org-shift-refpart (match-string 0) decr hline)
10596 t t)))
10598 (defun org-shift-refpart (ref &optional decr hline)
10599 "Shift a refrence part REF.
10600 If DECR is set, decrease the references row/column, else increase.
10601 If HLINE is set, this may be a hline reference, it certainly is not
10602 a translation reference."
10603 (save-match-data
10604 (let* ((sign (string-match "^[-+]" ref)) n)
10606 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10607 (cond
10608 ((and hline (string-match "^I+" ref))
10609 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10610 (setq n (+ n (if decr -1 1)))
10611 (if (= n 0) (setq n (+ n (if decr -1 1))))
10612 (if sign
10613 (setq sign (if (< n 0) "-" "+") n (abs n))
10614 (setq n (max 1 n)))
10615 (concat sign (make-string n ?I)))
10617 ((string-match "^[0-9]+" ref)
10618 (setq n (string-to-number (concat sign ref)))
10619 (setq n (+ n (if decr -1 1)))
10620 (if sign
10621 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10622 (number-to-string (max 1 n))))
10624 ((string-match "^[a-zA-Z]+" ref)
10625 (org-number-to-letters
10626 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10628 (t (error "Cannot shift reference"))))))
10630 (defun org-table-fedit-toggle-coordinates ()
10631 "Toggle the display of coordinates in the refrenced table."
10632 (interactive)
10633 (let ((pos (marker-position org-pos)))
10634 (with-current-buffer (marker-buffer org-pos)
10635 (save-excursion
10636 (goto-char pos)
10637 (org-table-toggle-coordinate-overlays)))))
10639 (defun org-table-fedit-finish (&optional arg)
10640 "Parse the buffer for formula definitions and install them.
10641 With prefix ARG, apply the new formulas to the table."
10642 (interactive "P")
10643 (org-table-remove-rectangle-highlight)
10644 (if org-table-use-standard-references
10645 (progn
10646 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10647 (setq org-table-buffer-is-an nil)))
10648 (let ((pos org-pos) eql var form)
10649 (goto-char (point-min))
10650 (while (re-search-forward
10652 nil t)
10653 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10654 form (match-string 3))
10655 (setq form (org-trim form))
10656 (when (not (equal form ""))
10658 (setq form (replace-match " " t t form)))
10659 (when (assoc var eql)
10660 (error "Double formulas for %s" var))
10661 (push (cons var form) eql)))
10662 (setq org-pos nil)
10663 (set-window-configuration org-window-configuration)
10664 (select-window (get-buffer-window (marker-buffer pos)))
10665 (goto-char pos)
10666 (unless (org-at-table-p)
10667 (error "Lost table position - cannot install formulae"))
10668 (org-table-store-formulas eql)
10669 (move-marker pos nil)
10670 (kill-buffer "*Edit Formulas*")
10671 (if arg
10672 (org-table-recalculate 'all)
10673 (message "New formulas installed - press C-u C-c C-c to apply."))))
10675 (defun org-table-fedit-abort ()
10676 "Abort editing formulas, without installing the changes."
10677 (interactive)
10678 (org-table-remove-rectangle-highlight)
10679 (let ((pos org-pos))
10680 (set-window-configuration org-window-configuration)
10681 (select-window (get-buffer-window (marker-buffer pos)))
10682 (goto-char pos)
10683 (move-marker pos nil)
10684 (message "Formula editing aborted without installing changes")))
10686 (defun org-table-fedit-lisp-indent ()
10687 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10688 (interactive)
10689 (let ((pos (point)) beg end ind)
10690 (beginning-of-line 1)
10691 (cond
10693 (goto-char pos)
10694 (call-interactively 'lisp-indent-line))
10696 ((not (fboundp 'pp-buffer))
10697 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10698 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10699 (goto-char (- (match-end 0) 2))
10700 (setq beg (point))
10701 (setq ind (make-string (current-column) ?\ ))
10702 (condition-case nil (forward-sexp 1)
10703 (error
10704 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10705 (setq end (point))
10706 (save-restriction
10707 (narrow-to-region beg end)
10708 (if (eq last-command this-command)
10709 (progn
10710 (goto-char (point-min))
10711 (setq this-command nil)
10713 (replace-match " ")))
10714 (pp-buffer)
10715 (untabify (point-min) (point-max))
10716 (goto-char (1+ (point-min)))
10717 (while (re-search-forward "^." nil t)
10718 (beginning-of-line 1)
10719 (insert ind))
10720 (goto-char (point-max))
10721 (backward-delete-char 1)))
10722 (goto-char beg))
10723 (t nil))))
10725 (defvar org-show-positions nil)
10727 (defun org-table-show-reference (&optional local)
10728 "Show the location/value of the $ expression at point."
10729 (interactive)
10730 (org-table-remove-rectangle-highlight)
10731 (catch 'exit
10732 (let ((pos (if local (point) org-pos))
10733 (face2 'highlight)
10734 (org-inhibit-highlight-removal t)
10735 (win (selected-window))
10736 (org-show-positions nil)
10737 var name e what match dest)
10738 (if local (org-table-get-specials))
10739 (setq what (cond
10740 ((or (org-at-regexp-p org-table-range-regexp2)
10741 (org-at-regexp-p org-table-translate-regexp)
10742 (org-at-regexp-p org-table-range-regexp))
10743 (setq match
10744 (save-match-data
10745 (org-table-convert-refs-to-rc (match-string 0))))
10746 'range)
10749 ((not local) nil)
10750 (t (error "No reference at point")))
10751 match (and what (or match (match-string 0))))
10752 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10753 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10754 'secondary-selection))
10755 (org-add-hook 'before-change-functions
10756 'org-table-remove-rectangle-highlight)
10757 (if (eq what 'name) (setq var (substring match 1)))
10758 (when (eq what 'range)
10759 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10760 (setq match (org-table-formula-substitute-names match)))
10761 (unless local
10762 (save-excursion
10763 (end-of-line 1)
10765 (beginning-of-line 1)
10767 (setq dest
10768 (save-match-data
10769 (org-table-convert-refs-to-rc (match-string 1))))
10770 (org-table-add-rectangle-overlay
10771 (match-beginning 1) (match-end 1) face2))))
10772 (if (and (markerp pos) (marker-buffer pos))
10773 (if (get-buffer-window (marker-buffer pos))
10774 (select-window (get-buffer-window (marker-buffer pos)))
10775 (org-switch-to-buffer-other-window (get-buffer-window
10776 (marker-buffer pos)))))
10777 (goto-char pos)
10778 (org-table-force-dataline)
10779 (when dest
10780 (setq name (substring dest 1))
10781 (cond
10783 (setq e (assoc name org-table-named-field-locations))
10784 (goto-line (nth 1 e))
10785 (org-table-goto-column (nth 2 e)))
10787 (let ((l (string-to-number (match-string 1 dest)))
10788 (c (string-to-number (match-string 2 dest))))
10789 (goto-line (aref org-table-dlines l))
10790 (org-table-goto-column c)))
10791 (t (org-table-goto-column (string-to-number name))))
10792 (move-marker pos (point))
10793 (org-table-highlight-rectangle nil nil face2))
10794 (cond
10795 ((equal dest match))
10796 ((not match))
10797 ((eq what 'range)
10798 (condition-case nil
10799 (save-excursion
10800 (org-table-get-range match nil nil 'highlight))
10801 (error nil)))
10802 ((setq e (assoc var org-table-named-field-locations))
10803 (goto-line (nth 1 e))
10804 (org-table-goto-column (nth 2 e))
10805 (org-table-highlight-rectangle (point) (point))
10806 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10807 ((setq e (assoc var org-table-column-names))
10808 (org-table-goto-column (string-to-number (cdr e)))
10809 (org-table-highlight-rectangle (point) (point))
10810 (goto-char (org-table-begin))
10812 (org-table-end) t)
10813 (progn
10814 (goto-char (match-beginning 1))
10815 (org-table-highlight-rectangle)
10816 (message "Named column (column %s)" (cdr e)))
10817 (error "Column name not found")))
10818 ((eq what 'column)
10819 ;; column number
10820 (org-table-goto-column (string-to-number (substring match 1)))
10821 (org-table-highlight-rectangle (point) (point))
10822 (message "Column %s" (substring match 1)))
10823 ((setq e (assoc var org-table-local-parameters))
10824 (goto-char (org-table-begin))
10826 (progn
10827 (goto-char (match-beginning 1))
10828 (org-table-highlight-rectangle)
10829 (message "Local parameter."))
10830 (error "Parameter not found")))
10831 (t
10832 (cond
10833 ((not var) (error "No reference at point"))
10834 ((setq e (assoc var org-table-formula-constants-local))
10835 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10836 var (cdr e)))
10837 ((setq e (assoc var org-table-formula-constants))
10838 (message "Constant: $%s=%s in `org-table-formula-constants'."
10839 var (cdr e)))
10840 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10841 (message "Constant: $%s=%s, from `constants.el'%s."
10842 var e (format " (%s units)" constants-unit-system)))
10843 (t (error "Undefined name $%s" var)))))
10844 (goto-char pos)
10845 (when (and org-show-positions
10846 (not (memq this-command '(org-table-fedit-scroll
10847 org-table-fedit-scroll-down))))
10848 (push pos org-show-positions)
10849 (push org-table-current-begin-pos org-show-positions)
10850 (let ((min (apply 'min org-show-positions))
10851 (max (apply 'max org-show-positions)))
10852 (goto-char min) (recenter 0)
10853 (goto-char max)
10854 (or (pos-visible-in-window-p max) (recenter -1))))
10855 (select-window win))))
10857 (defun org-table-force-dataline ()
10858 "Make sure the cursor is in a dataline in a table."
10859 (unless (save-excursion
10860 (beginning-of-line 1)
10861 (looking-at org-table-dataline-regexp))
10862 (let* ((re org-table-dataline-regexp)
10863 (p1 (save-excursion (re-search-forward re nil 'move)))
10864 (p2 (save-excursion (re-search-backward re nil 'move))))
10865 (cond ((and p1 p2)
10866 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10867 p1 p2)))
10868 ((or p1 p2) (goto-char (or p1 p2)))
10869 (t (error "No table dataline around here"))))))
10871 (defun org-table-fedit-line-up ()
10872 "Move cursor one line up in the window showing the table."
10873 (interactive)
10874 (org-table-fedit-move 'previous-line))
10876 (defun org-table-fedit-line-down ()
10877 "Move cursor one line down in the window showing the table."
10878 (interactive)
10879 (org-table-fedit-move 'next-line))
10881 (defun org-table-fedit-move (command)
10882 "Move the cursor in the window shoinw the table.
10883 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
10884 (let ((org-table-allow-automatic-line-recalculation nil)
10885 (pos org-pos) (win (selected-window)) p)
10886 (select-window (get-buffer-window (marker-buffer org-pos)))
10887 (setq p (point))
10888 (call-interactively command)
10889 (while (and (org-at-table-p)
10890 (org-at-table-hline-p))
10891 (call-interactively command))
10892 (or (org-at-table-p) (goto-char p))
10893 (move-marker pos (point))
10894 (select-window win)))
10896 (defun org-table-fedit-scroll (N)
10897 (interactive "p")
10898 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
10899 (scroll-other-window N)))
10901 (defun org-table-fedit-scroll-down (N)
10902 (interactive "p")
10903 (org-table-fedit-scroll (- N)))
10905 (defvar org-table-rectangle-overlays nil)
10907 (defun org-table-add-rectangle-overlay (beg end &optional face)
10908 "Add a new overlay."
10909 (let ((ov (org-make-overlay beg end)))
10910 (org-overlay-put ov 'face (or face 'secondary-selection))
10911 (push ov org-table-rectangle-overlays)))
10913 (defun org-table-highlight-rectangle (&optional beg end face)
10914 "Highlight rectangular region in a table."
10915 (setq beg (or beg (point)) end (or end (point)))
10916 (let ((b (min beg end))
10917 (e (max beg end))
10918 l1 c1 l2 c2 tmp)
10919 (and (boundp 'org-show-positions)
10920 (setq org-show-positions (cons b (cons e org-show-positions))))
10921 (goto-char (min beg end))
10922 (setq l1 (org-current-line)
10923 c1 (org-table-current-column))
10924 (goto-char (max beg end))
10925 (setq l2 (org-current-line)
10926 c2 (org-table-current-column))
10927 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
10928 (goto-line l1)
10929 (beginning-of-line 1)
10930 (loop for line from l1 to l2 do
10931 (when (looking-at org-table-dataline-regexp)
10932 (org-table-goto-column c1)
10934 (org-table-goto-column c2)
10936 (org-table-add-rectangle-overlay beg end face))
10937 (beginning-of-line 2))
10938 (goto-char b))
10939 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
10941 (defun org-table-remove-rectangle-highlight (&rest ignore)
10942 "Remove the rectangle overlays."
10943 (unless org-inhibit-highlight-removal
10944 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
10945 (mapc 'org-delete-overlay org-table-rectangle-overlays)
10946 (setq org-table-rectangle-overlays nil)))
10948 (defvar org-table-coordinate-overlays nil
10949 "Collects the cooordinate grid overlays, so that they can be removed.")
10950 (make-variable-buffer-local 'org-table-coordinate-overlays)
10952 (defun org-table-overlay-coordinates ()
10953 "Add overlays to the table at point, to show row/column coordinates."
10954 (interactive)
10955 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10956 (setq org-table-coordinate-overlays nil)
10957 (save-excursion
10958 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
10959 (goto-char (org-table-begin))
10960 (while (org-at-table-p)
10961 (setq eol (point-at-eol))
10962 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
10963 (push ov org-table-coordinate-overlays)
10964 (setq hline (looking-at org-table-hline-regexp))
10965 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
10966 (format "%4d" (setq id (1+ id)))))
10967 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
10968 (when hline
10969 (setq ic 0)
10971 (setq beg (1+ (match-beginning 0))
10972 ic (1+ ic)
10973 s1 (concat "$" (int-to-string ic))
10974 s2 (org-number-to-letters ic)
10975 str (if (eq org-table-use-standard-references t) s2 s1))
10976 (setq ov (org-make-overlay beg (+ beg (length str))))
10977 (push ov org-table-coordinate-overlays)
10978 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
10979 (beginning-of-line 2)))))
10981 (defun org-table-toggle-coordinate-overlays ()
10982 "Toggle the display of Row/Column numbers in tables."
10983 (interactive)
10984 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
10985 (message "Row/Column number display turned %s"
10986 (if org-table-overlay-coordinates "on" "off"))
10987 (if (and (org-at-table-p) org-table-overlay-coordinates)
10988 (org-table-align))
10989 (unless org-table-overlay-coordinates
10990 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10991 (setq org-table-coordinate-overlays nil)))
10993 (defun org-table-toggle-formula-debugger ()
10994 "Toggle the formula debugger in tables."
10995 (interactive)
10996 (setq org-table-formula-debug (not org-table-formula-debug))
10997 (message "Formula debugging has been turned %s"
10998 (if org-table-formula-debug "on" "off")))
11000 ;;; The orgtbl minor mode
11002 ;; Define a minor mode which can be used in other modes in order to
11003 ;; integrate the org-mode table editor.
11005 ;; This is really a hack, because the org-mode table editor uses several
11006 ;; keys which normally belong to the major mode, for example the TAB and
11007 ;; RET keys. Here is how it works: The minor mode defines all the keys
11008 ;; necessary to operate the table editor, but wraps the commands into a
11009 ;; function which tests if the cursor is currently inside a table. If that
11010 ;; is the case, the table editor command is executed. However, when any of
11011 ;; those keys is used outside a table, the function uses `key-binding' to
11012 ;; look up if the key has an associated command in another currently active
11013 ;; keymap (minor modes, major mode, global), and executes that command.
11014 ;; There might be problems if any of the keys used by the table editor is
11015 ;; otherwise used as a prefix key.
11017 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11018 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11019 ;; addresses this by checking explicitly for both bindings.
11021 ;; The optimized version (see variable `orgtbl-optimized') takes over
11022 ;; all keys which are bound to `self-insert-command' in the *global map*.
11023 ;; Some modes bind other commands to simple characters, for example
11024 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11025 ;; active, this binding is ignored inside tables and replaced with a
11026 ;; modified self-insert.
11028 (defvar orgtbl-mode nil
11029 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11030 table editor in arbitrary modes.")
11031 (make-variable-buffer-local 'orgtbl-mode)
11033 (defvar orgtbl-mode-map (make-keymap)
11034 "Keymap for `orgtbl-mode'.")
11036 ;;;###autoload
11037 (defun turn-on-orgtbl ()
11038 "Unconditionally turn on `orgtbl-mode'."
11039 (orgtbl-mode 1))
11041 (defvar org-old-auto-fill-inhibit-regexp nil
11042 "Local variable used by `orgtbl-mode'")
11045 "Matches a line belonging to an orgtbl.")
11047 (defconst orgtbl-extra-font-lock-keywords
11048 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11049 0 (quote 'org-table) 'prepend))
11050 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11052 ;;;###autoload
11053 (defun orgtbl-mode (&optional arg)
11054 "The `org-mode' table editor as a minor mode for use in other modes."
11055 (interactive)
11056 (if (org-mode-p)
11057 ;; Exit without error, in case some hook functions calls this
11058 ;; by accident in org-mode.
11059 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11060 (setq orgtbl-mode
11061 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11062 (if orgtbl-mode
11063 (progn
11064 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11065 ;; Make sure we are first in minor-mode-map-alist
11066 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11067 (and c (setq minor-mode-map-alist
11068 (cons c (delq c minor-mode-map-alist)))))
11069 (org-set-local (quote org-table-may-need-update) t)
11070 (org-add-hook 'before-change-functions 'org-before-change-function
11071 nil 'local)
11072 (org-set-local 'org-old-auto-fill-inhibit-regexp
11073 auto-fill-inhibit-regexp)
11074 (org-set-local 'auto-fill-inhibit-regexp
11075 (if auto-fill-inhibit-regexp
11077 auto-fill-inhibit-regexp)
11078 orgtbl-line-start-regexp))
11079 (org-add-to-invisibility-spec '(org-cwidth))
11080 (when (fboundp 'font-lock-add-keywords)
11081 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11082 (org-restart-font-lock))
11083 (easy-menu-add orgtbl-mode-menu)
11084 (run-hooks 'orgtbl-mode-hook))
11085 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11086 (org-cleanup-narrow-column-properties)
11087 (org-remove-from-invisibility-spec '(org-cwidth))
11088 (remove-hook 'before-change-functions 'org-before-change-function t)
11089 (when (fboundp 'font-lock-remove-keywords)
11090 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11091 (org-restart-font-lock))
11092 (easy-menu-remove orgtbl-mode-menu)
11093 (force-mode-line-update 'all))))
11095 (defun org-cleanup-narrow-column-properties ()
11096 "Remove all properties related to narrow-column invisibility."
11097 (let ((s 1))
11098 (while (setq s (text-property-any s (point-max)
11099 'display org-narrow-column-arrow))
11100 (remove-text-properties s (1+ s) '(display t)))
11101 (setq s 1)
11102 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11103 (remove-text-properties s (1+ s) '(org-cwidth t)))
11104 (setq s 1)
11105 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11106 (remove-text-properties s (1+ s) '(invisible t)))))
11108 ;; Install it as a minor mode.
11109 (put 'orgtbl-mode :included t)
11110 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11111 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11113 (defun orgtbl-make-binding (fun n &rest keys)
11114 "Create a function for binding in the table minor mode.
11115 FUN is the command to call inside a table. N is used to create a unique
11116 command name. KEYS are keys that should be checked in for a command
11117 to execute outside of tables."
11118 (eval
11119 (list 'defun
11120 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11121 '(arg)
11123 "Outside of tables, run the binding of `"
11124 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11125 "'.")
11126 '(interactive "p")
11127 (list 'if
11128 '(org-at-table-p)
11129 (list 'call-interactively (list 'quote fun))
11130 (list 'let '(orgtbl-mode)
11131 (list 'call-interactively
11132 (append '(or)
11133 (mapcar (lambda (k)
11134 (list 'key-binding k))
11135 keys)
11136 '('orgtbl-error))))))))
11138 (defun orgtbl-error ()
11139 "Error when there is no default binding for a table key."
11140 (interactive)
11141 (error "This key has no function outside tables"))
11143 (defun orgtbl-setup ()
11144 "Setup orgtbl keymaps."
11145 (let ((nfunc 0)
11146 (bindings
11147 (list
11148 '([(meta shift left)] org-table-delete-column)
11149 '([(meta left)] org-table-move-column-left)
11150 '([(meta right)] org-table-move-column-right)
11151 '([(meta shift right)] org-table-insert-column)
11152 '([(meta shift up)] org-table-kill-row)
11153 '([(meta shift down)] org-table-insert-row)
11154 '([(meta up)] org-table-move-row-up)
11155 '([(meta down)] org-table-move-row-down)
11156 '("\C-c\C-w" org-table-cut-region)
11157 '("\C-c\M-w" org-table-copy-region)
11158 '("\C-c\C-y" org-table-paste-rectangle)
11159 '("\C-c-" org-table-insert-hline)
11160 '("\C-c}" org-table-toggle-coordinate-overlays)
11161 '("\C-c{" org-table-toggle-formula-debugger)
11162 '("\C-m" org-table-next-row)
11163 '([(shift return)] org-table-copy-down)
11164 '("\C-c\C-q" org-table-wrap-region)
11165 '("\C-c?" org-table-field-info)
11166 '("\C-c " org-table-blank-field)
11167 '("\C-c+" org-table-sum)
11168 '("\C-c=" org-table-eval-formula)
11169 '("\C-c'" org-table-edit-formulas)
11170 '("\C-c`" org-table-edit-field)
11171 '("\C-c*" org-table-recalculate)
11172 '("\C-c|" org-table-create-or-convert-from-region)
11173 '("\C-c^" org-table-sort-lines)
11174 '([(control ?#)] org-table-rotate-recalc-marks)))
11175 elt key fun cmd)
11176 (while (setq elt (pop bindings))
11177 (setq nfunc (1+ nfunc))
11178 (setq key (org-key (car elt))
11179 fun (nth 1 elt)
11180 cmd (orgtbl-make-binding fun nfunc key))
11181 (org-defkey orgtbl-mode-map key cmd))
11183 ;; Special treatment needed for TAB and RET
11184 (org-defkey orgtbl-mode-map [(return)]
11185 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11186 (org-defkey orgtbl-mode-map "\C-m"
11187 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11189 (org-defkey orgtbl-mode-map [(tab)]
11190 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11191 (org-defkey orgtbl-mode-map "\C-i"
11192 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11194 (org-defkey orgtbl-mode-map [(shift tab)]
11195 (orgtbl-make-binding 'org-table-previous-field 104
11196 [(shift tab)] [(tab)] "\C-i"))
11198 (org-defkey orgtbl-mode-map "\M-\C-m"
11199 (orgtbl-make-binding 'org-table-wrap-region 105
11200 "\M-\C-m" [(meta return)]))
11201 (org-defkey orgtbl-mode-map [(meta return)]
11202 (orgtbl-make-binding 'org-table-wrap-region 106
11203 [(meta return)] "\M-\C-m"))
11205 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11206 (when orgtbl-optimized
11207 ;; If the user wants maximum table support, we need to hijack
11208 ;; some standard editing functions
11209 (org-remap orgtbl-mode-map
11210 'self-insert-command 'orgtbl-self-insert-command
11211 'delete-char 'org-delete-char
11212 'delete-backward-char 'org-delete-backward-char)
11213 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11214 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11215 '("OrgTbl"
11216 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11217 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11218 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11219 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11220 "--"
11221 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11222 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11223 ["Copy Field from Above"
11224 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11225 "--"
11226 ("Column"
11227 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11228 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11229 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11230 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11231 ("Row"
11232 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11233 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11234 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11235 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11236 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11237 "--"
11238 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11239 ("Rectangle"
11240 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11241 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11242 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11243 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11244 "--"
11245 ("Radio tables"
11246 ["Insert table template" orgtbl-insert-radio-table
11247 (assq major-mode orgtbl-radio-table-templates)]
11248 ["Comment/uncomment table" orgtbl-toggle-comment t])
11249 "--"
11250 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11251 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11252 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11253 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11254 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11255 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11256 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11257 ["Sum Column/Rectangle" org-table-sum
11258 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11259 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11260 ["Debug Formulas"
11261 org-table-toggle-formula-debugger :active (org-at-table-p)
11262 :keys "C-c {"
11263 :style toggle :selected org-table-formula-debug]
11264 ["Show Col/Row Numbers"
11265 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11266 :keys "C-c }"
11267 :style toggle :selected org-table-overlay-coordinates]
11268 ))
11269 t))
11271 (defun orgtbl-ctrl-c-ctrl-c (arg)
11272 "If the cursor is inside a table, realign the table.
11273 It it is a table to be sent away to a receiver, do it.
11274 With prefix arg, also recompute table."
11275 (interactive "P")
11276 (let ((pos (point)) action)
11277 (save-excursion
11278 (beginning-of-line 1)
11282 (cond
11283 ((integerp action)
11284 (goto-char action)
11285 (org-table-maybe-eval-formula)
11286 (if arg
11287 (call-interactively 'org-table-recalculate)
11288 (org-table-maybe-recalculate-line))
11289 (call-interactively 'org-table-align)
11290 (orgtbl-send-table 'maybe))
11291 ((eq action 'recalc)
11292 (save-excursion
11293 (beginning-of-line 1)
11295 (if (org-at-table-p)
11296 (org-call-with-arg 'org-table-recalculate t))))
11297 (t (let (orgtbl-mode)
11298 (call-interactively (key-binding "\C-c\C-c")))))))
11300 (defun orgtbl-tab (arg)
11301 "Justification and field motion for `orgtbl-mode'."
11302 (interactive "P")
11303 (if arg (org-table-edit-field t)
11304 (org-table-justify-field-maybe)
11305 (org-table-next-field)))
11307 (defun orgtbl-ret ()
11308 "Justification and field motion for `orgtbl-mode'."
11309 (interactive)
11310 (org-table-justify-field-maybe)
11311 (org-table-next-row))
11313 (defun orgtbl-self-insert-command (N)
11314 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11315 If the cursor is in a table looking at whitespace, the whitespace is
11316 overwritten, and the table is not marked as requiring realignment."
11317 (interactive "p")
11318 (if (and (org-at-table-p)
11319 (or
11320 (and org-table-auto-blank-field
11321 (member last-command
11322 '(orgtbl-hijacker-command-100
11323 orgtbl-hijacker-command-101
11324 orgtbl-hijacker-command-102
11325 orgtbl-hijacker-command-103
11326 orgtbl-hijacker-command-104
11327 orgtbl-hijacker-command-105))
11328 (org-table-blank-field))
11329 t)
11330 (eq N 1)
11332 (let (org-table-may-need-update)
11333 (goto-char (1- (match-end 0)))
11334 (delete-backward-char 1)
11335 (goto-char (match-beginning 0))
11336 (self-insert-command N))
11337 (setq org-table-may-need-update t)
11338 (let (orgtbl-mode)
11339 (call-interactively (key-binding (vector last-input-event))))))
11341 (defun org-force-self-insert (N)
11342 "Needed to enforce self-insert under remapping."
11343 (interactive "p")
11344 (self-insert-command N))
11347 "Regula expression matching exponentials as produced by calc.")
11349 (defvar org-table-clean-did-remove-column nil)
11351 (defun orgtbl-export (table target)
11352 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11354 org-table-last-alignment org-table-last-column-widths
11355 maxcol column)
11356 (if (not (fboundp func))
11357 (error "Cannot export orgtbl table to %s" target))
11358 (setq lines (org-table-clean-before-export lines))
11359 (setq table
11360 (mapcar
11361 (lambda (x)
11362 (if (string-match org-table-hline-regexp x)
11363 'hline
11365 lines))
11366 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11367 table)))
11368 (loop for i from (1- maxcol) downto 0 do
11369 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11370 (setq column (delq nil column))
11371 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11372 (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))
11373 (funcall func table nil)))
11375 (defun orgtbl-send-table (&optional maybe)
11376 "Send a tranformed version of this table to the receiver position.
11377 With argument MAYBE, fail quietly if no transformation is defined for
11378 this table."
11379 (interactive)
11380 (catch 'exit
11381 (unless (org-at-table-p) (error "Not at a table"))
11382 ;; when non-interactive, we assume align has just happened.
11383 (when (interactive-p) (org-table-align))
11384 (save-excursion
11385 (goto-char (org-table-begin))
11386 (beginning-of-line 0)
11388 (if maybe
11389 (throw 'exit nil)
11390 (error "Don't know how to transform this table."))))
11391 (let* ((name (match-string 1))
11392 beg
11393 (transform (intern (match-string 2)))
11394 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11395 (skip (plist-get params :skip))
11396 (skipcols (plist-get params :skipcols))
11397 (txt (buffer-substring-no-properties
11398 (org-table-begin) (org-table-end)))
11400 (lines (org-table-clean-before-export lines))
11401 (i0 (if org-table-clean-did-remove-column 2 1))
11402 (table (mapcar
11403 (lambda (x)
11404 (if (string-match org-table-hline-regexp x)
11405 'hline
11406 (org-remove-by-index
11408 skipcols i0)))
11409 lines))
11410 (fun (if (= i0 2) 'cdr 'identity))
11411 (org-table-last-alignment
11412 (org-remove-by-index (funcall fun org-table-last-alignment)
11413 skipcols i0))
11414 (org-table-last-column-widths
11415 (org-remove-by-index (funcall fun org-table-last-column-widths)
11416 skipcols i0)))
11418 (unless (fboundp transform)
11419 (error "No such transformation function %s" transform))
11420 (setq txt (funcall transform table params))
11421 ;; Find the insertion place
11422 (save-excursion
11423 (goto-char (point-min))
11424 (unless (re-search-forward
11426 (error "Don't know where to insert translated table"))
11427 (goto-char (match-beginning 0))
11428 (beginning-of-line 2)
11429 (setq beg (point))
11430 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11431 (error "Cannot find end of insertion region"))
11432 (beginning-of-line 1)
11433 (delete-region beg (point))
11434 (goto-char beg)
11436 (message "Table converted and installed at receiver location"))))
11438 (defun org-remove-by-index (list indices &optional i0)
11439 "Remove the elements in LIST with indices in INDICES.
11440 First element has index 0, or I0 if given."
11441 (if (not indices)
11442 list
11443 (if (integerp indices) (setq indices (list indices)))
11444 (setq i0 (1- (or i0 0)))
11445 (delq :rm (mapcar (lambda (x)
11446 (setq i0 (1+ i0))
11447 (if (memq i0 indices) :rm x))
11448 list))))
11450 (defun orgtbl-toggle-comment ()
11451 "Comment or uncomment the orgtbl at point."
11452 (interactive)
11453 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11454 (re2 (concat "^" orgtbl-line-start-regexp))
11455 (commented (save-excursion (beginning-of-line 1)
11456 (cond ((looking-at re1) t)
11457 ((looking-at re2) nil)
11458 (t (error "Not at an org table")))))
11459 (re (if commented re1 re2))
11460 beg end)
11461 (save-excursion
11462 (beginning-of-line 1)
11463 (while (looking-at re) (beginning-of-line 0))
11464 (beginning-of-line 2)
11465 (setq beg (point))
11466 (while (looking-at re) (beginning-of-line 2))
11467 (setq end (point)))
11468 (comment-region beg end (if commented '(4) nil))))
11470 (defun orgtbl-insert-radio-table ()
11471 "Insert a radio table template appropriate for this major mode."
11472 (interactive)
11473 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11474 (txt (nth 1 e))
11475 name pos)
11476 (unless e (error "No radio table setup defined for %s" major-mode))
11477 (setq name (read-string "Table name: "))
11478 (while (string-match "%n" txt)
11479 (setq txt (replace-match name t t txt)))
11481 (setq pos (point))
11482 (insert txt)
11483 (goto-char pos)))
11485 (defun org-get-param (params header i sym &optional hsym)
11486 "Get parameter value for symbol SYM.
11487 If this is a header line, actually get the value for the symbol with an
11489 If the value is a protperty list, get the element for the current column.
11490 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11491 (let ((val (plist-get params sym)))
11492 (and hsym header (setq val (or (plist-get params hsym) val)))
11493 (if (consp val) (plist-get val i) val)))
11495 (defun orgtbl-to-generic (table params)
11496 "Convert the orgtbl-mode TABLE to some other format.
11497 This generic routine can be used for many standard cases.
11498 TABLE is a list, each entry either the symbol `hline' for a horizontal
11499 separator line, or a list of fields for that line.
11500 PARAMS is a property list of parameters that can influence the conversion.
11501 For the generic converter, some parameters are obligatory: You need to
11502 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11503 :splice, you must have :tstart and :tend.
11505 Valid parameters are
11507 :tstart String to start the table. Ignored when :splice is t.
11508 :tend String to end the table. Ignored when :splice is t.
11510 :splice When set to t, return only table body lines, don't wrap
11511 them into :tstart and :tend. Default is nil.
11513 :hline String to be inserted on horizontal separation lines.
11514 May be nil to ignore hlines.
11516 :lstart String to start a new table line.
11517 :lend String to end a table line
11518 :sep Separator between two fields
11519 :lfmt Format for entire line, with enough %s to capture all fields.
11520 If this is present, :lstart, :lend, and :sep are ignored.
11521 :fmt A format to be used to wrap the field, should contain
11522 %s for the original field value. For example, to wrap
11524 This may also be a property list with column numbers and
11527 :hlstart :hlend :hlsep :hlfmt :hfmt
11528 Same as above, specific for the header lines in the table.
11529 All lines before the first hline are treated as header.
11530 If any of these is not present, the data line value is used.
11532 :efmt Use this format to print numbers with exponentials.
11533 The format should have %s twice for inserting mantissa
11535 may also be a property list with column numbers and
11536 formats. :fmt will still be applied after :efmt.
11538 In addition to this, the parameters :skip and :skipcols are always handled
11539 directly by `orgtbl-send-table'. See manual."
11540 (interactive)
11541 (let* ((p params)
11542 (splicep (plist-get p :splice))
11543 (hline (plist-get p :hline))
11544 rtn line i fm efm lfmt h)
11546 ;; Do we have a header?
11547 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11548 (setq h t))
11550 ;; Put header
11551 (unless splicep
11552 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11554 ;; Now loop over all lines
11555 (while (setq line (pop table))
11556 (if (eq line 'hline)
11557 ;; A horizontal separator line
11558 (progn (if hline (push hline rtn))
11559 (setq h nil)) ; no longer in header
11560 ;; A normal line. Convert the fields, push line onto the result list
11561 (setq i 0)
11562 (setq line
11563 (mapcar
11564 (lambda (f)
11565 (setq i (1+ i)
11566 fm (org-get-param p h i :fmt :hfmt)
11567 efm (org-get-param p h i :efmt))
11568 (if (and efm (string-match orgtbl-exp-regexp f))
11569 (setq f (format
11570 efm (match-string 1 f) (match-string 2 f))))
11571 (if fm (setq f (format fm f)))
11572 f)
11573 line))
11574 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11575 (push (apply 'format lfmt line) rtn)
11576 (push (concat
11577 (org-get-param p h i :lstart :hlstart)
11578 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11579 (org-get-param p h i :lend :hlend))
11580 rtn))))
11582 (unless splicep
11583 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11587 (defun orgtbl-to-latex (table params)
11588 "Convert the orgtbl-mode TABLE to LaTeX.
11589 TABLE is a list, each entry either the symbol `hline' for a horizontal
11590 separator line, or a list of fields for that line.
11591 PARAMS is a property list of parameters that can influence the conversion.
11592 Supports all parameters from `orgtbl-to-generic'. Most important for
11593 LaTeX are:
11595 :splice When set to t, return only table body lines, don't wrap
11596 them into a tabular environment. Default is nil.
11598 :fmt A format to be used to wrap the field, should contain %s for the
11599 original field value. For example, to wrap everything in dollars,
11603 :efmt Format for transforming numbers with exponentials. The format
11604 should have %s twice for inserting mantissa and exponent, for
11606 This may also be a property list with column numbers and formats.
11608 The general parameters :skip and :skipcols have already been applied when
11609 this function is called."
11610 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11611 org-table-last-alignment ""))
11612 (params2
11613 (list
11618 (orgtbl-to-generic table (org-combine-plists params2 params))))
11620 (defun orgtbl-to-html (table params)
11621 "Convert the orgtbl-mode TABLE to LaTeX.
11622 TABLE is a list, each entry either the symbol `hline' for a horizontal
11623 separator line, or a list of fields for that line.
11624 PARAMS is a property list of parameters that can influence the conversion.
11625 Currently this function recognizes the following parameters:
11627 :splice When set to t, return only table body lines, don't wrap
11628 them into a <table> environment. Default is nil.
11630 The general parameters :skip and :skipcols have already been applied when
11631 this function is called. The function does *not* use `orgtbl-to-generic',
11632 so you cannot specify parameters for it."
11633 (let* ((splicep (plist-get params :splice))
11634 html)
11635 ;; Just call the formatter we already have
11636 ;; We need to make text lines for it, so put the fields back together.
11637 (setq html (org-format-org-table-html
11638 (mapcar
11639 (lambda (x)
11640 (if (eq x 'hline)
11641 "|----+----|"
11642 (concat "| " (mapconcat 'identity x " | ") " |")))
11643 table)
11644 splicep))
11646 (setq html (replace-match "" t t html)))
11647 html))
11649 (defun orgtbl-to-texinfo (table params)
11650 "Convert the orgtbl-mode TABLE to TeXInfo.
11651 TABLE is a list, each entry either the symbol `hline' for a horizontal
11652 separator line, or a list of fields for that line.
11653 PARAMS is a property list of parameters that can influence the conversion.
11654 Supports all parameters from `orgtbl-to-generic'. Most important for
11655 TeXInfo are:
11657 :splice nil/t When set to t, return only table body lines, don't wrap
11658 them into a multitable environment. Default is nil.
11660 :fmt fmt A format to be used to wrap the field, should contain
11661 %s for the original field value. For example, to wrap
11663 This may also be a property list with column numbers and
11667 are computed automatically from the width of the columns
11668 under org-mode.
11670 The general parameters :skip and :skipcols have already been applied when
11671 this function is called."
11672 (let* ((total (float (apply '+ org-table-last-column-widths)))
11673 (colfrac (or (plist-get params :cf)
11674 (mapconcat
11675 (lambda (x) (format "%.3f" (/ (float x) total)))
11676 org-table-last-column-widths " ")))
11677 (params2
11678 (list
11679 :tstart (concat "@multitable @columnfractions " colfrac)
11680 :tend "@end multitable"
11681 :lstart "@item " :lend "" :sep " @tab "
11682 :hlstart "@headitem ")))
11683 (orgtbl-to-generic table (org-combine-plists params2 params))))
11685 ;;;; Link Stuff
11687 ;;; Link abbreviations
11689 (defun org-link-expand-abbrev (link)
11690 "Apply replacements as defined in `org-link-abbrev-alist."
11692 (let* ((key (match-string 1 link))
11693 (as (or (assoc key org-link-abbrev-alist-local)
11694 (assoc key org-link-abbrev-alist)))
11695 (tag (and (match-end 2) (match-string 3 link)))
11696 rpl)
11697 (if (not as)
11698 link
11699 (setq rpl (cdr as))
11700 (cond
11701 ((symbolp rpl) (funcall rpl tag))
11702 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11703 (t (concat rpl tag)))))
11704 link))
11706 ;;; Storing and inserting links
11708 (defvar org-insert-link-history nil
11709 "Minibuffer history for links inserted with `org-insert-link'.")
11711 (defvar org-stored-links nil
11712 "Contains the links stored with `org-store-link'.")
11714 (defvar org-store-link-plist nil
11715 "Plist with info about the most recently link created with `org-store-link'.")
11717 (defvar org-link-protocols nil
11718 "Link protocols added to Org-mode using `org-add-link-type'.")
11720 (defvar org-store-link-functions nil
11721 "List of functions that are called to create and store a link.
11722 Each function will be called in turn until one returns a non-nil
11723 value. Each function should check if it is responsible for creating
11724 this link (for example by looking at the major mode).
11725 If not, it must exit and return nil.
11726 If yes, it should return a non-nil value after a calling
11727 `org-store-link-props' with a list of properties and values.
11728 Special properties are:
11732 This is obligatory as well.
11733 :description Optional default description for the second pair
11734 of brackets in an Org-mode link. The user can still change
11735 this when inserting this link into an Org-mode buffer.
11737 In addition to these, any additional properties can be specified
11738 and then used in remember templates.")
11740 (defun org-add-link-type (type &optional follow publish)
11741 "Add TYPE to the list of `org-link-types'.
11742 Re-compute all regular expressions depending on `org-link-types'
11743 FOLLOW and PUBLISH are two functions. Both take the link path as
11744 an argument.
11745 FOLLOW should do whatever is necessary to follow the link, for example
11746 to find a file or display a mail message.
11748 PUBLISH takes the path and retuns the string that should be used when
11749 this document is published. FIMXE: This is actually not yet implemented."
11750 (add-to-list 'org-link-types type t)
11751 (org-make-link-regexps)
11752 (add-to-list 'org-link-protocols
11753 (list type follow publish)))
11755 (defun org-add-agenda-custom-command (entry)
11756 "Replace or add a command in `org-agenda-custom-commands'.
11757 This is mostly for hacking and trying a new command - once the command
11758 works you probably want to add it to `org-agenda-custom-commands' for good."
11759 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11760 (if ass
11761 (setcdr ass (cdr entry))
11762 (push entry org-agenda-custom-commands))))
11764 ;;;###autoload
11765 (defun org-store-link (arg)
11767 This link can later be inserted into an org-buffer with
11769 For some link types, a prefix arg is interpreted:
11770 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11771 For file links, arg negates `org-context-in-file-links'."
11772 (interactive "P")
11773 (setq org-store-link-plist nil) ; reset
11774 (let (link cpltxt desc description search txt)
11775 (cond
11777 ((run-hook-with-args-until-success 'org-store-link-functions)
11778 (setq link (plist-get org-store-link-plist :link)
11779 desc (or (plist-get org-store-link-plist :description) link)))
11781 ((eq major-mode 'bbdb-mode)
11782 (let ((name (bbdb-record-name (bbdb-current-record)))
11783 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11784 (setq cpltxt (concat "bbdb:" (or name company))
11785 link (org-make-link cpltxt))
11786 (org-store-link-props :type "bbdb" :name name :company company)))
11788 ((eq major-mode 'Info-mode)
11789 (setq link (org-make-link "info:"
11790 (file-name-nondirectory Info-current-file)
11791 ":" Info-current-node))
11792 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11793 ":" Info-current-node))
11794 (org-store-link-props :type "info" :file Info-current-file
11795 :node Info-current-node))
11797 ((eq major-mode 'calendar-mode)
11798 (let ((cd (calendar-cursor-to-date)))
11799 (setq link
11800 (format-time-string
11801 (car org-time-stamp-formats)
11802 (apply 'encode-time
11803 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11804 nil nil nil))))
11805 (org-store-link-props :type "calendar" :date cd)))
11807 ((or (eq major-mode 'vm-summary-mode)
11808 (eq major-mode 'vm-presentation-mode))
11809 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11810 (vm-follow-summary-cursor)
11811 (save-excursion
11812 (vm-select-folder-buffer)
11813 (let* ((message (car vm-message-pointer))
11814 (folder buffer-file-name)
11815 (subject (vm-su-subject message))
11816 (to (vm-get-header-contents message "To"))
11817 (from (vm-get-header-contents message "From"))
11818 (message-id (vm-su-message-id message)))
11819 (org-store-link-props :type "vm" :from from :to to :subject subject
11820 :message-id message-id)
11821 (setq message-id (org-remove-angle-brackets message-id))
11822 (setq folder (abbreviate-file-name folder))
11823 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11824 folder)
11825 (setq folder (replace-match "" t t folder)))
11826 (setq cpltxt (org-email-link-description))
11827 (setq link (org-make-link "vm:" folder "#" message-id)))))
11829 ((eq major-mode 'wl-summary-mode)
11830 (let* ((msgnum (wl-summary-message-number))
11831 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11832 msgnum 'message-id))
11833 (wl-message-entity
11834 (if (fboundp 'elmo-message-entity)
11835 (elmo-message-entity
11836 wl-summary-buffer-elmo-folder msgnum)
11837 (elmo-msgdb-overview-get-entity
11838 msgnum (wl-summary-buffer-msgdb))))
11839 (from (wl-summary-line-from))
11840 (to (car (elmo-message-entity-field wl-message-entity 'to)))
11841 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11842 (wl-summary-line-subject))))
11843 (org-store-link-props :type "wl" :from from :to to
11844 :subject subject :message-id message-id)
11845 (setq message-id (org-remove-angle-brackets message-id))
11846 (setq cpltxt (org-email-link-description))
11847 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11848 "#" message-id))))
11850 ((or (equal major-mode 'mh-folder-mode)
11851 (equal major-mode 'mh-show-mode))
11852 (let ((from (org-mhe-get-header "From:"))
11853 (to (org-mhe-get-header "To:"))
11854 (message-id (org-mhe-get-header "Message-Id:"))
11855 (subject (org-mhe-get-header "Subject:")))
11856 (org-store-link-props :type "mh" :from from :to to
11857 :subject subject :message-id message-id)
11858 (setq cpltxt (org-email-link-description))
11859 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11860 (org-remove-angle-brackets message-id)))))
11862 ((eq major-mode 'rmail-mode)
11863 (save-excursion
11864 (save-restriction
11865 (rmail-narrow-to-non-pruned-header)
11866 (let ((folder buffer-file-name)
11867 (message-id (mail-fetch-field "message-id"))
11868 (from (mail-fetch-field "from"))
11869 (to (mail-fetch-field "to"))
11870 (subject (mail-fetch-field "subject")))
11871 (org-store-link-props
11872 :type "rmail" :from from :to to
11873 :subject subject :message-id message-id)
11874 (setq message-id (org-remove-angle-brackets message-id))
11875 (setq cpltxt (org-email-link-description))
11876 (setq link (org-make-link "rmail:" folder "#" message-id))))))
11878 ((eq major-mode 'gnus-group-mode)
11879 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
11880 (gnus-group-group-name)) ; version
11881 ((fboundp 'gnus-group-name)
11882 (gnus-group-name))
11883 (t "???"))))
11884 (unless group (error "Not on a group"))
11885 (org-store-link-props :type "gnus" :group group)
11886 (setq cpltxt (concat
11887 (if (org-xor arg org-usenet-links-prefer-google)
11888 "http://groups.google.com/groups?group="
11889 "gnus:")
11890 group)
11891 link (org-make-link cpltxt))))
11893 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
11894 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
11895 (let* ((group gnus-newsgroup-name)
11896 (article (gnus-summary-article-number))
11897 (header (gnus-summary-article-header article))
11898 (from (mail-header-from header))
11899 (message-id (mail-header-id header))
11900 (date (mail-header-date header))
11901 (subject (gnus-summary-subject-string)))
11902 (org-store-link-props :type "gnus" :from from :subject subject
11903 :message-id message-id :group group)
11904 (setq cpltxt (org-email-link-description))
11905 (if (org-xor arg org-usenet-links-prefer-google)
11906 (setq link
11907 (concat
11909 (format "http://groups.google.com/groups?as_umsgid=%s"
11910 (org-fixup-message-id-for-http message-id))))
11911 (setq link (org-make-link "gnus:" group
11912 "#" (number-to-string article))))))
11914 ((eq major-mode 'w3-mode)
11915 (setq cpltxt (url-view-url t)
11916 link (org-make-link cpltxt))
11917 (org-store-link-props :type "w3" :url (url-view-url t)))
11919 ((eq major-mode 'w3m-mode)
11920 (setq cpltxt (or w3m-current-title w3m-current-url)
11921 link (org-make-link w3m-current-url))
11922 (org-store-link-props :type "w3m" :url (url-view-url t)))
11924 ((setq search (run-hook-with-args-until-success
11925 'org-create-file-search-functions))
11926 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
11927 "::" search))
11928 (setq cpltxt (or description link)))
11930 ((eq major-mode 'image-mode)
11931 (setq cpltxt (concat "file:"
11932 (abbreviate-file-name buffer-file-name))
11933 link (org-make-link cpltxt))
11934 (org-store-link-props :type "image" :file buffer-file-name))
11936 ((eq major-mode 'dired-mode)
11937 ;; link to the file in the current line
11938 (setq cpltxt (concat "file:"
11939 (abbreviate-file-name
11940 (expand-file-name
11941 (dired-get-filename nil t))))
11942 link (org-make-link cpltxt)))
11944 ((and buffer-file-name (org-mode-p))
11945 ;; Just link to current headline
11946 (setq cpltxt (concat "file:"
11947 (abbreviate-file-name buffer-file-name)))
11948 ;; Add a context search string
11949 (when (org-xor org-context-in-file-links arg)
11950 ;; Check if we are on a target
11952 (setq cpltxt (concat cpltxt "::" (match-string 1)))
11953 (setq txt (cond
11954 ((org-on-heading-p) nil)
11955 ((org-region-active-p)
11956 (buffer-substring (region-beginning) (region-end)))
11957 (t (buffer-substring (point-at-bol) (point-at-eol)))))
11959 (setq cpltxt
11960 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11961 desc "NONE"))))
11963 (setq cpltxt (substring cpltxt 0 -2)))
11964 (setq link (org-make-link cpltxt)))
11966 ((buffer-file-name (buffer-base-buffer))
11967 ;; Just link to this file here.
11968 (setq cpltxt (concat "file:"
11969 (abbreviate-file-name
11970 (buffer-file-name (buffer-base-buffer)))))
11971 ;; Add a context string
11972 (when (org-xor org-context-in-file-links arg)
11973 (setq txt (if (org-region-active-p)
11974 (buffer-substring (region-beginning) (region-end))
11975 (buffer-substring (point-at-bol) (point-at-eol))))
11976 ;; Only use search option if there is some text.
11978 (setq cpltxt
11979 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11980 desc "NONE")))
11981 (setq link (org-make-link cpltxt)))
11983 ((interactive-p)
11984 (error "Cannot link to a buffer which is not visiting a file"))
11986 (t (setq link nil)))
11988 (if (consp link) (setq cpltxt (car link) link (cdr link)))
11989 (setq link (or link cpltxt)
11990 desc (or desc cpltxt))
11991 (if (equal desc "NONE") (setq desc nil))
11993 (if (and (interactive-p) link)
11994 (progn
11995 (setq org-stored-links
11996 (cons (list link desc) org-stored-links))
11997 (message "Stored: %s" (or desc link)))
11998 (and link (org-make-link-string link desc)))))
12000 (defun org-store-link-props (&rest plist)
12001 "Store link properties, extract names and addresses."
12002 (let (x adr)
12003 (when (setq x (plist-get plist :from))
12004 (setq adr (mail-extract-address-components x))
12005 (plist-put plist :fromname (car adr))
12006 (plist-put plist :fromaddress (nth 1 adr)))
12007 (when (setq x (plist-get plist :to))
12008 (setq adr (mail-extract-address-components x))
12009 (plist-put plist :toname (car adr))
12010 (plist-put plist :toaddress (nth 1 adr))))
12011 (let ((from (plist-get plist :from))
12012 (to (plist-get plist :to)))
12013 (when (and from to org-from-is-user-regexp)
12014 (plist-put plist :fromto
12015 (if (string-match org-from-is-user-regexp from)
12016 (concat "to %t")
12017 (concat "from %f")))))
12018 (setq org-store-link-plist plist))
12020 (defun org-email-link-description (&optional fmt)
12021 "Return the description part of an email link.
12022 This takes information from `org-store-link-plist' and formats it
12023 according to FMT (default from `org-email-link-description-format')."
12024 (setq fmt (or fmt org-email-link-description-format))
12025 (let* ((p org-store-link-plist)
12026 (to (plist-get p :toaddress))
12027 (from (plist-get p :fromaddress))
12028 (table
12029 (list
12030 (cons "%c" (plist-get p :fromto))
12031 (cons "%F" (plist-get p :from))
12032 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12033 (cons "%T" (plist-get p :to))
12034 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12035 (cons "%s" (plist-get p :subject))
12036 (cons "%m" (plist-get p :message-id)))))
12037 (when (string-match "%c" fmt)
12038 ;; Check if the user wrote this message
12039 (if (and org-from-is-user-regexp from to
12040 (save-match-data (string-match org-from-is-user-regexp from)))
12041 (setq fmt (replace-match "to %t" t t fmt))
12042 (setq fmt (replace-match "from %f" t t fmt))))
12043 (org-replace-escapes fmt table)))
12045 (defun org-make-org-heading-search-string (&optional string heading)
12046 "Make search string for STRING or current headline."
12047 (interactive)
12048 (let ((s (or string (org-get-heading))))
12049 (unless (and string (not heading))
12050 ;; We are using a headline, clean up garbage in there.
12051 (if (string-match org-todo-regexp s)
12052 (setq s (replace-match "" t t s)))
12054 (setq s (replace-match "" t t s)))
12055 (setq s (org-trim s))
12058 (setq s (replace-match "" t t s)))
12059 (while (string-match org-ts-regexp s)
12060 (setq s (replace-match "" t t s))))
12062 (setq s (replace-match " " t t s)))
12063 (or string (setq s (concat "*" s))) ; Add * for headlines
12066 (defun org-make-link (&rest strings)
12067 "Concatenate STRINGS."
12068 (apply 'concat strings))
12070 (defun org-make-link-string (link &optional description)
12071 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12073 (error "Empty link"))
12074 (when (stringp description)
12075 ;; Remove brackets from the description, they are fatal.
12077 (setq description (replace-match "{" t t description)))
12079 (setq description (replace-match "}" t t description))))
12080 (when (equal (org-link-escape link) description)
12081 ;; No description needed, it is identical
12082 (setq description nil))
12083 (when (and (not description)
12084 (not (equal link (org-link-escape link))))
12085 (setq description link))
12086 (concat "[[" (org-link-escape link) "]"
12087 (if description (concat "[" description "]") "")
12088 "]"))
12090 (defconst org-link-escape-chars
12091 '((?\ . "%20")
12092 (?\[ . "%5B")
12093 (?\] . "%5D")
12104 (?\; . "%3B")
12105 (?? . "%3F")
12106 (?= . "%3D")
12107 (?+ . "%2B")
12108 )
12109 "Association list of escapes for some characters problematic in links.
12110 This is the list that is used for internal purposes.")
12112 (defconst org-link-escape-chars-browser
12113 '((?\ . "%20")) ; 32 for the SPC char
12114 "Association list of escapes for some characters problematic in links.
12115 This is the list that is used before handing over to the browser.")
12117 (defun org-link-escape (text &optional table)
12118 "Escape charaters in TEXT that are problematic for links."
12119 (setq table (or table org-link-escape-chars))
12120 (when text
12121 (let ((re (mapconcat (lambda (x) (regexp-quote
12122 (char-to-string (car x))))
12124 (while (string-match re text)
12125 (setq text
12126 (replace-match
12127 (cdr (assoc (string-to-char (match-string 0 text))
12128 table))
12129 t t text)))
12130 text)))
12132 (defun org-link-unescape (text &optional table)
12133 "Reverse the action of `org-link-escape'."
12134 (setq table (or table org-link-escape-chars))
12135 (when text
12136 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12138 (while (string-match re text)
12139 (setq text
12140 (replace-match
12141 (char-to-string (car (rassoc (match-string 0 text) table)))
12142 t t text)))
12143 text)))
12145 (defun org-xor (a b)
12146 "Exclusive or."
12147 (if a (not b) b))
12149 (defun org-get-header (header)
12150 "Find a header field in the current buffer."
12151 (save-excursion
12152 (goto-char (point-min))
12153 (let ((case-fold-search t) s)
12154 (cond
12155 ((eq header 'from)
12157 (setq s (match-string 1)))
12159 (setq s (replace-match "" t t s)))
12160 (if (string-match "[<(].*" s)
12161 (setq s (replace-match "" t t s))))
12162 ((eq header 'message-id)
12164 (setq s (match-string 1))))
12165 ((eq header 'subject)
12167 (setq s (match-string 1)))))
12170 s)))
12173 (defun org-fixup-message-id-for-http (s)
12174 "Replace special characters in a message id, so it can be used in an http query."
12175 (while (string-match "<" s)
12176 (setq s (replace-match "%3C" t t s)))
12177 (while (string-match ">" s)
12178 (setq s (replace-match "%3E" t t s)))
12179 (while (string-match "@" s)
12180 (setq s (replace-match "%40" t t s)))
12181 s)
12183 ;;;###autoload
12184 (defun org-insert-link-global ()
12185 "Insert a link like Org-mode does.
12186 This command can be called in any mode to insert a link in Org-mode syntax."
12187 (interactive)
12188 (org-run-like-in-org-mode 'org-insert-link))
12190 (defun org-insert-link (&optional complete-file)
12191 "Insert a link. At the prompt, enter the link.
12193 Completion can be used to select a link previously stored with
12194 `org-store-link'. When the empty string is entered (i.e. if you just
12195 press RET at the prompt), the link defaults to the most recently
12196 stored link. As SPC triggers completion in the minibuffer, you need to
12197 use M-SPC or C-q SPC to force the insertion of a space character.
12199 You will also be prompted for a description, and if one is given, it will
12200 be displayed in the buffer instead of the link.
12202 If there is already a link at point, this command will allow you to edit link
12203 and description parts.
12206 selected using completion. The path to the file will be relative to
12207 the current directory if the file is in the current directory or a
12208 subdirectory. Otherwise, the link will be the absolute path as
12209 completed in the minibuffer (i.e. normally ~/path/to/file).
12212 is in the current directory or below.
12214 `org-keep-stored-link-after-insertion'."
12215 (interactive "P")
12216 (let* ((wcf (current-window-configuration))
12217 (region (if (org-region-active-p)
12218 (buffer-substring (region-beginning) (region-end))))
12219 (remove (and region (list (region-beginning) (region-end))))
12220 (desc region)
12221 tmphist ; byte-compile incorrectly complains about this
12222 link entry file)
12223 (cond
12224 ((org-in-regexp org-bracket-link-regexp 1)
12225 ;; We do have a link at point, and we are going to edit it.
12226 (setq remove (list (match-beginning 0) (match-end 0)))
12227 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12228 (setq link (read-string "Link: "
12229 (org-link-unescape
12230 (org-match-string-no-properties 1)))))
12231 ((or (org-in-regexp org-angle-link-re)
12232 (org-in-regexp org-plain-link-re))
12233 ;; Convert to bracket link
12234 (setq remove (list (match-beginning 0) (match-end 0))
12235 link (read-string "Link: "
12236 (org-remove-angle-brackets (match-string 0)))))
12237 ((equal complete-file '(4))
12238 ;; Completing read for file names.
12239 (setq file (read-file-name "File: "))
12240 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12241 (pwd1 (file-name-as-directory (abbreviate-file-name
12242 (expand-file-name ".")))))
12243 (cond
12244 ((equal complete-file '(16))
12245 (setq link (org-make-link
12246 "file:"
12247 (abbreviate-file-name (expand-file-name file)))))
12249 (setq link (org-make-link "file:" (match-string 1 file))))
12251 (expand-file-name file))
12252 (setq link (org-make-link
12253 "file:" (match-string 1 (expand-file-name file)))))
12254 (t (setq link (org-make-link "file:" file))))))
12255 (t
12256 ;; Read link, with completion for stored links.
12257 (with-output-to-temp-buffer "*Org Links*"
12259 (when org-stored-links
12261 (princ (mapconcat
12262 (lambda (x)
12263 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12265 (let ((cw (selected-window)))
12266 (select-window (get-buffer-window "*Org Links*"))
12267 (shrink-window-if-larger-than-buffer)
12268 (setq truncate-lines t)
12269 (select-window cw))
12270 ;; Fake a link history, containing the stored links.
12271 (setq tmphist (append (mapcar 'car org-stored-links)
12272 org-insert-link-history))
12273 (unwind-protect
12274 (setq link (org-completing-read
12275 "Link: "
12276 (append
12277 (mapcar (lambda (x) (list (concat (car x) ":")))
12278 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12279 (mapcar (lambda (x) (list (concat x ":")))
12280 org-link-types))
12281 nil nil nil
12282 'tmphist
12283 (or (car (car org-stored-links)))))
12284 (set-window-configuration wcf)
12285 (kill-buffer "*Org Links*"))
12286 (setq entry (assoc link org-stored-links))
12287 (or entry (push link org-insert-link-history))
12288 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12289 (not org-keep-stored-link-after-insertion))
12290 (setq org-stored-links (delq (assoc link org-stored-links)
12291 org-stored-links)))
12292 (setq desc (or desc (nth 1 entry)))))
12294 (if (string-match org-plain-link-re link)
12295 ;; URL-like link, normalize the use of angular brackets.
12296 (setq link (org-make-link (org-remove-angle-brackets link))))
12298 ;; Check if we are linking to the current file with a search option
12299 ;; If yes, simplify the link by using only the search option.
12300 (when (and buffer-file-name
12302 (let* ((path (match-string 1 link))
12303 (case-fold-search nil)
12304 (search (match-string 2 link)))
12305 (save-match-data
12306 (if (equal (file-truename buffer-file-name) (file-truename path))
12307 ;; We are linking to this same file, with a search option
12308 (setq link search)))))
12310 ;; Check if we can/should use a relative path. If yes, simplify the link
12312 (let* ((path (match-string 1 link))
12313 (origpath path)
12314 (desc-is-link (equal link desc))
12315 (case-fold-search nil))
12316 (cond
12317 ((eq org-link-file-path-type 'absolute)
12318 (setq path (abbreviate-file-name (expand-file-name path))))
12319 ((eq org-link-file-path-type 'noabbrev)
12320 (setq path (expand-file-name path)))
12321 ((eq org-link-file-path-type 'relative)
12322 (setq path (file-relative-name path)))
12323 (t
12324 (save-match-data
12325 (if (string-match (concat "^" (regexp-quote
12326 (file-name-as-directory
12327 (expand-file-name "."))))
12328 (expand-file-name path))
12329 ;; We are linking a file with relative path name.
12330 (setq path (substring (expand-file-name path)
12331 (match-end 0)))))))
12332 (setq link (concat "file:" path))
12333 (if (equal desc origpath)
12334 (setq desc path))))
12336 (setq desc (read-string "Description: " desc))
12338 (if remove (apply 'delete-region remove))
12339 (insert (org-make-link-string link desc))))
12341 (defun org-completing-read (&rest args)
12342 (let ((minibuffer-local-completion-map
12343 (copy-keymap minibuffer-local-completion-map)))
12344 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12345 (apply 'completing-read args)))
12347 ;;; Opening/following a link
12348 (defvar org-link-search-failed nil)
12350 (defun org-next-link ()
12351 "Move forward to the next link.
12352 If the link is in hidden text, expose it."
12353 (interactive)
12354 (when (and org-link-search-failed (eq this-command last-command))
12355 (goto-char (point-min))
12356 (message "Link search wrapped back to beginning of buffer"))
12357 (setq org-link-search-failed nil)
12358 (let* ((pos (point))
12359 (ct (org-context))
12360 (a (assoc :link ct)))
12361 (if a (goto-char (nth 2 a)))
12362 (if (re-search-forward org-any-link-re nil t)
12363 (progn
12364 (goto-char (match-beginning 0))
12365 (if (org-invisible-p) (org-show-context)))
12366 (goto-char pos)
12367 (setq org-link-search-failed t)
12368 (error "No further link found"))))
12370 (defun org-previous-link ()
12371 "Move backward to the previous link.
12372 If the link is in hidden text, expose it."
12373 (interactive)
12374 (when (and org-link-search-failed (eq this-command last-command))
12375 (goto-char (point-max))
12376 (message "Link search wrapped back to end of buffer"))
12377 (setq org-link-search-failed nil)
12378 (let* ((pos (point))
12379 (ct (org-context))
12380 (a (assoc :link ct)))
12381 (if a (goto-char (nth 1 a)))
12382 (if (re-search-backward org-any-link-re nil t)
12383 (progn
12384 (goto-char (match-beginning 0))
12385 (if (org-invisible-p) (org-show-context)))
12386 (goto-char pos)
12387 (setq org-link-search-failed t)
12388 (error "No further link found"))))
12390 (defun org-find-file-at-mouse (ev)
12391 "Open file link or URL at mouse."
12392 (interactive "e")
12393 (mouse-set-point ev)
12394 (org-open-at-point 'in-emacs))
12396 (defun org-open-at-mouse (ev)
12397 "Open file link or URL at mouse."
12398 (interactive "e")
12399 (mouse-set-point ev)
12400 (org-open-at-point))
12402 (defvar org-window-config-before-follow-link nil
12403 "The window configuration before following a link.
12404 This is saved in case the need arises to restore it.")
12406 (defvar org-open-link-marker (make-marker)
12407 "Marker pointing to the location where `org-open-at-point; was called.")
12409 ;;;###autoload
12410 (defun org-open-at-point-global ()
12411 "Follow a link like Org-mode does.
12412 This command can be called in any mode to follow a link that has
12413 Org-mode syntax."
12414 (interactive)
12415 (org-run-like-in-org-mode 'org-open-at-point))
12417 (defun org-open-at-point (&optional in-emacs)
12418 "Open link at or after point.
12419 If there is no link at point, this function will search forward up to
12420 the end of the current subtree.
12421 Normally, files will be opened by an appropriate application. If the
12422 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12423 (interactive "P")
12424 (catch 'abort
12425 (move-marker org-open-link-marker (point))
12426 (setq org-window-config-before-follow-link (current-window-configuration))
12427 (org-remove-occur-highlights nil nil t)
12428 (if (org-at-timestamp-p t)
12429 (org-follow-timestamp-link)
12430 (let (type path link line search (pos (point)))
12431 (catch 'match
12432 (save-excursion
12434 (when (org-in-regexp org-bracket-link-regexp)
12435 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12437 (setq link (replace-match " " t t link)))
12438 (setq link (org-link-expand-abbrev link))
12439 (if (string-match org-link-re-with-space2 link)
12440 (setq type (match-string 1 link) path (match-string 2 link))
12441 (setq type "thisfile" path link))
12442 (throw 'match t)))
12444 (when (get-text-property (point) 'org-linked-text)
12445 (setq type "thisfile"
12446 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12447 (1+ (point)) (point))
12448 path (buffer-substring
12449 (previous-single-property-change pos 'org-linked-text)
12450 (next-single-property-change pos 'org-linked-text)))
12451 (throw 'match t))
12453 (save-excursion
12454 (when (or (org-in-regexp org-angle-link-re)
12455 (org-in-regexp org-plain-link-re))
12456 (setq type (match-string 1) path (match-string 2))
12457 (throw 'match t)))
12459 (setq type "tree-match"
12460 path (match-string 1))
12461 (throw 'match t))
12462 (save-excursion
12464 (setq type "tags"
12465 path (match-string 1))
12466 (while (string-match ":" path)
12467 (setq path (replace-match "+" t t path)))
12468 (throw 'match t))))
12469 (unless path
12470 (error "No link found"))
12471 ;; Remove any trailing spaces in path
12473 (setq path (replace-match "" t t path)))
12475 (cond
12477 ((assoc type org-link-protocols)
12478 (funcall (nth 1 (assoc type org-link-protocols)) path))
12480 ((equal type "mailto")
12481 (let ((cmd (car org-link-mailto-program))
12482 (args (cdr org-link-mailto-program)) args1
12483 (address path) (subject "") a)
12485 (setq address (match-string 1 path)
12486 subject (org-link-escape (match-string 2 path))))
12487 (while args
12488 (cond
12489 ((not (stringp (car args))) (push (pop args) args1))
12490 (t (setq a (pop args))
12491 (if (string-match "%a" a)
12492 (setq a (replace-match address t t a)))
12493 (if (string-match "%s" a)
12494 (setq a (replace-match subject t t a)))
12495 (push a args1))))
12496 (apply cmd (nreverse args1))))
12498 ((member type '("http" "https" "ftp" "news"))
12499 (browse-url (concat type ":" (org-link-escape
12500 path org-link-escape-chars-browser))))
12502 ((member type '("message"))
12503 (browse-url (concat type ":" path)))
12505 ((string= type "tags")
12506 (org-tags-view in-emacs path))
12507 ((string= type "thisfile")
12508 (if in-emacs
12509 (switch-to-buffer-other-window
12510 (org-get-buffer-for-internal-link (current-buffer)))
12511 (org-mark-ring-push))
12512 (let ((cmd `(org-link-search
12513 ,path
12514 ,(cond ((equal in-emacs '(4)) 'occur)
12515 ((equal in-emacs '(16)) 'org-occur)
12516 (t nil))
12517 ,pos)))
12518 (condition-case nil (eval cmd)
12519 (error (progn (widen) (eval cmd))))))
12521 ((string= type "tree-match")
12524 ((string= type "file")
12526 (setq line (string-to-number (match-string 1 path))
12527 path (substring path 0 (match-beginning 0)))
12529 (setq search (match-string 1 path)
12530 path (substring path 0 (match-beginning 0)))))
12531 (if (string-match "[*?{]" (file-name-nondirectory path))
12532 (dired path)
12533 (org-open-file path in-emacs line search)))
12535 ((string= type "news")
12536 (org-follow-gnus-link path))
12538 ((string= type "bbdb")
12539 (org-follow-bbdb-link path))
12541 ((string= type "info")
12542 (org-follow-info-link path))
12544 ((string= type "gnus")
12545 (let (group article)
12547 (error "Error in Gnus link"))
12548 (setq group (match-string 1 path)
12549 article (match-string 3 path))
12550 (org-follow-gnus-link group article)))
12552 ((string= type "vm")
12553 (let (folder article)
12555 (error "Error in VM link"))
12556 (setq folder (match-string 1 path)
12557 article (match-string 3 path))
12558 ;; in-emacs is the prefix arg, will be interpreted as read-only
12559 (org-follow-vm-link folder article in-emacs)))
12561 ((string= type "wl")
12562 (let (folder article)
12564 (error "Error in Wanderlust link"))
12565 (setq folder (match-string 1 path)
12566 article (match-string 3 path))
12567 (org-follow-wl-link folder article)))
12569 ((string= type "mhe")
12570 (let (folder article)
12572 (error "Error in MHE link"))
12573 (setq folder (match-string 1 path)
12574 article (match-string 3 path))
12575 (org-follow-mhe-link folder article)))
12577 ((string= type "rmail")
12578 (let (folder article)
12580 (error "Error in RMAIL link"))
12581 (setq folder (match-string 1 path)
12582 article (match-string 3 path))
12583 (org-follow-rmail-link folder article)))
12585 ((string= type "shell")
12586 (let ((cmd path))
12587 (if (or (not org-confirm-shell-link-function)
12588 (funcall org-confirm-shell-link-function
12590 (org-add-props cmd nil
12591 'face 'org-warning))))
12592 (progn
12593 (message "Executing %s" cmd)
12594 (shell-command cmd))
12595 (error "Abort"))))
12597 ((string= type "elisp")
12598 (let ((cmd path))
12599 (if (or (not org-confirm-elisp-link-function)
12600 (funcall org-confirm-elisp-link-function
12602 (org-add-props cmd nil
12603 'face 'org-warning))))
12604 (message "%s => %s" cmd (eval (read cmd)))
12605 (error "Abort"))))
12607 (t
12608 (browse-url-at-point)))))
12609 (move-marker org-open-link-marker nil)))
12611 ;;; File search
12613 (defvar org-create-file-search-functions nil
12614 "List of functions to construct the right search string for a file link.
12615 These functions are called in turn with point at the location to
12616 which the link should point.
12618 A function in the hook should first test if it would like to
12619 handle this file type, for example by checking the major-mode or
12620 the file extension. If it decides not to handle this file, it
12621 should just return nil to give other functions a chance. If it
12622 does handle the file, it must return the search string to be used
12623 when following the link. The search string will be part of the
12624 file link, given after a double colon, and `org-open-at-point'
12625 will automatically search for it. If special measures must be
12626 taken to make the search successful, another function should be
12627 added to the companion hook `org-execute-file-search-functions',
12628 which see.
12630 A function in this hook may also use `setq' to set the variable
12631 `description' to provide a suggestion for the descriptive text to
12632 be used for this link when it gets inserted into an Org-mode
12635 (defvar org-execute-file-search-functions nil
12636 "List of functions to execute a file search triggered by a link.
12638 Functions added to this hook must accept a single argument, the
12639 search string that was part of the file link, the part after the
12640 double colon. The function must first check if it would like to
12641 handle this search, for example by checking the major-mode or the
12642 file extension. If it decides not to handle this search, it
12643 should just return nil to give other functions a chance. If it
12644 does handle the search, it must return a non-nil value to keep
12645 other functions from trying.
12647 Each function can access the current prefix argument through the
12648 variable `current-prefix-argument'. Note that a single prefix is
12649 used to force opening a link in Emacs, so it may be good to only
12650 use a numeric or double prefix to guide the search function.
12652 In case this is needed, a function in this hook can also restore
12653 the window configuration before `org-open-at-point' was called using:
12655 (set-window-configuration org-window-config-before-follow-link)")
12657 (defun org-link-search (s &optional type avoid-pos)
12658 "Search for a link search option.
12659 If S is surrounded by forward slashes, it is interpreted as a
12660 regular expression. In org-mode files, this will create an `org-occur'
12661 sparse tree. In ordinary files, `occur' will be used to list matches.
12662 If the current buffer is in `dired-mode', grep will be used to search
12663 in all files. If AVOID-POS is given, ignore matches near that position."
12664 (let ((case-fold-search t)
12668 org-emphasis-alist)
12670 (pos (point))
12671 (pre "") (post "")
12672 words re0 re1 re2 re3 re4 re5 re2a reall)
12673 (cond
12674 ;; First check if there are any special
12675 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12676 ;; Now try the builtin stuff
12677 ((save-excursion
12678 (goto-char (point-min))
12679 (and
12680 (re-search-forward
12681 (concat "<<" (regexp-quote s0) ">>") nil t)
12682 (setq pos (match-beginning 0))))
12683 ;; There is an exact target for this
12684 (goto-char pos))
12686 ;; A regular expression
12687 (cond
12688 ((org-mode-p)
12689 (org-occur (match-string 1 s)))
12690 ;;((eq major-mode 'dired-mode)
12691 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12692 (t (org-do-occur (match-string 1 s)))))
12693 (t
12694 ;; A normal search strings
12695 (when (equal (string-to-char s) ?*)
12696 ;; Anchor on headlines, post may include tags.
12699 s (substring s 1)))
12700 (remove-text-properties
12701 0 (length s)
12702 '(face nil mouse-face nil keymap nil fontified nil) s)
12703 ;; Make a series of regular expressions to find a match
12710 re1 (concat pre re2 post)
12711 re3 (concat pre re4 post)
12712 re5 (concat pre ".*" re4)
12713 re2 (concat pre re2)
12714 re2a (concat pre re2a)
12715 re4 (concat pre re4)
12719 ))
12720 (cond
12721 ((eq type 'org-occur) (org-occur reall))
12722 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12723 (t (goto-char (point-min))
12724 (if (or (org-search-not-self 1 re0 nil t)
12725 (org-search-not-self 1 re1 nil t)
12726 (org-search-not-self 1 re2 nil t)
12727 (org-search-not-self 1 re2a nil t)
12728 (org-search-not-self 1 re3 nil t)
12729 (org-search-not-self 1 re4 nil t)
12730 (org-search-not-self 1 re5 nil t)
12731 )
12732 (goto-char (match-beginning 1))
12733 (goto-char pos)
12734 (error "No match")))))
12735 (t
12736 ;; Normal string-search
12737 (goto-char (point-min))
12738 (if (search-forward s nil t)
12739 (goto-char (match-beginning 0))
12740 (error "No match"))))
12741 (and (org-mode-p) (org-show-context 'link-search))))
12743 (defun org-search-not-self (group &rest args)
12744 "Execute `re-search-forward', but only accept matches that do not
12745 enclose the position of `org-open-link-marker'."
12746 (let ((m org-open-link-marker))
12747 (catch 'exit
12748 (while (apply 're-search-forward args)
12749 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12750 (goto-char (match-end group))
12751 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12752 (> (match-beginning 0) (marker-position m))
12753 (< (match-end 0) (marker-position m)))
12754 (save-match-data
12755 (or (not (org-in-regexp
12756 org-bracket-link-analytic-regexp 1))
12757 (not (match-end 4)) ; no description
12758 (and (<= (match-beginning 4) (point))
12759 (>= (match-end 4) (point))))))
12760 (throw 'exit (point))))))))
12762 (defun org-get-buffer-for-internal-link (buffer)
12763 "Return a buffer to be used for displaying the link target of internal links."
12764 (cond
12765 ((not org-display-internal-link-with-indirect-buffer)
12766 buffer)
12767 ((string-match "(Clone)$" (buffer-name buffer))
12768 (message "Buffer is already a clone, not making another one")
12769 ;; we also do not modify visibility in this case
12770 buffer)
12771 (t ; make a new indirect buffer for displaying the link
12772 (let* ((bn (buffer-name buffer))
12773 (ibn (concat bn "(Clone)"))
12774 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12775 (with-current-buffer ib (org-overview))
12776 ib))))
12778 (defun org-do-occur (regexp &optional cleanup)
12779 "Call the Emacs command `occur'.
12780 If CLEANUP is non-nil, remove the printout of the regular expression
12781 in the *Occur* buffer. This is useful if the regex is long and not useful
12782 to read."
12783 (occur regexp)
12784 (when cleanup
12785 (let ((cwin (selected-window)) win beg end)
12786 (when (setq win (get-buffer-window "*Occur*"))
12787 (select-window win))
12788 (goto-char (point-min))
12789 (when (re-search-forward "match[a-z]+" nil t)
12790 (setq beg (match-end 0))
12792 (setq end (1- (match-beginning 0)))))
12793 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12794 (goto-char (point-min))
12795 (select-window cwin))))
12797 ;;; The mark ring for links jumps
12799 (defvar org-mark-ring nil
12800 "Mark ring for positions before jumps in Org-mode.")
12801 (defvar org-mark-ring-last-goto nil
12802 "Last position in the mark ring used to go back.")
12803 ;; Fill and close the ring
12804 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12805 (loop for i from 1 to org-mark-ring-length do
12806 (push (make-marker) org-mark-ring))
12807 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12808 org-mark-ring)
12810 (defun org-mark-ring-push (&optional pos buffer)
12811 "Put the current position or POS into the mark ring and rotate it."
12812 (interactive)
12813 (setq pos (or pos (point)))
12814 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12815 (move-marker (car org-mark-ring)
12816 (or pos (point))
12817 (or buffer (current-buffer)))
12818 (message "%s"
12819 (substitute-command-keys
12822 (defun org-mark-ring-goto (&optional n)
12823 "Jump to the previous position in the mark ring.
12824 With prefix arg N, jump back that many stored positions. When
12825 called several times in succession, walk through the entire ring.
12826 Org-mode commands jumping to a different position in the current file,
12827 or to another Org-mode file, automatically push the old position
12828 onto the ring."
12829 (interactive "p")
12830 (let (p m)
12831 (if (eq last-command this-command)
12832 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12833 (setq p org-mark-ring))
12834 (setq org-mark-ring-last-goto p)
12835 (setq m (car p))
12836 (switch-to-buffer (marker-buffer m))
12837 (goto-char m)
12838 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12840 (defun org-remove-angle-brackets (s)
12841 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12842 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12843 s)
12844 (defun org-add-angle-brackets (s)
12845 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12846 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12847 s)
12849 ;;; Following specific links
12851 (defun org-follow-timestamp-link ()
12852 (cond
12853 ((org-at-date-range-p t)
12854 (let ((org-agenda-start-on-weekday)
12855 (t1 (match-string 1))
12856 (t2 (match-string 2)))
12857 (setq t1 (time-to-days (org-time-string-to-time t1))
12858 t2 (time-to-days (org-time-string-to-time t2)))
12859 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12860 ((org-at-timestamp-p t)
12861 (org-agenda-list nil (time-to-days (org-time-string-to-time
12862 (substring (match-string 1) 0 10)))
12863 1))
12864 (t (error "This should not happen"))))
12867 (defun org-follow-bbdb-link (name)
12868 "Follow a BBDB link to NAME."
12869 (require 'bbdb)
12870 (let ((inhibit-redisplay (not debug-on-error))
12871 (bbdb-electric-p nil))
12872 (catch 'exit
12873 ;; Exact match on name
12875 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12876 ;; Exact match on name
12878 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12879 ;; Partial match on name
12880 (bbdb-name name nil)
12881 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12882 ;; Partial match on company
12883 (bbdb-company name nil)
12884 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12885 ;; General match including network address and notes
12886 (bbdb name nil)
12887 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
12888 (delete-window (get-buffer-window "*BBDB*"))
12889 (error "No matching BBDB record")))))
12891 (defun org-follow-info-link (name)
12892 "Follow an info file & node link to NAME."
12895 (progn
12896 (require 'info)
12897 (if (match-string 2 name) ; If there isn't a node, choose "Top"
12898 (Info-find-node (match-string 1 name) (match-string 2 name))
12899 (Info-find-node (match-string 1 name) "Top")))
12900 (message "Could not open: %s" name)))
12902 (defun org-follow-gnus-link (&optional group article)
12903 "Follow a Gnus link to GROUP and ARTICLE."
12904 (require 'gnus)
12905 (funcall (cdr (assq 'gnus org-link-frame-setup)))
12906 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
12907 (cond ((and group article)
12908 (gnus-group-read-group 1 nil group)
12909 (gnus-summary-goto-article (string-to-number article) nil t))
12910 (group (gnus-group-jump-to-group group))))
12912 (defun org-follow-vm-link (&optional folder article readonly)
12913 "Follow a VM link to FOLDER and ARTICLE."
12914 (require 'vm)
12915 (setq article (org-add-angle-brackets article))
12917 ;; ange-ftp or efs or tramp access
12918 (let ((user (or (match-string 1 folder) (user-login-name)))
12919 (host (match-string 2 folder))
12920 (file (match-string 3 folder)))
12921 (cond
12922 ((featurep 'tramp)
12923 ;; use tramp to access the file
12924 (if (featurep 'xemacs)
12925 (setq folder (format "[%s@%s]%s" user host file))
12926 (setq folder (format "/%s@%s:%s" user host file))))
12927 (t
12928 ;; use ange-ftp or efs
12929 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
12930 (setq folder (format "/%s@%s:%s" user host file))))))
12931 (when folder
12932 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
12933 (sit-for 0.1)
12934 (when article
12935 (vm-select-folder-buffer)
12936 (widen)
12937 (let ((case-fold-search t))
12938 (goto-char (point-min))
12939 (if (not (re-search-forward
12940 (concat "^" "message-id: *" (regexp-quote article))))
12941 (error "Could not find the specified message in this folder"))
12942 (vm-isearch-update)
12943 (vm-isearch-narrow)
12944 (vm-beginning-of-message)
12945 (vm-summarize)))))
12947 (defun org-follow-wl-link (folder article)
12948 "Follow a Wanderlust link to FOLDER and ARTICLE."
12949 (if (and (string= folder "%")
12950 article
12952 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
12953 ;; Thus, we recompose folder and article ids.
12954 (setq folder (format "%s#%s" folder (match-string 1 article))
12955 article (match-string 3 article)))
12956 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
12957 (error "No such folder: %s" folder))
12958 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
12959 (and article
12960 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
12961 (wl-summary-redisplay)))
12963 (defun org-follow-rmail-link (folder article)
12964 "Follow an RMAIL link to FOLDER and ARTICLE."
12965 (setq article (org-add-angle-brackets article))
12966 (let (message-number)
12967 (save-excursion
12968 (save-window-excursion
12969 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12970 (setq message-number
12971 (save-restriction
12972 (widen)
12973 (goto-char (point-max))
12974 (if (re-search-backward
12976 (or article "")))
12977 nil t)
12978 (rmail-what-message))))))
12979 (if message-number
12980 (progn
12981 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12982 (rmail-show-message message-number)
12983 message-number)
12984 (error "Message not found"))))
12986 ;;; mh-e integration based on planner-mode
12987 (defun org-mhe-get-message-real-folder ()
12988 "Return the name of the current message real folder, so if you use
12989 sequences, it will now work."
12990 (save-excursion
12991 (let* ((folder
12992 (if (equal major-mode 'mh-folder-mode)
12993 mh-current-folder
12994 ;; Refer to the show buffer
12995 mh-show-folder-buffer))
12996 (end-index
12997 (if (boundp 'mh-index-folder)
12998 (min (length mh-index-folder) (length folder))))
12999 )
13000 ;; a simple test on mh-index-data does not work, because
13001 ;; mh-index-data is always nil in a show buffer.
13002 (if (and (boundp 'mh-index-folder)
13003 (string= mh-index-folder (substring folder 0 end-index)))
13004 (if (equal major-mode 'mh-show-mode)
13005 (save-window-excursion
13006 (let (pop-up-frames)
13007 (when (buffer-live-p (get-buffer folder))
13008 (progn
13009 (pop-to-buffer folder)
13010 (org-mhe-get-message-folder-from-index)
13011 )
13012 )))
13013 (org-mhe-get-message-folder-from-index)
13014 )
13015 folder
13016 )
13017 )))
13019 (defun org-mhe-get-message-folder-from-index ()
13020 "Returns the name of the message folder in a index folder buffer."
13021 (save-excursion
13022 (mh-index-previous-folder)
13024 (message "%s" (match-string 1))))
13026 (defun org-mhe-get-message-folder ()
13027 "Return the name of the current message folder. Be careful if you
13028 use sequences."
13029 (save-excursion
13030 (if (equal major-mode 'mh-folder-mode)
13031 mh-current-folder
13032 ;; Refer to the show buffer
13033 mh-show-folder-buffer)))
13035 (defun org-mhe-get-message-num ()
13036 "Return the number of the current message. Be careful if you
13037 use sequences."
13038 (save-excursion
13039 (if (equal major-mode 'mh-folder-mode)
13040 (mh-get-msg-num nil)
13041 ;; Refer to the show buffer
13042 (mh-show-buffer-message-number))))
13044 (defun org-mhe-get-header (header)
13045 "Return a header of the message in folder mode. This will create a
13046 show buffer for the corresponding message. If you have a more clever
13047 idea..."
13048 (let* ((folder (org-mhe-get-message-folder))
13049 (num (org-mhe-get-message-num))
13050 (buffer (get-buffer-create (concat "show-" folder)))
13051 (header-field))
13052 (with-current-buffer buffer
13053 (mh-display-msg num folder)
13054 (if (equal major-mode 'mh-folder-mode)
13055 (mh-header-display)
13056 (mh-show-header-display))
13057 (set-buffer buffer)
13058 (setq header-field (mh-get-header-field header))
13059 (if (equal major-mode 'mh-folder-mode)
13060 (mh-show)
13061 (mh-show-show))
13062 header-field)))
13064 (defun org-follow-mhe-link (folder article)
13065 "Follow an MHE link to FOLDER and ARTICLE.
13066 If ARTICLE is nil FOLDER is shown. If the configuration variable
13067 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13068 ARTICLE is searched in all folders. Indexed searches (swish++,
13069 namazu, and others supported by MH-E) will always search in all
13070 folders."
13071 (require 'mh-e)
13072 (require 'mh-search)
13073 (require 'mh-utils)
13074 (mh-find-path)
13075 (if (not article)
13076 (mh-visit-folder (mh-normalize-folder-name folder))
13077 (setq article (org-add-angle-brackets article))
13078 (mh-search-choose)
13079 (if (equal mh-searcher 'pick)
13080 (progn
13081 (mh-search folder (list "--message-id" article))
13082 (when (and org-mhe-search-all-folders
13083 (not (org-mhe-get-message-real-folder)))
13084 (kill-this-buffer)
13085 (mh-search "+" (list "--message-id" article))))
13086 (mh-search "+" article))
13087 (if (org-mhe-get-message-real-folder)
13088 (mh-show-msg 1)
13089 (kill-this-buffer)
13090 (error "Message not found"))))
13092 ;;; BibTeX links
13094 ;; Use the custom search meachnism to construct and use search strings for
13095 ;; file links to BibTeX database entries.
13097 (defun org-create-file-search-in-bibtex ()
13098 "Create the search string and description for a BibTeX database entry."
13099 (when (eq major-mode 'bibtex-mode)
13100 ;; yes, we want to construct this search string.
13101 ;; Make a good description for this entry, using names, year and the title
13102 ;; Put it into the `description' variable which is dynamically scoped.
13103 (let ((bibtex-autokey-names 1)
13104 (bibtex-autokey-names-stretch 1)
13105 (bibtex-autokey-name-case-convert-function 'identity)
13106 (bibtex-autokey-name-separator " & ")
13107 (bibtex-autokey-additional-names " et al.")
13108 (bibtex-autokey-year-length 4)
13109 (bibtex-autokey-name-year-separator " ")
13110 (bibtex-autokey-titlewords 3)
13111 (bibtex-autokey-titleword-separator " ")
13112 (bibtex-autokey-titleword-case-convert-function 'identity)
13113 (bibtex-autokey-titleword-length 'infty)
13114 (bibtex-autokey-year-title-separator ": "))
13115 (setq description (bibtex-generate-autokey)))
13116 ;; Now parse the entry, get the key and return it.
13117 (save-excursion
13118 (bibtex-beginning-of-entry)
13119 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13121 (defun org-execute-file-search-in-bibtex (s)
13122 "Find the link search string S as a key for a database entry."
13123 (when (eq major-mode 'bibtex-mode)
13124 ;; Yes, we want to do the search in this file.
13125 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13126 (goto-char (point-min))
13129 (goto-char (match-beginning 0)))
13130 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13131 ;; Use double prefix to indicate that any web link should be browsed
13132 (let ((b (current-buffer)) (p (point)))
13133 ;; Restore the window configuration because we just use the web link
13134 (set-window-configuration org-window-config-before-follow-link)
13135 (save-excursion (set-buffer b) (goto-char p)
13136 (bibtex-url)))
13137 (recenter 0)) ; Move entry start to beginning of window
13138 ;; return t to indicate that the search is done.
13139 t))
13141 ;; Finally add the functions to the right hooks.
13142 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13143 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13145 ;; end of Bibtex link setup
13147 ;;; Following file links
13149 (defun org-open-file (path &optional in-emacs line search)
13150 "Open the file at PATH.
13151 First, this expands any special file name abbreviations. Then the
13152 configuration variable `org-file-apps' is checked if it contains an
13153 entry for this file type, and if yes, the corresponding command is launched.
13154 If no application is found, Emacs simply visits the file.
13155 With optional argument IN-EMACS, Emacs will visit the file.
13156 Optional LINE specifies a line to go to, optional SEARCH a string to
13157 search for. If LINE or SEARCH is given, the file will always be
13158 opened in Emacs.
13159 If the file does not exist, an error is thrown."
13160 (setq in-emacs (or in-emacs line search))
13161 (let* ((file (if (equal path "")
13162 buffer-file-name
13163 (substitute-in-file-name (expand-file-name path))))
13164 (apps (append org-file-apps (org-default-apps)))
13165 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13166 (dirp (if remp nil (file-directory-p file)))
13167 (dfile (downcase file))
13168 (old-buffer (current-buffer))
13169 (old-pos (point))
13170 (old-mode major-mode)
13171 ext cmd)
13173 (setq ext (match-string 1 dfile))
13175 (setq ext (match-string 1 dfile))))
13176 (if in-emacs
13177 (setq cmd 'emacs)
13178 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13179 (and dirp (cdr (assoc 'directory apps)))
13180 (cdr (assoc ext apps))
13181 (cdr (assoc t apps)))))
13182 (when (eq cmd 'mailcap)
13183 (require 'mailcap)
13184 (mailcap-parse-mailcaps)
13185 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13186 (command (mailcap-mime-info mime-type)))
13187 (if (stringp command)
13188 (setq cmd command)
13189 (setq cmd 'emacs))))
13190 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13191 (not (file-exists-p file))
13192 (not org-open-non-existing-files))
13193 (error "No such file: %s" file))
13194 (cond
13196 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13198 (setq cmd (replace-match "%s" t t cmd)))
13199 (while (string-match "%s" cmd)
13200 (setq cmd (replace-match (shell-quote-argument file) t t cmd)))
13201 (save-window-excursion
13202 (start-process-shell-command cmd nil cmd)))
13203 ((or (stringp cmd)
13204 (eq cmd 'emacs))
13205 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13206 (widen)
13207 (if line (goto-line line)
13208 (if search (org-link-search search))))
13209 ((consp cmd)
13210 (eval cmd))
13211 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13212 (and (org-mode-p) (eq old-mode 'org-mode)
13213 (or (not (equal old-buffer (current-buffer)))
13214 (not (equal old-pos (point))))
13215 (org-mark-ring-push old-pos old-buffer))))
13217 (defun org-default-apps ()
13218 "Return the default applications for this operating system."
13219 (cond
13220 ((eq system-type 'darwin)
13221 org-file-apps-defaults-macosx)
13222 ((eq system-type 'windows-nt)
13223 org-file-apps-defaults-windowsnt)
13224 (t org-file-apps-defaults-gnu)))
13226 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13227 (defun org-file-remote-p (file)
13228 "Test whether FILE specifies a location on a remote system.
13229 Return non-nil if the location is indeed remote.
13233 (cond ((fboundp 'file-remote-p)
13234 (file-remote-p file))
13235 ((fboundp 'tramp-handle-file-remote-p)
13236 (tramp-handle-file-remote-p file))
13237 ((and (boundp 'ange-ftp-name-format)
13238 (string-match (car ange-ftp-name-format) file))
13239 t)
13240 (t nil)))
13243 ;;;; Hooks for remember.el, and refiling
13245 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13246 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13248 ;;;###autoload
13249 (defun org-remember-insinuate ()
13250 "Setup remember.el for use wiht Org-mode."
13251 (require 'remember)
13252 (setq remember-annotation-functions '(org-remember-annotation))
13253 (setq remember-handler-functions '(org-remember-handler))
13254 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13256 ;;;###autoload
13257 (defun org-remember-annotation ()
13258 "Return a link to the current location as an annotation for remember.el.
13259 If you are using Org-mode files as target for data storage with
13260 remember.el, then the annotations should include a link compatible with the
13261 conventions in Org-mode. This function returns such a link."
13262 (org-store-link nil))
13264 (defconst org-remember-help
13265 "Select a destination location for the note.
13266 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13267 RET on headline -> Store as sublevel entry to current headline
13268 RET at beg-of-buf -> Append to file as level 2 headline
13269 <left>/<right> -> before/after current headline, same headings level")
13271 (defvar org-remember-previous-location nil)
13272 (defvar org-force-remember-template-char) ;; dynamically scoped
13274 (defun org-select-remember-template (&optional use-char)
13275 (when org-remember-templates
13276 (let* ((templates (mapcar (lambda (x)
13277 (if (stringp (car x))
13278 (append (list (nth 1 x) (car x)) (cddr x))
13279 (append (list (car x) "") (cdr x))))
13280 org-remember-templates))
13281 (char (or use-char
13282 (cond
13283 ((= (length templates) 1)
13284 (caar templates))
13285 ((and (boundp 'org-force-remember-template-char)
13286 org-force-remember-template-char)
13287 (if (stringp org-force-remember-template-char)
13288 (string-to-char org-force-remember-template-char)
13289 org-force-remember-template-char))
13290 (t
13291 (message "Select template: %s"
13292 (mapconcat
13293 (lambda (x)
13294 (cond
13296 (format "[%c]" (car x)))
13297 ((equal (downcase (car x))
13298 (downcase (aref (nth 1 x) 0)))
13299 (format "[%c]%s" (car x)
13300 (substring (nth 1 x) 1)))
13301 (t (format "[%c]%s" (car x) (nth 1 x)))))
13302 templates " "))
13303 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13304 (when (equal char0 ?\C-g)
13305 (jump-to-register remember-register)
13306 (kill-buffer remember-buffer))
13307 char0))))))
13308 (cddr (assoc char templates)))))
13310 (defvar x-last-selected-text)
13311 (defvar x-last-selected-text-primary)
13313 ;;;###autoload
13314 (defun org-remember-apply-template (&optional use-char skip-interactive)
13315 "Initialize *remember* buffer with template, invoke `org-mode'.
13316 This function should be placed into `remember-mode-hook' and in fact requires
13317 to be run from that hook to function properly."
13318 (unless (fboundp 'remember-finalize)
13319 (defalias 'remember-finalize 'remember-buffer))
13320 (if org-remember-templates
13321 (let* ((entry (org-select-remember-template use-char))
13322 (tpl (car entry))
13323 (plist-p (if org-store-link-plist t nil))
13324 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13326 (nth 1 entry)
13327 org-default-notes-file))
13328 (headline (nth 2 entry))
13329 (v-c (or (and (eq window-system 'x)
13330 (fboundp 'x-cut-buffer-or-selection-value)
13331 (x-cut-buffer-or-selection-value))
13332 (org-bound-and-true-p x-last-selected-text)
13333 (org-bound-and-true-p x-last-selected-text-primary)
13334 (and (> (length kill-ring) 0) (current-kill 0))))
13335 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13336 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13337 (v-u (concat "[" (substring v-t 1 -1) "]"))
13338 (v-U (concat "[" (substring v-T 1 -1) "]"))
13339 ;; `initial' and `annotation' are bound in `remember'
13340 (v-i (if (boundp 'initial) initial))
13341 (v-a (if (and (boundp 'annotation) annotation)
13342 (if (equal annotation "[[]]") "" annotation)
13343 ""))
13344 (v-A (if (and v-a
13347 v-a))
13348 (v-n user-full-name)
13349 (org-startup-folded nil)
13350 org-time-was-given org-end-time-was-given x
13351 prompt completions char time pos default histvar)
13352 (setq org-store-link-plist
13353 (append (list :annotation v-a :initial v-i)
13354 org-store-link-plist))
13355 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13356 (erase-buffer)
13357 (insert (substitute-command-keys
13358 (format
13359 "## Filing location: Select interactively, default, or last used:
13360 ## %s to select file and header location interactively.
13364 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13365 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13366 (abbreviate-file-name (or file org-default-notes-file))
13367 (or headline "")
13368 (or (car org-remember-previous-location) "???")
13369 (or (cdr org-remember-previous-location) "???"))))
13370 (insert tpl) (goto-char (point-min))
13371 ;; Simple %-escapes
13373 (when (and initial (equal (match-string 0) "%i"))
13374 (save-match-data
13375 (let* ((lead (buffer-substring
13376 (point-at-bol) (match-beginning 0))))
13377 (setq v-i (mapconcat 'identity
13380 (replace-match
13381 (or (eval (intern (concat "v-" (match-string 1)))) "")
13382 t t))
13384 ;; %[] Insert contents of a file.
13385 (goto-char (point-min))
13387 (let ((start (match-beginning 0))
13388 (end (match-end 0))
13389 (filename (expand-file-name (match-string 1))))
13390 (goto-char start)
13391 (delete-region start end)
13392 (condition-case error
13393 (insert-file-contents filename)
13394 (error (insert (format "%%![Couldn't insert %s: %s]"
13395 filename error))))))
13396 ;; %() embedded elisp
13397 (goto-char (point-min))
13399 (goto-char (match-beginning 0))
13400 (let ((template-start (point)))
13401 (forward-char 1)
13402 (let ((result
13403 (condition-case error
13404 (eval (read (current-buffer)))
13405 (error (format "%%![Error: %s]" error)))))
13406 (delete-region template-start (point))
13407 (insert result))))
13409 ;; From the property list
13410 (when plist-p
13411 (goto-char (point-min))
13413 (and (setq x (or (plist-get org-store-link-plist
13414 (intern (match-string 1))) ""))
13415 (replace-match x t t))))
13417 ;; Turn on org-mode in the remember buffer, set local variables
13418 (org-mode)
13419 (org-set-local 'org-finish-function 'remember-finalize)
13421 (org-set-local 'org-default-notes-file file))
13423 (org-set-local 'org-remember-default-headline headline))
13424 ;; Interactive template entries
13425 (goto-char (point-min))
13427 (setq char (if (match-end 3) (match-string 3))
13428 prompt (if (match-end 2) (match-string 2)))
13429 (goto-char (match-beginning 0))
13430 (replace-match "")
13431 (setq completions nil default nil)
13432 (when prompt
13433 (setq completions (org-split-string prompt "|")
13434 prompt (pop completions)
13435 default (car completions)
13436 histvar (intern (concat
13437 "org-remember-template-prompt-history::"
13438 (or prompt "")))
13439 completions (mapcar 'list completions)))
13440 (cond
13441 ((member char '("G" "g"))
13442 (let* ((org-last-tags-completion-table
13443 (org-global-tags-completion-table
13444 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13445 (org-add-colon-after-tag-completion t)
13446 (ins (completing-read
13447 (if prompt (concat prompt ": ") "Tags: ")
13448 'org-tags-completion-function nil nil nil
13449 'org-tags-history)))
13450 (setq ins (mapconcat 'identity
13451 (org-split-string ins (org-re "[^[:alnum:]]+"))
13452 ":"))
13454 (or (equal (char-before) ?:) (insert ":"))
13455 (insert ins)
13456 (or (equal (char-after) ?:) (insert ":")))))
13457 (char
13458 (setq org-time-was-given (equal (upcase char) char))
13459 (setq time (org-read-date (equal (upcase char) "U") t nil
13460 prompt))
13461 (org-insert-time-stamp time org-time-was-given
13462 (member char '("u" "U"))
13463 nil nil (list org-end-time-was-given)))
13464 (t
13465 (insert (org-completing-read
13466 (concat (if prompt prompt "Enter string")
13467 (if default (concat " [" default "]"))
13468 ": ")
13469 completions nil nil nil histvar default)))))
13470 (goto-char (point-min))
13472 (replace-match "")
13474 (org-mode)
13475 (org-set-local 'org-finish-function 'remember-finalize))
13476 (when (save-excursion
13477 (goto-char (point-min))
13478 (re-search-forward "%!" nil t))
13479 (replace-match "")
13480 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13482 (defun org-remember-finish-immediately ()
13483 "File remember note immediately.
13484 This should be run in `post-command-hook' and will remove itself
13485 from that hook."
13486 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13487 (when org-finish-function
13488 (funcall org-finish-function)))
13491 ;;;###autoload
13492 (defun org-remember (&optional goto org-force-remember-template-char)
13493 "Call `remember'. If this is already a remember buffer, re-apply template.
13494 If there is an active region, make sure remember uses it as initial content
13495 of the remember buffer.
13497 When called interactively with a `C-u' prefix argument GOTO, don't remember
13498 anything, just go to the file/headline where the selected template usually
13499 stores its notes. With a double prefix arg `C-u C-u', go to the last
13500 note stored by remember.
13502 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13503 associated with a template in `org-remember-templates'."
13504 (interactive "P")
13505 (cond
13506 ((equal goto '(4)) (org-go-to-remember-target))
13507 ((equal goto '(16)) (org-remember-goto-last-stored))
13508 (t
13509 (if (memq org-finish-function '(remember-buffer remember-finalize))
13510 (progn
13511 (when (< (length org-remember-templates) 2)
13512 (error "No other template available"))
13513 (erase-buffer)
13514 (let ((annotation (plist-get org-store-link-plist :annotation))
13515 (initial (plist-get org-store-link-plist :initial)))
13516 (org-remember-apply-template))
13517 (message "Press C-c C-c to remember data"))
13518 (if (org-region-active-p)
13519 (remember (buffer-substring (point) (mark)))
13520 (call-interactively 'remember))))))
13522 (defun org-remember-goto-last-stored ()
13523 "Go to the location where the last remember note was stored."
13524 (interactive)
13525 (bookmark-jump "org-remember-last-stored")
13526 (message "This is the last note stored by remember"))
13528 (defun org-go-to-remember-target (&optional template-key)
13529 "Go to the target location of a remember template.
13530 The user is queried for the template."
13531 (interactive)
13532 (let* ((entry (org-select-remember-template template-key))
13533 (file (nth 1 entry))
13534 (heading (nth 2 entry))
13535 visiting)
13537 (setq file org-default-notes-file))
13539 (setq heading org-remember-default-headline))
13540 (setq visiting (org-find-base-buffer-visiting file))
13541 (if (not visiting) (find-file-noselect file))
13542 (switch-to-buffer (or visiting (get-file-buffer file)))
13543 (widen)
13544 (goto-char (point-min))
13545 (if (re-search-forward
13548 nil t)
13549 (goto-char (match-beginning 0))
13550 (error "Target headline not found: %s" heading))))
13552 (defvar org-note-abort nil) ; dynamically scoped
13554 ;;;###autoload
13555 (defun org-remember-handler ()
13556 "Store stuff from remember.el into an org file.
13557 First prompts for an org file. If the user just presses return, the value
13558 of `org-default-notes-file' is used.
13559 Then the command offers the headings tree of the selected file in order to
13560 file the text at a specific location.
13561 You can either immediately press RET to get the note appended to the
13562 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13563 find a better place. Then press RET or <left> or <right> in insert the note.
13565 Key Cursor position Note gets inserted
13566 -----------------------------------------------------------------------------
13567 RET buffer-start as level 1 heading at end of file
13568 RET on headline as sublevel of the heading at cursor
13569 RET no heading at cursor position, level taken from context.
13570 Or use prefix arg to specify level manually.
13571 <left> on headline as same level, before current heading
13572 <right> on headline as same level, after current heading
13574 So the fastest way to store the note is to press RET RET to append it to
13575 the default file. This way your current train of thought is not
13576 interrupted, in accordance with the principles of remember.el.
13577 You can also get the fast execution without prompting by using
13578 C-u C-c C-c to exit the remember buffer. See also the variable
13579 `org-remember-store-without-prompt'.
13581 Before being stored away, the function ensures that the text has a
13583 is constructed from the current date and some additional data.
13585 If the variable `org-adapt-indentation' is non-nil, the entire text is
13586 also indented so that it starts in the same column as the headline
13587 \(i.e. after the stars).
13589 See also the variable `org-reverse-note-order'."
13590 (goto-char (point-min))
13592 (replace-match ""))
13593 (goto-char (point-max))
13594 (beginning-of-line 1)
13596 (delete-region (1- (point)) (point-max))
13597 (beginning-of-line 1))
13598 (catch 'quit
13599 (if org-note-abort (throw 'quit nil))
13600 (let* ((txt (buffer-substring (point-min) (point-max)))
13601 (fastp (org-xor (equal current-prefix-arg '(4))
13602 org-remember-store-without-prompt))
13603 (file (cond
13604 (fastp org-default-notes-file)
13605 ((and org-remember-use-refile-when-interactive
13606 org-refile-targets)
13607 org-default-notes-file)
13608 (t (org-get-org-file))))
13609 (heading org-remember-default-headline)
13610 (visiting (and file (org-find-base-buffer-visiting file)))
13611 (org-startup-folded nil)
13612 (org-startup-align-all-tables nil)
13613 (org-goto-start-pos 1)
13614 spos exitcmd level indent reversed)
13615 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13616 (setq file (car org-remember-previous-location)
13617 heading (cdr org-remember-previous-location)
13618 fastp t))
13619 (setq current-prefix-arg nil)
13621 (setq txt (replace-match "" t t txt)))
13622 ;; Modify text so that it becomes a nice subtree which can be inserted
13623 ;; into an org tree.
13625 first)
13626 (setq first (car lines) lines (cdr lines))
13628 ;; Is already a headline
13629 (setq indent nil)
13630 ;; We need to add a headline: Use time and first buffer line
13631 (setq lines (cons first lines)
13632 first (concat "* " (current-time-string)
13633 " (" (remember-buffer-desc) ")")
13634 indent " "))
13635 (if (and org-adapt-indentation indent)
13636 (setq lines (mapcar
13637 (lambda (x)
13639 (concat indent x) x))
13640 lines)))
13647 ;; Put the modified text back into the remember buffer, for refile.
13648 (erase-buffer)
13649 (insert txt)
13650 (goto-char (point-min))
13651 (when (and org-remember-use-refile-when-interactive
13652 (not fastp))
13653 (org-refile nil (or visiting (find-file-noselect file)))
13654 (throw 'quit t))
13655 ;; Find the file
13656 (if (not visiting) (find-file-noselect file))
13657 (with-current-buffer (or visiting (get-file-buffer file))
13658 (unless (org-mode-p)
13659 (error "Target files for remember notes must be in Org-mode"))
13660 (save-excursion
13661 (save-restriction
13662 (widen)
13663 (and (goto-char (point-min))
13666 (setq reversed (org-notes-order-reversed-p))
13668 ;; Find the default location
13670 (goto-char (point-min))
13671 (if (re-search-forward
13674 nil t)
13675 (setq org-goto-start-pos (match-beginning 0))
13676 (when fastp
13677 (goto-char (point-max))
13678 (unless (bolp) (newline))
13680 (setq org-goto-start-pos (point-at-bol 0)))))
13682 ;; Ask the User for a location
13683 (if fastp
13684 (setq spos org-goto-start-pos
13685 exitcmd 'return)
13686 (setq spos (org-get-location (current-buffer) org-remember-help)
13687 exitcmd (cdr spos)
13688 spos (car spos)))
13689 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13690 ; not handle this note
13691 (goto-char spos)
13692 (cond ((org-on-heading-p t)
13693 (org-back-to-heading t)
13694 (setq level (funcall outline-level))
13695 (cond
13696 ((eq exitcmd 'return)
13697 ;; sublevel of current
13698 (setq org-remember-previous-location
13699 (cons (abbreviate-file-name file)
13700 (org-get-heading 'notags)))
13701 (if reversed
13702 (outline-next-heading)
13703 (org-end-of-subtree t)
13704 (if (not (bolp))
13706 (beginning-of-line 2)
13707 (end-of-line 1)
13709 (bookmark-set "org-remember-last-stored")
13710 (org-paste-subtree (org-get-valid-level level 1) txt))
13711 ((eq exitcmd 'left)
13712 ;; before current
13713 (bookmark-set "org-remember-last-stored")
13714 (org-paste-subtree level txt))
13715 ((eq exitcmd 'right)
13716 ;; after current
13717 (org-end-of-subtree t)
13718 (bookmark-set "org-remember-last-stored")
13719 (org-paste-subtree level txt))
13720 (t (error "This should not happen"))))
13722 ((and (bobp) (not reversed))
13723 ;; Put it at the end, one level below level 1
13724 (save-restriction
13725 (widen)
13726 (goto-char (point-max))
13727 (if (not (bolp)) (newline))
13728 (bookmark-set "org-remember-last-stored")
13729 (org-paste-subtree (org-get-valid-level 1 1) txt)))
13731 ((and (bobp) reversed)
13732 ;; Put it at the start, as level 1
13733 (save-restriction
13734 (widen)
13735 (goto-char (point-min))
13737 (beginning-of-line 1)
13738 (bookmark-set "org-remember-last-stored")
13739 (org-paste-subtree 1 txt)))
13740 (t
13741 ;; Put it right there, with automatic level determined by
13742 ;; org-paste-subtree or from prefix arg
13743 (bookmark-set "org-remember-last-stored")
13744 (org-paste-subtree
13745 (if (numberp current-prefix-arg) current-prefix-arg)
13746 txt)))
13747 (when remember-save-after-remembering
13748 (save-buffer)
13749 (if (not visiting) (kill-buffer (current-buffer)))))))))
13751 t) ;; return t to indicate that we took care of this note.
13753 (defun org-get-org-file ()
13754 "Read a filename, with default directory `org-directory'."
13755 (let ((default (or org-default-notes-file remember-data-file)))
13756 (read-file-name (format "File name [%s]: " default)
13757 (file-name-as-directory org-directory)
13758 default)))
13760 (defun org-notes-order-reversed-p ()
13761 "Check if the current file should receive notes in reversed order."
13762 (cond
13763 ((not org-reverse-note-order) nil)
13764 ((eq t org-reverse-note-order) t)
13765 ((not (listp org-reverse-note-order)) nil)
13766 (t (catch 'exit
13767 (let ((all org-reverse-note-order)
13768 entry)
13769 (while (setq entry (pop all))
13770 (if (string-match (car entry) buffer-file-name)
13771 (throw 'exit (cdr entry))))
13772 nil)))))
13774 ;;; Refiling
13776 (defvar org-refile-target-table nil
13777 "The list of refile targets, created by `org-refile'.")
13779 (defvar org-agenda-new-buffers nil
13780 "Buffers created to visit agenda files.")
13782 (defun org-get-refile-targets (&optional default-buffer)
13783 "Produce a table with refile targets."
13784 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13785 org-agenda-new-buffers targets txt re files f desc descre)
13786 (with-current-buffer (or default-buffer (current-buffer))
13787 (while (setq entry (pop entries))
13788 (setq files (car entry) desc (cdr entry))
13789 (cond
13790 ((null files) (setq files (list (current-buffer))))
13791 ((eq files 'org-agenda-files)
13792 (setq files (org-agenda-files 'unrestricted)))
13793 ((and (symbolp files) (fboundp files))
13794 (setq files (funcall files)))
13795 ((and (symbolp files) (boundp files))
13796 (setq files (symbol-value files))))
13797 (if (stringp files) (setq files (list files)))
13798 (cond
13799 ((eq (car desc) :tag)
13801 ((eq (car desc) :todo)
13803 ((eq (car desc) :regexp)
13804 (setq descre (cdr desc)))
13805 ((eq (car desc) :level)
13807 (if org-odd-levels-only
13808 (1- (* 2 (cdr desc)))
13809 (cdr desc)))
13811 ((eq (car desc) :maxlevel)
13813 (if org-odd-levels-only
13814 (1- (* 2 (cdr desc)))
13815 (cdr desc)))
13817 (t (error "Bad refiling target description %s" desc)))
13818 (while (setq f (pop files))
13819 (save-excursion
13820 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13821 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13822 (save-excursion
13823 (save-restriction
13824 (widen)
13825 (goto-char (point-min))
13826 (while (re-search-forward descre nil t)
13827 (goto-char (point-at-bol))
13828 (when (looking-at org-complex-heading-regexp)
13829 (setq txt (match-string 4)
13830 re (concat "^" (regexp-quote
13831 (buffer-substring (match-beginning 1)
13832 (match-end 4)))))
13834 (regexp-quote
13835 (match-string 5)))))
13837 (when org-refile-use-outline-path
13838 (setq txt (mapconcat 'identity
13839 (append
13840 (if (eq org-refile-use-outline-path 'file)
13841 (list (file-name-nondirectory
13842 (buffer-file-name (buffer-base-buffer))))
13843 (if (eq org-refile-use-outline-path 'full-file-path)
13844 (list (buffer-file-name (buffer-base-buffer)))))
13845 (org-get-outline-path)
13846 (list txt))
13847 "/")))
13848 (push (list txt f re (point)) targets))
13849 (goto-char (point-at-eol))))))))
13850 (org-release-buffers org-agenda-new-buffers)
13851 (nreverse targets))))
13853 (defun org-get-outline-path ()
13854 (let (rtn)
13855 (save-excursion
13856 (while (org-up-heading-safe)
13857 (when (looking-at org-complex-heading-regexp)
13858 (push (org-match-string-no-properties 4) rtn)))
13859 rtn)))
13861 (defvar org-refile-history nil
13862 "History for refiling operations.")
13864 (defun org-refile (&optional reversed-or-update default-buffer)
13865 "Move the entry at point to another heading.
13866 The list of target headings is compiled using the information in
13867 `org-refile-targets', which see. This list is created upon first use, and
13868 you can update it by calling this command with a double prefix (`C-u C-u').
13869 FIXME: Can we find a better way of updating?
13871 At the target location, the entry is filed as a subitem of the target heading.
13872 Depending on `org-reverse-note-order', the new subitem will either be the
13873 first of the last subitem. A single C-u prefix will toggle the value of this
13874 variable for the duration of the command."
13875 (interactive "P")
13876 (if (equal reversed-or-update '(16))
13877 (progn
13878 (setq org-refile-target-table (org-get-refile-targets default-buffer))
13879 (message "Refile targets updated (%d targets)"
13880 (length org-refile-target-table)))
13881 (when (or (not org-refile-target-table)
13882 (assq nil org-refile-targets))
13883 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
13884 (unless org-refile-target-table
13885 (error "No refile targets"))
13886 (let* ((cbuf (current-buffer))
13887 (filename (buffer-file-name (buffer-base-buffer cbuf)))
13888 (fname (and filename (file-truename filename)))
13889 (tbl (mapcar
13890 (lambda (x)
13891 (if (not (equal fname (file-truename (nth 1 x))))
13892 (cons (concat (car x) " (" (file-name-nondirectory
13893 (nth 1 x)) ")")
13894 (cdr x))
13895 x))
13896 org-refile-target-table))
13897 (completion-ignore-case t)
13898 pos it nbuf file re level reversed)
13899 (when (setq it (completing-read "Refile to: " tbl
13900 nil t nil 'org-refile-history))
13901 (setq it (assoc it tbl)
13902 file (nth 1 it)
13903 re (nth 2 it))
13904 (org-copy-special)
13905 (save-excursion
13906 (set-buffer (setq nbuf (or (find-buffer-visiting file)
13907 (find-file-noselect file))))
13908 (setq reversed (org-notes-order-reversed-p))
13909 (if (equal reversed-or-update '(16)) (setq reversed (not reversed)))
13910 (save-excursion
13911 (save-restriction
13912 (widen)
13913 (goto-char (point-min))
13914 (unless (re-search-forward re nil t)
13915 (error "Cannot find target location - try again with `C-u' prefix."))
13916 (goto-char (match-beginning 0))
13917 (looking-at outline-regexp)
13918 (setq level (org-get-valid-level (funcall outline-level) 1))
13919 (goto-char (or (save-excursion
13920 (if reversed
13921 (outline-next-heading)
13922 (outline-get-next-sibling)))
13923 (point-max)))
13924 (org-paste-subtree level))))
13925 (org-cut-special)
13928 ;;;; Dynamic blocks
13930 (defun org-find-dblock (name)
13931 "Find the first dynamic block with name NAME in the buffer.
13932 If not found, stay at current position and return nil."
13933 (let (pos)
13934 (save-excursion
13935 (goto-char (point-min))
13937 nil t)
13938 (match-beginning 0))))
13939 (if pos (goto-char pos))
13940 pos))
13942 (defconst org-dblock-start-re
13944 "Matches the startline of a dynamic block, with parameters.")
13947 "Matches the end of a dyhamic block.")
13949 (defun org-create-dblock (plist)
13950 "Create a dynamic block section, with parameters taken from PLIST.
13951 PLIST must containe a :name entry which is used as name of the block."
13952 (unless (bolp) (newline))
13953 (let ((name (plist-get plist :name)))
13954 (insert "#+BEGIN: " name)
13955 (while plist
13956 (if (eq (car plist) :name)
13957 (setq plist (cddr plist))
13958 (insert " " (prin1-to-string (pop plist)))))
13960 (beginning-of-line -2)))
13962 (defun org-prepare-dblock ()
13963 "Prepare dynamic block for refresh.
13964 This empties the block, puts the cursor at the insert position and returns
13965 the property list including an extra property :name with the block name."
13966 (unless (looking-at org-dblock-start-re)
13967 (error "Not at a dynamic block"))
13968 (let* ((begdel (1+ (match-end 0)))
13969 (name (org-no-properties (match-string 1)))
13970 (params (append (list :name name)
13971 (read (concat "(" (match-string 3) ")")))))
13972 (unless (re-search-forward org-dblock-end-re nil t)
13973 (error "Dynamic block not terminated"))
13974 (delete-region begdel (match-beginning 0))
13975 (goto-char begdel)
13976 (open-line 1)
13977 params))
13979 (defun org-map-dblocks (&optional command)
13980 "Apply COMMAND to all dynamic blocks in the current buffer.
13981 If COMMAND is not given, use `org-update-dblock'."
13982 (let ((cmd (or command 'org-update-dblock))
13983 pos)
13984 (save-excursion
13985 (goto-char (point-min))
13986 (while (re-search-forward org-dblock-start-re nil t)
13987 (goto-char (setq pos (match-beginning 0)))
13988 (condition-case nil
13989 (funcall cmd)
13990 (error (message "Error during update of dynamic block")))
13991 (goto-char pos)
13992 (unless (re-search-forward org-dblock-end-re nil t)
13993 (error "Dynamic block not terminated"))))))
13995 (defun org-dblock-update (&optional arg)
13996 "User command for updating dynamic blocks.
13997 Update the dynamic block at point. With prefix ARG, update all dynamic
13998 blocks in the buffer."
13999 (interactive "P")
14000 (if arg
14001 (org-update-all-dblocks)
14002 (or (looking-at org-dblock-start-re)
14003 (org-beginning-of-dblock))
14004 (org-update-dblock)))
14006 (defun org-update-dblock ()
14007 "Update the dynamic block at point
14008 This means to empty the block, parse for parameters and then call
14009 the correct writing function."
14010 (save-window-excursion
14011 (let* ((pos (point))
14012 (line (org-current-line))
14013 (params (org-prepare-dblock))
14014 (name (plist-get params :name))
14015 (cmd (intern (concat "org-dblock-write:" name))))
14016 (message "Updating dynamic block `%s' at line %d..." name line)
14017 (funcall cmd params)
14018 (message "Updating dynamic block `%s' at line %d...done" name line)
14019 (goto-char pos))))
14021 (defun org-beginning-of-dblock ()
14022 "Find the beginning of the dynamic block at point.
14023 Error if there is no scuh block at point."
14024 (let ((pos (point))
14025 beg)
14026 (end-of-line 1)
14027 (if (and (re-search-backward org-dblock-start-re nil t)
14028 (setq beg (match-beginning 0))
14029 (re-search-forward org-dblock-end-re nil t)
14030 (> (match-end 0) pos))
14031 (goto-char beg)
14032 (goto-char pos)
14033 (error "Not in a dynamic block"))))
14035 (defun org-update-all-dblocks ()
14036 "Update all dynamic blocks in the buffer.
14037 This function can be used in a hook."
14038 (when (org-mode-p)
14039 (org-map-dblocks 'org-update-dblock)))
14042 ;;;; Completion
14044 (defconst org-additional-option-like-keywords
14045 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14046 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14047 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14049 (defun org-complete (&optional arg)
14050 "Perform completion on word at point.
14051 At the beginning of a headline, this completes TODO keywords as given in
14052 `org-todo-keywords'.
14053 If the current word is preceded by a backslash, completes the TeX symbols
14054 that are supported for HTML support.
14056 setting file options.
14058 At all other locations, this simply calls the value of
14059 `org-completion-fallback-command'."
14060 (interactive "P")
14061 (org-without-partial-completion
14062 (catch 'exit
14063 (let* ((end (point))
14064 (beg1 (save-excursion
14065 (skip-chars-backward (org-re "[:alnum:]_@"))
14066 (point)))
14067 (beg (save-excursion
14068 (skip-chars-backward "a-zA-Z0-9_:$")
14069 (point)))
14070 (confirm (lambda (x) (stringp (car x))))
14071 (searchhead (equal (char-before beg) ?*))
14072 (tag (and (equal (char-before beg1) ?:)
14073 (equal (char-after (point-at-bol)) ?*)))
14074 (prop (and (equal (char-before beg1) ?:)
14075 (not (equal (char-after (point-at-bol)) ?*))))
14077 (link (equal (char-before beg) ?\[))
14078 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14079 beg)
14080 "#+"))
14082 (buffer-substring (point-at-bol) (point))))
14083 (completion-ignore-case opt)
14084 (type nil)
14085 (tbl nil)
14086 (table (cond
14087 (opt
14088 (setq type :opt)
14089 (append
14090 (mapcar
14091 (lambda (x)
14093 (cons (match-string 2 x) (match-string 1 x)))
14095 (mapcar 'list org-additional-option-like-keywords)))
14096 (startup
14097 (setq type :startup)
14098 org-startup-options)
14099 (link (append org-link-abbrev-alist-local
14100 org-link-abbrev-alist))
14101 (texp
14102 (setq type :tex)
14103 org-html-entities)
14105 (buffer-substring (point-at-bol) beg))
14106 (setq type :todo)
14107 (mapcar 'list org-todo-keywords-1))
14108 (searchhead
14109 (setq type :searchhead)
14110 (save-excursion
14111 (goto-char (point-min))
14112 (while (re-search-forward org-todo-line-regexp nil t)
14113 (push (list
14114 (org-make-org-heading-search-string
14115 (match-string 3) t))
14116 tbl)))
14117 tbl)
14118 (tag (setq type :tag beg beg1)
14119 (or org-tag-alist (org-get-buffer-tags)))
14120 (prop (setq type :prop beg beg1)
14121 (mapcar 'list (org-buffer-property-keys)))
14122 (t (progn
14123 (call-interactively org-completion-fallback-command)
14124 (throw 'exit nil)))))
14125 (pattern (buffer-substring-no-properties beg end))
14126 (completion (try-completion pattern table confirm)))
14127 (cond ((eq completion t)
14128 (if (not (assoc (upcase pattern) table))
14129 (message "Already complete")
14130 (if (equal type :opt)
14131 (insert (substring (cdr (assoc (upcase pattern) table))
14132 (length pattern)))
14133 (if (memq type '(:tag :prop)) (insert ":")))))
14134 ((null completion)
14136 (ding))
14137 ((not (string= pattern completion))
14138 (delete-region beg end)
14139 (if (string-match " +$" completion)
14140 (setq completion (replace-match "" t t completion)))
14141 (insert completion)
14142 (if (get-buffer-window "*Completions*")
14143 (delete-window (get-buffer-window "*Completions*")))
14144 (if (assoc completion table)
14145 (if (eq type :todo) (insert " ")
14146 (if (memq type '(:tag :prop)) (insert ":"))))
14147 (if (and (equal type :opt) (assoc completion table))
14148 (message "%s" (substitute-command-keys
14150 (t
14151 (message "Making completion list...")
14152 (let ((list (sort (all-completions pattern table confirm)
14153 'string<)))
14154 (with-output-to-temp-buffer "*Completions*"
14155 (condition-case nil
14156 ;; Protection needed for XEmacs and emacs 21
14157 (display-completion-list list pattern)
14158 (error (display-completion-list list)))))
14159 (message "Making completion list...%s" "done")))))))
14161 ;;;; TODO, DEADLINE, Comments
14163 (defun org-toggle-comment ()
14164 "Change the COMMENT state of an entry."
14165 (interactive)
14166 (save-excursion
14167 (org-back-to-heading)
14168 (let (case-fold-search)
14169 (if (looking-at (concat outline-regexp
14171 (replace-match "" t t nil 1)
14172 (if (looking-at outline-regexp)
14173 (progn
14174 (goto-char (match-end 0))
14175 (insert org-comment-string " ")))))))
14177 (defvar org-last-todo-state-is-todo nil
14178 "This is non-nil when the last TODO state change led to a TODO state.
14179 If the last change removed the TODO tag or switched to DONE, then
14180 this is nil.")
14182 (defvar org-setting-tags nil) ; dynamically skiped
14184 ;; FIXME: better place
14185 (defun org-property-or-variable-value (var &optional inherit)
14186 "Check if there is a property fixing the value of VAR.
14187 If yes, return this value. If not, return the current value of the variable."
14188 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14190 (read prop)
14191 (symbol-value var))))
14193 (defun org-parse-local-options (string var)
14194 "Parse STRING for startup setting relevant for variable VAR."
14195 (let ((rtn (symbol-value var))
14196 e opts)
14197 (save-match-data
14199 rtn
14200 (setq opts (delq nil (mapcar (lambda (x)
14201 (setq e (assoc x org-startup-options))
14202 (if (eq (nth 1 e) var) e nil))
14204 (if (not opts)
14205 rtn
14206 (setq rtn nil)
14207 (while (setq e (pop opts))
14208 (if (not (nth 3 e))
14209 (setq rtn (nth 2 e))
14210 (if (not (listp rtn)) (setq rtn nil))
14211 (push (nth 2 e) rtn)))
14212 rtn)))))
14214 (defvar org-blocker-hook nil
14215 "Hook for functions that are allowed to block a state change.
14217 Each function gets as its single argument a property list, see
14218 `org-trigger-hook' for more information about this list.
14220 If any of the functions in this hook returns nil, the state change
14221 is blocked.")
14223 (defvar org-trigger-hook nil
14224 "Hook for functions that are triggered by a state change.
14226 Each function gets as its single argument a property list with at least
14227 the following elements:
14229 (:type type-of-change :position pos-at-entry-start
14230 :from old-state :to new-state)
14232 Depending on the type, more properties may be present.
14234 This mechanism is currently implemented for:
14236 TODO state changes
14237 ------------------
14238 :type todo-state-change
14239 :from previous state (keyword as a string), or nil
14240 :to new state (keyword as a string), or nil")
14243 (defun org-todo (&optional arg)
14244 "Change the TODO state of an item.
14245 The state of an item is given by a keyword at the start of the heading,
14246 like
14247 *** TODO Write paper
14248 *** DONE Call mom
14250 The different keywords are specified in the variable `org-todo-keywords'.
14252 So for this example: when the item starts with TODO, it is changed to DONE.
14253 When it starts with DONE, the DONE is removed. And when neither TODO nor
14254 DONE are present, add TODO at the beginning of the heading.
14256 With C-u prefix arg, use completion to determine the new state.
14257 With numeric prefix arg, switch to that state.
14259 For calling through lisp, arg is also interpreted in the following way:
14260 'none -> empty state
14262 'done -> switch to DONE
14263 'nextset -> switch to the next set of keywords
14264 'previousset -> switch to the previous set of keywords
14266 really is a member of `org-todo-keywords'."
14267 (interactive "P")
14268 (save-excursion
14269 (catch 'exit
14270 (org-back-to-heading)
14271 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14272 (or (looking-at (concat " +" org-todo-regexp " *"))
14273 (looking-at " *"))
14274 (let* ((match-data (match-data))
14275 (startpos (point-at-bol))
14276 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14277 (org-log-done (org-parse-local-options logging 'org-log-done))
14278 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
14279 (this (match-string 1))
14280 (hl-pos (match-beginning 0))
14281 (head (org-get-todo-sequence-head this))
14282 (ass (assoc head org-todo-kwd-alist))
14283 (interpret (nth 1 ass))
14284 (done-word (nth 3 ass))
14285 (final-done-word (nth 4 ass))
14286 (last-state (or this ""))
14287 (completion-ignore-case t)
14288 (member (member this org-todo-keywords-1))
14289 (tail (cdr member))
14290 (state (cond
14291 ((and org-todo-key-trigger
14292 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14293 (and (not arg) org-use-fast-todo-selection
14294 (not (eq org-use-fast-todo-selection 'prefix)))))
14295 ;; Use fast selection
14296 (org-fast-todo-selection))
14297 ((and (equal arg '(4))
14298 (or (not org-use-fast-todo-selection)
14299 (not org-todo-key-trigger)))
14300 ;; Read a state with completion
14301 (completing-read "State: " (mapcar (lambda(x) (list x))
14302 org-todo-keywords-1)
14303 nil t))
14304 ((eq arg 'right)
14305 (if this
14306 (if tail (car tail) nil)
14307 (car org-todo-keywords-1)))
14308 ((eq arg 'left)
14309 (if (equal member org-todo-keywords-1)
14310 nil
14311 (if this
14312 (nth (- (length org-todo-keywords-1) (length tail) 2)
14313 org-todo-keywords-1)
14314 (org-last org-todo-keywords-1))))
14315 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14316 (setq arg nil))) ; hack to fall back to cycling
14317 (arg
14318 ;; user or caller requests a specific state
14319 (cond
14320 ((equal arg "") nil)
14321 ((eq arg 'none) nil)
14322 ((eq arg 'done) (or done-word (car org-done-keywords)))
14323 ((eq arg 'nextset)
14324 (or (car (cdr (member head org-todo-heads)))
14325 (car org-todo-heads)))
14326 ((eq arg 'previousset)
14327 (let ((org-todo-heads (reverse org-todo-heads)))
14328 (or (car (cdr (member head org-todo-heads)))
14329 (car org-todo-heads))))
14330 ((car (member arg org-todo-keywords-1)))
14331 ((nth (1- (prefix-numeric-value arg))
14332 org-todo-keywords-1))))
14333 ((null member) (or head (car org-todo-keywords-1)))
14334 ((equal this final-done-word) nil) ;; -> make empty
14335 ((null tail) nil) ;; -> first entry
14336 ((eq interpret 'sequence)
14337 (car tail))
14338 ((memq interpret '(type priority))
14339 (if (eq this-command last-command)
14340 (car tail)
14341 (if (> (length tail) 0)
14342 (or done-word (car org-done-keywords))
14343 nil)))
14344 (t nil)))
14345 (next (if state (concat " " state " ") " "))
14346 (change-plist (list :type 'todo-state-change :from this :to state
14347 :position startpos))
14348 dostates)
14349 (when org-blocker-hook
14350 (unless (save-excursion
14351 (save-match-data
14352 (run-hook-with-args-until-failure
14353 'org-blocker-hook change-plist)))
14354 (if (interactive-p)
14355 (error "TODO state change from %s to %s blocked" this state)
14356 ;; fail silently
14357 (message "TODO state change from %s to %s blocked" this state)
14358 (throw 'exit nil))))
14359 (store-match-data match-data)
14360 (replace-match next t t)
14361 (unless (pos-visible-in-window-p hl-pos)
14362 (message "TODO state changed to %s" (org-trim next)))
14363 (unless head
14364 (setq head (org-get-todo-sequence-head state)
14365 ass (assoc head org-todo-kwd-alist)
14366 interpret (nth 1 ass)
14367 done-word (nth 3 ass)
14368 final-done-word (nth 4 ass)))
14369 (when (memq arg '(nextset previousset))
14370 (message "Keyword-Set %d/%d: %s"
14371 (- (length org-todo-sets) -1
14372 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14373 (length org-todo-sets)
14374 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14375 (setq org-last-todo-state-is-todo
14376 (not (member state org-done-keywords)))
14377 (when (and org-log-done (not (memq arg '(nextset previousset))))
14378 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
14379 (or (not org-todo-log-states)
14380 (member state org-todo-log-states))))
14382 (cond
14383 ((and state (member state org-not-done-keywords)
14384 (not (member this org-not-done-keywords)))
14385 ;; This is now a todo state and was not one before
14386 ;; Remove any CLOSED timestamp, and possibly log the state change
14387 (org-add-planning-info nil nil 'closed)
14388 (and dostates (org-add-log-maybe 'state state 'findpos)))
14389 ((and state dostates)
14390 ;; This is a non-nil state, and we need to log it
14391 (org-add-log-maybe 'state state 'findpos))
14392 ((and (member state org-done-keywords)
14393 (not (member this org-done-keywords)))
14394 ;; It is now done, and it was not done before
14395 (org-add-planning-info 'closed (org-current-time))
14396 (org-add-log-maybe 'done state 'findpos))))
14397 ;; Fixup tag positioning
14398 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14399 (run-hooks 'org-after-todo-state-change-hook)
14400 (and (member state org-done-keywords) (org-auto-repeat-maybe))
14401 (if (and arg (not (member state org-done-keywords)))
14402 (setq head (org-get-todo-sequence-head state)))
14403 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14404 ;; Fixup cursor location if close to the keyword
14405 (if (and (outline-on-heading-p)
14406 (not (bolp))
14407 (save-excursion (beginning-of-line 1)
14408 (looking-at org-todo-line-regexp))
14409 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14410 (progn
14411 (goto-char (or (match-end 2) (match-end 1)))
14412 (just-one-space)))
14413 (when org-trigger-hook
14414 (save-excursion
14415 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14417 (defun org-get-todo-sequence-head (kwd)
14418 "Return the head of the TODO sequence to which KWD belongs.
14419 If KWD is not set, check if there is a text property remembering the
14420 right sequence."
14421 (let (p)
14422 (cond
14423 ((not kwd)
14424 (or (get-text-property (point-at-bol) 'org-todo-head)
14425 (progn
14426 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14427 nil (point-at-eol)))
14428 (get-text-property p 'org-todo-head))))
14429 ((not (member kwd org-todo-keywords-1))
14430 (car org-todo-keywords-1))
14431 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14433 (defun org-fast-todo-selection ()
14434 "Fast TODO keyword selection with single keys.
14435 Returns the new TODO keyword, or nil if no state change should occur."
14436 (let* ((fulltable org-todo-key-alist)
14437 (done-keywords org-done-keywords) ;; needed for the faces.
14438 (maxlen (apply 'max (mapcar
14439 (lambda (x)
14440 (if (stringp (car x)) (string-width (car x)) 0))
14441 fulltable)))
14442 (expert nil)
14443 (fwidth (+ maxlen 3 1 3))
14444 (ncol (/ (- (window-width) 4) fwidth))
14445 tg cnt e c tbl
14446 groups ingroup)
14447 (save-window-excursion
14448 (if expert
14449 (set-buffer (get-buffer-create " *Org todo*"))
14450 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14451 (erase-buffer)
14452 (org-set-local 'org-done-keywords done-keywords)
14453 (setq tbl fulltable cnt 0)
14454 (while (setq e (pop tbl))
14455 (cond
14456 ((equal e '(:startgroup))
14457 (push '() groups) (setq ingroup t)
14458 (when (not (= cnt 0))
14459 (setq cnt 0)
14461 (insert "{ "))
14462 ((equal e '(:endgroup))
14463 (setq ingroup nil cnt 0)
14465 (t
14466 (setq tg (car e) c (cdr e))
14467 (if ingroup (push tg (car groups)))
14468 (setq tg (org-add-props tg nil 'face
14469 (org-get-todo-face tg)))
14470 (if (and (= cnt 0) (not ingroup)) (insert " "))
14471 (insert "[" c "] " tg (make-string
14472 (- fwidth 4 (length tg)) ?\ ))
14473 (when (= (setq cnt (1+ cnt)) ncol)
14475 (if ingroup (insert " "))
14476 (setq cnt 0)))))
14478 (goto-char (point-min))
14479 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14480 (fit-window-to-buffer))
14481 (message "[a-z..]:Set [SPC]:clear")
14482 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14483 (cond
14484 ((or (= c ?\C-g)
14485 (and (= c ?q) (not (rassoc c fulltable))))
14486 (setq quit-flag t))
14487 ((= c ?\ ) nil)
14488 ((setq e (rassoc c fulltable) tg (car e))
14489 tg)
14490 (t (setq quit-flag t))))))
14492 (defun org-get-repeat ()
14493 "Check if tere is a deadline/schedule with repeater in this entry."
14494 (save-match-data
14495 (save-excursion
14496 (org-back-to-heading t)
14497 (if (re-search-forward
14498 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14499 (match-string 1)))))
14501 (defvar org-last-changed-timestamp)
14502 (defvar org-log-post-message)
14503 (defun org-auto-repeat-maybe ()
14504 "Check if the current headline contains a repeated deadline/schedule.
14505 If yes, set TODO state back to what it was and change the base date
14506 of repeating deadline/scheduled time stamps to new date.
14507 This function should be run in the `org-after-todo-state-change-hook'."
14508 ;; last-state is dynamically scoped into this function
14509 (let* ((repeat (org-get-repeat))
14510 (aa (assoc last-state org-todo-kwd-alist))
14511 (interpret (nth 1 aa))
14512 (head (nth 2 aa))
14513 (done-word (nth 3 aa))
14514 (whata '(("d" . day) ("m" . month) ("y" . year)))
14515 (msg "Entry repeats: ")
14516 (org-log-done)
14517 re type n what ts)
14518 (when repeat
14519 (org-todo (if (eq interpret 'type) last-state head))
14520 (when (and org-log-repeat
14521 (not (memq 'org-add-log-note
14522 (default-value 'post-command-hook))))
14523 ;; Make sure a note is taken
14524 (let ((org-log-done '(done)))
14525 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
14526 'findpos)))
14527 (org-back-to-heading t)
14528 (org-add-planning-info nil nil 'closed)
14531 (while (re-search-forward
14532 re (save-excursion (outline-next-heading) (point)) t)
14533 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
14534 ts (match-string (if (match-end 2) 2 4)))
14536 (setq n (string-to-number (match-string 1 ts))
14537 what (match-string 2 ts))
14538 (if (equal what "w") (setq n (* n 7) what "d"))
14539 (org-timestamp-change n (cdr (assoc what whata))))
14540 (setq msg (concat msg type org-last-changed-timestamp " ")))
14541 (setq org-log-post-message msg)
14542 (message "%s" msg))))
14544 (defun org-show-todo-tree (arg)
14545 "Make a compact tree which shows all headlines marked with TODO.
14546 The tree will show the lines where the regexp matches, and all higher
14547 headlines above the match.
14549 With a numeric prefix N, construct a sparse tree for the Nth element
14550 of `org-todo-keywords-1'."
14551 (interactive "P")
14552 (let ((case-fold-search nil)
14553 (kwd-re
14554 (cond ((null arg) org-not-done-regexp)
14555 ((equal arg '(4))
14556 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14557 (mapcar 'list org-todo-keywords-1))))
14561 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14562 (regexp-quote (nth (1- (prefix-numeric-value arg))
14563 org-todo-keywords-1)))
14564 (t (error "Invalid prefix argument: %s" arg)))))
14565 (message "%d TODO entries found"
14566 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14568 (defun org-deadline (&optional remove)
14570 With argument REMOVE, remove any deadline from the item."
14571 (interactive "P")
14572 (if remove
14573 (progn
14574 (org-add-planning-info nil nil 'deadline)
14575 (message "Item no longer has a deadline."))
14576 (org-add-planning-info 'deadline nil 'closed)))
14578 (defun org-schedule (&optional remove)
14579 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14580 With argument REMOVE, remove any scheduling date from the item."
14581 (interactive "P")
14582 (if remove
14583 (progn
14584 (org-add-planning-info nil nil 'scheduled)
14585 (message "Item is no longer scheduled."))
14586 (org-add-planning-info 'scheduled nil 'closed)))
14588 (defun org-add-planning-info (what &optional time &rest remove)
14589 "Insert new timestamp with keyword in the line directly after the headline.
14590 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14591 If non is given, the user is prompted for a date.
14592 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14593 be removed."
14594 (interactive)
14595 (let (org-time-was-given org-end-time-was-given)
14596 (when what (setq time (or time (org-read-date nil 'to-time))))
14597 (when (and org-insert-labeled-timestamps-at-point
14598 (member what '(scheduled deadline)))
14599 (insert
14600 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14601 (org-insert-time-stamp time org-time-was-given
14602 nil nil nil (list org-end-time-was-given))
14603 (setq what nil))
14604 (save-excursion
14605 (save-restriction
14606 (let (col list elt ts buffer-invisibility-spec)
14607 (org-back-to-heading t)
14609 (goto-char (match-end 1))
14610 (setq col (current-column))
14611 (goto-char (match-end 0))
14613 (if (and (not (looking-at outline-regexp))
14616 (not (equal (match-string 1) org-clock-string)))
14617 (narrow-to-region (match-beginning 0) (match-end 0))
14619 (backward-char 1)
14620 (narrow-to-region (point) (point))
14621 (indent-to-column col))
14622 ;; Check if we have to remove something.
14623 (setq list (cons what remove))
14624 (while list
14625 (setq elt (pop list))
14626 (goto-char (point-min))
14627 (when (or (and (eq elt 'scheduled)
14628 (re-search-forward org-scheduled-time-regexp nil t))
14629 (and (eq elt 'deadline)
14630 (re-search-forward org-deadline-time-regexp nil t))
14631 (and (eq elt 'closed)
14632 (re-search-forward org-closed-time-regexp nil t)))
14633 (replace-match "")
14634 (if (looking-at "--+<[^>]+>") (replace-match ""))
14635 (if (looking-at " +") (replace-match ""))))
14636 (goto-char (point-max))
14637 (when what
14638 (insert
14639 (if (not (equal (char-before) ?\ )) " " "")
14640 (cond ((eq what 'scheduled) org-scheduled-string)
14641 ((eq what 'deadline) org-deadline-string)
14642 ((eq what 'closed) org-closed-string))
14643 " ")
14644 (setq ts (org-insert-time-stamp
14645 time
14646 (or org-time-was-given
14647 (and (eq what 'closed) org-log-done-with-time))
14648 (eq what 'closed)
14649 nil nil (list org-end-time-was-given)))
14650 (end-of-line 1))
14651 (goto-char (point-min))
14652 (widen)
14654 (replace-match ""))
14655 ts)))))
14657 (defvar org-log-note-marker (make-marker))
14658 (defvar org-log-note-purpose nil)
14659 (defvar org-log-note-state nil)
14660 (defvar org-log-note-window-configuration nil)
14661 (defvar org-log-note-return-to (make-marker))
14662 (defvar org-log-post-message nil
14663 "Message to be displayed after a log note has been stored.
14664 The auto-repeater uses this.")
14666 (defun org-add-log-maybe (&optional purpose state findpos)
14667 "Set up the post command hook to take a note."
14668 (save-excursion
14669 (when (and (listp org-log-done)
14670 (memq purpose org-log-done))
14671 (when findpos
14672 (org-back-to-heading t)
14676 (goto-char (match-end 0))
14677 (unless org-log-states-order-reversed
14679 (org-skip-over-state-notes)
14681 (move-marker org-log-note-marker (point))
14682 (setq org-log-note-purpose purpose)
14683 (setq org-log-note-state state)
14684 (add-hook 'post-command-hook 'org-add-log-note 'append))))
14686 (defun org-skip-over-state-notes ()
14687 "Skip past the list of State notes in an entry."
14690 (condition-case nil
14691 (org-next-item)
14692 (error (org-end-of-item)))))
14694 (defun org-add-log-note (&optional purpose)
14695 "Pop up a window for taking a note, and add this note later at point."
14696 (remove-hook 'post-command-hook 'org-add-log-note)
14697 (setq org-log-note-window-configuration (current-window-configuration))
14698 (delete-other-windows)
14699 (move-marker org-log-note-return-to (point))
14700 (switch-to-buffer (marker-buffer org-log-note-marker))
14701 (goto-char org-log-note-marker)
14702 (org-switch-to-buffer-other-window "*Org Note*")
14703 (erase-buffer)
14704 (let ((org-inhibit-startup t)) (org-mode))
14705 (insert (format "# Insert note for %s.
14707 (cond
14708 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14709 ((eq org-log-note-purpose 'done) "closed todo item")
14710 ((eq org-log-note-purpose 'state)
14712 (t (error "This should not happen")))))
14713 (org-set-local 'org-finish-function 'org-store-log-note))
14715 (defun org-store-log-note ()
14716 "Finish taking a log note, and insert it to where it belongs."
14717 (let ((txt (buffer-string))
14718 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14719 lines ind)
14720 (kill-buffer (current-buffer))
14722 (setq txt (replace-match "" t t txt)))
14724 (setq txt (replace-match "" t t txt)))
14727 (setq note
14728 (org-replace-escapes
14729 note
14730 (list (cons "%u" (user-login-name))
14731 (cons "%U" user-full-name)
14732 (cons "%t" (format-time-string
14733 (org-time-stamp-format 'long 'inactive)
14734 (current-time)))
14735 (cons "%s" (if org-log-note-state
14737 "")))))
14739 (push note lines))
14740 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14741 (when lines
14742 (save-excursion
14743 (set-buffer (marker-buffer org-log-note-marker))
14744 (save-excursion
14745 (goto-char org-log-note-marker)
14746 (move-marker org-log-note-marker nil)
14747 (end-of-line 1)
14749 (indent-relative nil)
14750 (insert "- " (pop lines))
14751 (org-indent-line-function)
14752 (beginning-of-line 1)
14754 (setq ind (concat (match-string 0) " "))
14755 (end-of-line 1)
14757 (set-window-configuration org-log-note-window-configuration)
14758 (with-current-buffer (marker-buffer org-log-note-return-to)
14759 (goto-char org-log-note-return-to))
14760 (move-marker org-log-note-return-to nil)
14761 (and org-log-post-message (message "%s" org-log-post-message)))
14763 ;; FIXME: what else would be useful?
14764 ;; - priority
14765 ;; - date
14767 (defun org-sparse-tree (&optional arg)
14768 "Create a sparse tree, prompt for the details.
14769 This command can create sparse trees. You first need to select the type
14770 of match used to create the tree:
14772 t Show entries with a specific TODO keyword.
14773 T Show entries selected by a tags match.
14774 p Enter a property name and its value (both with completion on existing
14775 names/values) and show entries with that property.
14776 r Show entries matching a regular expression
14777 d Show deadlines due within `org-deadline-warning-days'."
14778 (interactive "P")
14779 (let (ans kwd value)
14780 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
14781 (setq ans (read-char-exclusive))
14782 (cond
14783 ((equal ans ?d)
14784 (call-interactively 'org-check-deadlines))
14785 ((equal ans ?b)
14786 (call-interactively 'org-check-before-date))
14787 ((equal ans ?t)
14788 (org-show-todo-tree '(4)))
14789 ((equal ans ?T)
14790 (call-interactively 'org-tags-sparse-tree))
14791 ((member ans '(?p ?P))
14792 (setq kwd (completing-read "Property: "
14793 (mapcar 'list (org-buffer-property-keys))))
14794 (setq value (completing-read "Value: "
14795 (mapcar 'list (org-property-values kwd))))
14798 (org-tags-sparse-tree arg (concat kwd "=" value)))
14799 ((member ans '(?r ?R ?/))
14800 (call-interactively 'org-occur))
14803 (defvar org-occur-highlights nil)
14804 (make-variable-buffer-local 'org-occur-highlights)
14806 (defun org-occur (regexp &optional keep-previous callback)
14807 "Make a compact tree which shows all matches of REGEXP.
14808 The tree will show the lines where the regexp matches, and all higher
14809 headlines above the match. It will also show the heading after the match,
14810 to make sure editing the matching entry is easy.
14811 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
14812 call to `org-occur' will be kept, to allow stacking of calls to this
14813 command.
14814 If CALLBACK is non-nil, it is a function which is called to confirm
14815 that the match should indeed be shown."
14817 (or keep-previous (org-remove-occur-highlights nil nil t))
14818 (let ((cnt 0))
14819 (save-excursion
14820 (goto-char (point-min))
14821 (if (or (not keep-previous) ; do not want to keep
14822 (not org-occur-highlights)) ; no previous matches
14823 ;; hide everything
14824 (org-overview))
14825 (while (re-search-forward regexp nil t)
14826 (when (or (not callback)
14827 (save-match-data (funcall callback)))
14828 (setq cnt (1+ cnt))
14829 (when org-highlight-sparse-tree-matches
14830 (org-highlight-new-match (match-beginning 0) (match-end 0)))
14831 (org-show-context 'occur-tree))))
14832 (when org-remove-highlights-with-change
14833 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
14834 nil 'local))
14835 (unless org-sparse-tree-open-archived-trees
14836 (org-hide-archived-subtrees (point-min) (point-max)))
14837 (run-hooks 'org-occur-hook)
14838 (if (interactive-p)
14839 (message "%d match(es) for regexp %s" cnt regexp))
14840 cnt))
14842 (defun org-show-context (&optional key)
14843 "Make sure point and context and visible.
14844 How much context is shown depends upon the variables
14845 `org-show-hierarchy-above', `org-show-following-heading'. and
14846 `org-show-siblings'."
14847 (let ((heading-p (org-on-heading-p t))
14848 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
14849 (following-p (org-get-alist-option org-show-following-heading key))
14850 (entry-p (org-get-alist-option org-show-entry-below key))
14851 (siblings-p (org-get-alist-option org-show-siblings key)))
14852 (catch 'exit
14853 ;; Show heading or entry text
14854 (if (and heading-p (not entry-p))
14855 (org-flag-heading nil) ; only show the heading
14856 (and (or entry-p (org-invisible-p) (org-invisible-p2))
14857 (org-show-hidden-entry))) ; show entire entry
14858 (when following-p
14859 ;; Show next sibling, or heading below text
14860 (save-excursion
14861 (and (if heading-p (org-goto-sibling) (outline-next-heading))
14862 (org-flag-heading nil))))
14863 (when siblings-p (org-show-siblings))
14864 (when hierarchy-p
14865 ;; show all higher headings, possibly with siblings
14866 (save-excursion
14867 (while (and (condition-case nil
14868 (progn (org-up-heading-all 1) t)
14869 (error nil))
14870 (not (bobp)))
14871 (org-flag-heading nil)
14872 (when siblings-p (org-show-siblings))))))))
14874 (defun org-reveal (&optional siblings)
14875 "Show current entry, hierarchy above it, and the following headline.
14876 This can be used to show a consistent set of context around locations
14877 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14878 not t for the search context.
14880 With optional argument SIBLINGS, on each level of the hierarchy all
14881 siblings are shown. This repairs the tree structure to what it would
14882 look like when opened with hierarchical calls to `org-cycle'."
14883 (interactive "P")
14884 (let ((org-show-hierarchy-above t)
14885 (org-show-following-heading t)
14886 (org-show-siblings (if siblings t org-show-siblings)))
14887 (org-show-context nil)))
14889 (defun org-highlight-new-match (beg end)
14890 "Highlight from BEG to END and mark the highlight is an occur headline."
14891 (let ((ov (org-make-overlay beg end)))
14892 (org-overlay-put ov 'face 'secondary-selection)
14893 (push ov org-occur-highlights)))
14895 (defun org-remove-occur-highlights (&optional beg end noremove)
14896 "Remove the occur highlights from the buffer.
14897 BEG and END are ignored. If NOREMOVE is nil, remove this function
14898 from the `before-change-functions' in the current buffer."
14899 (interactive)
14900 (unless org-inhibit-highlight-removal
14901 (mapc 'org-delete-overlay org-occur-highlights)
14902 (setq org-occur-highlights nil)
14903 (unless noremove
14904 (remove-hook 'before-change-functions
14905 'org-remove-occur-highlights 'local))))
14907 ;;;; Priorities
14910 "Regular expression matching the priority indicator.")
14912 (defvar org-remove-priority-next-time nil)
14914 (defun org-priority-up ()
14915 "Increase the priority of the current item."
14916 (interactive)
14917 (org-priority 'up))
14919 (defun org-priority-down ()
14920 "Decrease the priority of the current item."
14921 (interactive)
14922 (org-priority 'down))
14924 (defun org-priority (&optional action)
14925 "Change the priority of an item by ARG.
14926 ACTION can be `set', `up', `down', or a character."
14927 (interactive)
14928 (setq action (or action 'set))
14929 (let (current new news have remove)
14930 (save-excursion
14931 (org-back-to-heading)
14932 (if (looking-at org-priority-regexp)
14933 (setq current (string-to-char (match-string 2))
14934 have t)
14935 (setq current org-default-priority))
14936 (cond
14937 ((or (eq action 'set) (integerp action))
14938 (if (integerp action)
14939 (setq new action)
14940 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
14941 (setq new (read-char-exclusive)))
14942 (if (and (= (upcase org-highest-priority) org-highest-priority)
14943 (= (upcase org-lowest-priority) org-lowest-priority))
14944 (setq new (upcase new)))
14945 (cond ((equal new ?\ ) (setq remove t))
14946 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14947 (error "Priority must be between `%c' and `%c'"
14948 org-highest-priority org-lowest-priority))))
14949 ((eq action 'up)
14950 (if (and (not have) (eq last-command this-command))
14951 (setq new org-lowest-priority)
14952 (setq new (if (and org-priority-start-cycle-with-default (not have))
14953 org-default-priority (1- current)))))
14954 ((eq action 'down)
14955 (if (and (not have) (eq last-command this-command))
14956 (setq new org-highest-priority)
14957 (setq new (if (and org-priority-start-cycle-with-default (not have))
14958 org-default-priority (1+ current)))))
14959 (t (error "Invalid action")))
14960 (if (or (< (upcase new) org-highest-priority)
14961 (> (upcase new) org-lowest-priority))
14962 (setq remove t))
14963 (setq news (format "%c" new))
14964 (if have
14965 (if remove
14966 (replace-match "" t t nil 1)
14967 (replace-match news t t nil 2))
14968 (if remove
14969 (error "No priority cookie found in line")
14970 (looking-at org-todo-line-regexp)
14971 (if (match-end 2)
14972 (progn
14973 (goto-char (match-end 2))
14974 (insert " [#" news "]"))
14975 (goto-char (match-beginning 3))
14976 (insert "[#" news "] ")))))
14977 (org-preserve-lc (org-set-tags nil 'align))
14978 (if remove
14979 (message "Priority removed")
14980 (message "Priority of current item set to %s" news))))
14983 (defun org-get-priority (s)
14984 "Find priority cookie and return priority."
14985 (save-match-data
14986 (if (not (string-match org-priority-regexp s))
14987 (* 1000 (- org-lowest-priority org-default-priority))
14988 (* 1000 (- org-lowest-priority
14989 (string-to-char (match-string 2 s)))))))
14991 ;;;; Tags
14993 (defun org-scan-tags (action matcher &optional todo-only)
14994 "Scan headline tags with inheritance and produce output ACTION.
14995 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
14996 evaluated, testing if a given set of tags qualifies a headline for
14997 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
14998 are included in the output."
15001 (org-re
15003 (props (list 'face nil
15004 'done-face 'org-done
15005 'undone-face nil
15006 'mouse-face 'highlight
15007 'org-not-done-regexp org-not-done-regexp
15008 'org-todo-regexp org-todo-regexp
15009 'keymap org-agenda-keymap
15010 'help-echo
15011 (format "mouse-2 or RET jump to org file %s"
15012 (abbreviate-file-name
15013 (or (buffer-file-name (buffer-base-buffer))
15014 (buffer-name (buffer-base-buffer)))))))
15015 (case-fold-search nil)
15016 lspos
15017 tags tags-list tags-alist (llast 0) rtn level category i txt
15018 todo marker entry priority)
15019 (save-excursion
15020 (goto-char (point-min))
15021 (when (eq action 'sparse-tree)
15022 (org-overview)
15023 (org-remove-occur-highlights))
15024 (while (re-search-forward re nil t)
15025 (catch :skip
15026 (setq todo (if (match-end 1) (match-string 2))
15027 tags (if (match-end 4) (match-string 4)))
15028 (goto-char (setq lspos (1+ (match-beginning 0))))
15029 (setq level (org-reduced-level (funcall outline-level))
15030 category (org-get-category))
15031 (setq i llast llast level)
15032 ;; remove tag lists from same and sublevels
15033 (while (>= i level)
15034 (when (setq entry (assoc i tags-alist))
15035 (setq tags-alist (delete entry tags-alist)))
15036 (setq i (1- i)))
15037 ;; add the nex tags
15038 (when tags
15039 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15040 tags-alist
15041 (cons (cons level tags) tags-alist)))
15042 ;; compile tags for current headline
15043 (setq tags-list
15044 (if org-use-tag-inheritance
15045 (apply 'append (mapcar 'cdr tags-alist))
15046 tags))
15047 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15048 (eval matcher)
15049 (or (not org-agenda-skip-archived-trees)
15050 (not (member org-archive-tag tags-list))))
15051 (and (eq action 'agenda) (org-agenda-skip))
15052 ;; list this headline
15054 (if (eq action 'sparse-tree)
15055 (progn
15056 (and org-highlight-sparse-tree-matches
15057 (org-get-heading) (match-end 0)
15058 (org-highlight-new-match
15059 (match-beginning 0) (match-beginning 1)))
15060 (org-show-context 'tags-tree))
15061 (setq txt (org-format-agenda-item
15062 ""
15063 (concat
15064 (if org-tags-match-list-sublevels
15065 (make-string (1- level) ?.) "")
15066 (org-get-heading))
15067 category tags-list)
15068 priority (org-get-priority txt))
15069 (goto-char lspos)
15070 (setq marker (org-agenda-new-marker))
15071 (org-add-props txt props
15072 'org-marker marker 'org-hd-marker marker 'org-category category
15073 'priority priority 'type "tagsmatch")
15074 (push txt rtn))
15075 ;; if we are to skip sublevels, jump to end of subtree
15076 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15077 (when (and (eq action 'sparse-tree)
15078 (not org-sparse-tree-open-archived-trees))
15079 (org-hide-archived-subtrees (point-min) (point-max)))
15080 (nreverse rtn)))
15082 (defvar todo-only) ;; dynamically scoped
15084 (defun org-tags-sparse-tree (&optional todo-only match)
15085 "Create a sparse tree according to tags string MATCH.
15086 MATCH can contain positive and negative selection of tags, like
15088 If optional argument TODO_ONLY is non-nil, only select lines that are
15089 also TODO lines."
15090 (interactive "P")
15091 (org-prepare-agenda-buffers (list (current-buffer)))
15092 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15094 (defvar org-cached-props nil)
15095 (defun org-cached-entry-get (pom property)
15096 (if (or (eq t org-use-property-inheritance)
15097 (member property org-use-property-inheritance))
15098 ;; Caching is not possible, check it directly
15099 (org-entry-get pom property 'inherit)
15100 ;; Get all properties, so that we can do complicated checks easily
15101 (cdr (assoc property (or org-cached-props
15102 (setq org-cached-props
15103 (org-entry-properties pom)))))))
15105 (defun org-global-tags-completion-table (&optional files)
15106 "Return the list of all tags in all agenda buffer/files."
15107 (save-excursion
15108 (org-uniquify
15109 (apply 'append
15110 (mapcar
15111 (lambda (file)
15112 (set-buffer (find-file-noselect file))
15113 (org-get-buffer-tags))
15114 (if (and files (car files))
15115 files
15116 (org-agenda-files)))))))
15118 (defun org-make-tags-matcher (match)
15119 "Create the TAGS//TODO matcher form for the selection string MATCH."
15120 ;; todo-only is scoped dynamically into this function, and the function
15121 ;; may change it it the matcher asksk for it.
15122 (unless match
15123 ;; Get a new match request, with completion
15124 (let ((org-last-tags-completion-table
15125 (org-global-tags-completion-table)))
15126 (setq match (completing-read
15127 "Match: " 'org-tags-completion-function nil nil nil
15128 'org-tags-history))))
15130 ;; Parse the string and create a lisp form
15131 (let ((match0 match)
15132 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
15133 minus tag mm
15134 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15135 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15136 (if (string-match "/+" match)
15137 ;; match contains also a todo-matching request
15138 (progn
15139 (setq tagsmatch (substring match 0 (match-beginning 0))
15140 todomatch (substring match (match-end 0)))
15141 (if (string-match "^!" todomatch)
15142 (setq todo-only t todomatch (substring todomatch 1)))
15144 (setq todomatch nil)))
15145 ;; only matching tags
15146 (setq tagsmatch match todomatch nil))
15148 ;; Make the tags matcher
15150 (setq tagsmatcher t)
15151 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15152 (while (setq term (pop orterms))
15154 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15155 (while (string-match re term)
15156 (setq minus (and (match-end 1)
15157 (equal (match-string 1 term) "-"))
15158 tag (match-string 2 term)
15159 re-p (equal (string-to-char tag) ?{)
15160 level-p (match-end 3)
15161 prop-p (match-end 4)
15162 mm (cond
15163 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15164 (level-p `(= level ,(string-to-number
15165 (match-string 3 term))))
15166 (prop-p
15167 (setq pn (match-string 4 term)
15168 pv (match-string 5 term)
15169 cat-p (equal pn "CATEGORY")
15170 re-p (equal (string-to-char pv) ?{)
15171 pv (substring pv 1 -1))
15172 (if (equal pn "CATEGORY")
15173 (setq gv '(get-text-property (point) 'org-category))
15174 (setq gv `(org-cached-entry-get nil ,pn)))
15175 (if re-p
15176 `(string-match ,pv (or ,gv ""))
15177 `(equal ,pv ,gv)))
15178 (t `(member ,(downcase tag) tags-list)))
15179 mm (if minus (list 'not mm) mm)
15180 term (substring term (match-end 0)))
15181 (push mm tagsmatcher))
15182 (push (if (> (length tagsmatcher) 1)
15183 (cons 'and tagsmatcher)
15184 (car tagsmatcher))
15185 orlist)
15186 (setq tagsmatcher nil))
15187 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15188 (setq tagsmatcher
15189 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15191 ;; Make the todo matcher
15193 (setq todomatcher t)
15194 (setq orterms (org-split-string todomatch "|") orlist nil)
15195 (while (setq term (pop orterms))
15196 (while (string-match re term)
15197 (setq minus (and (match-end 1)
15198 (equal (match-string 1 term) "-"))
15199 kwd (match-string 2 term)
15200 re-p (equal (string-to-char kwd) ?{)
15201 term (substring term (match-end 0))
15202 mm (if re-p
15203 `(string-match ,(substring kwd 1 -1) todo)
15204 (list 'equal 'todo kwd))
15205 mm (if minus (list 'not mm) mm))
15206 (push mm todomatcher))
15207 (push (if (> (length todomatcher) 1)
15208 (cons 'and todomatcher)
15209 (car todomatcher))
15210 orlist)
15211 (setq todomatcher nil))
15212 (setq todomatcher (if (> (length orlist) 1)
15213 (cons 'or orlist) (car orlist))))
15215 ;; Return the string and lisp forms of the matcher
15216 (setq matcher (if todomatcher
15217 (list 'and tagsmatcher todomatcher)
15218 tagsmatcher))
15219 (cons match0 matcher)))
15221 (defun org-match-any-p (re list)
15222 "Does re match any element of list?"
15223 (setq list (mapcar (lambda (x) (string-match re x)) list))
15224 (delq nil list))
15226 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15227 (defvar org-tags-overlay (org-make-overlay 1 1))
15228 (org-detach-overlay org-tags-overlay)
15230 (defun org-align-tags-here (to-col)
15231 ;; Assumes that this is a headline
15232 (let ((pos (point)) (col (current-column)) tags)
15233 (beginning-of-line 1)
15235 (< pos (match-beginning 2)))
15236 (progn
15237 (setq tags (match-string 2))
15238 (goto-char (match-beginning 1))
15239 (insert " ")
15240 (delete-region (point) (1+ (match-end 0)))
15241 (backward-char 1)
15242 (move-to-column
15243 (max (1+ (current-column))
15244 (1+ col)
15245 (if (> to-col 0)
15246 to-col
15247 (- (abs to-col) (length tags))))
15248 t)
15249 (insert tags)
15250 (move-to-column (min (current-column) col) t))
15251 (goto-char pos))))
15253 (defun org-set-tags (&optional arg just-align)
15254 "Set the tags for the current headline.
15255 With prefix ARG, realign all tags in headings in the current buffer."
15256 (interactive "P")
15257 (let* ((re (concat "^" outline-regexp))
15258 (current (org-get-tags-string))
15259 (col (current-column))
15260 (org-setting-tags t)
15261 table current-tags inherited-tags ; computed below when needed
15262 tags p0 c0 c1 rpl)
15263 (if arg
15264 (save-excursion
15265 (goto-char (point-min))
15266 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15267 (while (re-search-forward re nil t)
15268 (org-set-tags nil t)
15269 (end-of-line 1)))
15270 (message "All tags realigned to column %d" org-tags-column))
15271 (if just-align
15272 (setq tags current)
15273 ;; Get a new set of tags from the user
15274 (save-excursion
15275 (setq table (or org-tag-alist (org-get-buffer-tags))
15276 org-last-tags-completion-table table
15277 current-tags (org-split-string current ":")
15278 inherited-tags (nreverse
15279 (nthcdr (length current-tags)
15280 (nreverse (org-get-tags-at))))
15281 tags
15282 (if (or (eq t org-use-fast-tag-selection)
15283 (and org-use-fast-tag-selection
15284 (delq nil (mapcar 'cdr table))))
15285 (org-fast-tag-selection
15286 current-tags inherited-tags table
15287 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15288 (let ((org-add-colon-after-tag-completion t))
15289 (org-trim
15290 (org-without-partial-completion
15291 (completing-read "Tags: " 'org-tags-completion-function
15292 nil nil current 'org-tags-history)))))))
15293 (while (string-match "[-+&]+" tags)
15294 ;; No boolean logic, just a list
15295 (setq tags (replace-match ":" t t tags))))
15298 (setq tags "")
15299 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15300 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15302 ;; Insert new tags at the correct column
15303 (beginning-of-line 1)
15304 (cond
15305 ((and (equal current "") (equal tags "")))
15306 ((re-search-forward
15308 (point-at-eol) t)
15309 (if (equal tags "")
15310 (setq rpl "")
15311 (goto-char (match-beginning 0))
15312 (setq c0 (current-column) p0 (point)
15313 c1 (max (1+ c0) (if (> org-tags-column 0)
15314 org-tags-column
15315 (- (- org-tags-column) (length tags))))
15316 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15317 (replace-match rpl t t)
15318 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
15319 tags)
15320 (t (error "Tags alignment failed")))
15321 (move-to-column col)
15322 (unless just-align
15323 (run-hooks 'org-after-tags-change-hook)))))
15325 (defun org-change-tag-in-region (beg end tag off)
15326 "Add or remove TAG for each entry in the region.
15327 This works in the agenda, and also in an org-mode buffer."
15328 (interactive
15329 (list (region-beginning) (region-end)
15330 (let ((org-last-tags-completion-table
15331 (if (org-mode-p)
15332 (org-get-buffer-tags)
15333 (org-global-tags-completion-table))))
15334 (completing-read
15335 "Tag: " 'org-tags-completion-function nil nil nil
15336 'org-tags-history))
15337 (progn
15338 (message "[s]et or [r]emove? ")
15339 (equal (read-char-exclusive) ?r))))
15340 (if (fboundp 'deactivate-mark) (deactivate-mark))
15341 (let ((agendap (equal major-mode 'org-agenda-mode))
15342 l1 l2 m buf pos newhead (cnt 0))
15343 (goto-char end)
15344 (setq l2 (1- (org-current-line)))
15345 (goto-char beg)
15346 (setq l1 (org-current-line))
15347 (loop for l from l1 to l2 do
15348 (goto-line l)
15349 (setq m (get-text-property (point) 'org-hd-marker))
15350 (when (or (and (org-mode-p) (org-on-heading-p))
15351 (and agendap m))
15352 (setq buf (if agendap (marker-buffer m) (current-buffer))
15353 pos (if agendap m (point)))
15354 (with-current-buffer buf
15355 (save-excursion
15356 (save-restriction
15357 (goto-char pos)
15358 (setq cnt (1+ cnt))
15359 (org-toggle-tag tag (if off 'off 'on))
15360 (setq newhead (org-get-heading)))))
15361 (and agendap (org-agenda-change-all-lines newhead m))))
15362 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15364 (defun org-tags-completion-function (string predicate &optional flag)
15365 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15366 (confirm (lambda (x) (stringp (car x)))))
15368 (setq s1 (match-string 1 string)
15369 s2 (match-string 2 string))
15370 (setq s1 "" s2 string))
15371 (cond
15372 ((eq flag nil)
15373 ;; try completion
15374 (setq rtn (try-completion s2 ctable confirm))
15375 (if (stringp rtn)
15376 (setq rtn
15377 (concat s1 s2 (substring rtn (length s2))
15378 (if (and org-add-colon-after-tag-completion
15379 (assoc rtn ctable))
15380 ":" ""))))
15381 rtn)
15382 ((eq flag t)
15383 ;; all-completions
15384 (all-completions s2 ctable confirm)
15385 )
15386 ((eq flag 'lambda)
15387 ;; exact match?
15388 (assoc s2 ctable)))
15389 ))
15391 (defun org-fast-tag-insert (kwd tags face &optional end)
15392 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15393 (insert (format "%-12s" (concat kwd ":"))
15394 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15395 (or end "")))
15397 (defun org-fast-tag-show-exit (flag)
15398 (save-excursion
15399 (goto-line 3)
15401 (replace-match ""))
15402 (when flag
15403 (end-of-line 1)
15404 (move-to-column (- (window-width) 19) t)
15405 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15407 (defun org-set-current-tags-overlay (current prefix)
15408 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15409 (if (featurep 'xemacs)
15410 (org-overlay-display org-tags-overlay (concat prefix s)
15411 'secondary-selection)
15412 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15413 (org-overlay-display org-tags-overlay (concat prefix s)))))
15415 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15416 "Fast tag selection with single keys.
15417 CURRENT is the current list of tags in the headline, INHERITED is the
15418 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15419 possibly with grouping information. TODO-TABLE is a similar table with
15420 TODO keywords, should these have keys assigned to them.
15421 If the keys are nil, a-z are automatically assigned.
15422 Returns the new tags string, or nil to not change the current settings."
15423 (let* ((fulltable (append table todo-table))
15424 (maxlen (apply 'max (mapcar
15425 (lambda (x)
15426 (if (stringp (car x)) (string-width (car x)) 0))
15427 fulltable)))
15428 (buf (current-buffer))
15429 (expert (eq org-fast-tag-selection-single-key 'expert))
15430 (buffer-tags nil)
15431 (fwidth (+ maxlen 3 1 3))
15432 (ncol (/ (- (window-width) 4) fwidth))
15433 (i-face 'org-done)
15434 (c-face 'org-todo)
15435 tg cnt e c char c1 c2 ntable tbl rtn
15436 ov-start ov-end ov-prefix
15437 (exit-after-next org-fast-tag-selection-single-key)
15438 (done-keywords org-done-keywords)
15439 groups ingroup)
15440 (save-excursion
15441 (beginning-of-line 1)
15442 (if (looking-at
15444 (setq ov-start (match-beginning 1)
15445 ov-end (match-end 1)
15446 ov-prefix "")
15447 (setq ov-start (1- (point-at-eol))
15448 ov-end (1+ ov-start))
15450 (setq ov-prefix
15451 (concat
15452 (buffer-substring (1- (point)) (point))
15453 (if (> (current-column) org-tags-column)
15454 " "
15455 (make-string (- org-tags-column (current-column)) ?\ ))))))
15456 (org-move-overlay org-tags-overlay ov-start ov-end)
15457 (save-window-excursion
15458 (if expert
15459 (set-buffer (get-buffer-create " *Org tags*"))
15460 (delete-other-windows)
15461 (split-window-vertically)
15462 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15463 (erase-buffer)
15464 (org-set-local 'org-done-keywords done-keywords)
15467 (org-fast-tag-show-exit exit-after-next)
15468 (org-set-current-tags-overlay current ov-prefix)
15469 (setq tbl fulltable char ?a cnt 0)
15470 (while (setq e (pop tbl))
15471 (cond
15472 ((equal e '(:startgroup))
15473 (push '() groups) (setq ingroup t)
15474 (when (not (= cnt 0))
15475 (setq cnt 0)
15477 (insert "{ "))
15478 ((equal e '(:endgroup))
15479 (setq ingroup nil cnt 0)
15481 (t
15482 (setq tg (car e) c2 nil)
15483 (if (cdr e)
15484 (setq c (cdr e))
15485 ;; automatically assign a character.
15486 (setq c1 (string-to-char
15487 (downcase (substring
15488 tg (if (= (string-to-char tg) ?@) 1 0)))))
15489 (if (or (rassoc c1 ntable) (rassoc c1 table))
15490 (while (or (rassoc char ntable) (rassoc char table))
15491 (setq char (1+ char)))
15492 (setq c2 c1))
15493 (setq c (or c2 char)))
15494 (if ingroup (push tg (car groups)))
15495 (setq tg (org-add-props tg nil 'face
15496 (cond
15497 ((not (assoc tg table))
15498 (org-get-todo-face tg))
15499 ((member tg current) c-face)
15500 ((member tg inherited) i-face)
15501 (t nil))))
15502 (if (and (= cnt 0) (not ingroup)) (insert " "))
15503 (insert "[" c "] " tg (make-string
15504 (- fwidth 4 (length tg)) ?\ ))
15505 (push (cons tg c) ntable)
15506 (when (= (setq cnt (1+ cnt)) ncol)
15508 (if ingroup (insert " "))
15509 (setq cnt 0)))))
15510 (setq ntable (nreverse ntable))
15512 (goto-char (point-min))
15513 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15514 (fit-window-to-buffer))
15515 (setq rtn
15516 (catch 'exit
15517 (while t
15518 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15519 (if groups " [!] no groups" " [!]groups")
15520 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15521 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15522 (cond
15524 ((= c ?!)
15525 (setq groups (not groups))
15526 (goto-char (point-min))
15527 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15528 ((= c ?\C-c)
15529 (if (not expert)
15530 (org-fast-tag-show-exit
15531 (setq exit-after-next (not exit-after-next)))
15532 (setq expert nil)
15533 (delete-other-windows)
15534 (split-window-vertically)
15535 (org-switch-to-buffer-other-window " *Org tags*")
15536 (and (fboundp 'fit-window-to-buffer)
15537 (fit-window-to-buffer))))
15538 ((or (= c ?\C-g)
15539 (and (= c ?q) (not (rassoc c ntable))))
15540 (org-detach-overlay org-tags-overlay)
15541 (setq quit-flag t))
15542 ((= c ?\ )
15543 (setq current nil)
15544 (if exit-after-next (setq exit-after-next 'now)))
15546 (condition-case nil
15547 (setq tg (completing-read
15548 "Tag: "
15549 (or buffer-tags
15550 (with-current-buffer buf
15551 (org-get-buffer-tags)))))
15552 (quit (setq tg "")))
15554 (add-to-list 'buffer-tags (list tg))
15555 (if (member tg current)
15556 (setq current (delete tg current))
15557 (push tg current)))
15558 (if exit-after-next (setq exit-after-next 'now)))
15559 ((setq e (rassoc c todo-table) tg (car e))
15560 (with-current-buffer buf
15561 (save-excursion (org-todo tg)))
15562 (if exit-after-next (setq exit-after-next 'now)))
15563 ((setq e (rassoc c ntable) tg (car e))
15564 (if (member tg current)
15565 (setq current (delete tg current))
15566 (loop for g in groups do
15567 (if (member tg g)
15568 (mapc (lambda (x)
15569 (setq current (delete x current)))
15570 g)))
15571 (push tg current))
15572 (if exit-after-next (setq exit-after-next 'now))))
15574 ;; Create a sorted list
15575 (setq current
15576 (sort current
15577 (lambda (a b)
15578 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15579 (if (eq exit-after-next 'now) (throw 'exit t))
15580 (goto-char (point-min))
15581 (beginning-of-line 2)
15582 (delete-region (point) (point-at-eol))
15583 (org-fast-tag-insert "Current" current c-face)
15584 (org-set-current-tags-overlay current ov-prefix)
15585 (while (re-search-forward
15587 (setq tg (match-string 1))
15588 (add-text-properties
15589 (match-beginning 1) (match-end 1)
15590 (list 'face
15591 (cond
15592 ((member tg current) c-face)
15593 ((member tg inherited) i-face)
15594 (t (get-text-property (match-beginning 1) 'face))))))
15595 (goto-char (point-min)))))
15596 (org-detach-overlay org-tags-overlay)
15597 (if rtn
15598 (mapconcat 'identity current ":")
15599 nil))))
15601 (defun org-get-tags-string ()
15602 "Get the TAGS string in the current headline."
15603 (unless (org-on-heading-p t)
15604 (error "Not on a heading"))
15605 (save-excursion
15606 (beginning-of-line 1)
15608 (org-match-string-no-properties 1)
15609 "")))
15611 (defun org-get-tags ()
15612 "Get the list of tags specified in the current headline."
15613 (org-split-string (org-get-tags-string) ":"))
15615 (defun org-get-buffer-tags ()
15616 "Get a table of all tags used in the buffer, for completion."
15617 (let (tags)
15618 (save-excursion
15619 (goto-char (point-min))
15620 (while (re-search-forward
15622 (when (equal (char-after (point-at-bol 0)) ?*)
15623 (mapc (lambda (x) (add-to-list 'tags x))
15624 (org-split-string (org-match-string-no-properties 1) ":")))))
15625 (mapcar 'list tags)))
15628 ;;;; Properties
15630 ;;; Setting and retrieving properties
15632 (defconst org-special-properties
15633 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15634 "TIMESTAMP" "TIMESTAMP_IA")
15635 "The special properties valid in Org-mode.
15637 These are properties that are not defined in the property drawer,
15638 but in some other way.")
15640 (defconst org-default-properties
15641 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15642 "LOCATION" "LOGGING" "COLUMNS")
15643 "Some properties that are used by Org-mode for various purposes.
15644 Being in this list makes sure that they are offered for completion.")
15647 "Regular expression matching the first line of a property drawer.")
15650 "Regular expression matching the first line of a property drawer.")
15652 (defun org-property-action ()
15653 "Do an action on properties."
15654 (interactive)
15655 (let (c)
15656 (org-at-property-p)
15657 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15658 (setq c (read-char-exclusive))
15659 (cond
15660 ((equal c ?s)
15661 (call-interactively 'org-set-property))
15662 ((equal c ?d)
15663 (call-interactively 'org-delete-property))
15664 ((equal c ?D)
15665 (call-interactively 'org-delete-property-globally))
15666 ((equal c ?c)
15667 (call-interactively 'org-compute-property-at-point))
15668 (t (error "No such property action %c" c)))))
15670 (defun org-at-property-p ()
15671 "Is the cursor in a property line?"
15672 ;; FIXME: Does not check if we are actually in the drawer.
15673 ;; FIXME: also returns true on any drawers.....
15674 ;; This is used by C-c C-c for property action.
15675 (save-excursion
15676 (beginning-of-line 1)
15679 (defmacro org-with-point-at (pom &rest body)
15680 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15681 (declare (indent 1) (debug t))
15682 `(save-excursion
15683 (if (markerp pom) (set-buffer (marker-buffer pom)))
15684 (save-excursion
15685 (goto-char (or pom (point)))
15686 ,@body)))
15688 (defun org-get-property-block (&optional beg end force)
15689 "Return the (beg . end) range of the body of the property drawer.
15690 BEG and END can be beginning and end of subtree, if not given
15691 they will be found.
15692 If the drawer does not exist and FORCE is non-nil, create the drawer."
15693 (catch 'exit
15694 (save-excursion
15695 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15696 (end (or end (progn (outline-next-heading) (point)))))
15697 (goto-char beg)
15698 (if (re-search-forward org-property-start-re end t)
15699 (setq beg (1+ (match-end 0)))
15700 (if force
15701 (save-excursion
15702 (org-insert-property-drawer)
15703 (setq end (progn (outline-next-heading) (point))))
15704 (throw 'exit nil))
15705 (goto-char beg)
15706 (if (re-search-forward org-property-start-re end t)
15707 (setq beg (1+ (match-end 0)))))
15708 (if (re-search-forward org-property-end-re end t)
15709 (setq end (match-beginning 0))
15710 (or force (throw 'exit nil))
15711 (goto-char beg)
15712 (setq end beg)
15713 (org-indent-line-function)
15715 (cons beg end)))))
15717 (defun org-entry-properties (&optional pom which)
15718 "Get all properties of the entry at point-or-marker POM.
15719 This includes the TODO keyword, the tags, time strings for deadline,
15720 scheduled, and clocking, and any additional properties defined in the
15721 entry. The return value is an alist, keys may occur multiple times
15722 if the property key was used several times.
15723 POM may also be nil, in which case the current entry is used.
15724 If WHICH is nil or `all', get all properties. If WHICH is
15725 `special' or `standard', only get that subclass."
15726 (setq which (or which 'all))
15727 (org-with-point-at pom
15728 (let ((clockstr (substring org-clock-string 0 -1))
15729 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15730 beg end range props sum-props key value string clocksum)
15731 (save-excursion
15732 (when (condition-case nil (org-back-to-heading t) (error nil))
15733 (setq beg (point))
15734 (setq sum-props (get-text-property (point) 'org-summaries))
15735 (setq clocksum (get-text-property (point) :org-clock-minutes))
15736 (outline-next-heading)
15737 (setq end (point))
15738 (when (memq which '(all special))
15739 ;; Get the special properties, like TODO and tags
15740 (goto-char beg)
15741 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15742 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15743 (when (looking-at org-priority-regexp)
15744 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15745 (when (and (setq value (org-get-tags-string))
15747 (push (cons "TAGS" value) props))
15748 (when (setq value (org-get-tags-at))
15749 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15750 props))
15751 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15752 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15753 string (if (equal key clockstr)
15754 (org-no-properties
15755 (org-trim
15756 (buffer-substring
15757 (match-beginning 3) (goto-char (point-at-eol)))))
15758 (substring (org-match-string-no-properties 3) 1 -1)))
15759 (unless key
15760 (if (= (char-after (match-beginning 3)) ?\[)
15761 (setq key "TIMESTAMP_IA")
15762 (setq key "TIMESTAMP")))
15763 (when (or (equal key clockstr) (not (assoc key props)))
15764 (push (cons key string) props)))
15766 )
15768 (when (memq which '(all standard))
15769 ;; Get the standard properties, like :PORP: ...
15770 (setq range (org-get-property-block beg end))
15771 (when range
15772 (goto-char (car range))
15773 (while (re-search-forward
15775 (cdr range) t)
15776 (setq key (org-match-string-no-properties 1)
15777 value (org-trim (or (org-match-string-no-properties 2) "")))
15778 (unless (member key excluded)
15779 (push (cons key (or value "")) props)))))
15780 (if clocksum
15781 (push (cons "CLOCKSUM"
15782 (org-column-number-to-string (/ (float clocksum) 60.)
15783 'add_times))
15784 props))
15785 (append sum-props (nreverse props)))))))
15787 (defun org-entry-get (pom property &optional inherit)
15788 "Get value of PROPERTY for entry at point-or-marker POM.
15789 If INHERIT is non-nil and the entry does not have the property,
15790 then also check higher levels of the hierarchy.
15791 If the property is present but empty, the return value is the empty string.
15792 If the property is not present at all, nil is returned."
15793 (org-with-point-at pom
15794 (if inherit
15795 (org-entry-get-with-inheritance property)
15796 (if (member property org-special-properties)
15797 ;; We need a special property. Use brute force, get all properties.
15798 (cdr (assoc property (org-entry-properties nil 'special)))
15799 (let ((range (org-get-property-block)))
15800 (if (and range
15801 (goto-char (car range))
15802 (re-search-forward
15804 (cdr range) t))
15805 ;; Found the property, return it.
15806 (if (match-end 1)
15807 (org-match-string-no-properties 1)
15808 "")))))))
15810 (defun org-entry-delete (pom property)
15811 "Delete the property PROPERTY from entry at point-or-marker POM."
15812 (org-with-point-at pom
15813 (if (member property org-special-properties)
15814 nil ; cannot delete these properties.
15815 (let ((range (org-get-property-block)))
15816 (if (and range
15817 (goto-char (car range))
15818 (re-search-forward
15820 (cdr range) t))
15821 (progn
15822 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15823 t)
15824 nil)))))
15826 ;; Multi-values properties are properties that contain multiple values
15827 ;; These values are assumed to be single words, separated by whitespace.
15828 (defun org-entry-add-to-multivalued-property (pom property value)
15829 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15830 (let* ((old (org-entry-get pom property))
15832 (unless (member value values)
15833 (setq values (cons value values))
15834 (org-entry-put pom property
15835 (mapconcat 'identity values " ")))))
15837 (defun org-entry-remove-from-multivalued-property (pom property value)
15838 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15839 (let* ((old (org-entry-get pom property))
15841 (when (member value values)
15842 (setq values (delete value values))
15843 (org-entry-put pom property
15844 (mapconcat 'identity values " ")))))
15846 (defun org-entry-member-in-multivalued-property (pom property value)
15847 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15848 (let* ((old (org-entry-get pom property))
15850 (member value values)))
15852 (defvar org-entry-property-inherited-from (make-marker))
15854 (defun org-entry-get-with-inheritance (property)
15855 "Get entry property, and search higher levels if not present."
15856 (let (tmp)
15857 (save-excursion
15858 (save-restriction
15859 (widen)
15860 (catch 'ex
15861 (while t
15862 (when (setq tmp (org-entry-get nil property))
15863 (org-back-to-heading t)
15864 (move-marker org-entry-property-inherited-from (point))
15865 (throw 'ex tmp))
15866 (or (org-up-heading-safe) (throw 'ex nil)))))
15867 (or tmp (cdr (assoc property org-local-properties))
15868 (cdr (assoc property org-global-properties))))))
15870 (defun org-entry-put (pom property value)
15871 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15872 (org-with-point-at pom
15873 (org-back-to-heading t)
15874 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15875 range)
15876 (cond
15877 ((equal property "TODO")
15879 (not (member value org-todo-keywords-1)))
15881 (if (or (not value)
15883 (setq value 'none))
15884 (org-todo value)
15885 (org-set-tags nil 'align))
15886 ((equal property "PRIORITY")
15888 (string-to-char value) ?\ ))
15889 (org-set-tags nil 'align))
15890 ((equal property "SCHEDULED")
15891 (if (re-search-forward org-scheduled-time-regexp end t)
15892 (cond
15893 ((eq value 'earlier) (org-timestamp-change -1 'day))
15894 ((eq value 'later) (org-timestamp-change 1 'day))
15895 (t (call-interactively 'org-schedule)))
15896 (call-interactively 'org-schedule)))
15897 ((equal property "DEADLINE")
15898 (if (re-search-forward org-deadline-time-regexp end t)
15899 (cond
15900 ((eq value 'earlier) (org-timestamp-change -1 'day))
15901 ((eq value 'later) (org-timestamp-change 1 'day))
15902 (t (call-interactively 'org-deadline)))
15903 (call-interactively 'org-deadline)))
15904 ((member property org-special-properties)
15905 (error "The %s property can not yet be set with `org-entry-put'"
15906 property))
15907 (t ; a non-special property
15908 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15909 (setq range (org-get-property-block beg end 'force))
15910 (goto-char (car range))
15911 (if (re-search-forward
15913 (progn
15914 (delete-region (match-beginning 1) (match-end 1))
15915 (goto-char (match-beginning 1)))
15916 (goto-char (cdr range))
15918 (backward-char 1)
15919 (org-indent-line-function)
15920 (insert ":" property ":"))
15921 (and value (insert " " value))
15922 (org-indent-line-function)))))))
15924 (defun org-buffer-property-keys (&optional include-specials include-defaults)
15925 "Get all property keys in the current buffer.
15926 With INCLUDE-SPECIALS, also list the special properties that relect things
15927 like tags and TODO state.
15928 With INCLUDE-DEFAULTS, also include properties that has special meaning
15929 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING."
15930 (let (rtn range)
15931 (save-excursion
15932 (save-restriction
15933 (widen)
15934 (goto-char (point-min))
15935 (while (re-search-forward org-property-start-re nil t)
15936 (setq range (org-get-property-block))
15937 (goto-char (car range))
15938 (while (re-search-forward
15940 (cdr range) t)
15941 (add-to-list 'rtn (org-match-string-no-properties 1)))
15942 (outline-next-heading))))
15944 (when include-specials
15945 (setq rtn (append org-special-properties rtn)))
15947 (when include-defaults
15948 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
15950 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15952 (defun org-property-values (key)
15953 "Return a list of all values of property KEY."
15954 (save-excursion
15955 (save-restriction
15956 (widen)
15957 (goto-char (point-min))
15959 values)
15960 (while (re-search-forward re nil t)
15961 (add-to-list 'values (org-trim (match-string 1))))
15962 (delete "" values)))))
15964 (defun org-insert-property-drawer ()
15965 "Insert a property drawer into the current entry."
15966 (interactive)
15967 (org-back-to-heading t)
15968 (looking-at outline-regexp)
15969 (let ((indent (- (match-end 0)(match-beginning 0)))
15970 (beg (point))
15972 end hiddenp)
15973 (outline-next-heading)
15974 (setq end (point))
15975 (goto-char beg)
15976 (while (re-search-forward re end t))
15977 (setq hiddenp (org-invisible-p))
15978 (end-of-line 1)
15980 (org-skip-over-state-notes)
15982 (if (eq (char-before) ?*) (forward-char 1))
15984 (beginning-of-line 0)
15985 (indent-to-column indent)
15986 (beginning-of-line 2)
15987 (indent-to-column indent)
15988 (beginning-of-line 0)
15989 (if hiddenp
15990 (save-excursion
15991 (org-back-to-heading t)
15992 (hide-entry))
15993 (org-flag-drawer t))))
15995 (defun org-set-property (property value)
15996 "In the current entry, set PROPERTY to VALUE.
15997 When called interactively, this will prompt for a property name, offering
15998 completion on existing and default properties. And then it will prompt
15999 for a value, offering competion either on allowed values (via an inherited
16000 xxx_ALL property) or on existing values in other instances of this property
16001 in the current file."
16002 (interactive
16003 (let* ((prop (completing-read
16004 "Property: " (mapcar 'list (org-buffer-property-keys nil t))))
16005 (cur (org-entry-get nil prop))
16006 (allowed (org-property-get-allowed-values nil prop 'table))
16007 (existing (mapcar 'list (org-property-values prop)))
16008 (val (if allowed
16009 (completing-read "Value: " allowed nil 'req-match)
16010 (completing-read
16012 (concat "[" cur "]") "")
16013 ": ")
16014 existing nil nil "" nil cur))))
16015 (list prop (if (equal val "") cur val))))
16016 (unless (equal (org-entry-get nil property) value)
16017 (org-entry-put nil property value)))
16019 (defun org-delete-property (property)
16020 "In the current entry, delete PROPERTY."
16021 (interactive
16022 (let* ((prop (completing-read
16023 "Property: " (org-entry-properties nil 'standard))))
16024 (list prop)))
16025 (message "Property %s %s" property
16026 (if (org-entry-delete nil property)
16027 "deleted"
16028 "was not present in the entry")))
16030 (defun org-delete-property-globally (property)
16031 "Remove PROPERTY globally, from all entries."
16032 (interactive
16033 (let* ((prop (completing-read
16034 "Globally remove property: "
16035 (mapcar 'list (org-buffer-property-keys)))))
16036 (list prop)))
16037 (save-excursion
16038 (save-restriction
16039 (widen)
16040 (goto-char (point-min))
16041 (let ((cnt 0))
16042 (while (re-search-forward
16044 nil t)
16045 (setq cnt (1+ cnt))
16046 (replace-match ""))
16049 (defvar org-columns-current-fmt-compiled) ; defined below
16051 (defun org-compute-property-at-point ()
16052 "Compute the property at point.
16053 This looks for an enclosing column format, extracts the operator and
16054 then applies it to the proerty in the column format's scope."
16055 (interactive)
16056 (unless (org-at-property-p)
16057 (error "Not at a property"))
16058 (let ((prop (org-match-string-no-properties 2)))
16059 (org-columns-get-format-and-top-level)
16060 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16061 (error "No operator defined for property %s" prop))
16062 (org-columns-compute prop)))
16064 (defun org-property-get-allowed-values (pom property &optional table)
16065 "Get allowed values for the property PROPERTY.
16066 When TABLE is non-nil, return an alist that can directly be used for
16067 completion."
16068 (let (vals)
16069 (cond
16070 ((equal property "TODO")
16071 (setq vals (org-with-point-at pom
16072 (append org-todo-keywords-1 '("")))))
16073 ((equal property "PRIORITY")
16074 (let ((n org-lowest-priority))
16075 (while (>= n org-highest-priority)
16076 (push (char-to-string n) vals)
16077 (setq n (1- n)))))
16078 ((member property org-special-properties))
16079 (t
16080 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16083 (setq vals (car (read-from-string (concat "(" vals ")"))))
16084 (setq vals (mapcar (lambda (x)
16085 (cond ((stringp x) x)
16086 ((numberp x) (number-to-string x))
16087 ((symbolp x) (symbol-name x))
16088 (t "???")))
16089 vals)))))
16090 (if table (mapcar 'list vals) vals)))
16092 (defun org-property-previous-allowed-value (&optional previous)
16093 "Switch to the next allowed value for this property."
16094 (interactive)
16095 (org-property-next-allowed-value t))
16097 (defun org-property-next-allowed-value (&optional previous)
16098 "Switch to the next allowed value for this property."
16099 (interactive)
16100 (unless (org-at-property-p)
16101 (error "Not at a property"))
16102 (let* ((key (match-string 2))
16103 (value (match-string 3))
16104 (allowed (or (org-property-get-allowed-values (point) key)
16105 (and (member value '("[ ]" "[-]" "[X]"))
16106 '("[ ]" "[X]"))))
16107 nval)
16108 (unless allowed
16109 (error "Allowed values for this property have not been defined"))
16110 (if previous (setq allowed (reverse allowed)))
16111 (if (member value allowed)
16112 (setq nval (car (cdr (member value allowed)))))
16113 (setq nval (or nval (car allowed)))
16114 (if (equal nval value)
16115 (error "Only one allowed value for this property"))
16116 (org-at-property-p)
16117 (replace-match (concat " :" key ": " nval) t t)
16118 (org-indent-line-function)
16119 (beginning-of-line 1)
16122 (defun org-find-entry-with-id (ident)
16123 "Locate the entry that contains the ID property with exact value IDENT.
16124 IDENT can be a string, a symbol or a number, this function will search for
16125 the string representation of it.
16126 Return the position where this entry starts, or nil if there is no such entry."
16127 (let ((id (cond
16128 ((stringp ident) ident)
16129 ((symbol-name ident) (symbol-name ident))
16130 ((numberp ident) (number-to-string ident))
16131 (t (error "IDENT %s must be a string, symbol or number" ident))))
16132 (case-fold-search nil))
16133 (save-excursion
16134 (save-restriction
16135 (goto-char (point-min))
16136 (when (re-search-forward
16138 nil t)
16139 (org-back-to-heading)
16140 (point))))))
16142 ;;; Column View
16144 (defvar org-columns-overlays nil
16145 "Holds the list of current column overlays.")
16147 (defvar org-columns-current-fmt nil
16148 "Local variable, holds the currently active column format.")
16149 (defvar org-columns-current-fmt-compiled nil
16150 "Local variable, holds the currently active column format.
16151 This is the compiled version of the format.")
16152 (defvar org-columns-current-widths nil
16153 "Loval variable, holds the currently widths of fields.")
16154 (defvar org-columns-current-maxwidths nil
16155 "Loval variable, holds the currently active maximum column widths.")
16156 (defvar org-columns-begin-marker (make-marker)
16157 "Points to the position where last a column creation command was called.")
16158 (defvar org-columns-top-level-marker (make-marker)
16159 "Points to the position where current columns region starts.")
16161 (defvar org-columns-map (make-sparse-keymap)
16162 "The keymap valid in column display.")
16164 (defun org-columns-content ()
16165 "Switch to contents view while in columns view."
16166 (interactive)
16167 (org-overview)
16168 (org-content))
16170 (org-defkey org-columns-map "c" 'org-columns-content)
16171 (org-defkey org-columns-map "o" 'org-overview)
16172 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16173 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16174 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16175 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16176 (org-defkey org-columns-map "v" 'org-columns-show-value)
16177 (org-defkey org-columns-map "q" 'org-columns-quit)
16178 (org-defkey org-columns-map "r" 'org-columns-redo)
16179 (org-defkey org-columns-map [left] 'backward-char)
16180 (org-defkey org-columns-map "\M-b" 'backward-char)
16181 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16182 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16183 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16184 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16185 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16186 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16187 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16188 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16189 (org-defkey org-columns-map "<" 'org-columns-narrow)
16190 (org-defkey org-columns-map ">" 'org-columns-widen)
16191 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16192 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16193 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16194 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16196 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16197 '("Column"
16198 ["Edit property" org-columns-edit-value t]
16199 ["Next allowed value" org-columns-next-allowed-value t]
16200 ["Previous allowed value" org-columns-previous-allowed-value t]
16201 ["Show full value" org-columns-show-value t]
16202 ["Edit allowed values" org-columns-edit-allowed t]
16203 "--"
16204 ["Edit column attributes" org-columns-edit-attributes t]
16205 ["Increase column width" org-columns-widen t]
16206 ["Decrease column width" org-columns-narrow t]
16207 "--"
16208 ["Move column right" org-columns-move-right t]
16209 ["Move column left" org-columns-move-left t]
16210 ["Add column" org-columns-new t]
16211 ["Delete column" org-columns-delete t]
16212 "--"
16213 ["CONTENTS" org-columns-content t]
16214 ["OVERVIEW" org-overview t]
16215 ["Refresh columns display" org-columns-redo t]
16216 "--"
16217 ["Open link" org-columns-open-link t]
16218 "--"
16219 ["Quit" org-columns-quit t]))
16221 (defun org-columns-new-overlay (beg end &optional string face)
16222 "Create a new column overlay and add it to the list."
16223 (let ((ov (org-make-overlay beg end)))
16224 (org-overlay-put ov 'face (or face 'secondary-selection))
16225 (org-overlay-display ov string face)
16226 (push ov org-columns-overlays)
16227 ov))
16229 (defun org-columns-display-here (&optional props)
16230 "Overlay the current line with column display."
16231 (interactive)
16232 (let* ((fmt org-columns-current-fmt-compiled)
16233 (beg (point-at-bol))
16234 (level-face (save-excursion
16235 (beginning-of-line 1)
16237 (org-get-level-face 2))))
16238 (color (list :foreground
16239 (face-attribute (or level-face 'default) :foreground)))
16240 props pom property ass width f string ov column val modval)
16241 ;; Check if the entry is in another buffer.
16242 (unless props
16243 (if (eq major-mode 'org-agenda-mode)
16244 (setq pom (or (get-text-property (point) 'org-hd-marker)
16245 (get-text-property (point) 'org-marker))
16246 props (if pom (org-entry-properties pom) nil))
16247 (setq props (org-entry-properties nil))))
16248 ;; Walk the format
16249 (while (setq column (pop fmt))
16250 (setq property (car column)
16251 ass (if (equal property "ITEM")
16252 (cons "ITEM"
16253 (save-match-data
16254 (org-no-properties
16255 (org-remove-tabs
16256 (buffer-substring-no-properties
16257 (point-at-bol) (point-at-eol))))))
16258 (assoc property props))
16259 width (or (cdr (assoc property org-columns-current-maxwidths))
16260 (nth 2 column)
16261 (length property))
16262 f (format "%%-%d.%ds | " width width)
16263 val (or (cdr ass) "")
16264 modval (if (equal property "ITEM")
16265 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16266 string (format f (or modval val)))
16267 ;; Create the overlay
16268 (org-unmodified
16269 (setq ov (org-columns-new-overlay
16270 beg (setq beg (1+ beg)) string
16271 (list color 'org-column)))
16272 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16273 (org-overlay-put ov 'keymap org-columns-map)
16274 (org-overlay-put ov 'org-columns-key property)
16275 (org-overlay-put ov 'org-columns-value (cdr ass))
16276 (org-overlay-put ov 'org-columns-value-modified modval)
16277 (org-overlay-put ov 'org-columns-pom pom)
16278 (org-overlay-put ov 'org-columns-format f))
16279 (if (or (not (char-after beg))
16281 (let ((inhibit-read-only t))
16282 (save-excursion
16283 (goto-char beg)
16284 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16285 ;; Make the rest of the line disappear.
16286 (org-unmodified
16287 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16288 (org-overlay-put ov 'invisible t)
16289 (org-overlay-put ov 'keymap org-columns-map)
16290 (org-overlay-put ov 'intangible t)
16291 (push ov org-columns-overlays)
16292 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16293 (org-overlay-put ov 'keymap org-columns-map)
16294 (push ov org-columns-overlays)
16295 (let ((inhibit-read-only t))
16296 (put-text-property (max (point-min) (1- (point-at-bol)))
16297 (min (point-max) (1+ (point-at-eol)))
16298 'read-only "Type `e' to edit property")))))
16300 (defvar org-previous-header-line-format nil
16301 "The header line format before column view was turned on.")
16302 (defvar org-columns-inhibit-recalculation nil
16303 "Inhibit recomputing of columns on column view startup.")
16306 (defvar header-line-format)
16307 (defun org-columns-display-here-title ()
16308 "Overlay the newline before the current line with the table title."
16309 (interactive)
16310 (let ((fmt org-columns-current-fmt-compiled)
16311 string (title "")
16312 property width f column str widths)
16313 (while (setq column (pop fmt))
16314 (setq property (car column)
16315 str (or (nth 1 column) property)
16316 width (or (cdr (assoc property org-columns-current-maxwidths))
16317 (nth 2 column)
16318 (length str))
16319 widths (push width widths)
16320 f (format "%%-%d.%ds | " width width)
16321 string (format f str)
16322 title (concat title string)))
16323 (setq title (concat
16324 (org-add-props " " nil 'display '(space :align-to 0))
16325 (org-add-props title nil 'face '(:weight bold :underline t))))
16326 (org-set-local 'org-previous-header-line-format header-line-format)
16327 (org-set-local 'org-columns-current-widths (nreverse widths))
16328 (setq header-line-format title)))
16330 (defun org-columns-remove-overlays ()
16331 "Remove all currently active column overlays."
16332 (interactive)
16333 (when (marker-buffer org-columns-begin-marker)
16334 (with-current-buffer (marker-buffer org-columns-begin-marker)
16335 (when (local-variable-p 'org-previous-header-line-format)
16336 (setq header-line-format org-previous-header-line-format)
16337 (kill-local-variable 'org-previous-header-line-format))
16338 (move-marker org-columns-begin-marker nil)
16339 (move-marker org-columns-top-level-marker nil)
16340 (org-unmodified
16341 (mapc 'org-delete-overlay org-columns-overlays)
16342 (setq org-columns-overlays nil)
16343 (let ((inhibit-read-only t))
16344 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16346 (defun org-columns-cleanup-item (item fmt)
16347 "Remove from ITEM what is a column in the format FMT."
16348 (if (not org-complex-heading-regexp)
16349 item
16350 (when (string-match org-complex-heading-regexp item)
16351 (concat
16352 (org-add-props (concat (match-string 1 item) " ") nil
16353 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16354 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16355 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16356 " " (match-string 4 item)
16357 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16359 (defun org-columns-show-value ()
16360 "Show the full value of the property."
16361 (interactive)
16362 (let ((value (get-char-property (point) 'org-columns-value)))
16363 (message "Value is: %s" (or value ""))))
16365 (defun org-columns-quit ()
16366 "Remove the column overlays and in this way exit column editing."
16367 (interactive)
16368 (org-unmodified
16369 (org-columns-remove-overlays)
16370 (let ((inhibit-read-only t))
16371 (remove-text-properties (point-min) (point-max) '(read-only t))))
16372 (when (eq major-mode 'org-agenda-mode)
16373 (message
16374 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16376 (defun org-columns-check-computed ()
16377 "Check if this column value is computed.
16378 If yes, throw an error indicating that changing it does not make sense."
16379 (let ((val (get-char-property (point) 'org-columns-value)))
16380 (when (and (stringp val)
16381 (get-char-property 0 'org-computed val))
16382 (error "This value is computed from the entry's children"))))
16384 (defun org-columns-todo (&optional arg)
16385 "Change the TODO state during column view."
16386 (interactive "P")
16387 (org-columns-edit-value "TODO"))
16389 (defun org-columns-set-tags-or-toggle (&optional arg)
16390 "Toggle checkbox at point, or set tags for current headline."
16391 (interactive "P")
16393 (get-char-property (point) 'org-columns-value))
16394 (org-columns-next-allowed-value)
16395 (org-columns-edit-value "TAGS")))
16397 (defun org-columns-edit-value (&optional key)
16398 "Edit the value of the property at point in column view.
16399 Where possible, use the standard interface for changing this line."
16400 (interactive)
16401 (org-columns-check-computed)
16402 (let* ((external-key key)
16403 (col (current-column))
16404 (key (or key (get-char-property (point) 'org-columns-key)))
16405 (value (get-char-property (point) 'org-columns-value))
16406 (bol (point-at-bol)) (eol (point-at-eol))
16407 (pom (or (get-text-property bol 'org-hd-marker)
16408 (point))) ; keep despite of compiler waring
16409 (line-overlays
16410 (delq nil (mapcar (lambda (x)
16411 (and (eq (overlay-buffer x) (current-buffer))
16412 (>= (overlay-start x) bol)
16413 (<= (overlay-start x) eol)
16414 x))
16415 org-columns-overlays)))
16416 nval eval allowed)
16417 (cond
16418 ((equal key "CLOCKSUM")
16419 (error "This special column cannot be edited"))
16420 ((equal key "ITEM")
16421 (setq eval '(org-with-point-at pom
16422 (org-edit-headline))))
16423 ((equal key "TODO")
16424 (setq eval '(org-with-point-at pom
16425 (let ((current-prefix-arg
16426 (if external-key current-prefix-arg '(4))))
16427 (call-interactively 'org-todo)))))
16428 ((equal key "PRIORITY")
16429 (setq eval '(org-with-point-at pom
16430 (call-interactively 'org-priority))))
16431 ((equal key "TAGS")
16432 (setq eval '(org-with-point-at pom
16433 (let ((org-fast-tag-selection-single-key
16434 (if (eq org-fast-tag-selection-single-key 'expert)
16435 t org-fast-tag-selection-single-key)))
16436 (call-interactively 'org-set-tags)))))
16437 ((equal key "DEADLINE")
16438 (setq eval '(org-with-point-at pom
16439 (call-interactively 'org-deadline))))
16440 ((equal key "SCHEDULED")
16441 (setq eval '(org-with-point-at pom
16442 (call-interactively 'org-schedule))))
16443 (t
16444 (setq allowed (org-property-get-allowed-values pom key 'table))
16445 (if allowed
16446 (setq nval (completing-read "Value: " allowed nil t))
16447 (setq nval (read-string "Edit: " value)))
16448 (setq nval (org-trim nval))
16449 (when (not (equal nval value))
16450 (setq eval '(org-entry-put pom key nval)))))
16451 (when eval
16452 (let ((inhibit-read-only t))
16453 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16454 (unwind-protect
16455 (progn
16456 (setq org-columns-overlays
16457 (org-delete-all line-overlays org-columns-overlays))
16458 (mapc 'org-delete-overlay line-overlays)
16459 (org-columns-eval eval))
16460 (org-columns-display-here))))
16461 (move-to-column col)
16462 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
16463 (org-columns-update key))))
16465 (defun org-edit-headline () ; FIXME: this is not columns specific
16466 "Edit the current headline, the part without TODO keyword, TAGS."
16467 (org-back-to-heading)
16468 (when (looking-at org-todo-line-regexp)
16469 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16470 (txt (match-string 3))
16471 (post "")
16472 txt2)
16474 (setq post (match-string 0 txt)
16475 txt (substring txt 0 (match-beginning 0))))
16476 (setq txt2 (read-string "Edit: " txt))
16477 (when (not (equal txt txt2))
16478 (beginning-of-line 1)
16479 (insert pre txt2 post)
16480 (delete-region (point) (point-at-eol))
16481 (org-set-tags nil t)))))
16483 (defun org-columns-edit-allowed ()
16484 "Edit the list of allowed values for the current property."
16485 (interactive)
16486 (let* ((key (get-char-property (point) 'org-columns-key))
16487 (key1 (concat key "_ALL"))
16488 (allowed (org-entry-get (point) key1 t))
16489 nval)
16490 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16491 (setq nval (read-string "Allowed: " allowed))
16492 (org-entry-put
16493 (cond ((marker-position org-entry-property-inherited-from)
16494 org-entry-property-inherited-from)
16495 ((marker-position org-columns-top-level-marker)
16496 org-columns-top-level-marker))
16497 key1 nval)))
16499 (defmacro org-no-warnings (&rest body)
16500 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16502 (defun org-columns-eval (form)
16503 (let (hidep)
16504 (save-excursion
16505 (beginning-of-line 1)
16506 ;; `next-line' is needed here, because it skips invisible line.
16507 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16508 (setq hidep (org-on-heading-p 1)))
16509 (eval form)
16510 (and hidep (hide-entry))))
16512 (defun org-columns-previous-allowed-value ()
16513 "Switch to the previous allowed value for this column."
16514 (interactive)
16515 (org-columns-next-allowed-value t))
16517 (defun org-columns-next-allowed-value (&optional previous)
16518 "Switch to the next allowed value for this column."
16519 (interactive)
16520 (org-columns-check-computed)
16521 (let* ((col (current-column))
16522 (key (get-char-property (point) 'org-columns-key))
16523 (value (get-char-property (point) 'org-columns-value))
16524 (bol (point-at-bol)) (eol (point-at-eol))
16525 (pom (or (get-text-property bol 'org-hd-marker)
16526 (point))) ; keep despite of compiler waring
16527 (line-overlays
16528 (delq nil (mapcar (lambda (x)
16529 (and (eq (overlay-buffer x) (current-buffer))
16530 (>= (overlay-start x) bol)
16531 (<= (overlay-start x) eol)
16532 x))
16533 org-columns-overlays)))
16534 (allowed (or (org-property-get-allowed-values pom key)
16535 (and (equal
16536 (nth 4 (assoc key org-columns-current-fmt-compiled))
16537 'checkbox) '("[ ]" "[X]"))))
16538 nval)
16539 (when (equal key "ITEM")
16540 (error "Cannot edit item headline from here"))
16541 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16542 (error "Allowed values for this property have not been defined"))
16543 (if (member key '("SCHEDULED" "DEADLINE"))
16544 (setq nval (if previous 'earlier 'later))
16545 (if previous (setq allowed (reverse allowed)))
16546 (if (member value allowed)
16547 (setq nval (car (cdr (member value allowed)))))
16548 (setq nval (or nval (car allowed)))
16549 (if (equal nval value)
16550 (error "Only one allowed value for this property")))
16551 (let ((inhibit-read-only t))
16552 (remove-text-properties (1- bol) eol '(read-only t))
16553 (unwind-protect
16554 (progn
16555 (setq org-columns-overlays
16556 (org-delete-all line-overlays org-columns-overlays))
16557 (mapc 'org-delete-overlay line-overlays)
16558 (org-columns-eval '(org-entry-put pom key nval)))
16559 (org-columns-display-here)))
16560 (move-to-column col)
16561 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
16562 (org-columns-update key))))
16564 (defun org-verify-version (task)
16565 (cond
16566 ((eq task 'columns)
16567 (if (or (featurep 'xemacs)
16568 (< emacs-major-version 22))
16569 (error "Emacs 22 is required for the columns feature")))))
16571 (defun org-columns-open-link (&optional arg)
16572 (interactive "P")
16573 (let ((key (get-char-property (point) 'org-columns-key))
16574 (value (get-char-property (point) 'org-columns-value)))
16575 (org-open-link-from-string arg)))
16577 (defun org-open-link-from-string (s &optional arg)
16578 "Open a link in the string S, as if it was in Org-mode."
16579 (interactive)
16580 (with-temp-buffer
16581 (let ((org-inhibit-startup t))
16582 (org-mode)
16583 (insert s)
16584 (goto-char (point-min))
16585 (org-open-at-point arg))))
16587 (defun org-columns-get-format-and-top-level ()
16588 (let (fmt)
16589 (when (condition-case nil (org-back-to-heading) (error nil))
16590 (move-marker org-entry-property-inherited-from nil)
16591 (setq fmt (org-entry-get nil "COLUMNS" t)))
16592 (setq fmt (or fmt org-columns-default-format))
16593 (org-set-local 'org-columns-current-fmt fmt)
16594 (org-columns-compile-format fmt)
16595 (if (marker-position org-entry-property-inherited-from)
16596 (move-marker org-columns-top-level-marker
16597 org-entry-property-inherited-from)
16598 (move-marker org-columns-top-level-marker (point)))
16599 fmt))
16601 (defun org-columns ()
16602 "Turn on column view on an org-mode file."
16603 (interactive)
16604 (org-verify-version 'columns)
16605 (org-columns-remove-overlays)
16606 (move-marker org-columns-begin-marker (point))
16607 (let (beg end fmt cache maxwidths clocksump)
16608 (setq fmt (org-columns-get-format-and-top-level))
16609 (save-excursion
16610 (goto-char org-columns-top-level-marker)
16611 (setq beg (point))
16612 (unless org-columns-inhibit-recalculation
16613 (org-columns-compute-all))
16614 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16615 (point-max)))
16616 ;; Get and cache the properties
16617 (goto-char beg)
16618 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16619 (setq clocksump t)
16620 (save-excursion
16621 (save-restriction
16622 (narrow-to-region beg end)
16623 (org-clock-sum))))
16624 (while (re-search-forward (concat "^" outline-regexp) end t)
16625 (push (cons (org-current-line) (org-entry-properties)) cache))
16626 (when cache
16627 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16628 (org-set-local 'org-columns-current-maxwidths maxwidths)
16629 (org-columns-display-here-title)
16630 (mapc (lambda (x)
16631 (goto-line (car x))
16632 (org-columns-display-here (cdr x)))
16633 cache)))))
16635 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16636 "Insert a new column, to the leeft o the current column."
16637 (interactive)
16638 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16639 cell)
16640 (setq prop (completing-read
16641 "Property: " (mapcar 'list (org-buffer-property-keys t))
16642 nil nil prop))
16643 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16644 (setq width (read-string "Column width: " (if width (number-to-string width))))
16646 (setq width (string-to-number width))
16647 (setq width nil))
16648 (setq fmt (completing-read "Summary [none]: "
16649 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox"))
16650 nil t))
16652 (setq fmt (intern fmt))
16653 (setq fmt nil))
16654 (if (eq fmt 'none) (setq fmt nil))
16655 (if editp
16656 (progn
16657 (setcar editp prop)
16658 (setcdr editp (list title width nil fmt)))
16659 (setq cell (nthcdr (1- (current-column))
16660 org-columns-current-fmt-compiled))
16661 (setcdr cell (cons (list prop title width nil fmt)
16662 (cdr cell))))
16663 (org-columns-store-format)
16664 (org-columns-redo)))
16666 (defun org-columns-delete ()
16667 "Delete the column at point from columns view."
16668 (interactive)
16669 (let* ((n (current-column))
16670 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16671 (when (y-or-n-p
16673 (setq org-columns-current-fmt-compiled
16674 (delq (nth n org-columns-current-fmt-compiled)
16675 org-columns-current-fmt-compiled))
16676 (org-columns-store-format)
16677 (org-columns-redo)
16678 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16679 (backward-char 1)))))
16681 (defun org-columns-edit-attributes ()
16682 "Edit the attributes of the current column."
16683 (interactive)
16684 (let* ((n (current-column))
16685 (info (nth n org-columns-current-fmt-compiled)))
16686 (apply 'org-columns-new info)))
16688 (defun org-columns-widen (arg)
16689 "Make the column wider by ARG characters."
16690 (interactive "p")
16691 (let* ((n (current-column))
16692 (entry (nth n org-columns-current-fmt-compiled))
16693 (width (or (nth 2 entry)
16694 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16695 (setq width (max 1 (+ width arg)))
16696 (setcar (nthcdr 2 entry) width)
16697 (org-columns-store-format)
16698 (org-columns-redo)))
16700 (defun org-columns-narrow (arg)
16701 "Make the column nrrower by ARG characters."
16702 (interactive "p")
16703 (org-columns-widen (- arg)))
16705 (defun org-columns-move-right ()
16706 "Swap this column with the one to the right."
16707 (interactive)
16708 (let* ((n (current-column))
16709 (cell (nthcdr n org-columns-current-fmt-compiled))
16710 e)
16711 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16712 (error "Cannot shift this column further to the right"))
16713 (setq e (car cell))
16714 (setcar cell (car (cdr cell)))
16715 (setcdr cell (cons e (cdr (cdr cell))))
16716 (org-columns-store-format)
16717 (org-columns-redo)
16718 (forward-char 1)))
16720 (defun org-columns-move-left ()
16721 "Swap this column with the one to the left."
16722 (interactive)
16723 (let* ((n (current-column)))
16724 (when (= n 0)
16725 (error "Cannot shift this column further to the left"))
16726 (backward-char 1)
16727 (org-columns-move-right)
16728 (backward-char 1)))
16730 (defun org-columns-store-format ()
16731 "Store the text version of the current columns format in appropriate place.
16732 This is either in the COLUMNS property of the node starting the current column
16733 display, or in the #+COLUMNS line of the current buffer."
16734 (let (fmt (cnt 0))
16735 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16736 (org-set-local 'org-columns-current-fmt fmt)
16737 (if (marker-position org-columns-top-level-marker)
16738 (save-excursion
16739 (goto-char org-columns-top-level-marker)
16740 (if (and (org-at-heading-p)
16741 (org-entry-get nil "COLUMNS"))
16742 (org-entry-put nil "COLUMNS" fmt)
16743 (goto-char (point-min))
16744 ;; Overwrite all #+COLUMNS lines....
16746 (setq cnt (1+ cnt))
16747 (replace-match (concat "#+COLUMNS: " fmt) t t))
16748 (unless (> cnt 0)
16749 (goto-char (point-min))
16750 (or (org-on-heading-p t) (outline-next-heading))
16751 (let ((inhibit-read-only t))
16753 (org-set-local 'org-columns-default-format fmt))))))
16755 (defvar org-overriding-columns-format nil
16756 "When set, overrides any other definition.")
16757 (defvar org-agenda-view-columns-initially nil
16758 "When set, switch to columns view immediately after creating the agenda.")
16760 (defun org-agenda-columns ()
16761 "Turn on column view in the agenda."
16762 (interactive)
16763 (org-verify-version 'columns)
16764 (org-columns-remove-overlays)
16765 (move-marker org-columns-begin-marker (point))
16766 (let (fmt cache maxwidths m)
16767 (cond
16768 ((and (local-variable-p 'org-overriding-columns-format)
16769 org-overriding-columns-format)
16770 (setq fmt org-overriding-columns-format))
16771 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
16772 (setq fmt (org-entry-get m "COLUMNS" t)))
16773 ((and (boundp 'org-columns-current-fmt)
16774 (local-variable-p 'org-columns-current-fmt)
16775 org-columns-current-fmt)
16776 (setq fmt org-columns-current-fmt))
16777 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
16778 (setq m (get-text-property m 'org-hd-marker))
16779 (setq fmt (org-entry-get m "COLUMNS" t))))
16780 (setq fmt (or fmt org-columns-default-format))
16781 (org-set-local 'org-columns-current-fmt fmt)
16782 (org-columns-compile-format fmt)
16783 (save-excursion
16784 ;; Get and cache the properties
16785 (goto-char (point-min))
16786 (while (not (eobp))
16787 (when (setq m (or (get-text-property (point) 'org-hd-marker)
16788 (get-text-property (point) 'org-marker)))
16789 (push (cons (org-current-line) (org-entry-properties m)) cache))
16790 (beginning-of-line 2))
16791 (when cache
16792 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16793 (org-set-local 'org-columns-current-maxwidths maxwidths)
16794 (org-columns-display-here-title)
16795 (mapc (lambda (x)
16796 (goto-line (car x))
16797 (org-columns-display-here (cdr x)))
16798 cache)))))
16800 (defun org-columns-get-autowidth-alist (s cache)
16801 "Derive the maximum column widths from the format and the cache."
16802 (let ((start 0) rtn)
16804 (push (cons (match-string 1 s) 1) rtn)
16805 (setq start (match-end 0)))
16806 (mapc (lambda (x)
16807 (setcdr x (apply 'max
16808 (mapcar
16809 (lambda (y)
16810 (length (or (cdr (assoc (car x) (cdr y))) " ")))
16811 cache))))
16812 rtn)
16813 rtn))
16815 (defun org-columns-compute-all ()
16816 "Compute all columns that have operators defined."
16817 (org-unmodified
16818 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
16819 (let ((columns org-columns-current-fmt-compiled) col)
16820 (while (setq col (pop columns))
16821 (when (nth 3 col)
16822 (save-excursion
16823 (org-columns-compute (car col)))))))
16825 (defun org-columns-update (property)
16826 "Recompute PROPERTY, and update the columns display for it."
16827 (org-columns-compute property)
16828 (let (fmt val pos)
16829 (save-excursion
16830 (mapc (lambda (ov)
16831 (when (equal (org-overlay-get ov 'org-columns-key) property)
16832 (setq pos (org-overlay-start ov))
16833 (goto-char pos)
16834 (when (setq val (cdr (assoc property
16835 (get-text-property
16836 (point-at-bol) 'org-summaries))))
16837 (setq fmt (org-overlay-get ov 'org-columns-format))
16838 (org-overlay-put ov 'org-columns-value val)
16839 (org-overlay-put ov 'display (format fmt val)))))
16840 org-columns-overlays))))
16842 (defun org-columns-compute (property)
16843 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
16844 (interactive)
16845 (let* ((re (concat "^" outline-regexp))
16846 (lmax 30) ; Does anyone use deeper levels???
16847 (lsum (make-vector lmax 0))
16848 (lflag (make-vector lmax nil))
16849 (level 0)
16850 (ass (assoc property org-columns-current-fmt-compiled))
16851 (format (nth 4 ass))
16852 (printf (nth 5 ass))
16853 (beg org-columns-top-level-marker)
16854 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
16855 (save-excursion
16856 ;; Find the region to compute
16857 (goto-char beg)
16858 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
16859 (goto-char end)
16860 ;; Walk the tree from the back and do the computations
16861 (while (re-search-backward re beg t)
16862 (setq sumpos (match-beginning 0)
16863 last-level level
16864 level (org-outline-level)
16865 val (org-entry-get nil property)
16867 (cond
16868 ((< level last-level)
16869 ;; put the sum of lower levels here as a property
16870 (setq sum (aref lsum last-level) ; current sum
16871 flag (aref lflag last-level) ; any valid entries from children?
16872 str (org-column-number-to-string sum format printf)
16873 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
16874 useval (if flag str1 (if valflag val ""))
16875 sum-alist (get-text-property sumpos 'org-summaries))
16876 (if (assoc property sum-alist)
16877 (setcdr (assoc property sum-alist) useval)
16878 (push (cons property useval) sum-alist)
16879 (org-unmodified
16880 (add-text-properties sumpos (1+ sumpos)
16881 (list 'org-summaries sum-alist))))
16882 (when val
16883 (org-entry-put nil property (if flag str val)))
16884 ;; add current to current level accumulator
16885 (when (or flag valflag)
16886 (aset lsum level (+ (aref lsum level)
16887 (if flag sum (org-column-string-to-number
16888 (if flag str val) format))))
16889 (aset lflag level t))
16890 ;; clear accumulators for deeper levels
16891 (loop for l from (1+ level) to (1- lmax) do
16892 (aset lsum l 0)
16893 (aset lflag l nil)))
16894 ((>= level last-level)
16895 ;; add what we have here to the accumulator for this level
16896 (aset lsum level (+ (aref lsum level)
16897 (org-column-string-to-number (or val "0") format)))
16898 (and valflag (aset lflag level t)))
16899 (t (error "This should not happen")))))))
16901 (defun org-columns-redo ()
16902 "Construct the column display again."
16903 (interactive)
16904 (message "Recomputing columns...")
16905 (save-excursion
16906 (if (marker-position org-columns-begin-marker)
16907 (goto-char org-columns-begin-marker))
16908 (org-columns-remove-overlays)
16909 (if (org-mode-p)
16910 (call-interactively 'org-columns)
16911 (call-interactively 'org-agenda-columns)))
16912 (message "Recomputing columns...done"))
16914 (defun org-columns-not-in-agenda ()
16915 (if (eq major-mode 'org-agenda-mode)
16916 (error "This command is only allowed in Org-mode buffers")))
16919 (defun org-string-to-number (s)
16920 "Convert string to number, and interpret hh:mm:ss."
16921 (if (not (string-match ":" s))
16922 (string-to-number s)
16923 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16924 (while l
16925 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16926 sum)))
16928 (defun org-column-number-to-string (n fmt &optional printf)
16929 "Convert a computed column number to a string value, according to FMT."
16930 (cond
16931 ((eq fmt 'add_times)
16932 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
16933 (format "%d:%02d" h m)))
16934 ((eq fmt 'checkbox)
16935 (cond ((= n (floor n)) "[X]")
16936 ((> n 1.) "[-]")
16937 (t "[ ]")))
16938 (printf (format printf n))
16939 ((eq fmt 'currency)
16940 (format "%.2f" n))
16941 (t (number-to-string n))))
16943 (defun org-column-string-to-number (s fmt)
16944 "Convert a column value to a number that can be used for column computing."
16945 (cond
16946 ((string-match ":" s)
16947 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16948 (while l
16949 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16950 sum))
16951 ((eq fmt 'checkbox)
16952 (if (equal s "[X]") 1. 0.000001))
16953 (t (string-to-number s))))
16955 (defun org-columns-uncompile-format (cfmt)
16956 "Turn the compiled columns format back into a string representation."
16957 (let ((rtn "") e s prop title op width fmt printf)
16958 (while (setq e (pop cfmt))
16959 (setq prop (car e)
16960 title (nth 1 e)
16961 width (nth 2 e)
16962 op (nth 3 e)
16963 fmt (nth 4 e)
16964 printf (nth 5 e))
16965 (cond
16966 ((eq fmt 'add_times) (setq op ":"))
16967 ((eq fmt 'checkbox) (setq op "X"))
16968 ((eq fmt 'add_numbers) (setq op "+"))
16969 ((eq fmt 'currency) (setq op "$")))
16970 (if (and op printf) (setq op (concat op ";" printf)))
16971 (if (equal title prop) (setq title nil))
16972 (setq s (concat "%" (if width (number-to-string width))
16973 prop
16974 (if title (concat "(" title ")"))
16975 (if op (concat "{" op "}"))))
16976 (setq rtn (concat rtn " " s)))
16977 (org-trim rtn)))
16979 (defun org-columns-compile-format (fmt)
16980 "Turn a column format string into an alist of specifications.
16981 The alist has one entry for each column in the format. The elements of
16982 that list are:
16983 property the property
16984 title the title field for the columns
16985 width the column width in characters, can be nil for automatic
16986 operator the operator if any
16987 format the output format for computed results, derived from operator
16988 printf a printf format for computed values"
16989 (let ((start 0) width prop title op f printf)
16990 (setq org-columns-current-fmt-compiled nil)
16991 (while (string-match
16992 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
16993 fmt start)
16994 (setq start (match-end 0)
16995 width (match-string 1 fmt)
16996 prop (match-string 2 fmt)
16997 title (or (match-string 3 fmt) prop)
16998 op (match-string 4 fmt)
16999 f nil
17000 printf nil)
17001 (if width (setq width (string-to-number width)))
17002 (when (and op (string-match ";" op))
17003 (setq printf (substring op (match-end 0))
17004 op (substring op 0 (match-beginning 0))))
17005 (cond
17006 ((equal op "+") (setq f 'add_numbers))
17007 ((equal op "$") (setq f 'currency))
17008 ((equal op ":") (setq f 'add_times))
17009 ((equal op "X") (setq f 'checkbox)))
17010 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17011 (setq org-columns-current-fmt-compiled
17012 (nreverse org-columns-current-fmt-compiled))))
17015 ;;; Dynamic block for Column view
17017 (defun org-columns-capture-view ()
17018 "Get the column view of the current buffer and return it as a list.
17019 The list will contains the title row and all other rows. Each row is
17020 a list of fields."
17021 (save-excursion
17022 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17023 (n (length title)) row tbl)
17024 (goto-char (point-min))
17026 (when (get-char-property (match-beginning 0) 'org-columns-key)
17027 (setq row nil)
17028 (loop for i from 0 to (1- n) do
17029 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17030 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17031 "")
17032 row))
17033 (setq row (nreverse row))
17034 (push row tbl)))
17035 (append (list title 'hline) (nreverse tbl)))))
17037 (defun org-dblock-write:columnview (params)
17038 "Write the column view table.
17039 PARAMS is a property list of parameters:
17041 :width enforce same column widths with <N> specifiers.
17042 :id the :ID: property of the entry where the columns view
17043 should be built, as a string. When `local', call locally.
17044 When `global' call column view with the cursor at the beginning
17045 of the buffer (usually this means that the whole buffer switches
17046 to column view).
17047 :hlines When t, insert a hline before each item. When a number, insert
17048 a hline before each level <= that number.
17049 :vlines When t, make each column a colgroup to enforce vertical lines."
17050 (let ((pos (move-marker (make-marker) (point)))
17051 (hlines (plist-get params :hlines))
17052 (vlines (plist-get params :vlines))
17053 tbl id idpos nfields tmp)
17054 (save-excursion
17055 (save-restriction
17056 (when (setq id (plist-get params :id))
17057 (cond ((not id) nil)
17058 ((eq id 'global) (goto-char (point-min)))
17059 ((eq id 'local) nil)
17060 ((setq idpos (org-find-entry-with-id id))
17061 (goto-char idpos))
17062 (t (error "Cannot find entry with :ID: %s" id))))
17063 (org-columns)
17064 (setq tbl (org-columns-capture-view))
17065 (setq nfields (length (car tbl)))
17066 (org-columns-quit)))
17067 (goto-char pos)
17068 (move-marker pos nil)
17069 (when tbl
17070 (when (plist-get params :hlines)
17071 (setq tmp nil)
17072 (while tbl
17073 (if (eq (car tbl) 'hline)
17074 (push (pop tbl) tmp)
17076 (if (and (not (eq (car tmp) 'hline))
17077 (or (eq hlines t)
17078 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17079 (push 'hline tmp)))
17080 (push (pop tbl) tmp)))
17081 (setq tbl (nreverse tmp)))
17082 (when vlines
17083 (setq tbl (mapcar (lambda (x)
17084 (if (eq 'hline x) x (cons "" x)))
17085 tbl))
17086 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17087 (setq pos (point))
17088 (insert (org-listtable-to-string tbl))
17089 (when (plist-get params :width)
17091 org-columns-current-widths "|")))
17092 (goto-char pos)
17093 (org-table-align))))
17095 (defun org-listtable-to-string (tbl)
17096 "Convert a listtable TBL to a string that contains the Org-mode table.
17097 The table still need to be alligned. The resulting string has no leading
17098 and tailing newline characters."
17099 (mapconcat
17100 (lambda (x)
17101 (cond
17102 ((listp x)
17103 (concat "|" (mapconcat 'identity x "|") "|"))
17104 ((eq x 'hline) "|-|")
17105 (t (error "Garbage in listtable: %s" x))))
17108 (defun org-insert-columns-dblock ()
17109 "Create a dynamic block capturing a column view table."
17110 (interactive)
17111 (let ((defaults '(:name "columnview" :hlines 1))
17112 (id (completing-read
17113 "Capture columns (local, global, entry with :ID: property) [local]: "
17114 (append '(("global") ("local"))
17115 (mapcar 'list (org-property-values "ID"))))))
17116 (if (equal id "") (setq id 'local))
17117 (if (equal id "global") (setq id 'global))
17118 (setq defaults (append defaults (list :id id)))
17119 (org-create-dblock defaults)
17120 (org-update-dblock)))
17122 ;;;; Timestamps
17124 (defvar org-last-changed-timestamp nil)
17125 (defvar org-time-was-given) ; dynamically scoped parameter
17126 (defvar org-end-time-was-given) ; dynamically scoped parameter
17127 (defvar org-ts-what) ; dynamically scoped parameter
17129 (defun org-time-stamp (arg)
17130 "Prompt for a date/time and insert a time stamp.
17131 If the user specifies a time like HH:MM, or if this command is called
17132 with a prefix argument, the time stamp will contain date and time.
17133 Otherwise, only the date will be included. All parts of a date not
17134 specified by the user will be filled in from the current date/time.
17135 So if you press just return without typing anything, the time stamp
17136 will represent the current date/time. If there is already a timestamp
17137 at the cursor, it will be modified."
17138 (interactive "P")
17139 (let* ((ts nil)
17140 (default-time
17141 ;; Default time is either today, or, when entering a range,
17142 ;; the range start.
17143 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17144 (save-excursion
17145 (re-search-backward
17147 (- (point) 20) t)))
17148 (apply 'encode-time (org-parse-time-string (match-string 1)))
17149 (current-time)))
17150 (default-input (and ts (org-get-compact-tod ts)))
17151 org-time-was-given org-end-time-was-given time)
17152 (cond
17153 ((and (org-at-timestamp-p)
17154 (eq last-command 'org-time-stamp)
17155 (eq this-command 'org-time-stamp))
17156 (insert "--")
17157 (setq time (let ((this-command this-command))
17158 (org-read-date arg 'totime nil nil default-time default-input)))
17159 (org-insert-time-stamp time (or org-time-was-given arg)))
17160 ((org-at-timestamp-p)
17161 (setq time (let ((this-command this-command))
17162 (org-read-date arg 'totime nil nil default-time default-input)))
17163 (when (org-at-timestamp-p) ; just to get the match data
17164 (replace-match "")
17165 (setq org-last-changed-timestamp
17166 (org-insert-time-stamp
17167 time (or org-time-was-given arg)
17168 nil nil nil (list org-end-time-was-given))))
17169 (message "Timestamp updated"))
17170 (t
17171 (setq time (let ((this-command this-command))
17172 (org-read-date arg 'totime nil nil default-time default-input)))
17173 (org-insert-time-stamp time (or org-time-was-given arg)
17174 nil nil nil (list org-end-time-was-given))))))
17176 ;; FIXME: can we use this for something else????
17177 ;; like computing time differences?????
17178 (defun org-get-compact-tod (s)
17179 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17180 (let* ((t1 (match-string 1 s))
17181 (h1 (string-to-number (match-string 2 s)))
17182 (m1 (string-to-number (match-string 3 s)))
17183 (t2 (and (match-end 4) (match-string 5 s)))
17184 (h2 (and t2 (string-to-number (match-string 6 s))))
17185 (m2 (and t2 (string-to-number (match-string 7 s))))
17186 dh dm)
17187 (if (not t2)
17188 t1
17189 (setq dh (- h2 h1) dm (- m2 m1))
17190 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17191 (concat t1 "+" (number-to-string dh)
17192 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17194 (defun org-time-stamp-inactive (&optional arg)
17195 "Insert an inactive time stamp.
17196 An inactive time stamp is enclosed in square brackets instead of angle
17197 brackets. It is inactive in the sense that it does not trigger agenda entries,
17198 does not link to the calendar and cannot be changed with the S-cursor keys.
17199 So these are more for recording a certain time/date."
17200 (interactive "P")
17201 (let (org-time-was-given org-end-time-was-given time)
17202 (setq time (org-read-date arg 'totime))
17203 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17204 nil nil (list org-end-time-was-given))))
17206 (defvar org-date-ovl (org-make-overlay 1 1))
17207 (org-overlay-put org-date-ovl 'face 'org-warning)
17208 (org-detach-overlay org-date-ovl)
17210 (defvar org-ans1) ; dynamically scoped parameter
17211 (defvar org-ans2) ; dynamically scoped parameter
17213 (defvar org-plain-time-of-day-regexp) ; defined below
17215 (defvar org-read-date-overlay nil)
17216 (defvar org-dcst nil) ; dynamically scoped
17218 (defun org-read-date (&optional with-time to-time from-string prompt
17219 default-time default-input)
17220 "Read a date, possibly a time, and make things smooth for the user.
17221 The prompt will suggest to enter an ISO date, but you can also enter anything
17222 which will at least partially be understood by `parse-time-string'.
17223 Unrecognized parts of the date will default to the current day, month, year,
17224 hour and minute. If this command is called to replace a timestamp at point,
17225 of to enter the second timestamp of a range, the default time is taken from the
17226 existing stamp. For example,
17227 3-2-5 --> 2003-02-05
17228 feb 15 --> currentyear-02-15
17229 sep 12 9 --> 2009-09-12
17230 12:45 --> today 12:45
17231 22 sept 0:34 --> currentyear-09-22 0:34
17232 12 --> currentyear-currentmonth-12
17233 Fri --> nearest Friday (today or later)
17234 etc.
17236 Furthermore you can specify a relative date by giving, as the *first* thing
17237 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17238 change in days weeks, months, years.
17239 With a single plus or minus, the date is relative to today. With a double
17240 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17241 +4d --> four days from today
17242 +4 --> same as above
17243 +2w --> two weeks from today
17244 ++5 --> five days from default date
17246 The function understands only English month and weekday abbreviations,
17247 but this can be configured with the variables `parse-time-months' and
17248 `parse-time-weekdays'.
17250 While prompting, a calendar is popped up - you can also select the
17251 date with the mouse (button 1). The calendar shows a period of three
17252 months. To scroll it to other months, use the keys `>' and `<'.
17253 If you don't like the calendar, turn it off with
17254 \(setq org-read-date-popup-calendar nil)
17256 With optional argument TO-TIME, the date will immediately be converted
17257 to an internal time.
17258 With an optional argument WITH-TIME, the prompt will suggest to also
17259 insert a time. Note that when WITH-TIME is not set, you can still
17260 enter a time, and this function will inform the calling routine about
17261 this change. The calling routine may then choose to change the format
17262 used to insert the time stamp into the buffer to include the time.
17263 With optional argument FROM-STRING, read from this string instead from
17264 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17265 the time/date that is used for everything that is not specified by the
17266 user."
17267 (require 'parse-time)
17268 (let* ((org-time-stamp-rounding-minutes
17269 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17270 (org-dcst org-display-custom-times)
17271 (ct (org-current-time))
17272 (def (or default-time ct))
17273 (defdecode (decode-time def))
17274 (dummy (progn
17275 (when (< (nth 2 defdecode) org-extend-today-until)
17276 (setcar (nthcdr 2 defdecode) -1)
17277 (setcar (nthcdr 1 defdecode) 59)
17278 (setq def (apply 'encode-time defdecode)
17279 defdecode (decode-time def)))))
17280 (calendar-move-hook nil)
17281 (view-diary-entries-initially nil)
17282 (view-calendar-holidays-initially nil)
17283 (timestr (format-time-string
17284 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17285 (prompt (concat (if prompt (concat prompt " ") "")
17286 (format "Date+time [%s]: " timestr)))
17287 ans (org-ans0 "") org-ans1 org-ans2 final)
17289 (cond
17290 (from-string (setq ans from-string))
17291 (org-read-date-popup-calendar
17292 (save-excursion
17293 (save-window-excursion
17294 (calendar)
17295 (calendar-forward-day (- (time-to-days def)
17296 (calendar-absolute-from-gregorian
17297 (calendar-current-date))))
17298 (org-eval-in-calendar nil t)
17299 (let* ((old-map (current-local-map))
17300 (map (copy-keymap calendar-mode-map))
17301 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17302 (org-defkey map (kbd "RET") 'org-calendar-select)
17303 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17304 'org-calendar-select-mouse)
17342 ;; org-ans0: from prompt
17343 ;; org-ans1: from mouse click
17344 ;; org-ans2: from calendar motion
17372 "Display the currrent date prompt interpretation in the minibuffer."
17388 org-time-stamp-custom-formats
17389 org-time-stamp-formats))
17398 org-end-time-was-given
17405 "Analyze the combined answer of the date prompt."
17406 ;; FIXME: cleanup and comment
17408 hour minute second wday pm h2 m2 tl wday1)
17416 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17426 t nil ans)))
17427 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17428 ;; If there is a time with am/pm, and *no* time without it, we convert
17429 ;; so that matching will be successful.
17443 t t ans))))
17445 ;; Check if a time range is given as a duration
17446 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17454 ;; Check if there is a time range
17488 ;; Weekday was given, but no day, so pick that day in the week
17489 ;; on or after the derived date.
17503 "Check string S for special relative date string.
17504 TODAY and DEFAULT are internal times, for today and for a default.
17505 Return shift list (N what def-flag)
17507 N is the number of WHATs to shift.
17508 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17509 the DEFAULT date rather than TODAY."
17518 ?+))
17525 delta)
17535 "Eval FORM in the calendar window and return to current window.
17536 Also, store the cursor date in variable org-ans2."
17547 ; ;; Update the prompt to show new default date
17548 ; (save-excursion
17549 ; (goto-char (point-min))
17550 ; (when (and org-ans2
17551 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17552 ; (get-text-property (match-end 0) 'field))
17553 ; (let ((inhibit-read-only t))
17554 ; (replace-match (concat "[" org-ans2 "]") t t)
17555 ; (add-text-properties (point-min) (1+ (match-end 0))
17556 ; (text-properties-at (1+ (point-min)))))))))
17559 "Return to `org-read-date' with the date currently selected.
17560 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17569 "Insert a date stamp for the date given by the internal TIME.
17570 WITH-HM means, use the stamp format that includes the time of the day.
17571 INACTIVE means use square brackets instead of angular ones, so that the
17572 stamp will not contribute to the agenda.
17573 PRE and POST are optional strings to be inserted before and after the
17574 stamp.
17575 The command returns the inserted time stamp."
17577 stamp)
17594 stamp))
17597 "Toggle the use of custom time stamp formats."
17618 "Overlay modified time stamp format over timestamp between BED and END."
17645 "Translate all timestamps in STRING to custom format.
17646 But do this only if the variable `org-display-custom-times' is set."
17651 t1 with-hm inactive tf time str beg end)
17660 org-time-stamp-custom-formats)
17669 string)
17672 "Set 0 instead of nil for the first 6 elements of time.
17673 Don't touch the rest."
17678 "Difference between TIMESTAMP-STRING and now in days."
17683 "Is the time in TIMESTAMP-STRING close to the current date?"
17689 "Get the deadline lead time appropriate for timestring TS."
17692 ;; 0 or negative, enforce this value no matter what
17695 ;; lead time is specified.
17700 ;; go for the default.
17704 "Return to `org-read-date' with the date currently selected.
17705 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17715 "Check if there are any deadlines due or past due.
17716 A deadline is considered due if it happens within `org-deadline-warning-days'
17717 days from today's date. If the deadline appears in an entry marked DONE,
17718 it is not shown. The prefix arg NDAYS can be used to test that many
17733 org-warn-days)))
17736 "Check if there are deadlines or scheduled entries before DATE."
17750 "Evaluate a time range by computing the difference between start and end.
17751 Normally the result is just printed in the echo area, but with prefix arg
17752 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17753 If the time range is actually in a table, the result is inserted into the
17754 next column.
17755 For time difference computation, a year is assumed to be exactly 365
17756 days in order to avoid rounding problems."
17776 ;; (ys (floor (* 365 24 60 60)))
17784 y d h m align)
17787 y 0
17792 y 0
17830 "Convert a time stamp to an absolute day number.
17831 If there is a specifyer for a cyclic time stamp, get the closest date to
17832 DAYNR."
17836 daynr
17844 "Return the time corresponding to date D.
17845 D may be an absolute day number, or a calendar-type list (month day year)."
17850 "List of holidays, for Diary display in Org-mode."
17858 "Process a SEXP diary ENTRY for DATE."
17878 "Get iCalendar entries from diary entries in buffer FROMBUF.
17879 This uses the icalendar.el library."
17882 temporary-file-directory))
17885 buf rtn b e)
17901 rtn))
17904 "Find the date closest to CURRENT that is consistent with START and CHANGE."
17905 ;; Make the proper lists from the dates
17908 dn dw sday cday n1 n2
17909 d m y y1 y2 date1 date2 nmonths nm ny m2)
17914 current
17938 ;; approx number of month between the tow dates
17940 ;; How often does dn fit in there?
17963 "Turn any specification of DATE into a gregorian date for the calendar."
17973 "Parse the standard Org-mode time string.
17974 This should be a lot faster than the normal `parse-time-string'.
17975 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17976 hour and minute fields will be nil if not given."
17986 nil nil nil)
17990 "Increase the date item at the cursor by one.
17991 If the cursor is on the year, change the year. If it is on the month or
17992 the day, change that.
17993 With prefix ARG, change by that many units."
17998 "Decrease the date item at the cursor by one.
17999 If the cursor is on the year, change the year. If it is on the month or
18000 the day, change that.
18001 With prefix ARG, change by that many units."
18006 "Increase the date in the time stamp by one day.
18007 With prefix ARG, change that many days."
18015 "Decrease the date in the time stamp by one day.
18016 With prefix ARG, change that many days."
18029 "Determine if the cursor is in or at a timestamp."
18055 ans))
18058 ""
18070 "Change the date in the time stamp at point.
18071 The date will be changed by N times WHAT. WHAT can be `day', `month',
18072 `year', `minute', `second'. If WHAT is not given, the cursor position
18073 in the timestamp determines what will be changed."
18075 with-hm inactive
18076 org-ts-what
18077 extra
18078 ts time time0)
18084 org-display-custom-times
18094 ts)
18122 ;; Try to recenter the calendar window, if any
18128 ;; FIXME: does not yet work for lead times
18130 "Change the different parts of the lead-time and repeat fields in timestamp."
18132 ng h m new)
18133 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18154 new
18156 s))
18159 "If the calendar is visible, recenter it to DATE."
18170 "Go to the Emacs calendar at the current date.
18171 If there is a time stamp in the current line, go to that date.
18172 A prefix ARG can be used to force the current date."
18191 "Return a list (month day year) of date at point in calendar."
18197 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18198 If there is already a time stamp at the cursor position, update it."
18206 ;; Make appt aware of appointments from the agenda
18207 ;;;###autoload
18209 "Activate appointments found in `org-agenda-files'.
18210 When prefixed, prompt for a regular expression and use it as a
18211 filter: only add entries if they match this regular expression.
18213 FILTER can be a string. In this case, use this string as a
18214 regular expression to filter results.
18216 FILTER can also be an alist, with the car of each cell being
18217 either 'headline or 'category. For example:
18222 will only add headlines containing IMPORTANT or headlines
18233 ;; Get all entries which may contain an appt
18238 file today
18241 ;; Map thru entries and find if they pass thru the filter
18254 ;; FIXME: Shall we remove text-properties for the appt text?
18255 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18267 ;;; The clock for measuring work time.
18292 "Start the clock on the current item.
18293 If necessary, clock-out of the currently active clock."
18301 org-clock-in-switch-to-state
18328 "Find the location where the next clock line should be inserted."
18334 first last)
18338 ;; we seem to have a CLOCK drawer, so go there.
18341 ;; Lets count the CLOCK lines
18349 ;; Wrap current entries into a new drawer
18367 ;; Planning info, skip to after it
18379 "Stop the currently running clock.
18380 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18419 "Cancel the running clock be removing the start timestamp."
18433 "Go to the currently clocked-in entry."
18450 "Sum the times for each subtree.
18451 Puts the resulting times in minutes as a text property on each headline."
18455 org-clock-string
18461 ts te dt
18462 time)
18469 ;; Two time stamps
18481 ;; A naket time
18498 "Show subtree times in the entire buffer.
18499 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18500 in the echo area."
18517 ;; Arrange to remove the overlays upon next change.
18527 "Put an overlays on the current line, displaying TIME.
18528 If LEVEL is given, prefix time with a corresponding number of stars.
18529 This creates a new overlay and stores it in `org-clock-overlays', so that it
18530 will be easy to remove."
18534 ov tx)
18553 "Remove the occur highlights from the buffer.
18554 BEG and END are ignored. If NOREMOVE is nil, remove this function
18555 from the `before-change-functions' in the current buffer."
18565 "Clock out if the current entry contains the running clock.
18566 This is used to stop the clock after a TODO entry is marked DONE,
18567 and is only done if the variable `org-clock-out-when-done' is not nil."
18573 org-clock-marker))
18574 ;; Clock out, but don't accept a logging message for this.
18578 org-log-done)))
18585 "Check if the current buffer contains the running clock.
18586 If yes, offer to stop it and to save the buffer with the changes."
18595 "Create a table containing a report about clocked time.
18596 If the cursor is inside an existing clocktable block, then the table
18597 will be updated. If not, a new clocktable will be inserted.
18598 When called with a prefix argument, move to the first clock table in the
18599 buffer and update it."
18610 "Check if the cursor is in a clocktable."
18618 start))))
18621 "If this is a CLOCK line, update it and return t.
18622 Otherwise, return nil."
18631 ts te h m s)
18633 nil
18647 t)))))
18650 "Return two times bordering a special time range.
18651 Key is a symbol specifying the range and can be one of `today', `yesterday',
18652 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18653 A week starts Monday 0:00 and ends Sunday 24:00.
18654 The range is determined relative to TIME. TIME defaults to the current time.
18655 The return value is a cons cell with two internal times like the ones
18656 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18657 the returned times will be formatted strings."
18662 s1 m1 h1 d1 month1 y1 diff ts te fm)
18692 "Write the standard clocktable."
18697 ipos time h m p level hlc hdl maxlevel
18698 ts te cc block beg end pos scope tbl tostring multifile)
18717 ;; Get the right scope
18740 file)
18750 org-clock-file-total-minutes)))))))
18761 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
18780 "Clock summary at ["
18784 "]."
18797 "|"
18798 "*Total time*| "
18821 x))
18822 lines)
18825 ;; FIXME: I don't think anybody uses this, ask David
18827 "Return an internal list with clocking information.
18828 This list has one entry for each CLOCK interval.
18829 FIXME: describe the elements."
18833 rtn beg end next cont level title total closedp leafp
18834 clockpos titlepos h m donep)
18859 total title titlepos level leafp)
18860 rtn)
18864 ;;;; Agenda, and Diary Integration
18866 ;;; Define the Org-agenda-mode
18880 "Mode for time-sorted view on action items in Org-mode files.
18882 The following commands are available:
18888 org-agenda-pending-undo-list nil)
18890 ;; Keep global-font-lock-mode from turning on font-lock-mode
18898 ;; Make sure properties are removed when copying text
18903 buffer-substring-filters)))
18906 org-agenda-show-log nil))
18913 "Restricted to single file"
18925 org-agenda-mode-map global-map)
19023 "--"
19030 "--"
19034 "--"
19039 "--"
19044 "--"
19049 "--"
19066 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19070 "--"
19072 "--"
19082 "--"
19084 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19088 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19092 "--"
19094 "--"
19097 ))
19099 ;;; Agenda undo
19111 "Execute BODY if there is no `org-protected' text property at point."
19117 "Execute BODY while recording undo information in two buffers."
19125 _c1 _c2)
19126 ,@_body
19133 ;; make sure there are undo boundaries
19136 ;; remember which buffer to undo
19138 org-agenda-undo-list)))))
19141 "Undo a remote editing step in the agenda.
19142 This undoes changes both in the agenda buffer and in the remote buffer
19143 that have been changed along."
19149 org-agenda-pending-undo-list org-agenda-undo-list))
19153 buf line cmd rembuf)
19175 "Verify that a real change occurred between the undo lists L1 and L2."
19180 ;;; Agenda dispatch
19188 ;;;###autoload
19190 "Dispatch agenda commands to collect entries to the agenda buffer.
19191 Prompts for a command to execute. Any prefix arg will be passed
19192 on to the selected command. The default selections are:
19194 a Call `org-agenda-list' to display the agenda for current day or week.
19195 t Call `org-todo-list' to display the global todo list.
19196 T Call `org-todo-list' to display the global todo list, select only
19197 entries with a specific TODO keyword (the user gets a prompt).
19198 m Call `org-tags-view' to display headlines with tags matching
19199 a condition (the user is prompted for the condition).
19200 M Like `m', but select only TODO entries, no ordinary headlines.
19201 L Create a timeline for the current buffer.
19202 e Export views to associated files.
19204 More commands can be added by configuring the variable
19205 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19206 searches can be pre-defined in this way.
19208 If the current buffer is in Org-mode and visiting a file, you can also
19209 first press `<' once to indicate that the agenda should be temporarily
19211 Pressing `<' twice means to restrict to the current subtree or region
19212 \(if active)."
19218 ;; normalize different versions
19224 nil)
19228 org-agenda-custom-commands)))
19231 entry key type match lprops ans)
19232 ;; Turn off restriction unless there is an overriding one
19238 ;; Delete old local properties
19240 ;; Remember where this call originated
19246 ;; Estabish the restriction, if any
19263 ;; For example the todo list should not need it (but does...)
19277 current-prefix-arg)))
19329 cmds)))
19332 "The user interface for selecting an agenda command."
19339 restriction second-time
19340 c entry key type match prefixes rmheader header-end custom1 desc)
19347 "
19348 Press key for an agenda command: < Buffer,subtree/region restriction
19349 -------------------------------- > Remove restriction
19350 a Agenda for current week or day e Export agenda views
19351 t List of all TODO entries T Entries with special TODO kwd
19352 m Match a TAGS query M Like m, but only TODO entries
19353 L Timeline for current buffer # List stuck projects (!=configure)
19354 / Multi-occur C Configure custom agenda commands
19359 header start)
19363 header)))
19415 prefix-descriptions))
19417 prefixes))
19428 " (restriction lock active)"
19441 prefixes nil
19447 nil
19449 custom))))
19466 nil)
19486 match ;; The byte compiler incorrectly complains about this. Keep it!
19487 cmd type lprops)
19518 ;;;###autoload
19520 "Run an agenda command in batch mode and send the result to STDOUT.
19521 If CMD-KEY is a string of length 1, it is used as a key in
19522 `org-agenda-custom-commands' and triggers this command. If it is a
19523 longer string it is used as a tags/todo match string.
19524 Paramters are alternating variable names and values that will be bound
19525 before running the agenda command."
19539 string))
19543 ;;;###autoload
19545 "Run an agenda command in batch mode and send the result to STDOUT.
19546 If CMD-KEY is a string of length 1, it is used as a key in
19547 `org-agenda-custom-commands' and triggers this command. If it is a
19548 longer string it is used as a tags/todo match string.
19549 Paramters are alternating variable names and values that will be bound
19550 before running the agenda command.
19552 The output gives a line for each selected agenda item. Each
19553 item is a list of comma-separated values, like this:
19555 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19557 category The category of the item
19558 head The headline, without TODO kwd, TAGS and PRIORITY
19559 type The type of the agenda entry, can be
19560 todo selected in TODO match
19561 tagsmatch selected in tags match
19562 diary imported from diary
19563 deadline a deadline on given date
19564 scheduled scheduled on given date
19565 timestamp entry has timestamp on given date
19566 closed entry was closed on given date
19567 upcoming-deadline warning about deadline
19568 past-scheduled forwarded scheduled item
19569 block entry has date block including g. date
19570 todo The todo keyword, if any
19571 tags All tags including inherited ones, separated by colons
19572 date The relevant date, like 2007-2-14
19573 time The time, like 15:00-16:50
19574 extra Sting with extra planning info
19575 priority-l The priority letter if any was given
19576 priority-n The computed numerical priority
19577 agenda-day The day in the agenda where this is listed"
19589 line)
19599 priority-letter priority agenda-day)
19604 "Make sure all properties on an agenda item have a canonical form,
19605 so the export commands can easily use it."
19632 props)
19646 ;;;###autoload
19651 ;; FIXME, why is this a macro?????
19652 ;;;###autoload
19654 "Run all custom agenda commands that have a file argument."
19658 pars cmd thiscmdkey files opts)
19681 "Write the current buffer (an agenda view) as a file.
19682 Depending on the extension of the file name, plain text (.txt),
19683 HTML (.html or .htm) or Postscript (.ps) is produced.
19684 If NOSETTINGS is given, do not scope the settings of
19685 `org-agenda-exporter-settings' into the export commands. This is used when
19686 the settings have already been scoped and we do not wish to overrule other,
19687 higher priority settings."
19703 ;; replace <style> section with org-agenda-export-html-style
19724 "Inhibit read-only for BODY."
19728 "Make sure current buffer is in org-mode. Error if not."
19731 major-mode)))
19734 "Fit the window to the buffer size."
19738 nil
19742 ;;; Agenda file list
19745 "Get the list of agenda files.
19746 Optional UNRESTRICTED means return the full list even if a restriction
19747 is currently in place."
19758 org-agenda-file-regexp)
19760 files)))
19766 files))
19770 "Edit the list of agenda files.
19771 Depending on setup, this either uses customize to edit the variable
19772 `org-agenda-files', or it visits the file that is holding the list. In the
19773 latter case, the buffer is set up in a way that saving it automatically kills
19774 the buffer and restores the previous window configuration."
19793 "Set new value for the agenda file list and save it correcly."
19804 "Read the list of agenda files from a file."
19811 ;;;###autoload
19813 "Cycle through the files in `org-agenda-files'.
19814 If the current buffer visits an agenda file, find the next one in the list.
19815 If the current buffer does not, find the first agenda file."
19820 file)
19832 "Move/add the current file to the top of the agenda file list.
19833 If the file is not present in the list, it is added to the front. If it is
19834 present, it is moved there. With optional argument TO-END, add/move to the
19835 end of the list."
19842 x had)
19855 "Remove current file from the list of files in variable `org-agenda-files'.
19856 These are the files which are being checked for agenda entries.
19857 Optional argument FILE means, use this file instead of the current."
19867 nil x))
19880 "Make sure FILE exists. If not, ask user what to do."
19891 ;;; Agenda prepare and finalize
19936 "Finishing touch for the agenda buffer, called just before displaying it."
19948 org-overriding-columns-format)
19950 org-overriding-columns-format))
19952 org-agenda-view-columns-initially)
19959 "Make highest priority lines bold, and lowest italic."
19966 b e p ov h l)
19970 org-highest-priority)
19972 org-lowest-priority)
19977 ov 'face
19985 "Create buffers for all agenda files, protect archived trees and comments."
19992 bmp file re)
20022 "Function to be called at each match during agenda construction.
20023 If this function returns nil, the current match should not be skipped.
20024 Otherwise, the function must return a position from where the search
20025 should be continued.
20026 This may also be a Lisp form, it will be evaluated.
20027 Never set this variable using `setq' or so, because then it will apply
20028 to all future agenda commands. Instead, bind it with `let' to scope
20029 it dynamically into the agenda-constructing command. A good way to set
20033 "Throw to `:skip' in places that should be skipped.
20034 Also moves point to the end of the skipped region, so that search can
20035 continue from there."
20061 "Return a new agenda marker.
20062 Org-mode keeps a list of these markers and resets them when they are
20063 no longer in use."
20067 m))
20070 "Reset markers created by `org-agenda'. But only if they are old enough."
20073 org-agenda-last-marker-time)
20079 "Get a buffer visiting FILE. If the buffer needs to be created, add
20080 it to the list of buffers which might be released later."
20083 buf ; just return it
20084 ;; Make a new buffer and remember it
20087 buf)))
20090 "Release all buffers in list, asking the user for confirmation when needed.
20091 When a buffer is unmodified, it is just killed. When modified, it is saved
20092 \(if the user agrees) and then killed."
20097 file
20103 "Get the category applying to position POS."
20106 ;;; Agenda timeline
20111 "Show a time-sorted view of the entries in the current org file.
20112 Only entries with a time stamp of today or later will be listed. With
20114 under the current date.
20115 If the buffer contains an active region, only check the region for
20116 dates."
20129 t doclosed ; always include today
20130 org-timeline-show-empty-dates))
20135 args
20136 s e rtn d emptyp)
20142 ;; Remove past dates from the list of dates.
20145 day-numbers))))
20162 dopast
20163 past)
20171 date args)))
20194 "Return a list of all relevant day numbers from BEG to END buffer positions.
20195 If NO-RANGES is non-nil, include only the start and end dates of a range,
20196 not every single day in the range. If FORCE-TODAY is non-nil, make
20197 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20198 inactive time stamps (those in square brackets) are included.
20199 When EMPTY is non-nil, also include days without any entries."
20201 dates dates1 date day day1 day2 ts1 ts2)
20231 dates)))
20233 ;;; Agenda Daily/Weekly
20244 ;;;###autoload
20246 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20247 The view will be for the current day or week, but from the overview buffer
20248 you will be able to go to other days/weeks.
20251 all unfinished TODO items will also be shown, before the agenda.
20252 This feature is considered obsolete, please use the TODO list or a block
20253 agenda instead.
20255 With a numeric prefix argument in an interactive call, the agenda will
20256 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20257 the number of days. NDAYS defaults to `org-agenda-ndays'.
20259 START-DAY defaults to TODAY, or to the most recent match for the weekday
20260 given in `org-agenda-start-on-weekday'."
20271 ;; Convert to an absolute day number
20279 org-agenda-start-on-weekday nil))
20288 sd
20297 s e rtn rtnall file date d start-pos end-pos todayp nd)
20300 ;; Make the list of days
20302 nd ndays)
20315 rtnall nil)
20343 rtnall nil)
20349 file date
20352 file date
20376 rtnall nd todayp))
20399 ;;; Agenda TODO list
20404 ;;;###autoload
20406 "Show all TODO entries from all agenda file in a single list.
20407 The prefix arg can be used to select a specific TODO keyword and limit
20409 for a keyword. A numeric prefix directly selects the Nth keyword in
20410 `org-todo-keywords-1'."
20424 rtn rtnall files file pos)
20434 rtnall nil)
20458 kwds))
20469 ;;; Agenda tags match
20471 ;;;###autoload
20473 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20474 The prefix arg TODO-ONLY limits the search to TODO entries."
20481 rtn rtnall files file pos matcher
20482 buffer)
20490 rtnall nil)
20498 ;; If file does not exist, merror message to agenda
20509 org-agenda-restrict-end)
20534 ;;; Agenda Finding stuck projects
20537 "Regular expression used in skipping subtrees for the agenda.
20538 This is basically a temporary global variable that can be set and then
20545 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20546 If yes, it returns the end position of this tree, causing agenda commands
20547 to skip this subtree. This is a function that can be put into
20548 `org-agenda-skip-function' for the duration of a command."
20550 skip)
20556 "Skip entry if any of CONDITIONS is true.
20557 See `org-agenda-skip-if' for details."
20561 "Skip entry if any of CONDITIONS is true.
20562 See `org-agenda-skip-if' for details."
20566 "Checks current entity for CONDITIONS.
20567 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20568 the entry, i.e. the text before the next heading is checked.
20570 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20571 from different tests. Valid conditions are:
20573 scheduled Check if there is a scheduled cookie
20574 notscheduled Check if there is no scheduled cookie
20575 deadline Check if there is a deadline
20576 notdeadline Check if there is no deadline
20577 regexp Check if regexp matches
20578 notregexp Check if regexp does not match.
20580 The regexp is taken from the conditions list, it must come right after
20581 the `regexp' or `notregexp' element.
20583 If any of these conditions is met, this function returns the end point of
20584 the entity, causing the search to continue from there. This is a function
20585 that can be put into `org-agenda-skip-function' for the duration of a command."
20609 end)))
20611 ;;;###autoload
20613 "Create agenda view for projects that are stuck.
20614 Stuck projects are project that have no next actions. For the definitions
20615 of what a project is and how to check if it stuck, customize the variable
20616 `org-stuck-projects'.
20617 MATCH is being ignored."
20620 ;; FIXME: we could have used org-agenda-skip-if here.
20628 org-done-keywords-for-agenda
20630 todo))
20647 gen-re)))))
20658 ;;; Diary integration
20663 "Get the (Emacs Calendar) diary entries for DATE."
20671 entries
20683 ;; No entries
20685 ;; Omit the date and other unnecessary stuff
20687 ;; Add prefix to each line and extend the text properties
20699 ;; Extend the text properties to the beginning of the line
20702 entries)))))
20705 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
20706 This gets rid of the date, the underline under the date, and
20707 the dummy entry installed by `org-mode' to ensure non-empty diary for each
20708 date. It also removes lines that contain only whitespace."
20725 ;; Make sure entries from the diary have the right text properties.
20728 ;; We can rely on the hook, nothing to do
20729 nil
20730 ;; Hook not avaiable, must use advice to make this work
20732 "Make the position visible."
20735 buffer-file-name)
20739 "Add text properties to string, allowing org-mode to act on it."
20742 'keymap org-agenda-keymap
20747 'org-agenda-diary-link t
20751 "Add a dummy entry to the diary.
20752 Needed to avoid empty dates which mess up holiday display."
20753 ;; Catch the error if dealing with the new add-to-diary-alist
20760 ;;;###autoload
20762 "Return diary information from org-files.
20764 It accesses org files and extracts information from those files to be
20765 listed in the diary. The function accepts arguments specifying what
20766 items should be listed. The following arguments are allowed:
20768 :timestamp List the headlines of items containing a date stamp or
20769 date range matching the selected date. Deadlines will
20770 also be listed, on the expiration day.
20772 :sexp List entries resulting from diary-like sexps.
20774 :deadline List any deadlines past due, or due within
20775 `org-deadline-warning-days'. The listing occurs only
20776 in the diary for *today*, not at any other date. If
20777 an entry is marked DONE, it is no longer listed.
20779 :scheduled List all items which are scheduled for the given date.
20780 The diary for *today* also contains items which were
20781 scheduled earlier and are not yet marked DONE.
20783 :todo List all TODO items from the org-file. This may be a
20784 long list - so this is not turned on by default.
20785 Like deadlines, these entries only show up in the
20786 diary for *today*, not at any other date.
20788 The call in the diary file should look like this:
20790 &%%(org-diary) ~/path/to/some/orgfile.org
20792 Use a separate line for each org file to check. Or, if you omit the file name,
20793 all files listed in `org-agenda-files' will be checked automatically:
20795 &%%(org-diary)
20797 If you don't give any arguments (as in the example above), the default
20798 arguments (:deadline :scheduled :timestamp :sexp) are used.
20799 So the example above may also be written as
20801 &%%(org-diary :deadline :timestamp :sexp :scheduled)
20803 The function expects the lisp variables `entry' and `date' to be provided
20804 by the caller, because this is how the calendar works. Don't use this
20805 function from a program - use `org-agenda-get-day-entries' instead."
20813 file rtn results)
20815 ;; If this is called during org-agenda, don't return any entries to
20816 ;; the calendar. Org Agenda will list these entries itself.
20824 ;;; Agenda entry finders
20827 "Does the work for `org-diary' and `org-agenda'.
20828 FILE is the path to a file to be checked for entries. DATE is date like
20829 the one returned by `calendar-current-date'. ARGS are symbols indicating
20830 which kind of entries should be extracted. For details about these, see
20831 the documentation of `org-diary'."
20838 arg results rtn)
20840 ;; If file does not exist, make sure an error message ends up in diary
20850 org-agenda-restrict-end)
20852 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
20876 results))))
20892 "Is the cursor inside a date range?"
20907 nil)))
20910 "Return the TODO information for agenda display."
20913 'org-not-done-regexp org-not-done-regexp
20914 'org-todo-regexp org-todo-regexp
20916 'keymap org-agenda-keymap
20917 'help-echo
20920 ;; FIXME: get rid of the \n at some point but watch out
20924 org-todo-regexp
20928 org-not-done-regexp)
20930 marker priority category tags
20931 ee txt beg end)
20970 "Return the date stamp information for agenda display."
20972 'org-not-done-regexp org-not-done-regexp
20973 'org-todo-regexp org-todo-regexp
20975 'keymap org-agenda-keymap
20976 'help-echo
20984 "<%Y-%m-%d"
20998 marker hdmarker deadlinep scheduledp donep tmp priority category
20999 ee txt timestr tags b0 b3 e3 head)
21017 b0)
21024 ;; substring should only run to end of time stamp
21036 nil head category tags timestr nil
21037 remove-re)))
21050 "Return the sexp information for agenda display."
21054 'keymap org-agenda-keymap
21055 'help-echo
21059 marker category ee txt tags entry result beg b sexp sexp-entry)
21091 "Return the logged TODO entries for agenda display."
21093 'org-not-done-regexp org-not-done-regexp
21094 'org-todo-regexp org-todo-regexp
21095 'keymap org-agenda-keymap
21096 'help-echo
21108 marker hdmarker priority category tags closedp
21109 ee txt timestr)
21118 ;; donep (org-entry-is-done-p)
21119 )
21121 ;; substring should only run to end of time stamp
21145 "Return the deadline information for agenda display."
21147 'org-not-done-regexp org-not-done-regexp
21148 'org-todo-regexp org-todo-regexp
21149 'keymap org-agenda-keymap
21150 'help-echo
21156 d2 diff dfrac wdays pos pos1 category tags
21157 ee txt head face s upcomingp donep timestr)
21169 ;; When to show a deadline in the calendar:
21170 ;; If the expiration is within wdays warning time.
21171 ;; Past-due deadlines are only shown on the current date
21199 diff))
21200 head category tags timestr))))
21209 'org-category category
21218 "Return the face to displaying a deadline item.
21219 FRACTION is what fraction of the head-warning time has passed."
21226 "Return the scheduled information for agenda display."
21228 'org-todo-regexp org-todo-regexp
21231 'keymap org-agenda-keymap
21232 'help-echo
21238 d2 diff pos pos1 category tags
21239 ee txt head pastschedp donep face timestr s)
21249 ;; When to show a scheduled item in the calendar:
21250 ;; If it is on or past the date.
21278 head category tags timestr))))
21282 'org-scheduled-previously
21285 'undone-face face
21297 "Return the date-range information for agenda display."
21299 'org-not-done-regexp org-not-done-regexp
21300 'org-todo-regexp org-todo-regexp
21302 'keymap org-agenda-keymap
21303 'help-echo
21308 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21309 donep head)
21321 ;; Only allow days between the limits, because the normal
21322 ;; date stamps will catch the limits.
21339 head category tags
21348 ;; Sort the entries by expiration date.
21351 ;;; Agenda presentation and sorting
21361 "Regular expression to match a plain time or time range.
21362 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21363 groups carry important information:
21364 0 the full match
21365 1 the first time, range or not
21373 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21374 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21375 groups carry important information:
21376 0 the full match
21377 7 hours of duration
21386 "Regular expression to match a timestamp time or time range.
21387 After a match, the following groups carry important information:
21388 0 the full match
21389 1 date plus weekday, for backreferencing to make sure both times on same day
21390 2 the first time, range or not
21394 "A flag, set by `org-compile-prefix-format'.
21397 "A flag, set by `org-compile-prefix-format'.
21401 noprefix remove-re)
21402 "Format TXT to be inserted into the agenda buffer.
21403 In particular, it adds the prefix and corresponding text properties. EXTRA
21404 must be a string and replaces the `%s' specifier in the prefix format.
21405 CATEGORY (string, symbol or nil) may be used to overrule the default
21406 category taken from local variable or file name. It will replace the `%c'
21407 specifier in the format. DOTIME, when non-nil, indicates that a
21408 time-of-day should be extracted from TXT for sorting of this entry, and for
21409 the `%t' specifier in the format. When DOTIME is a string, this string is
21410 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21411 only the correctly processes TXT should be returned - this is used by
21412 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21413 Any match of REMOVE-RE will be removed from TXT."
21415 ;; Diary entries sometimes have extra whitespace at the beginning
21418 org-category
21424 time ; time and tag are needed for the eval of the prefix format
21427 stamp plain s0 s1 s2 rtn srp)
21429 ;; Extract starting and ending time and move them to prefix
21437 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21438 ;; them, we might want to remove them there to avoid duplication.
21439 ;; The user can turn this off with a variable.
21445 t))
21447 ;; Normalize the time(s) to 24 hour
21455 org-agenda-default-appointment-duration))
21456 h)
21461 txt)
21462 ;; Tags are in the string
21465 org-prefix-has-tag))
21470 t t txt))))
21476 ;; Create the final string
21479 ;; Prepare the variables needed in the eval of the compiled format
21485 ;; Evaluate the compiled format
21488 ;; And finally add the text properties
21491 'org-highest-priority org-highest-priority
21492 'org-lowest-priority org-lowest-priority
21494 'time-of-day time-of-day
21495 'txt txt
21496 'time time
21497 'extra extra
21512 list)))
21517 new time)
21519 ;; don't show empty grid
21525 nil string "" nil
21527 new)
21535 "Compile the prefix format into a Lisp form that can be evaluated.
21536 The resulting form is returned and stored in the variable
21537 `org-prefix-format-compiled'."
21541 org-agenda-prefix-format)
21546 varform vars var e c f opt)
21548 s start)
21561 ""
21571 ;; the old format
21579 "Check string S for a time of day.
21580 If found, return it as a military time number between 0 and 2400.
21581 If not found, return nil.
21582 The optional STRING argument forces conversion into a 5 character wide string
21583 HH:MM."
21605 "Sort and concatenate the agenda items."
21608 list
21627 ; (and re (equal (string-match (concat "\\(\\.*\\)" re) x (or pl 0)) pl)
21628 ; (add-text-properties
21629 ; (or (match-end 1) (match-end 0)) (match-end 0)
21630 ; (list 'face (org-get-todo-face (match-string 2 x)))
21631 ; x))
21638 x)
21642 " "
21644 x)))
21647 "Compare the priorities of string A and B."
21655 "Compare the string values of categories of strings A and B."
21663 "Compare the string values of categories of strings A and B."
21673 "Compare the time-of-day values of strings A and B."
21682 "Predicate for sorting agenda entries."
21683 ;; The following variables will be used when the form is evaluated.
21684 ;; So even though the compiler complains, keep them.
21698 ;;; Agenda restriction lock
21716 "Set restriction lock for agenda, to current subtree or file.
21717 Restriction will be the file if TYPE is `file', or if type is the
21718 universal prefix '(4), or if the cursor is before the first headline
21719 in the file. Otherwise, restriction will be to the current subtree."
21751 "Remove the agenda restriction lock."
21765 "If there is any window showing the agenda view, update it."
21774 org-agenda-overriding-restriction)
21777 ;;; Agenda commands
21780 "Check if agenda buffer is of allowed type.
21781 If ERROR is non-nil, throw an error, otherwise just return nil."
21783 t
21786 nil)))
21789 "Exit agenda by removing the window or the buffer."
21796 ;; Maybe restore the pre-agenda window configuration.
21799 org-pre-agenda-window-conf
21803 "Exit agenda by removing the window or the buffer.
21804 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
21805 Org-mode buffers visited directly by the user will not be touched."
21819 "Save all Org-mode buffers without user confirmation."
21826 "Rebuild Agenda.
21827 When this is the global TODO list, a prefix argument will be interpreted."
21836 org-agenda-pending-undo-list nil)
21842 "Jump to DATE in agenda."
21847 "Go to today."
21873 "Go forward in time by thee current span.
21874 With prefix ARG, go forward that many times the current span."
21881 greg2 nd)
21903 "Go backward in time by the current span.
21904 With prefix ARG, go backward that many times the current span."
21909 "Switch to daily view for agenda."
21914 "Switch to daily view for agenda."
21919 "Switch to daily view for agenda."
21923 "Switch to daily view for agenda."
21930 "Change the agenda view to SPAN.
21931 SPAN may be `day', `week', `month', `year'."
21936 org-starting-day))
21947 "Compute starting date and number of days for agenda.
21948 SPAN may be `day', `week', `month', `year'. The return value
21949 is a cons cell with the starting date and the number of days,
21950 so that the date SD will be in that range."
21952 nd)
21969 sd)))
21975 sd))))
21978 ;; FIXME: does not work if user makes date format that starts with a blank
21980 "Jump to the next line indicating a date in agenda buffer."
21992 "Jump to the previous line indicating a date in agenda buffer."
21999 ;; Initialize the highlight
22004 "Highlight a region with overlay."
22009 "Detach overlay INDEX."
22012 ;; FIXME this is currently not used.
22021 "Toggle follow mode in an agenda buffer."
22029 "Toggle log mode in an agenda buffer."
22039 "Toggle diary inclusion in an agenda buffer."
22049 "Toggle time grid in an agenda buffer."
22059 "Set the mode name to indicate all the small mode settings."
22078 "Show the priority of the current item.
22079 This priority is composed of the main priority given with the [#A] cookies,
22080 and by additional input from the age of a schedules or deadline entry."
22086 "Show the tags applicable to the current item."
22095 "Go to the Org-mode file which contains the item at point."
22113 "Normal hook run after an item has been shown from the agenda.
22117 "Kill the entry or subtree belonging to the current agenda entry."
22150 "Kill the entry or subtree belonging to the current agenda entry."
22168 "Remove all lines in the agenda that correspond to a given subtree.
22169 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22170 If this information is not given, the function uses the tree at point."
22193 "Follow the link in the current line, if any."
22202 "Get a variable from a referenced buffer and install it here."
22209 "Go to the Org-mode file which contains the item at point."
22226 "Go to the Org-mode file which contains the item at the mouse click."
22232 "Display the Org-mode file which contains the item at point."
22239 "Display the Org-mode file which contains the item at point and recenter."
22247 "Display the Org-mode file which contains the item at the mouse click."
22253 "Check if the entry is a diary link and abort if yes."
22261 "Show the subtree corresponding to the current entry in an indirect buffer.
22262 This calls the command `org-tree-to-indirect-buffer' from the original
22263 Org-mode buffer.
22264 With numerical prefix arg ARG, go up to this level and then take that tree.
22265 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22266 dedicated frame)."
22279 "Marker pointing to the headline that last changed its TODO state
22283 "Switch TODO entry to next sequence."
22288 "Switch TODO entry to previous sequence."
22293 "Cycle TODO state of line at point, also in Org-mode file.
22294 This changes the line at point, all other lines in the agenda referring to
22295 the same tree node, and the headline of the tree node in the Org-mode file."
22305 newhead)
22326 "Change all lines in the agenda buffer which match HDMARKER.
22327 The new content of the line will be NEWHEAD (as modified by
22328 `org-format-agenda-item'). HDMARKER is checked with
22329 `equal' against all `org-hd-marker' text properties in the file.
22330 If FIXFACE is non-nil, the face of each item is modified acording to
22331 the new TODO state."
22333 props m pl undone-face done-face finish new dotime cat tags)
22363 undone-face done-face))))
22371 "Align all tags in agenda items to `org-agenda-tags-column'."
22384 org-agenda-tags-column))
22392 "Increase the priority of line at point, also in Org-mode file."
22397 "Decrease the priority of line at point, also in Org-mode file."
22402 "Set the priority of line at point, also in Org-mode file.
22403 This changes the line at point, all other lines in the agenda referring to
22404 the same tree node, and the headline of the tree node in the Org-mode file."
22413 newhead)
22429 "Get a list of all headline tags applicable at POS.
22430 POS defaults to point. If tags are inherited, the list contains
22431 the targets in the same sequence as the headlines appear, i.e.
22432 the tags of the current headline come last."
22447 tags)))
22451 tags)))
22453 ;; FIXME: should fix the tags property of the agenda line.
22455 "Set tags for the current headline."
22466 newhead)
22484 "Toggle the archive tag for the current entry."
22493 newhead)
22509 "Change the date of this item to one day later."
22528 "Change the date of this item to one day earlier."
22533 "Show new date stamp via text properties."
22534 ;; We use text properties to make this undoable
22543 ;; Use `duplicable' property to trigger undo recording
22558 "Change the date of this item. Date is prompted for, with default today.
22559 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22560 be used to request time specification in the time stamp."
22578 "Schedule the item at point."
22587 ts)
22597 "Schedule the item at point."
22606 ts)
22616 "Return the heading of the current entry, without the stars."
22626 "Start the clock on the currently selected item."
22639 "Stop the currently running clock."
22647 "Cancel the currently running clock."
22655 "Make a diary entry, like the `i' command from the calendar.
22656 All the standard commands work: block, weekly etc."
22672 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
22681 ;; We implement this by hacking the `calendar-cursor-to-date' function
22682 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
22698 "Execute a calendar command from the agenda, with the date associated to
22699 the cursor position."
22708 ;; the following 3 vars are needed in the calendar
22722 "Display the phases of the moon for the 3 months around the cursor date."
22727 "Display the holidays for the 3 months around the cursor date."
22736 "Display sunrise and sunset for the cursor date.
22737 Latitude and longitude can be specified with the variables
22738 `calendar-latitude' and `calendar-longitude'. When called with prefix
22739 argument, latitude and longitude will be prompted for."
22749 "Open the Emacs calendar with the date at the cursor."
22762 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
22763 This is a command that has to be installed in `calendar-mode-map'."
22767 nil))
22773 date s)
22799 ;;;; Embedded LaTeX
22814 "Toggle the minor `org-cdlatex-mode'.
22815 This mode supports entering LaTeX environment and math in LaTeX fragments
22816 in Org-mode.
22818 nil " OCDL" nil
22823 "Always return t in org-mode buffers.
22824 This is because we want to insert math symbols without dollars even outside
22825 the LaTeX math segments. If Orgmode thinks that point is actually inside
22826 en embedded LaTeX fragement, let texmathp do its job.
22843 "Unconditionally turn on `org-cdlatex-mode'."
22847 "Test if point is inside a LaTeX fragment.
22849 sequence appearing also before point.
22850 Even though the matchers for math are configurable, this function assumes
22852 delimiters are skipped when they have been removed by customization.
22853 The return value is nil, or a cons cell with the delimiter and
22854 and the position of this delimiter.
22856 This function does a reasonably good job, but can locally be fooled by
22857 for example currency specifications. For example it will assume being in
22859 fragments that are properly closed, but during editing, we have to live
22860 with the uncertainty caused by missing closing delimiters. This function
22861 looks only before point, not after."
22880 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
22884 ;; count $$
22892 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
22893 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
22894 - inside a LaTeX fragment, or
22895 - after the first word in a line, where an abbreviation expansion could
22896 insert a LaTeX environment."
22909 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
22910 Revert to the normal definition outside of these fragments."
22918 "Execute `cdlatex-math-modify' in LaTeX fragments.
22919 Revert to the normal definition outside of these fragments."
22931 "Remove all overlays with LaTeX fragment images in current buffer."
22936 "Preview the LaTeX fragment at point, or all locally or globally.
22937 If the cursor is in a LaTeX fragment, create the image and overlay
22938 it over the source code. If there is no fragment at point, display
22939 all fragments in the current text, from one headline to the next. With
22940 prefix SUBTREE, display all fragments in the current subtree. With a
22941 double prefix `C-u C-u', or when the cursor is before the first headline,
22942 display all fragments in the buffer.
22972 buffer-file-name)))
22978 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
22979 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
22980 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
22987 "Replace LaTeX fragments with links to an image, and produce images."
22996 m n block linkfile movefile ov)
22997 ;; Check if there are old images files with this prefix, and remove them
23001 todir 'full
23003 ;; Check the different regular expressions
23023 txt movefile opt forbuffer)
23031 ov 'end-glyph
23034 ov 'display
23041 ;; This function borrows from Ganesh Swami's latex2png.el
23045 temporary-file-directory))
23074 "-D" dpi
23075 ;;"-x" scale "-y" scale
23077 "-o" pngfile
23078 dvifile)
23081 ;; Use the requested file name and clean up
23085 pngfile))))
23088 "Return an rgb color specification for dvipng."
23094 "Return string to be used as color value for an RGB component."
23097 ;;;; Exporting
23099 ;;; Variables, constants, and parameter plists
23155 "Return the property list with default settings for the export variables."
23159 rtn))
23162 "Return the property list with file-local settings for export."
23169 p key val text options)
23202 o)
23206 options)
23210 p))))
23216 val)))
23217 dir))
23224 rtn line level)
23229 ;; Beginning of a COMMENT subtree. Skip it.
23235 ;; an ordinary comment line
23236 )
23242 ;; a special table line that should be removed
23243 )
23250 \[v] limit export to visible part of outline tree
23252 \[a] export as ASCII
23254 \[h] export as HTML
23255 \[H] export as HTML to temporary buffer
23256 \[R] export region as HTML
23257 \[b] export as HTML and browse immediately
23258 \[x] export as XOXO
23260 \[l] export as LaTeX
23261 \[L] export as LaTeX to temporary buffer
23263 \[i] export current file as iCalendar file
23264 \[I] export all agenda files as iCalendar files
23265 \[c] export agenda files into combined iCalendar file
23267 \[F] publish current file
23268 \[P] publish current project
23269 \[X] publish... (project will be prompted for)
23289 r1 r2 ass)
23592 )
23593 "Entities for TeX->HTML translation.
23597 The list contains HTML entities for Latin-1, Greek and other symbols.
23598 It is supplemented by a number of commonly used TeX macros with appropriate
23601 ;;; General functions for all backends
23604 "Cleanup a buffer STRING so that links can be created safely."
23622 a b xx
23623 rtn p)
23627 ;; Remove license-to-kill stuff
23635 ;; Get the correct stuff before the first headline
23646 ;; Get rid of archived trees
23658 ;; Get rid of drawers
23663 'identity
23671 ;; Find targets in comments and move them out of comments,
23672 ;; but mark them as targets that should be invisible
23677 ;; Protect backend specific stuff, throw away the others.
23682 fmt)
23713 ;; Protect quoted subtrees
23721 ;; Protect verbatim elements
23728 ;; Remove subtrees that are commented
23734 ;; Remove special table lines
23746 ;; Specific LaTeX stuff
23754 ;; Specific HTML stuff
23756 ;; Convert LaTeX fragments to images
23761 org-current-export-file)))
23765 ;; Remove or replace comments
23774 ;; Find matches for radio targets and turn them into internal links
23781 ;; Find all links that contain a newline and put them into a single line
23783 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
23789 ;; Normalize links: Convert angle and plain links into bracket links
23790 ;; Expand link abbreviations
23797 ;; added 'org-link face to links
23813 "]"
23821 ;; Find multiline emphasis and put them into single line
23835 rtn))
23838 "Get a title for the current document, from looking at the buffer."
23844 ;; Mark the line so that it will not be exported as normal text.
23848 ;; Return the title string
23852 "Return subtree title and exclude it from export."
23858 ;; This is a subtree, we take the title from the first heading
23865 title))
23868 "Take link text and make a safe target out of it."
23872 'identity
23878 "Get the minimum level in LINES."
23886 ;; Variable holding the vector with section numbers
23890 "Initialize the vector for the section numbers."
23907 "Return a string with the current section number.
23908 When LEVEL is non-nil, increase section numbers on that level."
23930 string))
23932 ;;; ASCII export
23940 "Export the outline as a pretty ASCII file.
23941 If there is an active region, export only the region.
23942 The prefix ARG specifies how many levels of the outline should become
23943 underlined headlines. The default is 3."
23972 filename))
23988 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
23997 region
23998 :for-ascii t
23999 :skip-before-1st-heading
24002 :verbatim-multiline t
24003 :archived-trees
24007 thetoc have-headings first-heading-pos
24008 table-open table-buffer)
24026 ;; create local variables for all options, to make sure all called
24027 ;; functions get the correct information
24031 org-export-plist-vars)
24034 org-export-headline-levels))
24037 umax))
24039 ;; File header
24043 org-export-author-info)
24065 line)
24066 ;; This is a headline
24072 todo
24076 org-done-keywords)))
24077 ; TODO, not DONE
24081 line lines level))))
24088 t t txt)))
24093 txt))
24108 thetoc)
24110 ))))
24111 lines)
24116 ;; Remove the quoted HTML tags.
24118 ;; Remove targets
24121 ;; Replace internal links
24125 t nil line)))
24130 ;; a Headline
24139 ;; New table starts
24141 ;; Accumulate lines
24162 ;; insert the table of contents
24174 ;; Convert whitespace place holders
24184 ;; remove display and invisible chars
24200 "Do extra work for ASCII export"
24210 "Search the subtree below LINE for any TODO entries."
24213 line lv todo)
24221 org-done-keywords))))
24222 ; TODO, not DONE
24227 "Handle quoted HTML for ASCII export."
24230 ;; We just remove the tags for now.
24232 line)
24235 "Insert the string S centered and underline it with character UNDERLINE."
24244 "Insert a new level in ASCII export."
24250 org-export-ascii-bullets))
24252 ;; find the indentation of the next non-empty line
24273 "Create a copy of the visible part of the current buffer, and export it.
24274 The copy is created in a temporary buffer and removed after use.
24275 TYPE is the final key (as a string) that also select the export command in
24276 the `C-c C-e' export dispatcher.
24277 As a special case, if the you type SPC at the prompt, the temporary
24278 org-mode file will not be removed but presented to you so that you can
24279 continue to use it. The prefix arg ARG is passed through to the exporting
24280 command."
24283 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24285 current-prefix-arg))
24300 s e)
24301 ;; Need to hack the drawers here.
24317 ;; Copy all comment lines to the end, to make sure #+ settings are
24318 ;; still available for the second export step. Kind of a hack, but
24319 ;; does do the trick.
24340 s))
24345 s))
24347 ;;; HTML export
24350 "Return a string with current options as keyword options.
24351 Does include HTML export options as well as TODO and CATEGORY stuff."
24353 "#+TITLE: %s
24354 #+AUTHOR: %s
24355 #+EMAIL: %s
24356 #+LANGUAGE: %s
24357 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24358 #+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
24359 #+CATEGORY: %s
24360 #+SEQ_TODO: %s
24361 #+TYP_TODO: %s
24362 #+PRIORITIES: %c %c %c
24363 #+DRAWERS: %s
24364 #+STARTUP: %s %s %s %s %s
24365 #+TAGS: %s
24366 #+ARCHIVE: %s
24367 #+LINK: %s
24368 "
24370 org-export-headline-levels
24371 org-export-with-section-numbers
24372 org-export-with-toc
24373 org-export-preserve-breaks
24374 org-export-html-expand
24375 org-export-with-fixed-width
24376 org-export-with-tables
24377 org-export-with-sub-superscripts
24378 org-export-with-special-strings
24379 org-export-with-footnotes
24380 org-export-with-emphasize
24381 org-export-with-TeX-macros
24382 org-export-with-LaTeX-fragments
24383 org-export-skip-text-before-1st-heading
24384 org-export-with-drawers
24385 org-export-with-tags
24387 "TODO FEEDBACK VERIFY DONE"
24388 "Me Jason Marie DONE"
24389 org-highest-priority org-lowest-priority org-default-priority
24408 org-archive-location
24409 "org file:~/org/%s.org"
24410 ))
24413 "Insert into the buffer a template with information for exporting."
24422 "Toggle the fixed-width export.
24423 If there is no active region, the QUOTE keyword at the current headline is
24424 inserted or removed. When present, it causes the text between this headline
24425 and the next to be exported as fixed-width text, and unmodified.
24426 If there is an active region, this command adds or removes a colon as the
24427 first character of this line. If the first character of a line is a colon,
24428 this line is also exported in fixed-width font."
24437 off)
24467 "Export the outline as HTML and immediately open it with a browser.
24468 If there is an active region, export only the region.
24469 The prefix ARG specifies how many levels of the outline should become
24470 headlines. The default is 3. Lower levels will become bulleted lists."
24476 "Call `org-export-as-html', may be used in batch processing as
24477 emacs --batch
24478 --load=$HOME/lib/emacs/org.el
24480 --visit=MyFile --funcall org-export-as-html-batch"
24484 "Call `org-exort-as-html` with output to a temporary buffer.
24485 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24491 "Assume the current region has org-mode syntax, and convert it to HTML.
24492 This can be used in any buffer. For example, you could write an
24493 itemized list in org-mode syntax in an HTML buffer and then use this
24494 command to convert it."
24514 "Convert region from BEG to END in org-mode buffer to HTML.
24515 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24516 contents, and only produce the region of converted text, useful for
24517 cut-and-paste operations.
24518 If BUFFER is a buffer or a string, use/create that buffer as a target
24519 of the converted HTML. If BUFFER is the symbol `string', return the
24520 produced HTML as a string and leave not buffer behind. For example,
24521 a Lisp program could call this function in the following way:
24523 (setq html (org-export-region-as-html beg end t 'string))
24525 When called interactively, the output buffer is selected, and shown
24526 in a window. A non-interactive call will only retunr the buffer."
24531 rtn)
24536 nil nil nil
24537 buffer body-only))
24541 rtn)))
24545 to-buffer body-only)
24546 "Export the outline as a pretty HTML file.
24547 If there is an active region, export only the region. The prefix
24548 ARG specifies how many levels of the outline should become
24549 headlines. The default is 3. Lower levels will become bulleted
24550 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24551 EXT-PLIST is a property list with external parameters overriding
24552 org-mode's default settings, but still inferior to file-local
24553 settings. When TO-BUFFER is non-nil, create a buffer with that
24554 name and export to that buffer. If TO-BUFFER is the symbol `string',
24555 don't leave any buffer behind but just return the resulting HTML as
24556 a string. When BODY-ONLY is set, don't produce the file header and footer,
24557 simply return the content of <body>...</body>, without even
24558 the body tags themselves."
24561 ;; Make sure we have a file name when we need it.
24567 buffer-file-name))
24576 ext-plist
24581 valid thetoc have-headings first-heading-pos
24590 ;; The following two are dynamically scoped into other
24591 ;; routines below.
24610 default-directory))
24644 buffer-file-coding-system))
24646 coding-system))
24648 coding-system))
24660 region
24661 :emph-multiline t
24662 :for-html t
24663 :skip-before-1st-heading
24666 :archived-trees
24668 :add-text
24670 :LaTeX-fragments
24673 table-open type
24674 table-buffer table-orig-buffer
24675 ind start-is-num starter didclose
24676 rpl path desc descp desc1 desc2 link
24677 )
24696 ;; Get the language-dependent settings
24700 ;; Switch to the output buffer
24710 ;; create local variables for all options, to make sure all called
24711 ;; functions get the correct information
24715 org-export-plist-vars)
24717 org-export-headline-levels))
24720 umax))
24722 ;; File header
24728 <head>
24729 <title>%s</title>
24734 %s
24735 </head><body>
24736 "
24749 org-export-html-toplevel-hlevel
24751 org-export-html-toplevel-hlevel)
24752 thetoc)
24757 ;; This is a headline
24766 todo
24770 org-done-keywords)))
24771 ; TODO, not DONE
24775 line lines level))))
24800 ;; Check for targets
24805 t t line))
24808 target-alist))
24819 )))
24820 line)
24821 lines))
24833 ;; end of quote section?
24837 ;; inside a quote section?
24842 ;; verbatim lines
24856 ;; Protected HTML
24871 ;; Horizontal line
24876 ;; make targets to anchors
24884 t t line)))
24888 ; (concat "@<i>" (match-string 1 line) "@</i> ")
24889 t t line)))
24895 t t line)))))
24899 ;; replace "&" by "&", "<" and ">" by "<" and ">"
24900 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
24901 ;; Also handle sub_superscripts and checkboxes
24905 ;; Format the links
24915 ;; Make an image out of the description if that is so wanted
24921 ;; FIXME: do we need to unescape here somewhere?
24931 ;; standard URL, just check if we need to inline an image
24939 ;; standard URL
24943 ;; FILE link
24946 thefile file-is-image-p search)
24954 t))
24963 ;; make sure this is can be used as target search
24988 ;; TODO items
24996 org-done-keywords)
25001 ;; Does this contain a reference to a footnote?
25013 t t line))))))
25017 ;; This is a headline
25025 ;; Close any local lists before inserting a new header line
25031 in-local-list nil))
25035 head-count)
25036 ;; QUOTES
25044 ;; New table starts
25046 ;; Accumulate lines
25058 ;; Normal lines
25061 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25062 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25065 line)
25072 ;; empty line. Pretend indentation is large.
25074 0
25090 ;; Start new (level of) list
25097 ;; continue current list
25101 ;; we did close a list, normal text follows: need <p>
25107 "<b>[X]</b>"
25109 t t line))))
25111 ;; Empty lines start a new paragraph. If hand-formatted lists
25112 ;; are not fully interpreted, lines starting with "-", "+", "*"
25113 ;; also start a new paragraph.
25116 ;; Is this the start of a footnote?
25122 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25124 ;; Check if the line break needs to be conserved
25133 ;; Properly close all local lists and other lists
25136 ;; Close any local lists before inserting a new header line
25142 in-local-list nil))
25145 head-count)
25176 ;; insert the table of contents
25193 ;; remove empty paragraphs and lists
25200 ;; Convert whitespace place holders
25221 "Format a table for ascii export."
25225 ;; Table made by table.el - test for spanning
25226 lines
25228 ;; A normal org table
25229 ;; Get rid of hlines at beginning and end
25235 ;; Check if the table has a marking column. If yes remove the
25236 ;; column and the special lines
25238 ;; Get rid of the vertical lines except for grouping
25240 rtn line vl1 start)
25262 vl))
25265 "Find out which HTML converter to use and return the HTML code."
25269 ;; A normal org table
25271 ;; Table made by table.el - test for spanning
25275 nil))
25276 lines)))
25282 hlines))))
25285 ;; We can use my own converter with HTML conversions
25287 ;; Need to use the code generator in table.el, with the original text.
25291 "Format a table into HTML."
25292 ;; Get rid of hlines at beginning and end
25298 ;; Check if the table has a marking column. If yes remove the
25299 ;; column and the special lines
25307 tbopen line fields html gr colgropen)
25319 ;; ignore this line
25321 ;; Break the line into fields
25339 html)))
25344 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25360 html)
25366 "Check if the table has a marking column.
25367 If yes remove the column and the special lines."
25373 lines))
25388 nil)
25390 lines)))
25404 nil)
25409 ;; remove the first column
25411 lines))))
25414 "Format a table generated by table.el into HTML.
25415 This conversion does *not* use `table-generate-source' from table.el.
25416 This has the advantage that Org-mode's HTML conversions can be used.
25417 But it has the disadvantage, that no cell- or row-spanning is allowed."
25420 fields html empty)
25430 html
25432 html
25433 "<tr>"
25446 ;; Ignore this line
25448 ;; Break the line into fields and store the fields
25454 field-buffer))
25457 html))
25460 "Format a table into html, using `table-generate-source' from table.el.
25461 This has the advantage that cell- or row-spanning is allowed.
25462 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25477 "Format time stamps in string S, or remove them."
25482 ;; never export CLOCK
25497 ;; Line break if line started and ended with time stamp stuff
25499 s
25503 r))))
25506 ;; convert & to &, < to < and > to >
25515 s)
25518 "Remove tags and time staps from lines going into the toc."
25527 t t s)))
25528 s)
25531 "Prepare STRING for HTML export. Applies all active conversions.
25532 If there are links in the string, don't modify these."
25535 m s l res)
25546 "Apply all active conversions to translate special ASCII to HTML."
25567 t t s))
25569 s)
25572 "Create a regular expression which will match a balanced sexp.
25573 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25574 as single character strings.
25575 The regexp returned will match the entire expression including the
25576 delimiters. It will also define a single group which contains the
25577 match except for the outermost delimiters. The maximum depth of
25578 stacked delimiters is N. Escaping delimiters is not possible."
25614 "Convert special characters in STRING to HTML."
25616 e a re rpl start)
25623 string))
25626 "Convert sub- and superscripts in STRING to HTML."
25642 t t string)))))
25645 string))
25648 "Apply emphasis."
25655 rpl
25661 org-emphasis-alist))
25666 string))
25670 "Insert <p>, but first close previous paragraph if any."
25675 "Close paragraph if there is one open."
25680 "Close <li> if necessary."
25686 "Insert a new level in HTML export.
25687 When TITLE is nil, just close all open levels."
25697 ;; If title is nil, this means this function is called to close
25698 ;; all levels, so the rest is done only if title is given
25710 t t title)))
25726 level level head-count title level))
25731 "Terminate one level in HTML export."
25737 ;;; iCalendar export
25739 ;;;###autoload
25741 "Export current file as an iCalendar file.
25742 The iCalendar file will be located in the same directory as the Org-mode
25743 file, but with extension `.ics'."
25747 ;;;###autoload
25749 "Export all files in `org-agenda-files' to iCalendar .ics files.
25750 Each iCalendar file will be located in the same directory as the Org-mode
25751 file, but with extension `.ics'."
25755 ;;;###autoload
25757 "Export all files in `org-agenda-files' to a single combined iCalendar file.
25758 The file is stored under the name `org-combined-agenda-icalendar-file'."
25763 "Create iCalendar files for all elements of FILES.
25764 If COMBINE is non-nil, combine all calendar entries into a single large
25765 file and store it under the name `org-combined-agenda-icalendar-file'."
25770 org-export-publishing-directory)))
25771 file ical-file ical-buffer category started org-agenda-new-buffers)
25777 org-combined-agenda-icalendar-file
25810 "Hook run after an iCalendar file has been saved.
25811 The iCalendar buffer is still current when this hook is run.
25812 A good way to use this is to tell a desktop calenndar application to re-read
25816 "Print iCalendar entries for the current Org-mode file to `standard-output'.
25817 When COMBINE is non nil, add the category to each line."
25824 scheduledp deadlinep tmp pri category entry location summary desc
25834 inc t
25841 t org-icalendar-include-body)
25851 pos)
25856 ts)
25859 ;; donep (org-entry-is-done-p)
25860 ))
25879 t t summary)))
25886 %s
25887 %s%s
25888 SUMMARY:%s%s%s
25889 CATEGORIES:%s
25893 rrule summary
25898 category)))))
25903 ;; Get all the literal sexps
25929 )
25936 t org-icalendar-include-body)
25942 t t hd)))
25952 %s
25953 SUMMARY:%s%s%s
25954 CATEGORIES:%s
25955 SEQUENCE:1
25956 PRIORITY:%d
25957 STATUS:%s
25959 dts
25965 category pri status)))))))))
25968 "Take out stuff and quote what needs to be quoted.
25969 When IS-BODY is non-nil, assume that this is the body of an item, clean up
25970 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
25971 characters."
25973 nil
25992 s))
25995 "Clean-up description string."
26001 "Start an iCalendar file by inserting the header."
26007 VERSION:2.0
26008 X-WR-CALNAME:%s
26009 PRODID:-//%s//Emacs with Org-mode//EN
26010 X-WR-TIMEZONE:%s
26014 "Finish an iCalendar file by inserting the END statement."
26018 "Take a time string S and convert it to iCalendar format.
26019 KEYWORD is added in front, to make a complete line like DTSTART....
26020 When INC is non-nil, increase the hour by two (if time string contains
26021 a time), or the day by one (if it does not contain a time)."
26023 t2 fmt have-time time)
26039 ;;; XOXO export
26047 "Export the org buffer as XOXO.
26048 The XOXO buffer is named *xoxo-<source buffer name>*"
26050 ;; A quickie abstraction
26052 ;; Output everything as XOXO
26066 ;; Check the output buffer is empty.
26068 ;; Kick off the output
26085 ;; Handle level rendering
26102 )
26106 ;; And output the new li
26112 ;; Finally finish off the ol
26119 ;; Finish the buffer off and clean it up.
26124 )))
26127 ;;;; Key bindings
26129 ;; Make `C-c C-x' a prefix key
26132 ;; TAB key with modifiers
26139 ;; The following line is necessary under Suse GNU/Linux
26145 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26146 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26147 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26149 ;; Cursor keys with modifiers
26150 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26151 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26152 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26153 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26155 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26156 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26157 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26158 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26160 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26161 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26162 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26163 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26165 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26166 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26168 ;;; Extra keys for tty access.
26169 ;; We only set them when really needed because otherwise the
26170 ;; menus don't show the simple keys
26172 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26173 (not window-system))
26174 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26175 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26176 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26177 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26178 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26179 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26180 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26181 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26182 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26183 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26184 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26185 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26186 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26187 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26188 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26189 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26190 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26191 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26192 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26193 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26194 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26195 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26197 ;; All the other keys
26199 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26200 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26201 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26202 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26203 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26204 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26205 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26206 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26207 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26208 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26209 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26210 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26211 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26212 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26213 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26215 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26216 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26217 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26218 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26219 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26220 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26221 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26222 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26223 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26224 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26225 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26226 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26227 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26228 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26229 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26230 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26231 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26233 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26234 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26235 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26236 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26237 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26238 (org-defkey org-mode-map "\C-c^" 'org-sort)
26239 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26240 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26241 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26242 (org-defkey org-mode-map "\C-m" 'org-return)
26243 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26244 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26245 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26246 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26247 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26248 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26249 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26250 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26251 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26252 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26253 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26254 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26255 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26256 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26257 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26258 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26259 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26261 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26262 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26263 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26264 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26266 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26267 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26268 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26269 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26270 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26271 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26272 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26273 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26274 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26275 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26276 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26277 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26279 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26281 (when (featurep 'xemacs)
26282 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26284 (defsubst org-table-p () (org-at-table-p))
26286 (defun org-self-insert-command (N)
26287 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26288 If the cursor is in a table looking at whitespace, the whitespace is
26289 overwritten, and the table is not marked as requiring realignment."
26290 (interactive "p")
26291 (if (and (org-table-p)
26292 (progn
26293 ;; check if we blank the field, and if that triggers align
26294 (and org-table-auto-blank-field
26295 (member last-command
26296 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26298 ;; got extra space, this field does not determine column width
26299 (let (org-table-may-need-update) (org-table-blank-field))
26300 ;; no extra space, this field may determine column width
26301 (org-table-blank-field)))
26302 t)
26303 (eq N 1)
26305 (let (org-table-may-need-update)
26306 (goto-char (1- (match-end 0)))
26307 (delete-backward-char 1)
26308 (goto-char (match-beginning 0))
26309 (self-insert-command N))
26310 (setq org-table-may-need-update t)
26311 (self-insert-command N)
26312 (org-fix-tags-on-the-fly)))
26314 (defun org-fix-tags-on-the-fly ()
26315 (when (and (equal (char-after (point-at-bol)) ?*)
26316 (org-on-heading-p))
26317 (org-align-tags-here org-tags-column)))
26319 (defun org-delete-backward-char (N)
26320 "Like `delete-backward-char', insert whitespace at field end in tables.
26321 When deleting backwards, in tables this function will insert whitespace in
26323 still be marked for re-alignment if the field did fill the entire column,
26324 because, in this case the deletion might narrow the column."
26325 (interactive "p")
26326 (if (and (org-table-p)
26327 (eq N 1)
26328 (string-match "|" (buffer-substring (point-at-bol) (point)))
26329 (looking-at ".*?|"))
26330 (let ((pos (point))
26332 (c org-table-may-need-update))
26333 (backward-delete-char N)
26334 (skip-chars-forward "^|")
26335 (insert " ")
26336 (goto-char (1- pos))
26337 ;; noalign: if there were two spaces at the end, this field
26338 ;; does not determine the width of the column.
26339 (if noalign (setq org-table-may-need-update c)))
26340 (backward-delete-char N)
26341 (org-fix-tags-on-the-fly)))
26343 (defun org-delete-char (N)
26344 "Like `delete-char', but insert whitespace at field end in tables.
26345 When deleting characters, in tables this function will insert whitespace in
26347 still be marked for re-alignment if the field did fill the entire column,
26348 because, in this case the deletion might narrow the column."
26349 (interactive "p")
26350 (if (and (org-table-p)
26351 (not (bolp))
26352 (not (= (char-after) ?|))
26353 (eq N 1))
26354 (if (looking-at ".*?|")
26355 (let ((pos (point))
26357 (c org-table-may-need-update))
26358 (replace-match (concat
26359 (substring (match-string 0) 1 -1)
26360 " |"))
26361 (goto-char pos)
26362 ;; noalign: if there were two spaces at the end, this field
26363 ;; does not determine the width of the column.
26364 (if noalign (setq org-table-may-need-update c)))
26365 (delete-char N))
26366 (delete-char N)
26367 (org-fix-tags-on-the-fly)))
26369 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26370 (put 'org-self-insert-command 'delete-selection t)
26371 (put 'orgtbl-self-insert-command 'delete-selection t)
26372 (put 'org-delete-char 'delete-selection 'supersede)
26373 (put 'org-delete-backward-char 'delete-selection 'supersede)
26375 ;; Make `flyspell-mode' delay after some commands
26376 (put 'org-self-insert-command 'flyspell-delayed t)
26377 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26378 (put 'org-delete-char 'flyspell-delayed t)
26379 (put 'org-delete-backward-char 'flyspell-delayed t)
26381 ;; Make pabbrev-mode expand after org-mode commands
26382 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26383 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26385 ;; How to do this: Measure non-white length of current string
26386 ;; If equal to column width, we should realign.
26388 (defun org-remap (map &rest commands)
26389 "In MAP, remap the functions given in COMMANDS.
26390 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26391 (let (new old)
26392 (while commands
26393 (setq old (pop commands) new (pop commands))
26394 (if (fboundp 'command-remapping)
26395 (org-defkey map (vector 'remap old) new)
26396 (substitute-key-definition old new map global-map)))))
26398 (when (eq org-enable-table-editor 'optimized)
26399 ;; If the user wants maximum table support, we need to hijack
26400 ;; some standard editing functions
26401 (org-remap org-mode-map
26402 'self-insert-command 'org-self-insert-command
26403 'delete-char 'org-delete-char
26404 'delete-backward-char 'org-delete-backward-char)
26405 (org-defkey org-mode-map "|" 'org-force-self-insert))
26407 (defun org-shiftcursor-error ()
26408 "Throw an error because Shift-Cursor command was applied in wrong context."
26409 (error "This command is active in special context like tables, headlines or timestamps"))
26411 (defun org-shifttab (&optional arg)
26412 "Global visibility cycling or move to previous table field.
26413 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26414 on context.
26415 See the individual commands for more information."
26416 (interactive "P")
26417 (cond
26418 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26419 (arg (message "Content view to level: ")
26420 (org-content (prefix-numeric-value arg))
26421 (setq org-cycle-global-status 'overview))
26422 (t (call-interactively 'org-global-cycle))))
26424 (defun org-shiftmetaleft ()
26425 "Promote subtree or delete table column.
26426 Calls `org-promote-subtree', `org-outdent-item',
26427 or `org-table-delete-column', depending on context.
26428 See the individual commands for more information."
26429 (interactive)
26430 (cond
26431 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26432 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26433 ((org-at-item-p) (call-interactively 'org-outdent-item))
26434 (t (org-shiftcursor-error))))
26436 (defun org-shiftmetaright ()
26437 "Demote subtree or insert table column.
26438 Calls `org-demote-subtree', `org-indent-item',
26439 or `org-table-insert-column', depending on context.
26440 See the individual commands for more information."
26441 (interactive)
26442 (cond
26443 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26444 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26445 ((org-at-item-p) (call-interactively 'org-indent-item))
26446 (t (org-shiftcursor-error))))
26448 (defun org-shiftmetaup (&optional arg)
26449 "Move subtree up or kill table row.
26450 Calls `org-move-subtree-up' or `org-table-kill-row' or
26451 `org-move-item-up' depending on context. See the individual commands
26452 for more information."
26453 (interactive "P")
26454 (cond
26455 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26456 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26457 ((org-at-item-p) (call-interactively 'org-move-item-up))
26458 (t (org-shiftcursor-error))))
26459 (defun org-shiftmetadown (&optional arg)
26460 "Move subtree down or insert table row.
26461 Calls `org-move-subtree-down' or `org-table-insert-row' or
26462 `org-move-item-down', depending on context. See the individual
26463 commands for more information."
26464 (interactive "P")
26465 (cond
26466 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26467 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26468 ((org-at-item-p) (call-interactively 'org-move-item-down))
26469 (t (org-shiftcursor-error))))
26471 (defun org-metaleft (&optional arg)
26472 "Promote heading or move table column to left.
26473 Calls `org-do-promote' or `org-table-move-column', depending on context.
26474 With no specific context, calls the Emacs default `backward-word'.
26475 See the individual commands for more information."
26476 (interactive "P")
26477 (cond
26478 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26479 ((or (org-on-heading-p) (org-region-active-p))
26480 (call-interactively 'org-do-promote))
26481 ((org-at-item-p) (call-interactively 'org-outdent-item))
26482 (t (call-interactively 'backward-word))))
26484 (defun org-metaright (&optional arg)
26485 "Demote subtree or move table column to right.
26486 Calls `org-do-demote' or `org-table-move-column', depending on context.
26487 With no specific context, calls the Emacs default `forward-word'.
26488 See the individual commands for more information."
26489 (interactive "P")
26490 (cond
26491 ((org-at-table-p) (call-interactively 'org-table-move-column))
26492 ((or (org-on-heading-p) (org-region-active-p))
26493 (call-interactively 'org-do-demote))
26494 ((org-at-item-p) (call-interactively 'org-indent-item))
26495 (t (call-interactively 'forward-word))))
26497 (defun org-metaup (&optional arg)
26498 "Move subtree up or move table row up.
26499 Calls `org-move-subtree-up' or `org-table-move-row' or
26500 `org-move-item-up', depending on context. See the individual commands
26501 for more information."
26502 (interactive "P")
26503 (cond
26504 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26505 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26506 ((org-at-item-p) (call-interactively 'org-move-item-up))
26507 (t (transpose-lines 1) (beginning-of-line -1))))
26509 (defun org-metadown (&optional arg)
26510 "Move subtree down or move table row down.
26511 Calls `org-move-subtree-down' or `org-table-move-row' or
26512 `org-move-item-down', depending on context. See the individual
26513 commands for more information."
26514 (interactive "P")
26515 (cond
26516 ((org-at-table-p) (call-interactively 'org-table-move-row))
26517 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26518 ((org-at-item-p) (call-interactively 'org-move-item-down))
26519 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26521 (defun org-shiftup (&optional arg)
26522 "Increase item in timestamp or increase priority of current headline.
26523 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26524 depending on context. See the individual commands for more information."
26525 (interactive "P")
26526 (cond
26527 ((org-at-timestamp-p t)
26528 (call-interactively (if org-edit-timestamp-down-means-later
26529 'org-timestamp-down 'org-timestamp-up)))
26530 ((org-on-heading-p) (call-interactively 'org-priority-up))
26531 ((org-at-item-p) (call-interactively 'org-previous-item))
26532 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26534 (defun org-shiftdown (&optional arg)
26535 "Decrease item in timestamp or decrease priority of current headline.
26536 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26537 depending on context. See the individual commands for more information."
26538 (interactive "P")
26539 (cond
26540 ((org-at-timestamp-p t)
26541 (call-interactively (if org-edit-timestamp-down-means-later
26542 'org-timestamp-up 'org-timestamp-down)))
26543 ((org-on-heading-p) (call-interactively 'org-priority-down))
26544 (t (call-interactively 'org-next-item))))
26546 (defun org-shiftright ()
26547 "Next TODO keyword or timestamp one day later, depending on context."
26548 (interactive)
26549 (cond
26550 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26551 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26552 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26553 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26554 (t (org-shiftcursor-error))))
26556 (defun org-shiftleft ()
26557 "Previous TODO keyword or timestamp one day earlier, depending on context."
26558 (interactive)
26559 (cond
26560 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26561 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26562 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26563 ((org-at-property-p)
26564 (call-interactively 'org-property-previous-allowed-value))
26565 (t (org-shiftcursor-error))))
26567 (defun org-shiftcontrolright ()
26568 "Switch to next TODO set."
26569 (interactive)
26570 (cond
26571 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26572 (t (org-shiftcursor-error))))
26574 (defun org-shiftcontrolleft ()
26575 "Switch to previous TODO set."
26576 (interactive)
26577 (cond
26578 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26579 (t (org-shiftcursor-error))))
26581 (defun org-ctrl-c-ret ()
26582 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26583 (interactive)
26584 (cond
26585 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26586 (t (call-interactively 'org-insert-heading))))
26588 (defun org-copy-special ()
26589 "Copy region in table or copy current subtree.
26590 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26591 See the individual commands for more information."
26592 (interactive)
26593 (call-interactively
26594 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26596 (defun org-cut-special ()
26597 "Cut region in table or cut current subtree.
26598 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26599 See the individual commands for more information."
26600 (interactive)
26601 (call-interactively
26602 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26604 (defun org-paste-special (arg)
26605 "Paste rectangular region into table, or past subtree relative to level.
26606 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26607 See the individual commands for more information."
26608 (interactive "P")
26609 (if (org-at-table-p)
26610 (org-table-paste-rectangle)
26611 (org-paste-subtree arg)))
26613 (defun org-ctrl-c-ctrl-c (&optional arg)
26614 "Set tags in headline, or update according to changed information at point.
26616 This command does many different things, depending on context:
26618 - If the cursor is in a headline, prompt for tags and insert them
26619 into the current line, aligned to `org-tags-column'. When called
26620 with prefix arg, realign all tags in the current buffer.
26622 - If the cursor is in one of the special #+KEYWORD lines, this
26623 triggers scanning the buffer for these lines and updating the
26624 information.
26626 - If the cursor is inside a table, realign the table. This command
26627 works even if the automatic table editor has been turned off.
26629 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26630 the entire table.
26632 - If the cursor is a the beginning of a dynamic block, update it.
26634 - If the cursor is inside a table created by the table.el package,
26635 activate that table.
26637 - If the current buffer is a remember buffer, close note and file it.
26638 with a prefix argument, file it without further interaction to the default
26639 location.
26641 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26642 links in this buffer.
26644 - If the cursor is on a numbered item in a plain list, renumber the
26645 ordered list.
26647 - If the cursor is on a checkbox, toggle it."
26648 (interactive "P")
26649 (let ((org-enable-table-editor t))
26650 (cond
26651 ((or org-clock-overlays
26652 org-occur-highlights
26653 org-latex-fragment-image-overlays)
26654 (org-remove-clock-overlays)
26655 (org-remove-occur-highlights)
26656 (org-remove-latex-fragment-image-overlays)
26657 (message "Temporary highlights/overlays removed from current buffer"))
26658 ((and (local-variable-p 'org-finish-function (current-buffer))
26659 (fboundp org-finish-function))
26660 (funcall org-finish-function))
26661 ((org-at-property-p)
26662 (call-interactively 'org-property-action))
26663 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
26664 ((org-on-heading-p) (call-interactively 'org-set-tags))
26665 ((org-at-table.el-p)
26666 (require 'table)
26667 (beginning-of-line 1)
26668 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
26669 (call-interactively 'table-recognize-table))
26670 ((org-at-table-p)
26671 (org-table-maybe-eval-formula)
26672 (if arg
26673 (call-interactively 'org-table-recalculate)
26674 (org-table-maybe-recalculate-line))
26675 (call-interactively 'org-table-align))
26676 ((org-at-item-checkbox-p)
26677 (call-interactively 'org-toggle-checkbox))
26678 ((org-at-item-p)
26679 (call-interactively 'org-maybe-renumber-ordered-list))
26681 ;; Dynamic block
26682 (beginning-of-line 1)
26683 (org-update-dblock))
26685 (cond
26686 ((equal (match-string 1) "TBLFM")
26687 ;; Recalculate the table before this line
26688 (save-excursion
26689 (beginning-of-line 1)
26691 (if (org-at-table-p)
26692 (org-call-with-arg 'org-table-recalculate t))))
26693 (t
26694 (call-interactively 'org-mode-restart))))
26695 (t (error "C-c C-c can do nothing useful at this location.")))))
26697 (defun org-mode-restart ()
26698 "Restart Org-mode, to scan again for special lines.
26699 Also updates the keyword regular expressions."
26700 (interactive)
26701 (let ((org-inhibit-startup t)) (org-mode))
26702 (message "Org-mode restarted to refresh keyword and special line setup"))
26704 (defun org-kill-note-or-show-branches ()
26705 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
26706 (interactive)
26707 (if (not org-finish-function)
26708 (call-interactively 'show-branches)
26709 (let ((org-note-abort t))
26710 (funcall org-finish-function))))
26712 (defun org-return (&optional indent)
26713 "Goto next table row or insert a newline.
26714 Calls `org-table-next-row' or `newline', depending on context.
26715 See the individual commands for more information."
26716 (interactive)
26717 (cond
26718 ((bobp) (if indent (newline-and-indent) (newline)))
26719 ((org-at-table-p)
26720 (org-table-justify-field-maybe)
26721 (call-interactively 'org-table-next-row))
26722 (t (if indent (newline-and-indent) (newline)))))
26724 (defun org-return-indent ()
26725 (interactive)
26726 "Goto next table row or insert a newline and indent.
26727 Calls `org-table-next-row' or `newline-and-indent', depending on
26728 context. See the individual commands for more information."
26729 (org-return t))
26731 (defun org-ctrl-c-minus ()
26732 "Insert separator line in table or modify bullet type in list.
26733 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
26734 depending on context."
26735 (interactive)
26736 (cond
26737 ((org-at-table-p)
26738 (call-interactively 'org-table-insert-hline))
26739 ((org-on-heading-p)
26740 ;; Convert to item
26741 (save-excursion
26742 (beginning-of-line 1)
26744 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
26745 ((org-in-item-p)
26746 (call-interactively 'org-cycle-list-bullet))
26747 (t (error "`C-c -' does have no function here."))))
26749 (defun org-meta-return (&optional arg)
26750 "Insert a new heading or wrap a region in a table.
26751 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
26752 See the individual commands for more information."
26753 (interactive "P")
26754 (cond
26755 ((org-at-table-p)
26756 (call-interactively 'org-table-wrap-region))
26757 (t (call-interactively 'org-insert-heading))))
26759 ;;; Menu entries
26761 ;; Define the Org-mode menus
26762 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
26763 '("Tbl"
26764 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
26765 ["Next Field" org-cycle (org-at-table-p)]
26766 ["Previous Field" org-shifttab (org-at-table-p)]
26767 ["Next Row" org-return (org-at-table-p)]
26768 "--"
26769 ["Blank Field" org-table-blank-field (org-at-table-p)]
26770 ["Edit Field" org-table-edit-field (org-at-table-p)]
26771 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
26772 "--"
26773 ("Column"
26774 ["Move Column Left" org-metaleft (org-at-table-p)]
26775 ["Move Column Right" org-metaright (org-at-table-p)]
26776 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
26777 ["Insert Column" org-shiftmetaright (org-at-table-p)])
26778 ("Row"
26779 ["Move Row Up" org-metaup (org-at-table-p)]
26780 ["Move Row Down" org-metadown (org-at-table-p)]
26781 ["Delete Row" org-shiftmetaup (org-at-table-p)]
26782 ["Insert Row" org-shiftmetadown (org-at-table-p)]
26783 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
26784 "--"
26785 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
26786 ("Rectangle"
26787 ["Copy Rectangle" org-copy-special (org-at-table-p)]
26788 ["Cut Rectangle" org-cut-special (org-at-table-p)]
26789 ["Paste Rectangle" org-paste-special (org-at-table-p)]
26790 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
26791 "--"
26792 ("Calculate"
26793 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
26794 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
26795 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
26796 "--"
26797 ["Recalculate line" org-table-recalculate (org-at-table-p)]
26798 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
26799 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
26800 "--"
26801 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
26802 "--"
26803 ["Sum Column/Rectangle" org-table-sum
26804 (or (org-at-table-p) (org-region-active-p))]
26805 ["Which Column?" org-table-current-column (org-at-table-p)])
26806 ["Debug Formulas"
26807 org-table-toggle-formula-debugger
26808 :style toggle :selected org-table-formula-debug]
26809 ["Show Col/Row Numbers"
26810 org-table-toggle-coordinate-overlays
26811 :style toggle :selected org-table-overlay-coordinates]
26812 "--"
26813 ["Create" org-table-create (and (not (org-at-table-p))
26814 org-enable-table-editor)]
26815 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
26816 ["Import from File" org-table-import (not (org-at-table-p))]
26817 ["Export to File" org-table-export (org-at-table-p)]
26818 "--"
26819 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
26821 (easy-menu-define org-org-menu org-mode-map "Org menu"
26822 '("Org"
26823 ("Show/Hide"
26824 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
26825 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
26826 ["Sparse Tree" org-occur t]
26827 ["Reveal Context" org-reveal t]
26828 ["Show All" show-all t]
26829 "--"
26830 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
26831 "--"
26832 ["New Heading" org-insert-heading t]
26833 ("Navigate Headings"
26834 ["Up" outline-up-heading t]
26835 ["Next" outline-next-visible-heading t]
26836 ["Previous" outline-previous-visible-heading t]
26837 ["Next Same Level" outline-forward-same-level t]
26838 ["Previous Same Level" outline-backward-same-level t]
26839 "--"
26840 ["Jump" org-goto t])
26841 ("Edit Structure"
26842 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
26843 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
26844 "--"
26845 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
26846 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
26847 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
26848 "--"
26849 ["Promote Heading" org-metaleft (not (org-at-table-p))]
26850 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
26851 ["Demote Heading" org-metaright (not (org-at-table-p))]
26852 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
26853 "--"
26854 ["Sort Region/Children" org-sort (not (org-at-table-p))]
26855 "--"
26856 ["Convert to odd levels" org-convert-to-odd-levels t]
26857 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
26858 ("Editing"
26859 ["Emphasis..." org-emphasize t])
26860 ("Archive"
26861 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
26862 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
26863 ; :active t :keys "C-u C-c C-x C-a"]
26864 ["Sparse trees open ARCHIVE trees"
26865 (setq org-sparse-tree-open-archived-trees
26866 (not org-sparse-tree-open-archived-trees))
26867 :style toggle :selected org-sparse-tree-open-archived-trees]
26868 ["Cycling opens ARCHIVE trees"
26869 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
26870 :style toggle :selected org-cycle-open-archived-trees]
26871 ["Agenda includes ARCHIVE trees"
26872 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
26873 :style toggle :selected (not org-agenda-skip-archived-trees)]
26874 "--"
26875 ["Move Subtree to Archive" org-advertized-archive-subtree t]
26876 ; ["Check and Move Children" (org-archive-subtree '(4))
26877 ; :active t :keys "C-u C-c C-x C-s"]
26878 )
26879 "--"
26880 ("TODO Lists"
26881 ["TODO/DONE/-" org-todo t]
26882 ("Select keyword"
26883 ["Next keyword" org-shiftright (org-on-heading-p)]
26884 ["Previous keyword" org-shiftleft (org-on-heading-p)]
26885 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
26886 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
26887 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
26888 ["Show TODO Tree" org-show-todo-tree t]
26889 ["Global TODO list" org-todo-list t]
26890 "--"
26891 ["Set Priority" org-priority t]
26892 ["Priority Up" org-shiftup t]
26893 ["Priority Down" org-shiftdown t])
26894 ("TAGS and Properties"
26895 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
26896 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
26897 "--"
26898 ["Set property" 'org-set-property t]
26899 ["Column view of properties" org-columns t]
26900 ["Insert Column View DBlock" org-insert-columns-dblock t])
26901 ("Dates and Scheduling"
26902 ["Timestamp" org-time-stamp t]
26903 ["Timestamp (inactive)" org-time-stamp-inactive t]
26904 ("Change Date"
26905 ["1 Day Later" org-shiftright t]
26906 ["1 Day Earlier" org-shiftleft t]
26907 ["1 ... Later" org-shiftup t]
26908 ["1 ... Earlier" org-shiftdown t])
26909 ["Compute Time Range" org-evaluate-time-range t]
26910 ["Schedule Item" org-schedule t]
26911 ["Deadline" org-deadline t]
26912 "--"
26913 ["Custom time format" org-toggle-time-stamp-overlays
26914 :style radio :selected org-display-custom-times]
26915 "--"
26916 ["Goto Calendar" org-goto-calendar t]
26917 ["Date from Calendar" org-date-from-calendar t])
26918 ("Logging work"
26919 ["Clock in" org-clock-in t]
26920 ["Clock out" org-clock-out t]
26921 ["Clock cancel" org-clock-cancel t]
26922 ["Goto running clock" org-clock-goto t]
26923 ["Display times" org-clock-display t]
26924 ["Create clock table" org-clock-report t]
26925 "--"
26926 ["Record DONE time"
26927 (progn (setq org-log-done (not org-log-done))
26928 (message "Switching to %s will %s record a timestamp"
26929 (car org-done-keywords)
26930 (if org-log-done "automatically" "not")))
26931 :style toggle :selected org-log-done])
26932 "--"
26933 ["Agenda Command..." org-agenda t]
26934 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
26935 ("File List for Agenda")
26936 ("Special views current file"
26937 ["TODO Tree" org-show-todo-tree t]
26938 ["Check Deadlines" org-check-deadlines t]
26939 ["Timeline" org-timeline t]
26940 ["Tags Tree" org-tags-sparse-tree t])
26941 "--"
26942 ("Hyperlinks"
26943 ["Store Link (Global)" org-store-link t]
26944 ["Insert Link" org-insert-link t]
26945 ["Follow Link" org-open-at-point t]
26946 "--"
26947 ["Next link" org-next-link t]
26948 ["Previous link" org-previous-link t]
26949 "--"
26950 ["Descriptive Links"
26951 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
26952 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
26953 ["Literal Links"
26954 (progn
26955 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
26956 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
26957 "--"
26958 ["Export/Publish..." org-export t]
26959 ("LaTeX"
26960 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
26961 :selected org-cdlatex-mode]
26962 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
26963 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
26964 ["Modify math symbol" org-cdlatex-math-modify
26965 (org-inside-LaTeX-fragment-p)]
26966 ["Export LaTeX fragments as images"
26967 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
26968 :style toggle :selected org-export-with-LaTeX-fragments])
26969 "--"
26970 ("Documentation"
26971 ["Show Version" org-version t]
26972 ["Info Documentation" org-info t])
26973 ("Customize"
26974 ["Browse Org Group" org-customize t]
26975 "--"
26976 ["Expand This Menu" org-create-customize-menu
26977 (fboundp 'customize-menu-create)])
26978 "--"
26979 ["Refresh setup" org-mode-restart t]
26980 ))
26982 (defun org-info (&optional node)
26983 "Read documentation for Org-mode in the info system.
26984 With optional NODE, go directly to that node."
26985 (interactive)
26986 (info (format "(org)%s" (or node ""))))
26988 (defun org-install-agenda-files-menu ()
26989 (let ((bl (buffer-list)))
26990 (save-excursion
26991 (while bl
26992 (set-buffer (pop bl))
26993 (if (org-mode-p) (setq bl nil)))
26994 (when (org-mode-p)
26995 (easy-menu-change
26996 '("Org") "File List for Agenda"
26997 (append
26998 (list
26999 ["Edit File List" (org-edit-agenda-file-list) t]
27000 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27001 ["Remove Current File from List" org-remove-file t]
27002 ["Cycle through agenda files" org-cycle-agenda-files t]
27003 ["Occur in all agenda files" org-occur-in-agenda-files t]
27004 "--")
27005 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27007 ;;;; Documentation
27009 (defun org-customize ()
27010 "Call the customize function with org as argument."
27011 (interactive)
27012 (customize-browse 'org))
27014 (defun org-create-customize-menu ()
27015 "Create a full customization menu for Org-mode, insert it into the menu."
27016 (interactive)
27017 (if (fboundp 'customize-menu-create)
27018 (progn
27019 (easy-menu-change
27020 '("Org") "Customize"
27021 `(["Browse Org group" org-customize t]
27022 "--"
27023 ,(customize-menu-create 'org)
27024 ["Set" Custom-set t]
27025 ["Save" Custom-save t]
27026 ["Reset to Current" Custom-reset-current t]
27027 ["Reset to Saved" Custom-reset-saved t]
27028 ["Reset to Standard Settings" Custom-reset-standard t]))
27030 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27032 ;;;; Miscellaneous stuff
27035 ;;; Generally useful functions
27037 (defun org-context ()
27038 "Return a list of contexts of the current cursor position.
27039 If several contexts apply, all are returned.
27040 Each context entry is a list with a symbol naming the context, and
27041 two positions indicating start and end of the context. Possible
27042 contexts are:
27044 :headline anywhere in a headline
27045 :headline-stars on the leading stars in a headline
27046 :todo-keyword on a TODO keyword (including DONE) in a headline
27047 :tags on the TAGS in a headline
27048 :priority on the priority cookie in a headline
27049 :item on the first line of a plain list item
27050 :item-bullet on the bullet/number of a plain list item
27051 :checkbox on the checkbox in a plain list item
27052 :table in an org-mode table
27053 :table-special on a special filed in a table
27054 :table-table in a table.el table
27055 :link on a hyperlink
27056 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27057 :target on a <<target>>
27058 :radio-target on a <<<radio-target>>>
27059 :latex-fragment on a LaTeX fragment
27060 :latex-preview on a LaTeX fragment with overlayed preview image
27062 This function expects the position to be visible because it uses font-lock
27063 faces as a help to recognize the following contexts: :table-special, :link,
27064 and :keyword."
27065 (let* ((f (get-text-property (point) 'face))
27066 (faces (if (listp f) f (list f)))
27067 (p (point)) clist o)
27068 ;; First the large context
27069 (cond
27070 ((org-on-heading-p t)
27071 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27072 (when (progn
27073 (beginning-of-line 1)
27074 (looking-at org-todo-line-tags-regexp))
27075 (push (org-point-in-group p 1 :headline-stars) clist)
27076 (push (org-point-in-group p 2 :todo-keyword) clist)
27077 (push (org-point-in-group p 4 :tags) clist))
27078 (goto-char p)
27081 (push (org-point-in-group p 0 :priority) clist)))
27083 ((org-at-item-p)
27084 (push (org-point-in-group p 2 :item-bullet) clist)
27085 (push (list :item (point-at-bol)
27086 (save-excursion (org-end-of-item) (point)))
27087 clist)
27088 (and (org-at-item-checkbox-p)
27089 (push (org-point-in-group p 0 :checkbox) clist)))
27091 ((org-at-table-p)
27092 (push (list :table (org-table-begin) (org-table-end)) clist)
27093 (if (memq 'org-formula faces)
27094 (push (list :table-special
27095 (previous-single-property-change p 'face)
27096 (next-single-property-change p 'face)) clist)))
27097 ((org-at-table-p 'any)
27098 (push (list :table-table) clist)))
27099 (goto-char p)
27101 ;; Now the small context
27102 (cond
27103 ((org-at-timestamp-p)
27104 (push (org-point-in-group p 0 :timestamp) clist))
27105 ((memq 'org-link faces)
27106 (push (list :link
27107 (previous-single-property-change p 'face)
27108 (next-single-property-change p 'face)) clist))
27109 ((memq 'org-special-keyword faces)
27110 (push (list :keyword
27111 (previous-single-property-change p 'face)
27112 (next-single-property-change p 'face)) clist))
27113 ((org-on-target-p)
27114 (push (org-point-in-group p 0 :target) clist)
27115 (goto-char (1- (match-beginning 0)))
27116 (if (looking-at org-radio-target-regexp)
27117 (push (org-point-in-group p 0 :radio-target) clist))
27118 (goto-char p))
27119 ((setq o (car (delq nil
27120 (mapcar
27121 (lambda (x)
27122 (if (memq x org-latex-fragment-image-overlays) x))
27123 (org-overlays-at (point))))))
27124 (push (list :latex-fragment
27125 (org-overlay-start o) (org-overlay-end o)) clist)
27126 (push (list :latex-preview
27127 (org-overlay-start o) (org-overlay-end o)) clist))
27128 ((org-inside-LaTeX-fragment-p)
27129 ;; FIXME: positions wrong.
27130 (push (list :latex-fragment (point) (point)) clist)))
27132 (setq clist (nreverse (delq nil clist)))
27133 clist))
27135 ;; FIXME: Compare with at-regexp-p Do we need both?
27136 (defun org-in-regexp (re &optional nlines visually)
27137 "Check if point is inside a match of regexp.
27138 Normally only the current line is checked, but you can include NLINES extra
27139 lines both before and after point into the search.
27140 If VISUALLY is set, require that the cursor is not after the match but
27141 really on, so that the block visually is on the match."
27142 (catch 'exit
27143 (let ((pos (point))
27144 (eol (point-at-eol (+ 1 (or nlines 0))))
27145 (inc (if visually 1 0)))
27146 (save-excursion
27147 (beginning-of-line (- 1 (or nlines 0)))
27148 (while (re-search-forward re eol t)
27149 (if (and (<= (match-beginning 0) pos)
27150 (>= (+ inc (match-end 0)) pos))
27151 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27153 (defun org-at-regexp-p (regexp)
27154 "Is point inside a match of REGEXP in the current line?"
27155 (catch 'exit
27156 (save-excursion
27157 (let ((pos (point)) (end (point-at-eol)))
27158 (beginning-of-line 1)
27159 (while (re-search-forward regexp end t)
27160 (if (and (<= (match-beginning 0) pos)
27161 (>= (match-end 0) pos))
27162 (throw 'exit t)))
27163 nil))))
27165 (defun org-occur-in-agenda-files (regexp &optional nlines)
27166 "Call `multi-occur' with buffers for all agenda files."
27168 (let* ((files (org-agenda-files))
27169 (tnames (mapcar 'file-truename files))
27170 (extra org-agenda-multi-occur-extra-files)
27171 f)
27172 (while (setq f (pop extra))
27173 (unless (member (file-truename f) tnames)
27174 (add-to-list 'files f 'append)
27175 (add-to-list 'tnames (file-truename f) 'append)))
27176 (multi-occur
27177 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27178 regexp)))
27180 (defun org-uniquify (list)
27181 "Remove duplicate elements from LIST."
27182 (let (res)
27183 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27184 res))
27186 (defun org-delete-all (elts list)
27187 "Remove all elements in ELTS from LIST."
27188 (while elts
27189 (setq list (delete (pop elts) list)))
27190 list)
27192 (defun org-back-over-empty-lines ()
27193 "Move backwards over witespace, to the beginning of the first empty line.
27194 Returns the number o empty lines passed."
27195 (let ((pos (point)))
27197 (beginning-of-line 2)
27198 (goto-char (min (point) pos))
27199 (count-lines (point) pos)))
27201 (defun org-skip-whitespace ()
27204 (defun org-point-in-group (point group &optional context)
27205 "Check if POINT is in match-group GROUP.
27206 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27207 match. If the match group does ot exist or point is not inside it,
27208 return nil."
27209 (and (match-beginning group)
27210 (>= point (match-beginning group))
27211 (<= point (match-end group))
27212 (if context
27213 (list context (match-beginning group) (match-end group))
27214 t)))
27216 (defun org-switch-to-buffer-other-window (&rest args)
27217 "Switch to buffer in a second window on the current frame.
27218 In particular, do not allow pop-up frames."
27219 (let (pop-up-frames special-display-buffer-names special-display-regexps
27220 special-display-function)
27221 (apply 'switch-to-buffer-other-window args)))
27223 (defun org-combine-plists (&rest plists)
27224 "Create a single property list from all plists in PLISTS.
27225 The process starts by copying the first list, and then setting properties
27226 from the other lists. Settings in the last list are the most significant
27227 ones and overrule settings in the other lists."
27228 (let ((rtn (copy-sequence (pop plists)))
27229 p v ls)
27230 (while plists
27231 (setq ls (pop plists))
27232 (while ls
27233 (setq p (pop ls) v (pop ls))
27234 (setq rtn (plist-put rtn p v))))
27235 rtn))
27237 (defun org-move-line-down (arg)
27238 "Move the current line down. With prefix argument, move it past ARG lines."
27239 (interactive "p")
27240 (let ((col (current-column))
27241 beg end pos)
27242 (beginning-of-line 1) (setq beg (point))
27243 (beginning-of-line 2) (setq end (point))
27244 (beginning-of-line (+ 1 arg))
27245 (setq pos (move-marker (make-marker) (point)))
27246 (insert (delete-and-extract-region beg end))
27247 (goto-char pos)
27248 (move-to-column col)))
27250 (defun org-move-line-up (arg)
27251 "Move the current line up. With prefix argument, move it past ARG lines."
27252 (interactive "p")
27253 (let ((col (current-column))
27254 beg end pos)
27255 (beginning-of-line 1) (setq beg (point))
27256 (beginning-of-line 2) (setq end (point))
27257 (beginning-of-line (- arg))
27258 (setq pos (move-marker (make-marker) (point)))
27259 (insert (delete-and-extract-region beg end))
27260 (goto-char pos)
27261 (move-to-column col)))
27263 (defun org-replace-escapes (string table)
27264 "Replace %-escapes in STRING with values in TABLE.
27266 The sequences in STRING may contain normal field width and padding information,
27268 so values can contain further %-escapes if they are define later in TABLE."
27269 (let ((case-fold-search nil)
27270 e re rpl)
27271 (while (setq e (pop table))
27272 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27273 (while (string-match re string)
27274 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27275 (cdr e)))
27276 (setq string (replace-match rpl t t string))))
27277 string))
27280 (defun org-sublist (list start end)
27281 "Return a section of LIST, from START to END.
27282 Counting starts at 1."
27283 (let (rtn (c start))
27284 (setq list (nthcdr (1- start) list))
27285 (while (and list (<= c end))
27286 (push (pop list) rtn)
27287 (setq c (1+ c)))
27288 (nreverse rtn)))
27290 (defun org-find-base-buffer-visiting (file)
27291 "Like `find-buffer-visiting' but alway return the base buffer and
27292 not an indirect buffer"
27293 (let ((buf (find-buffer-visiting file)))
27294 (if buf
27295 (or (buffer-base-buffer buf) buf)
27296 nil)))
27298 (defun org-image-file-name-regexp ()
27299 "Return regexp matching the file names of images."
27300 (if (fboundp 'image-file-name-regexp)
27301 (image-file-name-regexp)
27302 (let ((image-file-name-extensions
27303 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27304 "xbm" "xpm" "pbm" "pgm" "ppm")))
27306 (regexp-opt (nconc (mapcar 'upcase
27307 image-file-name-extensions)
27308 image-file-name-extensions)
27309 t)
27312 (defun org-file-image-p (file)
27313 "Return non-nil if FILE is an image."
27314 (save-match-data
27315 (string-match (org-image-file-name-regexp) file)))
27317 ;;; Paragraph filling stuff.
27318 ;; We want this to be just right, so use the full arsenal.
27320 (defun org-indent-line-function ()
27321 "Indent line like previous, but further if previous was headline or item."
27322 (interactive)
27323 (let* ((pos (point))
27324 (itemp (org-at-item-p))
27325 column bpos bcol tpos tcol bullet btype bullet-type)
27326 ;; Find the previous relevant line
27327 (beginning-of-line 1)
27328 (cond
27329 ((looking-at "#") (setq column 0))
27331 (t
27332 (beginning-of-line 0)
27334 (beginning-of-line 0))
27335 (cond
27337 (goto-char (match-end 0))
27338 (setq column (current-column)))
27339 ((org-in-item-p)
27340 (org-beginning-of-item)
27343 (setq bpos (match-beginning 1) tpos (match-end 0)
27344 bcol (progn (goto-char bpos) (current-column))
27345 tcol (progn (goto-char tpos) (current-column))
27346 bullet (match-string 1)
27347 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27348 (if (not itemp)
27349 (setq column tcol)
27350 (goto-char pos)
27351 (beginning-of-line 1)
27353 (progn
27355 (setq bullet (match-string 1)
27356 btype (if (string-match "[0-9]" bullet) "n" bullet))
27357 (setq column (if (equal btype bullet-type) bcol tcol)))
27358 (setq column (org-get-indentation)))))
27359 (t (setq column (org-get-indentation))))))
27360 (goto-char pos)
27361 (if (<= (current-column) (current-indentation))
27362 (indent-line-to column)
27363 (save-excursion (indent-line-to column)))
27364 (setq column (current-column))
27365 (beginning-of-line 1)
27366 (if (looking-at
27369 (match-string 2) (match-string 3)))
27370 t nil))
27371 (move-to-column column)))
27373 (defun org-set-autofill-regexps ()
27374 (interactive)
27375 ;; In the paragraph separator we include headlines, because filling
27376 ;; text in a line directly attached to a headline would otherwise
27377 ;; fill the headline as well.
27380 ;; The paragraph starter includes hand-formatted lists.
27381 (org-set-local 'paragraph-start
27383 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27384 ;; But only if the user has not turned off tables or fixed-width regions
27385 (org-set-local
27386 'auto-fill-inhibit-regexp
27389 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27390 (concat
27392 (if org-enable-table-editor "|" "")
27393 (if org-enable-fixed-width-editor ":" "")
27394 "]"))))
27395 ;; We use our own fill-paragraph function, to make sure that tables
27396 ;; and fixed-width regions are not wrapped. That function will pass
27397 ;; through to `fill-paragraph' when appropriate.
27398 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27399 ; Adaptive filling: To get full control, first make sure that
27400 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27402 (org-set-local 'adaptive-fill-function
27403 'org-adaptive-fill-function))
27405 (defun org-fill-paragraph (&optional justify)
27406 "Re-align a table, pass through to fill-paragraph if no table."
27407 (let ((table-p (org-at-table-p))
27408 (table.el-p (org-at-table.el-p)))
27409 (cond ((and (equal (char-after (point-at-bol)) ?*)
27410 (save-excursion (goto-char (point-at-bol))
27411 (looking-at outline-regexp)))
27412 t) ; skip headlines
27413 (table.el-p t) ; skip table.el tables
27414 (table-p (org-table-align) t) ; align org-mode tables
27415 (t nil)))) ; call paragraph-fill
27417 ;; For reference, this is the default value of adaptive-fill-regexp
27420 (defun org-adaptive-fill-function ()
27421 "Return a fill prefix for org-mode files.
27422 In particular, this makes sure hanging paragraphs for hand-formatted lists
27423 work correctly."
27425 (match-string 0))
27427 (save-excursion
27428 (goto-char (match-end 0))
27429 (make-string (current-column) ?\ )))
27430 (t nil)))
27432 ;;;; Functions extending outline functionality
27434 (defun org-beginning-of-line (&optional arg)
27435 "Go to the beginning of the current line. If that is invisible, continue
27436 to a visible line beginning. This makes the function of C-a more intuitive.
27437 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27438 first attempt, and only move to after the tags when the cursor is already
27439 beyond the end of the headline."
27440 (interactive "P")
27441 (let ((pos (point)))
27442 (beginning-of-line 1)
27443 (if (bobp)
27444 nil
27445 (backward-char 1)
27446 (if (org-invisible-p)
27447 (while (and (not (bobp)) (org-invisible-p))
27448 (backward-char 1)
27449 (beginning-of-line 1))
27450 (forward-char 1)))
27451 (when org-special-ctrl-a/e
27452 (cond
27453 ((and (looking-at org-todo-line-regexp)
27454 (= (char-after (match-end 1)) ?\ ))
27455 (goto-char
27456 (if (eq org-special-ctrl-a/e t)
27457 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27458 ((= pos (point)) (match-beginning 3))
27459 (t (point)))
27460 (cond ((> pos (point)) (point))
27461 ((not (eq last-command this-command)) (point))
27462 (t (match-beginning 3))))))
27463 ((org-at-item-p)
27464 (goto-char
27465 (if (eq org-special-ctrl-a/e t)
27466 (cond ((> pos (match-end 4)) (match-end 4))
27467 ((= pos (point)) (match-end 4))
27468 (t (point)))
27469 (cond ((> pos (point)) (point))
27470 ((not (eq last-command this-command)) (point))
27471 (t (match-end 4))))))))))
27473 (defun org-end-of-line (&optional arg)
27474 "Go to the end of the line.
27475 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27476 first attempt, and only move to after the tags when the cursor is already
27477 beyond the end of the headline."
27478 (interactive "P")
27479 (if (or (not org-special-ctrl-a/e)
27480 (not (org-on-heading-p)))
27481 (end-of-line arg)
27482 (let ((pos (point)))
27483 (beginning-of-line 1)
27485 (if (eq org-special-ctrl-a/e t)
27486 (if (or (< pos (match-beginning 1))
27487 (= pos (match-end 0)))
27488 (goto-char (match-beginning 1))
27489 (goto-char (match-end 0)))
27490 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27491 (goto-char (match-end 0))
27492 (goto-char (match-beginning 1))))
27493 (end-of-line arg)))))
27495 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27496 (define-key org-mode-map "\C-e" 'org-end-of-line)
27498 (defun org-invisible-p ()
27499 "Check if point is at a character currently not visible."
27500 ;; Early versions of noutline don't have `outline-invisible-p'.
27501 (if (fboundp 'outline-invisible-p)
27502 (outline-invisible-p)
27503 (get-char-property (point) 'invisible)))
27505 (defun org-invisible-p2 ()
27506 "Check if point is at a character currently not visible."
27507 (save-excursion
27508 (if (and (eolp) (not (bobp))) (backward-char 1))
27509 ;; Early versions of noutline don't have `outline-invisible-p'.
27510 (if (fboundp 'outline-invisible-p)
27511 (outline-invisible-p)
27512 (get-char-property (point) 'invisible))))
27514 (defalias 'org-back-to-heading 'outline-back-to-heading)
27515 (defalias 'org-on-heading-p 'outline-on-heading-p)
27516 (defalias 'org-at-heading-p 'outline-on-heading-p)
27517 (defun org-at-heading-or-item-p ()
27518 (or (org-on-heading-p) (org-at-item-p)))
27520 (defun org-on-target-p ()
27521 (or (org-in-regexp org-radio-target-regexp)
27522 (org-in-regexp org-target-regexp)))
27524 (defun org-up-heading-all (arg)
27525 "Move to the heading line of which the present line is a subheading.
27526 This function considers both visible and invisible heading lines.
27527 With argument, move up ARG levels."
27528 (if (fboundp 'outline-up-heading-all)
27529 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27530 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27532 (defun org-up-heading-safe ()
27533 "Move to the heading line of which the present line is a subheading.
27534 This version will not throw an error. It will return the level of the
27535 headline found, or nil if no higher level is found."
27536 (let ((pos (point)) start-level level
27537 (re (concat "^" outline-regexp)))
27538 (catch 'exit
27539 (outline-back-to-heading t)
27540 (setq start-level (funcall outline-level))
27541 (if (equal start-level 1) (throw 'exit nil))
27542 (while (re-search-backward re nil t)
27543 (setq level (funcall outline-level))
27544 (if (< level start-level) (throw 'exit level)))
27545 nil)))
27547 (defun org-first-sibling-p ()
27548 "Is this heading the first child of its parents?"
27549 (interactive)
27550 (let ((re (concat "^" outline-regexp))
27551 level l)
27552 (unless (org-at-heading-p t)
27553 (error "Not at a heading"))
27554 (setq level (funcall outline-level))
27555 (save-excursion
27556 (if (not (re-search-backward re nil t))
27557 t
27558 (setq l (funcall outline-level))
27559 (< l level)))))
27561 (defun org-goto-sibling (&optional previous)
27562 "Goto the next sibling, even if it is invisible.
27563 When PREVIOUS is set, go to the previous sibling instead. Returns t
27564 when a sibling was found. When none is found, return nil and don't
27565 move point."
27566 (let ((fun (if previous 're-search-backward 're-search-forward))
27567 (pos (point))
27568 (re (concat "^" outline-regexp))
27569 level l)
27570 (when (condition-case nil (org-back-to-heading t) (error nil))
27571 (setq level (funcall outline-level))
27572 (catch 'exit
27573 (or previous (forward-char 1))
27574 (while (funcall fun re nil t)
27575 (setq l (funcall outline-level))
27576 (when (< l level) (goto-char pos) (throw 'exit nil))
27577 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27578 (goto-char pos)
27579 nil))))
27581 (defun org-show-siblings ()
27582 "Show all siblings of the current headline."
27583 (save-excursion
27584 (while (org-goto-sibling) (org-flag-heading nil)))
27585 (save-excursion
27586 (while (org-goto-sibling 'previous)
27587 (org-flag-heading nil))))
27589 (defun org-show-hidden-entry ()
27590 "Show an entry where even the heading is hidden."
27591 (save-excursion
27592 (org-show-entry)))
27594 (defun org-flag-heading (flag &optional entry)
27595 "Flag the current heading. FLAG non-nil means make invisible.
27596 When ENTRY is non-nil, show the entire entry."
27597 (save-excursion
27598 (org-back-to-heading t)
27599 ;; Check if we should show the entire entry
27600 (if entry
27601 (progn
27602 (org-show-entry)
27603 (save-excursion
27604 (and (outline-next-heading)
27605 (org-flag-heading nil))))
27606 (outline-flag-region (max (point-min) (1- (point)))
27607 (save-excursion (outline-end-of-heading) (point))
27608 flag))))
27610 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27611 ;; This is an exact copy of the original function, but it uses
27612 ;; `org-back-to-heading', to make it work also in invisible
27613 ;; trees. And is uses an invisible-OK argument.
27614 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
27615 (org-back-to-heading invisible-OK)
27616 (let ((first t)
27617 (level (funcall outline-level)))
27618 (while (and (not (eobp))
27619 (or first (> (funcall outline-level) level)))
27620 (setq first nil)
27621 (outline-next-heading))
27622 (unless to-heading
27624 (progn
27625 ;; Go to end of line before heading
27626 (forward-char -1)
27628 ;; leave blank line before heading
27629 (forward-char -1))))))
27630 (point))
27632 (defun org-show-subtree ()
27633 "Show everything after this heading at deeper levels."
27634 (outline-flag-region
27635 (point)
27636 (save-excursion
27637 (outline-end-of-subtree) (outline-next-heading) (point))
27638 nil))
27640 (defun org-show-entry ()
27641 "Show the body directly following this heading.
27642 Show the heading too, if it is currently invisible."
27643 (interactive)
27644 (save-excursion
27645 (condition-case nil
27646 (progn
27647 (org-back-to-heading t)
27648 (outline-flag-region
27649 (max (point-min) (1- (point)))
27650 (save-excursion
27651 (re-search-forward
27653 (or (match-beginning 1) (point-max)))
27654 nil))
27655 (error nil))))
27657 (defun org-make-options-regexp (kwds)
27658 "Make a regular expression for keyword lines."
27659 (concat
27660 "^"
27666 ;; Make isearch reveal the necessary context
27667 (defun org-isearch-end ()
27668 "Reveal context after isearch exits."
27669 (when isearch-success ; only if search was successful
27670 (if (featurep 'xemacs)
27671 ;; Under XEmacs, the hook is run in the correct place,
27672 ;; we directly show the context.
27673 (org-show-context 'isearch)
27674 ;; In Emacs the hook runs *before* restoring the overlays.
27675 ;; So we have to use a one-time post-command-hook to do this.
27676 ;; (Emacs 22 has a special variable, see function `org-mode')
27677 (unless (and (boundp 'isearch-mode-end-hook-quit)
27678 isearch-mode-end-hook-quit)
27679 ;; Only when the isearch was not quitted.
27680 (org-add-hook 'post-command-hook 'org-isearch-post-command
27681 'append 'local)))))
27683 (defun org-isearch-post-command ()
27684 "Remove self from hook, and show context."
27685 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
27686 (org-show-context 'isearch))
27689 ;;;; Integration with and fixes for other packages
27691 ;;; Imenu support
27693 (defvar org-imenu-markers nil
27694 "All markers currently used by Imenu.")
27695 (make-variable-buffer-local 'org-imenu-markers)
27697 (defun org-imenu-new-marker (&optional pos)
27698 "Return a new marker for use by Imenu, and remember the marker."
27699 (let ((m (make-marker)))
27700 (move-marker m (or pos (point)))
27701 (push m org-imenu-markers)
27702 m))
27704 (defun org-imenu-get-tree ()
27705 "Produce the index for Imenu."
27706 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
27707 (setq org-imenu-markers nil)
27708 (let* ((n org-imenu-depth)
27709 (re (concat "^" outline-regexp))
27710 (subs (make-vector (1+ n) nil))
27711 (last-level 0)
27712 m tree level head)
27713 (save-excursion
27714 (save-restriction
27715 (widen)
27716 (goto-char (point-max))
27717 (while (re-search-backward re nil t)
27718 (setq level (org-reduced-level (funcall outline-level)))
27719 (when (<= level n)
27720 (looking-at org-complex-heading-regexp)
27721 (setq head (org-match-string-no-properties 4)
27722 m (org-imenu-new-marker))
27723 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
27724 (if (>= level last-level)
27725 (push (cons head m) (aref subs level))
27726 (push (cons head (aref subs (1+ level))) (aref subs level))
27727 (loop for i from (1+ level) to n do (aset subs i nil)))
27728 (setq last-level level)))))
27729 (aref subs 1)))
27731 (eval-after-load "imenu"
27732 '(progn
27733 (add-hook 'imenu-after-jump-hook
27734 (lambda () (org-show-context 'org-goto)))))
27736 ;; Speedbar support
27738 (defun org-speedbar-set-agenda-restriction ()
27739 "Restrict future agenda commands to the location at point in speedbar.
27741 (interactive)
27742 (let (p m tp np dir txt w)
27743 (cond
27744 ((setq p (text-property-any (point-at-bol) (point-at-eol)
27745 'org-imenu t))
27746 (setq m (get-text-property p 'org-imenu-marker))
27747 (save-excursion
27748 (save-restriction
27749 (set-buffer (marker-buffer m))
27750 (goto-char m)
27751 (org-agenda-set-restriction-lock 'subtree))))
27752 ((setq p (text-property-any (point-at-bol) (point-at-eol)
27753 'speedbar-function 'speedbar-find-file))
27754 (setq tp (previous-single-property-change
27755 (1+ p) 'speedbar-function)
27756 np (next-single-property-change
27757 tp 'speedbar-function)
27758 dir (speedbar-line-directory)
27759 txt (buffer-substring-no-properties (or tp (point-min))
27760 (or np (point-max))))
27761 (save-excursion
27762 (save-restriction
27763 (set-buffer (find-file-noselect
27764 (let ((default-directory dir))
27765 (expand-file-name txt))))
27766 (unless (org-mode-p)
27767 (error "Cannot restrict to non-Org-mode file"))
27768 (org-agenda-set-restriction-lock 'file))))
27769 (t (error "Don't know how to restrict Org-mode's agenda")))
27770 (org-move-overlay org-speedbar-restriction-lock-overlay
27771 (point-at-bol) (point-at-eol))
27772 (setq current-prefix-arg nil)
27773 (org-agenda-maybe-redo)))
27775 (eval-after-load "speedbar"
27776 '(progn
27777 (speedbar-add-supported-extension ".org")
27778 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
27779 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
27780 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
27781 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27782 (add-hook 'speedbar-visiting-tag-hook
27783 (lambda () (org-show-context 'org-goto)))))
27786 ;;; Fixes and Hacks
27788 ;; Make flyspell not check words in links, to not mess up our keymap
27789 (defun org-mode-flyspell-verify ()
27790 "Don't let flyspell put overlays at active buttons."
27791 (not (get-text-property (point) 'keymap)))
27793 ;; Make `bookmark-jump' show the jump location if it was hidden.
27794 (eval-after-load "bookmark"
27795 '(if (boundp 'bookmark-after-jump-hook)
27796 ;; We can use the hook
27797 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
27798 ;; Hook not available, use advice
27799 (defadvice bookmark-jump (after org-make-visible activate)
27800 "Make the position visible."
27801 (org-bookmark-jump-unhide))))
27803 (defun org-bookmark-jump-unhide ()
27804 "Unhide the current position, to show the bookmark location."
27805 (and (org-mode-p)
27806 (or (org-invisible-p)
27807 (save-excursion (goto-char (max (point-min) (1- (point))))
27808 (org-invisible-p)))
27809 (org-show-context 'bookmark-jump)))
27811 ;; Fix a bug in htmlize where there are text properties (face nil)
27812 (eval-after-load "htmlize"
27813 '(progn
27814 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
27815 "Make sure there are no nil faces"
27816 (setq ad-return-value (delq nil ad-return-value)))))
27818 ;; Make session.el ignore our circular variable
27819 (eval-after-load "session"
27820 '(add-to-list 'session-globals-exclude 'org-mark-ring))
27822 ;;;; Experimental code
27824 (defun org-closed-in-range ()
27825 "Sparse tree of items closed in a certain time range.
27826 Still experimental, may disappear in the future."
27827 (interactive)
27828 ;; Get the time interval from the user.
27829 (let* ((time1 (time-to-seconds
27830 (org-read-date nil 'to-time nil "Starting date: ")))
27831 (time2 (time-to-seconds
27832 (org-read-date nil 'to-time nil "End date:")))
27833 ;; callback function
27834 (callback (lambda ()
27835 (let ((time
27836 (time-to-seconds
27837 (apply 'encode-time
27838 (org-parse-time-string
27839 (match-string 1))))))
27840 ;; check if time in interval
27841 (and (>= time time1) (<= time time2))))))
27842 ;; make tree, check each match with the callback
27845 ;;;; Finish up
27847 (provide 'org)
27849 (run-hooks 'org-load-hook)
27851 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
27852 ;;; org.el ends here