| blob | f63d4e73d28b3fa2a930180f4bab0e70dae66d31 |
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.23a++
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
91 "Show the org-mode version in the echo area.
92 With prefix arg HERE, insert it at point."
99 ;;; Compatibility constants
108 "Return the value of symbol VAR if it is bound, else nil."
112 "Execute body without changing `buffer-modified-p'."
117 "Replace posix classes in regular expression."
125 ss))
126 s))
138 partial-completion-mode)))
145 ;;; The custom variables
148 "Outline-based notes management and organizer."
155 "Hook that is run after org.el has been loaded."
164 "Load all extensions listed in `org-default-extensions'."
169 org-modules)
173 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
179 "Modules that should always be loaded together with org.el.
180 If the description starts with <A>, this means the extension
181 will be autoloaded when needed, preloading is not necessary.
182 If a description starts with <C>, the file is not part of emacs
183 and loading it will require that you have downloaded and properly installed
184 the org-mode distribution."
187 :type
199 ; (const :tag "A export-latex: LaTeX export" org-export-latex)
200 ; (const :tag "A publish: Publishing" org-publish)
208 (const :tag "C interactive-query: Interactive modification of tags query" org-interactive-query)
219 ;; FIXME: Needs a separate group...
222 Normal means, no org-mode-specific context."
227 "Options concerning startup of Org-mode."
232 "Non-nil means, entering Org-mode will switch to OVERVIEW.
233 This can also be configured on a per-file basis by adding one of
234 the following lines anywhere in the buffer:
236 #+STARTUP: fold
237 #+STARTUP: nofold
238 #+STARTUP: content"
246 "Non-nil means, entering Org-mode will set `truncate-lines'.
247 This is useful since some lines containing links can be very long and
248 uninteresting. Also tables look terrible when wrapped."
253 "Non-nil means, align all tables when visiting a file.
254 This is useful when the column width in tables is forced with <N> cookies
255 in table fields. Such tables will look correct only after the first re-align.
256 This can also be configured on a per-file basis by adding one of
257 the following lines anywhere in the buffer:
258 #+STARTUP: align
259 #+STARTUP: noalign"
264 "Non-nil means insert the first line setting Org-mode in empty files.
265 When the function `org-mode' is called interactively in an empty file, this
266 normally means that the file name does not automatically trigger Org-mode.
267 To ensure that the file will always be in Org-mode in the future, a
268 line enforcing Org-mode will be inserted into the buffer, if this option
269 has been set."
274 "Non-nil means use alternative key bindings for some keys.
275 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
276 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
277 If you want to use Org-mode together with one of these other modes,
278 or more generally if you would like to move some Org-mode commands to
279 other keys, set this variable and configure the keys with the variable
280 `org-disputed-keys'.
282 This option is only relevant at load-time of Org-mode, and must be set
283 *before* org.el is loaded. Changing it requires a restart of Emacs to
284 become effective."
298 "Keys for which Org-mode and other modes compete.
299 This is an alist, cars are the default keys, second element specifies
300 the alternative to use when `org-replace-disputed-keys' is t.
302 Keys can be specified in any syntax supported by `define-key'.
303 The value of this option takes effect only at Org-mode's startup,
304 therefore you'll have to restart Emacs to apply it after changing."
309 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
310 Or return the original if not disputed."
315 org-disputed-keys)))
317 key))
327 "Define a key, possibly translated, as returned by `org-key'."
331 "The ellipsis to use in the Org-mode outline.
332 When nil, just use the standard three dots. When a string, use that instead,
333 When a face, use the standart 3 dots, but with the specified face.
334 The change affects only Org-mode (which will then use its own display table).
335 Changing this requires executing `M-x org-mode' in a buffer to become
336 effective."
346 "Keywords in Org-mode."
351 "String to mark deadline entries.
352 A deadline is this string, followed by a time stamp. Should be a word,
353 terminated by a colon. You can insert a schedule keyword and
355 Changes become only effective after restarting Emacs."
360 "String to mark scheduled TODO entries.
361 A schedule is this string, followed by a time stamp. Should be a word,
362 terminated by a colon. You can insert a schedule keyword and
364 Changes become only effective after restarting Emacs."
369 "String used as the prefix for timestamps logging closing a TODO entry."
374 "String used as prefix for timestamps clocking work hours on an item."
379 "Entries starting with this keyword will never be exported.
380 An entry can be toggled between COMMENT and normal with
382 Changes become only effective after restarting Emacs."
387 "Entries starting with this keyword will be exported in fixed-width font.
388 Quoting applies only to the text in the entry following the headline, and does
389 not extend beyond the next headline, even if that is lower level.
390 An entry can be toggled between QUOTE and normal with
397 "Regular expression for specifying repeated events.
401 "Options concerning the general structure of Org-mode files."
406 "Options about how to make context of a location visible."
430 "Non-nil means, show full hierarchy when revealing a location.
431 Org-mode often shows locations in an org-mode file which might have
432 been invisible before. When this is set, the hierarchy of headings
433 above the exposed location is shown.
434 Turning this off for example for sparse trees makes them very compact.
435 Instead of t, this can also be an alist specifying this option for different
436 contexts. Valid contexts are
437 agenda when exposing an entry from the agenda
438 org-goto when using the command `org-goto' on key C-c C-j
439 occur-tree when using the command `org-occur' on key C-c /
440 tags-tree when constructing a sparse tree based on tags matches
441 link-search when exposing search matches associated with a link
442 mark-goto when exposing the jump goal of a mark
443 bookmark-jump when exposing a bookmark location
444 isearch when exiting from an incremental search
445 default default for all contexts not set explicitly"
450 "Non-nil means, show following heading when revealing a location.
451 Org-mode often shows locations in an org-mode file which might have
452 been invisible before. When this is set, the heading following the
453 match is shown.
454 Turning this off for example for sparse trees makes them very compact,
455 but makes it harder to edit the location of the match. In such a case,
457 Instead of t, this can also be an alist specifying this option for different
458 contexts. See `org-show-hierarchy-above' for valid contexts."
463 "Non-nil means, show all sibling heading when revealing a location.
464 Org-mode often shows locations in an org-mode file which might have
465 been invisible before. When this is set, the sibling of the current entry
466 heading are all made visible. If `org-show-hierarchy-above' is t,
467 the same happens on each level of the hierarchy above the current entry.
469 By default this is on for the isearch context, off for all other contexts.
470 Turning this off for example for sparse trees makes them very compact,
471 but makes it harder to edit the location of the match. In such a case,
473 Instead of t, this can also be an alist specifying this option for different
474 contexts. See `org-show-hierarchy-above' for valid contexts."
479 "Non-nil means, show the entry below a headline when revealing a location.
480 Org-mode often shows locations in an org-mode file which might have
481 been invisible before. When this is set, the text below the headline that is
482 exposed is also shown.
484 By default this is off for all contexts.
485 Instead of t, this can also be an alist specifying this option for different
486 contexts. See `org-show-hierarchy-above' for valid contexts."
491 "Options concerning visibility cycling in Org-mode."
496 "Names of drawers. Drawers are not opened by cycling on the headline above.
497 Drawers only open with a TAB on the drawer line itself. A drawer looks like
498 this:
499 :DRAWERNAME:
500 .....
501 :END:
503 the property API.
505 Drawers can be defined on the per-file basis with a line like:
507 #+DRAWERS: HIDDEN STATE PROPERTIES"
512 "Cycle globally if cursor is at beginning of buffer and not at a headline.
513 This makes it possible to do global cycling without having to use S-TAB or
514 C-u TAB. For this special case to work, the first line of the buffer
515 must not be a headline - it may be empty ot some other text. When used in
516 this way, `org-cycle-hook' is disables temporarily, to make sure the
517 cursor stays at the beginning of the buffer.
518 When this option is nil, don't do anything special at the beginning
519 of the buffer."
524 "Where should `org-cycle' emulate TAB.
525 nil Never
526 white Only in completely white lines
527 whitestart Only at the beginning of lines, before the first non-white char
528 t Everywhere except in headlines
529 exc-hl-bol Everywhere except at the start of a headline
530 If TAB is used in a place where it does not emulate TAB, the current subtree
531 visibility is cycled."
538 ))
541 "Number of empty lines needed to keep an empty line between collapsed trees.
542 If you leave an empty line between the end of a subtree and the following
543 headline, this empty line is hidden when the subtree is folded.
544 Org-mode will leave (exactly) one empty line visible if the number of
545 empty lines is equal or larger to the number given in this variable.
546 So the default 2 means, at least 2 empty lines after the end of a subtree
547 are needed to produce free space between a collapsed subtree and the
548 following headline.
550 Special case: when 0, never leave empty lines in collapsed view."
555 org-cycle-hide-drawers
556 org-cycle-show-empty-lines
557 org-optimize-window-after-visibility-change)
558 "Hook that is run after `org-cycle' has changed the buffer visibility.
559 The function(s) in this hook must accept a single argument which indicates
560 the new state that was set by the most recent `org-cycle' command. The
561 argument is a symbol. After a global state change, it can have the values
562 `overview', `content', or `all'. After a local state change, it can have
563 the values `folded', `children', or `subtree'."
568 "Options concerning structure editing in Org-mode."
573 "Non-nil means, skip even levels and only use odd levels for the outline.
574 This has the effect that two stars are being added/taken away in
575 promotion/demotion commands. It also influences how levels are
576 handled by the exporters.
577 Changing it requires restart of `font-lock-mode' to become effective
578 for fontification also in regions already fontified.
579 You may also set this on a per-file basis by adding one of the following
580 lines to the buffer:
582 #+STARTUP: odd
583 #+STARTUP: oddeven"
589 "Non-nil means, adapt indentation when promoting and demoting.
590 When this is set and the *entire* text in an entry is indented, the
591 indentation is increased by one space in a demotion command, and
592 decreased by one in a promotion command. If any line in the entry
593 body starts at column 0, indentation is not changed at all."
598 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
599 When t, `C-a' will bring back the cursor to the beginning of the
600 headline text, i.e. after the stars and after a possible TODO keyword.
601 In an item, this will be the position after the bullet.
602 When the cursor is already at that position, another `C-a' will bring
603 it to the beginning of the line.
604 `C-e' will jump to the end of the headline, ignoring the presence of tags
605 in the headline. A second `C-e' will then jump to the true end of the
606 line, after any tags.
607 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
608 and only a directly following, identical keypress will bring the cursor
609 to the special positions."
620 "Non-nil means `C-k' will behave specially in headlines.
621 When nil, `C-k' will call the default `kill-line' command.
622 When t, the following will happen while the cursor is in the headline:
624 - When the cursor is at the beginning of a headline, kill the entire
625 line and possible the folded subtree below the line.
626 - When in the middle of the headline text, kill the headline up to the tags.
627 - When after the headline text, kill the tags."
632 "Non-nil means, M-RET will split the line at the cursor position.
633 When nil, it will go to the end of the line before making a
634 new line.
635 You may also set this option in a different way for different
636 contexts. Valid contexts are:
638 headline when creating a new headline
639 item when creating a new item
640 table in a table field
641 default the value to be used for all contexts not explicitly
642 customized"
660 "Should `org-insert-heading' leave a blank line before new heading/item?
661 The value is an alist, with `heading' and `plain-list-item' as car,
662 and a boolean flag as cdr."
669 "Hook being run after inserting a new heading."
675 This currently only means, they are never auto-wrapped.
676 When nil, such lines will be treated like ordinary lines.
677 See also the QUOTE keyword."
682 "Non-nil means, typing characters in org-goto starts incremental search."
687 "Options concerning sparse trees in Org-mode."
692 "Non-nil means, highlight all matches that define a sparse tree.
693 The highlights will automatically disappear the next time the buffer is
694 changed by an edit command."
699 "Non-nil means, any change to the buffer will remove temporary highlights.
700 Such highlights are created by `org-occur' and `org-clock-display'.
701 When nil, `C-c C-c needs to be used to get rid of the highlights.
702 The highlights created by `org-preview-latex-fragment' always need
703 `C-c C-c' to be removed."
710 "Hook that is run after `org-occur' has constructed a sparse tree.
711 This can be used to recenter the window to show as much of the structure
712 as possible."
717 "Options concerning plain lists in Org-mode."
722 "Non-nil means, include plain lists into visibility cycling.
723 This means that during cycling, plain list items will *temporarily* be
724 interpreted as outline headlines with a level given by 1000+i where i is the
725 indentation of the bullet. In all other operations, plain list items are
726 not seen as headlines. For example, you cannot assign a TODO keyword to
727 such an item."
732 "The character that makes a line with leading number an ordered list item.
733 Valid values are ?. and ?\). To get both terminators, use t. While
734 ?. may look nicer, it creates the danger that a line with leading
735 number may be incorrectly interpreted as an item. ?\) therefore is
736 the safe choice."
743 "Non-nil means, automatically renumber ordered plain lists.
744 Renumbering happens when the sequence have been changed with
751 "Non-nil means, update checkbox statistics after insert and toggle.
752 When this is set, checkbox statistics is updated each time you either insert
759 "Options concerning archiving in Org-mode."
764 "The tag that marks a subtree as archived.
765 An archived subtree does not open during visibility cycling, and does
766 not contribute to the agenda listings.
767 After changing this, font-lock must be restarted in the relevant buffers to
768 get the proper fontification."
774 "Non-nil means, the agenda will skip any items located in archived trees.
775 An archived tree is a tree marked with the tag ARCHIVE."
781 "Non-nil means, `org-cycle' will open archived trees.
782 An archived tree is a tree marked with the tag ARCHIVE.
783 When nil, archived trees will stay folded. You can still open them with
784 normal outline commands like `show-all', but not with the cycling commands."
790 "Non-nil means sparse tree construction shows matches in archived trees.
791 When nil, matches in these trees are highlighted, but the trees are kept in
792 collapsed state."
798 "The location where subtrees should be archived.
799 This string consists of two parts, separated by a double-colon.
801 The first part is a file name - when omitted, archiving happens in the same
802 file. %s will be replaced by the current file name (without directory part).
803 Archiving to a different file is useful to keep archived entries from
804 contributing to the Org-mode Agenda.
806 The part after the double colon is a headline. The archived entries will be
807 filed under that headline. When omitted, the subtrees are simply filed away
808 at the end of the file, as top-level entries.
810 Here are a few examples:
812 If the current file is Projects.org, archive in file
813 Projects.org_archive, as top-level trees. This is the default.
816 Archive in the current file, under the top-level headline
820 Archive in file ~/org/archive.org (absolute path), as top-level trees.
823 Archive in file ./basement (relative path), as level 3 trees
826 You may set this option on a per-file basis by adding to the buffer a
827 line like
829 #+ARCHIVE: basement::** Finished Tasks"
834 "Non-nil means, mark entries as DONE when they are moved to the archive file.
835 This can be a string to set the keyword to use. When t, Org-mode will
836 use the first keyword in its list that means done."
844 "Non-nil means, add a time stamp to entries moved to an archive file.
845 This variable is obsolete and has no effect anymore, instead add ot remove
846 `time' from the variablle `org-archive-save-context-info'."
851 "Parts of context info that should be stored as properties when archiving.
852 When a subtree is moved to an archive file, it looses information given by
853 context, like inherited tags, the category, and possibly also the TODO
854 state (depending on the variable `org-archive-mark-done').
855 This variable can be a list of any of the following symbols:
857 time The time of archiving.
858 file The file where the entry originates.
859 itags The local tags, in the headline of the subtree.
860 ltags The tags the subtree inherits from further up the hierarchy.
861 todo The pre-archive TODO state.
862 category The category, taken from file name or #+CATEGORY lines.
863 olpath The outline path to the item. These are all headlines above
864 the current item, separated by /, like a file path.
866 For each symbol present in the list, a property will be created in
868 information."
881 "Options concerning imenu and speedbar in Org-mode."
886 "The maximum level for Imenu access to Org-mode headlines.
887 This also applied for speedbar access."
892 "Options concerning tables in Org-mode."
898 When nil, such lines will be treated like ordinary lines.
900 When equal to the symbol `optimized', the table editor will be optimized to
901 do the following:
902 - Automatic overwrite mode in front of whitespace in table fields.
903 This makes the structure of the table stay in tact as long as the edited
904 field does not exceed the column width.
905 - Minimize the number of realigns. Normally, the table is aligned each time
906 TAB or RET are pressed to move to another field. With optimization this
907 happens only if changes to a field might have changed the column width.
908 Optimization requires replacing the functions `self-insert-command',
909 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
910 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
911 very good at guessing when a re-align will be necessary, but you can always
914 If you would like to use the optimized version in Org-mode, but the
915 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
917 This variable can be used to turn on and off the table editor during a session,
918 but in order to toggle optimization, a restart is required.
920 See also the variable `org-table-auto-blank-field'."
928 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
929 In the optimized version, the table editor takes over all simple keys that
930 normally just insert a character. In tables, the characters are inserted
931 in a way to minimize disturbing the table structure (i.e. in overwrite mode
932 for empty fields). Outside tables, the correct binding of the keys is
933 restored.
935 The default for this option is t if the optimized version is also used in
936 Org-mode. See the variable `org-enable-table-editor' for details. Changing
937 this variable requires a restart of Emacs to become effective."
943 % END RECEIVE ORGTBL %n
945 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
946 | | |
949 @c END RECEIVE ORGTBL %n
950 @ignore
951 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
952 | | |
955 <!-- END RECEIVE ORGTBL %n -->
956 <!--
957 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
958 | | |
960 "Templates for radio tables in different major modes.
961 All occurrences of %n in a template will be replaced with the name of the
962 table, obtained by prompting the user."
969 "Settings for tables in Org-mode."
974 "The default size for newly created tables, Columns x Rows."
980 "Regular expression for recognizing numbers in table columns.
981 If a table column contains mostly numbers, it will be aligned to the
982 right. If not, it will be aligned to the left.
984 The default value of this option is a regular expression which allows
985 anything which looks remotely like a number as used in scientific
986 context. For example, all of the following will be considered a
987 number:
988 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
990 Other options offered by the customize interface are more restrictive."
1008 "Fraction of numbers in a column required to make the column align right.
1009 In a column all non-white fields are considered. If at least this
1010 fraction of fields is matched by `org-table-number-fraction',
1011 alignment to the right border applies."
1016 "Behavior of tables during editing in Org-mode."
1021 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
1023 removal/insertion."
1028 "Non-nil means, automatically blank table field when starting to type into it.
1029 This only happens when typing immediately after a field motion
1030 command (TAB, S-TAB or RET).
1031 Only relevant when `org-enable-table-editor' is equal to `optimized'."
1036 "Non-nil means, tab in the last column of a table with jump over a hline.
1037 If a horizontal separator line is following the current line,
1038 `org-table-next-field' can either create a new row before that line, or jump
1039 over the line. When this option is nil, a new line will be created before
1040 this line."
1045 "Non-nil means, TAB will automatically notice a table.el table.
1046 When it sees such a table, it moves point into it and - if necessary -
1047 calls `table-recognize-table'."
1052 "Options concerning tables in Org-mode."
1057 "Should org-mode work with table refrences like B3 instead of @3$2?
1058 Possible values are:
1059 nil never use them
1060 from accept as input, do not present for editing
1061 t: accept as input and present for editing"
1076 calc-angle-mode deg
1077 calc-prefer-frac nil
1078 calc-symbolic-mode nil
1080 calc-display-working-message t
1081 )
1082 "List with Calc mode settings for use in calc-eval for table formulas.
1083 The list must contain alternating symbols (Calc modes variables and values).
1084 Don't remove any of the default settings, just change the values. Org-mode
1085 relies on the variables to be present in the list."
1090 "Non-nil means, TAB and RET evaluate a formula in current table field.
1091 If the current field starts with an equal sign, it is assumed to be a formula
1092 which should be evaluated as described in the manual and in the documentation
1093 string of the command `org-table-eval-formula'. This feature requires the
1094 Emacs calc package.
1095 When this variable is nil, formula calculation is only available through
1101 "Non-nil means, interpret constants in formulas in tables.
1102 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1103 by the value given in `org-table-formula-constants', or by a value obtained
1104 from the `constants.el' package."
1109 "Alist with constant names and values, for use in table formulas.
1110 The car of each element is a name of a constant, without the `$' before it.
1111 The cdr is the value as a string. For example, if you'd like to use the
1112 speed of light in a formula, you would configure
1116 and then use it in an equation like `$1*$c'.
1118 Constants can also be defined on a per-file basis using a line like
1120 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1131 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1132 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1137 "Options concerning links in Org-mode."
1142 "Buffer-local version of `org-link-abbrev-alist', which see.
1147 "Alist of link abbreviations.
1148 The car of each element is a string, to be replaced at the start of a link.
1150 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1152 [[linkkey:tag][description]]
1154 If REPLACE is a string, the tag will simply be appended to create the link.
1157 REPLACE may also be a function that will be called with the tag as the
1158 only argument to create the link, which should be returned as a string.
1160 See the manual for examples."
1165 "Non-nil means, hide link part and only show description of bracket links.
1166 Bracket links are like [[link][descritpion]]. This variable sets the initial
1167 state in new org-mode buffers. The setting can then be toggled on a
1168 per-buffer basis from the Org->Hyperlinks menu."
1173 "How the path name in file links should be stored.
1174 Valid values are:
1176 relative Relative to the current directory, i.e. the directory of the file
1177 into which the link is being inserted.
1178 absolute Absolute path, if possible with ~ for home directory.
1179 noabbrev Absolute path, no abbreviation of home directory.
1180 adaptive Use relative path for files in the current directory and sub-
1181 directories of it. For other files, use an absolute path."
1190 "Types of links that should be activated in Org-mode files.
1191 This is a list of symbols, each leading to the activation of a certain link
1192 type. In principle, it does not hurt to turn on most link types - there may
1193 be a small gain when turning off unused link types. The types are:
1195 bracket The recommended [[link][description]] or [[link]] links with hiding.
1196 angular Links in angular brackes that may contain whitespace like
1197 <bbdb:Carsten Dominik>.
1198 plain Plain links in normal text, no whitespace, like http://google.com.
1199 radio Text that is matched by a radio target, see manual for details.
1200 tag Tag settings in a headline (link to tag search).
1201 date Time stamps (link to calendar).
1203 Changing this variable requires a restart of Emacs to become effective."
1213 "Options concerning storing links in Org-mode."
1218 "Format of the description part of a link to an email or usenet message.
1219 The following %-excapes will be replaced by corresponding information:
1227 %s subject
1228 %m message-id.
1230 You may use normal field width specification between the % and the letter.
1231 This is for example useful to limit the length of the subject.
1245 It should match if the message is from the user him/herself."
1250 "Non-nil means, file links from `org-store-link' contain context.
1251 A search string will be added to the file name with :: as separator and
1252 used to find the context when the link is activated by the command
1253 `org-open-at-point'.
1255 negates this setting for the duration of the command."
1260 "Non-nil means, keep link in list for entire session.
1262 The command `org-store-link' adds a link pointing to the current
1263 location to an internal list. These links accumulate during a session.
1264 The command `org-insert-link' can be used to insert links into any
1265 Org-mode file (offering completion for all stored links). When this
1267 will be removed from the list, to make completing the unused links
1268 more efficient."
1273 "Options concerning following links in Org-mode."
1278 "Hook that is run after a link has been followed."
1283 "Non-nil means, on links TAB will follow the link.
1284 Needs to be set before org.el is loaded."
1289 "Non-nil means, on links RET will follow the link.
1290 Needs to be set before org.el is loaded."
1296 "Non-nil means, mouse-1 on a link will follow the link.
1297 A longer mouse click will still set point. Does not work on XEmacs.
1298 Needs to be set before org.el is loaded."
1303 "Number of different positions to be recorded in the ring
1304 Changing this requires a restart of Emacs to work correctly."
1312 "Setup the frame configuration for following links.
1313 When following a link with Emacs, it may often be useful to display
1314 this link in another window or frame. This variable can be used to
1315 set this up for the different types of links.
1316 For VM, use any of
1317 `vm-visit-folder'
1318 `vm-visit-folder-other-frame'
1319 For Gnus, use any of
1320 `gnus'
1321 `gnus-other-frame'
1322 For FILE, use any of
1323 `find-file'
1324 `find-file-other-window'
1325 `find-file-other-frame'
1326 For the calendar, use the variable `calendar-setup'.
1327 For BBDB, it is currently only possible to display the matches in
1328 another window."
1347 "Non-nil means, use indirect buffer to display infile links.
1348 Activating internal links (from one location in a file to another location
1349 in the same file) normally just jumps to the location. When the link is
1350 activated with a C-u prefix (or with mouse-3), the link is displayed in
1351 another window. When this option is set, the other window actually displays
1352 an indirect buffer clone of the current buffer, to avoid any visibility
1353 changes to the current buffer."
1358 "Non-nil means, `org-open-file' will open non-existing files.
1359 When nil, an error will be generated."
1364 "Function and arguments to call for following mailto links.
1365 This is a list with the first element being a lisp function, and the
1366 remaining elements being arguments to the function. In string arguments,
1367 %a will be replaced by the address, and %s will be replaced by the subject
1368 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1377 "Non-nil means, ask for confirmation before executing shell links.
1378 Shell links can be dangerous: just think about a link
1380 [[shell:rm -rf ~/*][Google Search]]
1383 but really it would remove your entire home directory.
1384 Therefore we advise against setting this variable to nil.
1385 Just change it to `y-or-n-p' of you want to confirm with a
1394 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1395 Elisp links can be dangerous: just think about a link
1400 but really it would remove your entire home directory.
1401 Therefore we advise against setting this variable to nil.
1402 Just change it to `y-or-n-p' of you want to confirm with a
1413 "Default file applications on a UNIX or GNU/Linux system.
1425 "Default file applications on a MacOS X system.
1427 for some files for which the OS does not have a good default.
1435 'mswindows-shell-execute
1438 "Default file applications on a Windows NT system.
1443 '(
1450 )
1451 "External applications for opening `file:path' items in a document.
1452 Org-mode uses system defaults for different file types, but
1453 you can use this variable to set the application for a given file
1454 extension. The entries in this list are cons cells where the car identifies
1455 files and the cdr the corresponding command. Possible values for the
1456 file identifier are
1458 `directory' Matches a directory
1459 `remote' Matches a remote file, accessible through tramp or efs.
1460 Remote files most likely should be visited through Emacs
1461 because external applications cannot handle such paths.
1462 t Default for all remaining files
1464 Possible values for the command are:
1465 `emacs' The file will be visited by the current Emacs process.
1466 `default' Use the default application for this file type.
1467 string A command to be executed by a shell; %s will be replaced
1468 by the path to the file.
1469 sexp A Lisp form which will be evaluated. The file path will
1470 be available in the Lisp variable `file'.
1471 For more examples, see the system specific constants
1472 `org-file-apps-defaults-macosx'
1473 `org-file-apps-defaults-windowsnt'
1474 `org-file-apps-defaults-gnu'."
1489 "Options concerning interaction with remember.el."
1494 "Directory with org files.
1495 This directory will be used as default to prompt for org files.
1496 Used by the hooks for remember.el."
1501 "Default target for storing notes.
1502 Used by the hooks for remember.el. This can be a string, or nil to mean
1503 the value of `remember-data-file'.
1504 You can set this on a per-template basis with the variable
1505 `org-remember-templates'."
1509 file))
1512 "Non-nil means, `C-c C-c' stores remember note without further promts.
1513 In this case, you need `C-u C-c C-c' to get the prompts for
1514 note file and headline.
1515 When this variable is nil, `C-c C-c' give you the prompts, and
1516 `C-u C-c C-c' trigger the fasttrack."
1521 "The interface to be used for interactive filing of remember notes.
1522 This is only used when the interactive mode for selecting a filing
1523 location is used (see the variable `org-remember-store-without-prompt').
1524 Allowed vaues are:
1525 outline The interface shows an outline of the relevant file
1526 and the correct heading is found by moving through
1527 the outline or by searching with incremental search.
1528 outline-path-completion Headlines in the current buffer are offered via
1529 completion.
1530 refile Use the refile interface, and offer headlines,
1531 possibly from different buffers."
1539 "The default interface to be used for `org-goto'.
1540 Allowed vaues are:
1541 outline The interface shows an outline of the relevant file
1542 and the correct heading is found by moving through
1543 the outline or by searching with incremental search.
1544 outline-path-completion Headlines in the current buffer are offered via
1545 completion."
1552 "The headline that should be the default location in the notes file.
1553 When filing remember notes, the cursor will start at that position.
1554 You can set this on a per-template basis with the variable
1555 `org-remember-templates'."
1560 "Templates for the creation of remember buffers.
1561 When nil, just let remember make the buffer.
1562 When not nil, this is a list of 5-element lists. In each entry, the first
1563 element is the name of the template, which should be a single short word.
1564 The second element is a character, a unique key to select this template.
1565 The third element is the template. The fourth element is optional and can
1566 specify a destination file for remember items created with this template.
1567 The default file is given by `org-default-notes-file'. An optional fifth
1568 element can specify the headline in that file that should be offered
1569 first when the user is asked to file the entry. The default headline is
1570 given in the variable `org-remember-default-headline'.
1572 An optional sixth element specifies the contexts in which the user can
1573 select the template. This element can be either a list of major modes
1574 or a function. `org-remember' will first check whether the function
1575 returns `t' or if we are in any of the listed major modes, and select
1576 the template accordingly.
1578 The template specifies the structure of the remember buffer. It should have
1579 a first line starting with a star, to act as the org-mode headline.
1580 Furthermore, the following %-escapes will be replaced with content:
1582 %^{prompt} Prompt the user for a string and replace this sequence with it.
1583 A default value and a completion table ca be specified like this:
1584 %^{prompt|default|completion2|completion3|...}
1585 %t time stamp, date only
1586 %T time stamp with date and time
1587 %u, %U like the above, but inactive time stamps
1588 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1589 You may define a prompt like %^{Please specify birthday}t
1590 %n user name (taken from `user-full-name')
1591 %a annotation, normally the link created with org-store-link
1592 %i initial content, the region active. If %i is indented,
1593 the entire inserted text will be indented as well.
1594 %c content of the clipboard, or current kill ring head
1595 %^g prompt for tags, with completion on tags in target file
1596 %^G prompt for tags, with completion all tags in all agenda files
1597 %:keyword specific information for certain link types, see below
1598 %[pathname] insert the contents of the file given by `pathname'
1599 %(sexp) evaluate elisp `(sexp)' and replace with the result
1600 %! Store this note immediately after filling the template
1602 %? After completing the template, position cursor here.
1604 Apart from these general escapes, you can access information specific to the
1605 link type that is created. For example, calling `remember' in emails or gnus
1606 will record the author and the subject of the message, which you can access
1607 with %:author and %:subject, respectively. Here is a complete list of what
1608 is recorded for each link type.
1610 Link type | Available information
1611 -------------------+------------------------------------------------------
1612 bbdb | %:type %:name %:company
1613 vm, wl, mh, rmail | %:type %:subject %:message-id
1614 | %:from %:fromname %:fromaddress
1615 | %:to %:toname %:toaddress
1617 gnus | %:group, for messages also all email fields
1618 w3, w3m | %:type %:url
1619 info | %:type %:file %:node
1620 calendar | %:type %:date"
1649 "Non-nil means, store new notes at the beginning of a file or entry.
1650 When nil, new notes will be filed to the end of a file or entry.
1651 This can also be a list with cons cells of regular expressions that
1652 are matched against file names, and values."
1662 This is list of cons cells. Each cell contains:
1663 - a specification of the files to be considered, either a list of files,
1664 or a symbol whose function or value fields will be used to retrieve
1665 a file name or a list of file names. Nil means, refile to a different
1666 heading in the current buffer.
1667 - A specification of how to find candidate refile targets. This may be
1668 any of
1670 This tag has to be present in all target headlines, inheritance will
1671 not be considered.
1673 todo keyword.
1675 headlines that are refiling targets.
1676 - a cons cell (:level . N). Any headline of level N is considered a target.
1677 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1678 ;; FIXME: what if there are a var and func with same name???
1694 "Non-nil means, provide refile targets as paths.
1695 So a level 3 headline will be available as level1/level2/level3.
1696 When the value is `file', also include the file name (without directory)
1697 into the path. When `full-file-path', include the full file path."
1706 "Options concerning TODO items in Org-mode."
1711 "Options concerning Progress logging in Org-mode."
1716 "List of TODO entry keyword sequences and their interpretation.
1719 Each sequence starts with a symbol, either `sequence' or `type',
1720 indicating if the keywords should be interpreted as a sequence of
1721 action steps, or as different types of TODO items. The first
1722 keywords are states requiring action - these states will select a headline
1723 for inclusion into the global TODO list Org-mode produces. If one of
1726 the last keyword is treated as the only DONE state of the sequence.
1729 additional state where no keyword is present. For details about this
1730 cycling, see the manual.
1732 TODO keywords and interpretation can also be set on a per-file basis with
1733 the special #+SEQ_TODO and #+TYP_TODO lines.
1735 Each keyword can optionally specify a character for fast state selection
1736 \(in combination with the variable `org-use-fast-todo-selection')
1737 and specifiers for state change logging, using the same syntax
1740 indicates to record a time stamp each time this state is selected.
1742 Each keyword may also specify if a timestamp or a note should be
1743 recorded when entering or leaving the state, by adding additional
1744 characters in the parenthesis after the keyword. This looks like this:
1746 record only the time of the state change. With X and Y being either
1748 Y when leaving the state if and only if the *target* state does not
1749 define X. You may omit any of the fast-selection key or X or /Y,
1750 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1752 For backward compatibility, this variable may also be just a list
1753 of keywords - in this case the interptetation (sequence or type) will be
1754 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1792 "Controls how TODO keywords are interpreted.
1793 This variable is in principle obsolete and is only used for
1794 backward compatibility, if the interpretation of todo keywords is
1795 not given already in `org-todo-keywords'. See that variable for
1796 more information."
1803 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1804 This variable describes if and under what circumstances the cycling
1805 mechanism for TODO keywords will be replaced by a single-key, direct
1806 selection scheme.
1808 When nil, fast selection is never used.
1810 When the symbol `prefix', it will be used when `org-todo' is called with
1811 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1812 in an agenda buffer.
1814 When t, fast selection is used by default. In this case, the prefix
1815 argument forces cycling instead.
1817 In all cases, the special interface is only used if access keys have actually
1818 been assigned by the user, i.e. if keywords in the configuration are followed
1819 by a letter in parenthesis, like TODO(t)."
1827 "Hook which is run after the state of a TODO item was changed.
1828 The new state (a string with a TODO keyword, or nil) is available in the
1829 Lisp variable `state'."
1834 "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
1835 When equal to the list (done), also prompt for a closing note.
1836 This can also be configured on a per-file basis by adding one of
1837 the following lines anywhere in the buffer:
1839 #+STARTUP: logdone
1840 #+STARTUP: lognotedone
1841 #+STARTUP: nologdone"
1849 ;; Normalize old uses of org-log-done.
1855 ;; FIXME: document
1857 "Non-nil means, recored a note when clocking out of an item.
1858 This can also be configured on a per-file basis by adding one of
1859 the following lines anywhere in the buffer:
1861 #+STARTUP: lognoteclock-out
1862 #+STARTUP: nolognoteclock-out"
1868 "Non-nil means, the CLOSED time stamp will contain date and time.
1869 When nil, only the date will be recorded."
1877 "Headings for notes added when clocking out or closing TODO items.
1878 The value is an alist, with the car being a symbol indicating the note
1879 context, and the cdr is the heading to be used. The heading may also be the
1880 empty string.
1881 %t in the heading will be replaced by a time stamp.
1882 %s will be replaced by the new TODO state, in double quotes.
1883 %u will be replaced by the user name.
1884 %U will be replaced by the full user name."
1890 "Heading when changing todo state (todo sequence only)"
1895 "Non-nil means, the latest state change note will be directly after heading.
1896 When nil, the notes will be orderer according to time."
1902 "Non-nil means, record moving through the DONE state when triggering repeat.
1903 An auto-repeating tasks is immediately switched back to TODO when marked
1905 the TODO keyword definition, or recording a cloing note by setting
1906 `org-log-done', there will be no record of the task moving trhough DONE.
1907 This variable forces taking a note anyway. Possible values are:
1909 nil Don't force a record
1910 time Record a time stamp
1911 note Record a note
1913 This option can also be set with on a per-file-basis with
1915 #+STARTUP: logrepeat
1916 #+STARTUP: lognoterepeat
1917 #+STARTUP: nologrepeat
1919 You can have local logging settings for a subtree by setting the LOGGING
1920 property to one or more of these keywords."
1929 "Should clocking info be wrapped into a drawer?
1930 When t, clocking info will always be inserted into a :CLOCK: drawer.
1931 If necessary, the drawer will be created.
1932 When nil, the drawer will not be created, but used when present.
1933 When an integer and the number of clocking entries in an item
1934 reaches or exceeds this number, a drawer will be created."
1943 "When t, the clock will be stopped when the relevant entry is marked DONE.
1944 Nil means, clock will keep running until stopped explicitly with
1945 `C-c C-x C-o', or until the clock is started in a different item."
1950 "Set task to a special todo state while clocking it.
1951 The value should be the state to which the entry should be switched."
1959 "Priorities in Org-mode."
1964 "The highest priority of TODO items. A character like ?A, ?B etc.
1965 Must have a smaller ASCII number than `org-lowest-priority'."
1970 "The lowest priority of TODO items. A character like ?A, ?B etc.
1971 Must have a larger ASCII number than `org-highest-priority'."
1976 "The default priority of TODO items.
1977 This is the priority an item get if no explicit priority is given."
1982 "Non-nil means, start with default priority when starting to cycle.
1983 When this is nil, the first step in the cycle will be (depending on the
1984 command used) one higher or lower that the default priority."
1989 "Options concerning time stamps and deadlines in Org-mode."
1994 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1995 When nil, these labeled time stamps are forces into the second line of an
1996 entry, just after the headline. When scheduling from the global TODO list,
1997 the time stamp will always be forced into the second line."
2002 "Formats for `format-time-string' which are used for time stamps.
2006 "Number of minutes to round time stamps to.
2007 These are two values, the first applies when first creating a time stamp.
2008 The second applies when changing it with the commands `S-up' and `S-down'.
2009 When changing the time stamp, this means that it will change in steps
2010 of N minutes, as given by the second value.
2012 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2013 numbers should be factors of 60, so for example 5, 10, 15.
2015 When this is larger than 1, you can still force an exact time-stamp by using
2016 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2017 and by using a prefix arg to `S-up/down' to specify the exact number
2018 of minutes to shift."
2028 ;; Make sure old customizations of this variable don't lead to problems.
2032 org-time-stamp-rounding-minutes)))
2035 "Non-nil means, overlay custom formats over all time stamps.
2036 The formats are defined through the variable `org-time-stamp-custom-formats'.
2037 To turn this on on a per-file basis, insert anywhere in the file:
2038 #+STARTUP: customtime"
2046 "Custom formats for time stamps. See `format-time-string' for the syntax.
2047 These are overlayed over the default ISO format if the variable
2048 `org-display-custom-times' is set. Time like %H:%M should be at the
2049 end of the second format."
2054 "Get the right format for a time string."
2059 f)))
2062 "Non-nil means, assume future for incomplete date input from user.
2063 This affects the following situations:
2064 1. The user gives a day, but no month.
2067 it will be considered as *this* month.
2068 2. The user gives a month but not a year.
2072 Currently this does not work for ISO week specifications.
2074 When this option is nil, the current month and year will always be used
2075 as defaults."
2080 "Non-nil means, display current interpretation of date prompt live.
2081 This display will be in an overlay, in the minibuffer."
2086 "Non-nil means, pop up a calendar when prompting for a date.
2087 In the calendar, the date can be selected with mouse-1. However, the
2088 minibuffer will also be active, and you can simply enter the date as well.
2089 When nil, only the minibuffer will be available."
2097 "The hour when your day really ends.
2098 This has influence for the following applications:
2100 the time given here, the day recognized as TODAY is actually yesterday.
2101 - When a date is read from the user and it is still before the time given
2102 here, the current date and time will be assumed to be yesterday, 23:59.
2104 FIXME:
2105 IMPORTANT: This is still a very experimental feature, it may disappear
2106 again or it may be extended to mean more things."
2111 "Non-nil means, S-down will increase the time in a time stamp.
2112 When nil, S-up will increase."
2117 "Non-nil means, make the calendar window follow timestamp changes.
2118 When a timestamp is modified and the calendar window is visible, it will be
2119 moved to the new date."
2124 "When non-nil, should be a function to create `org-clock-heading'.
2125 This is the string shown in the mode line when a clock is running.
2126 The function is called with point at the beginning of the headline."
2131 "Options concerning tags in Org-mode."
2136 "List of tags allowed in Org-mode files.
2137 When this list is nil, Org-mode will base TAG input on what is already in the
2138 buffer.
2139 The value of this variable is an alist, the car of each entry must be a
2140 keyword as a string, the cdr may be a character that is used to select
2141 that tag through the fast-tag-selection interface.
2142 See the manual for details."
2152 "Non-nil means, use fast tag selection scheme.
2153 This is a special interface to select and deselect tags with single keys.
2154 When nil, fast selection is never used.
2155 When the symbol `auto', fast selection is used if and only if selection
2156 characters for tags have been configured, either through the variable
2157 `org-tag-alist' or through a #+TAGS line in the buffer.
2158 When t, fast selection is always used and selection keys are assigned
2159 automatically if necessary."
2167 "Non-nil means, fast tag selection exits after first change.
2168 When nil, you have to press RET to exit it.
2169 During fast tag selection, you can toggle this flag with `C-c'.
2170 This variable can also have the value `expert'. In this case, the window
2171 displaying the tags menu is not even shown, until you press C-c again."
2179 "Non-nil means, fast tags selection interface will also offer TODO states.
2183 "The column to which tags should be indented in a headline.
2184 If this number is positive, it specifies the column. If it is negative,
2185 it means that the tags should be flushright to that column. For example,
2186 -80 works well for a normal 80 character screen."
2191 "Non-nil means, realign tags after pro/demotion of TODO state change.
2192 These operations change the length of a headline and therefore shift
2193 the tags around. With this options turned on, after each such operation
2194 the tags are again aligned to `org-tags-column'."
2199 "Non-nil means, tags in levels apply also for sublevels.
2200 When nil, only the tags directly given in a specific line apply there.
2201 If you turn off this option, you very likely want to turn on the
2202 companion option `org-tags-match-list-sublevels'."
2207 "Non-nil means list also sublevels of headlines matching tag search.
2208 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2209 the sublevels of a headline matching a tag search often also match
2210 the same search. Listing all of them can create very long lists.
2211 Setting this variable to nil causes subtrees of a match to be skipped.
2212 This option is off by default, because inheritance in on. If you turn
2213 inheritance off, you very likely want to turn this option on.
2215 As a special case, if the tag search is restricted to TODO items, the
2216 value of this variable is ignored and sublevels are always checked, to
2217 make sure all corresponding TODO items find their way into the list."
2229 "Options concerning properties in Org-mode."
2234 "How property key/value pairs should be formatted by `indent-line'.
2235 When `indent-line' hits a property definition, it will format the line
2236 according to this format, mainly to make sure that the values are
2237 lined-up with respect to each other."
2242 "Non-nil means, properties apply also for sublevels.
2243 This setting is only relevant during property searches, not when querying
2244 an entry with `org-entry-get'. To retrieve a property with inheritance,
2245 you need to call `org-entry-get' with the inheritance flag.
2246 Turning this on can cause significant overhead when doing a search, so
2247 this is turned off by default.
2248 When nil, only the properties directly given in the current entry count.
2249 The value may also be a list of properties that shouldhave inheritance.
2251 However, note that some special properties use inheritance under special
2252 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2254 for valid values of a property."
2262 "The default column format, if no other format has been defined.
2263 This variable can be set on the per-file basis by inserting a line
2265 #+COLUMNS: %25ITEM ....."
2270 "List of property/value pairs that can be inherited by any entry.
2271 You can set buffer-local values for this by adding lines like
2273 #+PROPERTY: NAME VALUE"
2280 "List of property/value pairs that can be inherited by any entry.
2281 Valid for the current buffer.
2285 "Options concerning agenda views in Org-mode."
2290 "Variable used by org files to set a category for agenda display.
2291 Such files should use a file variable to set it, for example
2295 or contain a special line
2297 #+CATEGORY: ELisp
2299 If the file does not specify a category, then file's base name
2304 "The files to be used for agenda display.
2308 If an entry is a directory, all files in that directory that are matched by
2309 `org-agenda-file-regexp' will be part of the file list.
2311 If the value of the variable is not a list but a single file name, then
2312 the list of agenda files is actually stored and maintained in that file, one
2313 agenda file per line."
2320 "Regular expression to match files for `org-agenda-files'.
2321 If any element in the list in that variable contains a directory instead
2322 of a normal file, all files in that directory that are matched by this
2323 regular expression will be included."
2328 "t means to just skip non-reachable files in `org-agenda-files'.
2329 Nil means to remove them, after a query, from the list."
2334 "List of extra files to be searched by text search commands.
2335 These files will be search in addition to the agenda files bu the
2336 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2337 Note that these files will only be searched for text search commands,
2338 not for the other agenda views like todo lists, tag earches or the weekly
2339 agenda. This variable is intended to list notes and possibly archive files
2340 that should also be searched by these two commands."
2349 "When set, remote killing from the agenda buffer needs confirmation.
2350 When t, a confirmation is always needed. When a number N, confirmation is
2351 only needed when the text to be killed contains more than N non-white lines."
2359 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2360 The command `org-calendar-goto-agenda' will be bound to this key. The
2361 default is the character `c' because then `c' can be used to switch back and
2362 forth between agenda and calendar."
2367 "Non-nil means, make the block agenda more compact.
2368 This is done by leaving out unnecessary lines."
2373 "Options concerning exporting agenda views in Org-mode."
2378 "Non-nil means, use colors in agenda views."
2383 "Alist of variable/value pairs that should be active during agenda export.
2384 This is a good place to set uptions for ps-print and for htmlize."
2392 "The style specification for exported HTML Agenda files.
2393 If this variable contains a string, it will replace the default <style>
2394 section as produced by `htmlize'.
2395 Since there are different ways of setting style information, this variable
2396 needs to contain the full HTML structure to provide a style, including the
2397 surrounding HTML tags. The style specifications should include definitions
2398 the fonts used by the agenda, here is an example:
2401 p { font-weight: normal; color: gray; }
2402 .org-agenda-structure {
2403 font-size: 110%;
2404 color: #003399;
2405 font-weight: 600;
2406 }
2407 .org-todo {
2408 color: #cc6666;
2409 font-weight: bold;
2410 }
2411 .org-done {
2412 color: #339933;
2413 }
2414 .title { text-align: center; }
2415 .todo, .deadline { color: red; }
2416 .done { color: green; }
2417 </style>
2419 or, if you want to keep the style in a file,
2423 As the value of this option simply gets inserted into the HTML <head> header,
2425 <style>...</style> is required, if not present the variable will be ignored."
2431 "Options concerning agenda views in Org-mode."
2505 "Selection of examples for agenda command settings.
2506 This will be spliced into the custom type of
2511 "Custom commands for the agenda.
2512 These commands will be offered on the splash screen displayed by the
2515 (key desc type match settings files)
2517 key The key (one or more characters as a string) to be associated
2518 with the command.
2519 desc A description of the command, when omitted or nil, a default
2520 description is built using MATCH.
2521 type The command type, any of the following symbols:
2522 agenda The daily/weekly agenda.
2523 todo Entries with a specific TODO keyword, in all agenda files.
2524 search Entries containing search words entry or headline.
2525 tags Tags/Property/TODO match in all agenda files.
2526 tags-todo Tags/P/T match in all agenda files, TODO entries only.
2527 todo-tree Sparse tree of specific TODO keyword in *current* file.
2528 tags-tree Sparse tree with all tags matches in *current* file.
2529 occur-tree Occur sparse tree for *current* file.
2530 ... A user-defined function.
2531 match What to search for:
2532 - a single keyword for TODO keyword searches
2533 - a tags match expression for tags searches
2534 - a word search expression for text searches.
2535 - a regular expression for occur searches
2536 For all other commands, this should be the empty string.
2537 settings A list of option settings, similar to that in a let form, so like
2538 this: ((opt1 val1) (opt2 val2) ...). The values will be
2539 evaluated at the moment of execution, so quote them when needed.
2540 files A list of files file to write the produced agenda buffer to
2541 with the command `org-store-agenda-views'.
2544 produced. Otherwide, only the plain text is written to the file.
2546 You can also define a set of commands, to create a composite agenda buffer.
2547 In this case, an entry looks like this:
2549 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
2551 where
2553 desc A description string to be displayed in the dispatcher menu.
2554 cmd An agenda command, similar to the above. However, tree commands
2555 are no allowed, but instead you can get agenda and global todo list.
2556 So valid commands for a set are:
2565 Each command can carry a list of options, and another set of options can be
2566 given for the whole set of commands. Individual command options take
2567 precedence over the general options.
2569 When using several characters as key to a command, the first characters
2570 are prefix commands. For the dispatcher to display useful information, you
2571 should provide a description for the prefix, like
2573 (setq org-agenda-custom-commands
2597 ,org-agenda-custom-commands-local-options
2646 "The register holding the current query string.
2647 The prupose of this is that if you construct a query string interactively,
2648 you can then use it to define a custom command."
2654 "How to identify stuck projects.
2655 This is a list of four items:
2656 1. A tags/todo matcher string that is used to identify a project.
2657 The entire tree below a headline matched by this is considered one project.
2658 2. A list of TODO keywords identifying non-stuck projects.
2659 If the project subtree contains any headline with one of these todo
2660 keywords, the project is considered to be not stuck. If you specify
2662 3. A list of tags identifying non-stuck projects.
2663 If the project subtree contains any headline with one of these tags,
2665 a tag, any tag will mark the project unstuck.
2666 4. An arbitrary regular expression matching non-stuck projects.
2669 or `C-c a #' to produce the list."
2673 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2679 "Options concerning skipping parts of agenda files."
2684 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2685 When nil, the sublevels of a TODO entry are not checked, resulting in
2686 potentially much shorter TODO lists."
2692 "Non-nil means, don't show entries with a date in the global todo list.
2693 You can use this if you prefer to mark mere appointments with a TODO keyword,
2694 but don't want them to show up in the TODO list.
2695 When this is set, it also covers deadlines and scheduled items, the settings
2696 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2697 will be ignored."
2703 "Non-nil means, don't show scheduled entries in the global todo list.
2704 The idea behind this is that by scheduling it, you have already taken care
2705 of this item.
2706 See also `org-agenda-todo-ignore-with-date'."
2712 "Non-nil means, don't show near deadline entries in the global todo list.
2713 Near means closer than `org-deadline-warning-days' days.
2714 The idea behind this is that such items will appear in the agenda anyway.
2715 See also `org-agenda-todo-ignore-with-date'."
2721 "Non-nil means don't show scheduled items in agenda when they are done.
2722 This is relevant for the daily/weekly agenda, not for the TODO list. And
2723 it applies only to the actual date of the scheduling. Warnings about
2724 an item with a past scheduling dates are always turned off when the item
2725 is DONE."
2730 "Non-nil means don't show deadines when the corresponding item is done.
2731 When nil, the deadline is still shown and should give you a happy feeling.
2732 This is relevant for the daily/weekly agenda. And it applied only to the
2733 actualy date of the deadline. Warnings about approching and past-due
2734 deadlines are always turned off when the item is DONE."
2739 "Non-nil means don't select item by timestamp or -range if it is DONE."
2744 "Non-nil means, `org-timeline' also shows dates without an entry.
2745 When nil, only the days which actually have entries are shown.
2746 When t, all days between the first and the last date are shown.
2747 When an integer, show also empty dates, but if there is a gap of more than
2748 N days, just insert a special line indicating the size of the gap."
2757 "Options concerning initial settings in the Agenda in Org Mode."
2762 "Hook run just before displaying an agenda buffer."
2767 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2768 A longer mouse click will still set point. Does not work on XEmacs.
2769 Needs to be set before org.el is loaded."
2774 "The initial value of follow-mode in a newly created agenda window."
2779 "Options concerning the windows used by the Agenda in Org Mode."
2784 "How the agenda buffer should be displayed.
2785 Possible values for this option are:
2787 current-window Show agenda in the current window, keeping all other windows.
2788 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2789 other-window Use `switch-to-buffer-other-window' to display agenda.
2790 reorganize-frame Show only two windows on the current frame, the current
2791 window and the agenda.
2792 See also the variable `org-agenda-restore-windows-after-quit'."
2801 "The min and max height of the agenda window as a fraction of frame height.
2802 The value of the variable is a cons cell with two numbers between 0 and 1.
2803 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2808 "Non-nil means, restore window configuration open exiting agenda.
2809 Before the window configuration is changed for displaying the agenda,
2810 the current status is recorded. When the agenda is exited with
2811 `q' or `x' and this option is set, the old state is restored. If
2812 `org-agenda-window-setup' is `other-frame', the value of this
2813 option will be ignored.."
2818 "How should indirect tree buffers be displayed?
2819 This applies to indirect buffers created with the commands
2821 Valid values are:
2822 current-window Display in the current window
2823 other-window Just display in another window.
2824 dedicated-frame Create one new frame, and re-use it each time.
2825 new-frame Make a new frame each time. Note that in this case
2826 previously-made indirect buffers are kept, and you need to
2827 kill these buffers yourself."
2837 "Options concerning the daily/weekly agenda."
2842 "Number of days to include in overview display.
2843 Should be 1 or 7."
2848 "Non-nil means, start the overview always on the specified weekday.
2849 0 denotes Sunday, 1 denotes Monday etc.
2850 When nil, always start on the current day."
2856 "Non-nil means, `org-agenda' shows every day in the selected range.
2857 When nil, only the days which actually have entries are shown."
2862 "Format string for displaying dates in the agenda.
2863 Used by the daily/weekly agenda and by the timeline. This should be
2864 a format string understood by `format-time-string', or a function returning
2865 the formatted date as a string. The function must take a single argument,
2866 a calendar-style date list like (month day year)."
2873 "Format a date string for display in the daily/weekly agenda, or timeline.
2874 This function makes sure that dates are aligned for easy reading."
2893 dayname day monthname year weekstring)))
2896 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2901 "Set means weekly/daily agenda will always contain all TODO entries.
2902 The TODO entries will be listed at the top of the agenda, before
2903 the entries for specific days."
2908 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2909 When nil, only one occurence is shown, either today or the
2910 nearest into the future."
2915 "No. of days before expiration during which a deadline becomes active.
2916 This variable governs the display in sparse trees and in the agenda.
2917 When 0 or negative, it means use this number (the absolute value of it)
2918 even if a deadline has a different individual lead time specified."
2924 "No. of days to continue listing scheduled items that are not marked DONE.
2925 When an item is scheduled on a date, it shows up in the agenda on this
2926 day and will be listed until it is marked done for the number of days
2927 given here."
2932 "Options concerning the time grid in the Org-mode Agenda."
2937 "Non-nil means, show a time grid in the agenda schedule.
2938 A time grid is a set of lines for specific times (like every two hours between
2939 8:00 and 20:00). The items scheduled for a day at specific times are
2940 sorted in between these lines.
2941 For details about when the grid will be shown, and what it will look like, see
2942 the variable `org-agenda-time-grid'."
2948 "----------------"
2951 "The settings for time grid for agenda display.
2952 This is a list of three items. The first item is again a list. It contains
2953 symbols specifying conditions when the grid should be displayed:
2955 daily if the agenda shows a single day
2956 weekly if the agenda shows an entire week
2957 today show grid on current date, independent of daily/weekly display
2958 require-timed show grid only if at least one item has a time specification
2960 The second item is a string which will be places behing the grid time.
2962 The third item is a list of integers, indicating the times that should have
2963 a grid line."
2965 :type
2972 require-timed)
2974 remove-match))
2979 "Options concerning sorting in the Org-mode Agenda."
2988 "Sorting structure for the agenda items of a single day.
2989 This is a list of symbols which will be used in sequence to determine
2990 if an entry should be listed before another entry. The following
2991 symbols are recognized:
2993 time-up Put entries with time-of-day indications first, early first
2994 time-down Put entries with time-of-day indications first, late first
2995 category-keep Keep the default order of categories, corresponding to the
2996 sequence in `org-agenda-files'.
2997 category-up Sort alphabetically by category, A-Z.
2998 category-down Sort alphabetically by category, Z-A.
2999 tag-up Sort alphabetically by last tag, A-Z.
3000 tag-down Sort alphabetically by last tag, Z-A.
3001 priority-up Sort numerically by priority, high priority last.
3002 priority-down Sort numerically by priority, high priority first.
3004 The different possibilities will be tried in sequence, and testing stops
3006 '(time-up category-keep priority-down)
3007 means: Pull out all entries having a specified time of day and sort them,
3008 in order to make a time schedule for the current day the first thing in the
3009 agenda listing for the day. Of the entries without a time indication, keep
3010 the grouped in categories, don't sort the categories, but keep them in
3011 the sequence given in `org-agenda-files'. Within each category sort by
3012 priority.
3014 Leaving out `category-keep' would mean that items will be sorted across
3015 categories by priority.
3017 Instead of a single list, this can also be a set of list for specific
3018 contents, with a context symbol in the car of the list, any of
3019 `agenda', `todo', `tags' for the corresponding agenda views."
3032 "Non-nil means, items without time are considered late.
3033 This is only relevant for sorting. When t, items which have no explicit
3034 time like 15:30 will be considered as 99:01, i.e. later than any items which
3035 do have a time. When nil, the default time is before 0:00. You can use this
3036 option to decide if the schedule for today should come before or after timeless
3037 agenda entries."
3042 "Options concerning the entry prefix in the Org-mode agenda display."
3052 "Format specifications for the prefix of items in the agenda views.
3053 An alist with four entries, for the different agenda types. The keys to the
3054 sublists are `agenda', `timeline', `todo', and `tags'. The values
3055 are format strings.
3056 This format works similar to a printf format, with the following meaning:
3059 as given by the CATEGORY keyword or derived from the file name.
3060 %T the *last* tag of the item. Last because inherited tags come
3061 first in the list.
3062 %t the time-of-day specification if one applies to the entry, in the
3063 format HH:MM
3064 %s Scheduling/Deadline information, a short string
3066 All specifiers work basically like the standard `%s' of printf, but may
3067 contain two additional characters: A question mark just after the `%' and
3068 a whitespace/punctuation character just before the final letter.
3070 If the first character after `%' is a question mark, the entire field
3071 will only be included if the corresponding value applies to the
3072 current entry. This is useful for fields which should have fixed
3073 width when present, but zero width when absent. For example,
3075 day is specified, but will completely disappear in entries which do
3076 not contain a time.
3078 If there is punctuation or whitespace character just before the final
3079 format letter, this character will be appended to the field value if
3082 empty, no additional colon would be interted.
3085 - Indent the line with two space characters
3086 - Give the category in a 12 chars wide field, padded with whitespace on
3087 the right (because of `-'). Append a colon if there is a category
3088 (because of `:').
3089 - If there is a time-of-day, put it into a 12 chars wide field. If no
3090 time, don't put in an empty field, just skip it (because of '?').
3091 - Finally, put the scheduling information and append a whitespace.
3093 As another example, if you don't want the time-of-day of entries in
3094 the prefix, you could use:
3098 See also the variables `org-agenda-remove-times-when-in-prefix' and
3099 `org-agenda-remove-tags'."
3111 "The compiled version of the most recently used prefix format.
3115 "Format for the TODO keyword in agenda lines.
3117 to occupy a fixed space in the agenda display."
3122 "Text preceeding scheduled items in the agenda view.
3123 This is a list with two strings. The first applies when the item is
3124 scheduled on the current day. The second applies when it has been scheduled
3125 previously, it may contain a %d to capture how many days ago the item was
3126 scheduled."
3133 "Text preceeding deadline items in the agenda view.
3134 This is a list with two strings. The first applies when the item has its
3135 deadline on the current day. The second applies when it is in the past or
3136 in the future, it may contain %d to capture how many days away the deadline
3137 is (was)."
3144 "Non-nil means, remove duplicate time specifications in agenda items.
3145 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
3146 time-of-day specification in a headline or diary entry is extracted and
3147 placed into the prefix. If this option is non-nil, the original specification
3148 \(a timestamp or -range, or just a plain time(range) specification like
3149 11:30-4pm) will be removed for agenda display. This makes the agenda less
3150 cluttered.
3151 The option can be t or nil. It may also be the symbol `beg', indicating
3152 that the time should only be removed what it is located at the beginning of
3153 the headline/diary entry."
3162 "Default duration for appointments that only have a starting time.
3163 When nil, no duration is specified in such cases.
3164 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
3172 "Non-nil means, remove the tags from the headline copy in the agenda.
3173 When this is the symbol `prefix', only remove tags when
3174 `org-agenda-prefix-format' contains a `%T' specifier."
3186 "Shift tags in agenda items to this column.
3187 If this number is positive, it specifies the column. If it is negative,
3188 it means that the tags should be flushright to that column. For example,
3189 -80 works well for a normal 80 character screen."
3197 "Non-nil means, highlight low and high priorities in agenda.
3198 When t, the highest priority entries are bold, lowest priority italic.
3199 This may also be an association list of priority faces. The face may be
3210 "Options for embedding LaTeX code into Org-mode."
3218 "Options for creating images from LaTeX fragments.
3219 This is a property list with the following properties:
3221 `default' means use the forground of the default face.
3223 `default' means use the background of the default face.
3224 :scale a scaling factor for the size of the images
3225 :html-foreground, :html-background, :html-scale
3226 The same numbers for HTML export.
3227 :matchers a list indicating which matchers should be used to
3228 find LaTeX fragments. Valid members of this list are:
3245 "The document header used for processing LaTeX fragments."
3250 "Options for exporting org-listings."
3255 "General options for exporting Org-mode files."
3259 ;; FIXME
3264 When this option is turned on, these strings will be exported as:
3266 Org HTML LaTeX
3267 -----+----------+--------
3269 -- – --
3270 --- — ---
3271 ... … \ldots
3288 "Terms used in export text, translated to different languages.
3289 Use the variable `org-export-default-language' to set the language,
3290 or use the +OPTION lines for a per-file setting."
3300 "The default language of HTML export, as a string.
3301 This should have an association in `org-export-language-setup'."
3306 "Non-nil means, skip all text before the first headline when exporting.
3307 When nil, that text is exported as well."
3312 "The last level which is still exported as a headline.
3313 Inferior levels will produce itemize lists when exported.
3314 Note that a numeric prefix argument to an exporter function overrides
3315 this setting.
3322 "Non-nil means, add section numbers to headlines when exporting.
3329 "Non-nil means, create a table of contents in exported files.
3330 The TOC contains headlines with levels up to`org-export-headline-levels'.
3331 When an integer, include levels up to N in the toc, this may then be
3332 different from `org-export-headline-levels', but it will not be allowed
3333 to be larger than the number of headline levels.
3334 When nil, no table of contents is made.
3337 ASCII export, and with red color in HTML output, if the option
3338 `org-export-mark-todo-in-toc' is set.
3340 In HTML output, the TOC will be clickable.
3351 "Non-nil means, mark TOC lines that contain any open TODO items."
3356 "Non-nil means, preserve all line breaks when exporting.
3357 Normally, in HTML output paragraphs will be reformatted. In ASCII
3358 export, line breaks will always be preserved, regardless of this variable.
3365 "Whether subtrees with the ARCHIVE tag should be exported.
3366 This can have three different values
3367 nil Do not export, pretend this tree is not present
3368 t Do export the entire tree
3369 headline Only export the headline, but skip the tree below it."
3378 "Non-nil means, insert author name and email into the exported file.
3380 This option can also be set with the +OPTIONS line,
3386 "Non-nil means, insert a time stamp into the exported file.
3387 The time stamp shows when the file was created.
3389 This option can also be set with the +OPTIONS line,
3395 "If nil, do not export time stamps and associated keywords."
3400 "If nil, remove timestamps from the table of contents entries."
3405 "If nil, do not export tags, just remove them from headlines.
3406 If this is the symbol `not-in-toc', tags will be removed from table of
3407 contents entries, but still be shown in the headlines of the document.
3417 "Non-nil means, export with drawers like the property drawer.
3418 When t, all drawers are exported. This may also be a list of
3419 drawer names to export."
3428 "Options for translating special ascii sequences for the export backends."
3433 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3434 If the export target supports emphasizing text, the word will be
3435 typeset in bold, italic, or underlined, respectively. Works only for
3436 single words, but you can say: I *really* *mean* *this*.
3437 Not all export backends support this.
3444 "If nil, export [1] as a footnote marker.
3445 Lines starting with [1] will be formatted as footnotes.
3453 When this option is turned on, you can use TeX-like syntax for sub- and
3455 considered as a single item - so grouping with {} is normally not
3456 needed. For example, the following things will be parsed as single
3457 sub- or superscripts.
3459 10^24 or 10^tau several digits will be considered 1 item.
3460 10^-12 or 10^-tau a leading sign with digits or a word
3461 x^2-y^3 will be read as x^2 - y^3, because items are
3462 terminated by almost any nonword/nondigit char.
3463 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3465 Still, ambiguity is possible - so when in doubt use {} to enclose the
3466 sub/superscript. If you set this variable to the symbol `{}',
3467 the braces are *required* in order to trigger interpretations as
3469 frequently in plain text.
3471 Not all export backends support this, but HTML does.
3482 When this option is turned on, these strings will be exported as:
3485 -- : –
3486 --- : —
3488 Not all export backends support this, but HTML does.
3495 "Non-nil means, interpret simple TeX-like macros when exporting.
3497 No only real TeX macros will work here, but the standard HTML entities
3498 for math can be used as macro names as well. For a list of supported
3499 names in HTML export, see the constant `org-html-entities'.
3500 Not all export backends support this.
3508 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3510 the first non-white thing on a line. It will also find the math delimiters
3512 display math.
3521 This can be used to have pre-formatted text, fragments of code etc. For
3522 example:
3523 : ;; Some Lisp examples
3524 : (while (defc cnt)
3525 : (ding))
3526 will be looking just like this in also HTML. See also the QUOTE keyword.
3527 Not all export backends support this.
3534 "Number of stacked braces for sub/superscript matching.
3535 This has to be set before loading org.el to be effective."
3540 "Options for exporting tables in Org-mode."
3546 For example:
3548 | Name | Address | Birthday |
3549 |-------------+----------+-----------|
3550 | Arthur Dent | England | 29.2.2100 |
3552 Not all export backends support this.
3559 "Non-nil means, highlight the first table line.
3560 In HTML export, this means use <th> instead of <td>.
3561 In tables created with table.el, this applies to the first table line.
3562 In Org-mode tables, all lines before the first horizontal separator
3563 line will be formatted with <th> tags."
3568 "Remove special lines and marking characters in calculating tables.
3569 This removes the special marking character column from tables that are set
3570 up for spreadsheet calculations. It also removes the entire lines
3571 marked with `!', `_', or `^'. The lines with `$' are kept, because
3572 the values of constants may be useful to have."
3577 "Non-nil means, always export tables created with table.el natively.
3578 Natively means, use the HTML code generator in table.el.
3579 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3580 the table does not use row- or column-spanning). This has the
3581 advantage, that the automatic HTML conversions for math symbols and
3582 sub/superscripts can be applied. Org-mode's HTML generator is also
3583 much faster."
3588 "Options specific for ASCII export of Org-mode files."
3593 "Characters for underlining headings in ASCII export.
3594 In the given sequence, these characters will be used for level 1, 2, ..."
3599 "Bullet characters for headlines converted to lists in ASCII export.
3600 The first character is used for the first lest level generated in this
3601 way, and so on. If there are more levels than characters given here,
3602 the list will be repeated.
3603 Note that plain lists will keep the same bullets as the have in the
3604 Org-mode file."
3609 "Options specific for XML export of Org-mode files."
3614 "Options specific for HTML export of Org-mode files."
3619 ""
3624 "The extension for exported HTML files."
3630 html {
3631 font-family: Times, serif;
3632 font-size: 12pt;
3633 }
3634 .title { text-align: center; }
3635 .todo { color: red; }
3636 .done { color: green; }
3637 .timestamp { color: grey }
3638 .timestamp-kwd { color: CadetBlue }
3639 .tag { background-color:lightblue; font-weight:normal }
3640 .target { background-color: lavender; }
3641 pre {
3642 border: 1pt solid #AEBDCC;
3643 background-color: #F3F5F7;
3644 padding: 5pt;
3645 font-family: courier, monospace;
3646 }
3647 table { border-collapse: collapse; }
3648 td, th {
3649 vertical-align: top;
3650 <!--border: 1pt solid #ADB9CC;-->
3651 }
3652 </style>"
3653 "The default style specification for exported HTML files.
3654 Since there are different ways of setting style information, this variable
3655 needs to contain the full HTML structure to provide a style, including the
3656 surrounding HTML tags. The style specifications should include definitions
3657 for new classes todo, done, title, and deadline. For example, valid values
3658 would be:
3661 p { font-weight: normal; color: gray; }
3662 h1 { color: black; }
3663 .title { text-align: center; }
3664 .todo, .deadline { color: red; }
3665 .done { color: green; }
3666 </style>
3668 or, if you want to keep the style in a file,
3672 As the value of this option simply gets inserted into the HTML <head> header,
3679 "Format for typesetting the document title in HTML export."
3684 "The <H> level for level 1 headings in HTML export."
3689 "Non-nil means, make file links to `file.org' point to `file.html'.
3690 When org-mode is exporting an org-mode file to HTML, links to
3691 non-html files are directly put into a href tag in HTML.
3692 However, links to other Org-mode files (recognized by the
3693 extension `.org.) should become links to the corresponding html
3694 file, assuming that the linked org-mode file will also be
3695 converted to HTML.
3696 When nil, the links still point to the plain `.org' file."
3701 "Non-nil means, inline images into exported HTML pages.
3702 This is done using an <img> tag. When nil, an anchor with href is used to
3703 link to the image. If this option is `maybe', then images in links with
3704 an empty description will be inlined, while images with a description will
3705 be linked only."
3711 ;; FIXME: rename
3713 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3714 When nil, these tags will be exported as plain text and therefore
3715 not be interpreted by a browser.
3723 "The HTML tag that is used to start a table.
3724 This must be a <table> tag, but you may change the options like
3725 borders and spacing."
3730 "The opening tag for table header fields.
3731 This is customizable so that alignment options can be specified."
3736 "The opening tag for table data fields.
3737 This is customizable so that alignment options can be specified."
3742 "If non-nil, write `org-export-html-html-helper-timestamp'
3743 into the exported HTML text. Otherwise, the buffer will just be saved
3744 to a file."
3750 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3755 "Options specific for iCalendar export of Org-mode files."
3760 "The file name for the iCalendar file covering all agenda files.
3762 The file name should be absolute, the file will be overwritten without warning."
3767 "Non-nil means, export to iCalendar files should also cover TODO items."
3775 "Non-nil means, export to iCalendar files should also cover sexp entries.
3776 These are entries like in the diary, but directly in an Org-mode file."
3781 "Amount of text below headline to be included in iCalendar export.
3782 This is a number of characters that should maximally be included.
3783 Properties, scheduling and clocking lines will always be removed.
3784 The text will be inserted into the DESCRIPTION field."
3792 "Calendar name for the combined iCalendar representing all agenda files."
3797 "Font-lock settings for highlighting in Org-mode."
3802 "Non-nil means fontify only the stars in each headline.
3803 When nil, the entire headline is fontified.
3804 Changing it requires restart of `font-lock-mode' to become effective
3805 also in regions already fontified."
3810 "Non-nil means, hide the first N-1 stars in a headline.
3811 This works by using the face `org-hide' for these stars. This
3812 face is white for a light background, and black for a dark
3813 background. You may have to customize the face `org-hide' to
3814 make this work.
3815 Changing it requires restart of `font-lock-mode' to become effective
3816 also in regions already fontified.
3817 You may also set this on a per-file basis by adding one of the following
3818 lines to the buffer:
3820 #+STARTUP: hidestars
3821 #+STARTUP: showstars"
3826 "Non-nil means, change the face of a headline if it is marked DONE.
3827 Normally, only the TODO/DONE keyword indicates the state of a headline.
3828 When this is non-nil, the headline after the keyword is set to the
3829 `org-headline-done' as an additional indication."
3834 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3835 Changing this variable requires a restart of Emacs to take effect."
3840 "Non-nil means, fontify what is treated specially by the exporters."
3845 "Non-nil mean font-lock should hide the emphasis marker characters."
3856 "Set variable and compute the emphasis regular expression."
3860 org-emphasis-alist org-emphasis-regexp-components)
3873 ;; make sure special characters appear at the right position in the class
3885 ;; Make the regexp
3893 body1
3905 body1
3913 "Components used to build the regular expression for emphasis.
3914 This is a list with 6 entries. Terminology: In an emphasis string
3918 specify what is allowed/forbidden in each part:
3920 pre Chars allowed as prematch. Beginning of line will be allowed too.
3921 post Chars allowed as postmatch. End of line will be allowed too.
3922 border The chars *forbidden* as border characters.
3924 non-shy groups here, and don't allow newline here.
3925 newline The maximum number of newlines allowed in an emphasis exp.
3927 Use customize to modify this, or restart Emacs after changing it."
3945 )
3946 "Special syntax for emphasized text.
3947 Text starting and ending with a special character will be emphasized, for
3948 example *bold*, _underlined_ and /italic/. This variable sets the marker
3949 characters, the face to be used by font-lock for highlighting in Org-mode
3950 Emacs buffers, and the HTML tags to be used for this.
3951 Use customize to modify this, or restart Emacs after changing it."
3964 ;;; The faces
3967 "Faces in Org-mode."
3972 "Make a compatible face specification.
3973 If INHERITS is an existing face and if the Emacs version supports it,
3974 just inherit the face. If not, use SPECS to define the face.
3975 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3976 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3977 to the top of the list. The `min-colors' attribute will be removed from
3978 any other entries, and any resulting duplicates will be removed entirely."
3982 ;; In Emacs 23, we use inheritance where possible.
3983 ;; We only do this in Emacs 23, because only there the outline
3984 ;; faces have been changed to the original org-mode-level-faces.
3987 ;; These do not understand the `min-colors' attribute.
4006 "Face used to hide leading stars in headlines.
4007 The forground color of this face should be equal to the background
4008 color of the frame."
4019 "Face used for level 1 headlines."
4029 "Face used for level 2 headlines."
4041 "Face used for level 3 headlines."
4053 "Face used for level 4 headlines."
4061 "Face used for level 5 headlines."
4069 "Face used for level 6 headlines."
4077 "Face used for level 7 headlines."
4085 "Face used for level 8 headlines."
4093 "Face used for special keywords."
4104 "Face used for drawers."
4108 "Face used for the value of a property."
4120 "Face for column display of entry properties."
4124 ;; Make sure that a fixed-width face is used when we have a column table.
4136 "Face for deadlines and TODO keywords."
4149 "Face for headline with the ARCHIVE tag."
4156 "Face for links."
4163 "Face for the ellipsis in folded text."
4170 "Face for links."
4177 "Face for links."
4184 "Face for links."
4189 "Face for tags."
4199 "Face for TODO keywords."
4208 "Face used for todo keywords that indicate DONE items."
4216 "Face used to indicate that a headline is DONE.
4217 This face is only used if `org-fontify-done-headline' is set. If applies
4218 to the part of the headline after the DONE keyword."
4222 "Faces for specific TODO keywords.
4223 This is a list of cons cells, with TODO keywords in the car
4224 and faces in the cdr. The face can be a symbol, or a property
4241 "Face used for tables."
4251 "Face for formulas."
4264 "Face for fixed-with text like code snippets."
4278 "Face for fixed-with text like code snippets."
4290 "Face used in agenda for captions and dates."
4299 "Face for items scheduled for a certain day."
4309 "Face for items scheduled previously, and not yet done."
4319 "Face for items scheduled previously, and not yet done."
4326 "Faces for showing deadlines in the agenda.
4327 This is a list of cons cells. The cdr of each cell is a face to be used,
4329 Each car is a fraction of the head-warning time that must have passed for
4330 this the face in the cdr to be used for display. The numbers must be
4331 given in descending order. The head-warning time is normally taken
4332 from `org-deadline-warning-days', but can also be specified in the deadline
4333 timestamp itself, like this:
4335 DEADLINE: <2007-08-13 Mon -8d>
4337 You may use d for days, w for weeks, m for months and y for years. Months
4338 and years will only be treated in an approximate fashion (30.4 days for a
4339 month and 365.24 days for a year)."
4347 ;; FIXME: this is not a good face yet.
4356 "Face for showing the agenda restriction lock."
4364 "Face used for time grids."
4369 org-level-5 org-level-6 org-level-7 org-level-8
4370 ))
4373 "The number of different faces to be used for headlines.
4374 Org-mode defines 8 different headline faces, so this can be at most 8.
4375 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4379 ;;; Functions and variables from ther packages
4380 ;; Declared here to avoid compiler warnings
4386 ;; XEmacs only
4392 ;; Emacs only
4395 ;; Various packages
4396 ;; FIXME: get the argument lists for the UNKNOWN stuff
4450 ;;; Variables for pre-computed regular expressions, all buffer local
4465 "Matches a headline and puts everything into groups:
4466 group 1: the stars
4467 group 2: The todo keyword, maybe
4468 group 3: Priority cookie
4469 group 4: True headline
4473 "Matches a headline and puts TODO state into group 2 if present.
4518 rear-nonsticky t mouse-map t fontified t)
4525 s)
4532 s)
4541 "Modified `buffer-invisibility-spec' for Emacs 21.
4542 Some ops with invisible text do not work correctly on Emacs 21. For these
4543 we turn off invisibility temporarily. Use this in a `let' form."
4547 "Make VAR local in current buffer and set it to VALUE."
4551 "Check if the current buffer is in Org-mode."
4555 "Return the last element of LIST."
4588 "Variable associated with STARTUP options for org-mode.
4589 Each element is a list of three items: The startup options as written
4590 in the #+STARTUP line, the corresponding variable, and the value to
4591 set this variable to if the option is found. An optional forth element PUSH
4595 "Precompute regular expressions for current buffer."
4610 kwds kws0 kwsa key log value cat arch tags const links hw dws
4611 tail sep kws1 prio props drawers)
4635 links)))
4641 props)))
4648 l var val)
4663 )))
4677 ;; Process the TODO keywords
4679 ;; Use the global values as if they had been given locally.
4690 kwsa nil
4693 ;; 1 2
4701 kw)
4703 kws0)
4720 ;; Process the constants
4728 ;; Process the tags.
4738 tgs))
4746 ;; Compute the regular expressions and other local variables
4751 org-drawer-regexp
4755 org-not-done-keywords
4757 org-todo-regexp
4760 org-not-done-regexp
4764 org-todo-line-regexp
4768 org-complex-heading-regexp
4773 org-nl-done-regexp
4777 org-todo-line-tags-regexp
4782 org-looking-at-done-regexp
4787 org-deadline-time-regexp
4789 org-deadline-line-regexp
4791 org-scheduled-regexp
4793 org-scheduled-time-regexp
4795 org-closed-time-regexp
4797 org-keyword-time-regexp
4803 org-keyword-time-not-clock-regexp
4809 org-maybe-keyword-time-regexp
4815 org-planning-or-clock-line-re
4820 )
4825 "Extract the log state setting from a TODO keyword string.
4839 "Remove a pair of parenthesis at the end of each string in LIST."
4843 x))
4844 list))
4846 ;; FIXME: this could be done much better, using second characters etc.
4848 "Assign fast keys to a keyword-key alist.
4849 Respect keys that are already there."
4859 ;; automatically assign a character.
4871 ;;; Some variables ujsed in various places
4876 "Function to be called when `C-c C-c' is used.
4880 ;; FIXME: Occasionally check by commenting these, to make sure
4881 ;; no other functions uses these, forgetting to let-bind them.
4888 ;; Defined somewhere in this file, but used before definition.
4901 ;;;; Emacs/XEmacs compatibility
4903 ;; Overlay compatibility functions
4921 "Make overlay OVL display TEXT with face FACE."
4931 "Make overlay OVL display TEXT with face FACE."
4954 "Find all overlays specifying PROP at POS or point.
4955 If DELETE is non-nil, delete all those overlays."
4957 ov found)
4961 found))
4963 ;; Region compatibility
4966 "Add-hook, compatible with both Emacsen."
4975 "Is `transient-mark-mode' on and the region active?
4976 Works on both Emacs and XEmacs."
4978 nil
4985 ;; Invisibility compatibility
4988 "Add elements to `buffer-invisibility-spec'.
4989 See documentation for `buffer-invisibility-spec' for the kind of elements
4990 that can be added."
5001 "Remove elements from `buffer-invisibility-spec'."
5009 "Is ARG a member of `buffer-invisibility-spec'?"
5012 nil))
5014 ;;;; Define the Org-mode
5017 (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."))
5020 ;; We use a before-change function to check if a table might need
5021 ;; an update.
5023 "Indicates that a table might need an update.
5024 This variable is set by `org-before-change-function'.
5033 ;;;###autoload
5035 "Outline-based notes management and organizer, alias
5038 Org-mode develops organizational tasks around a NOTES file which
5039 contains information about projects as plain text. Org-mode is
5040 implemented on top of outline-mode, which is ideal to keep the content
5041 of large files well structured. It supports ToDo items, deadlines and
5042 time stamps, which magically appear in the diary listing of the Emacs
5043 calendar. Tables are easily created with a built-in table editor.
5044 Plain text URL-like links connect to websites, emails (VM), Usenet
5045 messages (Gnus), BBDB entries, and any files related to the project.
5046 For printing and sharing of notes, an Org-mode file (or a part of it)
5047 can be exported as a structured ASCII or HTML file.
5049 The following commands are available:
5053 ;; Get rid of Outline menus, they are not needed
5054 ;; Need to do this here because define-derived-mode sets up
5055 ;; the keymap so late. Still, it is a waste to call this each time
5056 ;; we switch another buffer into org-mode.
5059 ;; Assume this is Greg's port, it used easymenu
5083 org-display-table 4
5086 org-ellipsis)))
5090 ;; Calc embedded
5097 ;; Activate before-change-function
5101 ;; Check for running clock before killing a buffer
5103 ;; Paragraphs and auto-filling
5108 ;; Comment characters
5109 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
5112 ;; Align options lines
5114 'align-mode-rules-list
5119 ;; Imenu
5123 ;; Make isearch reveal context
5126 ;; Emacs 21 and XEmacs make use of the hook
5128 ;; Emacs 22 deals with this through a special variable
5132 ;; If empty file that did not turn on org-mode automatically, make it to.
5154 "Call COMMAND interactively, but pretend prefix are was ARG."
5160 ;; works also in narrowed buffer, because we start at 1, not point-min
5164 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5174 "Add text properties to entire string, from beginning to end.
5175 PLIST may be a list of properties, PROPS are individual properties and values
5176 that will be added to PLIST. Returns the string that was modified."
5179 string)
5183 ;;;; Font-Lock stuff, including the activators
5188 (org-defkey org-mouse-map
5189 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5190 (when org-mouse-1-follows-link
5191 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5192 (when org-tab-follows-link
5193 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5194 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5195 (when org-return-follows-link
5196 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5197 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5199 (require 'font-lock)
5202 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5203 "shell" "elisp"))
5204 (defvar org-link-re-with-space nil
5205 "Matches a link with spaces, optional angular brackets around it.")
5206 (defvar org-link-re-with-space2 nil
5207 "Matches a link with spaces, optional angular brackets around it.")
5208 (defvar org-angle-link-re nil
5209 "Matches link with angular brackets, spaces are allowed.")
5210 (defvar org-plain-link-re nil
5211 "Matches plain link, without spaces.")
5212 (defvar org-bracket-link-regexp nil
5213 "Matches a link in double brackets.")
5214 (defvar org-bracket-link-analytic-regexp nil
5215 "Regular expression used to analyze links.
5216 Here is what the match groups contain after a match:
5217 1: http:
5218 2: http
5219 3: path
5220 4: [desc]
5221 5: desc")
5222 (defvar org-any-link-re nil
5223 "Regular expression matching any link.")
5225 (defun org-make-link-regexps ()
5226 "Update the link regular expressions.
5227 This should be called after the variable `org-link-types' has changed."
5228 (setq org-link-re-with-space
5229 (concat
5232 "[^" org-non-link-chars "]*"
5234 org-link-re-with-space2
5235 (concat
5240 org-angle-link-re
5241 (concat
5244 "[^" org-non-link-chars "]*"
5246 org-plain-link-re
5247 (concat
5250 org-bracket-link-regexp
5252 org-bracket-link-analytic-regexp
5253 (concat
5260 org-any-link-re
5265 (org-make-link-regexps)
5268 "Regular expression for fast time stamp matching.")
5270 "Regular expression for fast time stamp matching.")
5271 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5272 "Regular expression matching time strings for analysis.
5273 This one does not require the space after the date, so it can be used
5274 on a string that terminates immediately after the date.")
5275 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5276 "Regular expression matching time strings for analysis.")
5278 "Regular expression matching time stamps, with groups.")
5280 "Regular expression matching time stamps (also [..]), with groups.")
5281 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5282 "Regular expression matching a time stamp range.")
5283 (defconst org-tr-regexp-both
5284 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5285 "Regular expression matching a time stamp range.")
5288 "Regular expression matching a time stamp or time stamp range.")
5291 "Regular expression matching a time stamp or time stamp range.
5292 The time stamps may be either active or inactive.")
5294 (defvar org-emph-face nil)
5296 (defun org-do-emphasis-faces (limit)
5297 "Run through the buffer and add overlays to links."
5298 (let (rtn)
5299 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5300 (if (not (= (char-after (match-beginning 3))
5301 (char-after (match-beginning 4))))
5302 (progn
5303 (setq rtn t)
5304 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5305 'face
5306 (nth 1 (assoc (match-string 3)
5307 org-emphasis-alist)))
5308 (add-text-properties (match-beginning 2) (match-end 2)
5309 '(font-lock-multiline t))
5310 (when org-hide-emphasis-markers
5311 (add-text-properties (match-end 4) (match-beginning 5)
5312 '(invisible org-link))
5313 (add-text-properties (match-beginning 3) (match-end 3)
5314 '(invisible org-link)))))
5315 (backward-char 1))
5316 rtn))
5318 (defun org-emphasize (&optional char)
5319 "Insert or change an emphasis, i.e. a font like bold or italic.
5320 If there is an active region, change that region to a new emphasis.
5321 If there is no region, just insert the marker characters and position
5322 the cursor between them.
5323 CHAR should be either the marker character, or the first character of the
5324 HTML tag associated with that emphasis. If CHAR is a space, the means
5325 to remove the emphasis of the selected region.
5326 If char is not given (for example in an interactive call) it
5327 will be prompted for."
5328 (interactive)
5329 (let ((eal org-emphasis-alist) e det
5330 (erc org-emphasis-regexp-components)
5331 (prompt "")
5332 (string "") beg end move tag c s)
5333 (if (org-region-active-p)
5334 (setq beg (region-beginning) end (region-end)
5335 string (buffer-substring beg end))
5336 (setq move t))
5338 (while (setq e (pop eal))
5339 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5340 c (aref tag 0))
5341 (push (cons c (string-to-char (car e))) det)
5342 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5343 (substring tag 1)))))
5344 (unless char
5345 (message "%s" (concat "Emphasis marker or tag:" prompt))
5346 (setq char (read-char-exclusive)))
5347 (setq char (or (cdr (assoc char det)) char))
5348 (if (equal char ?\ )
5349 (setq s "" move nil)
5350 (unless (assoc (char-to-string char) org-emphasis-alist)
5352 (setq s (char-to-string char)))
5353 (while (and (> (length string) 1)
5354 (equal (substring string 0 1) (substring string -1))
5355 (assoc (substring string 0 1) org-emphasis-alist))
5356 (setq string (substring string 1 -1)))
5357 (setq string (concat s string s))
5358 (if beg (delete-region beg end))
5359 (unless (or (bolp)
5361 (char-to-string (char-before (point)))))
5362 (insert " "))
5364 (char-to-string (char-after (point))))
5365 (insert " ") (backward-char 1))
5366 (insert string)
5367 (and move (backward-char 1))))
5369 (defconst org-nonsticky-props
5370 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5373 (defun org-activate-plain-links (limit)
5374 "Run through the buffer and add overlays to links."
5375 (catch 'exit
5376 (let (f)
5377 (while (re-search-forward org-plain-link-re limit t)
5378 (setq f (get-text-property (match-beginning 0) 'face))
5379 (if (or (eq f 'org-tag)
5380 (and (listp f) (memq 'org-tag f)))
5381 nil
5382 (add-text-properties (match-beginning 0) (match-end 0)
5383 (list 'mouse-face 'highlight
5384 'rear-nonsticky org-nonsticky-props
5385 'keymap org-mouse-map
5386 ))
5387 (throw 'exit t))))))
5389 (defun org-activate-code (limit)
5391 (unless (get-text-property (match-beginning 1) 'face)
5392 (remove-text-properties (match-beginning 0) (match-end 0)
5393 '(display t invisible t intangible t))
5394 t)))
5396 (defun org-activate-angle-links (limit)
5397 "Run through the buffer and add overlays to links."
5398 (if (re-search-forward org-angle-link-re limit t)
5399 (progn
5400 (add-text-properties (match-beginning 0) (match-end 0)
5401 (list 'mouse-face 'highlight
5402 'rear-nonsticky org-nonsticky-props
5403 'keymap org-mouse-map
5404 ))
5405 t)))
5407 (defmacro org-maybe-intangible (props)
5408 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5409 In emacs 21, invisible text is not avoided by the command loop, so the
5410 intangible property is needed to make sure point skips this text.
5411 In Emacs 22, this is not necessary. The intangible text property has
5412 led to problems with flyspell. These problems are fixed in flyspell.el,
5413 but we still avoid setting the property in Emacs 22 and later.
5414 We use a macro so that the test can happen at compilation time."
5415 (if (< emacs-major-version 22)
5416 `(append '(intangible t) ,props)
5417 props))
5419 (defun org-activate-bracket-links (limit)
5420 "Run through the buffer and add overlays to bracketed links."
5421 (if (re-search-forward org-bracket-link-regexp limit t)
5422 (let* ((help (concat "LINK: "
5423 (org-match-string-no-properties 1)))
5424 ;; FIXME: above we should remove the escapes.
5425 ;; but that requires another match, protecting match data,
5426 ;; a lot of overhead for font-lock.
5427 (ip (org-maybe-intangible
5428 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5429 'keymap org-mouse-map 'mouse-face 'highlight
5430 'font-lock-multiline t 'help-echo help)))
5431 (vp (list 'rear-nonsticky org-nonsticky-props
5432 'keymap org-mouse-map 'mouse-face 'highlight
5433 ' font-lock-multiline t 'help-echo help)))
5434 ;; We need to remove the invisible property here. Table narrowing
5435 ;; may have made some of this invisible.
5436 (remove-text-properties (match-beginning 0) (match-end 0)
5437 '(invisible nil))
5438 (if (match-end 3)
5439 (progn
5440 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5441 (add-text-properties (match-beginning 3) (match-end 3) vp)
5442 (add-text-properties (match-end 3) (match-end 0) ip))
5443 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5444 (add-text-properties (match-beginning 1) (match-end 1) vp)
5445 (add-text-properties (match-end 1) (match-end 0) ip))
5446 t)))
5448 (defun org-activate-dates (limit)
5449 "Run through the buffer and add overlays to dates."
5450 (if (re-search-forward org-tsr-regexp-both limit t)
5451 (progn
5452 (add-text-properties (match-beginning 0) (match-end 0)
5453 (list 'mouse-face 'highlight
5454 'rear-nonsticky org-nonsticky-props
5455 'keymap org-mouse-map))
5456 (when org-display-custom-times
5457 (if (match-end 3)
5458 (org-display-custom-time (match-beginning 3) (match-end 3)))
5459 (org-display-custom-time (match-beginning 1) (match-end 1)))
5460 t)))
5462 (defvar org-target-link-regexp nil
5463 "Regular expression matching radio targets in plain text.")
5465 "Regular expression matching a link target.")
5467 "Regular expression matching a radio target.")
5468 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5469 "Regular expression matching any target.")
5471 (defun org-activate-target-links (limit)
5472 "Run through the buffer and add overlays to target matches."
5473 (when org-target-link-regexp
5474 (let ((case-fold-search t))
5475 (if (re-search-forward org-target-link-regexp limit t)
5476 (progn
5477 (add-text-properties (match-beginning 0) (match-end 0)
5478 (list 'mouse-face 'highlight
5479 'rear-nonsticky org-nonsticky-props
5480 'keymap org-mouse-map
5481 'help-echo "Radio target link"
5482 'org-linked-text t))
5483 t)))))
5485 (defun org-update-radio-target-regexp ()
5486 "Find all radio targets in this file and update the regular expression."
5487 (interactive)
5488 (when (memq 'radio org-activate-links)
5489 (setq org-target-link-regexp
5490 (org-make-target-link-regexp (org-all-targets 'radio)))
5491 (org-restart-font-lock)))
5493 (defun org-hide-wide-columns (limit)
5494 (let (s e)
5495 (setq s (text-property-any (point) (or limit (point-max))
5496 'org-cwidth t))
5497 (when s
5498 (setq e (next-single-property-change s 'org-cwidth))
5499 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5500 (goto-char e)
5501 t)))
5503 (defvar org-latex-and-specials-regexp nil
5504 "Regular expression for highlighting export special stuff.")
5505 (defvar org-match-substring-regexp)
5506 (defvar org-match-substring-with-braces-regexp)
5507 (defvar org-export-html-special-string-regexps)
5509 (defun org-compute-latex-and-specials-regexp ()
5510 "Compute regular expression for stuff treated specially by exporters."
5511 (if (not org-highlight-latex-fragments-and-specials)
5512 (org-set-local 'org-latex-and-specials-regexp nil)
5513 (let*
5514 ((matchers (plist-get org-format-latex-options :matchers))
5515 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5516 org-latex-regexps)))
5517 (options (org-combine-plists (org-default-export-plist)
5518 (org-infile-export-plist)))
5519 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5520 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5521 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5522 (org-export-html-expand (plist-get options :expand-quoted-html))
5523 (org-export-with-special-strings (plist-get options :special-strings))
5524 (re-sub
5525 (cond
5526 ((equal org-export-with-sub-superscripts '{})
5527 (list org-match-substring-with-braces-regexp))
5528 (org-export-with-sub-superscripts
5529 (list org-match-substring-regexp))
5530 (t nil)))
5531 (re-latex
5532 (if org-export-with-LaTeX-fragments
5533 (mapcar (lambda (x) (nth 1 x)) latexs)))
5534 (re-macros
5535 (if org-export-with-TeX-macros
5537 (regexp-opt
5538 (append (mapcar 'car org-html-entities)
5539 (if (boundp 'org-latex-entities)
5540 org-latex-entities nil))
5541 'words))) ; FIXME
5542 ))
5544 (re-special (if org-export-with-special-strings
5545 (mapcar (lambda (x) (car x))
5546 org-export-html-special-string-regexps)))
5547 (re-rest
5548 (delq nil
5549 (list
5551 ))))
5552 (org-set-local
5553 'org-latex-and-specials-regexp
5554 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5557 (defface org-latex-and-export-specials
5558 (let ((font (cond ((assq :inherit custom-face-attributes)
5559 '(:inherit underline))
5560 (t '(:underline t)))))
5561 `((((class grayscale) (background light))
5562 (:foreground "DimGray" ,@font))
5563 (((class grayscale) (background dark))
5564 (:foreground "LightGray" ,@font))
5565 (((class color) (background light))
5566 (:foreground "SaddleBrown"))
5567 (((class color) (background dark))
5568 (:foreground "burlywood"))
5569 (t (,@font))))
5570 "Face used to highlight math latex and other special exporter stuff."
5571 :group 'org-faces)
5573 (defun org-do-latex-and-special-faces (limit)
5574 "Run through the buffer and add overlays to links."
5575 (when org-latex-and-specials-regexp
5576 (let (rtn d)
5577 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5578 limit t))
5579 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5580 'face))
5581 '(org-code org-verbatim underline)))
5582 (progn
5583 (setq rtn t
5584 d (cond ((member (char-after (1+ (match-beginning 0)))
5585 '(?_ ?^)) 1)
5586 (t 0)))
5587 (font-lock-prepend-text-property
5588 (+ d (match-beginning 0)) (match-end 0)
5589 'face 'org-latex-and-export-specials)
5590 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5591 '(font-lock-multiline t)))))
5592 rtn)))
5594 (defun org-restart-font-lock ()
5595 "Restart font-lock-mode, to force refontification."
5596 (when (and (boundp 'font-lock-mode) font-lock-mode)
5597 (font-lock-mode -1)
5598 (font-lock-mode 1)))
5600 (defun org-all-targets (&optional radio)
5601 "Return a list of all targets in this file.
5602 With optional argument RADIO, only find radio targets."
5603 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5604 rtn)
5605 (save-excursion
5606 (goto-char (point-min))
5607 (while (re-search-forward re nil t)
5608 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5609 rtn)))
5611 (defun org-make-target-link-regexp (targets)
5612 "Make regular expression matching all strings in TARGETS.
5613 The regular expression finds the targets also if there is a line break
5614 between words."
5615 (and targets
5616 (concat
5618 (mapconcat
5619 (lambda (x)
5620 (while (string-match " +" x)
5622 x)
5623 targets
5627 (defun org-activate-tags (limit)
5629 (progn
5630 (add-text-properties (match-beginning 1) (match-end 1)
5631 (list 'mouse-face 'highlight
5632 'rear-nonsticky org-nonsticky-props
5633 'keymap org-mouse-map))
5634 t)))
5636 (defun org-outline-level ()
5637 (save-excursion
5638 (looking-at outline-regexp)
5639 (if (match-beginning 1)
5640 (+ (org-get-string-indentation (match-string 1)) 1000)
5641 (1- (- (match-end 0) (match-beginning 0))))))
5643 (defvar org-font-lock-keywords nil)
5646 "Regular expression matching a property line.")
5648 (defun org-set-font-lock-defaults ()
5649 (let* ((em org-fontify-emphasized-text)
5650 (lk org-activate-links)
5651 (org-font-lock-extra-keywords
5652 (list
5653 ;; Headlines
5655 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5656 ;; Table lines
5658 (1 'org-table t))
5659 ;; Table internals
5663 ;; Drawers
5664 (list org-drawer-regexp '(0 'org-special-keyword t))
5666 ;; Properties
5667 (list org-property-re
5668 '(1 'org-special-keyword t)
5669 '(3 'org-property-value t))
5670 (if org-format-transports-properties-p
5672 ;; Links
5673 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5674 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5675 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5676 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5677 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5678 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5680 '(org-hide-wide-columns (0 nil append))
5681 ;; TODO lines
5683 '(1 (org-get-todo-face 1) t))
5684 ;; DONE
5685 (if org-fontify-done-headline
5689 '(2 'org-headline-done t))
5690 nil)
5691 ;; Priorities
5693 ;; Special keywords
5698 ;; Emphasis
5699 (if em
5700 (if (featurep 'xemacs)
5701 '(org-do-emphasis-faces (0 nil append))
5702 '(org-do-emphasis-faces)))
5703 ;; Checkboxes
5705 2 'bold prepend)
5706 (if org-provide-checkbox-statistics
5708 (0 (org-get-checkbox-statistics-face) t)))
5710 '(1 'org-archived prepend))
5711 ;; Specials
5712 '(org-do-latex-and-special-faces)
5713 ;; Code
5714 '(org-activate-code (1 'org-code t))
5715 ;; COMMENT
5718 '(1 'org-special-keyword t))
5719 '("^#.*" (0 'font-lock-comment-face t))
5720 )))
5721 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5722 ;; Now set the full font-lock-keywords
5723 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5724 (org-set-local 'font-lock-defaults
5725 '(org-font-lock-keywords t nil nil backward-paragraph))
5726 (kill-local-variable 'font-lock-keywords) nil))
5728 (defvar org-m nil)
5729 (defvar org-l nil)
5730 (defvar org-f nil)
5731 (defun org-get-level-face (n)
5732 "Get the right face for match N in font-lock matching of healdines."
5733 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5734 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5735 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5736 (cond
5737 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5738 ((eq n 2) org-f)
5739 (t (if org-level-color-stars-only nil org-f))))
5741 (defun org-get-todo-face (kwd)
5742 "Get the right face for a TODO keyword KWD.
5743 If KWD is a number, get the corresponding match group."
5744 (if (numberp kwd) (setq kwd (match-string kwd)))
5745 (or (cdr (assoc kwd org-todo-keyword-faces))
5746 (and (member kwd org-done-keywords) 'org-done)
5747 'org-todo))
5749 (defun org-unfontify-region (beg end &optional maybe_loudly)
5750 "Remove fontification and activation overlays from links."
5751 (font-lock-default-unfontify-region beg end)
5752 (let* ((buffer-undo-list t)
5753 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5754 (inhibit-modification-hooks t)
5755 deactivate-mark buffer-file-name buffer-file-truename)
5756 (remove-text-properties beg end
5757 '(mouse-face t keymap t org-linked-text t
5758 invisible t intangible t))))
5760 ;;;; Visibility cycling, including org-goto and indirect buffer
5762 ;;; Cycling
5764 (defvar org-cycle-global-status nil)
5765 (make-variable-buffer-local 'org-cycle-global-status)
5766 (defvar org-cycle-subtree-status nil)
5767 (make-variable-buffer-local 'org-cycle-subtree-status)
5769 ;;;###autoload
5770 (defun org-cycle (&optional arg)
5771 "Visibility cycling for Org-mode.
5773 - When this function is called with a prefix argument, rotate the entire
5774 buffer through 3 states (global cycling)
5775 1. OVERVIEW: Show only top-level headlines.
5776 2. CONTENTS: Show all headlines of all levels, but no body text.
5777 3. SHOW ALL: Show everything.
5779 - When point is at the beginning of a headline, rotate the subtree started
5780 by this line through 3 different states (local cycling)
5781 1. FOLDED: Only the main headline is shown.
5782 2. CHILDREN: The main headline and the direct children are shown.
5783 From this state, you can move to one of the children
5784 and zoom in further.
5785 3. SUBTREE: Show the entire subtree, including body text.
5787 - When there is a numeric prefix, go up to a heading with level ARG, do
5788 a `show-subtree' and return to the previous cursor position. If ARG
5789 is negative, go up that many levels.
5791 - When point is not at the beginning of a headline, execute
5792 `indent-relative', like TAB normally does. See the option
5793 `org-cycle-emulate-tab' for details.
5795 - Special case: if point is at the beginning of the buffer and there is
5796 no headline in line 1, this function will act as if called with prefix arg.
5797 But only if also the variable `org-cycle-global-at-bob' is t."
5798 (interactive "P")
5799 (org-load-modules-maybe)
5800 (let* ((outline-regexp
5801 (if (and (org-mode-p) org-cycle-include-plain-lists)
5803 outline-regexp))
5804 (bob-special (and org-cycle-global-at-bob (bobp)
5805 (not (looking-at outline-regexp))))
5806 (org-cycle-hook
5807 (if bob-special
5808 (delq 'org-optimize-window-after-visibility-change
5809 (copy-sequence org-cycle-hook))
5810 org-cycle-hook))
5811 (pos (point)))
5813 (if (or bob-special (equal arg '(4)))
5814 ;; special case: use global cycling
5815 (setq arg t))
5817 (cond
5819 ((org-at-table-p 'any)
5820 ;; Enter the table or move to the next field in the table
5821 (or (org-table-recognize-table.el)
5822 (progn
5823 (if arg (org-table-edit-field t)
5824 (org-table-justify-field-maybe)
5825 (call-interactively 'org-table-next-field)))))
5827 ((eq arg t) ;; Global cycling
5829 (cond
5830 ((and (eq last-command this-command)
5831 (eq org-cycle-global-status 'overview))
5832 ;; We just created the overview - now do table of contents
5833 ;; This can be slow in very large buffers, so indicate action
5834 (message "CONTENTS...")
5835 (org-content)
5836 (message "CONTENTS...done")
5837 (setq org-cycle-global-status 'contents)
5838 (run-hook-with-args 'org-cycle-hook 'contents))
5840 ((and (eq last-command this-command)
5841 (eq org-cycle-global-status 'contents))
5842 ;; We just showed the table of contents - now show everything
5843 (show-all)
5844 (message "SHOW ALL")
5845 (setq org-cycle-global-status 'all)
5846 (run-hook-with-args 'org-cycle-hook 'all))
5848 (t
5849 ;; Default action: go to overview
5850 (org-overview)
5851 (message "OVERVIEW")
5852 (setq org-cycle-global-status 'overview)
5853 (run-hook-with-args 'org-cycle-hook 'overview))))
5855 ((and org-drawers org-drawer-regexp
5856 (save-excursion
5857 (beginning-of-line 1)
5858 (looking-at org-drawer-regexp)))
5859 ;; Toggle block visibility
5860 (org-flag-drawer
5861 (not (get-char-property (match-end 0) 'invisible))))
5863 ((integerp arg)
5864 ;; Show-subtree, ARG levels up from here.
5865 (save-excursion
5866 (org-back-to-heading)
5867 (outline-up-heading (if (< arg 0) (- arg)
5868 (- (funcall outline-level) arg)))
5869 (org-show-subtree)))
5871 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5872 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5873 ;; At a heading: rotate between three different views
5874 (org-back-to-heading)
5875 (let ((goal-column 0) eoh eol eos)
5876 ;; First, some boundaries
5877 (save-excursion
5878 (org-back-to-heading)
5879 (save-excursion
5880 (beginning-of-line 2)
5881 (while (and (not (eobp)) ;; this is like `next-line'
5882 (get-char-property (1- (point)) 'invisible))
5883 (beginning-of-line 2)) (setq eol (point)))
5884 (outline-end-of-heading) (setq eoh (point))
5885 (org-end-of-subtree t)
5886 (unless (eobp)
5888 (beginning-of-line 1) ; in case this is an item
5889 )
5890 (setq eos (1- (point))))
5891 ;; Find out what to do next and set `this-command'
5892 (cond
5893 ((= eos eoh)
5894 ;; Nothing is hidden behind this heading
5895 (message "EMPTY ENTRY")
5896 (setq org-cycle-subtree-status nil)
5897 (save-excursion
5898 (goto-char eos)
5899 (outline-next-heading)
5900 (if (org-invisible-p) (org-flag-heading nil))))
5901 ((or (>= eol eos)
5903 ;; Entire subtree is hidden in one line: open it
5904 (org-show-entry)
5905 (show-children)
5906 (message "CHILDREN")
5907 (save-excursion
5908 (goto-char eos)
5909 (outline-next-heading)
5910 (if (org-invisible-p) (org-flag-heading nil)))
5911 (setq org-cycle-subtree-status 'children)
5912 (run-hook-with-args 'org-cycle-hook 'children))
5913 ((and (eq last-command this-command)
5914 (eq org-cycle-subtree-status 'children))
5915 ;; We just showed the children, now show everything.
5916 (org-show-subtree)
5917 (message "SUBTREE")
5918 (setq org-cycle-subtree-status 'subtree)
5919 (run-hook-with-args 'org-cycle-hook 'subtree))
5920 (t
5921 ;; Default action: hide the subtree.
5922 (hide-subtree)
5923 (message "FOLDED")
5924 (setq org-cycle-subtree-status 'folded)
5925 (run-hook-with-args 'org-cycle-hook 'folded)))))
5927 ;; TAB emulation
5928 (buffer-read-only (org-back-to-heading))
5930 ((org-try-cdlatex-tab))
5932 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5933 (or (not (bolp))
5934 (not (looking-at outline-regexp))))
5937 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5939 (or (and (eq org-cycle-emulate-tab 'white)
5940 (= (match-end 0) (point-at-eol)))
5941 (and (eq org-cycle-emulate-tab 'whitestart)
5942 (>= (match-end 0) pos))))
5943 t
5944 (eq org-cycle-emulate-tab t))
5947 ; (point-at-bol) (point))))
5948 ; (progn
5949 ; (beginning-of-line 1)
5953 (t (save-excursion
5954 (org-back-to-heading)
5955 (org-cycle))))))
5957 ;;;###autoload
5958 (defun org-global-cycle (&optional arg)
5959 "Cycle the global visibility. For details see `org-cycle'."
5960 (interactive "P")
5961 (let ((org-cycle-include-plain-lists
5962 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5963 (if (integerp arg)
5964 (progn
5965 (show-all)
5966 (hide-sublevels arg)
5967 (setq org-cycle-global-status 'contents))
5968 (org-cycle '(4)))))
5970 (defun org-overview ()
5971 "Switch to overview mode, shoing only top-level headlines.
5972 Really, this shows all headlines with level equal or greater than the level
5973 of the first headline in the buffer. This is important, because if the
5974 first headline is not level one, then (hide-sublevels 1) gives confusing
5975 results."
5976 (interactive)
5977 (let ((level (save-excursion
5978 (goto-char (point-min))
5979 (if (re-search-forward (concat "^" outline-regexp) nil t)
5980 (progn
5981 (goto-char (match-beginning 0))
5982 (funcall outline-level))))))
5983 (and level (hide-sublevels level))))
5985 (defun org-content (&optional arg)
5986 "Show all headlines in the buffer, like a table of contents.
5987 With numerical argument N, show content up to level N."
5988 (interactive "P")
5989 (save-excursion
5990 ;; Visit all headings and show their offspring
5991 (and (integerp arg) (org-overview))
5992 (goto-char (point-max))
5993 (catch 'exit
5994 (while (and (progn (condition-case nil
5995 (outline-previous-visible-heading 1)
5996 (error (goto-char (point-min))))
5997 t)
5998 (looking-at outline-regexp))
5999 (if (integerp arg)
6000 (show-children (1- arg))
6001 (show-branches))
6002 (if (bobp) (throw 'exit nil))))))
6005 (defun org-optimize-window-after-visibility-change (state)
6006 "Adjust the window after a change in outline visibility.
6007 This function is the default value of the hook `org-cycle-hook'."
6008 (when (get-buffer-window (current-buffer))
6009 (cond
6010 ; ((eq state 'overview) (org-first-headline-recenter 1))
6011 ; ((eq state 'overview) (org-beginning-of-line))
6012 ((eq state 'content) nil)
6013 ((eq state 'all) nil)
6014 ((eq state 'folded) nil)
6015 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6016 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6018 (defun org-compact-display-after-subtree-move ()
6019 (let (beg end)
6020 (save-excursion
6021 (if (org-up-heading-safe)
6022 (progn
6023 (hide-subtree)
6024 (show-entry)
6025 (show-children)
6026 (org-cycle-show-empty-lines 'children)
6027 (org-cycle-hide-drawers 'children))
6028 (org-overview)))))
6030 (defun org-cycle-show-empty-lines (state)
6031 "Show empty lines above all visible headlines.
6032 The region to be covered depends on STATE when called through
6033 `org-cycle-hook'. Lisp program can use t for STATE to get the
6034 entire buffer covered. Note that an empty line is only shown if there
6035 are at least `org-cycle-separator-lines' empty lines before the headeline."
6036 (when (> org-cycle-separator-lines 0)
6037 (save-excursion
6038 (let* ((n org-cycle-separator-lines)
6039 (re (cond
6042 (t (let ((ns (number-to-string (- n 2))))
6045 beg end)
6046 (cond
6047 ((memq state '(overview contents t))
6048 (setq beg (point-min) end (point-max)))
6049 ((memq state '(children folded))
6050 (setq beg (point) end (progn (org-end-of-subtree t t)
6051 (beginning-of-line 2)
6052 (point)))))
6053 (when beg
6054 (goto-char beg)
6055 (while (re-search-forward re end t)
6056 (if (not (get-char-property (match-end 1) 'invisible))
6057 (outline-flag-region
6058 (match-beginning 1) (match-end 1) nil)))))))
6059 ;; Never hide empty lines at the end of the file.
6060 (save-excursion
6061 (goto-char (point-max))
6062 (outline-previous-heading)
6063 (outline-end-of-heading)
6065 (= (match-end 0) (point-max)))
6066 (outline-flag-region (point) (match-end 0) nil))))
6068 (defun org-subtree-end-visible-p ()
6069 "Is the end of the current subtree visible?"
6070 (pos-visible-in-window-p
6071 (save-excursion (org-end-of-subtree t) (point))))
6073 (defun org-first-headline-recenter (&optional N)
6074 "Move cursor to the first headline and recenter the headline.
6075 Optional argument N means, put the headline into the Nth line of the window."
6076 (goto-char (point-min))
6078 (beginning-of-line)
6079 (recenter (prefix-numeric-value N))))
6081 ;;; Org-goto
6083 (defvar org-goto-window-configuration nil)
6084 (defvar org-goto-marker nil)
6085 (defvar org-goto-map
6086 (let ((map (make-sparse-keymap)))
6087 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6088 (while (setq cmd (pop cmds))
6089 (substitute-key-definition cmd cmd map global-map)))
6090 (suppress-keymap map)
6091 (org-defkey map "\C-m" 'org-goto-ret)
6092 (org-defkey map [(return)] 'org-goto-ret)
6093 (org-defkey map [(left)] 'org-goto-left)
6094 (org-defkey map [(right)] 'org-goto-right)
6095 (org-defkey map [(control ?g)] 'org-goto-quit)
6096 (org-defkey map "\C-i" 'org-cycle)
6097 (org-defkey map [(tab)] 'org-cycle)
6098 (org-defkey map [(down)] 'outline-next-visible-heading)
6099 (org-defkey map [(up)] 'outline-previous-visible-heading)
6100 (if org-goto-auto-isearch
6101 (if (fboundp 'define-key-after)
6102 (define-key-after map [t] 'org-goto-local-auto-isearch)
6103 nil)
6104 (org-defkey map "q" 'org-goto-quit)
6105 (org-defkey map "n" 'outline-next-visible-heading)
6106 (org-defkey map "p" 'outline-previous-visible-heading)
6107 (org-defkey map "f" 'outline-forward-same-level)
6108 (org-defkey map "b" 'outline-backward-same-level)
6109 (org-defkey map "u" 'outline-up-heading))
6110 (org-defkey map "/" 'org-occur)
6111 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6112 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6113 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6114 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6115 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6116 map))
6118 (defconst org-goto-help
6119 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6120 RET=jump to location [Q]uit and return to previous location
6121 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6123 (defvar org-goto-start-pos) ; dynamically scoped parameter
6125 (defun org-goto (&optional alternative-interface)
6126 "Look up a different location in the current file, keeping current visibility.
6128 When you want look-up or go to a different location in a document, the
6129 fastest way is often to fold the entire buffer and then dive into the tree.
6130 This method has the disadvantage, that the previous location will be folded,
6131 which may not be what you want.
6133 This command works around this by showing a copy of the current buffer
6134 in an indirect buffer, in overview mode. You can dive into the tree in
6135 that copy, use org-occur and incremental search to find a location.
6136 When pressing RET or `Q', the command returns to the original buffer in
6137 which the visibility is still unchanged. After RET is will also jump to
6138 the location selected in the indirect buffer and expose the
6139 the headline hierarchy above."
6140 (interactive "P")
6141 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
6142 (org-refile-use-outline-path t)
6143 (interface
6144 (if (not alternative-interface)
6145 org-goto-interface
6146 (if (eq org-goto-interface 'outline)
6147 'outline-path-completion
6148 'outline)))
6149 (org-goto-start-pos (point))
6150 (selected-point
6151 (if (eq interface 'outline)
6152 (car (org-get-location (current-buffer) org-goto-help))
6153 (nth 3 (org-refile-get-location "Goto: ")))))
6154 (if selected-point
6155 (progn
6156 (org-mark-ring-push org-goto-start-pos)
6157 (goto-char selected-point)
6158 (if (or (org-invisible-p) (org-invisible-p2))
6159 (org-show-context 'org-goto)))
6160 (message "Quit"))))
6162 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6163 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6164 (defvar org-goto-local-auto-isearch-map) ; defined below
6166 (defun org-get-location (buf help)
6167 "Let the user select a location in the Org-mode buffer BUF.
6168 This function uses a recursive edit. It returns the selected position
6169 or nil."
6170 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6171 (isearch-hide-immediately nil)
6172 (isearch-search-fun-function
6173 (lambda () 'org-goto-local-search-forward-headings))
6174 (org-goto-selected-point org-goto-exit-command))
6175 (save-excursion
6176 (save-window-excursion
6177 (delete-other-windows)
6178 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6179 (switch-to-buffer
6180 (condition-case nil
6181 (make-indirect-buffer (current-buffer) "*org-goto*")
6182 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6183 (with-output-to-temp-buffer "*Help*"
6184 (princ help))
6185 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6186 (setq buffer-read-only nil)
6187 (let ((org-startup-truncated t)
6188 (org-startup-folded nil)
6189 (org-startup-align-all-tables nil))
6190 (org-mode)
6191 (org-overview))
6192 (setq buffer-read-only t)
6193 (if (and (boundp 'org-goto-start-pos)
6194 (integer-or-marker-p org-goto-start-pos))
6195 (let ((org-show-hierarchy-above t)
6196 (org-show-siblings t)
6197 (org-show-following-heading t))
6198 (goto-char org-goto-start-pos)
6199 (and (org-invisible-p) (org-show-context)))
6200 (goto-char (point-min)))
6201 (org-beginning-of-line)
6202 (message "Select location and press RET")
6203 (use-local-map org-goto-map)
6204 (recursive-edit)
6205 ))
6206 (kill-buffer "*org-goto*")
6207 (cons org-goto-selected-point org-goto-exit-command)))
6209 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6210 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6211 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6212 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6214 (defun org-goto-local-search-forward-headings (string bound noerror)
6215 "Search and make sure that anu matches are in headlines."
6216 (catch 'return
6217 (while (search-forward string bound noerror)
6218 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6219 (and (member :headline context)
6220 (not (member :tags context))))
6221 (throw 'return (point))))))
6223 (defun org-goto-local-auto-isearch ()
6224 "Start isearch."
6225 (interactive)
6226 (goto-char (point-min))
6227 (let ((keys (this-command-keys)))
6228 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6229 (isearch-mode t)
6230 (isearch-process-search-char (string-to-char keys)))))
6232 (defun org-goto-ret (&optional arg)
6233 "Finish `org-goto' by going to the new location."
6234 (interactive "P")
6235 (setq org-goto-selected-point (point)
6236 org-goto-exit-command 'return)
6237 (throw 'exit nil))
6239 (defun org-goto-left ()
6240 "Finish `org-goto' by going to the new location."
6241 (interactive)
6242 (if (org-on-heading-p)
6243 (progn
6244 (beginning-of-line 1)
6245 (setq org-goto-selected-point (point)
6246 org-goto-exit-command 'left)
6247 (throw 'exit nil))
6248 (error "Not on a heading")))
6250 (defun org-goto-right ()
6251 "Finish `org-goto' by going to the new location."
6252 (interactive)
6253 (if (org-on-heading-p)
6254 (progn
6255 (setq org-goto-selected-point (point)
6256 org-goto-exit-command 'right)
6257 (throw 'exit nil))
6258 (error "Not on a heading")))
6260 (defun org-goto-quit ()
6261 "Finish `org-goto' without cursor motion."
6262 (interactive)
6263 (setq org-goto-selected-point nil)
6264 (setq org-goto-exit-command 'quit)
6265 (throw 'exit nil))
6267 ;;; Indirect buffer display of subtrees
6269 (defvar org-indirect-dedicated-frame nil
6270 "This is the frame being used for indirect tree display.")
6271 (defvar org-last-indirect-buffer nil)
6273 (defun org-tree-to-indirect-buffer (&optional arg)
6274 "Create indirect buffer and narrow it to current subtree.
6275 With numerical prefix ARG, go up to this level and then take that tree.
6276 If ARG is negative, go up that many levels.
6277 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6278 indirect buffer previously made with this command, to avoid proliferation of
6279 indirect buffers. However, when you call the command with a `C-u' prefix, or
6280 when `org-indirect-buffer-display' is `new-frame', the last buffer
6281 is kept so that you can work with several indirect buffers at the same time.
6282 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6283 requests that a new frame be made for the new buffer, so that the dedicated
6284 frame is not changed."
6285 (interactive "P")
6286 (let ((cbuf (current-buffer))
6287 (cwin (selected-window))
6288 (pos (point))
6289 beg end level heading ibuf)
6290 (save-excursion
6291 (org-back-to-heading t)
6292 (when (numberp arg)
6293 (setq level (org-outline-level))
6294 (if (< arg 0) (setq arg (+ level arg)))
6295 (while (> (setq level (org-outline-level)) arg)
6296 (outline-up-heading 1 t)))
6297 (setq beg (point)
6298 heading (org-get-heading))
6299 (org-end-of-subtree t) (setq end (point)))
6300 (if (and (buffer-live-p org-last-indirect-buffer)
6301 (not (eq org-indirect-buffer-display 'new-frame))
6302 (not arg))
6303 (kill-buffer org-last-indirect-buffer))
6304 (setq ibuf (org-get-indirect-buffer cbuf)
6305 org-last-indirect-buffer ibuf)
6306 (cond
6307 ((or (eq org-indirect-buffer-display 'new-frame)
6308 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6309 (select-frame (make-frame))
6310 (delete-other-windows)
6311 (switch-to-buffer ibuf)
6312 (org-set-frame-title heading))
6313 ((eq org-indirect-buffer-display 'dedicated-frame)
6314 (raise-frame
6315 (select-frame (or (and org-indirect-dedicated-frame
6316 (frame-live-p org-indirect-dedicated-frame)
6317 org-indirect-dedicated-frame)
6318 (setq org-indirect-dedicated-frame (make-frame)))))
6319 (delete-other-windows)
6320 (switch-to-buffer ibuf)
6321 (org-set-frame-title (concat "Indirect: " heading)))
6322 ((eq org-indirect-buffer-display 'current-window)
6323 (switch-to-buffer ibuf))
6324 ((eq org-indirect-buffer-display 'other-window)
6325 (pop-to-buffer ibuf))
6326 (t (error "Invalid value.")))
6327 (if (featurep 'xemacs)
6328 (save-excursion (org-mode) (turn-on-font-lock)))
6329 (narrow-to-region beg end)
6330 (show-all)
6331 (goto-char pos)
6332 (and (window-live-p cwin) (select-window cwin))))
6334 (defun org-get-indirect-buffer (&optional buffer)
6335 (setq buffer (or buffer (current-buffer)))
6336 (let ((n 1) (base (buffer-name buffer)) bname)
6337 (while (buffer-live-p
6338 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6339 (setq n (1+ n)))
6340 (condition-case nil
6341 (make-indirect-buffer buffer bname 'clone)
6342 (error (make-indirect-buffer buffer bname)))))
6344 (defun org-set-frame-title (title)
6345 "Set the title of the current frame to the string TITLE."
6346 ;; FIXME: how to name a single frame in XEmacs???
6347 (unless (featurep 'xemacs)
6348 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6350 ;;;; Structure editing
6352 ;;; Inserting headlines
6354 (defun org-insert-heading (&optional force-heading)
6355 "Insert a new heading or item with same depth at point.
6356 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6357 If point is at the beginning of a headline, insert a sibling before the
6358 current headline. If point is not at the beginning, do not split the line,
6359 but create the new hedline after the current line."
6360 (interactive "P")
6361 (if (= (buffer-size) 0)
6363 (when (or force-heading (not (org-insert-item)))
6364 (let* ((head (save-excursion
6365 (condition-case nil
6366 (progn
6367 (org-back-to-heading)
6368 (match-string 0))
6369 (error "*"))))
6370 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6371 pos)
6372 (cond
6373 ((and (org-on-heading-p) (bolp)
6374 (or (bobp)
6375 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6376 ;; insert before the current line
6377 (open-line (if blank 2 1)))
6378 ((and (bolp)
6379 (or (bobp)
6380 (save-excursion
6381 (backward-char 1) (not (org-invisible-p)))))
6382 ;; insert right here
6383 nil)
6384 (t
6385 ; ;; in the middle of the line
6386 ; (org-show-entry)
6387 ; (if (org-get-alist-option org-M-RET-may-split-line 'headline)
6388 ; (if (and
6389 ; (org-on-heading-p)
6391 ; ;; protect the tags
6392 ;; (let ((tags (match-string 2)) pos)
6393 ; (delete-region (match-beginning 1) (match-end 1))
6394 ; (setq pos (point-at-bol))
6395 ; (newline (if blank 2 1))
6396 ; (save-excursion
6397 ; (goto-char pos)
6398 ; (end-of-line 1)
6399 ; (insert " " tags)
6400 ; (org-set-tags nil 'align)))
6401 ; (newline (if blank 2 1)))
6402 ; (newline (if blank 2 1))))
6405 ;; in the middle of the line
6406 (org-show-entry)
6407 (let ((split
6408 (org-get-alist-option org-M-RET-may-split-line 'headline))
6409 tags pos)
6410 (if (org-on-heading-p)
6411 (progn
6413 (setq tags (and (match-end 2) (match-string 2)))
6414 (and (match-end 1)
6415 (delete-region (match-beginning 1) (match-end 1)))
6416 (setq pos (point-at-bol))
6417 (or split (end-of-line 1))
6418 (delete-horizontal-space)
6419 (newline (if blank 2 1))
6420 (when tags
6421 (save-excursion
6422 (goto-char pos)
6423 (end-of-line 1)
6424 (insert " " tags)
6425 (org-set-tags nil 'align))))
6426 (or split (end-of-line 1))
6427 (newline (if blank 2 1))))))
6428 (insert head) (just-one-space)
6429 (setq pos (point))
6430 (end-of-line 1)
6431 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6432 (run-hooks 'org-insert-heading-hook)))))
6434 (defun org-insert-heading-after-current ()
6435 "Insert a new heading with same level as current, after current subtree."
6436 (interactive)
6437 (org-back-to-heading)
6438 (org-insert-heading)
6439 (org-move-subtree-down)
6440 (end-of-line 1))
6442 (defun org-insert-todo-heading (arg)
6443 "Insert a new heading with the same level and TODO state as current heading.
6444 If the heading has no TODO state, or if the state is DONE, use the first
6445 state (TODO by default). Also with prefix arg, force first state."
6446 (interactive "P")
6447 (when (not (org-insert-item 'checkbox))
6448 (org-insert-heading)
6449 (save-excursion
6450 (org-back-to-heading)
6451 (outline-previous-heading)
6452 (looking-at org-todo-line-regexp))
6453 (if (or arg
6454 (not (match-beginning 2))
6455 (member (match-string 2) org-done-keywords))
6456 (insert (car org-todo-keywords-1) " ")
6457 (insert (match-string 2) " "))))
6459 (defun org-insert-subheading (arg)
6460 "Insert a new subheading and demote it.
6461 Works for outline headings and for plain lists alike."
6462 (interactive "P")
6463 (org-insert-heading arg)
6464 (cond
6465 ((org-on-heading-p) (org-do-demote))
6466 ((org-at-item-p) (org-indent-item 1))))
6468 (defun org-insert-todo-subheading (arg)
6469 "Insert a new subheading with TODO keyword or checkbox and demote it.
6470 Works for outline headings and for plain lists alike."
6471 (interactive "P")
6472 (org-insert-todo-heading arg)
6473 (cond
6474 ((org-on-heading-p) (org-do-demote))
6475 ((org-at-item-p) (org-indent-item 1))))
6477 ;;; Promotion and Demotion
6479 (defun org-promote-subtree ()
6480 "Promote the entire subtree.
6481 See also `org-promote'."
6482 (interactive)
6483 (save-excursion
6484 (org-map-tree 'org-promote))
6485 (org-fix-position-after-promote))
6487 (defun org-demote-subtree ()
6488 "Demote the entire subtree. See `org-demote'.
6489 See also `org-promote'."
6490 (interactive)
6491 (save-excursion
6492 (org-map-tree 'org-demote))
6493 (org-fix-position-after-promote))
6496 (defun org-do-promote ()
6497 "Promote the current heading higher up the tree.
6498 If the region is active in `transient-mark-mode', promote all headings
6499 in the region."
6500 (interactive)
6501 (save-excursion
6502 (if (org-region-active-p)
6503 (org-map-region 'org-promote (region-beginning) (region-end))
6504 (org-promote)))
6505 (org-fix-position-after-promote))
6507 (defun org-do-demote ()
6508 "Demote the current heading lower down the tree.
6509 If the region is active in `transient-mark-mode', demote all headings
6510 in the region."
6511 (interactive)
6512 (save-excursion
6513 (if (org-region-active-p)
6514 (org-map-region 'org-demote (region-beginning) (region-end))
6515 (org-demote)))
6516 (org-fix-position-after-promote))
6518 (defun org-fix-position-after-promote ()
6519 "Make sure that after pro/demotion cursor position is right."
6520 (let ((pos (point)))
6521 (when (save-excursion
6522 (beginning-of-line 1)
6523 (looking-at org-todo-line-regexp)
6524 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6525 (cond ((eobp) (insert " "))
6526 ((eolp) (insert " "))
6527 ((equal (char-after) ?\ ) (forward-char 1))))))
6529 (defun org-reduced-level (l)
6530 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6532 (defun org-get-valid-level (level &optional change)
6533 "Rectify a level change under the influence of `org-odd-levels-only'
6534 LEVEL is a current level, CHANGE is by how much the level should be
6535 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6536 even level numbers will become the next higher odd number."
6537 (if org-odd-levels-only
6538 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6539 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6540 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6541 (max 1 (+ level change))))
6543 (if (featurep 'xemacs)
6544 (define-obsolete-function-alias 'org-get-legal-level
6545 'org-get-valid-level)
6546 (define-obsolete-function-alias 'org-get-legal-level
6547 'org-get-valid-level "23.1"))
6549 (defun org-promote ()
6550 "Promote the current heading higher up the tree.
6551 If the region is active in `transient-mark-mode', promote all headings
6552 in the region."
6553 (org-back-to-heading t)
6554 (let* ((level (save-match-data (funcall outline-level)))
6555 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6556 (diff (abs (- level (length up-head) -1))))
6557 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6558 (replace-match up-head nil t)
6559 ;; Fixup tag positioning
6560 (and org-auto-align-tags (org-set-tags nil t))
6561 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6563 (defun org-demote ()
6564 "Demote the current heading lower down the tree.
6565 If the region is active in `transient-mark-mode', demote all headings
6566 in the region."
6567 (org-back-to-heading t)
6568 (let* ((level (save-match-data (funcall outline-level)))
6569 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6570 (diff (abs (- level (length down-head) -1))))
6571 (replace-match down-head nil t)
6572 ;; Fixup tag positioning
6573 (and org-auto-align-tags (org-set-tags nil t))
6574 (if org-adapt-indentation (org-fixup-indentation diff))))
6576 (defun org-map-tree (fun)
6577 "Call FUN for every heading underneath the current one."
6578 (org-back-to-heading)
6579 (let ((level (funcall outline-level)))
6580 (save-excursion
6581 (funcall fun)
6582 (while (and (progn
6583 (outline-next-heading)
6584 (> (funcall outline-level) level))
6585 (not (eobp)))
6586 (funcall fun)))))
6588 (defun org-map-region (fun beg end)
6589 "Call FUN for every heading between BEG and END."
6590 (let ((org-ignore-region t))
6591 (save-excursion
6592 (setq end (copy-marker end))
6593 (goto-char beg)
6594 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6595 (< (point) end))
6596 (funcall fun))
6597 (while (and (progn
6598 (outline-next-heading)
6599 (< (point) end))
6600 (not (eobp)))
6601 (funcall fun)))))
6603 (defun org-fixup-indentation (diff)
6604 "Change the indentation in the current entry by DIFF
6605 However, if any line in the current entry has no indentation, or if it
6606 would end up with no indentation after the change, nothing at all is done."
6607 (save-excursion
6608 (let ((end (save-excursion (outline-next-heading)
6609 (point-marker)))
6610 (prohibit (if (> diff 0)
6613 col)
6614 (unless (save-excursion (end-of-line 1)
6615 (re-search-forward prohibit end t))
6616 (while (and (< (point) end)
6618 (goto-char (match-end 0))
6619 (setq col (current-column))
6620 (if (< diff 0) (replace-match ""))
6621 (indent-to (+ diff col))))
6622 (move-marker end nil))))
6624 (defun org-convert-to-odd-levels ()
6625 "Convert an org-mode file with all levels allowed to one with odd levels.
6626 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6627 level 5 etc."
6628 (interactive)
6629 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6630 (let ((org-odd-levels-only nil) n)
6631 (save-excursion
6632 (goto-char (point-min))
6634 (setq n (- (length (match-string 0)) 2))
6635 (while (>= (setq n (1- n)) 0)
6636 (org-demote))
6637 (end-of-line 1))))))
6640 (defun org-convert-to-oddeven-levels ()
6641 "Convert an org-mode file with only odd levels to one with odd and even levels.
6642 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6643 section with an even level, conversion would destroy the structure of the file. An error
6644 is signaled in this case."
6645 (interactive)
6646 (goto-char (point-min))
6647 ;; First check if there are no even levels
6649 (org-show-context t)
6650 (error "Not all levels are odd in this file. Conversion not possible."))
6651 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6652 (let ((org-odd-levels-only nil) n)
6653 (save-excursion
6654 (goto-char (point-min))
6656 (setq n (/ (1- (length (match-string 0))) 2))
6657 (while (>= (setq n (1- n)) 0)
6658 (org-promote))
6659 (end-of-line 1))))))
6661 (defun org-tr-level (n)
6662 "Make N odd if required."
6663 (if org-odd-levels-only (1+ (/ n 2)) n))
6665 ;;; Vertical tree motion, cutting and pasting of subtrees
6667 (defun org-move-subtree-up (&optional arg)
6668 "Move the current subtree up past ARG headlines of the same level."
6669 (interactive "p")
6670 (org-move-subtree-down (- (prefix-numeric-value arg))))
6672 (defun org-move-subtree-down (&optional arg)
6673 "Move the current subtree down past ARG headlines of the same level."
6674 (interactive "p")
6675 (setq arg (prefix-numeric-value arg))
6676 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6677 'outline-get-last-sibling))
6678 (ins-point (make-marker))
6679 (cnt (abs arg))
6680 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6681 ;; Select the tree
6682 (org-back-to-heading)
6683 (setq beg0 (point))
6684 (save-excursion
6685 (setq ne-beg (org-back-over-empty-lines))
6686 (setq beg (point)))
6687 (save-match-data
6688 (save-excursion (outline-end-of-heading)
6689 (setq folded (org-invisible-p)))
6690 (outline-end-of-subtree))
6691 (outline-next-heading)
6692 (setq ne-end (org-back-over-empty-lines))
6693 (setq end (point))
6694 (goto-char beg0)
6695 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6696 ;; include less whitespace
6697 (save-excursion
6698 (goto-char beg)
6699 (forward-line (- ne-beg ne-end))
6700 (setq beg (point))))
6701 ;; Find insertion point, with error handling
6702 (while (> cnt 0)
6703 (or (and (funcall movfunc) (looking-at outline-regexp))
6704 (progn (goto-char beg0)
6705 (error "Cannot move past superior level or buffer limit")))
6706 (setq cnt (1- cnt)))
6707 (if (> arg 0)
6708 ;; Moving forward - still need to move over subtree
6709 (progn (org-end-of-subtree t t)
6710 (save-excursion
6711 (org-back-over-empty-lines)
6712 (or (bolp) (newline)))))
6713 (setq ne-ins (org-back-over-empty-lines))
6714 (move-marker ins-point (point))
6715 (setq txt (buffer-substring beg end))
6716 (delete-region beg end)
6717 (outline-flag-region (1- beg) beg nil)
6718 (outline-flag-region (1- (point)) (point) nil)
6719 (insert txt)
6721 (setq ins-end (point))
6722 (goto-char ins-point)
6723 (org-skip-whitespace)
6724 (when (and (< arg 0)
6725 (org-first-sibling-p)
6726 (> ne-ins ne-beg))
6727 ;; Move whitespace back to beginning
6728 (save-excursion
6729 (goto-char ins-end)
6730 (let ((kill-whole-line t))
6731 (kill-line (- ne-ins ne-beg)) (point)))
6733 (move-marker ins-point nil)
6734 (org-compact-display-after-subtree-move)
6735 (unless folded
6736 (org-show-entry)
6737 (show-children)
6738 (org-cycle-hide-drawers 'children))))
6740 (defvar org-subtree-clip ""
6741 "Clipboard for cut and paste of subtrees.
6742 This is actually only a copy of the kill, because we use the normal kill
6743 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6745 (defvar org-subtree-clip-folded nil
6746 "Was the last copied subtree folded?
6747 This is used to fold the tree back after pasting.")
6749 (defun org-cut-subtree (&optional n)
6750 "Cut the current subtree into the clipboard.
6751 With prefix arg N, cut this many sequential subtrees.
6752 This is a short-hand for marking the subtree and then cutting it."
6753 (interactive "p")
6754 (org-copy-subtree n 'cut))
6756 (defun org-copy-subtree (&optional n cut)
6757 "Cut the current subtree into the clipboard.
6758 With prefix arg N, cut this many sequential subtrees.
6759 This is a short-hand for marking the subtree and then copying it.
6760 If CUT is non-nil, actually cut the subtree."
6761 (interactive "p")
6762 (let (beg end folded (beg0 (point)))
6763 (if (interactive-p)
6764 (org-back-to-heading nil) ; take what looks like a subtree
6765 (org-back-to-heading t)) ; take what is really there
6766 (org-back-over-empty-lines)
6767 (setq beg (point))
6769 (save-match-data
6770 (save-excursion (outline-end-of-heading)
6771 (setq folded (org-invisible-p)))
6772 (condition-case nil
6773 (outline-forward-same-level (1- n))
6774 (error nil))
6775 (org-end-of-subtree t t))
6776 (org-back-over-empty-lines)
6777 (setq end (point))
6778 (goto-char beg0)
6779 (when (> end beg)
6780 (setq org-subtree-clip-folded folded)
6781 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6782 (setq org-subtree-clip (current-kill 0))
6783 (message "%s: Subtree(s) with %d characters"
6784 (if cut "Cut" "Copied")
6785 (length org-subtree-clip)))))
6787 (defun org-paste-subtree (&optional level tree)
6788 "Paste the clipboard as a subtree, with modification of headline level.
6789 The entire subtree is promoted or demoted in order to match a new headline
6790 level. By default, the new level is derived from the visible headings
6791 before and after the insertion point, and taken to be the inferior headline
6792 level of the two. So if the previous visible heading is level 3 and the
6793 next is level 4 (or vice versa), level 4 will be used for insertion.
6794 This makes sure that the subtree remains an independent subtree and does
6795 not swallow low level entries.
6797 You can also force a different level, either by using a numeric prefix
6798 argument, or by inserting the heading marker by hand. For example, if the
6803 If optional TREE is given, use this text instead of the kill ring."
6804 (interactive "P")
6805 (unless (org-kill-is-subtree-p tree)
6806 (error "%s"
6807 (substitute-command-keys
6809 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6814 (old-level (if (string-match ^re txt)
6815 (- (match-end 0) (match-beginning 0) 1)
6816 -1))
6817 (force-level (cond (level (prefix-numeric-value level))
6818 ((string-match
6819 ^re_ (buffer-substring (point-at-bol) (point)))
6820 (- (match-end 1) (match-beginning 1)))
6821 (t nil)))
6822 (previous-level (save-excursion
6823 (condition-case nil
6824 (progn
6825 (outline-previous-visible-heading 1)
6826 (if (looking-at re)
6827 (- (match-end 0) (match-beginning 0) 1)
6828 1))
6829 (error 1))))
6830 (next-level (save-excursion
6831 (condition-case nil
6832 (progn
6833 (or (looking-at outline-regexp)
6834 (outline-next-visible-heading 1))
6835 (if (looking-at re)
6836 (- (match-end 0) (match-beginning 0) 1)
6837 1))
6838 (error 1))))
6839 (new-level (or force-level (max previous-level next-level)))
6840 (shift (if (or (= old-level -1)
6841 (= new-level -1)
6842 (= old-level new-level))
6843 0
6844 (- new-level old-level)))
6845 (delta (if (> shift 0) -1 1))
6846 (func (if (> shift 0) 'org-demote 'org-promote))
6847 (org-odd-levels-only nil)
6848 beg end)
6849 ;; Remove the forced level indicator
6850 (if force-level
6851 (delete-region (point-at-bol) (point)))
6852 ;; Paste
6853 (beginning-of-line 1)
6854 (org-back-over-empty-lines) ;; FIXME: correct fix????
6855 (setq beg (point))
6856 (insert-before-markers txt) ;; FIXME: correct fix????
6858 (setq end (point))
6859 (goto-char beg)
6861 (setq beg (point))
6862 ;; Shift if necessary
6863 (unless (= shift 0)
6864 (save-restriction
6865 (narrow-to-region beg end)
6866 (while (not (= shift 0))
6867 (org-map-region func (point-min) (point-max))
6868 (setq shift (+ delta shift)))
6869 (goto-char (point-min))))
6870 (when (interactive-p)
6871 (message "Clipboard pasted as level %d subtree" new-level))
6872 (if (and kill-ring
6873 (eq org-subtree-clip (current-kill 0))
6874 org-subtree-clip-folded)
6875 ;; The tree was folded before it was killed/copied
6876 (hide-subtree))))
6878 (defun org-kill-is-subtree-p (&optional txt)
6879 "Check if the current kill is an outline subtree, or a set of trees.
6880 Returns nil if kill does not start with a headline, or if the first
6881 headline level is not the largest headline level in the tree.
6882 So this will actually accept several entries of equal levels as well,
6883 which is OK for `org-paste-subtree'.
6884 If optional TXT is given, check this string instead of the current kill."
6885 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6886 (start-level (and kill
6889 kill)
6890 (- (match-end 2) (match-beginning 2) 1)))
6891 (re (concat "^" org-outline-regexp))
6892 (start (1+ (match-beginning 2))))
6893 (if (not start-level)
6894 (progn
6895 nil) ;; does not even start with a heading
6896 (catch 'exit
6897 (while (setq start (string-match re kill (1+ start)))
6898 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6899 (throw 'exit nil)))
6900 t))))
6902 (defun org-narrow-to-subtree ()
6903 "Narrow buffer to the current subtree."
6904 (interactive)
6905 (save-excursion
6906 (save-match-data
6907 (narrow-to-region
6908 (progn (org-back-to-heading) (point))
6909 (progn (org-end-of-subtree t t) (point))))))
6912 ;;; Outline Sorting
6914 (defun org-sort (with-case)
6915 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6916 Optional argument WITH-CASE means sort case-sensitively."
6917 (interactive "P")
6918 (if (org-at-table-p)
6919 (org-call-with-arg 'org-table-sort-lines with-case)
6920 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6922 (defvar org-priority-regexp) ; defined later in the file
6924 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6925 "Sort entries on a certain level of an outline tree.
6926 If there is an active region, the entries in the region are sorted.
6927 Else, if the cursor is before the first entry, sort the top-level items.
6928 Else, the children of the entry at point are sorted.
6930 Sorting can be alphabetically, numerically, and by date/time as given by
6931 the first time stamp in the entry. The command prompts for the sorting
6932 type unless it has been given to the function through the SORTING-TYPE
6933 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6934 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6935 called with point at the beginning of the record. It must return either
6936 a string or a number that should serve as the sorting key for that record.
6938 Comparing entries ignores case by default. However, with an optional argument
6939 WITH-CASE, the sorting considers case as well."
6940 (interactive "P")
6941 (let ((case-func (if with-case 'identity 'downcase))
6942 start beg end stars re re2
6943 txt what tmp plain-list-p)
6944 ;; Find beginning and end of region to sort
6945 (cond
6946 ((org-region-active-p)
6947 ;; we will sort the region
6948 (setq end (region-end)
6949 what "region")
6950 (goto-char (region-beginning))
6951 (if (not (org-on-heading-p)) (outline-next-heading))
6952 (setq start (point)))
6953 ((org-at-item-p)
6954 ;; we will sort this plain list
6955 (org-beginning-of-item-list) (setq start (point))
6956 (org-end-of-item-list) (setq end (point))
6957 (goto-char start)
6958 (setq plain-list-p t
6959 what "plain list"))
6960 ((or (org-on-heading-p)
6961 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6962 ;; we will sort the children of the current headline
6963 (org-back-to-heading)
6964 (setq start (point)
6965 end (progn (org-end-of-subtree t t)
6966 (org-back-over-empty-lines)
6967 (point))
6968 what "children")
6969 (goto-char start)
6970 (show-subtree)
6971 (outline-next-heading))
6972 (t
6973 ;; we will sort the top-level entries in this file
6974 (goto-char (point-min))
6975 (or (org-on-heading-p) (outline-next-heading))
6976 (setq start (point) end (point-max) what "top-level")
6977 (goto-char start)
6978 (show-all)))
6980 (setq beg (point))
6981 (if (>= beg end) (error "Nothing to sort"))
6983 (unless plain-list-p
6985 (setq stars (match-string 1)
6986 re (concat "^" (regexp-quote stars) " +")
6987 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6988 txt (buffer-substring beg end))
6990 (if (and (not (equal stars "*")) (string-match re2 txt))
6991 (error "Region to sort contains a level above the first entry")))
6993 (unless sorting-type
6994 (message
6995 (if plain-list-p
6996 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6997 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6998 what)
6999 (setq sorting-type (read-char-exclusive))
7001 (and (= (downcase sorting-type) ?f)
7002 (setq getkey-func
7003 (completing-read "Sort using function: "
7004 obarray 'fboundp t nil nil))
7005 (setq getkey-func (intern getkey-func)))
7007 (and (= (downcase sorting-type) ?r)
7008 (setq property
7009 (completing-read "Property: "
7010 (mapcar 'list (org-buffer-property-keys t))
7011 nil t))))
7013 (message "Sorting entries...")
7015 (save-restriction
7016 (narrow-to-region start end)
7018 (let ((dcst (downcase sorting-type))
7019 (now (current-time)))
7020 (sort-subr
7021 (/= dcst sorting-type)
7022 ;; This function moves to the beginning character of the "record" to
7023 ;; be sorted.
7024 (if plain-list-p
7025 (lambda nil
7026 (if (org-at-item-p) t (goto-char (point-max))))
7027 (lambda nil
7028 (if (re-search-forward re nil t)
7029 (goto-char (match-beginning 0))
7030 (goto-char (point-max)))))
7031 ;; This function moves to the last character of the "record" being
7032 ;; sorted.
7033 (if plain-list-p
7034 'org-end-of-item
7035 (lambda nil
7036 (save-match-data
7037 (condition-case nil
7038 (outline-forward-same-level 1)
7039 (error
7040 (goto-char (point-max)))))))
7042 ;; This function returns the value that gets sorted against.
7043 (if plain-list-p
7044 (lambda nil
7046 (cond
7047 ((= dcst ?n)
7048 (string-to-number (buffer-substring (match-end 0)
7049 (point-at-eol))))
7050 ((= dcst ?a)
7051 (buffer-substring (match-end 0) (point-at-eol)))
7052 ((= dcst ?t)
7053 (if (re-search-forward org-ts-regexp
7054 (point-at-eol) t)
7055 (org-time-string-to-time (match-string 0))
7056 now))
7057 ((= dcst ?f)
7058 (if getkey-func
7059 (progn
7060 (setq tmp (funcall getkey-func))
7061 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7062 tmp)
7063 (error "Invalid key function `%s'" getkey-func)))
7064 (t (error "Invalid sorting type `%c'" sorting-type)))))
7065 (lambda nil
7066 (cond
7067 ((= dcst ?n)
7068 (if (looking-at outline-regexp)
7069 (string-to-number (buffer-substring (match-end 0)
7070 (point-at-eol)))
7071 nil))
7072 ((= dcst ?a)
7073 (funcall case-func (buffer-substring (point-at-bol)
7074 (point-at-eol))))
7075 ((= dcst ?t)
7076 (if (re-search-forward org-ts-regexp
7077 (save-excursion
7078 (forward-line 2)
7079 (point)) t)
7080 (org-time-string-to-time (match-string 0))
7081 now))
7082 ((= dcst ?p)
7083 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7084 (string-to-char (match-string 2))
7085 org-default-priority))
7086 ((= dcst ?r)
7087 (or (org-entry-get nil property) ""))
7088 ((= dcst ?f)
7089 (if getkey-func
7090 (progn
7091 (setq tmp (funcall getkey-func))
7092 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7093 tmp)
7094 (error "Invalid key function `%s'" getkey-func)))
7095 (t (error "Invalid sorting type `%c'" sorting-type)))))
7096 nil
7097 (cond
7098 ((= dcst ?a) 'string<)
7099 ((= dcst ?t) 'time-less-p)
7100 (t nil)))))
7101 (message "Sorting entries...done")))
7103 (defun org-do-sort (table what &optional with-case sorting-type)
7104 "Sort TABLE of WHAT according to SORTING-TYPE.
7105 The user will be prompted for the SORTING-TYPE if the call to this
7106 function does not specify it. WHAT is only for the prompt, to indicate
7107 what is being sorted. The sorting key will be extracted from
7108 the car of the elements of the table.
7109 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7110 (unless sorting-type
7111 (message
7112 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7113 what)
7114 (setq sorting-type (read-char-exclusive)))
7115 (let ((dcst (downcase sorting-type))
7116 extractfun comparefun)
7117 ;; Define the appropriate functions
7118 (cond
7119 ((= dcst ?n)
7120 (setq extractfun 'string-to-number
7121 comparefun (if (= dcst sorting-type) '< '>)))
7122 ((= dcst ?a)
7123 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7124 (lambda(x) (downcase (org-sort-remove-invisible x))))
7125 comparefun (if (= dcst sorting-type)
7126 'string<
7127 (lambda (a b) (and (not (string< a b))
7128 (not (string= a b)))))))
7129 ((= dcst ?t)
7130 (setq extractfun
7131 (lambda (x)
7132 (if (string-match org-ts-regexp x)
7133 (time-to-seconds
7134 (org-time-string-to-time (match-string 0 x)))
7135 0))
7136 comparefun (if (= dcst sorting-type) '< '>)))
7137 (t (error "Invalid sorting type `%c'" sorting-type)))
7139 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7140 table)
7141 (lambda (a b) (funcall comparefun (car a) (car b))))))
7143 ;;;; Plain list items, including checkboxes
7145 ;;; Plain list items
7147 (defun org-at-item-p ()
7148 "Is point in a line starting a hand-formatted item?"
7149 (let ((llt org-plain-list-ordered-item-terminator))
7150 (save-excursion
7151 (goto-char (point-at-bol))
7152 (looking-at
7153 (cond
7157 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7159 (defun org-in-item-p ()
7160 "It the cursor inside a plain list item.
7161 Does not have to be the first line."
7162 (save-excursion
7163 (condition-case nil
7164 (progn
7165 (org-beginning-of-item)
7166 (org-at-item-p)
7167 t)
7168 (error nil))))
7170 (defun org-insert-item (&optional checkbox)
7171 "Insert a new item at the current level.
7172 Return t when things worked, nil when we are not in an item."
7173 (when (save-excursion
7174 (condition-case nil
7175 (progn
7176 (org-beginning-of-item)
7177 (org-at-item-p)
7178 (if (org-invisible-p) (error "Invisible item"))
7179 t)
7180 (error nil)))
7181 (let* ((bul (match-string 0))
7183 (match-end 0)))
7184 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7185 pos)
7186 (cond
7187 ((and (org-at-item-p) (<= (point) eow))
7188 ;; before the bullet
7189 (beginning-of-line 1)
7190 (open-line (if blank 2 1)))
7191 ((<= (point) eow)
7192 (beginning-of-line 1))
7193 (t
7194 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7195 (end-of-line 1)
7196 (delete-horizontal-space))
7197 (newline (if blank 2 1))))
7198 (insert bul (if checkbox "[ ]" ""))
7199 (just-one-space)
7200 (setq pos (point))
7201 (end-of-line 1)
7202 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7203 (org-maybe-renumber-ordered-list)
7204 (and checkbox (org-update-checkbox-count-maybe))
7205 t))
7207 ;;; Checkboxes
7209 (defun org-at-item-checkbox-p ()
7210 "Is point at a line starting a plain-list item with a checklet?"
7211 (and (org-at-item-p)
7212 (save-excursion
7213 (goto-char (match-end 0))
7217 (defun org-toggle-checkbox (&optional arg)
7218 "Toggle the checkbox in the current line."
7219 (interactive "P")
7220 (catch 'exit
7221 (let (beg end status (firstnew 'unknown))
7222 (cond
7223 ((org-region-active-p)
7224 (setq beg (region-beginning) end (region-end)))
7225 ((org-on-heading-p)
7226 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7227 ((org-at-item-checkbox-p)
7228 (let ((pos (point)))
7229 (replace-match
7230 (cond (arg "[-]")
7231 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7232 (t "[ ]"))
7233 t t)
7234 (goto-char pos))
7235 (throw 'exit t))
7236 (t (error "Not at a checkbox or heading, and no active region")))
7237 (save-excursion
7238 (goto-char beg)
7239 (while (< (point) end)
7240 (when (org-at-item-checkbox-p)
7241 (setq status (equal (match-string 0) "[X]"))
7242 (when (eq firstnew 'unknown)
7243 (setq firstnew (not status)))
7244 (replace-match
7245 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7246 (beginning-of-line 2)))))
7247 (org-update-checkbox-count-maybe))
7249 (defun org-update-checkbox-count-maybe ()
7250 "Update checkbox statistics unless turned off by user."
7251 (when org-provide-checkbox-statistics
7252 (org-update-checkbox-count)))
7254 (defun org-update-checkbox-count (&optional all)
7255 "Update the checkbox statistics in the current section.
7256 This will find all statistic cookies like [57%] and [6/12] and update them
7257 with the current numbers. With optional prefix argument ALL, do this for
7258 the whole buffer."
7259 (interactive "P")
7260 (save-excursion
7261 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7262 (beg (condition-case nil
7263 (progn (outline-back-to-heading) (point))
7264 (error (point-min))))
7265 (end (move-marker (make-marker)
7266 (progn (outline-next-heading) (point))))
7270 beg-cookie end-cookie is-percent c-on c-off lim
7271 eline curr-ind next-ind continue-from startsearch
7272 (cstat 0)
7273 )
7274 (when all
7275 (goto-char (point-min))
7276 (outline-next-heading)
7277 (setq beg (point) end (point-max)))
7278 (goto-char end)
7279 ;; find each statistic cookie
7280 (while (re-search-backward re-find beg t)
7281 (setq beg-cookie (match-beginning 1)
7282 end-cookie (match-end 1)
7283 cstat (+ cstat (if end-cookie 1 0))
7284 startsearch (point-at-eol)
7285 continue-from (point-at-bol)
7286 is-percent (match-beginning 2)
7287 lim (cond
7288 ((org-on-heading-p) (outline-next-heading) (point))
7289 ((org-at-item-p) (org-end-of-item) (point))
7290 (t nil))
7291 c-on 0
7292 c-off 0)
7293 (when lim
7294 ;; find first checkbox for this cookie and gather
7295 ;; statistics from all that are at this indentation level
7296 (goto-char startsearch)
7297 (if (re-search-forward re-box lim t)
7298 (progn
7299 (org-beginning-of-item)
7300 (setq curr-ind (org-get-indentation))
7301 (setq next-ind curr-ind)
7302 (while (= curr-ind next-ind)
7303 (save-excursion (end-of-line) (setq eline (point)))
7304 (if (re-search-forward re-box eline t)
7305 (if (member (match-string 2) '("[ ]" "[-]"))
7306 (setq c-off (1+ c-off))
7307 (setq c-on (1+ c-on))
7308 )
7309 )
7310 (org-end-of-item)
7311 (setq next-ind (org-get-indentation))
7312 )))
7313 (goto-char continue-from)
7314 ;; update cookie
7315 (when end-cookie
7316 (delete-region beg-cookie end-cookie)
7317 (goto-char beg-cookie)
7318 (insert
7319 (if is-percent
7320 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7321 (format "[%d/%d]" c-on (+ c-on c-off)))))
7322 ;; update items checkbox if it has one
7323 (when (org-at-item-p)
7324 (org-beginning-of-item)
7325 (when (and (> (+ c-on c-off) 0)
7326 (re-search-forward re-box (point-at-eol) t))
7327 (setq beg-cookie (match-beginning 2)
7328 end-cookie (match-end 2))
7329 (delete-region beg-cookie end-cookie)
7330 (goto-char beg-cookie)
7331 (cond ((= c-off 0) (insert "[X]"))
7332 ((= c-on 0) (insert "[ ]"))
7333 (t (insert "[-]")))
7334 )))
7335 (goto-char continue-from))
7336 (when (interactive-p)
7337 (message "Checkbox satistics updated %s (%d places)"
7338 (if all "in entire file" "in current outline entry") cstat)))))
7340 (defun org-get-checkbox-statistics-face ()
7341 "Select the face for checkbox statistics.
7342 The face will be `org-done' when all relevant boxes are checked. Otherwise
7343 it will be `org-todo'."
7344 (if (match-end 1)
7345 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7346 (if (and (> (match-end 2) (match-beginning 2))
7347 (equal (match-string 2) (match-string 3)))
7348 'org-done
7349 'org-todo)))
7351 (defun org-get-indentation (&optional line)
7352 "Get the indentation of the current line, interpreting tabs.
7353 When LINE is given, assume it represents a line and compute its indentation."
7354 (if line
7355 (if (string-match "^ *" (org-remove-tabs line))
7356 (match-end 0))
7357 (save-excursion
7358 (beginning-of-line 1)
7360 (current-column))))
7362 (defun org-remove-tabs (s &optional width)
7363 "Replace tabulators in S with spaces.
7364 Assumes that s is a single line, starting in column 0."
7365 (setq width (or width tab-width))
7367 (setq s (replace-match
7368 (make-string
7369 (- (* width (/ (+ (match-beginning 0) width) width))
7370 (match-beginning 0)) ?\ )
7371 t t s)))
7372 s)
7374 (defun org-fix-indentation (line ind)
7375 "Fix indentation in LINE.
7376 IND is a cons cell with target and minimum indentation.
7377 If the current indenation in LINE is smaller than the minimum,
7378 leave it alone. If it is larger than ind, set it to the target."
7379 (let* ((l (org-remove-tabs line))
7380 (i (org-get-indentation l))
7381 (i1 (car ind)) (i2 (cdr ind)))
7382 (if (>= i i2) (setq l (substring line i2)))
7383 (if (> i1 0)
7384 (concat (make-string i1 ?\ ) l)
7385 l)))
7387 (defcustom org-empty-line-terminates-plain-lists nil
7388 "Non-nil means, an empty line ends all plain list levels.
7389 When nil, empty lines are part of the preceeding item."
7390 :group 'org-plain-lists
7391 :type 'boolean)
7393 (defun org-beginning-of-item ()
7394 "Go to the beginning of the current hand-formatted item.
7395 If the cursor is not in an item, throw an error."
7396 (interactive)
7397 (let ((pos (point))
7398 (limit (save-excursion
7399 (condition-case nil
7400 (progn
7401 (org-back-to-heading)
7402 (beginning-of-line 2) (point))
7403 (error (point-min)))))
7404 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7405 ind ind1)
7406 (if (org-at-item-p)
7407 (beginning-of-line 1)
7408 (beginning-of-line 1)
7410 (setq ind (current-column))
7411 (if (catch 'exit
7412 (while t
7413 (beginning-of-line 0)
7414 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7417 (setq ind1 ind-empty)
7419 (setq ind1 (current-column)))
7420 (if (< ind1 ind)
7421 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7422 nil
7423 (goto-char pos)
7424 (error "Not in an item")))))
7426 (defun org-end-of-item ()
7427 "Go to the end of the current hand-formatted item.
7428 If the cursor is not in an item, throw an error."
7429 (interactive)
7430 (let* ((pos (point))
7431 ind1
7432 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7433 (limit (save-excursion (outline-next-heading) (point)))
7434 (ind (save-excursion
7435 (org-beginning-of-item)
7437 (current-column)))
7438 (end (catch 'exit
7439 (while t
7440 (beginning-of-line 2)
7441 (if (eobp) (throw 'exit (point)))
7442 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7444 (setq ind1 ind-empty)
7446 (setq ind1 (current-column)))
7447 (if (<= ind1 ind)
7448 (throw 'exit (point-at-bol)))))))
7449 (if end
7450 (goto-char end)
7451 (goto-char pos)
7452 (error "Not in an item"))))
7454 (defun org-next-item ()
7455 "Move to the beginning of the next item in the current plain list.
7456 Error if not at a plain list, or if this is the last item in the list."
7457 (interactive)
7458 (let (ind ind1 (pos (point)))
7459 (org-beginning-of-item)
7460 (setq ind (org-get-indentation))
7461 (org-end-of-item)
7462 (setq ind1 (org-get-indentation))
7463 (unless (and (org-at-item-p) (= ind ind1))
7464 (goto-char pos)
7465 (error "On last item"))))
7467 (defun org-previous-item ()
7468 "Move to the beginning of the previous item in the current plain list.
7469 Error if not at a plain list, or if this is the first item in the list."
7470 (interactive)
7471 (let (beg ind ind1 (pos (point)))
7472 (org-beginning-of-item)
7473 (setq beg (point))
7474 (setq ind (org-get-indentation))
7475 (goto-char beg)
7476 (catch 'exit
7477 (while t
7478 (beginning-of-line 0)
7480 nil
7481 (if (<= (setq ind1 (org-get-indentation)) ind)
7482 (throw 'exit t)))))
7483 (condition-case nil
7484 (if (or (not (org-at-item-p))
7485 (< ind1 (1- ind)))
7486 (error "")
7487 (org-beginning-of-item))
7488 (error (goto-char pos)
7489 (error "On first item")))))
7491 (defun org-first-list-item-p ()
7492 "Is this heading the item in a plain list?"
7493 (unless (org-at-item-p)
7494 (error "Not at a plain list item"))
7495 (org-beginning-of-item)
7496 (= (point) (save-excursion (org-beginning-of-item-list))))
7498 (defun org-move-item-down ()
7499 "Move the plain list item at point down, i.e. swap with following item.
7500 Subitems (items with larger indentation) are considered part of the item,
7501 so this really moves item trees."
7502 (interactive)
7503 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7504 (org-beginning-of-item)
7505 (setq beg0 (point))
7506 (save-excursion
7507 (setq ne-beg (org-back-over-empty-lines))
7508 (setq beg (point)))
7509 (goto-char beg0)
7510 (setq ind (org-get-indentation))
7511 (org-end-of-item)
7512 (setq end0 (point))
7513 (setq ind1 (org-get-indentation))
7514 (setq ne-end (org-back-over-empty-lines))
7515 (setq end (point))
7516 (goto-char beg0)
7517 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7518 ;; include less whitespace
7519 (save-excursion
7520 (goto-char beg)
7521 (forward-line (- ne-beg ne-end))
7522 (setq beg (point))))
7523 (goto-char end0)
7524 (if (and (org-at-item-p) (= ind ind1))
7525 (progn
7526 (org-end-of-item)
7527 (org-back-over-empty-lines)
7528 (setq txt (buffer-substring beg end))
7529 (save-excursion
7530 (delete-region beg end))
7531 (setq pos (point))
7532 (insert txt)
7533 (goto-char pos) (org-skip-whitespace)
7534 (org-maybe-renumber-ordered-list))
7535 (goto-char pos)
7536 (error "Cannot move this item further down"))))
7538 (defun org-move-item-up (arg)
7539 "Move the plain list item at point up, i.e. swap with previous item.
7540 Subitems (items with larger indentation) are considered part of the item,
7541 so this really moves item trees."
7542 (interactive "p")
7543 (let (beg beg0 end ind ind1 (pos (point)) txt
7544 ne-beg ne-ins ins-end)
7545 (org-beginning-of-item)
7546 (setq beg0 (point))
7547 (setq ind (org-get-indentation))
7548 (save-excursion
7549 (setq ne-beg (org-back-over-empty-lines))
7550 (setq beg (point)))
7551 (goto-char beg0)
7552 (org-end-of-item)
7553 (setq end (point))
7554 (goto-char beg0)
7555 (catch 'exit
7556 (while t
7557 (beginning-of-line 0)
7559 (if org-empty-line-terminates-plain-lists
7560 (progn
7561 (goto-char pos)
7562 (error "Cannot move this item further up"))
7563 nil)
7564 (if (<= (setq ind1 (org-get-indentation)) ind)
7565 (throw 'exit t)))))
7566 (condition-case nil
7567 (org-beginning-of-item)
7568 (error (goto-char beg)
7569 (error "Cannot move this item further up")))
7570 (setq ind1 (org-get-indentation))
7571 (if (and (org-at-item-p) (= ind ind1))
7572 (progn
7573 (setq ne-ins (org-back-over-empty-lines))
7574 (setq txt (buffer-substring beg end))
7575 (save-excursion
7576 (delete-region beg end))
7577 (setq pos (point))
7578 (insert txt)
7579 (setq ins-end (point))
7580 (goto-char pos) (org-skip-whitespace)
7582 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7583 ;; Move whitespace back to beginning
7584 (save-excursion
7585 (goto-char ins-end)
7586 (let ((kill-whole-line t))
7587 (kill-line (- ne-ins ne-beg)) (point)))
7590 (org-maybe-renumber-ordered-list))
7591 (goto-char pos)
7592 (error "Cannot move this item further up"))))
7594 (defun org-maybe-renumber-ordered-list ()
7595 "Renumber the ordered list at point if setup allows it.
7596 This tests the user option `org-auto-renumber-ordered-lists' before
7597 doing the renumbering."
7598 (interactive)
7599 (when (and org-auto-renumber-ordered-lists
7600 (org-at-item-p))
7601 (if (match-beginning 3)
7602 (org-renumber-ordered-list 1)
7603 (org-fix-bullet-type))))
7605 (defun org-maybe-renumber-ordered-list-safe ()
7606 (condition-case nil
7607 (save-excursion
7608 (org-maybe-renumber-ordered-list))
7609 (error nil)))
7611 (defun org-cycle-list-bullet (&optional which)
7612 "Cycle through the different itemize/enumerate bullets.
7613 This cycle the entire list level through the sequence:
7615 `-' -> `+' -> `*' -> `1.' -> `1)'
7617 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7618 0 meand `-', 1 means `+' etc."
7619 (interactive "P")
7620 (org-preserve-lc
7621 (org-beginning-of-item-list)
7622 (org-at-item-p)
7623 (beginning-of-line 1)
7624 (let ((current (match-string 0))
7625 (prevp (eq which 'previous))
7626 new)
7627 (setq new (cond
7628 ((and (numberp which)
7629 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7630 ((string-match "-" current) (if prevp "1)" "+"))
7635 ((string-match ")" current) (if prevp "1." "-"))
7636 (t (error "This should not happen"))))
7638 (org-fix-bullet-type)
7639 (org-maybe-renumber-ordered-list))))
7641 (defun org-get-string-indentation (s)
7642 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7643 (let ((n -1) (i 0) (w tab-width) c)
7644 (catch 'exit
7645 (while (< (setq n (1+ n)) (length s))
7646 (setq c (aref s n))
7647 (cond ((= c ?\ ) (setq i (1+ i)))
7649 (t (throw 'exit t)))))
7650 i))
7652 (defun org-renumber-ordered-list (arg)
7653 "Renumber an ordered plain list.
7654 Cursor needs to be in the first line of an item, the line that starts
7656 (interactive "p")
7657 (unless (and (org-at-item-p)
7658 (match-beginning 3))
7659 (error "This is not an ordered list"))
7660 (let ((line (org-current-line))
7661 (col (current-column))
7662 (ind (org-get-string-indentation
7663 (buffer-substring (point-at-bol) (match-beginning 3))))
7664 ;; (term (substring (match-string 3) -1))
7665 ind1 (n (1- arg))
7666 fmt)
7667 ;; find where this list begins
7668 (org-beginning-of-item-list)
7670 (setq fmt (concat "%d" (match-string 1)))
7671 (beginning-of-line 0)
7672 ;; walk forward and replace these numbers
7673 (catch 'exit
7674 (while t
7675 (catch 'next
7676 (beginning-of-line 2)
7677 (if (eobp) (throw 'exit nil))
7680 (if (> ind1 ind) (throw 'next t))
7681 (if (< ind1 ind) (throw 'exit t))
7682 (if (not (org-at-item-p)) (throw 'exit nil))
7683 (delete-region (match-beginning 2) (match-end 2))
7684 (goto-char (match-beginning 2))
7685 (insert (format fmt (setq n (1+ n)))))))
7686 (goto-line line)
7687 (move-to-column col)))
7689 (defun org-fix-bullet-type ()
7690 "Make sure all items in this list have the same bullet as the firsst item."
7691 (interactive)
7692 (unless (org-at-item-p) (error "This is not a list"))
7693 (let ((line (org-current-line))
7694 (col (current-column))
7695 (ind (current-indentation))
7696 ind1 bullet)
7697 ;; find where this list begins
7698 (org-beginning-of-item-list)
7699 (beginning-of-line 1)
7700 ;; find out what the bullet type is
7702 (setq bullet (match-string 1))
7703 ;; walk forward and replace these numbers
7704 (beginning-of-line 0)
7705 (catch 'exit
7706 (while t
7707 (catch 'next
7708 (beginning-of-line 2)
7709 (if (eobp) (throw 'exit nil))
7712 (if (> ind1 ind) (throw 'next t))
7713 (if (< ind1 ind) (throw 'exit t))
7714 (if (not (org-at-item-p)) (throw 'exit nil))
7717 (replace-match bullet))))
7718 (goto-line line)
7719 (move-to-column col)
7720 (if (string-match "[0-9]" bullet)
7721 (org-renumber-ordered-list 1))))
7723 (defun org-beginning-of-item-list ()
7724 "Go to the beginning of the current item list.
7725 I.e. to the first item in this list."
7726 (interactive)
7727 (org-beginning-of-item)
7728 (let ((pos (point-at-bol))
7729 (ind (org-get-indentation))
7730 ind1)
7731 ;; find where this list begins
7732 (catch 'exit
7733 (while t
7734 (catch 'next
7735 (beginning-of-line 0)
7737 (throw (if (bobp) 'exit 'next) t))
7739 (if (or (< ind1 ind)
7740 (and (= ind1 ind)
7741 (not (org-at-item-p)))
7742 (bobp))
7743 (throw 'exit t)
7744 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7745 (goto-char pos)))
7748 (defun org-end-of-item-list ()
7749 "Go to the end of the current item list.
7750 I.e. to the text after the last item."
7751 (interactive)
7752 (org-beginning-of-item)
7753 (let ((pos (point-at-bol))
7754 (ind (org-get-indentation))
7755 ind1)
7756 ;; find where this list begins
7757 (catch 'exit
7758 (while t
7759 (catch 'next
7760 (beginning-of-line 2)
7762 (throw (if (eobp) 'exit 'next) t))
7764 (if (or (< ind1 ind)
7765 (and (= ind1 ind)
7766 (not (org-at-item-p)))
7767 (eobp))
7768 (progn
7769 (setq pos (point-at-bol))
7770 (throw 'exit t))))))
7771 (goto-char pos)))
7774 (defvar org-last-indent-begin-marker (make-marker))
7775 (defvar org-last-indent-end-marker (make-marker))
7777 (defun org-outdent-item (arg)
7778 "Outdent a local list item."
7779 (interactive "p")
7780 (org-indent-item (- arg)))
7782 (defun org-indent-item (arg)
7783 "Indent a local list item."
7784 (interactive "p")
7785 (unless (org-at-item-p)
7786 (error "Not on an item"))
7787 (save-excursion
7788 (let (beg end ind ind1 tmp delta ind-down ind-up)
7789 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7790 (setq beg org-last-indent-begin-marker
7791 end org-last-indent-end-marker)
7792 (org-beginning-of-item)
7793 (setq beg (move-marker org-last-indent-begin-marker (point)))
7794 (org-end-of-item)
7795 (setq end (move-marker org-last-indent-end-marker (point))))
7796 (goto-char beg)
7797 (setq tmp (org-item-indent-positions)
7798 ind (car tmp)
7799 ind-down (nth 2 tmp)
7800 ind-up (nth 1 tmp)
7801 delta (if (> arg 0)
7802 (if ind-down (- ind-down ind) 2)
7803 (if ind-up (- ind-up ind) -2)))
7804 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7805 (while (< (point) end)
7806 (beginning-of-line 1)
7808 (delete-region (point-at-bol) (point))
7809 (or (eolp) (indent-to-column (+ ind1 delta)))
7810 (beginning-of-line 2))))
7811 (org-fix-bullet-type)
7812 (org-maybe-renumber-ordered-list-safe)
7813 (save-excursion
7814 (beginning-of-line 0)
7815 (condition-case nil (org-beginning-of-item) (error nil))
7816 (org-maybe-renumber-ordered-list-safe)))
7818 (defun org-item-indent-positions ()
7819 "Return indentation for plain list items.
7820 This returns a list with three values: The current indentation, the
7821 parent indentation and the indentation a child should habe.
7822 Assumes cursor in item line."
7823 (let* ((bolpos (point-at-bol))
7824 (ind (org-get-indentation))
7825 ind-down ind-up pos)
7826 (save-excursion
7827 (org-beginning-of-item-list)
7829 (when (org-in-item-p)
7830 (org-beginning-of-item)
7831 (setq ind-up (org-get-indentation))))
7832 (setq pos (point))
7833 (save-excursion
7834 (cond
7835 ((and (condition-case nil (progn (org-previous-item) t)
7836 (error nil))
7837 (or (forward-char 1) t)
7838 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7839 (setq ind-down (org-get-indentation)))
7840 ((and (goto-char pos)
7841 (org-at-item-p))
7842 (goto-char (match-end 0))
7844 (setq ind-down (current-column)))))
7845 (list ind ind-up ind-down)))
7847 ;;; The orgstruct minor mode
7849 ;; Define a minor mode which can be used in other modes in order to
7850 ;; integrate the org-mode structure editing commands.
7852 ;; This is really a hack, because the org-mode structure commands use
7853 ;; keys which normally belong to the major mode. Here is how it
7854 ;; works: The minor mode defines all the keys necessary to operate the
7855 ;; structure commands, but wraps the commands into a function which
7856 ;; tests if the cursor is currently at a headline or a plain list
7857 ;; item. If that is the case, the structure command is used,
7858 ;; temporarily setting many Org-mode variables like regular
7859 ;; expressions for filling etc. However, when any of those keys is
7860 ;; used at a different location, function uses `key-binding' to look
7861 ;; up if the key has an associated command in another currently active
7862 ;; keymap (minor modes, major mode, global), and executes that
7863 ;; command. There might be problems if any of the keys is otherwise
7864 ;; used as a prefix key.
7866 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7867 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7868 ;; addresses this by checking explicitly for both bindings.
7870 (defvar orgstruct-mode-map (make-sparse-keymap)
7871 "Keymap for the minor `orgstruct-mode'.")
7873 (defvar org-local-vars nil
7874 "List of local variables, for use by `orgstruct-mode'")
7876 ;;;###autoload
7877 (define-minor-mode orgstruct-mode
7878 "Toggle the minor more `orgstruct-mode'.
7879 This mode is for using Org-mode structure commands in other modes.
7880 The following key behave as if Org-mode was active, if the cursor
7881 is on a headline, or on a plain list item (both in the definition
7882 of Org-mode).
7884 M-up Move entry/item up
7885 M-down Move entry/item down
7886 M-left Promote
7887 M-right Demote
7888 M-S-up Move entry/item up
7889 M-S-down Move entry/item down
7890 M-S-left Promote subtree
7891 M-S-right Demote subtree
7892 M-q Fill paragraph and items like in Org-mode
7893 C-c ^ Sort entries
7894 C-c - Cycle list bullet
7895 TAB Cycle item visibility
7896 M-RET Insert new heading/item
7897 S-M-RET Insert new TODO heading / Chekbox item
7898 C-c C-c Set tags / toggle checkbox"
7899 nil " OrgStruct" nil
7900 (org-load-modules-maybe)
7901 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7903 ;;;###autoload
7904 (defun turn-on-orgstruct ()
7905 "Unconditionally turn on `orgstruct-mode'."
7906 (orgstruct-mode 1))
7908 ;;;###autoload
7909 (defun turn-on-orgstruct++ ()
7910 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7911 In addition to setting orgstruct-mode, this also exports all indentation and
7912 autofilling variables from org-mode into the buffer. Note that turning
7913 off orgstruct-mode will *not* remove these additional settings."
7914 (orgstruct-mode 1)
7915 (let (var val)
7916 (mapc
7917 (lambda (x)
7918 (when (string-match
7920 (symbol-name (car x)))
7921 (setq var (car x) val (nth 1 x))
7922 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7923 org-local-vars)))
7925 (defun orgstruct-error ()
7926 "Error when there is no default binding for a structure key."
7927 (interactive)
7928 (error "This key has no function outside structure elements"))
7930 (defun orgstruct-setup ()
7931 "Setup orgstruct keymaps."
7932 (let ((nfunc 0)
7933 (bindings
7934 (list
7935 '([(meta up)] org-metaup)
7936 '([(meta down)] org-metadown)
7937 '([(meta left)] org-metaleft)
7938 '([(meta right)] org-metaright)
7939 '([(meta shift up)] org-shiftmetaup)
7940 '([(meta shift down)] org-shiftmetadown)
7941 '([(meta shift left)] org-shiftmetaleft)
7942 '([(meta shift right)] org-shiftmetaright)
7943 '([(shift up)] org-shiftup)
7944 '([(shift down)] org-shiftdown)
7945 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7946 '("\M-q" fill-paragraph)
7947 '("\C-c^" org-sort)
7948 '("\C-c-" org-cycle-list-bullet)))
7949 elt key fun cmd)
7950 (while (setq elt (pop bindings))
7951 (setq nfunc (1+ nfunc))
7952 (setq key (org-key (car elt))
7953 fun (nth 1 elt)
7954 cmd (orgstruct-make-binding fun nfunc key))
7955 (org-defkey orgstruct-mode-map key cmd))
7957 ;; Special treatment needed for TAB and RET
7958 (org-defkey orgstruct-mode-map [(tab)]
7959 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7960 (org-defkey orgstruct-mode-map "\C-i"
7961 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7963 (org-defkey orgstruct-mode-map "\M-\C-m"
7964 (orgstruct-make-binding 'org-insert-heading 105
7965 "\M-\C-m" [(meta return)]))
7966 (org-defkey orgstruct-mode-map [(meta return)]
7967 (orgstruct-make-binding 'org-insert-heading 106
7968 [(meta return)] "\M-\C-m"))
7970 (org-defkey orgstruct-mode-map [(shift meta return)]
7971 (orgstruct-make-binding 'org-insert-todo-heading 107
7972 [(meta return)] "\M-\C-m"))
7974 (unless org-local-vars
7975 (setq org-local-vars (org-get-local-variables)))
7977 t))
7979 (defun orgstruct-make-binding (fun n &rest keys)
7980 "Create a function for binding in the structure minor mode.
7981 FUN is the command to call inside a table. N is used to create a unique
7982 command name. KEYS are keys that should be checked in for a command
7983 to execute outside of tables."
7984 (eval
7985 (list 'defun
7986 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7987 '(arg)
7989 "Outside of structure, run the binding of `"
7990 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7991 "'.")
7992 '(interactive "p")
7993 (list 'if
7994 '(org-context-p 'headline 'item)
7995 (list 'org-run-like-in-org-mode (list 'quote fun))
7996 (list 'let '(orgstruct-mode)
7997 (list 'call-interactively
7998 (append '(or)
7999 (mapcar (lambda (k)
8000 (list 'key-binding k))
8001 keys)
8002 '('orgstruct-error))))))))
8004 (defun org-context-p (&rest contexts)
8005 "Check if local context is and of CONTEXTS.
8006 Possible values in the list of contexts are `table', `headline', and `item'."
8007 (let ((pos (point)))
8008 (goto-char (point-at-bol))
8009 (prog1 (or (and (memq 'table contexts)
8011 (and (memq 'headline contexts)
8013 (and (memq 'item contexts)
8015 (goto-char pos))))
8017 (defun org-get-local-variables ()
8018 "Return a list of all local variables in an org-mode buffer."
8019 (let (varlist)
8020 (with-current-buffer (get-buffer-create "*Org tmp*")
8021 (erase-buffer)
8022 (org-mode)
8023 (setq varlist (buffer-local-variables)))
8024 (kill-buffer "*Org tmp*")
8025 (delq nil
8026 (mapcar
8027 (lambda (x)
8028 (setq x
8029 (if (symbolp x)
8030 (list x)
8031 (list (car x) (list 'quote (cdr x)))))
8032 (if (string-match
8033 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8034 (symbol-name (car x)))
8035 x nil))
8036 varlist))))
8038 ;;;###autoload
8039 (defun org-run-like-in-org-mode (cmd)
8040 (org-load-modules-maybe)
8041 (unless org-local-vars
8042 (setq org-local-vars (org-get-local-variables)))
8043 (eval (list 'let org-local-vars
8044 (list 'call-interactively (list 'quote cmd)))))
8046 ;;;; Archiving
8048 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
8050 (defun org-archive-subtree (&optional find-done)
8051 "Move the current subtree to the archive.
8052 The archive can be a certain top-level heading in the current file, or in
8053 a different file. The tree will be moved to that location, the subtree
8054 heading be marked DONE, and the current time will be added.
8056 When called with prefix argument FIND-DONE, find whole trees without any
8057 open TODO items and archive them (after getting confirmation from the user).
8058 If the cursor is not at a headline when this comand is called, try all level
8059 1 trees. If the cursor is on a headline, only try the direct children of
8060 this heading."
8061 (interactive "P")
8062 (if find-done
8063 (org-archive-all-done)
8064 ;; Save all relevant TODO keyword-relatex variables
8066 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
8067 (tr-org-todo-keywords-1 org-todo-keywords-1)
8068 (tr-org-todo-kwd-alist org-todo-kwd-alist)
8069 (tr-org-done-keywords org-done-keywords)
8070 (tr-org-todo-regexp org-todo-regexp)
8071 (tr-org-todo-line-regexp org-todo-line-regexp)
8072 (tr-org-odd-levels-only org-odd-levels-only)
8073 (this-buffer (current-buffer))
8074 (org-archive-location org-archive-location)
8076 ;; start of variables that will be used for saving context
8077 ;; The compiler complains about them - keep them anyway!
8078 (file (abbreviate-file-name (buffer-file-name)))
8079 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
8080 (time (format-time-string
8081 (substring (cdr org-time-stamp-formats) 1 -1)
8082 (current-time)))
8083 afile heading buffer level newfile-p
8084 category todo priority
8085 ;; start of variables that will be used for savind context
8086 ltags itags prop)
8088 ;; Try to find a local archive location
8089 (save-excursion
8090 (save-restriction
8091 (widen)
8092 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
8094 (setq org-archive-location prop)
8095 (if (or (re-search-backward re nil t)
8096 (re-search-forward re nil t))
8097 (setq org-archive-location (match-string 1))))))
8100 (progn
8101 (setq afile (format (match-string 1 org-archive-location)
8102 (file-name-nondirectory buffer-file-name))
8103 heading (match-string 2 org-archive-location)))
8104 (error "Invalid `org-archive-location'"))
8105 (if (> (length afile) 0)
8106 (setq newfile-p (not (file-exists-p afile))
8107 buffer (find-file-noselect afile))
8108 (setq buffer (current-buffer)))
8109 (unless buffer
8111 (if (and (> (length heading) 0)
8113 (setq level (match-end 0))
8114 (setq heading nil level 0))
8115 (save-excursion
8116 (org-back-to-heading t)
8117 ;; Get context information that will be lost by moving the tree
8118 (org-refresh-category-properties)
8119 (setq category (org-get-category)
8120 todo (and (looking-at org-todo-line-regexp)
8121 (match-string 2))
8122 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
8123 ltags (org-get-tags)
8124 itags (org-delete-all ltags (org-get-tags-at)))
8125 (setq ltags (mapconcat 'identity ltags " ")
8126 itags (mapconcat 'identity itags " "))
8127 ;; We first only copy, in case something goes wrong
8128 ;; we need to protect this-command, to avoid kill-region sets it,
8129 ;; which would lead to duplication of subtrees
8130 (let (this-command) (org-copy-subtree))
8131 (set-buffer buffer)
8132 ;; Enforce org-mode for the archive buffer
8133 (if (not (org-mode-p))
8134 ;; Force the mode for future visits.
8135 (let ((org-insert-mode-line-in-empty-file t)
8136 (org-inhibit-startup t))
8137 (call-interactively 'org-mode)))
8138 (when newfile-p
8139 (goto-char (point-max))
8141 (buffer-file-name this-buffer))))
8142 ;; Force the TODO keywords of the original buffer
8143 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
8144 (org-todo-keywords-1 tr-org-todo-keywords-1)
8145 (org-todo-kwd-alist tr-org-todo-kwd-alist)
8146 (org-done-keywords tr-org-done-keywords)
8147 (org-todo-regexp tr-org-todo-regexp)
8148 (org-todo-line-regexp tr-org-todo-line-regexp)
8149 (org-odd-levels-only
8150 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8151 org-odd-levels-only
8152 tr-org-odd-levels-only)))
8153 (goto-char (point-min))
8154 (show-all)
8155 (if heading
8156 (progn
8157 (if (re-search-forward
8158 (concat "^" (regexp-quote heading)
8160 nil t)
8161 (goto-char (match-end 0))
8162 ;; Heading not found, just insert it at the end
8163 (goto-char (point-max))
8166 (end-of-line 0))
8167 ;; Make the subtree visible
8168 (show-subtree)
8169 (org-end-of-subtree t)
8173 ;; No specific heading, just go to end of file.
8175 ;; Paste
8176 (org-paste-subtree (org-get-valid-level level 1))
8178 ;; Mark the entry as done
8179 (when (and org-archive-mark-done
8180 (looking-at org-todo-line-regexp)
8181 (or (not (match-end 2))
8182 (not (member (match-string 2) org-done-keywords))))
8183 (let (org-log-done org-todo-log-states)
8184 (org-todo
8185 (car (or (member org-archive-mark-done org-done-keywords)
8186 org-done-keywords)))))
8188 ;; Add the context info
8189 (when org-archive-save-context-info
8190 (let ((l org-archive-save-context-info) e n v)
8191 (while (setq e (pop l))
8192 (when (and (setq v (symbol-value e))
8194 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8195 (org-entry-put (point) n v)))))
8197 ;; Save and kill the buffer, if it is not the same buffer.
8198 (if (not (eq this-buffer buffer))
8199 (progn (save-buffer) (kill-buffer buffer)))))
8200 ;; Here we are back in the original buffer. Everything seems to have
8201 ;; worked. So now cut the tree and finish up.
8202 (let (this-command) (org-cut-subtree))
8204 (message "Subtree archived %s"
8205 (if (eq this-buffer buffer)
8206 (concat "under heading: " heading)
8207 (concat "in file: " (abbreviate-file-name afile)))))))
8209 (defun org-refresh-category-properties ()
8210 "Refresh category text properties in teh buffer."
8211 (let ((def-cat (cond
8212 ((null org-category)
8213 (if buffer-file-name
8214 (file-name-sans-extension
8215 (file-name-nondirectory buffer-file-name))
8216 "???"))
8217 ((symbolp org-category) (symbol-name org-category))
8218 (t org-category)))
8219 beg end cat pos optionp)
8220 (org-unmodified
8221 (save-excursion
8222 (save-restriction
8223 (widen)
8224 (goto-char (point-min))
8225 (put-text-property (point) (point-max) 'org-category def-cat)
8226 (while (re-search-forward
8228 (setq pos (match-end 0)
8229 optionp (equal (char-after (match-beginning 0)) ?#)
8230 cat (org-trim (match-string 2)))
8231 (if optionp
8232 (setq beg (point-at-bol) end (point-max))
8233 (org-back-to-heading t)
8234 (setq beg (point) end (org-end-of-subtree t t)))
8235 (put-text-property beg end 'org-category cat)
8236 (goto-char pos)))))))
8238 (defun org-archive-all-done (&optional tag)
8239 "Archive sublevels of the current tree without open TODO items.
8240 If the cursor is not on a headline, try all level 1 trees. If
8241 it is on a headline, try all direct children.
8242 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8244 (rea (concat ".*:" org-archive-tag ":"))
8245 (begm (make-marker))
8246 (endm (make-marker))
8247 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8248 "Move subtree to archive (no open TODO items)? "))
8249 beg end (cntarch 0))
8250 (if (org-on-heading-p)
8251 (progn
8252 (setq re1 (concat "^" (regexp-quote
8253 (make-string
8254 (1+ (- (match-end 0) (match-beginning 0) 1))
8255 ?*))
8256 " "))
8257 (move-marker begm (point))
8258 (move-marker endm (org-end-of-subtree t)))
8259 (setq re1 "^* ")
8260 (move-marker begm (point-min))
8261 (move-marker endm (point-max)))
8262 (save-excursion
8263 (goto-char begm)
8264 (while (re-search-forward re1 endm t)
8265 (setq beg (match-beginning 0)
8266 end (save-excursion (org-end-of-subtree t) (point)))
8267 (goto-char beg)
8268 (if (re-search-forward re end t)
8269 (goto-char end)
8270 (goto-char beg)
8271 (if (and (or (not tag) (not (looking-at rea)))
8272 (y-or-n-p question))
8273 (progn
8274 (if tag
8275 (org-toggle-tag org-archive-tag 'on)
8276 (org-archive-subtree))
8277 (setq cntarch (1+ cntarch)))
8278 (goto-char end)))))
8279 (message "%d trees archived" cntarch)))
8281 (defun org-cycle-hide-drawers (state)
8282 "Re-hide all drawers after a visibility state change."
8283 (when (and (org-mode-p)
8284 (not (memq state '(overview folded))))
8285 (save-excursion
8286 (let* ((globalp (memq state '(contents all)))
8287 (beg (if globalp (point-min) (point)))
8288 (end (if globalp (point-max) (org-end-of-subtree t))))
8289 (goto-char beg)
8290 (while (re-search-forward org-drawer-regexp end t)
8291 (org-flag-drawer t))))))
8293 (defun org-flag-drawer (flag)
8294 (save-excursion
8295 (beginning-of-line 1)
8297 (let ((b (match-end 0))
8298 (outline-regexp org-outline-regexp))
8299 (if (re-search-forward
8301 (save-excursion (outline-next-heading) (point)) t)
8302 (outline-flag-region b (point-at-eol) flag)
8303 (error ":END: line missing"))))))
8305 (defun org-cycle-hide-archived-subtrees (state)
8306 "Re-hide all archived subtrees after a visibility state change."
8307 (when (and (not org-cycle-open-archived-trees)
8308 (not (memq state '(overview folded))))
8309 (save-excursion
8310 (let* ((globalp (memq state '(contents all)))
8311 (beg (if globalp (point-min) (point)))
8312 (end (if globalp (point-max) (org-end-of-subtree t))))
8313 (org-hide-archived-subtrees beg end)
8314 (goto-char beg)
8315 (if (looking-at (concat ".*:" org-archive-tag ":"))
8316 (message "%s" (substitute-command-keys
8317 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8319 (defun org-force-cycle-archived ()
8320 "Cycle subtree even if it is archived."
8321 (interactive)
8322 (setq this-command 'org-cycle)
8323 (let ((org-cycle-open-archived-trees t))
8324 (call-interactively 'org-cycle)))
8326 (defun org-hide-archived-subtrees (beg end)
8327 "Re-hide all archived subtrees after a visibility state change."
8328 (save-excursion
8329 (let* ((re (concat ":" org-archive-tag ":")))
8330 (goto-char beg)
8331 (while (re-search-forward re end t)
8332 (and (org-on-heading-p) (hide-subtree))
8333 (org-end-of-subtree t)))))
8335 (defun org-toggle-tag (tag &optional onoff)
8336 "Toggle the tag TAG for the current line.
8337 If ONOFF is `on' or `off', don't toggle but set to this state."
8338 (unless (org-on-heading-p t) (error "Not on headling"))
8339 (let (res current)
8340 (save-excursion
8341 (beginning-of-line)
8343 (point-at-eol) t)
8344 (progn
8345 (setq current (match-string 1))
8346 (replace-match ""))
8347 (setq current ""))
8348 (setq current (nreverse (org-split-string current ":")))
8349 (cond
8350 ((eq onoff 'on)
8351 (setq res t)
8352 (or (member tag current) (push tag current)))
8353 ((eq onoff 'off)
8354 (or (not (member tag current)) (setq current (delete tag current))))
8355 (t (if (member tag current)
8356 (setq current (delete tag current))
8357 (setq res t)
8358 (push tag current))))
8359 (end-of-line 1)
8360 (if current
8361 (progn
8362 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8363 (org-set-tags nil t))
8364 (delete-horizontal-space))
8365 (run-hooks 'org-after-tags-change-hook))
8366 res))
8368 (defun org-toggle-archive-tag (&optional arg)
8369 "Toggle the archive tag for the current headline.
8370 With prefix ARG, check all children of current headline and offer tagging
8371 the children that do not contain any open TODO items."
8372 (interactive "P")
8373 (if arg
8374 (org-archive-all-done 'tag)
8375 (let (set)
8376 (save-excursion
8377 (org-back-to-heading t)
8378 (setq set (org-toggle-tag org-archive-tag))
8379 (when set (hide-subtree)))
8380 (and set (beginning-of-line 1))
8381 (message "Subtree %s" (if set "archived" "unarchived")))))
8384 ;;;; Tables
8386 ;;; The table editor
8388 ;; Watch out: Here we are talking about two different kind of tables.
8389 ;; Most of the code is for the tables created with the Org-mode table editor.
8390 ;; Sometimes, we talk about tables created and edited with the table.el
8391 ;; Emacs package. We call the former org-type tables, and the latter
8392 ;; table.el-type tables.
8394 (defun org-before-change-function (beg end)
8395 "Every change indicates that a table might need an update."
8396 (setq org-table-may-need-update t))
8399 "Detects an org-type table line.")
8401 "Detects an org-type table line.")
8403 "Detects a table line marked for automatic recalculation.")
8405 "Detects a table line marked for automatic recalculation.")
8407 "Detects a table line marked for automatic recalculation.")
8409 "Detects an org-type table hline.")
8411 "Detects a table-type table hline.")
8413 "Detects an org-type or table-type table.")
8415 "Searching from within a table (any type) this finds the first line
8416 outside the table.")
8418 "Searching from within a table (any type) this finds the first line
8419 outside the table.")
8421 (defvar org-table-last-highlighted-reference nil)
8422 (defvar org-table-formula-history nil)
8424 (defvar org-table-column-names nil
8425 "Alist with column names, derived from the `!' line.")
8426 (defvar org-table-column-name-regexp nil
8427 "Regular expression matching the current column names.")
8428 (defvar org-table-local-parameters nil
8429 "Alist with parameter names, derived from the `$' line.")
8430 (defvar org-table-named-field-locations nil
8431 "Alist with locations of named fields.")
8433 (defvar org-table-current-line-types nil
8434 "Table row types, non-nil only for the duration of a comand.")
8435 (defvar org-table-current-begin-line nil
8436 "Table begin line, non-nil only for the duration of a comand.")
8437 (defvar org-table-current-begin-pos nil
8438 "Table begin position, non-nil only for the duration of a comand.")
8439 (defvar org-table-dlines nil
8440 "Vector of data line line numbers in the current table.")
8441 (defvar org-table-hlines nil
8442 "Vector of hline line numbers in the current table.")
8444 (defconst org-table-range-regexp
8445 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8446 ;; 1 2 3 4 5
8447 "Regular expression for matching ranges in formulas.")
8449 (defconst org-table-range-regexp2
8450 (concat
8454 "Match a range for reference display.")
8456 (defconst org-table-translate-regexp
8458 "Match a reference that needs translation, for reference display.")
8460 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8462 (defun org-table-create-with-table.el ()
8463 "Use the table.el package to insert a new table.
8464 If there is already a table at point, convert between Org-mode tables
8465 and table.el tables."
8466 (interactive)
8467 (require 'table)
8468 (cond
8469 ((org-at-table.el-p)
8470 (if (y-or-n-p "Convert table to Org-mode table? ")
8471 (org-table-convert)))
8472 ((org-at-table-p)
8473 (if (y-or-n-p "Convert table to table.el table? ")
8474 (org-table-convert)))
8475 (t (call-interactively 'table-insert))))
8477 (defun org-table-create-or-convert-from-region (arg)
8478 "Convert region to table, or create an empty table.
8479 If there is an active region, convert it to a table, using the function
8480 `org-table-convert-region'. See the documentation of that function
8481 to learn how the prefix argument is interpreted to determine the field
8482 separator.
8483 If there is no such region, create an empty table with `org-table-create'."
8484 (interactive "P")
8485 (if (org-region-active-p)
8486 (org-table-convert-region (region-beginning) (region-end) arg)
8487 (org-table-create arg)))
8489 (defun org-table-create (&optional size)
8490 "Query for a size and insert a table skeleton.
8492 (interactive "P")
8493 (unless size
8494 (setq size (read-string
8495 (concat "Table size Columns x Rows [e.g. "
8496 org-table-default-size "]: ")
8497 "" nil org-table-default-size)))
8499 (let* ((pos (point))
8500 (indent (make-string (current-column) ?\ ))
8501 (split (org-split-string size " *x *"))
8502 (rows (string-to-number (nth 1 split)))
8503 (columns (string-to-number (car split)))
8504 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8507 (point-at-bol) (point)))
8508 (beginning-of-line 1)
8509 (newline))
8510 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8511 (dotimes (i rows) (insert line))
8512 (goto-char pos)
8513 (if (> rows 1)
8514 ;; Insert a hline after the first row.
8515 (progn
8516 (end-of-line 1)
8518 (goto-char pos)))
8519 (org-table-align)))
8521 (defun org-table-convert-region (beg0 end0 &optional separator)
8522 "Convert region to a table.
8523 The region goes from BEG0 to END0, but these borders will be moved
8524 slightly, to make sure a beginning of line in the first line is included.
8526 SEPARATOR specifies the field separator in the lines. It can have the
8527 following values:
8529 '(4) Use the comma as a field separator
8530 '(16) Use a TAB as field separator
8531 integer When a number, use that many spaces as field separator
8532 nil When nil, the command tries to be smart and figure out the
8533 separator in the following way:
8534 - when each line contains a TAB, assume TAB-separated material
8535 - when each line contains a comme, assume CSV material
8536 - else, assume one or more SPACE charcters as separator."
8537 (interactive "rP")
8538 (let* ((beg (min beg0 end0))
8539 (end (max beg0 end0))
8540 re)
8541 (goto-char beg)
8542 (beginning-of-line 1)
8543 (setq beg (move-marker (make-marker) (point)))
8544 (goto-char end)
8545 (if (bolp) (backward-char 1) (end-of-line 1))
8546 (setq end (move-marker (make-marker) (point)))
8547 ;; Get the right field separator
8548 (unless separator
8549 (goto-char beg)
8550 (setq separator
8551 (cond
8554 (t 1))))
8555 (setq re (cond
8558 ((integerp separator)
8560 (t (error "This should not happen"))))
8561 (goto-char beg)
8562 (while (re-search-forward re end t)
8563 (replace-match "| " t t))
8564 (goto-char beg)
8565 (insert " ")
8566 (org-table-align)))
8568 (defun org-table-import (file arg)
8569 "Import FILE as a table.
8570 The file is assumed to be tab-separated. Such files can be produced by most
8571 spreadsheet and database applications. If no tabs (at least one per line)
8572 are found, lines will be split on whitespace into fields."
8574 (or (bolp) (newline))
8575 (let ((beg (point))
8576 (pm (point-max)))
8577 (insert-file-contents file)
8578 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8580 (defun org-table-export ()
8581 "Export table as a tab-separated file.
8582 Such a file can be imported into a spreadsheet program like Excel."
8583 (interactive)
8584 (let* ((beg (org-table-begin))
8585 (end (org-table-end))
8586 (table (buffer-substring beg end))
8587 (file (read-file-name "Export table to: "))
8588 buf)
8589 (unless (or (not (file-exists-p file))
8590 (y-or-n-p (format "Overwrite file %s? " file)))
8591 (error "Abort"))
8592 (with-current-buffer (find-file-noselect file)
8593 (setq buf (current-buffer))
8594 (erase-buffer)
8595 (fundamental-mode)
8596 (insert table)
8597 (goto-char (point-min))
8599 (replace-match "" t t)
8600 (end-of-line 1))
8601 (goto-char (point-min))
8603 (replace-match "" t t)
8604 (goto-char (min (1+ (point)) (point-max))))
8605 (goto-char (point-min))
8606 (while (re-search-forward "^-[-+]*$" nil t)
8607 (replace-match "")
8609 (delete-char 1)))
8610 (goto-char (point-min))
8613 (save-buffer))
8614 (kill-buffer buf)))
8616 (defvar org-table-aligned-begin-marker (make-marker)
8617 "Marker at the beginning of the table last aligned.
8618 Used to check if cursor still is in that table, to minimize realignment.")
8619 (defvar org-table-aligned-end-marker (make-marker)
8620 "Marker at the end of the table last aligned.
8621 Used to check if cursor still is in that table, to minimize realignment.")
8622 (defvar org-table-last-alignment nil
8623 "List of flags for flushright alignment, from the last re-alignment.
8624 This is being used to correctly align a single field after TAB or RET.")
8625 (defvar org-table-last-column-widths nil
8626 "List of max width of fields in each column.
8627 This is being used to correctly align a single field after TAB or RET.")
8628 (defvar org-table-overlay-coordinates nil
8629 "Overlay coordinates after each align of a table.")
8630 (make-variable-buffer-local 'org-table-overlay-coordinates)
8632 (defvar org-last-recalc-line nil)
8633 (defconst org-narrow-column-arrow "=>"
8634 "Used as display property in narrowed table columns.")
8636 (defun org-table-align ()
8637 "Align the table at point by aligning all vertical bars."
8638 (interactive)
8639 (let* (
8640 ;; Limits of table
8641 (beg (org-table-begin))
8642 (end (org-table-end))
8643 ;; Current cursor position
8644 (linepos (org-current-line))
8645 (colpos (org-table-current-column))
8646 (winstart (window-start))
8647 (winstartline (org-current-line (min winstart (1- (point-max)))))
8648 lines (new "") lengths l typenums ty fields maxfields i
8649 column
8650 (indent "") cnt frac
8651 rfmt hfmt
8652 (spaces '(1 . 1))
8653 (sp1 (car spaces))
8654 (sp2 (cdr spaces))
8655 (rfmt1 (concat
8656 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8657 (hfmt1 (concat
8658 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8659 emptystrings links dates emph narrow fmax f1 len c e)
8660 (untabify beg end)
8661 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8662 ;; Check if we have links or dates
8663 (goto-char beg)
8664 (setq links (re-search-forward org-bracket-link-regexp end t))
8665 (goto-char beg)
8666 (setq emph (and org-hide-emphasis-markers
8667 (re-search-forward org-emph-re end t)))
8668 (goto-char beg)
8669 (setq dates (and org-display-custom-times
8670 (re-search-forward org-ts-regexp-both end t)))
8671 ;; Make sure the link properties are right
8672 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8673 ;; Make sure the date properties are right
8674 (when dates (goto-char beg) (while (org-activate-dates end)))
8675 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8677 ;; Check if we are narrowing any columns
8678 (goto-char beg)
8679 (setq narrow (and org-format-transports-properties-p
8680 (re-search-forward "<[0-9]+>" end t)))
8681 ;; Get the rows
8682 (setq lines (org-split-string
8684 ;; Store the indentation of the first line
8685 (if (string-match "^ *" (car lines))
8686 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8687 ;; Mark the hlines by setting the corresponding element to nil
8688 ;; At the same time, we remove trailing space.
8689 (setq lines (mapcar (lambda (l)
8690 (if (string-match "^ *|-" l)
8691 nil
8693 (substring l 0 (match-beginning 0))
8694 l)))
8695 lines))
8696 ;; Get the data fields by splitting the lines.
8697 (setq fields (mapcar
8698 (lambda (l)
8699 (org-split-string l " *| *"))
8700 (delq nil (copy-sequence lines))))
8701 ;; How many fields in the longest line?
8702 (condition-case nil
8703 (setq maxfields (apply 'max (mapcar 'length fields)))
8704 (error
8705 (kill-region beg end)
8706 (org-table-create org-table-default-size)
8707 (error "Empty table - created default table")))
8708 ;; A list of empty strings to fill any short rows on output
8709 (setq emptystrings (make-list maxfields ""))
8710 ;; Check for special formatting.
8711 (setq i -1)
8712 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8713 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8714 ;; Check if there is an explicit width specified
8715 (when narrow
8716 (setq c column fmax nil)
8717 (while c
8718 (setq e (pop c))
8720 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8721 ;; Find fields that are wider than fmax, and shorten them
8722 (when fmax
8723 (loop for xx in column do
8724 (when (and (stringp xx)
8725 (> (org-string-width xx) fmax))
8726 (org-add-props xx nil
8727 'help-echo
8728 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8729 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8730 (unless (> f1 1)
8732 (match-string 0 xx)))
8733 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8734 (add-text-properties (- f1 2) f1
8735 (list 'display org-narrow-column-arrow)
8736 xx)))))
8737 ;; Get the maximum width for each column
8738 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8739 ;; Get the fraction of numbers, to decide about alignment of the column
8740 (setq cnt 0 frac 0.0)
8741 (loop for x in column do
8742 (if (equal x "")
8743 nil
8744 (setq frac ( / (+ (* frac cnt)
8745 (if (string-match org-table-number-regexp x) 1 0))
8746 (setq cnt (1+ cnt))))))
8747 (push (>= frac org-table-number-fraction) typenums))
8748 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8750 ;; Store the alignment of this table, for later editing of single fields
8751 (setq org-table-last-alignment typenums
8752 org-table-last-column-widths lengths)
8754 ;; With invisible characters, `format' does not get the field width right
8755 ;; So we need to make these fields wide by hand.
8756 (when (or links emph)
8757 (loop for i from 0 upto (1- maxfields) do
8758 (setq len (nth i lengths))
8759 (loop for j from 0 upto (1- (length fields)) do
8760 (setq c (nthcdr i (car (nthcdr j fields))))
8761 (if (and (stringp (car c))
8762 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8763 ; (string-match org-bracket-link-regexp (car c))
8764 (< (org-string-width (car c)) len))
8765 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8767 ;; Compute the formats needed for output of the table
8768 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8769 (while (setq l (pop lengths))
8770 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8771 (setq rfmt (concat rfmt (format rfmt1 ty l))
8772 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8776 (setq new (mapconcat
8777 (lambda (l)
8778 (if l (apply 'format rfmt
8779 (append (pop fields) emptystrings))
8780 hfmt))
8781 lines ""))
8782 ;; Replace the old one
8783 (delete-region beg end)
8784 (move-marker end nil)
8785 (move-marker org-table-aligned-begin-marker (point))
8786 (insert new)
8787 (move-marker org-table-aligned-end-marker (point))
8788 (when (and orgtbl-mode (not (org-mode-p)))
8789 (goto-char org-table-aligned-begin-marker)
8790 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8791 ;; Try to move to the old location
8792 (goto-line winstartline)
8793 (setq winstart (point-at-bol))
8794 (goto-line linepos)
8795 (set-window-start (selected-window) winstart 'noforce)
8796 (org-table-goto-column colpos)
8797 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8798 (setq org-table-may-need-update nil)
8799 ))
8801 (defun org-string-width (s)
8802 "Compute width of string, ignoring invisible characters.
8803 This ignores character with invisibility property `org-link', and also
8804 characters with property `org-cwidth', because these will become invisible
8805 upon the next fontification round."
8806 (let (b l)
8807 (when (or (eq t buffer-invisibility-spec)
8808 (assq 'org-link buffer-invisibility-spec))
8809 (while (setq b (text-property-any 0 (length s)
8810 'invisible 'org-link s))
8811 (setq s (concat (substring s 0 b)
8812 (substring s (or (next-single-property-change
8813 b 'invisible s) (length s)))))))
8814 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8815 (setq s (concat (substring s 0 b)
8816 (substring s (or (next-single-property-change
8817 b 'org-cwidth s) (length s))))))
8818 (setq l (string-width s) b -1)
8819 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8820 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8821 l))
8823 (defun org-table-begin (&optional table-type)
8824 "Find the beginning of the table and return its position.
8825 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8826 (save-excursion
8827 (if (not (re-search-backward
8828 (if table-type org-table-any-border-regexp
8829 org-table-border-regexp)
8830 nil t))
8831 (progn (goto-char (point-min)) (point))
8832 (goto-char (match-beginning 0))
8833 (beginning-of-line 2)
8834 (point))))
8836 (defun org-table-end (&optional table-type)
8837 "Find the end of the table and return its position.
8838 With argument TABLE-TYPE, go to the end of a table.el-type table."
8839 (save-excursion
8840 (if (not (re-search-forward
8841 (if table-type org-table-any-border-regexp
8842 org-table-border-regexp)
8843 nil t))
8844 (goto-char (point-max))
8845 (goto-char (match-beginning 0)))
8846 (point-marker)))
8848 (defun org-table-justify-field-maybe (&optional new)
8849 "Justify the current field, text to left, number to right.
8850 Optional argument NEW may specify text to replace the current field content."
8851 (cond
8852 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8853 ((org-at-table-hline-p))
8854 ((and (not new)
8855 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8856 (current-buffer)))
8857 (< (point) org-table-aligned-begin-marker)
8858 (>= (point) org-table-aligned-end-marker)))
8859 ;; This is not the same table, force a full re-align
8860 (setq org-table-may-need-update t))
8861 (t ;; realign the current field, based on previous full realign
8862 (let* ((pos (point)) s
8863 (col (org-table-current-column))
8864 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8865 l f n o e)
8866 (when (> col 0)
8869 (progn
8870 (setq s (match-string 1)
8871 o (match-string 0)
8872 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8873 e (not (= (match-beginning 2) (match-end 2))))
8874 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8875 l (if e "|" (setq org-table-may-need-update t) ""))
8876 n (format f s))
8877 (if new
8878 (if (<= (length new) l) ;; FIXME: length -> str-width?
8879 (setq n (format f new))
8880 (setq n (concat new "|") org-table-may-need-update t)))
8881 (or (equal n o)
8882 (let (org-table-may-need-update)
8883 (replace-match n t t))))
8884 (setq org-table-may-need-update t))
8885 (goto-char pos))))))
8887 (defun org-table-next-field ()
8888 "Go to the next field in the current table, creating new lines as needed.
8889 Before doing so, re-align the table if necessary."
8890 (interactive)
8891 (org-table-maybe-eval-formula)
8892 (org-table-maybe-recalculate-line)
8893 (if (and org-table-automatic-realign
8894 org-table-may-need-update)
8895 (org-table-align))
8896 (let ((end (org-table-end)))
8897 (if (org-at-table-hline-p)
8898 (end-of-line 1))
8899 (condition-case nil
8900 (progn
8901 (re-search-forward "|" end)
8903 (re-search-forward "|" end))
8904 (if (and (looking-at "-")
8905 org-table-tab-jumps-over-hlines
8907 (goto-char (match-beginning 1)))
8908 (if (looking-at "-")
8909 (progn
8910 (beginning-of-line 0)
8911 (org-table-insert-row 'below))
8912 (if (looking-at " ") (forward-char 1))))
8913 (error
8914 (org-table-insert-row 'below)))))
8916 (defun org-table-previous-field ()
8917 "Go to the previous field in the table.
8918 Before doing so, re-align the table if necessary."
8919 (interactive)
8920 (org-table-justify-field-maybe)
8921 (org-table-maybe-recalculate-line)
8922 (if (and org-table-automatic-realign
8923 org-table-may-need-update)
8924 (org-table-align))
8925 (if (org-at-table-hline-p)
8926 (end-of-line 1))
8927 (re-search-backward "|" (org-table-begin))
8928 (re-search-backward "|" (org-table-begin))
8930 (re-search-backward "|" (org-table-begin)))
8931 (if (looking-at "| ?")
8932 (goto-char (match-end 0))))
8934 (defun org-table-next-row ()
8935 "Go to the next row (same column) in the current table.
8936 Before doing so, re-align the table if necessary."
8937 (interactive)
8938 (org-table-maybe-eval-formula)
8939 (org-table-maybe-recalculate-line)
8942 (newline)
8943 (if (and org-table-automatic-realign
8944 org-table-may-need-update)
8945 (org-table-align))
8946 (let ((col (org-table-current-column)))
8947 (beginning-of-line 2)
8948 (if (or (not (org-at-table-p))
8949 (org-at-table-hline-p))
8950 (progn
8951 (beginning-of-line 0)
8952 (org-table-insert-row 'below)))
8953 (org-table-goto-column col)
8955 (if (looking-at " ") (forward-char 1)))))
8957 (defun org-table-copy-down (n)
8958 "Copy a field down in the current column.
8959 If the field at the cursor is empty, copy into it the content of the nearest
8960 non-empty field above. With argument N, use the Nth non-empty field.
8961 If the current field is not empty, it is copied down to the next row, and
8962 the cursor is moved with it. Therefore, repeating this command causes the
8963 column to be filled row-by-row.
8964 If the variable `org-table-copy-increment' is non-nil and the field is an
8965 integer or a timestamp, it will be incremented while copying. In the case of
8966 a timestamp, if the cursor is on the year, change the year. If it is on the
8967 month or the day, change that. Point will stay on the current date field
8968 in order to easily repeat the interval."
8969 (interactive "p")
8970 (let* ((colpos (org-table-current-column))
8971 (col (current-column))
8972 (field (org-table-get-field))
8974 (beg (org-table-begin))
8975 txt)
8976 (org-table-check-inside-data-field)
8977 (if non-empty
8978 (progn
8979 (setq txt (org-trim field))
8980 (org-table-next-row)
8981 (org-table-blank-field))
8982 (save-excursion
8983 (setq txt
8984 (catch 'exit
8985 (while (progn (beginning-of-line 1)
8986 (re-search-backward org-table-dataline-regexp
8987 beg t))
8988 (org-table-goto-column colpos t)
8989 (if (and (looking-at
8991 (= (setq n (1- n)) 0))
8992 (throw 'exit (match-string 1))))))))
8993 (if txt
8994 (progn
8995 (if (and org-table-copy-increment
8996 (string-match "^[0-9]+$" txt))
8997 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8998 (insert txt)
8999 (move-to-column col)
9000 (if (and org-table-copy-increment (org-at-timestamp-p t))
9001 (org-timestamp-up 1)
9002 (org-table-maybe-recalculate-line))
9003 (org-table-align)
9004 (move-to-column col))
9005 (error "No non-empty field found"))))
9007 (defun org-table-check-inside-data-field ()
9008 "Is point inside a table data field?
9009 I.e. not on a hline or before the first or after the last column?
9010 This actually throws an error, so it aborts the current command."
9011 (if (or (not (org-at-table-p))
9012 (= (org-table-current-column) 0)
9013 (org-at-table-hline-p)
9015 (error "Not in table data field")))
9017 (defvar org-table-clip nil
9018 "Clipboard for table regions.")
9020 (defun org-table-blank-field ()
9021 "Blank the current table field or active region."
9022 (interactive)
9023 (org-table-check-inside-data-field)
9024 (if (and (interactive-p) (org-region-active-p))
9025 (let (org-table-clip)
9026 (org-table-cut-region (region-beginning) (region-end)))
9027 (skip-chars-backward "^|")
9028 (backward-char 1)
9030 (let* ((pos (match-beginning 0))
9031 (match (match-string 0))
9032 (len (org-string-width match)))
9033 (replace-match (concat "|" (make-string (1- len) ?\ )))
9034 (goto-char (+ 2 pos))
9035 (substring match 1)))))
9037 (defun org-table-get-field (&optional n replace)
9038 "Return the value of the field in column N of current row.
9039 N defaults to current field.
9040 If REPLACE is a string, replace field with this value. The return value
9041 is always the old value."
9042 (and n (org-table-goto-column n))
9044 (backward-char 1)
9046 (let* ((pos (match-beginning 0))
9047 (val (buffer-substring (1+ pos) (match-end 0))))
9048 (if replace
9049 (replace-match (concat "|" replace) t t))
9050 (goto-char (min (point-at-eol) (+ 2 pos)))
9051 val)
9052 (forward-char 1) ""))
9054 (defun org-table-field-info (arg)
9055 "Show info about the current field, and highlight any reference at point."
9056 (interactive "P")
9057 (org-table-get-specials)
9058 (save-excursion
9059 (let* ((pos (point))
9060 (col (org-table-current-column))
9061 (cname (car (rassoc (int-to-string col) org-table-column-names)))
9062 (name (car (rassoc (list (org-current-line) col)
9063 org-table-named-field-locations)))
9064 (eql (org-table-get-stored-formulas))
9065 (dline (org-table-current-dline))
9066 (ref (format "@%d$%d" dline col))
9067 (ref1 (org-table-convert-refs-to-an ref))
9068 (fequation (or (assoc name eql) (assoc ref eql)))
9069 (cequation (assoc (int-to-string col) eql))
9070 (eqn (or fequation cequation)))
9071 (goto-char pos)
9072 (condition-case nil
9073 (org-table-show-reference 'local)
9074 (error nil))
9075 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
9076 dline col
9077 (if cname (concat " or $" cname) "")
9078 dline col ref1
9079 (if name (concat " or $" name) "")
9080 ;; FIXME: formula info not correct if special table line
9081 (if eqn
9082 (concat ", formula: "
9083 (org-table-formula-to-user
9084 (concat
9085 (if (string-match "^[$@]"(car eqn)) "" "$")
9086 (car eqn) "=" (cdr eqn))))
9087 "")))))
9089 (defun org-table-current-column ()
9090 "Find out which column we are in.
9091 When called interactively, column is also displayed in echo area."
9092 (interactive)
9093 (if (interactive-p) (org-table-check-inside-data-field))
9094 (save-excursion
9095 (let ((cnt 0) (pos (point)))
9096 (beginning-of-line 1)
9097 (while (search-forward "|" pos t)
9098 (setq cnt (1+ cnt)))
9099 (if (interactive-p) (message "This is table column %d" cnt))
9100 cnt)))
9102 (defun org-table-current-dline ()
9103 "Find out what table data line we are in.
9104 Only datalins count for this."
9105 (interactive)
9106 (if (interactive-p) (org-table-check-inside-data-field))
9107 (save-excursion
9108 (let ((cnt 0) (pos (point)))
9109 (goto-char (org-table-begin))
9110 (while (<= (point) pos)
9111 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
9112 (beginning-of-line 2))
9113 (if (interactive-p) (message "This is table line %d" cnt))
9114 cnt)))
9116 (defun org-table-goto-column (n &optional on-delim force)
9117 "Move the cursor to the Nth column in the current table line.
9118 With optional argument ON-DELIM, stop with point before the left delimiter
9119 of the field.
9120 If there are less than N fields, just go to after the last delimiter.
9121 However, when FORCE is non-nil, create new columns if necessary."
9122 (interactive "p")
9123 (let ((pos (point-at-eol)))
9124 (beginning-of-line 1)
9125 (when (> n 0)
9126 (while (and (> (setq n (1- n)) -1)
9127 (or (search-forward "|" pos t)
9128 (and force
9129 (progn (end-of-line 1)
9130 (skip-chars-backward "^|")
9131 (insert " | "))))))
9132 ; (backward-char 2) t)))))
9133 (when (and force (not (looking-at ".*|")))
9134 (save-excursion (end-of-line 1) (insert " | ")))
9135 (if on-delim
9136 (backward-char 1)
9137 (if (looking-at " ") (forward-char 1))))))
9139 (defun org-at-table-p (&optional table-type)
9140 "Return t if the cursor is inside an org-type table.
9141 If TABLE-TYPE is non-nil, also check for table.el-type tables."
9142 (if org-enable-table-editor
9143 (save-excursion
9144 (beginning-of-line 1)
9145 (looking-at (if table-type org-table-any-line-regexp
9146 org-table-line-regexp)))
9147 nil))
9149 (defun org-at-table.el-p ()
9150 "Return t if and only if we are at a table.el table."
9151 (and (org-at-table-p 'any)
9152 (save-excursion
9153 (goto-char (org-table-begin 'any))
9154 (looking-at org-table1-hline-regexp))))
9156 (defun org-table-recognize-table.el ()
9157 "If there is a table.el table nearby, recognize it and move into it."
9158 (if org-table-tab-recognizes-table.el
9159 (if (org-at-table.el-p)
9160 (progn
9161 (beginning-of-line 1)
9162 (if (looking-at org-table-dataline-regexp)
9163 nil
9164 (if (looking-at org-table1-hline-regexp)
9165 (progn
9166 (beginning-of-line 2)
9167 (if (looking-at org-table-any-border-regexp)
9168 (beginning-of-line -1)))))
9169 (if (re-search-forward "|" (org-table-end t) t)
9170 (progn
9171 (require 'table)
9172 (if (table--at-cell-p (point))
9173 t
9174 (message "recognizing table.el table...")
9175 (table-recognize-table)
9176 (message "recognizing table.el table...done")))
9177 (error "This should not happen..."))
9178 t)
9179 nil)
9180 nil))
9182 (defun org-at-table-hline-p ()
9183 "Return t if the cursor is inside a hline in a table."
9184 (if org-enable-table-editor
9185 (save-excursion
9186 (beginning-of-line 1)
9187 (looking-at org-table-hline-regexp))
9188 nil))
9190 (defun org-table-insert-column ()
9191 "Insert a new column into the table."
9192 (interactive)
9193 (if (not (org-at-table-p))
9194 (error "Not at a table"))
9195 (org-table-find-dataline)
9196 (let* ((col (max 1 (org-table-current-column)))
9197 (beg (org-table-begin))
9198 (end (org-table-end))
9199 ;; Current cursor position
9200 (linepos (org-current-line))
9201 (colpos col))
9202 (goto-char beg)
9203 (while (< (point) end)
9204 (if (org-at-table-hline-p)
9205 nil
9206 (org-table-goto-column col t)
9207 (insert "| "))
9208 (beginning-of-line 2))
9209 (move-marker end nil)
9210 (goto-line linepos)
9211 (org-table-goto-column colpos)
9212 (org-table-align)
9213 (org-table-fix-formulas "$" nil (1- col) 1)))
9215 (defun org-table-find-dataline ()
9216 "Find a dataline in the current table, which is needed for column commands."
9217 (if (and (org-at-table-p)
9218 (not (org-at-table-hline-p)))
9219 t
9220 (let ((col (current-column))
9221 (end (org-table-end)))
9222 (move-to-column col)
9223 (while (and (< (point) end)
9224 (or (not (= (current-column) col))
9225 (org-at-table-hline-p)))
9226 (beginning-of-line 2)
9227 (move-to-column col))
9228 (if (and (org-at-table-p)
9229 (not (org-at-table-hline-p)))
9230 t
9231 (error
9232 "Please position cursor in a data line for column operations")))))
9234 (defun org-table-delete-column ()
9235 "Delete a column from the table."
9236 (interactive)
9237 (if (not (org-at-table-p))
9238 (error "Not at a table"))
9239 (org-table-find-dataline)
9240 (org-table-check-inside-data-field)
9241 (let* ((col (org-table-current-column))
9242 (beg (org-table-begin))
9243 (end (org-table-end))
9244 ;; Current cursor position
9245 (linepos (org-current-line))
9246 (colpos col))
9247 (goto-char beg)
9248 (while (< (point) end)
9249 (if (org-at-table-hline-p)
9250 nil
9251 (org-table-goto-column col t)
9253 (replace-match "|")))
9254 (beginning-of-line 2))
9255 (move-marker end nil)
9256 (goto-line linepos)
9257 (org-table-goto-column colpos)
9258 (org-table-align)
9259 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9260 col -1 col)))
9262 (defun org-table-move-column-right ()
9263 "Move column to the right."
9264 (interactive)
9265 (org-table-move-column nil))
9266 (defun org-table-move-column-left ()
9267 "Move column to the left."
9268 (interactive)
9269 (org-table-move-column 'left))
9271 (defun org-table-move-column (&optional left)
9272 "Move the current column to the right. With arg LEFT, move to the left."
9273 (interactive "P")
9274 (if (not (org-at-table-p))
9275 (error "Not at a table"))
9276 (org-table-find-dataline)
9277 (org-table-check-inside-data-field)
9278 (let* ((col (org-table-current-column))
9279 (col1 (if left (1- col) col))
9280 (beg (org-table-begin))
9281 (end (org-table-end))
9282 ;; Current cursor position
9283 (linepos (org-current-line))
9284 (colpos (if left (1- col) (1+ col))))
9285 (if (and left (= col 1))
9286 (error "Cannot move column further left"))
9288 (error "Cannot move column further right"))
9289 (goto-char beg)
9290 (while (< (point) end)
9291 (if (org-at-table-hline-p)
9292 nil
9293 (org-table-goto-column col1 t)
9296 (beginning-of-line 2))
9297 (move-marker end nil)
9298 (goto-line linepos)
9299 (org-table-goto-column colpos)
9300 (org-table-align)
9301 (org-table-fix-formulas
9302 "$" (list (cons (number-to-string col) (number-to-string colpos))
9303 (cons (number-to-string colpos) (number-to-string col))))))
9305 (defun org-table-move-row-down ()
9306 "Move table row down."
9307 (interactive)
9308 (org-table-move-row nil))
9309 (defun org-table-move-row-up ()
9310 "Move table row up."
9311 (interactive)
9312 (org-table-move-row 'up))
9314 (defun org-table-move-row (&optional up)
9315 "Move the current table line down. With arg UP, move it up."
9316 (interactive "P")
9317 (let* ((col (current-column))
9318 (pos (point))
9319 (hline1p (save-excursion (beginning-of-line 1)
9320 (looking-at org-table-hline-regexp)))
9321 (dline1 (org-table-current-dline))
9322 (dline2 (+ dline1 (if up -1 1)))
9323 (tonew (if up 0 2))
9324 txt hline2p)
9325 (beginning-of-line tonew)
9326 (unless (org-at-table-p)
9327 (goto-char pos)
9328 (error "Cannot move row further"))
9329 (setq hline2p (looking-at org-table-hline-regexp))
9330 (goto-char pos)
9331 (beginning-of-line 1)
9332 (setq pos (point))
9333 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9334 (delete-region (point) (1+ (point-at-eol)))
9335 (beginning-of-line tonew)
9336 (insert txt)
9337 (beginning-of-line 0)
9338 (move-to-column col)
9339 (unless (or hline1p hline2p)
9340 (org-table-fix-formulas
9341 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9342 (cons (number-to-string dline2) (number-to-string dline1)))))))
9344 (defun org-table-insert-row (&optional arg)
9345 "Insert a new row above the current line into the table.
9346 With prefix ARG, insert below the current line."
9347 (interactive "P")
9348 (if (not (org-at-table-p))
9349 (error "Not at a table"))
9350 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9351 (new (org-table-clean-line line)))
9352 ;; Fix the first field if necessary
9354 (setq new (replace-match (match-string 0 line) t t new)))
9355 (beginning-of-line (if arg 2 1))
9357 (beginning-of-line 0)
9358 (re-search-forward "| ?" (point-at-eol) t)
9359 (and (or org-table-may-need-update org-table-overlay-coordinates)
9360 (org-table-align))
9361 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9363 (defun org-table-insert-hline (&optional above)
9364 "Insert a horizontal-line below the current line into the table.
9365 With prefix ABOVE, insert above the current line."
9366 (interactive "P")
9367 (if (not (org-at-table-p))
9368 (error "Not at a table"))
9369 (let ((line (org-table-clean-line
9370 (buffer-substring (point-at-bol) (point-at-eol))))
9371 (col (current-column)))
9373 (setq line (replace-match
9374 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9375 ?-) "|") t t line)))
9377 (beginning-of-line (if above 1 2))
9379 (beginning-of-line (if above 1 -1))
9380 (move-to-column col)
9381 (and org-table-overlay-coordinates (org-table-align))))
9383 (defun org-table-hline-and-move (&optional same-column)
9384 "Insert a hline and move to the row below that line."
9385 (interactive "P")
9386 (let ((col (org-table-current-column)))
9387 (org-table-maybe-eval-formula)
9388 (org-table-maybe-recalculate-line)
9389 (org-table-insert-hline)
9390 (end-of-line 2)
9393 (org-table-next-field))
9394 (if same-column (org-table-goto-column col))))
9396 (defun org-table-clean-line (s)
9398 In particular, this does handle wide and invisible characters."
9400 ;; It's a hline, just map the characters
9401 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9403 (setq s (replace-match
9404 (concat "|" (make-string (org-string-width (match-string 1 s))
9405 ?\ ) "|")
9406 t t s)))
9407 s))
9409 (defun org-table-kill-row ()
9410 "Delete the current row or horizontal line from the table."
9411 (interactive)
9412 (if (not (org-at-table-p))
9413 (error "Not at a table"))
9414 (let ((col (current-column))
9415 (dline (org-table-current-dline)))
9416 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9417 (if (not (org-at-table-p)) (beginning-of-line 0))
9418 (move-to-column col)
9419 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9420 dline -1 dline)))
9422 (defun org-table-sort-lines (with-case &optional sorting-type)
9423 "Sort table lines according to the column at point.
9425 The position of point indicates the column to be used for
9426 sorting, and the range of lines is the range between the nearest
9427 horizontal separator lines, or the entire table of no such lines
9428 exist. If point is before the first column, you will be prompted
9429 for the sorting column. If there is an active region, the mark
9430 specifies the first line and the sorting column, while point
9431 should be in the last line to be included into the sorting.
9433 The command then prompts for the sorting type which can be
9434 alphabetically, numerically, or by time (as given in a time stamp
9435 in the field). Sorting in reverse order is also possible.
9437 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9439 If SORTING-TYPE is specified when this function is called from a Lisp
9440 program, no prompting will take place. SORTING-TYPE must be a character,
9441 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9442 should be done in reverse order."
9443 (interactive "P")
9444 (let* ((thisline (org-current-line))
9445 (thiscol (org-table-current-column))
9446 beg end bcol ecol tend tbeg column lns pos)
9447 (when (equal thiscol 0)
9448 (if (interactive-p)
9449 (setq thiscol
9450 (string-to-number
9451 (read-string "Use column N for sorting: ")))
9452 (setq thiscol 1))
9453 (org-table-goto-column thiscol))
9454 (org-table-check-inside-data-field)
9455 (if (org-region-active-p)
9456 (progn
9457 (setq beg (region-beginning) end (region-end))
9458 (goto-char beg)
9459 (setq column (org-table-current-column)
9460 beg (point-at-bol))
9461 (goto-char end)
9462 (setq end (point-at-bol 2)))
9463 (setq column (org-table-current-column)
9464 pos (point)
9465 tbeg (org-table-begin)
9466 tend (org-table-end))
9467 (if (re-search-backward org-table-hline-regexp tbeg t)
9468 (setq beg (point-at-bol 2))
9469 (goto-char tbeg)
9470 (setq beg (point-at-bol 1)))
9471 (goto-char pos)
9472 (if (re-search-forward org-table-hline-regexp tend t)
9473 (setq end (point-at-bol 1))
9474 (goto-char tend)
9475 (setq end (point-at-bol))))
9476 (setq beg (move-marker (make-marker) beg)
9477 end (move-marker (make-marker) end))
9478 (untabify beg end)
9479 (goto-char beg)
9480 (org-table-goto-column column)
9481 (skip-chars-backward "^|")
9482 (setq bcol (current-column))
9483 (org-table-goto-column (1+ column))
9484 (skip-chars-backward "^|")
9485 (setq ecol (1- (current-column)))
9486 (org-table-goto-column column)
9487 (setq lns (mapcar (lambda(x) (cons
9488 (org-sort-remove-invisible
9489 (nth (1- column)
9491 x))
9493 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9494 (delete-region beg end)
9495 (move-marker beg nil)
9496 (move-marker end nil)
9498 (goto-line thisline)
9499 (org-table-goto-column thiscol)
9500 (message "%d lines sorted, based on column %d" (length lns) column)))
9502 ;; FIXME: maybe we will not need this? Table sorting is broken....
9503 (defun org-sort-remove-invisible (s)
9504 (remove-text-properties 0 (length s) org-rm-props s)
9505 (while (string-match org-bracket-link-regexp s)
9506 (setq s (replace-match (if (match-end 2)
9507 (match-string 3 s)
9508 (match-string 1 s)) t t s)))
9509 s)
9511 (defun org-table-cut-region (beg end)
9512 "Copy region in table to the clipboard and blank all relevant fields."
9513 (interactive "r")
9514 (org-table-copy-region beg end 'cut))
9516 (defun org-table-copy-region (beg end &optional cut)
9517 "Copy rectangular region in table to clipboard.
9518 A special clipboard is used which can only be accessed
9519 with `org-table-paste-rectangle'."
9520 (interactive "rP")
9521 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9522 region cols
9523 (rpl (if cut " " nil)))
9524 (goto-char beg)
9525 (org-table-check-inside-data-field)
9526 (setq l01 (org-current-line)
9527 c01 (org-table-current-column))
9528 (goto-char end)
9529 (org-table-check-inside-data-field)
9530 (setq l02 (org-current-line)
9531 c02 (org-table-current-column))
9532 (setq l1 (min l01 l02) l2 (max l01 l02)
9533 c1 (min c01 c02) c2 (max c01 c02))
9534 (catch 'exit
9535 (while t
9536 (catch 'nextline
9537 (if (> l1 l2) (throw 'exit t))
9538 (goto-line l1)
9539 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9540 (setq cols nil ic1 c1 ic2 c2)
9541 (while (< ic1 (1+ ic2))
9542 (push (org-table-get-field ic1 rpl) cols)
9543 (setq ic1 (1+ ic1)))
9544 (push (nreverse cols) region)
9545 (setq l1 (1+ l1)))))
9546 (setq org-table-clip (nreverse region))
9547 (if cut (org-table-align))
9548 org-table-clip))
9550 (defun org-table-paste-rectangle ()
9551 "Paste a rectangular region into a table.
9552 The upper right corner ends up in the current field. All involved fields
9553 will be overwritten. If the rectangle does not fit into the present table,
9554 the table is enlarged as needed. The process ignores horizontal separator
9555 lines."
9556 (interactive)
9557 (unless (and org-table-clip (listp org-table-clip))
9558 (error "First cut/copy a region to paste!"))
9559 (org-table-check-inside-data-field)
9560 (let* ((clip org-table-clip)
9561 (line (org-current-line))
9562 (col (org-table-current-column))
9563 (org-enable-table-editor t)
9564 (org-table-automatic-realign nil)
9565 c cols field)
9566 (while (setq cols (pop clip))
9567 (while (org-at-table-hline-p) (beginning-of-line 2))
9568 (if (not (org-at-table-p))
9569 (progn (end-of-line 0) (org-table-next-field)))
9570 (setq c col)
9571 (while (setq field (pop cols))
9572 (org-table-goto-column c nil 'force)
9573 (org-table-get-field nil field)
9574 (setq c (1+ c)))
9575 (beginning-of-line 2))
9576 (goto-line line)
9577 (org-table-goto-column col)
9578 (org-table-align)))
9580 (defun org-table-convert ()
9581 "Convert from `org-mode' table to table.el and back.
9582 Obviously, this only works within limits. When an Org-mode table is
9583 converted to table.el, all horizontal separator lines get lost, because
9584 table.el uses these as cell boundaries and has no notion of horizontal lines.
9585 A table.el table can be converted to an Org-mode table only if it does not
9586 do row or column spanning. Multiline cells will become multiple cells.
9587 Beware, Org-mode does not test if the table can be successfully converted - it
9588 blindly applies a recipe that works for simple tables."
9589 (interactive)
9590 (require 'table)
9591 (if (org-at-table.el-p)
9592 ;; convert to Org-mode table
9593 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9594 (end (move-marker (make-marker) (org-table-end t))))
9595 (table-unrecognize-region beg end)
9596 (goto-char beg)
9598 (replace-match ""))
9599 (goto-char beg))
9600 (if (org-at-table-p)
9601 ;; convert to table.el table
9602 (let ((beg (move-marker (make-marker) (org-table-begin)))
9603 (end (move-marker (make-marker) (org-table-end))))
9604 ;; first, get rid of all horizontal lines
9605 (goto-char beg)
9607 (replace-match ""))
9608 ;; insert a hline before first
9609 (goto-char beg)
9610 (org-table-insert-hline 'above)
9611 (beginning-of-line -1)
9612 ;; insert a hline after each line
9613 (while (progn (beginning-of-line 3) (< (point) end))
9614 (org-table-insert-hline))
9615 (goto-char beg)
9616 (setq end (move-marker end (org-table-end)))
9617 ;; replace "+" at beginning and ending of hlines
9620 (goto-char beg)
9622 (replace-match "-+"))
9623 (goto-char beg)))))
9625 (defun org-table-wrap-region (arg)
9626 "Wrap several fields in a column like a paragraph.
9627 This is useful if you'd like to spread the contents of a field over several
9628 lines, in order to keep the table compact.
9630 If there is an active region, and both point and mark are in the same column,
9631 the text in the column is wrapped to minimum width for the given number of
9632 lines. Generally, this makes the table more compact. A prefix ARG may be
9634 formats the selected text to two lines. If the region was longer than two
9635 lines, the remaining lines remain empty. A negative prefix argument reduces
9636 the current number of lines by that amount. The wrapped text is pasted back
9637 into the table. If you formatted it to more lines than it was before, fields
9638 further down in the table get overwritten - so you might need to make space in
9639 the table first.
9641 If there is no region, the current field is split at the cursor position and
9642 the text fragment to the right of the cursor is prepended to the field one
9643 line down.
9645 If there is no region, but you specify a prefix ARG, the current field gets
9646 blank, and the content is appended to the field above."
9647 (interactive "P")
9648 (org-table-check-inside-data-field)
9649 (if (org-region-active-p)
9650 ;; There is a region: fill as a paragraph
9651 (let* ((beg (region-beginning))
9652 (cline (save-excursion (goto-char beg) (org-current-line)))
9653 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9654 nlines)
9655 (org-table-cut-region (region-beginning) (region-end))
9656 (if (> (length (car org-table-clip)) 1)
9657 (error "Region must be limited to single column"))
9658 (setq nlines (if arg
9659 (if (< arg 1)
9660 (+ (length org-table-clip) arg)
9661 arg)
9662 (length org-table-clip)))
9663 (setq org-table-clip
9664 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9665 nil nlines)))
9666 (goto-line cline)
9667 (org-table-goto-column ccol)
9668 (org-table-paste-rectangle))
9669 ;; No region, split the current field at point
9670 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9672 (if arg
9673 ;; combine with field above
9674 (let ((s (org-table-blank-field))
9675 (col (org-table-current-column)))
9676 (beginning-of-line 0)
9677 (while (org-at-table-hline-p) (beginning-of-line 0))
9678 (org-table-goto-column col)
9679 (skip-chars-forward "^|")
9680 (skip-chars-backward " ")
9681 (insert " " (org-trim s))
9682 (org-table-align))
9683 ;; split field
9685 (let ((s (match-string 1)))
9686 (replace-match " |")
9687 (goto-char (match-beginning 0))
9688 (org-table-next-row)
9689 (insert (org-trim s) " ")
9690 (org-table-align))
9691 (org-table-next-row)))))
9693 (defvar org-field-marker nil)
9695 (defun org-table-edit-field (arg)
9696 "Edit table field in a different window.
9697 This is mainly useful for fields that contain hidden parts.
9699 it can be edited in place."
9700 (interactive "P")
9701 (if arg
9702 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9704 (remove-text-properties b e '(org-cwidth t invisible t
9705 display t intangible t))
9706 (if (and (boundp 'font-lock-mode) font-lock-mode)
9707 (font-lock-fontify-block)))
9708 (let ((pos (move-marker (make-marker) (point)))
9709 (field (org-table-get-field))
9710 (cw (current-window-configuration))
9711 p)
9712 (org-switch-to-buffer-other-window "*Org tmp*")
9713 (erase-buffer)
9715 (let ((org-inhibit-startup t)) (org-mode))
9716 (goto-char (setq p (point-max)))
9717 (insert (org-trim field))
9718 (remove-text-properties p (point-max)
9719 '(invisible t org-cwidth t display t
9720 intangible t))
9721 (goto-char p)
9722 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9723 (org-set-local 'org-window-configuration cw)
9724 (org-set-local 'org-field-marker pos)
9725 (message "Edit and finish with C-c C-c"))))
9727 (defun org-table-finish-edit-field ()
9728 "Finish editing a table data field.
9729 Remove all newline characters, insert the result into the table, realign
9730 the table and kill the editing buffer."
9731 (let ((pos org-field-marker)
9732 (cw org-window-configuration)
9733 (cb (current-buffer))
9734 text)
9735 (goto-char (point-min))
9738 (replace-match " "))
9739 (setq text (org-trim (buffer-string)))
9740 (set-window-configuration cw)
9741 (kill-buffer cb)
9742 (select-window (get-buffer-window (marker-buffer pos)))
9743 (goto-char pos)
9744 (move-marker pos nil)
9745 (org-table-check-inside-data-field)
9746 (org-table-get-field nil text)
9747 (org-table-align)
9748 (message "New field value inserted")))
9750 (defun org-trim (s)
9751 "Remove whitespace at beginning and end of string."
9754 s)
9756 (defun org-wrap (string &optional width lines)
9757 "Wrap string to either a number of lines, or a width in characters.
9758 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9759 that costs. If there is a word longer than WIDTH, the text is actually
9760 wrapped to the length of that word.
9761 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9762 many lines, whatever width that takes.
9763 The return value is a list of lines, without newlines at the end."
9765 (maxword (apply 'max (mapcar 'org-string-width words)))
9766 w ll)
9767 (cond (width
9768 (org-do-wrap words (max maxword width)))
9769 (lines
9770 (setq w maxword)
9771 (setq ll (org-do-wrap words maxword))
9772 (if (<= (length ll) lines)
9773 ll
9774 (setq ll words)
9775 (while (> (length ll) lines)
9776 (setq w (1+ w))
9777 (setq ll (org-do-wrap words w)))
9778 ll))
9779 (t (error "Cannot wrap this")))))
9782 (defun org-do-wrap (words width)
9783 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9784 (let (lines line)
9785 (while words
9786 (setq line (pop words))
9787 (while (and words (< (+ (length line) (length (car words))) width))
9788 (setq line (concat line " " (pop words))))
9789 (setq lines (push line lines)))
9790 (nreverse lines)))
9792 (defun org-split-string (string &optional separators)
9793 "Splits STRING into substrings at SEPARATORS.
9794 No empty strings are returned if there are matches at the beginning
9795 and end of string."
9797 (start 0)
9798 notfirst
9799 (list nil))
9800 (while (and (string-match rexp string
9801 (if (and notfirst
9802 (= start (match-beginning 0))
9803 (< start (length string)))
9804 (1+ start) start))
9805 (< (match-beginning 0) (length string)))
9806 (setq notfirst t)
9807 (or (eq (match-beginning 0) 0)
9808 (and (eq (match-beginning 0) (match-end 0))
9809 (eq (match-beginning 0) start))
9810 (setq list
9811 (cons (substring string start (match-beginning 0))
9812 list)))
9813 (setq start (match-end 0)))
9814 (or (eq start (length string))
9815 (setq list
9816 (cons (substring string start)
9817 list)))
9818 (nreverse list)))
9820 (defun org-table-map-tables (function)
9821 "Apply FUNCTION to the start of all tables in the buffer."
9822 (save-excursion
9823 (save-restriction
9824 (widen)
9825 (goto-char (point-min))
9826 (while (re-search-forward org-table-any-line-regexp nil t)
9827 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9828 (beginning-of-line 1)
9829 (if (looking-at org-table-line-regexp)
9830 (save-excursion (funcall function)))
9831 (re-search-forward org-table-any-border-regexp nil 1))))
9832 (message "Mapping tables: done"))
9834 (defvar org-timecnt) ; dynamically scoped parameter
9836 (defun org-table-sum (&optional beg end nlast)
9837 "Sum numbers in region of current table column.
9838 The result will be displayed in the echo area, and will be available
9841 If there is an active region, it is interpreted as a rectangle and all
9842 numbers in that rectangle will be summed. If there is no active
9843 region and point is located in a table column, sum all numbers in that
9844 column.
9846 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9847 numbers are assumed to be times as well (in decimal hours) and the
9848 numbers are added as such.
9850 If NLAST is a number, only the NLAST fields will actually be summed."
9851 (interactive)
9852 (save-excursion
9853 (let (col (org-timecnt 0) diff h m s org-table-clip)
9854 (cond
9855 ((and beg end)) ; beg and end given explicitly
9856 ((org-region-active-p)
9857 (setq beg (region-beginning) end (region-end)))
9858 (t
9859 (setq col (org-table-current-column))
9860 (goto-char (org-table-begin))
9862 (error "No table data"))
9863 (org-table-goto-column col)
9864 (setq beg (point))
9865 (goto-char (org-table-end))
9867 (error "No table data"))
9868 (org-table-goto-column col)
9869 (setq end (point))))
9870 (let* ((items (apply 'append (org-table-copy-region beg end)))
9871 (items1 (cond ((not nlast) items)
9872 ((>= nlast (length items)) items)
9873 (t (setq items (reverse items))
9874 (setcdr (nthcdr (1- nlast) items) nil)
9875 (nreverse items))))
9876 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9877 items1)))
9878 (res (apply '+ numbers))
9879 (sres (if (= org-timecnt 0)
9880 (format "%g" res)
9881 (setq diff (* 3600 res)
9882 h (floor (/ diff 3600)) diff (mod diff 3600)
9883 m (floor (/ diff 60)) diff (mod diff 60)
9884 s diff)
9885 (format "%d:%02d:%02d" h m s))))
9886 (kill-new sres)
9887 (if (interactive-p)
9888 (message "%s"
9889 (substitute-command-keys
9891 (length numbers) sres))))
9892 sres))))
9894 (defun org-table-get-number-for-summing (s)
9895 (let (n)
9896 (if (string-match "^ *|? *" s)
9897 (setq s (replace-match "" nil nil s)))
9898 (if (string-match " *|? *$" s)
9899 (setq s (replace-match "" nil nil s)))
9900 (setq n (string-to-number s))
9901 (cond
9902 ((and (string-match "0" s)
9906 (let ((h (string-to-number (or (match-string 1 s) "0")))
9907 (m (string-to-number (or (match-string 2 s) "0")))
9908 (s (string-to-number (or (match-string 4 s) "0"))))
9909 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9910 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9911 ((equal n 0) nil)
9912 (t n))))
9914 (defun org-table-current-field-formula (&optional key noerror)
9915 "Return the formula active for the current field.
9916 Assumes that specials are in place.
9917 If KEY is given, return the key to this formula.
9919 (let* ((name (car (rassoc (list (org-current-line)
9920 (org-table-current-column))
9921 org-table-named-field-locations)))
9922 (col (org-table-current-column))
9923 (scol (int-to-string col))
9924 (ref (format "@%d$%d" (org-table-current-dline) col))
9925 (stored-list (org-table-get-stored-formulas noerror))
9926 (ass (or (assoc name stored-list)
9927 (assoc ref stored-list)
9928 (assoc scol stored-list))))
9929 (if key
9930 (car ass)
9931 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9932 (cdr ass))))))
9934 (defun org-table-get-formula (&optional equation named)
9935 "Read a formula from the minibuffer, offer stored formula as default.
9936 When NAMED is non-nil, look for a named equation."
9937 (let* ((stored-list (org-table-get-stored-formulas))
9938 (name (car (rassoc (list (org-current-line)
9939 (org-table-current-column))
9940 org-table-named-field-locations)))
9941 (ref (format "@%d$%d" (org-table-current-dline)
9942 (org-table-current-column)))
9943 (refass (assoc ref stored-list))
9944 (scol (if named
9945 (if name name ref)
9946 (int-to-string (org-table-current-column))))
9947 (dummy (and (or name refass) (not named)
9948 (not (y-or-n-p "Replace field formula with column formula? " ))
9949 (error "Abort")))
9950 (name (or name ref))
9951 (org-table-may-need-update nil)
9952 (stored (cdr (assoc scol stored-list)))
9953 (eq (cond
9954 ((and stored equation (string-match "^ *=? *$" equation))
9955 stored)
9956 ((stringp equation)
9957 equation)
9958 (t (org-table-formula-from-user
9959 (read-string
9960 (org-table-formula-to-user
9961 (format "%s formula %s%s="
9962 (if named "Field" "Column")
9963 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9964 scol))
9965 (if stored (org-table-formula-to-user stored) "")
9966 'org-table-formula-history
9967 )))))
9968 mustsave)
9970 ;; remove formula
9971 (setq stored-list (delq (assoc scol stored-list) stored-list))
9972 (org-table-store-formulas stored-list)
9973 (error "Formula removed"))
9974 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9975 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9976 (if (and name (not named))
9977 ;; We set the column equation, delete the named one.
9978 (setq stored-list (delq (assoc name stored-list) stored-list)
9979 mustsave t))
9980 (if stored
9981 (setcdr (assoc scol stored-list) eq)
9982 (setq stored-list (cons (cons scol eq) stored-list)))
9983 (if (or mustsave (not (equal stored eq)))
9984 (org-table-store-formulas stored-list))
9985 eq))
9987 (defun org-table-store-formulas (alist)
9988 "Store the list of formulas below the current table."
9989 (setq alist (sort alist 'org-table-formula-less-p))
9990 (save-excursion
9991 (goto-char (org-table-end))
9993 (progn
9994 ;; don't overwrite TBLFM, we might use text properties to store stuff
9995 (goto-char (match-beginning 2))
9996 (delete-region (match-beginning 2) (match-end 0)))
9997 (insert "#+TBLFM:"))
9998 (insert " "
9999 (mapconcat (lambda (x)
10000 (concat
10001 (if (equal (string-to-char (car x)) ?@) "" "$")
10002 (car x) "=" (cdr x)))
10003 alist "::")
10006 (defsubst org-table-formula-make-cmp-string (a)
10008 (concat
10009 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
10010 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
10011 (if (match-end 5) (concat "@@" (match-string 5 a))))))
10013 (defun org-table-formula-less-p (a b)
10014 "Compare two formulas for sorting."
10015 (let ((as (org-table-formula-make-cmp-string (car a)))
10016 (bs (org-table-formula-make-cmp-string (car b))))
10017 (and as bs (string< as bs))))
10019 (defun org-table-get-stored-formulas (&optional noerror)
10020 "Return an alist with the stored formulas directly after current table."
10021 (interactive)
10022 (let (scol eq eq-alist strings string seen)
10023 (save-excursion
10024 (goto-char (org-table-end))
10026 (setq strings (org-split-string (match-string 2) " *:: *"))
10027 (while (setq string (pop strings))
10028 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
10029 (setq scol (if (match-end 2)
10030 (match-string 2 string)
10031 (match-string 1 string))
10032 eq (match-string 3 string)
10033 eq-alist (cons (cons scol eq) eq-alist))
10034 (if (member scol seen)
10035 (if noerror
10036 (progn
10037 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
10038 (ding)
10039 (sit-for 2))
10040 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
10041 (push scol seen))))))
10042 (nreverse eq-alist)))
10044 (defun org-table-fix-formulas (key replace &optional limit delta remove)
10045 "Modify the equations after the table structure has been edited.
10047 For all numbers larger than LIMIT, shift them by DELTA."
10048 (save-excursion
10049 (goto-char (org-table-end))
10052 (re2
10053 (when remove
10054 (if (equal key "$")
10057 s n a)
10058 (when remove
10059 (while (re-search-forward re2 (point-at-eol) t)
10060 (replace-match "")))
10061 (while (re-search-forward re (point-at-eol) t)
10062 (setq s (match-string 1) n (string-to-number s))
10063 (cond
10064 ((setq a (assoc s replace))
10065 (replace-match (concat key (cdr a)) t t))
10066 ((and limit (> n limit))
10067 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
10069 (defun org-table-get-specials ()
10070 "Get the column names and local parameters for this table."
10071 (save-excursion
10072 (let ((beg (org-table-begin)) (end (org-table-end))
10073 names name fields fields1 field cnt
10074 c v l line col types dlines hlines)
10075 (setq org-table-column-names nil
10076 org-table-local-parameters nil
10077 org-table-named-field-locations nil
10078 org-table-current-begin-line nil
10079 org-table-current-begin-pos nil
10080 org-table-current-line-types nil)
10081 (goto-char beg)
10083 (setq names (org-split-string (match-string 1) " *| *")
10084 cnt 1)
10085 (while (setq name (pop names))
10086 (setq cnt (1+ cnt))
10087 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
10088 (push (cons name (int-to-string cnt)) org-table-column-names))))
10089 (setq org-table-column-names (nreverse org-table-column-names))
10090 (setq org-table-column-name-regexp
10092 (goto-char beg)
10094 (setq fields (org-split-string (match-string 1) " *| *"))
10095 (while (setq field (pop fields))
10097 (push (cons (match-string 1 field) (match-string 2 field))
10098 org-table-local-parameters))))
10099 (goto-char beg)
10101 (setq c (match-string 1)
10102 fields (org-split-string (match-string 2) " *| *"))
10103 (save-excursion
10104 (beginning-of-line (if (equal c "_") 2 0))
10105 (setq line (org-current-line) col 1)
10107 (setq fields1 (org-split-string (match-string 1) " *| *"))))
10108 (while (and fields1 (setq field (pop fields)))
10109 (setq v (pop fields1) col (1+ col))
10110 (when (and (stringp field) (stringp v)
10111 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
10112 (push (cons field v) org-table-local-parameters)
10113 (push (list field line col) org-table-named-field-locations))))
10114 ;; Analyse the line types
10115 (goto-char beg)
10116 (setq org-table-current-begin-line (org-current-line)
10117 org-table-current-begin-pos (point)
10118 l org-table-current-begin-line)
10120 (push (if (match-end 1) 'hline 'dline) types)
10121 (if (match-end 1) (push l hlines) (push l dlines))
10122 (beginning-of-line 2)
10123 (setq l (1+ l)))
10124 (setq org-table-current-line-types (apply 'vector (nreverse types))
10125 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
10126 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
10128 (defun org-table-maybe-eval-formula ()
10130 If yes, store the formula and apply it."
10131 ;; We already know we are in a table. Get field will only return a formula
10132 ;; when appropriate. It might return a separator line, but no problem.
10133 (when org-table-formula-evaluate-inline
10134 (let* ((field (org-trim (or (org-table-get-field) "")))
10135 named eq)
10137 (setq named (equal (string-to-char field) ?:)
10138 eq (match-string 1 field))
10139 (if (or (fboundp 'calc-eval)
10140 (equal (substring eq 0 (min 2 (length eq))) "'("))
10141 (org-table-eval-formula (if named '(4) nil)
10142 (org-table-formula-from-user eq))
10143 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
10145 (defvar org-recalc-commands nil
10146 "List of commands triggering the recalculation of a line.
10147 Will be filled automatically during use.")
10149 (defvar org-recalc-marks
10150 '((" " . "Unmarked: no special line, no automatic recalculation")
10151 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10152 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10153 ("!" . "Column name definition line. Reference in formula as $name.")
10154 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10155 ("_" . "Names for values in row below this one.")
10156 ("^" . "Names for values in row above this one.")))
10158 (defun org-table-rotate-recalc-marks (&optional newchar)
10159 "Rotate the recalculation mark in the first column.
10160 If in any row, the first field is not consistent with a mark,
10161 insert a new column for the markers.
10162 When there is an active region, change all the lines in the region,
10163 after prompting for the marking character.
10164 After each change, a message will be displayed indicating the meaning
10165 of the new mark."
10166 (interactive)
10167 (unless (org-at-table-p) (error "Not at a table"))
10168 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10169 (beg (org-table-begin))
10170 (end (org-table-end))
10171 (l (org-current-line))
10172 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10173 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10174 (have-col
10175 (save-excursion
10176 (goto-char beg)
10178 (col (org-table-current-column))
10179 (forcenew (car (assoc newchar org-recalc-marks)))
10180 epos new)
10181 (when l1
10182 (message "Change region to what mark? Type # * ! $ or SPC: ")
10183 (setq newchar (char-to-string (read-char-exclusive))
10184 forcenew (car (assoc newchar org-recalc-marks))))
10185 (if (and newchar (not forcenew))
10186 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10187 newchar))
10188 (if l1 (goto-line l1))
10189 (save-excursion
10190 (beginning-of-line 1)
10191 (unless (looking-at org-table-dataline-regexp)
10192 (error "Not at a table data line")))
10193 (unless have-col
10194 (org-table-goto-column 1)
10195 (org-table-insert-column)
10196 (org-table-goto-column (1+ col)))
10197 (setq epos (point-at-eol))
10198 (save-excursion
10199 (beginning-of-line 1)
10200 (org-table-get-field
10202 (concat " "
10203 (setq new (or forcenew
10204 (cadr (member (match-string 1) marks))))
10205 " ")
10206 " # ")))
10207 (if (and l1 l2)
10208 (progn
10209 (goto-line l1)
10210 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10211 (and (looking-at org-table-dataline-regexp)
10212 (org-table-get-field 1 (concat " " new " "))))
10213 (goto-line l1)))
10214 (if (not (= epos (point-at-eol))) (org-table-align))
10215 (goto-line l)
10216 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10218 (defun org-table-maybe-recalculate-line ()
10219 "Recompute the current line if marked for it, and if we haven't just done it."
10220 (interactive)
10221 (and org-table-allow-automatic-line-recalculation
10222 (not (and (memq last-command org-recalc-commands)
10223 (equal org-last-recalc-line (org-current-line))))
10224 (save-excursion (beginning-of-line 1)
10225 (looking-at org-table-auto-recalculate-regexp))
10226 (org-table-recalculate) t))
10228 (defvar org-table-formula-debug nil
10229 "Non-nil means, debug table formulas.
10231 (make-variable-buffer-local 'org-table-formula-debug)
10233 (defvar modes)
10234 (defsubst org-set-calc-mode (var &optional value)
10235 (if (stringp var)
10236 (setq var (assoc var '(("D" calc-angle-mode deg)
10237 ("R" calc-angle-mode rad)
10238 ("F" calc-prefer-frac t)
10239 ("S" calc-symbolic-mode t)))
10240 value (nth 2 var) var (nth 1 var)))
10241 (if (memq var modes)
10242 (setcar (cdr (memq var modes)) value)
10243 (cons var (cons value modes)))
10244 modes)
10246 (defun org-table-eval-formula (&optional arg equation
10247 suppress-align suppress-const
10248 suppress-store suppress-analysis)
10249 "Replace the table field value at the cursor by the result of a calculation.
10251 This function makes use of Dave Gillespie's Calc package, in my view the
10252 most exciting program ever written for GNU Emacs. So you need to have Calc
10253 installed in order to use this function.
10255 In a table, this command replaces the value in the current field with the
10257 formula, by storing it in a special line below the table. When called
10258 with a `C-u' prefix, the current field must ba a named field, and the
10259 formula is installed as valid in only this specific field.
10261 When called with two `C-u' prefixes, insert the active equation
10262 for the field back into the current field, so that it can be
10264 to check the referenced fields.
10266 When called, the command first prompts for a formula, which is read in
10267 the minibuffer. Previously entered formulas are available through the
10268 history list, and the last used formula is offered as a default.
10269 These stored formulas are adapted correctly when moving, inserting, or
10270 deleting columns with the corresponding commands.
10272 The formula can be any algebraic expression understood by the Calc package.
10273 For details, see the Org-mode manual.
10275 This function can also be called from Lisp programs and offers
10276 additional arguments: EQUATION can be the formula to apply. If this
10277 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10278 used to speed-up recursive calls by by-passing unnecessary aligns.
10279 SUPPRESS-CONST suppresses the interpretation of constants in the
10280 formula, assuming that this has been done already outside the function.
10281 SUPPRESS-STORE means the formula should not be stored, either because
10282 it is already stored, or because it is a modified equation that should
10283 not overwrite the stored one."
10284 (interactive "P")
10285 (org-table-check-inside-data-field)
10286 (or suppress-analysis (org-table-get-specials))
10287 (if (equal arg '(16))
10288 (let ((eq (org-table-current-field-formula)))
10289 (or eq (error "No equation active for current field"))
10290 (org-table-get-field nil eq)
10291 (org-table-align)
10292 (setq org-table-may-need-update t))
10293 (let* (fields
10294 (ndown (if (integerp arg) arg 1))
10295 (org-table-automatic-realign nil)
10296 (case-fold-search nil)
10297 (down (> ndown 1))
10298 (formula (if (and equation suppress-store)
10299 equation
10300 (org-table-get-formula equation (equal arg '(4)))))
10301 (n0 (org-table-current-column))
10302 (modes (copy-sequence org-calc-default-modes))
10303 (numbers nil) ; was a variable, now fixed default
10304 (keep-empty nil)
10305 n form form0 bw fmt x ev orig c lispp literal)
10306 ;; Parse the format string. Since we have a lot of modes, this is
10307 ;; a lot of work. However, I think calc still uses most of the time.
10308 (if (string-match ";" formula)
10309 (let ((tmp (org-split-string formula ";")))
10310 (setq formula (car tmp)
10311 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10312 (nth 1 tmp)))
10314 (setq c (string-to-char (match-string 1 fmt))
10315 n (string-to-number (match-string 2 fmt)))
10316 (if (= c ?p)
10317 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10318 (setq modes (org-set-calc-mode
10319 'calc-float-format
10320 (list (cdr (assoc c '((?n . float) (?f . fix)
10321 (?s . sci) (?e . eng))))
10322 n))))
10323 (setq fmt (replace-match "" t t fmt)))
10324 (if (string-match "[NT]" fmt)
10325 (setq numbers (equal (match-string 0 fmt) "N")
10326 fmt (replace-match "" t t fmt)))
10327 (if (string-match "L" fmt)
10328 (setq literal t
10329 fmt (replace-match "" t t fmt)))
10330 (if (string-match "E" fmt)
10331 (setq keep-empty t
10332 fmt (replace-match "" t t fmt)))
10333 (while (string-match "[DRFS]" fmt)
10334 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10335 (setq fmt (replace-match "" t t fmt)))
10337 (setq fmt nil))))
10338 (if (and (not suppress-const) org-table-formula-use-constants)
10339 (setq formula (org-table-formula-substitute-names formula)))
10340 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10341 (while (> ndown 0)
10342 (setq fields (org-split-string
10343 (org-no-properties
10344 (buffer-substring (point-at-bol) (point-at-eol)))
10345 " *| *"))
10346 (if (eq numbers t)
10347 (setq fields (mapcar
10348 (lambda (x) (number-to-string (string-to-number x)))
10349 fields)))
10350 (setq ndown (1- ndown))
10351 (setq form (copy-sequence formula)
10352 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10353 (if (and lispp literal) (setq lispp 'literal))
10354 ;; Check for old vertical references
10355 (setq form (org-rewrite-old-row-references form))
10356 ;; Insert complex ranges
10357 (while (string-match org-table-range-regexp form)
10358 (setq form
10359 (replace-match
10360 (save-match-data
10361 (org-table-make-reference
10362 (org-table-get-range (match-string 0 form) nil n0)
10363 keep-empty numbers lispp))
10364 t t form)))
10365 ;; Insert simple ranges
10367 (setq form
10368 (replace-match
10369 (save-match-data
10370 (org-table-make-reference
10371 (org-sublist
10372 fields (string-to-number (match-string 1 form))
10373 (string-to-number (match-string 2 form)))
10374 keep-empty numbers lispp))
10375 t t form)))
10376 (setq form0 form)
10377 ;; Insert the references to fields in same row
10379 (setq n (string-to-number (match-string 1 form))
10380 x (nth (1- (if (= n 0) n0 n)) fields))
10382 (match-string 0 form)))
10383 (setq form (replace-match
10384 (save-match-data
10385 (org-table-make-reference x nil numbers lispp))
10386 t t form)))
10388 (if lispp
10389 (setq ev (condition-case nil
10390 (eval (eval (read form)))
10391 (error "#ERROR"))
10392 ev (if (numberp ev) (number-to-string ev) ev))
10393 (or (fboundp 'calc-eval)
10394 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10395 (setq ev (calc-eval (cons form modes)
10396 (if numbers 'num))))
10398 (when org-table-formula-debug
10399 (with-output-to-temp-buffer "*Substitution History*"
10400 (princ (format "Substitution history of formula
10401 Orig: %s
10402 $xyz-> %s
10403 @r$c-> %s
10405 (if (listp ev)
10407 (make-string (car ev) ?\-) (nth 1 ev)))
10409 ev (or fmt "NONE")
10410 (if fmt (format fmt (string-to-number ev)) ev)))))
10411 (setq bw (get-buffer-window "*Substitution History*"))
10412 (shrink-window-if-larger-than-buffer bw)
10413 (unless (and (interactive-p) (not ndown))
10414 (unless (let (inhibit-redisplay)
10415 (y-or-n-p "Debugging Formula. Continue to next? "))
10416 (org-table-align)
10417 (error "Abort"))
10418 (delete-window bw)
10419 (message "")))
10420 (if (listp ev) (setq fmt nil ev "#ERROR"))
10421 (org-table-justify-field-maybe
10422 (if fmt (format fmt (string-to-number ev)) ev))
10424 (call-interactively 'org-return)
10425 (setq ndown 0)))
10426 (and down (org-table-maybe-recalculate-line))
10427 (or suppress-align (and org-table-may-need-update
10428 (org-table-align))))))
10430 (defun org-table-put-field-property (prop value)
10431 (save-excursion
10432 (put-text-property (progn (skip-chars-backward "^|") (point))
10433 (progn (skip-chars-forward "^|") (point))
10434 prop value)))
10436 (defun org-table-get-range (desc &optional tbeg col highlight)
10437 "Get a calc vector from a column, accorting to descriptor DESC.
10438 Optional arguments TBEG and COL can give the beginning of the table and
10439 the current column, to avoid unnecessary parsing.
10440 HIGHLIGHT means, just highlight the range."
10441 (if (not (equal (string-to-char desc) ?@))
10442 (setq desc (concat "@" desc)))
10443 (save-excursion
10444 (or tbeg (setq tbeg (org-table-begin)))
10445 (or col (setq col (org-table-current-column)))
10446 (let ((thisline (org-current-line))
10447 beg end c1 c2 r1 r2 rangep tmp)
10448 (unless (string-match org-table-range-regexp desc)
10449 (error "Invalid table range specifier `%s'" desc))
10450 (setq rangep (match-end 3)
10451 r1 (and (match-end 1) (match-string 1 desc))
10452 r2 (and (match-end 4) (match-string 4 desc))
10453 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10454 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10456 (and c1 (setq c1 (+ (string-to-number c1)
10457 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10458 (and c2 (setq c2 (+ (string-to-number c2)
10459 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10460 (if (equal r1 "") (setq r1 nil))
10461 (if (equal r2 "") (setq r2 nil))
10462 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10463 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10464 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10465 (if (not r1) (setq r1 thisline))
10466 (if (not r2) (setq r2 thisline))
10467 (if (not c1) (setq c1 col))
10468 (if (not c2) (setq c2 col))
10469 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10470 ;; just one field
10471 (progn
10472 (goto-line r1)
10473 (while (not (looking-at org-table-dataline-regexp))
10474 (beginning-of-line 2))
10475 (prog1 (org-trim (org-table-get-field c1))
10476 (if highlight (org-table-highlight-rectangle (point) (point)))))
10477 ;; A range, return a vector
10478 ;; First sort the numbers to get a regular ractangle
10479 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10480 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10481 (goto-line r1)
10482 (while (not (looking-at org-table-dataline-regexp))
10483 (beginning-of-line 2))
10484 (org-table-goto-column c1)
10485 (setq beg (point))
10486 (goto-line r2)
10487 (while (not (looking-at org-table-dataline-regexp))
10488 (beginning-of-line 0))
10489 (org-table-goto-column c2)
10490 (setq end (point))
10491 (if highlight
10492 (org-table-highlight-rectangle
10494 ;; return string representation of calc vector
10495 (mapcar 'org-trim
10496 (apply 'append (org-table-copy-region beg end)))))))
10498 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10499 "Analyze descriptor DESC and retrieve the corresponding line number.
10500 The cursor is currently in line CLINE, the table begins in line BLINE,
10501 and TABLE is a vector with line types."
10502 (if (string-match "^[0-9]+$" desc)
10503 (aref org-table-dlines (string-to-number desc))
10504 (setq cline (or cline (org-current-line))
10505 bline (or bline org-table-current-begin-line)
10506 table (or table org-table-current-line-types))
10507 (if (or
10509 ;; 1 2 3 4 5 6
10510 (and (not (match-end 3)) (not (match-end 6)))
10511 (and (match-end 3) (match-end 6) (not (match-end 5))))
10512 (error "invalid row descriptor `%s'" desc))
10513 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10514 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10515 (odir (and (match-end 5) (match-string 5 desc)))
10516 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10517 (i (- cline bline))
10518 (rel (and (match-end 6)
10519 (or (and (match-end 1) (not (match-end 3)))
10520 (match-end 5)))))
10521 (if (and hn (not hdir))
10522 (progn
10523 (setq i 0 hdir "+")
10524 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10525 (if (and (not hn) on (not odir))
10526 (error "should never happen");;(aref org-table-dlines on)
10527 (if (and hn (> hn 0))
10528 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10529 (if on
10530 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10531 (+ bline i)))))
10533 (defun org-find-row-type (table i type backwards relative n)
10534 (let ((l (length table)))
10535 (while (> n 0)
10536 (while (and (setq i (+ i (if backwards -1 1)))
10537 (>= i 0) (< i l)
10538 (not (eq (aref table i) type))
10539 (if (and relative (eq (aref table i) 'hline))
10540 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10541 t)))
10542 (setq n (1- n)))
10543 (if (or (< i 0) (>= i l))
10544 (error "Row descriptor leads outside table")
10545 i)))
10547 (defun org-rewrite-old-row-references (s)
10548 (if (string-match "&[-+0-9I]" s)
10549 (error "Formula contains old &row reference, please rewrite using @-syntax")
10550 s))
10552 (defun org-table-make-reference (elements keep-empty numbers lispp)
10553 "Convert list ELEMENTS to something appropriate to insert into formula.
10554 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10555 NUMBERS indicates that everything should be converted to numbers.
10556 LISPP means to return something appropriate for a Lisp list."
10557 (if (stringp elements) ; just a single val
10558 (if lispp
10559 (if (eq lispp 'literal)
10560 elements
10561 (prin1-to-string (if numbers (string-to-number elements) elements)))
10562 (if (equal elements "") (setq elements "0"))
10563 (if numbers (number-to-string (string-to-number elements)) elements))
10564 (unless keep-empty
10565 (setq elements
10566 (delq nil
10568 elements))))
10569 (setq elements (or elements '("0")))
10570 (if lispp
10571 (mapconcat
10572 (lambda (x)
10573 (if (eq lispp 'literal)
10574 x
10575 (prin1-to-string (if numbers (string-to-number x) x))))
10576 elements " ")
10577 (concat "[" (mapconcat
10578 (lambda (x)
10579 (if numbers (number-to-string (string-to-number x)) x))
10580 elements
10581 ",") "]"))))
10583 (defun org-table-recalculate (&optional all noalign)
10584 "Recalculate the current table line by applying all stored formulas.
10585 With prefix arg ALL, do this for all lines in the table."
10586 (interactive "P")
10587 (or (memq this-command org-recalc-commands)
10588 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10589 (unless (org-at-table-p) (error "Not at a table"))
10590 (if (equal all '(16))
10591 (org-table-iterate)
10592 (org-table-get-specials)
10593 (let* ((eqlist (sort (org-table-get-stored-formulas)
10594 (lambda (a b) (string< (car a) (car b)))))
10595 (inhibit-redisplay (not debug-on-error))
10596 (line-re org-table-dataline-regexp)
10597 (thisline (org-current-line))
10598 (thiscol (org-table-current-column))
10599 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10600 ;; Insert constants in all formulas
10601 (setq eqlist
10602 (mapcar (lambda (x)
10603 (setcdr x (org-table-formula-substitute-names (cdr x)))
10604 x)
10605 eqlist))
10606 ;; Split the equation list
10607 (while (setq eq (pop eqlist))
10608 (if (<= (string-to-char (car eq)) ?9)
10609 (push eq eqlnum)
10610 (push eq eqlname)))
10611 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10612 (if all
10613 (progn
10614 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10615 (goto-char (setq beg (org-table-begin)))
10616 (if (re-search-forward org-table-calculate-mark-regexp end t)
10617 ;; This is a table with marked lines, compute selected lines
10618 (setq line-re org-table-recalculate-regexp)
10619 ;; Move forward to the first non-header line
10620 (if (and (re-search-forward org-table-dataline-regexp end t)
10621 (re-search-forward org-table-hline-regexp end t)
10622 (re-search-forward org-table-dataline-regexp end t))
10623 (setq beg (match-beginning 0))
10624 nil))) ;; just leave beg where it is
10625 (setq beg (point-at-bol)
10626 end (move-marker (make-marker) (1+ (point-at-eol)))))
10627 (goto-char beg)
10628 (and all (message "Re-applying formulas to full table..."))
10630 ;; First find the named fields, and mark them untouchanble
10631 (remove-text-properties beg end '(org-untouchable t))
10632 (while (setq eq (pop eqlname))
10633 (setq name (car eq)
10634 a (assoc name org-table-named-field-locations))
10635 (and (not a)
10637 (setq a (list name
10638 (aref org-table-dlines
10639 (string-to-number (match-string 1 name)))
10640 (string-to-number (match-string 2 name)))))
10641 (when (and a (or all (equal (nth 1 a) thisline)))
10642 (message "Re-applying formula to field: %s" name)
10643 (goto-line (nth 1 a))
10644 (org-table-goto-column (nth 2 a))
10645 (push (append a (list (cdr eq))) eqlname1)
10646 (org-table-put-field-property :org-untouchable t)))
10648 ;; Now evauluate the column formulas, but skip fields covered by
10649 ;; field formulas
10650 (goto-char beg)
10651 (while (re-search-forward line-re end t)
10652 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10653 ;; Unprotected line, recalculate
10654 (and all (message "Re-applying formulas to full table...(line %d)"
10655 (setq cnt (1+ cnt))))
10656 (setq org-last-recalc-line (org-current-line))
10657 (setq eql eqlnum)
10658 (while (setq entry (pop eql))
10659 (goto-line org-last-recalc-line)
10660 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10661 (unless (get-text-property (point) :org-untouchable)
10662 (org-table-eval-formula nil (cdr entry)
10663 'noalign 'nocst 'nostore 'noanalysis)))))
10665 ;; Now evaluate the field formulas
10666 (while (setq eq (pop eqlname1))
10667 (message "Re-applying formula to field: %s" (car eq))
10668 (goto-line (nth 1 eq))
10669 (org-table-goto-column (nth 2 eq))
10670 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10671 'nostore 'noanalysis))
10673 (goto-line thisline)
10674 (org-table-goto-column thiscol)
10675 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10676 (or noalign (and org-table-may-need-update (org-table-align))
10677 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10679 ;; back to initial position
10680 (message "Re-applying formulas...done")
10681 (goto-line thisline)
10682 (org-table-goto-column thiscol)
10683 (or noalign (and org-table-may-need-update (org-table-align))
10684 (and all (message "Re-applying formulas...done"))))))
10686 (defun org-table-iterate (&optional arg)
10687 "Recalculate the table until it does not change anymore."
10688 (interactive "P")
10689 (let ((imax (if arg (prefix-numeric-value arg) 10))
10690 (i 0)
10691 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10692 thistbl)
10693 (catch 'exit
10694 (while (< i imax)
10695 (setq i (1+ i))
10696 (org-table-recalculate 'all)
10697 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10698 (if (not (string= lasttbl thistbl))
10699 (setq lasttbl thistbl)
10700 (if (> i 1)
10701 (message "Convergence after %d iterations" i)
10702 (message "Table was already stable"))
10703 (throw 'exit t)))
10704 (error "No convergence after %d iterations" i))))
10706 (defun org-table-formula-substitute-names (f)
10707 "Replace $const with values in string F."
10708 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10709 ;; First, check for column names
10710 (while (setq start (string-match org-table-column-name-regexp f start))
10711 (setq start (1+ start))
10712 (setq a (assoc (match-string 1 f) org-table-column-names))
10713 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10714 ;; Parameters and constants
10715 (setq start 0)
10717 (setq start (1+ start))
10718 (if (setq a (save-match-data
10719 (org-table-get-constant (match-string 1 f))))
10720 (setq f (replace-match
10721 (concat (if pp "(") a (if pp ")")) t t f))))
10722 (if org-table-formula-debug
10723 (put-text-property 0 (length f) :orig-formula f1 f))
10724 f))
10726 (defun org-table-get-constant (const)
10727 "Find the value for a parameter or constant in a formula.
10728 Parameters get priority."
10729 (or (cdr (assoc const org-table-local-parameters))
10730 (cdr (assoc const org-table-formula-constants-local))
10731 (cdr (assoc const org-table-formula-constants))
10732 (and (fboundp 'constants-get) (constants-get const))
10733 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10734 (org-entry-get nil (substring const 5) 'inherit))
10735 "#UNDEFINED_NAME"))
10737 (defvar org-table-fedit-map
10738 (let ((map (make-sparse-keymap)))
10739 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10740 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10741 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10742 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10743 (org-defkey map "\C-c?" 'org-table-show-reference)
10744 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10745 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10746 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10747 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10748 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10749 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10750 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10751 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10752 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10753 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10754 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10755 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10756 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10757 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10758 map))
10760 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10761 '("Edit-Formulas"
10762 ["Finish and Install" org-table-fedit-finish t]
10763 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10764 ["Abort" org-table-fedit-abort t]
10765 "--"
10766 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10767 ["Complete Lisp Symbol" lisp-complete-symbol t]
10768 "--"
10769 "Shift Reference at Point"
10770 ["Up" org-table-fedit-ref-up t]
10771 ["Down" org-table-fedit-ref-down t]
10772 ["Left" org-table-fedit-ref-left t]
10773 ["Right" org-table-fedit-ref-right t]
10774 "-"
10775 "Change Test Row for Column Formulas"
10776 ["Up" org-table-fedit-line-up t]
10777 ["Down" org-table-fedit-line-down t]
10778 "--"
10779 ["Scroll Table Window" org-table-fedit-scroll t]
10780 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10781 ["Show Table Grid" org-table-fedit-toggle-coordinates
10782 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10783 org-table-overlay-coordinates)]
10784 "--"
10785 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10786 :style toggle :selected org-table-buffer-is-an]))
10788 (defvar org-pos)
10790 (defun org-table-edit-formulas ()
10791 "Edit the formulas of the current table in a separate buffer."
10792 (interactive)
10794 (beginning-of-line 0))
10795 (unless (org-at-table-p) (error "Not at a table"))
10796 (org-table-get-specials)
10797 (let ((key (org-table-current-field-formula 'key 'noerror))
10798 (eql (sort (org-table-get-stored-formulas 'noerror)
10799 'org-table-formula-less-p))
10800 (pos (move-marker (make-marker) (point)))
10801 (startline 1)
10802 (wc (current-window-configuration))
10806 entry s type title)
10807 (org-switch-to-buffer-other-window "*Edit Formulas*")
10808 (erase-buffer)
10809 ;; Keep global-font-lock-mode from turning on font-lock-mode
10810 (let ((font-lock-global-modes '(not fundamental-mode)))
10811 (fundamental-mode))
10812 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10813 (org-set-local 'org-pos pos)
10814 (org-set-local 'org-window-configuration wc)
10815 (use-local-map org-table-fedit-map)
10816 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10817 (easy-menu-add org-table-fedit-menu)
10818 (setq startline (org-current-line))
10819 (while (setq entry (pop eql))
10820 (setq type (cond
10821 ((equal (string-to-char (car entry)) ?@) 'field)
10822 ((string-match "^[0-9]" (car entry)) 'column)
10823 (t 'named)))
10824 (when (setq title (assq type titles))
10826 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10827 (setq titles (delq title titles)))
10828 (if (equal key (car entry)) (setq startline (org-current-line)))
10829 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10831 (remove-text-properties 0 (length s) '(face nil) s)
10832 (insert s))
10833 (if (eq org-table-use-standard-references t)
10834 (org-table-fedit-toggle-ref-type))
10835 (goto-line startline)
10836 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10838 (defun org-table-fedit-post-command ()
10839 (when (not (memq this-command '(lisp-complete-symbol)))
10840 (let ((win (selected-window)))
10841 (save-excursion
10842 (condition-case nil
10843 (org-table-show-reference)
10844 (error nil))
10845 (select-window win)))))
10847 (defun org-table-formula-to-user (s)
10848 "Convert a formula from internal to user representation."
10849 (if (eq org-table-use-standard-references t)
10850 (org-table-convert-refs-to-an s)
10851 s))
10853 (defun org-table-formula-from-user (s)
10854 "Convert a formula from user to internal representation."
10855 (if org-table-use-standard-references
10856 (org-table-convert-refs-to-rc s)
10857 s))
10859 (defun org-table-convert-refs-to-rc (s)
10860 "Convert spreadsheet references from AB7 to @7$28.
10861 Works for single references, but also for entire formulas and even the
10862 full TBLFM line."
10863 (let ((start 0))
10865 (cond
10866 ((match-end 3)
10867 ;; format match, just advance
10868 (setq start (match-end 0)))
10869 ((and (> (match-beginning 0) 0)
10870 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10871 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10872 ;; 3.e5 or something like this.
10873 (setq start (match-end 0)))
10874 (t
10875 (setq start (match-beginning 0)
10876 s (replace-match
10877 (if (equal (match-string 2 s) "&")
10878 (format "$%d" (org-letters-to-number (match-string 1 s)))
10879 (format "@%d$%d"
10880 (string-to-number (match-string 2 s))
10881 (org-letters-to-number (match-string 1 s))))
10882 t t s)))))
10883 s))
10885 (defun org-table-convert-refs-to-an (s)
10886 "Convert spreadsheet references from to @7$28 to AB7.
10887 Works for single references, but also for entire formulas and even the
10888 full TBLFM line."
10890 (setq s (replace-match
10891 (format "%s%d"
10892 (org-number-to-letters
10893 (string-to-number (match-string 2 s)))
10894 (string-to-number (match-string 1 s)))
10895 t t s)))
10898 (org-number-to-letters
10899 (string-to-number (match-string 2 s))) "&")
10900 t nil s)))
10901 s)
10903 (defun org-letters-to-number (s)
10904 "Convert a base 26 number represented by letters into an integer.
10905 For example: AB -> 28."
10906 (let ((n 0))
10907 (setq s (upcase s))
10908 (while (> (length s) 0)
10909 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10910 s (substring s 1)))
10911 n))
10913 (defun org-number-to-letters (n)
10914 "Convert an integer into a base 26 number represented by letters.
10915 For example: 28 -> AB."
10916 (let ((s ""))
10917 (while (> n 0)
10918 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10919 n (/ (1- n) 26)))
10920 s))
10922 (defun org-table-fedit-convert-buffer (function)
10923 "Convert all references in this buffer, using FUNTION."
10924 (let ((line (org-current-line)))
10925 (goto-char (point-min))
10926 (while (not (eobp))
10927 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10928 (delete-region (point) (point-at-eol))
10929 (or (eobp) (forward-char 1)))
10930 (goto-line line)))
10932 (defun org-table-fedit-toggle-ref-type ()
10933 "Convert all references in the buffer from B3 to @3$2 and back."
10934 (interactive)
10935 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10936 (org-table-fedit-convert-buffer
10937 (if org-table-buffer-is-an
10938 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10939 (message "Reference type switched to %s"
10940 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10942 (defun org-table-fedit-ref-up ()
10943 "Shift the reference at point one row/hline up."
10944 (interactive)
10945 (org-table-fedit-shift-reference 'up))
10946 (defun org-table-fedit-ref-down ()
10947 "Shift the reference at point one row/hline down."
10948 (interactive)
10949 (org-table-fedit-shift-reference 'down))
10950 (defun org-table-fedit-ref-left ()
10951 "Shift the reference at point one field to the left."
10952 (interactive)
10953 (org-table-fedit-shift-reference 'left))
10954 (defun org-table-fedit-ref-right ()
10955 "Shift the reference at point one field to the right."
10956 (interactive)
10957 (org-table-fedit-shift-reference 'right))
10959 (defun org-table-fedit-shift-reference (dir)
10960 (cond
10962 (if (memq dir '(left right))
10963 (org-rematch-and-replace 1 (eq dir 'left))
10964 (error "Cannot shift reference in this direction")))
10966 ;; A B3-like reference
10967 (if (memq dir '(up down))
10968 (org-rematch-and-replace 2 (eq dir 'up))
10969 (org-rematch-and-replace 1 (eq dir 'left))))
10970 ((org-at-regexp-p
10972 ;; An internal reference
10973 (if (memq dir '(up down))
10974 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10975 (org-rematch-and-replace 5 (eq dir 'left))))))
10977 (defun org-rematch-and-replace (n &optional decr hline)
10978 "Re-match the group N, and replace it with the shifted refrence."
10979 (or (match-end n) (error "Cannot shift reference in this direction"))
10980 (goto-char (match-beginning n))
10981 (and (looking-at (regexp-quote (match-string n)))
10982 (replace-match (org-shift-refpart (match-string 0) decr hline)
10983 t t)))
10985 (defun org-shift-refpart (ref &optional decr hline)
10986 "Shift a refrence part REF.
10987 If DECR is set, decrease the references row/column, else increase.
10988 If HLINE is set, this may be a hline reference, it certainly is not
10989 a translation reference."
10990 (save-match-data
10991 (let* ((sign (string-match "^[-+]" ref)) n)
10993 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10994 (cond
10995 ((and hline (string-match "^I+" ref))
10996 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10997 (setq n (+ n (if decr -1 1)))
10998 (if (= n 0) (setq n (+ n (if decr -1 1))))
10999 (if sign
11000 (setq sign (if (< n 0) "-" "+") n (abs n))
11001 (setq n (max 1 n)))
11002 (concat sign (make-string n ?I)))
11004 ((string-match "^[0-9]+" ref)
11005 (setq n (string-to-number (concat sign ref)))
11006 (setq n (+ n (if decr -1 1)))
11007 (if sign
11008 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
11009 (number-to-string (max 1 n))))
11011 ((string-match "^[a-zA-Z]+" ref)
11012 (org-number-to-letters
11013 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
11015 (t (error "Cannot shift reference"))))))
11017 (defun org-table-fedit-toggle-coordinates ()
11018 "Toggle the display of coordinates in the refrenced table."
11019 (interactive)
11020 (let ((pos (marker-position org-pos)))
11021 (with-current-buffer (marker-buffer org-pos)
11022 (save-excursion
11023 (goto-char pos)
11024 (org-table-toggle-coordinate-overlays)))))
11026 (defun org-table-fedit-finish (&optional arg)
11027 "Parse the buffer for formula definitions and install them.
11028 With prefix ARG, apply the new formulas to the table."
11029 (interactive "P")
11030 (org-table-remove-rectangle-highlight)
11031 (if org-table-use-standard-references
11032 (progn
11033 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
11034 (setq org-table-buffer-is-an nil)))
11035 (let ((pos org-pos) eql var form)
11036 (goto-char (point-min))
11037 (while (re-search-forward
11039 nil t)
11040 (setq var (if (match-end 2) (match-string 2) (match-string 1))
11041 form (match-string 3))
11042 (setq form (org-trim form))
11043 (when (not (equal form ""))
11045 (setq form (replace-match " " t t form)))
11046 (when (assoc var eql)
11047 (error "Double formulas for %s" var))
11048 (push (cons var form) eql)))
11049 (setq org-pos nil)
11050 (set-window-configuration org-window-configuration)
11051 (select-window (get-buffer-window (marker-buffer pos)))
11052 (goto-char pos)
11053 (unless (org-at-table-p)
11054 (error "Lost table position - cannot install formulae"))
11055 (org-table-store-formulas eql)
11056 (move-marker pos nil)
11057 (kill-buffer "*Edit Formulas*")
11058 (if arg
11059 (org-table-recalculate 'all)
11060 (message "New formulas installed - press C-u C-c C-c to apply."))))
11062 (defun org-table-fedit-abort ()
11063 "Abort editing formulas, without installing the changes."
11064 (interactive)
11065 (org-table-remove-rectangle-highlight)
11066 (let ((pos org-pos))
11067 (set-window-configuration org-window-configuration)
11068 (select-window (get-buffer-window (marker-buffer pos)))
11069 (goto-char pos)
11070 (move-marker pos nil)
11071 (message "Formula editing aborted without installing changes")))
11073 (defun org-table-fedit-lisp-indent ()
11074 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
11075 (interactive)
11076 (let ((pos (point)) beg end ind)
11077 (beginning-of-line 1)
11078 (cond
11080 (goto-char pos)
11081 (call-interactively 'lisp-indent-line))
11083 ((not (fboundp 'pp-buffer))
11084 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
11085 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
11086 (goto-char (- (match-end 0) 2))
11087 (setq beg (point))
11088 (setq ind (make-string (current-column) ?\ ))
11089 (condition-case nil (forward-sexp 1)
11090 (error
11091 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
11092 (setq end (point))
11093 (save-restriction
11094 (narrow-to-region beg end)
11095 (if (eq last-command this-command)
11096 (progn
11097 (goto-char (point-min))
11098 (setq this-command nil)
11100 (replace-match " ")))
11101 (pp-buffer)
11102 (untabify (point-min) (point-max))
11103 (goto-char (1+ (point-min)))
11104 (while (re-search-forward "^." nil t)
11105 (beginning-of-line 1)
11106 (insert ind))
11107 (goto-char (point-max))
11108 (backward-delete-char 1)))
11109 (goto-char beg))
11110 (t nil))))
11112 (defvar org-show-positions nil)
11114 (defun org-table-show-reference (&optional local)
11115 "Show the location/value of the $ expression at point."
11116 (interactive)
11117 (org-table-remove-rectangle-highlight)
11118 (catch 'exit
11119 (let ((pos (if local (point) org-pos))
11120 (face2 'highlight)
11121 (org-inhibit-highlight-removal t)
11122 (win (selected-window))
11123 (org-show-positions nil)
11124 var name e what match dest)
11125 (if local (org-table-get-specials))
11126 (setq what (cond
11127 ((or (org-at-regexp-p org-table-range-regexp2)
11128 (org-at-regexp-p org-table-translate-regexp)
11129 (org-at-regexp-p org-table-range-regexp))
11130 (setq match
11131 (save-match-data
11132 (org-table-convert-refs-to-rc (match-string 0))))
11133 'range)
11136 ((not local) nil)
11137 (t (error "No reference at point")))
11138 match (and what (or match (match-string 0))))
11139 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
11140 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
11141 'secondary-selection))
11142 (org-add-hook 'before-change-functions
11143 'org-table-remove-rectangle-highlight)
11144 (if (eq what 'name) (setq var (substring match 1)))
11145 (when (eq what 'range)
11146 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
11147 (setq match (org-table-formula-substitute-names match)))
11148 (unless local
11149 (save-excursion
11150 (end-of-line 1)
11152 (beginning-of-line 1)
11154 (setq dest
11155 (save-match-data
11156 (org-table-convert-refs-to-rc (match-string 1))))
11157 (org-table-add-rectangle-overlay
11158 (match-beginning 1) (match-end 1) face2))))
11159 (if (and (markerp pos) (marker-buffer pos))
11160 (if (get-buffer-window (marker-buffer pos))
11161 (select-window (get-buffer-window (marker-buffer pos)))
11162 (org-switch-to-buffer-other-window (get-buffer-window
11163 (marker-buffer pos)))))
11164 (goto-char pos)
11165 (org-table-force-dataline)
11166 (when dest
11167 (setq name (substring dest 1))
11168 (cond
11170 (setq e (assoc name org-table-named-field-locations))
11171 (goto-line (nth 1 e))
11172 (org-table-goto-column (nth 2 e)))
11174 (let ((l (string-to-number (match-string 1 dest)))
11175 (c (string-to-number (match-string 2 dest))))
11176 (goto-line (aref org-table-dlines l))
11177 (org-table-goto-column c)))
11178 (t (org-table-goto-column (string-to-number name))))
11179 (move-marker pos (point))
11180 (org-table-highlight-rectangle nil nil face2))
11181 (cond
11182 ((equal dest match))
11183 ((not match))
11184 ((eq what 'range)
11185 (condition-case nil
11186 (save-excursion
11187 (org-table-get-range match nil nil 'highlight))
11188 (error nil)))
11189 ((setq e (assoc var org-table-named-field-locations))
11190 (goto-line (nth 1 e))
11191 (org-table-goto-column (nth 2 e))
11192 (org-table-highlight-rectangle (point) (point))
11193 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11194 ((setq e (assoc var org-table-column-names))
11195 (org-table-goto-column (string-to-number (cdr e)))
11196 (org-table-highlight-rectangle (point) (point))
11197 (goto-char (org-table-begin))
11199 (org-table-end) t)
11200 (progn
11201 (goto-char (match-beginning 1))
11202 (org-table-highlight-rectangle)
11203 (message "Named column (column %s)" (cdr e)))
11204 (error "Column name not found")))
11205 ((eq what 'column)
11206 ;; column number
11207 (org-table-goto-column (string-to-number (substring match 1)))
11208 (org-table-highlight-rectangle (point) (point))
11209 (message "Column %s" (substring match 1)))
11210 ((setq e (assoc var org-table-local-parameters))
11211 (goto-char (org-table-begin))
11213 (progn
11214 (goto-char (match-beginning 1))
11215 (org-table-highlight-rectangle)
11216 (message "Local parameter."))
11217 (error "Parameter not found")))
11218 (t
11219 (cond
11220 ((not var) (error "No reference at point"))
11221 ((setq e (assoc var org-table-formula-constants-local))
11222 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11223 var (cdr e)))
11224 ((setq e (assoc var org-table-formula-constants))
11225 (message "Constant: $%s=%s in `org-table-formula-constants'."
11226 var (cdr e)))
11227 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11228 (message "Constant: $%s=%s, from `constants.el'%s."
11229 var e (format " (%s units)" constants-unit-system)))
11230 (t (error "Undefined name $%s" var)))))
11231 (goto-char pos)
11232 (when (and org-show-positions
11233 (not (memq this-command '(org-table-fedit-scroll
11234 org-table-fedit-scroll-down))))
11235 (push pos org-show-positions)
11236 (push org-table-current-begin-pos org-show-positions)
11237 (let ((min (apply 'min org-show-positions))
11238 (max (apply 'max org-show-positions)))
11239 (goto-char min) (recenter 0)
11240 (goto-char max)
11241 (or (pos-visible-in-window-p max) (recenter -1))))
11242 (select-window win))))
11244 (defun org-table-force-dataline ()
11245 "Make sure the cursor is in a dataline in a table."
11246 (unless (save-excursion
11247 (beginning-of-line 1)
11248 (looking-at org-table-dataline-regexp))
11249 (let* ((re org-table-dataline-regexp)
11250 (p1 (save-excursion (re-search-forward re nil 'move)))
11251 (p2 (save-excursion (re-search-backward re nil 'move))))
11252 (cond ((and p1 p2)
11253 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11254 p1 p2)))
11255 ((or p1 p2) (goto-char (or p1 p2)))
11256 (t (error "No table dataline around here"))))))
11258 (defun org-table-fedit-line-up ()
11259 "Move cursor one line up in the window showing the table."
11260 (interactive)
11261 (org-table-fedit-move 'previous-line))
11263 (defun org-table-fedit-line-down ()
11264 "Move cursor one line down in the window showing the table."
11265 (interactive)
11266 (org-table-fedit-move 'next-line))
11268 (defun org-table-fedit-move (command)
11269 "Move the cursor in the window shoinw the table.
11270 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11271 (let ((org-table-allow-automatic-line-recalculation nil)
11272 (pos org-pos) (win (selected-window)) p)
11273 (select-window (get-buffer-window (marker-buffer org-pos)))
11274 (setq p (point))
11275 (call-interactively command)
11276 (while (and (org-at-table-p)
11277 (org-at-table-hline-p))
11278 (call-interactively command))
11279 (or (org-at-table-p) (goto-char p))
11280 (move-marker pos (point))
11281 (select-window win)))
11283 (defun org-table-fedit-scroll (N)
11284 (interactive "p")
11285 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11286 (scroll-other-window N)))
11288 (defun org-table-fedit-scroll-down (N)
11289 (interactive "p")
11290 (org-table-fedit-scroll (- N)))
11292 (defvar org-table-rectangle-overlays nil)
11294 (defun org-table-add-rectangle-overlay (beg end &optional face)
11295 "Add a new overlay."
11296 (let ((ov (org-make-overlay beg end)))
11297 (org-overlay-put ov 'face (or face 'secondary-selection))
11298 (push ov org-table-rectangle-overlays)))
11300 (defun org-table-highlight-rectangle (&optional beg end face)
11301 "Highlight rectangular region in a table."
11302 (setq beg (or beg (point)) end (or end (point)))
11303 (let ((b (min beg end))
11304 (e (max beg end))
11305 l1 c1 l2 c2 tmp)
11306 (and (boundp 'org-show-positions)
11307 (setq org-show-positions (cons b (cons e org-show-positions))))
11308 (goto-char (min beg end))
11309 (setq l1 (org-current-line)
11310 c1 (org-table-current-column))
11311 (goto-char (max beg end))
11312 (setq l2 (org-current-line)
11313 c2 (org-table-current-column))
11314 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11315 (goto-line l1)
11316 (beginning-of-line 1)
11317 (loop for line from l1 to l2 do
11318 (when (looking-at org-table-dataline-regexp)
11319 (org-table-goto-column c1)
11321 (org-table-goto-column c2)
11323 (org-table-add-rectangle-overlay beg end face))
11324 (beginning-of-line 2))
11325 (goto-char b))
11326 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11328 (defun org-table-remove-rectangle-highlight (&rest ignore)
11329 "Remove the rectangle overlays."
11330 (unless org-inhibit-highlight-removal
11331 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11332 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11333 (setq org-table-rectangle-overlays nil)))
11335 (defvar org-table-coordinate-overlays nil
11336 "Collects the cooordinate grid overlays, so that they can be removed.")
11337 (make-variable-buffer-local 'org-table-coordinate-overlays)
11339 (defun org-table-overlay-coordinates ()
11340 "Add overlays to the table at point, to show row/column coordinates."
11341 (interactive)
11342 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11343 (setq org-table-coordinate-overlays nil)
11344 (save-excursion
11345 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11346 (goto-char (org-table-begin))
11347 (while (org-at-table-p)
11348 (setq eol (point-at-eol))
11349 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11350 (push ov org-table-coordinate-overlays)
11351 (setq hline (looking-at org-table-hline-regexp))
11352 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11353 (format "%4d" (setq id (1+ id)))))
11354 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11355 (when hline
11356 (setq ic 0)
11358 (setq beg (1+ (match-beginning 0))
11359 ic (1+ ic)
11360 s1 (concat "$" (int-to-string ic))
11361 s2 (org-number-to-letters ic)
11362 str (if (eq org-table-use-standard-references t) s2 s1))
11363 (setq ov (org-make-overlay beg (+ beg (length str))))
11364 (push ov org-table-coordinate-overlays)
11365 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11366 (beginning-of-line 2)))))
11368 (defun org-table-toggle-coordinate-overlays ()
11369 "Toggle the display of Row/Column numbers in tables."
11370 (interactive)
11371 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11372 (message "Row/Column number display turned %s"
11373 (if org-table-overlay-coordinates "on" "off"))
11374 (if (and (org-at-table-p) org-table-overlay-coordinates)
11375 (org-table-align))
11376 (unless org-table-overlay-coordinates
11377 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11378 (setq org-table-coordinate-overlays nil)))
11380 (defun org-table-toggle-formula-debugger ()
11381 "Toggle the formula debugger in tables."
11382 (interactive)
11383 (setq org-table-formula-debug (not org-table-formula-debug))
11384 (message "Formula debugging has been turned %s"
11385 (if org-table-formula-debug "on" "off")))
11387 ;;; The orgtbl minor mode
11389 ;; Define a minor mode which can be used in other modes in order to
11390 ;; integrate the org-mode table editor.
11392 ;; This is really a hack, because the org-mode table editor uses several
11393 ;; keys which normally belong to the major mode, for example the TAB and
11394 ;; RET keys. Here is how it works: The minor mode defines all the keys
11395 ;; necessary to operate the table editor, but wraps the commands into a
11396 ;; function which tests if the cursor is currently inside a table. If that
11397 ;; is the case, the table editor command is executed. However, when any of
11398 ;; those keys is used outside a table, the function uses `key-binding' to
11399 ;; look up if the key has an associated command in another currently active
11400 ;; keymap (minor modes, major mode, global), and executes that command.
11401 ;; There might be problems if any of the keys used by the table editor is
11402 ;; otherwise used as a prefix key.
11404 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11405 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11406 ;; addresses this by checking explicitly for both bindings.
11408 ;; The optimized version (see variable `orgtbl-optimized') takes over
11409 ;; all keys which are bound to `self-insert-command' in the *global map*.
11410 ;; Some modes bind other commands to simple characters, for example
11411 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11412 ;; active, this binding is ignored inside tables and replaced with a
11413 ;; modified self-insert.
11415 (defvar orgtbl-mode nil
11416 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11417 table editor in arbitrary modes.")
11418 (make-variable-buffer-local 'orgtbl-mode)
11420 (defvar orgtbl-mode-map (make-keymap)
11421 "Keymap for `orgtbl-mode'.")
11423 ;;;###autoload
11424 (defun turn-on-orgtbl ()
11425 "Unconditionally turn on `orgtbl-mode'."
11426 (orgtbl-mode 1))
11428 (defvar org-old-auto-fill-inhibit-regexp nil
11429 "Local variable used by `orgtbl-mode'")
11432 "Matches a line belonging to an orgtbl.")
11434 (defconst orgtbl-extra-font-lock-keywords
11435 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11436 0 (quote 'org-table) 'prepend))
11437 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11439 ;;;###autoload
11440 (defun orgtbl-mode (&optional arg)
11441 "The `org-mode' table editor as a minor mode for use in other modes."
11442 (interactive)
11443 (org-load-modules-maybe)
11444 (if (org-mode-p)
11445 ;; Exit without error, in case some hook functions calls this
11446 ;; by accident in org-mode.
11447 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11448 (setq orgtbl-mode
11449 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11450 (if orgtbl-mode
11451 (progn
11452 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11453 ;; Make sure we are first in minor-mode-map-alist
11454 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11455 (and c (setq minor-mode-map-alist
11456 (cons c (delq c minor-mode-map-alist)))))
11457 (org-set-local (quote org-table-may-need-update) t)
11458 (org-add-hook 'before-change-functions 'org-before-change-function
11459 nil 'local)
11460 (org-set-local 'org-old-auto-fill-inhibit-regexp
11461 auto-fill-inhibit-regexp)
11462 (org-set-local 'auto-fill-inhibit-regexp
11463 (if auto-fill-inhibit-regexp
11465 auto-fill-inhibit-regexp)
11466 orgtbl-line-start-regexp))
11467 (org-add-to-invisibility-spec '(org-cwidth))
11468 (when (fboundp 'font-lock-add-keywords)
11469 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11470 (org-restart-font-lock))
11471 (easy-menu-add orgtbl-mode-menu)
11472 (run-hooks 'orgtbl-mode-hook))
11473 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11474 (org-cleanup-narrow-column-properties)
11475 (org-remove-from-invisibility-spec '(org-cwidth))
11476 (remove-hook 'before-change-functions 'org-before-change-function t)
11477 (when (fboundp 'font-lock-remove-keywords)
11478 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11479 (org-restart-font-lock))
11480 (easy-menu-remove orgtbl-mode-menu)
11481 (force-mode-line-update 'all))))
11483 (defun org-cleanup-narrow-column-properties ()
11484 "Remove all properties related to narrow-column invisibility."
11485 (let ((s 1))
11486 (while (setq s (text-property-any s (point-max)
11487 'display org-narrow-column-arrow))
11488 (remove-text-properties s (1+ s) '(display t)))
11489 (setq s 1)
11490 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11491 (remove-text-properties s (1+ s) '(org-cwidth t)))
11492 (setq s 1)
11493 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11494 (remove-text-properties s (1+ s) '(invisible t)))))
11496 ;; Install it as a minor mode.
11497 (put 'orgtbl-mode :included t)
11498 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11499 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11501 (defun orgtbl-make-binding (fun n &rest keys)
11502 "Create a function for binding in the table minor mode.
11503 FUN is the command to call inside a table. N is used to create a unique
11504 command name. KEYS are keys that should be checked in for a command
11505 to execute outside of tables."
11506 (eval
11507 (list 'defun
11508 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11509 '(arg)
11511 "Outside of tables, run the binding of `"
11512 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11513 "'.")
11514 '(interactive "p")
11515 (list 'if
11516 '(org-at-table-p)
11517 (list 'call-interactively (list 'quote fun))
11518 (list 'let '(orgtbl-mode)
11519 (list 'call-interactively
11520 (append '(or)
11521 (mapcar (lambda (k)
11522 (list 'key-binding k))
11523 keys)
11524 '('orgtbl-error))))))))
11526 (defun orgtbl-error ()
11527 "Error when there is no default binding for a table key."
11528 (interactive)
11529 (error "This key has no function outside tables"))
11531 (defun orgtbl-setup ()
11532 "Setup orgtbl keymaps."
11533 (let ((nfunc 0)
11534 (bindings
11535 (list
11536 '([(meta shift left)] org-table-delete-column)
11537 '([(meta left)] org-table-move-column-left)
11538 '([(meta right)] org-table-move-column-right)
11539 '([(meta shift right)] org-table-insert-column)
11540 '([(meta shift up)] org-table-kill-row)
11541 '([(meta shift down)] org-table-insert-row)
11542 '([(meta up)] org-table-move-row-up)
11543 '([(meta down)] org-table-move-row-down)
11544 '("\C-c\C-w" org-table-cut-region)
11545 '("\C-c\M-w" org-table-copy-region)
11546 '("\C-c\C-y" org-table-paste-rectangle)
11547 '("\C-c-" org-table-insert-hline)
11548 '("\C-c}" org-table-toggle-coordinate-overlays)
11549 '("\C-c{" org-table-toggle-formula-debugger)
11550 '("\C-m" org-table-next-row)
11551 '([(shift return)] org-table-copy-down)
11552 '("\C-c\C-q" org-table-wrap-region)
11553 '("\C-c?" org-table-field-info)
11554 '("\C-c " org-table-blank-field)
11555 '("\C-c+" org-table-sum)
11556 '("\C-c=" org-table-eval-formula)
11557 '("\C-c'" org-table-edit-formulas)
11558 '("\C-c`" org-table-edit-field)
11559 '("\C-c*" org-table-recalculate)
11560 '("\C-c|" org-table-create-or-convert-from-region)
11561 '("\C-c^" org-table-sort-lines)
11562 '([(control ?#)] org-table-rotate-recalc-marks)))
11563 elt key fun cmd)
11564 (while (setq elt (pop bindings))
11565 (setq nfunc (1+ nfunc))
11566 (setq key (org-key (car elt))
11567 fun (nth 1 elt)
11568 cmd (orgtbl-make-binding fun nfunc key))
11569 (org-defkey orgtbl-mode-map key cmd))
11571 ;; Special treatment needed for TAB and RET
11572 (org-defkey orgtbl-mode-map [(return)]
11573 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11574 (org-defkey orgtbl-mode-map "\C-m"
11575 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11577 (org-defkey orgtbl-mode-map [(tab)]
11578 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11579 (org-defkey orgtbl-mode-map "\C-i"
11580 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11582 (org-defkey orgtbl-mode-map [(shift tab)]
11583 (orgtbl-make-binding 'org-table-previous-field 104
11584 [(shift tab)] [(tab)] "\C-i"))
11586 (org-defkey orgtbl-mode-map "\M-\C-m"
11587 (orgtbl-make-binding 'org-table-wrap-region 105
11588 "\M-\C-m" [(meta return)]))
11589 (org-defkey orgtbl-mode-map [(meta return)]
11590 (orgtbl-make-binding 'org-table-wrap-region 106
11591 [(meta return)] "\M-\C-m"))
11593 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11594 (when orgtbl-optimized
11595 ;; If the user wants maximum table support, we need to hijack
11596 ;; some standard editing functions
11597 (org-remap orgtbl-mode-map
11598 'self-insert-command 'orgtbl-self-insert-command
11599 'delete-char 'org-delete-char
11600 'delete-backward-char 'org-delete-backward-char)
11601 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11602 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11603 '("OrgTbl"
11604 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11605 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11606 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11607 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11608 "--"
11609 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11610 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11611 ["Copy Field from Above"
11612 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11613 "--"
11614 ("Column"
11615 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11616 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11617 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11618 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11619 ("Row"
11620 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11621 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11622 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11623 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11624 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
11625 "--"
11626 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11627 ("Rectangle"
11628 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11629 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11630 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11631 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11632 "--"
11633 ("Radio tables"
11634 ["Insert table template" orgtbl-insert-radio-table
11635 (assq major-mode orgtbl-radio-table-templates)]
11636 ["Comment/uncomment table" orgtbl-toggle-comment t])
11637 "--"
11638 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11639 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11640 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11641 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11642 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11643 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11644 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11645 ["Sum Column/Rectangle" org-table-sum
11646 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11647 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11648 ["Debug Formulas"
11649 org-table-toggle-formula-debugger :active (org-at-table-p)
11650 :keys "C-c {"
11651 :style toggle :selected org-table-formula-debug]
11652 ["Show Col/Row Numbers"
11653 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11654 :keys "C-c }"
11655 :style toggle :selected org-table-overlay-coordinates]
11656 ))
11657 t))
11659 (defun orgtbl-ctrl-c-ctrl-c (arg)
11660 "If the cursor is inside a table, realign the table.
11661 It it is a table to be sent away to a receiver, do it.
11662 With prefix arg, also recompute table."
11663 (interactive "P")
11664 (let ((pos (point)) action)
11665 (save-excursion
11666 (beginning-of-line 1)
11670 (cond
11671 ((integerp action)
11672 (goto-char action)
11673 (org-table-maybe-eval-formula)
11674 (if arg
11675 (call-interactively 'org-table-recalculate)
11676 (org-table-maybe-recalculate-line))
11677 (call-interactively 'org-table-align)
11678 (orgtbl-send-table 'maybe))
11679 ((eq action 'recalc)
11680 (save-excursion
11681 (beginning-of-line 1)
11683 (if (org-at-table-p)
11684 (org-call-with-arg 'org-table-recalculate t))))
11685 (t (let (orgtbl-mode)
11686 (call-interactively (key-binding "\C-c\C-c")))))))
11688 (defun orgtbl-tab (arg)
11689 "Justification and field motion for `orgtbl-mode'."
11690 (interactive "P")
11691 (if arg (org-table-edit-field t)
11692 (org-table-justify-field-maybe)
11693 (org-table-next-field)))
11695 (defun orgtbl-ret ()
11696 "Justification and field motion for `orgtbl-mode'."
11697 (interactive)
11698 (org-table-justify-field-maybe)
11699 (org-table-next-row))
11701 (defun orgtbl-self-insert-command (N)
11702 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11703 If the cursor is in a table looking at whitespace, the whitespace is
11704 overwritten, and the table is not marked as requiring realignment."
11705 (interactive "p")
11706 (if (and (org-at-table-p)
11707 (or
11708 (and org-table-auto-blank-field
11709 (member last-command
11710 '(orgtbl-hijacker-command-100
11711 orgtbl-hijacker-command-101
11712 orgtbl-hijacker-command-102
11713 orgtbl-hijacker-command-103
11714 orgtbl-hijacker-command-104
11715 orgtbl-hijacker-command-105))
11716 (org-table-blank-field))
11717 t)
11718 (eq N 1)
11720 (let (org-table-may-need-update)
11721 (goto-char (1- (match-end 0)))
11722 (delete-backward-char 1)
11723 (goto-char (match-beginning 0))
11724 (self-insert-command N))
11725 (setq org-table-may-need-update t)
11726 (let (orgtbl-mode)
11727 (call-interactively (key-binding (vector last-input-event))))))
11729 (defun org-force-self-insert (N)
11730 "Needed to enforce self-insert under remapping."
11731 (interactive "p")
11732 (self-insert-command N))
11735 "Regula expression matching exponentials as produced by calc.")
11737 (defvar org-table-clean-did-remove-column nil)
11739 (defun orgtbl-export (table target)
11740 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11742 org-table-last-alignment org-table-last-column-widths
11743 maxcol column)
11744 (if (not (fboundp func))
11745 (error "Cannot export orgtbl table to %s" target))
11746 (setq lines (org-table-clean-before-export lines))
11747 (setq table
11748 (mapcar
11749 (lambda (x)
11750 (if (string-match org-table-hline-regexp x)
11751 'hline
11753 lines))
11754 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11755 table)))
11756 (loop for i from (1- maxcol) downto 0 do
11757 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11758 (setq column (delq nil column))
11759 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11760 (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))
11761 (funcall func table nil)))
11763 (defun orgtbl-send-table (&optional maybe)
11764 "Send a tranformed version of this table to the receiver position.
11765 With argument MAYBE, fail quietly if no transformation is defined for
11766 this table."
11767 (interactive)
11768 (catch 'exit
11769 (unless (org-at-table-p) (error "Not at a table"))
11770 ;; when non-interactive, we assume align has just happened.
11771 (when (interactive-p) (org-table-align))
11772 (save-excursion
11773 (goto-char (org-table-begin))
11774 (beginning-of-line 0)
11776 (if maybe
11777 (throw 'exit nil)
11778 (error "Don't know how to transform this table."))))
11779 (let* ((name (match-string 1))
11780 beg
11781 (transform (intern (match-string 2)))
11782 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11783 (skip (plist-get params :skip))
11784 (skipcols (plist-get params :skipcols))
11785 (txt (buffer-substring-no-properties
11786 (org-table-begin) (org-table-end)))
11788 (lines (org-table-clean-before-export lines))
11789 (i0 (if org-table-clean-did-remove-column 2 1))
11790 (table (mapcar
11791 (lambda (x)
11792 (if (string-match org-table-hline-regexp x)
11793 'hline
11794 (org-remove-by-index
11796 skipcols i0)))
11797 lines))
11798 (fun (if (= i0 2) 'cdr 'identity))
11799 (org-table-last-alignment
11800 (org-remove-by-index (funcall fun org-table-last-alignment)
11801 skipcols i0))
11802 (org-table-last-column-widths
11803 (org-remove-by-index (funcall fun org-table-last-column-widths)
11804 skipcols i0)))
11806 (unless (fboundp transform)
11807 (error "No such transformation function %s" transform))
11808 (setq txt (funcall transform table params))
11809 ;; Find the insertion place
11810 (save-excursion
11811 (goto-char (point-min))
11812 (unless (re-search-forward
11814 (error "Don't know where to insert translated table"))
11815 (goto-char (match-beginning 0))
11816 (beginning-of-line 2)
11817 (setq beg (point))
11818 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11819 (error "Cannot find end of insertion region"))
11820 (beginning-of-line 1)
11821 (delete-region beg (point))
11822 (goto-char beg)
11824 (message "Table converted and installed at receiver location"))))
11826 (defun org-remove-by-index (list indices &optional i0)
11827 "Remove the elements in LIST with indices in INDICES.
11828 First element has index 0, or I0 if given."
11829 (if (not indices)
11830 list
11831 (if (integerp indices) (setq indices (list indices)))
11832 (setq i0 (1- (or i0 0)))
11833 (delq :rm (mapcar (lambda (x)
11834 (setq i0 (1+ i0))
11835 (if (memq i0 indices) :rm x))
11836 list))))
11838 (defun orgtbl-toggle-comment ()
11839 "Comment or uncomment the orgtbl at point."
11840 (interactive)
11841 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11842 (re2 (concat "^" orgtbl-line-start-regexp))
11843 (commented (save-excursion (beginning-of-line 1)
11844 (cond ((looking-at re1) t)
11845 ((looking-at re2) nil)
11846 (t (error "Not at an org table")))))
11847 (re (if commented re1 re2))
11848 beg end)
11849 (save-excursion
11850 (beginning-of-line 1)
11851 (while (looking-at re) (beginning-of-line 0))
11852 (beginning-of-line 2)
11853 (setq beg (point))
11854 (while (looking-at re) (beginning-of-line 2))
11855 (setq end (point)))
11856 (comment-region beg end (if commented '(4) nil))))
11858 (defun orgtbl-insert-radio-table ()
11859 "Insert a radio table template appropriate for this major mode."
11860 (interactive)
11861 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11862 (txt (nth 1 e))
11863 name pos)
11864 (unless e (error "No radio table setup defined for %s" major-mode))
11865 (setq name (read-string "Table name: "))
11866 (while (string-match "%n" txt)
11867 (setq txt (replace-match name t t txt)))
11869 (setq pos (point))
11870 (insert txt)
11871 (goto-char pos)))
11873 (defun org-get-param (params header i sym &optional hsym)
11874 "Get parameter value for symbol SYM.
11875 If this is a header line, actually get the value for the symbol with an
11877 If the value is a protperty list, get the element for the current column.
11878 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11879 (let ((val (plist-get params sym)))
11880 (and hsym header (setq val (or (plist-get params hsym) val)))
11881 (if (consp val) (plist-get val i) val)))
11883 (defun orgtbl-to-generic (table params)
11884 "Convert the orgtbl-mode TABLE to some other format.
11885 This generic routine can be used for many standard cases.
11886 TABLE is a list, each entry either the symbol `hline' for a horizontal
11887 separator line, or a list of fields for that line.
11888 PARAMS is a property list of parameters that can influence the conversion.
11889 For the generic converter, some parameters are obligatory: You need to
11890 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11891 :splice, you must have :tstart and :tend.
11893 Valid parameters are
11895 :tstart String to start the table. Ignored when :splice is t.
11896 :tend String to end the table. Ignored when :splice is t.
11898 :splice When set to t, return only table body lines, don't wrap
11899 them into :tstart and :tend. Default is nil.
11901 :hline String to be inserted on horizontal separation lines.
11902 May be nil to ignore hlines.
11904 :lstart String to start a new table line.
11905 :lend String to end a table line
11906 :sep Separator between two fields
11907 :lfmt Format for entire line, with enough %s to capture all fields.
11908 If this is present, :lstart, :lend, and :sep are ignored.
11909 :fmt A format to be used to wrap the field, should contain
11910 %s for the original field value. For example, to wrap
11912 This may also be a property list with column numbers and
11915 :hlstart :hlend :hlsep :hlfmt :hfmt
11916 Same as above, specific for the header lines in the table.
11917 All lines before the first hline are treated as header.
11918 If any of these is not present, the data line value is used.
11920 :efmt Use this format to print numbers with exponentials.
11921 The format should have %s twice for inserting mantissa
11923 may also be a property list with column numbers and
11924 formats. :fmt will still be applied after :efmt.
11926 In addition to this, the parameters :skip and :skipcols are always handled
11927 directly by `orgtbl-send-table'. See manual."
11928 (interactive)
11929 (let* ((p params)
11930 (splicep (plist-get p :splice))
11931 (hline (plist-get p :hline))
11932 rtn line i fm efm lfmt h)
11934 ;; Do we have a header?
11935 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11936 (setq h t))
11938 ;; Put header
11939 (unless splicep
11940 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11942 ;; Now loop over all lines
11943 (while (setq line (pop table))
11944 (if (eq line 'hline)
11945 ;; A horizontal separator line
11946 (progn (if hline (push hline rtn))
11947 (setq h nil)) ; no longer in header
11948 ;; A normal line. Convert the fields, push line onto the result list
11949 (setq i 0)
11950 (setq line
11951 (mapcar
11952 (lambda (f)
11953 (setq i (1+ i)
11954 fm (org-get-param p h i :fmt :hfmt)
11955 efm (org-get-param p h i :efmt))
11956 (if (and efm (string-match orgtbl-exp-regexp f))
11957 (setq f (format
11958 efm (match-string 1 f) (match-string 2 f))))
11959 (if fm (setq f (format fm f)))
11960 f)
11961 line))
11962 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11963 (push (apply 'format lfmt line) rtn)
11964 (push (concat
11965 (org-get-param p h i :lstart :hlstart)
11966 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11967 (org-get-param p h i :lend :hlend))
11968 rtn))))
11970 (unless splicep
11971 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11975 (defun orgtbl-to-latex (table params)
11976 "Convert the orgtbl-mode TABLE to LaTeX.
11977 TABLE is a list, each entry either the symbol `hline' for a horizontal
11978 separator line, or a list of fields for that line.
11979 PARAMS is a property list of parameters that can influence the conversion.
11980 Supports all parameters from `orgtbl-to-generic'. Most important for
11981 LaTeX are:
11983 :splice When set to t, return only table body lines, don't wrap
11984 them into a tabular environment. Default is nil.
11986 :fmt A format to be used to wrap the field, should contain %s for the
11987 original field value. For example, to wrap everything in dollars,
11991 :efmt Format for transforming numbers with exponentials. The format
11992 should have %s twice for inserting mantissa and exponent, for
11994 This may also be a property list with column numbers and formats.
11996 The general parameters :skip and :skipcols have already been applied when
11997 this function is called."
11998 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11999 org-table-last-alignment ""))
12000 (params2
12001 (list
12006 (orgtbl-to-generic table (org-combine-plists params2 params))))
12008 (defun orgtbl-to-html (table params)
12009 "Convert the orgtbl-mode TABLE to LaTeX.
12010 TABLE is a list, each entry either the symbol `hline' for a horizontal
12011 separator line, or a list of fields for that line.
12012 PARAMS is a property list of parameters that can influence the conversion.
12013 Currently this function recognizes the following parameters:
12015 :splice When set to t, return only table body lines, don't wrap
12016 them into a <table> environment. Default is nil.
12018 The general parameters :skip and :skipcols have already been applied when
12019 this function is called. The function does *not* use `orgtbl-to-generic',
12020 so you cannot specify parameters for it."
12021 (let* ((splicep (plist-get params :splice))
12022 html)
12023 ;; Just call the formatter we already have
12024 ;; We need to make text lines for it, so put the fields back together.
12025 (setq html (org-format-org-table-html
12026 (mapcar
12027 (lambda (x)
12028 (if (eq x 'hline)
12029 "|----+----|"
12030 (concat "| " (mapconcat 'identity x " | ") " |")))
12031 table)
12032 splicep))
12034 (setq html (replace-match "" t t html)))
12035 html))
12037 (defun orgtbl-to-texinfo (table params)
12038 "Convert the orgtbl-mode TABLE to TeXInfo.
12039 TABLE is a list, each entry either the symbol `hline' for a horizontal
12040 separator line, or a list of fields for that line.
12041 PARAMS is a property list of parameters that can influence the conversion.
12042 Supports all parameters from `orgtbl-to-generic'. Most important for
12043 TeXInfo are:
12045 :splice nil/t When set to t, return only table body lines, don't wrap
12046 them into a multitable environment. Default is nil.
12048 :fmt fmt A format to be used to wrap the field, should contain
12049 %s for the original field value. For example, to wrap
12051 This may also be a property list with column numbers and
12055 are computed automatically from the width of the columns
12056 under org-mode.
12058 The general parameters :skip and :skipcols have already been applied when
12059 this function is called."
12060 (let* ((total (float (apply '+ org-table-last-column-widths)))
12061 (colfrac (or (plist-get params :cf)
12062 (mapconcat
12063 (lambda (x) (format "%.3f" (/ (float x) total)))
12064 org-table-last-column-widths " ")))
12065 (params2
12066 (list
12067 :tstart (concat "@multitable @columnfractions " colfrac)
12068 :tend "@end multitable"
12069 :lstart "@item " :lend "" :sep " @tab "
12070 :hlstart "@headitem ")))
12071 (orgtbl-to-generic table (org-combine-plists params2 params))))
12073 ;;;; Link Stuff
12075 ;;; Link abbreviations
12077 (defun org-link-expand-abbrev (link)
12078 "Apply replacements as defined in `org-link-abbrev-alist."
12080 (let* ((key (match-string 1 link))
12081 (as (or (assoc key org-link-abbrev-alist-local)
12082 (assoc key org-link-abbrev-alist)))
12083 (tag (and (match-end 2) (match-string 3 link)))
12084 rpl)
12085 (if (not as)
12086 link
12087 (setq rpl (cdr as))
12088 (cond
12089 ((symbolp rpl) (funcall rpl tag))
12090 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
12091 (t (concat rpl tag)))))
12092 link))
12094 ;;; Storing and inserting links
12096 (defvar org-insert-link-history nil
12097 "Minibuffer history for links inserted with `org-insert-link'.")
12099 (defvar org-stored-links nil
12100 "Contains the links stored with `org-store-link'.")
12102 (defvar org-store-link-plist nil
12103 "Plist with info about the most recently link created with `org-store-link'.")
12105 (defvar org-link-protocols nil
12106 "Link protocols added to Org-mode using `org-add-link-type'.")
12108 (defvar org-store-link-functions nil
12109 "List of functions that are called to create and store a link.
12110 Each function will be called in turn until one returns a non-nil
12111 value. Each function should check if it is responsible for creating
12112 this link (for example by looking at the major mode).
12113 If not, it must exit and return nil.
12114 If yes, it should return a non-nil value after a calling
12115 `org-store-link-props' with a list of properties and values.
12116 Special properties are:
12120 This is obligatory as well.
12121 :description Optional default description for the second pair
12122 of brackets in an Org-mode link. The user can still change
12123 this when inserting this link into an Org-mode buffer.
12125 In addition to these, any additional properties can be specified
12126 and then used in remember templates.")
12128 (defun org-add-link-type (type &optional follow export)
12129 "Add TYPE to the list of `org-link-types'.
12130 Re-compute all regular expressions depending on `org-link-types'
12132 FOLLOW and EXPORT are two functions.
12134 FOLLOW should take the link path as the single argument and do whatever
12135 is necessary to follow the link, for example find a file or display
12136 a mail message.
12138 EXPORT should format the link path for export to one of the export formats.
12139 It should be a function accepting three arguments:
12142 desc the description of the link, if any, nil if there was no descripton
12143 format the export format, a symbol like `html' or `latex'.
12145 The function may use the FORMAT information to return different values
12146 depending on the format. The return value will be put literally into
12147 the exported file.
12148 Org-mode has a built-in default for exporting links. If you are happy with
12149 this default, there is no need to define an export function for the link
12150 type. For a simple example of an export function, see `org-bbdb.el'."
12151 (add-to-list 'org-link-types type t)
12152 (org-make-link-regexps)
12153 (if (assoc type org-link-protocols)
12154 (setcdr (assoc type org-link-protocols) (list follow export))
12155 (push (list type follow export) org-link-protocols)))
12158 (defun org-add-agenda-custom-command (entry)
12159 "Replace or add a command in `org-agenda-custom-commands'.
12160 This is mostly for hacking and trying a new command - once the command
12161 works you probably want to add it to `org-agenda-custom-commands' for good."
12162 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
12163 (if ass
12164 (setcdr ass (cdr entry))
12165 (push entry org-agenda-custom-commands))))
12167 ;;;###autoload
12168 (defun org-store-link (arg)
12170 This link is added to `org-stored-links' and can later be inserted
12173 For some link types, a prefix arg is interpreted:
12174 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12175 For file links, arg negates `org-context-in-file-links'."
12176 (interactive "P")
12177 (org-load-modules-maybe)
12178 (setq org-store-link-plist nil) ; reset
12179 (let (link cpltxt desc description search txt)
12180 (cond
12182 ((run-hook-with-args-until-success 'org-store-link-functions)
12183 (setq link (plist-get org-store-link-plist :link)
12184 desc (or (plist-get org-store-link-plist :description) link)))
12186 ((eq major-mode 'calendar-mode)
12187 (let ((cd (calendar-cursor-to-date)))
12188 (setq link
12189 (format-time-string
12190 (car org-time-stamp-formats)
12191 (apply 'encode-time
12192 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12193 nil nil nil))))
12194 (org-store-link-props :type "calendar" :date cd)))
12196 ((eq major-mode 'w3-mode)
12197 (setq cpltxt (url-view-url t)
12198 link (org-make-link cpltxt))
12199 (org-store-link-props :type "w3" :url (url-view-url t)))
12201 ((eq major-mode 'w3m-mode)
12202 (setq cpltxt (or w3m-current-title w3m-current-url)
12203 link (org-make-link w3m-current-url))
12204 (org-store-link-props :type "w3m" :url (url-view-url t)))
12206 ((setq search (run-hook-with-args-until-success
12207 'org-create-file-search-functions))
12208 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12209 "::" search))
12210 (setq cpltxt (or description link)))
12212 ((eq major-mode 'image-mode)
12213 (setq cpltxt (concat "file:"
12214 (abbreviate-file-name buffer-file-name))
12215 link (org-make-link cpltxt))
12216 (org-store-link-props :type "image" :file buffer-file-name))
12218 ((eq major-mode 'dired-mode)
12219 ;; link to the file in the current line
12220 (setq cpltxt (concat "file:"
12221 (abbreviate-file-name
12222 (expand-file-name
12223 (dired-get-filename nil t))))
12224 link (org-make-link cpltxt)))
12226 ((and buffer-file-name (org-mode-p))
12227 ;; Just link to current headline
12228 (setq cpltxt (concat "file:"
12229 (abbreviate-file-name buffer-file-name)))
12230 ;; Add a context search string
12231 (when (org-xor org-context-in-file-links arg)
12232 ;; Check if we are on a target
12234 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12235 (setq txt (cond
12236 ((org-on-heading-p) nil)
12237 ((org-region-active-p)
12238 (buffer-substring (region-beginning) (region-end)))
12239 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12241 (setq cpltxt
12242 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12243 desc "NONE"))))
12245 (setq cpltxt (substring cpltxt 0 -2)))
12246 (setq link (org-make-link cpltxt)))
12248 ((buffer-file-name (buffer-base-buffer))
12249 ;; Just link to this file here.
12250 (setq cpltxt (concat "file:"
12251 (abbreviate-file-name
12252 (buffer-file-name (buffer-base-buffer)))))
12253 ;; Add a context string
12254 (when (org-xor org-context-in-file-links arg)
12255 (setq txt (if (org-region-active-p)
12256 (buffer-substring (region-beginning) (region-end))
12257 (buffer-substring (point-at-bol) (point-at-eol))))
12258 ;; Only use search option if there is some text.
12260 (setq cpltxt
12261 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12262 desc "NONE")))
12263 (setq link (org-make-link cpltxt)))
12265 ((interactive-p)
12266 (error "Cannot link to a buffer which is not visiting a file"))
12268 (t (setq link nil)))
12270 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12271 (setq link (or link cpltxt)
12272 desc (or desc cpltxt))
12273 (if (equal desc "NONE") (setq desc nil))
12275 (if (and (interactive-p) link)
12276 (progn
12277 (setq org-stored-links
12278 (cons (list link desc) org-stored-links))
12279 (message "Stored: %s" (or desc link)))
12280 (and link (org-make-link-string link desc)))))
12282 (defun org-store-link-props (&rest plist)
12283 "Store link properties, extract names and addresses."
12284 (let (x adr)
12285 (when (setq x (plist-get plist :from))
12286 (setq adr (mail-extract-address-components x))
12287 (plist-put plist :fromname (car adr))
12288 (plist-put plist :fromaddress (nth 1 adr)))
12289 (when (setq x (plist-get plist :to))
12290 (setq adr (mail-extract-address-components x))
12291 (plist-put plist :toname (car adr))
12292 (plist-put plist :toaddress (nth 1 adr))))
12293 (let ((from (plist-get plist :from))
12294 (to (plist-get plist :to)))
12295 (when (and from to org-from-is-user-regexp)
12296 (plist-put plist :fromto
12297 (if (string-match org-from-is-user-regexp from)
12298 (concat "to %t")
12299 (concat "from %f")))))
12300 (setq org-store-link-plist plist))
12302 (defun org-add-link-props (&rest plist)
12303 "Add these properties to the link property list."
12304 (let (key value)
12305 (while plist
12306 (setq key (pop plist) value (pop plist))
12307 (setq org-store-link-plist
12308 (plist-put org-store-link-plist key value)))))
12310 (defun org-email-link-description (&optional fmt)
12311 "Return the description part of an email link.
12312 This takes information from `org-store-link-plist' and formats it
12313 according to FMT (default from `org-email-link-description-format')."
12314 (setq fmt (or fmt org-email-link-description-format))
12315 (let* ((p org-store-link-plist)
12316 (to (plist-get p :toaddress))
12317 (from (plist-get p :fromaddress))
12318 (table
12319 (list
12320 (cons "%c" (plist-get p :fromto))
12321 (cons "%F" (plist-get p :from))
12322 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12323 (cons "%T" (plist-get p :to))
12324 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12325 (cons "%s" (plist-get p :subject))
12326 (cons "%m" (plist-get p :message-id)))))
12327 (when (string-match "%c" fmt)
12328 ;; Check if the user wrote this message
12329 (if (and org-from-is-user-regexp from to
12330 (save-match-data (string-match org-from-is-user-regexp from)))
12331 (setq fmt (replace-match "to %t" t t fmt))
12332 (setq fmt (replace-match "from %f" t t fmt))))
12333 (org-replace-escapes fmt table)))
12335 (defun org-make-org-heading-search-string (&optional string heading)
12336 "Make search string for STRING or current headline."
12337 (interactive)
12338 (let ((s (or string (org-get-heading))))
12339 (unless (and string (not heading))
12340 ;; We are using a headline, clean up garbage in there.
12341 (if (string-match org-todo-regexp s)
12342 (setq s (replace-match "" t t s)))
12344 (setq s (replace-match "" t t s)))
12345 (setq s (org-trim s))
12348 (setq s (replace-match "" t t s)))
12349 (while (string-match org-ts-regexp s)
12350 (setq s (replace-match "" t t s))))
12352 (setq s (replace-match " " t t s)))
12353 (or string (setq s (concat "*" s))) ; Add * for headlines
12356 (defun org-make-link (&rest strings)
12357 "Concatenate STRINGS."
12358 (apply 'concat strings))
12360 (defun org-make-link-string (link &optional description)
12361 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12363 (error "Empty link"))
12364 (when (stringp description)
12365 ;; Remove brackets from the description, they are fatal.
12367 (setq description (replace-match "{" t t description)))
12369 (setq description (replace-match "}" t t description))))
12370 (when (equal (org-link-escape link) description)
12371 ;; No description needed, it is identical
12372 (setq description nil))
12373 (when (and (not description)
12374 (not (equal link (org-link-escape link))))
12375 (setq description link))
12376 (concat "[[" (org-link-escape link) "]"
12377 (if description (concat "[" description "]") "")
12378 "]"))
12380 (defconst org-link-escape-chars
12381 '((?\ . "%20")
12382 (?\[ . "%5B")
12383 (?\] . "%5D")
12394 (?\; . "%3B")
12395 (?? . "%3F")
12396 (?= . "%3D")
12397 (?+ . "%2B")
12398 )
12399 "Association list of escapes for some characters problematic in links.
12400 This is the list that is used for internal purposes.")
12402 (defconst org-link-escape-chars-browser
12403 '((?\ . "%20")) ; 32 for the SPC char
12404 "Association list of escapes for some characters problematic in links.
12405 This is the list that is used before handing over to the browser.")
12407 (defun org-link-escape (text &optional table)
12408 "Escape charaters in TEXT that are problematic for links."
12409 (setq table (or table org-link-escape-chars))
12410 (when text
12411 (let ((re (mapconcat (lambda (x) (regexp-quote
12412 (char-to-string (car x))))
12414 (while (string-match re text)
12415 (setq text
12416 (replace-match
12417 (cdr (assoc (string-to-char (match-string 0 text))
12418 table))
12419 t t text)))
12420 text)))
12422 (defun org-link-unescape (text &optional table)
12423 "Reverse the action of `org-link-escape'."
12424 (setq table (or table org-link-escape-chars))
12425 (when text
12426 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12428 (while (string-match re text)
12429 (setq text
12430 (replace-match
12431 (char-to-string (car (rassoc (match-string 0 text) table)))
12432 t t text)))
12433 text)))
12435 (defun org-xor (a b)
12436 "Exclusive or."
12437 (if a (not b) b))
12439 (defun org-get-header (header)
12440 "Find a header field in the current buffer."
12441 (save-excursion
12442 (goto-char (point-min))
12443 (let ((case-fold-search t) s)
12444 (cond
12445 ((eq header 'from)
12447 (setq s (match-string 1)))
12449 (setq s (replace-match "" t t s)))
12450 (if (string-match "[<(].*" s)
12451 (setq s (replace-match "" t t s))))
12452 ((eq header 'message-id)
12454 (setq s (match-string 1))))
12455 ((eq header 'subject)
12457 (setq s (match-string 1)))))
12460 s)))
12463 (defun org-fixup-message-id-for-http (s)
12464 "Replace special characters in a message id, so it can be used in an http query."
12465 (while (string-match "<" s)
12466 (setq s (replace-match "%3C" t t s)))
12467 (while (string-match ">" s)
12468 (setq s (replace-match "%3E" t t s)))
12469 (while (string-match "@" s)
12470 (setq s (replace-match "%40" t t s)))
12471 s)
12473 ;;;###autoload
12474 (defun org-insert-link-global ()
12475 "Insert a link like Org-mode does.
12476 This command can be called in any mode to insert a link in Org-mode syntax."
12477 (interactive)
12478 (org-load-modules-maybe)
12479 (org-run-like-in-org-mode 'org-insert-link))
12481 (defun org-insert-link (&optional complete-file)
12482 "Insert a link. At the prompt, enter the link.
12484 Completion can be used to select a link previously stored with
12485 `org-store-link'. When the empty string is entered (i.e. if you just
12486 press RET at the prompt), the link defaults to the most recently
12487 stored link. As SPC triggers completion in the minibuffer, you need to
12488 use M-SPC or C-q SPC to force the insertion of a space character.
12490 You will also be prompted for a description, and if one is given, it will
12491 be displayed in the buffer instead of the link.
12493 If there is already a link at point, this command will allow you to edit link
12494 and description parts.
12497 selected using completion. The path to the file will be relative to
12498 the current directory if the file is in the current directory or a
12499 subdirectory. Otherwise, the link will be the absolute path as
12500 completed in the minibuffer (i.e. normally ~/path/to/file).
12503 is in the current directory or below.
12505 `org-keep-stored-link-after-insertion'."
12506 (interactive "P")
12507 (let* ((wcf (current-window-configuration))
12508 (region (if (org-region-active-p)
12509 (buffer-substring (region-beginning) (region-end))))
12510 (remove (and region (list (region-beginning) (region-end))))
12511 (desc region)
12512 tmphist ; byte-compile incorrectly complains about this
12513 link entry file)
12514 (cond
12515 ((org-in-regexp org-bracket-link-regexp 1)
12516 ;; We do have a link at point, and we are going to edit it.
12517 (setq remove (list (match-beginning 0) (match-end 0)))
12518 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12519 (setq link (read-string "Link: "
12520 (org-link-unescape
12521 (org-match-string-no-properties 1)))))
12522 ((or (org-in-regexp org-angle-link-re)
12523 (org-in-regexp org-plain-link-re))
12524 ;; Convert to bracket link
12525 (setq remove (list (match-beginning 0) (match-end 0))
12526 link (read-string "Link: "
12527 (org-remove-angle-brackets (match-string 0)))))
12528 ((equal complete-file '(4))
12529 ;; Completing read for file names.
12530 (setq file (read-file-name "File: "))
12531 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12532 (pwd1 (file-name-as-directory (abbreviate-file-name
12533 (expand-file-name ".")))))
12534 (cond
12535 ((equal complete-file '(16))
12536 (setq link (org-make-link
12537 "file:"
12538 (abbreviate-file-name (expand-file-name file)))))
12540 (setq link (org-make-link "file:" (match-string 1 file))))
12542 (expand-file-name file))
12543 (setq link (org-make-link
12544 "file:" (match-string 1 (expand-file-name file)))))
12545 (t (setq link (org-make-link "file:" file))))))
12546 (t
12547 ;; Read link, with completion for stored links.
12548 (with-output-to-temp-buffer "*Org Links*"
12550 (when org-stored-links
12552 (princ (mapconcat
12553 (lambda (x)
12554 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12556 (let ((cw (selected-window)))
12557 (select-window (get-buffer-window "*Org Links*"))
12558 (shrink-window-if-larger-than-buffer)
12559 (setq truncate-lines t)
12560 (select-window cw))
12561 ;; Fake a link history, containing the stored links.
12562 (setq tmphist (append (mapcar 'car org-stored-links)
12563 org-insert-link-history))
12564 (unwind-protect
12565 (setq link (org-completing-read
12566 "Link: "
12567 (append
12568 (mapcar (lambda (x) (list (concat (car x) ":")))
12569 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12570 (mapcar (lambda (x) (list (concat x ":")))
12571 org-link-types))
12572 nil nil nil
12573 'tmphist
12574 (or (car (car org-stored-links)))))
12575 (set-window-configuration wcf)
12576 (kill-buffer "*Org Links*"))
12577 (setq entry (assoc link org-stored-links))
12578 (or entry (push link org-insert-link-history))
12579 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12580 (not org-keep-stored-link-after-insertion))
12581 (setq org-stored-links (delq (assoc link org-stored-links)
12582 org-stored-links)))
12583 (setq desc (or desc (nth 1 entry)))))
12585 (if (string-match org-plain-link-re link)
12586 ;; URL-like link, normalize the use of angular brackets.
12587 (setq link (org-make-link (org-remove-angle-brackets link))))
12589 ;; Check if we are linking to the current file with a search option
12590 ;; If yes, simplify the link by using only the search option.
12591 (when (and buffer-file-name
12593 (let* ((path (match-string 1 link))
12594 (case-fold-search nil)
12595 (search (match-string 2 link)))
12596 (save-match-data
12597 (if (equal (file-truename buffer-file-name) (file-truename path))
12598 ;; We are linking to this same file, with a search option
12599 (setq link search)))))
12601 ;; Check if we can/should use a relative path. If yes, simplify the link
12603 (let* ((path (match-string 1 link))
12604 (origpath path)
12605 (case-fold-search nil))
12606 (cond
12607 ((eq org-link-file-path-type 'absolute)
12608 (setq path (abbreviate-file-name (expand-file-name path))))
12609 ((eq org-link-file-path-type 'noabbrev)
12610 (setq path (expand-file-name path)))
12611 ((eq org-link-file-path-type 'relative)
12612 (setq path (file-relative-name path)))
12613 (t
12614 (save-match-data
12615 (if (string-match (concat "^" (regexp-quote
12616 (file-name-as-directory
12617 (expand-file-name "."))))
12618 (expand-file-name path))
12619 ;; We are linking a file with relative path name.
12620 (setq path (substring (expand-file-name path)
12621 (match-end 0)))))))
12622 (setq link (concat "file:" path))
12623 (if (equal desc origpath)
12624 (setq desc path))))
12626 (setq desc (read-string "Description: " desc))
12628 (if remove (apply 'delete-region remove))
12629 (insert (org-make-link-string link desc))))
12631 (defun org-completing-read (&rest args)
12632 (let ((minibuffer-local-completion-map
12633 (copy-keymap minibuffer-local-completion-map)))
12634 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12635 (apply 'completing-read args)))
12637 ;;; Opening/following a link
12638 (defvar org-link-search-failed nil)
12640 (defun org-next-link ()
12641 "Move forward to the next link.
12642 If the link is in hidden text, expose it."
12643 (interactive)
12644 (when (and org-link-search-failed (eq this-command last-command))
12645 (goto-char (point-min))
12646 (message "Link search wrapped back to beginning of buffer"))
12647 (setq org-link-search-failed nil)
12648 (let* ((pos (point))
12649 (ct (org-context))
12650 (a (assoc :link ct)))
12651 (if a (goto-char (nth 2 a)))
12652 (if (re-search-forward org-any-link-re nil t)
12653 (progn
12654 (goto-char (match-beginning 0))
12655 (if (org-invisible-p) (org-show-context)))
12656 (goto-char pos)
12657 (setq org-link-search-failed t)
12658 (error "No further link found"))))
12660 (defun org-previous-link ()
12661 "Move backward to the previous link.
12662 If the link is in hidden text, expose it."
12663 (interactive)
12664 (when (and org-link-search-failed (eq this-command last-command))
12665 (goto-char (point-max))
12666 (message "Link search wrapped back to end of buffer"))
12667 (setq org-link-search-failed nil)
12668 (let* ((pos (point))
12669 (ct (org-context))
12670 (a (assoc :link ct)))
12671 (if a (goto-char (nth 1 a)))
12672 (if (re-search-backward org-any-link-re nil t)
12673 (progn
12674 (goto-char (match-beginning 0))
12675 (if (org-invisible-p) (org-show-context)))
12676 (goto-char pos)
12677 (setq org-link-search-failed t)
12678 (error "No further link found"))))
12680 (defun org-find-file-at-mouse (ev)
12681 "Open file link or URL at mouse."
12682 (interactive "e")
12683 (mouse-set-point ev)
12684 (org-open-at-point 'in-emacs))
12686 (defun org-open-at-mouse (ev)
12687 "Open file link or URL at mouse."
12688 (interactive "e")
12689 (mouse-set-point ev)
12690 (org-open-at-point))
12692 (defvar org-window-config-before-follow-link nil
12693 "The window configuration before following a link.
12694 This is saved in case the need arises to restore it.")
12696 (defvar org-open-link-marker (make-marker)
12697 "Marker pointing to the location where `org-open-at-point; was called.")
12699 ;;;###autoload
12700 (defun org-open-at-point-global ()
12701 "Follow a link like Org-mode does.
12702 This command can be called in any mode to follow a link that has
12703 Org-mode syntax."
12704 (interactive)
12705 (org-run-like-in-org-mode 'org-open-at-point))
12707 (defun org-open-at-point (&optional in-emacs)
12708 "Open link at or after point.
12709 If there is no link at point, this function will search forward up to
12710 the end of the current subtree.
12711 Normally, files will be opened by an appropriate application. If the
12712 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12713 (interactive "P")
12714 (org-load-modules-maybe)
12715 (move-marker org-open-link-marker (point))
12716 (setq org-window-config-before-follow-link (current-window-configuration))
12717 (org-remove-occur-highlights nil nil t)
12718 (if (org-at-timestamp-p t)
12719 (org-follow-timestamp-link)
12720 (let (type path link line search (pos (point)))
12721 (catch 'match
12722 (save-excursion
12724 (when (org-in-regexp org-bracket-link-regexp)
12725 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12727 (setq link (replace-match " " t t link)))
12728 (setq link (org-link-expand-abbrev link))
12729 (if (string-match org-link-re-with-space2 link)
12730 (setq type (match-string 1 link) path (match-string 2 link))
12731 (setq type "thisfile" path link))
12732 (throw 'match t)))
12734 (when (get-text-property (point) 'org-linked-text)
12735 (setq type "thisfile"
12736 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12737 (1+ (point)) (point))
12738 path (buffer-substring
12739 (previous-single-property-change pos 'org-linked-text)
12740 (next-single-property-change pos 'org-linked-text)))
12741 (throw 'match t))
12743 (save-excursion
12744 (when (or (org-in-regexp org-angle-link-re)
12745 (org-in-regexp org-plain-link-re))
12746 (setq type (match-string 1) path (match-string 2))
12747 (throw 'match t)))
12749 (setq type "tree-match"
12750 path (match-string 1))
12751 (throw 'match t))
12752 (save-excursion
12754 (setq type "tags"
12755 path (match-string 1))
12756 (while (string-match ":" path)
12757 (setq path (replace-match "+" t t path)))
12758 (throw 'match t))))
12759 (unless path
12760 (error "No link found"))
12761 ;; Remove any trailing spaces in path
12763 (setq path (replace-match "" t t path)))
12765 (cond
12767 ((assoc type org-link-protocols)
12768 (funcall (nth 1 (assoc type org-link-protocols)) path))
12770 ((equal type "mailto")
12771 (let ((cmd (car org-link-mailto-program))
12772 (args (cdr org-link-mailto-program)) args1
12773 (address path) (subject "") a)
12775 (setq address (match-string 1 path)
12776 subject (org-link-escape (match-string 2 path))))
12777 (while args
12778 (cond
12779 ((not (stringp (car args))) (push (pop args) args1))
12780 (t (setq a (pop args))
12781 (if (string-match "%a" a)
12782 (setq a (replace-match address t t a)))
12783 (if (string-match "%s" a)
12784 (setq a (replace-match subject t t a)))
12785 (push a args1))))
12786 (apply cmd (nreverse args1))))
12788 ((member type '("http" "https" "ftp" "news"))
12789 (browse-url (concat type ":" (org-link-escape
12790 path org-link-escape-chars-browser))))
12792 ((member type '("message"))
12793 (browse-url (concat type ":" path)))
12795 ((string= type "tags")
12796 (org-tags-view in-emacs path))
12797 ((string= type "thisfile")
12798 (if in-emacs
12799 (switch-to-buffer-other-window
12800 (org-get-buffer-for-internal-link (current-buffer)))
12801 (org-mark-ring-push))
12802 (let ((cmd `(org-link-search
12803 ,path
12804 ,(cond ((equal in-emacs '(4)) 'occur)
12805 ((equal in-emacs '(16)) 'org-occur)
12806 (t nil))
12807 ,pos)))
12808 (condition-case nil (eval cmd)
12809 (error (progn (widen) (eval cmd))))))
12811 ((string= type "tree-match")
12814 ((string= type "file")
12816 (setq line (string-to-number (match-string 1 path))
12817 path (substring path 0 (match-beginning 0)))
12819 (setq search (match-string 1 path)
12820 path (substring path 0 (match-beginning 0)))))
12821 (if (string-match "[*?{]" (file-name-nondirectory path))
12822 (dired path)
12823 (org-open-file path in-emacs line search)))
12825 ((string= type "news")
12826 (require 'org-gnus)
12827 (org-gnus-follow-link path))
12829 ((string= type "shell")
12830 (let ((cmd path))
12831 (if (or (not org-confirm-shell-link-function)
12832 (funcall org-confirm-shell-link-function
12834 (org-add-props cmd nil
12835 'face 'org-warning))))
12836 (progn
12837 (message "Executing %s" cmd)
12838 (shell-command cmd))
12839 (error "Abort"))))
12841 ((string= type "elisp")
12842 (let ((cmd path))
12843 (if (or (not org-confirm-elisp-link-function)
12844 (funcall org-confirm-elisp-link-function
12846 (org-add-props cmd nil
12847 'face 'org-warning))))
12848 (message "%s => %s" cmd (eval (read cmd)))
12849 (error "Abort"))))
12851 (t
12852 (browse-url-at-point)))))
12853 (move-marker org-open-link-marker nil)
12854 (run-hook-with-args 'org-follow-link-hook))
12856 ;;; File search
12858 (defvar org-create-file-search-functions nil
12859 "List of functions to construct the right search string for a file link.
12860 These functions are called in turn with point at the location to
12861 which the link should point.
12863 A function in the hook should first test if it would like to
12864 handle this file type, for example by checking the major-mode or
12865 the file extension. If it decides not to handle this file, it
12866 should just return nil to give other functions a chance. If it
12867 does handle the file, it must return the search string to be used
12868 when following the link. The search string will be part of the
12869 file link, given after a double colon, and `org-open-at-point'
12870 will automatically search for it. If special measures must be
12871 taken to make the search successful, another function should be
12872 added to the companion hook `org-execute-file-search-functions',
12873 which see.
12875 A function in this hook may also use `setq' to set the variable
12876 `description' to provide a suggestion for the descriptive text to
12877 be used for this link when it gets inserted into an Org-mode
12880 (defvar org-execute-file-search-functions nil
12881 "List of functions to execute a file search triggered by a link.
12883 Functions added to this hook must accept a single argument, the
12884 search string that was part of the file link, the part after the
12885 double colon. The function must first check if it would like to
12886 handle this search, for example by checking the major-mode or the
12887 file extension. If it decides not to handle this search, it
12888 should just return nil to give other functions a chance. If it
12889 does handle the search, it must return a non-nil value to keep
12890 other functions from trying.
12892 Each function can access the current prefix argument through the
12893 variable `current-prefix-argument'. Note that a single prefix is
12894 used to force opening a link in Emacs, so it may be good to only
12895 use a numeric or double prefix to guide the search function.
12897 In case this is needed, a function in this hook can also restore
12898 the window configuration before `org-open-at-point' was called using:
12900 (set-window-configuration org-window-config-before-follow-link)")
12902 (defun org-link-search (s &optional type avoid-pos)
12903 "Search for a link search option.
12904 If S is surrounded by forward slashes, it is interpreted as a
12905 regular expression. In org-mode files, this will create an `org-occur'
12906 sparse tree. In ordinary files, `occur' will be used to list matches.
12907 If the current buffer is in `dired-mode', grep will be used to search
12908 in all files. If AVOID-POS is given, ignore matches near that position."
12909 (let ((case-fold-search t)
12913 org-emphasis-alist)
12915 (pos (point))
12916 (pre "") (post "")
12917 words re0 re1 re2 re3 re4 re5 re2a reall)
12918 (cond
12919 ;; First check if there are any special
12920 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12921 ;; Now try the builtin stuff
12922 ((save-excursion
12923 (goto-char (point-min))
12924 (and
12925 (re-search-forward
12926 (concat "<<" (regexp-quote s0) ">>") nil t)
12927 (setq pos (match-beginning 0))))
12928 ;; There is an exact target for this
12929 (goto-char pos))
12931 ;; A regular expression
12932 (cond
12933 ((org-mode-p)
12934 (org-occur (match-string 1 s)))
12935 ;;((eq major-mode 'dired-mode)
12936 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12937 (t (org-do-occur (match-string 1 s)))))
12938 (t
12939 ;; A normal search strings
12940 (when (equal (string-to-char s) ?*)
12941 ;; Anchor on headlines, post may include tags.
12944 s (substring s 1)))
12945 (remove-text-properties
12946 0 (length s)
12947 '(face nil mouse-face nil keymap nil fontified nil) s)
12948 ;; Make a series of regular expressions to find a match
12955 re1 (concat pre re2 post)
12956 re3 (concat pre re4 post)
12957 re5 (concat pre ".*" re4)
12958 re2 (concat pre re2)
12959 re2a (concat pre re2a)
12960 re4 (concat pre re4)
12964 ))
12965 (cond
12966 ((eq type 'org-occur) (org-occur reall))
12967 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12968 (t (goto-char (point-min))
12969 (if (or (org-search-not-self 1 re0 nil t)
12970 (org-search-not-self 1 re1 nil t)
12971 (org-search-not-self 1 re2 nil t)
12972 (org-search-not-self 1 re2a nil t)
12973 (org-search-not-self 1 re3 nil t)
12974 (org-search-not-self 1 re4 nil t)
12975 (org-search-not-self 1 re5 nil t)
12976 )
12977 (goto-char (match-beginning 1))
12978 (goto-char pos)
12979 (error "No match")))))
12980 (t
12981 ;; Normal string-search
12982 (goto-char (point-min))
12983 (if (search-forward s nil t)
12984 (goto-char (match-beginning 0))
12985 (error "No match"))))
12986 (and (org-mode-p) (org-show-context 'link-search))))
12988 (defun org-search-not-self (group &rest args)
12989 "Execute `re-search-forward', but only accept matches that do not
12990 enclose the position of `org-open-link-marker'."
12991 (let ((m org-open-link-marker))
12992 (catch 'exit
12993 (while (apply 're-search-forward args)
12994 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12995 (goto-char (match-end group))
12996 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12997 (> (match-beginning 0) (marker-position m))
12998 (< (match-end 0) (marker-position m)))
12999 (save-match-data
13000 (or (not (org-in-regexp
13001 org-bracket-link-analytic-regexp 1))
13002 (not (match-end 4)) ; no description
13003 (and (<= (match-beginning 4) (point))
13004 (>= (match-end 4) (point))))))
13005 (throw 'exit (point))))))))
13007 (defun org-get-buffer-for-internal-link (buffer)
13008 "Return a buffer to be used for displaying the link target of internal links."
13009 (cond
13010 ((not org-display-internal-link-with-indirect-buffer)
13011 buffer)
13012 ((string-match "(Clone)$" (buffer-name buffer))
13013 (message "Buffer is already a clone, not making another one")
13014 ;; we also do not modify visibility in this case
13015 buffer)
13016 (t ; make a new indirect buffer for displaying the link
13017 (let* ((bn (buffer-name buffer))
13018 (ibn (concat bn "(Clone)"))
13019 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13020 (with-current-buffer ib (org-overview))
13021 ib))))
13023 (defun org-do-occur (regexp &optional cleanup)
13024 "Call the Emacs command `occur'.
13025 If CLEANUP is non-nil, remove the printout of the regular expression
13026 in the *Occur* buffer. This is useful if the regex is long and not useful
13027 to read."
13028 (occur regexp)
13029 (when cleanup
13030 (let ((cwin (selected-window)) win beg end)
13031 (when (setq win (get-buffer-window "*Occur*"))
13032 (select-window win))
13033 (goto-char (point-min))
13034 (when (re-search-forward "match[a-z]+" nil t)
13035 (setq beg (match-end 0))
13037 (setq end (1- (match-beginning 0)))))
13038 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13039 (goto-char (point-min))
13040 (select-window cwin))))
13042 ;;; The mark ring for links jumps
13044 (defvar org-mark-ring nil
13045 "Mark ring for positions before jumps in Org-mode.")
13046 (defvar org-mark-ring-last-goto nil
13047 "Last position in the mark ring used to go back.")
13048 ;; Fill and close the ring
13049 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13050 (loop for i from 1 to org-mark-ring-length do
13051 (push (make-marker) org-mark-ring))
13052 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13053 org-mark-ring)
13055 (defun org-mark-ring-push (&optional pos buffer)
13056 "Put the current position or POS into the mark ring and rotate it."
13057 (interactive)
13058 (setq pos (or pos (point)))
13059 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13060 (move-marker (car org-mark-ring)
13061 (or pos (point))
13062 (or buffer (current-buffer)))
13063 (message "%s"
13064 (substitute-command-keys
13067 (defun org-mark-ring-goto (&optional n)
13068 "Jump to the previous position in the mark ring.
13069 With prefix arg N, jump back that many stored positions. When
13070 called several times in succession, walk through the entire ring.
13071 Org-mode commands jumping to a different position in the current file,
13072 or to another Org-mode file, automatically push the old position
13073 onto the ring."
13074 (interactive "p")
13075 (let (p m)
13076 (if (eq last-command this-command)
13077 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13078 (setq p org-mark-ring))
13079 (setq org-mark-ring-last-goto p)
13080 (setq m (car p))
13081 (switch-to-buffer (marker-buffer m))
13082 (goto-char m)
13083 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13085 (defun org-remove-angle-brackets (s)
13086 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13087 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13088 s)
13089 (defun org-add-angle-brackets (s)
13090 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13091 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13092 s)
13094 ;;; Following specific links
13096 (defun org-follow-timestamp-link ()
13097 (cond
13098 ((org-at-date-range-p t)
13099 (let ((org-agenda-start-on-weekday)
13100 (t1 (match-string 1))
13101 (t2 (match-string 2)))
13102 (setq t1 (time-to-days (org-time-string-to-time t1))
13103 t2 (time-to-days (org-time-string-to-time t2)))
13104 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13105 ((org-at-timestamp-p t)
13106 (org-agenda-list nil (time-to-days (org-time-string-to-time
13107 (substring (match-string 1) 0 10)))
13108 1))
13109 (t (error "This should not happen"))))
13112 ;;; BibTeX links
13114 ;; Use the custom search meachnism to construct and use search strings for
13115 ;; file links to BibTeX database entries.
13117 (defun org-create-file-search-in-bibtex ()
13118 "Create the search string and description for a BibTeX database entry."
13119 (when (eq major-mode 'bibtex-mode)
13120 ;; yes, we want to construct this search string.
13121 ;; Make a good description for this entry, using names, year and the title
13122 ;; Put it into the `description' variable which is dynamically scoped.
13123 (let ((bibtex-autokey-names 1)
13124 (bibtex-autokey-names-stretch 1)
13125 (bibtex-autokey-name-case-convert-function 'identity)
13126 (bibtex-autokey-name-separator " & ")
13127 (bibtex-autokey-additional-names " et al.")
13128 (bibtex-autokey-year-length 4)
13129 (bibtex-autokey-name-year-separator " ")
13130 (bibtex-autokey-titlewords 3)
13131 (bibtex-autokey-titleword-separator " ")
13132 (bibtex-autokey-titleword-case-convert-function 'identity)
13133 (bibtex-autokey-titleword-length 'infty)
13134 (bibtex-autokey-year-title-separator ": "))
13135 (setq description (bibtex-generate-autokey)))
13136 ;; Now parse the entry, get the key and return it.
13137 (save-excursion
13138 (bibtex-beginning-of-entry)
13139 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13141 (defun org-execute-file-search-in-bibtex (s)
13142 "Find the link search string S as a key for a database entry."
13143 (when (eq major-mode 'bibtex-mode)
13144 ;; Yes, we want to do the search in this file.
13145 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13146 (goto-char (point-min))
13149 (goto-char (match-beginning 0)))
13150 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13151 ;; Use double prefix to indicate that any web link should be browsed
13152 (let ((b (current-buffer)) (p (point)))
13153 ;; Restore the window configuration because we just use the web link
13154 (set-window-configuration org-window-config-before-follow-link)
13155 (save-excursion (set-buffer b) (goto-char p)
13156 (bibtex-url)))
13157 (recenter 0)) ; Move entry start to beginning of window
13158 ;; return t to indicate that the search is done.
13159 t))
13161 ;; Finally add the functions to the right hooks.
13162 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13163 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13165 ;; end of Bibtex link setup
13167 ;;; Following file links
13169 (defun org-open-file (path &optional in-emacs line search)
13170 "Open the file at PATH.
13171 First, this expands any special file name abbreviations. Then the
13172 configuration variable `org-file-apps' is checked if it contains an
13173 entry for this file type, and if yes, the corresponding command is launched.
13174 If no application is found, Emacs simply visits the file.
13175 With optional argument IN-EMACS, Emacs will visit the file.
13176 Optional LINE specifies a line to go to, optional SEARCH a string to
13177 search for. If LINE or SEARCH is given, the file will always be
13178 opened in Emacs.
13179 If the file does not exist, an error is thrown."
13180 (setq in-emacs (or in-emacs line search))
13181 (let* ((file (if (equal path "")
13182 buffer-file-name
13183 (substitute-in-file-name (expand-file-name path))))
13184 (apps (append org-file-apps (org-default-apps)))
13185 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13186 (dirp (if remp nil (file-directory-p file)))
13187 (dfile (downcase file))
13188 (old-buffer (current-buffer))
13189 (old-pos (point))
13190 (old-mode major-mode)
13191 ext cmd)
13193 (setq ext (match-string 1 dfile))
13195 (setq ext (match-string 1 dfile))))
13196 (if in-emacs
13197 (setq cmd 'emacs)
13198 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13199 (and dirp (cdr (assoc 'directory apps)))
13200 (cdr (assoc ext apps))
13201 (cdr (assoc t apps)))))
13202 (when (eq cmd 'mailcap)
13203 (require 'mailcap)
13204 (mailcap-parse-mailcaps)
13205 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13206 (command (mailcap-mime-info mime-type)))
13207 (if (stringp command)
13208 (setq cmd command)
13209 (setq cmd 'emacs))))
13210 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13211 (not (file-exists-p file))
13212 (not org-open-non-existing-files))
13213 (error "No such file: %s" file))
13214 (cond
13216 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13218 (setq cmd (replace-match "%s" t t cmd)))
13219 (while (string-match "%s" cmd)
13220 (setq cmd (replace-match
13221 (save-match-data (shell-quote-argument file))
13222 t t cmd)))
13223 (save-window-excursion
13224 (start-process-shell-command cmd nil cmd)))
13225 ((or (stringp cmd)
13226 (eq cmd 'emacs))
13227 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13228 (widen)
13229 (if line (goto-line line)
13230 (if search (org-link-search search))))
13231 ((consp cmd)
13232 (eval cmd))
13233 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13234 (and (org-mode-p) (eq old-mode 'org-mode)
13235 (or (not (equal old-buffer (current-buffer)))
13236 (not (equal old-pos (point))))
13237 (org-mark-ring-push old-pos old-buffer))))
13239 (defun org-default-apps ()
13240 "Return the default applications for this operating system."
13241 (cond
13242 ((eq system-type 'darwin)
13243 org-file-apps-defaults-macosx)
13244 ((eq system-type 'windows-nt)
13245 org-file-apps-defaults-windowsnt)
13246 (t org-file-apps-defaults-gnu)))
13248 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13249 (defun org-file-remote-p (file)
13250 "Test whether FILE specifies a location on a remote system.
13251 Return non-nil if the location is indeed remote.
13255 (cond ((fboundp 'file-remote-p)
13256 (file-remote-p file))
13257 ((fboundp 'tramp-handle-file-remote-p)
13258 (tramp-handle-file-remote-p file))
13259 ((and (boundp 'ange-ftp-name-format)
13260 (string-match (car ange-ftp-name-format) file))
13261 t)
13262 (t nil)))
13265 ;;;; Hooks for remember.el, and refiling
13267 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13268 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13270 ;;;###autoload
13271 (defun org-remember-insinuate ()
13272 "Setup remember.el for use wiht Org-mode."
13273 (require 'remember)
13274 (setq remember-annotation-functions '(org-remember-annotation))
13275 (setq remember-handler-functions '(org-remember-handler))
13276 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13278 ;;;###autoload
13279 (defun org-remember-annotation ()
13280 "Return a link to the current location as an annotation for remember.el.
13281 If you are using Org-mode files as target for data storage with
13282 remember.el, then the annotations should include a link compatible with the
13283 conventions in Org-mode. This function returns such a link."
13284 (org-store-link nil))
13286 (defconst org-remember-help
13287 "Select a destination location for the note.
13288 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13289 RET on headline -> Store as sublevel entry to current headline
13290 RET at beg-of-buf -> Append to file as level 2 headline
13291 <left>/<right> -> before/after current headline, same headings level")
13293 (defvar org-remember-previous-location nil)
13294 (defvar org-force-remember-template-char) ;; dynamically scoped
13296 ;; Save the major mode of the buffer we called remember from
13297 (defvar org-select-template-temp-major-mode nil)
13299 ;; Temporary store the buffer where remember was called from
13300 (defvar org-select-template-original-buffer nil)
13302 (defun org-select-remember-template (&optional use-char)
13303 (when org-remember-templates
13304 (let* ((pre-selected-templates
13305 (mapcar
13306 (lambda (tpl)
13307 (let ((ctxt (nth 5 tpl))
13308 (mode org-select-template-temp-major-mode)
13309 (buf org-select-template-original-buffer))
13310 (and (or (not ctxt) (eq ctxt t)
13311 (and (listp ctxt) (memq mode ctxt))
13312 (and (functionp ctxt)
13313 (with-current-buffer buf
13314 ;; Protect the user-defined function from error
13315 (condition-case nil (funcall ctxt) (error nil)))))
13316 tpl)))
13317 org-remember-templates))
13318 ;; If no template at this point, add the default templates:
13319 (pre-selected-templates1
13320 (if (not (delq nil pre-selected-templates))
13321 (mapcar (lambda(x) (if (not (nth 5 x)) x))
13322 org-remember-templates)
13323 pre-selected-templates))
13324 ;; Then unconditionnally add template for any contexts
13325 (pre-selected-templates2
13326 (append (mapcar (lambda(x) (if (eq (nth 5 x) t) x))
13327 org-remember-templates)
13328 (delq nil pre-selected-templates1)))
13329 (templates (mapcar (lambda (x)
13330 (if (stringp (car x))
13331 (append (list (nth 1 x) (car x)) (cddr x))
13332 (append (list (car x) "") (cdr x))))
13333 (delq nil pre-selected-templates2)))
13334 (char (or use-char
13335 (cond
13336 ((= (length templates) 1)
13337 (caar templates))
13338 ((and (boundp 'org-force-remember-template-char)
13339 org-force-remember-template-char)
13340 (if (stringp org-force-remember-template-char)
13341 (string-to-char org-force-remember-template-char)
13342 org-force-remember-template-char))
13343 (t
13344 (message "Select template: %s"
13345 (mapconcat
13346 (lambda (x)
13347 (cond
13349 (format "[%c]" (car x)))
13350 ((equal (downcase (car x))
13351 (downcase (aref (nth 1 x) 0)))
13352 (format "[%c]%s" (car x)
13353 (substring (nth 1 x) 1)))
13354 (t (format "[%c]%s" (car x) (nth 1 x)))))
13355 templates " "))
13356 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13357 (when (equal char0 ?\C-g)
13358 (jump-to-register remember-register)
13359 (kill-buffer remember-buffer))
13360 char0))))))
13361 (cddr (assoc char templates)))))
13363 (defvar x-last-selected-text)
13364 (defvar x-last-selected-text-primary)
13366 ;;;###autoload
13367 (defun org-remember-apply-template (&optional use-char skip-interactive)
13368 "Initialize *remember* buffer with template, invoke `org-mode'.
13369 This function should be placed into `remember-mode-hook' and in fact requires
13370 to be run from that hook to function properly."
13371 (if org-remember-templates
13372 (let* ((entry (org-select-remember-template use-char))
13373 (tpl (car entry))
13374 (plist-p (if org-store-link-plist t nil))
13375 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13377 (nth 1 entry)
13378 org-default-notes-file))
13379 (headline (nth 2 entry))
13380 (v-c (or (and (eq window-system 'x)
13381 (fboundp 'x-cut-buffer-or-selection-value)
13382 (x-cut-buffer-or-selection-value))
13383 (org-bound-and-true-p x-last-selected-text)
13384 (org-bound-and-true-p x-last-selected-text-primary)
13385 (and (> (length kill-ring) 0) (current-kill 0))))
13386 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13387 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13388 (v-u (concat "[" (substring v-t 1 -1) "]"))
13389 (v-U (concat "[" (substring v-T 1 -1) "]"))
13390 ;; `initial' and `annotation' are bound in `remember'
13391 (v-i (if (boundp 'initial) initial))
13392 (v-a (if (and (boundp 'annotation) annotation)
13393 (if (equal annotation "[[]]") "" annotation)
13394 ""))
13395 (v-A (if (and v-a
13398 v-a))
13399 (v-n user-full-name)
13400 (org-startup-folded nil)
13401 org-time-was-given org-end-time-was-given x
13402 prompt completions char time pos default histvar)
13403 (setq org-store-link-plist
13404 (append (list :annotation v-a :initial v-i)
13405 org-store-link-plist))
13406 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13407 (erase-buffer)
13408 (insert (substitute-command-keys
13409 (format
13410 "## Filing location: Select interactively, default, or last used:
13411 ## %s to select file and header location interactively.
13415 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13416 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13417 (abbreviate-file-name (or file org-default-notes-file))
13418 (or headline "")
13419 (or (car org-remember-previous-location) "???")
13420 (or (cdr org-remember-previous-location) "???"))))
13421 (insert tpl) (goto-char (point-min))
13422 ;; Simple %-escapes
13424 (when (and initial (equal (match-string 0) "%i"))
13425 (save-match-data
13426 (let* ((lead (buffer-substring
13427 (point-at-bol) (match-beginning 0))))
13428 (setq v-i (mapconcat 'identity
13431 (replace-match
13432 (or (eval (intern (concat "v-" (match-string 1)))) "")
13433 t t))
13435 ;; %[] Insert contents of a file.
13436 (goto-char (point-min))
13438 (let ((start (match-beginning 0))
13439 (end (match-end 0))
13440 (filename (expand-file-name (match-string 1))))
13441 (goto-char start)
13442 (delete-region start end)
13443 (condition-case error
13444 (insert-file-contents filename)
13445 (error (insert (format "%%![Couldn't insert %s: %s]"
13446 filename error))))))
13447 ;; %() embedded elisp
13448 (goto-char (point-min))
13450 (goto-char (match-beginning 0))
13451 (let ((template-start (point)))
13452 (forward-char 1)
13453 (let ((result
13454 (condition-case error
13455 (eval (read (current-buffer)))
13456 (error (format "%%![Error: %s]" error)))))
13457 (delete-region template-start (point))
13458 (insert result))))
13460 ;; From the property list
13461 (when plist-p
13462 (goto-char (point-min))
13464 (and (setq x (or (plist-get org-store-link-plist
13465 (intern (match-string 1))) ""))
13466 (replace-match x t t))))
13468 ;; Turn on org-mode in the remember buffer, set local variables
13469 (org-mode)
13470 (org-set-local 'org-finish-function 'org-remember-finalize)
13472 (org-set-local 'org-default-notes-file file))
13474 (org-set-local 'org-remember-default-headline headline))
13475 ;; Interactive template entries
13476 (goto-char (point-min))
13478 (setq char (if (match-end 3) (match-string 3))
13479 prompt (if (match-end 2) (match-string 2)))
13480 (goto-char (match-beginning 0))
13481 (replace-match "")
13482 (setq completions nil default nil)
13483 (when prompt
13484 (setq completions (org-split-string prompt "|")
13485 prompt (pop completions)
13486 default (car completions)
13487 histvar (intern (concat
13488 "org-remember-template-prompt-history::"
13489 (or prompt "")))
13490 completions (mapcar 'list completions)))
13491 (cond
13492 ((member char '("G" "g"))
13493 (let* ((org-last-tags-completion-table
13494 (org-global-tags-completion-table
13495 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13496 (org-add-colon-after-tag-completion t)
13497 (ins (completing-read
13498 (if prompt (concat prompt ": ") "Tags: ")
13499 'org-tags-completion-function nil nil nil
13500 'org-tags-history)))
13501 (setq ins (mapconcat 'identity
13502 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13503 ":"))
13505 (or (equal (char-before) ?:) (insert ":"))
13506 (insert ins)
13507 (or (equal (char-after) ?:) (insert ":")))))
13508 (char
13509 (setq org-time-was-given (equal (upcase char) char))
13510 (setq time (org-read-date (equal (upcase char) "U") t nil
13511 prompt))
13512 (org-insert-time-stamp time org-time-was-given
13513 (member char '("u" "U"))
13514 nil nil (list org-end-time-was-given)))
13515 (t
13516 (insert (org-completing-read
13517 (concat (if prompt prompt "Enter string")
13518 (if default (concat " [" default "]"))
13519 ": ")
13520 completions nil nil nil histvar default)))))
13521 (goto-char (point-min))
13523 (replace-match "")
13525 (org-mode)
13526 (org-set-local 'org-finish-function 'org-remember-finalize))
13527 (when (save-excursion
13528 (goto-char (point-min))
13529 (re-search-forward "%!" nil t))
13530 (replace-match "")
13531 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13533 (defun org-remember-finish-immediately ()
13534 "File remember note immediately.
13535 This should be run in `post-command-hook' and will remove itself
13536 from that hook."
13537 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13538 (when org-finish-function
13539 (funcall org-finish-function)))
13541 (defvar org-clock-marker) ; Defined below
13542 (defun org-remember-finalize ()
13543 "Finalize the remember process."
13544 (unless (fboundp 'remember-finalize)
13545 (defalias 'remember-finalize 'remember-buffer))
13546 (when (and org-clock-marker
13547 (equal (marker-buffer org-clock-marker) (current-buffer)))
13548 ;; FIXME: test this, this is w/o notetaking!
13549 (let (org-log-note-clock-out) (org-clock-out)))
13550 (when buffer-file-name
13551 (save-buffer)
13552 (setq buffer-file-name nil))
13553 (remember-finalize))
13555 ;;;###autoload
13556 (defun org-remember (&optional goto org-force-remember-template-char)
13557 "Call `remember'. If this is already a remember buffer, re-apply template.
13558 If there is an active region, make sure remember uses it as initial content
13559 of the remember buffer.
13561 When called interactively with a `C-u' prefix argument GOTO, don't remember
13562 anything, just go to the file/headline where the selected template usually
13563 stores its notes. With a double prefix arg `C-u C-u', go to the last
13564 note stored by remember.
13566 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13567 associated with a template in `org-remember-templates'."
13568 (interactive "P")
13569 (cond
13570 ((equal goto '(4)) (org-go-to-remember-target))
13571 ((equal goto '(16)) (org-remember-goto-last-stored))
13572 (t
13573 ;; set temporary variables that will be needed in
13574 ;; `org-select-remember-template'
13575 (setq org-select-template-temp-major-mode major-mode)
13576 (setq org-select-template-original-buffer (current-buffer))
13577 (if (memq org-finish-function '(remember-buffer remember-finalize))
13578 (progn
13579 (when (< (length org-remember-templates) 2)
13580 (error "No other template available"))
13581 (erase-buffer)
13582 (let ((annotation (plist-get org-store-link-plist :annotation))
13583 (initial (plist-get org-store-link-plist :initial)))
13584 (org-remember-apply-template))
13585 (message "Press C-c C-c to remember data"))
13586 (if (org-region-active-p)
13587 (remember (buffer-substring (point) (mark)))
13588 (call-interactively 'remember))))))
13590 (defun org-remember-goto-last-stored ()
13591 "Go to the location where the last remember note was stored."
13592 (interactive)
13593 (bookmark-jump "org-remember-last-stored")
13594 (message "This is the last note stored by remember"))
13596 (defun org-go-to-remember-target (&optional template-key)
13597 "Go to the target location of a remember template.
13598 The user is queried for the template."
13599 (interactive)
13600 (let* (org-select-template-temp-major-mode
13601 (entry (org-select-remember-template template-key))
13602 (file (nth 1 entry))
13603 (heading (nth 2 entry))
13604 visiting)
13606 (setq file org-default-notes-file))
13608 (setq heading org-remember-default-headline))
13609 (setq visiting (org-find-base-buffer-visiting file))
13610 (if (not visiting) (find-file-noselect file))
13611 (switch-to-buffer (or visiting (get-file-buffer file)))
13612 (widen)
13613 (goto-char (point-min))
13614 (if (re-search-forward
13617 nil t)
13618 (goto-char (match-beginning 0))
13619 (error "Target headline not found: %s" heading))))
13621 (defvar org-note-abort nil) ; dynamically scoped
13623 ;;;###autoload
13624 (defun org-remember-handler ()
13625 "Store stuff from remember.el into an org file.
13626 First prompts for an org file. If the user just presses return, the value
13627 of `org-default-notes-file' is used.
13628 Then the command offers the headings tree of the selected file in order to
13629 file the text at a specific location.
13630 You can either immediately press RET to get the note appended to the
13631 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13632 find a better place. Then press RET or <left> or <right> in insert the note.
13634 Key Cursor position Note gets inserted
13635 -----------------------------------------------------------------------------
13636 RET buffer-start as level 1 heading at end of file
13637 RET on headline as sublevel of the heading at cursor
13638 RET no heading at cursor position, level taken from context.
13639 Or use prefix arg to specify level manually.
13640 <left> on headline as same level, before current heading
13641 <right> on headline as same level, after current heading
13643 So the fastest way to store the note is to press RET RET to append it to
13644 the default file. This way your current train of thought is not
13645 interrupted, in accordance with the principles of remember.el.
13646 You can also get the fast execution without prompting by using
13647 C-u C-c C-c to exit the remember buffer. See also the variable
13648 `org-remember-store-without-prompt'.
13650 Before being stored away, the function ensures that the text has a
13652 is constructed from the current date and some additional data.
13654 If the variable `org-adapt-indentation' is non-nil, the entire text is
13655 also indented so that it starts in the same column as the headline
13656 \(i.e. after the stars).
13658 See also the variable `org-reverse-note-order'."
13659 (goto-char (point-min))
13661 (replace-match ""))
13662 (goto-char (point-max))
13663 (beginning-of-line 1)
13665 (delete-region (1- (point)) (point-max))
13666 (beginning-of-line 1))
13667 (catch 'quit
13668 (if org-note-abort (throw 'quit nil))
13669 (let* ((txt (buffer-substring (point-min) (point-max)))
13670 (fastp (org-xor (equal current-prefix-arg '(4))
13671 org-remember-store-without-prompt))
13672 (file (cond
13673 (fastp org-default-notes-file)
13674 ((and (eq org-remember-interactive-interface 'refile)
13675 org-refile-targets)
13676 org-default-notes-file)
13677 ((not (and (equal current-prefix-arg '(16))
13678 org-remember-previous-location))
13679 (org-get-org-file))))
13680 (heading org-remember-default-headline)
13681 (visiting (and file (org-find-base-buffer-visiting file)))
13682 (org-startup-folded nil)
13683 (org-startup-align-all-tables nil)
13684 (org-goto-start-pos 1)
13685 spos exitcmd level indent reversed)
13686 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13687 (setq file (car org-remember-previous-location)
13688 heading (cdr org-remember-previous-location)
13689 fastp t))
13690 (setq current-prefix-arg nil)
13692 (setq txt (replace-match "" t t txt)))
13693 ;; Modify text so that it becomes a nice subtree which can be inserted
13694 ;; into an org tree.
13696 first)
13697 (setq first (car lines) lines (cdr lines))
13699 ;; Is already a headline
13700 (setq indent nil)
13701 ;; We need to add a headline: Use time and first buffer line
13702 (setq lines (cons first lines)
13703 first (concat "* " (current-time-string)
13704 " (" (remember-buffer-desc) ")")
13705 indent " "))
13706 (if (and org-adapt-indentation indent)
13707 (setq lines (mapcar
13708 (lambda (x)
13710 (concat indent x) x))
13711 lines)))
13718 ;; Put the modified text back into the remember buffer, for refile.
13719 (erase-buffer)
13720 (insert txt)
13721 (goto-char (point-min))
13722 (when (and (eq org-remember-interactive-interface 'refile)
13723 (not fastp))
13724 (org-refile nil (or visiting (find-file-noselect file)))
13725 (throw 'quit t))
13726 ;; Find the file
13727 (if (not visiting) (find-file-noselect file))
13728 (with-current-buffer (or visiting (get-file-buffer file))
13729 (unless (org-mode-p)
13730 (error "Target files for remember notes must be in Org-mode"))
13731 (save-excursion
13732 (save-restriction
13733 (widen)
13734 (and (goto-char (point-min))
13737 (setq reversed (org-notes-order-reversed-p))
13739 ;; Find the default location
13741 (goto-char (point-min))
13742 (if (re-search-forward
13745 nil t)
13746 (setq org-goto-start-pos (match-beginning 0))
13747 (when fastp
13748 (goto-char (point-max))
13749 (unless (bolp) (newline))
13751 (setq org-goto-start-pos (point-at-bol 0)))))
13753 ;; Ask the User for a location, using the appropriate interface
13754 (cond
13755 (fastp (setq spos org-goto-start-pos
13756 exitcmd 'return))
13757 ((eq org-remember-interactive-interface 'outline)
13758 (setq spos (org-get-location (current-buffer)
13759 org-remember-help)
13760 exitcmd (cdr spos)
13761 spos (car spos)))
13762 ((eq org-remember-interactive-interface 'outline-path-completion)
13763 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13764 (org-refile-use-outline-path t))
13765 (setq spos (org-refile-get-location "Heading: ")
13766 exitcmd 'return
13767 spos (nth 3 spos))))
13768 (t (error "this should not hapen")))
13769 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13770 ; not handle this note
13771 (goto-char spos)
13772 (cond ((org-on-heading-p t)
13773 (org-back-to-heading t)
13774 (setq level (funcall outline-level))
13775 (cond
13776 ((eq exitcmd 'return)
13777 ;; sublevel of current
13778 (setq org-remember-previous-location
13779 (cons (abbreviate-file-name file)
13780 (org-get-heading 'notags)))
13781 (if reversed
13782 (outline-next-heading)
13783 (org-end-of-subtree t)
13784 (if (not (bolp))
13786 (beginning-of-line 2)
13787 (end-of-line 1)
13789 (bookmark-set "org-remember-last-stored")
13790 (org-paste-subtree (org-get-valid-level level 1) txt))
13791 ((eq exitcmd 'left)
13792 ;; before current
13793 (bookmark-set "org-remember-last-stored")
13794 (org-paste-subtree level txt))
13795 ((eq exitcmd 'right)
13796 ;; after current
13797 (org-end-of-subtree t)
13798 (bookmark-set "org-remember-last-stored")
13799 (org-paste-subtree level txt))
13800 (t (error "This should not happen"))))
13802 ((and (bobp) (not reversed))
13803 ;; Put it at the end, one level below level 1
13804 (save-restriction
13805 (widen)
13806 (goto-char (point-max))
13807 (if (not (bolp)) (newline))
13808 (bookmark-set "org-remember-last-stored")
13809 (org-paste-subtree (org-get-valid-level 1 1) txt)))
13811 ((and (bobp) reversed)
13812 ;; Put it at the start, as level 1
13813 (save-restriction
13814 (widen)
13815 (goto-char (point-min))
13817 (beginning-of-line 1)
13818 (bookmark-set "org-remember-last-stored")
13819 (org-paste-subtree 1 txt)))
13820 (t
13821 ;; Put it right there, with automatic level determined by
13822 ;; org-paste-subtree or from prefix arg
13823 (bookmark-set "org-remember-last-stored")
13824 (org-paste-subtree
13825 (if (numberp current-prefix-arg) current-prefix-arg)
13826 txt)))
13827 (when remember-save-after-remembering
13828 (save-buffer)
13829 (if (not visiting) (kill-buffer (current-buffer)))))))))
13831 t) ;; return t to indicate that we took care of this note.
13833 (defun org-get-org-file ()
13834 "Read a filename, with default directory `org-directory'."
13835 (let ((default (or org-default-notes-file remember-data-file)))
13836 (read-file-name (format "File name [%s]: " default)
13837 (file-name-as-directory org-directory)
13838 default)))
13840 (defun org-notes-order-reversed-p ()
13841 "Check if the current file should receive notes in reversed order."
13842 (cond
13843 ((not org-reverse-note-order) nil)
13844 ((eq t org-reverse-note-order) t)
13845 ((not (listp org-reverse-note-order)) nil)
13846 (t (catch 'exit
13847 (let ((all org-reverse-note-order)
13848 entry)
13849 (while (setq entry (pop all))
13850 (if (string-match (car entry) buffer-file-name)
13851 (throw 'exit (cdr entry))))
13852 nil)))))
13854 ;;; Refiling
13856 (defvar org-refile-target-table nil
13857 "The list of refile targets, created by `org-refile'.")
13859 (defvar org-agenda-new-buffers nil
13860 "Buffers created to visit agenda files.")
13862 (defun org-get-refile-targets (&optional default-buffer)
13863 "Produce a table with refile targets."
13864 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13865 targets txt re files f desc descre)
13866 (with-current-buffer (or default-buffer (current-buffer))
13867 (while (setq entry (pop entries))
13868 (setq files (car entry) desc (cdr entry))
13869 (cond
13870 ((null files) (setq files (list (current-buffer))))
13871 ((eq files 'org-agenda-files)
13872 (setq files (org-agenda-files 'unrestricted)))
13873 ((and (symbolp files) (fboundp files))
13874 (setq files (funcall files)))
13875 ((and (symbolp files) (boundp files))
13876 (setq files (symbol-value files))))
13877 (if (stringp files) (setq files (list files)))
13878 (cond
13879 ((eq (car desc) :tag)
13881 ((eq (car desc) :todo)
13883 ((eq (car desc) :regexp)
13884 (setq descre (cdr desc)))
13885 ((eq (car desc) :level)
13887 (if org-odd-levels-only
13888 (1- (* 2 (cdr desc)))
13889 (cdr desc)))
13891 ((eq (car desc) :maxlevel)
13893 (if org-odd-levels-only
13894 (1- (* 2 (cdr desc)))
13895 (cdr desc)))
13897 (t (error "Bad refiling target description %s" desc)))
13898 (while (setq f (pop files))
13899 (save-excursion
13900 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13901 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13902 (save-excursion
13903 (save-restriction
13904 (widen)
13905 (goto-char (point-min))
13906 (while (re-search-forward descre nil t)
13907 (goto-char (point-at-bol))
13908 (when (looking-at org-complex-heading-regexp)
13909 (setq txt (match-string 4)
13910 re (concat "^" (regexp-quote
13911 (buffer-substring (match-beginning 1)
13912 (match-end 4)))))
13914 (regexp-quote
13915 (match-string 5)))))
13917 (when org-refile-use-outline-path
13918 (setq txt (mapconcat 'identity
13919 (append
13920 (if (eq org-refile-use-outline-path 'file)
13921 (list (file-name-nondirectory
13922 (buffer-file-name (buffer-base-buffer))))
13923 (if (eq org-refile-use-outline-path 'full-file-path)
13924 (list (buffer-file-name (buffer-base-buffer)))))
13925 (org-get-outline-path)
13926 (list txt))
13927 "/")))
13928 (push (list txt f re (point)) targets))
13929 (goto-char (point-at-eol))))))))
13930 (nreverse targets))))
13932 (defun org-get-outline-path ()
13933 "Return the outline path to the current entry, as a list."
13934 (let (rtn)
13935 (save-excursion
13936 (while (org-up-heading-safe)
13937 (when (looking-at org-complex-heading-regexp)
13938 (push (org-match-string-no-properties 4) rtn)))
13939 rtn)))
13941 (defvar org-refile-history nil
13942 "History for refiling operations.")
13944 (defun org-refile (&optional goto default-buffer)
13945 "Move the entry at point to another heading.
13946 The list of target headings is compiled using the information in
13947 `org-refile-targets', which see. This list is created upon first use, and
13948 you can update it by calling this command with a double prefix (`C-u C-u').
13949 FIXME: Can we find a better way of updating?
13951 At the target location, the entry is filed as a subitem of the target heading.
13952 Depending on `org-reverse-note-order', the new subitem will either be the
13953 first of the last subitem.
13955 With prefix arg GOTO, the command will only visit the target location,
13956 not actually move anything.
13957 With a double prefix `C-c C-c', go to the location where the last refiling
13958 operation has put the subtree.
13960 With a double prefix argument, the command can be used to jump to any
13961 heading in the current buffer."
13962 (interactive "P")
13963 (let* ((cbuf (current-buffer))
13964 (filename (buffer-file-name (buffer-base-buffer cbuf)))
13965 pos it nbuf file re level reversed)
13966 (if (equal goto '(16))
13967 (org-refile-goto-last-stored)
13968 (when (setq it (org-refile-get-location
13969 (if goto "Goto: " "Refile to: ") default-buffer))
13970 (setq file (nth 1 it)
13971 re (nth 2 it)
13972 pos (nth 3 it))
13973 (setq nbuf (or (find-buffer-visiting file)
13974 (find-file-noselect file)))
13975 (if goto
13976 (progn
13977 (switch-to-buffer nbuf)
13978 (goto-char pos)
13979 (org-show-context 'org-goto))
13980 (org-copy-special)
13981 (save-excursion
13982 (set-buffer (setq nbuf (or (find-buffer-visiting file)
13983 (find-file-noselect file))))
13984 (setq reversed (org-notes-order-reversed-p))
13985 (save-excursion
13986 (save-restriction
13987 (widen)
13988 (goto-char pos)
13989 (looking-at outline-regexp)
13990 (setq level (org-get-valid-level (funcall outline-level) 1))
13991 (goto-char
13992 (if reversed
13993 (outline-next-heading)
13994 (or (save-excursion (outline-get-next-sibling))
13995 (org-end-of-subtree t t)
13996 (point-max))))
13997 (bookmark-set "org-refile-last-stored")
13998 (org-paste-subtree level))))
13999 (org-cut-special)
14002 (defun org-refile-goto-last-stored ()
14003 "Go to the location where the last refile was stored."
14004 (interactive)
14005 (bookmark-jump "org-refile-last-stored")
14006 (message "This is the location of the last refile"))
14008 (defun org-refile-get-location (&optional prompt default-buffer)
14009 "Prompt the user for a refile location, using PROMPT."
14010 (let ((org-refile-targets org-refile-targets)
14011 (org-refile-use-outline-path org-refile-use-outline-path))
14012 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14013 (unless org-refile-target-table
14014 (error "No refile targets"))
14015 (let* ((cbuf (current-buffer))
14016 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14017 (fname (and filename (file-truename filename)))
14018 (tbl (mapcar
14019 (lambda (x)
14020 (if (not (equal fname (file-truename (nth 1 x))))
14021 (cons (concat (car x) " (" (file-name-nondirectory
14022 (nth 1 x)) ")")
14023 (cdr x))
14024 x))
14025 org-refile-target-table))
14026 (completion-ignore-case t))
14027 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14028 tbl)))
14030 ;;;; Dynamic blocks
14032 (defun org-find-dblock (name)
14033 "Find the first dynamic block with name NAME in the buffer.
14034 If not found, stay at current position and return nil."
14035 (let (pos)
14036 (save-excursion
14037 (goto-char (point-min))
14039 nil t)
14040 (match-beginning 0))))
14041 (if pos (goto-char pos))
14042 pos))
14044 (defconst org-dblock-start-re
14046 "Matches the startline of a dynamic block, with parameters.")
14049 "Matches the end of a dyhamic block.")
14051 (defun org-create-dblock (plist)
14052 "Create a dynamic block section, with parameters taken from PLIST.
14053 PLIST must containe a :name entry which is used as name of the block."
14054 (unless (bolp) (newline))
14055 (let ((name (plist-get plist :name)))
14056 (insert "#+BEGIN: " name)
14057 (while plist
14058 (if (eq (car plist) :name)
14059 (setq plist (cddr plist))
14060 (insert " " (prin1-to-string (pop plist)))))
14062 (beginning-of-line -2)))
14064 (defun org-prepare-dblock ()
14065 "Prepare dynamic block for refresh.
14066 This empties the block, puts the cursor at the insert position and returns
14067 the property list including an extra property :name with the block name."
14068 (unless (looking-at org-dblock-start-re)
14069 (error "Not at a dynamic block"))
14070 (let* ((begdel (1+ (match-end 0)))
14071 (name (org-no-properties (match-string 1)))
14072 (params (append (list :name name)
14073 (read (concat "(" (match-string 3) ")")))))
14074 (unless (re-search-forward org-dblock-end-re nil t)
14075 (error "Dynamic block not terminated"))
14076 (setq params
14077 (append params
14078 (list :content (buffer-substring
14079 begdel (match-beginning 0)))))
14080 (delete-region begdel (match-beginning 0))
14081 (goto-char begdel)
14082 (open-line 1)
14083 params))
14085 (defun org-map-dblocks (&optional command)
14086 "Apply COMMAND to all dynamic blocks in the current buffer.
14087 If COMMAND is not given, use `org-update-dblock'."
14088 (let ((cmd (or command 'org-update-dblock))
14089 pos)
14090 (save-excursion
14091 (goto-char (point-min))
14092 (while (re-search-forward org-dblock-start-re nil t)
14093 (goto-char (setq pos (match-beginning 0)))
14094 (condition-case nil
14095 (funcall cmd)
14096 (error (message "Error during update of dynamic block")))
14097 (goto-char pos)
14098 (unless (re-search-forward org-dblock-end-re nil t)
14099 (error "Dynamic block not terminated"))))))
14101 (defun org-dblock-update (&optional arg)
14102 "User command for updating dynamic blocks.
14103 Update the dynamic block at point. With prefix ARG, update all dynamic
14104 blocks in the buffer."
14105 (interactive "P")
14106 (if arg
14107 (org-update-all-dblocks)
14108 (or (looking-at org-dblock-start-re)
14109 (org-beginning-of-dblock))
14110 (org-update-dblock)))
14112 (defun org-update-dblock ()
14113 "Update the dynamic block at point
14114 This means to empty the block, parse for parameters and then call
14115 the correct writing function."
14116 (save-window-excursion
14117 (let* ((pos (point))
14118 (line (org-current-line))
14119 (params (org-prepare-dblock))
14120 (name (plist-get params :name))
14121 (cmd (intern (concat "org-dblock-write:" name))))
14122 (message "Updating dynamic block `%s' at line %d..." name line)
14123 (funcall cmd params)
14124 (message "Updating dynamic block `%s' at line %d...done" name line)
14125 (goto-char pos))))
14127 (defun org-beginning-of-dblock ()
14128 "Find the beginning of the dynamic block at point.
14129 Error if there is no scuh block at point."
14130 (let ((pos (point))
14131 beg)
14132 (end-of-line 1)
14133 (if (and (re-search-backward org-dblock-start-re nil t)
14134 (setq beg (match-beginning 0))
14135 (re-search-forward org-dblock-end-re nil t)
14136 (> (match-end 0) pos))
14137 (goto-char beg)
14138 (goto-char pos)
14139 (error "Not in a dynamic block"))))
14141 (defun org-update-all-dblocks ()
14142 "Update all dynamic blocks in the buffer.
14143 This function can be used in a hook."
14144 (when (org-mode-p)
14145 (org-map-dblocks 'org-update-dblock)))
14148 ;;;; Completion
14150 (defconst org-additional-option-like-keywords
14151 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14152 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "TBLFM"
14153 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14155 (defun org-complete (&optional arg)
14156 "Perform completion on word at point.
14157 At the beginning of a headline, this completes TODO keywords as given in
14158 `org-todo-keywords'.
14159 If the current word is preceded by a backslash, completes the TeX symbols
14160 that are supported for HTML support.
14162 setting file options.
14164 At all other locations, this simply calls the value of
14165 `org-completion-fallback-command'."
14166 (interactive "P")
14167 (org-without-partial-completion
14168 (catch 'exit
14169 (let* ((end (point))
14170 (beg1 (save-excursion
14171 (skip-chars-backward (org-re "[:alnum:]_@"))
14172 (point)))
14173 (beg (save-excursion
14174 (skip-chars-backward "a-zA-Z0-9_:$")
14175 (point)))
14176 (confirm (lambda (x) (stringp (car x))))
14177 (searchhead (equal (char-before beg) ?*))
14178 (tag (and (equal (char-before beg1) ?:)
14179 (equal (char-after (point-at-bol)) ?*)))
14180 (prop (and (equal (char-before beg1) ?:)
14181 (not (equal (char-after (point-at-bol)) ?*))))
14183 (link (equal (char-before beg) ?\[))
14184 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14185 beg)
14186 "#+"))
14188 (buffer-substring (point-at-bol) (point))))
14189 (completion-ignore-case opt)
14190 (type nil)
14191 (tbl nil)
14192 (table (cond
14193 (opt
14194 (setq type :opt)
14195 (append
14196 (mapcar
14197 (lambda (x)
14199 (cons (match-string 2 x) (match-string 1 x)))
14201 (mapcar 'list org-additional-option-like-keywords)))
14202 (startup
14203 (setq type :startup)
14204 org-startup-options)
14205 (link (append org-link-abbrev-alist-local
14206 org-link-abbrev-alist))
14207 (texp
14208 (setq type :tex)
14209 org-html-entities)
14211 (buffer-substring (point-at-bol) beg))
14212 (setq type :todo)
14213 (mapcar 'list org-todo-keywords-1))
14214 (searchhead
14215 (setq type :searchhead)
14216 (save-excursion
14217 (goto-char (point-min))
14218 (while (re-search-forward org-todo-line-regexp nil t)
14219 (push (list
14220 (org-make-org-heading-search-string
14221 (match-string 3) t))
14222 tbl)))
14223 tbl)
14224 (tag (setq type :tag beg beg1)
14225 (or org-tag-alist (org-get-buffer-tags)))
14226 (prop (setq type :prop beg beg1)
14227 (mapcar 'list (org-buffer-property-keys nil t t)))
14228 (t (progn
14229 (call-interactively org-completion-fallback-command)
14230 (throw 'exit nil)))))
14231 (pattern (buffer-substring-no-properties beg end))
14232 (completion (try-completion pattern table confirm)))
14233 (cond ((eq completion t)
14234 (if (not (assoc (upcase pattern) table))
14235 (message "Already complete")
14236 (if (and (equal type :opt)
14237 (not (member (car (assoc (upcase pattern) table))
14238 org-additional-option-like-keywords)))
14239 (insert (substring (cdr (assoc (upcase pattern) table))
14240 (length pattern)))
14241 (if (memq type '(:tag :prop)) (insert ":")))))
14242 ((null completion)
14244 (ding))
14245 ((not (string= pattern completion))
14246 (delete-region beg end)
14247 (if (string-match " +$" completion)
14248 (setq completion (replace-match "" t t completion)))
14249 (insert completion)
14250 (if (get-buffer-window "*Completions*")
14251 (delete-window (get-buffer-window "*Completions*")))
14252 (if (assoc completion table)
14253 (if (eq type :todo) (insert " ")
14254 (if (memq type '(:tag :prop)) (insert ":"))))
14255 (if (and (equal type :opt) (assoc completion table))
14256 (message "%s" (substitute-command-keys
14258 (t
14259 (message "Making completion list...")
14260 (let ((list (sort (all-completions pattern table confirm)
14261 'string<)))
14262 (with-output-to-temp-buffer "*Completions*"
14263 (condition-case nil
14264 ;; Protection needed for XEmacs and emacs 21
14265 (display-completion-list list pattern)
14266 (error (display-completion-list list)))))
14267 (message "Making completion list...%s" "done")))))))
14269 ;;;; TODO, DEADLINE, Comments
14271 (defun org-toggle-comment ()
14272 "Change the COMMENT state of an entry."
14273 (interactive)
14274 (save-excursion
14275 (org-back-to-heading)
14276 (let (case-fold-search)
14277 (if (looking-at (concat outline-regexp
14279 (replace-match "" t t nil 1)
14280 (if (looking-at outline-regexp)
14281 (progn
14282 (goto-char (match-end 0))
14283 (insert org-comment-string " ")))))))
14285 (defvar org-last-todo-state-is-todo nil
14286 "This is non-nil when the last TODO state change led to a TODO state.
14287 If the last change removed the TODO tag or switched to DONE, then
14288 this is nil.")
14290 (defvar org-setting-tags nil) ; dynamically skiped
14292 ;; FIXME: better place
14293 (defun org-property-or-variable-value (var &optional inherit)
14294 "Check if there is a property fixing the value of VAR.
14295 If yes, return this value. If not, return the current value of the variable."
14296 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14298 (read prop)
14299 (symbol-value var))))
14301 (defun org-parse-local-options (string var)
14302 "Parse STRING for startup setting relevant for variable VAR."
14303 (let ((rtn (symbol-value var))
14304 e opts)
14305 (save-match-data
14307 rtn
14308 (setq opts (delq nil (mapcar (lambda (x)
14309 (setq e (assoc x org-startup-options))
14310 (if (eq (nth 1 e) var) e nil))
14312 (if (not opts)
14313 rtn
14314 (setq rtn nil)
14315 (while (setq e (pop opts))
14316 (if (not (nth 3 e))
14317 (setq rtn (nth 2 e))
14318 (if (not (listp rtn)) (setq rtn nil))
14319 (push (nth 2 e) rtn)))
14320 rtn)))))
14322 (defvar org-blocker-hook nil
14323 "Hook for functions that are allowed to block a state change.
14325 Each function gets as its single argument a property list, see
14326 `org-trigger-hook' for more information about this list.
14328 If any of the functions in this hook returns nil, the state change
14329 is blocked.")
14331 (defvar org-trigger-hook nil
14332 "Hook for functions that are triggered by a state change.
14334 Each function gets as its single argument a property list with at least
14335 the following elements:
14337 (:type type-of-change :position pos-at-entry-start
14338 :from old-state :to new-state)
14340 Depending on the type, more properties may be present.
14342 This mechanism is currently implemented for:
14344 TODO state changes
14345 ------------------
14346 :type todo-state-change
14347 :from previous state (keyword as a string), or nil
14348 :to new state (keyword as a string), or nil")
14351 (defun org-todo (&optional arg)
14352 "Change the TODO state of an item.
14353 The state of an item is given by a keyword at the start of the heading,
14354 like
14355 *** TODO Write paper
14356 *** DONE Call mom
14358 The different keywords are specified in the variable `org-todo-keywords'.
14360 So for this example: when the item starts with TODO, it is changed to DONE.
14361 When it starts with DONE, the DONE is removed. And when neither TODO nor
14362 DONE are present, add TODO at the beginning of the heading.
14364 With C-u prefix arg, use completion to determine the new state.
14365 With numeric prefix arg, switch to that state.
14367 For calling through lisp, arg is also interpreted in the following way:
14368 'none -> empty state
14370 'done -> switch to DONE
14371 'nextset -> switch to the next set of keywords
14372 'previousset -> switch to the previous set of keywords
14374 really is a member of `org-todo-keywords'."
14375 (interactive "P")
14376 (save-excursion
14377 (catch 'exit
14378 (org-back-to-heading)
14379 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14380 (or (looking-at (concat " +" org-todo-regexp " *"))
14381 (looking-at " *"))
14382 (let* ((match-data (match-data))
14383 (startpos (point-at-bol))
14384 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14385 (org-log-done org-log-done)
14386 (org-log-repeat org-log-repeat)
14387 (org-todo-log-states org-todo-log-states)
14388 (this (match-string 1))
14389 (hl-pos (match-beginning 0))
14390 (head (org-get-todo-sequence-head this))
14391 (ass (assoc head org-todo-kwd-alist))
14392 (interpret (nth 1 ass))
14393 (done-word (nth 3 ass))
14394 (final-done-word (nth 4 ass))
14395 (last-state (or this ""))
14396 (completion-ignore-case t)
14397 (member (member this org-todo-keywords-1))
14398 (tail (cdr member))
14399 (state (cond
14400 ((and org-todo-key-trigger
14401 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14402 (and (not arg) org-use-fast-todo-selection
14403 (not (eq org-use-fast-todo-selection 'prefix)))))
14404 ;; Use fast selection
14405 (org-fast-todo-selection))
14406 ((and (equal arg '(4))
14407 (or (not org-use-fast-todo-selection)
14408 (not org-todo-key-trigger)))
14409 ;; Read a state with completion
14410 (completing-read "State: " (mapcar (lambda(x) (list x))
14411 org-todo-keywords-1)
14412 nil t))
14413 ((eq arg 'right)
14414 (if this
14415 (if tail (car tail) nil)
14416 (car org-todo-keywords-1)))
14417 ((eq arg 'left)
14418 (if (equal member org-todo-keywords-1)
14419 nil
14420 (if this
14421 (nth (- (length org-todo-keywords-1) (length tail) 2)
14422 org-todo-keywords-1)
14423 (org-last org-todo-keywords-1))))
14424 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14425 (setq arg nil))) ; hack to fall back to cycling
14426 (arg
14427 ;; user or caller requests a specific state
14428 (cond
14429 ((equal arg "") nil)
14430 ((eq arg 'none) nil)
14431 ((eq arg 'done) (or done-word (car org-done-keywords)))
14432 ((eq arg 'nextset)
14433 (or (car (cdr (member head org-todo-heads)))
14434 (car org-todo-heads)))
14435 ((eq arg 'previousset)
14436 (let ((org-todo-heads (reverse org-todo-heads)))
14437 (or (car (cdr (member head org-todo-heads)))
14438 (car org-todo-heads))))
14439 ((car (member arg org-todo-keywords-1)))
14440 ((nth (1- (prefix-numeric-value arg))
14441 org-todo-keywords-1))))
14442 ((null member) (or head (car org-todo-keywords-1)))
14443 ((equal this final-done-word) nil) ;; -> make empty
14444 ((null tail) nil) ;; -> first entry
14445 ((eq interpret 'sequence)
14446 (car tail))
14447 ((memq interpret '(type priority))
14448 (if (eq this-command last-command)
14449 (car tail)
14450 (if (> (length tail) 0)
14451 (or done-word (car org-done-keywords))
14452 nil)))
14453 (t nil)))
14454 (next (if state (concat " " state " ") " "))
14455 (change-plist (list :type 'todo-state-change :from this :to state
14456 :position startpos))
14457 dolog now-done-p)
14458 (when org-blocker-hook
14459 (unless (save-excursion
14460 (save-match-data
14461 (run-hook-with-args-until-failure
14462 'org-blocker-hook change-plist)))
14463 (if (interactive-p)
14464 (error "TODO state change from %s to %s blocked" this state)
14465 ;; fail silently
14466 (message "TODO state change from %s to %s blocked" this state)
14467 (throw 'exit nil))))
14468 (store-match-data match-data)
14469 (replace-match next t t)
14470 (unless (pos-visible-in-window-p hl-pos)
14471 (message "TODO state changed to %s" (org-trim next)))
14472 (unless head
14473 (setq head (org-get-todo-sequence-head state)
14474 ass (assoc head org-todo-kwd-alist)
14475 interpret (nth 1 ass)
14476 done-word (nth 3 ass)
14477 final-done-word (nth 4 ass)))
14478 (when (memq arg '(nextset previousset))
14479 (message "Keyword-Set %d/%d: %s"
14480 (- (length org-todo-sets) -1
14481 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14482 (length org-todo-sets)
14483 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14484 (setq org-last-todo-state-is-todo
14485 (not (member state org-done-keywords)))
14486 (setq now-done-p (and (member state org-done-keywords)
14487 (not (member this org-done-keywords))))
14488 (and logging (org-local-logging logging))
14489 (when (and (or org-todo-log-states org-log-done)
14490 (not (memq arg '(nextset previousset))))
14491 ;; we need to look at recording a time and note
14492 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14493 (nth 2 (assoc this org-todo-log-states))))
14494 (when (and state
14495 (member state org-not-done-keywords)
14496 (not (member this org-not-done-keywords)))
14497 ;; This is now a todo state and was not one before
14498 ;; If there was a CLOSED time stamp, get rid of it.
14499 (org-add-planning-info nil nil 'closed))
14500 (when (and now-done-p org-log-done)
14501 ;; It is now done, and it was not done before
14502 (org-add-planning-info 'closed (org-current-time))
14503 (if (and (not dolog) (eq 'note org-log-done))
14504 (org-add-log-maybe 'done state 'findpos 'note)))
14505 (when (and state dolog)
14506 ;; This is a non-nil state, and we need to log it
14507 (org-add-log-maybe 'state state 'findpos dolog)))
14508 ;; Fixup tag positioning
14509 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14510 (run-hooks 'org-after-todo-state-change-hook)
14511 (if (and arg (not (member state org-done-keywords)))
14512 (setq head (org-get-todo-sequence-head state)))
14513 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14514 ;; Do we need to trigger a repeat?
14515 (when now-done-p (org-auto-repeat-maybe state))
14516 ;; Fixup cursor location if close to the keyword
14517 (if (and (outline-on-heading-p)
14518 (not (bolp))
14519 (save-excursion (beginning-of-line 1)
14520 (looking-at org-todo-line-regexp))
14521 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14522 (progn
14523 (goto-char (or (match-end 2) (match-end 1)))
14524 (just-one-space)))
14525 (when org-trigger-hook
14526 (save-excursion
14527 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14529 (defun org-local-logging (value)
14530 "Get logging settings from a property VALUE."
14531 (let* (words w a)
14532 ;; directly set the variables, they are already local.
14533 (setq org-log-done nil
14534 org-log-repeat nil
14535 org-todo-log-states nil)
14536 (setq words (org-split-string value))
14537 (while (setq w (pop words))
14538 (cond
14539 ((setq a (assoc w org-startup-options))
14540 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14541 (set (nth 1 a) (nth 2 a))))
14542 ((setq a (org-extract-log-state-settings w))
14543 (and (member (car a) org-todo-keywords-1)
14544 (push a org-todo-log-states)))))))
14546 (defun org-get-todo-sequence-head (kwd)
14547 "Return the head of the TODO sequence to which KWD belongs.
14548 If KWD is not set, check if there is a text property remembering the
14549 right sequence."
14550 (let (p)
14551 (cond
14552 ((not kwd)
14553 (or (get-text-property (point-at-bol) 'org-todo-head)
14554 (progn
14555 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14556 nil (point-at-eol)))
14557 (get-text-property p 'org-todo-head))))
14558 ((not (member kwd org-todo-keywords-1))
14559 (car org-todo-keywords-1))
14560 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14562 (defun org-fast-todo-selection ()
14563 "Fast TODO keyword selection with single keys.
14564 Returns the new TODO keyword, or nil if no state change should occur."
14565 (let* ((fulltable org-todo-key-alist)
14566 (done-keywords org-done-keywords) ;; needed for the faces.
14567 (maxlen (apply 'max (mapcar
14568 (lambda (x)
14569 (if (stringp (car x)) (string-width (car x)) 0))
14570 fulltable)))
14571 (expert nil)
14572 (fwidth (+ maxlen 3 1 3))
14573 (ncol (/ (- (window-width) 4) fwidth))
14574 tg cnt e c tbl
14575 groups ingroup)
14576 (save-window-excursion
14577 (if expert
14578 (set-buffer (get-buffer-create " *Org todo*"))
14579 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14580 (erase-buffer)
14581 (org-set-local 'org-done-keywords done-keywords)
14582 (setq tbl fulltable cnt 0)
14583 (while (setq e (pop tbl))
14584 (cond
14585 ((equal e '(:startgroup))
14586 (push '() groups) (setq ingroup t)
14587 (when (not (= cnt 0))
14588 (setq cnt 0)
14590 (insert "{ "))
14591 ((equal e '(:endgroup))
14592 (setq ingroup nil cnt 0)
14594 (t
14595 (setq tg (car e) c (cdr e))
14596 (if ingroup (push tg (car groups)))
14597 (setq tg (org-add-props tg nil 'face
14598 (org-get-todo-face tg)))
14599 (if (and (= cnt 0) (not ingroup)) (insert " "))
14600 (insert "[" c "] " tg (make-string
14601 (- fwidth 4 (length tg)) ?\ ))
14602 (when (= (setq cnt (1+ cnt)) ncol)
14604 (if ingroup (insert " "))
14605 (setq cnt 0)))))
14607 (goto-char (point-min))
14608 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14609 (fit-window-to-buffer))
14610 (message "[a-z..]:Set [SPC]:clear")
14611 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14612 (cond
14613 ((or (= c ?\C-g)
14614 (and (= c ?q) (not (rassoc c fulltable))))
14615 (setq quit-flag t))
14616 ((= c ?\ ) nil)
14617 ((setq e (rassoc c fulltable) tg (car e))
14618 tg)
14619 (t (setq quit-flag t))))))
14621 (defun org-get-repeat ()
14622 "Check if tere is a deadline/schedule with repeater in this entry."
14623 (save-match-data
14624 (save-excursion
14625 (org-back-to-heading t)
14626 (if (re-search-forward
14627 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14628 (match-string 1)))))
14630 (defvar org-last-changed-timestamp)
14631 (defvar org-log-post-message)
14632 (defvar org-log-note-purpose)
14633 (defun org-auto-repeat-maybe (done-word)
14634 "Check if the current headline contains a repeated deadline/schedule.
14635 If yes, set TODO state back to what it was and change the base date
14636 of repeating deadline/scheduled time stamps to new date.
14637 This function is run automatically after each state change to a DONE state."
14638 ;; last-state is dynamically scoped into this function
14639 (let* ((repeat (org-get-repeat))
14640 (aa (assoc last-state org-todo-kwd-alist))
14641 (interpret (nth 1 aa))
14642 (head (nth 2 aa))
14643 (whata '(("d" . day) ("m" . month) ("y" . year)))
14644 (msg "Entry repeats: ")
14645 (org-log-done nil)
14646 (org-todo-log-states nil)
14647 (nshiftmax 10) (nshift 0)
14648 re type n what ts mb0 time)
14649 (when repeat
14650 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
14651 (org-todo (if (eq interpret 'type) last-state head))
14652 (when (and org-log-repeat
14653 (or (not (memq 'org-add-log-note
14654 (default-value 'post-command-hook)))
14655 (eq org-log-note-purpose 'done)))
14656 ;; Make sure a note is taken;
14657 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
14658 'findpos org-log-repeat))
14659 (org-back-to-heading t)
14660 (org-add-planning-info nil nil 'closed)
14664 (while (re-search-forward
14665 re (save-excursion (outline-next-heading) (point)) t)
14666 (setq type (if (match-end 1) org-scheduled-string
14667 (if (match-end 3) org-deadline-string "Plain:"))
14668 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0)))
14669 mb0 (match-beginning 0))
14671 (setq n (string-to-number (match-string 2 ts))
14672 what (match-string 3 ts))
14673 (if (equal what "w") (setq n (* n 7) what "d"))
14674 ;; Preparation, see if we need to modify the start date for the change
14675 (when (match-end 1)
14676 (setq time (save-match-data (org-time-string-to-time ts)))
14677 (cond
14678 ((equal (match-string 1 ts) ".")
14679 ;; Shift starting date to today
14680 (org-timestamp-change
14681 (- (time-to-days (current-time)) (time-to-days time))
14682 'day))
14683 ((equal (match-string 1 ts) "+")
14684 (while (< (time-to-days time) (time-to-days (current-time)))
14685 (when (= (incf nshift) nshiftmax)
14686 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
14687 (error "Abort")))
14688 (org-timestamp-change n (cdr (assoc what whata)))
14689 (sit-for .0001) ;; so we can watch the date shifting
14690 (org-at-timestamp-p t)
14691 (setq ts (match-string 1))
14692 (setq time (save-match-data (org-time-string-to-time ts))))
14693 (org-timestamp-change (- n) (cdr (assoc what whata)))
14694 ;; rematch, so that we have everything in place for the real shift
14695 (org-at-timestamp-p t)
14696 (setq ts (match-string 1))
14698 (org-timestamp-change n (cdr (assoc what whata)))
14699 (setq msg (concat msg type org-last-changed-timestamp " "))))
14700 (setq org-log-post-message msg)
14701 (message "%s" msg))))
14703 (defun org-show-todo-tree (arg)
14704 "Make a compact tree which shows all headlines marked with TODO.
14705 The tree will show the lines where the regexp matches, and all higher
14706 headlines above the match.
14708 With a numeric prefix N, construct a sparse tree for the Nth element
14709 of `org-todo-keywords-1'."
14710 (interactive "P")
14711 (let ((case-fold-search nil)
14712 (kwd-re
14713 (cond ((null arg) org-not-done-regexp)
14714 ((equal arg '(4))
14715 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14716 (mapcar 'list org-todo-keywords-1))))
14720 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14721 (regexp-quote (nth (1- (prefix-numeric-value arg))
14722 org-todo-keywords-1)))
14723 (t (error "Invalid prefix argument: %s" arg)))))
14724 (message "%d TODO entries found"
14725 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14727 (defun org-deadline (&optional remove)
14729 With argument REMOVE, remove any deadline from the item."
14730 (interactive "P")
14731 (if remove
14732 (progn
14733 (org-remove-timestamp-with-keyword org-deadline-string)
14734 (message "Item no longer has a deadline."))
14735 (org-add-planning-info 'deadline nil 'closed)))
14737 (defun org-schedule (&optional remove)
14738 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14739 With argument REMOVE, remove any scheduling date from the item."
14740 (interactive "P")
14741 (if remove
14742 (progn
14743 (org-remove-timestamp-with-keyword org-scheduled-string)
14744 (message "Item is no longer scheduled."))
14745 (org-add-planning-info 'scheduled nil 'closed)))
14747 (defun org-remove-timestamp-with-keyword (keyword)
14748 "Remove all time stamps with KEYWORD in the current entry."
14750 beg)
14751 (save-excursion
14752 (org-back-to-heading t)
14753 (setq beg (point))
14754 (org-end-of-subtree t t)
14755 (while (re-search-backward re beg t)
14756 (replace-match "")
14758 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14760 (defun org-add-planning-info (what &optional time &rest remove)
14761 "Insert new timestamp with keyword in the line directly after the headline.
14762 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14763 If non is given, the user is prompted for a date.
14764 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14765 be removed."
14766 (interactive)
14767 (let (org-time-was-given org-end-time-was-given ts
14768 end default-time default-input)
14770 (when (and (not time) (memq what '(scheduled deadline)))
14771 ;; Try to get a default date/time from existing timestamp
14772 (save-excursion
14773 (org-back-to-heading t)
14774 (setq end (save-excursion (outline-next-heading) (point)))
14775 (when (re-search-forward (if (eq what 'scheduled)
14776 org-scheduled-time-regexp
14777 org-deadline-time-regexp)
14778 end t)
14779 (setq ts (match-string 1)
14780 default-time
14781 (apply 'encode-time (org-parse-time-string ts))
14782 default-input (and ts (org-get-compact-tod ts))))))
14783 (when what
14784 ;; If necessary, get the time from the user
14785 (setq time (or time (org-read-date nil 'to-time nil nil
14786 default-time default-input))))
14788 (when (and org-insert-labeled-timestamps-at-point
14789 (member what '(scheduled deadline)))
14790 (insert
14791 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14792 (org-insert-time-stamp time org-time-was-given
14793 nil nil nil (list org-end-time-was-given))
14794 (setq what nil))
14795 (save-excursion
14796 (save-restriction
14797 (let (col list elt ts buffer-invisibility-spec)
14798 (org-back-to-heading t)
14800 (goto-char (match-end 1))
14801 (setq col (current-column))
14802 (goto-char (match-end 0))
14804 (if (and (not (looking-at outline-regexp))
14807 (not (equal (match-string 1) org-clock-string)))
14808 (narrow-to-region (match-beginning 0) (match-end 0))
14810 (backward-char 1)
14811 (narrow-to-region (point) (point))
14812 (indent-to-column col))
14813 ;; Check if we have to remove something.
14814 (setq list (cons what remove))
14815 (while list
14816 (setq elt (pop list))
14817 (goto-char (point-min))
14818 (when (or (and (eq elt 'scheduled)
14819 (re-search-forward org-scheduled-time-regexp nil t))
14820 (and (eq elt 'deadline)
14821 (re-search-forward org-deadline-time-regexp nil t))
14822 (and (eq elt 'closed)
14823 (re-search-forward org-closed-time-regexp nil t)))
14824 (replace-match "")
14825 (if (looking-at "--+<[^>]+>") (replace-match ""))
14826 (if (looking-at " +") (replace-match ""))))
14827 (goto-char (point-max))
14828 (when what
14829 (insert
14830 (if (not (equal (char-before) ?\ )) " " "")
14831 (cond ((eq what 'scheduled) org-scheduled-string)
14832 ((eq what 'deadline) org-deadline-string)
14833 ((eq what 'closed) org-closed-string))
14834 " ")
14835 (setq ts (org-insert-time-stamp
14836 time
14837 (or org-time-was-given
14838 (and (eq what 'closed) org-log-done-with-time))
14839 (eq what 'closed)
14840 nil nil (list org-end-time-was-given)))
14841 (end-of-line 1))
14842 (goto-char (point-min))
14843 (widen)
14845 (replace-match ""))
14846 ts)))))
14848 (defvar org-log-note-marker (make-marker))
14849 (defvar org-log-note-purpose nil)
14850 (defvar org-log-note-state nil)
14851 (defvar org-log-note-how nil)
14852 (defvar org-log-note-window-configuration nil)
14853 (defvar org-log-note-return-to (make-marker))
14854 (defvar org-log-post-message nil
14855 "Message to be displayed after a log note has been stored.
14856 The auto-repeater uses this.")
14858 (defun org-add-log-maybe (&optional purpose state findpos how)
14859 "Set up the post command hook to take a note.
14860 If this is about to TODO state change, the new state is expected in STATE.
14861 When FINDPOS is non-nil, find the correct position for the note in
14862 the current entry. If not, assume that it can be inserted at point."
14863 (save-excursion
14864 (when findpos
14865 (org-back-to-heading t)
14869 (goto-char (match-end 0))
14870 (unless org-log-states-order-reversed
14872 (org-skip-over-state-notes)
14874 (move-marker org-log-note-marker (point))
14875 (setq org-log-note-purpose purpose
14876 org-log-note-state state
14877 org-log-note-how how)
14878 (add-hook 'post-command-hook 'org-add-log-note 'append)))
14880 (defun org-skip-over-state-notes ()
14881 "Skip past the list of State notes in an entry."
14884 (condition-case nil
14885 (org-next-item)
14886 (error (org-end-of-item)))))
14888 (defun org-add-log-note (&optional purpose)
14889 "Pop up a window for taking a note, and add this note later at point."
14890 (remove-hook 'post-command-hook 'org-add-log-note)
14891 (setq org-log-note-window-configuration (current-window-configuration))
14892 (delete-other-windows)
14893 (move-marker org-log-note-return-to (point))
14894 (switch-to-buffer (marker-buffer org-log-note-marker))
14895 (goto-char org-log-note-marker)
14896 (org-switch-to-buffer-other-window "*Org Note*")
14897 (erase-buffer)
14898 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
14899 (org-store-log-note)
14900 (let ((org-inhibit-startup t)) (org-mode))
14901 (insert (format "# Insert note for %s.
14903 (cond
14904 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14905 ((eq org-log-note-purpose 'done) "closed todo item")
14906 ((eq org-log-note-purpose 'state)
14908 (t (error "This should not happen")))))
14909 (org-set-local 'org-finish-function 'org-store-log-note)))
14911 (defun org-store-log-note ()
14912 "Finish taking a log note, and insert it to where it belongs."
14913 (let ((txt (buffer-string))
14914 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14915 lines ind)
14916 (kill-buffer (current-buffer))
14918 (setq txt (replace-match "" t t txt)))
14920 (setq txt (replace-match "" t t txt)))
14923 (setq note
14924 (org-replace-escapes
14925 note
14926 (list (cons "%u" (user-login-name))
14927 (cons "%U" user-full-name)
14928 (cons "%t" (format-time-string
14929 (org-time-stamp-format 'long 'inactive)
14930 (current-time)))
14931 (cons "%s" (if org-log-note-state
14933 "")))))
14935 (push note lines))
14936 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14937 (when lines
14938 (save-excursion
14939 (set-buffer (marker-buffer org-log-note-marker))
14940 (save-excursion
14941 (goto-char org-log-note-marker)
14942 (move-marker org-log-note-marker nil)
14943 (end-of-line 1)
14945 (indent-relative nil)
14946 (insert "- " (pop lines))
14947 (org-indent-line-function)
14948 (beginning-of-line 1)
14950 (setq ind (concat (match-string 0) " "))
14951 (end-of-line 1)
14953 (set-window-configuration org-log-note-window-configuration)
14954 (with-current-buffer (marker-buffer org-log-note-return-to)
14955 (goto-char org-log-note-return-to))
14956 (move-marker org-log-note-return-to nil)
14957 (and org-log-post-message (message "%s" org-log-post-message)))
14959 ;; FIXME: what else would be useful?
14960 ;; - priority
14961 ;; - date
14963 (defun org-sparse-tree (&optional arg)
14964 "Create a sparse tree, prompt for the details.
14965 This command can create sparse trees. You first need to select the type
14966 of match used to create the tree:
14968 t Show entries with a specific TODO keyword.
14969 T Show entries selected by a tags match.
14970 p Enter a property name and its value (both with completion on existing
14971 names/values) and show entries with that property.
14972 r Show entries matching a regular expression
14973 d Show deadlines due within `org-deadline-warning-days'."
14974 (interactive "P")
14975 (let (ans kwd value)
14976 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
14977 (setq ans (read-char-exclusive))
14978 (cond
14979 ((equal ans ?d)
14980 (call-interactively 'org-check-deadlines))
14981 ((equal ans ?b)
14982 (call-interactively 'org-check-before-date))
14983 ((equal ans ?t)
14984 (org-show-todo-tree '(4)))
14985 ((equal ans ?T)
14986 (call-interactively 'org-tags-sparse-tree))
14987 ((member ans '(?p ?P))
14988 (setq kwd (completing-read "Property: "
14989 (mapcar 'list (org-buffer-property-keys))))
14990 (setq value (completing-read "Value: "
14991 (mapcar 'list (org-property-values kwd))))
14994 (org-tags-sparse-tree arg (concat kwd "=" value)))
14995 ((member ans '(?r ?R ?/))
14996 (call-interactively 'org-occur))
14999 (defvar org-occur-highlights nil
15000 "List of overlays used for occur matches.")
15001 (make-variable-buffer-local 'org-occur-highlights)
15002 (defvar org-occur-parameters nil
15003 "Parameters of the active org-occur calls.
15004 This is a list, each call to org-occur pushes as cons cell,
15005 containing the regular expression and the callback, onto the list.
15006 The list can contain several entries if `org-occur' has been called
15007 several time with the KEEP-PREVIOUS argument. Otherwise, this list
15008 will only contain one set of parameters. When the highlights are
15009 removed (for example with `C-c C-c', or with the next edit (depending
15010 on `org-remove-highlights-with-change'), this variable is emptied
15011 as well.")
15012 (make-variable-buffer-local 'org-occur-parameters)
15014 (defun org-occur (regexp &optional keep-previous callback)
15015 "Make a compact tree which shows all matches of REGEXP.
15016 The tree will show the lines where the regexp matches, and all higher
15017 headlines above the match. It will also show the heading after the match,
15018 to make sure editing the matching entry is easy.
15019 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15020 call to `org-occur' will be kept, to allow stacking of calls to this
15021 command.
15022 If CALLBACK is non-nil, it is a function which is called to confirm
15023 that the match should indeed be shown."
15025 (unless keep-previous
15026 (org-remove-occur-highlights nil nil t))
15027 (push (cons regexp callback) org-occur-parameters)
15028 (let ((cnt 0))
15029 (save-excursion
15030 (goto-char (point-min))
15031 (if (or (not keep-previous) ; do not want to keep
15032 (not org-occur-highlights)) ; no previous matches
15033 ;; hide everything
15034 (org-overview))
15035 (while (re-search-forward regexp nil t)
15036 (when (or (not callback)
15037 (save-match-data (funcall callback)))
15038 (setq cnt (1+ cnt))
15039 (when org-highlight-sparse-tree-matches
15040 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15041 (org-show-context 'occur-tree))))
15042 (when org-remove-highlights-with-change
15043 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15044 nil 'local))
15045 (unless org-sparse-tree-open-archived-trees
15046 (org-hide-archived-subtrees (point-min) (point-max)))
15047 (run-hooks 'org-occur-hook)
15048 (if (interactive-p)
15049 (message "%d match(es) for regexp %s" cnt regexp))
15050 cnt))
15052 (defun org-show-context (&optional key)
15053 "Make sure point and context and visible.
15054 How much context is shown depends upon the variables
15055 `org-show-hierarchy-above', `org-show-following-heading'. and
15056 `org-show-siblings'."
15057 (let ((heading-p (org-on-heading-p t))
15058 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15059 (following-p (org-get-alist-option org-show-following-heading key))
15060 (entry-p (org-get-alist-option org-show-entry-below key))
15061 (siblings-p (org-get-alist-option org-show-siblings key)))
15062 (catch 'exit
15063 ;; Show heading or entry text
15064 (if (and heading-p (not entry-p))
15065 (org-flag-heading nil) ; only show the heading
15066 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15067 (org-show-hidden-entry))) ; show entire entry
15068 (when following-p
15069 ;; Show next sibling, or heading below text
15070 (save-excursion
15071 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15072 (org-flag-heading nil))))
15073 (when siblings-p (org-show-siblings))
15074 (when hierarchy-p
15075 ;; show all higher headings, possibly with siblings
15076 (save-excursion
15077 (while (and (condition-case nil
15078 (progn (org-up-heading-all 1) t)
15079 (error nil))
15080 (not (bobp)))
15081 (org-flag-heading nil)
15082 (when siblings-p (org-show-siblings))))))))
15084 (defun org-reveal (&optional siblings)
15085 "Show current entry, hierarchy above it, and the following headline.
15086 This can be used to show a consistent set of context around locations
15087 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15088 not t for the search context.
15090 With optional argument SIBLINGS, on each level of the hierarchy all
15091 siblings are shown. This repairs the tree structure to what it would
15092 look like when opened with hierarchical calls to `org-cycle'."
15093 (interactive "P")
15094 (let ((org-show-hierarchy-above t)
15095 (org-show-following-heading t)
15096 (org-show-siblings (if siblings t org-show-siblings)))
15097 (org-show-context nil)))
15099 (defun org-highlight-new-match (beg end)
15100 "Highlight from BEG to END and mark the highlight is an occur headline."
15101 (let ((ov (org-make-overlay beg end)))
15102 (org-overlay-put ov 'face 'secondary-selection)
15103 (push ov org-occur-highlights)))
15105 (defun org-remove-occur-highlights (&optional beg end noremove)
15106 "Remove the occur highlights from the buffer.
15107 BEG and END are ignored. If NOREMOVE is nil, remove this function
15108 from the `before-change-functions' in the current buffer."
15109 (interactive)
15110 (unless org-inhibit-highlight-removal
15111 (mapc 'org-delete-overlay org-occur-highlights)
15112 (setq org-occur-highlights nil)
15113 (setq org-occur-parameters nil)
15114 (unless noremove
15115 (remove-hook 'before-change-functions
15116 'org-remove-occur-highlights 'local))))
15118 ;;;; Priorities
15121 "Regular expression matching the priority indicator.")
15123 (defvar org-remove-priority-next-time nil)
15125 (defun org-priority-up ()
15126 "Increase the priority of the current item."
15127 (interactive)
15128 (org-priority 'up))
15130 (defun org-priority-down ()
15131 "Decrease the priority of the current item."
15132 (interactive)
15133 (org-priority 'down))
15135 (defun org-priority (&optional action)
15136 "Change the priority of an item by ARG.
15137 ACTION can be `set', `up', `down', or a character."
15138 (interactive)
15139 (setq action (or action 'set))
15140 (let (current new news have remove)
15141 (save-excursion
15142 (org-back-to-heading)
15143 (if (looking-at org-priority-regexp)
15144 (setq current (string-to-char (match-string 2))
15145 have t)
15146 (setq current org-default-priority))
15147 (cond
15148 ((or (eq action 'set) (integerp action))
15149 (if (integerp action)
15150 (setq new action)
15151 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15152 (setq new (read-char-exclusive)))
15153 (if (and (= (upcase org-highest-priority) org-highest-priority)
15154 (= (upcase org-lowest-priority) org-lowest-priority))
15155 (setq new (upcase new)))
15156 (cond ((equal new ?\ ) (setq remove t))
15157 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15158 (error "Priority must be between `%c' and `%c'"
15159 org-highest-priority org-lowest-priority))))
15160 ((eq action 'up)
15161 (if (and (not have) (eq last-command this-command))
15162 (setq new org-lowest-priority)
15163 (setq new (if (and org-priority-start-cycle-with-default (not have))
15164 org-default-priority (1- current)))))
15165 ((eq action 'down)
15166 (if (and (not have) (eq last-command this-command))
15167 (setq new org-highest-priority)
15168 (setq new (if (and org-priority-start-cycle-with-default (not have))
15169 org-default-priority (1+ current)))))
15170 (t (error "Invalid action")))
15171 (if (or (< (upcase new) org-highest-priority)
15172 (> (upcase new) org-lowest-priority))
15173 (setq remove t))
15174 (setq news (format "%c" new))
15175 (if have
15176 (if remove
15177 (replace-match "" t t nil 1)
15178 (replace-match news t t nil 2))
15179 (if remove
15180 (error "No priority cookie found in line")
15181 (looking-at org-todo-line-regexp)
15182 (if (match-end 2)
15183 (progn
15184 (goto-char (match-end 2))
15185 (insert " [#" news "]"))
15186 (goto-char (match-beginning 3))
15187 (insert "[#" news "] ")))))
15188 (org-preserve-lc (org-set-tags nil 'align))
15189 (if remove
15190 (message "Priority removed")
15191 (message "Priority of current item set to %s" news))))
15194 (defun org-get-priority (s)
15195 "Find priority cookie and return priority."
15196 (save-match-data
15197 (if (not (string-match org-priority-regexp s))
15198 (* 1000 (- org-lowest-priority org-default-priority))
15199 (* 1000 (- org-lowest-priority
15200 (string-to-char (match-string 2 s)))))))
15202 ;;;; Tags
15204 (defun org-scan-tags (action matcher &optional todo-only)
15205 "Scan headline tags with inheritance and produce output ACTION.
15206 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15207 evaluated, testing if a given set of tags qualifies a headline for
15208 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15209 are included in the output."
15212 (org-re
15214 (props (list 'face nil
15215 'done-face 'org-done
15216 'undone-face nil
15217 'mouse-face 'highlight
15218 'org-not-done-regexp org-not-done-regexp
15219 'org-todo-regexp org-todo-regexp
15220 'keymap org-agenda-keymap
15221 'help-echo
15222 (format "mouse-2 or RET jump to org file %s"
15223 (abbreviate-file-name
15224 (or (buffer-file-name (buffer-base-buffer))
15225 (buffer-name (buffer-base-buffer)))))))
15226 (case-fold-search nil)
15227 lspos
15228 tags tags-list tags-alist (llast 0) rtn level category i txt
15229 todo marker entry priority)
15230 (save-excursion
15231 (goto-char (point-min))
15232 (when (eq action 'sparse-tree)
15233 (org-overview)
15234 (org-remove-occur-highlights))
15235 (while (re-search-forward re nil t)
15236 (catch :skip
15237 (setq todo (if (match-end 1) (match-string 2))
15238 tags (if (match-end 4) (match-string 4)))
15239 (goto-char (setq lspos (1+ (match-beginning 0))))
15240 (setq level (org-reduced-level (funcall outline-level))
15241 category (org-get-category))
15242 (setq i llast llast level)
15243 ;; remove tag lists from same and sublevels
15244 (while (>= i level)
15245 (when (setq entry (assoc i tags-alist))
15246 (setq tags-alist (delete entry tags-alist)))
15247 (setq i (1- i)))
15248 ;; add the nex tags
15249 (when tags
15250 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15251 tags-alist
15252 (cons (cons level tags) tags-alist)))
15253 ;; compile tags for current headline
15254 (setq tags-list
15255 (if org-use-tag-inheritance
15256 (apply 'append (mapcar 'cdr tags-alist))
15257 tags))
15258 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15259 (eval matcher)
15260 (or (not org-agenda-skip-archived-trees)
15261 (not (member org-archive-tag tags-list))))
15262 (and (eq action 'agenda) (org-agenda-skip))
15263 ;; list this headline
15265 (if (eq action 'sparse-tree)
15266 (progn
15267 (and org-highlight-sparse-tree-matches
15268 (org-get-heading) (match-end 0)
15269 (org-highlight-new-match
15270 (match-beginning 0) (match-beginning 1)))
15271 (org-show-context 'tags-tree))
15272 (setq txt (org-format-agenda-item
15273 ""
15274 (concat
15275 (if org-tags-match-list-sublevels
15276 (make-string (1- level) ?.) "")
15277 (org-get-heading))
15278 category tags-list)
15279 priority (org-get-priority txt))
15280 (goto-char lspos)
15281 (setq marker (org-agenda-new-marker))
15282 (org-add-props txt props
15283 'org-marker marker 'org-hd-marker marker 'org-category category
15284 'priority priority 'type "tagsmatch")
15285 (push txt rtn))
15286 ;; if we are to skip sublevels, jump to end of subtree
15287 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15288 (when (and (eq action 'sparse-tree)
15289 (not org-sparse-tree-open-archived-trees))
15290 (org-hide-archived-subtrees (point-min) (point-max)))
15291 (nreverse rtn)))
15293 (defvar todo-only) ;; dynamically scoped
15295 (defun org-tags-sparse-tree (&optional todo-only match)
15296 "Create a sparse tree according to tags string MATCH.
15297 MATCH can contain positive and negative selection of tags, like
15299 If optional argument TODO_ONLY is non-nil, only select lines that are
15300 also TODO lines."
15301 (interactive "P")
15302 (org-prepare-agenda-buffers (list (current-buffer)))
15303 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15305 (defvar org-cached-props nil)
15306 (defun org-cached-entry-get (pom property)
15307 (if (or (eq t org-use-property-inheritance)
15308 (member property org-use-property-inheritance))
15309 ;; Caching is not possible, check it directly
15310 (org-entry-get pom property 'inherit)
15311 ;; Get all properties, so that we can do complicated checks easily
15312 (cdr (assoc property (or org-cached-props
15313 (setq org-cached-props
15314 (org-entry-properties pom)))))))
15316 (defun org-global-tags-completion-table (&optional files)
15317 "Return the list of all tags in all agenda buffer/files."
15318 (save-excursion
15319 (org-uniquify
15320 (delq nil
15321 (apply 'append
15322 (mapcar
15323 (lambda (file)
15324 (set-buffer (find-file-noselect file))
15325 (append (org-get-buffer-tags)
15326 (mapcar (lambda (x) (if (stringp (car-safe x))
15327 (list (car-safe x)) nil))
15328 org-tag-alist)))
15329 (if (and files (car files))
15330 files
15331 (org-agenda-files))))))))
15333 (defun org-make-tags-matcher (match)
15334 "Create the TAGS//TODO matcher form for the selection string MATCH."
15335 ;; todo-only is scoped dynamically into this function, and the function
15336 ;; may change it it the matcher asksk for it.
15337 (unless match
15338 ;; Get a new match request, with completion
15339 (let ((org-last-tags-completion-table
15340 (org-global-tags-completion-table)))
15341 (setq match (completing-read
15342 "Match: " 'org-tags-completion-function nil nil nil
15343 'org-tags-history))))
15345 ;; Parse the string and create a lisp form
15346 (let ((match0 match)
15347 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15348 minus tag mm
15349 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15350 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15351 (if (string-match "/+" match)
15352 ;; match contains also a todo-matching request
15353 (progn
15354 (setq tagsmatch (substring match 0 (match-beginning 0))
15355 todomatch (substring match (match-end 0)))
15356 (if (string-match "^!" todomatch)
15357 (setq todo-only t todomatch (substring todomatch 1)))
15359 (setq todomatch nil)))
15360 ;; only matching tags
15361 (setq tagsmatch match todomatch nil))
15363 ;; Make the tags matcher
15365 (setq tagsmatcher t)
15366 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15367 (while (setq term (pop orterms))
15369 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15370 (while (string-match re term)
15371 (setq minus (and (match-end 1)
15372 (equal (match-string 1 term) "-"))
15373 tag (match-string 2 term)
15374 re-p (equal (string-to-char tag) ?{)
15375 level-p (match-end 3)
15376 prop-p (match-end 4)
15377 mm (cond
15378 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15379 (level-p `(= level ,(string-to-number
15380 (match-string 3 term))))
15381 (prop-p
15382 (setq pn (match-string 4 term)
15383 pv (match-string 5 term)
15384 cat-p (equal pn "CATEGORY")
15385 re-p (equal (string-to-char pv) ?{)
15386 pv (substring pv 1 -1))
15387 (if (equal pn "CATEGORY")
15388 (setq gv '(get-text-property (point) 'org-category))
15389 (setq gv `(org-cached-entry-get nil ,pn)))
15390 (if re-p
15391 `(string-match ,pv (or ,gv ""))
15392 `(equal ,pv (or ,gv ""))))
15393 (t `(member ,(downcase tag) tags-list)))
15394 mm (if minus (list 'not mm) mm)
15395 term (substring term (match-end 0)))
15396 (push mm tagsmatcher))
15397 (push (if (> (length tagsmatcher) 1)
15398 (cons 'and tagsmatcher)
15399 (car tagsmatcher))
15400 orlist)
15401 (setq tagsmatcher nil))
15402 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15403 (setq tagsmatcher
15404 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15406 ;; Make the todo matcher
15408 (setq todomatcher t)
15409 (setq orterms (org-split-string todomatch "|") orlist nil)
15410 (while (setq term (pop orterms))
15411 (while (string-match re term)
15412 (setq minus (and (match-end 1)
15413 (equal (match-string 1 term) "-"))
15414 kwd (match-string 2 term)
15415 re-p (equal (string-to-char kwd) ?{)
15416 term (substring term (match-end 0))
15417 mm (if re-p
15418 `(string-match ,(substring kwd 1 -1) todo)
15419 (list 'equal 'todo kwd))
15420 mm (if minus (list 'not mm) mm))
15421 (push mm todomatcher))
15422 (push (if (> (length todomatcher) 1)
15423 (cons 'and todomatcher)
15424 (car todomatcher))
15425 orlist)
15426 (setq todomatcher nil))
15427 (setq todomatcher (if (> (length orlist) 1)
15428 (cons 'or orlist) (car orlist))))
15430 ;; Return the string and lisp forms of the matcher
15431 (setq matcher (if todomatcher
15432 (list 'and tagsmatcher todomatcher)
15433 tagsmatcher))
15434 (cons match0 matcher)))
15436 (defun org-match-any-p (re list)
15437 "Does re match any element of list?"
15438 (setq list (mapcar (lambda (x) (string-match re x)) list))
15439 (delq nil list))
15441 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15442 (defvar org-tags-overlay (org-make-overlay 1 1))
15443 (org-detach-overlay org-tags-overlay)
15445 (defun org-align-tags-here (to-col)
15446 ;; Assumes that this is a headline
15447 (let ((pos (point)) (col (current-column)) tags)
15448 (beginning-of-line 1)
15450 (< pos (match-beginning 2)))
15451 (progn
15452 (setq tags (match-string 2))
15453 (goto-char (match-beginning 1))
15454 (insert " ")
15455 (delete-region (point) (1+ (match-end 0)))
15456 (backward-char 1)
15457 (move-to-column
15458 (max (1+ (current-column))
15459 (1+ col)
15460 (if (> to-col 0)
15461 to-col
15462 (- (abs to-col) (length tags))))
15463 t)
15464 (insert tags)
15465 (move-to-column (min (current-column) col) t))
15466 (goto-char pos))))
15468 (defun org-set-tags (&optional arg just-align)
15469 "Set the tags for the current headline.
15470 With prefix ARG, realign all tags in headings in the current buffer."
15471 (interactive "P")
15472 (let* ((re (concat "^" outline-regexp))
15473 (current (org-get-tags-string))
15474 (col (current-column))
15475 (org-setting-tags t)
15476 table current-tags inherited-tags ; computed below when needed
15477 tags p0 c0 c1 rpl)
15478 (if arg
15479 (save-excursion
15480 (goto-char (point-min))
15481 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15482 (while (re-search-forward re nil t)
15483 (org-set-tags nil t)
15484 (end-of-line 1)))
15485 (message "All tags realigned to column %d" org-tags-column))
15486 (if just-align
15487 (setq tags current)
15488 ;; Get a new set of tags from the user
15489 (save-excursion
15490 (setq table (or org-tag-alist (org-get-buffer-tags))
15491 org-last-tags-completion-table table
15492 current-tags (org-split-string current ":")
15493 inherited-tags (nreverse
15494 (nthcdr (length current-tags)
15495 (nreverse (org-get-tags-at))))
15496 tags
15497 (if (or (eq t org-use-fast-tag-selection)
15498 (and org-use-fast-tag-selection
15499 (delq nil (mapcar 'cdr table))))
15500 (org-fast-tag-selection
15501 current-tags inherited-tags table
15502 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15503 (let ((org-add-colon-after-tag-completion t))
15504 (org-trim
15505 (org-without-partial-completion
15506 (completing-read "Tags: " 'org-tags-completion-function
15507 nil nil current 'org-tags-history)))))))
15508 (while (string-match "[-+&]+" tags)
15509 ;; No boolean logic, just a list
15510 (setq tags (replace-match ":" t t tags))))
15513 (setq tags "")
15514 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15515 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15517 ;; Insert new tags at the correct column
15518 (beginning-of-line 1)
15519 (cond
15520 ((and (equal current "") (equal tags "")))
15521 ((re-search-forward
15523 (point-at-eol) t)
15524 (if (equal tags "")
15525 (setq rpl "")
15526 (goto-char (match-beginning 0))
15527 (setq c0 (current-column) p0 (point)
15528 c1 (max (1+ c0) (if (> org-tags-column 0)
15529 org-tags-column
15530 (- (- org-tags-column) (length tags))))
15531 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15532 (replace-match rpl t t)
15533 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15534 tags)
15535 (t (error "Tags alignment failed")))
15536 (move-to-column col)
15537 (unless just-align
15538 (run-hooks 'org-after-tags-change-hook)))))
15540 (defun org-change-tag-in-region (beg end tag off)
15541 "Add or remove TAG for each entry in the region.
15542 This works in the agenda, and also in an org-mode buffer."
15543 (interactive
15544 (list (region-beginning) (region-end)
15545 (let ((org-last-tags-completion-table
15546 (if (org-mode-p)
15547 (org-get-buffer-tags)
15548 (org-global-tags-completion-table))))
15549 (completing-read
15550 "Tag: " 'org-tags-completion-function nil nil nil
15551 'org-tags-history))
15552 (progn
15553 (message "[s]et or [r]emove? ")
15554 (equal (read-char-exclusive) ?r))))
15555 (if (fboundp 'deactivate-mark) (deactivate-mark))
15556 (let ((agendap (equal major-mode 'org-agenda-mode))
15557 l1 l2 m buf pos newhead (cnt 0))
15558 (goto-char end)
15559 (setq l2 (1- (org-current-line)))
15560 (goto-char beg)
15561 (setq l1 (org-current-line))
15562 (loop for l from l1 to l2 do
15563 (goto-line l)
15564 (setq m (get-text-property (point) 'org-hd-marker))
15565 (when (or (and (org-mode-p) (org-on-heading-p))
15566 (and agendap m))
15567 (setq buf (if agendap (marker-buffer m) (current-buffer))
15568 pos (if agendap m (point)))
15569 (with-current-buffer buf
15570 (save-excursion
15571 (save-restriction
15572 (goto-char pos)
15573 (setq cnt (1+ cnt))
15574 (org-toggle-tag tag (if off 'off 'on))
15575 (setq newhead (org-get-heading)))))
15576 (and agendap (org-agenda-change-all-lines newhead m))))
15577 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15579 (defun org-tags-completion-function (string predicate &optional flag)
15580 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15581 (confirm (lambda (x) (stringp (car x)))))
15583 (setq s1 (match-string 1 string)
15584 s2 (match-string 2 string))
15585 (setq s1 "" s2 string))
15586 (cond
15587 ((eq flag nil)
15588 ;; try completion
15589 (setq rtn (try-completion s2 ctable confirm))
15590 (if (stringp rtn)
15591 (setq rtn
15592 (concat s1 s2 (substring rtn (length s2))
15593 (if (and org-add-colon-after-tag-completion
15594 (assoc rtn ctable))
15595 ":" ""))))
15596 rtn)
15597 ((eq flag t)
15598 ;; all-completions
15599 (all-completions s2 ctable confirm)
15600 )
15601 ((eq flag 'lambda)
15602 ;; exact match?
15603 (assoc s2 ctable)))
15604 ))
15606 (defun org-fast-tag-insert (kwd tags face &optional end)
15607 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15608 (insert (format "%-12s" (concat kwd ":"))
15609 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15610 (or end "")))
15612 (defun org-fast-tag-show-exit (flag)
15613 (save-excursion
15614 (goto-line 3)
15616 (replace-match ""))
15617 (when flag
15618 (end-of-line 1)
15619 (move-to-column (- (window-width) 19) t)
15620 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15622 (defun org-set-current-tags-overlay (current prefix)
15623 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15624 (if (featurep 'xemacs)
15625 (org-overlay-display org-tags-overlay (concat prefix s)
15626 'secondary-selection)
15627 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15628 (org-overlay-display org-tags-overlay (concat prefix s)))))
15630 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15631 "Fast tag selection with single keys.
15632 CURRENT is the current list of tags in the headline, INHERITED is the
15633 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15634 possibly with grouping information. TODO-TABLE is a similar table with
15635 TODO keywords, should these have keys assigned to them.
15636 If the keys are nil, a-z are automatically assigned.
15637 Returns the new tags string, or nil to not change the current settings."
15638 (let* ((fulltable (append table todo-table))
15639 (maxlen (apply 'max (mapcar
15640 (lambda (x)
15641 (if (stringp (car x)) (string-width (car x)) 0))
15642 fulltable)))
15643 (buf (current-buffer))
15644 (expert (eq org-fast-tag-selection-single-key 'expert))
15645 (buffer-tags nil)
15646 (fwidth (+ maxlen 3 1 3))
15647 (ncol (/ (- (window-width) 4) fwidth))
15648 (i-face 'org-done)
15649 (c-face 'org-todo)
15650 tg cnt e c char c1 c2 ntable tbl rtn
15651 ov-start ov-end ov-prefix
15652 (exit-after-next org-fast-tag-selection-single-key)
15653 (done-keywords org-done-keywords)
15654 groups ingroup)
15655 (save-excursion
15656 (beginning-of-line 1)
15657 (if (looking-at
15659 (setq ov-start (match-beginning 1)
15660 ov-end (match-end 1)
15661 ov-prefix "")
15662 (setq ov-start (1- (point-at-eol))
15663 ov-end (1+ ov-start))
15665 (setq ov-prefix
15666 (concat
15667 (buffer-substring (1- (point)) (point))
15668 (if (> (current-column) org-tags-column)
15669 " "
15670 (make-string (- org-tags-column (current-column)) ?\ ))))))
15671 (org-move-overlay org-tags-overlay ov-start ov-end)
15672 (save-window-excursion
15673 (if expert
15674 (set-buffer (get-buffer-create " *Org tags*"))
15675 (delete-other-windows)
15676 (split-window-vertically)
15677 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15678 (erase-buffer)
15679 (org-set-local 'org-done-keywords done-keywords)
15682 (org-fast-tag-show-exit exit-after-next)
15683 (org-set-current-tags-overlay current ov-prefix)
15684 (setq tbl fulltable char ?a cnt 0)
15685 (while (setq e (pop tbl))
15686 (cond
15687 ((equal e '(:startgroup))
15688 (push '() groups) (setq ingroup t)
15689 (when (not (= cnt 0))
15690 (setq cnt 0)
15692 (insert "{ "))
15693 ((equal e '(:endgroup))
15694 (setq ingroup nil cnt 0)
15696 (t
15697 (setq tg (car e) c2 nil)
15698 (if (cdr e)
15699 (setq c (cdr e))
15700 ;; automatically assign a character.
15701 (setq c1 (string-to-char
15702 (downcase (substring
15703 tg (if (= (string-to-char tg) ?@) 1 0)))))
15704 (if (or (rassoc c1 ntable) (rassoc c1 table))
15705 (while (or (rassoc char ntable) (rassoc char table))
15706 (setq char (1+ char)))
15707 (setq c2 c1))
15708 (setq c (or c2 char)))
15709 (if ingroup (push tg (car groups)))
15710 (setq tg (org-add-props tg nil 'face
15711 (cond
15712 ((not (assoc tg table))
15713 (org-get-todo-face tg))
15714 ((member tg current) c-face)
15715 ((member tg inherited) i-face)
15716 (t nil))))
15717 (if (and (= cnt 0) (not ingroup)) (insert " "))
15718 (insert "[" c "] " tg (make-string
15719 (- fwidth 4 (length tg)) ?\ ))
15720 (push (cons tg c) ntable)
15721 (when (= (setq cnt (1+ cnt)) ncol)
15723 (if ingroup (insert " "))
15724 (setq cnt 0)))))
15725 (setq ntable (nreverse ntable))
15727 (goto-char (point-min))
15728 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15729 (fit-window-to-buffer))
15730 (setq rtn
15731 (catch 'exit
15732 (while t
15733 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15734 (if groups " [!] no groups" " [!]groups")
15735 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15736 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15737 (cond
15739 ((= c ?!)
15740 (setq groups (not groups))
15741 (goto-char (point-min))
15742 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15743 ((= c ?\C-c)
15744 (if (not expert)
15745 (org-fast-tag-show-exit
15746 (setq exit-after-next (not exit-after-next)))
15747 (setq expert nil)
15748 (delete-other-windows)
15749 (split-window-vertically)
15750 (org-switch-to-buffer-other-window " *Org tags*")
15751 (and (fboundp 'fit-window-to-buffer)
15752 (fit-window-to-buffer))))
15753 ((or (= c ?\C-g)
15754 (and (= c ?q) (not (rassoc c ntable))))
15755 (org-detach-overlay org-tags-overlay)
15756 (setq quit-flag t))
15757 ((= c ?\ )
15758 (setq current nil)
15759 (if exit-after-next (setq exit-after-next 'now)))
15761 (condition-case nil
15762 (setq tg (completing-read
15763 "Tag: "
15764 (or buffer-tags
15765 (with-current-buffer buf
15766 (org-get-buffer-tags)))))
15767 (quit (setq tg "")))
15769 (add-to-list 'buffer-tags (list tg))
15770 (if (member tg current)
15771 (setq current (delete tg current))
15772 (push tg current)))
15773 (if exit-after-next (setq exit-after-next 'now)))
15774 ((setq e (rassoc c todo-table) tg (car e))
15775 (with-current-buffer buf
15776 (save-excursion (org-todo tg)))
15777 (if exit-after-next (setq exit-after-next 'now)))
15778 ((setq e (rassoc c ntable) tg (car e))
15779 (if (member tg current)
15780 (setq current (delete tg current))
15781 (loop for g in groups do
15782 (if (member tg g)
15783 (mapc (lambda (x)
15784 (setq current (delete x current)))
15785 g)))
15786 (push tg current))
15787 (if exit-after-next (setq exit-after-next 'now))))
15789 ;; Create a sorted list
15790 (setq current
15791 (sort current
15792 (lambda (a b)
15793 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15794 (if (eq exit-after-next 'now) (throw 'exit t))
15795 (goto-char (point-min))
15796 (beginning-of-line 2)
15797 (delete-region (point) (point-at-eol))
15798 (org-fast-tag-insert "Current" current c-face)
15799 (org-set-current-tags-overlay current ov-prefix)
15800 (while (re-search-forward
15802 (setq tg (match-string 1))
15803 (add-text-properties
15804 (match-beginning 1) (match-end 1)
15805 (list 'face
15806 (cond
15807 ((member tg current) c-face)
15808 ((member tg inherited) i-face)
15809 (t (get-text-property (match-beginning 1) 'face))))))
15810 (goto-char (point-min)))))
15811 (org-detach-overlay org-tags-overlay)
15812 (if rtn
15813 (mapconcat 'identity current ":")
15814 nil))))
15816 (defun org-get-tags-string ()
15817 "Get the TAGS string in the current headline."
15818 (unless (org-on-heading-p t)
15819 (error "Not on a heading"))
15820 (save-excursion
15821 (beginning-of-line 1)
15823 (org-match-string-no-properties 1)
15824 "")))
15826 (defun org-get-tags ()
15827 "Get the list of tags specified in the current headline."
15828 (org-split-string (org-get-tags-string) ":"))
15830 (defun org-get-buffer-tags ()
15831 "Get a table of all tags used in the buffer, for completion."
15832 (let (tags)
15833 (save-excursion
15834 (goto-char (point-min))
15835 (while (re-search-forward
15837 (when (equal (char-after (point-at-bol 0)) ?*)
15838 (mapc (lambda (x) (add-to-list 'tags x))
15839 (org-split-string (org-match-string-no-properties 1) ":")))))
15840 (mapcar 'list tags)))
15843 ;;;; Properties
15845 ;;; Setting and retrieving properties
15847 (defconst org-special-properties
15848 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15849 "TIMESTAMP" "TIMESTAMP_IA")
15850 "The special properties valid in Org-mode.
15852 These are properties that are not defined in the property drawer,
15853 but in some other way.")
15855 (defconst org-default-properties
15856 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15857 "LOCATION" "LOGGING" "COLUMNS")
15858 "Some properties that are used by Org-mode for various purposes.
15859 Being in this list makes sure that they are offered for completion.")
15862 "Regular expression matching the first line of a property drawer.")
15865 "Regular expression matching the first line of a property drawer.")
15867 (defun org-property-action ()
15868 "Do an action on properties."
15869 (interactive)
15870 (let (c)
15871 (org-at-property-p)
15872 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15873 (setq c (read-char-exclusive))
15874 (cond
15875 ((equal c ?s)
15876 (call-interactively 'org-set-property))
15877 ((equal c ?d)
15878 (call-interactively 'org-delete-property))
15879 ((equal c ?D)
15880 (call-interactively 'org-delete-property-globally))
15881 ((equal c ?c)
15882 (call-interactively 'org-compute-property-at-point))
15883 (t (error "No such property action %c" c)))))
15885 (defun org-at-property-p ()
15886 "Is the cursor in a property line?"
15887 ;; FIXME: Does not check if we are actually in the drawer.
15888 ;; FIXME: also returns true on any drawers.....
15889 ;; This is used by C-c C-c for property action.
15890 (save-excursion
15891 (beginning-of-line 1)
15894 (defmacro org-with-point-at (pom &rest body)
15895 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15896 (declare (indent 1) (debug t))
15897 `(save-excursion
15898 (if (markerp pom) (set-buffer (marker-buffer pom)))
15899 (save-excursion
15900 (goto-char (or pom (point)))
15901 ,@body)))
15903 (defun org-get-property-block (&optional beg end force)
15904 "Return the (beg . end) range of the body of the property drawer.
15905 BEG and END can be beginning and end of subtree, if not given
15906 they will be found.
15907 If the drawer does not exist and FORCE is non-nil, create the drawer."
15908 (catch 'exit
15909 (save-excursion
15910 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15911 (end (or end (progn (outline-next-heading) (point)))))
15912 (goto-char beg)
15913 (if (re-search-forward org-property-start-re end t)
15914 (setq beg (1+ (match-end 0)))
15915 (if force
15916 (save-excursion
15917 (org-insert-property-drawer)
15918 (setq end (progn (outline-next-heading) (point))))
15919 (throw 'exit nil))
15920 (goto-char beg)
15921 (if (re-search-forward org-property-start-re end t)
15922 (setq beg (1+ (match-end 0)))))
15923 (if (re-search-forward org-property-end-re end t)
15924 (setq end (match-beginning 0))
15925 (or force (throw 'exit nil))
15926 (goto-char beg)
15927 (setq end beg)
15928 (org-indent-line-function)
15930 (cons beg end)))))
15932 (defun org-entry-properties (&optional pom which)
15933 "Get all properties of the entry at point-or-marker POM.
15934 This includes the TODO keyword, the tags, time strings for deadline,
15935 scheduled, and clocking, and any additional properties defined in the
15936 entry. The return value is an alist, keys may occur multiple times
15937 if the property key was used several times.
15938 POM may also be nil, in which case the current entry is used.
15939 If WHICH is nil or `all', get all properties. If WHICH is
15940 `special' or `standard', only get that subclass."
15941 (setq which (or which 'all))
15942 (org-with-point-at pom
15943 (let ((clockstr (substring org-clock-string 0 -1))
15944 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15945 beg end range props sum-props key value string clocksum)
15946 (save-excursion
15947 (when (condition-case nil (org-back-to-heading t) (error nil))
15948 (setq beg (point))
15949 (setq sum-props (get-text-property (point) 'org-summaries))
15950 (setq clocksum (get-text-property (point) :org-clock-minutes))
15951 (outline-next-heading)
15952 (setq end (point))
15953 (when (memq which '(all special))
15954 ;; Get the special properties, like TODO and tags
15955 (goto-char beg)
15956 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15957 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15958 (when (looking-at org-priority-regexp)
15959 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15960 (when (and (setq value (org-get-tags-string))
15962 (push (cons "TAGS" value) props))
15963 (when (setq value (org-get-tags-at))
15964 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15965 props))
15966 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15967 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15968 string (if (equal key clockstr)
15969 (org-no-properties
15970 (org-trim
15971 (buffer-substring
15972 (match-beginning 3) (goto-char (point-at-eol)))))
15973 (substring (org-match-string-no-properties 3) 1 -1)))
15974 (unless key
15975 (if (= (char-after (match-beginning 3)) ?\[)
15976 (setq key "TIMESTAMP_IA")
15977 (setq key "TIMESTAMP")))
15978 (when (or (equal key clockstr) (not (assoc key props)))
15979 (push (cons key string) props)))
15981 )
15983 (when (memq which '(all standard))
15984 ;; Get the standard properties, like :PORP: ...
15985 (setq range (org-get-property-block beg end))
15986 (when range
15987 (goto-char (car range))
15988 (while (re-search-forward
15990 (cdr range) t)
15991 (setq key (org-match-string-no-properties 1)
15992 value (org-trim (or (org-match-string-no-properties 2) "")))
15993 (unless (member key excluded)
15994 (push (cons key (or value "")) props)))))
15995 (if clocksum
15996 (push (cons "CLOCKSUM"
15997 (org-column-number-to-string (/ (float clocksum) 60.)
15998 'add_times))
15999 props))
16000 (append sum-props (nreverse props)))))))
16002 (defun org-entry-get (pom property &optional inherit)
16003 "Get value of PROPERTY for entry at point-or-marker POM.
16004 If INHERIT is non-nil and the entry does not have the property,
16005 then also check higher levels of the hierarchy.
16006 If the property is present but empty, the return value is the empty string.
16007 If the property is not present at all, nil is returned."
16008 (org-with-point-at pom
16009 (if inherit
16010 (org-entry-get-with-inheritance property)
16011 (if (member property org-special-properties)
16012 ;; We need a special property. Use brute force, get all properties.
16013 (cdr (assoc property (org-entry-properties nil 'special)))
16014 (let ((range (org-get-property-block)))
16015 (if (and range
16016 (goto-char (car range))
16017 (re-search-forward
16019 (cdr range) t))
16020 ;; Found the property, return it.
16021 (if (match-end 1)
16022 (org-match-string-no-properties 1)
16023 "")))))))
16025 (defun org-entry-delete (pom property)
16026 "Delete the property PROPERTY from entry at point-or-marker POM."
16027 (org-with-point-at pom
16028 (if (member property org-special-properties)
16029 nil ; cannot delete these properties.
16030 (let ((range (org-get-property-block)))
16031 (if (and range
16032 (goto-char (car range))
16033 (re-search-forward
16035 (cdr range) t))
16036 (progn
16037 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16038 t)
16039 nil)))))
16041 ;; Multi-values properties are properties that contain multiple values
16042 ;; These values are assumed to be single words, separated by whitespace.
16043 (defun org-entry-add-to-multivalued-property (pom property value)
16044 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16045 (let* ((old (org-entry-get pom property))
16047 (unless (member value values)
16048 (setq values (cons value values))
16049 (org-entry-put pom property
16050 (mapconcat 'identity values " ")))))
16052 (defun org-entry-remove-from-multivalued-property (pom property value)
16053 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16054 (let* ((old (org-entry-get pom property))
16056 (when (member value values)
16057 (setq values (delete value values))
16058 (org-entry-put pom property
16059 (mapconcat 'identity values " ")))))
16061 (defun org-entry-member-in-multivalued-property (pom property value)
16062 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16063 (let* ((old (org-entry-get pom property))
16065 (member value values)))
16067 (defvar org-entry-property-inherited-from (make-marker))
16069 (defun org-entry-get-with-inheritance (property)
16070 "Get entry property, and search higher levels if not present."
16071 (let (tmp)
16072 (save-excursion
16073 (save-restriction
16074 (widen)
16075 (catch 'ex
16076 (while t
16077 (when (setq tmp (org-entry-get nil property))
16078 (org-back-to-heading t)
16079 (move-marker org-entry-property-inherited-from (point))
16080 (throw 'ex tmp))
16081 (or (org-up-heading-safe) (throw 'ex nil)))))
16082 (or tmp (cdr (assoc property org-local-properties))
16083 (cdr (assoc property org-global-properties))))))
16085 (defun org-entry-put (pom property value)
16086 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16087 (org-with-point-at pom
16088 (org-back-to-heading t)
16089 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16090 range)
16091 (cond
16092 ((equal property "TODO")
16094 (not (member value org-todo-keywords-1)))
16096 (if (or (not value)
16098 (setq value 'none))
16099 (org-todo value)
16100 (org-set-tags nil 'align))
16101 ((equal property "PRIORITY")
16103 (string-to-char value) ?\ ))
16104 (org-set-tags nil 'align))
16105 ((equal property "SCHEDULED")
16106 (if (re-search-forward org-scheduled-time-regexp end t)
16107 (cond
16108 ((eq value 'earlier) (org-timestamp-change -1 'day))
16109 ((eq value 'later) (org-timestamp-change 1 'day))
16110 (t (call-interactively 'org-schedule)))
16111 (call-interactively 'org-schedule)))
16112 ((equal property "DEADLINE")
16113 (if (re-search-forward org-deadline-time-regexp end t)
16114 (cond
16115 ((eq value 'earlier) (org-timestamp-change -1 'day))
16116 ((eq value 'later) (org-timestamp-change 1 'day))
16117 (t (call-interactively 'org-deadline)))
16118 (call-interactively 'org-deadline)))
16119 ((member property org-special-properties)
16120 (error "The %s property can not yet be set with `org-entry-put'"
16121 property))
16122 (t ; a non-special property
16123 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16124 (setq range (org-get-property-block beg end 'force))
16125 (goto-char (car range))
16126 (if (re-search-forward
16128 (progn
16129 (delete-region (match-beginning 1) (match-end 1))
16130 (goto-char (match-beginning 1)))
16131 (goto-char (cdr range))
16133 (backward-char 1)
16134 (org-indent-line-function)
16135 (insert ":" property ":"))
16136 (and value (insert " " value))
16137 (org-indent-line-function)))))))
16139 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16140 "Get all property keys in the current buffer.
16141 With INCLUDE-SPECIALS, also list the special properties that relect things
16142 like tags and TODO state.
16143 With INCLUDE-DEFAULTS, also include properties that has special meaning
16144 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16145 With INCLUDE-COLUMNS, also include property names given in COLUMN
16146 formats in the current buffer."
16147 (let (rtn range cfmt cols s p)
16148 (save-excursion
16149 (save-restriction
16150 (widen)
16151 (goto-char (point-min))
16152 (while (re-search-forward org-property-start-re nil t)
16153 (setq range (org-get-property-block))
16154 (goto-char (car range))
16155 (while (re-search-forward
16157 (cdr range) t)
16158 (add-to-list 'rtn (org-match-string-no-properties 1)))
16159 (outline-next-heading))))
16161 (when include-specials
16162 (setq rtn (append org-special-properties rtn)))
16164 (when include-defaults
16165 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16167 (when include-columns
16168 (save-excursion
16169 (save-restriction
16170 (widen)
16171 (goto-char (point-min))
16172 (while (re-search-forward
16174 nil t)
16175 (setq cfmt (match-string 2) s 0)
16177 cfmt s)
16178 (setq s (match-end 0)
16179 p (match-string 1 cfmt))
16180 (unless (or (equal p "ITEM")
16181 (member p org-special-properties))
16182 (add-to-list 'rtn (match-string 1 cfmt))))))))
16184 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16186 (defun org-property-values (key)
16187 "Return a list of all values of property KEY."
16188 (save-excursion
16189 (save-restriction
16190 (widen)
16191 (goto-char (point-min))
16193 values)
16194 (while (re-search-forward re nil t)
16195 (add-to-list 'values (org-trim (match-string 1))))
16196 (delete "" values)))))
16198 (defun org-insert-property-drawer ()
16199 "Insert a property drawer into the current entry."
16200 (interactive)
16201 (org-back-to-heading t)
16202 (looking-at outline-regexp)
16203 (let ((indent (- (match-end 0)(match-beginning 0)))
16204 (beg (point))
16206 end hiddenp)
16207 (outline-next-heading)
16208 (setq end (point))
16209 (goto-char beg)
16210 (while (re-search-forward re end t))
16211 (setq hiddenp (org-invisible-p))
16212 (end-of-line 1)
16214 (org-skip-over-state-notes)
16216 (if (eq (char-before) ?*) (forward-char 1))
16218 (beginning-of-line 0)
16219 (indent-to-column indent)
16220 (beginning-of-line 2)
16221 (indent-to-column indent)
16222 (beginning-of-line 0)
16223 (if hiddenp
16224 (save-excursion
16225 (org-back-to-heading t)
16226 (hide-entry))
16227 (org-flag-drawer t))))
16229 (defun org-set-property (property value)
16230 "In the current entry, set PROPERTY to VALUE.
16231 When called interactively, this will prompt for a property name, offering
16232 completion on existing and default properties. And then it will prompt
16233 for a value, offering competion either on allowed values (via an inherited
16234 xxx_ALL property) or on existing values in other instances of this property
16235 in the current file."
16236 (interactive
16237 (let* ((prop (completing-read
16238 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16239 (cur (org-entry-get nil prop))
16240 (allowed (org-property-get-allowed-values nil prop 'table))
16241 (existing (mapcar 'list (org-property-values prop)))
16242 (val (if allowed
16243 (completing-read "Value: " allowed nil 'req-match)
16244 (completing-read
16246 (concat "[" cur "]") "")
16247 ": ")
16248 existing nil nil "" nil cur))))
16249 (list prop (if (equal val "") cur val))))
16250 (unless (equal (org-entry-get nil property) value)
16251 (org-entry-put nil property value)))
16253 (defun org-delete-property (property)
16254 "In the current entry, delete PROPERTY."
16255 (interactive
16256 (let* ((prop (completing-read
16257 "Property: " (org-entry-properties nil 'standard))))
16258 (list prop)))
16259 (message "Property %s %s" property
16260 (if (org-entry-delete nil property)
16261 "deleted"
16262 "was not present in the entry")))
16264 (defun org-delete-property-globally (property)
16265 "Remove PROPERTY globally, from all entries."
16266 (interactive
16267 (let* ((prop (completing-read
16268 "Globally remove property: "
16269 (mapcar 'list (org-buffer-property-keys)))))
16270 (list prop)))
16271 (save-excursion
16272 (save-restriction
16273 (widen)
16274 (goto-char (point-min))
16275 (let ((cnt 0))
16276 (while (re-search-forward
16278 nil t)
16279 (setq cnt (1+ cnt))
16280 (replace-match ""))
16283 (defvar org-columns-current-fmt-compiled) ; defined below
16285 (defun org-compute-property-at-point ()
16286 "Compute the property at point.
16287 This looks for an enclosing column format, extracts the operator and
16288 then applies it to the proerty in the column format's scope."
16289 (interactive)
16290 (unless (org-at-property-p)
16291 (error "Not at a property"))
16292 (let ((prop (org-match-string-no-properties 2)))
16293 (org-columns-get-format-and-top-level)
16294 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16295 (error "No operator defined for property %s" prop))
16296 (org-columns-compute prop)))
16298 (defun org-property-get-allowed-values (pom property &optional table)
16299 "Get allowed values for the property PROPERTY.
16300 When TABLE is non-nil, return an alist that can directly be used for
16301 completion."
16302 (let (vals)
16303 (cond
16304 ((equal property "TODO")
16305 (setq vals (org-with-point-at pom
16306 (append org-todo-keywords-1 '("")))))
16307 ((equal property "PRIORITY")
16308 (let ((n org-lowest-priority))
16309 (while (>= n org-highest-priority)
16310 (push (char-to-string n) vals)
16311 (setq n (1- n)))))
16312 ((member property org-special-properties))
16313 (t
16314 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16317 (setq vals (car (read-from-string (concat "(" vals ")"))))
16318 (setq vals (mapcar (lambda (x)
16319 (cond ((stringp x) x)
16320 ((numberp x) (number-to-string x))
16321 ((symbolp x) (symbol-name x))
16322 (t "???")))
16323 vals)))))
16324 (if table (mapcar 'list vals) vals)))
16326 (defun org-property-previous-allowed-value (&optional previous)
16327 "Switch to the next allowed value for this property."
16328 (interactive)
16329 (org-property-next-allowed-value t))
16331 (defun org-property-next-allowed-value (&optional previous)
16332 "Switch to the next allowed value for this property."
16333 (interactive)
16334 (unless (org-at-property-p)
16335 (error "Not at a property"))
16336 (let* ((key (match-string 2))
16337 (value (match-string 3))
16338 (allowed (or (org-property-get-allowed-values (point) key)
16339 (and (member value '("[ ]" "[-]" "[X]"))
16340 '("[ ]" "[X]"))))
16341 nval)
16342 (unless allowed
16343 (error "Allowed values for this property have not been defined"))
16344 (if previous (setq allowed (reverse allowed)))
16345 (if (member value allowed)
16346 (setq nval (car (cdr (member value allowed)))))
16347 (setq nval (or nval (car allowed)))
16348 (if (equal nval value)
16349 (error "Only one allowed value for this property"))
16350 (org-at-property-p)
16351 (replace-match (concat " :" key ": " nval) t t)
16352 (org-indent-line-function)
16353 (beginning-of-line 1)
16356 (defun org-find-entry-with-id (ident)
16357 "Locate the entry that contains the ID property with exact value IDENT.
16358 IDENT can be a string, a symbol or a number, this function will search for
16359 the string representation of it.
16360 Return the position where this entry starts, or nil if there is no such entry."
16361 (let ((id (cond
16362 ((stringp ident) ident)
16363 ((symbol-name ident) (symbol-name ident))
16364 ((numberp ident) (number-to-string ident))
16365 (t (error "IDENT %s must be a string, symbol or number" ident))))
16366 (case-fold-search nil))
16367 (save-excursion
16368 (save-restriction
16369 (widen)
16370 (goto-char (point-min))
16371 (when (re-search-forward
16373 nil t)
16374 (org-back-to-heading)
16375 (point))))))
16377 ;;; Column View
16379 (defvar org-columns-overlays nil
16380 "Holds the list of current column overlays.")
16382 (defvar org-columns-current-fmt nil
16383 "Local variable, holds the currently active column format.")
16384 (defvar org-columns-current-fmt-compiled nil
16385 "Local variable, holds the currently active column format.
16386 This is the compiled version of the format.")
16387 (defvar org-columns-current-widths nil
16388 "Loval variable, holds the currently widths of fields.")
16389 (defvar org-columns-current-maxwidths nil
16390 "Loval variable, holds the currently active maximum column widths.")
16391 (defvar org-columns-begin-marker (make-marker)
16392 "Points to the position where last a column creation command was called.")
16393 (defvar org-columns-top-level-marker (make-marker)
16394 "Points to the position where current columns region starts.")
16396 (defvar org-columns-map (make-sparse-keymap)
16397 "The keymap valid in column display.")
16399 (defun org-columns-content ()
16400 "Switch to contents view while in columns view."
16401 (interactive)
16402 (org-overview)
16403 (org-content))
16405 (org-defkey org-columns-map "c" 'org-columns-content)
16406 (org-defkey org-columns-map "o" 'org-overview)
16407 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16408 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16409 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16410 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16411 (org-defkey org-columns-map "v" 'org-columns-show-value)
16412 (org-defkey org-columns-map "q" 'org-columns-quit)
16413 (org-defkey org-columns-map "r" 'org-columns-redo)
16414 (org-defkey org-columns-map "g" 'org-columns-redo)
16415 (org-defkey org-columns-map [left] 'backward-char)
16416 (org-defkey org-columns-map "\M-b" 'backward-char)
16417 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16418 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16419 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16420 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16421 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16422 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16423 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16424 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16425 (org-defkey org-columns-map "<" 'org-columns-narrow)
16426 (org-defkey org-columns-map ">" 'org-columns-widen)
16427 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16428 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16429 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16430 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16432 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16433 '("Column"
16434 ["Edit property" org-columns-edit-value t]
16435 ["Next allowed value" org-columns-next-allowed-value t]
16436 ["Previous allowed value" org-columns-previous-allowed-value t]
16437 ["Show full value" org-columns-show-value t]
16438 ["Edit allowed values" org-columns-edit-allowed t]
16439 "--"
16440 ["Edit column attributes" org-columns-edit-attributes t]
16441 ["Increase column width" org-columns-widen t]
16442 ["Decrease column width" org-columns-narrow t]
16443 "--"
16444 ["Move column right" org-columns-move-right t]
16445 ["Move column left" org-columns-move-left t]
16446 ["Add column" org-columns-new t]
16447 ["Delete column" org-columns-delete t]
16448 "--"
16449 ["CONTENTS" org-columns-content t]
16450 ["OVERVIEW" org-overview t]
16451 ["Refresh columns display" org-columns-redo t]
16452 "--"
16453 ["Open link" org-columns-open-link t]
16454 "--"
16455 ["Quit" org-columns-quit t]))
16457 (defun org-columns-new-overlay (beg end &optional string face)
16458 "Create a new column overlay and add it to the list."
16459 (let ((ov (org-make-overlay beg end)))
16460 (org-overlay-put ov 'face (or face 'secondary-selection))
16461 (org-overlay-display ov string face)
16462 (push ov org-columns-overlays)
16463 ov))
16465 (defun org-columns-display-here (&optional props)
16466 "Overlay the current line with column display."
16467 (interactive)
16468 (let* ((fmt org-columns-current-fmt-compiled)
16469 (beg (point-at-bol))
16470 (level-face (save-excursion
16471 (beginning-of-line 1)
16473 (org-get-level-face 2))))
16474 (color (list :foreground
16475 (face-attribute (or level-face 'default) :foreground)))
16476 props pom property ass width f string ov column val modval)
16477 ;; Check if the entry is in another buffer.
16478 (unless props
16479 (if (eq major-mode 'org-agenda-mode)
16480 (setq pom (or (get-text-property (point) 'org-hd-marker)
16481 (get-text-property (point) 'org-marker))
16482 props (if pom (org-entry-properties pom) nil))
16483 (setq props (org-entry-properties nil))))
16484 ;; Walk the format
16485 (while (setq column (pop fmt))
16486 (setq property (car column)
16487 ass (if (equal property "ITEM")
16488 (cons "ITEM"
16489 (save-match-data
16490 (org-no-properties
16491 (org-remove-tabs
16492 (buffer-substring-no-properties
16493 (point-at-bol) (point-at-eol))))))
16494 (assoc property props))
16495 width (or (cdr (assoc property org-columns-current-maxwidths))
16496 (nth 2 column)
16497 (length property))
16498 f (format "%%-%d.%ds | " width width)
16499 val (or (cdr ass) "")
16500 modval (if (equal property "ITEM")
16501 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16502 string (format f (or modval val)))
16503 ;; Create the overlay
16504 (org-unmodified
16505 (setq ov (org-columns-new-overlay
16506 beg (setq beg (1+ beg)) string
16507 (list color 'org-column)))
16508 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16509 (org-overlay-put ov 'keymap org-columns-map)
16510 (org-overlay-put ov 'org-columns-key property)
16511 (org-overlay-put ov 'org-columns-value (cdr ass))
16512 (org-overlay-put ov 'org-columns-value-modified modval)
16513 (org-overlay-put ov 'org-columns-pom pom)
16514 (org-overlay-put ov 'org-columns-format f))
16515 (if (or (not (char-after beg))
16517 (let ((inhibit-read-only t))
16518 (save-excursion
16519 (goto-char beg)
16520 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16521 ;; Make the rest of the line disappear.
16522 (org-unmodified
16523 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16524 (org-overlay-put ov 'invisible t)
16525 (org-overlay-put ov 'keymap org-columns-map)
16526 (org-overlay-put ov 'intangible t)
16527 (push ov org-columns-overlays)
16528 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16529 (org-overlay-put ov 'keymap org-columns-map)
16530 (push ov org-columns-overlays)
16531 (let ((inhibit-read-only t))
16532 (put-text-property (max (point-min) (1- (point-at-bol)))
16533 (min (point-max) (1+ (point-at-eol)))
16534 'read-only "Type `e' to edit property")))))
16536 (defvar org-previous-header-line-format nil
16537 "The header line format before column view was turned on.")
16538 (defvar org-columns-inhibit-recalculation nil
16539 "Inhibit recomputing of columns on column view startup.")
16542 (defvar header-line-format)
16543 (defun org-columns-display-here-title ()
16544 "Overlay the newline before the current line with the table title."
16545 (interactive)
16546 (let ((fmt org-columns-current-fmt-compiled)
16547 string (title "")
16548 property width f column str widths)
16549 (while (setq column (pop fmt))
16550 (setq property (car column)
16551 str (or (nth 1 column) property)
16552 width (or (cdr (assoc property org-columns-current-maxwidths))
16553 (nth 2 column)
16554 (length str))
16555 widths (push width widths)
16556 f (format "%%-%d.%ds | " width width)
16557 string (format f str)
16558 title (concat title string)))
16559 (setq title (concat
16560 (org-add-props " " nil 'display '(space :align-to 0))
16561 (org-add-props title nil 'face '(:weight bold :underline t))))
16562 (org-set-local 'org-previous-header-line-format header-line-format)
16563 (org-set-local 'org-columns-current-widths (nreverse widths))
16564 (setq header-line-format title)))
16566 (defun org-columns-remove-overlays ()
16567 "Remove all currently active column overlays."
16568 (interactive)
16569 (when (marker-buffer org-columns-begin-marker)
16570 (with-current-buffer (marker-buffer org-columns-begin-marker)
16571 (when (local-variable-p 'org-previous-header-line-format)
16572 (setq header-line-format org-previous-header-line-format)
16573 (kill-local-variable 'org-previous-header-line-format))
16574 (move-marker org-columns-begin-marker nil)
16575 (move-marker org-columns-top-level-marker nil)
16576 (org-unmodified
16577 (mapc 'org-delete-overlay org-columns-overlays)
16578 (setq org-columns-overlays nil)
16579 (let ((inhibit-read-only t))
16580 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16582 (defun org-columns-cleanup-item (item fmt)
16583 "Remove from ITEM what is a column in the format FMT."
16584 (if (not org-complex-heading-regexp)
16585 item
16586 (when (string-match org-complex-heading-regexp item)
16587 (concat
16588 (org-add-props (concat (match-string 1 item) " ") nil
16589 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16590 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16591 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16592 " " (match-string 4 item)
16593 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16595 (defun org-columns-show-value ()
16596 "Show the full value of the property."
16597 (interactive)
16598 (let ((value (get-char-property (point) 'org-columns-value)))
16599 (message "Value is: %s" (or value ""))))
16601 (defun org-columns-quit ()
16602 "Remove the column overlays and in this way exit column editing."
16603 (interactive)
16604 (org-unmodified
16605 (org-columns-remove-overlays)
16606 (let ((inhibit-read-only t))
16607 (remove-text-properties (point-min) (point-max) '(read-only t))))
16608 (when (eq major-mode 'org-agenda-mode)
16609 (message
16610 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16612 (defun org-columns-check-computed ()
16613 "Check if this column value is computed.
16614 If yes, throw an error indicating that changing it does not make sense."
16615 (let ((val (get-char-property (point) 'org-columns-value)))
16616 (when (and (stringp val)
16617 (get-char-property 0 'org-computed val))
16618 (error "This value is computed from the entry's children"))))
16620 (defun org-columns-todo (&optional arg)
16621 "Change the TODO state during column view."
16622 (interactive "P")
16623 (org-columns-edit-value "TODO"))
16625 (defun org-columns-set-tags-or-toggle (&optional arg)
16626 "Toggle checkbox at point, or set tags for current headline."
16627 (interactive "P")
16629 (get-char-property (point) 'org-columns-value))
16630 (org-columns-next-allowed-value)
16631 (org-columns-edit-value "TAGS")))
16633 (defun org-columns-edit-value (&optional key)
16634 "Edit the value of the property at point in column view.
16635 Where possible, use the standard interface for changing this line."
16636 (interactive)
16637 (org-columns-check-computed)
16638 (let* ((external-key key)
16639 (col (current-column))
16640 (key (or key (get-char-property (point) 'org-columns-key)))
16641 (value (get-char-property (point) 'org-columns-value))
16642 (bol (point-at-bol)) (eol (point-at-eol))
16643 (pom (or (get-text-property bol 'org-hd-marker)
16644 (point))) ; keep despite of compiler waring
16645 (line-overlays
16646 (delq nil (mapcar (lambda (x)
16647 (and (eq (overlay-buffer x) (current-buffer))
16648 (>= (overlay-start x) bol)
16649 (<= (overlay-start x) eol)
16650 x))
16651 org-columns-overlays)))
16652 nval eval allowed)
16653 (cond
16654 ((equal key "CLOCKSUM")
16655 (error "This special column cannot be edited"))
16656 ((equal key "ITEM")
16657 (setq eval '(org-with-point-at pom
16658 (org-edit-headline))))
16659 ((equal key "TODO")
16660 (setq eval '(org-with-point-at pom
16661 (let ((current-prefix-arg
16662 (if external-key current-prefix-arg '(4))))
16663 (call-interactively 'org-todo)))))
16664 ((equal key "PRIORITY")
16665 (setq eval '(org-with-point-at pom
16666 (call-interactively 'org-priority))))
16667 ((equal key "TAGS")
16668 (setq eval '(org-with-point-at pom
16669 (let ((org-fast-tag-selection-single-key
16670 (if (eq org-fast-tag-selection-single-key 'expert)
16671 t org-fast-tag-selection-single-key)))
16672 (call-interactively 'org-set-tags)))))
16673 ((equal key "DEADLINE")
16674 (setq eval '(org-with-point-at pom
16675 (call-interactively 'org-deadline))))
16676 ((equal key "SCHEDULED")
16677 (setq eval '(org-with-point-at pom
16678 (call-interactively 'org-schedule))))
16679 (t
16680 (setq allowed (org-property-get-allowed-values pom key 'table))
16681 (if allowed
16682 (setq nval (completing-read "Value: " allowed nil t))
16683 (setq nval (read-string "Edit: " value)))
16684 (setq nval (org-trim nval))
16685 (when (not (equal nval value))
16686 (setq eval '(org-entry-put pom key nval)))))
16687 (when eval
16688 (let ((inhibit-read-only t))
16689 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16690 (unwind-protect
16691 (progn
16692 (setq org-columns-overlays
16693 (org-delete-all line-overlays org-columns-overlays))
16694 (mapc 'org-delete-overlay line-overlays)
16695 (org-columns-eval eval))
16696 (org-columns-display-here))))
16697 (move-to-column col)
16698 (if (and (org-mode-p)
16699 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16700 (org-columns-update key))))
16702 (defun org-edit-headline () ; FIXME: this is not columns specific
16703 "Edit the current headline, the part without TODO keyword, TAGS."
16704 (org-back-to-heading)
16705 (when (looking-at org-todo-line-regexp)
16706 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16707 (txt (match-string 3))
16708 (post "")
16709 txt2)
16711 (setq post (match-string 0 txt)
16712 txt (substring txt 0 (match-beginning 0))))
16713 (setq txt2 (read-string "Edit: " txt))
16714 (when (not (equal txt txt2))
16715 (beginning-of-line 1)
16716 (insert pre txt2 post)
16717 (delete-region (point) (point-at-eol))
16718 (org-set-tags nil t)))))
16720 (defun org-columns-edit-allowed ()
16721 "Edit the list of allowed values for the current property."
16722 (interactive)
16723 (let* ((key (get-char-property (point) 'org-columns-key))
16724 (key1 (concat key "_ALL"))
16725 (allowed (org-entry-get (point) key1 t))
16726 nval)
16727 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16728 (setq nval (read-string "Allowed: " allowed))
16729 (org-entry-put
16730 (cond ((marker-position org-entry-property-inherited-from)
16731 org-entry-property-inherited-from)
16732 ((marker-position org-columns-top-level-marker)
16733 org-columns-top-level-marker))
16734 key1 nval)))
16736 (defmacro org-no-warnings (&rest body)
16737 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16739 (defun org-columns-eval (form)
16740 (let (hidep)
16741 (save-excursion
16742 (beginning-of-line 1)
16743 ;; `next-line' is needed here, because it skips invisible line.
16744 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16745 (setq hidep (org-on-heading-p 1)))
16746 (eval form)
16747 (and hidep (hide-entry))))
16749 (defun org-columns-previous-allowed-value ()
16750 "Switch to the previous allowed value for this column."
16751 (interactive)
16752 (org-columns-next-allowed-value t))
16754 (defun org-columns-next-allowed-value (&optional previous)
16755 "Switch to the next allowed value for this column."
16756 (interactive)
16757 (org-columns-check-computed)
16758 (let* ((col (current-column))
16759 (key (get-char-property (point) 'org-columns-key))
16760 (value (get-char-property (point) 'org-columns-value))
16761 (bol (point-at-bol)) (eol (point-at-eol))
16762 (pom (or (get-text-property bol 'org-hd-marker)
16763 (point))) ; keep despite of compiler waring
16764 (line-overlays
16765 (delq nil (mapcar (lambda (x)
16766 (and (eq (overlay-buffer x) (current-buffer))
16767 (>= (overlay-start x) bol)
16768 (<= (overlay-start x) eol)
16769 x))
16770 org-columns-overlays)))
16771 (allowed (or (org-property-get-allowed-values pom key)
16772 (and (memq
16773 (nth 4 (assoc key org-columns-current-fmt-compiled))
16774 '(checkbox checkbox-n-of-m checkbox-percent))
16775 '("[ ]" "[X]"))))
16776 nval)
16777 (when (equal key "ITEM")
16778 (error "Cannot edit item headline from here"))
16779 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16780 (error "Allowed values for this property have not been defined"))
16781 (if (member key '("SCHEDULED" "DEADLINE"))
16782 (setq nval (if previous 'earlier 'later))
16783 (if previous (setq allowed (reverse allowed)))
16784 (if (member value allowed)
16785 (setq nval (car (cdr (member value allowed)))))
16786 (setq nval (or nval (car allowed)))
16787 (if (equal nval value)
16788 (error "Only one allowed value for this property")))
16789 (let ((inhibit-read-only t))
16790 (remove-text-properties (1- bol) eol '(read-only t))
16791 (unwind-protect
16792 (progn
16793 (setq org-columns-overlays
16794 (org-delete-all line-overlays org-columns-overlays))
16795 (mapc 'org-delete-overlay line-overlays)
16796 (org-columns-eval '(org-entry-put pom key nval)))
16797 (org-columns-display-here)))
16798 (move-to-column col)
16799 (if (and (org-mode-p)
16800 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16801 (org-columns-update key))))
16803 (defun org-verify-version (task)
16804 (cond
16805 ((eq task 'columns)
16806 (if (or (featurep 'xemacs)
16807 (< emacs-major-version 22))
16808 (error "Emacs 22 is required for the columns feature")))))
16810 (defun org-columns-open-link (&optional arg)
16811 (interactive "P")
16812 (let ((value (get-char-property (point) 'org-columns-value)))
16813 (org-open-link-from-string value arg)))
16815 (defun org-open-link-from-string (s &optional arg)
16816 "Open a link in the string S, as if it was in Org-mode."
16817 (interactive)
16818 (with-temp-buffer
16819 (let ((org-inhibit-startup t))
16820 (org-mode)
16821 (insert s)
16822 (goto-char (point-min))
16823 (org-open-at-point arg))))
16825 (defun org-columns-get-format-and-top-level ()
16826 (let (fmt)
16827 (when (condition-case nil (org-back-to-heading) (error nil))
16828 (move-marker org-entry-property-inherited-from nil)
16829 (setq fmt (org-entry-get nil "COLUMNS" t)))
16830 (setq fmt (or fmt org-columns-default-format))
16831 (org-set-local 'org-columns-current-fmt fmt)
16832 (org-columns-compile-format fmt)
16833 (if (marker-position org-entry-property-inherited-from)
16834 (move-marker org-columns-top-level-marker
16835 org-entry-property-inherited-from)
16836 (move-marker org-columns-top-level-marker (point)))
16837 fmt))
16839 (defun org-columns ()
16840 "Turn on column view on an org-mode file."
16841 (interactive)
16842 (org-verify-version 'columns)
16843 (org-columns-remove-overlays)
16844 (move-marker org-columns-begin-marker (point))
16845 (let (beg end fmt cache maxwidths)
16846 (setq fmt (org-columns-get-format-and-top-level))
16847 (save-excursion
16848 (goto-char org-columns-top-level-marker)
16849 (setq beg (point))
16850 (unless org-columns-inhibit-recalculation
16851 (org-columns-compute-all))
16852 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16853 (point-max)))
16854 ;; Get and cache the properties
16855 (goto-char beg)
16856 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16857 (save-excursion
16858 (save-restriction
16859 (narrow-to-region beg end)
16860 (org-clock-sum))))
16861 (while (re-search-forward (concat "^" outline-regexp) end t)
16862 (push (cons (org-current-line) (org-entry-properties)) cache))
16863 (when cache
16864 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16865 (org-set-local 'org-columns-current-maxwidths maxwidths)
16866 (org-columns-display-here-title)
16867 (mapc (lambda (x)
16868 (goto-line (car x))
16869 (org-columns-display-here (cdr x)))
16870 cache)))))
16872 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16873 "Insert a new column, to the left of the current column."
16874 (interactive)
16875 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16876 cell)
16877 (setq prop (completing-read
16878 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
16879 nil nil prop))
16880 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16881 (setq width (read-string "Column width: " (if width (number-to-string width))))
16883 (setq width (string-to-number width))
16884 (setq width nil))
16885 (setq fmt (completing-read "Summary [none]: "
16886 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
16887 nil t))
16889 (setq fmt (intern fmt))
16890 (setq fmt nil))
16891 (if (eq fmt 'none) (setq fmt nil))
16892 (if editp
16893 (progn
16894 (setcar editp prop)
16895 (setcdr editp (list title width nil fmt)))
16896 (setq cell (nthcdr (1- (current-column))
16897 org-columns-current-fmt-compiled))
16898 (setcdr cell (cons (list prop title width nil fmt)
16899 (cdr cell))))
16900 (org-columns-store-format)
16901 (org-columns-redo)))
16903 (defun org-columns-delete ()
16904 "Delete the column at point from columns view."
16905 (interactive)
16906 (let* ((n (current-column))
16907 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16908 (when (y-or-n-p
16910 (setq org-columns-current-fmt-compiled
16911 (delq (nth n org-columns-current-fmt-compiled)
16912 org-columns-current-fmt-compiled))
16913 (org-columns-store-format)
16914 (org-columns-redo)
16915 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16916 (backward-char 1)))))
16918 (defun org-columns-edit-attributes ()
16919 "Edit the attributes of the current column."
16920 (interactive)
16921 (let* ((n (current-column))
16922 (info (nth n org-columns-current-fmt-compiled)))
16923 (apply 'org-columns-new info)))
16925 (defun org-columns-widen (arg)
16926 "Make the column wider by ARG characters."
16927 (interactive "p")
16928 (let* ((n (current-column))
16929 (entry (nth n org-columns-current-fmt-compiled))
16930 (width (or (nth 2 entry)
16931 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16932 (setq width (max 1 (+ width arg)))
16933 (setcar (nthcdr 2 entry) width)
16934 (org-columns-store-format)
16935 (org-columns-redo)))
16937 (defun org-columns-narrow (arg)
16938 "Make the column nrrower by ARG characters."
16939 (interactive "p")
16940 (org-columns-widen (- arg)))
16942 (defun org-columns-move-right ()
16943 "Swap this column with the one to the right."
16944 (interactive)
16945 (let* ((n (current-column))
16946 (cell (nthcdr n org-columns-current-fmt-compiled))
16947 e)
16948 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16949 (error "Cannot shift this column further to the right"))
16950 (setq e (car cell))
16951 (setcar cell (car (cdr cell)))
16952 (setcdr cell (cons e (cdr (cdr cell))))
16953 (org-columns-store-format)
16954 (org-columns-redo)
16955 (forward-char 1)))
16957 (defun org-columns-move-left ()
16958 "Swap this column with the one to the left."
16959 (interactive)
16960 (let* ((n (current-column)))
16961 (when (= n 0)
16962 (error "Cannot shift this column further to the left"))
16963 (backward-char 1)
16964 (org-columns-move-right)
16965 (backward-char 1)))
16967 (defun org-columns-store-format ()
16968 "Store the text version of the current columns format in appropriate place.
16969 This is either in the COLUMNS property of the node starting the current column
16970 display, or in the #+COLUMNS line of the current buffer."
16971 (let (fmt (cnt 0))
16972 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16973 (org-set-local 'org-columns-current-fmt fmt)
16974 (if (marker-position org-columns-top-level-marker)
16975 (save-excursion
16976 (goto-char org-columns-top-level-marker)
16977 (if (and (org-at-heading-p)
16978 (org-entry-get nil "COLUMNS"))
16979 (org-entry-put nil "COLUMNS" fmt)
16980 (goto-char (point-min))
16981 ;; Overwrite all #+COLUMNS lines....
16983 (setq cnt (1+ cnt))
16984 (replace-match (concat "#+COLUMNS: " fmt) t t))
16985 (unless (> cnt 0)
16986 (goto-char (point-min))
16987 (or (org-on-heading-p t) (outline-next-heading))
16988 (let ((inhibit-read-only t))
16990 (org-set-local 'org-columns-default-format fmt))))))
16992 (defvar org-overriding-columns-format nil
16993 "When set, overrides any other definition.")
16994 (defvar org-agenda-view-columns-initially nil
16995 "When set, switch to columns view immediately after creating the agenda.")
16997 (defun org-agenda-columns ()
16998 "Turn on column view in the agenda."
16999 (interactive)
17000 (org-verify-version 'columns)
17001 (org-columns-remove-overlays)
17002 (move-marker org-columns-begin-marker (point))
17003 (let (fmt cache maxwidths m)
17004 (cond
17005 ((and (local-variable-p 'org-overriding-columns-format)
17006 org-overriding-columns-format)
17007 (setq fmt org-overriding-columns-format))
17008 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17009 (setq fmt (org-entry-get m "COLUMNS" t)))
17010 ((and (boundp 'org-columns-current-fmt)
17011 (local-variable-p 'org-columns-current-fmt)
17012 org-columns-current-fmt)
17013 (setq fmt org-columns-current-fmt))
17014 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17015 (setq m (get-text-property m 'org-hd-marker))
17016 (setq fmt (org-entry-get m "COLUMNS" t))))
17017 (setq fmt (or fmt org-columns-default-format))
17018 (org-set-local 'org-columns-current-fmt fmt)
17019 (org-columns-compile-format fmt)
17020 (save-excursion
17021 ;; Get and cache the properties
17022 (goto-char (point-min))
17023 (while (not (eobp))
17024 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17025 (get-text-property (point) 'org-marker)))
17026 (push (cons (org-current-line) (org-entry-properties m)) cache))
17027 (beginning-of-line 2))
17028 (when cache
17029 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17030 (org-set-local 'org-columns-current-maxwidths maxwidths)
17031 (org-columns-display-here-title)
17032 (mapc (lambda (x)
17033 (goto-line (car x))
17034 (org-columns-display-here (cdr x)))
17035 cache)))))
17037 (defun org-columns-get-autowidth-alist (s cache)
17038 "Derive the maximum column widths from the format and the cache."
17039 (let ((start 0) rtn)
17041 (push (cons (match-string 1 s) 1) rtn)
17042 (setq start (match-end 0)))
17043 (mapc (lambda (x)
17044 (setcdr x (apply 'max
17045 (mapcar
17046 (lambda (y)
17047 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17048 cache))))
17049 rtn)
17050 rtn))
17052 (defun org-columns-compute-all ()
17053 "Compute all columns that have operators defined."
17054 (org-unmodified
17055 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17056 (let ((columns org-columns-current-fmt-compiled) col)
17057 (while (setq col (pop columns))
17058 (when (nth 3 col)
17059 (save-excursion
17060 (org-columns-compute (car col)))))))
17062 (defun org-columns-update (property)
17063 "Recompute PROPERTY, and update the columns display for it."
17064 (org-columns-compute property)
17065 (let (fmt val pos)
17066 (save-excursion
17067 (mapc (lambda (ov)
17068 (when (equal (org-overlay-get ov 'org-columns-key) property)
17069 (setq pos (org-overlay-start ov))
17070 (goto-char pos)
17071 (when (setq val (cdr (assoc property
17072 (get-text-property
17073 (point-at-bol) 'org-summaries))))
17074 (setq fmt (org-overlay-get ov 'org-columns-format))
17075 (org-overlay-put ov 'org-columns-value val)
17076 (org-overlay-put ov 'display (format fmt val)))))
17077 org-columns-overlays))))
17079 (defun org-columns-compute (property)
17080 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17081 (interactive)
17082 (let* ((re (concat "^" outline-regexp))
17083 (lmax 30) ; Does anyone use deeper levels???
17084 (lsum (make-vector lmax 0))
17085 (lflag (make-vector lmax nil))
17086 (level 0)
17087 (ass (assoc property org-columns-current-fmt-compiled))
17088 (format (nth 4 ass))
17089 (printf (nth 5 ass))
17090 (beg org-columns-top-level-marker)
17091 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17092 (save-excursion
17093 ;; Find the region to compute
17094 (goto-char beg)
17095 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17096 (goto-char end)
17097 ;; Walk the tree from the back and do the computations
17098 (while (re-search-backward re beg t)
17099 (setq sumpos (match-beginning 0)
17100 last-level level
17101 level (org-outline-level)
17102 val (org-entry-get nil property)
17104 (cond
17105 ((< level last-level)
17106 ;; put the sum of lower levels here as a property
17107 (setq sum (aref lsum last-level) ; current sum
17108 flag (aref lflag last-level) ; any valid entries from children?
17109 str (org-column-number-to-string sum format printf)
17110 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17111 useval (if flag str1 (if valflag val ""))
17112 sum-alist (get-text-property sumpos 'org-summaries))
17113 (if (assoc property sum-alist)
17114 (setcdr (assoc property sum-alist) useval)
17115 (push (cons property useval) sum-alist)
17116 (org-unmodified
17117 (add-text-properties sumpos (1+ sumpos)
17118 (list 'org-summaries sum-alist))))
17119 (when val
17120 (org-entry-put nil property (if flag str val)))
17121 ;; add current to current level accumulator
17122 (when (or flag valflag)
17123 (aset lsum level (+ (aref lsum level)
17124 (if flag sum (org-column-string-to-number
17125 (if flag str val) format))))
17126 (aset lflag level t))
17127 ;; clear accumulators for deeper levels
17128 (loop for l from (1+ level) to (1- lmax) do
17129 (aset lsum l 0)
17130 (aset lflag l nil)))
17131 ((>= level last-level)
17132 ;; add what we have here to the accumulator for this level
17133 (aset lsum level (+ (aref lsum level)
17134 (org-column-string-to-number (or val "0") format)))
17135 (and valflag (aset lflag level t)))
17136 (t (error "This should not happen")))))))
17138 (defun org-columns-redo ()
17139 "Construct the column display again."
17140 (interactive)
17141 (message "Recomputing columns...")
17142 (save-excursion
17143 (if (marker-position org-columns-begin-marker)
17144 (goto-char org-columns-begin-marker))
17145 (org-columns-remove-overlays)
17146 (if (org-mode-p)
17147 (call-interactively 'org-columns)
17148 (call-interactively 'org-agenda-columns)))
17149 (message "Recomputing columns...done"))
17151 (defun org-columns-not-in-agenda ()
17152 (if (eq major-mode 'org-agenda-mode)
17153 (error "This command is only allowed in Org-mode buffers")))
17156 (defun org-string-to-number (s)
17157 "Convert string to number, and interpret hh:mm:ss."
17158 (if (not (string-match ":" s))
17159 (string-to-number s)
17160 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17161 (while l
17162 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17163 sum)))
17165 (defun org-column-number-to-string (n fmt &optional printf)
17166 "Convert a computed column number to a string value, according to FMT."
17167 (cond
17168 ((eq fmt 'add_times)
17169 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17170 (format "%d:%02d" h m)))
17171 ((eq fmt 'checkbox)
17172 (cond ((= n (floor n)) "[X]")
17173 ((> n 1.) "[-]")
17174 (t "[ ]")))
17175 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17176 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17177 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17178 (printf (format printf n))
17179 ((eq fmt 'currency)
17180 (format "%.2f" n))
17181 (t (number-to-string n))))
17183 (defun org-nofm-to-completion (n m &optional percent)
17184 (if (not percent)
17185 (format "[%d/%d]" n m)
17186 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17188 (defun org-column-string-to-number (s fmt)
17189 "Convert a column value to a number that can be used for column computing."
17190 (cond
17191 ((string-match ":" s)
17192 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17193 (while l
17194 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17195 sum))
17196 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17197 (if (equal s "[X]") 1. 0.000001))
17198 (t (string-to-number s))))
17200 (defun org-columns-uncompile-format (cfmt)
17201 "Turn the compiled columns format back into a string representation."
17202 (let ((rtn "") e s prop title op width fmt printf)
17203 (while (setq e (pop cfmt))
17204 (setq prop (car e)
17205 title (nth 1 e)
17206 width (nth 2 e)
17207 op (nth 3 e)
17208 fmt (nth 4 e)
17209 printf (nth 5 e))
17210 (cond
17211 ((eq fmt 'add_times) (setq op ":"))
17212 ((eq fmt 'checkbox) (setq op "X"))
17213 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17214 ((eq fmt 'checkbox-percent) (setq op "X%"))
17215 ((eq fmt 'add_numbers) (setq op "+"))
17216 ((eq fmt 'currency) (setq op "$")))
17217 (if (and op printf) (setq op (concat op ";" printf)))
17218 (if (equal title prop) (setq title nil))
17219 (setq s (concat "%" (if width (number-to-string width))
17220 prop
17221 (if title (concat "(" title ")"))
17222 (if op (concat "{" op "}"))))
17223 (setq rtn (concat rtn " " s)))
17224 (org-trim rtn)))
17226 (defun org-columns-compile-format (fmt)
17227 "Turn a column format string into an alist of specifications.
17228 The alist has one entry for each column in the format. The elements of
17229 that list are:
17230 property the property
17231 title the title field for the columns
17232 width the column width in characters, can be nil for automatic
17233 operator the operator if any
17234 format the output format for computed results, derived from operator
17235 printf a printf format for computed values"
17236 (let ((start 0) width prop title op f printf)
17237 (setq org-columns-current-fmt-compiled nil)
17238 (while (string-match
17239 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17240 fmt start)
17241 (setq start (match-end 0)
17242 width (match-string 1 fmt)
17243 prop (match-string 2 fmt)
17244 title (or (match-string 3 fmt) prop)
17245 op (match-string 4 fmt)
17246 f nil
17247 printf nil)
17248 (if width (setq width (string-to-number width)))
17249 (when (and op (string-match ";" op))
17250 (setq printf (substring op (match-end 0))
17251 op (substring op 0 (match-beginning 0))))
17252 (cond
17253 ((equal op "+") (setq f 'add_numbers))
17254 ((equal op "$") (setq f 'currency))
17255 ((equal op ":") (setq f 'add_times))
17256 ((equal op "X") (setq f 'checkbox))
17257 ((equal op "X/") (setq f 'checkbox-n-of-m))
17258 ((equal op "X%") (setq f 'checkbox-percent))
17259 )
17260 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17261 (setq org-columns-current-fmt-compiled
17262 (nreverse org-columns-current-fmt-compiled))))
17265 ;;; Dynamic block for Column view
17267 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
17268 "Get the column view of the current buffer or subtree.
17269 The first optional argument MAXLEVEL sets the level limit. A
17270 second optional argument SKIP-EMPTY-ROWS tells whether to skip
17271 empty rows, an empty row being one where all the column view
17272 specifiers except ITEM are empty. This function returns a list
17273 containing the title row and all other rows. Each row is a list
17274 of fields."
17275 (save-excursion
17276 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17277 (n (length title)) row tbl)
17278 (goto-char (point-min))
17280 (or (null maxlevel)
17281 (>= maxlevel
17282 (if org-odd-levels-only
17283 (/ (1+ (length (match-string 1))) 2)
17284 (length (match-string 1))))))
17285 (when (get-char-property (match-beginning 0) 'org-columns-key)
17286 (setq row nil)
17287 (loop for i from 0 to (1- n) do
17288 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17289 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17290 "")
17291 row))
17292 (setq row (nreverse row))
17293 (unless (and skip-empty-rows
17294 (eq 1 (length (delete "" (delete-dups row)))))
17295 (push row tbl))))
17296 (append (list title 'hline) (nreverse tbl)))))
17298 (defun org-dblock-write:columnview (params)
17299 "Write the column view table.
17300 PARAMS is a property list of parameters:
17302 :width enforce same column widths with <N> specifiers.
17303 :id the :ID: property of the entry where the columns view
17304 should be built, as a string. When `local', call locally.
17305 When `global' call column view with the cursor at the beginning
17306 of the buffer (usually this means that the whole buffer switches
17307 to column view).
17308 :hlines When t, insert a hline before each item. When a number, insert
17309 a hline before each level <= that number.
17310 :vlines When t, make each column a colgroup to enforce vertical lines.
17311 :maxlevel When set to a number, don't capture headlines below this level.
17312 :skip-empty-rows
17313 When t, skip rows where all specifiers other than ITEM are empty."
17314 (let ((pos (move-marker (make-marker) (point)))
17315 (hlines (plist-get params :hlines))
17316 (vlines (plist-get params :vlines))
17317 (maxlevel (plist-get params :maxlevel))
17318 (skip-empty-rows (plist-get params :skip-empty-rows))
17319 tbl id idpos nfields tmp)
17320 (save-excursion
17321 (save-restriction
17322 (when (setq id (plist-get params :id))
17323 (cond ((not id) nil)
17324 ((eq id 'global) (goto-char (point-min)))
17325 ((eq id 'local) nil)
17326 ((setq idpos (org-find-entry-with-id id))
17327 (goto-char idpos))
17328 (t (error "Cannot find entry with :ID: %s" id))))
17329 (org-columns)
17330 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
17331 (setq nfields (length (car tbl)))
17332 (org-columns-quit)))
17333 (goto-char pos)
17334 (move-marker pos nil)
17335 (when tbl
17336 (when (plist-get params :hlines)
17337 (setq tmp nil)
17338 (while tbl
17339 (if (eq (car tbl) 'hline)
17340 (push (pop tbl) tmp)
17342 (if (and (not (eq (car tmp) 'hline))
17343 (or (eq hlines t)
17344 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17345 (push 'hline tmp)))
17346 (push (pop tbl) tmp)))
17347 (setq tbl (nreverse tmp)))
17348 (when vlines
17349 (setq tbl (mapcar (lambda (x)
17350 (if (eq 'hline x) x (cons "" x)))
17351 tbl))
17352 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17353 (setq pos (point))
17354 (insert (org-listtable-to-string tbl))
17355 (when (plist-get params :width)
17357 org-columns-current-widths "|")))
17358 (goto-char pos)
17359 (org-table-align))))
17361 (defun org-listtable-to-string (tbl)
17362 "Convert a listtable TBL to a string that contains the Org-mode table.
17363 The table still need to be alligned. The resulting string has no leading
17364 and tailing newline characters."
17365 (mapconcat
17366 (lambda (x)
17367 (cond
17368 ((listp x)
17369 (concat "|" (mapconcat 'identity x "|") "|"))
17370 ((eq x 'hline) "|-|")
17371 (t (error "Garbage in listtable: %s" x))))
17374 (defun org-insert-columns-dblock ()
17375 "Create a dynamic block capturing a column view table."
17376 (interactive)
17377 (let ((defaults '(:name "columnview" :hlines 1))
17378 (id (completing-read
17379 "Capture columns (local, global, entry with :ID: property) [local]: "
17380 (append '(("global") ("local"))
17381 (mapcar 'list (org-property-values "ID"))))))
17382 (if (equal id "") (setq id 'local))
17383 (if (equal id "global") (setq id 'global))
17384 (setq defaults (append defaults (list :id id)))
17385 (org-create-dblock defaults)
17386 (org-update-dblock)))
17388 ;;;; Timestamps
17390 (defvar org-last-changed-timestamp nil)
17391 (defvar org-time-was-given) ; dynamically scoped parameter
17392 (defvar org-end-time-was-given) ; dynamically scoped parameter
17393 (defvar org-ts-what) ; dynamically scoped parameter
17395 (defun org-time-stamp (arg)
17396 "Prompt for a date/time and insert a time stamp.
17397 If the user specifies a time like HH:MM, or if this command is called
17398 with a prefix argument, the time stamp will contain date and time.
17399 Otherwise, only the date will be included. All parts of a date not
17400 specified by the user will be filled in from the current date/time.
17401 So if you press just return without typing anything, the time stamp
17402 will represent the current date/time. If there is already a timestamp
17403 at the cursor, it will be modified."
17404 (interactive "P")
17405 (let* ((ts nil)
17406 (default-time
17407 ;; Default time is either today, or, when entering a range,
17408 ;; the range start.
17409 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17410 (save-excursion
17411 (re-search-backward
17413 (- (point) 20) t)))
17414 (apply 'encode-time (org-parse-time-string (match-string 1)))
17415 (current-time)))
17416 (default-input (and ts (org-get-compact-tod ts)))
17417 org-time-was-given org-end-time-was-given time)
17418 (cond
17419 ((and (org-at-timestamp-p)
17420 (eq last-command 'org-time-stamp)
17421 (eq this-command 'org-time-stamp))
17422 (insert "--")
17423 (setq time (let ((this-command this-command))
17424 (org-read-date arg 'totime nil nil default-time default-input)))
17425 (org-insert-time-stamp time (or org-time-was-given arg)))
17426 ((org-at-timestamp-p)
17427 (setq time (let ((this-command this-command))
17428 (org-read-date arg 'totime nil nil default-time default-input)))
17429 (when (org-at-timestamp-p) ; just to get the match data
17430 (replace-match "")
17431 (setq org-last-changed-timestamp
17432 (org-insert-time-stamp
17433 time (or org-time-was-given arg)
17434 nil nil nil (list org-end-time-was-given))))
17435 (message "Timestamp updated"))
17436 (t
17437 (setq time (let ((this-command this-command))
17438 (org-read-date arg 'totime nil nil default-time default-input)))
17439 (org-insert-time-stamp time (or org-time-was-given arg)
17440 nil nil nil (list org-end-time-was-given))))))
17442 ;; FIXME: can we use this for something else????
17443 ;; like computing time differences?????
17444 (defun org-get-compact-tod (s)
17445 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17446 (let* ((t1 (match-string 1 s))
17447 (h1 (string-to-number (match-string 2 s)))
17448 (m1 (string-to-number (match-string 3 s)))
17449 (t2 (and (match-end 4) (match-string 5 s)))
17450 (h2 (and t2 (string-to-number (match-string 6 s))))
17451 (m2 (and t2 (string-to-number (match-string 7 s))))
17452 dh dm)
17453 (if (not t2)
17454 t1
17455 (setq dh (- h2 h1) dm (- m2 m1))
17456 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17457 (concat t1 "+" (number-to-string dh)
17458 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17460 (defun org-time-stamp-inactive (&optional arg)
17461 "Insert an inactive time stamp.
17462 An inactive time stamp is enclosed in square brackets instead of angle
17463 brackets. It is inactive in the sense that it does not trigger agenda entries,
17464 does not link to the calendar and cannot be changed with the S-cursor keys.
17465 So these are more for recording a certain time/date."
17466 (interactive "P")
17467 (let (org-time-was-given org-end-time-was-given time)
17468 (setq time (org-read-date arg 'totime))
17469 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17470 nil nil (list org-end-time-was-given))))
17472 (defvar org-date-ovl (org-make-overlay 1 1))
17473 (org-overlay-put org-date-ovl 'face 'org-warning)
17474 (org-detach-overlay org-date-ovl)
17476 (defvar org-ans1) ; dynamically scoped parameter
17477 (defvar org-ans2) ; dynamically scoped parameter
17479 (defvar org-plain-time-of-day-regexp) ; defined below
17481 (defvar org-read-date-overlay nil)
17482 (defvar org-dcst nil) ; dynamically scoped
17484 (defun org-read-date (&optional with-time to-time from-string prompt
17485 default-time default-input)
17486 "Read a date, possibly a time, and make things smooth for the user.
17487 The prompt will suggest to enter an ISO date, but you can also enter anything
17488 which will at least partially be understood by `parse-time-string'.
17489 Unrecognized parts of the date will default to the current day, month, year,
17490 hour and minute. If this command is called to replace a timestamp at point,
17491 of to enter the second timestamp of a range, the default time is taken from the
17492 existing stamp. For example,
17493 3-2-5 --> 2003-02-05
17494 feb 15 --> currentyear-02-15
17495 sep 12 9 --> 2009-09-12
17496 12:45 --> today 12:45
17497 22 sept 0:34 --> currentyear-09-22 0:34
17498 12 --> currentyear-currentmonth-12
17499 Fri --> nearest Friday (today or later)
17500 etc.
17502 Furthermore you can specify a relative date by giving, as the *first* thing
17503 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17504 change in days weeks, months, years.
17505 With a single plus or minus, the date is relative to today. With a double
17506 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17507 +4d --> four days from today
17508 +4 --> same as above
17509 +2w --> two weeks from today
17510 ++5 --> five days from default date
17512 The function understands only English month and weekday abbreviations,
17513 but this can be configured with the variables `parse-time-months' and
17514 `parse-time-weekdays'.
17516 While prompting, a calendar is popped up - you can also select the
17517 date with the mouse (button 1). The calendar shows a period of three
17518 months. To scroll it to other months, use the keys `>' and `<'.
17519 If you don't like the calendar, turn it off with
17520 \(setq org-read-date-popup-calendar nil)
17522 With optional argument TO-TIME, the date will immediately be converted
17523 to an internal time.
17524 With an optional argument WITH-TIME, the prompt will suggest to also
17525 insert a time. Note that when WITH-TIME is not set, you can still
17526 enter a time, and this function will inform the calling routine about
17527 this change. The calling routine may then choose to change the format
17528 used to insert the time stamp into the buffer to include the time.
17529 With optional argument FROM-STRING, read from this string instead from
17530 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17531 the time/date that is used for everything that is not specified by the
17532 user."
17533 (require 'parse-time)
17534 (let* ((org-time-stamp-rounding-minutes
17535 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
17536 (org-dcst org-display-custom-times)
17537 (ct (org-current-time))
17538 (def (or default-time ct))
17539 (defdecode (decode-time def))
17540 (dummy (progn
17541 (when (< (nth 2 defdecode) org-extend-today-until)
17542 (setcar (nthcdr 2 defdecode) -1)
17543 (setcar (nthcdr 1 defdecode) 59)
17544 (setq def (apply 'encode-time defdecode)
17545 defdecode (decode-time def)))))
17546 (calendar-move-hook nil)
17547 (view-diary-entries-initially nil)
17548 (view-calendar-holidays-initially nil)
17549 (timestr (format-time-string
17550 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17551 (prompt (concat (if prompt (concat prompt " ") "")
17552 (format "Date+time [%s]: " timestr)))
17553 ans (org-ans0 "") org-ans1 org-ans2 final)
17555 (cond
17556 (from-string (setq ans from-string))
17557 (org-read-date-popup-calendar
17558 (save-excursion
17559 (save-window-excursion
17560 (calendar)
17561 (calendar-forward-day (- (time-to-days def)
17562 (calendar-absolute-from-gregorian
17563 (calendar-current-date))))
17564 (org-eval-in-calendar nil t)
17565 (let* ((old-map (current-local-map))
17566 (map (copy-keymap calendar-mode-map))
17567 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17568 (org-defkey map (kbd "RET") 'org-calendar-select)
17569 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17570 'org-calendar-select-mouse)
17608 ;; org-ans0: from prompt
17609 ;; org-ans1: from mouse click
17610 ;; org-ans2: from calendar motion
17638 "Display the currrent date prompt interpretation in the minibuffer."
17654 org-time-stamp-custom-formats
17655 org-time-stamp-formats))
17664 org-end-time-was-given
17671 "Analyze the combined answer of the date prompt."
17672 ;; FIXME: cleanup and comment
17674 hour minute second wday pm h2 m2 tl wday1
17675 iso-year iso-weekday iso-week iso-year iso-date)
17683 ;; Check if there is an iso week date in there
17684 ;; If yes, sore the info and ostpone interpreting it until the rest
17685 ;; of the parsing is done
17686 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17687 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
17692 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17702 t nil ans)))
17703 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17704 ;; If there is a time with am/pm, and *no* time without it, we convert
17705 ;; so that matching will be successful.
17719 t t ans))))
17721 ;; Check if a time range is given as a duration
17722 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17730 t t ans)))
17732 ;; Check if there is a time range
17758 ;; Special date definitions below
17761 ;; There was an iso week
17764 wday nil ; to make sure that the trigger below does not match
17768 ; FIXME: Should we also push ISO weeks into the future?
17769 ; (when (and org-read-date-prefer-future
17770 ; (not iso-year)
17771 ; (< (calendar-absolute-from-gregorian iso-date)
17772 ; (time-to-days (current-time))))
17773 ; (setq year (1+ year)
17774 ; iso-date (calendar-gregorian-from-absolute
17775 ; (calendar-absolute-from-iso
17776 ; (list iso-week day year)))))
17789 ;; Weekday was given, but no day, so pick that day in the week
17790 ;; on or after the derived date.
17804 "Check string S for special relative date string.
17805 TODAY and DEFAULT are internal times, for today and for a default.
17806 Return shift list (N what def-flag)
17808 N is the number of WHATs to shift.
17809 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17810 the DEFAULT date rather than TODAY."
17819 ?+))
17826 delta)
17836 "Eval FORM in the calendar window and return to current window.
17837 Also, store the cursor date in variable org-ans2."
17848 ; ;; Update the prompt to show new default date
17849 ; (save-excursion
17850 ; (goto-char (point-min))
17851 ; (when (and org-ans2
17852 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17853 ; (get-text-property (match-end 0) 'field))
17854 ; (let ((inhibit-read-only t))
17855 ; (replace-match (concat "[" org-ans2 "]") t t)
17856 ; (add-text-properties (point-min) (1+ (match-end 0))
17857 ; (text-properties-at (1+ (point-min)))))))))
17860 "Return to `org-read-date' with the date currently selected.
17861 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17870 "Insert a date stamp for the date given by the internal TIME.
17871 WITH-HM means, use the stamp format that includes the time of the day.
17872 INACTIVE means use square brackets instead of angular ones, so that the
17873 stamp will not contribute to the agenda.
17874 PRE and POST are optional strings to be inserted before and after the
17875 stamp.
17876 The command returns the inserted time stamp."
17878 stamp)
17895 stamp))
17898 "Toggle the use of custom time stamp formats."
17919 "Overlay modified time stamp format over timestamp between BED and END."
17946 "Translate all timestamps in STRING to custom format.
17947 But do this only if the variable `org-display-custom-times' is set."
17952 t1 with-hm inactive tf time str beg end)
17961 org-time-stamp-custom-formats)
17970 string)
17973 "Set 0 instead of nil for the first 6 elements of time.
17974 Don't touch the rest."
17979 "Difference between TIMESTAMP-STRING and now in days."
17984 "Is the time in TIMESTAMP-STRING close to the current date?"
17990 "Get the deadline lead time appropriate for timestring TS."
17993 ;; 0 or negative, enforce this value no matter what
17996 ;; lead time is specified.
18001 ;; go for the default.
18005 "Return to `org-read-date' with the date currently selected.
18006 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18016 "Check if there are any deadlines due or past due.
18017 A deadline is considered due if it happens within `org-deadline-warning-days'
18018 days from today's date. If the deadline appears in an entry marked DONE,
18019 it is not shown. The prefix arg NDAYS can be used to test that many
18034 org-warn-days)))
18037 "Check if there are deadlines or scheduled entries before DATE."
18051 "Evaluate a time range by computing the difference between start and end.
18052 Normally the result is just printed in the echo area, but with prefix arg
18053 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18054 If the time range is actually in a table, the result is inserted into the
18055 next column.
18056 For time difference computation, a year is assumed to be exactly 365
18057 days in order to avoid rounding problems."
18077 ;; (ys (floor (* 365 24 60 60)))
18085 y d h m align)
18088 y 0
18093 y 0
18131 "Convert a time stamp to an absolute day number.
18132 If there is a specifyer for a cyclic time stamp, get the closest date to
18133 DAYNR."
18137 daynr
18142 prefer))
18146 "Return the time corresponding to date D.
18147 D may be an absolute day number, or a calendar-type list (month day year)."
18152 "List of holidays, for Diary display in Org-mode."
18160 "Process a SEXP diary ENTRY for DATE."
18180 "Get iCalendar entries from diary entries in buffer FROMBUF.
18181 This uses the icalendar.el library."
18184 temporary-file-directory))
18187 buf rtn b e)
18203 rtn))
18206 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18207 When PREFER is `past' return a date that is either CURRENT or past.
18208 When PREFER is `future', return a date that is either CURRENT or future."
18209 ;; Make the proper lists from the dates
18212 dn dw sday cday n1 n2
18213 d m y y1 y2 date1 date2 nmonths nm ny m2)
18218 current
18242 ;; approx number of month between the tow dates
18244 ;; How often does dn fit in there?
18273 "Turn any specification of DATE into a gregorian date for the calendar."
18283 "Parse the standard Org-mode time string.
18284 This should be a lot faster than the normal `parse-time-string'.
18285 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18286 hour and minute fields will be nil if not given."
18296 nil nil nil)
18300 "Increase the date item at the cursor by one.
18301 If the cursor is on the year, change the year. If it is on the month or
18302 the day, change that.
18303 With prefix ARG, change by that many units."
18308 "Decrease the date item at the cursor by one.
18309 If the cursor is on the year, change the year. If it is on the month or
18310 the day, change that.
18311 With prefix ARG, change by that many units."
18316 "Increase the date in the time stamp by one day.
18317 With prefix ARG, change that many days."
18325 "Decrease the date in the time stamp by one day.
18326 With prefix ARG, change that many days."
18339 "Determine if the cursor is in or at a timestamp."
18365 ans))
18368 "Toggle the type (<active> or [inactive]) of a time stamp."
18380 "Change the date in the time stamp at point.
18381 The date will be changed by N times WHAT. WHAT can be `day', `month',
18382 `year', `minute', `second'. If WHAT is not given, the cursor position
18383 in the timestamp determines what will be changed."
18385 with-hm inactive
18387 org-ts-what
18388 extra rem
18389 ts time time0)
18395 org-display-custom-times
18405 ts)
18439 ;; Try to recenter the calendar window, if any
18445 ;; FIXME: does not yet work for lead times
18447 "Change the different parts of the lead-time and repeat fields in timestamp."
18449 ng h m new rem)
18450 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18479 new
18481 s))
18484 "If the calendar is visible, recenter it to DATE."
18495 "Go to the Emacs calendar at the current date.
18496 If there is a time stamp in the current line, go to that date.
18497 A prefix ARG can be used to force the current date."
18516 "Return a list (month day year) of date at point in calendar."
18522 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18523 If there is already a time stamp at the cursor position, update it."
18533 ;;;###autoload
18535 "Activate appointments found in `org-agenda-files'.
18537 appointements.
18539 If FILTER is t, interactively prompt the user for a regular
18540 expression, and filter out entries that don't match it.
18542 If FILTER is a string, use this string as a regular expression
18543 for filtering entries out.
18545 FILTER can also be an alist with the car of each cell being
18546 either 'headline or 'category. For example:
18551 will only add headlines containing IMPORTANT or headlines
18564 ;; Get all entries which may contain an appt
18571 ;; Map thru entries and find if we should filter them out
18584 ;; FIXME: Shall we remove text-properties for the appt text?
18585 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18599 ;;; The clock for measuring work time.
18624 "Start the clock on the current item.
18625 If necessary, clock-out of the currently active clock."
18633 org-clock-in-switch-to-state
18660 "Find the location where the next clock line should be inserted."
18670 first last)
18674 ;; we seem to have a CLOCK drawer, so go there.
18677 ;; Lets count the CLOCK lines
18685 ;; Wrap current entries into a new drawer
18703 ;; Planning info, skip to after it
18715 "Stop the currently running clock.
18716 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18753 "Cancel the running clock be removing the start timestamp."
18767 "Go to the currently clocked-in entry."
18784 "Sum the times for each subtree.
18785 Puts the resulting times in minutes as a text property on each headline."
18789 org-clock-string
18795 ts te dt
18796 time)
18803 ;; Two time stamps
18815 ;; A naket time
18832 "Show subtree times in the entire buffer.
18833 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18834 in the echo area."
18851 ;; Arrange to remove the overlays upon next change.
18861 "Put an overlays on the current line, displaying TIME.
18862 If LEVEL is given, prefix time with a corresponding number of stars.
18863 This creates a new overlay and stores it in `org-clock-overlays', so that it
18864 will be easy to remove."
18868 ov tx)
18887 "Remove the occur highlights from the buffer.
18888 BEG and END are ignored. If NOREMOVE is nil, remove this function
18889 from the `before-change-functions' in the current buffer."
18899 "Clock out if the current entry contains the running clock.
18900 This is used to stop the clock after a TODO entry is marked DONE,
18901 and is only done if the variable `org-clock-out-when-done' is not nil."
18907 org-clock-marker))
18908 ;; Clock out, but don't accept a logging message for this.
18916 "Check if the current buffer contains the running clock.
18917 If yes, offer to stop it and to save the buffer with the changes."
18926 "Create a table containing a report about clocked time.
18927 If the cursor is inside an existing clocktable block, then the table
18928 will be updated. If not, a new clocktable will be inserted.
18929 When called with a prefix argument, move to the first clock table in the
18930 buffer and update it."
18943 "Check if the cursor is in a clocktable."
18951 start))))
18954 "If this is a CLOCK line, update it and return t.
18955 Otherwise, return nil."
18964 ts te h m s)
18966 nil
18980 t)))))
18983 "Return two times bordering a special time range.
18984 Key is a symbol specifying the range and can be one of `today', `yesterday',
18985 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18986 A week starts Monday 0:00 and ends Sunday 24:00.
18987 The range is determined relative to TIME. TIME defaults to the current time.
18988 The return value is a cons cell with two internal times like the ones
18989 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18990 the returned times will be formatted strings."
18995 s1 m1 h1 d1 month1 y1 diff ts te fm)
19025 "Write the standard clocktable."
19041 ipos time h m p level hlc hdl
19042 cc beg end pos tbl)
19056 ;; Get the right scope
19079 file)
19089 org-clock-file-total-minutes)))))))
19100 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19129 "Clock summary at ["
19133 "]."
19146 "|"
19147 "*Total time*| "
19169 cc)
19203 x))
19204 lines)
19207 ;; FIXME: I don't think anybody uses this, ask David
19209 "Return an internal list with clocking information.
19210 This list has one entry for each CLOCK interval.
19211 FIXME: describe the elements."
19215 rtn beg end next cont level title total closedp leafp
19216 clockpos titlepos h m donep)
19241 total title titlepos level leafp)
19242 rtn)
19246 ;;;; Agenda, and Diary Integration
19248 ;;; Define the Org-agenda-mode
19263 "Mode for time-sorted view on action items in Org-mode files.
19265 The following commands are available:
19271 org-agenda-pending-undo-list nil)
19273 ;; Keep global-font-lock-mode from turning on font-lock-mode
19281 ;; Make sure properties are removed when copying text
19286 buffer-substring-filters)))
19289 org-agenda-show-log nil))
19296 "Restricted to single file"
19308 org-agenda-mode-map global-map)
19411 "--"
19418 "--"
19422 "--"
19427 "--"
19432 "--"
19437 "--"
19454 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19458 "--"
19460 "--"
19470 "--"
19472 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19476 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19480 "--"
19482 "--"
19485 ))
19487 ;;; Agenda undo
19499 "Execute BODY if there is no `org-protected' text property at point."
19505 "Execute BODY while recording undo information in two buffers."
19513 _c1 _c2)
19514 ,@_body
19521 ;; make sure there are undo boundaries
19524 ;; remember which buffer to undo
19526 org-agenda-undo-list)))))
19529 "Undo a remote editing step in the agenda.
19530 This undoes changes both in the agenda buffer and in the remote buffer
19531 that have been changed along."
19537 org-agenda-pending-undo-list org-agenda-undo-list))
19541 buf line cmd rembuf)
19563 "Verify that a real change occurred between the undo lists L1 and L2."
19568 ;;; Agenda dispatch
19576 ;;;###autoload
19578 "Dispatch agenda commands to collect entries to the agenda buffer.
19579 Prompts for a command to execute. Any prefix arg will be passed
19580 on to the selected command. The default selections are:
19582 a Call `org-agenda-list' to display the agenda for current day or week.
19583 t Call `org-todo-list' to display the global todo list.
19584 T Call `org-todo-list' to display the global todo list, select only
19585 entries with a specific TODO keyword (the user gets a prompt).
19586 m Call `org-tags-view' to display headlines with tags matching
19587 a condition (the user is prompted for the condition).
19588 M Like `m', but select only TODO entries, no ordinary headlines.
19589 L Create a timeline for the current buffer.
19590 e Export views to associated files.
19592 More commands can be added by configuring the variable
19593 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19594 searches can be pre-defined in this way.
19596 If the current buffer is in Org-mode and visiting a file, you can also
19597 first press `<' once to indicate that the agenda should be temporarily
19599 Pressing `<' twice means to restrict to the current subtree or region
19600 \(if active)."
19606 ;; normalize different versions
19612 nil)
19616 org-agenda-custom-commands)))
19619 entry key type match lprops ans)
19620 ;; Turn off restriction unless there is an overriding one
19626 ;; Delete old local properties
19628 ;; Remember where this call originated
19634 ;; Estabish the restriction, if any
19651 ;; For example the todo list should not need it (but does...)
19667 current-prefix-arg)))
19720 cmds)))
19723 "The user interface for selecting an agenda command."
19730 restriction second-time
19731 c entry key type match prefixes rmheader header-end custom1 desc)
19738 "
19739 Press key for an agenda command: < Buffer,subtree/region restriction
19740 -------------------------------- > Remove restriction
19741 a Agenda for current week or day e Export agenda views
19742 t List of all TODO entries T Entries with special TODO kwd
19743 m Match a TAGS query M Like m, but only TODO entries
19744 L Timeline for current buffer # List stuck projects (!=configure)
19745 s Search for keywords C Configure custom agenda commands
19746 / Multi-occur
19751 header start)
19755 header)))
19808 prefix-descriptions))
19810 prefixes))
19821 " (restriction lock active)"
19834 prefixes nil
19840 nil
19842 custom))))
19859 nil)
19879 match ;; The byte compiler incorrectly complains about this. Keep it!
19880 cmd type lprops)
19914 ;;;###autoload
19916 "Run an agenda command in batch mode and send the result to STDOUT.
19917 If CMD-KEY is a string of length 1, it is used as a key in
19918 `org-agenda-custom-commands' and triggers this command. If it is a
19919 longer string it is used as a tags/todo match string.
19920 Paramters are alternating variable names and values that will be bound
19921 before running the agenda command."
19935 string))
19939 ;;;###autoload
19941 "Run an agenda command in batch mode and send the result to STDOUT.
19942 If CMD-KEY is a string of length 1, it is used as a key in
19943 `org-agenda-custom-commands' and triggers this command. If it is a
19944 longer string it is used as a tags/todo match string.
19945 Paramters are alternating variable names and values that will be bound
19946 before running the agenda command.
19948 The output gives a line for each selected agenda item. Each
19949 item is a list of comma-separated values, like this:
19951 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19953 category The category of the item
19954 head The headline, without TODO kwd, TAGS and PRIORITY
19955 type The type of the agenda entry, can be
19956 todo selected in TODO match
19957 tagsmatch selected in tags match
19958 diary imported from diary
19959 deadline a deadline on given date
19960 scheduled scheduled on given date
19961 timestamp entry has timestamp on given date
19962 closed entry was closed on given date
19963 upcoming-deadline warning about deadline
19964 past-scheduled forwarded scheduled item
19965 block entry has date block including g. date
19966 todo The todo keyword, if any
19967 tags All tags including inherited ones, separated by colons
19968 date The relevant date, like 2007-2-14
19969 time The time, like 15:00-16:50
19970 extra Sting with extra planning info
19971 priority-l The priority letter if any was given
19972 priority-n The computed numerical priority
19973 agenda-day The day in the agenda where this is listed"
19985 line)
19995 priority-letter priority agenda-day)
20000 "Make sure all properties on an agenda item have a canonical form,
20001 so the export commands can easily use it."
20028 props)
20042 ;;;###autoload
20047 ;; FIXME, why is this a macro?????
20048 ;;;###autoload
20050 "Run all custom agenda commands that have a file argument."
20054 pars cmd thiscmdkey files opts)
20077 "Write the current buffer (an agenda view) as a file.
20078 Depending on the extension of the file name, plain text (.txt),
20079 HTML (.html or .htm) or Postscript (.ps) is produced.
20080 If the extension is .ics, run icalendar export over all files used
20081 to construct the agenda and limit the export to entries listed in the
20082 agenda now.
20083 If NOSETTINGS is given, do not scope the settings of
20084 `org-agenda-exporter-settings' into the export commands. This is used when
20085 the settings have already been scoped and we do not wish to overrule other,
20086 higher priority settings."
20102 ;; replace <style> section with org-agenda-export-html-style
20130 "Collect the markers pointing to entries in the agenda buffer."
20142 "Create a alist of files names with all marker positions in that file."
20153 tbl)))
20157 "Check of the current entry is on the marker list."
20159 a)
20167 "Inhibit read-only for BODY."
20171 "Make sure current buffer is in org-mode. Error if not."
20174 major-mode)))
20177 "Fit the window to the buffer size."
20181 nil
20185 ;;; Agenda file list
20188 "Get the list of agenda files.
20189 Optional UNRESTRICTED means return the full list even if a restriction
20190 is currently in place."
20201 org-agenda-file-regexp)
20203 files)))
20209 files))
20213 "Edit the list of agenda files.
20214 Depending on setup, this either uses customize to edit the variable
20215 `org-agenda-files', or it visits the file that is holding the list. In the
20216 latter case, the buffer is set up in a way that saving it automatically kills
20217 the buffer and restores the previous window configuration."
20236 "Set new value for the agenda file list and save it correcly."
20247 "Read the list of agenda files from a file."
20254 ;;;###autoload
20256 "Cycle through the files in `org-agenda-files'.
20257 If the current buffer visits an agenda file, find the next one in the list.
20258 If the current buffer does not, find the first agenda file."
20263 file)
20275 "Move/add the current file to the top of the agenda file list.
20276 If the file is not present in the list, it is added to the front. If it is
20277 present, it is moved there. With optional argument TO-END, add/move to the
20278 end of the list."
20285 x had)
20298 "Remove current file from the list of files in variable `org-agenda-files'.
20299 These are the files which are being checked for agenda entries.
20300 Optional argument FILE means, use this file instead of the current."
20310 nil x))
20323 "Make sure FILE exists. If not, ask user what to do."
20334 ;;; Agenda prepare and finalize
20379 "Finishing touch for the agenda buffer, called just before displaying it."
20391 org-overriding-columns-format)
20393 org-overriding-columns-format))
20395 org-agenda-view-columns-initially)
20401 )))
20404 "Make highest priority lines bold, and lowest italic."
20411 b e p ov h l)
20415 org-highest-priority)
20417 org-lowest-priority)
20422 ov 'face
20430 "Create buffers for all agenda files, protect archived trees and comments."
20437 bmp file re)
20467 "Function to be called at each match during agenda construction.
20468 If this function returns nil, the current match should not be skipped.
20469 Otherwise, the function must return a position from where the search
20470 should be continued.
20471 This may also be a Lisp form, it will be evaluated.
20472 Never set this variable using `setq' or so, because then it will apply
20473 to all future agenda commands. Instead, bind it with `let' to scope
20474 it dynamically into the agenda-constructing command. A good way to set
20478 "Throw to `:skip' in places that should be skipped.
20479 Also moves point to the end of the skipped region, so that search can
20480 continue from there."
20506 "Return a new agenda marker.
20507 Org-mode keeps a list of these markers and resets them when they are
20508 no longer in use."
20512 m))
20515 "Reset markers created by `org-agenda'."
20520 "Get a buffer visiting FILE. If the buffer needs to be created, add
20521 it to the list of buffers which might be released later."
20524 buf ; just return it
20525 ;; Make a new buffer and remember it
20528 buf)))
20531 "Release all buffers in list, asking the user for confirmation when needed.
20532 When a buffer is unmodified, it is just killed. When modified, it is saved
20533 \(if the user agrees) and then killed."
20538 file
20544 "Get the category applying to position POS."
20547 ;;; Agenda timeline
20552 "Show a time-sorted view of the entries in the current org file.
20553 Only entries with a time stamp of today or later will be listed. With
20555 under the current date.
20556 If the buffer contains an active region, only check the region for
20557 dates."
20570 t doclosed ; always include today
20571 org-timeline-show-empty-dates))
20576 args
20577 s e rtn d emptyp)
20583 ;; Remove past dates from the list of dates.
20586 day-numbers))))
20603 dopast
20604 past)
20612 date args)))
20635 "Return a list of all relevant day numbers from BEG to END buffer positions.
20636 If NO-RANGES is non-nil, include only the start and end dates of a range,
20637 not every single day in the range. If FORCE-TODAY is non-nil, make
20638 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20639 inactive time stamps (those in square brackets) are included.
20640 When EMPTY is non-nil, also include days without any entries."
20644 dates dates1 date day day1 day2 ts1 ts2)
20674 dates)))
20676 ;;; Agenda Daily/Weekly
20687 ;;;###autoload
20689 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20690 The view will be for the current day or week, but from the overview buffer
20691 you will be able to go to other days/weeks.
20694 all unfinished TODO items will also be shown, before the agenda.
20695 This feature is considered obsolete, please use the TODO list or a block
20696 agenda instead.
20698 With a numeric prefix argument in an interactive call, the agenda will
20699 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20700 the number of days. NDAYS defaults to `org-agenda-ndays'.
20702 START-DAY defaults to TODAY, or to the most recent match for the weekday
20703 given in `org-agenda-start-on-weekday'."
20714 ;; Convert to an absolute day number
20722 org-agenda-start-on-weekday nil))
20731 sd
20740 s e rtn rtnall file date d start-pos end-pos todayp nd)
20743 ;; Make the list of days
20745 nd ndays)
20758 rtnall nil)
20778 "-agenda"
20796 rtnall nil)
20802 file date
20805 file date
20829 rtnall nd todayp))
20852 ;;; Agenda word search
20858 "Special syntax table for org-mode search.
20859 In this table, we have single quotes not as word constituents, to
20867 org-search-syntax-table)
20869 ;;;###autoload
20871 "Show all entries that contain words or regular expressions.
20872 If the first character of the search string is an asterisks,
20873 search only the headlines.
20875 With optional prefix argument TODO-ONLY, only consider entries that are
20876 TODO entries. The argument STRING can be used to pass a default search
20877 string into this function. If EDIT-AT is non-nil, it means that the
20878 user should get a chance to edit this string, with cursor at position
20879 EDIT-AT.
20882 The individual words are then interpreted as a boolean expression with
20883 logical AND. Words prefixed with a minus must not occur in the entry.
20884 Words without a prefix or prefixed with a plus must occur in the entry.
20885 Matching is case-insensitive and the words are enclosed by word delimiters.
20887 Words enclosed by curly braces are interpreted as regular expressions
20888 that must or must not match in the entry.
20890 If the search string starts with an asterisk, search only in headlines.
20891 If (possibly after the leading star) the search string starts with an
20892 exclamation mark, this also means to look at TODO entries only, an effect
20893 that can also be achieved with a prefix argument.
20895 This command searches the agenda files, and in addition the files listed
20896 in `org-agenda-text-search-extra-files'."
20903 'org-not-done-regexp org-not-done-regexp
20904 'org-todo-regexp org-todo-regexp
20906 'keymap org-agenda-keymap
20908 regexp rtn rtnall files file pos
20909 marker priority category tags c neg re
20944 words)
20950 regexp))))
20952 rtnall nil)
20961 ;; If file does not exist, make sure an error message is sent
20963 file))))
20973 org-agenda-restrict-end)
20995 regexps-)
21001 regexps+)
21002 regexps+))
21008 ""
21011 category tags))
21014 'org-todo-regexp org-todo-regexp
21043 ;;; Agenda TODO list
21048 ;;;###autoload
21050 "Show all TODO entries from all agenda file in a single list.
21051 The prefix arg can be used to select a specific TODO keyword and limit
21053 for a keyword. A numeric prefix directly selects the Nth keyword in
21054 `org-todo-keywords-1'."
21068 rtn rtnall files file pos)
21078 rtnall nil)
21102 kwds))
21113 ;;; Agenda tags match
21115 ;;;###autoload
21117 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
21118 The prefix arg TODO-ONLY limits the search to TODO entries."
21125 rtn rtnall files file pos matcher
21126 buffer)
21135 rtnall nil)
21143 ;; If file does not exist, merror message to agenda
21154 org-agenda-restrict-end)
21179 ;;; Agenda Finding stuck projects
21182 "Regular expression used in skipping subtrees for the agenda.
21183 This is basically a temporary global variable that can be set and then
21190 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
21191 If yes, it returns the end position of this tree, causing agenda commands
21192 to skip this subtree. This is a function that can be put into
21193 `org-agenda-skip-function' for the duration of a command."
21195 skip)
21201 "Skip entry if any of CONDITIONS is true.
21202 See `org-agenda-skip-if' for details."
21206 "Skip entry if any of CONDITIONS is true.
21207 See `org-agenda-skip-if' for details."
21211 "Checks current entity for CONDITIONS.
21212 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
21213 the entry, i.e. the text before the next heading is checked.
21215 CONDITIONS is a list of symbols, boolean OR is used to combine the results
21216 from different tests. Valid conditions are:
21218 scheduled Check if there is a scheduled cookie
21219 notscheduled Check if there is no scheduled cookie
21220 deadline Check if there is a deadline
21221 notdeadline Check if there is no deadline
21222 regexp Check if regexp matches
21223 notregexp Check if regexp does not match.
21225 The regexp is taken from the conditions list, it must come right after
21226 the `regexp' or `notregexp' element.
21228 If any of these conditions is met, this function returns the end point of
21229 the entity, causing the search to continue from there. This is a function
21230 that can be put into `org-agenda-skip-function' for the duration of a command."
21254 end)))
21256 ;;;###autoload
21258 "Create agenda view for projects that are stuck.
21259 Stuck projects are project that have no next actions. For the definitions
21260 of what a project is and how to check if it stuck, customize the variable
21261 `org-stuck-projects'.
21262 MATCH is being ignored."
21265 ;; FIXME: we could have used org-agenda-skip-if here.
21273 org-done-keywords-for-agenda
21275 todo))
21292 gen-re)))))
21303 ;;; Diary integration
21309 "Get the (Emacs Calendar) diary entries for DATE."
21318 entries
21330 ;; No entries
21332 ;; Omit the date and other unnecessary stuff
21334 ;; Add prefix to each line and extend the text properties
21346 ;; Extend the text properties to the beginning of the line
21349 entries)))))
21352 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21353 This gets rid of the date, the underline under the date, and
21354 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21355 date. It also removes lines that contain only whitespace."
21372 ;; Make sure entries from the diary have the right text properties.
21375 ;; We can rely on the hook, nothing to do
21376 nil
21377 ;; Hook not avaiable, must use advice to make this work
21379 "Make the position visible."
21382 buffer-file-name)
21386 "Add text properties to string, allowing org-mode to act on it."
21389 'keymap org-agenda-keymap
21394 'org-agenda-diary-link t
21398 "Add a dummy entry to the diary.
21399 Needed to avoid empty dates which mess up holiday display."
21400 ;; Catch the error if dealing with the new add-to-diary-alist
21407 ;;;###autoload
21409 "Return diary information from org-files.
21411 It accesses org files and extracts information from those files to be
21412 listed in the diary. The function accepts arguments specifying what
21413 items should be listed. The following arguments are allowed:
21415 :timestamp List the headlines of items containing a date stamp or
21416 date range matching the selected date. Deadlines will
21417 also be listed, on the expiration day.
21419 :sexp List entries resulting from diary-like sexps.
21421 :deadline List any deadlines past due, or due within
21422 `org-deadline-warning-days'. The listing occurs only
21423 in the diary for *today*, not at any other date. If
21424 an entry is marked DONE, it is no longer listed.
21426 :scheduled List all items which are scheduled for the given date.
21427 The diary for *today* also contains items which were
21428 scheduled earlier and are not yet marked DONE.
21430 :todo List all TODO items from the org-file. This may be a
21431 long list - so this is not turned on by default.
21432 Like deadlines, these entries only show up in the
21433 diary for *today*, not at any other date.
21435 The call in the diary file should look like this:
21437 &%%(org-diary) ~/path/to/some/orgfile.org
21439 Use a separate line for each org file to check. Or, if you omit the file name,
21440 all files listed in `org-agenda-files' will be checked automatically:
21442 &%%(org-diary)
21444 If you don't give any arguments (as in the example above), the default
21445 arguments (:deadline :scheduled :timestamp :sexp) are used.
21446 So the example above may also be written as
21448 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21450 The function expects the lisp variables `entry' and `date' to be provided
21451 by the caller, because this is how the calendar works. Don't use this
21452 function from a program - use `org-agenda-get-day-entries' instead."
21454 org-agenda-last-marker-time)
21463 file rtn results)
21465 ;; If this is called during org-agenda, don't return any entries to
21466 ;; the calendar. Org Agenda will list these entries itself.
21474 ;;; Agenda entry finders
21477 "Does the work for `org-diary' and `org-agenda'.
21478 FILE is the path to a file to be checked for entries. DATE is date like
21479 the one returned by `calendar-current-date'. ARGS are symbols indicating
21480 which kind of entries should be extracted. For details about these, see
21481 the documentation of `org-diary'."
21488 arg results rtn)
21490 ;; If file does not exist, make sure an error message ends up in diary
21500 org-agenda-restrict-end)
21502 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21526 results))))
21542 "Is the cursor inside a date range?"
21557 nil)))
21560 "Return the TODO information for agenda display."
21563 'org-not-done-regexp org-not-done-regexp
21564 'org-todo-regexp org-todo-regexp
21566 'keymap org-agenda-keymap
21567 'help-echo
21570 ;; FIXME: get rid of the \n at some point but watch out
21574 org-todo-regexp
21578 org-not-done-regexp)
21580 marker priority category tags
21581 ee txt beg end)
21620 "Return the date stamp information for agenda display."
21622 'org-not-done-regexp org-not-done-regexp
21623 'org-todo-regexp org-todo-regexp
21625 'keymap org-agenda-keymap
21626 'help-echo
21634 "<%Y-%m-%d"
21648 marker hdmarker deadlinep scheduledp donep tmp priority category
21649 ee txt timestr tags b0 b3 e3 head)
21667 b0)
21674 ;; substring should only run to end of time stamp
21686 nil head category tags timestr nil
21687 remove-re)))
21700 "Return the sexp information for agenda display."
21704 'keymap org-agenda-keymap
21705 'help-echo
21709 marker category ee txt tags entry result beg b sexp sexp-entry)
21741 "Return the logged TODO entries for agenda display."
21743 'org-not-done-regexp org-not-done-regexp
21744 'org-todo-regexp org-todo-regexp
21745 'keymap org-agenda-keymap
21746 'help-echo
21758 marker hdmarker priority category tags closedp
21759 ee txt timestr)
21768 ;; donep (org-entry-is-done-p)
21769 )
21771 ;; substring should only run to end of time stamp
21795 "Return the deadline information for agenda display."
21797 'org-not-done-regexp org-not-done-regexp
21798 'org-todo-regexp org-todo-regexp
21799 'keymap org-agenda-keymap
21800 'help-echo
21806 d2 diff dfrac wdays pos pos1 category tags
21807 ee txt head face s upcomingp donep timestr)
21819 ;; When to show a deadline in the calendar:
21820 ;; If the expiration is within wdays warning time.
21821 ;; Past-due deadlines are only shown on the current date
21849 diff))
21850 head category tags timestr))))
21859 'org-category category
21868 "Return the face to displaying a deadline item.
21869 FRACTION is what fraction of the head-warning time has passed."
21877 "Return the scheduled information for agenda display."
21879 'org-todo-regexp org-todo-regexp
21882 'keymap org-agenda-keymap
21883 'help-echo
21889 d2 diff pos pos1 category tags
21890 ee txt head pastschedp donep face timestr s)
21898 ;;; is this right?
21899 ;;; do we need to do this for deadleine too????
21900 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21903 ;; When to show a scheduled item in the calendar:
21904 ;; If it is on or past the date.
21933 head category tags timestr))))
21937 'org-scheduled-previously
21940 'undone-face face
21952 "Return the date-range information for agenda display."
21954 'org-not-done-regexp org-not-done-regexp
21955 'org-todo-regexp org-todo-regexp
21957 'keymap org-agenda-keymap
21958 'help-echo
21963 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21964 donep head)
21976 ;; Only allow days between the limits, because the normal
21977 ;; date stamps will catch the limits.
21994 head category tags
22003 ;; Sort the entries by expiration date.
22006 ;;; Agenda presentation and sorting
22016 "Regular expression to match a plain time or time range.
22017 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22018 groups carry important information:
22019 0 the full match
22020 1 the first time, range or not
22028 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
22029 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22030 groups carry important information:
22031 0 the full match
22032 7 hours of duration
22041 "Regular expression to match a timestamp time or time range.
22042 After a match, the following groups carry important information:
22043 0 the full match
22044 1 date plus weekday, for backreferencing to make sure both times on same day
22045 2 the first time, range or not
22049 "A flag, set by `org-compile-prefix-format'.
22052 "A flag, set by `org-compile-prefix-format'.
22056 noprefix remove-re)
22057 "Format TXT to be inserted into the agenda buffer.
22058 In particular, it adds the prefix and corresponding text properties. EXTRA
22059 must be a string and replaces the `%s' specifier in the prefix format.
22060 CATEGORY (string, symbol or nil) may be used to overrule the default
22061 category taken from local variable or file name. It will replace the `%c'
22062 specifier in the format. DOTIME, when non-nil, indicates that a
22063 time-of-day should be extracted from TXT for sorting of this entry, and for
22064 the `%t' specifier in the format. When DOTIME is a string, this string is
22065 searched for a time before TXT is. NOPREFIX is a flag and indicates that
22066 only the correctly processes TXT should be returned - this is used by
22067 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
22068 Any match of REMOVE-RE will be removed from TXT."
22070 ;; Diary entries sometimes have extra whitespace at the beginning
22073 org-category
22079 time ; time and tag are needed for the eval of the prefix format
22082 stamp plain s0 s1 s2 rtn srp)
22084 ;; Extract starting and ending time and move them to prefix
22092 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
22093 ;; them, we might want to remove them there to avoid duplication.
22094 ;; The user can turn this off with a variable.
22100 t))
22102 ;; Normalize the time(s) to 24 hour
22110 org-agenda-default-appointment-duration))
22111 h)
22116 txt)
22117 ;; Tags are in the string
22120 org-prefix-has-tag))
22125 t t txt))))
22131 ;; Create the final string
22134 ;; Prepare the variables needed in the eval of the compiled format
22140 ;; Evaluate the compiled format
22143 ;; And finally add the text properties
22146 'org-highest-priority org-highest-priority
22147 'org-lowest-priority org-lowest-priority
22149 'time-of-day time-of-day
22150 'txt txt
22151 'time time
22152 'extra extra
22167 list)))
22172 new time)
22174 ;; don't show empty grid
22180 nil string "" nil
22182 new)
22190 "Compile the prefix format into a Lisp form that can be evaluated.
22191 The resulting form is returned and stored in the variable
22192 `org-prefix-format-compiled'."
22196 org-agenda-prefix-format)
22201 varform vars var e c f opt)
22203 s start)
22216 ""
22226 ;; the old format
22234 "Check string S for a time of day.
22235 If found, return it as a military time number between 0 and 2400.
22236 If not found, return nil.
22237 The optional STRING argument forces conversion into a 5 character wide string
22238 HH:MM."
22260 "Sort and concatenate the agenda items."
22263 list
22288 x)
22292 " "
22294 x)))
22297 "Compare the priorities of string A and B."
22305 "Compare the string values of categories of strings A and B."
22313 "Compare the string values of categories of strings A and B."
22323 "Compare the time-of-day values of strings A and B."
22332 "Predicate for sorting agenda entries."
22333 ;; The following variables will be used when the form is evaluated.
22334 ;; So even though the compiler complains, keep them.
22348 ;;; Agenda restriction lock
22366 "Set restriction lock for agenda, to current subtree or file.
22367 Restriction will be the file if TYPE is `file', or if type is the
22368 universal prefix '(4), or if the cursor is before the first headline
22369 in the file. Otherwise, restriction will be to the current subtree."
22401 "Remove the agenda restriction lock."
22415 "If there is any window showing the agenda view, update it."
22424 org-agenda-overriding-restriction)
22427 ;;; Agenda commands
22430 "Check if agenda buffer is of allowed type.
22431 If ERROR is non-nil, throw an error, otherwise just return nil."
22433 t
22436 nil)))
22439 "Exit agenda by removing the window or the buffer."
22446 ;; Maybe restore the pre-agenda window configuration.
22449 org-pre-agenda-window-conf
22453 "Exit agenda by removing the window or the buffer.
22454 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22455 Org-mode buffers visited directly by the user will not be touched."
22469 "Save all Org-mode buffers without user confirmation."
22476 "Rebuild Agenda.
22477 When this is the global TODO list, a prefix argument will be interpreted."
22486 org-agenda-pending-undo-list nil)
22492 "Manipulate the query by adding a search term with positive selection.
22493 Positive selection means, the term must be matched for selection of an entry."
22497 "Manipulate the query by adding a search term with negative selection.
22498 Negative selection means, term must not be matched for selection of an entry."
22502 "Manipulate the query by adding a search regexp with positive selection.
22503 Positive selection means, the regexp must match for selection of an entry."
22507 "Manipulate the query by adding a search regexp with negative selection.
22508 Negative selection means, regexp must not match for selection of an entry."
22515 'org-agenda-query-string
22520 org-todo-only
22521 org-agenda-query-string
22527 org-agenda-type))))
22533 "Jump to DATE in agenda."
22538 "Go to today."
22564 "Go forward in time by thee current span.
22565 With prefix ARG, go forward that many times the current span."
22572 greg2 nd)
22594 "Go backward in time by the current span.
22595 With prefix ARG, go backward that many times the current span."
22600 "Switch to daily view for agenda.
22601 With argument DAY-OF-YEAR, switch to that day of the year."
22606 "Switch to daily view for agenda.
22607 With argument ISO-WEEK, switch to the corresponding ISO week.
22608 If ISO-WEEK has more then 2 digits, only the last two encode the
22609 week. Any digits before this encode a year. So 200712 means
22610 week 12 of year 2007. Years in the range 1938-2037 can also be
22611 written as 2-digit years."
22616 "Switch to daily view for agenda.
22617 With argument MONTH, switch to that month."
22619 ;; FIXME: allow month like 812 to mean 2008 december
22622 "Switch to daily view for agenda.
22623 With argument YEAR, switch to that year.
22624 If MONTH has more then 2 digits, only the last two encode the
22625 month. Any digits before this encode a year. So 200712 means
22626 December year 2007. Years in the range 1938-2037 can also be
22627 written as 2-digit years."
22636 "Change the agenda view to SPAN.
22637 SPAN may be `day', `week', `month', `year'."
22642 org-starting-day))
22653 "Compute starting date and number of days for agenda.
22654 SPAN may be `day', `week', `month', `year'. The return value
22655 is a cons cell with the starting date and the number of days,
22656 so that the date SD will be in that range."
22661 nd w1 y1 m1 thisweek)
22695 sd)))
22701 sd))))
22705 "Return the iso week number."
22710 "Convert 2-digit years into 4-digit years.
22711 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
22712 The year 2000 cannot be abbreviated. Any year lager than 99
22713 is retrned unchanged."
22718 year)
22720 ;; FIXME: does not work if user makes date format that starts with a blank
22722 "Jump to the next line indicating a date in agenda buffer."
22734 "Jump to the previous line indicating a date in agenda buffer."
22741 ;; Initialize the highlight
22746 "Highlight a region with overlay."
22751 "Detach overlay INDEX."
22754 ;; FIXME this is currently not used.
22763 "Toggle follow mode in an agenda buffer."
22771 "Toggle log mode in an agenda buffer."
22781 "Toggle diary inclusion in an agenda buffer."
22791 "Toggle time grid in an agenda buffer."
22801 "Set the mode name to indicate all the small mode settings."
22820 "Show the priority of the current item.
22821 This priority is composed of the main priority given with the [#A] cookies,
22822 and by additional input from the age of a schedules or deadline entry."
22828 "Show the tags applicable to the current item."
22837 "Go to the Org-mode file which contains the item at point."
22856 "Normal hook run after an item has been shown from the agenda.
22860 "Kill the entry or subtree belonging to the current agenda entry."
22893 "Kill the entry or subtree belonging to the current agenda entry."
22911 "Remove all lines in the agenda that correspond to a given subtree.
22912 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22913 If this information is not given, the function uses the tree at point."
22936 "Follow the link in the current line, if any."
22945 "Get a variable from a referenced buffer and install it here."
22952 "Go to the Org-mode file which contains the item at point."
22969 "Go to the Org-mode file which contains the item at the mouse click."
22975 "Display the Org-mode file which contains the item at point."
22982 "Display the Org-mode file which contains the item at point and recenter."
22990 "Display the Org-mode file which contains the item at the mouse click."
22996 "Check if the entry is a diary link and abort if yes."
23004 "Show the subtree corresponding to the current entry in an indirect buffer.
23005 This calls the command `org-tree-to-indirect-buffer' from the original
23006 Org-mode buffer.
23007 With numerical prefix arg ARG, go up to this level and then take that tree.
23008 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
23009 dedicated frame)."
23022 "Marker pointing to the headline that last changed its TODO state
23026 "Switch TODO entry to next sequence."
23031 "Switch TODO entry to previous sequence."
23036 "Cycle TODO state of line at point, also in Org-mode file.
23037 This changes the line at point, all other lines in the agenda referring to
23038 the same tree node, and the headline of the tree node in the Org-mode file."
23048 newhead)
23069 "Change all lines in the agenda buffer which match HDMARKER.
23070 The new content of the line will be NEWHEAD (as modified by
23071 `org-format-agenda-item'). HDMARKER is checked with
23072 `equal' against all `org-hd-marker' text properties in the file.
23073 If FIXFACE is non-nil, the face of each item is modified acording to
23074 the new TODO state."
23076 props m pl undone-face done-face finish new dotime cat tags)
23106 undone-face done-face))))
23114 "Align all tags in agenda items to `org-agenda-tags-column'."
23127 org-agenda-tags-column))
23135 "Increase the priority of line at point, also in Org-mode file."
23140 "Decrease the priority of line at point, also in Org-mode file."
23145 "Set the priority of line at point, also in Org-mode file.
23146 This changes the line at point, all other lines in the agenda referring to
23147 the same tree node, and the headline of the tree node in the Org-mode file."
23156 newhead)
23172 "Get a list of all headline tags applicable at POS.
23173 POS defaults to point. If tags are inherited, the list contains
23174 the targets in the same sequence as the headlines appear, i.e.
23175 the tags of the current headline come last."
23191 tags)))
23195 tags)))
23197 ;; FIXME: should fix the tags property of the agenda line.
23199 "Set tags for the current headline."
23210 newhead)
23228 "Toggle the archive tag for the current entry."
23237 newhead)
23253 "Change the date of this item to one day later."
23272 "Change the date of this item to one day earlier."
23277 "Show new date stamp via text properties."
23278 ;; We use text properties to make this undoable
23287 ;; Use `duplicable' property to trigger undo recording
23302 "Change the date of this item. Date is prompted for, with default today.
23303 The prefix ARG is passed to the `org-time-stamp' command and can therefore
23304 be used to request time specification in the time stamp."
23322 "Schedule the item at point."
23332 ts)
23344 "Schedule the item at point."
23353 ts)
23363 "Return the heading of the current entry, without the stars."
23373 "Start the clock on the currently selected item."
23386 "Stop the currently running clock."
23394 "Cancel the currently running clock."
23402 "Make a diary entry, like the `i' command from the calendar.
23403 All the standard commands work: block, weekly etc."
23419 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23428 ;; We implement this by hacking the `calendar-cursor-to-date' function
23429 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23445 "Execute a calendar command from the agenda, with the date associated to
23446 the cursor position."
23455 ;; the following 3 vars are needed in the calendar
23469 "Display the phases of the moon for the 3 months around the cursor date."
23474 "Display the holidays for the 3 months around the cursor date."
23483 "Display sunrise and sunset for the cursor date.
23484 Latitude and longitude can be specified with the variables
23485 `calendar-latitude' and `calendar-longitude'. When called with prefix
23486 argument, latitude and longitude will be prompted for."
23496 "Open the Emacs calendar with the date at the cursor."
23509 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23510 This is a command that has to be installed in `calendar-mode-map'."
23514 nil))
23520 date s)
23546 ;;;; Embedded LaTeX
23561 "Toggle the minor `org-cdlatex-mode'.
23562 This mode supports entering LaTeX environment and math in LaTeX fragments
23563 in Org-mode.
23565 nil " OCDL" nil
23570 "Always return t in org-mode buffers.
23571 This is because we want to insert math symbols without dollars even outside
23572 the LaTeX math segments. If Orgmode thinks that point is actually inside
23573 en embedded LaTeX fragement, let texmathp do its job.
23590 "Unconditionally turn on `org-cdlatex-mode'."
23594 "Test if point is inside a LaTeX fragment.
23596 sequence appearing also before point.
23597 Even though the matchers for math are configurable, this function assumes
23599 delimiters are skipped when they have been removed by customization.
23600 The return value is nil, or a cons cell with the delimiter and
23601 and the position of this delimiter.
23603 This function does a reasonably good job, but can locally be fooled by
23604 for example currency specifications. For example it will assume being in
23606 fragments that are properly closed, but during editing, we have to live
23607 with the uncertainty caused by missing closing delimiters. This function
23608 looks only before point, not after."
23627 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23631 ;; count $$
23639 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23640 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23641 - inside a LaTeX fragment, or
23642 - after the first word in a line, where an abbreviation expansion could
23643 insert a LaTeX environment."
23656 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23657 Revert to the normal definition outside of these fragments."
23665 "Execute `cdlatex-math-modify' in LaTeX fragments.
23666 Revert to the normal definition outside of these fragments."
23678 "Remove all overlays with LaTeX fragment images in current buffer."
23683 "Preview the LaTeX fragment at point, or all locally or globally.
23684 If the cursor is in a LaTeX fragment, create the image and overlay
23685 it over the source code. If there is no fragment at point, display
23686 all fragments in the current text, from one headline to the next. With
23687 prefix SUBTREE, display all fragments in the current subtree. With a
23688 double prefix `C-u C-u', or when the cursor is before the first headline,
23689 display all fragments in the buffer.
23719 buffer-file-name)))
23725 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23726 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23727 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23734 "Replace LaTeX fragments with links to an image, and produce images."
23743 m n block linkfile movefile ov)
23744 ;; Check if there are old images files with this prefix, and remove them
23748 todir 'full
23750 ;; Check the different regular expressions
23770 txt movefile opt forbuffer)
23778 ov 'end-glyph
23781 ov 'display
23788 ;; This function borrows from Ganesh Swami's latex2png.el
23792 temporary-file-directory))
23821 "-D" dpi
23822 ;;"-x" scale "-y" scale
23824 "-o" pngfile
23825 dvifile)
23828 ;; Use the requested file name and clean up
23832 pngfile))))
23835 "Return an rgb color specification for dvipng."
23841 "Return string to be used as color value for an RGB component."
23844 ;;;; Exporting
23846 ;;; Variables, constants, and parameter plists
23902 "Return the property list with default settings for the export variables."
23906 rtn))
23909 "Return the property list with file-local settings for export."
23916 p key val text options)
23949 o)
23953 options)
23957 p))))
23963 val)))
23964 dir))
23971 rtn line level)
23976 ;; Beginning of a COMMENT subtree. Skip it.
23982 ;; an ordinary comment line
23983 )
23989 ;; a special table line that should be removed
23990 )
23997 \[v] limit export to visible part of outline tree
23999 \[a] export as ASCII
24001 \[h] export as HTML
24002 \[H] export as HTML to temporary buffer
24003 \[R] export region as HTML
24004 \[b] export as HTML and browse immediately
24005 \[x] export as XOXO
24007 \[l] export as LaTeX
24008 \[L] export as LaTeX to temporary buffer
24010 \[i] export current file as iCalendar file
24011 \[I] export all agenda files as iCalendar files
24012 \[c] export agenda files into combined iCalendar file
24014 \[F] publish current file
24015 \[P] publish current project
24016 \[X] publish... (project will be prompted for)
24036 r1 r2 ass)
24339 )
24340 "Entities for TeX->HTML translation.
24344 The list contains HTML entities for Latin-1, Greek and other symbols.
24345 It is supplemented by a number of commonly used TeX macros with appropriate
24348 ;;; General functions for all backends
24351 "Cleanup a buffer STRING so that links can be created safely."
24369 a b xx
24370 rtn p)
24374 ;; Remove license-to-kill stuff
24382 ;; Get rid of drawers
24387 'identity
24395 ;; Get the correct stuff before the first headline
24406 ;; Get rid of archived trees
24418 ;; Find targets in comments and move them out of comments,
24419 ;; but mark them as targets that should be invisible
24424 ;; Protect backend specific stuff, throw away the others.
24429 fmt)
24460 ;; Protect quoted subtrees
24468 ;; Protect verbatim elements
24475 ;; Remove subtrees that are commented
24481 ;; Remove special table lines
24493 ;; Specific LaTeX stuff
24501 ;; Specific HTML stuff
24503 ;; Convert LaTeX fragments to images
24508 org-current-export-file)))
24512 ;; Remove or replace comments
24521 ;; Find matches for radio targets and turn them into internal links
24528 ;; Find all links that contain a newline and put them into a single line
24530 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24536 ;; Normalize links: Convert angle and plain links into bracket links
24537 ;; Expand link abbreviations
24544 ;; added 'org-link face to links
24560 "]"
24568 ;; Find multiline emphasis and put them into single line
24582 rtn))
24585 "Get a title for the current document, from looking at the buffer."
24591 ;; Mark the line so that it will not be exported as normal text.
24595 ;; Return the title string
24599 "Return subtree title and exclude it from export."
24605 ;; This is a subtree, we take the title from the first heading
24612 title))
24615 "Take link text and make a safe target out of it."
24619 'identity
24625 "Get the minimum level in LINES."
24633 ;; Variable holding the vector with section numbers
24637 "Initialize the vector for the section numbers."
24654 "Return a string with the current section number.
24655 When LEVEL is non-nil, increase section numbers on that level."
24677 string))
24679 ;;; ASCII export
24687 "Export the outline as a pretty ASCII file.
24688 If there is an active region, export only the region.
24689 The prefix ARG specifies how many levels of the outline should become
24690 underlined headlines. The default is 3."
24719 filename))
24735 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24744 region
24745 :for-ascii t
24746 :skip-before-1st-heading
24749 :verbatim-multiline t
24750 :archived-trees
24754 thetoc have-headings first-heading-pos
24755 table-open table-buffer)
24773 ;; create local variables for all options, to make sure all called
24774 ;; functions get the correct information
24778 org-export-plist-vars)
24781 org-export-headline-levels))
24784 umax))
24786 ;; File header
24790 org-export-author-info)
24812 line)
24813 ;; This is a headline
24819 todo
24823 org-done-keywords)))
24824 ; TODO, not DONE
24828 line lines level))))
24835 t t txt)))
24840 txt))
24855 thetoc)
24857 ))))
24858 lines)
24863 ;; Remove the quoted HTML tags.
24865 ;; Remove targets
24868 ;; Replace internal links
24872 t nil line)))
24877 ;; a Headline
24886 ;; New table starts
24888 ;; Accumulate lines
24909 ;; insert the table of contents
24921 ;; Convert whitespace place holders
24931 ;; remove display and invisible chars
24947 "Do extra work for ASCII export"
24957 "Search the subtree below LINE for any TODO entries."
24960 line lv todo)
24968 org-done-keywords))))
24969 ; TODO, not DONE
24974 "Handle quoted HTML for ASCII export."
24977 ;; We just remove the tags for now.
24979 line)
24982 "Insert the string S centered and underline it with character UNDERLINE."
24991 "Insert a new level in ASCII export."
24997 org-export-ascii-bullets))
24999 ;; find the indentation of the next non-empty line
25020 "Create a copy of the visible part of the current buffer, and export it.
25021 The copy is created in a temporary buffer and removed after use.
25022 TYPE is the final key (as a string) that also select the export command in
25023 the `C-c C-e' export dispatcher.
25024 As a special case, if the you type SPC at the prompt, the temporary
25025 org-mode file will not be removed but presented to you so that you can
25026 continue to use it. The prefix arg ARG is passed through to the exporting
25027 command."
25030 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
25032 current-prefix-arg))
25047 s e)
25048 ;; Need to hack the drawers here.
25064 ;; Copy all comment lines to the end, to make sure #+ settings are
25065 ;; still available for the second export step. Kind of a hack, but
25066 ;; does do the trick.
25087 s))
25092 s))
25094 ;;; HTML export
25097 "Return a string with current options as keyword options.
25098 Does include HTML export options as well as TODO and CATEGORY stuff."
25100 "#+TITLE: %s
25101 #+AUTHOR: %s
25102 #+EMAIL: %s
25103 #+DATE: %s
25104 #+LANGUAGE: %s
25105 #+TEXT: Some descriptive text to be emitted. Several lines OK.
25106 #+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
25107 #+CATEGORY: %s
25108 #+SEQ_TODO: %s
25109 #+TYP_TODO: %s
25110 #+PRIORITIES: %c %c %c
25111 #+DRAWERS: %s
25112 #+STARTUP: %s %s %s %s %s
25113 #+TAGS: %s
25114 #+ARCHIVE: %s
25115 #+LINK: %s
25116 "
25119 org-export-default-language
25120 org-export-headline-levels
25121 org-export-with-section-numbers
25122 org-export-with-toc
25123 org-export-preserve-breaks
25124 org-export-html-expand
25125 org-export-with-fixed-width
25126 org-export-with-tables
25127 org-export-with-sub-superscripts
25128 org-export-with-special-strings
25129 org-export-with-footnotes
25130 org-export-with-emphasize
25131 org-export-with-TeX-macros
25132 org-export-with-LaTeX-fragments
25133 org-export-skip-text-before-1st-heading
25134 org-export-with-drawers
25135 org-export-with-tags
25137 "TODO FEEDBACK VERIFY DONE"
25138 "Me Jason Marie DONE"
25139 org-highest-priority org-lowest-priority org-default-priority
25156 org-archive-location
25157 "org file:~/org/%s.org"
25158 ))
25161 "Insert into the buffer a template with information for exporting."
25170 "Toggle the fixed-width export.
25171 If there is no active region, the QUOTE keyword at the current headline is
25172 inserted or removed. When present, it causes the text between this headline
25173 and the next to be exported as fixed-width text, and unmodified.
25174 If there is an active region, this command adds or removes a colon as the
25175 first character of this line. If the first character of a line is a colon,
25176 this line is also exported in fixed-width font."
25185 off)
25215 "Export the outline as HTML and immediately open it with a browser.
25216 If there is an active region, export only the region.
25217 The prefix ARG specifies how many levels of the outline should become
25218 headlines. The default is 3. Lower levels will become bulleted lists."
25224 "Call `org-export-as-html', may be used in batch processing as
25225 emacs --batch
25226 --load=$HOME/lib/emacs/org.el
25228 --visit=MyFile --funcall org-export-as-html-batch"
25232 "Call `org-exort-as-html` with output to a temporary buffer.
25233 No file is created. The prefix ARG is passed through to `org-export-as-html'."
25239 "Assume the current region has org-mode syntax, and convert it to HTML.
25240 This can be used in any buffer. For example, you could write an
25241 itemized list in org-mode syntax in an HTML buffer and then use this
25242 command to convert it."
25262 "Convert region from BEG to END in org-mode buffer to HTML.
25263 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
25264 contents, and only produce the region of converted text, useful for
25265 cut-and-paste operations.
25266 If BUFFER is a buffer or a string, use/create that buffer as a target
25267 of the converted HTML. If BUFFER is the symbol `string', return the
25268 produced HTML as a string and leave not buffer behind. For example,
25269 a Lisp program could call this function in the following way:
25271 (setq html (org-export-region-as-html beg end t 'string))
25273 When called interactively, the output buffer is selected, and shown
25274 in a window. A non-interactive call will only retunr the buffer."
25279 rtn)
25284 nil nil nil
25285 buffer body-only))
25289 rtn)))
25293 to-buffer body-only pub-dir)
25294 "Export the outline as a pretty HTML file.
25295 If there is an active region, export only the region. The prefix
25296 ARG specifies how many levels of the outline should become
25297 headlines. The default is 3. Lower levels will become bulleted
25298 lists. When HIDDEN is non-nil, don't display the HTML buffer.
25299 EXT-PLIST is a property list with external parameters overriding
25300 org-mode's default settings, but still inferior to file-local
25301 settings. When TO-BUFFER is non-nil, create a buffer with that
25302 name and export to that buffer. If TO-BUFFER is the symbol
25303 `string', don't leave any buffer behind but just return the
25304 resulting HTML as a string. When BODY-ONLY is set, don't produce
25305 the file header and footer, simply return the content of
25306 <body>...</body>, without even the body tags themselves. When
25307 PUB-DIR is set, use this as the publishing directory."
25310 ;; Make sure we have a file name when we need it.
25316 buffer-file-name))
25325 ext-plist
25331 valid thetoc have-headings first-heading-pos
25340 ;; The following two are dynamically scoped into other
25341 ;; routines below.
25361 default-directory))
25395 buffer-file-coding-system))
25397 coding-system))
25399 coding-system))
25411 region
25412 :emph-multiline t
25413 :for-html t
25414 :skip-before-1st-heading
25417 :archived-trees
25419 :add-text
25421 :LaTeX-fragments
25424 table-open type
25425 table-buffer table-orig-buffer
25426 ind start-is-num starter didclose
25427 rpl path desc descp desc1 desc2 link
25428 snumber fnc
25429 )
25448 ;; Get the language-dependent settings
25452 ;; Switch to the output buffer
25462 ;; create local variables for all options, to make sure all called
25463 ;; functions get the correct information
25467 org-export-plist-vars)
25469 org-export-headline-levels))
25472 umax))
25474 ;; File header
25480 <head>
25481 <title>%s</title>
25486 %s
25487 </head><body>
25488 "
25501 org-export-html-toplevel-hlevel
25503 org-export-html-toplevel-hlevel)
25504 thetoc)
25510 ;; This is a headline
25519 todo
25523 org-done-keywords)))
25524 ; TODO, not DONE
25528 line lines level))))
25553 ;; Check for targets
25558 t t line))
25561 target-alist))
25572 )))
25573 line)
25574 lines))
25587 ;; end of quote section?
25591 ;; inside a quote section?
25596 ;; verbatim lines
25610 ;; Protected HTML
25625 ;; Horizontal line
25630 ;; make targets to anchors
25638 t t line)))
25642 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25643 t t line)))
25649 t t line)))))
25653 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25654 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25655 ;; Also handle sub_superscripts and checkboxes
25659 ;; Format the links
25669 ;; Make an image out of the description if that is so wanted
25675 ;; FIXME: do we need to unescape here somewhere?
25685 ;; standard URL, just check if we need to inline an image
25693 ;; standard URL
25697 ;; FILE link
25700 thefile file-is-image-p search)
25708 t))
25717 ;; make sure this is can be used as target search
25742 ;; just publish the path, as default
25749 ;; TODO items
25757 org-done-keywords)
25762 ;; Does this contain a reference to a footnote?
25774 t t line))))))
25778 ;; This is a headline
25786 ;; Close any local lists before inserting a new header line
25792 in-local-list nil))
25796 head-count)
25797 ;; QUOTES
25805 ;; New table starts
25807 ;; Accumulate lines
25819 ;; Normal lines
25822 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25823 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25826 line)
25833 ;; empty line. Pretend indentation is large.
25835 0
25851 ;; Start new (level of) list
25858 ;; continue current list
25862 ;; we did close a list, normal text follows: need <p>
25868 "<b>[X]</b>"
25870 t t line))))
25872 ;; Empty lines start a new paragraph. If hand-formatted lists
25873 ;; are not fully interpreted, lines starting with "-", "+", "*"
25874 ;; also start a new paragraph.
25877 ;; Is this the start of a footnote?
25883 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25885 ;; Check if the line break needs to be conserved
25894 ;; Properly close all local lists and other lists
25897 ;; Close any local lists before inserting a new header line
25903 in-local-list nil))
25906 head-count)
25907 ;; the </div> to lose the last text-... div.
25939 ;; insert the table of contents
25956 ;; remove empty paragraphs and lists
25966 ;; Convert whitespace place holders
25986 "Format a table for ascii export."
25990 ;; Table made by table.el - test for spanning
25991 lines
25993 ;; A normal org table
25994 ;; Get rid of hlines at beginning and end
26000 ;; Check if the table has a marking column. If yes remove the
26001 ;; column and the special lines
26003 ;; Get rid of the vertical lines except for grouping
26005 rtn line vl1 start)
26027 vl))
26030 "Find out which HTML converter to use and return the HTML code."
26034 ;; A normal org table
26036 ;; Table made by table.el - test for spanning
26040 nil))
26041 lines)))
26047 hlines))))
26050 ;; We can use my own converter with HTML conversions
26052 ;; Need to use the code generator in table.el, with the original text.
26056 "Format a table into HTML."
26057 ;; Get rid of hlines at beginning and end
26063 ;; Check if the table has a marking column. If yes remove the
26064 ;; column and the special lines
26072 tbopen line fields html gr colgropen)
26084 ;; ignore this line
26086 ;; Break the line into fields
26104 html)))
26109 ;; Put in col tags with the alignment (unfortuntely often ignored...)
26125 html)
26131 "Check if the table has a marking column.
26132 If yes remove the column and the special lines."
26138 lines))
26153 nil)
26155 lines)))
26169 nil)
26174 ;; remove the first column
26176 lines))))
26179 "Format a table generated by table.el into HTML.
26180 This conversion does *not* use `table-generate-source' from table.el.
26181 This has the advantage that Org-mode's HTML conversions can be used.
26182 But it has the disadvantage, that no cell- or row-spanning is allowed."
26185 fields html empty)
26195 html
26197 html
26198 "<tr>"
26211 ;; Ignore this line
26213 ;; Break the line into fields and store the fields
26219 field-buffer))
26222 html))
26225 "Format a table into html, using `table-generate-source' from table.el.
26226 This has the advantage that cell- or row-spanning is allowed.
26227 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
26242 "Format time stamps in string S, or remove them."
26247 ;; never export CLOCK
26262 ;; Line break if line started and ended with time stamp stuff
26264 s
26268 r))))
26271 ;; convert & to &, < to < and > to >
26280 s)
26283 "Remove tags and time staps from lines going into the toc."
26292 t t s)))
26293 s)
26296 "Prepare STRING for HTML export. Applies all active conversions.
26297 If there are links in the string, don't modify these."
26300 m s l res)
26311 "Apply all active conversions to translate special ASCII to HTML."
26332 t t s))
26334 s)
26337 "Create a regular expression which will match a balanced sexp.
26338 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
26339 as single character strings.
26340 The regexp returned will match the entire expression including the
26341 delimiters. It will also define a single group which contains the
26342 match except for the outermost delimiters. The maximum depth of
26343 stacked delimiters is N. Escaping delimiters is not possible."
26379 "Convert special characters in STRING to HTML."
26381 e a re rpl start)
26388 string))
26391 "Convert sub- and superscripts in STRING to HTML."
26407 t t string)))))
26410 string))
26413 "Apply emphasis."
26420 rpl
26426 org-emphasis-alist))
26431 string))
26435 "Insert <p>, but first close previous paragraph if any."
26440 "Close paragraph if there is one open."
26445 "Close <li> if necessary."
26451 "Insert a new level in HTML export.
26452 When TITLE is nil, just close all open levels."
26462 ;; If title is nil, this means this function is called to close
26463 ;; all levels, so the rest is done only if title is given
26475 t t title)))
26491 (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d\">\n<h%d id=\"sec-%s\">%s</h%d>\n<div id=\"text-%s\">\n"
26492 snumber level level snumber title level snumber))
26496 "Terminate one level in HTML export."
26502 ;;; iCalendar export
26504 ;;;###autoload
26506 "Export current file as an iCalendar file.
26507 The iCalendar file will be located in the same directory as the Org-mode
26508 file, but with extension `.ics'."
26512 ;;;###autoload
26514 "Export all files in `org-agenda-files' to iCalendar .ics files.
26515 Each iCalendar file will be located in the same directory as the Org-mode
26516 file, but with extension `.ics'."
26520 ;;;###autoload
26522 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26523 The file is stored under the name `org-combined-agenda-icalendar-file'."
26528 "Create iCalendar files for all elements of FILES.
26529 If COMBINE is non-nil, combine all calendar entries into a single large
26530 file and store it under the name `org-combined-agenda-icalendar-file'."
26535 org-export-publishing-directory)))
26536 file ical-file ical-buffer category started org-agenda-new-buffers)
26541 org-combined-agenda-icalendar-file
26574 "Hook run after an iCalendar file has been saved.
26575 The iCalendar buffer is still current when this hook is run.
26576 A good way to use this is to tell a desktop calenndar application to re-read
26580 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26581 When COMBINE is non nil, add the category to each line."
26588 scheduledp deadlinep tmp pri category entry location summary desc
26603 inc t
26610 t org-icalendar-include-body)
26620 pos)
26625 ts)
26628 ;; donep (org-entry-is-done-p)
26629 ))
26648 t t summary)))
26655 %s
26656 %s%s
26657 SUMMARY:%s%s%s
26658 CATEGORIES:%s
26662 rrule summary
26667 category)))))
26672 ;; Get all the literal sexps
26703 )
26710 t org-icalendar-include-body)
26716 t t hd)))
26726 %s
26727 SUMMARY:%s%s%s
26728 CATEGORIES:%s
26729 SEQUENCE:1
26730 PRIORITY:%d
26731 STATUS:%s
26733 dts
26739 category pri status)))))))))
26742 "Take out stuff and quote what needs to be quoted.
26743 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26744 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26745 characters."
26747 nil
26766 s))
26769 "Clean-up description string."
26775 "Start an iCalendar file by inserting the header."
26781 VERSION:2.0
26782 X-WR-CALNAME:%s
26783 PRODID:-//%s//Emacs with Org-mode//EN
26784 X-WR-TIMEZONE:%s
26788 "Finish an iCalendar file by inserting the END statement."
26792 "Take a time string S and convert it to iCalendar format.
26793 KEYWORD is added in front, to make a complete line like DTSTART....
26794 When INC is non-nil, increase the hour by two (if time string contains
26795 a time), or the day by one (if it does not contain a time)."
26797 t2 fmt have-time time)
26813 ;;; XOXO export
26821 "Export the org buffer as XOXO.
26822 The XOXO buffer is named *xoxo-<source buffer name>*"
26824 ;; A quickie abstraction
26826 ;; Output everything as XOXO
26840 ;; Check the output buffer is empty.
26842 ;; Kick off the output
26859 ;; Handle level rendering
26876 )
26880 ;; And output the new li
26886 ;; Finally finish off the ol
26893 ;; Finish the buffer off and clean it up.
26898 )))
26901 ;;;; Key bindings
26903 ;; Make `C-c C-x' a prefix key
26906 ;; TAB key with modifiers
26913 ;; The following line is necessary under Suse GNU/Linux
26919 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26920 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26921 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26923 ;; Cursor keys with modifiers
26924 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26925 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26926 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26927 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26929 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26930 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26931 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26932 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26934 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26935 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26936 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26937 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26939 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26940 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26942 ;;; Extra keys for tty access.
26943 ;; We only set them when really needed because otherwise the
26944 ;; menus don't show the simple keys
26946 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26947 (not window-system))
26948 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26949 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26950 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26951 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26952 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26953 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26954 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26955 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26956 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26957 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26958 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26959 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26960 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26961 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26962 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26963 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26964 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26965 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26966 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26967 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26968 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26969 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26971 ;; All the other keys
26973 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26974 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26975 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26976 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26977 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26978 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26979 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26980 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26981 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26982 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26983 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26984 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26985 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26986 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26987 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26989 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26990 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26991 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26992 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26993 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26994 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26995 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26996 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26997 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26998 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26999 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
27000 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
27001 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
27002 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
27003 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
27004 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
27005 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
27007 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
27008 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
27009 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
27010 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27011 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
27012 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
27013 (org-defkey org-mode-map "\C-c^" 'org-sort)
27014 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
27015 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
27016 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
27017 (org-defkey org-mode-map "\C-m" 'org-return)
27018 (org-defkey org-mode-map "\C-j" 'org-return-indent)
27019 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
27020 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
27021 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
27022 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
27023 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
27024 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
27025 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
27026 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
27027 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
27028 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
27029 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
27030 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
27031 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
27032 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
27033 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
27035 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
27036 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
27037 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
27038 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
27040 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
27041 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
27042 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
27043 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
27044 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
27045 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
27046 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
27047 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
27048 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
27049 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
27050 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
27051 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
27053 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
27055 (when (featurep 'xemacs)
27056 (org-defkey org-mode-map 'button3 'popup-mode-menu))
27058 (defsubst org-table-p () (org-at-table-p))
27060 (defun org-self-insert-command (N)
27061 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
27062 If the cursor is in a table looking at whitespace, the whitespace is
27063 overwritten, and the table is not marked as requiring realignment."
27064 (interactive "p")
27065 (if (and (org-table-p)
27066 (progn
27067 ;; check if we blank the field, and if that triggers align
27068 (and org-table-auto-blank-field
27069 (member last-command
27070 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
27072 ;; got extra space, this field does not determine column width
27073 (let (org-table-may-need-update) (org-table-blank-field))
27074 ;; no extra space, this field may determine column width
27075 (org-table-blank-field)))
27076 t)
27077 (eq N 1)
27079 (let (org-table-may-need-update)
27080 (goto-char (1- (match-end 0)))
27081 (delete-backward-char 1)
27082 (goto-char (match-beginning 0))
27083 (self-insert-command N))
27084 (setq org-table-may-need-update t)
27085 (self-insert-command N)
27086 (org-fix-tags-on-the-fly)))
27088 (defun org-fix-tags-on-the-fly ()
27089 (when (and (equal (char-after (point-at-bol)) ?*)
27090 (org-on-heading-p))
27091 (org-align-tags-here org-tags-column)))
27093 (defun org-delete-backward-char (N)
27094 "Like `delete-backward-char', insert whitespace at field end in tables.
27095 When deleting backwards, in tables this function will insert whitespace in
27097 still be marked for re-alignment if the field did fill the entire column,
27098 because, in this case the deletion might narrow the column."
27099 (interactive "p")
27100 (if (and (org-table-p)
27101 (eq N 1)
27102 (string-match "|" (buffer-substring (point-at-bol) (point)))
27103 (looking-at ".*?|"))
27104 (let ((pos (point))
27106 (c org-table-may-need-update))
27107 (backward-delete-char N)
27108 (skip-chars-forward "^|")
27109 (insert " ")
27110 (goto-char (1- pos))
27111 ;; noalign: if there were two spaces at the end, this field
27112 ;; does not determine the width of the column.
27113 (if noalign (setq org-table-may-need-update c)))
27114 (backward-delete-char N)
27115 (org-fix-tags-on-the-fly)))
27117 (defun org-delete-char (N)
27118 "Like `delete-char', but insert whitespace at field end in tables.
27119 When deleting characters, in tables this function will insert whitespace in
27121 still be marked for re-alignment if the field did fill the entire column,
27122 because, in this case the deletion might narrow the column."
27123 (interactive "p")
27124 (if (and (org-table-p)
27125 (not (bolp))
27126 (not (= (char-after) ?|))
27127 (eq N 1))
27128 (if (looking-at ".*?|")
27129 (let ((pos (point))
27131 (c org-table-may-need-update))
27132 (replace-match (concat
27133 (substring (match-string 0) 1 -1)
27134 " |"))
27135 (goto-char pos)
27136 ;; noalign: if there were two spaces at the end, this field
27137 ;; does not determine the width of the column.
27138 (if noalign (setq org-table-may-need-update c)))
27139 (delete-char N))
27140 (delete-char N)
27141 (org-fix-tags-on-the-fly)))
27143 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
27144 (put 'org-self-insert-command 'delete-selection t)
27145 (put 'orgtbl-self-insert-command 'delete-selection t)
27146 (put 'org-delete-char 'delete-selection 'supersede)
27147 (put 'org-delete-backward-char 'delete-selection 'supersede)
27149 ;; Make `flyspell-mode' delay after some commands
27150 (put 'org-self-insert-command 'flyspell-delayed t)
27151 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
27152 (put 'org-delete-char 'flyspell-delayed t)
27153 (put 'org-delete-backward-char 'flyspell-delayed t)
27155 ;; Make pabbrev-mode expand after org-mode commands
27156 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
27157 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
27159 ;; How to do this: Measure non-white length of current string
27160 ;; If equal to column width, we should realign.
27162 (defun org-remap (map &rest commands)
27163 "In MAP, remap the functions given in COMMANDS.
27164 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
27165 (let (new old)
27166 (while commands
27167 (setq old (pop commands) new (pop commands))
27168 (if (fboundp 'command-remapping)
27169 (org-defkey map (vector 'remap old) new)
27170 (substitute-key-definition old new map global-map)))))
27172 (when (eq org-enable-table-editor 'optimized)
27173 ;; If the user wants maximum table support, we need to hijack
27174 ;; some standard editing functions
27175 (org-remap org-mode-map
27176 'self-insert-command 'org-self-insert-command
27177 'delete-char 'org-delete-char
27178 'delete-backward-char 'org-delete-backward-char)
27179 (org-defkey org-mode-map "|" 'org-force-self-insert))
27181 (defun org-shiftcursor-error ()
27182 "Throw an error because Shift-Cursor command was applied in wrong context."
27183 (error "This command is active in special context like tables, headlines or timestamps"))
27185 (defun org-shifttab (&optional arg)
27186 "Global visibility cycling or move to previous table field.
27187 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
27188 on context.
27189 See the individual commands for more information."
27190 (interactive "P")
27191 (cond
27192 ((org-at-table-p) (call-interactively 'org-table-previous-field))
27193 (arg (message "Content view to level: ")
27194 (org-content (prefix-numeric-value arg))
27195 (setq org-cycle-global-status 'overview))
27196 (t (call-interactively 'org-global-cycle))))
27198 (defun org-shiftmetaleft ()
27199 "Promote subtree or delete table column.
27200 Calls `org-promote-subtree', `org-outdent-item',
27201 or `org-table-delete-column', depending on context.
27202 See the individual commands for more information."
27203 (interactive)
27204 (cond
27205 ((org-at-table-p) (call-interactively 'org-table-delete-column))
27206 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
27207 ((org-at-item-p) (call-interactively 'org-outdent-item))
27208 (t (org-shiftcursor-error))))
27210 (defun org-shiftmetaright ()
27211 "Demote subtree or insert table column.
27212 Calls `org-demote-subtree', `org-indent-item',
27213 or `org-table-insert-column', depending on context.
27214 See the individual commands for more information."
27215 (interactive)
27216 (cond
27217 ((org-at-table-p) (call-interactively 'org-table-insert-column))
27218 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
27219 ((org-at-item-p) (call-interactively 'org-indent-item))
27220 (t (org-shiftcursor-error))))
27222 (defun org-shiftmetaup (&optional arg)
27223 "Move subtree up or kill table row.
27224 Calls `org-move-subtree-up' or `org-table-kill-row' or
27225 `org-move-item-up' depending on context. See the individual commands
27226 for more information."
27227 (interactive "P")
27228 (cond
27229 ((org-at-table-p) (call-interactively 'org-table-kill-row))
27230 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27231 ((org-at-item-p) (call-interactively 'org-move-item-up))
27232 (t (org-shiftcursor-error))))
27233 (defun org-shiftmetadown (&optional arg)
27234 "Move subtree down or insert table row.
27235 Calls `org-move-subtree-down' or `org-table-insert-row' or
27236 `org-move-item-down', depending on context. See the individual
27237 commands for more information."
27238 (interactive "P")
27239 (cond
27240 ((org-at-table-p) (call-interactively 'org-table-insert-row))
27241 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27242 ((org-at-item-p) (call-interactively 'org-move-item-down))
27243 (t (org-shiftcursor-error))))
27245 (defun org-metaleft (&optional arg)
27246 "Promote heading or move table column to left.
27247 Calls `org-do-promote' or `org-table-move-column', depending on context.
27248 With no specific context, calls the Emacs default `backward-word'.
27249 See the individual commands for more information."
27250 (interactive "P")
27251 (cond
27252 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
27253 ((or (org-on-heading-p) (org-region-active-p))
27254 (call-interactively 'org-do-promote))
27255 ((org-at-item-p) (call-interactively 'org-outdent-item))
27256 (t (call-interactively 'backward-word))))
27258 (defun org-metaright (&optional arg)
27259 "Demote subtree or move table column to right.
27260 Calls `org-do-demote' or `org-table-move-column', depending on context.
27261 With no specific context, calls the Emacs default `forward-word'.
27262 See the individual commands for more information."
27263 (interactive "P")
27264 (cond
27265 ((org-at-table-p) (call-interactively 'org-table-move-column))
27266 ((or (org-on-heading-p) (org-region-active-p))
27267 (call-interactively 'org-do-demote))
27268 ((org-at-item-p) (call-interactively 'org-indent-item))
27269 (t (call-interactively 'forward-word))))
27271 (defun org-metaup (&optional arg)
27272 "Move subtree up or move table row up.
27273 Calls `org-move-subtree-up' or `org-table-move-row' or
27274 `org-move-item-up', depending on context. See the individual commands
27275 for more information."
27276 (interactive "P")
27277 (cond
27278 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
27279 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27280 ((org-at-item-p) (call-interactively 'org-move-item-up))
27281 (t (transpose-lines 1) (beginning-of-line -1))))
27283 (defun org-metadown (&optional arg)
27284 "Move subtree down or move table row down.
27285 Calls `org-move-subtree-down' or `org-table-move-row' or
27286 `org-move-item-down', depending on context. See the individual
27287 commands for more information."
27288 (interactive "P")
27289 (cond
27290 ((org-at-table-p) (call-interactively 'org-table-move-row))
27291 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27292 ((org-at-item-p) (call-interactively 'org-move-item-down))
27293 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
27295 (defun org-shiftup (&optional arg)
27296 "Increase item in timestamp or increase priority of current headline.
27297 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
27298 depending on context. See the individual commands for more information."
27299 (interactive "P")
27300 (cond
27301 ((org-at-timestamp-p t)
27302 (call-interactively (if org-edit-timestamp-down-means-later
27303 'org-timestamp-down 'org-timestamp-up)))
27304 ((org-on-heading-p) (call-interactively 'org-priority-up))
27305 ((org-at-item-p) (call-interactively 'org-previous-item))
27306 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
27308 (defun org-shiftdown (&optional arg)
27309 "Decrease item in timestamp or decrease priority of current headline.
27310 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
27311 depending on context. See the individual commands for more information."
27312 (interactive "P")
27313 (cond
27314 ((org-at-timestamp-p t)
27315 (call-interactively (if org-edit-timestamp-down-means-later
27316 'org-timestamp-up 'org-timestamp-down)))
27317 ((org-on-heading-p) (call-interactively 'org-priority-down))
27318 (t (call-interactively 'org-next-item))))
27320 (defun org-shiftright ()
27321 "Next TODO keyword or timestamp one day later, depending on context."
27322 (interactive)
27323 (cond
27324 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
27325 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
27326 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
27327 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
27328 (t (org-shiftcursor-error))))
27330 (defun org-shiftleft ()
27331 "Previous TODO keyword or timestamp one day earlier, depending on context."
27332 (interactive)
27333 (cond
27334 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
27335 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
27336 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
27337 ((org-at-property-p)
27338 (call-interactively 'org-property-previous-allowed-value))
27339 (t (org-shiftcursor-error))))
27341 (defun org-shiftcontrolright ()
27342 "Switch to next TODO set."
27343 (interactive)
27344 (cond
27345 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
27346 (t (org-shiftcursor-error))))
27348 (defun org-shiftcontrolleft ()
27349 "Switch to previous TODO set."
27350 (interactive)
27351 (cond
27352 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
27353 (t (org-shiftcursor-error))))
27355 (defun org-ctrl-c-ret ()
27356 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
27357 (interactive)
27358 (cond
27359 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27360 (t (call-interactively 'org-insert-heading))))
27362 (defun org-copy-special ()
27363 "Copy region in table or copy current subtree.
27364 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27365 See the individual commands for more information."
27366 (interactive)
27367 (call-interactively
27368 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27370 (defun org-cut-special ()
27371 "Cut region in table or cut current subtree.
27372 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27373 See the individual commands for more information."
27374 (interactive)
27375 (call-interactively
27376 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27378 (defun org-paste-special (arg)
27379 "Paste rectangular region into table, or past subtree relative to level.
27380 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27381 See the individual commands for more information."
27382 (interactive "P")
27383 (if (org-at-table-p)
27384 (org-table-paste-rectangle)
27385 (org-paste-subtree arg)))
27387 (defun org-ctrl-c-ctrl-c (&optional arg)
27388 "Set tags in headline, or update according to changed information at point.
27390 This command does many different things, depending on context:
27392 - If the cursor is in a headline, prompt for tags and insert them
27393 into the current line, aligned to `org-tags-column'. When called
27394 with prefix arg, realign all tags in the current buffer.
27396 - If the cursor is in one of the special #+KEYWORD lines, this
27397 triggers scanning the buffer for these lines and updating the
27398 information.
27400 - If the cursor is inside a table, realign the table. This command
27401 works even if the automatic table editor has been turned off.
27403 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27404 the entire table.
27406 - If the cursor is a the beginning of a dynamic block, update it.
27408 - If the cursor is inside a table created by the table.el package,
27409 activate that table.
27411 - If the current buffer is a remember buffer, close note and file it.
27412 with a prefix argument, file it without further interaction to the default
27413 location.
27415 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27416 links in this buffer.
27418 - If the cursor is on a numbered item in a plain list, renumber the
27419 ordered list.
27421 - If the cursor is on a checkbox, toggle it."
27422 (interactive "P")
27423 (let ((org-enable-table-editor t))
27424 (cond
27425 ((or org-clock-overlays
27426 org-occur-highlights
27427 org-latex-fragment-image-overlays)
27428 (org-remove-clock-overlays)
27429 (org-remove-occur-highlights)
27430 (org-remove-latex-fragment-image-overlays)
27431 (message "Temporary highlights/overlays removed from current buffer"))
27432 ((and (local-variable-p 'org-finish-function (current-buffer))
27433 (fboundp org-finish-function))
27434 (funcall org-finish-function))
27435 ((org-at-property-p)
27436 (call-interactively 'org-property-action))
27437 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27438 ((org-on-heading-p) (call-interactively 'org-set-tags))
27439 ((org-at-table.el-p)
27440 (require 'table)
27441 (beginning-of-line 1)
27442 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27443 (call-interactively 'table-recognize-table))
27444 ((org-at-table-p)
27445 (org-table-maybe-eval-formula)
27446 (if arg
27447 (call-interactively 'org-table-recalculate)
27448 (org-table-maybe-recalculate-line))
27449 (call-interactively 'org-table-align))
27450 ((org-at-item-checkbox-p)
27451 (call-interactively 'org-toggle-checkbox))
27452 ((org-at-item-p)
27453 (call-interactively 'org-maybe-renumber-ordered-list))
27455 ;; Dynamic block
27456 (beginning-of-line 1)
27457 (org-update-dblock))
27459 (cond
27460 ((equal (match-string 1) "TBLFM")
27461 ;; Recalculate the table before this line
27462 (save-excursion
27463 (beginning-of-line 1)
27465 (if (org-at-table-p)
27466 (org-call-with-arg 'org-table-recalculate t))))
27467 (t
27468 (call-interactively 'org-mode-restart))))
27469 (t (error "C-c C-c can do nothing useful at this location.")))))
27471 (defun org-mode-restart ()
27472 "Restart Org-mode, to scan again for special lines.
27473 Also updates the keyword regular expressions."
27474 (interactive)
27475 (let ((org-inhibit-startup t)) (org-mode))
27476 (message "Org-mode restarted to refresh keyword and special line setup"))
27478 (defun org-kill-note-or-show-branches ()
27479 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27480 (interactive)
27481 (if (not org-finish-function)
27482 (call-interactively 'show-branches)
27483 (let ((org-note-abort t))
27484 (funcall org-finish-function))))
27486 (defun org-return (&optional indent)
27487 "Goto next table row or insert a newline.
27488 Calls `org-table-next-row' or `newline', depending on context.
27489 See the individual commands for more information."
27490 (interactive)
27491 (cond
27492 ((bobp) (if indent (newline-and-indent) (newline)))
27493 ((and (org-at-heading-p)
27494 (looking-at
27496 (org-show-entry)
27497 (end-of-line 1)
27498 (newline))
27499 ((org-at-table-p)
27500 (org-table-justify-field-maybe)
27501 (call-interactively 'org-table-next-row))
27502 (t (if indent (newline-and-indent) (newline)))))
27504 (defun org-return-indent ()
27505 "Goto next table row or insert a newline and indent.
27506 Calls `org-table-next-row' or `newline-and-indent', depending on
27507 context. See the individual commands for more information."
27508 (interactive)
27509 (org-return t))
27511 (defun org-ctrl-c-star ()
27512 "Compute table, or change heading status of lines.
27513 Calls `org-table-recalculate' or `org-toggle-region-headlines',
27514 depending on context. This will also turn a plain list item or a normal
27515 line into a subheading."
27516 (interactive)
27517 (cond
27518 ((org-at-table-p)
27519 (call-interactively 'org-table-recalculate))
27520 ((org-region-active-p)
27521 ;; Convert all lines in region to list items
27522 (call-interactively 'org-toggle-region-headings))
27523 ((org-on-heading-p)
27524 (org-toggle-region-headings (point-at-bol)
27525 (min (1+ (point-at-eol)) (point-max))))
27526 ((org-at-item-p)
27527 ;; Convert to heading
27528 (let ((level (save-match-data
27529 (save-excursion
27530 (condition-case nil
27531 (progn
27532 (org-back-to-heading t)
27533 (funcall outline-level))
27534 (error 0))))))
27535 (replace-match
27536 (concat (make-string (org-get-valid-level level 1) ?*) " ") t t)))
27537 (t (org-toggle-region-headings (point-at-bol)
27538 (min (1+ (point-at-eol)) (point-max))))))
27540 (defun org-ctrl-c-minus ()
27541 "Insert separator line in table or modify bullet status of line.
27542 Also turns a plain line or a region of lines into list items.
27543 Calls `org-table-insert-hline', `org-toggle-region-items', or
27544 `org-cycle-list-bullet', depending on context."
27545 (interactive)
27546 (cond
27547 ((org-at-table-p)
27548 (call-interactively 'org-table-insert-hline))
27549 ((org-on-heading-p)
27550 ;; Convert to item
27551 (save-excursion
27552 (beginning-of-line 1)
27554 (replace-match (concat (make-string (- (match-end 0) (point) 1) ?\ ) "- ")))))
27555 ((org-region-active-p)
27556 ;; Convert all lines in region to list items
27557 (call-interactively 'org-toggle-region-items))
27558 ((org-in-item-p)
27559 (call-interactively 'org-cycle-list-bullet))
27560 (t (org-toggle-region-items (point-at-bol)
27561 (min (1+ (point-at-eol)) (point-max))))))
27563 (defun org-toggle-region-items (beg end)
27564 "Convert all lines in region to list items.
27565 If the first line is already an item, convert all list items in the region
27566 to normal lines."
27567 (interactive "r")
27568 (let (l2 l)
27569 (save-excursion
27570 (goto-char end)
27571 (setq l2 (org-current-line))
27572 (goto-char beg)
27573 (beginning-of-line 1)
27574 (setq l (1- (org-current-line)))
27575 (if (org-at-item-p)
27576 ;; We already have items, de-itemize
27577 (while (< (setq l (1+ l)) l2)
27578 (when (org-at-item-p)
27579 (goto-char (match-beginning 2))
27580 (delete-region (match-beginning 2) (match-end 2))
27582 (beginning-of-line 2))
27583 (while (< (setq l (1+ l)) l2)
27584 (unless (org-at-item-p)
27587 (beginning-of-line 2))))))
27589 (defun org-toggle-region-headings (beg end)
27590 "Convert all lines in region to list items.
27591 If the first line is already an item, convert all list items in the region
27592 to normal lines."
27593 (interactive "r")
27594 (let (l2 l)
27595 (save-excursion
27596 (goto-char end)
27597 (setq l2 (org-current-line))
27598 (goto-char beg)
27599 (beginning-of-line 1)
27600 (setq l (1- (org-current-line)))
27601 (if (org-on-heading-p)
27602 ;; We already have headlines, de-star them
27603 (while (< (setq l (1+ l)) l2)
27604 (when (org-on-heading-p t)
27605 (and (looking-at outline-regexp) (replace-match "")))
27606 (beginning-of-line 2))
27607 (let* ((stars (save-excursion
27608 (re-search-backward org-complex-heading-regexp nil t)
27609 (or (match-string 1) "*")))
27610 (add-stars (if org-odd-levels-only "**" "*"))
27612 (while (< (setq l (1+ l)) l2)
27613 (unless (org-on-heading-p)
27615 (replace-match rpl)))
27616 (beginning-of-line 2)))))))
27618 (defun org-meta-return (&optional arg)
27619 "Insert a new heading or wrap a region in a table.
27620 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27621 See the individual commands for more information."
27622 (interactive "P")
27623 (cond
27624 ((org-at-table-p)
27625 (call-interactively 'org-table-wrap-region))
27626 (t (call-interactively 'org-insert-heading))))
27628 ;;; Menu entries
27630 ;; Define the Org-mode menus
27631 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27632 '("Tbl"
27633 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27634 ["Next Field" org-cycle (org-at-table-p)]
27635 ["Previous Field" org-shifttab (org-at-table-p)]
27636 ["Next Row" org-return (org-at-table-p)]
27637 "--"
27638 ["Blank Field" org-table-blank-field (org-at-table-p)]
27639 ["Edit Field" org-table-edit-field (org-at-table-p)]
27640 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27641 "--"
27642 ("Column"
27643 ["Move Column Left" org-metaleft (org-at-table-p)]
27644 ["Move Column Right" org-metaright (org-at-table-p)]
27645 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27646 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27647 ("Row"
27648 ["Move Row Up" org-metaup (org-at-table-p)]
27649 ["Move Row Down" org-metadown (org-at-table-p)]
27650 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27651 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27652 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27653 "--"
27654 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27655 ("Rectangle"
27656 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27657 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27658 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27659 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27660 "--"
27661 ("Calculate"
27662 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27663 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27664 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27665 "--"
27666 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27667 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27668 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27669 "--"
27670 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27671 "--"
27672 ["Sum Column/Rectangle" org-table-sum
27673 (or (org-at-table-p) (org-region-active-p))]
27674 ["Which Column?" org-table-current-column (org-at-table-p)])
27675 ["Debug Formulas"
27676 org-table-toggle-formula-debugger
27677 :style toggle :selected org-table-formula-debug]
27678 ["Show Col/Row Numbers"
27679 org-table-toggle-coordinate-overlays
27680 :style toggle :selected org-table-overlay-coordinates]
27681 "--"
27682 ["Create" org-table-create (and (not (org-at-table-p))
27683 org-enable-table-editor)]
27684 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27685 ["Import from File" org-table-import (not (org-at-table-p))]
27686 ["Export to File" org-table-export (org-at-table-p)]
27687 "--"
27688 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27690 (easy-menu-define org-org-menu org-mode-map "Org menu"
27691 '("Org"
27692 ("Show/Hide"
27693 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27694 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27695 ["Sparse Tree" org-occur t]
27696 ["Reveal Context" org-reveal t]
27697 ["Show All" show-all t]
27698 "--"
27699 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27700 "--"
27701 ["New Heading" org-insert-heading t]
27702 ("Navigate Headings"
27703 ["Up" outline-up-heading t]
27704 ["Next" outline-next-visible-heading t]
27705 ["Previous" outline-previous-visible-heading t]
27706 ["Next Same Level" outline-forward-same-level t]
27707 ["Previous Same Level" outline-backward-same-level t]
27708 "--"
27709 ["Jump" org-goto t])
27710 ("Edit Structure"
27711 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27712 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27713 "--"
27714 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27715 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27716 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27717 "--"
27718 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27719 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27720 ["Demote Heading" org-metaright (not (org-at-table-p))]
27721 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27722 "--"
27723 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27724 "--"
27725 ["Convert to odd levels" org-convert-to-odd-levels t]
27726 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27727 ("Editing"
27728 ["Emphasis..." org-emphasize t])
27729 ("Archive"
27730 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27731 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27732 ; :active t :keys "C-u C-c C-x C-a"]
27733 ["Sparse trees open ARCHIVE trees"
27734 (setq org-sparse-tree-open-archived-trees
27735 (not org-sparse-tree-open-archived-trees))
27736 :style toggle :selected org-sparse-tree-open-archived-trees]
27737 ["Cycling opens ARCHIVE trees"
27738 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27739 :style toggle :selected org-cycle-open-archived-trees]
27740 ["Agenda includes ARCHIVE trees"
27741 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27742 :style toggle :selected (not org-agenda-skip-archived-trees)]
27743 "--"
27744 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27745 ; ["Check and Move Children" (org-archive-subtree '(4))
27746 ; :active t :keys "C-u C-c C-x C-s"]
27747 )
27748 "--"
27749 ("TODO Lists"
27750 ["TODO/DONE/-" org-todo t]
27751 ("Select keyword"
27752 ["Next keyword" org-shiftright (org-on-heading-p)]
27753 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27754 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27755 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27756 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27757 ["Show TODO Tree" org-show-todo-tree t]
27758 ["Global TODO list" org-todo-list t]
27759 "--"
27760 ["Set Priority" org-priority t]
27761 ["Priority Up" org-shiftup t]
27762 ["Priority Down" org-shiftdown t])
27763 ("TAGS and Properties"
27764 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27765 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27766 "--"
27767 ["Set property" 'org-set-property t]
27768 ["Column view of properties" org-columns t]
27769 ["Insert Column View DBlock" org-insert-columns-dblock t])
27770 ("Dates and Scheduling"
27771 ["Timestamp" org-time-stamp t]
27772 ["Timestamp (inactive)" org-time-stamp-inactive t]
27773 ("Change Date"
27774 ["1 Day Later" org-shiftright t]
27775 ["1 Day Earlier" org-shiftleft t]
27776 ["1 ... Later" org-shiftup t]
27777 ["1 ... Earlier" org-shiftdown t])
27778 ["Compute Time Range" org-evaluate-time-range t]
27779 ["Schedule Item" org-schedule t]
27780 ["Deadline" org-deadline t]
27781 "--"
27782 ["Custom time format" org-toggle-time-stamp-overlays
27783 :style radio :selected org-display-custom-times]
27784 "--"
27785 ["Goto Calendar" org-goto-calendar t]
27786 ["Date from Calendar" org-date-from-calendar t])
27787 ("Logging work"
27788 ["Clock in" org-clock-in t]
27789 ["Clock out" org-clock-out t]
27790 ["Clock cancel" org-clock-cancel t]
27791 ["Goto running clock" org-clock-goto t]
27792 ["Display times" org-clock-display t]
27793 ["Create clock table" org-clock-report t]
27794 "--"
27795 ["Record DONE time"
27796 (progn (setq org-log-done (not org-log-done))
27797 (message "Switching to %s will %s record a timestamp"
27798 (car org-done-keywords)
27799 (if org-log-done "automatically" "not")))
27800 :style toggle :selected org-log-done])
27801 "--"
27802 ["Agenda Command..." org-agenda t]
27803 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27804 ("File List for Agenda")
27805 ("Special views current file"
27806 ["TODO Tree" org-show-todo-tree t]
27807 ["Check Deadlines" org-check-deadlines t]
27808 ["Timeline" org-timeline t]
27809 ["Tags Tree" org-tags-sparse-tree t])
27810 "--"
27811 ("Hyperlinks"
27812 ["Store Link (Global)" org-store-link t]
27813 ["Insert Link" org-insert-link t]
27814 ["Follow Link" org-open-at-point t]
27815 "--"
27816 ["Next link" org-next-link t]
27817 ["Previous link" org-previous-link t]
27818 "--"
27819 ["Descriptive Links"
27820 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27821 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27822 ["Literal Links"
27823 (progn
27824 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27825 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27826 "--"
27827 ["Export/Publish..." org-export t]
27828 ("LaTeX"
27829 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27830 :selected org-cdlatex-mode]
27831 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27832 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27833 ["Modify math symbol" org-cdlatex-math-modify
27834 (org-inside-LaTeX-fragment-p)]
27835 ["Export LaTeX fragments as images"
27836 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27837 :style toggle :selected org-export-with-LaTeX-fragments])
27838 "--"
27839 ("Documentation"
27840 ["Show Version" org-version t]
27841 ["Info Documentation" org-info t])
27842 ("Customize"
27843 ["Browse Org Group" org-customize t]
27844 "--"
27845 ["Expand This Menu" org-create-customize-menu
27846 (fboundp 'customize-menu-create)])
27847 "--"
27848 ["Refresh setup" org-mode-restart t]
27849 ))
27851 (defun org-info (&optional node)
27852 "Read documentation for Org-mode in the info system.
27853 With optional NODE, go directly to that node."
27854 (interactive)
27855 (info (format "(org)%s" (or node ""))))
27857 (defun org-install-agenda-files-menu ()
27858 (let ((bl (buffer-list)))
27859 (save-excursion
27860 (while bl
27861 (set-buffer (pop bl))
27862 (if (org-mode-p) (setq bl nil)))
27863 (when (org-mode-p)
27864 (easy-menu-change
27865 '("Org") "File List for Agenda"
27866 (append
27867 (list
27868 ["Edit File List" (org-edit-agenda-file-list) t]
27869 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27870 ["Remove Current File from List" org-remove-file t]
27871 ["Cycle through agenda files" org-cycle-agenda-files t]
27872 ["Occur in all agenda files" org-occur-in-agenda-files t]
27873 "--")
27874 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27876 ;;;; Documentation
27878 (defun org-customize ()
27879 "Call the customize function with org as argument."
27880 (interactive)
27881 (customize-browse 'org))
27883 (defun org-create-customize-menu ()
27884 "Create a full customization menu for Org-mode, insert it into the menu."
27885 (interactive)
27886 (if (fboundp 'customize-menu-create)
27887 (progn
27888 (easy-menu-change
27889 '("Org") "Customize"
27890 `(["Browse Org group" org-customize t]
27891 "--"
27892 ,(customize-menu-create 'org)
27893 ["Set" Custom-set t]
27894 ["Save" Custom-save t]
27895 ["Reset to Current" Custom-reset-current t]
27896 ["Reset to Saved" Custom-reset-saved t]
27897 ["Reset to Standard Settings" Custom-reset-standard t]))
27899 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27901 ;;;; Miscellaneous stuff
27904 ;;; Generally useful functions
27906 (defun org-context ()
27907 "Return a list of contexts of the current cursor position.
27908 If several contexts apply, all are returned.
27909 Each context entry is a list with a symbol naming the context, and
27910 two positions indicating start and end of the context. Possible
27911 contexts are:
27913 :headline anywhere in a headline
27914 :headline-stars on the leading stars in a headline
27915 :todo-keyword on a TODO keyword (including DONE) in a headline
27916 :tags on the TAGS in a headline
27917 :priority on the priority cookie in a headline
27918 :item on the first line of a plain list item
27919 :item-bullet on the bullet/number of a plain list item
27920 :checkbox on the checkbox in a plain list item
27921 :table in an org-mode table
27922 :table-special on a special filed in a table
27923 :table-table in a table.el table
27924 :link on a hyperlink
27925 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27926 :target on a <<target>>
27927 :radio-target on a <<<radio-target>>>
27928 :latex-fragment on a LaTeX fragment
27929 :latex-preview on a LaTeX fragment with overlayed preview image
27931 This function expects the position to be visible because it uses font-lock
27932 faces as a help to recognize the following contexts: :table-special, :link,
27933 and :keyword."
27934 (let* ((f (get-text-property (point) 'face))
27935 (faces (if (listp f) f (list f)))
27936 (p (point)) clist o)
27937 ;; First the large context
27938 (cond
27939 ((org-on-heading-p t)
27940 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27941 (when (progn
27942 (beginning-of-line 1)
27943 (looking-at org-todo-line-tags-regexp))
27944 (push (org-point-in-group p 1 :headline-stars) clist)
27945 (push (org-point-in-group p 2 :todo-keyword) clist)
27946 (push (org-point-in-group p 4 :tags) clist))
27947 (goto-char p)
27950 (push (org-point-in-group p 0 :priority) clist)))
27952 ((org-at-item-p)
27953 (push (org-point-in-group p 2 :item-bullet) clist)
27954 (push (list :item (point-at-bol)
27955 (save-excursion (org-end-of-item) (point)))
27956 clist)
27957 (and (org-at-item-checkbox-p)
27958 (push (org-point-in-group p 0 :checkbox) clist)))
27960 ((org-at-table-p)
27961 (push (list :table (org-table-begin) (org-table-end)) clist)
27962 (if (memq 'org-formula faces)
27963 (push (list :table-special
27964 (previous-single-property-change p 'face)
27965 (next-single-property-change p 'face)) clist)))
27966 ((org-at-table-p 'any)
27967 (push (list :table-table) clist)))
27968 (goto-char p)
27970 ;; Now the small context
27971 (cond
27972 ((org-at-timestamp-p)
27973 (push (org-point-in-group p 0 :timestamp) clist))
27974 ((memq 'org-link faces)
27975 (push (list :link
27976 (previous-single-property-change p 'face)
27977 (next-single-property-change p 'face)) clist))
27978 ((memq 'org-special-keyword faces)
27979 (push (list :keyword
27980 (previous-single-property-change p 'face)
27981 (next-single-property-change p 'face)) clist))
27982 ((org-on-target-p)
27983 (push (org-point-in-group p 0 :target) clist)
27984 (goto-char (1- (match-beginning 0)))
27985 (if (looking-at org-radio-target-regexp)
27986 (push (org-point-in-group p 0 :radio-target) clist))
27987 (goto-char p))
27988 ((setq o (car (delq nil
27989 (mapcar
27990 (lambda (x)
27991 (if (memq x org-latex-fragment-image-overlays) x))
27992 (org-overlays-at (point))))))
27993 (push (list :latex-fragment
27994 (org-overlay-start o) (org-overlay-end o)) clist)
27995 (push (list :latex-preview
27996 (org-overlay-start o) (org-overlay-end o)) clist))
27997 ((org-inside-LaTeX-fragment-p)
27998 ;; FIXME: positions wrong.
27999 (push (list :latex-fragment (point) (point)) clist)))
28001 (setq clist (nreverse (delq nil clist)))
28002 clist))
28004 ;; FIXME: Compare with at-regexp-p Do we need both?
28005 (defun org-in-regexp (re &optional nlines visually)
28006 "Check if point is inside a match of regexp.
28007 Normally only the current line is checked, but you can include NLINES extra
28008 lines both before and after point into the search.
28009 If VISUALLY is set, require that the cursor is not after the match but
28010 really on, so that the block visually is on the match."
28011 (catch 'exit
28012 (let ((pos (point))
28013 (eol (point-at-eol (+ 1 (or nlines 0))))
28014 (inc (if visually 1 0)))
28015 (save-excursion
28016 (beginning-of-line (- 1 (or nlines 0)))
28017 (while (re-search-forward re eol t)
28018 (if (and (<= (match-beginning 0) pos)
28019 (>= (+ inc (match-end 0)) pos))
28020 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
28022 (defun org-at-regexp-p (regexp)
28023 "Is point inside a match of REGEXP in the current line?"
28024 (catch 'exit
28025 (save-excursion
28026 (let ((pos (point)) (end (point-at-eol)))
28027 (beginning-of-line 1)
28028 (while (re-search-forward regexp end t)
28029 (if (and (<= (match-beginning 0) pos)
28030 (>= (match-end 0) pos))
28031 (throw 'exit t)))
28032 nil))))
28034 (defun org-occur-in-agenda-files (regexp &optional nlines)
28035 "Call `multi-occur' with buffers for all agenda files."
28037 (let* ((files (org-agenda-files))
28038 (tnames (mapcar 'file-truename files))
28039 (extra org-agenda-text-search-extra-files)
28040 f)
28041 (while (setq f (pop extra))
28042 (unless (member (file-truename f) tnames)
28043 (add-to-list 'files f 'append)
28044 (add-to-list 'tnames (file-truename f) 'append)))
28045 (multi-occur
28046 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
28047 regexp)))
28049 (if (boundp 'occur-mode-find-occurrence-hook)
28050 ;; Emacs 23
28051 (add-hook 'occur-mode-find-occurrence-hook
28052 (lambda ()
28053 (when (org-mode-p)
28054 (org-reveal))))
28055 ;; Emacs 22
28056 (defadvice occur-mode-goto-occurrence
28057 (after org-occur-reveal activate)
28058 (and (org-mode-p) (org-reveal)))
28059 (defadvice occur-mode-goto-occurrence-other-window
28060 (after org-occur-reveal activate)
28061 (and (org-mode-p) (org-reveal)))
28062 (defadvice occur-mode-display-occurrence
28063 (after org-occur-reveal activate)
28064 (when (org-mode-p)
28065 (let ((pos (occur-mode-find-occurrence)))
28066 (with-current-buffer (marker-buffer pos)
28067 (save-excursion
28068 (goto-char pos)
28069 (org-reveal)))))))
28071 (defun org-uniquify (list)
28072 "Remove duplicate elements from LIST."
28073 (let (res)
28074 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
28075 res))
28077 (defun org-delete-all (elts list)
28078 "Remove all elements in ELTS from LIST."
28079 (while elts
28080 (setq list (delete (pop elts) list)))
28081 list)
28083 (defun org-back-over-empty-lines ()
28084 "Move backwards over witespace, to the beginning of the first empty line.
28085 Returns the number of empty lines passed."
28086 (let ((pos (point)))
28088 (beginning-of-line 2)
28089 (goto-char (min (point) pos))
28090 (count-lines (point) pos)))
28092 (defun org-skip-whitespace ()
28095 (defun org-point-in-group (point group &optional context)
28096 "Check if POINT is in match-group GROUP.
28097 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
28098 match. If the match group does ot exist or point is not inside it,
28099 return nil."
28100 (and (match-beginning group)
28101 (>= point (match-beginning group))
28102 (<= point (match-end group))
28103 (if context
28104 (list context (match-beginning group) (match-end group))
28105 t)))
28107 (defun org-switch-to-buffer-other-window (&rest args)
28108 "Switch to buffer in a second window on the current frame.
28109 In particular, do not allow pop-up frames."
28110 (let (pop-up-frames special-display-buffer-names special-display-regexps
28111 special-display-function)
28112 (apply 'switch-to-buffer-other-window args)))
28114 (defun org-combine-plists (&rest plists)
28115 "Create a single property list from all plists in PLISTS.
28116 The process starts by copying the first list, and then setting properties
28117 from the other lists. Settings in the last list are the most significant
28118 ones and overrule settings in the other lists."
28119 (let ((rtn (copy-sequence (pop plists)))
28120 p v ls)
28121 (while plists
28122 (setq ls (pop plists))
28123 (while ls
28124 (setq p (pop ls) v (pop ls))
28125 (setq rtn (plist-put rtn p v))))
28126 rtn))
28128 (defun org-move-line-down (arg)
28129 "Move the current line down. With prefix argument, move it past ARG lines."
28130 (interactive "p")
28131 (let ((col (current-column))
28132 beg end pos)
28133 (beginning-of-line 1) (setq beg (point))
28134 (beginning-of-line 2) (setq end (point))
28135 (beginning-of-line (+ 1 arg))
28136 (setq pos (move-marker (make-marker) (point)))
28137 (insert (delete-and-extract-region beg end))
28138 (goto-char pos)
28139 (move-to-column col)))
28141 (defun org-move-line-up (arg)
28142 "Move the current line up. With prefix argument, move it past ARG lines."
28143 (interactive "p")
28144 (let ((col (current-column))
28145 beg end pos)
28146 (beginning-of-line 1) (setq beg (point))
28147 (beginning-of-line 2) (setq end (point))
28148 (beginning-of-line (- arg))
28149 (setq pos (move-marker (make-marker) (point)))
28150 (insert (delete-and-extract-region beg end))
28151 (goto-char pos)
28152 (move-to-column col)))
28154 (defun org-replace-escapes (string table)
28155 "Replace %-escapes in STRING with values in TABLE.
28157 The sequences in STRING may contain normal field width and padding information,
28159 so values can contain further %-escapes if they are define later in TABLE."
28160 (let ((case-fold-search nil)
28161 e re rpl)
28162 (while (setq e (pop table))
28163 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
28164 (while (string-match re string)
28165 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
28166 (cdr e)))
28167 (setq string (replace-match rpl t t string))))
28168 string))
28171 (defun org-sublist (list start end)
28172 "Return a section of LIST, from START to END.
28173 Counting starts at 1."
28174 (let (rtn (c start))
28175 (setq list (nthcdr (1- start) list))
28176 (while (and list (<= c end))
28177 (push (pop list) rtn)
28178 (setq c (1+ c)))
28179 (nreverse rtn)))
28181 (defun org-find-base-buffer-visiting (file)
28182 "Like `find-buffer-visiting' but alway return the base buffer and
28183 not an indirect buffer."
28184 (let ((buf (find-buffer-visiting file)))
28185 (if buf
28186 (or (buffer-base-buffer buf) buf)
28187 nil)))
28189 (defun org-image-file-name-regexp ()
28190 "Return regexp matching the file names of images."
28191 (if (fboundp 'image-file-name-regexp)
28192 (image-file-name-regexp)
28193 (let ((image-file-name-extensions
28194 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
28195 "xbm" "xpm" "pbm" "pgm" "ppm")))
28197 (regexp-opt (nconc (mapcar 'upcase
28198 image-file-name-extensions)
28199 image-file-name-extensions)
28200 t)
28203 (defun org-file-image-p (file)
28204 "Return non-nil if FILE is an image."
28205 (save-match-data
28206 (string-match (org-image-file-name-regexp) file)))
28208 ;;; Paragraph filling stuff.
28209 ;; We want this to be just right, so use the full arsenal.
28211 (defun org-indent-line-function ()
28212 "Indent line like previous, but further if previous was headline or item."
28213 (interactive)
28214 (let* ((pos (point))
28215 (itemp (org-at-item-p))
28216 column bpos bcol tpos tcol bullet btype bullet-type)
28217 ;; Find the previous relevant line
28218 (beginning-of-line 1)
28219 (cond
28220 ((looking-at "#") (setq column 0))
28222 (t
28223 (beginning-of-line 0)
28225 (beginning-of-line 0))
28226 (cond
28228 (goto-char (match-end 0))
28229 (setq column (current-column)))
28230 ((org-in-item-p)
28231 (org-beginning-of-item)
28234 (setq bpos (match-beginning 1) tpos (match-end 0)
28235 bcol (progn (goto-char bpos) (current-column))
28236 tcol (progn (goto-char tpos) (current-column))
28237 bullet (match-string 1)
28238 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
28239 (if (not itemp)
28240 (setq column tcol)
28241 (goto-char pos)
28242 (beginning-of-line 1)
28244 (progn
28246 (setq bullet (match-string 1)
28247 btype (if (string-match "[0-9]" bullet) "n" bullet))
28248 (setq column (if (equal btype bullet-type) bcol tcol)))
28249 (setq column (org-get-indentation)))))
28250 (t (setq column (org-get-indentation))))))
28251 (goto-char pos)
28252 (if (<= (current-column) (current-indentation))
28253 (indent-line-to column)
28254 (save-excursion (indent-line-to column)))
28255 (setq column (current-column))
28256 (beginning-of-line 1)
28257 (if (looking-at
28260 (match-string 2) (match-string 3)))
28261 t nil))
28262 (move-to-column column)))
28264 (defun org-set-autofill-regexps ()
28265 (interactive)
28266 ;; In the paragraph separator we include headlines, because filling
28267 ;; text in a line directly attached to a headline would otherwise
28268 ;; fill the headline as well.
28271 ;; The paragraph starter includes hand-formatted lists.
28272 (org-set-local 'paragraph-start
28274 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
28275 ;; But only if the user has not turned off tables or fixed-width regions
28276 (org-set-local
28277 'auto-fill-inhibit-regexp
28280 (if (or org-enable-table-editor org-enable-fixed-width-editor)
28281 (concat
28283 (if org-enable-table-editor "|" "")
28284 (if org-enable-fixed-width-editor ":" "")
28285 "]"))))
28286 ;; We use our own fill-paragraph function, to make sure that tables
28287 ;; and fixed-width regions are not wrapped. That function will pass
28288 ;; through to `fill-paragraph' when appropriate.
28289 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
28290 ; Adaptive filling: To get full control, first make sure that
28291 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
28293 (org-set-local 'adaptive-fill-function
28294 'org-adaptive-fill-function)
28295 (org-set-local
28296 'align-mode-rules-list
28297 '((org-in-buffer-settings
28299 (modes . '(org-mode))))))
28301 (defun org-fill-paragraph (&optional justify)
28302 "Re-align a table, pass through to fill-paragraph if no table."
28303 (let ((table-p (org-at-table-p))
28304 (table.el-p (org-at-table.el-p)))
28305 (cond ((and (equal (char-after (point-at-bol)) ?*)
28306 (save-excursion (goto-char (point-at-bol))
28307 (looking-at outline-regexp)))
28308 t) ; skip headlines
28309 (table.el-p t) ; skip table.el tables
28310 (table-p (org-table-align) t) ; align org-mode tables
28311 (t nil)))) ; call paragraph-fill
28313 ;; For reference, this is the default value of adaptive-fill-regexp
28316 (defun org-adaptive-fill-function ()
28317 "Return a fill prefix for org-mode files.
28318 In particular, this makes sure hanging paragraphs for hand-formatted lists
28319 work correctly."
28321 (match-string 0))
28323 (save-excursion
28324 (goto-char (match-end 0))
28325 (make-string (current-column) ?\ )))
28326 (t nil)))
28328 ;;;; Functions extending outline functionality
28331 (defun org-beginning-of-line (&optional arg)
28332 "Go to the beginning of the current line. If that is invisible, continue
28333 to a visible line beginning. This makes the function of C-a more intuitive.
28334 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28335 first attempt, and only move to after the tags when the cursor is already
28336 beyond the end of the headline."
28337 (interactive "P")
28338 (let ((pos (point)))
28339 (beginning-of-line 1)
28340 (if (bobp)
28341 nil
28342 (backward-char 1)
28343 (if (org-invisible-p)
28344 (while (and (not (bobp)) (org-invisible-p))
28345 (backward-char 1)
28346 (beginning-of-line 1))
28347 (forward-char 1)))
28348 (when org-special-ctrl-a/e
28349 (cond
28350 ((and (looking-at org-todo-line-regexp)
28351 (= (char-after (match-end 1)) ?\ ))
28352 (goto-char
28353 (if (eq org-special-ctrl-a/e t)
28354 (cond ((> pos (match-beginning 3)) (match-beginning 3))
28355 ((= pos (point)) (match-beginning 3))
28356 (t (point)))
28357 (cond ((> pos (point)) (point))
28358 ((not (eq last-command this-command)) (point))
28359 (t (match-beginning 3))))))
28360 ((org-at-item-p)
28361 (goto-char
28362 (if (eq org-special-ctrl-a/e t)
28363 (cond ((> pos (match-end 4)) (match-end 4))
28364 ((= pos (point)) (match-end 4))
28365 (t (point)))
28366 (cond ((> pos (point)) (point))
28367 ((not (eq last-command this-command)) (point))
28368 (t (match-end 4))))))))))
28370 (defun org-end-of-line (&optional arg)
28371 "Go to the end of the line.
28372 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28373 first attempt, and only move to after the tags when the cursor is already
28374 beyond the end of the headline."
28375 (interactive "P")
28376 (if (or (not org-special-ctrl-a/e)
28377 (not (org-on-heading-p)))
28378 (end-of-line arg)
28379 (let ((pos (point)))
28380 (beginning-of-line 1)
28382 (if (eq org-special-ctrl-a/e t)
28383 (if (or (< pos (match-beginning 1))
28384 (= pos (match-end 0)))
28385 (goto-char (match-beginning 1))
28386 (goto-char (match-end 0)))
28387 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
28388 (goto-char (match-end 0))
28389 (goto-char (match-beginning 1))))
28390 (end-of-line arg)))))
28392 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
28393 (define-key org-mode-map "\C-e" 'org-end-of-line)
28395 (defun org-kill-line (&optional arg)
28396 "Kill line, to tags or end of line."
28397 (interactive "P")
28398 (cond
28399 ((or (not org-special-ctrl-k)
28400 (bolp)
28401 (not (org-on-heading-p)))
28402 (call-interactively 'kill-line))
28404 (kill-region (point) (match-beginning 1))
28405 (org-set-tags nil t))
28406 (t (kill-region (point) (point-at-eol)))))
28408 (define-key org-mode-map "\C-k" 'org-kill-line)
28410 (defun org-invisible-p ()
28411 "Check if point is at a character currently not visible."
28412 ;; Early versions of noutline don't have `outline-invisible-p'.
28413 (if (fboundp 'outline-invisible-p)
28414 (outline-invisible-p)
28415 (get-char-property (point) 'invisible)))
28417 (defun org-invisible-p2 ()
28418 "Check if point is at a character currently not visible."
28419 (save-excursion
28420 (if (and (eolp) (not (bobp))) (backward-char 1))
28421 ;; Early versions of noutline don't have `outline-invisible-p'.
28422 (if (fboundp 'outline-invisible-p)
28423 (outline-invisible-p)
28424 (get-char-property (point) 'invisible))))
28426 (defalias 'org-back-to-heading 'outline-back-to-heading)
28427 (defalias 'org-on-heading-p 'outline-on-heading-p)
28428 (defalias 'org-at-heading-p 'outline-on-heading-p)
28429 (defun org-at-heading-or-item-p ()
28430 (or (org-on-heading-p) (org-at-item-p)))
28432 (defun org-on-target-p ()
28433 (or (org-in-regexp org-radio-target-regexp)
28434 (org-in-regexp org-target-regexp)))
28436 (defun org-up-heading-all (arg)
28437 "Move to the heading line of which the present line is a subheading.
28438 This function considers both visible and invisible heading lines.
28439 With argument, move up ARG levels."
28440 (if (fboundp 'outline-up-heading-all)
28441 (outline-up-heading-all arg) ; emacs 21 version of outline.el
28442 (outline-up-heading arg t))) ; emacs 22 version of outline.el
28444 (defun org-up-heading-safe ()
28445 "Move to the heading line of which the present line is a subheading.
28446 This version will not throw an error. It will return the level of the
28447 headline found, or nil if no higher level is found."
28448 (let ((pos (point)) start-level level
28449 (re (concat "^" outline-regexp)))
28450 (catch 'exit
28451 (outline-back-to-heading t)
28452 (setq start-level (funcall outline-level))
28453 (if (equal start-level 1) (throw 'exit nil))
28454 (while (re-search-backward re nil t)
28455 (setq level (funcall outline-level))
28456 (if (< level start-level) (throw 'exit level)))
28457 nil)))
28459 (defun org-first-sibling-p ()
28460 "Is this heading the first child of its parents?"
28461 (interactive)
28462 (let ((re (concat "^" outline-regexp))
28463 level l)
28464 (unless (org-at-heading-p t)
28465 (error "Not at a heading"))
28466 (setq level (funcall outline-level))
28467 (save-excursion
28468 (if (not (re-search-backward re nil t))
28469 t
28470 (setq l (funcall outline-level))
28471 (< l level)))))
28473 (defun org-goto-sibling (&optional previous)
28474 "Goto the next sibling, even if it is invisible.
28475 When PREVIOUS is set, go to the previous sibling instead. Returns t
28476 when a sibling was found. When none is found, return nil and don't
28477 move point."
28478 (let ((fun (if previous 're-search-backward 're-search-forward))
28479 (pos (point))
28480 (re (concat "^" outline-regexp))
28481 level l)
28482 (when (condition-case nil (org-back-to-heading t) (error nil))
28483 (setq level (funcall outline-level))
28484 (catch 'exit
28485 (or previous (forward-char 1))
28486 (while (funcall fun re nil t)
28487 (setq l (funcall outline-level))
28488 (when (< l level) (goto-char pos) (throw 'exit nil))
28489 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28490 (goto-char pos)
28491 nil))))
28493 (defun org-show-siblings ()
28494 "Show all siblings of the current headline."
28495 (save-excursion
28496 (while (org-goto-sibling) (org-flag-heading nil)))
28497 (save-excursion
28498 (while (org-goto-sibling 'previous)
28499 (org-flag-heading nil))))
28501 (defun org-show-hidden-entry ()
28502 "Show an entry where even the heading is hidden."
28503 (save-excursion
28504 (org-show-entry)))
28506 (defun org-flag-heading (flag &optional entry)
28507 "Flag the current heading. FLAG non-nil means make invisible.
28508 When ENTRY is non-nil, show the entire entry."
28509 (save-excursion
28510 (org-back-to-heading t)
28511 ;; Check if we should show the entire entry
28512 (if entry
28513 (progn
28514 (org-show-entry)
28515 (save-excursion
28516 (and (outline-next-heading)
28517 (org-flag-heading nil))))
28518 (outline-flag-region (max (point-min) (1- (point)))
28519 (save-excursion (outline-end-of-heading) (point))
28520 flag))))
28522 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28523 ;; This is an exact copy of the original function, but it uses
28524 ;; `org-back-to-heading', to make it work also in invisible
28525 ;; trees. And is uses an invisible-OK argument.
28526 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28527 (org-back-to-heading invisible-OK)
28528 (let ((first t)
28529 (level (funcall outline-level)))
28530 (while (and (not (eobp))
28531 (or first (> (funcall outline-level) level)))
28532 (setq first nil)
28533 (outline-next-heading))
28534 (unless to-heading
28536 (progn
28537 ;; Go to end of line before heading
28538 (forward-char -1)
28540 ;; leave blank line before heading
28541 (forward-char -1))))))
28542 (point))
28544 (defun org-show-subtree ()
28545 "Show everything after this heading at deeper levels."
28546 (outline-flag-region
28547 (point)
28548 (save-excursion
28549 (outline-end-of-subtree) (outline-next-heading) (point))
28550 nil))
28552 (defun org-show-entry ()
28553 "Show the body directly following this heading.
28554 Show the heading too, if it is currently invisible."
28555 (interactive)
28556 (save-excursion
28557 (condition-case nil
28558 (progn
28559 (org-back-to-heading t)
28560 (outline-flag-region
28561 (max (point-min) (1- (point)))
28562 (save-excursion
28563 (re-search-forward
28565 (or (match-beginning 1) (point-max)))
28566 nil))
28567 (error nil))))
28569 (defun org-make-options-regexp (kwds)
28570 "Make a regular expression for keyword lines."
28571 (concat
28572 "^"
28578 ;; Make isearch reveal the necessary context
28579 (defun org-isearch-end ()
28580 "Reveal context after isearch exits."
28581 (when isearch-success ; only if search was successful
28582 (if (featurep 'xemacs)
28583 ;; Under XEmacs, the hook is run in the correct place,
28584 ;; we directly show the context.
28585 (org-show-context 'isearch)
28586 ;; In Emacs the hook runs *before* restoring the overlays.
28587 ;; So we have to use a one-time post-command-hook to do this.
28588 ;; (Emacs 22 has a special variable, see function `org-mode')
28589 (unless (and (boundp 'isearch-mode-end-hook-quit)
28590 isearch-mode-end-hook-quit)
28591 ;; Only when the isearch was not quitted.
28592 (org-add-hook 'post-command-hook 'org-isearch-post-command
28593 'append 'local)))))
28595 (defun org-isearch-post-command ()
28596 "Remove self from hook, and show context."
28597 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28598 (org-show-context 'isearch))
28601 ;;;; Integration with and fixes for other packages
28603 ;;; Imenu support
28605 (defvar org-imenu-markers nil
28606 "All markers currently used by Imenu.")
28607 (make-variable-buffer-local 'org-imenu-markers)
28609 (defun org-imenu-new-marker (&optional pos)
28610 "Return a new marker for use by Imenu, and remember the marker."
28611 (let ((m (make-marker)))
28612 (move-marker m (or pos (point)))
28613 (push m org-imenu-markers)
28614 m))
28616 (defun org-imenu-get-tree ()
28617 "Produce the index for Imenu."
28618 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28619 (setq org-imenu-markers nil)
28620 (let* ((n org-imenu-depth)
28621 (re (concat "^" outline-regexp))
28622 (subs (make-vector (1+ n) nil))
28623 (last-level 0)
28624 m tree level head)
28625 (save-excursion
28626 (save-restriction
28627 (widen)
28628 (goto-char (point-max))
28629 (while (re-search-backward re nil t)
28630 (setq level (org-reduced-level (funcall outline-level)))
28631 (when (<= level n)
28632 (looking-at org-complex-heading-regexp)
28633 (setq head (org-match-string-no-properties 4)
28634 m (org-imenu-new-marker))
28635 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28636 (if (>= level last-level)
28637 (push (cons head m) (aref subs level))
28638 (push (cons head (aref subs (1+ level))) (aref subs level))
28639 (loop for i from (1+ level) to n do (aset subs i nil)))
28640 (setq last-level level)))))
28641 (aref subs 1)))
28643 (eval-after-load "imenu"
28644 '(progn
28645 (add-hook 'imenu-after-jump-hook
28646 (lambda () (org-show-context 'org-goto)))))
28648 ;; Speedbar support
28650 (defun org-speedbar-set-agenda-restriction ()
28651 "Restrict future agenda commands to the location at point in speedbar.
28653 (interactive)
28654 (let (p m tp np dir txt w)
28655 (cond
28656 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28657 'org-imenu t))
28658 (setq m (get-text-property p 'org-imenu-marker))
28659 (save-excursion
28660 (save-restriction
28661 (set-buffer (marker-buffer m))
28662 (goto-char m)
28663 (org-agenda-set-restriction-lock 'subtree))))
28664 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28665 'speedbar-function 'speedbar-find-file))
28666 (setq tp (previous-single-property-change
28667 (1+ p) 'speedbar-function)
28668 np (next-single-property-change
28669 tp 'speedbar-function)
28670 dir (speedbar-line-directory)
28671 txt (buffer-substring-no-properties (or tp (point-min))
28672 (or np (point-max))))
28673 (save-excursion
28674 (save-restriction
28675 (set-buffer (find-file-noselect
28676 (let ((default-directory dir))
28677 (expand-file-name txt))))
28678 (unless (org-mode-p)
28679 (error "Cannot restrict to non-Org-mode file"))
28680 (org-agenda-set-restriction-lock 'file))))
28681 (t (error "Don't know how to restrict Org-mode's agenda")))
28682 (org-move-overlay org-speedbar-restriction-lock-overlay
28683 (point-at-bol) (point-at-eol))
28684 (setq current-prefix-arg nil)
28685 (org-agenda-maybe-redo)))
28687 (eval-after-load "speedbar"
28688 '(progn
28689 (speedbar-add-supported-extension ".org")
28690 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28691 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28692 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28693 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28694 (add-hook 'speedbar-visiting-tag-hook
28695 (lambda () (org-show-context 'org-goto)))))
28698 ;;; Fixes and Hacks
28700 ;; Make flyspell not check words in links, to not mess up our keymap
28701 (defun org-mode-flyspell-verify ()
28702 "Don't let flyspell put overlays at active buttons."
28703 (not (get-text-property (point) 'keymap)))
28705 ;; Make `bookmark-jump' show the jump location if it was hidden.
28706 (eval-after-load "bookmark"
28707 '(if (boundp 'bookmark-after-jump-hook)
28708 ;; We can use the hook
28709 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28710 ;; Hook not available, use advice
28711 (defadvice bookmark-jump (after org-make-visible activate)
28712 "Make the position visible."
28713 (org-bookmark-jump-unhide))))
28715 (defun org-bookmark-jump-unhide ()
28716 "Unhide the current position, to show the bookmark location."
28717 (and (org-mode-p)
28718 (or (org-invisible-p)
28719 (save-excursion (goto-char (max (point-min) (1- (point))))
28720 (org-invisible-p)))
28721 (org-show-context 'bookmark-jump)))
28723 ;; Make session.el ignore our circular variable
28724 (eval-after-load "session"
28725 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28727 ;;;; Experimental code
28729 (defun org-closed-in-range ()
28730 "Sparse tree of items closed in a certain time range.
28731 Still experimental, may disappear in the future."
28732 (interactive)
28733 ;; Get the time interval from the user.
28734 (let* ((time1 (time-to-seconds
28735 (org-read-date nil 'to-time nil "Starting date: ")))
28736 (time2 (time-to-seconds
28737 (org-read-date nil 'to-time nil "End date:")))
28738 ;; callback function
28739 (callback (lambda ()
28740 (let ((time
28741 (time-to-seconds
28742 (apply 'encode-time
28743 (org-parse-time-string
28744 (match-string 1))))))
28745 ;; check if time in interval
28746 (and (>= time time1) (<= time time2))))))
28747 ;; make tree, check each match with the callback
28751 ;;;; Finish up
28753 (provide 'org)
28755 (run-hooks 'org-load-hook)
28757 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28758 ;;; org.el ends here