| blob | 4c9663d6a217986cec41f19d7e586b06f16da0bc |
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.22a+
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.
156 This happens also after `org' has been provided, so
157 requiring something in this hook that does a (require 'org) is ok."
162 "Extensions that should always be loaded together with org.el.
163 If the description starts with <A>, this means the extension
164 will be autoloaded when needed, preloading is not necessary."
166 :type
175 "Load all extensions that are listed in `org-default-extensions'."
178 ;; FIXME: Needs a separate group...
181 Normal means, no org-mode-specific context."
186 "Options concerning startup of Org-mode."
191 "Non-nil means, entering Org-mode will switch to OVERVIEW.
192 This can also be configured on a per-file basis by adding one of
193 the following lines anywhere in the buffer:
195 #+STARTUP: fold
196 #+STARTUP: nofold
197 #+STARTUP: content"
205 "Non-nil means, entering Org-mode will set `truncate-lines'.
206 This is useful since some lines containing links can be very long and
207 uninteresting. Also tables look terrible when wrapped."
212 "Non-nil means, align all tables when visiting a file.
213 This is useful when the column width in tables is forced with <N> cookies
214 in table fields. Such tables will look correct only after the first re-align.
215 This can also be configured on a per-file basis by adding one of
216 the following lines anywhere in the buffer:
217 #+STARTUP: align
218 #+STARTUP: noalign"
223 "Non-nil means insert the first line setting Org-mode in empty files.
224 When the function `org-mode' is called interactively in an empty file, this
225 normally means that the file name does not automatically trigger Org-mode.
226 To ensure that the file will always be in Org-mode in the future, a
227 line enforcing Org-mode will be inserted into the buffer, if this option
228 has been set."
233 "Non-nil means use alternative key bindings for some keys.
234 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
235 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
236 If you want to use Org-mode together with one of these other modes,
237 or more generally if you would like to move some Org-mode commands to
238 other keys, set this variable and configure the keys with the variable
239 `org-disputed-keys'.
241 This option is only relevant at load-time of Org-mode, and must be set
242 *before* org.el is loaded. Changing it requires a restart of Emacs to
243 become effective."
257 "Keys for which Org-mode and other modes compete.
258 This is an alist, cars are the default keys, second element specifies
259 the alternative to use when `org-replace-disputed-keys' is t.
261 Keys can be specified in any syntax supported by `define-key'.
262 The value of this option takes effect only at Org-mode's startup,
263 therefore you'll have to restart Emacs to apply it after changing."
268 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
269 Or return the original if not disputed."
274 org-disputed-keys)))
276 key))
286 "Define a key, possibly translated, as returned by `org-key'."
290 "The ellipsis to use in the Org-mode outline.
291 When nil, just use the standard three dots. When a string, use that instead,
292 When a face, use the standart 3 dots, but with the specified face.
293 The change affects only Org-mode (which will then use its own display table).
294 Changing this requires executing `M-x org-mode' in a buffer to become
295 effective."
305 "Keywords in Org-mode."
310 "String to mark deadline entries.
311 A deadline is this string, followed by a time stamp. Should be a word,
312 terminated by a colon. You can insert a schedule keyword and
314 Changes become only effective after restarting Emacs."
319 "String to mark scheduled TODO entries.
320 A schedule is this string, followed by a time stamp. Should be a word,
321 terminated by a colon. You can insert a schedule keyword and
323 Changes become only effective after restarting Emacs."
328 "String used as the prefix for timestamps logging closing a TODO entry."
333 "String used as prefix for timestamps clocking work hours on an item."
338 "Entries starting with this keyword will never be exported.
339 An entry can be toggled between COMMENT and normal with
341 Changes become only effective after restarting Emacs."
346 "Entries starting with this keyword will be exported in fixed-width font.
347 Quoting applies only to the text in the entry following the headline, and does
348 not extend beyond the next headline, even if that is lower level.
349 An entry can be toggled between QUOTE and normal with
355 ; (concat "\\(?:\\<\\(?:" org-scheduled-string "\\|" org-deadline-string "\\)"
356 ; " +<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\)\\(\\+[0-9]+[dwmy]\\)")
358 "Regular expression for specifying repeated events.
362 "Options concerning the general structure of Org-mode files."
367 "Options about how to make context of a location visible."
391 "Non-nil means, show full hierarchy when revealing a location.
392 Org-mode often shows locations in an org-mode file which might have
393 been invisible before. When this is set, the hierarchy of headings
394 above the exposed location is shown.
395 Turning this off for example for sparse trees makes them very compact.
396 Instead of t, this can also be an alist specifying this option for different
397 contexts. Valid contexts are
398 agenda when exposing an entry from the agenda
399 org-goto when using the command `org-goto' on key C-c C-j
400 occur-tree when using the command `org-occur' on key C-c /
401 tags-tree when constructing a sparse tree based on tags matches
402 link-search when exposing search matches associated with a link
403 mark-goto when exposing the jump goal of a mark
404 bookmark-jump when exposing a bookmark location
405 isearch when exiting from an incremental search
406 default default for all contexts not set explicitly"
411 "Non-nil means, show following heading when revealing a location.
412 Org-mode often shows locations in an org-mode file which might have
413 been invisible before. When this is set, the heading following the
414 match is shown.
415 Turning this off for example for sparse trees makes them very compact,
416 but makes it harder to edit the location of the match. In such a case,
418 Instead of t, this can also be an alist specifying this option for different
419 contexts. See `org-show-hierarchy-above' for valid contexts."
424 "Non-nil means, show all sibling heading when revealing a location.
425 Org-mode often shows locations in an org-mode file which might have
426 been invisible before. When this is set, the sibling of the current entry
427 heading are all made visible. If `org-show-hierarchy-above' is t,
428 the same happens on each level of the hierarchy above the current entry.
430 By default this is on for the isearch context, off for all other contexts.
431 Turning this off for example for sparse trees makes them very compact,
432 but makes it harder to edit the location of the match. In such a case,
434 Instead of t, this can also be an alist specifying this option for different
435 contexts. See `org-show-hierarchy-above' for valid contexts."
440 "Non-nil means, show the entry below a headline when revealing a location.
441 Org-mode often shows locations in an org-mode file which might have
442 been invisible before. When this is set, the text below the headline that is
443 exposed is also shown.
445 By default this is off for all contexts.
446 Instead of t, this can also be an alist specifying this option for different
447 contexts. See `org-show-hierarchy-above' for valid contexts."
452 "Options concerning visibility cycling in Org-mode."
457 "Names of drawers. Drawers are not opened by cycling on the headline above.
458 Drawers only open with a TAB on the drawer line itself. A drawer looks like
459 this:
460 :DRAWERNAME:
461 .....
462 :END:
464 the property API.
466 Drawers can be defined on the per-file basis with a line like:
468 #+DRAWERS: HIDDEN STATE PROPERTIES"
473 "Cycle globally if cursor is at beginning of buffer and not at a headline.
474 This makes it possible to do global cycling without having to use S-TAB or
475 C-u TAB. For this special case to work, the first line of the buffer
476 must not be a headline - it may be empty ot some other text. When used in
477 this way, `org-cycle-hook' is disables temporarily, to make sure the
478 cursor stays at the beginning of the buffer.
479 When this option is nil, don't do anything special at the beginning
480 of the buffer."
485 "Where should `org-cycle' emulate TAB.
486 nil Never
487 white Only in completely white lines
488 whitestart Only at the beginning of lines, before the first non-white char
489 t Everywhere except in headlines
490 exc-hl-bol Everywhere except at the start of a headline
491 If TAB is used in a place where it does not emulate TAB, the current subtree
492 visibility is cycled."
499 ))
502 "Number of empty lines needed to keep an empty line between collapsed trees.
503 If you leave an empty line between the end of a subtree and the following
504 headline, this empty line is hidden when the subtree is folded.
505 Org-mode will leave (exactly) one empty line visible if the number of
506 empty lines is equal or larger to the number given in this variable.
507 So the default 2 means, at least 2 empty lines after the end of a subtree
508 are needed to produce free space between a collapsed subtree and the
509 following headline.
511 Special case: when 0, never leave empty lines in collapsed view."
516 org-cycle-hide-drawers
517 org-cycle-show-empty-lines
518 org-optimize-window-after-visibility-change)
519 "Hook that is run after `org-cycle' has changed the buffer visibility.
520 The function(s) in this hook must accept a single argument which indicates
521 the new state that was set by the most recent `org-cycle' command. The
522 argument is a symbol. After a global state change, it can have the values
523 `overview', `content', or `all'. After a local state change, it can have
524 the values `folded', `children', or `subtree'."
529 "Options concerning structure editing in Org-mode."
534 "Non-nil means, skip even levels and only use odd levels for the outline.
535 This has the effect that two stars are being added/taken away in
536 promotion/demotion commands. It also influences how levels are
537 handled by the exporters.
538 Changing it requires restart of `font-lock-mode' to become effective
539 for fontification also in regions already fontified.
540 You may also set this on a per-file basis by adding one of the following
541 lines to the buffer:
543 #+STARTUP: odd
544 #+STARTUP: oddeven"
550 "Non-nil means, adapt indentation when promoting and demoting.
551 When this is set and the *entire* text in an entry is indented, the
552 indentation is increased by one space in a demotion command, and
553 decreased by one in a promotion command. If any line in the entry
554 body starts at column 0, indentation is not changed at all."
559 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
560 When t, `C-a' will bring back the cursor to the beginning of the
561 headline text, i.e. after the stars and after a possible TODO keyword.
562 In an item, this will be the position after the bullet.
563 When the cursor is already at that position, another `C-a' will bring
564 it to the beginning of the line.
565 `C-e' will jump to the end of the headline, ignoring the presence of tags
566 in the headline. A second `C-e' will then jump to the true end of the
567 line, after any tags.
568 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
569 and only a directly following, identical keypress will bring the cursor
570 to the special positions."
581 "Non-nil means `C-k' will behave specially in headlines.
582 When nil, `C-k' will call the default `kill-line' command.
583 When t, the following will happen while the cursor is in the headline:
585 - When the cursor is at the beginning of a headline, kill the entire
586 line and possible the folded subtree below the line.
587 - When in the middle of the headline text, kill the headline up to the tags.
588 - When after the headline text, kill the tags."
593 "Non-nil means, M-RET will split the line at the cursor position.
594 When nil, it will go to the end of the line before making a
595 new line.
596 You may also set this option in a different way for different
597 contexts. Valid contexts are:
599 headline when creating a new headline
600 item when creating a new item
601 table in a table field
602 default the value to be used for all contexts not explicitly
603 customized"
621 "Should `org-insert-heading' leave a blank line before new heading/item?
622 The value is an alist, with `heading' and `plain-list-item' as car,
623 and a boolean flag as cdr."
630 "Hook being run after inserting a new heading."
636 This currently only means, they are never auto-wrapped.
637 When nil, such lines will be treated like ordinary lines.
638 See also the QUOTE keyword."
643 "Non-nil means, typing characters in org-goto starts incremental search."
648 "Options concerning sparse trees in Org-mode."
653 "Non-nil means, highlight all matches that define a sparse tree.
654 The highlights will automatically disappear the next time the buffer is
655 changed by an edit command."
660 "Non-nil means, any change to the buffer will remove temporary highlights.
661 Such highlights are created by `org-occur' and `org-clock-display'.
662 When nil, `C-c C-c needs to be used to get rid of the highlights.
663 The highlights created by `org-preview-latex-fragment' always need
664 `C-c C-c' to be removed."
671 "Hook that is run after `org-occur' has constructed a sparse tree.
672 This can be used to recenter the window to show as much of the structure
673 as possible."
678 "Options concerning plain lists in Org-mode."
683 "Non-nil means, include plain lists into visibility cycling.
684 This means that during cycling, plain list items will *temporarily* be
685 interpreted as outline headlines with a level given by 1000+i where i is the
686 indentation of the bullet. In all other operations, plain list items are
687 not seen as headlines. For example, you cannot assign a TODO keyword to
688 such an item."
693 "The character that makes a line with leading number an ordered list item.
694 Valid values are ?. and ?\). To get both terminators, use t. While
695 ?. may look nicer, it creates the danger that a line with leading
696 number may be incorrectly interpreted as an item. ?\) therefore is
697 the safe choice."
704 "Non-nil means, automatically renumber ordered plain lists.
705 Renumbering happens when the sequence have been changed with
712 "Non-nil means, update checkbox statistics after insert and toggle.
713 When this is set, checkbox statistics is updated each time you either insert
720 "Options concerning archiving in Org-mode."
725 "The tag that marks a subtree as archived.
726 An archived subtree does not open during visibility cycling, and does
727 not contribute to the agenda listings.
728 After changing this, font-lock must be restarted in the relevant buffers to
729 get the proper fontification."
735 "Non-nil means, the agenda will skip any items located in archived trees.
736 An archived tree is a tree marked with the tag ARCHIVE."
742 "Non-nil means, `org-cycle' will open archived trees.
743 An archived tree is a tree marked with the tag ARCHIVE.
744 When nil, archived trees will stay folded. You can still open them with
745 normal outline commands like `show-all', but not with the cycling commands."
751 "Non-nil means sparse tree construction shows matches in archived trees.
752 When nil, matches in these trees are highlighted, but the trees are kept in
753 collapsed state."
759 "The location where subtrees should be archived.
760 This string consists of two parts, separated by a double-colon.
762 The first part is a file name - when omitted, archiving happens in the same
763 file. %s will be replaced by the current file name (without directory part).
764 Archiving to a different file is useful to keep archived entries from
765 contributing to the Org-mode Agenda.
767 The part after the double colon is a headline. The archived entries will be
768 filed under that headline. When omitted, the subtrees are simply filed away
769 at the end of the file, as top-level entries.
771 Here are a few examples:
773 If the current file is Projects.org, archive in file
774 Projects.org_archive, as top-level trees. This is the default.
777 Archive in the current file, under the top-level headline
781 Archive in file ~/org/archive.org (absolute path), as top-level trees.
784 Archive in file ./basement (relative path), as level 3 trees
787 You may set this option on a per-file basis by adding to the buffer a
788 line like
790 #+ARCHIVE: basement::** Finished Tasks"
795 "Non-nil means, mark entries as DONE when they are moved to the archive file.
796 This can be a string to set the keyword to use. When t, Org-mode will
797 use the first keyword in its list that means done."
805 "Non-nil means, add a time stamp to entries moved to an archive file.
806 This variable is obsolete and has no effect anymore, instead add ot remove
807 `time' from the variablle `org-archive-save-context-info'."
812 "Parts of context info that should be stored as properties when archiving.
813 When a subtree is moved to an archive file, it looses information given by
814 context, like inherited tags, the category, and possibly also the TODO
815 state (depending on the variable `org-archive-mark-done').
816 This variable can be a list of any of the following symbols:
818 time The time of archiving.
819 file The file where the entry originates.
820 itags The local tags, in the headline of the subtree.
821 ltags The tags the subtree inherits from further up the hierarchy.
822 todo The pre-archive TODO state.
823 category The category, taken from file name or #+CATEGORY lines.
824 olpath The outline path to the item. These are all headlines above
825 the current item, separated by /, like a file path.
827 For each symbol present in the list, a property will be created in
829 information."
842 "Options concerning imenu and speedbar in Org-mode."
847 "The maximum level for Imenu access to Org-mode headlines.
848 This also applied for speedbar access."
853 "Options concerning tables in Org-mode."
859 When nil, such lines will be treated like ordinary lines.
861 When equal to the symbol `optimized', the table editor will be optimized to
862 do the following:
863 - Automatic overwrite mode in front of whitespace in table fields.
864 This makes the structure of the table stay in tact as long as the edited
865 field does not exceed the column width.
866 - Minimize the number of realigns. Normally, the table is aligned each time
867 TAB or RET are pressed to move to another field. With optimization this
868 happens only if changes to a field might have changed the column width.
869 Optimization requires replacing the functions `self-insert-command',
870 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
871 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
872 very good at guessing when a re-align will be necessary, but you can always
875 If you would like to use the optimized version in Org-mode, but the
876 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
878 This variable can be used to turn on and off the table editor during a session,
879 but in order to toggle optimization, a restart is required.
881 See also the variable `org-table-auto-blank-field'."
889 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
890 In the optimized version, the table editor takes over all simple keys that
891 normally just insert a character. In tables, the characters are inserted
892 in a way to minimize disturbing the table structure (i.e. in overwrite mode
893 for empty fields). Outside tables, the correct binding of the keys is
894 restored.
896 The default for this option is t if the optimized version is also used in
897 Org-mode. See the variable `org-enable-table-editor' for details. Changing
898 this variable requires a restart of Emacs to become effective."
904 % END RECEIVE ORGTBL %n
906 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
907 | | |
910 @c END RECEIVE ORGTBL %n
911 @ignore
912 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
913 | | |
916 <!-- END RECEIVE ORGTBL %n -->
917 <!--
918 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
919 | | |
921 "Templates for radio tables in different major modes.
922 All occurrences of %n in a template will be replaced with the name of the
923 table, obtained by prompting the user."
930 "Settings for tables in Org-mode."
935 "The default size for newly created tables, Columns x Rows."
941 "Regular expression for recognizing numbers in table columns.
942 If a table column contains mostly numbers, it will be aligned to the
943 right. If not, it will be aligned to the left.
945 The default value of this option is a regular expression which allows
946 anything which looks remotely like a number as used in scientific
947 context. For example, all of the following will be considered a
948 number:
949 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
951 Other options offered by the customize interface are more restrictive."
969 "Fraction of numbers in a column required to make the column align right.
970 In a column all non-white fields are considered. If at least this
971 fraction of fields is matched by `org-table-number-fraction',
972 alignment to the right border applies."
977 "Behavior of tables during editing in Org-mode."
982 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
984 removal/insertion."
989 "Non-nil means, automatically blank table field when starting to type into it.
990 This only happens when typing immediately after a field motion
991 command (TAB, S-TAB or RET).
992 Only relevant when `org-enable-table-editor' is equal to `optimized'."
997 "Non-nil means, tab in the last column of a table with jump over a hline.
998 If a horizontal separator line is following the current line,
999 `org-table-next-field' can either create a new row before that line, or jump
1000 over the line. When this option is nil, a new line will be created before
1001 this line."
1006 "Non-nil means, TAB will automatically notice a table.el table.
1007 When it sees such a table, it moves point into it and - if necessary -
1008 calls `table-recognize-table'."
1013 "Options concerning tables in Org-mode."
1018 "Should org-mode work with table refrences like B3 instead of @3$2?
1019 Possible values are:
1020 nil never use them
1021 from accept as input, do not present for editing
1022 t: accept as input and present for editing"
1037 calc-angle-mode deg
1038 calc-prefer-frac nil
1039 calc-symbolic-mode nil
1041 calc-display-working-message t
1042 )
1043 "List with Calc mode settings for use in calc-eval for table formulas.
1044 The list must contain alternating symbols (Calc modes variables and values).
1045 Don't remove any of the default settings, just change the values. Org-mode
1046 relies on the variables to be present in the list."
1051 "Non-nil means, TAB and RET evaluate a formula in current table field.
1052 If the current field starts with an equal sign, it is assumed to be a formula
1053 which should be evaluated as described in the manual and in the documentation
1054 string of the command `org-table-eval-formula'. This feature requires the
1055 Emacs calc package.
1056 When this variable is nil, formula calculation is only available through
1062 "Non-nil means, interpret constants in formulas in tables.
1063 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1064 by the value given in `org-table-formula-constants', or by a value obtained
1065 from the `constants.el' package."
1070 "Alist with constant names and values, for use in table formulas.
1071 The car of each element is a name of a constant, without the `$' before it.
1072 The cdr is the value as a string. For example, if you'd like to use the
1073 speed of light in a formula, you would configure
1077 and then use it in an equation like `$1*$c'.
1079 Constants can also be defined on a per-file basis using a line like
1081 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1092 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1093 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1098 "Options concerning links in Org-mode."
1103 "Buffer-local version of `org-link-abbrev-alist', which see.
1108 "Alist of link abbreviations.
1109 The car of each element is a string, to be replaced at the start of a link.
1111 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1113 [[linkkey:tag][description]]
1115 If REPLACE is a string, the tag will simply be appended to create the link.
1118 REPLACE may also be a function that will be called with the tag as the
1119 only argument to create the link, which should be returned as a string.
1121 See the manual for examples."
1126 "Non-nil means, hide link part and only show description of bracket links.
1127 Bracket links are like [[link][descritpion]]. This variable sets the initial
1128 state in new org-mode buffers. The setting can then be toggled on a
1129 per-buffer basis from the Org->Hyperlinks menu."
1134 "How the path name in file links should be stored.
1135 Valid values are:
1137 relative Relative to the current directory, i.e. the directory of the file
1138 into which the link is being inserted.
1139 absolute Absolute path, if possible with ~ for home directory.
1140 noabbrev Absolute path, no abbreviation of home directory.
1141 adaptive Use relative path for files in the current directory and sub-
1142 directories of it. For other files, use an absolute path."
1151 "Types of links that should be activated in Org-mode files.
1152 This is a list of symbols, each leading to the activation of a certain link
1153 type. In principle, it does not hurt to turn on most link types - there may
1154 be a small gain when turning off unused link types. The types are:
1156 bracket The recommended [[link][description]] or [[link]] links with hiding.
1157 angular Links in angular brackes that may contain whitespace like
1158 <bbdb:Carsten Dominik>.
1159 plain Plain links in normal text, no whitespace, like http://google.com.
1160 radio Text that is matched by a radio target, see manual for details.
1161 tag Tag settings in a headline (link to tag search).
1162 date Time stamps (link to calendar).
1164 Changing this variable requires a restart of Emacs to become effective."
1174 "Options concerning storing links in Org-mode"
1179 "Format of the description part of a link to an email or usenet message.
1180 The following %-excapes will be replaced by corresponding information:
1188 %s subject
1189 %m message-id.
1191 You may use normal field width specification between the % and the letter.
1192 This is for example useful to limit the length of the subject.
1206 It should match if the message is from the user him/herself."
1211 "Non-nil means, file links from `org-store-link' contain context.
1212 A search string will be added to the file name with :: as separator and
1213 used to find the context when the link is activated by the command
1214 `org-open-at-point'.
1216 negates this setting for the duration of the command."
1221 "Non-nil means, keep link in list for entire session.
1223 The command `org-store-link' adds a link pointing to the current
1224 location to an internal list. These links accumulate during a session.
1225 The command `org-insert-link' can be used to insert links into any
1226 Org-mode file (offering completion for all stored links). When this
1228 will be removed from the list, to make completing the unused links
1229 more efficient."
1234 "Non-nil means, `org-store-link' will create web links to Google groups.
1235 When nil, Gnus will be used for such links.
1237 negates this setting for the duration of the command."
1242 "Options concerning following links in Org-mode"
1247 "Non-nil means, on links TAB will follow the link.
1248 Needs to be set before org.el is loaded."
1253 "Non-nil means, on links RET will follow the link.
1254 Needs to be set before org.el is loaded."
1260 "Non-nil means, mouse-1 on a link will follow the link.
1261 A longer mouse click will still set point. Does not work on XEmacs.
1262 Needs to be set before org.el is loaded."
1267 "Number of different positions to be recorded in the ring
1268 Changing this requires a restart of Emacs to work correctly."
1276 "Setup the frame configuration for following links.
1277 When following a link with Emacs, it may often be useful to display
1278 this link in another window or frame. This variable can be used to
1279 set this up for the different types of links.
1280 For VM, use any of
1281 `vm-visit-folder'
1282 `vm-visit-folder-other-frame'
1283 For Gnus, use any of
1284 `gnus'
1285 `gnus-other-frame'
1286 For FILE, use any of
1287 `find-file'
1288 `find-file-other-window'
1289 `find-file-other-frame'
1290 For the calendar, use the variable `calendar-setup'.
1291 For BBDB, it is currently only possible to display the matches in
1292 another window."
1311 "Non-nil means, use indirect buffer to display infile links.
1312 Activating internal links (from one location in a file to another location
1313 in the same file) normally just jumps to the location. When the link is
1314 activated with a C-u prefix (or with mouse-3), the link is displayed in
1315 another window. When this option is set, the other window actually displays
1316 an indirect buffer clone of the current buffer, to avoid any visibility
1317 changes to the current buffer."
1322 "Non-nil means, `org-open-file' will open non-existing files.
1323 When nil, an error will be generated."
1328 "Function and arguments to call for following mailto links.
1329 This is a list with the first element being a lisp function, and the
1330 remaining elements being arguments to the function. In string arguments,
1331 %a will be replaced by the address, and %s will be replaced by the subject
1332 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1341 "Non-nil means, ask for confirmation before executing shell links.
1342 Shell links can be dangerous: just think about a link
1344 [[shell:rm -rf ~/*][Google Search]]
1347 but really it would remove your entire home directory.
1348 Therefore we advise against setting this variable to nil.
1349 Just change it to `y-or-n-p' of you want to confirm with a
1358 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1359 Elisp links can be dangerous: just think about a link
1364 but really it would remove your entire home directory.
1365 Therefore we advise against setting this variable to nil.
1366 Just change it to `y-or-n-p' of you want to confirm with a
1377 "Default file applications on a UNIX or GNU/Linux system.
1389 "Default file applications on a MacOS X system.
1391 for some files for which the OS does not have a good default.
1399 'mswindows-shell-execute
1402 "Default file applications on a Windows NT system.
1407 '(
1414 )
1415 "External applications for opening `file:path' items in a document.
1416 Org-mode uses system defaults for different file types, but
1417 you can use this variable to set the application for a given file
1418 extension. The entries in this list are cons cells where the car identifies
1419 files and the cdr the corresponding command. Possible values for the
1420 file identifier are
1422 `directory' Matches a directory
1423 `remote' Matches a remote file, accessible through tramp or efs.
1424 Remote files most likely should be visited through Emacs
1425 because external applications cannot handle such paths.
1426 t Default for all remaining files
1428 Possible values for the command are:
1429 `emacs' The file will be visited by the current Emacs process.
1430 `default' Use the default application for this file type.
1431 string A command to be executed by a shell; %s will be replaced
1432 by the path to the file.
1433 sexp A Lisp form which will be evaluated. The file path will
1434 be available in the Lisp variable `file'.
1435 For more examples, see the system specific constants
1436 `org-file-apps-defaults-macosx'
1437 `org-file-apps-defaults-windowsnt'
1438 `org-file-apps-defaults-gnu'."
1453 "Non-nil means, that the search for the mh-message will be extended to
1454 all folders if the message cannot be found in the folder given in the link.
1455 Searching all folders is very efficient with one of the search engines
1456 supported by MH-E, but will be slow with pick."
1461 "Options concerning interaction with remember.el."
1466 "Directory with org files.
1467 This directory will be used as default to prompt for org files.
1468 Used by the hooks for remember.el."
1473 "Default target for storing notes.
1474 Used by the hooks for remember.el. This can be a string, or nil to mean
1475 the value of `remember-data-file'.
1476 You can set this on a per-template basis with the variable
1477 `org-remember-templates'."
1481 file))
1484 "Non-nil means, `C-c C-c' stores remember note without further promts.
1485 In this case, you need `C-u C-c C-c' to get the prompts for
1486 note file and headline.
1487 When this variable is nil, `C-c C-c' give you the prompts, and
1488 `C-u C-c C-c' trigger the fasttrack."
1493 "The interface to be used for interactive filing of remember notes.
1494 This is only used when the interactive mode for selecting a filing
1495 location is used (see the variable `org-remember-store-without-prompt').
1496 Allowed vaues are:
1497 outline The interface shows an outline of the relevant file
1498 and the correct heading is found by moving through
1499 the outline or by searching with incremental search.
1500 outline-path-completion Headlines in the current buffer are offered via
1501 completion.
1502 refile Use the refile interface, and offer headlines,
1503 possibly from different buffers."
1511 "The default interface to be used for `org-goto'.
1512 Allowed vaues are:
1513 outline The interface shows an outline of the relevant file
1514 and the correct heading is found by moving through
1515 the outline or by searching with incremental search.
1516 outline-path-completion Headlines in the current buffer are offered via
1517 completion."
1524 "The headline that should be the default location in the notes file.
1525 When filing remember notes, the cursor will start at that position.
1526 You can set this on a per-template basis with the variable
1527 `org-remember-templates'."
1532 "Templates for the creation of remember buffers.
1533 When nil, just let remember make the buffer.
1534 When not nil, this is a list of 5-element lists. In each entry, the first
1535 element is the name of the template, which should be a single short word.
1536 The second element is a character, a unique key to select this template.
1537 The third element is the template. The fourth element is optional and can
1538 specify a destination file for remember items created with this template.
1539 The default file is given by `org-default-notes-file'. An optional fifth
1540 element can specify the headline in that file that should be offered
1541 first when the user is asked to file the entry. The default headline is
1542 given in the variable `org-remember-default-headline'.
1544 The template specifies the structure of the remember buffer. It should have
1545 a first line starting with a star, to act as the org-mode headline.
1546 Furthermore, the following %-escapes will be replaced with content:
1548 %^{prompt} Prompt the user for a string and replace this sequence with it.
1549 A default value and a completion table ca be specified like this:
1550 %^{prompt|default|completion2|completion3|...}
1551 %t time stamp, date only
1552 %T time stamp with date and time
1553 %u, %U like the above, but inactive time stamps
1554 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1555 You may define a prompt like %^{Please specify birthday}t
1556 %n user name (taken from `user-full-name')
1557 %a annotation, normally the link created with org-store-link
1558 %i initial content, the region active. If %i is indented,
1559 the entire inserted text will be indented as well.
1560 %c content of the clipboard, or current kill ring head
1561 %^g prompt for tags, with completion on tags in target file
1562 %^G prompt for tags, with completion all tags in all agenda files
1563 %:keyword specific information for certain link types, see below
1564 %[pathname] insert the contents of the file given by `pathname'
1565 %(sexp) evaluate elisp `(sexp)' and replace with the result
1566 %! Store this note immediately after filling the template
1568 %? After completing the template, position cursor here.
1570 Apart from these general escapes, you can access information specific to the
1571 link type that is created. For example, calling `remember' in emails or gnus
1572 will record the author and the subject of the message, which you can access
1573 with %:author and %:subject, respectively. Here is a complete list of what
1574 is recorded for each link type.
1576 Link type | Available information
1577 -------------------+------------------------------------------------------
1578 bbdb | %:type %:name %:company
1579 vm, wl, mh, rmail | %:type %:subject %:message-id
1580 | %:from %:fromname %:fromaddress
1581 | %:to %:toname %:toaddress
1583 gnus | %:group, for messages also all email fields
1584 w3, w3m | %:type %:url
1585 info | %:type %:file %:node
1586 calendar | %:type %:date"
1609 "Non-nil means, store new notes at the beginning of a file or entry.
1610 When nil, new notes will be filed to the end of a file or entry.
1611 This can also be a list with cons cells of regular expressions that
1612 are matched against file names, and values."
1622 This is list of cons cells. Each cell contains:
1623 - a specification of the files to be considered, either a list of files,
1624 or a symbol whose function or value fields will be used to retrieve
1625 a file name or a list of file names. Nil means, refile to a different
1626 heading in the current buffer.
1627 - A specification of how to find candidate refile targets. This may be
1628 any of
1630 This tag has to be present in all target headlines, inheritance will
1631 not be considered.
1633 todo keyword.
1635 headlines that are refiling targets.
1636 - a cons cell (:level . N). Any headline of level N is considered a target.
1637 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1638 ;; FIXME: what if there are a var and func with same name???
1654 "Non-nil means, provide refile targets as paths.
1655 So a level 3 headline will be available as level1/level2/level3.
1656 When the value is `file', also include the file name (without directory)
1657 into the path. When `full-file-path', include the full file path."
1666 "Options concerning TODO items in Org-mode."
1671 "Options concerning Progress logging in Org-mode."
1676 "List of TODO entry keyword sequences and their interpretation.
1679 Each sequence starts with a symbol, either `sequence' or `type',
1680 indicating if the keywords should be interpreted as a sequence of
1681 action steps, or as different types of TODO items. The first
1682 keywords are states requiring action - these states will select a headline
1683 for inclusion into the global TODO list Org-mode produces. If one of
1686 the last keyword is treated as the only DONE state of the sequence.
1689 additional state where no keyword is present. For details about this
1690 cycling, see the manual.
1692 TODO keywords and interpretation can also be set on a per-file basis with
1693 the special #+SEQ_TODO and #+TYP_TODO lines.
1695 Each keyword can optionally specify a character for fast state selection
1696 \(in combination with the variable `org-use-fast-todo-selection')
1697 and specifiers for state change logging, using the same syntax
1700 indicates to record a time stamp each time this state is selected.
1703 entering and when leaving this state.
1705 For backward compatibility, this variable may also be just a list
1706 of keywords - in this case the interptetation (sequence or type) will be
1707 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1745 "Controls how TODO keywords are interpreted.
1746 This variable is in principle obsolete and is only used for
1747 backward compatibility, if the interpretation of todo keywords is
1748 not given already in `org-todo-keywords'. See that variable for
1749 more information."
1756 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1757 This variable describes if and under what circumstances the cycling
1758 mechanism for TODO keywords will be replaced by a single-key, direct
1759 selection scheme.
1761 When nil, fast selection is never used.
1763 When the symbol `prefix', it will be used when `org-todo' is called with
1764 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1765 in an agenda buffer.
1767 When t, fast selection is used by default. In this case, the prefix
1768 argument forces cycling instead.
1770 In all cases, the special interface is only used if access keys have actually
1771 been assigned by the user, i.e. if keywords in the configuration are followed
1772 by a letter in parenthesis, like TODO(t)."
1780 "Hook which is run after the state of a TODO item was changed.
1781 The new state (a string with a TODO keyword, or nil) is available in the
1782 Lisp variable `state'."
1787 "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
1788 When equal to the list (done), also prompt for a closing note.
1789 This can also be configured on a per-file basis by adding one of
1790 the following lines anywhere in the buffer:
1792 #+STARTUP: logdone
1793 #+STARTUP: lognotedone
1794 #+STARTUP: nologdone"
1802 ;; Normalize old uses of org-log-done.
1808 ;; FIXME: document
1810 "Non-nil means, recored a note when clocking out of an item.
1811 This can also be configured on a per-file basis by adding one of
1812 the following lines anywhere in the buffer:
1814 #+STARTUP: lognoteclock-out
1815 #+STARTUP: nolognoteclock-out"
1821 "Non-nil means, the CLOSED time stamp will contain date and time.
1822 When nil, only the date will be recorded."
1830 "Headings for notes added when clocking out or closing TODO items.
1831 The value is an alist, with the car being a symbol indicating the note
1832 context, and the cdr is the heading to be used. The heading may also be the
1833 empty string.
1834 %t in the heading will be replaced by a time stamp.
1835 %s will be replaced by the new TODO state, in double quotes.
1836 %u will be replaced by the user name.
1837 %U will be replaced by the full user name."
1843 "Heading when changing todo state (todo sequence only)"
1848 "Non-nil means, the latest state change note will be directly after heading.
1849 When nil, the notes will be orderer according to time."
1855 "Non-nil means, record moving through the DONE state when triggering repeat.
1856 An auto-repeating tasks is immediately switched back to TODO when marked
1858 the TODO keyword definition, or recording a cloing note by setting
1859 `org-log-done', there will be no record of the task moving trhough DONE.
1860 This variable forces taking a note anyway. Possible values are:
1862 nil Don't force a record
1863 time Record a time stamp
1864 note Record a note
1866 This option can also be set with on a per-file-basis with
1868 #+STARTUP: logrepeat
1869 #+STARTUP: lognoterepeat
1870 #+STARTUP: nologrepeat
1872 You can have local logging settings for a subtree by setting the LOGGING
1873 property to one or more of these keywords."
1882 "Should clocking info be wrapped into a drawer?
1883 When t, clocking info will always be inserted into a :CLOCK: drawer.
1884 If necessary, the drawer will be created.
1885 When nil, the drawer will not be created, but used when present.
1886 When an integer and the number of clocking entries in an item
1887 reaches or exceeds this number, a drawer will be created."
1896 "When t, the clock will be stopped when the relevant entry is marked DONE.
1897 Nil means, clock will keep running until stopped explicitly with
1898 `C-c C-x C-o', or until the clock is started in a different item."
1903 "Set task to a special todo state while clocking it.
1904 The value should be the state to which the entry should be switched."
1912 "Priorities in Org-mode."
1917 "The highest priority of TODO items. A character like ?A, ?B etc.
1918 Must have a smaller ASCII number than `org-lowest-priority'."
1923 "The lowest priority of TODO items. A character like ?A, ?B etc.
1924 Must have a larger ASCII number than `org-highest-priority'."
1929 "The default priority of TODO items.
1930 This is the priority an item get if no explicit priority is given."
1935 "Non-nil means, start with default priority when starting to cycle.
1936 When this is nil, the first step in the cycle will be (depending on the
1937 command used) one higher or lower that the default priority."
1942 "Options concerning time stamps and deadlines in Org-mode."
1947 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1948 When nil, these labeled time stamps are forces into the second line of an
1949 entry, just after the headline. When scheduling from the global TODO list,
1950 the time stamp will always be forced into the second line."
1955 "Formats for `format-time-string' which are used for time stamps.
1959 "Number of minutes to round time stamps to upon insertion.
1960 When zero, insert the time unmodified. Useful rounding numbers
1961 should be factors of 60, so for example 5, 10, 15.
1962 When this is not zero, you can still force an exact time-stamp by using
1963 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1968 "Non-nil means, overlay custom formats over all time stamps.
1969 The formats are defined through the variable `org-time-stamp-custom-formats'.
1970 To turn this on on a per-file basis, insert anywhere in the file:
1971 #+STARTUP: customtime"
1979 "Custom formats for time stamps. See `format-time-string' for the syntax.
1980 These are overlayed over the default ISO format if the variable
1981 `org-display-custom-times' is set. Time like %H:%M should be at the
1982 end of the second format."
1987 "Get the right format for a time string."
1992 f)))
1995 "Non-nil means, assume future for incomplete date input from user.
1996 This affects the following situations:
1997 1. The user gives a day, but no month.
2000 it will be considered as *this* month.
2001 2. The user gives a month but not a year.
2005 When this option is nil, the current month and year will always be used
2006 as defaults."
2011 "Non-nil means, display current interpretation of date prompt live.
2012 This display will be in an overlay, in the minibuffer."
2017 "Non-nil means, pop up a calendar when prompting for a date.
2018 In the calendar, the date can be selected with mouse-1. However, the
2019 minibuffer will also be active, and you can simply enter the date as well.
2020 When nil, only the minibuffer will be available."
2028 "The hour when your day really ends.
2029 This has influence for the following applications:
2031 the time given here, the day recognized as TODAY is actually yesterday.
2032 - When a date is read from the user and it is still before the time given
2033 here, the current date and time will be assumed to be yesterday, 23:59.
2035 FIXME:
2036 IMPORTANT: This is still a very experimental feature, it may disappear
2037 again or it may be extended to mean more things."
2042 "Non-nil means, S-down will increase the time in a time stamp.
2043 When nil, S-up will increase."
2048 "Non-nil means, make the calendar window follow timestamp changes.
2049 When a timestamp is modified and the calendar window is visible, it will be
2050 moved to the new date."
2055 "When non-nil, should be a function to create `org-clock-heading'.
2056 This is the string shown in the mode line when a clock is running.
2057 The function is called with point at the beginning of the headline."
2062 "Options concerning tags in Org-mode."
2067 "List of tags allowed in Org-mode files.
2068 When this list is nil, Org-mode will base TAG input on what is already in the
2069 buffer.
2070 The value of this variable is an alist, the car of each entry must be a
2071 keyword as a string, the cdr may be a character that is used to select
2072 that tag through the fast-tag-selection interface.
2073 See the manual for details."
2083 "Non-nil means, use fast tag selection scheme.
2084 This is a special interface to select and deselect tags with single keys.
2085 When nil, fast selection is never used.
2086 When the symbol `auto', fast selection is used if and only if selection
2087 characters for tags have been configured, either through the variable
2088 `org-tag-alist' or through a #+TAGS line in the buffer.
2089 When t, fast selection is always used and selection keys are assigned
2090 automatically if necessary."
2098 "Non-nil means, fast tag selection exits after first change.
2099 When nil, you have to press RET to exit it.
2100 During fast tag selection, you can toggle this flag with `C-c'.
2101 This variable can also have the value `expert'. In this case, the window
2102 displaying the tags menu is not even shown, until you press C-c again."
2110 "Non-nil means, fast tags selection interface will also offer TODO states.
2114 "The column to which tags should be indented in a headline.
2115 If this number is positive, it specifies the column. If it is negative,
2116 it means that the tags should be flushright to that column. For example,
2117 -80 works well for a normal 80 character screen."
2122 "Non-nil means, realign tags after pro/demotion of TODO state change.
2123 These operations change the length of a headline and therefore shift
2124 the tags around. With this options turned on, after each such operation
2125 the tags are again aligned to `org-tags-column'."
2130 "Non-nil means, tags in levels apply also for sublevels.
2131 When nil, only the tags directly given in a specific line apply there.
2132 If you turn off this option, you very likely want to turn on the
2133 companion option `org-tags-match-list-sublevels'."
2138 "Non-nil means list also sublevels of headlines matching tag search.
2139 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2140 the sublevels of a headline matching a tag search often also match
2141 the same search. Listing all of them can create very long lists.
2142 Setting this variable to nil causes subtrees of a match to be skipped.
2143 This option is off by default, because inheritance in on. If you turn
2144 inheritance off, you very likely want to turn this option on.
2146 As a special case, if the tag search is restricted to TODO items, the
2147 value of this variable is ignored and sublevels are always checked, to
2148 make sure all corresponding TODO items find their way into the list."
2160 "Options concerning properties in Org-mode."
2165 "How property key/value pairs should be formatted by `indent-line'.
2166 When `indent-line' hits a property definition, it will format the line
2167 according to this format, mainly to make sure that the values are
2168 lined-up with respect to each other."
2173 "Non-nil means, properties apply also for sublevels.
2174 This setting is only relevant during property searches, not when querying
2175 an entry with `org-entry-get'. To retrieve a property with inheritance,
2176 you need to call `org-entry-get' with the inheritance flag.
2177 Turning this on can cause significant overhead when doing a search, so
2178 this is turned off by default.
2179 When nil, only the properties directly given in the current entry count.
2180 The value may also be a list of properties that shouldhave inheritance.
2182 However, note that some special properties use inheritance under special
2183 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2185 for valid values of a property."
2193 "The default column format, if no other format has been defined.
2194 This variable can be set on the per-file basis by inserting a line
2196 #+COLUMNS: %25ITEM ....."
2201 "List of property/value pairs that can be inherited by any entry.
2202 You can set buffer-local values for this by adding lines like
2204 #+PROPERTY: NAME VALUE"
2211 "List of property/value pairs that can be inherited by any entry.
2212 Valid for the current buffer.
2216 "Options concerning agenda views in Org-mode."
2221 "Variable used by org files to set a category for agenda display.
2222 Such files should use a file variable to set it, for example
2226 or contain a special line
2228 #+CATEGORY: ELisp
2230 If the file does not specify a category, then file's base name
2235 "The files to be used for agenda display.
2239 If an entry is a directory, all files in that directory that are matched by
2240 `org-agenda-file-regexp' will be part of the file list.
2242 If the value of the variable is not a list but a single file name, then
2243 the list of agenda files is actually stored and maintained in that file, one
2244 agenda file per line."
2251 "Regular expression to match files for `org-agenda-files'.
2252 If any element in the list in that variable contains a directory instead
2253 of a normal file, all files in that directory that are matched by this
2254 regular expression will be included."
2259 "t means to just skip non-reachable files in `org-agenda-files'.
2260 Nil means to remove them, after a query, from the list."
2265 "List of extra files to be searched by text search commands.
2266 These files will be search in addition to the agenda files bu the
2267 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2268 Note that these files will only be searched for text search commands,
2269 not for the other agenda views like todo lists, tag earches or the weekly
2270 agenda. This variable is intended to list notes and possibly archive files
2271 that should also be searched by these two commands."
2280 "When set, remote killing from the agenda buffer needs confirmation.
2281 When t, a confirmation is always needed. When a number N, confirmation is
2282 only needed when the text to be killed contains more than N non-white lines."
2290 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2291 The command `org-calendar-goto-agenda' will be bound to this key. The
2292 default is the character `c' because then `c' can be used to switch back and
2293 forth between agenda and calendar."
2298 "Non-nil means, make the block agenda more compact.
2299 This is done by leaving out unnecessary lines."
2304 "Options concerning exporting agenda views in Org-mode."
2309 "Non-nil means, use colors in agenda views."
2314 "Alist of variable/value pairs that should be active during agenda export.
2315 This is a good place to set uptions for ps-print and for htmlize."
2323 "The style specification for exported HTML Agenda files.
2324 If this variable contains a string, it will replace the default <style>
2325 section as produced by `htmlize'.
2326 Since there are different ways of setting style information, this variable
2327 needs to contain the full HTML structure to provide a style, including the
2328 surrounding HTML tags. The style specifications should include definitions
2329 the fonts used by the agenda, here is an example:
2332 p { font-weight: normal; color: gray; }
2333 .org-agenda-structure {
2334 font-size: 110%;
2335 color: #003399;
2336 font-weight: 600;
2337 }
2338 .org-todo {
2339 color: #cc6666;Week-agenda:
2340 font-weight: bold;
2341 }
2342 .org-done {
2343 color: #339933;
2344 }
2345 .title { text-align: center; }
2346 .todo, .deadline { color: red; }
2347 .done { color: green; }
2348 </style>
2350 or, if you want to keep the style in a file,
2354 As the value of this option simply gets inserted into the HTML <head> header,
2356 <style>...</style> is required, if not present the variable will be ignored."
2362 "Options concerning agenda views in Org-mode."
2367 "Custom commands for the agenda.
2368 These commands will be offered on the splash screen displayed by the
2371 (key desc type match options files)
2373 key The key (one or more characters as a string) to be associated
2374 with the command.
2375 desc A description of the commend, when omitted or nil, a default
2376 description is built using MATCH.
2377 type The command type, any of the following symbols:
2378 agenda The daily/weekly agenda.
2379 todo Entries with a specific TODO keyword, in all agenda files.
2380 search Entries containing search words entry or headline.
2381 tags Tags/Property/TODO match in all agenda files.
2382 tags-todo Tags/P/T match in all agenda files, TODO entries only.
2383 todo-tree Sparse tree of specific TODO keyword in *current* file.
2384 tags-tree Sparse tree with all tags matches in *current* file.
2385 occur-tree Occur sparse tree for *current* file.
2386 ... A user-defined function.
2387 match What to search for:
2388 - a single keyword for TODO keyword searches
2389 - a tags match expression for tags searches
2390 - a regular expression for occur searches
2391 options A list of option settings, similar to that in a let form, so like
2392 this: ((opt1 val1) (opt2 val2) ...)
2393 files A list of files file to write the produced agenda buffer to
2394 with the command `org-store-agenda-views'.
2397 produced. Otherwide, only the plain text is written to the file.
2399 You can also define a set of commands, to create a composite agenda buffer.
2400 In this case, an entry looks like this:
2402 (key desc (cmd1 cmd2 ...) general-options file)
2404 where
2406 desc A description string to be displayed in the dispatcher menu.
2407 cmd An agenda command, similar to the above. However, tree commands
2408 are no allowed, but instead you can get agenda and global todo list.
2409 So valid commands for a set are:
2410 (agenda)
2411 (alltodo)
2412 (stuck)
2418 Each command can carry a list of options, and another set of options can be
2419 given for the whole set of commands. Individual command options take
2420 precedence over the general options.
2422 When using several characters as key to a command, the first characters
2423 are prefix commands. For the dispatcher to display useful information, you
2424 should provide a description for the prefix, like
2426 (setq org-agenda-custom-commands
2504 "The register holding the current query string.
2505 The prupose of this is that if you construct a query string interactively,
2506 you can then use it to define a custom command."
2512 "How to identify stuck projects.
2513 This is a list of four items:
2514 1. A tags/todo matcher string that is used to identify a project.
2515 The entire tree below a headline matched by this is considered one project.
2516 2. A list of TODO keywords identifying non-stuck projects.
2517 If the project subtree contains any headline with one of these todo
2518 keywords, the project is considered to be not stuck. If you specify
2520 3. A list of tags identifying non-stuck projects.
2521 If the project subtree contains any headline with one of these tags,
2523 a tag, any tag will mark the project unstuck.
2524 4. An arbitrary regular expression matching non-stuck projects.
2527 or `C-c a #' to produce the list."
2531 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2537 "Options concerning skipping parts of agenda files."
2542 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2543 When nil, the sublevels of a TODO entry are not checked, resulting in
2544 potentially much shorter TODO lists."
2550 "Non-nil means, don't show entries with a date in the global todo list.
2551 You can use this if you prefer to mark mere appointments with a TODO keyword,
2552 but don't want them to show up in the TODO list.
2553 When this is set, it also covers deadlines and scheduled items, the settings
2554 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2555 will be ignored."
2561 "Non-nil means, don't show scheduled entries in the global todo list.
2562 The idea behind this is that by scheduling it, you have already taken care
2563 of this item.
2564 See also `org-agenda-todo-ignore-with-date'."
2570 "Non-nil means, don't show near deadline entries in the global todo list.
2571 Near means closer than `org-deadline-warning-days' days.
2572 The idea behind this is that such items will appear in the agenda anyway.
2573 See also `org-agenda-todo-ignore-with-date'."
2579 "Non-nil means don't show scheduled items in agenda when they are done.
2580 This is relevant for the daily/weekly agenda, not for the TODO list. And
2581 it applies only to the actual date of the scheduling. Warnings about
2582 an item with a past scheduling dates are always turned off when the item
2583 is DONE."
2588 "Non-nil means don't show deadines when the corresponding item is done.
2589 When nil, the deadline is still shown and should give you a happy feeling.
2590 This is relevant for the daily/weekly agenda. And it applied only to the
2591 actualy date of the deadline. Warnings about approching and past-due
2592 deadlines are always turned off when the item is DONE."
2597 "Non-nil means don't select item by timestamp or -range if it is DONE."
2602 "Non-nil means, `org-timeline' also shows dates without an entry.
2603 When nil, only the days which actually have entries are shown.
2604 When t, all days between the first and the last date are shown.
2605 When an integer, show also empty dates, but if there is a gap of more than
2606 N days, just insert a special line indicating the size of the gap."
2615 "Options concerning initial settings in the Agenda in Org Mode."
2620 "Hook run just before displaying an agenda buffer."
2625 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2626 A longer mouse click will still set point. Does not work on XEmacs.
2627 Needs to be set before org.el is loaded."
2632 "The initial value of follow-mode in a newly created agenda window."
2637 "Options concerning the windows used by the Agenda in Org Mode."
2642 "How the agenda buffer should be displayed.
2643 Possible values for this option are:
2645 current-window Show agenda in the current window, keeping all other windows.
2646 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2647 other-window Use `switch-to-buffer-other-window' to display agenda.
2648 reorganize-frame Show only two windows on the current frame, the current
2649 window and the agenda.
2650 See also the variable `org-agenda-restore-windows-after-quit'."
2659 "The min and max height of the agenda window as a fraction of frame height.
2660 The value of the variable is a cons cell with two numbers between 0 and 1.
2661 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2666 "Non-nil means, restore window configuration open exiting agenda.
2667 Before the window configuration is changed for displaying the agenda,
2668 the current status is recorded. When the agenda is exited with
2669 `q' or `x' and this option is set, the old state is restored. If
2670 `org-agenda-window-setup' is `other-frame', the value of this
2671 option will be ignored.."
2676 "How should indirect tree buffers be displayed?
2677 This applies to indirect buffers created with the commands
2679 Valid values are:
2680 current-window Display in the current window
2681 other-window Just display in another window.
2682 dedicated-frame Create one new frame, and re-use it each time.
2683 new-frame Make a new frame each time. Note that in this case
2684 previously-made indirect buffers are kept, and you need to
2685 kill these buffers yourself."
2695 "Options concerning the daily/weekly agenda."
2700 "Number of days to include in overview display.
2701 Should be 1 or 7."
2706 "Non-nil means, start the overview always on the specified weekday.
2707 0 denotes Sunday, 1 denotes Monday etc.
2708 When nil, always start on the current day."
2714 "Non-nil means, `org-agenda' shows every day in the selected range.
2715 When nil, only the days which actually have entries are shown."
2720 "Format string for displaying dates in the agenda.
2721 Used by the daily/weekly agenda and by the timeline. This should be
2722 a format string understood by `format-time-string', or a function returning
2723 the formatted date as a string. The function must take a single argument,
2724 a calendar-style date list like (month day year)."
2731 "Format a date string for display in the daily/weekly agenda, or timeline.
2732 This function makes sure that dates are aligned for easy reading."
2740 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2745 "Set means weekly/daily agenda will always contain all TODO entries.
2746 The TODO entries will be listed at the top of the agenda, before
2747 the entries for specific days."
2752 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2753 When nil, only one occurence is shown, either today or the
2754 nearest into the future."
2759 "No. of days before expiration during which a deadline becomes active.
2760 This variable governs the display in sparse trees and in the agenda.
2761 When 0 or negative, it means use this number (the absolute value of it)
2762 even if a deadline has a different individual lead time specified."
2768 "No. of days to continue listing scheduled items that are not marked DONE.
2769 When an item is scheduled on a date, it shows up in the agenda on this
2770 day and will be listed until it is marked done for the number of days
2771 given here."
2776 "Options concerning the time grid in the Org-mode Agenda."
2781 "Non-nil means, show a time grid in the agenda schedule.
2782 A time grid is a set of lines for specific times (like every two hours between
2783 8:00 and 20:00). The items scheduled for a day at specific times are
2784 sorted in between these lines.
2785 For details about when the grid will be shown, and what it will look like, see
2786 the variable `org-agenda-time-grid'."
2792 "----------------"
2795 "The settings for time grid for agenda display.
2796 This is a list of three items. The first item is again a list. It contains
2797 symbols specifying conditions when the grid should be displayed:
2799 daily if the agenda shows a single day
2800 weekly if the agenda shows an entire week
2801 today show grid on current date, independent of daily/weekly display
2802 require-timed show grid only if at least one item has a time specification
2804 The second item is a string which will be places behing the grid time.
2806 The third item is a list of integers, indicating the times that should have
2807 a grid line."
2809 :type
2816 require-timed)
2818 remove-match))
2823 "Options concerning sorting in the Org-mode Agenda."
2840 "Sorting structure for the agenda items of a single day.
2841 This is a list of symbols which will be used in sequence to determine
2842 if an entry should be listed before another entry. The following
2843 symbols are recognized:
2845 time-up Put entries with time-of-day indications first, early first
2846 time-down Put entries with time-of-day indications first, late first
2847 category-keep Keep the default order of categories, corresponding to the
2848 sequence in `org-agenda-files'.
2849 category-up Sort alphabetically by category, A-Z.
2850 category-down Sort alphabetically by category, Z-A.
2851 tag-up Sort alphabetically by last tag, A-Z.
2852 tag-down Sort alphabetically by last tag, Z-A.
2853 priority-up Sort numerically by priority, high priority last.
2854 priority-down Sort numerically by priority, high priority first.
2856 The different possibilities will be tried in sequence, and testing stops
2858 '(time-up category-keep priority-down)
2859 means: Pull out all entries having a specified time of day and sort them,
2860 in order to make a time schedule for the current day the first thing in the
2861 agenda listing for the day. Of the entries without a time indication, keep
2862 the grouped in categories, don't sort the categories, but keep them in
2863 the sequence given in `org-agenda-files'. Within each category sort by
2864 priority.
2866 Leaving out `category-keep' would mean that items will be sorted across
2867 categories by priority.
2869 Instead of a single list, this can also be a set of list for specific
2870 contents, with a context symbol in the car of the list, any of
2871 `agenda', `todo', `tags' for the corresponding agenda views."
2884 "Non-nil means, items without time are considered late.
2885 This is only relevant for sorting. When t, items which have no explicit
2886 time like 15:30 will be considered as 99:01, i.e. later than any items which
2887 do have a time. When nil, the default time is before 0:00. You can use this
2888 option to decide if the schedule for today should come before or after timeless
2889 agenda entries."
2894 "Options concerning the entry prefix in the Org-mode agenda display."
2904 "Format specifications for the prefix of items in the agenda views.
2905 An alist with four entries, for the different agenda types. The keys to the
2906 sublists are `agenda', `timeline', `todo', and `tags'. The values
2907 are format strings.
2908 This format works similar to a printf format, with the following meaning:
2911 as given by the CATEGORY keyword or derived from the file name.
2912 %T the *last* tag of the item. Last because inherited tags come
2913 first in the list.
2914 %t the time-of-day specification if one applies to the entry, in the
2915 format HH:MM
2916 %s Scheduling/Deadline information, a short string
2918 All specifiers work basically like the standard `%s' of printf, but may
2919 contain two additional characters: A question mark just after the `%' and
2920 a whitespace/punctuation character just before the final letter.
2922 If the first character after `%' is a question mark, the entire field
2923 will only be included if the corresponding value applies to the
2924 current entry. This is useful for fields which should have fixed
2925 width when present, but zero width when absent. For example,
2927 day is specified, but will completely disappear in entries which do
2928 not contain a time.
2930 If there is punctuation or whitespace character just before the final
2931 format letter, this character will be appended to the field value if
2934 empty, no additional colon would be interted.
2937 - Indent the line with two space characters
2938 - Give the category in a 12 chars wide field, padded with whitespace on
2939 the right (because of `-'). Append a colon if there is a category
2940 (because of `:').
2941 - If there is a time-of-day, put it into a 12 chars wide field. If no
2942 time, don't put in an empty field, just skip it (because of '?').
2943 - Finally, put the scheduling information and append a whitespace.
2945 As another example, if you don't want the time-of-day of entries in
2946 the prefix, you could use:
2950 See also the variables `org-agenda-remove-times-when-in-prefix' and
2951 `org-agenda-remove-tags'."
2963 "The compiled version of the most recently used prefix format.
2967 "Format for the TODO keyword in agenda lines.
2969 to occupy a fixed space in the agenda display."
2974 "Text preceeding scheduled items in the agenda view.
2975 This is a list with two strings. The first applies when the item is
2976 scheduled on the current day. The second applies when it has been scheduled
2977 previously, it may contain a %d to capture how many days ago the item was
2978 scheduled."
2985 "Text preceeding deadline items in the agenda view.
2986 This is a list with two strings. The first applies when the item has its
2987 deadline on the current day. The second applies when it is in the past or
2988 in the future, it may contain %d to capture how many days away the deadline
2989 is (was)."
2996 "Non-nil means, remove duplicate time specifications in agenda items.
2997 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2998 time-of-day specification in a headline or diary entry is extracted and
2999 placed into the prefix. If this option is non-nil, the original specification
3000 \(a timestamp or -range, or just a plain time(range) specification like
3001 11:30-4pm) will be removed for agenda display. This makes the agenda less
3002 cluttered.
3003 The option can be t or nil. It may also be the symbol `beg', indicating
3004 that the time should only be removed what it is located at the beginning of
3005 the headline/diary entry."
3014 "Default duration for appointments that only have a starting time.
3015 When nil, no duration is specified in such cases.
3016 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
3024 "Non-nil means, remove the tags from the headline copy in the agenda.
3025 When this is the symbol `prefix', only remove tags when
3026 `org-agenda-prefix-format' contains a `%T' specifier."
3038 "Shift tags in agenda items to this column.
3039 If this number is positive, it specifies the column. If it is negative,
3040 it means that the tags should be flushright to that column. For example,
3041 -80 works well for a normal 80 character screen."
3049 "Non-nil means, highlight low and high priorities in agenda.
3050 When t, the highest priority entries are bold, lowest priority italic.
3051 This may also be an association list of priority faces. The face may be
3062 "Options for embedding LaTeX code into Org-mode"
3070 "Options for creating images from LaTeX fragments.
3071 This is a property list with the following properties:
3073 `default' means use the forground of the default face.
3075 `default' means use the background of the default face.
3076 :scale a scaling factor for the size of the images
3077 :html-foreground, :html-background, :html-scale
3078 The same numbers for HTML export.
3079 :matchers a list indicating which matchers should be used to
3080 find LaTeX fragments. Valid members of this list are:
3097 "The document header used for processing LaTeX fragments."
3102 "Options for exporting org-listings."
3107 "General options for exporting Org-mode files."
3111 ;; FIXME
3116 When this option is turned on, these strings will be exported as:
3118 Org HTML LaTeX
3119 -----+----------+--------
3121 -- – --
3122 --- — ---
3123 ... … \ldots
3140 "Terms used in export text, translated to different languages.
3141 Use the variable `org-export-default-language' to set the language,
3142 or use the +OPTION lines for a per-file setting."
3152 "The default language of HTML export, as a string.
3153 This should have an association in `org-export-language-setup'."
3158 "Non-nil means, skip all text before the first headline when exporting.
3159 When nil, that text is exported as well."
3164 "The last level which is still exported as a headline.
3165 Inferior levels will produce itemize lists when exported.
3166 Note that a numeric prefix argument to an exporter function overrides
3167 this setting.
3174 "Non-nil means, add section numbers to headlines when exporting.
3181 "Non-nil means, create a table of contents in exported files.
3182 The TOC contains headlines with levels up to`org-export-headline-levels'.
3183 When an integer, include levels up to N in the toc, this may then be
3184 different from `org-export-headline-levels', but it will not be allowed
3185 to be larger than the number of headline levels.
3186 When nil, no table of contents is made.
3189 ASCII export, and with red color in HTML output, if the option
3190 `org-export-mark-todo-in-toc' is set.
3192 In HTML output, the TOC will be clickable.
3203 "Non-nil means, mark TOC lines that contain any open TODO items."
3208 "Non-nil means, preserve all line breaks when exporting.
3209 Normally, in HTML output paragraphs will be reformatted. In ASCII
3210 export, line breaks will always be preserved, regardless of this variable.
3217 "Whether subtrees with the ARCHIVE tag should be exported.
3218 This can have three different values
3219 nil Do not export, pretend this tree is not present
3220 t Do export the entire tree
3221 headline Only export the headline, but skip the tree below it."
3230 "Non-nil means, insert author name and email into the exported file.
3232 This option can also be set with the +OPTIONS line,
3238 "Non-nil means, insert a time stamp into the exported file.
3239 The time stamp shows when the file was created.
3241 This option can also be set with the +OPTIONS line,
3247 "If nil, do not export time stamps and associated keywords."
3252 "If nil, remove timestamps from the table of contents entries."
3257 "If nil, do not export tags, just remove them from headlines.
3258 If this is the symbol `not-in-toc', tags will be removed from table of
3259 contents entries, but still be shown in the headlines of the document.
3269 "Non-nil means, export with drawers like the property drawer.
3270 When t, all drawers are exported. This may also be a list of
3271 drawer names to export."
3280 "Options for translating special ascii sequences for the export backends."
3285 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3286 If the export target supports emphasizing text, the word will be
3287 typeset in bold, italic, or underlined, respectively. Works only for
3288 single words, but you can say: I *really* *mean* *this*.
3289 Not all export backends support this.
3296 "If nil, export [1] as a footnote marker.
3297 Lines starting with [1] will be formatted as footnotes.
3305 When this option is turned on, you can use TeX-like syntax for sub- and
3307 considered as a single item - so grouping with {} is normally not
3308 needed. For example, the following things will be parsed as single
3309 sub- or superscripts.
3311 10^24 or 10^tau several digits will be considered 1 item.
3312 10^-12 or 10^-tau a leading sign with digits or a word
3313 x^2-y^3 will be read as x^2 - y^3, because items are
3314 terminated by almost any nonword/nondigit char.
3315 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3317 Still, ambiguity is possible - so when in doubt use {} to enclose the
3318 sub/superscript. If you set this variable to the symbol `{}',
3319 the braces are *required* in order to trigger interpretations as
3321 frequently in plain text.
3323 Not all export backends support this, but HTML does.
3334 When this option is turned on, these strings will be exported as:
3337 -- : –
3338 --- : —
3340 Not all export backends support this, but HTML does.
3347 "Non-nil means, interpret simple TeX-like macros when exporting.
3349 No only real TeX macros will work here, but the standard HTML entities
3350 for math can be used as macro names as well. For a list of supported
3351 names in HTML export, see the constant `org-html-entities'.
3352 Not all export backends support this.
3360 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3362 the first non-white thing on a line. It will also find the math delimiters
3364 display math.
3373 This can be used to have pre-formatted text, fragments of code etc. For
3374 example:
3375 : ;; Some Lisp examples
3376 : (while (defc cnt)
3377 : (ding))
3378 will be looking just like this in also HTML. See also the QUOTE keyword.
3379 Not all export backends support this.
3386 "Number of stacked braces for sub/superscript matching.
3387 This has to be set before loading org.el to be effective."
3392 "Options for exporting tables in Org-mode."
3398 For example:
3400 | Name | Address | Birthday |
3401 |-------------+----------+-----------|
3402 | Arthur Dent | England | 29.2.2100 |
3404 Not all export backends support this.
3411 "Non-nil means, highlight the first table line.
3412 In HTML export, this means use <th> instead of <td>.
3413 In tables created with table.el, this applies to the first table line.
3414 In Org-mode tables, all lines before the first horizontal separator
3415 line will be formatted with <th> tags."
3420 "Remove special lines and marking characters in calculating tables.
3421 This removes the special marking character column from tables that are set
3422 up for spreadsheet calculations. It also removes the entire lines
3423 marked with `!', `_', or `^'. The lines with `$' are kept, because
3424 the values of constants may be useful to have."
3429 "Non-nil means, always export tables created with table.el natively.
3430 Natively means, use the HTML code generator in table.el.
3431 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3432 the table does not use row- or column-spanning). This has the
3433 advantage, that the automatic HTML conversions for math symbols and
3434 sub/superscripts can be applied. Org-mode's HTML generator is also
3435 much faster."
3440 "Options specific for ASCII export of Org-mode files."
3445 "Characters for underlining headings in ASCII export.
3446 In the given sequence, these characters will be used for level 1, 2, ..."
3451 "Bullet characters for headlines converted to lists in ASCII export.
3452 The first character is used for the first lest level generated in this
3453 way, and so on. If there are more levels than characters given here,
3454 the list will be repeated.
3455 Note that plain lists will keep the same bullets as the have in the
3456 Org-mode file."
3461 "Options specific for XML export of Org-mode files."
3466 "Options specific for HTML export of Org-mode files."
3471 ""
3476 "The extension for exported HTML files."
3482 html {
3483 font-family: Times, serif;
3484 font-size: 12pt;
3485 }
3486 .title { text-align: center; }
3487 .todo { color: red; }
3488 .done { color: green; }
3489 .timestamp { color: grey }
3490 .timestamp-kwd { color: CadetBlue }
3491 .tag { background-color:lightblue; font-weight:normal }
3492 .target { background-color: lavender; }
3493 pre {
3494 border: 1pt solid #AEBDCC;
3495 background-color: #F3F5F7;
3496 padding: 5pt;
3497 font-family: courier, monospace;
3498 }
3499 table { border-collapse: collapse; }
3500 td, th {
3501 vertical-align: top;
3502 <!--border: 1pt solid #ADB9CC;-->
3503 }
3504 </style>"
3505 "The default style specification for exported HTML files.
3506 Since there are different ways of setting style information, this variable
3507 needs to contain the full HTML structure to provide a style, including the
3508 surrounding HTML tags. The style specifications should include definitions
3509 for new classes todo, done, title, and deadline. For example, legal values
3510 would be:
3513 p { font-weight: normal; color: gray; }
3514 h1 { color: black; }
3515 .title { text-align: center; }
3516 .todo, .deadline { color: red; }
3517 .done { color: green; }
3518 </style>
3520 or, if you want to keep the style in a file,
3524 As the value of this option simply gets inserted into the HTML <head> header,
3531 "Format for typesetting the document title in HTML export."
3536 "The <H> level for level 1 headings in HTML export."
3541 "Non-nil means, make file links to `file.org' point to `file.html'.
3542 When org-mode is exporting an org-mode file to HTML, links to
3543 non-html files are directly put into a href tag in HTML.
3544 However, links to other Org-mode files (recognized by the
3545 extension `.org.) should become links to the corresponding html
3546 file, assuming that the linked org-mode file will also be
3547 converted to HTML.
3548 When nil, the links still point to the plain `.org' file."
3553 "Non-nil means, inline images into exported HTML pages.
3554 This is done using an <img> tag. When nil, an anchor with href is used to
3555 link to the image. If this option is `maybe', then images in links with
3556 an empty description will be inlined, while images with a description will
3557 be linked only."
3563 ;; FIXME: rename
3565 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3566 When nil, these tags will be exported as plain text and therefore
3567 not be interpreted by a browser.
3575 "The HTML tag that is used to start a table.
3576 This must be a <table> tag, but you may change the options like
3577 borders and spacing."
3582 "The opening tag for table header fields.
3583 This is customizable so that alignment options can be specified."
3588 "The opening tag for table data fields.
3589 This is customizable so that alignment options can be specified."
3594 "If non-nil, write `org-export-html-html-helper-timestamp'
3595 into the exported HTML text. Otherwise, the buffer will just be saved
3596 to a file."
3602 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3607 "Options specific for iCalendar export of Org-mode files."
3612 "The file name for the iCalendar file covering all agenda files.
3614 The file name should be absolute, the file will be overwritten without warning."
3619 "Non-nil means, export to iCalendar files should also cover TODO items."
3627 "Non-nil means, export to iCalendar files should also cover sexp entries.
3628 These are entries like in the diary, but directly in an Org-mode file."
3633 "Amount of text below headline to be included in iCalendar export.
3634 This is a number of characters that should maximally be included.
3635 Properties, scheduling and clocking lines will always be removed.
3636 The text will be inserted into the DESCRIPTION field."
3644 "Calendar name for the combined iCalendar representing all agenda files."
3649 "Font-lock settings for highlighting in Org-mode."
3654 "Non-nil means fontify only the stars in each headline.
3655 When nil, the entire headline is fontified.
3656 Changing it requires restart of `font-lock-mode' to become effective
3657 also in regions already fontified."
3662 "Non-nil means, hide the first N-1 stars in a headline.
3663 This works by using the face `org-hide' for these stars. This
3664 face is white for a light background, and black for a dark
3665 background. You may have to customize the face `org-hide' to
3666 make this work.
3667 Changing it requires restart of `font-lock-mode' to become effective
3668 also in regions already fontified.
3669 You may also set this on a per-file basis by adding one of the following
3670 lines to the buffer:
3672 #+STARTUP: hidestars
3673 #+STARTUP: showstars"
3678 "Non-nil means, change the face of a headline if it is marked DONE.
3679 Normally, only the TODO/DONE keyword indicates the state of a headline.
3680 When this is non-nil, the headline after the keyword is set to the
3681 `org-headline-done' as an additional indication."
3686 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3687 Changing this variable requires a restart of Emacs to take effect."
3692 "Non-nil means, fontify what is treated specially by the exporters."
3697 "Non-nil mean font-lock should hide the emphasis marker characters."
3708 "Set variable and compute the emphasis regular expression."
3712 org-emphasis-alist org-emphasis-regexp-components)
3725 ;; make sure special characters appear at the right position in the class
3737 ;; Make the regexp
3745 body1
3757 body1
3765 "Components used to build the regular expression for emphasis.
3766 This is a list with 6 entries. Terminology: In an emphasis string
3770 specify what is allowed/forbidden in each part:
3772 pre Chars allowed as prematch. Beginning of line will be allowed too.
3773 post Chars allowed as postmatch. End of line will be allowed too.
3774 border The chars *forbidden* as border characters.
3776 non-shy groups here, and don't allow newline here.
3777 newline The maximum number of newlines allowed in an emphasis exp.
3779 Use customize to modify this, or restart Emacs after changing it."
3797 )
3798 "Special syntax for emphasized text.
3799 Text starting and ending with a special character will be emphasized, for
3800 example *bold*, _underlined_ and /italic/. This variable sets the marker
3801 characters, the face to be used by font-lock for highlighting in Org-mode
3802 Emacs buffers, and the HTML tags to be used for this.
3803 Use customize to modify this, or restart Emacs after changing it."
3816 ;;; The faces
3819 "Faces in Org-mode."
3824 "Make a compatible face specification.
3825 If INHERITS is an existing face and if the Emacs version supports it,
3826 just inherit the face. If not, use SPECS to define the face.
3827 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3828 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3829 to the top of the list. The `min-colors' attribute will be removed from
3830 any other entries, and any resulting duplicates will be removed entirely."
3834 ;; In Emacs 23, we use inheritance where possible.
3835 ;; We only do this in Emacs 23, because only there the outline
3836 ;; faces have been changed to the original org-mode-level-faces.
3839 ;; These do not understand the `min-colors' attribute.
3858 "Face used to hide leading stars in headlines.
3859 The forground color of this face should be equal to the background
3860 color of the frame."
3871 "Face used for level 1 headlines."
3881 "Face used for level 2 headlines."
3893 "Face used for level 3 headlines."
3905 "Face used for level 4 headlines."
3913 "Face used for level 5 headlines."
3921 "Face used for level 6 headlines."
3929 "Face used for level 7 headlines."
3937 "Face used for level 8 headlines."
3945 "Face used for special keywords."
3956 "Face used for drawers."
3960 "Face used for the value of a property."
3972 "Face for column display of entry properties."
3976 ;; Make sure that a fixed-width face is used when we have a column table.
3988 "Face for deadlines and TODO keywords."
4001 "Face for headline with the ARCHIVE tag."
4008 "Face for links."
4015 "Face for the ellipsis in folded text."
4022 "Face for links."
4029 "Face for links."
4036 "Face for links."
4041 "Face for tags."
4051 "Face for TODO keywords."
4060 "Face used for todo keywords that indicate DONE items."
4068 "Face used to indicate that a headline is DONE.
4069 This face is only used if `org-fontify-done-headline' is set. If applies
4070 to the part of the headline after the DONE keyword."
4074 "Faces for specific TODO keywords.
4075 This is a list of cons cells, with TODO keywords in the car
4076 and faces in the cdr. The face can be a symbol, or a property
4093 "Face used for tables."
4103 "Face for formulas."
4116 "Face for fixed-with text like code snippets."
4130 "Face for fixed-with text like code snippets."
4142 "Face used in agenda for captions and dates."
4151 "Face for items scheduled for a certain day."
4161 "Face for items scheduled previously, and not yet done."
4171 "Face for items scheduled previously, and not yet done."
4178 "Faces for showing deadlines in the agenda.
4179 This is a list of cons cells. The cdr of each cell is a face to be used,
4181 Each car is a fraction of the head-warning time that must have passed for
4182 this the face in the cdr to be used for display. The numbers must be
4183 given in descending order. The head-warning time is normally taken
4184 from `org-deadline-warning-days', but can also be specified in the deadline
4185 timestamp itself, like this:
4187 DEADLINE: <2007-08-13 Mon -8d>
4189 You may use d for days, w for weeks, m for months and y for years. Months
4190 and years will only be treated in an approximate fashion (30.4 days for a
4191 month and 365.24 days for a year)."
4199 ;; FIXME: this is not a good face yet.
4208 "Face for showing the agenda restriction lock."
4216 "Face used for time grids."
4221 org-level-5 org-level-6 org-level-7 org-level-8
4222 ))
4225 "The number of different faces to be used for headlines.
4226 Org-mode defines 8 different headline faces, so this can be at most 8.
4227 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4231 ;;; Functions and variables from ther packages
4232 ;; Declared here to avoid compiler warnings
4238 ;; XEmacs only
4244 ;; Emacs only
4247 ;; Various packages
4248 ;; FIXME: get the argument lists for the UNKNOWN stuff
4303 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4304 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4335 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4346 ;; backward compatibility to old version of wl
4349 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4362 ;;; Variables for pre-computed regular expressions, all buffer local
4377 "Matches a headline and puts everything into groups:
4378 group 1: the stars
4379 group 2: The todo keyword, maybe
4380 group 3: Priority cookie
4381 group 4: True headline
4385 "Matches a headline and puts TODO state into group 2 if present.
4430 rear-nonsticky t mouse-map t fontified t)
4437 s)
4444 s)
4453 "Modified `buffer-invisibility-spec' for Emacs 21.
4454 Some ops with invisible text do not work correctly on Emacs 21. For these
4455 we turn off invisibility temporarily. Use this in a `let' form."
4459 "Make VAR local in current buffer and set it to VALUE."
4463 "Check if the current buffer is in Org-mode."
4467 "Return the last element of LIST."
4500 "Variable associated with STARTUP options for org-mode.
4501 Each element is a list of three items: The startup options as written
4502 in the #+STARTUP line, the corresponding variable, and the value to
4503 set this variable to if the option is found. An optional forth element PUSH
4507 "Precompute regular expressions for current buffer."
4522 kwds kws0 kwsa key log value cat arch tags const links hw dws
4523 tail sep kws1 prio props drawers)
4547 links)))
4553 props)))
4560 l var val)
4575 )))
4589 ;; Process the TODO keywords
4591 ;; Use the global values as if they had been given locally.
4602 kwsa nil
4605 ;; 1 2
4613 kw)
4615 kws0)
4632 ;; Process the constants
4640 ;; Process the tags.
4650 tgs))
4658 ;; Compute the regular expressions and other local variables
4663 org-drawer-regexp
4667 org-not-done-keywords
4669 org-todo-regexp
4672 org-not-done-regexp
4676 org-todo-line-regexp
4680 org-complex-heading-regexp
4685 org-nl-done-regexp
4689 org-todo-line-tags-regexp
4694 org-looking-at-done-regexp
4699 org-deadline-time-regexp
4701 org-deadline-line-regexp
4703 org-scheduled-regexp
4705 org-scheduled-time-regexp
4707 org-closed-time-regexp
4709 org-keyword-time-regexp
4715 org-keyword-time-not-clock-regexp
4721 org-maybe-keyword-time-regexp
4727 org-planning-or-clock-line-re
4732 )
4737 "Extract the log state setting from a TODO keyword string.
4751 "Remove a pair of parenthesis at the end of each string in LIST."
4755 x))
4756 list))
4758 ;; FIXME: this could be done much better, using second characters etc.
4760 "Assign fast keys to a keyword-key alist.
4761 Respect keys that are already there."
4771 ;; automatically assign a character.
4783 ;;; Some variables ujsed in various places
4788 "Function to be called when `C-c C-c' is used.
4792 ;; FIXME: Occasionally check by commenting these, to make sure
4793 ;; no other functions uses these, forgetting to let-bind them.
4800 ;; Defined somewhere in this file, but used before definition.
4813 ;;;; Emacs/XEmacs compatibility
4815 ;; Overlay compatibility functions
4833 "Make overlay OVL display TEXT with face FACE."
4843 "Make overlay OVL display TEXT with face FACE."
4866 "Find all overlays specifying PROP at POS or point.
4867 If DELETE is non-nil, delete all those overlays."
4869 ov found)
4873 found))
4875 ;; Region compatibility
4878 "Add-hook, compatible with both Emacsen."
4887 "Is `transient-mark-mode' on and the region active?
4888 Works on both Emacs and XEmacs."
4890 nil
4897 ;; Invisibility compatibility
4900 "Add elements to `buffer-invisibility-spec'.
4901 See documentation for `buffer-invisibility-spec' for the kind of elements
4902 that can be added."
4913 "Remove elements from `buffer-invisibility-spec'."
4921 "Is ARG a member of `buffer-invisibility-spec'?"
4924 nil))
4926 ;;;; Define the Org-mode
4929 (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."))
4932 ;; We use a before-change function to check if a table might need
4933 ;; an update.
4935 "Indicates that a table might need an update.
4936 This variable is set by `org-before-change-function'.
4945 ;;;###autoload
4947 "Outline-based notes management and organizer, alias
4950 Org-mode develops organizational tasks around a NOTES file which
4951 contains information about projects as plain text. Org-mode is
4952 implemented on top of outline-mode, which is ideal to keep the content
4953 of large files well structured. It supports ToDo items, deadlines and
4954 time stamps, which magically appear in the diary listing of the Emacs
4955 calendar. Tables are easily created with a built-in table editor.
4956 Plain text URL-like links connect to websites, emails (VM), Usenet
4957 messages (Gnus), BBDB entries, and any files related to the project.
4958 For printing and sharing of notes, an Org-mode file (or a part of it)
4959 can be exported as a structured ASCII or HTML file.
4961 The following commands are available:
4965 ;; Get rid of Outline menus, they are not needed
4966 ;; Need to do this here because define-derived-mode sets up
4967 ;; the keymap so late. Still, it is a waste to call this each time
4968 ;; we switch another buffer into org-mode.
4971 ;; Assume this is Greg's port, it used easymenu
4994 org-display-table 4
4997 org-ellipsis)))
5001 ;; Calc embedded
5008 ;; Activate before-change-function
5012 ;; Check for running clock before killing a buffer
5014 ;; Paragraphs and auto-filling
5019 ;; Comment characters
5020 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
5023 ;; Align options lines
5025 'align-mode-rules-list
5030 ;; Imenu
5034 ;; Make isearch reveal context
5037 ;; Emacs 21 and XEmacs make use of the hook
5039 ;; Emacs 22 deals with this through a special variable
5043 ;; If empty file that did not turn on org-mode automatically, make it to.
5065 "Call COMMAND interactively, but pretend prefix are was ARG."
5071 ;; works also in narrowed buffer, because we start at 1, not point-min
5075 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5085 "Add text properties to entire string, from beginning to end.
5086 PLIST may be a list of properties, PROPS are individual properties and values
5087 that will be added to PLIST. Returns the string that was modified."
5090 string)
5094 ;;;; Font-Lock stuff, including the activators
5099 (org-defkey org-mouse-map
5100 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5101 (when org-mouse-1-follows-link
5102 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5103 (when org-tab-follows-link
5104 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5105 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5106 (when org-return-follows-link
5107 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5108 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5110 (require 'font-lock)
5113 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5114 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5115 (defvar org-link-re-with-space nil
5116 "Matches a link with spaces, optional angular brackets around it.")
5117 (defvar org-link-re-with-space2 nil
5118 "Matches a link with spaces, optional angular brackets around it.")
5119 (defvar org-angle-link-re nil
5120 "Matches link with angular brackets, spaces are allowed.")
5121 (defvar org-plain-link-re nil
5122 "Matches plain link, without spaces.")
5123 (defvar org-bracket-link-regexp nil
5124 "Matches a link in double brackets.")
5125 (defvar org-bracket-link-analytic-regexp nil
5126 "Regular expression used to analyze links.
5127 Here is what the match groups contain after a match:
5128 1: http:
5129 2: http
5130 3: path
5131 4: [desc]
5132 5: desc")
5133 (defvar org-any-link-re nil
5134 "Regular expression matching any link.")
5136 (defun org-make-link-regexps ()
5137 "Update the link regular expressions.
5138 This should be called after the variable `org-link-types' has changed."
5139 (setq org-link-re-with-space
5140 (concat
5143 "[^" org-non-link-chars "]*"
5145 org-link-re-with-space2
5146 (concat
5151 org-angle-link-re
5152 (concat
5155 "[^" org-non-link-chars "]*"
5157 org-plain-link-re
5158 (concat
5161 org-bracket-link-regexp
5163 org-bracket-link-analytic-regexp
5164 (concat
5171 org-any-link-re
5176 (org-make-link-regexps)
5179 "Regular expression for fast time stamp matching.")
5181 "Regular expression for fast time stamp matching.")
5182 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5183 "Regular expression matching time strings for analysis.
5184 This one does not require the space after the date.")
5185 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5186 "Regular expression matching time strings for analysis.")
5188 "Regular expression matching time stamps, with groups.")
5190 "Regular expression matching time stamps (also [..]), with groups.")
5191 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5192 "Regular expression matching a time stamp range.")
5193 (defconst org-tr-regexp-both
5194 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5195 "Regular expression matching a time stamp range.")
5198 "Regular expression matching a time stamp or time stamp range.")
5201 "Regular expression matching a time stamp or time stamp range.
5202 The time stamps may be either active or inactive.")
5204 (defvar org-emph-face nil)
5206 (defun org-do-emphasis-faces (limit)
5207 "Run through the buffer and add overlays to links."
5208 (let (rtn)
5209 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5210 (if (not (= (char-after (match-beginning 3))
5211 (char-after (match-beginning 4))))
5212 (progn
5213 (setq rtn t)
5214 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5215 'face
5216 (nth 1 (assoc (match-string 3)
5217 org-emphasis-alist)))
5218 (add-text-properties (match-beginning 2) (match-end 2)
5219 '(font-lock-multiline t))
5220 (when org-hide-emphasis-markers
5221 (add-text-properties (match-end 4) (match-beginning 5)
5222 '(invisible org-link))
5223 (add-text-properties (match-beginning 3) (match-end 3)
5224 '(invisible org-link)))))
5225 (backward-char 1))
5226 rtn))
5228 (defun org-emphasize (&optional char)
5229 "Insert or change an emphasis, i.e. a font like bold or italic.
5230 If there is an active region, change that region to a new emphasis.
5231 If there is no region, just insert the marker characters and position
5232 the cursor between them.
5233 CHAR should be either the marker character, or the first character of the
5234 HTML tag associated with that emphasis. If CHAR is a space, the means
5235 to remove the emphasis of the selected region.
5236 If char is not given (for example in an interactive call) it
5237 will be prompted for."
5238 (interactive)
5239 (let ((eal org-emphasis-alist) e det
5240 (erc org-emphasis-regexp-components)
5241 (prompt "")
5242 (string "") beg end move tag c s)
5243 (if (org-region-active-p)
5244 (setq beg (region-beginning) end (region-end)
5245 string (buffer-substring beg end))
5246 (setq move t))
5248 (while (setq e (pop eal))
5249 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5250 c (aref tag 0))
5251 (push (cons c (string-to-char (car e))) det)
5252 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5253 (substring tag 1)))))
5254 (unless char
5255 (message "%s" (concat "Emphasis marker or tag:" prompt))
5256 (setq char (read-char-exclusive)))
5257 (setq char (or (cdr (assoc char det)) char))
5258 (if (equal char ?\ )
5259 (setq s "" move nil)
5260 (unless (assoc (char-to-string char) org-emphasis-alist)
5262 (setq s (char-to-string char)))
5263 (while (and (> (length string) 1)
5264 (equal (substring string 0 1) (substring string -1))
5265 (assoc (substring string 0 1) org-emphasis-alist))
5266 (setq string (substring string 1 -1)))
5267 (setq string (concat s string s))
5268 (if beg (delete-region beg end))
5269 (unless (or (bolp)
5271 (char-to-string (char-before (point)))))
5272 (insert " "))
5274 (char-to-string (char-after (point))))
5275 (insert " ") (backward-char 1))
5276 (insert string)
5277 (and move (backward-char 1))))
5279 (defconst org-nonsticky-props
5280 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5283 (defun org-activate-plain-links (limit)
5284 "Run through the buffer and add overlays to links."
5285 (catch 'exit
5286 (let (f)
5287 (while (re-search-forward org-plain-link-re limit t)
5288 (setq f (get-text-property (match-beginning 0) 'face))
5289 (if (or (eq f 'org-tag)
5290 (and (listp f) (memq 'org-tag f)))
5291 nil
5292 (add-text-properties (match-beginning 0) (match-end 0)
5293 (list 'mouse-face 'highlight
5294 'rear-nonsticky org-nonsticky-props
5295 'keymap org-mouse-map
5296 ))
5297 (throw 'exit t))))))
5299 (defun org-activate-code (limit)
5301 (unless (get-text-property (match-beginning 1) 'face)
5302 (remove-text-properties (match-beginning 0) (match-end 0)
5303 '(display t invisible t intangible t))
5304 t)))
5306 (defun org-activate-angle-links (limit)
5307 "Run through the buffer and add overlays to links."
5308 (if (re-search-forward org-angle-link-re limit t)
5309 (progn
5310 (add-text-properties (match-beginning 0) (match-end 0)
5311 (list 'mouse-face 'highlight
5312 'rear-nonsticky org-nonsticky-props
5313 'keymap org-mouse-map
5314 ))
5315 t)))
5317 (defmacro org-maybe-intangible (props)
5318 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5319 In emacs 21, invisible text is not avoided by the command loop, so the
5320 intangible property is needed to make sure point skips this text.
5321 In Emacs 22, this is not necessary. The intangible text property has
5322 led to problems with flyspell. These problems are fixed in flyspell.el,
5323 but we still avoid setting the property in Emacs 22 and later.
5324 We use a macro so that the test can happen at compilation time."
5325 (if (< emacs-major-version 22)
5326 `(append '(intangible t) ,props)
5327 props))
5329 (defun org-activate-bracket-links (limit)
5330 "Run through the buffer and add overlays to bracketed links."
5331 (if (re-search-forward org-bracket-link-regexp limit t)
5332 (let* ((help (concat "LINK: "
5333 (org-match-string-no-properties 1)))
5334 ;; FIXME: above we should remove the escapes.
5335 ;; but that requires another match, protecting match data,
5336 ;; a lot of overhead for font-lock.
5337 (ip (org-maybe-intangible
5338 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5339 'keymap org-mouse-map 'mouse-face 'highlight
5340 'font-lock-multiline t 'help-echo help)))
5341 (vp (list 'rear-nonsticky org-nonsticky-props
5342 'keymap org-mouse-map 'mouse-face 'highlight
5343 ' font-lock-multiline t 'help-echo help)))
5344 ;; We need to remove the invisible property here. Table narrowing
5345 ;; may have made some of this invisible.
5346 (remove-text-properties (match-beginning 0) (match-end 0)
5347 '(invisible nil))
5348 (if (match-end 3)
5349 (progn
5350 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5351 (add-text-properties (match-beginning 3) (match-end 3) vp)
5352 (add-text-properties (match-end 3) (match-end 0) ip))
5353 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5354 (add-text-properties (match-beginning 1) (match-end 1) vp)
5355 (add-text-properties (match-end 1) (match-end 0) ip))
5356 t)))
5358 (defun org-activate-dates (limit)
5359 "Run through the buffer and add overlays to dates."
5360 (if (re-search-forward org-tsr-regexp-both limit t)
5361 (progn
5362 (add-text-properties (match-beginning 0) (match-end 0)
5363 (list 'mouse-face 'highlight
5364 'rear-nonsticky org-nonsticky-props
5365 'keymap org-mouse-map))
5366 (when org-display-custom-times
5367 (if (match-end 3)
5368 (org-display-custom-time (match-beginning 3) (match-end 3)))
5369 (org-display-custom-time (match-beginning 1) (match-end 1)))
5370 t)))
5372 (defvar org-target-link-regexp nil
5373 "Regular expression matching radio targets in plain text.")
5375 "Regular expression matching a link target.")
5377 "Regular expression matching a radio target.")
5378 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5379 "Regular expression matching any target.")
5381 (defun org-activate-target-links (limit)
5382 "Run through the buffer and add overlays to target matches."
5383 (when org-target-link-regexp
5384 (let ((case-fold-search t))
5385 (if (re-search-forward org-target-link-regexp limit t)
5386 (progn
5387 (add-text-properties (match-beginning 0) (match-end 0)
5388 (list 'mouse-face 'highlight
5389 'rear-nonsticky org-nonsticky-props
5390 'keymap org-mouse-map
5391 'help-echo "Radio target link"
5392 'org-linked-text t))
5393 t)))))
5395 (defun org-update-radio-target-regexp ()
5396 "Find all radio targets in this file and update the regular expression."
5397 (interactive)
5398 (when (memq 'radio org-activate-links)
5399 (setq org-target-link-regexp
5400 (org-make-target-link-regexp (org-all-targets 'radio)))
5401 (org-restart-font-lock)))
5403 (defun org-hide-wide-columns (limit)
5404 (let (s e)
5405 (setq s (text-property-any (point) (or limit (point-max))
5406 'org-cwidth t))
5407 (when s
5408 (setq e (next-single-property-change s 'org-cwidth))
5409 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5410 (goto-char e)
5411 t)))
5413 (defvar org-latex-and-specials-regexp nil
5414 "Regular expression for highlighting export special stuff.")
5415 (defvar org-match-substring-regexp)
5416 (defvar org-match-substring-with-braces-regexp)
5417 (defvar org-export-html-special-string-regexps)
5419 (defun org-compute-latex-and-specials-regexp ()
5420 "Compute regular expression for stuff treated specially by exporters."
5421 (if (not org-highlight-latex-fragments-and-specials)
5422 (org-set-local 'org-latex-and-specials-regexp nil)
5423 (let*
5424 ((matchers (plist-get org-format-latex-options :matchers))
5425 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5426 org-latex-regexps)))
5427 (options (org-combine-plists (org-default-export-plist)
5428 (org-infile-export-plist)))
5429 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5430 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5431 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5432 (org-export-html-expand (plist-get options :expand-quoted-html))
5433 (org-export-with-special-strings (plist-get options :special-strings))
5434 (re-sub
5435 (cond
5436 ((equal org-export-with-sub-superscripts '{})
5437 (list org-match-substring-with-braces-regexp))
5438 (org-export-with-sub-superscripts
5439 (list org-match-substring-regexp))
5440 (t nil)))
5441 (re-latex
5442 (if org-export-with-LaTeX-fragments
5443 (mapcar (lambda (x) (nth 1 x)) latexs)))
5444 (re-macros
5445 (if org-export-with-TeX-macros
5447 (regexp-opt
5448 (append (mapcar 'car org-html-entities)
5449 (if (boundp 'org-latex-entities)
5450 org-latex-entities nil))
5451 'words))) ; FIXME
5452 ))
5454 (re-special (if org-export-with-special-strings
5455 (mapcar (lambda (x) (car x))
5456 org-export-html-special-string-regexps)))
5457 (re-rest
5458 (delq nil
5459 (list
5461 ))))
5462 (org-set-local
5463 'org-latex-and-specials-regexp
5464 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5467 (defface org-latex-and-export-specials
5468 (let ((font (cond ((assq :inherit custom-face-attributes)
5469 '(:inherit underline))
5470 (t '(:underline t)))))
5471 `((((class grayscale) (background light))
5472 (:foreground "DimGray" ,@font))
5473 (((class grayscale) (background dark))
5474 (:foreground "LightGray" ,@font))
5475 (((class color) (background light))
5476 (:foreground "SaddleBrown"))
5477 (((class color) (background dark))
5478 (:foreground "burlywood"))
5479 (t (,@font))))
5480 "Face used to highlight math latex and other special exporter stuff."
5481 :group 'org-faces)
5483 (defun org-do-latex-and-special-faces (limit)
5484 "Run through the buffer and add overlays to links."
5485 (when org-latex-and-specials-regexp
5486 (let (rtn d)
5487 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5488 limit t))
5489 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5490 'face))
5491 '(org-code org-verbatim underline)))
5492 (progn
5493 (setq rtn t
5494 d (cond ((member (char-after (1+ (match-beginning 0)))
5495 '(?_ ?^)) 1)
5496 (t 0)))
5497 (font-lock-prepend-text-property
5498 (+ d (match-beginning 0)) (match-end 0)
5499 'face 'org-latex-and-export-specials)
5500 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5501 '(font-lock-multiline t)))))
5502 rtn)))
5504 (defun org-restart-font-lock ()
5505 "Restart font-lock-mode, to force refontification."
5506 (when (and (boundp 'font-lock-mode) font-lock-mode)
5507 (font-lock-mode -1)
5508 (font-lock-mode 1)))
5510 (defun org-all-targets (&optional radio)
5511 "Return a list of all targets in this file.
5512 With optional argument RADIO, only find radio targets."
5513 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5514 rtn)
5515 (save-excursion
5516 (goto-char (point-min))
5517 (while (re-search-forward re nil t)
5518 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5519 rtn)))
5521 (defun org-make-target-link-regexp (targets)
5522 "Make regular expression matching all strings in TARGETS.
5523 The regular expression finds the targets also if there is a line break
5524 between words."
5525 (and targets
5526 (concat
5528 (mapconcat
5529 (lambda (x)
5530 (while (string-match " +" x)
5532 x)
5533 targets
5537 (defun org-activate-tags (limit)
5539 (progn
5540 (add-text-properties (match-beginning 1) (match-end 1)
5541 (list 'mouse-face 'highlight
5542 'rear-nonsticky org-nonsticky-props
5543 'keymap org-mouse-map))
5544 t)))
5546 (defun org-outline-level ()
5547 (save-excursion
5548 (looking-at outline-regexp)
5549 (if (match-beginning 1)
5550 (+ (org-get-string-indentation (match-string 1)) 1000)
5551 (1- (- (match-end 0) (match-beginning 0))))))
5553 (defvar org-font-lock-keywords nil)
5556 "Regular expression matching a property line.")
5558 (defun org-set-font-lock-defaults ()
5559 (let* ((em org-fontify-emphasized-text)
5560 (lk org-activate-links)
5561 (org-font-lock-extra-keywords
5562 (list
5563 ;; Headlines
5565 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5566 ;; Table lines
5568 (1 'org-table t))
5569 ;; Table internals
5573 ;; Drawers
5574 (list org-drawer-regexp '(0 'org-special-keyword t))
5576 ;; Properties
5577 (list org-property-re
5578 '(1 'org-special-keyword t)
5579 '(3 'org-property-value t))
5580 (if org-format-transports-properties-p
5582 ;; Links
5583 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5584 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5585 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5586 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5587 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5588 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5590 '(org-hide-wide-columns (0 nil append))
5591 ;; TODO lines
5593 '(1 (org-get-todo-face 1) t))
5594 ;; DONE
5595 (if org-fontify-done-headline
5599 '(2 'org-headline-done t))
5600 nil)
5601 ;; Priorities
5603 ;; Special keywords
5608 ;; Emphasis
5609 (if em
5610 (if (featurep 'xemacs)
5611 '(org-do-emphasis-faces (0 nil append))
5612 '(org-do-emphasis-faces)))
5613 ;; Checkboxes
5615 2 'bold prepend)
5616 (if org-provide-checkbox-statistics
5618 (0 (org-get-checkbox-statistics-face) t)))
5620 '(1 'org-archived prepend))
5621 ;; Specials
5622 '(org-do-latex-and-special-faces)
5623 ;; Code
5624 '(org-activate-code (1 'org-code t))
5625 ;; COMMENT
5628 '(1 'org-special-keyword t))
5629 '("^#.*" (0 'font-lock-comment-face t))
5630 )))
5631 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5632 ;; Now set the full font-lock-keywords
5633 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5634 (org-set-local 'font-lock-defaults
5635 '(org-font-lock-keywords t nil nil backward-paragraph))
5636 (kill-local-variable 'font-lock-keywords) nil))
5638 (defvar org-m nil)
5639 (defvar org-l nil)
5640 (defvar org-f nil)
5641 (defun org-get-level-face (n)
5642 "Get the right face for match N in font-lock matching of healdines."
5643 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5644 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5645 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5646 (cond
5647 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5648 ((eq n 2) org-f)
5649 (t (if org-level-color-stars-only nil org-f))))
5651 (defun org-get-todo-face (kwd)
5652 "Get the right face for a TODO keyword KWD.
5653 If KWD is a number, get the corresponding match group."
5654 (if (numberp kwd) (setq kwd (match-string kwd)))
5655 (or (cdr (assoc kwd org-todo-keyword-faces))
5656 (and (member kwd org-done-keywords) 'org-done)
5657 'org-todo))
5659 (defun org-unfontify-region (beg end &optional maybe_loudly)
5660 "Remove fontification and activation overlays from links."
5661 (font-lock-default-unfontify-region beg end)
5662 (let* ((buffer-undo-list t)
5663 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5664 (inhibit-modification-hooks t)
5665 deactivate-mark buffer-file-name buffer-file-truename)
5666 (remove-text-properties beg end
5667 '(mouse-face t keymap t org-linked-text t
5668 invisible t intangible t))))
5670 ;;;; Visibility cycling, including org-goto and indirect buffer
5672 ;;; Cycling
5674 (defvar org-cycle-global-status nil)
5675 (make-variable-buffer-local 'org-cycle-global-status)
5676 (defvar org-cycle-subtree-status nil)
5677 (make-variable-buffer-local 'org-cycle-subtree-status)
5679 ;;;###autoload
5680 (defun org-cycle (&optional arg)
5681 "Visibility cycling for Org-mode.
5683 - When this function is called with a prefix argument, rotate the entire
5684 buffer through 3 states (global cycling)
5685 1. OVERVIEW: Show only top-level headlines.
5686 2. CONTENTS: Show all headlines of all levels, but no body text.
5687 3. SHOW ALL: Show everything.
5689 - When point is at the beginning of a headline, rotate the subtree started
5690 by this line through 3 different states (local cycling)
5691 1. FOLDED: Only the main headline is shown.
5692 2. CHILDREN: The main headline and the direct children are shown.
5693 From this state, you can move to one of the children
5694 and zoom in further.
5695 3. SUBTREE: Show the entire subtree, including body text.
5697 - When there is a numeric prefix, go up to a heading with level ARG, do
5698 a `show-subtree' and return to the previous cursor position. If ARG
5699 is negative, go up that many levels.
5701 - When point is not at the beginning of a headline, execute
5702 `indent-relative', like TAB normally does. See the option
5703 `org-cycle-emulate-tab' for details.
5705 - Special case: if point is at the beginning of the buffer and there is
5706 no headline in line 1, this function will act as if called with prefix arg.
5707 But only if also the variable `org-cycle-global-at-bob' is t."
5708 (interactive "P")
5709 (let* ((outline-regexp
5710 (if (and (org-mode-p) org-cycle-include-plain-lists)
5712 outline-regexp))
5713 (bob-special (and org-cycle-global-at-bob (bobp)
5714 (not (looking-at outline-regexp))))
5715 (org-cycle-hook
5716 (if bob-special
5717 (delq 'org-optimize-window-after-visibility-change
5718 (copy-sequence org-cycle-hook))
5719 org-cycle-hook))
5720 (pos (point)))
5722 (if (or bob-special (equal arg '(4)))
5723 ;; special case: use global cycling
5724 (setq arg t))
5726 (cond
5728 ((org-at-table-p 'any)
5729 ;; Enter the table or move to the next field in the table
5730 (or (org-table-recognize-table.el)
5731 (progn
5732 (if arg (org-table-edit-field t)
5733 (org-table-justify-field-maybe)
5734 (call-interactively 'org-table-next-field)))))
5736 ((eq arg t) ;; Global cycling
5738 (cond
5739 ((and (eq last-command this-command)
5740 (eq org-cycle-global-status 'overview))
5741 ;; We just created the overview - now do table of contents
5742 ;; This can be slow in very large buffers, so indicate action
5743 (message "CONTENTS...")
5744 (org-content)
5745 (message "CONTENTS...done")
5746 (setq org-cycle-global-status 'contents)
5747 (run-hook-with-args 'org-cycle-hook 'contents))
5749 ((and (eq last-command this-command)
5750 (eq org-cycle-global-status 'contents))
5751 ;; We just showed the table of contents - now show everything
5752 (show-all)
5753 (message "SHOW ALL")
5754 (setq org-cycle-global-status 'all)
5755 (run-hook-with-args 'org-cycle-hook 'all))
5757 (t
5758 ;; Default action: go to overview
5759 (org-overview)
5760 (message "OVERVIEW")
5761 (setq org-cycle-global-status 'overview)
5762 (run-hook-with-args 'org-cycle-hook 'overview))))
5764 ((and org-drawers org-drawer-regexp
5765 (save-excursion
5766 (beginning-of-line 1)
5767 (looking-at org-drawer-regexp)))
5768 ;; Toggle block visibility
5769 (org-flag-drawer
5770 (not (get-char-property (match-end 0) 'invisible))))
5772 ((integerp arg)
5773 ;; Show-subtree, ARG levels up from here.
5774 (save-excursion
5775 (org-back-to-heading)
5776 (outline-up-heading (if (< arg 0) (- arg)
5777 (- (funcall outline-level) arg)))
5778 (org-show-subtree)))
5780 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5781 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5782 ;; At a heading: rotate between three different views
5783 (org-back-to-heading)
5784 (let ((goal-column 0) eoh eol eos)
5785 ;; First, some boundaries
5786 (save-excursion
5787 (org-back-to-heading)
5788 (save-excursion
5789 (beginning-of-line 2)
5790 (while (and (not (eobp)) ;; this is like `next-line'
5791 (get-char-property (1- (point)) 'invisible))
5792 (beginning-of-line 2)) (setq eol (point)))
5793 (outline-end-of-heading) (setq eoh (point))
5794 (org-end-of-subtree t)
5795 (unless (eobp)
5797 (beginning-of-line 1) ; in case this is an item
5798 )
5799 (setq eos (1- (point))))
5800 ;; Find out what to do next and set `this-command'
5801 (cond
5802 ((= eos eoh)
5803 ;; Nothing is hidden behind this heading
5804 (message "EMPTY ENTRY")
5805 (setq org-cycle-subtree-status nil)
5806 (save-excursion
5807 (goto-char eos)
5808 (outline-next-heading)
5809 (if (org-invisible-p) (org-flag-heading nil))))
5810 ((or (>= eol eos)
5812 ;; Entire subtree is hidden in one line: open it
5813 (org-show-entry)
5814 (show-children)
5815 (message "CHILDREN")
5816 (save-excursion
5817 (goto-char eos)
5818 (outline-next-heading)
5819 (if (org-invisible-p) (org-flag-heading nil)))
5820 (setq org-cycle-subtree-status 'children)
5821 (run-hook-with-args 'org-cycle-hook 'children))
5822 ((and (eq last-command this-command)
5823 (eq org-cycle-subtree-status 'children))
5824 ;; We just showed the children, now show everything.
5825 (org-show-subtree)
5826 (message "SUBTREE")
5827 (setq org-cycle-subtree-status 'subtree)
5828 (run-hook-with-args 'org-cycle-hook 'subtree))
5829 (t
5830 ;; Default action: hide the subtree.
5831 (hide-subtree)
5832 (message "FOLDED")
5833 (setq org-cycle-subtree-status 'folded)
5834 (run-hook-with-args 'org-cycle-hook 'folded)))))
5836 ;; TAB emulation
5837 (buffer-read-only (org-back-to-heading))
5839 ((org-try-cdlatex-tab))
5841 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5842 (or (not (bolp))
5843 (not (looking-at outline-regexp))))
5846 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5848 (or (and (eq org-cycle-emulate-tab 'white)
5849 (= (match-end 0) (point-at-eol)))
5850 (and (eq org-cycle-emulate-tab 'whitestart)
5851 (>= (match-end 0) pos))))
5852 t
5853 (eq org-cycle-emulate-tab t))
5856 ; (point-at-bol) (point))))
5857 ; (progn
5858 ; (beginning-of-line 1)
5862 (t (save-excursion
5863 (org-back-to-heading)
5864 (org-cycle))))))
5866 ;;;###autoload
5867 (defun org-global-cycle (&optional arg)
5868 "Cycle the global visibility. For details see `org-cycle'."
5869 (interactive "P")
5870 (let ((org-cycle-include-plain-lists
5871 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5872 (if (integerp arg)
5873 (progn
5874 (show-all)
5875 (hide-sublevels arg)
5876 (setq org-cycle-global-status 'contents))
5877 (org-cycle '(4)))))
5879 (defun org-overview ()
5880 "Switch to overview mode, shoing only top-level headlines.
5881 Really, this shows all headlines with level equal or greater than the level
5882 of the first headline in the buffer. This is important, because if the
5883 first headline is not level one, then (hide-sublevels 1) gives confusing
5884 results."
5885 (interactive)
5886 (let ((level (save-excursion
5887 (goto-char (point-min))
5888 (if (re-search-forward (concat "^" outline-regexp) nil t)
5889 (progn
5890 (goto-char (match-beginning 0))
5891 (funcall outline-level))))))
5892 (and level (hide-sublevels level))))
5894 (defun org-content (&optional arg)
5895 "Show all headlines in the buffer, like a table of contents.
5896 With numerical argument N, show content up to level N."
5897 (interactive "P")
5898 (save-excursion
5899 ;; Visit all headings and show their offspring
5900 (and (integerp arg) (org-overview))
5901 (goto-char (point-max))
5902 (catch 'exit
5903 (while (and (progn (condition-case nil
5904 (outline-previous-visible-heading 1)
5905 (error (goto-char (point-min))))
5906 t)
5907 (looking-at outline-regexp))
5908 (if (integerp arg)
5909 (show-children (1- arg))
5910 (show-branches))
5911 (if (bobp) (throw 'exit nil))))))
5914 (defun org-optimize-window-after-visibility-change (state)
5915 "Adjust the window after a change in outline visibility.
5916 This function is the default value of the hook `org-cycle-hook'."
5917 (when (get-buffer-window (current-buffer))
5918 (cond
5919 ; ((eq state 'overview) (org-first-headline-recenter 1))
5920 ; ((eq state 'overview) (org-beginning-of-line))
5921 ((eq state 'content) nil)
5922 ((eq state 'all) nil)
5923 ((eq state 'folded) nil)
5924 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5925 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5927 (defun org-compact-display-after-subtree-move ()
5928 (let (beg end)
5929 (save-excursion
5930 (if (org-up-heading-safe)
5931 (progn
5932 (hide-subtree)
5933 (show-entry)
5934 (show-children)
5935 (org-cycle-show-empty-lines 'children)
5936 (org-cycle-hide-drawers 'children))
5937 (org-overview)))))
5939 (defun org-cycle-show-empty-lines (state)
5940 "Show empty lines above all visible headlines.
5941 The region to be covered depends on STATE when called through
5942 `org-cycle-hook'. Lisp program can use t for STATE to get the
5943 entire buffer covered. Note that an empty line is only shown if there
5944 are at least `org-cycle-separator-lines' empty lines before the headeline."
5945 (when (> org-cycle-separator-lines 0)
5946 (save-excursion
5947 (let* ((n org-cycle-separator-lines)
5948 (re (cond
5951 (t (let ((ns (number-to-string (- n 2))))
5954 beg end)
5955 (cond
5956 ((memq state '(overview contents t))
5957 (setq beg (point-min) end (point-max)))
5958 ((memq state '(children folded))
5959 (setq beg (point) end (progn (org-end-of-subtree t t)
5960 (beginning-of-line 2)
5961 (point)))))
5962 (when beg
5963 (goto-char beg)
5964 (while (re-search-forward re end t)
5965 (if (not (get-char-property (match-end 1) 'invisible))
5966 (outline-flag-region
5967 (match-beginning 1) (match-end 1) nil)))))))
5968 ;; Never hide empty lines at the end of the file.
5969 (save-excursion
5970 (goto-char (point-max))
5971 (outline-previous-heading)
5972 (outline-end-of-heading)
5974 (= (match-end 0) (point-max)))
5975 (outline-flag-region (point) (match-end 0) nil))))
5977 (defun org-subtree-end-visible-p ()
5978 "Is the end of the current subtree visible?"
5979 (pos-visible-in-window-p
5980 (save-excursion (org-end-of-subtree t) (point))))
5982 (defun org-first-headline-recenter (&optional N)
5983 "Move cursor to the first headline and recenter the headline.
5984 Optional argument N means, put the headline into the Nth line of the window."
5985 (goto-char (point-min))
5987 (beginning-of-line)
5988 (recenter (prefix-numeric-value N))))
5990 ;;; Org-goto
5992 (defvar org-goto-window-configuration nil)
5993 (defvar org-goto-marker nil)
5994 (defvar org-goto-map
5995 (let ((map (make-sparse-keymap)))
5996 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5997 (while (setq cmd (pop cmds))
5998 (substitute-key-definition cmd cmd map global-map)))
5999 (suppress-keymap map)
6000 (org-defkey map "\C-m" 'org-goto-ret)
6001 (org-defkey map [(return)] 'org-goto-ret)
6002 (org-defkey map [(left)] 'org-goto-left)
6003 (org-defkey map [(right)] 'org-goto-right)
6004 (org-defkey map [(control ?g)] 'org-goto-quit)
6005 (org-defkey map "\C-i" 'org-cycle)
6006 (org-defkey map [(tab)] 'org-cycle)
6007 (org-defkey map [(down)] 'outline-next-visible-heading)
6008 (org-defkey map [(up)] 'outline-previous-visible-heading)
6009 (if org-goto-auto-isearch
6010 (if (fboundp 'define-key-after)
6011 (define-key-after map [t] 'org-goto-local-auto-isearch)
6012 nil)
6013 (org-defkey map "q" 'org-goto-quit)
6014 (org-defkey map "n" 'outline-next-visible-heading)
6015 (org-defkey map "p" 'outline-previous-visible-heading)
6016 (org-defkey map "f" 'outline-forward-same-level)
6017 (org-defkey map "b" 'outline-backward-same-level)
6018 (org-defkey map "u" 'outline-up-heading))
6019 (org-defkey map "/" 'org-occur)
6020 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6021 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6022 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6023 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6024 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6025 map))
6027 (defconst org-goto-help
6028 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6029 RET=jump to location [Q]uit and return to previous location
6030 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6032 (defvar org-goto-start-pos) ; dynamically scoped parameter
6034 (defun org-goto (&optional alternative-interface)
6035 "Look up a different location in the current file, keeping current visibility.
6037 When you want look-up or go to a different location in a document, the
6038 fastest way is often to fold the entire buffer and then dive into the tree.
6039 This method has the disadvantage, that the previous location will be folded,
6040 which may not be what you want.
6042 This command works around this by showing a copy of the current buffer
6043 in an indirect buffer, in overview mode. You can dive into the tree in
6044 that copy, use org-occur and incremental search to find a location.
6045 When pressing RET or `Q', the command returns to the original buffer in
6046 which the visibility is still unchanged. After RET is will also jump to
6047 the location selected in the indirect buffer and expose the
6048 the headline hierarchy above."
6049 (interactive "P")
6050 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
6051 (org-refile-use-outline-path t)
6052 (interface
6053 (if (not alternative-interface)
6054 org-goto-interface
6055 (if (eq org-goto-interface 'outline)
6056 'outline-path-completion
6057 'outline)))
6058 (org-goto-start-pos (point))
6059 (selected-point
6060 (if (eq interface 'outline)
6061 (car (org-get-location (current-buffer) org-goto-help))
6062 (nth 3 (org-refile-get-location "Goto: ")))))
6063 (if selected-point
6064 (progn
6065 (org-mark-ring-push org-goto-start-pos)
6066 (goto-char selected-point)
6067 (if (or (org-invisible-p) (org-invisible-p2))
6068 (org-show-context 'org-goto)))
6069 (message "Quit"))))
6071 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6072 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6073 (defvar org-goto-local-auto-isearch-map) ; defined below
6075 (defun org-get-location (buf help)
6076 "Let the user select a location in the Org-mode buffer BUF.
6077 This function uses a recursive edit. It returns the selected position
6078 or nil."
6079 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6080 (isearch-hide-immediately nil)
6081 (isearch-search-fun-function
6082 (lambda () 'org-goto-local-search-forward-headings))
6083 (org-goto-selected-point org-goto-exit-command))
6084 (save-excursion
6085 (save-window-excursion
6086 (delete-other-windows)
6087 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6088 (switch-to-buffer
6089 (condition-case nil
6090 (make-indirect-buffer (current-buffer) "*org-goto*")
6091 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6092 (with-output-to-temp-buffer "*Help*"
6093 (princ help))
6094 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6095 (setq buffer-read-only nil)
6096 (let ((org-startup-truncated t)
6097 (org-startup-folded nil)
6098 (org-startup-align-all-tables nil))
6099 (org-mode)
6100 (org-overview))
6101 (setq buffer-read-only t)
6102 (if (and (boundp 'org-goto-start-pos)
6103 (integer-or-marker-p org-goto-start-pos))
6104 (let ((org-show-hierarchy-above t)
6105 (org-show-siblings t)
6106 (org-show-following-heading t))
6107 (goto-char org-goto-start-pos)
6108 (and (org-invisible-p) (org-show-context)))
6109 (goto-char (point-min)))
6110 (org-beginning-of-line)
6111 (message "Select location and press RET")
6112 (use-local-map org-goto-map)
6113 (recursive-edit)
6114 ))
6115 (kill-buffer "*org-goto*")
6116 (cons org-goto-selected-point org-goto-exit-command)))
6118 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6119 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6120 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6121 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6123 (defun org-goto-local-search-forward-headings (string bound noerror)
6124 "Search and make sure that anu matches are in headlines."
6125 (catch 'return
6126 (while (search-forward string bound noerror)
6127 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6128 (and (member :headline context)
6129 (not (member :tags context))))
6130 (throw 'return (point))))))
6132 (defun org-goto-local-auto-isearch ()
6133 "Start isearch."
6134 (interactive)
6135 (goto-char (point-min))
6136 (let ((keys (this-command-keys)))
6137 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6138 (isearch-mode t)
6139 (isearch-process-search-char (string-to-char keys)))))
6141 (defun org-goto-ret (&optional arg)
6142 "Finish `org-goto' by going to the new location."
6143 (interactive "P")
6144 (setq org-goto-selected-point (point)
6145 org-goto-exit-command 'return)
6146 (throw 'exit nil))
6148 (defun org-goto-left ()
6149 "Finish `org-goto' by going to the new location."
6150 (interactive)
6151 (if (org-on-heading-p)
6152 (progn
6153 (beginning-of-line 1)
6154 (setq org-goto-selected-point (point)
6155 org-goto-exit-command 'left)
6156 (throw 'exit nil))
6157 (error "Not on a heading")))
6159 (defun org-goto-right ()
6160 "Finish `org-goto' by going to the new location."
6161 (interactive)
6162 (if (org-on-heading-p)
6163 (progn
6164 (setq org-goto-selected-point (point)
6165 org-goto-exit-command 'right)
6166 (throw 'exit nil))
6167 (error "Not on a heading")))
6169 (defun org-goto-quit ()
6170 "Finish `org-goto' without cursor motion."
6171 (interactive)
6172 (setq org-goto-selected-point nil)
6173 (setq org-goto-exit-command 'quit)
6174 (throw 'exit nil))
6176 ;;; Indirect buffer display of subtrees
6178 (defvar org-indirect-dedicated-frame nil
6179 "This is the frame being used for indirect tree display.")
6180 (defvar org-last-indirect-buffer nil)
6182 (defun org-tree-to-indirect-buffer (&optional arg)
6183 "Create indirect buffer and narrow it to current subtree.
6184 With numerical prefix ARG, go up to this level and then take that tree.
6185 If ARG is negative, go up that many levels.
6186 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6187 indirect buffer previously made with this command, to avoid proliferation of
6188 indirect buffers. However, when you call the command with a `C-u' prefix, or
6189 when `org-indirect-buffer-display' is `new-frame', the last buffer
6190 is kept so that you can work with several indirect buffers at the same time.
6191 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6192 requests that a new frame be made for the new buffer, so that the dedicated
6193 frame is not changed."
6194 (interactive "P")
6195 (let ((cbuf (current-buffer))
6196 (cwin (selected-window))
6197 (pos (point))
6198 beg end level heading ibuf)
6199 (save-excursion
6200 (org-back-to-heading t)
6201 (when (numberp arg)
6202 (setq level (org-outline-level))
6203 (if (< arg 0) (setq arg (+ level arg)))
6204 (while (> (setq level (org-outline-level)) arg)
6205 (outline-up-heading 1 t)))
6206 (setq beg (point)
6207 heading (org-get-heading))
6208 (org-end-of-subtree t) (setq end (point)))
6209 (if (and (buffer-live-p org-last-indirect-buffer)
6210 (not (eq org-indirect-buffer-display 'new-frame))
6211 (not arg))
6212 (kill-buffer org-last-indirect-buffer))
6213 (setq ibuf (org-get-indirect-buffer cbuf)
6214 org-last-indirect-buffer ibuf)
6215 (cond
6216 ((or (eq org-indirect-buffer-display 'new-frame)
6217 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6218 (select-frame (make-frame))
6219 (delete-other-windows)
6220 (switch-to-buffer ibuf)
6221 (org-set-frame-title heading))
6222 ((eq org-indirect-buffer-display 'dedicated-frame)
6223 (raise-frame
6224 (select-frame (or (and org-indirect-dedicated-frame
6225 (frame-live-p org-indirect-dedicated-frame)
6226 org-indirect-dedicated-frame)
6227 (setq org-indirect-dedicated-frame (make-frame)))))
6228 (delete-other-windows)
6229 (switch-to-buffer ibuf)
6230 (org-set-frame-title (concat "Indirect: " heading)))
6231 ((eq org-indirect-buffer-display 'current-window)
6232 (switch-to-buffer ibuf))
6233 ((eq org-indirect-buffer-display 'other-window)
6234 (pop-to-buffer ibuf))
6235 (t (error "Invalid value.")))
6236 (if (featurep 'xemacs)
6237 (save-excursion (org-mode) (turn-on-font-lock)))
6238 (narrow-to-region beg end)
6239 (show-all)
6240 (goto-char pos)
6241 (and (window-live-p cwin) (select-window cwin))))
6243 (defun org-get-indirect-buffer (&optional buffer)
6244 (setq buffer (or buffer (current-buffer)))
6245 (let ((n 1) (base (buffer-name buffer)) bname)
6246 (while (buffer-live-p
6247 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6248 (setq n (1+ n)))
6249 (condition-case nil
6250 (make-indirect-buffer buffer bname 'clone)
6251 (error (make-indirect-buffer buffer bname)))))
6253 (defun org-set-frame-title (title)
6254 "Set the title of the current frame to the string TITLE."
6255 ;; FIXME: how to name a single frame in XEmacs???
6256 (unless (featurep 'xemacs)
6257 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6259 ;;;; Structure editing
6261 ;;; Inserting headlines
6263 (defun org-insert-heading (&optional force-heading)
6264 "Insert a new heading or item with same depth at point.
6265 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6266 If point is at the beginning of a headline, insert a sibling before the
6267 current headline. If point is not at the beginning, do not split the line,
6268 but create the new hedline after the current line."
6269 (interactive "P")
6270 (if (= (buffer-size) 0)
6272 (when (or force-heading (not (org-insert-item)))
6273 (let* ((head (save-excursion
6274 (condition-case nil
6275 (progn
6276 (org-back-to-heading)
6277 (match-string 0))
6278 (error "*"))))
6279 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6280 pos)
6281 (cond
6282 ((and (org-on-heading-p) (bolp)
6283 (or (bobp)
6284 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6285 ;; insert before the current line
6286 (open-line (if blank 2 1)))
6287 ((and (bolp)
6288 (or (bobp)
6289 (save-excursion
6290 (backward-char 1) (not (org-invisible-p)))))
6291 ;; insert right here
6292 nil)
6293 (t
6294 ; ;; in the middle of the line
6295 ; (org-show-entry)
6296 ; (if (org-get-alist-option org-M-RET-may-split-line 'headline)
6297 ; (if (and
6298 ; (org-on-heading-p)
6300 ; ;; protect the tags
6301 ;; (let ((tags (match-string 2)) pos)
6302 ; (delete-region (match-beginning 1) (match-end 1))
6303 ; (setq pos (point-at-bol))
6304 ; (newline (if blank 2 1))
6305 ; (save-excursion
6306 ; (goto-char pos)
6307 ; (end-of-line 1)
6308 ; (insert " " tags)
6309 ; (org-set-tags nil 'align)))
6310 ; (newline (if blank 2 1)))
6311 ; (newline (if blank 2 1))))
6314 ;; in the middle of the line
6315 (org-show-entry)
6316 (let ((split
6317 (org-get-alist-option org-M-RET-may-split-line 'headline))
6318 tags pos)
6319 (if (org-on-heading-p)
6320 (progn
6322 (setq tags (and (match-end 2) (match-string 2)))
6323 (and (match-end 1)
6324 (delete-region (match-beginning 1) (match-end 1)))
6325 (setq pos (point-at-bol))
6326 (or split (end-of-line 1))
6327 (delete-horizontal-space)
6328 (newline (if blank 2 1))
6329 (when tags
6330 (save-excursion
6331 (goto-char pos)
6332 (end-of-line 1)
6333 (insert " " tags)
6334 (org-set-tags nil 'align))))
6335 (or split (end-of-line 1))
6336 (newline (if blank 2 1))))))
6337 (insert head) (just-one-space)
6338 (setq pos (point))
6339 (end-of-line 1)
6340 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6341 (run-hooks 'org-insert-heading-hook)))))
6343 (defun org-insert-heading-after-current ()
6344 "Insert a new heading with same level as current, after current subtree."
6345 (interactive)
6346 (org-back-to-heading)
6347 (org-insert-heading)
6348 (org-move-subtree-down)
6349 (end-of-line 1))
6351 (defun org-insert-todo-heading (arg)
6352 "Insert a new heading with the same level and TODO state as current heading.
6353 If the heading has no TODO state, or if the state is DONE, use the first
6354 state (TODO by default). Also with prefix arg, force first state."
6355 (interactive "P")
6356 (when (not (org-insert-item 'checkbox))
6357 (org-insert-heading)
6358 (save-excursion
6359 (org-back-to-heading)
6360 (outline-previous-heading)
6361 (looking-at org-todo-line-regexp))
6362 (if (or arg
6363 (not (match-beginning 2))
6364 (member (match-string 2) org-done-keywords))
6365 (insert (car org-todo-keywords-1) " ")
6366 (insert (match-string 2) " "))))
6368 (defun org-insert-subheading (arg)
6369 "Insert a new subheading and demote it.
6370 Works for outline headings and for plain lists alike."
6371 (interactive "P")
6372 (org-insert-heading arg)
6373 (cond
6374 ((org-on-heading-p) (org-do-demote))
6375 ((org-at-item-p) (org-indent-item 1))))
6377 (defun org-insert-todo-subheading (arg)
6378 "Insert a new subheading with TODO keyword or checkbox and demote it.
6379 Works for outline headings and for plain lists alike."
6380 (interactive "P")
6381 (org-insert-todo-heading arg)
6382 (cond
6383 ((org-on-heading-p) (org-do-demote))
6384 ((org-at-item-p) (org-indent-item 1))))
6386 ;;; Promotion and Demotion
6388 (defun org-promote-subtree ()
6389 "Promote the entire subtree.
6390 See also `org-promote'."
6391 (interactive)
6392 (save-excursion
6393 (org-map-tree 'org-promote))
6394 (org-fix-position-after-promote))
6396 (defun org-demote-subtree ()
6397 "Demote the entire subtree. See `org-demote'.
6398 See also `org-promote'."
6399 (interactive)
6400 (save-excursion
6401 (org-map-tree 'org-demote))
6402 (org-fix-position-after-promote))
6405 (defun org-do-promote ()
6406 "Promote the current heading higher up the tree.
6407 If the region is active in `transient-mark-mode', promote all headings
6408 in the region."
6409 (interactive)
6410 (save-excursion
6411 (if (org-region-active-p)
6412 (org-map-region 'org-promote (region-beginning) (region-end))
6413 (org-promote)))
6414 (org-fix-position-after-promote))
6416 (defun org-do-demote ()
6417 "Demote the current heading lower down the tree.
6418 If the region is active in `transient-mark-mode', demote all headings
6419 in the region."
6420 (interactive)
6421 (save-excursion
6422 (if (org-region-active-p)
6423 (org-map-region 'org-demote (region-beginning) (region-end))
6424 (org-demote)))
6425 (org-fix-position-after-promote))
6427 (defun org-fix-position-after-promote ()
6428 "Make sure that after pro/demotion cursor position is right."
6429 (let ((pos (point)))
6430 (when (save-excursion
6431 (beginning-of-line 1)
6432 (looking-at org-todo-line-regexp)
6433 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6434 (cond ((eobp) (insert " "))
6435 ((eolp) (insert " "))
6436 ((equal (char-after) ?\ ) (forward-char 1))))))
6438 (defun org-reduced-level (l)
6439 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6441 (defun org-get-legal-level (level &optional change)
6442 "Rectify a level change under the influence of `org-odd-levels-only'
6443 LEVEL is a current level, CHANGE is by how much the level should be
6444 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6445 even level numbers will become the next higher odd number."
6446 (if org-odd-levels-only
6447 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6448 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6449 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6450 (max 1 (+ level change))))
6452 (defun org-promote ()
6453 "Promote the current heading higher up the tree.
6454 If the region is active in `transient-mark-mode', promote all headings
6455 in the region."
6456 (org-back-to-heading t)
6457 (let* ((level (save-match-data (funcall outline-level)))
6458 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6459 (diff (abs (- level (length up-head) -1))))
6460 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6461 (replace-match up-head nil t)
6462 ;; Fixup tag positioning
6463 (and org-auto-align-tags (org-set-tags nil t))
6464 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6466 (defun org-demote ()
6467 "Demote the current heading lower down the tree.
6468 If the region is active in `transient-mark-mode', demote all headings
6469 in the region."
6470 (org-back-to-heading t)
6471 (let* ((level (save-match-data (funcall outline-level)))
6472 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6473 (diff (abs (- level (length down-head) -1))))
6474 (replace-match down-head nil t)
6475 ;; Fixup tag positioning
6476 (and org-auto-align-tags (org-set-tags nil t))
6477 (if org-adapt-indentation (org-fixup-indentation diff))))
6479 (defun org-map-tree (fun)
6480 "Call FUN for every heading underneath the current one."
6481 (org-back-to-heading)
6482 (let ((level (funcall outline-level)))
6483 (save-excursion
6484 (funcall fun)
6485 (while (and (progn
6486 (outline-next-heading)
6487 (> (funcall outline-level) level))
6488 (not (eobp)))
6489 (funcall fun)))))
6491 (defun org-map-region (fun beg end)
6492 "Call FUN for every heading between BEG and END."
6493 (let ((org-ignore-region t))
6494 (save-excursion
6495 (setq end (copy-marker end))
6496 (goto-char beg)
6497 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6498 (< (point) end))
6499 (funcall fun))
6500 (while (and (progn
6501 (outline-next-heading)
6502 (< (point) end))
6503 (not (eobp)))
6504 (funcall fun)))))
6506 (defun org-fixup-indentation (diff)
6507 "Change the indentation in the current entry by DIFF
6508 However, if any line in the current entry has no indentation, or if it
6509 would end up with no indentation after the change, nothing at all is done."
6510 (save-excursion
6511 (let ((end (save-excursion (outline-next-heading)
6512 (point-marker)))
6513 (prohibit (if (> diff 0)
6516 col)
6517 (unless (save-excursion (end-of-line 1)
6518 (re-search-forward prohibit end t))
6519 (while (and (< (point) end)
6521 (goto-char (match-end 0))
6522 (setq col (current-column))
6523 (if (< diff 0) (replace-match ""))
6524 (indent-to (+ diff col))))
6525 (move-marker end nil))))
6527 (defun org-convert-to-odd-levels ()
6528 "Convert an org-mode file with all levels allowed to one with odd levels.
6529 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6530 level 5 etc."
6531 (interactive)
6532 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6533 (let ((org-odd-levels-only nil) n)
6534 (save-excursion
6535 (goto-char (point-min))
6537 (setq n (- (length (match-string 0)) 2))
6538 (while (>= (setq n (1- n)) 0)
6539 (org-demote))
6540 (end-of-line 1))))))
6543 (defun org-convert-to-oddeven-levels ()
6544 "Convert an org-mode file with only odd levels to one with odd and even levels.
6545 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6546 section with an even level, conversion would destroy the structure of the file. An error
6547 is signaled in this case."
6548 (interactive)
6549 (goto-char (point-min))
6550 ;; First check if there are no even levels
6552 (org-show-context t)
6553 (error "Not all levels are odd in this file. Conversion not possible."))
6554 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6555 (let ((org-odd-levels-only nil) n)
6556 (save-excursion
6557 (goto-char (point-min))
6559 (setq n (/ (1- (length (match-string 0))) 2))
6560 (while (>= (setq n (1- n)) 0)
6561 (org-promote))
6562 (end-of-line 1))))))
6564 (defun org-tr-level (n)
6565 "Make N odd if required."
6566 (if org-odd-levels-only (1+ (/ n 2)) n))
6568 ;;; Vertical tree motion, cutting and pasting of subtrees
6570 (defun org-move-subtree-up (&optional arg)
6571 "Move the current subtree up past ARG headlines of the same level."
6572 (interactive "p")
6573 (org-move-subtree-down (- (prefix-numeric-value arg))))
6575 (defun org-move-subtree-down (&optional arg)
6576 "Move the current subtree down past ARG headlines of the same level."
6577 (interactive "p")
6578 (setq arg (prefix-numeric-value arg))
6579 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6580 'outline-get-last-sibling))
6581 (ins-point (make-marker))
6582 (cnt (abs arg))
6583 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6584 ;; Select the tree
6585 (org-back-to-heading)
6586 (setq beg0 (point))
6587 (save-excursion
6588 (setq ne-beg (org-back-over-empty-lines))
6589 (setq beg (point)))
6590 (save-match-data
6591 (save-excursion (outline-end-of-heading)
6592 (setq folded (org-invisible-p)))
6593 (outline-end-of-subtree))
6594 (outline-next-heading)
6595 (setq ne-end (org-back-over-empty-lines))
6596 (setq end (point))
6597 (goto-char beg0)
6598 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6599 ;; include less whitespace
6600 (save-excursion
6601 (goto-char beg)
6602 (forward-line (- ne-beg ne-end))
6603 (setq beg (point))))
6604 ;; Find insertion point, with error handling
6605 (while (> cnt 0)
6606 (or (and (funcall movfunc) (looking-at outline-regexp))
6607 (progn (goto-char beg0)
6608 (error "Cannot move past superior level or buffer limit")))
6609 (setq cnt (1- cnt)))
6610 (if (> arg 0)
6611 ;; Moving forward - still need to move over subtree
6612 (progn (org-end-of-subtree t t)
6613 (save-excursion
6614 (org-back-over-empty-lines)
6615 (or (bolp) (newline)))))
6616 (setq ne-ins (org-back-over-empty-lines))
6617 (move-marker ins-point (point))
6618 (setq txt (buffer-substring beg end))
6619 (delete-region beg end)
6620 (outline-flag-region (1- beg) beg nil)
6621 (outline-flag-region (1- (point)) (point) nil)
6622 (insert txt)
6624 (setq ins-end (point))
6625 (goto-char ins-point)
6626 (org-skip-whitespace)
6627 (when (and (< arg 0)
6628 (org-first-sibling-p)
6629 (> ne-ins ne-beg))
6630 ;; Move whitespace back to beginning
6631 (save-excursion
6632 (goto-char ins-end)
6633 (let ((kill-whole-line t))
6634 (kill-line (- ne-ins ne-beg)) (point)))
6636 (move-marker ins-point nil)
6637 (org-compact-display-after-subtree-move)
6638 (unless folded
6639 (org-show-entry)
6640 (show-children)
6641 (org-cycle-hide-drawers 'children))))
6643 (defvar org-subtree-clip ""
6644 "Clipboard for cut and paste of subtrees.
6645 This is actually only a copy of the kill, because we use the normal kill
6646 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6648 (defvar org-subtree-clip-folded nil
6649 "Was the last copied subtree folded?
6650 This is used to fold the tree back after pasting.")
6652 (defun org-cut-subtree (&optional n)
6653 "Cut the current subtree into the clipboard.
6654 With prefix arg N, cut this many sequential subtrees.
6655 This is a short-hand for marking the subtree and then cutting it."
6656 (interactive "p")
6657 (org-copy-subtree n 'cut))
6659 (defun org-copy-subtree (&optional n cut)
6660 "Cut the current subtree into the clipboard.
6661 With prefix arg N, cut this many sequential subtrees.
6662 This is a short-hand for marking the subtree and then copying it.
6663 If CUT is non-nil, actually cut the subtree."
6664 (interactive "p")
6665 (let (beg end folded (beg0 (point)))
6666 (if (interactive-p)
6667 (org-back-to-heading nil) ; take what looks like a subtree
6668 (org-back-to-heading t)) ; take what is really there
6669 (org-back-over-empty-lines)
6670 (setq beg (point))
6672 (save-match-data
6673 (save-excursion (outline-end-of-heading)
6674 (setq folded (org-invisible-p)))
6675 (condition-case nil
6676 (outline-forward-same-level (1- n))
6677 (error nil))
6678 (org-end-of-subtree t t))
6679 (org-back-over-empty-lines)
6680 (setq end (point))
6681 (goto-char beg0)
6682 (when (> end beg)
6683 (setq org-subtree-clip-folded folded)
6684 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6685 (setq org-subtree-clip (current-kill 0))
6686 (message "%s: Subtree(s) with %d characters"
6687 (if cut "Cut" "Copied")
6688 (length org-subtree-clip)))))
6690 (defun org-paste-subtree (&optional level tree)
6691 "Paste the clipboard as a subtree, with modification of headline level.
6692 The entire subtree is promoted or demoted in order to match a new headline
6693 level. By default, the new level is derived from the visible headings
6694 before and after the insertion point, and taken to be the inferior headline
6695 level of the two. So if the previous visible heading is level 3 and the
6696 next is level 4 (or vice versa), level 4 will be used for insertion.
6697 This makes sure that the subtree remains an independent subtree and does
6698 not swallow low level entries.
6700 You can also force a different level, either by using a numeric prefix
6701 argument, or by inserting the heading marker by hand. For example, if the
6706 If optional TREE is given, use this text instead of the kill ring."
6707 (interactive "P")
6708 (unless (org-kill-is-subtree-p tree)
6709 (error "%s"
6710 (substitute-command-keys
6712 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6717 (old-level (if (string-match ^re txt)
6718 (- (match-end 0) (match-beginning 0) 1)
6719 -1))
6720 (force-level (cond (level (prefix-numeric-value level))
6721 ((string-match
6722 ^re_ (buffer-substring (point-at-bol) (point)))
6723 (- (match-end 1) (match-beginning 1)))
6724 (t nil)))
6725 (previous-level (save-excursion
6726 (condition-case nil
6727 (progn
6728 (outline-previous-visible-heading 1)
6729 (if (looking-at re)
6730 (- (match-end 0) (match-beginning 0) 1)
6731 1))
6732 (error 1))))
6733 (next-level (save-excursion
6734 (condition-case nil
6735 (progn
6736 (or (looking-at outline-regexp)
6737 (outline-next-visible-heading 1))
6738 (if (looking-at re)
6739 (- (match-end 0) (match-beginning 0) 1)
6740 1))
6741 (error 1))))
6742 (new-level (or force-level (max previous-level next-level)))
6743 (shift (if (or (= old-level -1)
6744 (= new-level -1)
6745 (= old-level new-level))
6746 0
6747 (- new-level old-level)))
6748 (delta (if (> shift 0) -1 1))
6749 (func (if (> shift 0) 'org-demote 'org-promote))
6750 (org-odd-levels-only nil)
6751 beg end)
6752 ;; Remove the forced level indicator
6753 (if force-level
6754 (delete-region (point-at-bol) (point)))
6755 ;; Paste
6756 (beginning-of-line 1)
6757 (org-back-over-empty-lines) ;; FIXME: correct fix????
6758 (setq beg (point))
6759 (insert-before-markers txt) ;; FIXME: correct fix????
6761 (setq end (point))
6762 (goto-char beg)
6764 (setq beg (point))
6765 ;; Shift if necessary
6766 (unless (= shift 0)
6767 (save-restriction
6768 (narrow-to-region beg end)
6769 (while (not (= shift 0))
6770 (org-map-region func (point-min) (point-max))
6771 (setq shift (+ delta shift)))
6772 (goto-char (point-min))))
6773 (when (interactive-p)
6774 (message "Clipboard pasted as level %d subtree" new-level))
6775 (if (and kill-ring
6776 (eq org-subtree-clip (current-kill 0))
6777 org-subtree-clip-folded)
6778 ;; The tree was folded before it was killed/copied
6779 (hide-subtree))))
6781 (defun org-kill-is-subtree-p (&optional txt)
6782 "Check if the current kill is an outline subtree, or a set of trees.
6783 Returns nil if kill does not start with a headline, or if the first
6784 headline level is not the largest headline level in the tree.
6785 So this will actually accept several entries of equal levels as well,
6786 which is OK for `org-paste-subtree'.
6787 If optional TXT is given, check this string instead of the current kill."
6788 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6789 (start-level (and kill
6792 kill)
6793 (- (match-end 2) (match-beginning 2) 1)))
6794 (re (concat "^" org-outline-regexp))
6795 (start (1+ (match-beginning 2))))
6796 (if (not start-level)
6797 (progn
6798 nil) ;; does not even start with a heading
6799 (catch 'exit
6800 (while (setq start (string-match re kill (1+ start)))
6801 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6802 (throw 'exit nil)))
6803 t))))
6805 (defun org-narrow-to-subtree ()
6806 "Narrow buffer to the current subtree."
6807 (interactive)
6808 (save-excursion
6809 (save-match-data
6810 (narrow-to-region
6811 (progn (org-back-to-heading) (point))
6812 (progn (org-end-of-subtree t t) (point))))))
6815 ;;; Outline Sorting
6817 (defun org-sort (with-case)
6818 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6819 Optional argument WITH-CASE means sort case-sensitively."
6820 (interactive "P")
6821 (if (org-at-table-p)
6822 (org-call-with-arg 'org-table-sort-lines with-case)
6823 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6825 (defvar org-priority-regexp) ; defined later in the file
6827 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6828 "Sort entries on a certain level of an outline tree.
6829 If there is an active region, the entries in the region are sorted.
6830 Else, if the cursor is before the first entry, sort the top-level items.
6831 Else, the children of the entry at point are sorted.
6833 Sorting can be alphabetically, numerically, and by date/time as given by
6834 the first time stamp in the entry. The command prompts for the sorting
6835 type unless it has been given to the function through the SORTING-TYPE
6836 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6837 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6838 called with point at the beginning of the record. It must return either
6839 a string or a number that should serve as the sorting key for that record.
6841 Comparing entries ignores case by default. However, with an optional argument
6842 WITH-CASE, the sorting considers case as well."
6843 (interactive "P")
6844 (let ((case-func (if with-case 'identity 'downcase))
6845 start beg end stars re re2
6846 txt what tmp plain-list-p)
6847 ;; Find beginning and end of region to sort
6848 (cond
6849 ((org-region-active-p)
6850 ;; we will sort the region
6851 (setq end (region-end)
6852 what "region")
6853 (goto-char (region-beginning))
6854 (if (not (org-on-heading-p)) (outline-next-heading))
6855 (setq start (point)))
6856 ((org-at-item-p)
6857 ;; we will sort this plain list
6858 (org-beginning-of-item-list) (setq start (point))
6859 (org-end-of-item-list) (setq end (point))
6860 (goto-char start)
6861 (setq plain-list-p t
6862 what "plain list"))
6863 ((or (org-on-heading-p)
6864 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6865 ;; we will sort the children of the current headline
6866 (org-back-to-heading)
6867 (setq start (point)
6868 end (progn (org-end-of-subtree t t)
6869 (org-back-over-empty-lines)
6870 (point))
6871 what "children")
6872 (goto-char start)
6873 (show-subtree)
6874 (outline-next-heading))
6875 (t
6876 ;; we will sort the top-level entries in this file
6877 (goto-char (point-min))
6878 (or (org-on-heading-p) (outline-next-heading))
6879 (setq start (point) end (point-max) what "top-level")
6880 (goto-char start)
6881 (show-all)))
6883 (setq beg (point))
6884 (if (>= beg end) (error "Nothing to sort"))
6886 (unless plain-list-p
6888 (setq stars (match-string 1)
6889 re (concat "^" (regexp-quote stars) " +")
6890 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6891 txt (buffer-substring beg end))
6893 (if (and (not (equal stars "*")) (string-match re2 txt))
6894 (error "Region to sort contains a level above the first entry")))
6896 (unless sorting-type
6897 (message
6898 (if plain-list-p
6899 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6900 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6901 what)
6902 (setq sorting-type (read-char-exclusive))
6904 (and (= (downcase sorting-type) ?f)
6905 (setq getkey-func
6906 (completing-read "Sort using function: "
6907 obarray 'fboundp t nil nil))
6908 (setq getkey-func (intern getkey-func)))
6910 (and (= (downcase sorting-type) ?r)
6911 (setq property
6912 (completing-read "Property: "
6913 (mapcar 'list (org-buffer-property-keys t))
6914 nil t))))
6916 (message "Sorting entries...")
6918 (save-restriction
6919 (narrow-to-region start end)
6921 (let ((dcst (downcase sorting-type))
6922 (now (current-time)))
6923 (sort-subr
6924 (/= dcst sorting-type)
6925 ;; This function moves to the beginning character of the "record" to
6926 ;; be sorted.
6927 (if plain-list-p
6928 (lambda nil
6929 (if (org-at-item-p) t (goto-char (point-max))))
6930 (lambda nil
6931 (if (re-search-forward re nil t)
6932 (goto-char (match-beginning 0))
6933 (goto-char (point-max)))))
6934 ;; This function moves to the last character of the "record" being
6935 ;; sorted.
6936 (if plain-list-p
6937 'org-end-of-item
6938 (lambda nil
6939 (save-match-data
6940 (condition-case nil
6941 (outline-forward-same-level 1)
6942 (error
6943 (goto-char (point-max)))))))
6945 ;; This function returns the value that gets sorted against.
6946 (if plain-list-p
6947 (lambda nil
6949 (cond
6950 ((= dcst ?n)
6951 (string-to-number (buffer-substring (match-end 0)
6952 (point-at-eol))))
6953 ((= dcst ?a)
6954 (buffer-substring (match-end 0) (point-at-eol)))
6955 ((= dcst ?t)
6956 (if (re-search-forward org-ts-regexp
6957 (point-at-eol) t)
6958 (org-time-string-to-time (match-string 0))
6959 now))
6960 ((= dcst ?f)
6961 (if getkey-func
6962 (progn
6963 (setq tmp (funcall getkey-func))
6964 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6965 tmp)
6966 (error "Invalid key function `%s'" getkey-func)))
6967 (t (error "Invalid sorting type `%c'" sorting-type)))))
6968 (lambda nil
6969 (cond
6970 ((= dcst ?n)
6971 (if (looking-at outline-regexp)
6972 (string-to-number (buffer-substring (match-end 0)
6973 (point-at-eol)))
6974 nil))
6975 ((= dcst ?a)
6976 (funcall case-func (buffer-substring (point-at-bol)
6977 (point-at-eol))))
6978 ((= dcst ?t)
6979 (if (re-search-forward org-ts-regexp
6980 (save-excursion
6981 (forward-line 2)
6982 (point)) t)
6983 (org-time-string-to-time (match-string 0))
6984 now))
6985 ((= dcst ?p)
6986 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6987 (string-to-char (match-string 2))
6988 org-default-priority))
6989 ((= dcst ?r)
6990 (or (org-entry-get nil property) ""))
6991 ((= dcst ?f)
6992 (if getkey-func
6993 (progn
6994 (setq tmp (funcall getkey-func))
6995 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6996 tmp)
6997 (error "Invalid key function `%s'" getkey-func)))
6998 (t (error "Invalid sorting type `%c'" sorting-type)))))
6999 nil
7000 (cond
7001 ((= dcst ?a) 'string<)
7002 ((= dcst ?t) 'time-less-p)
7003 (t nil)))))
7004 (message "Sorting entries...done")))
7006 (defun org-do-sort (table what &optional with-case sorting-type)
7007 "Sort TABLE of WHAT according to SORTING-TYPE.
7008 The user will be prompted for the SORTING-TYPE if the call to this
7009 function does not specify it. WHAT is only for the prompt, to indicate
7010 what is being sorted. The sorting key will be extracted from
7011 the car of the elements of the table.
7012 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7013 (unless sorting-type
7014 (message
7015 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7016 what)
7017 (setq sorting-type (read-char-exclusive)))
7018 (let ((dcst (downcase sorting-type))
7019 extractfun comparefun)
7020 ;; Define the appropriate functions
7021 (cond
7022 ((= dcst ?n)
7023 (setq extractfun 'string-to-number
7024 comparefun (if (= dcst sorting-type) '< '>)))
7025 ((= dcst ?a)
7026 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7027 (lambda(x) (downcase (org-sort-remove-invisible x))))
7028 comparefun (if (= dcst sorting-type)
7029 'string<
7030 (lambda (a b) (and (not (string< a b))
7031 (not (string= a b)))))))
7032 ((= dcst ?t)
7033 (setq extractfun
7034 (lambda (x)
7035 (if (string-match org-ts-regexp x)
7036 (time-to-seconds
7037 (org-time-string-to-time (match-string 0 x)))
7038 0))
7039 comparefun (if (= dcst sorting-type) '< '>)))
7040 (t (error "Invalid sorting type `%c'" sorting-type)))
7042 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7043 table)
7044 (lambda (a b) (funcall comparefun (car a) (car b))))))
7046 ;;;; Plain list items, including checkboxes
7048 ;;; Plain list items
7050 (defun org-at-item-p ()
7051 "Is point in a line starting a hand-formatted item?"
7052 (let ((llt org-plain-list-ordered-item-terminator))
7053 (save-excursion
7054 (goto-char (point-at-bol))
7055 (looking-at
7056 (cond
7060 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7062 (defun org-in-item-p ()
7063 "It the cursor inside a plain list item.
7064 Does not have to be the first line."
7065 (save-excursion
7066 (condition-case nil
7067 (progn
7068 (org-beginning-of-item)
7069 (org-at-item-p)
7070 t)
7071 (error nil))))
7073 (defun org-insert-item (&optional checkbox)
7074 "Insert a new item at the current level.
7075 Return t when things worked, nil when we are not in an item."
7076 (when (save-excursion
7077 (condition-case nil
7078 (progn
7079 (org-beginning-of-item)
7080 (org-at-item-p)
7081 (if (org-invisible-p) (error "Invisible item"))
7082 t)
7083 (error nil)))
7084 (let* ((bul (match-string 0))
7086 (match-end 0)))
7087 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7088 pos)
7089 (cond
7090 ((and (org-at-item-p) (<= (point) eow))
7091 ;; before the bullet
7092 (beginning-of-line 1)
7093 (open-line (if blank 2 1)))
7094 ((<= (point) eow)
7095 (beginning-of-line 1))
7096 (t
7097 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7098 (end-of-line 1)
7099 (delete-horizontal-space))
7100 (newline (if blank 2 1))))
7101 (insert bul (if checkbox "[ ]" ""))
7102 (just-one-space)
7103 (setq pos (point))
7104 (end-of-line 1)
7105 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7106 (org-maybe-renumber-ordered-list)
7107 (and checkbox (org-update-checkbox-count-maybe))
7108 t))
7110 ;;; Checkboxes
7112 (defun org-at-item-checkbox-p ()
7113 "Is point at a line starting a plain-list item with a checklet?"
7114 (and (org-at-item-p)
7115 (save-excursion
7116 (goto-char (match-end 0))
7120 (defun org-toggle-checkbox (&optional arg)
7121 "Toggle the checkbox in the current line."
7122 (interactive "P")
7123 (catch 'exit
7124 (let (beg end status (firstnew 'unknown))
7125 (cond
7126 ((org-region-active-p)
7127 (setq beg (region-beginning) end (region-end)))
7128 ((org-on-heading-p)
7129 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7130 ((org-at-item-checkbox-p)
7131 (let ((pos (point)))
7132 (replace-match
7133 (cond (arg "[-]")
7134 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7135 (t "[ ]"))
7136 t t)
7137 (goto-char pos))
7138 (throw 'exit t))
7139 (t (error "Not at a checkbox or heading, and no active region")))
7140 (save-excursion
7141 (goto-char beg)
7142 (while (< (point) end)
7143 (when (org-at-item-checkbox-p)
7144 (setq status (equal (match-string 0) "[X]"))
7145 (when (eq firstnew 'unknown)
7146 (setq firstnew (not status)))
7147 (replace-match
7148 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7149 (beginning-of-line 2)))))
7150 (org-update-checkbox-count-maybe))
7152 (defun org-update-checkbox-count-maybe ()
7153 "Update checkbox statistics unless turned off by user."
7154 (when org-provide-checkbox-statistics
7155 (org-update-checkbox-count)))
7157 (defun org-update-checkbox-count (&optional all)
7158 "Update the checkbox statistics in the current section.
7159 This will find all statistic cookies like [57%] and [6/12] and update them
7160 with the current numbers. With optional prefix argument ALL, do this for
7161 the whole buffer."
7162 (interactive "P")
7163 (save-excursion
7164 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7165 (beg (condition-case nil
7166 (progn (outline-back-to-heading) (point))
7167 (error (point-min))))
7168 (end (move-marker (make-marker)
7169 (progn (outline-next-heading) (point))))
7173 beg-cookie end-cookie is-percent c-on c-off lim
7174 eline curr-ind next-ind continue-from startsearch
7175 (cstat 0)
7176 )
7177 (when all
7178 (goto-char (point-min))
7179 (outline-next-heading)
7180 (setq beg (point) end (point-max)))
7181 (goto-char end)
7182 ;; find each statistic cookie
7183 (while (re-search-backward re-find beg t)
7184 (setq beg-cookie (match-beginning 1)
7185 end-cookie (match-end 1)
7186 cstat (+ cstat (if end-cookie 1 0))
7187 startsearch (point-at-eol)
7188 continue-from (point-at-bol)
7189 is-percent (match-beginning 2)
7190 lim (cond
7191 ((org-on-heading-p) (outline-next-heading) (point))
7192 ((org-at-item-p) (org-end-of-item) (point))
7193 (t nil))
7194 c-on 0
7195 c-off 0)
7196 (when lim
7197 ;; find first checkbox for this cookie and gather
7198 ;; statistics from all that are at this indentation level
7199 (goto-char startsearch)
7200 (if (re-search-forward re-box lim t)
7201 (progn
7202 (org-beginning-of-item)
7203 (setq curr-ind (org-get-indentation))
7204 (setq next-ind curr-ind)
7205 (while (= curr-ind next-ind)
7206 (save-excursion (end-of-line) (setq eline (point)))
7207 (if (re-search-forward re-box eline t)
7208 (if (member (match-string 2) '("[ ]" "[-]"))
7209 (setq c-off (1+ c-off))
7210 (setq c-on (1+ c-on))
7211 )
7212 )
7213 (org-end-of-item)
7214 (setq next-ind (org-get-indentation))
7215 )))
7216 (goto-char continue-from)
7217 ;; update cookie
7218 (when end-cookie
7219 (delete-region beg-cookie end-cookie)
7220 (goto-char beg-cookie)
7221 (insert
7222 (if is-percent
7223 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7224 (format "[%d/%d]" c-on (+ c-on c-off)))))
7225 ;; update items checkbox if it has one
7226 (when (org-at-item-p)
7227 (org-beginning-of-item)
7228 (when (and (> (+ c-on c-off) 0)
7229 (re-search-forward re-box (point-at-eol) t))
7230 (setq beg-cookie (match-beginning 2)
7231 end-cookie (match-end 2))
7232 (delete-region beg-cookie end-cookie)
7233 (goto-char beg-cookie)
7234 (cond ((= c-off 0) (insert "[X]"))
7235 ((= c-on 0) (insert "[ ]"))
7236 (t (insert "[-]")))
7237 )))
7238 (goto-char continue-from))
7239 (when (interactive-p)
7240 (message "Checkbox satistics updated %s (%d places)"
7241 (if all "in entire file" "in current outline entry") cstat)))))
7243 (defun org-get-checkbox-statistics-face ()
7244 "Select the face for checkbox statistics.
7245 The face will be `org-done' when all relevant boxes are checked. Otherwise
7246 it will be `org-todo'."
7247 (if (match-end 1)
7248 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7249 (if (and (> (match-end 2) (match-beginning 2))
7250 (equal (match-string 2) (match-string 3)))
7251 'org-done
7252 'org-todo)))
7254 (defun org-get-indentation (&optional line)
7255 "Get the indentation of the current line, interpreting tabs.
7256 When LINE is given, assume it represents a line and compute its indentation."
7257 (if line
7258 (if (string-match "^ *" (org-remove-tabs line))
7259 (match-end 0))
7260 (save-excursion
7261 (beginning-of-line 1)
7263 (current-column))))
7265 (defun org-remove-tabs (s &optional width)
7266 "Replace tabulators in S with spaces.
7267 Assumes that s is a single line, starting in column 0."
7268 (setq width (or width tab-width))
7270 (setq s (replace-match
7271 (make-string
7272 (- (* width (/ (+ (match-beginning 0) width) width))
7273 (match-beginning 0)) ?\ )
7274 t t s)))
7275 s)
7277 (defun org-fix-indentation (line ind)
7278 "Fix indentation in LINE.
7279 IND is a cons cell with target and minimum indentation.
7280 If the current indenation in LINE is smaller than the minimum,
7281 leave it alone. If it is larger than ind, set it to the target."
7282 (let* ((l (org-remove-tabs line))
7283 (i (org-get-indentation l))
7284 (i1 (car ind)) (i2 (cdr ind)))
7285 (if (>= i i2) (setq l (substring line i2)))
7286 (if (> i1 0)
7287 (concat (make-string i1 ?\ ) l)
7288 l)))
7290 (defcustom org-empty-line-terminates-plain-lists nil
7291 "Non-nil means, an empty line ends all plain list levels.
7292 When nil, empty lines are part of the preceeding item."
7293 :group 'org-plain-lists
7294 :type 'boolean)
7296 (defun org-beginning-of-item ()
7297 "Go to the beginning of the current hand-formatted item.
7298 If the cursor is not in an item, throw an error."
7299 (interactive)
7300 (let ((pos (point))
7301 (limit (save-excursion
7302 (condition-case nil
7303 (progn
7304 (org-back-to-heading)
7305 (beginning-of-line 2) (point))
7306 (error (point-min)))))
7307 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7308 ind ind1)
7309 (if (org-at-item-p)
7310 (beginning-of-line 1)
7311 (beginning-of-line 1)
7313 (setq ind (current-column))
7314 (if (catch 'exit
7315 (while t
7316 (beginning-of-line 0)
7317 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7320 (setq ind1 ind-empty)
7322 (setq ind1 (current-column)))
7323 (if (< ind1 ind)
7324 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7325 nil
7326 (goto-char pos)
7327 (error "Not in an item")))))
7329 (defun org-end-of-item ()
7330 "Go to the end of the current hand-formatted item.
7331 If the cursor is not in an item, throw an error."
7332 (interactive)
7333 (let* ((pos (point))
7334 ind1
7335 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7336 (limit (save-excursion (outline-next-heading) (point)))
7337 (ind (save-excursion
7338 (org-beginning-of-item)
7340 (current-column)))
7341 (end (catch 'exit
7342 (while t
7343 (beginning-of-line 2)
7344 (if (eobp) (throw 'exit (point)))
7345 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7347 (setq ind1 ind-empty)
7349 (setq ind1 (current-column)))
7350 (if (<= ind1 ind)
7351 (throw 'exit (point-at-bol)))))))
7352 (if end
7353 (goto-char end)
7354 (goto-char pos)
7355 (error "Not in an item"))))
7357 (defun org-next-item ()
7358 "Move to the beginning of the next item in the current plain list.
7359 Error if not at a plain list, or if this is the last item in the list."
7360 (interactive)
7361 (let (ind ind1 (pos (point)))
7362 (org-beginning-of-item)
7363 (setq ind (org-get-indentation))
7364 (org-end-of-item)
7365 (setq ind1 (org-get-indentation))
7366 (unless (and (org-at-item-p) (= ind ind1))
7367 (goto-char pos)
7368 (error "On last item"))))
7370 (defun org-previous-item ()
7371 "Move to the beginning of the previous item in the current plain list.
7372 Error if not at a plain list, or if this is the first item in the list."
7373 (interactive)
7374 (let (beg ind ind1 (pos (point)))
7375 (org-beginning-of-item)
7376 (setq beg (point))
7377 (setq ind (org-get-indentation))
7378 (goto-char beg)
7379 (catch 'exit
7380 (while t
7381 (beginning-of-line 0)
7383 nil
7384 (if (<= (setq ind1 (org-get-indentation)) ind)
7385 (throw 'exit t)))))
7386 (condition-case nil
7387 (if (or (not (org-at-item-p))
7388 (< ind1 (1- ind)))
7389 (error "")
7390 (org-beginning-of-item))
7391 (error (goto-char pos)
7392 (error "On first item")))))
7394 (defun org-first-list-item-p ()
7395 "Is this heading the item in a plain list?"
7396 (unless (org-at-item-p)
7397 (error "Not at a plain list item"))
7398 (org-beginning-of-item)
7399 (= (point) (save-excursion (org-beginning-of-item-list))))
7401 (defun org-move-item-down ()
7402 "Move the plain list item at point down, i.e. swap with following item.
7403 Subitems (items with larger indentation) are considered part of the item,
7404 so this really moves item trees."
7405 (interactive)
7406 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7407 (org-beginning-of-item)
7408 (setq beg0 (point))
7409 (save-excursion
7410 (setq ne-beg (org-back-over-empty-lines))
7411 (setq beg (point)))
7412 (goto-char beg0)
7413 (setq ind (org-get-indentation))
7414 (org-end-of-item)
7415 (setq end0 (point))
7416 (setq ind1 (org-get-indentation))
7417 (setq ne-end (org-back-over-empty-lines))
7418 (setq end (point))
7419 (goto-char beg0)
7420 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7421 ;; include less whitespace
7422 (save-excursion
7423 (goto-char beg)
7424 (forward-line (- ne-beg ne-end))
7425 (setq beg (point))))
7426 (goto-char end0)
7427 (if (and (org-at-item-p) (= ind ind1))
7428 (progn
7429 (org-end-of-item)
7430 (org-back-over-empty-lines)
7431 (setq txt (buffer-substring beg end))
7432 (save-excursion
7433 (delete-region beg end))
7434 (setq pos (point))
7435 (insert txt)
7436 (goto-char pos) (org-skip-whitespace)
7437 (org-maybe-renumber-ordered-list))
7438 (goto-char pos)
7439 (error "Cannot move this item further down"))))
7441 (defun org-move-item-up (arg)
7442 "Move the plain list item at point up, i.e. swap with previous item.
7443 Subitems (items with larger indentation) are considered part of the item,
7444 so this really moves item trees."
7445 (interactive "p")
7446 (let (beg beg0 end ind ind1 (pos (point)) txt
7447 ne-beg ne-ins ins-end)
7448 (org-beginning-of-item)
7449 (setq beg0 (point))
7450 (setq ind (org-get-indentation))
7451 (save-excursion
7452 (setq ne-beg (org-back-over-empty-lines))
7453 (setq beg (point)))
7454 (goto-char beg0)
7455 (org-end-of-item)
7456 (setq end (point))
7457 (goto-char beg0)
7458 (catch 'exit
7459 (while t
7460 (beginning-of-line 0)
7462 (if org-empty-line-terminates-plain-lists
7463 (progn
7464 (goto-char pos)
7465 (error "Cannot move this item further up"))
7466 nil)
7467 (if (<= (setq ind1 (org-get-indentation)) ind)
7468 (throw 'exit t)))))
7469 (condition-case nil
7470 (org-beginning-of-item)
7471 (error (goto-char beg)
7472 (error "Cannot move this item further up")))
7473 (setq ind1 (org-get-indentation))
7474 (if (and (org-at-item-p) (= ind ind1))
7475 (progn
7476 (setq ne-ins (org-back-over-empty-lines))
7477 (setq txt (buffer-substring beg end))
7478 (save-excursion
7479 (delete-region beg end))
7480 (setq pos (point))
7481 (insert txt)
7482 (setq ins-end (point))
7483 (goto-char pos) (org-skip-whitespace)
7485 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7486 ;; Move whitespace back to beginning
7487 (save-excursion
7488 (goto-char ins-end)
7489 (let ((kill-whole-line t))
7490 (kill-line (- ne-ins ne-beg)) (point)))
7493 (org-maybe-renumber-ordered-list))
7494 (goto-char pos)
7495 (error "Cannot move this item further up"))))
7497 (defun org-maybe-renumber-ordered-list ()
7498 "Renumber the ordered list at point if setup allows it.
7499 This tests the user option `org-auto-renumber-ordered-lists' before
7500 doing the renumbering."
7501 (interactive)
7502 (when (and org-auto-renumber-ordered-lists
7503 (org-at-item-p))
7504 (if (match-beginning 3)
7505 (org-renumber-ordered-list 1)
7506 (org-fix-bullet-type))))
7508 (defun org-maybe-renumber-ordered-list-safe ()
7509 (condition-case nil
7510 (save-excursion
7511 (org-maybe-renumber-ordered-list))
7512 (error nil)))
7514 (defun org-cycle-list-bullet (&optional which)
7515 "Cycle through the different itemize/enumerate bullets.
7516 This cycle the entire list level through the sequence:
7518 `-' -> `+' -> `*' -> `1.' -> `1)'
7520 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7521 0 meand `-', 1 means `+' etc."
7522 (interactive "P")
7523 (org-preserve-lc
7524 (org-beginning-of-item-list)
7525 (org-at-item-p)
7526 (beginning-of-line 1)
7527 (let ((current (match-string 0))
7528 (prevp (eq which 'previous))
7529 new)
7530 (setq new (cond
7531 ((and (numberp which)
7532 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7533 ((string-match "-" current) (if prevp "1)" "+"))
7538 ((string-match ")" current) (if prevp "1." "-"))
7539 (t (error "This should not happen"))))
7541 (org-fix-bullet-type)
7542 (org-maybe-renumber-ordered-list))))
7544 (defun org-get-string-indentation (s)
7545 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7546 (let ((n -1) (i 0) (w tab-width) c)
7547 (catch 'exit
7548 (while (< (setq n (1+ n)) (length s))
7549 (setq c (aref s n))
7550 (cond ((= c ?\ ) (setq i (1+ i)))
7552 (t (throw 'exit t)))))
7553 i))
7555 (defun org-renumber-ordered-list (arg)
7556 "Renumber an ordered plain list.
7557 Cursor needs to be in the first line of an item, the line that starts
7559 (interactive "p")
7560 (unless (and (org-at-item-p)
7561 (match-beginning 3))
7562 (error "This is not an ordered list"))
7563 (let ((line (org-current-line))
7564 (col (current-column))
7565 (ind (org-get-string-indentation
7566 (buffer-substring (point-at-bol) (match-beginning 3))))
7567 ;; (term (substring (match-string 3) -1))
7568 ind1 (n (1- arg))
7569 fmt)
7570 ;; find where this list begins
7571 (org-beginning-of-item-list)
7573 (setq fmt (concat "%d" (match-string 1)))
7574 (beginning-of-line 0)
7575 ;; walk forward and replace these numbers
7576 (catch 'exit
7577 (while t
7578 (catch 'next
7579 (beginning-of-line 2)
7580 (if (eobp) (throw 'exit nil))
7583 (if (> ind1 ind) (throw 'next t))
7584 (if (< ind1 ind) (throw 'exit t))
7585 (if (not (org-at-item-p)) (throw 'exit nil))
7586 (delete-region (match-beginning 2) (match-end 2))
7587 (goto-char (match-beginning 2))
7588 (insert (format fmt (setq n (1+ n)))))))
7589 (goto-line line)
7590 (move-to-column col)))
7592 (defun org-fix-bullet-type ()
7593 "Make sure all items in this list have the same bullet as the firsst item."
7594 (interactive)
7595 (unless (org-at-item-p) (error "This is not a list"))
7596 (let ((line (org-current-line))
7597 (col (current-column))
7598 (ind (current-indentation))
7599 ind1 bullet)
7600 ;; find where this list begins
7601 (org-beginning-of-item-list)
7602 (beginning-of-line 1)
7603 ;; find out what the bullet type is
7605 (setq bullet (match-string 1))
7606 ;; walk forward and replace these numbers
7607 (beginning-of-line 0)
7608 (catch 'exit
7609 (while t
7610 (catch 'next
7611 (beginning-of-line 2)
7612 (if (eobp) (throw 'exit nil))
7615 (if (> ind1 ind) (throw 'next t))
7616 (if (< ind1 ind) (throw 'exit t))
7617 (if (not (org-at-item-p)) (throw 'exit nil))
7620 (replace-match bullet))))
7621 (goto-line line)
7622 (move-to-column col)
7623 (if (string-match "[0-9]" bullet)
7624 (org-renumber-ordered-list 1))))
7626 (defun org-beginning-of-item-list ()
7627 "Go to the beginning of the current item list.
7628 I.e. to the first item in this list."
7629 (interactive)
7630 (org-beginning-of-item)
7631 (let ((pos (point-at-bol))
7632 (ind (org-get-indentation))
7633 ind1)
7634 ;; find where this list begins
7635 (catch 'exit
7636 (while t
7637 (catch 'next
7638 (beginning-of-line 0)
7640 (throw (if (bobp) 'exit 'next) t))
7642 (if (or (< ind1 ind)
7643 (and (= ind1 ind)
7644 (not (org-at-item-p)))
7645 (bobp))
7646 (throw 'exit t)
7647 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7648 (goto-char pos)))
7651 (defun org-end-of-item-list ()
7652 "Go to the end of the current item list.
7653 I.e. to the text after the last item."
7654 (interactive)
7655 (org-beginning-of-item)
7656 (let ((pos (point-at-bol))
7657 (ind (org-get-indentation))
7658 ind1)
7659 ;; find where this list begins
7660 (catch 'exit
7661 (while t
7662 (catch 'next
7663 (beginning-of-line 2)
7665 (throw (if (eobp) 'exit 'next) t))
7667 (if (or (< ind1 ind)
7668 (and (= ind1 ind)
7669 (not (org-at-item-p)))
7670 (eobp))
7671 (progn
7672 (setq pos (point-at-bol))
7673 (throw 'exit t))))))
7674 (goto-char pos)))
7677 (defvar org-last-indent-begin-marker (make-marker))
7678 (defvar org-last-indent-end-marker (make-marker))
7680 (defun org-outdent-item (arg)
7681 "Outdent a local list item."
7682 (interactive "p")
7683 (org-indent-item (- arg)))
7685 (defun org-indent-item (arg)
7686 "Indent a local list item."
7687 (interactive "p")
7688 (unless (org-at-item-p)
7689 (error "Not on an item"))
7690 (save-excursion
7691 (let (beg end ind ind1 tmp delta ind-down ind-up)
7692 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7693 (setq beg org-last-indent-begin-marker
7694 end org-last-indent-end-marker)
7695 (org-beginning-of-item)
7696 (setq beg (move-marker org-last-indent-begin-marker (point)))
7697 (org-end-of-item)
7698 (setq end (move-marker org-last-indent-end-marker (point))))
7699 (goto-char beg)
7700 (setq tmp (org-item-indent-positions)
7701 ind (car tmp)
7702 ind-down (nth 2 tmp)
7703 ind-up (nth 1 tmp)
7704 delta (if (> arg 0)
7705 (if ind-down (- ind-down ind) 2)
7706 (if ind-up (- ind-up ind) -2)))
7707 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7708 (while (< (point) end)
7709 (beginning-of-line 1)
7711 (delete-region (point-at-bol) (point))
7712 (or (eolp) (indent-to-column (+ ind1 delta)))
7713 (beginning-of-line 2))))
7714 (org-fix-bullet-type)
7715 (org-maybe-renumber-ordered-list-safe)
7716 (save-excursion
7717 (beginning-of-line 0)
7718 (condition-case nil (org-beginning-of-item) (error nil))
7719 (org-maybe-renumber-ordered-list-safe)))
7721 (defun org-item-indent-positions ()
7722 "Return indentation for plain list items.
7723 This returns a list with three values: The current indentation, the
7724 parent indentation and the indentation a child should habe.
7725 Assumes cursor in item line."
7726 (let* ((bolpos (point-at-bol))
7727 (ind (org-get-indentation))
7728 ind-down ind-up pos)
7729 (save-excursion
7730 (org-beginning-of-item-list)
7732 (when (org-in-item-p)
7733 (org-beginning-of-item)
7734 (setq ind-up (org-get-indentation))))
7735 (setq pos (point))
7736 (save-excursion
7737 (cond
7738 ((and (condition-case nil (progn (org-previous-item) t)
7739 (error nil))
7740 (or (forward-char 1) t)
7741 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7742 (setq ind-down (org-get-indentation)))
7743 ((and (goto-char pos)
7744 (org-at-item-p))
7745 (goto-char (match-end 0))
7747 (setq ind-down (current-column)))))
7748 (list ind ind-up ind-down)))
7750 ;;; The orgstruct minor mode
7752 ;; Define a minor mode which can be used in other modes in order to
7753 ;; integrate the org-mode structure editing commands.
7755 ;; This is really a hack, because the org-mode structure commands use
7756 ;; keys which normally belong to the major mode. Here is how it
7757 ;; works: The minor mode defines all the keys necessary to operate the
7758 ;; structure commands, but wraps the commands into a function which
7759 ;; tests if the cursor is currently at a headline or a plain list
7760 ;; item. If that is the case, the structure command is used,
7761 ;; temporarily setting many Org-mode variables like regular
7762 ;; expressions for filling etc. However, when any of those keys is
7763 ;; used at a different location, function uses `key-binding' to look
7764 ;; up if the key has an associated command in another currently active
7765 ;; keymap (minor modes, major mode, global), and executes that
7766 ;; command. There might be problems if any of the keys is otherwise
7767 ;; used as a prefix key.
7769 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7770 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7771 ;; addresses this by checking explicitly for both bindings.
7773 (defvar orgstruct-mode-map (make-sparse-keymap)
7774 "Keymap for the minor `orgstruct-mode'.")
7776 (defvar org-local-vars nil
7777 "List of local variables, for use by `orgstruct-mode'")
7779 ;;;###autoload
7780 (define-minor-mode orgstruct-mode
7781 "Toggle the minor more `orgstruct-mode'.
7782 This mode is for using Org-mode structure commands in other modes.
7783 The following key behave as if Org-mode was active, if the cursor
7784 is on a headline, or on a plain list item (both in the definition
7785 of Org-mode).
7787 M-up Move entry/item up
7788 M-down Move entry/item down
7789 M-left Promote
7790 M-right Demote
7791 M-S-up Move entry/item up
7792 M-S-down Move entry/item down
7793 M-S-left Promote subtree
7794 M-S-right Demote subtree
7795 M-q Fill paragraph and items like in Org-mode
7796 C-c ^ Sort entries
7797 C-c - Cycle list bullet
7798 TAB Cycle item visibility
7799 M-RET Insert new heading/item
7800 S-M-RET Insert new TODO heading / Chekbox item
7801 C-c C-c Set tags / toggle checkbox"
7802 nil " OrgStruct" nil
7803 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7805 ;;;###autoload
7806 (defun turn-on-orgstruct ()
7807 "Unconditionally turn on `orgstruct-mode'."
7808 (orgstruct-mode 1))
7810 ;;;###autoload
7811 (defun turn-on-orgstruct++ ()
7812 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7813 In addition to setting orgstruct-mode, this also exports all indentation and
7814 autofilling variables from org-mode into the buffer. Note that turning
7815 off orgstruct-mode will *not* remove these additional settings."
7816 (orgstruct-mode 1)
7817 (let (var val)
7818 (mapc
7819 (lambda (x)
7820 (when (string-match
7822 (symbol-name (car x)))
7823 (setq var (car x) val (nth 1 x))
7824 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7825 org-local-vars)))
7827 (defun orgstruct-error ()
7828 "Error when there is no default binding for a structure key."
7829 (interactive)
7830 (error "This key has no function outside structure elements"))
7832 (defun orgstruct-setup ()
7833 "Setup orgstruct keymaps."
7834 (let ((nfunc 0)
7835 (bindings
7836 (list
7837 '([(meta up)] org-metaup)
7838 '([(meta down)] org-metadown)
7839 '([(meta left)] org-metaleft)
7840 '([(meta right)] org-metaright)
7841 '([(meta shift up)] org-shiftmetaup)
7842 '([(meta shift down)] org-shiftmetadown)
7843 '([(meta shift left)] org-shiftmetaleft)
7844 '([(meta shift right)] org-shiftmetaright)
7845 '([(shift up)] org-shiftup)
7846 '([(shift down)] org-shiftdown)
7847 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7848 '("\M-q" fill-paragraph)
7849 '("\C-c^" org-sort)
7850 '("\C-c-" org-cycle-list-bullet)))
7851 elt key fun cmd)
7852 (while (setq elt (pop bindings))
7853 (setq nfunc (1+ nfunc))
7854 (setq key (org-key (car elt))
7855 fun (nth 1 elt)
7856 cmd (orgstruct-make-binding fun nfunc key))
7857 (org-defkey orgstruct-mode-map key cmd))
7859 ;; Special treatment needed for TAB and RET
7860 (org-defkey orgstruct-mode-map [(tab)]
7861 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7862 (org-defkey orgstruct-mode-map "\C-i"
7863 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7865 (org-defkey orgstruct-mode-map "\M-\C-m"
7866 (orgstruct-make-binding 'org-insert-heading 105
7867 "\M-\C-m" [(meta return)]))
7868 (org-defkey orgstruct-mode-map [(meta return)]
7869 (orgstruct-make-binding 'org-insert-heading 106
7870 [(meta return)] "\M-\C-m"))
7872 (org-defkey orgstruct-mode-map [(shift meta return)]
7873 (orgstruct-make-binding 'org-insert-todo-heading 107
7874 [(meta return)] "\M-\C-m"))
7876 (unless org-local-vars
7877 (setq org-local-vars (org-get-local-variables)))
7879 t))
7881 (defun orgstruct-make-binding (fun n &rest keys)
7882 "Create a function for binding in the structure minor mode.
7883 FUN is the command to call inside a table. N is used to create a unique
7884 command name. KEYS are keys that should be checked in for a command
7885 to execute outside of tables."
7886 (eval
7887 (list 'defun
7888 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7889 '(arg)
7891 "Outside of structure, run the binding of `"
7892 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7893 "'.")
7894 '(interactive "p")
7895 (list 'if
7896 '(org-context-p 'headline 'item)
7897 (list 'org-run-like-in-org-mode (list 'quote fun))
7898 (list 'let '(orgstruct-mode)
7899 (list 'call-interactively
7900 (append '(or)
7901 (mapcar (lambda (k)
7902 (list 'key-binding k))
7903 keys)
7904 '('orgstruct-error))))))))
7906 (defun org-context-p (&rest contexts)
7907 "Check if local context is and of CONTEXTS.
7908 Possible values in the list of contexts are `table', `headline', and `item'."
7909 (let ((pos (point)))
7910 (goto-char (point-at-bol))
7911 (prog1 (or (and (memq 'table contexts)
7913 (and (memq 'headline contexts)
7915 (and (memq 'item contexts)
7917 (goto-char pos))))
7919 (defun org-get-local-variables ()
7920 "Return a list of all local variables in an org-mode buffer."
7921 (let (varlist)
7922 (with-current-buffer (get-buffer-create "*Org tmp*")
7923 (erase-buffer)
7924 (org-mode)
7925 (setq varlist (buffer-local-variables)))
7926 (kill-buffer "*Org tmp*")
7927 (delq nil
7928 (mapcar
7929 (lambda (x)
7930 (setq x
7931 (if (symbolp x)
7932 (list x)
7933 (list (car x) (list 'quote (cdr x)))))
7934 (if (string-match
7935 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7936 (symbol-name (car x)))
7937 x nil))
7938 varlist))))
7940 ;;;###autoload
7941 (defun org-run-like-in-org-mode (cmd)
7942 (unless org-local-vars
7943 (setq org-local-vars (org-get-local-variables)))
7944 (eval (list 'let org-local-vars
7945 (list 'call-interactively (list 'quote cmd)))))
7947 ;;;; Archiving
7949 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7951 (defun org-archive-subtree (&optional find-done)
7952 "Move the current subtree to the archive.
7953 The archive can be a certain top-level heading in the current file, or in
7954 a different file. The tree will be moved to that location, the subtree
7955 heading be marked DONE, and the current time will be added.
7957 When called with prefix argument FIND-DONE, find whole trees without any
7958 open TODO items and archive them (after getting confirmation from the user).
7959 If the cursor is not at a headline when this comand is called, try all level
7960 1 trees. If the cursor is on a headline, only try the direct children of
7961 this heading."
7962 (interactive "P")
7963 (if find-done
7964 (org-archive-all-done)
7965 ;; Save all relevant TODO keyword-relatex variables
7967 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7968 (tr-org-todo-keywords-1 org-todo-keywords-1)
7969 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7970 (tr-org-done-keywords org-done-keywords)
7971 (tr-org-todo-regexp org-todo-regexp)
7972 (tr-org-todo-line-regexp org-todo-line-regexp)
7973 (tr-org-odd-levels-only org-odd-levels-only)
7974 (this-buffer (current-buffer))
7975 (org-archive-location org-archive-location)
7977 ;; start of variables that will be used for saving context
7978 ;; The compiler complains about them - keep them anyway!
7979 (file (abbreviate-file-name (buffer-file-name)))
7980 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7981 (time (format-time-string
7982 (substring (cdr org-time-stamp-formats) 1 -1)
7983 (current-time)))
7984 afile heading buffer level newfile-p
7985 category todo priority
7986 ;; start of variables that will be used for savind context
7987 ltags itags prop)
7989 ;; Try to find a local archive location
7990 (save-excursion
7991 (save-restriction
7992 (widen)
7993 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7995 (setq org-archive-location prop)
7996 (if (or (re-search-backward re nil t)
7997 (re-search-forward re nil t))
7998 (setq org-archive-location (match-string 1))))))
8001 (progn
8002 (setq afile (format (match-string 1 org-archive-location)
8003 (file-name-nondirectory buffer-file-name))
8004 heading (match-string 2 org-archive-location)))
8005 (error "Invalid `org-archive-location'"))
8006 (if (> (length afile) 0)
8007 (setq newfile-p (not (file-exists-p afile))
8008 buffer (find-file-noselect afile))
8009 (setq buffer (current-buffer)))
8010 (unless buffer
8012 (if (and (> (length heading) 0)
8014 (setq level (match-end 0))
8015 (setq heading nil level 0))
8016 (save-excursion
8017 (org-back-to-heading t)
8018 ;; Get context information that will be lost by moving the tree
8019 (org-refresh-category-properties)
8020 (setq category (org-get-category)
8021 todo (and (looking-at org-todo-line-regexp)
8022 (match-string 2))
8023 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
8024 ltags (org-get-tags)
8025 itags (org-delete-all ltags (org-get-tags-at)))
8026 (setq ltags (mapconcat 'identity ltags " ")
8027 itags (mapconcat 'identity itags " "))
8028 ;; We first only copy, in case something goes wrong
8029 ;; we need to protect this-command, to avoid kill-region sets it,
8030 ;; which would lead to duplication of subtrees
8031 (let (this-command) (org-copy-subtree))
8032 (set-buffer buffer)
8033 ;; Enforce org-mode for the archive buffer
8034 (if (not (org-mode-p))
8035 ;; Force the mode for future visits.
8036 (let ((org-insert-mode-line-in-empty-file t)
8037 (org-inhibit-startup t))
8038 (call-interactively 'org-mode)))
8039 (when newfile-p
8040 (goto-char (point-max))
8042 (buffer-file-name this-buffer))))
8043 ;; Force the TODO keywords of the original buffer
8044 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
8045 (org-todo-keywords-1 tr-org-todo-keywords-1)
8046 (org-todo-kwd-alist tr-org-todo-kwd-alist)
8047 (org-done-keywords tr-org-done-keywords)
8048 (org-todo-regexp tr-org-todo-regexp)
8049 (org-todo-line-regexp tr-org-todo-line-regexp)
8050 (org-odd-levels-only
8051 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8052 org-odd-levels-only
8053 tr-org-odd-levels-only)))
8054 (goto-char (point-min))
8055 (show-all)
8056 (if heading
8057 (progn
8058 (if (re-search-forward
8059 (concat "^" (regexp-quote heading)
8061 nil t)
8062 (goto-char (match-end 0))
8063 ;; Heading not found, just insert it at the end
8064 (goto-char (point-max))
8067 (end-of-line 0))
8068 ;; Make the subtree visible
8069 (show-subtree)
8070 (org-end-of-subtree t)
8074 ;; No specific heading, just go to end of file.
8076 ;; Paste
8077 (org-paste-subtree (org-get-legal-level level 1))
8079 ;; Mark the entry as done
8080 (when (and org-archive-mark-done
8081 (looking-at org-todo-line-regexp)
8082 (or (not (match-end 2))
8083 (not (member (match-string 2) org-done-keywords))))
8084 (let (org-log-done org-todo-log-states)
8085 (org-todo
8086 (car (or (member org-archive-mark-done org-done-keywords)
8087 org-done-keywords)))))
8089 ;; Add the context info
8090 (when org-archive-save-context-info
8091 (let ((l org-archive-save-context-info) e n v)
8092 (while (setq e (pop l))
8093 (when (and (setq v (symbol-value e))
8095 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8096 (org-entry-put (point) n v)))))
8098 ;; Save and kill the buffer, if it is not the same buffer.
8099 (if (not (eq this-buffer buffer))
8100 (progn (save-buffer) (kill-buffer buffer)))))
8101 ;; Here we are back in the original buffer. Everything seems to have
8102 ;; worked. So now cut the tree and finish up.
8103 (let (this-command) (org-cut-subtree))
8105 (message "Subtree archived %s"
8106 (if (eq this-buffer buffer)
8107 (concat "under heading: " heading)
8108 (concat "in file: " (abbreviate-file-name afile)))))))
8110 (defun org-refresh-category-properties ()
8111 "Refresh category text properties in teh buffer."
8112 (let ((def-cat (cond
8113 ((null org-category)
8114 (if buffer-file-name
8115 (file-name-sans-extension
8116 (file-name-nondirectory buffer-file-name))
8117 "???"))
8118 ((symbolp org-category) (symbol-name org-category))
8119 (t org-category)))
8120 beg end cat pos optionp)
8121 (org-unmodified
8122 (save-excursion
8123 (save-restriction
8124 (widen)
8125 (goto-char (point-min))
8126 (put-text-property (point) (point-max) 'org-category def-cat)
8127 (while (re-search-forward
8129 (setq pos (match-end 0)
8130 optionp (equal (char-after (match-beginning 0)) ?#)
8131 cat (org-trim (match-string 2)))
8132 (if optionp
8133 (setq beg (point-at-bol) end (point-max))
8134 (org-back-to-heading t)
8135 (setq beg (point) end (org-end-of-subtree t t)))
8136 (put-text-property beg end 'org-category cat)
8137 (goto-char pos)))))))
8139 (defun org-archive-all-done (&optional tag)
8140 "Archive sublevels of the current tree without open TODO items.
8141 If the cursor is not on a headline, try all level 1 trees. If
8142 it is on a headline, try all direct children.
8143 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8145 (rea (concat ".*:" org-archive-tag ":"))
8146 (begm (make-marker))
8147 (endm (make-marker))
8148 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8149 "Move subtree to archive (no open TODO items)? "))
8150 beg end (cntarch 0))
8151 (if (org-on-heading-p)
8152 (progn
8153 (setq re1 (concat "^" (regexp-quote
8154 (make-string
8155 (1+ (- (match-end 0) (match-beginning 0) 1))
8156 ?*))
8157 " "))
8158 (move-marker begm (point))
8159 (move-marker endm (org-end-of-subtree t)))
8160 (setq re1 "^* ")
8161 (move-marker begm (point-min))
8162 (move-marker endm (point-max)))
8163 (save-excursion
8164 (goto-char begm)
8165 (while (re-search-forward re1 endm t)
8166 (setq beg (match-beginning 0)
8167 end (save-excursion (org-end-of-subtree t) (point)))
8168 (goto-char beg)
8169 (if (re-search-forward re end t)
8170 (goto-char end)
8171 (goto-char beg)
8172 (if (and (or (not tag) (not (looking-at rea)))
8173 (y-or-n-p question))
8174 (progn
8175 (if tag
8176 (org-toggle-tag org-archive-tag 'on)
8177 (org-archive-subtree))
8178 (setq cntarch (1+ cntarch)))
8179 (goto-char end)))))
8180 (message "%d trees archived" cntarch)))
8182 (defun org-cycle-hide-drawers (state)
8183 "Re-hide all drawers after a visibility state change."
8184 (when (and (org-mode-p)
8185 (not (memq state '(overview folded))))
8186 (save-excursion
8187 (let* ((globalp (memq state '(contents all)))
8188 (beg (if globalp (point-min) (point)))
8189 (end (if globalp (point-max) (org-end-of-subtree t))))
8190 (goto-char beg)
8191 (while (re-search-forward org-drawer-regexp end t)
8192 (org-flag-drawer t))))))
8194 (defun org-flag-drawer (flag)
8195 (save-excursion
8196 (beginning-of-line 1)
8198 (let ((b (match-end 0))
8199 (outline-regexp org-outline-regexp))
8200 (if (re-search-forward
8202 (save-excursion (outline-next-heading) (point)) t)
8203 (outline-flag-region b (point-at-eol) flag)
8204 (error ":END: line missing"))))))
8206 (defun org-cycle-hide-archived-subtrees (state)
8207 "Re-hide all archived subtrees after a visibility state change."
8208 (when (and (not org-cycle-open-archived-trees)
8209 (not (memq state '(overview folded))))
8210 (save-excursion
8211 (let* ((globalp (memq state '(contents all)))
8212 (beg (if globalp (point-min) (point)))
8213 (end (if globalp (point-max) (org-end-of-subtree t))))
8214 (org-hide-archived-subtrees beg end)
8215 (goto-char beg)
8216 (if (looking-at (concat ".*:" org-archive-tag ":"))
8217 (message "%s" (substitute-command-keys
8218 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8220 (defun org-force-cycle-archived ()
8221 "Cycle subtree even if it is archived."
8222 (interactive)
8223 (setq this-command 'org-cycle)
8224 (let ((org-cycle-open-archived-trees t))
8225 (call-interactively 'org-cycle)))
8227 (defun org-hide-archived-subtrees (beg end)
8228 "Re-hide all archived subtrees after a visibility state change."
8229 (save-excursion
8230 (let* ((re (concat ":" org-archive-tag ":")))
8231 (goto-char beg)
8232 (while (re-search-forward re end t)
8233 (and (org-on-heading-p) (hide-subtree))
8234 (org-end-of-subtree t)))))
8236 (defun org-toggle-tag (tag &optional onoff)
8237 "Toggle the tag TAG for the current line.
8238 If ONOFF is `on' or `off', don't toggle but set to this state."
8239 (unless (org-on-heading-p t) (error "Not on headling"))
8240 (let (res current)
8241 (save-excursion
8242 (beginning-of-line)
8244 (point-at-eol) t)
8245 (progn
8246 (setq current (match-string 1))
8247 (replace-match ""))
8248 (setq current ""))
8249 (setq current (nreverse (org-split-string current ":")))
8250 (cond
8251 ((eq onoff 'on)
8252 (setq res t)
8253 (or (member tag current) (push tag current)))
8254 ((eq onoff 'off)
8255 (or (not (member tag current)) (setq current (delete tag current))))
8256 (t (if (member tag current)
8257 (setq current (delete tag current))
8258 (setq res t)
8259 (push tag current))))
8260 (end-of-line 1)
8261 (if current
8262 (progn
8263 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8264 (org-set-tags nil t))
8265 (delete-horizontal-space))
8266 (run-hooks 'org-after-tags-change-hook))
8267 res))
8269 (defun org-toggle-archive-tag (&optional arg)
8270 "Toggle the archive tag for the current headline.
8271 With prefix ARG, check all children of current headline and offer tagging
8272 the children that do not contain any open TODO items."
8273 (interactive "P")
8274 (if arg
8275 (org-archive-all-done 'tag)
8276 (let (set)
8277 (save-excursion
8278 (org-back-to-heading t)
8279 (setq set (org-toggle-tag org-archive-tag))
8280 (when set (hide-subtree)))
8281 (and set (beginning-of-line 1))
8282 (message "Subtree %s" (if set "archived" "unarchived")))))
8285 ;;;; Tables
8287 ;;; The table editor
8289 ;; Watch out: Here we are talking about two different kind of tables.
8290 ;; Most of the code is for the tables created with the Org-mode table editor.
8291 ;; Sometimes, we talk about tables created and edited with the table.el
8292 ;; Emacs package. We call the former org-type tables, and the latter
8293 ;; table.el-type tables.
8295 (defun org-before-change-function (beg end)
8296 "Every change indicates that a table might need an update."
8297 (setq org-table-may-need-update t))
8300 "Detects an org-type table line.")
8302 "Detects an org-type table line.")
8304 "Detects a table line marked for automatic recalculation.")
8306 "Detects a table line marked for automatic recalculation.")
8308 "Detects a table line marked for automatic recalculation.")
8310 "Detects an org-type table hline.")
8312 "Detects a table-type table hline.")
8314 "Detects an org-type or table-type table.")
8316 "Searching from within a table (any type) this finds the first line
8317 outside the table.")
8319 "Searching from within a table (any type) this finds the first line
8320 outside the table.")
8322 (defvar org-table-last-highlighted-reference nil)
8323 (defvar org-table-formula-history nil)
8325 (defvar org-table-column-names nil
8326 "Alist with column names, derived from the `!' line.")
8327 (defvar org-table-column-name-regexp nil
8328 "Regular expression matching the current column names.")
8329 (defvar org-table-local-parameters nil
8330 "Alist with parameter names, derived from the `$' line.")
8331 (defvar org-table-named-field-locations nil
8332 "Alist with locations of named fields.")
8334 (defvar org-table-current-line-types nil
8335 "Table row types, non-nil only for the duration of a comand.")
8336 (defvar org-table-current-begin-line nil
8337 "Table begin line, non-nil only for the duration of a comand.")
8338 (defvar org-table-current-begin-pos nil
8339 "Table begin position, non-nil only for the duration of a comand.")
8340 (defvar org-table-dlines nil
8341 "Vector of data line line numbers in the current table.")
8342 (defvar org-table-hlines nil
8343 "Vector of hline line numbers in the current table.")
8345 (defconst org-table-range-regexp
8346 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8347 ;; 1 2 3 4 5
8348 "Regular expression for matching ranges in formulas.")
8350 (defconst org-table-range-regexp2
8351 (concat
8355 "Match a range for reference display.")
8357 (defconst org-table-translate-regexp
8359 "Match a reference that needs translation, for reference display.")
8361 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8363 (defun org-table-create-with-table.el ()
8364 "Use the table.el package to insert a new table.
8365 If there is already a table at point, convert between Org-mode tables
8366 and table.el tables."
8367 (interactive)
8368 (require 'table)
8369 (cond
8370 ((org-at-table.el-p)
8371 (if (y-or-n-p "Convert table to Org-mode table? ")
8372 (org-table-convert)))
8373 ((org-at-table-p)
8374 (if (y-or-n-p "Convert table to table.el table? ")
8375 (org-table-convert)))
8376 (t (call-interactively 'table-insert))))
8378 (defun org-table-create-or-convert-from-region (arg)
8379 "Convert region to table, or create an empty table.
8380 If there is an active region, convert it to a table, using the function
8381 `org-table-convert-region'. See the documentation of that function
8382 to learn how the prefix argument is interpreted to determine the field
8383 separator.
8384 If there is no such region, create an empty table with `org-table-create'."
8385 (interactive "P")
8386 (if (org-region-active-p)
8387 (org-table-convert-region (region-beginning) (region-end) arg)
8388 (org-table-create arg)))
8390 (defun org-table-create (&optional size)
8391 "Query for a size and insert a table skeleton.
8393 (interactive "P")
8394 (unless size
8395 (setq size (read-string
8396 (concat "Table size Columns x Rows [e.g. "
8397 org-table-default-size "]: ")
8398 "" nil org-table-default-size)))
8400 (let* ((pos (point))
8401 (indent (make-string (current-column) ?\ ))
8402 (split (org-split-string size " *x *"))
8403 (rows (string-to-number (nth 1 split)))
8404 (columns (string-to-number (car split)))
8405 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8408 (point-at-bol) (point)))
8409 (beginning-of-line 1)
8410 (newline))
8411 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8412 (dotimes (i rows) (insert line))
8413 (goto-char pos)
8414 (if (> rows 1)
8415 ;; Insert a hline after the first row.
8416 (progn
8417 (end-of-line 1)
8419 (goto-char pos)))
8420 (org-table-align)))
8422 (defun org-table-convert-region (beg0 end0 &optional separator)
8423 "Convert region to a table.
8424 The region goes from BEG0 to END0, but these borders will be moved
8425 slightly, to make sure a beginning of line in the first line is included.
8427 SEPARATOR specifies the field separator in the lines. It can have the
8428 following values:
8430 '(4) Use the comma as a field separator
8431 '(16) Use a TAB as field separator
8432 integer When a number, use that many spaces as field separator
8433 nil When nil, the command tries to be smart and figure out the
8434 separator in the following way:
8435 - when each line contains a TAB, assume TAB-separated material
8436 - when each line contains a comme, assume CSV material
8437 - else, assume one or more SPACE charcters as separator."
8438 (interactive "rP")
8439 (let* ((beg (min beg0 end0))
8440 (end (max beg0 end0))
8441 re)
8442 (goto-char beg)
8443 (beginning-of-line 1)
8444 (setq beg (move-marker (make-marker) (point)))
8445 (goto-char end)
8446 (if (bolp) (backward-char 1) (end-of-line 1))
8447 (setq end (move-marker (make-marker) (point)))
8448 ;; Get the right field separator
8449 (unless separator
8450 (goto-char beg)
8451 (setq separator
8452 (cond
8455 (t 1))))
8456 (setq re (cond
8459 ((integerp separator)
8461 (t (error "This should not happen"))))
8462 (goto-char beg)
8463 (while (re-search-forward re end t)
8464 (replace-match "| " t t))
8465 (goto-char beg)
8466 (insert " ")
8467 (org-table-align)))
8469 (defun org-table-import (file arg)
8470 "Import FILE as a table.
8471 The file is assumed to be tab-separated. Such files can be produced by most
8472 spreadsheet and database applications. If no tabs (at least one per line)
8473 are found, lines will be split on whitespace into fields."
8475 (or (bolp) (newline))
8476 (let ((beg (point))
8477 (pm (point-max)))
8478 (insert-file-contents file)
8479 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8481 (defun org-table-export ()
8482 "Export table as a tab-separated file.
8483 Such a file can be imported into a spreadsheet program like Excel."
8484 (interactive)
8485 (let* ((beg (org-table-begin))
8486 (end (org-table-end))
8487 (table (buffer-substring beg end))
8488 (file (read-file-name "Export table to: "))
8489 buf)
8490 (unless (or (not (file-exists-p file))
8491 (y-or-n-p (format "Overwrite file %s? " file)))
8492 (error "Abort"))
8493 (with-current-buffer (find-file-noselect file)
8494 (setq buf (current-buffer))
8495 (erase-buffer)
8496 (fundamental-mode)
8497 (insert table)
8498 (goto-char (point-min))
8500 (replace-match "" t t)
8501 (end-of-line 1))
8502 (goto-char (point-min))
8504 (replace-match "" t t)
8505 (goto-char (min (1+ (point)) (point-max))))
8506 (goto-char (point-min))
8507 (while (re-search-forward "^-[-+]*$" nil t)
8508 (replace-match "")
8510 (delete-char 1)))
8511 (goto-char (point-min))
8514 (save-buffer))
8515 (kill-buffer buf)))
8517 (defvar org-table-aligned-begin-marker (make-marker)
8518 "Marker at the beginning of the table last aligned.
8519 Used to check if cursor still is in that table, to minimize realignment.")
8520 (defvar org-table-aligned-end-marker (make-marker)
8521 "Marker at the end of the table last aligned.
8522 Used to check if cursor still is in that table, to minimize realignment.")
8523 (defvar org-table-last-alignment nil
8524 "List of flags for flushright alignment, from the last re-alignment.
8525 This is being used to correctly align a single field after TAB or RET.")
8526 (defvar org-table-last-column-widths nil
8527 "List of max width of fields in each column.
8528 This is being used to correctly align a single field after TAB or RET.")
8529 (defvar org-table-overlay-coordinates nil
8530 "Overlay coordinates after each align of a table.")
8531 (make-variable-buffer-local 'org-table-overlay-coordinates)
8533 (defvar org-last-recalc-line nil)
8534 (defconst org-narrow-column-arrow "=>"
8535 "Used as display property in narrowed table columns.")
8537 (defun org-table-align ()
8538 "Align the table at point by aligning all vertical bars."
8539 (interactive)
8540 (let* (
8541 ;; Limits of table
8542 (beg (org-table-begin))
8543 (end (org-table-end))
8544 ;; Current cursor position
8545 (linepos (org-current-line))
8546 (colpos (org-table-current-column))
8547 (winstart (window-start))
8548 (winstartline (org-current-line (min winstart (1- (point-max)))))
8549 lines (new "") lengths l typenums ty fields maxfields i
8550 column
8551 (indent "") cnt frac
8552 rfmt hfmt
8553 (spaces '(1 . 1))
8554 (sp1 (car spaces))
8555 (sp2 (cdr spaces))
8556 (rfmt1 (concat
8557 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8558 (hfmt1 (concat
8559 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8560 emptystrings links dates emph narrow fmax f1 len c e)
8561 (untabify beg end)
8562 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8563 ;; Check if we have links or dates
8564 (goto-char beg)
8565 (setq links (re-search-forward org-bracket-link-regexp end t))
8566 (goto-char beg)
8567 (setq emph (and org-hide-emphasis-markers
8568 (re-search-forward org-emph-re end t)))
8569 (goto-char beg)
8570 (setq dates (and org-display-custom-times
8571 (re-search-forward org-ts-regexp-both end t)))
8572 ;; Make sure the link properties are right
8573 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8574 ;; Make sure the date properties are right
8575 (when dates (goto-char beg) (while (org-activate-dates end)))
8576 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8578 ;; Check if we are narrowing any columns
8579 (goto-char beg)
8580 (setq narrow (and org-format-transports-properties-p
8581 (re-search-forward "<[0-9]+>" end t)))
8582 ;; Get the rows
8583 (setq lines (org-split-string
8585 ;; Store the indentation of the first line
8586 (if (string-match "^ *" (car lines))
8587 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8588 ;; Mark the hlines by setting the corresponding element to nil
8589 ;; At the same time, we remove trailing space.
8590 (setq lines (mapcar (lambda (l)
8591 (if (string-match "^ *|-" l)
8592 nil
8594 (substring l 0 (match-beginning 0))
8595 l)))
8596 lines))
8597 ;; Get the data fields by splitting the lines.
8598 (setq fields (mapcar
8599 (lambda (l)
8600 (org-split-string l " *| *"))
8601 (delq nil (copy-sequence lines))))
8602 ;; How many fields in the longest line?
8603 (condition-case nil
8604 (setq maxfields (apply 'max (mapcar 'length fields)))
8605 (error
8606 (kill-region beg end)
8607 (org-table-create org-table-default-size)
8608 (error "Empty table - created default table")))
8609 ;; A list of empty strings to fill any short rows on output
8610 (setq emptystrings (make-list maxfields ""))
8611 ;; Check for special formatting.
8612 (setq i -1)
8613 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8614 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8615 ;; Check if there is an explicit width specified
8616 (when narrow
8617 (setq c column fmax nil)
8618 (while c
8619 (setq e (pop c))
8621 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8622 ;; Find fields that are wider than fmax, and shorten them
8623 (when fmax
8624 (loop for xx in column do
8625 (when (and (stringp xx)
8626 (> (org-string-width xx) fmax))
8627 (org-add-props xx nil
8628 'help-echo
8629 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8630 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8631 (unless (> f1 1)
8633 (match-string 0 xx)))
8634 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8635 (add-text-properties (- f1 2) f1
8636 (list 'display org-narrow-column-arrow)
8637 xx)))))
8638 ;; Get the maximum width for each column
8639 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8640 ;; Get the fraction of numbers, to decide about alignment of the column
8641 (setq cnt 0 frac 0.0)
8642 (loop for x in column do
8643 (if (equal x "")
8644 nil
8645 (setq frac ( / (+ (* frac cnt)
8646 (if (string-match org-table-number-regexp x) 1 0))
8647 (setq cnt (1+ cnt))))))
8648 (push (>= frac org-table-number-fraction) typenums))
8649 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8651 ;; Store the alignment of this table, for later editing of single fields
8652 (setq org-table-last-alignment typenums
8653 org-table-last-column-widths lengths)
8655 ;; With invisible characters, `format' does not get the field width right
8656 ;; So we need to make these fields wide by hand.
8657 (when (or links emph)
8658 (loop for i from 0 upto (1- maxfields) do
8659 (setq len (nth i lengths))
8660 (loop for j from 0 upto (1- (length fields)) do
8661 (setq c (nthcdr i (car (nthcdr j fields))))
8662 (if (and (stringp (car c))
8663 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8664 ; (string-match org-bracket-link-regexp (car c))
8665 (< (org-string-width (car c)) len))
8666 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8668 ;; Compute the formats needed for output of the table
8669 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8670 (while (setq l (pop lengths))
8671 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8672 (setq rfmt (concat rfmt (format rfmt1 ty l))
8673 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8677 (setq new (mapconcat
8678 (lambda (l)
8679 (if l (apply 'format rfmt
8680 (append (pop fields) emptystrings))
8681 hfmt))
8682 lines ""))
8683 ;; Replace the old one
8684 (delete-region beg end)
8685 (move-marker end nil)
8686 (move-marker org-table-aligned-begin-marker (point))
8687 (insert new)
8688 (move-marker org-table-aligned-end-marker (point))
8689 (when (and orgtbl-mode (not (org-mode-p)))
8690 (goto-char org-table-aligned-begin-marker)
8691 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8692 ;; Try to move to the old location
8693 (goto-line winstartline)
8694 (setq winstart (point-at-bol))
8695 (goto-line linepos)
8696 (set-window-start (selected-window) winstart 'noforce)
8697 (org-table-goto-column colpos)
8698 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8699 (setq org-table-may-need-update nil)
8700 ))
8702 (defun org-string-width (s)
8703 "Compute width of string, ignoring invisible characters.
8704 This ignores character with invisibility property `org-link', and also
8705 characters with property `org-cwidth', because these will become invisible
8706 upon the next fontification round."
8707 (let (b l)
8708 (when (or (eq t buffer-invisibility-spec)
8709 (assq 'org-link buffer-invisibility-spec))
8710 (while (setq b (text-property-any 0 (length s)
8711 'invisible 'org-link s))
8712 (setq s (concat (substring s 0 b)
8713 (substring s (or (next-single-property-change
8714 b 'invisible s) (length s)))))))
8715 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8716 (setq s (concat (substring s 0 b)
8717 (substring s (or (next-single-property-change
8718 b 'org-cwidth s) (length s))))))
8719 (setq l (string-width s) b -1)
8720 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8721 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8722 l))
8724 (defun org-table-begin (&optional table-type)
8725 "Find the beginning of the table and return its position.
8726 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8727 (save-excursion
8728 (if (not (re-search-backward
8729 (if table-type org-table-any-border-regexp
8730 org-table-border-regexp)
8731 nil t))
8732 (progn (goto-char (point-min)) (point))
8733 (goto-char (match-beginning 0))
8734 (beginning-of-line 2)
8735 (point))))
8737 (defun org-table-end (&optional table-type)
8738 "Find the end of the table and return its position.
8739 With argument TABLE-TYPE, go to the end of a table.el-type table."
8740 (save-excursion
8741 (if (not (re-search-forward
8742 (if table-type org-table-any-border-regexp
8743 org-table-border-regexp)
8744 nil t))
8745 (goto-char (point-max))
8746 (goto-char (match-beginning 0)))
8747 (point-marker)))
8749 (defun org-table-justify-field-maybe (&optional new)
8750 "Justify the current field, text to left, number to right.
8751 Optional argument NEW may specify text to replace the current field content."
8752 (cond
8753 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8754 ((org-at-table-hline-p))
8755 ((and (not new)
8756 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8757 (current-buffer)))
8758 (< (point) org-table-aligned-begin-marker)
8759 (>= (point) org-table-aligned-end-marker)))
8760 ;; This is not the same table, force a full re-align
8761 (setq org-table-may-need-update t))
8762 (t ;; realign the current field, based on previous full realign
8763 (let* ((pos (point)) s
8764 (col (org-table-current-column))
8765 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8766 l f n o e)
8767 (when (> col 0)
8770 (progn
8771 (setq s (match-string 1)
8772 o (match-string 0)
8773 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8774 e (not (= (match-beginning 2) (match-end 2))))
8775 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8776 l (if e "|" (setq org-table-may-need-update t) ""))
8777 n (format f s))
8778 (if new
8779 (if (<= (length new) l) ;; FIXME: length -> str-width?
8780 (setq n (format f new))
8781 (setq n (concat new "|") org-table-may-need-update t)))
8782 (or (equal n o)
8783 (let (org-table-may-need-update)
8784 (replace-match n t t))))
8785 (setq org-table-may-need-update t))
8786 (goto-char pos))))))
8788 (defun org-table-next-field ()
8789 "Go to the next field in the current table, creating new lines as needed.
8790 Before doing so, re-align the table if necessary."
8791 (interactive)
8792 (org-table-maybe-eval-formula)
8793 (org-table-maybe-recalculate-line)
8794 (if (and org-table-automatic-realign
8795 org-table-may-need-update)
8796 (org-table-align))
8797 (let ((end (org-table-end)))
8798 (if (org-at-table-hline-p)
8799 (end-of-line 1))
8800 (condition-case nil
8801 (progn
8802 (re-search-forward "|" end)
8804 (re-search-forward "|" end))
8805 (if (and (looking-at "-")
8806 org-table-tab-jumps-over-hlines
8808 (goto-char (match-beginning 1)))
8809 (if (looking-at "-")
8810 (progn
8811 (beginning-of-line 0)
8812 (org-table-insert-row 'below))
8813 (if (looking-at " ") (forward-char 1))))
8814 (error
8815 (org-table-insert-row 'below)))))
8817 (defun org-table-previous-field ()
8818 "Go to the previous field in the table.
8819 Before doing so, re-align the table if necessary."
8820 (interactive)
8821 (org-table-justify-field-maybe)
8822 (org-table-maybe-recalculate-line)
8823 (if (and org-table-automatic-realign
8824 org-table-may-need-update)
8825 (org-table-align))
8826 (if (org-at-table-hline-p)
8827 (end-of-line 1))
8828 (re-search-backward "|" (org-table-begin))
8829 (re-search-backward "|" (org-table-begin))
8831 (re-search-backward "|" (org-table-begin)))
8832 (if (looking-at "| ?")
8833 (goto-char (match-end 0))))
8835 (defun org-table-next-row ()
8836 "Go to the next row (same column) in the current table.
8837 Before doing so, re-align the table if necessary."
8838 (interactive)
8839 (org-table-maybe-eval-formula)
8840 (org-table-maybe-recalculate-line)
8843 (newline)
8844 (if (and org-table-automatic-realign
8845 org-table-may-need-update)
8846 (org-table-align))
8847 (let ((col (org-table-current-column)))
8848 (beginning-of-line 2)
8849 (if (or (not (org-at-table-p))
8850 (org-at-table-hline-p))
8851 (progn
8852 (beginning-of-line 0)
8853 (org-table-insert-row 'below)))
8854 (org-table-goto-column col)
8856 (if (looking-at " ") (forward-char 1)))))
8858 (defun org-table-copy-down (n)
8859 "Copy a field down in the current column.
8860 If the field at the cursor is empty, copy into it the content of the nearest
8861 non-empty field above. With argument N, use the Nth non-empty field.
8862 If the current field is not empty, it is copied down to the next row, and
8863 the cursor is moved with it. Therefore, repeating this command causes the
8864 column to be filled row-by-row.
8865 If the variable `org-table-copy-increment' is non-nil and the field is an
8866 integer or a timestamp, it will be incremented while copying. In the case of
8867 a timestamp, if the cursor is on the year, change the year. If it is on the
8868 month or the day, change that. Point will stay on the current date field
8869 in order to easily repeat the interval."
8870 (interactive "p")
8871 (let* ((colpos (org-table-current-column))
8872 (col (current-column))
8873 (field (org-table-get-field))
8875 (beg (org-table-begin))
8876 txt)
8877 (org-table-check-inside-data-field)
8878 (if non-empty
8879 (progn
8880 (setq txt (org-trim field))
8881 (org-table-next-row)
8882 (org-table-blank-field))
8883 (save-excursion
8884 (setq txt
8885 (catch 'exit
8886 (while (progn (beginning-of-line 1)
8887 (re-search-backward org-table-dataline-regexp
8888 beg t))
8889 (org-table-goto-column colpos t)
8890 (if (and (looking-at
8892 (= (setq n (1- n)) 0))
8893 (throw 'exit (match-string 1))))))))
8894 (if txt
8895 (progn
8896 (if (and org-table-copy-increment
8897 (string-match "^[0-9]+$" txt))
8898 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8899 (insert txt)
8900 (move-to-column col)
8901 (if (and org-table-copy-increment (org-at-timestamp-p t))
8902 (org-timestamp-up 1)
8903 (org-table-maybe-recalculate-line))
8904 (org-table-align)
8905 (move-to-column col))
8906 (error "No non-empty field found"))))
8908 (defun org-table-check-inside-data-field ()
8909 "Is point inside a table data field?
8910 I.e. not on a hline or before the first or after the last column?
8911 This actually throws an error, so it aborts the current command."
8912 (if (or (not (org-at-table-p))
8913 (= (org-table-current-column) 0)
8914 (org-at-table-hline-p)
8916 (error "Not in table data field")))
8918 (defvar org-table-clip nil
8919 "Clipboard for table regions.")
8921 (defun org-table-blank-field ()
8922 "Blank the current table field or active region."
8923 (interactive)
8924 (org-table-check-inside-data-field)
8925 (if (and (interactive-p) (org-region-active-p))
8926 (let (org-table-clip)
8927 (org-table-cut-region (region-beginning) (region-end)))
8928 (skip-chars-backward "^|")
8929 (backward-char 1)
8931 (let* ((pos (match-beginning 0))
8932 (match (match-string 0))
8933 (len (org-string-width match)))
8934 (replace-match (concat "|" (make-string (1- len) ?\ )))
8935 (goto-char (+ 2 pos))
8936 (substring match 1)))))
8938 (defun org-table-get-field (&optional n replace)
8939 "Return the value of the field in column N of current row.
8940 N defaults to current field.
8941 If REPLACE is a string, replace field with this value. The return value
8942 is always the old value."
8943 (and n (org-table-goto-column n))
8945 (backward-char 1)
8947 (let* ((pos (match-beginning 0))
8948 (val (buffer-substring (1+ pos) (match-end 0))))
8949 (if replace
8950 (replace-match (concat "|" replace) t t))
8951 (goto-char (min (point-at-eol) (+ 2 pos)))
8952 val)
8953 (forward-char 1) ""))
8955 (defun org-table-field-info (arg)
8956 "Show info about the current field, and highlight any reference at point."
8957 (interactive "P")
8958 (org-table-get-specials)
8959 (save-excursion
8960 (let* ((pos (point))
8961 (col (org-table-current-column))
8962 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8963 (name (car (rassoc (list (org-current-line) col)
8964 org-table-named-field-locations)))
8965 (eql (org-table-get-stored-formulas))
8966 (dline (org-table-current-dline))
8967 (ref (format "@%d$%d" dline col))
8968 (ref1 (org-table-convert-refs-to-an ref))
8969 (fequation (or (assoc name eql) (assoc ref eql)))
8970 (cequation (assoc (int-to-string col) eql))
8971 (eqn (or fequation cequation)))
8972 (goto-char pos)
8973 (condition-case nil
8974 (org-table-show-reference 'local)
8975 (error nil))
8976 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8977 dline col
8978 (if cname (concat " or $" cname) "")
8979 dline col ref1
8980 (if name (concat " or $" name) "")
8981 ;; FIXME: formula info not correct if special table line
8982 (if eqn
8983 (concat ", formula: "
8984 (org-table-formula-to-user
8985 (concat
8986 (if (string-match "^[$@]"(car eqn)) "" "$")
8987 (car eqn) "=" (cdr eqn))))
8988 "")))))
8990 (defun org-table-current-column ()
8991 "Find out which column we are in.
8992 When called interactively, column is also displayed in echo area."
8993 (interactive)
8994 (if (interactive-p) (org-table-check-inside-data-field))
8995 (save-excursion
8996 (let ((cnt 0) (pos (point)))
8997 (beginning-of-line 1)
8998 (while (search-forward "|" pos t)
8999 (setq cnt (1+ cnt)))
9000 (if (interactive-p) (message "This is table column %d" cnt))
9001 cnt)))
9003 (defun org-table-current-dline ()
9004 "Find out what table data line we are in.
9005 Only datalins count for this."
9006 (interactive)
9007 (if (interactive-p) (org-table-check-inside-data-field))
9008 (save-excursion
9009 (let ((cnt 0) (pos (point)))
9010 (goto-char (org-table-begin))
9011 (while (<= (point) pos)
9012 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
9013 (beginning-of-line 2))
9014 (if (interactive-p) (message "This is table line %d" cnt))
9015 cnt)))
9017 (defun org-table-goto-column (n &optional on-delim force)
9018 "Move the cursor to the Nth column in the current table line.
9019 With optional argument ON-DELIM, stop with point before the left delimiter
9020 of the field.
9021 If there are less than N fields, just go to after the last delimiter.
9022 However, when FORCE is non-nil, create new columns if necessary."
9023 (interactive "p")
9024 (let ((pos (point-at-eol)))
9025 (beginning-of-line 1)
9026 (when (> n 0)
9027 (while (and (> (setq n (1- n)) -1)
9028 (or (search-forward "|" pos t)
9029 (and force
9030 (progn (end-of-line 1)
9031 (skip-chars-backward "^|")
9032 (insert " | "))))))
9033 ; (backward-char 2) t)))))
9034 (when (and force (not (looking-at ".*|")))
9035 (save-excursion (end-of-line 1) (insert " | ")))
9036 (if on-delim
9037 (backward-char 1)
9038 (if (looking-at " ") (forward-char 1))))))
9040 (defun org-at-table-p (&optional table-type)
9041 "Return t if the cursor is inside an org-type table.
9042 If TABLE-TYPE is non-nil, also check for table.el-type tables."
9043 (if org-enable-table-editor
9044 (save-excursion
9045 (beginning-of-line 1)
9046 (looking-at (if table-type org-table-any-line-regexp
9047 org-table-line-regexp)))
9048 nil))
9050 (defun org-at-table.el-p ()
9051 "Return t if and only if we are at a table.el table."
9052 (and (org-at-table-p 'any)
9053 (save-excursion
9054 (goto-char (org-table-begin 'any))
9055 (looking-at org-table1-hline-regexp))))
9057 (defun org-table-recognize-table.el ()
9058 "If there is a table.el table nearby, recognize it and move into it."
9059 (if org-table-tab-recognizes-table.el
9060 (if (org-at-table.el-p)
9061 (progn
9062 (beginning-of-line 1)
9063 (if (looking-at org-table-dataline-regexp)
9064 nil
9065 (if (looking-at org-table1-hline-regexp)
9066 (progn
9067 (beginning-of-line 2)
9068 (if (looking-at org-table-any-border-regexp)
9069 (beginning-of-line -1)))))
9070 (if (re-search-forward "|" (org-table-end t) t)
9071 (progn
9072 (require 'table)
9073 (if (table--at-cell-p (point))
9074 t
9075 (message "recognizing table.el table...")
9076 (table-recognize-table)
9077 (message "recognizing table.el table...done")))
9078 (error "This should not happen..."))
9079 t)
9080 nil)
9081 nil))
9083 (defun org-at-table-hline-p ()
9084 "Return t if the cursor is inside a hline in a table."
9085 (if org-enable-table-editor
9086 (save-excursion
9087 (beginning-of-line 1)
9088 (looking-at org-table-hline-regexp))
9089 nil))
9091 (defun org-table-insert-column ()
9092 "Insert a new column into the table."
9093 (interactive)
9094 (if (not (org-at-table-p))
9095 (error "Not at a table"))
9096 (org-table-find-dataline)
9097 (let* ((col (max 1 (org-table-current-column)))
9098 (beg (org-table-begin))
9099 (end (org-table-end))
9100 ;; Current cursor position
9101 (linepos (org-current-line))
9102 (colpos col))
9103 (goto-char beg)
9104 (while (< (point) end)
9105 (if (org-at-table-hline-p)
9106 nil
9107 (org-table-goto-column col t)
9108 (insert "| "))
9109 (beginning-of-line 2))
9110 (move-marker end nil)
9111 (goto-line linepos)
9112 (org-table-goto-column colpos)
9113 (org-table-align)
9114 (org-table-fix-formulas "$" nil (1- col) 1)))
9116 (defun org-table-find-dataline ()
9117 "Find a dataline in the current table, which is needed for column commands."
9118 (if (and (org-at-table-p)
9119 (not (org-at-table-hline-p)))
9120 t
9121 (let ((col (current-column))
9122 (end (org-table-end)))
9123 (move-to-column col)
9124 (while (and (< (point) end)
9125 (or (not (= (current-column) col))
9126 (org-at-table-hline-p)))
9127 (beginning-of-line 2)
9128 (move-to-column col))
9129 (if (and (org-at-table-p)
9130 (not (org-at-table-hline-p)))
9131 t
9132 (error
9133 "Please position cursor in a data line for column operations")))))
9135 (defun org-table-delete-column ()
9136 "Delete a column from the table."
9137 (interactive)
9138 (if (not (org-at-table-p))
9139 (error "Not at a table"))
9140 (org-table-find-dataline)
9141 (org-table-check-inside-data-field)
9142 (let* ((col (org-table-current-column))
9143 (beg (org-table-begin))
9144 (end (org-table-end))
9145 ;; Current cursor position
9146 (linepos (org-current-line))
9147 (colpos col))
9148 (goto-char beg)
9149 (while (< (point) end)
9150 (if (org-at-table-hline-p)
9151 nil
9152 (org-table-goto-column col t)
9154 (replace-match "|")))
9155 (beginning-of-line 2))
9156 (move-marker end nil)
9157 (goto-line linepos)
9158 (org-table-goto-column colpos)
9159 (org-table-align)
9160 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9161 col -1 col)))
9163 (defun org-table-move-column-right ()
9164 "Move column to the right."
9165 (interactive)
9166 (org-table-move-column nil))
9167 (defun org-table-move-column-left ()
9168 "Move column to the left."
9169 (interactive)
9170 (org-table-move-column 'left))
9172 (defun org-table-move-column (&optional left)
9173 "Move the current column to the right. With arg LEFT, move to the left."
9174 (interactive "P")
9175 (if (not (org-at-table-p))
9176 (error "Not at a table"))
9177 (org-table-find-dataline)
9178 (org-table-check-inside-data-field)
9179 (let* ((col (org-table-current-column))
9180 (col1 (if left (1- col) col))
9181 (beg (org-table-begin))
9182 (end (org-table-end))
9183 ;; Current cursor position
9184 (linepos (org-current-line))
9185 (colpos (if left (1- col) (1+ col))))
9186 (if (and left (= col 1))
9187 (error "Cannot move column further left"))
9189 (error "Cannot move column further right"))
9190 (goto-char beg)
9191 (while (< (point) end)
9192 (if (org-at-table-hline-p)
9193 nil
9194 (org-table-goto-column col1 t)
9197 (beginning-of-line 2))
9198 (move-marker end nil)
9199 (goto-line linepos)
9200 (org-table-goto-column colpos)
9201 (org-table-align)
9202 (org-table-fix-formulas
9203 "$" (list (cons (number-to-string col) (number-to-string colpos))
9204 (cons (number-to-string colpos) (number-to-string col))))))
9206 (defun org-table-move-row-down ()
9207 "Move table row down."
9208 (interactive)
9209 (org-table-move-row nil))
9210 (defun org-table-move-row-up ()
9211 "Move table row up."
9212 (interactive)
9213 (org-table-move-row 'up))
9215 (defun org-table-move-row (&optional up)
9216 "Move the current table line down. With arg UP, move it up."
9217 (interactive "P")
9218 (let* ((col (current-column))
9219 (pos (point))
9220 (hline1p (save-excursion (beginning-of-line 1)
9221 (looking-at org-table-hline-regexp)))
9222 (dline1 (org-table-current-dline))
9223 (dline2 (+ dline1 (if up -1 1)))
9224 (tonew (if up 0 2))
9225 txt hline2p)
9226 (beginning-of-line tonew)
9227 (unless (org-at-table-p)
9228 (goto-char pos)
9229 (error "Cannot move row further"))
9230 (setq hline2p (looking-at org-table-hline-regexp))
9231 (goto-char pos)
9232 (beginning-of-line 1)
9233 (setq pos (point))
9234 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9235 (delete-region (point) (1+ (point-at-eol)))
9236 (beginning-of-line tonew)
9237 (insert txt)
9238 (beginning-of-line 0)
9239 (move-to-column col)
9240 (unless (or hline1p hline2p)
9241 (org-table-fix-formulas
9242 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9243 (cons (number-to-string dline2) (number-to-string dline1)))))))
9245 (defun org-table-insert-row (&optional arg)
9246 "Insert a new row above the current line into the table.
9247 With prefix ARG, insert below the current line."
9248 (interactive "P")
9249 (if (not (org-at-table-p))
9250 (error "Not at a table"))
9251 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9252 (new (org-table-clean-line line)))
9253 ;; Fix the first field if necessary
9255 (setq new (replace-match (match-string 0 line) t t new)))
9256 (beginning-of-line (if arg 2 1))
9258 (beginning-of-line 0)
9259 (re-search-forward "| ?" (point-at-eol) t)
9260 (and (or org-table-may-need-update org-table-overlay-coordinates)
9261 (org-table-align))
9262 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9264 (defun org-table-insert-hline (&optional above)
9265 "Insert a horizontal-line below the current line into the table.
9266 With prefix ABOVE, insert above the current line."
9267 (interactive "P")
9268 (if (not (org-at-table-p))
9269 (error "Not at a table"))
9270 (let ((line (org-table-clean-line
9271 (buffer-substring (point-at-bol) (point-at-eol))))
9272 (col (current-column)))
9274 (setq line (replace-match
9275 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9276 ?-) "|") t t line)))
9278 (beginning-of-line (if above 1 2))
9280 (beginning-of-line (if above 1 -1))
9281 (move-to-column col)
9282 (and org-table-overlay-coordinates (org-table-align))))
9284 (defun org-table-hline-and-move (&optional same-column)
9285 "Insert a hline and move to the row below that line."
9286 (interactive "P")
9287 (let ((col (org-table-current-column)))
9288 (org-table-maybe-eval-formula)
9289 (org-table-maybe-recalculate-line)
9290 (org-table-insert-hline)
9291 (end-of-line 2)
9294 (org-table-next-field))
9295 (if same-column (org-table-goto-column col))))
9297 (defun org-table-clean-line (s)
9299 In particular, this does handle wide and invisible characters."
9301 ;; It's a hline, just map the characters
9302 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9304 (setq s (replace-match
9305 (concat "|" (make-string (org-string-width (match-string 1 s))
9306 ?\ ) "|")
9307 t t s)))
9308 s))
9310 (defun org-table-kill-row ()
9311 "Delete the current row or horizontal line from the table."
9312 (interactive)
9313 (if (not (org-at-table-p))
9314 (error "Not at a table"))
9315 (let ((col (current-column))
9316 (dline (org-table-current-dline)))
9317 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9318 (if (not (org-at-table-p)) (beginning-of-line 0))
9319 (move-to-column col)
9320 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9321 dline -1 dline)))
9323 (defun org-table-sort-lines (with-case &optional sorting-type)
9324 "Sort table lines according to the column at point.
9326 The position of point indicates the column to be used for
9327 sorting, and the range of lines is the range between the nearest
9328 horizontal separator lines, or the entire table of no such lines
9329 exist. If point is before the first column, you will be prompted
9330 for the sorting column. If there is an active region, the mark
9331 specifies the first line and the sorting column, while point
9332 should be in the last line to be included into the sorting.
9334 The command then prompts for the sorting type which can be
9335 alphabetically, numerically, or by time (as given in a time stamp
9336 in the field). Sorting in reverse order is also possible.
9338 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9340 If SORTING-TYPE is specified when this function is called from a Lisp
9341 program, no prompting will take place. SORTING-TYPE must be a character,
9342 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9343 should be done in reverse order."
9344 (interactive "P")
9345 (let* ((thisline (org-current-line))
9346 (thiscol (org-table-current-column))
9347 beg end bcol ecol tend tbeg column lns pos)
9348 (when (equal thiscol 0)
9349 (if (interactive-p)
9350 (setq thiscol
9351 (string-to-number
9352 (read-string "Use column N for sorting: ")))
9353 (setq thiscol 1))
9354 (org-table-goto-column thiscol))
9355 (org-table-check-inside-data-field)
9356 (if (org-region-active-p)
9357 (progn
9358 (setq beg (region-beginning) end (region-end))
9359 (goto-char beg)
9360 (setq column (org-table-current-column)
9361 beg (point-at-bol))
9362 (goto-char end)
9363 (setq end (point-at-bol 2)))
9364 (setq column (org-table-current-column)
9365 pos (point)
9366 tbeg (org-table-begin)
9367 tend (org-table-end))
9368 (if (re-search-backward org-table-hline-regexp tbeg t)
9369 (setq beg (point-at-bol 2))
9370 (goto-char tbeg)
9371 (setq beg (point-at-bol 1)))
9372 (goto-char pos)
9373 (if (re-search-forward org-table-hline-regexp tend t)
9374 (setq end (point-at-bol 1))
9375 (goto-char tend)
9376 (setq end (point-at-bol))))
9377 (setq beg (move-marker (make-marker) beg)
9378 end (move-marker (make-marker) end))
9379 (untabify beg end)
9380 (goto-char beg)
9381 (org-table-goto-column column)
9382 (skip-chars-backward "^|")
9383 (setq bcol (current-column))
9384 (org-table-goto-column (1+ column))
9385 (skip-chars-backward "^|")
9386 (setq ecol (1- (current-column)))
9387 (org-table-goto-column column)
9388 (setq lns (mapcar (lambda(x) (cons
9389 (org-sort-remove-invisible
9390 (nth (1- column)
9392 x))
9394 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9395 (delete-region beg end)
9396 (move-marker beg nil)
9397 (move-marker end nil)
9399 (goto-line thisline)
9400 (org-table-goto-column thiscol)
9401 (message "%d lines sorted, based on column %d" (length lns) column)))
9403 ;; FIXME: maybe we will not need this? Table sorting is broken....
9404 (defun org-sort-remove-invisible (s)
9405 (remove-text-properties 0 (length s) org-rm-props s)
9406 (while (string-match org-bracket-link-regexp s)
9407 (setq s (replace-match (if (match-end 2)
9408 (match-string 3 s)
9409 (match-string 1 s)) t t s)))
9410 s)
9412 (defun org-table-cut-region (beg end)
9413 "Copy region in table to the clipboard and blank all relevant fields."
9414 (interactive "r")
9415 (org-table-copy-region beg end 'cut))
9417 (defun org-table-copy-region (beg end &optional cut)
9418 "Copy rectangular region in table to clipboard.
9419 A special clipboard is used which can only be accessed
9420 with `org-table-paste-rectangle'."
9421 (interactive "rP")
9422 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9423 region cols
9424 (rpl (if cut " " nil)))
9425 (goto-char beg)
9426 (org-table-check-inside-data-field)
9427 (setq l01 (org-current-line)
9428 c01 (org-table-current-column))
9429 (goto-char end)
9430 (org-table-check-inside-data-field)
9431 (setq l02 (org-current-line)
9432 c02 (org-table-current-column))
9433 (setq l1 (min l01 l02) l2 (max l01 l02)
9434 c1 (min c01 c02) c2 (max c01 c02))
9435 (catch 'exit
9436 (while t
9437 (catch 'nextline
9438 (if (> l1 l2) (throw 'exit t))
9439 (goto-line l1)
9440 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9441 (setq cols nil ic1 c1 ic2 c2)
9442 (while (< ic1 (1+ ic2))
9443 (push (org-table-get-field ic1 rpl) cols)
9444 (setq ic1 (1+ ic1)))
9445 (push (nreverse cols) region)
9446 (setq l1 (1+ l1)))))
9447 (setq org-table-clip (nreverse region))
9448 (if cut (org-table-align))
9449 org-table-clip))
9451 (defun org-table-paste-rectangle ()
9452 "Paste a rectangular region into a table.
9453 The upper right corner ends up in the current field. All involved fields
9454 will be overwritten. If the rectangle does not fit into the present table,
9455 the table is enlarged as needed. The process ignores horizontal separator
9456 lines."
9457 (interactive)
9458 (unless (and org-table-clip (listp org-table-clip))
9459 (error "First cut/copy a region to paste!"))
9460 (org-table-check-inside-data-field)
9461 (let* ((clip org-table-clip)
9462 (line (org-current-line))
9463 (col (org-table-current-column))
9464 (org-enable-table-editor t)
9465 (org-table-automatic-realign nil)
9466 c cols field)
9467 (while (setq cols (pop clip))
9468 (while (org-at-table-hline-p) (beginning-of-line 2))
9469 (if (not (org-at-table-p))
9470 (progn (end-of-line 0) (org-table-next-field)))
9471 (setq c col)
9472 (while (setq field (pop cols))
9473 (org-table-goto-column c nil 'force)
9474 (org-table-get-field nil field)
9475 (setq c (1+ c)))
9476 (beginning-of-line 2))
9477 (goto-line line)
9478 (org-table-goto-column col)
9479 (org-table-align)))
9481 (defun org-table-convert ()
9482 "Convert from `org-mode' table to table.el and back.
9483 Obviously, this only works within limits. When an Org-mode table is
9484 converted to table.el, all horizontal separator lines get lost, because
9485 table.el uses these as cell boundaries and has no notion of horizontal lines.
9486 A table.el table can be converted to an Org-mode table only if it does not
9487 do row or column spanning. Multiline cells will become multiple cells.
9488 Beware, Org-mode does not test if the table can be successfully converted - it
9489 blindly applies a recipe that works for simple tables."
9490 (interactive)
9491 (require 'table)
9492 (if (org-at-table.el-p)
9493 ;; convert to Org-mode table
9494 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9495 (end (move-marker (make-marker) (org-table-end t))))
9496 (table-unrecognize-region beg end)
9497 (goto-char beg)
9499 (replace-match ""))
9500 (goto-char beg))
9501 (if (org-at-table-p)
9502 ;; convert to table.el table
9503 (let ((beg (move-marker (make-marker) (org-table-begin)))
9504 (end (move-marker (make-marker) (org-table-end))))
9505 ;; first, get rid of all horizontal lines
9506 (goto-char beg)
9508 (replace-match ""))
9509 ;; insert a hline before first
9510 (goto-char beg)
9511 (org-table-insert-hline 'above)
9512 (beginning-of-line -1)
9513 ;; insert a hline after each line
9514 (while (progn (beginning-of-line 3) (< (point) end))
9515 (org-table-insert-hline))
9516 (goto-char beg)
9517 (setq end (move-marker end (org-table-end)))
9518 ;; replace "+" at beginning and ending of hlines
9521 (goto-char beg)
9523 (replace-match "-+"))
9524 (goto-char beg)))))
9526 (defun org-table-wrap-region (arg)
9527 "Wrap several fields in a column like a paragraph.
9528 This is useful if you'd like to spread the contents of a field over several
9529 lines, in order to keep the table compact.
9531 If there is an active region, and both point and mark are in the same column,
9532 the text in the column is wrapped to minimum width for the given number of
9533 lines. Generally, this makes the table more compact. A prefix ARG may be
9535 formats the selected text to two lines. If the region was longer than two
9536 lines, the remaining lines remain empty. A negative prefix argument reduces
9537 the current number of lines by that amount. The wrapped text is pasted back
9538 into the table. If you formatted it to more lines than it was before, fields
9539 further down in the table get overwritten - so you might need to make space in
9540 the table first.
9542 If there is no region, the current field is split at the cursor position and
9543 the text fragment to the right of the cursor is prepended to the field one
9544 line down.
9546 If there is no region, but you specify a prefix ARG, the current field gets
9547 blank, and the content is appended to the field above."
9548 (interactive "P")
9549 (org-table-check-inside-data-field)
9550 (if (org-region-active-p)
9551 ;; There is a region: fill as a paragraph
9552 (let* ((beg (region-beginning))
9553 (cline (save-excursion (goto-char beg) (org-current-line)))
9554 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9555 nlines)
9556 (org-table-cut-region (region-beginning) (region-end))
9557 (if (> (length (car org-table-clip)) 1)
9558 (error "Region must be limited to single column"))
9559 (setq nlines (if arg
9560 (if (< arg 1)
9561 (+ (length org-table-clip) arg)
9562 arg)
9563 (length org-table-clip)))
9564 (setq org-table-clip
9565 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9566 nil nlines)))
9567 (goto-line cline)
9568 (org-table-goto-column ccol)
9569 (org-table-paste-rectangle))
9570 ;; No region, split the current field at point
9571 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9573 (if arg
9574 ;; combine with field above
9575 (let ((s (org-table-blank-field))
9576 (col (org-table-current-column)))
9577 (beginning-of-line 0)
9578 (while (org-at-table-hline-p) (beginning-of-line 0))
9579 (org-table-goto-column col)
9580 (skip-chars-forward "^|")
9581 (skip-chars-backward " ")
9582 (insert " " (org-trim s))
9583 (org-table-align))
9584 ;; split field
9586 (let ((s (match-string 1)))
9587 (replace-match " |")
9588 (goto-char (match-beginning 0))
9589 (org-table-next-row)
9590 (insert (org-trim s) " ")
9591 (org-table-align))
9592 (org-table-next-row)))))
9594 (defvar org-field-marker nil)
9596 (defun org-table-edit-field (arg)
9597 "Edit table field in a different window.
9598 This is mainly useful for fields that contain hidden parts.
9600 it can be edited in place."
9601 (interactive "P")
9602 (if arg
9603 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9605 (remove-text-properties b e '(org-cwidth t invisible t
9606 display t intangible t))
9607 (if (and (boundp 'font-lock-mode) font-lock-mode)
9608 (font-lock-fontify-block)))
9609 (let ((pos (move-marker (make-marker) (point)))
9610 (field (org-table-get-field))
9611 (cw (current-window-configuration))
9612 p)
9613 (org-switch-to-buffer-other-window "*Org tmp*")
9614 (erase-buffer)
9616 (let ((org-inhibit-startup t)) (org-mode))
9617 (goto-char (setq p (point-max)))
9618 (insert (org-trim field))
9619 (remove-text-properties p (point-max)
9620 '(invisible t org-cwidth t display t
9621 intangible t))
9622 (goto-char p)
9623 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9624 (org-set-local 'org-window-configuration cw)
9625 (org-set-local 'org-field-marker pos)
9626 (message "Edit and finish with C-c C-c"))))
9628 (defun org-table-finish-edit-field ()
9629 "Finish editing a table data field.
9630 Remove all newline characters, insert the result into the table, realign
9631 the table and kill the editing buffer."
9632 (let ((pos org-field-marker)
9633 (cw org-window-configuration)
9634 (cb (current-buffer))
9635 text)
9636 (goto-char (point-min))
9639 (replace-match " "))
9640 (setq text (org-trim (buffer-string)))
9641 (set-window-configuration cw)
9642 (kill-buffer cb)
9643 (select-window (get-buffer-window (marker-buffer pos)))
9644 (goto-char pos)
9645 (move-marker pos nil)
9646 (org-table-check-inside-data-field)
9647 (org-table-get-field nil text)
9648 (org-table-align)
9649 (message "New field value inserted")))
9651 (defun org-trim (s)
9652 "Remove whitespace at beginning and end of string."
9655 s)
9657 (defun org-wrap (string &optional width lines)
9658 "Wrap string to either a number of lines, or a width in characters.
9659 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9660 that costs. If there is a word longer than WIDTH, the text is actually
9661 wrapped to the length of that word.
9662 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9663 many lines, whatever width that takes.
9664 The return value is a list of lines, without newlines at the end."
9666 (maxword (apply 'max (mapcar 'org-string-width words)))
9667 w ll)
9668 (cond (width
9669 (org-do-wrap words (max maxword width)))
9670 (lines
9671 (setq w maxword)
9672 (setq ll (org-do-wrap words maxword))
9673 (if (<= (length ll) lines)
9674 ll
9675 (setq ll words)
9676 (while (> (length ll) lines)
9677 (setq w (1+ w))
9678 (setq ll (org-do-wrap words w)))
9679 ll))
9680 (t (error "Cannot wrap this")))))
9683 (defun org-do-wrap (words width)
9684 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9685 (let (lines line)
9686 (while words
9687 (setq line (pop words))
9688 (while (and words (< (+ (length line) (length (car words))) width))
9689 (setq line (concat line " " (pop words))))
9690 (setq lines (push line lines)))
9691 (nreverse lines)))
9693 (defun org-split-string (string &optional separators)
9694 "Splits STRING into substrings at SEPARATORS.
9695 No empty strings are returned if there are matches at the beginning
9696 and end of string."
9698 (start 0)
9699 notfirst
9700 (list nil))
9701 (while (and (string-match rexp string
9702 (if (and notfirst
9703 (= start (match-beginning 0))
9704 (< start (length string)))
9705 (1+ start) start))
9706 (< (match-beginning 0) (length string)))
9707 (setq notfirst t)
9708 (or (eq (match-beginning 0) 0)
9709 (and (eq (match-beginning 0) (match-end 0))
9710 (eq (match-beginning 0) start))
9711 (setq list
9712 (cons (substring string start (match-beginning 0))
9713 list)))
9714 (setq start (match-end 0)))
9715 (or (eq start (length string))
9716 (setq list
9717 (cons (substring string start)
9718 list)))
9719 (nreverse list)))
9721 (defun org-table-map-tables (function)
9722 "Apply FUNCTION to the start of all tables in the buffer."
9723 (save-excursion
9724 (save-restriction
9725 (widen)
9726 (goto-char (point-min))
9727 (while (re-search-forward org-table-any-line-regexp nil t)
9728 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9729 (beginning-of-line 1)
9730 (if (looking-at org-table-line-regexp)
9731 (save-excursion (funcall function)))
9732 (re-search-forward org-table-any-border-regexp nil 1))))
9733 (message "Mapping tables: done"))
9735 (defvar org-timecnt) ; dynamically scoped parameter
9737 (defun org-table-sum (&optional beg end nlast)
9738 "Sum numbers in region of current table column.
9739 The result will be displayed in the echo area, and will be available
9742 If there is an active region, it is interpreted as a rectangle and all
9743 numbers in that rectangle will be summed. If there is no active
9744 region and point is located in a table column, sum all numbers in that
9745 column.
9747 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9748 numbers are assumed to be times as well (in decimal hours) and the
9749 numbers are added as such.
9751 If NLAST is a number, only the NLAST fields will actually be summed."
9752 (interactive)
9753 (save-excursion
9754 (let (col (org-timecnt 0) diff h m s org-table-clip)
9755 (cond
9756 ((and beg end)) ; beg and end given explicitly
9757 ((org-region-active-p)
9758 (setq beg (region-beginning) end (region-end)))
9759 (t
9760 (setq col (org-table-current-column))
9761 (goto-char (org-table-begin))
9763 (error "No table data"))
9764 (org-table-goto-column col)
9765 (setq beg (point))
9766 (goto-char (org-table-end))
9768 (error "No table data"))
9769 (org-table-goto-column col)
9770 (setq end (point))))
9771 (let* ((items (apply 'append (org-table-copy-region beg end)))
9772 (items1 (cond ((not nlast) items)
9773 ((>= nlast (length items)) items)
9774 (t (setq items (reverse items))
9775 (setcdr (nthcdr (1- nlast) items) nil)
9776 (nreverse items))))
9777 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9778 items1)))
9779 (res (apply '+ numbers))
9780 (sres (if (= org-timecnt 0)
9781 (format "%g" res)
9782 (setq diff (* 3600 res)
9783 h (floor (/ diff 3600)) diff (mod diff 3600)
9784 m (floor (/ diff 60)) diff (mod diff 60)
9785 s diff)
9786 (format "%d:%02d:%02d" h m s))))
9787 (kill-new sres)
9788 (if (interactive-p)
9789 (message "%s"
9790 (substitute-command-keys
9792 (length numbers) sres))))
9793 sres))))
9795 (defun org-table-get-number-for-summing (s)
9796 (let (n)
9797 (if (string-match "^ *|? *" s)
9798 (setq s (replace-match "" nil nil s)))
9799 (if (string-match " *|? *$" s)
9800 (setq s (replace-match "" nil nil s)))
9801 (setq n (string-to-number s))
9802 (cond
9803 ((and (string-match "0" s)
9807 (let ((h (string-to-number (or (match-string 1 s) "0")))
9808 (m (string-to-number (or (match-string 2 s) "0")))
9809 (s (string-to-number (or (match-string 4 s) "0"))))
9810 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9811 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9812 ((equal n 0) nil)
9813 (t n))))
9815 (defun org-table-current-field-formula (&optional key noerror)
9816 "Return the formula active for the current field.
9817 Assumes that specials are in place.
9818 If KEY is given, return the key to this formula.
9820 (let* ((name (car (rassoc (list (org-current-line)
9821 (org-table-current-column))
9822 org-table-named-field-locations)))
9823 (col (org-table-current-column))
9824 (scol (int-to-string col))
9825 (ref (format "@%d$%d" (org-table-current-dline) col))
9826 (stored-list (org-table-get-stored-formulas noerror))
9827 (ass (or (assoc name stored-list)
9828 (assoc ref stored-list)
9829 (assoc scol stored-list))))
9830 (if key
9831 (car ass)
9832 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9833 (cdr ass))))))
9835 (defun org-table-get-formula (&optional equation named)
9836 "Read a formula from the minibuffer, offer stored formula as default.
9837 When NAMED is non-nil, look for a named equation."
9838 (let* ((stored-list (org-table-get-stored-formulas))
9839 (name (car (rassoc (list (org-current-line)
9840 (org-table-current-column))
9841 org-table-named-field-locations)))
9842 (ref (format "@%d$%d" (org-table-current-dline)
9843 (org-table-current-column)))
9844 (refass (assoc ref stored-list))
9845 (scol (if named
9846 (if name name ref)
9847 (int-to-string (org-table-current-column))))
9848 (dummy (and (or name refass) (not named)
9849 (not (y-or-n-p "Replace field formula with column formula? " ))
9850 (error "Abort")))
9851 (name (or name ref))
9852 (org-table-may-need-update nil)
9853 (stored (cdr (assoc scol stored-list)))
9854 (eq (cond
9855 ((and stored equation (string-match "^ *=? *$" equation))
9856 stored)
9857 ((stringp equation)
9858 equation)
9859 (t (org-table-formula-from-user
9860 (read-string
9861 (org-table-formula-to-user
9862 (format "%s formula %s%s="
9863 (if named "Field" "Column")
9864 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9865 scol))
9866 (if stored (org-table-formula-to-user stored) "")
9867 'org-table-formula-history
9868 )))))
9869 mustsave)
9871 ;; remove formula
9872 (setq stored-list (delq (assoc scol stored-list) stored-list))
9873 (org-table-store-formulas stored-list)
9874 (error "Formula removed"))
9875 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9876 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9877 (if (and name (not named))
9878 ;; We set the column equation, delete the named one.
9879 (setq stored-list (delq (assoc name stored-list) stored-list)
9880 mustsave t))
9881 (if stored
9882 (setcdr (assoc scol stored-list) eq)
9883 (setq stored-list (cons (cons scol eq) stored-list)))
9884 (if (or mustsave (not (equal stored eq)))
9885 (org-table-store-formulas stored-list))
9886 eq))
9888 (defun org-table-store-formulas (alist)
9889 "Store the list of formulas below the current table."
9890 (setq alist (sort alist 'org-table-formula-less-p))
9891 (save-excursion
9892 (goto-char (org-table-end))
9894 (progn
9895 ;; don't overwrite TBLFM, we might use text properties to store stuff
9896 (goto-char (match-beginning 2))
9897 (delete-region (match-beginning 2) (match-end 0)))
9898 (insert "#+TBLFM:"))
9899 (insert " "
9900 (mapconcat (lambda (x)
9901 (concat
9902 (if (equal (string-to-char (car x)) ?@) "" "$")
9903 (car x) "=" (cdr x)))
9904 alist "::")
9907 (defsubst org-table-formula-make-cmp-string (a)
9909 (concat
9910 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9911 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9912 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9914 (defun org-table-formula-less-p (a b)
9915 "Compare two formulas for sorting."
9916 (let ((as (org-table-formula-make-cmp-string (car a)))
9917 (bs (org-table-formula-make-cmp-string (car b))))
9918 (and as bs (string< as bs))))
9920 (defun org-table-get-stored-formulas (&optional noerror)
9921 "Return an alist with the stored formulas directly after current table."
9922 (interactive)
9923 (let (scol eq eq-alist strings string seen)
9924 (save-excursion
9925 (goto-char (org-table-end))
9927 (setq strings (org-split-string (match-string 2) " *:: *"))
9928 (while (setq string (pop strings))
9929 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9930 (setq scol (if (match-end 2)
9931 (match-string 2 string)
9932 (match-string 1 string))
9933 eq (match-string 3 string)
9934 eq-alist (cons (cons scol eq) eq-alist))
9935 (if (member scol seen)
9936 (if noerror
9937 (progn
9938 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9939 (ding)
9940 (sit-for 2))
9941 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9942 (push scol seen))))))
9943 (nreverse eq-alist)))
9945 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9946 "Modify the equations after the table structure has been edited.
9948 For all numbers larger than LIMIT, shift them by DELTA."
9949 (save-excursion
9950 (goto-char (org-table-end))
9953 (re2
9954 (when remove
9955 (if (equal key "$")
9958 s n a)
9959 (when remove
9960 (while (re-search-forward re2 (point-at-eol) t)
9961 (replace-match "")))
9962 (while (re-search-forward re (point-at-eol) t)
9963 (setq s (match-string 1) n (string-to-number s))
9964 (cond
9965 ((setq a (assoc s replace))
9966 (replace-match (concat key (cdr a)) t t))
9967 ((and limit (> n limit))
9968 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9970 (defun org-table-get-specials ()
9971 "Get the column names and local parameters for this table."
9972 (save-excursion
9973 (let ((beg (org-table-begin)) (end (org-table-end))
9974 names name fields fields1 field cnt
9975 c v l line col types dlines hlines)
9976 (setq org-table-column-names nil
9977 org-table-local-parameters nil
9978 org-table-named-field-locations nil
9979 org-table-current-begin-line nil
9980 org-table-current-begin-pos nil
9981 org-table-current-line-types nil)
9982 (goto-char beg)
9984 (setq names (org-split-string (match-string 1) " *| *")
9985 cnt 1)
9986 (while (setq name (pop names))
9987 (setq cnt (1+ cnt))
9988 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9989 (push (cons name (int-to-string cnt)) org-table-column-names))))
9990 (setq org-table-column-names (nreverse org-table-column-names))
9991 (setq org-table-column-name-regexp
9993 (goto-char beg)
9995 (setq fields (org-split-string (match-string 1) " *| *"))
9996 (while (setq field (pop fields))
9998 (push (cons (match-string 1 field) (match-string 2 field))
9999 org-table-local-parameters))))
10000 (goto-char beg)
10002 (setq c (match-string 1)
10003 fields (org-split-string (match-string 2) " *| *"))
10004 (save-excursion
10005 (beginning-of-line (if (equal c "_") 2 0))
10006 (setq line (org-current-line) col 1)
10008 (setq fields1 (org-split-string (match-string 1) " *| *"))))
10009 (while (and fields1 (setq field (pop fields)))
10010 (setq v (pop fields1) col (1+ col))
10011 (when (and (stringp field) (stringp v)
10012 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
10013 (push (cons field v) org-table-local-parameters)
10014 (push (list field line col) org-table-named-field-locations))))
10015 ;; Analyse the line types
10016 (goto-char beg)
10017 (setq org-table-current-begin-line (org-current-line)
10018 org-table-current-begin-pos (point)
10019 l org-table-current-begin-line)
10021 (push (if (match-end 1) 'hline 'dline) types)
10022 (if (match-end 1) (push l hlines) (push l dlines))
10023 (beginning-of-line 2)
10024 (setq l (1+ l)))
10025 (setq org-table-current-line-types (apply 'vector (nreverse types))
10026 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
10027 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
10029 (defun org-table-maybe-eval-formula ()
10031 If yes, store the formula and apply it."
10032 ;; We already know we are in a table. Get field will only return a formula
10033 ;; when appropriate. It might return a separator line, but no problem.
10034 (when org-table-formula-evaluate-inline
10035 (let* ((field (org-trim (or (org-table-get-field) "")))
10036 named eq)
10038 (setq named (equal (string-to-char field) ?:)
10039 eq (match-string 1 field))
10040 (if (or (fboundp 'calc-eval)
10041 (equal (substring eq 0 (min 2 (length eq))) "'("))
10042 (org-table-eval-formula (if named '(4) nil)
10043 (org-table-formula-from-user eq))
10044 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
10046 (defvar org-recalc-commands nil
10047 "List of commands triggering the recalculation of a line.
10048 Will be filled automatically during use.")
10050 (defvar org-recalc-marks
10051 '((" " . "Unmarked: no special line, no automatic recalculation")
10052 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10053 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10054 ("!" . "Column name definition line. Reference in formula as $name.")
10055 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10056 ("_" . "Names for values in row below this one.")
10057 ("^" . "Names for values in row above this one.")))
10059 (defun org-table-rotate-recalc-marks (&optional newchar)
10060 "Rotate the recalculation mark in the first column.
10061 If in any row, the first field is not consistent with a mark,
10062 insert a new column for the markers.
10063 When there is an active region, change all the lines in the region,
10064 after prompting for the marking character.
10065 After each change, a message will be displayed indicating the meaning
10066 of the new mark."
10067 (interactive)
10068 (unless (org-at-table-p) (error "Not at a table"))
10069 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10070 (beg (org-table-begin))
10071 (end (org-table-end))
10072 (l (org-current-line))
10073 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10074 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10075 (have-col
10076 (save-excursion
10077 (goto-char beg)
10079 (col (org-table-current-column))
10080 (forcenew (car (assoc newchar org-recalc-marks)))
10081 epos new)
10082 (when l1
10083 (message "Change region to what mark? Type # * ! $ or SPC: ")
10084 (setq newchar (char-to-string (read-char-exclusive))
10085 forcenew (car (assoc newchar org-recalc-marks))))
10086 (if (and newchar (not forcenew))
10087 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10088 newchar))
10089 (if l1 (goto-line l1))
10090 (save-excursion
10091 (beginning-of-line 1)
10092 (unless (looking-at org-table-dataline-regexp)
10093 (error "Not at a table data line")))
10094 (unless have-col
10095 (org-table-goto-column 1)
10096 (org-table-insert-column)
10097 (org-table-goto-column (1+ col)))
10098 (setq epos (point-at-eol))
10099 (save-excursion
10100 (beginning-of-line 1)
10101 (org-table-get-field
10103 (concat " "
10104 (setq new (or forcenew
10105 (cadr (member (match-string 1) marks))))
10106 " ")
10107 " # ")))
10108 (if (and l1 l2)
10109 (progn
10110 (goto-line l1)
10111 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10112 (and (looking-at org-table-dataline-regexp)
10113 (org-table-get-field 1 (concat " " new " "))))
10114 (goto-line l1)))
10115 (if (not (= epos (point-at-eol))) (org-table-align))
10116 (goto-line l)
10117 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10119 (defun org-table-maybe-recalculate-line ()
10120 "Recompute the current line if marked for it, and if we haven't just done it."
10121 (interactive)
10122 (and org-table-allow-automatic-line-recalculation
10123 (not (and (memq last-command org-recalc-commands)
10124 (equal org-last-recalc-line (org-current-line))))
10125 (save-excursion (beginning-of-line 1)
10126 (looking-at org-table-auto-recalculate-regexp))
10127 (org-table-recalculate) t))
10129 (defvar org-table-formula-debug nil
10130 "Non-nil means, debug table formulas.
10132 (make-variable-buffer-local 'org-table-formula-debug)
10134 (defvar modes)
10135 (defsubst org-set-calc-mode (var &optional value)
10136 (if (stringp var)
10137 (setq var (assoc var '(("D" calc-angle-mode deg)
10138 ("R" calc-angle-mode rad)
10139 ("F" calc-prefer-frac t)
10140 ("S" calc-symbolic-mode t)))
10141 value (nth 2 var) var (nth 1 var)))
10142 (if (memq var modes)
10143 (setcar (cdr (memq var modes)) value)
10144 (cons var (cons value modes)))
10145 modes)
10147 (defun org-table-eval-formula (&optional arg equation
10148 suppress-align suppress-const
10149 suppress-store suppress-analysis)
10150 "Replace the table field value at the cursor by the result of a calculation.
10152 This function makes use of Dave Gillespie's Calc package, in my view the
10153 most exciting program ever written for GNU Emacs. So you need to have Calc
10154 installed in order to use this function.
10156 In a table, this command replaces the value in the current field with the
10158 formula, by storing it in a special line below the table. When called
10159 with a `C-u' prefix, the current field must ba a named field, and the
10160 formula is installed as valid in only this specific field.
10162 When called with two `C-u' prefixes, insert the active equation
10163 for the field back into the current field, so that it can be
10165 to check the referenced fields.
10167 When called, the command first prompts for a formula, which is read in
10168 the minibuffer. Previously entered formulas are available through the
10169 history list, and the last used formula is offered as a default.
10170 These stored formulas are adapted correctly when moving, inserting, or
10171 deleting columns with the corresponding commands.
10173 The formula can be any algebraic expression understood by the Calc package.
10174 For details, see the Org-mode manual.
10176 This function can also be called from Lisp programs and offers
10177 additional arguments: EQUATION can be the formula to apply. If this
10178 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10179 used to speed-up recursive calls by by-passing unnecessary aligns.
10180 SUPPRESS-CONST suppresses the interpretation of constants in the
10181 formula, assuming that this has been done already outside the function.
10182 SUPPRESS-STORE means the formula should not be stored, either because
10183 it is already stored, or because it is a modified equation that should
10184 not overwrite the stored one."
10185 (interactive "P")
10186 (org-table-check-inside-data-field)
10187 (or suppress-analysis (org-table-get-specials))
10188 (if (equal arg '(16))
10189 (let ((eq (org-table-current-field-formula)))
10190 (or eq (error "No equation active for current field"))
10191 (org-table-get-field nil eq)
10192 (org-table-align)
10193 (setq org-table-may-need-update t))
10194 (let* (fields
10195 (ndown (if (integerp arg) arg 1))
10196 (org-table-automatic-realign nil)
10197 (case-fold-search nil)
10198 (down (> ndown 1))
10199 (formula (if (and equation suppress-store)
10200 equation
10201 (org-table-get-formula equation (equal arg '(4)))))
10202 (n0 (org-table-current-column))
10203 (modes (copy-sequence org-calc-default-modes))
10204 (numbers nil) ; was a variable, now fixed default
10205 (keep-empty nil)
10206 n form form0 bw fmt x ev orig c lispp literal)
10207 ;; Parse the format string. Since we have a lot of modes, this is
10208 ;; a lot of work. However, I think calc still uses most of the time.
10209 (if (string-match ";" formula)
10210 (let ((tmp (org-split-string formula ";")))
10211 (setq formula (car tmp)
10212 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10213 (nth 1 tmp)))
10215 (setq c (string-to-char (match-string 1 fmt))
10216 n (string-to-number (match-string 2 fmt)))
10217 (if (= c ?p)
10218 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10219 (setq modes (org-set-calc-mode
10220 'calc-float-format
10221 (list (cdr (assoc c '((?n . float) (?f . fix)
10222 (?s . sci) (?e . eng))))
10223 n))))
10224 (setq fmt (replace-match "" t t fmt)))
10225 (if (string-match "[NT]" fmt)
10226 (setq numbers (equal (match-string 0 fmt) "N")
10227 fmt (replace-match "" t t fmt)))
10228 (if (string-match "L" fmt)
10229 (setq literal t
10230 fmt (replace-match "" t t fmt)))
10231 (if (string-match "E" fmt)
10232 (setq keep-empty t
10233 fmt (replace-match "" t t fmt)))
10234 (while (string-match "[DRFS]" fmt)
10235 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10236 (setq fmt (replace-match "" t t fmt)))
10238 (setq fmt nil))))
10239 (if (and (not suppress-const) org-table-formula-use-constants)
10240 (setq formula (org-table-formula-substitute-names formula)))
10241 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10242 (while (> ndown 0)
10243 (setq fields (org-split-string
10244 (org-no-properties
10245 (buffer-substring (point-at-bol) (point-at-eol)))
10246 " *| *"))
10247 (if (eq numbers t)
10248 (setq fields (mapcar
10249 (lambda (x) (number-to-string (string-to-number x)))
10250 fields)))
10251 (setq ndown (1- ndown))
10252 (setq form (copy-sequence formula)
10253 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10254 (if (and lispp literal) (setq lispp 'literal))
10255 ;; Check for old vertical references
10256 (setq form (org-rewrite-old-row-references form))
10257 ;; Insert complex ranges
10258 (while (string-match org-table-range-regexp form)
10259 (setq form
10260 (replace-match
10261 (save-match-data
10262 (org-table-make-reference
10263 (org-table-get-range (match-string 0 form) nil n0)
10264 keep-empty numbers lispp))
10265 t t form)))
10266 ;; Insert simple ranges
10268 (setq form
10269 (replace-match
10270 (save-match-data
10271 (org-table-make-reference
10272 (org-sublist
10273 fields (string-to-number (match-string 1 form))
10274 (string-to-number (match-string 2 form)))
10275 keep-empty numbers lispp))
10276 t t form)))
10277 (setq form0 form)
10278 ;; Insert the references to fields in same row
10280 (setq n (string-to-number (match-string 1 form))
10281 x (nth (1- (if (= n 0) n0 n)) fields))
10283 (match-string 0 form)))
10284 (setq form (replace-match
10285 (save-match-data
10286 (org-table-make-reference x nil numbers lispp))
10287 t t form)))
10289 (if lispp
10290 (setq ev (condition-case nil
10291 (eval (eval (read form)))
10292 (error "#ERROR"))
10293 ev (if (numberp ev) (number-to-string ev) ev))
10294 (or (fboundp 'calc-eval)
10295 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10296 (setq ev (calc-eval (cons form modes)
10297 (if numbers 'num))))
10299 (when org-table-formula-debug
10300 (with-output-to-temp-buffer "*Substitution History*"
10301 (princ (format "Substitution history of formula
10302 Orig: %s
10303 $xyz-> %s
10304 @r$c-> %s
10306 (if (listp ev)
10308 (make-string (car ev) ?\-) (nth 1 ev)))
10310 ev (or fmt "NONE")
10311 (if fmt (format fmt (string-to-number ev)) ev)))))
10312 (setq bw (get-buffer-window "*Substitution History*"))
10313 (shrink-window-if-larger-than-buffer bw)
10314 (unless (and (interactive-p) (not ndown))
10315 (unless (let (inhibit-redisplay)
10316 (y-or-n-p "Debugging Formula. Continue to next? "))
10317 (org-table-align)
10318 (error "Abort"))
10319 (delete-window bw)
10320 (message "")))
10321 (if (listp ev) (setq fmt nil ev "#ERROR"))
10322 (org-table-justify-field-maybe
10323 (if fmt (format fmt (string-to-number ev)) ev))
10325 (call-interactively 'org-return)
10326 (setq ndown 0)))
10327 (and down (org-table-maybe-recalculate-line))
10328 (or suppress-align (and org-table-may-need-update
10329 (org-table-align))))))
10331 (defun org-table-put-field-property (prop value)
10332 (save-excursion
10333 (put-text-property (progn (skip-chars-backward "^|") (point))
10334 (progn (skip-chars-forward "^|") (point))
10335 prop value)))
10337 (defun org-table-get-range (desc &optional tbeg col highlight)
10338 "Get a calc vector from a column, accorting to descriptor DESC.
10339 Optional arguments TBEG and COL can give the beginning of the table and
10340 the current column, to avoid unnecessary parsing.
10341 HIGHLIGHT means, just highlight the range."
10342 (if (not (equal (string-to-char desc) ?@))
10343 (setq desc (concat "@" desc)))
10344 (save-excursion
10345 (or tbeg (setq tbeg (org-table-begin)))
10346 (or col (setq col (org-table-current-column)))
10347 (let ((thisline (org-current-line))
10348 beg end c1 c2 r1 r2 rangep tmp)
10349 (unless (string-match org-table-range-regexp desc)
10350 (error "Invalid table range specifier `%s'" desc))
10351 (setq rangep (match-end 3)
10352 r1 (and (match-end 1) (match-string 1 desc))
10353 r2 (and (match-end 4) (match-string 4 desc))
10354 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10355 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10357 (and c1 (setq c1 (+ (string-to-number c1)
10358 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10359 (and c2 (setq c2 (+ (string-to-number c2)
10360 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10361 (if (equal r1 "") (setq r1 nil))
10362 (if (equal r2 "") (setq r2 nil))
10363 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10364 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10365 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10366 (if (not r1) (setq r1 thisline))
10367 (if (not r2) (setq r2 thisline))
10368 (if (not c1) (setq c1 col))
10369 (if (not c2) (setq c2 col))
10370 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10371 ;; just one field
10372 (progn
10373 (goto-line r1)
10374 (while (not (looking-at org-table-dataline-regexp))
10375 (beginning-of-line 2))
10376 (prog1 (org-trim (org-table-get-field c1))
10377 (if highlight (org-table-highlight-rectangle (point) (point)))))
10378 ;; A range, return a vector
10379 ;; First sort the numbers to get a regular ractangle
10380 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10381 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10382 (goto-line r1)
10383 (while (not (looking-at org-table-dataline-regexp))
10384 (beginning-of-line 2))
10385 (org-table-goto-column c1)
10386 (setq beg (point))
10387 (goto-line r2)
10388 (while (not (looking-at org-table-dataline-regexp))
10389 (beginning-of-line 0))
10390 (org-table-goto-column c2)
10391 (setq end (point))
10392 (if highlight
10393 (org-table-highlight-rectangle
10395 ;; return string representation of calc vector
10396 (mapcar 'org-trim
10397 (apply 'append (org-table-copy-region beg end)))))))
10399 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10400 "Analyze descriptor DESC and retrieve the corresponding line number.
10401 The cursor is currently in line CLINE, the table begins in line BLINE,
10402 and TABLE is a vector with line types."
10403 (if (string-match "^[0-9]+$" desc)
10404 (aref org-table-dlines (string-to-number desc))
10405 (setq cline (or cline (org-current-line))
10406 bline (or bline org-table-current-begin-line)
10407 table (or table org-table-current-line-types))
10408 (if (or
10410 ;; 1 2 3 4 5 6
10411 (and (not (match-end 3)) (not (match-end 6)))
10412 (and (match-end 3) (match-end 6) (not (match-end 5))))
10413 (error "invalid row descriptor `%s'" desc))
10414 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10415 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10416 (odir (and (match-end 5) (match-string 5 desc)))
10417 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10418 (i (- cline bline))
10419 (rel (and (match-end 6)
10420 (or (and (match-end 1) (not (match-end 3)))
10421 (match-end 5)))))
10422 (if (and hn (not hdir))
10423 (progn
10424 (setq i 0 hdir "+")
10425 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10426 (if (and (not hn) on (not odir))
10427 (error "should never happen");;(aref org-table-dlines on)
10428 (if (and hn (> hn 0))
10429 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10430 (if on
10431 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10432 (+ bline i)))))
10434 (defun org-find-row-type (table i type backwards relative n)
10435 (let ((l (length table)))
10436 (while (> n 0)
10437 (while (and (setq i (+ i (if backwards -1 1)))
10438 (>= i 0) (< i l)
10439 (not (eq (aref table i) type))
10440 (if (and relative (eq (aref table i) 'hline))
10441 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10442 t)))
10443 (setq n (1- n)))
10444 (if (or (< i 0) (>= i l))
10445 (error "Row descriptior leads outside table")
10446 i)))
10448 (defun org-rewrite-old-row-references (s)
10449 (if (string-match "&[-+0-9I]" s)
10450 (error "Formula contains old &row reference, please rewrite using @-syntax")
10451 s))
10453 (defun org-table-make-reference (elements keep-empty numbers lispp)
10454 "Convert list ELEMENTS to something appropriate to insert into formula.
10455 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10456 NUMBERS indicates that everything should be converted to numbers.
10457 LISPP means to return something appropriate for a Lisp list."
10458 (if (stringp elements) ; just a single val
10459 (if lispp
10460 (if (eq lispp 'literal)
10461 elements
10462 (prin1-to-string (if numbers (string-to-number elements) elements)))
10463 (if (equal elements "") (setq elements "0"))
10464 (if numbers (number-to-string (string-to-number elements)) elements))
10465 (unless keep-empty
10466 (setq elements
10467 (delq nil
10469 elements))))
10470 (setq elements (or elements '("0")))
10471 (if lispp
10472 (mapconcat
10473 (lambda (x)
10474 (if (eq lispp 'literal)
10475 x
10476 (prin1-to-string (if numbers (string-to-number x) x))))
10477 elements " ")
10478 (concat "[" (mapconcat
10479 (lambda (x)
10480 (if numbers (number-to-string (string-to-number x)) x))
10481 elements
10482 ",") "]"))))
10484 (defun org-table-recalculate (&optional all noalign)
10485 "Recalculate the current table line by applying all stored formulas.
10486 With prefix arg ALL, do this for all lines in the table."
10487 (interactive "P")
10488 (or (memq this-command org-recalc-commands)
10489 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10490 (unless (org-at-table-p) (error "Not at a table"))
10491 (if (equal all '(16))
10492 (org-table-iterate)
10493 (org-table-get-specials)
10494 (let* ((eqlist (sort (org-table-get-stored-formulas)
10495 (lambda (a b) (string< (car a) (car b)))))
10496 (inhibit-redisplay (not debug-on-error))
10497 (line-re org-table-dataline-regexp)
10498 (thisline (org-current-line))
10499 (thiscol (org-table-current-column))
10500 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10501 ;; Insert constants in all formulas
10502 (setq eqlist
10503 (mapcar (lambda (x)
10504 (setcdr x (org-table-formula-substitute-names (cdr x)))
10505 x)
10506 eqlist))
10507 ;; Split the equation list
10508 (while (setq eq (pop eqlist))
10509 (if (<= (string-to-char (car eq)) ?9)
10510 (push eq eqlnum)
10511 (push eq eqlname)))
10512 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10513 (if all
10514 (progn
10515 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10516 (goto-char (setq beg (org-table-begin)))
10517 (if (re-search-forward org-table-calculate-mark-regexp end t)
10518 ;; This is a table with marked lines, compute selected lines
10519 (setq line-re org-table-recalculate-regexp)
10520 ;; Move forward to the first non-header line
10521 (if (and (re-search-forward org-table-dataline-regexp end t)
10522 (re-search-forward org-table-hline-regexp end t)
10523 (re-search-forward org-table-dataline-regexp end t))
10524 (setq beg (match-beginning 0))
10525 nil))) ;; just leave beg where it is
10526 (setq beg (point-at-bol)
10527 end (move-marker (make-marker) (1+ (point-at-eol)))))
10528 (goto-char beg)
10529 (and all (message "Re-applying formulas to full table..."))
10531 ;; First find the named fields, and mark them untouchanble
10532 (remove-text-properties beg end '(org-untouchable t))
10533 (while (setq eq (pop eqlname))
10534 (setq name (car eq)
10535 a (assoc name org-table-named-field-locations))
10536 (and (not a)
10538 (setq a (list name
10539 (aref org-table-dlines
10540 (string-to-number (match-string 1 name)))
10541 (string-to-number (match-string 2 name)))))
10542 (when (and a (or all (equal (nth 1 a) thisline)))
10543 (message "Re-applying formula to field: %s" name)
10544 (goto-line (nth 1 a))
10545 (org-table-goto-column (nth 2 a))
10546 (push (append a (list (cdr eq))) eqlname1)
10547 (org-table-put-field-property :org-untouchable t)))
10549 ;; Now evauluate the column formulas, but skip fields covered by
10550 ;; field formulas
10551 (goto-char beg)
10552 (while (re-search-forward line-re end t)
10553 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10554 ;; Unprotected line, recalculate
10555 (and all (message "Re-applying formulas to full table...(line %d)"
10556 (setq cnt (1+ cnt))))
10557 (setq org-last-recalc-line (org-current-line))
10558 (setq eql eqlnum)
10559 (while (setq entry (pop eql))
10560 (goto-line org-last-recalc-line)
10561 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10562 (unless (get-text-property (point) :org-untouchable)
10563 (org-table-eval-formula nil (cdr entry)
10564 'noalign 'nocst 'nostore 'noanalysis)))))
10566 ;; Now evaluate the field formulas
10567 (while (setq eq (pop eqlname1))
10568 (message "Re-applying formula to field: %s" (car eq))
10569 (goto-line (nth 1 eq))
10570 (org-table-goto-column (nth 2 eq))
10571 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10572 'nostore 'noanalysis))
10574 (goto-line thisline)
10575 (org-table-goto-column thiscol)
10576 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10577 (or noalign (and org-table-may-need-update (org-table-align))
10578 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10580 ;; back to initial position
10581 (message "Re-applying formulas...done")
10582 (goto-line thisline)
10583 (org-table-goto-column thiscol)
10584 (or noalign (and org-table-may-need-update (org-table-align))
10585 (and all (message "Re-applying formulas...done"))))))
10587 (defun org-table-iterate (&optional arg)
10588 "Recalculate the table until it does not change anymore."
10589 (interactive "P")
10590 (let ((imax (if arg (prefix-numeric-value arg) 10))
10591 (i 0)
10592 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10593 thistbl)
10594 (catch 'exit
10595 (while (< i imax)
10596 (setq i (1+ i))
10597 (org-table-recalculate 'all)
10598 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10599 (if (not (string= lasttbl thistbl))
10600 (setq lasttbl thistbl)
10601 (if (> i 1)
10602 (message "Convergence after %d iterations" i)
10603 (message "Table was already stable"))
10604 (throw 'exit t)))
10605 (error "No convergence after %d iterations" i))))
10607 (defun org-table-formula-substitute-names (f)
10608 "Replace $const with values in string F."
10609 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10610 ;; First, check for column names
10611 (while (setq start (string-match org-table-column-name-regexp f start))
10612 (setq start (1+ start))
10613 (setq a (assoc (match-string 1 f) org-table-column-names))
10614 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10615 ;; Parameters and constants
10616 (setq start 0)
10618 (setq start (1+ start))
10619 (if (setq a (save-match-data
10620 (org-table-get-constant (match-string 1 f))))
10621 (setq f (replace-match
10622 (concat (if pp "(") a (if pp ")")) t t f))))
10623 (if org-table-formula-debug
10624 (put-text-property 0 (length f) :orig-formula f1 f))
10625 f))
10627 (defun org-table-get-constant (const)
10628 "Find the value for a parameter or constant in a formula.
10629 Parameters get priority."
10630 (or (cdr (assoc const org-table-local-parameters))
10631 (cdr (assoc const org-table-formula-constants-local))
10632 (cdr (assoc const org-table-formula-constants))
10633 (and (fboundp 'constants-get) (constants-get const))
10634 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10635 (org-entry-get nil (substring const 5) 'inherit))
10636 "#UNDEFINED_NAME"))
10638 (defvar org-table-fedit-map
10639 (let ((map (make-sparse-keymap)))
10640 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10641 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10642 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10643 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10644 (org-defkey map "\C-c?" 'org-table-show-reference)
10645 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10646 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10647 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10648 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10649 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10650 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10651 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10652 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10653 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10654 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10655 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10656 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10657 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10658 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10659 map))
10661 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10662 '("Edit-Formulas"
10663 ["Finish and Install" org-table-fedit-finish t]
10664 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10665 ["Abort" org-table-fedit-abort t]
10666 "--"
10667 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10668 ["Complete Lisp Symbol" lisp-complete-symbol t]
10669 "--"
10670 "Shift Reference at Point"
10671 ["Up" org-table-fedit-ref-up t]
10672 ["Down" org-table-fedit-ref-down t]
10673 ["Left" org-table-fedit-ref-left t]
10674 ["Right" org-table-fedit-ref-right t]
10675 "-"
10676 "Change Test Row for Column Formulas"
10677 ["Up" org-table-fedit-line-up t]
10678 ["Down" org-table-fedit-line-down t]
10679 "--"
10680 ["Scroll Table Window" org-table-fedit-scroll t]
10681 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10682 ["Show Table Grid" org-table-fedit-toggle-coordinates
10683 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10684 org-table-overlay-coordinates)]
10685 "--"
10686 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10687 :style toggle :selected org-table-buffer-is-an]))
10689 (defvar org-pos)
10691 (defun org-table-edit-formulas ()
10692 "Edit the formulas of the current table in a separate buffer."
10693 (interactive)
10695 (beginning-of-line 0))
10696 (unless (org-at-table-p) (error "Not at a table"))
10697 (org-table-get-specials)
10698 (let ((key (org-table-current-field-formula 'key 'noerror))
10699 (eql (sort (org-table-get-stored-formulas 'noerror)
10700 'org-table-formula-less-p))
10701 (pos (move-marker (make-marker) (point)))
10702 (startline 1)
10703 (wc (current-window-configuration))
10707 entry s type title)
10708 (org-switch-to-buffer-other-window "*Edit Formulas*")
10709 (erase-buffer)
10710 ;; Keep global-font-lock-mode from turning on font-lock-mode
10711 (let ((font-lock-global-modes '(not fundamental-mode)))
10712 (fundamental-mode))
10713 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10714 (org-set-local 'org-pos pos)
10715 (org-set-local 'org-window-configuration wc)
10716 (use-local-map org-table-fedit-map)
10717 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10718 (easy-menu-add org-table-fedit-menu)
10719 (setq startline (org-current-line))
10720 (while (setq entry (pop eql))
10721 (setq type (cond
10722 ((equal (string-to-char (car entry)) ?@) 'field)
10723 ((string-match "^[0-9]" (car entry)) 'column)
10724 (t 'named)))
10725 (when (setq title (assq type titles))
10727 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10728 (setq titles (delq title titles)))
10729 (if (equal key (car entry)) (setq startline (org-current-line)))
10730 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10732 (remove-text-properties 0 (length s) '(face nil) s)
10733 (insert s))
10734 (if (eq org-table-use-standard-references t)
10735 (org-table-fedit-toggle-ref-type))
10736 (goto-line startline)
10737 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10739 (defun org-table-fedit-post-command ()
10740 (when (not (memq this-command '(lisp-complete-symbol)))
10741 (let ((win (selected-window)))
10742 (save-excursion
10743 (condition-case nil
10744 (org-table-show-reference)
10745 (error nil))
10746 (select-window win)))))
10748 (defun org-table-formula-to-user (s)
10749 "Convert a formula from internal to user representation."
10750 (if (eq org-table-use-standard-references t)
10751 (org-table-convert-refs-to-an s)
10752 s))
10754 (defun org-table-formula-from-user (s)
10755 "Convert a formula from user to internal representation."
10756 (if org-table-use-standard-references
10757 (org-table-convert-refs-to-rc s)
10758 s))
10760 (defun org-table-convert-refs-to-rc (s)
10761 "Convert spreadsheet references from AB7 to @7$28.
10762 Works for single references, but also for entire formulas and even the
10763 full TBLFM line."
10764 (let ((start 0))
10766 (cond
10767 ((match-end 3)
10768 ;; format match, just advance
10769 (setq start (match-end 0)))
10770 ((and (> (match-beginning 0) 0)
10771 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10772 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10773 ;; 3.e5 or something like this.
10774 (setq start (match-end 0)))
10775 (t
10776 (setq start (match-beginning 0)
10777 s (replace-match
10778 (if (equal (match-string 2 s) "&")
10779 (format "$%d" (org-letters-to-number (match-string 1 s)))
10780 (format "@%d$%d"
10781 (string-to-number (match-string 2 s))
10782 (org-letters-to-number (match-string 1 s))))
10783 t t s)))))
10784 s))
10786 (defun org-table-convert-refs-to-an (s)
10787 "Convert spreadsheet references from to @7$28 to AB7.
10788 Works for single references, but also for entire formulas and even the
10789 full TBLFM line."
10791 (setq s (replace-match
10792 (format "%s%d"
10793 (org-number-to-letters
10794 (string-to-number (match-string 2 s)))
10795 (string-to-number (match-string 1 s)))
10796 t t s)))
10799 (org-number-to-letters
10800 (string-to-number (match-string 2 s))) "&")
10801 t nil s)))
10802 s)
10804 (defun org-letters-to-number (s)
10805 "Convert a base 26 number represented by letters into an integer.
10806 For example: AB -> 28."
10807 (let ((n 0))
10808 (setq s (upcase s))
10809 (while (> (length s) 0)
10810 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10811 s (substring s 1)))
10812 n))
10814 (defun org-number-to-letters (n)
10815 "Convert an integer into a base 26 number represented by letters.
10816 For example: 28 -> AB."
10817 (let ((s ""))
10818 (while (> n 0)
10819 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10820 n (/ (1- n) 26)))
10821 s))
10823 (defun org-table-fedit-convert-buffer (function)
10824 "Convert all references in this buffer, using FUNTION."
10825 (let ((line (org-current-line)))
10826 (goto-char (point-min))
10827 (while (not (eobp))
10828 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10829 (delete-region (point) (point-at-eol))
10830 (or (eobp) (forward-char 1)))
10831 (goto-line line)))
10833 (defun org-table-fedit-toggle-ref-type ()
10834 "Convert all references in the buffer from B3 to @3$2 and back."
10835 (interactive)
10836 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10837 (org-table-fedit-convert-buffer
10838 (if org-table-buffer-is-an
10839 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10840 (message "Reference type switched to %s"
10841 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10843 (defun org-table-fedit-ref-up ()
10844 "Shift the reference at point one row/hline up."
10845 (interactive)
10846 (org-table-fedit-shift-reference 'up))
10847 (defun org-table-fedit-ref-down ()
10848 "Shift the reference at point one row/hline down."
10849 (interactive)
10850 (org-table-fedit-shift-reference 'down))
10851 (defun org-table-fedit-ref-left ()
10852 "Shift the reference at point one field to the left."
10853 (interactive)
10854 (org-table-fedit-shift-reference 'left))
10855 (defun org-table-fedit-ref-right ()
10856 "Shift the reference at point one field to the right."
10857 (interactive)
10858 (org-table-fedit-shift-reference 'right))
10860 (defun org-table-fedit-shift-reference (dir)
10861 (cond
10863 (if (memq dir '(left right))
10864 (org-rematch-and-replace 1 (eq dir 'left))
10865 (error "Cannot shift reference in this direction")))
10867 ;; A B3-like reference
10868 (if (memq dir '(up down))
10869 (org-rematch-and-replace 2 (eq dir 'up))
10870 (org-rematch-and-replace 1 (eq dir 'left))))
10871 ((org-at-regexp-p
10873 ;; An internal reference
10874 (if (memq dir '(up down))
10875 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10876 (org-rematch-and-replace 5 (eq dir 'left))))))
10878 (defun org-rematch-and-replace (n &optional decr hline)
10879 "Re-match the group N, and replace it with the shifted refrence."
10880 (or (match-end n) (error "Cannot shift reference in this direction"))
10881 (goto-char (match-beginning n))
10882 (and (looking-at (regexp-quote (match-string n)))
10883 (replace-match (org-shift-refpart (match-string 0) decr hline)
10884 t t)))
10886 (defun org-shift-refpart (ref &optional decr hline)
10887 "Shift a refrence part REF.
10888 If DECR is set, decrease the references row/column, else increase.
10889 If HLINE is set, this may be a hline reference, it certainly is not
10890 a translation reference."
10891 (save-match-data
10892 (let* ((sign (string-match "^[-+]" ref)) n)
10894 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10895 (cond
10896 ((and hline (string-match "^I+" ref))
10897 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10898 (setq n (+ n (if decr -1 1)))
10899 (if (= n 0) (setq n (+ n (if decr -1 1))))
10900 (if sign
10901 (setq sign (if (< n 0) "-" "+") n (abs n))
10902 (setq n (max 1 n)))
10903 (concat sign (make-string n ?I)))
10905 ((string-match "^[0-9]+" ref)
10906 (setq n (string-to-number (concat sign ref)))
10907 (setq n (+ n (if decr -1 1)))
10908 (if sign
10909 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10910 (number-to-string (max 1 n))))
10912 ((string-match "^[a-zA-Z]+" ref)
10913 (org-number-to-letters
10914 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10916 (t (error "Cannot shift reference"))))))
10918 (defun org-table-fedit-toggle-coordinates ()
10919 "Toggle the display of coordinates in the refrenced table."
10920 (interactive)
10921 (let ((pos (marker-position org-pos)))
10922 (with-current-buffer (marker-buffer org-pos)
10923 (save-excursion
10924 (goto-char pos)
10925 (org-table-toggle-coordinate-overlays)))))
10927 (defun org-table-fedit-finish (&optional arg)
10928 "Parse the buffer for formula definitions and install them.
10929 With prefix ARG, apply the new formulas to the table."
10930 (interactive "P")
10931 (org-table-remove-rectangle-highlight)
10932 (if org-table-use-standard-references
10933 (progn
10934 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10935 (setq org-table-buffer-is-an nil)))
10936 (let ((pos org-pos) eql var form)
10937 (goto-char (point-min))
10938 (while (re-search-forward
10940 nil t)
10941 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10942 form (match-string 3))
10943 (setq form (org-trim form))
10944 (when (not (equal form ""))
10946 (setq form (replace-match " " t t form)))
10947 (when (assoc var eql)
10948 (error "Double formulas for %s" var))
10949 (push (cons var form) eql)))
10950 (setq org-pos nil)
10951 (set-window-configuration org-window-configuration)
10952 (select-window (get-buffer-window (marker-buffer pos)))
10953 (goto-char pos)
10954 (unless (org-at-table-p)
10955 (error "Lost table position - cannot install formulae"))
10956 (org-table-store-formulas eql)
10957 (move-marker pos nil)
10958 (kill-buffer "*Edit Formulas*")
10959 (if arg
10960 (org-table-recalculate 'all)
10961 (message "New formulas installed - press C-u C-c C-c to apply."))))
10963 (defun org-table-fedit-abort ()
10964 "Abort editing formulas, without installing the changes."
10965 (interactive)
10966 (org-table-remove-rectangle-highlight)
10967 (let ((pos org-pos))
10968 (set-window-configuration org-window-configuration)
10969 (select-window (get-buffer-window (marker-buffer pos)))
10970 (goto-char pos)
10971 (move-marker pos nil)
10972 (message "Formula editing aborted without installing changes")))
10974 (defun org-table-fedit-lisp-indent ()
10975 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10976 (interactive)
10977 (let ((pos (point)) beg end ind)
10978 (beginning-of-line 1)
10979 (cond
10981 (goto-char pos)
10982 (call-interactively 'lisp-indent-line))
10984 ((not (fboundp 'pp-buffer))
10985 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10986 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10987 (goto-char (- (match-end 0) 2))
10988 (setq beg (point))
10989 (setq ind (make-string (current-column) ?\ ))
10990 (condition-case nil (forward-sexp 1)
10991 (error
10992 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10993 (setq end (point))
10994 (save-restriction
10995 (narrow-to-region beg end)
10996 (if (eq last-command this-command)
10997 (progn
10998 (goto-char (point-min))
10999 (setq this-command nil)
11001 (replace-match " ")))
11002 (pp-buffer)
11003 (untabify (point-min) (point-max))
11004 (goto-char (1+ (point-min)))
11005 (while (re-search-forward "^." nil t)
11006 (beginning-of-line 1)
11007 (insert ind))
11008 (goto-char (point-max))
11009 (backward-delete-char 1)))
11010 (goto-char beg))
11011 (t nil))))
11013 (defvar org-show-positions nil)
11015 (defun org-table-show-reference (&optional local)
11016 "Show the location/value of the $ expression at point."
11017 (interactive)
11018 (org-table-remove-rectangle-highlight)
11019 (catch 'exit
11020 (let ((pos (if local (point) org-pos))
11021 (face2 'highlight)
11022 (org-inhibit-highlight-removal t)
11023 (win (selected-window))
11024 (org-show-positions nil)
11025 var name e what match dest)
11026 (if local (org-table-get-specials))
11027 (setq what (cond
11028 ((or (org-at-regexp-p org-table-range-regexp2)
11029 (org-at-regexp-p org-table-translate-regexp)
11030 (org-at-regexp-p org-table-range-regexp))
11031 (setq match
11032 (save-match-data
11033 (org-table-convert-refs-to-rc (match-string 0))))
11034 'range)
11037 ((not local) nil)
11038 (t (error "No reference at point")))
11039 match (and what (or match (match-string 0))))
11040 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
11041 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
11042 'secondary-selection))
11043 (org-add-hook 'before-change-functions
11044 'org-table-remove-rectangle-highlight)
11045 (if (eq what 'name) (setq var (substring match 1)))
11046 (when (eq what 'range)
11047 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
11048 (setq match (org-table-formula-substitute-names match)))
11049 (unless local
11050 (save-excursion
11051 (end-of-line 1)
11053 (beginning-of-line 1)
11055 (setq dest
11056 (save-match-data
11057 (org-table-convert-refs-to-rc (match-string 1))))
11058 (org-table-add-rectangle-overlay
11059 (match-beginning 1) (match-end 1) face2))))
11060 (if (and (markerp pos) (marker-buffer pos))
11061 (if (get-buffer-window (marker-buffer pos))
11062 (select-window (get-buffer-window (marker-buffer pos)))
11063 (org-switch-to-buffer-other-window (get-buffer-window
11064 (marker-buffer pos)))))
11065 (goto-char pos)
11066 (org-table-force-dataline)
11067 (when dest
11068 (setq name (substring dest 1))
11069 (cond
11071 (setq e (assoc name org-table-named-field-locations))
11072 (goto-line (nth 1 e))
11073 (org-table-goto-column (nth 2 e)))
11075 (let ((l (string-to-number (match-string 1 dest)))
11076 (c (string-to-number (match-string 2 dest))))
11077 (goto-line (aref org-table-dlines l))
11078 (org-table-goto-column c)))
11079 (t (org-table-goto-column (string-to-number name))))
11080 (move-marker pos (point))
11081 (org-table-highlight-rectangle nil nil face2))
11082 (cond
11083 ((equal dest match))
11084 ((not match))
11085 ((eq what 'range)
11086 (condition-case nil
11087 (save-excursion
11088 (org-table-get-range match nil nil 'highlight))
11089 (error nil)))
11090 ((setq e (assoc var org-table-named-field-locations))
11091 (goto-line (nth 1 e))
11092 (org-table-goto-column (nth 2 e))
11093 (org-table-highlight-rectangle (point) (point))
11094 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11095 ((setq e (assoc var org-table-column-names))
11096 (org-table-goto-column (string-to-number (cdr e)))
11097 (org-table-highlight-rectangle (point) (point))
11098 (goto-char (org-table-begin))
11100 (org-table-end) t)
11101 (progn
11102 (goto-char (match-beginning 1))
11103 (org-table-highlight-rectangle)
11104 (message "Named column (column %s)" (cdr e)))
11105 (error "Column name not found")))
11106 ((eq what 'column)
11107 ;; column number
11108 (org-table-goto-column (string-to-number (substring match 1)))
11109 (org-table-highlight-rectangle (point) (point))
11110 (message "Column %s" (substring match 1)))
11111 ((setq e (assoc var org-table-local-parameters))
11112 (goto-char (org-table-begin))
11114 (progn
11115 (goto-char (match-beginning 1))
11116 (org-table-highlight-rectangle)
11117 (message "Local parameter."))
11118 (error "Parameter not found")))
11119 (t
11120 (cond
11121 ((not var) (error "No reference at point"))
11122 ((setq e (assoc var org-table-formula-constants-local))
11123 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11124 var (cdr e)))
11125 ((setq e (assoc var org-table-formula-constants))
11126 (message "Constant: $%s=%s in `org-table-formula-constants'."
11127 var (cdr e)))
11128 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11129 (message "Constant: $%s=%s, from `constants.el'%s."
11130 var e (format " (%s units)" constants-unit-system)))
11131 (t (error "Undefined name $%s" var)))))
11132 (goto-char pos)
11133 (when (and org-show-positions
11134 (not (memq this-command '(org-table-fedit-scroll
11135 org-table-fedit-scroll-down))))
11136 (push pos org-show-positions)
11137 (push org-table-current-begin-pos org-show-positions)
11138 (let ((min (apply 'min org-show-positions))
11139 (max (apply 'max org-show-positions)))
11140 (goto-char min) (recenter 0)
11141 (goto-char max)
11142 (or (pos-visible-in-window-p max) (recenter -1))))
11143 (select-window win))))
11145 (defun org-table-force-dataline ()
11146 "Make sure the cursor is in a dataline in a table."
11147 (unless (save-excursion
11148 (beginning-of-line 1)
11149 (looking-at org-table-dataline-regexp))
11150 (let* ((re org-table-dataline-regexp)
11151 (p1 (save-excursion (re-search-forward re nil 'move)))
11152 (p2 (save-excursion (re-search-backward re nil 'move))))
11153 (cond ((and p1 p2)
11154 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11155 p1 p2)))
11156 ((or p1 p2) (goto-char (or p1 p2)))
11157 (t (error "No table dataline around here"))))))
11159 (defun org-table-fedit-line-up ()
11160 "Move cursor one line up in the window showing the table."
11161 (interactive)
11162 (org-table-fedit-move 'previous-line))
11164 (defun org-table-fedit-line-down ()
11165 "Move cursor one line down in the window showing the table."
11166 (interactive)
11167 (org-table-fedit-move 'next-line))
11169 (defun org-table-fedit-move (command)
11170 "Move the cursor in the window shoinw the table.
11171 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11172 (let ((org-table-allow-automatic-line-recalculation nil)
11173 (pos org-pos) (win (selected-window)) p)
11174 (select-window (get-buffer-window (marker-buffer org-pos)))
11175 (setq p (point))
11176 (call-interactively command)
11177 (while (and (org-at-table-p)
11178 (org-at-table-hline-p))
11179 (call-interactively command))
11180 (or (org-at-table-p) (goto-char p))
11181 (move-marker pos (point))
11182 (select-window win)))
11184 (defun org-table-fedit-scroll (N)
11185 (interactive "p")
11186 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11187 (scroll-other-window N)))
11189 (defun org-table-fedit-scroll-down (N)
11190 (interactive "p")
11191 (org-table-fedit-scroll (- N)))
11193 (defvar org-table-rectangle-overlays nil)
11195 (defun org-table-add-rectangle-overlay (beg end &optional face)
11196 "Add a new overlay."
11197 (let ((ov (org-make-overlay beg end)))
11198 (org-overlay-put ov 'face (or face 'secondary-selection))
11199 (push ov org-table-rectangle-overlays)))
11201 (defun org-table-highlight-rectangle (&optional beg end face)
11202 "Highlight rectangular region in a table."
11203 (setq beg (or beg (point)) end (or end (point)))
11204 (let ((b (min beg end))
11205 (e (max beg end))
11206 l1 c1 l2 c2 tmp)
11207 (and (boundp 'org-show-positions)
11208 (setq org-show-positions (cons b (cons e org-show-positions))))
11209 (goto-char (min beg end))
11210 (setq l1 (org-current-line)
11211 c1 (org-table-current-column))
11212 (goto-char (max beg end))
11213 (setq l2 (org-current-line)
11214 c2 (org-table-current-column))
11215 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11216 (goto-line l1)
11217 (beginning-of-line 1)
11218 (loop for line from l1 to l2 do
11219 (when (looking-at org-table-dataline-regexp)
11220 (org-table-goto-column c1)
11222 (org-table-goto-column c2)
11224 (org-table-add-rectangle-overlay beg end face))
11225 (beginning-of-line 2))
11226 (goto-char b))
11227 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11229 (defun org-table-remove-rectangle-highlight (&rest ignore)
11230 "Remove the rectangle overlays."
11231 (unless org-inhibit-highlight-removal
11232 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11233 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11234 (setq org-table-rectangle-overlays nil)))
11236 (defvar org-table-coordinate-overlays nil
11237 "Collects the cooordinate grid overlays, so that they can be removed.")
11238 (make-variable-buffer-local 'org-table-coordinate-overlays)
11240 (defun org-table-overlay-coordinates ()
11241 "Add overlays to the table at point, to show row/column coordinates."
11242 (interactive)
11243 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11244 (setq org-table-coordinate-overlays nil)
11245 (save-excursion
11246 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11247 (goto-char (org-table-begin))
11248 (while (org-at-table-p)
11249 (setq eol (point-at-eol))
11250 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11251 (push ov org-table-coordinate-overlays)
11252 (setq hline (looking-at org-table-hline-regexp))
11253 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11254 (format "%4d" (setq id (1+ id)))))
11255 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11256 (when hline
11257 (setq ic 0)
11259 (setq beg (1+ (match-beginning 0))
11260 ic (1+ ic)
11261 s1 (concat "$" (int-to-string ic))
11262 s2 (org-number-to-letters ic)
11263 str (if (eq org-table-use-standard-references t) s2 s1))
11264 (setq ov (org-make-overlay beg (+ beg (length str))))
11265 (push ov org-table-coordinate-overlays)
11266 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11267 (beginning-of-line 2)))))
11269 (defun org-table-toggle-coordinate-overlays ()
11270 "Toggle the display of Row/Column numbers in tables."
11271 (interactive)
11272 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11273 (message "Row/Column number display turned %s"
11274 (if org-table-overlay-coordinates "on" "off"))
11275 (if (and (org-at-table-p) org-table-overlay-coordinates)
11276 (org-table-align))
11277 (unless org-table-overlay-coordinates
11278 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11279 (setq org-table-coordinate-overlays nil)))
11281 (defun org-table-toggle-formula-debugger ()
11282 "Toggle the formula debugger in tables."
11283 (interactive)
11284 (setq org-table-formula-debug (not org-table-formula-debug))
11285 (message "Formula debugging has been turned %s"
11286 (if org-table-formula-debug "on" "off")))
11288 ;;; The orgtbl minor mode
11290 ;; Define a minor mode which can be used in other modes in order to
11291 ;; integrate the org-mode table editor.
11293 ;; This is really a hack, because the org-mode table editor uses several
11294 ;; keys which normally belong to the major mode, for example the TAB and
11295 ;; RET keys. Here is how it works: The minor mode defines all the keys
11296 ;; necessary to operate the table editor, but wraps the commands into a
11297 ;; function which tests if the cursor is currently inside a table. If that
11298 ;; is the case, the table editor command is executed. However, when any of
11299 ;; those keys is used outside a table, the function uses `key-binding' to
11300 ;; look up if the key has an associated command in another currently active
11301 ;; keymap (minor modes, major mode, global), and executes that command.
11302 ;; There might be problems if any of the keys used by the table editor is
11303 ;; otherwise used as a prefix key.
11305 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11306 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11307 ;; addresses this by checking explicitly for both bindings.
11309 ;; The optimized version (see variable `orgtbl-optimized') takes over
11310 ;; all keys which are bound to `self-insert-command' in the *global map*.
11311 ;; Some modes bind other commands to simple characters, for example
11312 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11313 ;; active, this binding is ignored inside tables and replaced with a
11314 ;; modified self-insert.
11316 (defvar orgtbl-mode nil
11317 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11318 table editor in arbitrary modes.")
11319 (make-variable-buffer-local 'orgtbl-mode)
11321 (defvar orgtbl-mode-map (make-keymap)
11322 "Keymap for `orgtbl-mode'.")
11324 ;;;###autoload
11325 (defun turn-on-orgtbl ()
11326 "Unconditionally turn on `orgtbl-mode'."
11327 (orgtbl-mode 1))
11329 (defvar org-old-auto-fill-inhibit-regexp nil
11330 "Local variable used by `orgtbl-mode'")
11333 "Matches a line belonging to an orgtbl.")
11335 (defconst orgtbl-extra-font-lock-keywords
11336 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11337 0 (quote 'org-table) 'prepend))
11338 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11340 ;;;###autoload
11341 (defun orgtbl-mode (&optional arg)
11342 "The `org-mode' table editor as a minor mode for use in other modes."
11343 (interactive)
11344 (if (org-mode-p)
11345 ;; Exit without error, in case some hook functions calls this
11346 ;; by accident in org-mode.
11347 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11348 (setq orgtbl-mode
11349 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11350 (if orgtbl-mode
11351 (progn
11352 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11353 ;; Make sure we are first in minor-mode-map-alist
11354 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11355 (and c (setq minor-mode-map-alist
11356 (cons c (delq c minor-mode-map-alist)))))
11357 (org-set-local (quote org-table-may-need-update) t)
11358 (org-add-hook 'before-change-functions 'org-before-change-function
11359 nil 'local)
11360 (org-set-local 'org-old-auto-fill-inhibit-regexp
11361 auto-fill-inhibit-regexp)
11362 (org-set-local 'auto-fill-inhibit-regexp
11363 (if auto-fill-inhibit-regexp
11365 auto-fill-inhibit-regexp)
11366 orgtbl-line-start-regexp))
11367 (org-add-to-invisibility-spec '(org-cwidth))
11368 (when (fboundp 'font-lock-add-keywords)
11369 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11370 (org-restart-font-lock))
11371 (easy-menu-add orgtbl-mode-menu)
11372 (run-hooks 'orgtbl-mode-hook))
11373 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11374 (org-cleanup-narrow-column-properties)
11375 (org-remove-from-invisibility-spec '(org-cwidth))
11376 (remove-hook 'before-change-functions 'org-before-change-function t)
11377 (when (fboundp 'font-lock-remove-keywords)
11378 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11379 (org-restart-font-lock))
11380 (easy-menu-remove orgtbl-mode-menu)
11381 (force-mode-line-update 'all))))
11383 (defun org-cleanup-narrow-column-properties ()
11384 "Remove all properties related to narrow-column invisibility."
11385 (let ((s 1))
11386 (while (setq s (text-property-any s (point-max)
11387 'display org-narrow-column-arrow))
11388 (remove-text-properties s (1+ s) '(display t)))
11389 (setq s 1)
11390 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11391 (remove-text-properties s (1+ s) '(org-cwidth t)))
11392 (setq s 1)
11393 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11394 (remove-text-properties s (1+ s) '(invisible t)))))
11396 ;; Install it as a minor mode.
11397 (put 'orgtbl-mode :included t)
11398 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11399 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11401 (defun orgtbl-make-binding (fun n &rest keys)
11402 "Create a function for binding in the table minor mode.
11403 FUN is the command to call inside a table. N is used to create a unique
11404 command name. KEYS are keys that should be checked in for a command
11405 to execute outside of tables."
11406 (eval
11407 (list 'defun
11408 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11409 '(arg)
11411 "Outside of tables, run the binding of `"
11412 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11413 "'.")
11414 '(interactive "p")
11415 (list 'if
11416 '(org-at-table-p)
11417 (list 'call-interactively (list 'quote fun))
11418 (list 'let '(orgtbl-mode)
11419 (list 'call-interactively
11420 (append '(or)
11421 (mapcar (lambda (k)
11422 (list 'key-binding k))
11423 keys)
11424 '('orgtbl-error))))))))
11426 (defun orgtbl-error ()
11427 "Error when there is no default binding for a table key."
11428 (interactive)
11429 (error "This key has no function outside tables"))
11431 (defun orgtbl-setup ()
11432 "Setup orgtbl keymaps."
11433 (let ((nfunc 0)
11434 (bindings
11435 (list
11436 '([(meta shift left)] org-table-delete-column)
11437 '([(meta left)] org-table-move-column-left)
11438 '([(meta right)] org-table-move-column-right)
11439 '([(meta shift right)] org-table-insert-column)
11440 '([(meta shift up)] org-table-kill-row)
11441 '([(meta shift down)] org-table-insert-row)
11442 '([(meta up)] org-table-move-row-up)
11443 '([(meta down)] org-table-move-row-down)
11444 '("\C-c\C-w" org-table-cut-region)
11445 '("\C-c\M-w" org-table-copy-region)
11446 '("\C-c\C-y" org-table-paste-rectangle)
11447 '("\C-c-" org-table-insert-hline)
11448 '("\C-c}" org-table-toggle-coordinate-overlays)
11449 '("\C-c{" org-table-toggle-formula-debugger)
11450 '("\C-m" org-table-next-row)
11451 '([(shift return)] org-table-copy-down)
11452 '("\C-c\C-q" org-table-wrap-region)
11453 '("\C-c?" org-table-field-info)
11454 '("\C-c " org-table-blank-field)
11455 '("\C-c+" org-table-sum)
11456 '("\C-c=" org-table-eval-formula)
11457 '("\C-c'" org-table-edit-formulas)
11458 '("\C-c`" org-table-edit-field)
11459 '("\C-c*" org-table-recalculate)
11460 '("\C-c|" org-table-create-or-convert-from-region)
11461 '("\C-c^" org-table-sort-lines)
11462 '([(control ?#)] org-table-rotate-recalc-marks)))
11463 elt key fun cmd)
11464 (while (setq elt (pop bindings))
11465 (setq nfunc (1+ nfunc))
11466 (setq key (org-key (car elt))
11467 fun (nth 1 elt)
11468 cmd (orgtbl-make-binding fun nfunc key))
11469 (org-defkey orgtbl-mode-map key cmd))
11471 ;; Special treatment needed for TAB and RET
11472 (org-defkey orgtbl-mode-map [(return)]
11473 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11474 (org-defkey orgtbl-mode-map "\C-m"
11475 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11477 (org-defkey orgtbl-mode-map [(tab)]
11478 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11479 (org-defkey orgtbl-mode-map "\C-i"
11480 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11482 (org-defkey orgtbl-mode-map [(shift tab)]
11483 (orgtbl-make-binding 'org-table-previous-field 104
11484 [(shift tab)] [(tab)] "\C-i"))
11486 (org-defkey orgtbl-mode-map "\M-\C-m"
11487 (orgtbl-make-binding 'org-table-wrap-region 105
11488 "\M-\C-m" [(meta return)]))
11489 (org-defkey orgtbl-mode-map [(meta return)]
11490 (orgtbl-make-binding 'org-table-wrap-region 106
11491 [(meta return)] "\M-\C-m"))
11493 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11494 (when orgtbl-optimized
11495 ;; If the user wants maximum table support, we need to hijack
11496 ;; some standard editing functions
11497 (org-remap orgtbl-mode-map
11498 'self-insert-command 'orgtbl-self-insert-command
11499 'delete-char 'org-delete-char
11500 'delete-backward-char 'org-delete-backward-char)
11501 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11502 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11503 '("OrgTbl"
11504 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11505 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11506 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11507 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11508 "--"
11509 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11510 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11511 ["Copy Field from Above"
11512 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11513 "--"
11514 ("Column"
11515 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11516 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11517 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11518 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11519 ("Row"
11520 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11521 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11522 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11523 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11524 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
11525 "--"
11526 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11527 ("Rectangle"
11528 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11529 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11530 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11531 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11532 "--"
11533 ("Radio tables"
11534 ["Insert table template" orgtbl-insert-radio-table
11535 (assq major-mode orgtbl-radio-table-templates)]
11536 ["Comment/uncomment table" orgtbl-toggle-comment t])
11537 "--"
11538 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11539 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11540 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11541 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11542 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11543 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11544 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11545 ["Sum Column/Rectangle" org-table-sum
11546 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11547 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11548 ["Debug Formulas"
11549 org-table-toggle-formula-debugger :active (org-at-table-p)
11550 :keys "C-c {"
11551 :style toggle :selected org-table-formula-debug]
11552 ["Show Col/Row Numbers"
11553 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11554 :keys "C-c }"
11555 :style toggle :selected org-table-overlay-coordinates]
11556 ))
11557 t))
11559 (defun orgtbl-ctrl-c-ctrl-c (arg)
11560 "If the cursor is inside a table, realign the table.
11561 It it is a table to be sent away to a receiver, do it.
11562 With prefix arg, also recompute table."
11563 (interactive "P")
11564 (let ((pos (point)) action)
11565 (save-excursion
11566 (beginning-of-line 1)
11570 (cond
11571 ((integerp action)
11572 (goto-char action)
11573 (org-table-maybe-eval-formula)
11574 (if arg
11575 (call-interactively 'org-table-recalculate)
11576 (org-table-maybe-recalculate-line))
11577 (call-interactively 'org-table-align)
11578 (orgtbl-send-table 'maybe))
11579 ((eq action 'recalc)
11580 (save-excursion
11581 (beginning-of-line 1)
11583 (if (org-at-table-p)
11584 (org-call-with-arg 'org-table-recalculate t))))
11585 (t (let (orgtbl-mode)
11586 (call-interactively (key-binding "\C-c\C-c")))))))
11588 (defun orgtbl-tab (arg)
11589 "Justification and field motion for `orgtbl-mode'."
11590 (interactive "P")
11591 (if arg (org-table-edit-field t)
11592 (org-table-justify-field-maybe)
11593 (org-table-next-field)))
11595 (defun orgtbl-ret ()
11596 "Justification and field motion for `orgtbl-mode'."
11597 (interactive)
11598 (org-table-justify-field-maybe)
11599 (org-table-next-row))
11601 (defun orgtbl-self-insert-command (N)
11602 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11603 If the cursor is in a table looking at whitespace, the whitespace is
11604 overwritten, and the table is not marked as requiring realignment."
11605 (interactive "p")
11606 (if (and (org-at-table-p)
11607 (or
11608 (and org-table-auto-blank-field
11609 (member last-command
11610 '(orgtbl-hijacker-command-100
11611 orgtbl-hijacker-command-101
11612 orgtbl-hijacker-command-102
11613 orgtbl-hijacker-command-103
11614 orgtbl-hijacker-command-104
11615 orgtbl-hijacker-command-105))
11616 (org-table-blank-field))
11617 t)
11618 (eq N 1)
11620 (let (org-table-may-need-update)
11621 (goto-char (1- (match-end 0)))
11622 (delete-backward-char 1)
11623 (goto-char (match-beginning 0))
11624 (self-insert-command N))
11625 (setq org-table-may-need-update t)
11626 (let (orgtbl-mode)
11627 (call-interactively (key-binding (vector last-input-event))))))
11629 (defun org-force-self-insert (N)
11630 "Needed to enforce self-insert under remapping."
11631 (interactive "p")
11632 (self-insert-command N))
11635 "Regula expression matching exponentials as produced by calc.")
11637 (defvar org-table-clean-did-remove-column nil)
11639 (defun orgtbl-export (table target)
11640 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11642 org-table-last-alignment org-table-last-column-widths
11643 maxcol column)
11644 (if (not (fboundp func))
11645 (error "Cannot export orgtbl table to %s" target))
11646 (setq lines (org-table-clean-before-export lines))
11647 (setq table
11648 (mapcar
11649 (lambda (x)
11650 (if (string-match org-table-hline-regexp x)
11651 'hline
11653 lines))
11654 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11655 table)))
11656 (loop for i from (1- maxcol) downto 0 do
11657 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11658 (setq column (delq nil column))
11659 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11660 (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))
11661 (funcall func table nil)))
11663 (defun orgtbl-send-table (&optional maybe)
11664 "Send a tranformed version of this table to the receiver position.
11665 With argument MAYBE, fail quietly if no transformation is defined for
11666 this table."
11667 (interactive)
11668 (catch 'exit
11669 (unless (org-at-table-p) (error "Not at a table"))
11670 ;; when non-interactive, we assume align has just happened.
11671 (when (interactive-p) (org-table-align))
11672 (save-excursion
11673 (goto-char (org-table-begin))
11674 (beginning-of-line 0)
11676 (if maybe
11677 (throw 'exit nil)
11678 (error "Don't know how to transform this table."))))
11679 (let* ((name (match-string 1))
11680 beg
11681 (transform (intern (match-string 2)))
11682 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11683 (skip (plist-get params :skip))
11684 (skipcols (plist-get params :skipcols))
11685 (txt (buffer-substring-no-properties
11686 (org-table-begin) (org-table-end)))
11688 (lines (org-table-clean-before-export lines))
11689 (i0 (if org-table-clean-did-remove-column 2 1))
11690 (table (mapcar
11691 (lambda (x)
11692 (if (string-match org-table-hline-regexp x)
11693 'hline
11694 (org-remove-by-index
11696 skipcols i0)))
11697 lines))
11698 (fun (if (= i0 2) 'cdr 'identity))
11699 (org-table-last-alignment
11700 (org-remove-by-index (funcall fun org-table-last-alignment)
11701 skipcols i0))
11702 (org-table-last-column-widths
11703 (org-remove-by-index (funcall fun org-table-last-column-widths)
11704 skipcols i0)))
11706 (unless (fboundp transform)
11707 (error "No such transformation function %s" transform))
11708 (setq txt (funcall transform table params))
11709 ;; Find the insertion place
11710 (save-excursion
11711 (goto-char (point-min))
11712 (unless (re-search-forward
11714 (error "Don't know where to insert translated table"))
11715 (goto-char (match-beginning 0))
11716 (beginning-of-line 2)
11717 (setq beg (point))
11718 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11719 (error "Cannot find end of insertion region"))
11720 (beginning-of-line 1)
11721 (delete-region beg (point))
11722 (goto-char beg)
11724 (message "Table converted and installed at receiver location"))))
11726 (defun org-remove-by-index (list indices &optional i0)
11727 "Remove the elements in LIST with indices in INDICES.
11728 First element has index 0, or I0 if given."
11729 (if (not indices)
11730 list
11731 (if (integerp indices) (setq indices (list indices)))
11732 (setq i0 (1- (or i0 0)))
11733 (delq :rm (mapcar (lambda (x)
11734 (setq i0 (1+ i0))
11735 (if (memq i0 indices) :rm x))
11736 list))))
11738 (defun orgtbl-toggle-comment ()
11739 "Comment or uncomment the orgtbl at point."
11740 (interactive)
11741 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11742 (re2 (concat "^" orgtbl-line-start-regexp))
11743 (commented (save-excursion (beginning-of-line 1)
11744 (cond ((looking-at re1) t)
11745 ((looking-at re2) nil)
11746 (t (error "Not at an org table")))))
11747 (re (if commented re1 re2))
11748 beg end)
11749 (save-excursion
11750 (beginning-of-line 1)
11751 (while (looking-at re) (beginning-of-line 0))
11752 (beginning-of-line 2)
11753 (setq beg (point))
11754 (while (looking-at re) (beginning-of-line 2))
11755 (setq end (point)))
11756 (comment-region beg end (if commented '(4) nil))))
11758 (defun orgtbl-insert-radio-table ()
11759 "Insert a radio table template appropriate for this major mode."
11760 (interactive)
11761 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11762 (txt (nth 1 e))
11763 name pos)
11764 (unless e (error "No radio table setup defined for %s" major-mode))
11765 (setq name (read-string "Table name: "))
11766 (while (string-match "%n" txt)
11767 (setq txt (replace-match name t t txt)))
11769 (setq pos (point))
11770 (insert txt)
11771 (goto-char pos)))
11773 (defun org-get-param (params header i sym &optional hsym)
11774 "Get parameter value for symbol SYM.
11775 If this is a header line, actually get the value for the symbol with an
11777 If the value is a protperty list, get the element for the current column.
11778 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11779 (let ((val (plist-get params sym)))
11780 (and hsym header (setq val (or (plist-get params hsym) val)))
11781 (if (consp val) (plist-get val i) val)))
11783 (defun orgtbl-to-generic (table params)
11784 "Convert the orgtbl-mode TABLE to some other format.
11785 This generic routine can be used for many standard cases.
11786 TABLE is a list, each entry either the symbol `hline' for a horizontal
11787 separator line, or a list of fields for that line.
11788 PARAMS is a property list of parameters that can influence the conversion.
11789 For the generic converter, some parameters are obligatory: You need to
11790 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11791 :splice, you must have :tstart and :tend.
11793 Valid parameters are
11795 :tstart String to start the table. Ignored when :splice is t.
11796 :tend String to end the table. Ignored when :splice is t.
11798 :splice When set to t, return only table body lines, don't wrap
11799 them into :tstart and :tend. Default is nil.
11801 :hline String to be inserted on horizontal separation lines.
11802 May be nil to ignore hlines.
11804 :lstart String to start a new table line.
11805 :lend String to end a table line
11806 :sep Separator between two fields
11807 :lfmt Format for entire line, with enough %s to capture all fields.
11808 If this is present, :lstart, :lend, and :sep are ignored.
11809 :fmt A format to be used to wrap the field, should contain
11810 %s for the original field value. For example, to wrap
11812 This may also be a property list with column numbers and
11815 :hlstart :hlend :hlsep :hlfmt :hfmt
11816 Same as above, specific for the header lines in the table.
11817 All lines before the first hline are treated as header.
11818 If any of these is not present, the data line value is used.
11820 :efmt Use this format to print numbers with exponentials.
11821 The format should have %s twice for inserting mantissa
11823 may also be a property list with column numbers and
11824 formats. :fmt will still be applied after :efmt.
11826 In addition to this, the parameters :skip and :skipcols are always handled
11827 directly by `orgtbl-send-table'. See manual."
11828 (interactive)
11829 (let* ((p params)
11830 (splicep (plist-get p :splice))
11831 (hline (plist-get p :hline))
11832 rtn line i fm efm lfmt h)
11834 ;; Do we have a header?
11835 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11836 (setq h t))
11838 ;; Put header
11839 (unless splicep
11840 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11842 ;; Now loop over all lines
11843 (while (setq line (pop table))
11844 (if (eq line 'hline)
11845 ;; A horizontal separator line
11846 (progn (if hline (push hline rtn))
11847 (setq h nil)) ; no longer in header
11848 ;; A normal line. Convert the fields, push line onto the result list
11849 (setq i 0)
11850 (setq line
11851 (mapcar
11852 (lambda (f)
11853 (setq i (1+ i)
11854 fm (org-get-param p h i :fmt :hfmt)
11855 efm (org-get-param p h i :efmt))
11856 (if (and efm (string-match orgtbl-exp-regexp f))
11857 (setq f (format
11858 efm (match-string 1 f) (match-string 2 f))))
11859 (if fm (setq f (format fm f)))
11860 f)
11861 line))
11862 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11863 (push (apply 'format lfmt line) rtn)
11864 (push (concat
11865 (org-get-param p h i :lstart :hlstart)
11866 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11867 (org-get-param p h i :lend :hlend))
11868 rtn))))
11870 (unless splicep
11871 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11875 (defun orgtbl-to-latex (table params)
11876 "Convert the orgtbl-mode TABLE to LaTeX.
11877 TABLE is a list, each entry either the symbol `hline' for a horizontal
11878 separator line, or a list of fields for that line.
11879 PARAMS is a property list of parameters that can influence the conversion.
11880 Supports all parameters from `orgtbl-to-generic'. Most important for
11881 LaTeX are:
11883 :splice When set to t, return only table body lines, don't wrap
11884 them into a tabular environment. Default is nil.
11886 :fmt A format to be used to wrap the field, should contain %s for the
11887 original field value. For example, to wrap everything in dollars,
11891 :efmt Format for transforming numbers with exponentials. The format
11892 should have %s twice for inserting mantissa and exponent, for
11894 This may also be a property list with column numbers and formats.
11896 The general parameters :skip and :skipcols have already been applied when
11897 this function is called."
11898 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11899 org-table-last-alignment ""))
11900 (params2
11901 (list
11906 (orgtbl-to-generic table (org-combine-plists params2 params))))
11908 (defun orgtbl-to-html (table params)
11909 "Convert the orgtbl-mode TABLE to LaTeX.
11910 TABLE is a list, each entry either the symbol `hline' for a horizontal
11911 separator line, or a list of fields for that line.
11912 PARAMS is a property list of parameters that can influence the conversion.
11913 Currently this function recognizes the following parameters:
11915 :splice When set to t, return only table body lines, don't wrap
11916 them into a <table> environment. Default is nil.
11918 The general parameters :skip and :skipcols have already been applied when
11919 this function is called. The function does *not* use `orgtbl-to-generic',
11920 so you cannot specify parameters for it."
11921 (let* ((splicep (plist-get params :splice))
11922 html)
11923 ;; Just call the formatter we already have
11924 ;; We need to make text lines for it, so put the fields back together.
11925 (setq html (org-format-org-table-html
11926 (mapcar
11927 (lambda (x)
11928 (if (eq x 'hline)
11929 "|----+----|"
11930 (concat "| " (mapconcat 'identity x " | ") " |")))
11931 table)
11932 splicep))
11934 (setq html (replace-match "" t t html)))
11935 html))
11937 (defun orgtbl-to-texinfo (table params)
11938 "Convert the orgtbl-mode TABLE to TeXInfo.
11939 TABLE is a list, each entry either the symbol `hline' for a horizontal
11940 separator line, or a list of fields for that line.
11941 PARAMS is a property list of parameters that can influence the conversion.
11942 Supports all parameters from `orgtbl-to-generic'. Most important for
11943 TeXInfo are:
11945 :splice nil/t When set to t, return only table body lines, don't wrap
11946 them into a multitable environment. Default is nil.
11948 :fmt fmt A format to be used to wrap the field, should contain
11949 %s for the original field value. For example, to wrap
11951 This may also be a property list with column numbers and
11955 are computed automatically from the width of the columns
11956 under org-mode.
11958 The general parameters :skip and :skipcols have already been applied when
11959 this function is called."
11960 (let* ((total (float (apply '+ org-table-last-column-widths)))
11961 (colfrac (or (plist-get params :cf)
11962 (mapconcat
11963 (lambda (x) (format "%.3f" (/ (float x) total)))
11964 org-table-last-column-widths " ")))
11965 (params2
11966 (list
11967 :tstart (concat "@multitable @columnfractions " colfrac)
11968 :tend "@end multitable"
11969 :lstart "@item " :lend "" :sep " @tab "
11970 :hlstart "@headitem ")))
11971 (orgtbl-to-generic table (org-combine-plists params2 params))))
11973 ;;;; Link Stuff
11975 ;;; Link abbreviations
11977 (defun org-link-expand-abbrev (link)
11978 "Apply replacements as defined in `org-link-abbrev-alist."
11980 (let* ((key (match-string 1 link))
11981 (as (or (assoc key org-link-abbrev-alist-local)
11982 (assoc key org-link-abbrev-alist)))
11983 (tag (and (match-end 2) (match-string 3 link)))
11984 rpl)
11985 (if (not as)
11986 link
11987 (setq rpl (cdr as))
11988 (cond
11989 ((symbolp rpl) (funcall rpl tag))
11990 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11991 (t (concat rpl tag)))))
11992 link))
11994 ;;; Storing and inserting links
11996 (defvar org-insert-link-history nil
11997 "Minibuffer history for links inserted with `org-insert-link'.")
11999 (defvar org-stored-links nil
12000 "Contains the links stored with `org-store-link'.")
12002 (defvar org-store-link-plist nil
12003 "Plist with info about the most recently link created with `org-store-link'.")
12005 (defvar org-link-protocols nil
12006 "Link protocols added to Org-mode using `org-add-link-type'.")
12008 (defvar org-store-link-functions nil
12009 "List of functions that are called to create and store a link.
12010 Each function will be called in turn until one returns a non-nil
12011 value. Each function should check if it is responsible for creating
12012 this link (for example by looking at the major mode).
12013 If not, it must exit and return nil.
12014 If yes, it should return a non-nil value after a calling
12015 `org-store-link-props' with a list of properties and values.
12016 Special properties are:
12020 This is obligatory as well.
12021 :description Optional default description for the second pair
12022 of brackets in an Org-mode link. The user can still change
12023 this when inserting this link into an Org-mode buffer.
12025 In addition to these, any additional properties can be specified
12026 and then used in remember templates.")
12028 (defun org-add-link-type (type &optional follow publish)
12029 "Add TYPE to the list of `org-link-types'.
12030 Re-compute all regular expressions depending on `org-link-types'
12031 FOLLOW and PUBLISH are two functions. Both take the link path as
12032 an argument.
12033 FOLLOW should do whatever is necessary to follow the link, for example
12034 to find a file or display a mail message.
12036 PUBLISH takes the path and retuns the string that should be used when
12037 this document is published. FIMXE: This is actually not yet implemented."
12038 (add-to-list 'org-link-types type t)
12039 (org-make-link-regexps)
12040 (add-to-list 'org-link-protocols
12041 (list type follow publish)))
12043 (defun org-add-agenda-custom-command (entry)
12044 "Replace or add a command in `org-agenda-custom-commands'.
12045 This is mostly for hacking and trying a new command - once the command
12046 works you probably want to add it to `org-agenda-custom-commands' for good."
12047 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
12048 (if ass
12049 (setcdr ass (cdr entry))
12050 (push entry org-agenda-custom-commands))))
12052 ;;;###autoload
12053 (defun org-store-link (arg)
12055 This link is added to `org-stored-links' and can later be inserted
12058 For some link types, a prefix arg is interpreted:
12059 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12060 For file links, arg negates `org-context-in-file-links'."
12061 (interactive "P")
12062 (setq org-store-link-plist nil) ; reset
12063 (let (link cpltxt desc description search txt)
12064 (cond
12066 ((run-hook-with-args-until-success 'org-store-link-functions)
12067 (setq link (plist-get org-store-link-plist :link)
12068 desc (or (plist-get org-store-link-plist :description) link)))
12070 ((eq major-mode 'bbdb-mode)
12071 (let ((name (bbdb-record-name (bbdb-current-record)))
12072 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
12073 (setq cpltxt (concat "bbdb:" (or name company))
12074 link (org-make-link cpltxt))
12075 (org-store-link-props :type "bbdb" :name name :company company)))
12077 ((eq major-mode 'Info-mode)
12078 (setq link (org-make-link "info:"
12079 (file-name-nondirectory Info-current-file)
12080 ":" Info-current-node))
12081 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
12082 ":" Info-current-node))
12083 (org-store-link-props :type "info" :file Info-current-file
12084 :node Info-current-node))
12086 ((eq major-mode 'calendar-mode)
12087 (let ((cd (calendar-cursor-to-date)))
12088 (setq link
12089 (format-time-string
12090 (car org-time-stamp-formats)
12091 (apply 'encode-time
12092 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12093 nil nil nil))))
12094 (org-store-link-props :type "calendar" :date cd)))
12096 ((or (eq major-mode 'vm-summary-mode)
12097 (eq major-mode 'vm-presentation-mode))
12098 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
12099 (vm-follow-summary-cursor)
12100 (save-excursion
12101 (vm-select-folder-buffer)
12102 (let* ((message (car vm-message-pointer))
12103 (folder buffer-file-name)
12104 (subject (vm-su-subject message))
12105 (to (vm-get-header-contents message "To"))
12106 (from (vm-get-header-contents message "From"))
12107 (message-id (vm-su-message-id message)))
12108 (org-store-link-props :type "vm" :from from :to to :subject subject
12109 :message-id message-id)
12110 (setq message-id (org-remove-angle-brackets message-id))
12111 (setq folder (abbreviate-file-name folder))
12112 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
12113 folder)
12114 (setq folder (replace-match "" t t folder)))
12115 (setq cpltxt (org-email-link-description))
12116 (setq link (org-make-link "vm:" folder "#" message-id)))))
12118 ((eq major-mode 'wl-summary-mode)
12119 (let* ((msgnum (wl-summary-message-number))
12120 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12121 msgnum 'message-id))
12122 (wl-message-entity
12123 (if (fboundp 'elmo-message-entity)
12124 (elmo-message-entity
12125 wl-summary-buffer-elmo-folder msgnum)
12126 (elmo-msgdb-overview-get-entity
12127 msgnum (wl-summary-buffer-msgdb))))
12128 (from (wl-summary-line-from))
12129 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12130 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12131 (wl-summary-line-subject))))
12132 (org-store-link-props :type "wl" :from from :to to
12133 :subject subject :message-id message-id)
12134 (setq message-id (org-remove-angle-brackets message-id))
12135 (setq cpltxt (org-email-link-description))
12136 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12137 "#" message-id))))
12139 ((or (equal major-mode 'mh-folder-mode)
12140 (equal major-mode 'mh-show-mode))
12141 (let ((from (org-mhe-get-header "From:"))
12142 (to (org-mhe-get-header "To:"))
12143 (message-id (org-mhe-get-header "Message-Id:"))
12144 (subject (org-mhe-get-header "Subject:")))
12145 (org-store-link-props :type "mh" :from from :to to
12146 :subject subject :message-id message-id)
12147 (setq cpltxt (org-email-link-description))
12148 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12149 (org-remove-angle-brackets message-id)))))
12151 ((or (eq major-mode 'rmail-mode)
12152 (eq major-mode 'rmail-summary-mode))
12153 (save-window-excursion
12154 (save-restriction
12155 (when (eq major-mode 'rmail-summary-mode)
12156 (rmail-show-message rmail-current-message))
12157 (rmail-narrow-to-non-pruned-header)
12158 (let ((folder buffer-file-name)
12159 (message-id (mail-fetch-field "message-id"))
12160 (from (mail-fetch-field "from"))
12161 (to (mail-fetch-field "to"))
12162 (subject (mail-fetch-field "subject")))
12163 (org-store-link-props
12164 :type "rmail" :from from :to to
12165 :subject subject :message-id message-id)
12166 (setq message-id (org-remove-angle-brackets message-id))
12167 (setq cpltxt (org-email-link-description))
12168 (setq link (org-make-link "rmail:" folder "#" message-id)))
12169 (rmail-show-message rmail-current-message))))
12171 ((eq major-mode 'gnus-group-mode)
12172 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12173 (gnus-group-group-name)) ; version
12174 ((fboundp 'gnus-group-name)
12175 (gnus-group-name))
12176 (t "???"))))
12177 (unless group (error "Not on a group"))
12178 (org-store-link-props :type "gnus" :group group)
12179 (setq cpltxt (concat
12180 (if (org-xor arg org-usenet-links-prefer-google)
12181 "http://groups.google.com/groups?group="
12182 "gnus:")
12183 group)
12184 link (org-make-link cpltxt))))
12186 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12187 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12188 (let* ((group gnus-newsgroup-name)
12189 (article (gnus-summary-article-number))
12190 (header (gnus-summary-article-header article))
12191 (from (mail-header-from header))
12192 (message-id (mail-header-id header))
12193 (date (mail-header-date header))
12194 (subject (gnus-summary-subject-string)))
12195 (org-store-link-props :type "gnus" :from from :subject subject
12196 :message-id message-id :group group)
12197 (setq cpltxt (org-email-link-description))
12198 (if (org-xor arg org-usenet-links-prefer-google)
12199 (setq link
12200 (concat
12202 (format "http://groups.google.com/groups?as_umsgid=%s"
12203 (org-fixup-message-id-for-http message-id))))
12204 (setq link (org-make-link "gnus:" group
12205 "#" (number-to-string article))))))
12207 ((eq major-mode 'w3-mode)
12208 (setq cpltxt (url-view-url t)
12209 link (org-make-link cpltxt))
12210 (org-store-link-props :type "w3" :url (url-view-url t)))
12212 ((eq major-mode 'w3m-mode)
12213 (setq cpltxt (or w3m-current-title w3m-current-url)
12214 link (org-make-link w3m-current-url))
12215 (org-store-link-props :type "w3m" :url (url-view-url t)))
12217 ((setq search (run-hook-with-args-until-success
12218 'org-create-file-search-functions))
12219 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12220 "::" search))
12221 (setq cpltxt (or description link)))
12223 ((eq major-mode 'image-mode)
12224 (setq cpltxt (concat "file:"
12225 (abbreviate-file-name buffer-file-name))
12226 link (org-make-link cpltxt))
12227 (org-store-link-props :type "image" :file buffer-file-name))
12229 ((eq major-mode 'dired-mode)
12230 ;; link to the file in the current line
12231 (setq cpltxt (concat "file:"
12232 (abbreviate-file-name
12233 (expand-file-name
12234 (dired-get-filename nil t))))
12235 link (org-make-link cpltxt)))
12237 ((and buffer-file-name (org-mode-p))
12238 ;; Just link to current headline
12239 (setq cpltxt (concat "file:"
12240 (abbreviate-file-name buffer-file-name)))
12241 ;; Add a context search string
12242 (when (org-xor org-context-in-file-links arg)
12243 ;; Check if we are on a target
12245 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12246 (setq txt (cond
12247 ((org-on-heading-p) nil)
12248 ((org-region-active-p)
12249 (buffer-substring (region-beginning) (region-end)))
12250 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12252 (setq cpltxt
12253 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12254 desc "NONE"))))
12256 (setq cpltxt (substring cpltxt 0 -2)))
12257 (setq link (org-make-link cpltxt)))
12259 ((buffer-file-name (buffer-base-buffer))
12260 ;; Just link to this file here.
12261 (setq cpltxt (concat "file:"
12262 (abbreviate-file-name
12263 (buffer-file-name (buffer-base-buffer)))))
12264 ;; Add a context string
12265 (when (org-xor org-context-in-file-links arg)
12266 (setq txt (if (org-region-active-p)
12267 (buffer-substring (region-beginning) (region-end))
12268 (buffer-substring (point-at-bol) (point-at-eol))))
12269 ;; Only use search option if there is some text.
12271 (setq cpltxt
12272 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12273 desc "NONE")))
12274 (setq link (org-make-link cpltxt)))
12276 ((interactive-p)
12277 (error "Cannot link to a buffer which is not visiting a file"))
12279 (t (setq link nil)))
12281 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12282 (setq link (or link cpltxt)
12283 desc (or desc cpltxt))
12284 (if (equal desc "NONE") (setq desc nil))
12286 (if (and (interactive-p) link)
12287 (progn
12288 (setq org-stored-links
12289 (cons (list link desc) org-stored-links))
12290 (message "Stored: %s" (or desc link)))
12291 (and link (org-make-link-string link desc)))))
12293 (defun org-store-link-props (&rest plist)
12294 "Store link properties, extract names and addresses."
12295 (let (x adr)
12296 (when (setq x (plist-get plist :from))
12297 (setq adr (mail-extract-address-components x))
12298 (plist-put plist :fromname (car adr))
12299 (plist-put plist :fromaddress (nth 1 adr)))
12300 (when (setq x (plist-get plist :to))
12301 (setq adr (mail-extract-address-components x))
12302 (plist-put plist :toname (car adr))
12303 (plist-put plist :toaddress (nth 1 adr))))
12304 (let ((from (plist-get plist :from))
12305 (to (plist-get plist :to)))
12306 (when (and from to org-from-is-user-regexp)
12307 (plist-put plist :fromto
12308 (if (string-match org-from-is-user-regexp from)
12309 (concat "to %t")
12310 (concat "from %f")))))
12311 (setq org-store-link-plist plist))
12313 (defun org-email-link-description (&optional fmt)
12314 "Return the description part of an email link.
12315 This takes information from `org-store-link-plist' and formats it
12316 according to FMT (default from `org-email-link-description-format')."
12317 (setq fmt (or fmt org-email-link-description-format))
12318 (let* ((p org-store-link-plist)
12319 (to (plist-get p :toaddress))
12320 (from (plist-get p :fromaddress))
12321 (table
12322 (list
12323 (cons "%c" (plist-get p :fromto))
12324 (cons "%F" (plist-get p :from))
12325 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12326 (cons "%T" (plist-get p :to))
12327 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12328 (cons "%s" (plist-get p :subject))
12329 (cons "%m" (plist-get p :message-id)))))
12330 (when (string-match "%c" fmt)
12331 ;; Check if the user wrote this message
12332 (if (and org-from-is-user-regexp from to
12333 (save-match-data (string-match org-from-is-user-regexp from)))
12334 (setq fmt (replace-match "to %t" t t fmt))
12335 (setq fmt (replace-match "from %f" t t fmt))))
12336 (org-replace-escapes fmt table)))
12338 (defun org-make-org-heading-search-string (&optional string heading)
12339 "Make search string for STRING or current headline."
12340 (interactive)
12341 (let ((s (or string (org-get-heading))))
12342 (unless (and string (not heading))
12343 ;; We are using a headline, clean up garbage in there.
12344 (if (string-match org-todo-regexp s)
12345 (setq s (replace-match "" t t s)))
12347 (setq s (replace-match "" t t s)))
12348 (setq s (org-trim s))
12351 (setq s (replace-match "" t t s)))
12352 (while (string-match org-ts-regexp s)
12353 (setq s (replace-match "" t t s))))
12355 (setq s (replace-match " " t t s)))
12356 (or string (setq s (concat "*" s))) ; Add * for headlines
12359 (defun org-make-link (&rest strings)
12360 "Concatenate STRINGS."
12361 (apply 'concat strings))
12363 (defun org-make-link-string (link &optional description)
12364 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12366 (error "Empty link"))
12367 (when (stringp description)
12368 ;; Remove brackets from the description, they are fatal.
12370 (setq description (replace-match "{" t t description)))
12372 (setq description (replace-match "}" t t description))))
12373 (when (equal (org-link-escape link) description)
12374 ;; No description needed, it is identical
12375 (setq description nil))
12376 (when (and (not description)
12377 (not (equal link (org-link-escape link))))
12378 (setq description link))
12379 (concat "[[" (org-link-escape link) "]"
12380 (if description (concat "[" description "]") "")
12381 "]"))
12383 (defconst org-link-escape-chars
12384 '((?\ . "%20")
12385 (?\[ . "%5B")
12386 (?\] . "%5D")
12397 (?\; . "%3B")
12398 (?? . "%3F")
12399 (?= . "%3D")
12400 (?+ . "%2B")
12401 )
12402 "Association list of escapes for some characters problematic in links.
12403 This is the list that is used for internal purposes.")
12405 (defconst org-link-escape-chars-browser
12406 '((?\ . "%20")) ; 32 for the SPC char
12407 "Association list of escapes for some characters problematic in links.
12408 This is the list that is used before handing over to the browser.")
12410 (defun org-link-escape (text &optional table)
12411 "Escape charaters in TEXT that are problematic for links."
12412 (setq table (or table org-link-escape-chars))
12413 (when text
12414 (let ((re (mapconcat (lambda (x) (regexp-quote
12415 (char-to-string (car x))))
12417 (while (string-match re text)
12418 (setq text
12419 (replace-match
12420 (cdr (assoc (string-to-char (match-string 0 text))
12421 table))
12422 t t text)))
12423 text)))
12425 (defun org-link-unescape (text &optional table)
12426 "Reverse the action of `org-link-escape'."
12427 (setq table (or table org-link-escape-chars))
12428 (when text
12429 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12431 (while (string-match re text)
12432 (setq text
12433 (replace-match
12434 (char-to-string (car (rassoc (match-string 0 text) table)))
12435 t t text)))
12436 text)))
12438 (defun org-xor (a b)
12439 "Exclusive or."
12440 (if a (not b) b))
12442 (defun org-get-header (header)
12443 "Find a header field in the current buffer."
12444 (save-excursion
12445 (goto-char (point-min))
12446 (let ((case-fold-search t) s)
12447 (cond
12448 ((eq header 'from)
12450 (setq s (match-string 1)))
12452 (setq s (replace-match "" t t s)))
12453 (if (string-match "[<(].*" s)
12454 (setq s (replace-match "" t t s))))
12455 ((eq header 'message-id)
12457 (setq s (match-string 1))))
12458 ((eq header 'subject)
12460 (setq s (match-string 1)))))
12463 s)))
12466 (defun org-fixup-message-id-for-http (s)
12467 "Replace special characters in a message id, so it can be used in an http query."
12468 (while (string-match "<" s)
12469 (setq s (replace-match "%3C" t t s)))
12470 (while (string-match ">" s)
12471 (setq s (replace-match "%3E" t t s)))
12472 (while (string-match "@" s)
12473 (setq s (replace-match "%40" t t s)))
12474 s)
12476 ;;;###autoload
12477 (defun org-insert-link-global ()
12478 "Insert a link like Org-mode does.
12479 This command can be called in any mode to insert a link in Org-mode syntax."
12480 (interactive)
12481 (org-run-like-in-org-mode 'org-insert-link))
12483 (defun org-insert-link (&optional complete-file)
12484 "Insert a link. At the prompt, enter the link.
12486 Completion can be used to select a link previously stored with
12487 `org-store-link'. When the empty string is entered (i.e. if you just
12488 press RET at the prompt), the link defaults to the most recently
12489 stored link. As SPC triggers completion in the minibuffer, you need to
12490 use M-SPC or C-q SPC to force the insertion of a space character.
12492 You will also be prompted for a description, and if one is given, it will
12493 be displayed in the buffer instead of the link.
12495 If there is already a link at point, this command will allow you to edit link
12496 and description parts.
12499 selected using completion. The path to the file will be relative to
12500 the current directory if the file is in the current directory or a
12501 subdirectory. Otherwise, the link will be the absolute path as
12502 completed in the minibuffer (i.e. normally ~/path/to/file).
12505 is in the current directory or below.
12507 `org-keep-stored-link-after-insertion'."
12508 (interactive "P")
12509 (let* ((wcf (current-window-configuration))
12510 (region (if (org-region-active-p)
12511 (buffer-substring (region-beginning) (region-end))))
12512 (remove (and region (list (region-beginning) (region-end))))
12513 (desc region)
12514 tmphist ; byte-compile incorrectly complains about this
12515 link entry file)
12516 (cond
12517 ((org-in-regexp org-bracket-link-regexp 1)
12518 ;; We do have a link at point, and we are going to edit it.
12519 (setq remove (list (match-beginning 0) (match-end 0)))
12520 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12521 (setq link (read-string "Link: "
12522 (org-link-unescape
12523 (org-match-string-no-properties 1)))))
12524 ((or (org-in-regexp org-angle-link-re)
12525 (org-in-regexp org-plain-link-re))
12526 ;; Convert to bracket link
12527 (setq remove (list (match-beginning 0) (match-end 0))
12528 link (read-string "Link: "
12529 (org-remove-angle-brackets (match-string 0)))))
12530 ((equal complete-file '(4))
12531 ;; Completing read for file names.
12532 (setq file (read-file-name "File: "))
12533 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12534 (pwd1 (file-name-as-directory (abbreviate-file-name
12535 (expand-file-name ".")))))
12536 (cond
12537 ((equal complete-file '(16))
12538 (setq link (org-make-link
12539 "file:"
12540 (abbreviate-file-name (expand-file-name file)))))
12542 (setq link (org-make-link "file:" (match-string 1 file))))
12544 (expand-file-name file))
12545 (setq link (org-make-link
12546 "file:" (match-string 1 (expand-file-name file)))))
12547 (t (setq link (org-make-link "file:" file))))))
12548 (t
12549 ;; Read link, with completion for stored links.
12550 (with-output-to-temp-buffer "*Org Links*"
12552 (when org-stored-links
12554 (princ (mapconcat
12555 (lambda (x)
12556 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12558 (let ((cw (selected-window)))
12559 (select-window (get-buffer-window "*Org Links*"))
12560 (shrink-window-if-larger-than-buffer)
12561 (setq truncate-lines t)
12562 (select-window cw))
12563 ;; Fake a link history, containing the stored links.
12564 (setq tmphist (append (mapcar 'car org-stored-links)
12565 org-insert-link-history))
12566 (unwind-protect
12567 (setq link (org-completing-read
12568 "Link: "
12569 (append
12570 (mapcar (lambda (x) (list (concat (car x) ":")))
12571 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12572 (mapcar (lambda (x) (list (concat x ":")))
12573 org-link-types))
12574 nil nil nil
12575 'tmphist
12576 (or (car (car org-stored-links)))))
12577 (set-window-configuration wcf)
12578 (kill-buffer "*Org Links*"))
12579 (setq entry (assoc link org-stored-links))
12580 (or entry (push link org-insert-link-history))
12581 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12582 (not org-keep-stored-link-after-insertion))
12583 (setq org-stored-links (delq (assoc link org-stored-links)
12584 org-stored-links)))
12585 (setq desc (or desc (nth 1 entry)))))
12587 (if (string-match org-plain-link-re link)
12588 ;; URL-like link, normalize the use of angular brackets.
12589 (setq link (org-make-link (org-remove-angle-brackets link))))
12591 ;; Check if we are linking to the current file with a search option
12592 ;; If yes, simplify the link by using only the search option.
12593 (when (and buffer-file-name
12595 (let* ((path (match-string 1 link))
12596 (case-fold-search nil)
12597 (search (match-string 2 link)))
12598 (save-match-data
12599 (if (equal (file-truename buffer-file-name) (file-truename path))
12600 ;; We are linking to this same file, with a search option
12601 (setq link search)))))
12603 ;; Check if we can/should use a relative path. If yes, simplify the link
12605 (let* ((path (match-string 1 link))
12606 (origpath path)
12607 (case-fold-search nil))
12608 (cond
12609 ((eq org-link-file-path-type 'absolute)
12610 (setq path (abbreviate-file-name (expand-file-name path))))
12611 ((eq org-link-file-path-type 'noabbrev)
12612 (setq path (expand-file-name path)))
12613 ((eq org-link-file-path-type 'relative)
12614 (setq path (file-relative-name path)))
12615 (t
12616 (save-match-data
12617 (if (string-match (concat "^" (regexp-quote
12618 (file-name-as-directory
12619 (expand-file-name "."))))
12620 (expand-file-name path))
12621 ;; We are linking a file with relative path name.
12622 (setq path (substring (expand-file-name path)
12623 (match-end 0)))))))
12624 (setq link (concat "file:" path))
12625 (if (equal desc origpath)
12626 (setq desc path))))
12628 (setq desc (read-string "Description: " desc))
12630 (if remove (apply 'delete-region remove))
12631 (insert (org-make-link-string link desc))))
12633 (defun org-completing-read (&rest args)
12634 (let ((minibuffer-local-completion-map
12635 (copy-keymap minibuffer-local-completion-map)))
12636 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12637 (apply 'completing-read args)))
12639 ;;; Opening/following a link
12640 (defvar org-link-search-failed nil)
12642 (defun org-next-link ()
12643 "Move forward to the next link.
12644 If the link is in hidden text, expose it."
12645 (interactive)
12646 (when (and org-link-search-failed (eq this-command last-command))
12647 (goto-char (point-min))
12648 (message "Link search wrapped back to beginning of buffer"))
12649 (setq org-link-search-failed nil)
12650 (let* ((pos (point))
12651 (ct (org-context))
12652 (a (assoc :link ct)))
12653 (if a (goto-char (nth 2 a)))
12654 (if (re-search-forward org-any-link-re nil t)
12655 (progn
12656 (goto-char (match-beginning 0))
12657 (if (org-invisible-p) (org-show-context)))
12658 (goto-char pos)
12659 (setq org-link-search-failed t)
12660 (error "No further link found"))))
12662 (defun org-previous-link ()
12663 "Move backward to the previous link.
12664 If the link is in hidden text, expose it."
12665 (interactive)
12666 (when (and org-link-search-failed (eq this-command last-command))
12667 (goto-char (point-max))
12668 (message "Link search wrapped back to end of buffer"))
12669 (setq org-link-search-failed nil)
12670 (let* ((pos (point))
12671 (ct (org-context))
12672 (a (assoc :link ct)))
12673 (if a (goto-char (nth 1 a)))
12674 (if (re-search-backward org-any-link-re nil t)
12675 (progn
12676 (goto-char (match-beginning 0))
12677 (if (org-invisible-p) (org-show-context)))
12678 (goto-char pos)
12679 (setq org-link-search-failed t)
12680 (error "No further link found"))))
12682 (defun org-find-file-at-mouse (ev)
12683 "Open file link or URL at mouse."
12684 (interactive "e")
12685 (mouse-set-point ev)
12686 (org-open-at-point 'in-emacs))
12688 (defun org-open-at-mouse (ev)
12689 "Open file link or URL at mouse."
12690 (interactive "e")
12691 (mouse-set-point ev)
12692 (org-open-at-point))
12694 (defvar org-window-config-before-follow-link nil
12695 "The window configuration before following a link.
12696 This is saved in case the need arises to restore it.")
12698 (defvar org-open-link-marker (make-marker)
12699 "Marker pointing to the location where `org-open-at-point; was called.")
12701 ;;;###autoload
12702 (defun org-open-at-point-global ()
12703 "Follow a link like Org-mode does.
12704 This command can be called in any mode to follow a link that has
12705 Org-mode syntax."
12706 (interactive)
12707 (org-run-like-in-org-mode 'org-open-at-point))
12709 (defun org-open-at-point (&optional in-emacs)
12710 "Open link at or after point.
12711 If there is no link at point, this function will search forward up to
12712 the end of the current subtree.
12713 Normally, files will be opened by an appropriate application. If the
12714 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12715 (interactive "P")
12716 (move-marker org-open-link-marker (point))
12717 (setq org-window-config-before-follow-link (current-window-configuration))
12718 (org-remove-occur-highlights nil nil t)
12719 (if (org-at-timestamp-p t)
12720 (org-follow-timestamp-link)
12721 (let (type path link line search (pos (point)))
12722 (catch 'match
12723 (save-excursion
12725 (when (org-in-regexp org-bracket-link-regexp)
12726 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12728 (setq link (replace-match " " t t link)))
12729 (setq link (org-link-expand-abbrev link))
12730 (if (string-match org-link-re-with-space2 link)
12731 (setq type (match-string 1 link) path (match-string 2 link))
12732 (setq type "thisfile" path link))
12733 (throw 'match t)))
12735 (when (get-text-property (point) 'org-linked-text)
12736 (setq type "thisfile"
12737 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12738 (1+ (point)) (point))
12739 path (buffer-substring
12740 (previous-single-property-change pos 'org-linked-text)
12741 (next-single-property-change pos 'org-linked-text)))
12742 (throw 'match t))
12744 (save-excursion
12745 (when (or (org-in-regexp org-angle-link-re)
12746 (org-in-regexp org-plain-link-re))
12747 (setq type (match-string 1) path (match-string 2))
12748 (throw 'match t)))
12750 (setq type "tree-match"
12751 path (match-string 1))
12752 (throw 'match t))
12753 (save-excursion
12755 (setq type "tags"
12756 path (match-string 1))
12757 (while (string-match ":" path)
12758 (setq path (replace-match "+" t t path)))
12759 (throw 'match t))))
12760 (unless path
12761 (error "No link found"))
12762 ;; Remove any trailing spaces in path
12764 (setq path (replace-match "" t t path)))
12766 (cond
12768 ((assoc type org-link-protocols)
12769 (funcall (nth 1 (assoc type org-link-protocols)) path))
12771 ((equal type "mailto")
12772 (let ((cmd (car org-link-mailto-program))
12773 (args (cdr org-link-mailto-program)) args1
12774 (address path) (subject "") a)
12776 (setq address (match-string 1 path)
12777 subject (org-link-escape (match-string 2 path))))
12778 (while args
12779 (cond
12780 ((not (stringp (car args))) (push (pop args) args1))
12781 (t (setq a (pop args))
12782 (if (string-match "%a" a)
12783 (setq a (replace-match address t t a)))
12784 (if (string-match "%s" a)
12785 (setq a (replace-match subject t t a)))
12786 (push a args1))))
12787 (apply cmd (nreverse args1))))
12789 ((member type '("http" "https" "ftp" "news"))
12790 (browse-url (concat type ":" (org-link-escape
12791 path org-link-escape-chars-browser))))
12793 ((member type '("message"))
12794 (browse-url (concat type ":" path)))
12796 ((string= type "tags")
12797 (org-tags-view in-emacs path))
12798 ((string= type "thisfile")
12799 (if in-emacs
12800 (switch-to-buffer-other-window
12801 (org-get-buffer-for-internal-link (current-buffer)))
12802 (org-mark-ring-push))
12803 (let ((cmd `(org-link-search
12804 ,path
12805 ,(cond ((equal in-emacs '(4)) 'occur)
12806 ((equal in-emacs '(16)) 'org-occur)
12807 (t nil))
12808 ,pos)))
12809 (condition-case nil (eval cmd)
12810 (error (progn (widen) (eval cmd))))))
12812 ((string= type "tree-match")
12815 ((string= type "file")
12817 (setq line (string-to-number (match-string 1 path))
12818 path (substring path 0 (match-beginning 0)))
12820 (setq search (match-string 1 path)
12821 path (substring path 0 (match-beginning 0)))))
12822 (if (string-match "[*?{]" (file-name-nondirectory path))
12823 (dired path)
12824 (org-open-file path in-emacs line search)))
12826 ((string= type "news")
12827 (org-follow-gnus-link path))
12829 ((string= type "bbdb")
12830 (org-follow-bbdb-link path))
12832 ((string= type "info")
12833 (org-follow-info-link path))
12835 ((string= type "gnus")
12836 (let (group article)
12838 (error "Error in Gnus link"))
12839 (setq group (match-string 1 path)
12840 article (match-string 3 path))
12841 (org-follow-gnus-link group article)))
12843 ((string= type "vm")
12844 (let (folder article)
12846 (error "Error in VM link"))
12847 (setq folder (match-string 1 path)
12848 article (match-string 3 path))
12849 ;; in-emacs is the prefix arg, will be interpreted as read-only
12850 (org-follow-vm-link folder article in-emacs)))
12852 ((string= type "wl")
12853 (let (folder article)
12855 (error "Error in Wanderlust link"))
12856 (setq folder (match-string 1 path)
12857 article (match-string 3 path))
12858 (org-follow-wl-link folder article)))
12860 ((string= type "mhe")
12861 (let (folder article)
12863 (error "Error in MHE link"))
12864 (setq folder (match-string 1 path)
12865 article (match-string 3 path))
12866 (org-follow-mhe-link folder article)))
12868 ((string= type "rmail")
12869 (let (folder article)
12871 (error "Error in RMAIL link"))
12872 (setq folder (match-string 1 path)
12873 article (match-string 3 path))
12874 (org-follow-rmail-link folder article)))
12876 ((string= type "shell")
12877 (let ((cmd path))
12878 (if (or (not org-confirm-shell-link-function)
12879 (funcall org-confirm-shell-link-function
12881 (org-add-props cmd nil
12882 'face 'org-warning))))
12883 (progn
12884 (message "Executing %s" cmd)
12885 (shell-command cmd))
12886 (error "Abort"))))
12888 ((string= type "elisp")
12889 (let ((cmd path))
12890 (if (or (not org-confirm-elisp-link-function)
12891 (funcall org-confirm-elisp-link-function
12893 (org-add-props cmd nil
12894 'face 'org-warning))))
12895 (message "%s => %s" cmd (eval (read cmd)))
12896 (error "Abort"))))
12898 (t
12899 (browse-url-at-point)))))
12900 (move-marker org-open-link-marker nil))
12902 ;;; File search
12904 (defvar org-create-file-search-functions nil
12905 "List of functions to construct the right search string for a file link.
12906 These functions are called in turn with point at the location to
12907 which the link should point.
12909 A function in the hook should first test if it would like to
12910 handle this file type, for example by checking the major-mode or
12911 the file extension. If it decides not to handle this file, it
12912 should just return nil to give other functions a chance. If it
12913 does handle the file, it must return the search string to be used
12914 when following the link. The search string will be part of the
12915 file link, given after a double colon, and `org-open-at-point'
12916 will automatically search for it. If special measures must be
12917 taken to make the search successful, another function should be
12918 added to the companion hook `org-execute-file-search-functions',
12919 which see.
12921 A function in this hook may also use `setq' to set the variable
12922 `description' to provide a suggestion for the descriptive text to
12923 be used for this link when it gets inserted into an Org-mode
12926 (defvar org-execute-file-search-functions nil
12927 "List of functions to execute a file search triggered by a link.
12929 Functions added to this hook must accept a single argument, the
12930 search string that was part of the file link, the part after the
12931 double colon. The function must first check if it would like to
12932 handle this search, for example by checking the major-mode or the
12933 file extension. If it decides not to handle this search, it
12934 should just return nil to give other functions a chance. If it
12935 does handle the search, it must return a non-nil value to keep
12936 other functions from trying.
12938 Each function can access the current prefix argument through the
12939 variable `current-prefix-argument'. Note that a single prefix is
12940 used to force opening a link in Emacs, so it may be good to only
12941 use a numeric or double prefix to guide the search function.
12943 In case this is needed, a function in this hook can also restore
12944 the window configuration before `org-open-at-point' was called using:
12946 (set-window-configuration org-window-config-before-follow-link)")
12948 (defun org-link-search (s &optional type avoid-pos)
12949 "Search for a link search option.
12950 If S is surrounded by forward slashes, it is interpreted as a
12951 regular expression. In org-mode files, this will create an `org-occur'
12952 sparse tree. In ordinary files, `occur' will be used to list matches.
12953 If the current buffer is in `dired-mode', grep will be used to search
12954 in all files. If AVOID-POS is given, ignore matches near that position."
12955 (let ((case-fold-search t)
12959 org-emphasis-alist)
12961 (pos (point))
12962 (pre "") (post "")
12963 words re0 re1 re2 re3 re4 re5 re2a reall)
12964 (cond
12965 ;; First check if there are any special
12966 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12967 ;; Now try the builtin stuff
12968 ((save-excursion
12969 (goto-char (point-min))
12970 (and
12971 (re-search-forward
12972 (concat "<<" (regexp-quote s0) ">>") nil t)
12973 (setq pos (match-beginning 0))))
12974 ;; There is an exact target for this
12975 (goto-char pos))
12977 ;; A regular expression
12978 (cond
12979 ((org-mode-p)
12980 (org-occur (match-string 1 s)))
12981 ;;((eq major-mode 'dired-mode)
12982 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12983 (t (org-do-occur (match-string 1 s)))))
12984 (t
12985 ;; A normal search strings
12986 (when (equal (string-to-char s) ?*)
12987 ;; Anchor on headlines, post may include tags.
12990 s (substring s 1)))
12991 (remove-text-properties
12992 0 (length s)
12993 '(face nil mouse-face nil keymap nil fontified nil) s)
12994 ;; Make a series of regular expressions to find a match
13001 re1 (concat pre re2 post)
13002 re3 (concat pre re4 post)
13003 re5 (concat pre ".*" re4)
13004 re2 (concat pre re2)
13005 re2a (concat pre re2a)
13006 re4 (concat pre re4)
13010 ))
13011 (cond
13012 ((eq type 'org-occur) (org-occur reall))
13013 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
13014 (t (goto-char (point-min))
13015 (if (or (org-search-not-self 1 re0 nil t)
13016 (org-search-not-self 1 re1 nil t)
13017 (org-search-not-self 1 re2 nil t)
13018 (org-search-not-self 1 re2a nil t)
13019 (org-search-not-self 1 re3 nil t)
13020 (org-search-not-self 1 re4 nil t)
13021 (org-search-not-self 1 re5 nil t)
13022 )
13023 (goto-char (match-beginning 1))
13024 (goto-char pos)
13025 (error "No match")))))
13026 (t
13027 ;; Normal string-search
13028 (goto-char (point-min))
13029 (if (search-forward s nil t)
13030 (goto-char (match-beginning 0))
13031 (error "No match"))))
13032 (and (org-mode-p) (org-show-context 'link-search))))
13034 (defun org-search-not-self (group &rest args)
13035 "Execute `re-search-forward', but only accept matches that do not
13036 enclose the position of `org-open-link-marker'."
13037 (let ((m org-open-link-marker))
13038 (catch 'exit
13039 (while (apply 're-search-forward args)
13040 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
13041 (goto-char (match-end group))
13042 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
13043 (> (match-beginning 0) (marker-position m))
13044 (< (match-end 0) (marker-position m)))
13045 (save-match-data
13046 (or (not (org-in-regexp
13047 org-bracket-link-analytic-regexp 1))
13048 (not (match-end 4)) ; no description
13049 (and (<= (match-beginning 4) (point))
13050 (>= (match-end 4) (point))))))
13051 (throw 'exit (point))))))))
13053 (defun org-get-buffer-for-internal-link (buffer)
13054 "Return a buffer to be used for displaying the link target of internal links."
13055 (cond
13056 ((not org-display-internal-link-with-indirect-buffer)
13057 buffer)
13058 ((string-match "(Clone)$" (buffer-name buffer))
13059 (message "Buffer is already a clone, not making another one")
13060 ;; we also do not modify visibility in this case
13061 buffer)
13062 (t ; make a new indirect buffer for displaying the link
13063 (let* ((bn (buffer-name buffer))
13064 (ibn (concat bn "(Clone)"))
13065 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13066 (with-current-buffer ib (org-overview))
13067 ib))))
13069 (defun org-do-occur (regexp &optional cleanup)
13070 "Call the Emacs command `occur'.
13071 If CLEANUP is non-nil, remove the printout of the regular expression
13072 in the *Occur* buffer. This is useful if the regex is long and not useful
13073 to read."
13074 (occur regexp)
13075 (when cleanup
13076 (let ((cwin (selected-window)) win beg end)
13077 (when (setq win (get-buffer-window "*Occur*"))
13078 (select-window win))
13079 (goto-char (point-min))
13080 (when (re-search-forward "match[a-z]+" nil t)
13081 (setq beg (match-end 0))
13083 (setq end (1- (match-beginning 0)))))
13084 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13085 (goto-char (point-min))
13086 (select-window cwin))))
13088 ;;; The mark ring for links jumps
13090 (defvar org-mark-ring nil
13091 "Mark ring for positions before jumps in Org-mode.")
13092 (defvar org-mark-ring-last-goto nil
13093 "Last position in the mark ring used to go back.")
13094 ;; Fill and close the ring
13095 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13096 (loop for i from 1 to org-mark-ring-length do
13097 (push (make-marker) org-mark-ring))
13098 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13099 org-mark-ring)
13101 (defun org-mark-ring-push (&optional pos buffer)
13102 "Put the current position or POS into the mark ring and rotate it."
13103 (interactive)
13104 (setq pos (or pos (point)))
13105 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13106 (move-marker (car org-mark-ring)
13107 (or pos (point))
13108 (or buffer (current-buffer)))
13109 (message "%s"
13110 (substitute-command-keys
13113 (defun org-mark-ring-goto (&optional n)
13114 "Jump to the previous position in the mark ring.
13115 With prefix arg N, jump back that many stored positions. When
13116 called several times in succession, walk through the entire ring.
13117 Org-mode commands jumping to a different position in the current file,
13118 or to another Org-mode file, automatically push the old position
13119 onto the ring."
13120 (interactive "p")
13121 (let (p m)
13122 (if (eq last-command this-command)
13123 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13124 (setq p org-mark-ring))
13125 (setq org-mark-ring-last-goto p)
13126 (setq m (car p))
13127 (switch-to-buffer (marker-buffer m))
13128 (goto-char m)
13129 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13131 (defun org-remove-angle-brackets (s)
13132 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13133 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13134 s)
13135 (defun org-add-angle-brackets (s)
13136 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13137 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13138 s)
13140 ;;; Following specific links
13142 (defun org-follow-timestamp-link ()
13143 (cond
13144 ((org-at-date-range-p t)
13145 (let ((org-agenda-start-on-weekday)
13146 (t1 (match-string 1))
13147 (t2 (match-string 2)))
13148 (setq t1 (time-to-days (org-time-string-to-time t1))
13149 t2 (time-to-days (org-time-string-to-time t2)))
13150 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13151 ((org-at-timestamp-p t)
13152 (org-agenda-list nil (time-to-days (org-time-string-to-time
13153 (substring (match-string 1) 0 10)))
13154 1))
13155 (t (error "This should not happen"))))
13158 (defun org-follow-bbdb-link (name)
13159 "Follow a BBDB link to NAME."
13160 (require 'bbdb)
13161 (let ((inhibit-redisplay (not debug-on-error))
13162 (bbdb-electric-p nil))
13163 (catch 'exit
13164 ;; Exact match on name
13166 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13167 ;; Exact match on name
13169 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13170 ;; Partial match on name
13171 (bbdb-name name nil)
13172 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13173 ;; Partial match on company
13174 (bbdb-company name nil)
13175 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13176 ;; General match including network address and notes
13177 (bbdb name nil)
13178 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13179 (delete-window (get-buffer-window "*BBDB*"))
13180 (error "No matching BBDB record")))))
13182 (defun org-follow-info-link (name)
13183 "Follow an info file & node link to NAME."
13186 (progn
13187 (require 'info)
13188 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13189 (Info-find-node (match-string 1 name) (match-string 2 name))
13190 (Info-find-node (match-string 1 name) "Top")))
13191 (message "Could not open: %s" name)))
13193 (defun org-follow-gnus-link (&optional group article)
13194 "Follow a Gnus link to GROUP and ARTICLE."
13195 (require 'gnus)
13196 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13197 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13198 (cond ((and group article)
13199 (gnus-group-read-group 1 nil group)
13200 (gnus-summary-goto-article (string-to-number article) nil t))
13201 (group (gnus-group-jump-to-group group))))
13203 (defun org-follow-vm-link (&optional folder article readonly)
13204 "Follow a VM link to FOLDER and ARTICLE."
13205 (require 'vm)
13206 (setq article (org-add-angle-brackets article))
13208 ;; ange-ftp or efs or tramp access
13209 (let ((user (or (match-string 1 folder) (user-login-name)))
13210 (host (match-string 2 folder))
13211 (file (match-string 3 folder)))
13212 (cond
13213 ((featurep 'tramp)
13214 ;; use tramp to access the file
13215 (if (featurep 'xemacs)
13216 (setq folder (format "[%s@%s]%s" user host file))
13217 (setq folder (format "/%s@%s:%s" user host file))))
13218 (t
13219 ;; use ange-ftp or efs
13220 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13221 (setq folder (format "/%s@%s:%s" user host file))))))
13222 (when folder
13223 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13224 (sit-for 0.1)
13225 (when article
13226 (vm-select-folder-buffer)
13227 (widen)
13228 (let ((case-fold-search t))
13229 (goto-char (point-min))
13230 (if (not (re-search-forward
13231 (concat "^" "message-id: *" (regexp-quote article))))
13232 (error "Could not find the specified message in this folder"))
13233 (vm-isearch-update)
13234 (vm-isearch-narrow)
13235 (vm-beginning-of-message)
13236 (vm-summarize)))))
13238 (defun org-follow-wl-link (folder article)
13239 "Follow a Wanderlust link to FOLDER and ARTICLE."
13240 (if (and (string= folder "%")
13241 article
13243 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13244 ;; Thus, we recompose folder and article ids.
13245 (setq folder (format "%s#%s" folder (match-string 1 article))
13246 article (match-string 3 article)))
13247 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13248 (error "No such folder: %s" folder))
13249 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13250 (and article
13251 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13252 (wl-summary-redisplay)))
13254 (defun org-follow-rmail-link (folder article)
13255 "Follow an RMAIL link to FOLDER and ARTICLE."
13256 (setq article (org-add-angle-brackets article))
13257 (let (message-number)
13258 (save-excursion
13259 (save-window-excursion
13260 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13261 (setq message-number
13262 (save-restriction
13263 (widen)
13264 (goto-char (point-max))
13265 (if (re-search-backward
13267 (or article "")))
13268 nil t)
13269 (rmail-what-message))))))
13270 (if message-number
13271 (progn
13272 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13273 (rmail-show-message message-number)
13274 message-number)
13275 (error "Message not found"))))
13277 ;;; mh-e integration based on planner-mode
13278 (defun org-mhe-get-message-real-folder ()
13279 "Return the name of the current message real folder, so if you use
13280 sequences, it will now work."
13281 (save-excursion
13282 (let* ((folder
13283 (if (equal major-mode 'mh-folder-mode)
13284 mh-current-folder
13285 ;; Refer to the show buffer
13286 mh-show-folder-buffer))
13287 (end-index
13288 (if (boundp 'mh-index-folder)
13289 (min (length mh-index-folder) (length folder))))
13290 )
13291 ;; a simple test on mh-index-data does not work, because
13292 ;; mh-index-data is always nil in a show buffer.
13293 (if (and (boundp 'mh-index-folder)
13294 (string= mh-index-folder (substring folder 0 end-index)))
13295 (if (equal major-mode 'mh-show-mode)
13296 (save-window-excursion
13297 (let (pop-up-frames)
13298 (when (buffer-live-p (get-buffer folder))
13299 (progn
13300 (pop-to-buffer folder)
13301 (org-mhe-get-message-folder-from-index)
13302 )
13303 )))
13304 (org-mhe-get-message-folder-from-index)
13305 )
13306 folder
13307 )
13308 )))
13310 (defun org-mhe-get-message-folder-from-index ()
13311 "Returns the name of the message folder in a index folder buffer."
13312 (save-excursion
13313 (mh-index-previous-folder)
13315 (message "%s" (match-string 1))))
13317 (defun org-mhe-get-message-folder ()
13318 "Return the name of the current message folder. Be careful if you
13319 use sequences."
13320 (save-excursion
13321 (if (equal major-mode 'mh-folder-mode)
13322 mh-current-folder
13323 ;; Refer to the show buffer
13324 mh-show-folder-buffer)))
13326 (defun org-mhe-get-message-num ()
13327 "Return the number of the current message. Be careful if you
13328 use sequences."
13329 (save-excursion
13330 (if (equal major-mode 'mh-folder-mode)
13331 (mh-get-msg-num nil)
13332 ;; Refer to the show buffer
13333 (mh-show-buffer-message-number))))
13335 (defun org-mhe-get-header (header)
13336 "Return a header of the message in folder mode. This will create a
13337 show buffer for the corresponding message. If you have a more clever
13338 idea..."
13339 (let* ((folder (org-mhe-get-message-folder))
13340 (num (org-mhe-get-message-num))
13341 (buffer (get-buffer-create (concat "show-" folder)))
13342 (header-field))
13343 (with-current-buffer buffer
13344 (mh-display-msg num folder)
13345 (if (equal major-mode 'mh-folder-mode)
13346 (mh-header-display)
13347 (mh-show-header-display))
13348 (set-buffer buffer)
13349 (setq header-field (mh-get-header-field header))
13350 (if (equal major-mode 'mh-folder-mode)
13351 (mh-show)
13352 (mh-show-show))
13353 header-field)))
13355 (defun org-follow-mhe-link (folder article)
13356 "Follow an MHE link to FOLDER and ARTICLE.
13357 If ARTICLE is nil FOLDER is shown. If the configuration variable
13358 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13359 ARTICLE is searched in all folders. Indexed searches (swish++,
13360 namazu, and others supported by MH-E) will always search in all
13361 folders."
13362 (require 'mh-e)
13363 (require 'mh-search)
13364 (require 'mh-utils)
13365 (mh-find-path)
13366 (if (not article)
13367 (mh-visit-folder (mh-normalize-folder-name folder))
13368 (setq article (org-add-angle-brackets article))
13369 (mh-search-choose)
13370 (if (equal mh-searcher 'pick)
13371 (progn
13372 (mh-search folder (list "--message-id" article))
13373 (when (and org-mhe-search-all-folders
13374 (not (org-mhe-get-message-real-folder)))
13375 (kill-this-buffer)
13376 (mh-search "+" (list "--message-id" article))))
13377 (mh-search "+" article))
13378 (if (org-mhe-get-message-real-folder)
13379 (mh-show-msg 1)
13380 (kill-this-buffer)
13381 (error "Message not found"))))
13383 ;;; BibTeX links
13385 ;; Use the custom search meachnism to construct and use search strings for
13386 ;; file links to BibTeX database entries.
13388 (defun org-create-file-search-in-bibtex ()
13389 "Create the search string and description for a BibTeX database entry."
13390 (when (eq major-mode 'bibtex-mode)
13391 ;; yes, we want to construct this search string.
13392 ;; Make a good description for this entry, using names, year and the title
13393 ;; Put it into the `description' variable which is dynamically scoped.
13394 (let ((bibtex-autokey-names 1)
13395 (bibtex-autokey-names-stretch 1)
13396 (bibtex-autokey-name-case-convert-function 'identity)
13397 (bibtex-autokey-name-separator " & ")
13398 (bibtex-autokey-additional-names " et al.")
13399 (bibtex-autokey-year-length 4)
13400 (bibtex-autokey-name-year-separator " ")
13401 (bibtex-autokey-titlewords 3)
13402 (bibtex-autokey-titleword-separator " ")
13403 (bibtex-autokey-titleword-case-convert-function 'identity)
13404 (bibtex-autokey-titleword-length 'infty)
13405 (bibtex-autokey-year-title-separator ": "))
13406 (setq description (bibtex-generate-autokey)))
13407 ;; Now parse the entry, get the key and return it.
13408 (save-excursion
13409 (bibtex-beginning-of-entry)
13410 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13412 (defun org-execute-file-search-in-bibtex (s)
13413 "Find the link search string S as a key for a database entry."
13414 (when (eq major-mode 'bibtex-mode)
13415 ;; Yes, we want to do the search in this file.
13416 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13417 (goto-char (point-min))
13420 (goto-char (match-beginning 0)))
13421 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13422 ;; Use double prefix to indicate that any web link should be browsed
13423 (let ((b (current-buffer)) (p (point)))
13424 ;; Restore the window configuration because we just use the web link
13425 (set-window-configuration org-window-config-before-follow-link)
13426 (save-excursion (set-buffer b) (goto-char p)
13427 (bibtex-url)))
13428 (recenter 0)) ; Move entry start to beginning of window
13429 ;; return t to indicate that the search is done.
13430 t))
13432 ;; Finally add the functions to the right hooks.
13433 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13434 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13436 ;; end of Bibtex link setup
13438 ;;; Following file links
13440 (defun org-open-file (path &optional in-emacs line search)
13441 "Open the file at PATH.
13442 First, this expands any special file name abbreviations. Then the
13443 configuration variable `org-file-apps' is checked if it contains an
13444 entry for this file type, and if yes, the corresponding command is launched.
13445 If no application is found, Emacs simply visits the file.
13446 With optional argument IN-EMACS, Emacs will visit the file.
13447 Optional LINE specifies a line to go to, optional SEARCH a string to
13448 search for. If LINE or SEARCH is given, the file will always be
13449 opened in Emacs.
13450 If the file does not exist, an error is thrown."
13451 (setq in-emacs (or in-emacs line search))
13452 (let* ((file (if (equal path "")
13453 buffer-file-name
13454 (substitute-in-file-name (expand-file-name path))))
13455 (apps (append org-file-apps (org-default-apps)))
13456 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13457 (dirp (if remp nil (file-directory-p file)))
13458 (dfile (downcase file))
13459 (old-buffer (current-buffer))
13460 (old-pos (point))
13461 (old-mode major-mode)
13462 ext cmd)
13464 (setq ext (match-string 1 dfile))
13466 (setq ext (match-string 1 dfile))))
13467 (if in-emacs
13468 (setq cmd 'emacs)
13469 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13470 (and dirp (cdr (assoc 'directory apps)))
13471 (cdr (assoc ext apps))
13472 (cdr (assoc t apps)))))
13473 (when (eq cmd 'mailcap)
13474 (require 'mailcap)
13475 (mailcap-parse-mailcaps)
13476 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13477 (command (mailcap-mime-info mime-type)))
13478 (if (stringp command)
13479 (setq cmd command)
13480 (setq cmd 'emacs))))
13481 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13482 (not (file-exists-p file))
13483 (not org-open-non-existing-files))
13484 (error "No such file: %s" file))
13485 (cond
13487 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13489 (setq cmd (replace-match "%s" t t cmd)))
13490 (while (string-match "%s" cmd)
13491 (setq cmd (replace-match
13492 (save-match-data (shell-quote-argument file))
13493 t t cmd)))
13494 (save-window-excursion
13495 (start-process-shell-command cmd nil cmd)))
13496 ((or (stringp cmd)
13497 (eq cmd 'emacs))
13498 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13499 (widen)
13500 (if line (goto-line line)
13501 (if search (org-link-search search))))
13502 ((consp cmd)
13503 (eval cmd))
13504 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13505 (and (org-mode-p) (eq old-mode 'org-mode)
13506 (or (not (equal old-buffer (current-buffer)))
13507 (not (equal old-pos (point))))
13508 (org-mark-ring-push old-pos old-buffer))))
13510 (defun org-default-apps ()
13511 "Return the default applications for this operating system."
13512 (cond
13513 ((eq system-type 'darwin)
13514 org-file-apps-defaults-macosx)
13515 ((eq system-type 'windows-nt)
13516 org-file-apps-defaults-windowsnt)
13517 (t org-file-apps-defaults-gnu)))
13519 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13520 (defun org-file-remote-p (file)
13521 "Test whether FILE specifies a location on a remote system.
13522 Return non-nil if the location is indeed remote.
13526 (cond ((fboundp 'file-remote-p)
13527 (file-remote-p file))
13528 ((fboundp 'tramp-handle-file-remote-p)
13529 (tramp-handle-file-remote-p file))
13530 ((and (boundp 'ange-ftp-name-format)
13531 (string-match (car ange-ftp-name-format) file))
13532 t)
13533 (t nil)))
13536 ;;;; Hooks for remember.el, and refiling
13538 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13539 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13541 ;;;###autoload
13542 (defun org-remember-insinuate ()
13543 "Setup remember.el for use wiht Org-mode."
13544 (require 'remember)
13545 (setq remember-annotation-functions '(org-remember-annotation))
13546 (setq remember-handler-functions '(org-remember-handler))
13547 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13549 ;;;###autoload
13550 (defun org-remember-annotation ()
13551 "Return a link to the current location as an annotation for remember.el.
13552 If you are using Org-mode files as target for data storage with
13553 remember.el, then the annotations should include a link compatible with the
13554 conventions in Org-mode. This function returns such a link."
13555 (org-store-link nil))
13557 (defconst org-remember-help
13558 "Select a destination location for the note.
13559 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13560 RET on headline -> Store as sublevel entry to current headline
13561 RET at beg-of-buf -> Append to file as level 2 headline
13562 <left>/<right> -> before/after current headline, same headings level")
13564 (defvar org-remember-previous-location nil)
13565 (defvar org-force-remember-template-char) ;; dynamically scoped
13567 (defun org-select-remember-template (&optional use-char)
13568 (when org-remember-templates
13569 (let* ((templates (mapcar (lambda (x)
13570 (if (stringp (car x))
13571 (append (list (nth 1 x) (car x)) (cddr x))
13572 (append (list (car x) "") (cdr x))))
13573 org-remember-templates))
13574 (char (or use-char
13575 (cond
13576 ((= (length templates) 1)
13577 (caar templates))
13578 ((and (boundp 'org-force-remember-template-char)
13579 org-force-remember-template-char)
13580 (if (stringp org-force-remember-template-char)
13581 (string-to-char org-force-remember-template-char)
13582 org-force-remember-template-char))
13583 (t
13584 (message "Select template: %s"
13585 (mapconcat
13586 (lambda (x)
13587 (cond
13589 (format "[%c]" (car x)))
13590 ((equal (downcase (car x))
13591 (downcase (aref (nth 1 x) 0)))
13592 (format "[%c]%s" (car x)
13593 (substring (nth 1 x) 1)))
13594 (t (format "[%c]%s" (car x) (nth 1 x)))))
13595 templates " "))
13596 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13597 (when (equal char0 ?\C-g)
13598 (jump-to-register remember-register)
13599 (kill-buffer remember-buffer))
13600 char0))))))
13601 (cddr (assoc char templates)))))
13603 (defvar x-last-selected-text)
13604 (defvar x-last-selected-text-primary)
13606 ;;;###autoload
13607 (defun org-remember-apply-template (&optional use-char skip-interactive)
13608 "Initialize *remember* buffer with template, invoke `org-mode'.
13609 This function should be placed into `remember-mode-hook' and in fact requires
13610 to be run from that hook to function properly."
13611 (if org-remember-templates
13612 (let* ((entry (org-select-remember-template use-char))
13613 (tpl (car entry))
13614 (plist-p (if org-store-link-plist t nil))
13615 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13617 (nth 1 entry)
13618 org-default-notes-file))
13619 (headline (nth 2 entry))
13620 (v-c (or (and (eq window-system 'x)
13621 (fboundp 'x-cut-buffer-or-selection-value)
13622 (x-cut-buffer-or-selection-value))
13623 (org-bound-and-true-p x-last-selected-text)
13624 (org-bound-and-true-p x-last-selected-text-primary)
13625 (and (> (length kill-ring) 0) (current-kill 0))))
13626 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13627 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13628 (v-u (concat "[" (substring v-t 1 -1) "]"))
13629 (v-U (concat "[" (substring v-T 1 -1) "]"))
13630 ;; `initial' and `annotation' are bound in `remember'
13631 (v-i (if (boundp 'initial) initial))
13632 (v-a (if (and (boundp 'annotation) annotation)
13633 (if (equal annotation "[[]]") "" annotation)
13634 ""))
13635 (v-A (if (and v-a
13638 v-a))
13639 (v-n user-full-name)
13640 (org-startup-folded nil)
13641 org-time-was-given org-end-time-was-given x
13642 prompt completions char time pos default histvar)
13643 (setq org-store-link-plist
13644 (append (list :annotation v-a :initial v-i)
13645 org-store-link-plist))
13646 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13647 (erase-buffer)
13648 (insert (substitute-command-keys
13649 (format
13650 "## Filing location: Select interactively, default, or last used:
13651 ## %s to select file and header location interactively.
13655 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13656 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13657 (abbreviate-file-name (or file org-default-notes-file))
13658 (or headline "")
13659 (or (car org-remember-previous-location) "???")
13660 (or (cdr org-remember-previous-location) "???"))))
13661 (insert tpl) (goto-char (point-min))
13662 ;; Simple %-escapes
13664 (when (and initial (equal (match-string 0) "%i"))
13665 (save-match-data
13666 (let* ((lead (buffer-substring
13667 (point-at-bol) (match-beginning 0))))
13668 (setq v-i (mapconcat 'identity
13671 (replace-match
13672 (or (eval (intern (concat "v-" (match-string 1)))) "")
13673 t t))
13675 ;; %[] Insert contents of a file.
13676 (goto-char (point-min))
13678 (let ((start (match-beginning 0))
13679 (end (match-end 0))
13680 (filename (expand-file-name (match-string 1))))
13681 (goto-char start)
13682 (delete-region start end)
13683 (condition-case error
13684 (insert-file-contents filename)
13685 (error (insert (format "%%![Couldn't insert %s: %s]"
13686 filename error))))))
13687 ;; %() embedded elisp
13688 (goto-char (point-min))
13690 (goto-char (match-beginning 0))
13691 (let ((template-start (point)))
13692 (forward-char 1)
13693 (let ((result
13694 (condition-case error
13695 (eval (read (current-buffer)))
13696 (error (format "%%![Error: %s]" error)))))
13697 (delete-region template-start (point))
13698 (insert result))))
13700 ;; From the property list
13701 (when plist-p
13702 (goto-char (point-min))
13704 (and (setq x (or (plist-get org-store-link-plist
13705 (intern (match-string 1))) ""))
13706 (replace-match x t t))))
13708 ;; Turn on org-mode in the remember buffer, set local variables
13709 (org-mode)
13710 (org-set-local 'org-finish-function 'org-remember-finalize)
13712 (org-set-local 'org-default-notes-file file))
13714 (org-set-local 'org-remember-default-headline headline))
13715 ;; Interactive template entries
13716 (goto-char (point-min))
13718 (setq char (if (match-end 3) (match-string 3))
13719 prompt (if (match-end 2) (match-string 2)))
13720 (goto-char (match-beginning 0))
13721 (replace-match "")
13722 (setq completions nil default nil)
13723 (when prompt
13724 (setq completions (org-split-string prompt "|")
13725 prompt (pop completions)
13726 default (car completions)
13727 histvar (intern (concat
13728 "org-remember-template-prompt-history::"
13729 (or prompt "")))
13730 completions (mapcar 'list completions)))
13731 (cond
13732 ((member char '("G" "g"))
13733 (let* ((org-last-tags-completion-table
13734 (org-global-tags-completion-table
13735 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13736 (org-add-colon-after-tag-completion t)
13737 (ins (completing-read
13738 (if prompt (concat prompt ": ") "Tags: ")
13739 'org-tags-completion-function nil nil nil
13740 'org-tags-history)))
13741 (setq ins (mapconcat 'identity
13742 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13743 ":"))
13745 (or (equal (char-before) ?:) (insert ":"))
13746 (insert ins)
13747 (or (equal (char-after) ?:) (insert ":")))))
13748 (char
13749 (setq org-time-was-given (equal (upcase char) char))
13750 (setq time (org-read-date (equal (upcase char) "U") t nil
13751 prompt))
13752 (org-insert-time-stamp time org-time-was-given
13753 (member char '("u" "U"))
13754 nil nil (list org-end-time-was-given)))
13755 (t
13756 (insert (org-completing-read
13757 (concat (if prompt prompt "Enter string")
13758 (if default (concat " [" default "]"))
13759 ": ")
13760 completions nil nil nil histvar default)))))
13761 (goto-char (point-min))
13763 (replace-match "")
13765 (org-mode)
13766 (org-set-local 'org-finish-function 'org-remember-finalize))
13767 (when (save-excursion
13768 (goto-char (point-min))
13769 (re-search-forward "%!" nil t))
13770 (replace-match "")
13771 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13773 (defun org-remember-finish-immediately ()
13774 "File remember note immediately.
13775 This should be run in `post-command-hook' and will remove itself
13776 from that hook."
13777 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13778 (when org-finish-function
13779 (funcall org-finish-function)))
13781 (defvar org-clock-marker) ; Defined below
13782 (defun org-remember-finalize ()
13783 "Finalize the remember process."
13784 (unless (fboundp 'remember-finalize)
13785 (defalias 'remember-finalize 'remember-buffer))
13786 (when (and org-clock-marker
13787 (equal (marker-buffer org-clock-marker) (current-buffer)))
13788 ;; FIXME: test this, this is w/o notetaking!
13789 (let (org-log-note-clock-out) (org-clock-out)))
13790 (when buffer-file-name
13791 (save-buffer)
13792 (setq buffer-file-name nil))
13793 (remember-finalize))
13795 ;;;###autoload
13796 (defun org-remember (&optional goto org-force-remember-template-char)
13797 "Call `remember'. If this is already a remember buffer, re-apply template.
13798 If there is an active region, make sure remember uses it as initial content
13799 of the remember buffer.
13801 When called interactively with a `C-u' prefix argument GOTO, don't remember
13802 anything, just go to the file/headline where the selected template usually
13803 stores its notes. With a double prefix arg `C-u C-u', go to the last
13804 note stored by remember.
13806 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13807 associated with a template in `org-remember-templates'."
13808 (interactive "P")
13809 (cond
13810 ((equal goto '(4)) (org-go-to-remember-target))
13811 ((equal goto '(16)) (org-remember-goto-last-stored))
13812 (t
13813 (if (memq org-finish-function '(remember-buffer remember-finalize))
13814 (progn
13815 (when (< (length org-remember-templates) 2)
13816 (error "No other template available"))
13817 (erase-buffer)
13818 (let ((annotation (plist-get org-store-link-plist :annotation))
13819 (initial (plist-get org-store-link-plist :initial)))
13820 (org-remember-apply-template))
13821 (message "Press C-c C-c to remember data"))
13822 (if (org-region-active-p)
13823 (remember (buffer-substring (point) (mark)))
13824 (call-interactively 'remember))))))
13826 (defun org-remember-goto-last-stored ()
13827 "Go to the location where the last remember note was stored."
13828 (interactive)
13829 (bookmark-jump "org-remember-last-stored")
13830 (message "This is the last note stored by remember"))
13832 (defun org-go-to-remember-target (&optional template-key)
13833 "Go to the target location of a remember template.
13834 The user is queried for the template."
13835 (interactive)
13836 (let* ((entry (org-select-remember-template template-key))
13837 (file (nth 1 entry))
13838 (heading (nth 2 entry))
13839 visiting)
13841 (setq file org-default-notes-file))
13843 (setq heading org-remember-default-headline))
13844 (setq visiting (org-find-base-buffer-visiting file))
13845 (if (not visiting) (find-file-noselect file))
13846 (switch-to-buffer (or visiting (get-file-buffer file)))
13847 (widen)
13848 (goto-char (point-min))
13849 (if (re-search-forward
13852 nil t)
13853 (goto-char (match-beginning 0))
13854 (error "Target headline not found: %s" heading))))
13856 (defvar org-note-abort nil) ; dynamically scoped
13858 ;;;###autoload
13859 (defun org-remember-handler ()
13860 "Store stuff from remember.el into an org file.
13861 First prompts for an org file. If the user just presses return, the value
13862 of `org-default-notes-file' is used.
13863 Then the command offers the headings tree of the selected file in order to
13864 file the text at a specific location.
13865 You can either immediately press RET to get the note appended to the
13866 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13867 find a better place. Then press RET or <left> or <right> in insert the note.
13869 Key Cursor position Note gets inserted
13870 -----------------------------------------------------------------------------
13871 RET buffer-start as level 1 heading at end of file
13872 RET on headline as sublevel of the heading at cursor
13873 RET no heading at cursor position, level taken from context.
13874 Or use prefix arg to specify level manually.
13875 <left> on headline as same level, before current heading
13876 <right> on headline as same level, after current heading
13878 So the fastest way to store the note is to press RET RET to append it to
13879 the default file. This way your current train of thought is not
13880 interrupted, in accordance with the principles of remember.el.
13881 You can also get the fast execution without prompting by using
13882 C-u C-c C-c to exit the remember buffer. See also the variable
13883 `org-remember-store-without-prompt'.
13885 Before being stored away, the function ensures that the text has a
13887 is constructed from the current date and some additional data.
13889 If the variable `org-adapt-indentation' is non-nil, the entire text is
13890 also indented so that it starts in the same column as the headline
13891 \(i.e. after the stars).
13893 See also the variable `org-reverse-note-order'."
13894 (goto-char (point-min))
13896 (replace-match ""))
13897 (goto-char (point-max))
13898 (beginning-of-line 1)
13900 (delete-region (1- (point)) (point-max))
13901 (beginning-of-line 1))
13902 (catch 'quit
13903 (if org-note-abort (throw 'quit nil))
13904 (let* ((txt (buffer-substring (point-min) (point-max)))
13905 (fastp (org-xor (equal current-prefix-arg '(4))
13906 org-remember-store-without-prompt))
13907 (file (cond
13908 (fastp org-default-notes-file)
13909 ((and (eq org-remember-interactive-interface 'refile)
13910 org-refile-targets)
13911 org-default-notes-file)
13912 ((not (and (equal current-prefix-arg '(16))
13913 org-remember-previous-location))
13914 (org-get-org-file))))
13915 (heading org-remember-default-headline)
13916 (visiting (and file (org-find-base-buffer-visiting file)))
13917 (org-startup-folded nil)
13918 (org-startup-align-all-tables nil)
13919 (org-goto-start-pos 1)
13920 spos exitcmd level indent reversed)
13921 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13922 (setq file (car org-remember-previous-location)
13923 heading (cdr org-remember-previous-location)
13924 fastp t))
13925 (setq current-prefix-arg nil)
13927 (setq txt (replace-match "" t t txt)))
13928 ;; Modify text so that it becomes a nice subtree which can be inserted
13929 ;; into an org tree.
13931 first)
13932 (setq first (car lines) lines (cdr lines))
13934 ;; Is already a headline
13935 (setq indent nil)
13936 ;; We need to add a headline: Use time and first buffer line
13937 (setq lines (cons first lines)
13938 first (concat "* " (current-time-string)
13939 " (" (remember-buffer-desc) ")")
13940 indent " "))
13941 (if (and org-adapt-indentation indent)
13942 (setq lines (mapcar
13943 (lambda (x)
13945 (concat indent x) x))
13946 lines)))
13953 ;; Put the modified text back into the remember buffer, for refile.
13954 (erase-buffer)
13955 (insert txt)
13956 (goto-char (point-min))
13957 (when (and (eq org-remember-interactive-interface 'refile)
13958 (not fastp))
13959 (org-refile nil (or visiting (find-file-noselect file)))
13960 (throw 'quit t))
13961 ;; Find the file
13962 (if (not visiting) (find-file-noselect file))
13963 (with-current-buffer (or visiting (get-file-buffer file))
13964 (unless (org-mode-p)
13965 (error "Target files for remember notes must be in Org-mode"))
13966 (save-excursion
13967 (save-restriction
13968 (widen)
13969 (and (goto-char (point-min))
13972 (setq reversed (org-notes-order-reversed-p))
13974 ;; Find the default location
13976 (goto-char (point-min))
13977 (if (re-search-forward
13980 nil t)
13981 (setq org-goto-start-pos (match-beginning 0))
13982 (when fastp
13983 (goto-char (point-max))
13984 (unless (bolp) (newline))
13986 (setq org-goto-start-pos (point-at-bol 0)))))
13988 ;; Ask the User for a location, using the appropriate interface
13989 (cond
13990 (fastp (setq spos org-goto-start-pos
13991 exitcmd 'return))
13992 ((eq org-remember-interactive-interface 'outline)
13993 (setq spos (org-get-location (current-buffer)
13994 org-remember-help)
13995 exitcmd (cdr spos)
13996 spos (car spos)))
13997 ((eq org-remember-interactive-interface 'outline-path-completion)
13998 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13999 (org-refile-use-outline-path t))
14000 (setq spos (org-refile-get-location "Heading: ")
14001 exitcmd 'return
14002 spos (nth 3 spos))))
14003 (t (error "this should not hapen")))
14004 (if (not spos) (throw 'quit nil)) ; return nil to show we did
14005 ; not handle this note
14006 (goto-char spos)
14007 (cond ((org-on-heading-p t)
14008 (org-back-to-heading t)
14009 (setq level (funcall outline-level))
14010 (cond
14011 ((eq exitcmd 'return)
14012 ;; sublevel of current
14013 (setq org-remember-previous-location
14014 (cons (abbreviate-file-name file)
14015 (org-get-heading 'notags)))
14016 (if reversed
14017 (outline-next-heading)
14018 (org-end-of-subtree t)
14019 (if (not (bolp))
14021 (beginning-of-line 2)
14022 (end-of-line 1)
14024 (bookmark-set "org-remember-last-stored")
14025 (org-paste-subtree (org-get-legal-level level 1) txt))
14026 ((eq exitcmd 'left)
14027 ;; before current
14028 (bookmark-set "org-remember-last-stored")
14029 (org-paste-subtree level txt))
14030 ((eq exitcmd 'right)
14031 ;; after current
14032 (org-end-of-subtree t)
14033 (bookmark-set "org-remember-last-stored")
14034 (org-paste-subtree level txt))
14035 (t (error "This should not happen"))))
14037 ((and (bobp) (not reversed))
14038 ;; Put it at the end, one level below level 1
14039 (save-restriction
14040 (widen)
14041 (goto-char (point-max))
14042 (if (not (bolp)) (newline))
14043 (bookmark-set "org-remember-last-stored")
14044 (org-paste-subtree (org-get-legal-level 1 1) txt)))
14046 ((and (bobp) reversed)
14047 ;; Put it at the start, as level 1
14048 (save-restriction
14049 (widen)
14050 (goto-char (point-min))
14052 (beginning-of-line 1)
14053 (bookmark-set "org-remember-last-stored")
14054 (org-paste-subtree 1 txt)))
14055 (t
14056 ;; Put it right there, with automatic level determined by
14057 ;; org-paste-subtree or from prefix arg
14058 (bookmark-set "org-remember-last-stored")
14059 (org-paste-subtree
14060 (if (numberp current-prefix-arg) current-prefix-arg)
14061 txt)))
14062 (when remember-save-after-remembering
14063 (save-buffer)
14064 (if (not visiting) (kill-buffer (current-buffer)))))))))
14066 t) ;; return t to indicate that we took care of this note.
14068 (defun org-get-org-file ()
14069 "Read a filename, with default directory `org-directory'."
14070 (let ((default (or org-default-notes-file remember-data-file)))
14071 (read-file-name (format "File name [%s]: " default)
14072 (file-name-as-directory org-directory)
14073 default)))
14075 (defun org-notes-order-reversed-p ()
14076 "Check if the current file should receive notes in reversed order."
14077 (cond
14078 ((not org-reverse-note-order) nil)
14079 ((eq t org-reverse-note-order) t)
14080 ((not (listp org-reverse-note-order)) nil)
14081 (t (catch 'exit
14082 (let ((all org-reverse-note-order)
14083 entry)
14084 (while (setq entry (pop all))
14085 (if (string-match (car entry) buffer-file-name)
14086 (throw 'exit (cdr entry))))
14087 nil)))))
14089 ;;; Refiling
14091 (defvar org-refile-target-table nil
14092 "The list of refile targets, created by `org-refile'.")
14094 (defvar org-agenda-new-buffers nil
14095 "Buffers created to visit agenda files.")
14097 (defun org-get-refile-targets (&optional default-buffer)
14098 "Produce a table with refile targets."
14099 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
14100 targets txt re files f desc descre)
14101 (with-current-buffer (or default-buffer (current-buffer))
14102 (while (setq entry (pop entries))
14103 (setq files (car entry) desc (cdr entry))
14104 (cond
14105 ((null files) (setq files (list (current-buffer))))
14106 ((eq files 'org-agenda-files)
14107 (setq files (org-agenda-files 'unrestricted)))
14108 ((and (symbolp files) (fboundp files))
14109 (setq files (funcall files)))
14110 ((and (symbolp files) (boundp files))
14111 (setq files (symbol-value files))))
14112 (if (stringp files) (setq files (list files)))
14113 (cond
14114 ((eq (car desc) :tag)
14116 ((eq (car desc) :todo)
14118 ((eq (car desc) :regexp)
14119 (setq descre (cdr desc)))
14120 ((eq (car desc) :level)
14122 (if org-odd-levels-only
14123 (1- (* 2 (cdr desc)))
14124 (cdr desc)))
14126 ((eq (car desc) :maxlevel)
14128 (if org-odd-levels-only
14129 (1- (* 2 (cdr desc)))
14130 (cdr desc)))
14132 (t (error "Bad refiling target description %s" desc)))
14133 (while (setq f (pop files))
14134 (save-excursion
14135 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14136 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14137 (save-excursion
14138 (save-restriction
14139 (widen)
14140 (goto-char (point-min))
14141 (while (re-search-forward descre nil t)
14142 (goto-char (point-at-bol))
14143 (when (looking-at org-complex-heading-regexp)
14144 (setq txt (match-string 4)
14145 re (concat "^" (regexp-quote
14146 (buffer-substring (match-beginning 1)
14147 (match-end 4)))))
14149 (regexp-quote
14150 (match-string 5)))))
14152 (when org-refile-use-outline-path
14153 (setq txt (mapconcat 'identity
14154 (append
14155 (if (eq org-refile-use-outline-path 'file)
14156 (list (file-name-nondirectory
14157 (buffer-file-name (buffer-base-buffer))))
14158 (if (eq org-refile-use-outline-path 'full-file-path)
14159 (list (buffer-file-name (buffer-base-buffer)))))
14160 (org-get-outline-path)
14161 (list txt))
14162 "/")))
14163 (push (list txt f re (point)) targets))
14164 (goto-char (point-at-eol))))))))
14165 (nreverse targets))))
14167 (defun org-get-outline-path ()
14168 "Return the outline path to the current entry, as a list."
14169 (let (rtn)
14170 (save-excursion
14171 (while (org-up-heading-safe)
14172 (when (looking-at org-complex-heading-regexp)
14173 (push (org-match-string-no-properties 4) rtn)))
14174 rtn)))
14176 (defvar org-refile-history nil
14177 "History for refiling operations.")
14179 (defun org-refile (&optional goto default-buffer)
14180 "Move the entry at point to another heading.
14181 The list of target headings is compiled using the information in
14182 `org-refile-targets', which see. This list is created upon first use, and
14183 you can update it by calling this command with a double prefix (`C-u C-u').
14184 FIXME: Can we find a better way of updating?
14186 At the target location, the entry is filed as a subitem of the target heading.
14187 Depending on `org-reverse-note-order', the new subitem will either be the
14188 first of the last subitem.
14190 With prefix arg GOTO, the command will only visit the target location,
14191 not actually move anything.
14192 With a double prefix `C-c C-c', go to the location where the last refiling
14193 operation has put the subtree.
14195 With a double prefix argument, the command can be used to jump to any
14196 heading in the current buffer."
14197 (interactive "P")
14198 (let* ((cbuf (current-buffer))
14199 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14200 pos it nbuf file re level reversed)
14201 (if (equal goto '(16))
14202 (org-refile-goto-last-stored)
14203 (when (setq it (org-refile-get-location
14204 (if goto "Goto: " "Refile to: ") default-buffer))
14205 (setq file (nth 1 it)
14206 re (nth 2 it)
14207 pos (nth 3 it))
14208 (setq nbuf (or (find-buffer-visiting file)
14209 (find-file-noselect file)))
14210 (if goto
14211 (progn
14212 (switch-to-buffer nbuf)
14213 (goto-char pos)
14214 (org-show-context 'org-goto))
14215 (org-copy-special)
14216 (save-excursion
14217 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14218 (find-file-noselect file))))
14219 (setq reversed (org-notes-order-reversed-p))
14220 (save-excursion
14221 (save-restriction
14222 (widen)
14223 (goto-char pos)
14224 (looking-at outline-regexp)
14225 (setq level (org-get-legal-level (funcall outline-level) 1))
14226 (goto-char
14227 (if reversed
14228 (outline-next-heading)
14229 (or (save-excursion (outline-get-next-sibling))
14230 (org-end-of-subtree t t)
14231 (point-max))))
14232 (bookmark-set "org-refile-last-stored")
14233 (org-paste-subtree level))))
14234 (org-cut-special)
14237 (defun org-refile-goto-last-stored ()
14238 "Go to the location where the last refile was stored."
14239 (interactive)
14240 (bookmark-jump "org-refile-last-stored")
14241 (message "This is the location of the last refile"))
14243 (defun org-refile-get-location (&optional prompt default-buffer)
14244 "Prompt the user for a refile location, using PROMPT."
14245 (let ((org-refile-targets org-refile-targets)
14246 (org-refile-use-outline-path org-refile-use-outline-path))
14247 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14248 (unless org-refile-target-table
14249 (error "No refile targets"))
14250 (let* ((cbuf (current-buffer))
14251 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14252 (fname (and filename (file-truename filename)))
14253 (tbl (mapcar
14254 (lambda (x)
14255 (if (not (equal fname (file-truename (nth 1 x))))
14256 (cons (concat (car x) " (" (file-name-nondirectory
14257 (nth 1 x)) ")")
14258 (cdr x))
14259 x))
14260 org-refile-target-table))
14261 (completion-ignore-case t))
14262 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14263 tbl)))
14265 ;;;; Dynamic blocks
14267 (defun org-find-dblock (name)
14268 "Find the first dynamic block with name NAME in the buffer.
14269 If not found, stay at current position and return nil."
14270 (let (pos)
14271 (save-excursion
14272 (goto-char (point-min))
14274 nil t)
14275 (match-beginning 0))))
14276 (if pos (goto-char pos))
14277 pos))
14279 (defconst org-dblock-start-re
14281 "Matches the startline of a dynamic block, with parameters.")
14284 "Matches the end of a dyhamic block.")
14286 (defun org-create-dblock (plist)
14287 "Create a dynamic block section, with parameters taken from PLIST.
14288 PLIST must containe a :name entry which is used as name of the block."
14289 (unless (bolp) (newline))
14290 (let ((name (plist-get plist :name)))
14291 (insert "#+BEGIN: " name)
14292 (while plist
14293 (if (eq (car plist) :name)
14294 (setq plist (cddr plist))
14295 (insert " " (prin1-to-string (pop plist)))))
14297 (beginning-of-line -2)))
14299 (defun org-prepare-dblock ()
14300 "Prepare dynamic block for refresh.
14301 This empties the block, puts the cursor at the insert position and returns
14302 the property list including an extra property :name with the block name."
14303 (unless (looking-at org-dblock-start-re)
14304 (error "Not at a dynamic block"))
14305 (let* ((begdel (1+ (match-end 0)))
14306 (name (org-no-properties (match-string 1)))
14307 (params (append (list :name name)
14308 (read (concat "(" (match-string 3) ")")))))
14309 (unless (re-search-forward org-dblock-end-re nil t)
14310 (error "Dynamic block not terminated"))
14311 (delete-region begdel (match-beginning 0))
14312 (goto-char begdel)
14313 (open-line 1)
14314 params))
14316 (defun org-map-dblocks (&optional command)
14317 "Apply COMMAND to all dynamic blocks in the current buffer.
14318 If COMMAND is not given, use `org-update-dblock'."
14319 (let ((cmd (or command 'org-update-dblock))
14320 pos)
14321 (save-excursion
14322 (goto-char (point-min))
14323 (while (re-search-forward org-dblock-start-re nil t)
14324 (goto-char (setq pos (match-beginning 0)))
14325 (condition-case nil
14326 (funcall cmd)
14327 (error (message "Error during update of dynamic block")))
14328 (goto-char pos)
14329 (unless (re-search-forward org-dblock-end-re nil t)
14330 (error "Dynamic block not terminated"))))))
14332 (defun org-dblock-update (&optional arg)
14333 "User command for updating dynamic blocks.
14334 Update the dynamic block at point. With prefix ARG, update all dynamic
14335 blocks in the buffer."
14336 (interactive "P")
14337 (if arg
14338 (org-update-all-dblocks)
14339 (or (looking-at org-dblock-start-re)
14340 (org-beginning-of-dblock))
14341 (org-update-dblock)))
14343 (defun org-update-dblock ()
14344 "Update the dynamic block at point
14345 This means to empty the block, parse for parameters and then call
14346 the correct writing function."
14347 (save-window-excursion
14348 (let* ((pos (point))
14349 (line (org-current-line))
14350 (params (org-prepare-dblock))
14351 (name (plist-get params :name))
14352 (cmd (intern (concat "org-dblock-write:" name))))
14353 (message "Updating dynamic block `%s' at line %d..." name line)
14354 (funcall cmd params)
14355 (message "Updating dynamic block `%s' at line %d...done" name line)
14356 (goto-char pos))))
14358 (defun org-beginning-of-dblock ()
14359 "Find the beginning of the dynamic block at point.
14360 Error if there is no scuh block at point."
14361 (let ((pos (point))
14362 beg)
14363 (end-of-line 1)
14364 (if (and (re-search-backward org-dblock-start-re nil t)
14365 (setq beg (match-beginning 0))
14366 (re-search-forward org-dblock-end-re nil t)
14367 (> (match-end 0) pos))
14368 (goto-char beg)
14369 (goto-char pos)
14370 (error "Not in a dynamic block"))))
14372 (defun org-update-all-dblocks ()
14373 "Update all dynamic blocks in the buffer.
14374 This function can be used in a hook."
14375 (when (org-mode-p)
14376 (org-map-dblocks 'org-update-dblock)))
14379 ;;;; Completion
14381 (defconst org-additional-option-like-keywords
14382 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14383 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14384 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14386 (defun org-complete (&optional arg)
14387 "Perform completion on word at point.
14388 At the beginning of a headline, this completes TODO keywords as given in
14389 `org-todo-keywords'.
14390 If the current word is preceded by a backslash, completes the TeX symbols
14391 that are supported for HTML support.
14393 setting file options.
14395 At all other locations, this simply calls the value of
14396 `org-completion-fallback-command'."
14397 (interactive "P")
14398 (org-without-partial-completion
14399 (catch 'exit
14400 (let* ((end (point))
14401 (beg1 (save-excursion
14402 (skip-chars-backward (org-re "[:alnum:]_@"))
14403 (point)))
14404 (beg (save-excursion
14405 (skip-chars-backward "a-zA-Z0-9_:$")
14406 (point)))
14407 (confirm (lambda (x) (stringp (car x))))
14408 (searchhead (equal (char-before beg) ?*))
14409 (tag (and (equal (char-before beg1) ?:)
14410 (equal (char-after (point-at-bol)) ?*)))
14411 (prop (and (equal (char-before beg1) ?:)
14412 (not (equal (char-after (point-at-bol)) ?*))))
14414 (link (equal (char-before beg) ?\[))
14415 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14416 beg)
14417 "#+"))
14419 (buffer-substring (point-at-bol) (point))))
14420 (completion-ignore-case opt)
14421 (type nil)
14422 (tbl nil)
14423 (table (cond
14424 (opt
14425 (setq type :opt)
14426 (append
14427 (mapcar
14428 (lambda (x)
14430 (cons (match-string 2 x) (match-string 1 x)))
14432 (mapcar 'list org-additional-option-like-keywords)))
14433 (startup
14434 (setq type :startup)
14435 org-startup-options)
14436 (link (append org-link-abbrev-alist-local
14437 org-link-abbrev-alist))
14438 (texp
14439 (setq type :tex)
14440 org-html-entities)
14442 (buffer-substring (point-at-bol) beg))
14443 (setq type :todo)
14444 (mapcar 'list org-todo-keywords-1))
14445 (searchhead
14446 (setq type :searchhead)
14447 (save-excursion
14448 (goto-char (point-min))
14449 (while (re-search-forward org-todo-line-regexp nil t)
14450 (push (list
14451 (org-make-org-heading-search-string
14452 (match-string 3) t))
14453 tbl)))
14454 tbl)
14455 (tag (setq type :tag beg beg1)
14456 (or org-tag-alist (org-get-buffer-tags)))
14457 (prop (setq type :prop beg beg1)
14458 (mapcar 'list (org-buffer-property-keys nil t t)))
14459 (t (progn
14460 (call-interactively org-completion-fallback-command)
14461 (throw 'exit nil)))))
14462 (pattern (buffer-substring-no-properties beg end))
14463 (completion (try-completion pattern table confirm)))
14464 (cond ((eq completion t)
14465 (if (not (assoc (upcase pattern) table))
14466 (message "Already complete")
14467 (if (equal type :opt)
14468 (insert (substring (cdr (assoc (upcase pattern) table))
14469 (length pattern)))
14470 (if (memq type '(:tag :prop)) (insert ":")))))
14471 ((null completion)
14473 (ding))
14474 ((not (string= pattern completion))
14475 (delete-region beg end)
14476 (if (string-match " +$" completion)
14477 (setq completion (replace-match "" t t completion)))
14478 (insert completion)
14479 (if (get-buffer-window "*Completions*")
14480 (delete-window (get-buffer-window "*Completions*")))
14481 (if (assoc completion table)
14482 (if (eq type :todo) (insert " ")
14483 (if (memq type '(:tag :prop)) (insert ":"))))
14484 (if (and (equal type :opt) (assoc completion table))
14485 (message "%s" (substitute-command-keys
14487 (t
14488 (message "Making completion list...")
14489 (let ((list (sort (all-completions pattern table confirm)
14490 'string<)))
14491 (with-output-to-temp-buffer "*Completions*"
14492 (condition-case nil
14493 ;; Protection needed for XEmacs and emacs 21
14494 (display-completion-list list pattern)
14495 (error (display-completion-list list)))))
14496 (message "Making completion list...%s" "done")))))))
14498 ;;;; TODO, DEADLINE, Comments
14500 (defun org-toggle-comment ()
14501 "Change the COMMENT state of an entry."
14502 (interactive)
14503 (save-excursion
14504 (org-back-to-heading)
14505 (let (case-fold-search)
14506 (if (looking-at (concat outline-regexp
14508 (replace-match "" t t nil 1)
14509 (if (looking-at outline-regexp)
14510 (progn
14511 (goto-char (match-end 0))
14512 (insert org-comment-string " ")))))))
14514 (defvar org-last-todo-state-is-todo nil
14515 "This is non-nil when the last TODO state change led to a TODO state.
14516 If the last change removed the TODO tag or switched to DONE, then
14517 this is nil.")
14519 (defvar org-setting-tags nil) ; dynamically skiped
14521 ;; FIXME: better place
14522 (defun org-property-or-variable-value (var &optional inherit)
14523 "Check if there is a property fixing the value of VAR.
14524 If yes, return this value. If not, return the current value of the variable."
14525 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14527 (read prop)
14528 (symbol-value var))))
14530 (defun org-parse-local-options (string var)
14531 "Parse STRING for startup setting relevant for variable VAR."
14532 (let ((rtn (symbol-value var))
14533 e opts)
14534 (save-match-data
14536 rtn
14537 (setq opts (delq nil (mapcar (lambda (x)
14538 (setq e (assoc x org-startup-options))
14539 (if (eq (nth 1 e) var) e nil))
14541 (if (not opts)
14542 rtn
14543 (setq rtn nil)
14544 (while (setq e (pop opts))
14545 (if (not (nth 3 e))
14546 (setq rtn (nth 2 e))
14547 (if (not (listp rtn)) (setq rtn nil))
14548 (push (nth 2 e) rtn)))
14549 rtn)))))
14551 (defvar org-blocker-hook nil
14552 "Hook for functions that are allowed to block a state change.
14554 Each function gets as its single argument a property list, see
14555 `org-trigger-hook' for more information about this list.
14557 If any of the functions in this hook returns nil, the state change
14558 is blocked.")
14560 (defvar org-trigger-hook nil
14561 "Hook for functions that are triggered by a state change.
14563 Each function gets as its single argument a property list with at least
14564 the following elements:
14566 (:type type-of-change :position pos-at-entry-start
14567 :from old-state :to new-state)
14569 Depending on the type, more properties may be present.
14571 This mechanism is currently implemented for:
14573 TODO state changes
14574 ------------------
14575 :type todo-state-change
14576 :from previous state (keyword as a string), or nil
14577 :to new state (keyword as a string), or nil")
14580 (defun org-todo (&optional arg)
14581 "Change the TODO state of an item.
14582 The state of an item is given by a keyword at the start of the heading,
14583 like
14584 *** TODO Write paper
14585 *** DONE Call mom
14587 The different keywords are specified in the variable `org-todo-keywords'.
14589 So for this example: when the item starts with TODO, it is changed to DONE.
14590 When it starts with DONE, the DONE is removed. And when neither TODO nor
14591 DONE are present, add TODO at the beginning of the heading.
14593 With C-u prefix arg, use completion to determine the new state.
14594 With numeric prefix arg, switch to that state.
14596 For calling through lisp, arg is also interpreted in the following way:
14597 'none -> empty state
14599 'done -> switch to DONE
14600 'nextset -> switch to the next set of keywords
14601 'previousset -> switch to the previous set of keywords
14603 really is a member of `org-todo-keywords'."
14604 (interactive "P")
14605 (save-excursion
14606 (catch 'exit
14607 (org-back-to-heading)
14608 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14609 (or (looking-at (concat " +" org-todo-regexp " *"))
14610 (looking-at " *"))
14611 (let* ((match-data (match-data))
14612 (startpos (point-at-bol))
14613 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14614 (org-log-done org-log-done)
14615 (org-log-repeat org-log-repeat)
14616 (org-todo-log-states org-todo-log-states)
14617 (this (match-string 1))
14618 (hl-pos (match-beginning 0))
14619 (head (org-get-todo-sequence-head this))
14620 (ass (assoc head org-todo-kwd-alist))
14621 (interpret (nth 1 ass))
14622 (done-word (nth 3 ass))
14623 (final-done-word (nth 4 ass))
14624 (last-state (or this ""))
14625 (completion-ignore-case t)
14626 (member (member this org-todo-keywords-1))
14627 (tail (cdr member))
14628 (state (cond
14629 ((and org-todo-key-trigger
14630 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14631 (and (not arg) org-use-fast-todo-selection
14632 (not (eq org-use-fast-todo-selection 'prefix)))))
14633 ;; Use fast selection
14634 (org-fast-todo-selection))
14635 ((and (equal arg '(4))
14636 (or (not org-use-fast-todo-selection)
14637 (not org-todo-key-trigger)))
14638 ;; Read a state with completion
14639 (completing-read "State: " (mapcar (lambda(x) (list x))
14640 org-todo-keywords-1)
14641 nil t))
14642 ((eq arg 'right)
14643 (if this
14644 (if tail (car tail) nil)
14645 (car org-todo-keywords-1)))
14646 ((eq arg 'left)
14647 (if (equal member org-todo-keywords-1)
14648 nil
14649 (if this
14650 (nth (- (length org-todo-keywords-1) (length tail) 2)
14651 org-todo-keywords-1)
14652 (org-last org-todo-keywords-1))))
14653 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14654 (setq arg nil))) ; hack to fall back to cycling
14655 (arg
14656 ;; user or caller requests a specific state
14657 (cond
14658 ((equal arg "") nil)
14659 ((eq arg 'none) nil)
14660 ((eq arg 'done) (or done-word (car org-done-keywords)))
14661 ((eq arg 'nextset)
14662 (or (car (cdr (member head org-todo-heads)))
14663 (car org-todo-heads)))
14664 ((eq arg 'previousset)
14665 (let ((org-todo-heads (reverse org-todo-heads)))
14666 (or (car (cdr (member head org-todo-heads)))
14667 (car org-todo-heads))))
14668 ((car (member arg org-todo-keywords-1)))
14669 ((nth (1- (prefix-numeric-value arg))
14670 org-todo-keywords-1))))
14671 ((null member) (or head (car org-todo-keywords-1)))
14672 ((equal this final-done-word) nil) ;; -> make empty
14673 ((null tail) nil) ;; -> first entry
14674 ((eq interpret 'sequence)
14675 (car tail))
14676 ((memq interpret '(type priority))
14677 (if (eq this-command last-command)
14678 (car tail)
14679 (if (> (length tail) 0)
14680 (or done-word (car org-done-keywords))
14681 nil)))
14682 (t nil)))
14683 (next (if state (concat " " state " ") " "))
14684 (change-plist (list :type 'todo-state-change :from this :to state
14685 :position startpos))
14686 dolog now-done-p)
14687 (when org-blocker-hook
14688 (unless (save-excursion
14689 (save-match-data
14690 (run-hook-with-args-until-failure
14691 'org-blocker-hook change-plist)))
14692 (if (interactive-p)
14693 (error "TODO state change from %s to %s blocked" this state)
14694 ;; fail silently
14695 (message "TODO state change from %s to %s blocked" this state)
14696 (throw 'exit nil))))
14697 (store-match-data match-data)
14698 (replace-match next t t)
14699 (unless (pos-visible-in-window-p hl-pos)
14700 (message "TODO state changed to %s" (org-trim next)))
14701 (unless head
14702 (setq head (org-get-todo-sequence-head state)
14703 ass (assoc head org-todo-kwd-alist)
14704 interpret (nth 1 ass)
14705 done-word (nth 3 ass)
14706 final-done-word (nth 4 ass)))
14707 (when (memq arg '(nextset previousset))
14708 (message "Keyword-Set %d/%d: %s"
14709 (- (length org-todo-sets) -1
14710 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14711 (length org-todo-sets)
14712 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14713 (setq org-last-todo-state-is-todo
14714 (not (member state org-done-keywords)))
14715 (setq now-done-p (and (member state org-done-keywords)
14716 (not (member this org-done-keywords))))
14717 (and logging (org-local-logging logging))
14718 (when (and (or org-todo-log-states org-log-done)
14719 (not (memq arg '(nextset previousset))))
14720 ;; we need to look at recording a time and note
14721 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14722 (nth 2 (assoc this org-todo-log-states))))
14723 (when (and state
14724 (member state org-not-done-keywords)
14725 (not (member this org-not-done-keywords)))
14726 ;; This is now a todo state and was not one before
14727 ;; If there was a CLOSED time stamp, get rid of it.
14728 (org-add-planning-info nil nil 'closed))
14729 (when (and now-done-p org-log-done)
14730 ;; It is now done, and it was not done before
14731 (org-add-planning-info 'closed (org-current-time))
14732 (if (and (not dolog) (eq 'note org-log-done))
14733 (org-add-log-maybe 'done state 'findpos 'note)))
14734 (when (and state dolog)
14735 ;; This is a non-nil state, and we need to log it
14736 (org-add-log-maybe 'state state 'findpos dolog)))
14737 ;; Fixup tag positioning
14738 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14739 (run-hooks 'org-after-todo-state-change-hook)
14740 (if (and arg (not (member state org-done-keywords)))
14741 (setq head (org-get-todo-sequence-head state)))
14742 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14743 ;; Do we need to trigger a repeat?
14744 (when now-done-p (org-auto-repeat-maybe state))
14745 ;; Fixup cursor location if close to the keyword
14746 (if (and (outline-on-heading-p)
14747 (not (bolp))
14748 (save-excursion (beginning-of-line 1)
14749 (looking-at org-todo-line-regexp))
14750 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14751 (progn
14752 (goto-char (or (match-end 2) (match-end 1)))
14753 (just-one-space)))
14754 (when org-trigger-hook
14755 (save-excursion
14756 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14758 (defun org-local-logging (value)
14759 "Get logging settings from a property VALUE."
14760 (let* (words w a)
14761 ;; directly set the variables, they are already local.
14762 (setq org-log-done nil
14763 org-log-repeat nil
14764 org-todo-log-states nil)
14765 (setq words (org-split-string value))
14766 (while (setq w (pop words))
14767 (cond
14768 ((setq a (assoc w org-startup-options))
14769 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14770 (set (nth 1 a) (nth 2 a))))
14771 ((setq a (org-extract-log-state-settings w))
14772 (and (member (car a) org-todo-keywords-1)
14773 (push a org-todo-log-states)))))))
14775 (defun org-get-todo-sequence-head (kwd)
14776 "Return the head of the TODO sequence to which KWD belongs.
14777 If KWD is not set, check if there is a text property remembering the
14778 right sequence."
14779 (let (p)
14780 (cond
14781 ((not kwd)
14782 (or (get-text-property (point-at-bol) 'org-todo-head)
14783 (progn
14784 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14785 nil (point-at-eol)))
14786 (get-text-property p 'org-todo-head))))
14787 ((not (member kwd org-todo-keywords-1))
14788 (car org-todo-keywords-1))
14789 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14791 (defun org-fast-todo-selection ()
14792 "Fast TODO keyword selection with single keys.
14793 Returns the new TODO keyword, or nil if no state change should occur."
14794 (let* ((fulltable org-todo-key-alist)
14795 (done-keywords org-done-keywords) ;; needed for the faces.
14796 (maxlen (apply 'max (mapcar
14797 (lambda (x)
14798 (if (stringp (car x)) (string-width (car x)) 0))
14799 fulltable)))
14800 (expert nil)
14801 (fwidth (+ maxlen 3 1 3))
14802 (ncol (/ (- (window-width) 4) fwidth))
14803 tg cnt e c tbl
14804 groups ingroup)
14805 (save-window-excursion
14806 (if expert
14807 (set-buffer (get-buffer-create " *Org todo*"))
14808 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14809 (erase-buffer)
14810 (org-set-local 'org-done-keywords done-keywords)
14811 (setq tbl fulltable cnt 0)
14812 (while (setq e (pop tbl))
14813 (cond
14814 ((equal e '(:startgroup))
14815 (push '() groups) (setq ingroup t)
14816 (when (not (= cnt 0))
14817 (setq cnt 0)
14819 (insert "{ "))
14820 ((equal e '(:endgroup))
14821 (setq ingroup nil cnt 0)
14823 (t
14824 (setq tg (car e) c (cdr e))
14825 (if ingroup (push tg (car groups)))
14826 (setq tg (org-add-props tg nil 'face
14827 (org-get-todo-face tg)))
14828 (if (and (= cnt 0) (not ingroup)) (insert " "))
14829 (insert "[" c "] " tg (make-string
14830 (- fwidth 4 (length tg)) ?\ ))
14831 (when (= (setq cnt (1+ cnt)) ncol)
14833 (if ingroup (insert " "))
14834 (setq cnt 0)))))
14836 (goto-char (point-min))
14837 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14838 (fit-window-to-buffer))
14839 (message "[a-z..]:Set [SPC]:clear")
14840 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14841 (cond
14842 ((or (= c ?\C-g)
14843 (and (= c ?q) (not (rassoc c fulltable))))
14844 (setq quit-flag t))
14845 ((= c ?\ ) nil)
14846 ((setq e (rassoc c fulltable) tg (car e))
14847 tg)
14848 (t (setq quit-flag t))))))
14850 (defun org-get-repeat ()
14851 "Check if tere is a deadline/schedule with repeater in this entry."
14852 (save-match-data
14853 (save-excursion
14854 (org-back-to-heading t)
14855 (if (re-search-forward
14856 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14857 (match-string 1)))))
14859 (defvar org-last-changed-timestamp)
14860 (defvar org-log-post-message)
14861 (defvar org-log-note-purpose)
14862 (defun org-auto-repeat-maybe (done-word)
14863 "Check if the current headline contains a repeated deadline/schedule.
14864 If yes, set TODO state back to what it was and change the base date
14865 of repeating deadline/scheduled time stamps to new date.
14866 This function is run automatically after each state change to a DONE state."
14867 ;; last-state is dynamically scoped into this function
14868 (let* ((repeat (org-get-repeat))
14869 (aa (assoc last-state org-todo-kwd-alist))
14870 (interpret (nth 1 aa))
14871 (head (nth 2 aa))
14872 (whata '(("d" . day) ("m" . month) ("y" . year)))
14873 (msg "Entry repeats: ")
14874 (org-log-done nil)
14875 (org-todo-log-states nil)
14876 re type n what ts)
14877 (when repeat
14878 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
14879 (org-todo (if (eq interpret 'type) last-state head))
14880 (when (and org-log-repeat
14881 (or (not (memq 'org-add-log-note
14882 (default-value 'post-command-hook)))
14883 (eq org-log-note-purpose 'done)))
14884 ;; Make sure a note is taken;
14885 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
14886 'findpos org-log-repeat))
14887 (org-back-to-heading t)
14888 (org-add-planning-info nil nil 'closed)
14892 (while (re-search-forward
14893 re (save-excursion (outline-next-heading) (point)) t)
14894 (setq type (if (match-end 1) org-scheduled-string
14895 (if (match-end 3) org-deadline-string "Plain:"))
14896 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14898 (setq n (string-to-number (match-string 1 ts))
14899 what (match-string 2 ts))
14900 (if (equal what "w") (setq n (* n 7) what "d"))
14901 (org-timestamp-change n (cdr (assoc what whata)))
14902 (setq msg (concat msg type org-last-changed-timestamp " "))))
14903 (setq org-log-post-message msg)
14904 (message "%s" msg))))
14906 (defun org-show-todo-tree (arg)
14907 "Make a compact tree which shows all headlines marked with TODO.
14908 The tree will show the lines where the regexp matches, and all higher
14909 headlines above the match.
14911 With a numeric prefix N, construct a sparse tree for the Nth element
14912 of `org-todo-keywords-1'."
14913 (interactive "P")
14914 (let ((case-fold-search nil)
14915 (kwd-re
14916 (cond ((null arg) org-not-done-regexp)
14917 ((equal arg '(4))
14918 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14919 (mapcar 'list org-todo-keywords-1))))
14923 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14924 (regexp-quote (nth (1- (prefix-numeric-value arg))
14925 org-todo-keywords-1)))
14926 (t (error "Invalid prefix argument: %s" arg)))))
14927 (message "%d TODO entries found"
14928 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14930 (defun org-deadline (&optional remove)
14932 With argument REMOVE, remove any deadline from the item."
14933 (interactive "P")
14934 (if remove
14935 (progn
14936 (org-remove-timestamp-with-keyword org-deadline-string)
14937 (message "Item no longer has a deadline."))
14938 (org-add-planning-info 'deadline nil 'closed)))
14940 (defun org-schedule (&optional remove)
14941 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14942 With argument REMOVE, remove any scheduling date from the item."
14943 (interactive "P")
14944 (if remove
14945 (progn
14946 (org-remove-timestamp-with-keyword org-scheduled-string)
14947 (message "Item is no longer scheduled."))
14948 (org-add-planning-info 'scheduled nil 'closed)))
14950 (defun org-remove-timestamp-with-keyword (keyword)
14951 "Remove all time stamps with KEYWORD in the current entry."
14953 beg)
14954 (save-excursion
14955 (org-back-to-heading t)
14956 (setq beg (point))
14957 (org-end-of-subtree t t)
14958 (while (re-search-backward re beg t)
14959 (replace-match "")
14961 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14963 (defun org-add-planning-info (what &optional time &rest remove)
14964 "Insert new timestamp with keyword in the line directly after the headline.
14965 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14966 If non is given, the user is prompted for a date.
14967 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14968 be removed."
14969 (interactive)
14970 (let (org-time-was-given org-end-time-was-given)
14971 (when what (setq time (or time (org-read-date nil 'to-time))))
14972 (when (and org-insert-labeled-timestamps-at-point
14973 (member what '(scheduled deadline)))
14974 (insert
14975 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14976 (org-insert-time-stamp time org-time-was-given
14977 nil nil nil (list org-end-time-was-given))
14978 (setq what nil))
14979 (save-excursion
14980 (save-restriction
14981 (let (col list elt ts buffer-invisibility-spec)
14982 (org-back-to-heading t)
14984 (goto-char (match-end 1))
14985 (setq col (current-column))
14986 (goto-char (match-end 0))
14988 (if (and (not (looking-at outline-regexp))
14991 (not (equal (match-string 1) org-clock-string)))
14992 (narrow-to-region (match-beginning 0) (match-end 0))
14994 (backward-char 1)
14995 (narrow-to-region (point) (point))
14996 (indent-to-column col))
14997 ;; Check if we have to remove something.
14998 (setq list (cons what remove))
14999 (while list
15000 (setq elt (pop list))
15001 (goto-char (point-min))
15002 (when (or (and (eq elt 'scheduled)
15003 (re-search-forward org-scheduled-time-regexp nil t))
15004 (and (eq elt 'deadline)
15005 (re-search-forward org-deadline-time-regexp nil t))
15006 (and (eq elt 'closed)
15007 (re-search-forward org-closed-time-regexp nil t)))
15008 (replace-match "")
15009 (if (looking-at "--+<[^>]+>") (replace-match ""))
15010 (if (looking-at " +") (replace-match ""))))
15011 (goto-char (point-max))
15012 (when what
15013 (insert
15014 (if (not (equal (char-before) ?\ )) " " "")
15015 (cond ((eq what 'scheduled) org-scheduled-string)
15016 ((eq what 'deadline) org-deadline-string)
15017 ((eq what 'closed) org-closed-string))
15018 " ")
15019 (setq ts (org-insert-time-stamp
15020 time
15021 (or org-time-was-given
15022 (and (eq what 'closed) org-log-done-with-time))
15023 (eq what 'closed)
15024 nil nil (list org-end-time-was-given)))
15025 (end-of-line 1))
15026 (goto-char (point-min))
15027 (widen)
15029 (replace-match ""))
15030 ts)))))
15032 (defvar org-log-note-marker (make-marker))
15033 (defvar org-log-note-purpose nil)
15034 (defvar org-log-note-state nil)
15035 (defvar org-log-note-how nil)
15036 (defvar org-log-note-window-configuration nil)
15037 (defvar org-log-note-return-to (make-marker))
15038 (defvar org-log-post-message nil
15039 "Message to be displayed after a log note has been stored.
15040 The auto-repeater uses this.")
15042 (defun org-add-log-maybe (&optional purpose state findpos how)
15043 "Set up the post command hook to take a note.
15044 If this is about to TODO state change, the new state is expected in STATE.
15045 When FINDPOS is non-nil, find the correct position for the note in
15046 the current entry. If not, assume that it can be inserted at point."
15047 (save-excursion
15048 (when findpos
15049 (org-back-to-heading t)
15053 (goto-char (match-end 0))
15054 (unless org-log-states-order-reversed
15056 (org-skip-over-state-notes)
15058 (move-marker org-log-note-marker (point))
15059 (setq org-log-note-purpose purpose
15060 org-log-note-state state
15061 org-log-note-how how)
15062 (add-hook 'post-command-hook 'org-add-log-note 'append)))
15064 (defun org-skip-over-state-notes ()
15065 "Skip past the list of State notes in an entry."
15068 (condition-case nil
15069 (org-next-item)
15070 (error (org-end-of-item)))))
15072 (defun org-add-log-note (&optional purpose)
15073 "Pop up a window for taking a note, and add this note later at point."
15074 (remove-hook 'post-command-hook 'org-add-log-note)
15075 (setq org-log-note-window-configuration (current-window-configuration))
15076 (delete-other-windows)
15077 (move-marker org-log-note-return-to (point))
15078 (switch-to-buffer (marker-buffer org-log-note-marker))
15079 (goto-char org-log-note-marker)
15080 (org-switch-to-buffer-other-window "*Org Note*")
15081 (erase-buffer)
15082 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
15083 (org-store-log-note)
15084 (let ((org-inhibit-startup t)) (org-mode))
15085 (insert (format "# Insert note for %s.
15087 (cond
15088 ((eq org-log-note-purpose 'clock-out) "stopped clock")
15089 ((eq org-log-note-purpose 'done) "closed todo item")
15090 ((eq org-log-note-purpose 'state)
15092 (t (error "This should not happen")))))
15093 (org-set-local 'org-finish-function 'org-store-log-note)))
15095 (defun org-store-log-note ()
15096 "Finish taking a log note, and insert it to where it belongs."
15097 (let ((txt (buffer-string))
15098 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
15099 lines ind)
15100 (kill-buffer (current-buffer))
15102 (setq txt (replace-match "" t t txt)))
15104 (setq txt (replace-match "" t t txt)))
15107 (setq note
15108 (org-replace-escapes
15109 note
15110 (list (cons "%u" (user-login-name))
15111 (cons "%U" user-full-name)
15112 (cons "%t" (format-time-string
15113 (org-time-stamp-format 'long 'inactive)
15114 (current-time)))
15115 (cons "%s" (if org-log-note-state
15117 "")))))
15119 (push note lines))
15120 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15121 (when lines
15122 (save-excursion
15123 (set-buffer (marker-buffer org-log-note-marker))
15124 (save-excursion
15125 (goto-char org-log-note-marker)
15126 (move-marker org-log-note-marker nil)
15127 (end-of-line 1)
15129 (indent-relative nil)
15130 (insert "- " (pop lines))
15131 (org-indent-line-function)
15132 (beginning-of-line 1)
15134 (setq ind (concat (match-string 0) " "))
15135 (end-of-line 1)
15137 (set-window-configuration org-log-note-window-configuration)
15138 (with-current-buffer (marker-buffer org-log-note-return-to)
15139 (goto-char org-log-note-return-to))
15140 (move-marker org-log-note-return-to nil)
15141 (and org-log-post-message (message "%s" org-log-post-message)))
15143 ;; FIXME: what else would be useful?
15144 ;; - priority
15145 ;; - date
15147 (defun org-sparse-tree (&optional arg)
15148 "Create a sparse tree, prompt for the details.
15149 This command can create sparse trees. You first need to select the type
15150 of match used to create the tree:
15152 t Show entries with a specific TODO keyword.
15153 T Show entries selected by a tags match.
15154 p Enter a property name and its value (both with completion on existing
15155 names/values) and show entries with that property.
15156 r Show entries matching a regular expression
15157 d Show deadlines due within `org-deadline-warning-days'."
15158 (interactive "P")
15159 (let (ans kwd value)
15160 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15161 (setq ans (read-char-exclusive))
15162 (cond
15163 ((equal ans ?d)
15164 (call-interactively 'org-check-deadlines))
15165 ((equal ans ?b)
15166 (call-interactively 'org-check-before-date))
15167 ((equal ans ?t)
15168 (org-show-todo-tree '(4)))
15169 ((equal ans ?T)
15170 (call-interactively 'org-tags-sparse-tree))
15171 ((member ans '(?p ?P))
15172 (setq kwd (completing-read "Property: "
15173 (mapcar 'list (org-buffer-property-keys))))
15174 (setq value (completing-read "Value: "
15175 (mapcar 'list (org-property-values kwd))))
15178 (org-tags-sparse-tree arg (concat kwd "=" value)))
15179 ((member ans '(?r ?R ?/))
15180 (call-interactively 'org-occur))
15183 (defvar org-occur-highlights nil)
15184 (make-variable-buffer-local 'org-occur-highlights)
15186 (defun org-occur (regexp &optional keep-previous callback)
15187 "Make a compact tree which shows all matches of REGEXP.
15188 The tree will show the lines where the regexp matches, and all higher
15189 headlines above the match. It will also show the heading after the match,
15190 to make sure editing the matching entry is easy.
15191 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15192 call to `org-occur' will be kept, to allow stacking of calls to this
15193 command.
15194 If CALLBACK is non-nil, it is a function which is called to confirm
15195 that the match should indeed be shown."
15197 (or keep-previous (org-remove-occur-highlights nil nil t))
15198 (let ((cnt 0))
15199 (save-excursion
15200 (goto-char (point-min))
15201 (if (or (not keep-previous) ; do not want to keep
15202 (not org-occur-highlights)) ; no previous matches
15203 ;; hide everything
15204 (org-overview))
15205 (while (re-search-forward regexp nil t)
15206 (when (or (not callback)
15207 (save-match-data (funcall callback)))
15208 (setq cnt (1+ cnt))
15209 (when org-highlight-sparse-tree-matches
15210 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15211 (org-show-context 'occur-tree))))
15212 (when org-remove-highlights-with-change
15213 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15214 nil 'local))
15215 (unless org-sparse-tree-open-archived-trees
15216 (org-hide-archived-subtrees (point-min) (point-max)))
15217 (run-hooks 'org-occur-hook)
15218 (if (interactive-p)
15219 (message "%d match(es) for regexp %s" cnt regexp))
15220 cnt))
15222 (defun org-show-context (&optional key)
15223 "Make sure point and context and visible.
15224 How much context is shown depends upon the variables
15225 `org-show-hierarchy-above', `org-show-following-heading'. and
15226 `org-show-siblings'."
15227 (let ((heading-p (org-on-heading-p t))
15228 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15229 (following-p (org-get-alist-option org-show-following-heading key))
15230 (entry-p (org-get-alist-option org-show-entry-below key))
15231 (siblings-p (org-get-alist-option org-show-siblings key)))
15232 (catch 'exit
15233 ;; Show heading or entry text
15234 (if (and heading-p (not entry-p))
15235 (org-flag-heading nil) ; only show the heading
15236 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15237 (org-show-hidden-entry))) ; show entire entry
15238 (when following-p
15239 ;; Show next sibling, or heading below text
15240 (save-excursion
15241 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15242 (org-flag-heading nil))))
15243 (when siblings-p (org-show-siblings))
15244 (when hierarchy-p
15245 ;; show all higher headings, possibly with siblings
15246 (save-excursion
15247 (while (and (condition-case nil
15248 (progn (org-up-heading-all 1) t)
15249 (error nil))
15250 (not (bobp)))
15251 (org-flag-heading nil)
15252 (when siblings-p (org-show-siblings))))))))
15254 (defun org-reveal (&optional siblings)
15255 "Show current entry, hierarchy above it, and the following headline.
15256 This can be used to show a consistent set of context around locations
15257 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15258 not t for the search context.
15260 With optional argument SIBLINGS, on each level of the hierarchy all
15261 siblings are shown. This repairs the tree structure to what it would
15262 look like when opened with hierarchical calls to `org-cycle'."
15263 (interactive "P")
15264 (let ((org-show-hierarchy-above t)
15265 (org-show-following-heading t)
15266 (org-show-siblings (if siblings t org-show-siblings)))
15267 (org-show-context nil)))
15269 (defun org-highlight-new-match (beg end)
15270 "Highlight from BEG to END and mark the highlight is an occur headline."
15271 (let ((ov (org-make-overlay beg end)))
15272 (org-overlay-put ov 'face 'secondary-selection)
15273 (push ov org-occur-highlights)))
15275 (defun org-remove-occur-highlights (&optional beg end noremove)
15276 "Remove the occur highlights from the buffer.
15277 BEG and END are ignored. If NOREMOVE is nil, remove this function
15278 from the `before-change-functions' in the current buffer."
15279 (interactive)
15280 (unless org-inhibit-highlight-removal
15281 (mapc 'org-delete-overlay org-occur-highlights)
15282 (setq org-occur-highlights nil)
15283 (unless noremove
15284 (remove-hook 'before-change-functions
15285 'org-remove-occur-highlights 'local))))
15287 ;;;; Priorities
15290 "Regular expression matching the priority indicator.")
15292 (defvar org-remove-priority-next-time nil)
15294 (defun org-priority-up ()
15295 "Increase the priority of the current item."
15296 (interactive)
15297 (org-priority 'up))
15299 (defun org-priority-down ()
15300 "Decrease the priority of the current item."
15301 (interactive)
15302 (org-priority 'down))
15304 (defun org-priority (&optional action)
15305 "Change the priority of an item by ARG.
15306 ACTION can be `set', `up', `down', or a character."
15307 (interactive)
15308 (setq action (or action 'set))
15309 (let (current new news have remove)
15310 (save-excursion
15311 (org-back-to-heading)
15312 (if (looking-at org-priority-regexp)
15313 (setq current (string-to-char (match-string 2))
15314 have t)
15315 (setq current org-default-priority))
15316 (cond
15317 ((or (eq action 'set) (integerp action))
15318 (if (integerp action)
15319 (setq new action)
15320 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15321 (setq new (read-char-exclusive)))
15322 (if (and (= (upcase org-highest-priority) org-highest-priority)
15323 (= (upcase org-lowest-priority) org-lowest-priority))
15324 (setq new (upcase new)))
15325 (cond ((equal new ?\ ) (setq remove t))
15326 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15327 (error "Priority must be between `%c' and `%c'"
15328 org-highest-priority org-lowest-priority))))
15329 ((eq action 'up)
15330 (if (and (not have) (eq last-command this-command))
15331 (setq new org-lowest-priority)
15332 (setq new (if (and org-priority-start-cycle-with-default (not have))
15333 org-default-priority (1- current)))))
15334 ((eq action 'down)
15335 (if (and (not have) (eq last-command this-command))
15336 (setq new org-highest-priority)
15337 (setq new (if (and org-priority-start-cycle-with-default (not have))
15338 org-default-priority (1+ current)))))
15339 (t (error "Invalid action")))
15340 (if (or (< (upcase new) org-highest-priority)
15341 (> (upcase new) org-lowest-priority))
15342 (setq remove t))
15343 (setq news (format "%c" new))
15344 (if have
15345 (if remove
15346 (replace-match "" t t nil 1)
15347 (replace-match news t t nil 2))
15348 (if remove
15349 (error "No priority cookie found in line")
15350 (looking-at org-todo-line-regexp)
15351 (if (match-end 2)
15352 (progn
15353 (goto-char (match-end 2))
15354 (insert " [#" news "]"))
15355 (goto-char (match-beginning 3))
15356 (insert "[#" news "] ")))))
15357 (org-preserve-lc (org-set-tags nil 'align))
15358 (if remove
15359 (message "Priority removed")
15360 (message "Priority of current item set to %s" news))))
15363 (defun org-get-priority (s)
15364 "Find priority cookie and return priority."
15365 (save-match-data
15366 (if (not (string-match org-priority-regexp s))
15367 (* 1000 (- org-lowest-priority org-default-priority))
15368 (* 1000 (- org-lowest-priority
15369 (string-to-char (match-string 2 s)))))))
15371 ;;;; Tags
15373 (defun org-scan-tags (action matcher &optional todo-only)
15374 "Scan headline tags with inheritance and produce output ACTION.
15375 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15376 evaluated, testing if a given set of tags qualifies a headline for
15377 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15378 are included in the output."
15381 (org-re
15383 (props (list 'face nil
15384 'done-face 'org-done
15385 'undone-face nil
15386 'mouse-face 'highlight
15387 'org-not-done-regexp org-not-done-regexp
15388 'org-todo-regexp org-todo-regexp
15389 'keymap org-agenda-keymap
15390 'help-echo
15391 (format "mouse-2 or RET jump to org file %s"
15392 (abbreviate-file-name
15393 (or (buffer-file-name (buffer-base-buffer))
15394 (buffer-name (buffer-base-buffer)))))))
15395 (case-fold-search nil)
15396 lspos
15397 tags tags-list tags-alist (llast 0) rtn level category i txt
15398 todo marker entry priority)
15399 (save-excursion
15400 (goto-char (point-min))
15401 (when (eq action 'sparse-tree)
15402 (org-overview)
15403 (org-remove-occur-highlights))
15404 (while (re-search-forward re nil t)
15405 (catch :skip
15406 (setq todo (if (match-end 1) (match-string 2))
15407 tags (if (match-end 4) (match-string 4)))
15408 (goto-char (setq lspos (1+ (match-beginning 0))))
15409 (setq level (org-reduced-level (funcall outline-level))
15410 category (org-get-category))
15411 (setq i llast llast level)
15412 ;; remove tag lists from same and sublevels
15413 (while (>= i level)
15414 (when (setq entry (assoc i tags-alist))
15415 (setq tags-alist (delete entry tags-alist)))
15416 (setq i (1- i)))
15417 ;; add the nex tags
15418 (when tags
15419 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15420 tags-alist
15421 (cons (cons level tags) tags-alist)))
15422 ;; compile tags for current headline
15423 (setq tags-list
15424 (if org-use-tag-inheritance
15425 (apply 'append (mapcar 'cdr tags-alist))
15426 tags))
15427 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15428 (eval matcher)
15429 (or (not org-agenda-skip-archived-trees)
15430 (not (member org-archive-tag tags-list))))
15431 (and (eq action 'agenda) (org-agenda-skip))
15432 ;; list this headline
15434 (if (eq action 'sparse-tree)
15435 (progn
15436 (and org-highlight-sparse-tree-matches
15437 (org-get-heading) (match-end 0)
15438 (org-highlight-new-match
15439 (match-beginning 0) (match-beginning 1)))
15440 (org-show-context 'tags-tree))
15441 (setq txt (org-format-agenda-item
15442 ""
15443 (concat
15444 (if org-tags-match-list-sublevels
15445 (make-string (1- level) ?.) "")
15446 (org-get-heading))
15447 category tags-list)
15448 priority (org-get-priority txt))
15449 (goto-char lspos)
15450 (setq marker (org-agenda-new-marker))
15451 (org-add-props txt props
15452 'org-marker marker 'org-hd-marker marker 'org-category category
15453 'priority priority 'type "tagsmatch")
15454 (push txt rtn))
15455 ;; if we are to skip sublevels, jump to end of subtree
15456 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15457 (when (and (eq action 'sparse-tree)
15458 (not org-sparse-tree-open-archived-trees))
15459 (org-hide-archived-subtrees (point-min) (point-max)))
15460 (nreverse rtn)))
15462 (defvar todo-only) ;; dynamically scoped
15464 (defun org-tags-sparse-tree (&optional todo-only match)
15465 "Create a sparse tree according to tags string MATCH.
15466 MATCH can contain positive and negative selection of tags, like
15468 If optional argument TODO_ONLY is non-nil, only select lines that are
15469 also TODO lines."
15470 (interactive "P")
15471 (org-prepare-agenda-buffers (list (current-buffer)))
15472 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15474 (defvar org-cached-props nil)
15475 (defun org-cached-entry-get (pom property)
15476 (if (or (eq t org-use-property-inheritance)
15477 (member property org-use-property-inheritance))
15478 ;; Caching is not possible, check it directly
15479 (org-entry-get pom property 'inherit)
15480 ;; Get all properties, so that we can do complicated checks easily
15481 (cdr (assoc property (or org-cached-props
15482 (setq org-cached-props
15483 (org-entry-properties pom)))))))
15485 (defun org-global-tags-completion-table (&optional files)
15486 "Return the list of all tags in all agenda buffer/files."
15487 (save-excursion
15488 (org-uniquify
15489 (delq nil
15490 (apply 'append
15491 (mapcar
15492 (lambda (file)
15493 (set-buffer (find-file-noselect file))
15494 (append (org-get-buffer-tags)
15495 (mapcar (lambda (x) (if (stringp (car-safe x))
15496 (list (car-safe x)) nil))
15497 org-tag-alist)))
15498 (if (and files (car files))
15499 files
15500 (org-agenda-files))))))))
15502 (defun org-make-tags-matcher (match)
15503 "Create the TAGS//TODO matcher form for the selection string MATCH."
15504 ;; todo-only is scoped dynamically into this function, and the function
15505 ;; may change it it the matcher asksk for it.
15506 (unless match
15507 ;; Get a new match request, with completion
15508 (let ((org-last-tags-completion-table
15509 (org-global-tags-completion-table)))
15510 (setq match (completing-read
15511 "Match: " 'org-tags-completion-function nil nil nil
15512 'org-tags-history))))
15514 ;; Parse the string and create a lisp form
15515 (let ((match0 match)
15516 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15517 minus tag mm
15518 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15519 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15520 (if (string-match "/+" match)
15521 ;; match contains also a todo-matching request
15522 (progn
15523 (setq tagsmatch (substring match 0 (match-beginning 0))
15524 todomatch (substring match (match-end 0)))
15525 (if (string-match "^!" todomatch)
15526 (setq todo-only t todomatch (substring todomatch 1)))
15528 (setq todomatch nil)))
15529 ;; only matching tags
15530 (setq tagsmatch match todomatch nil))
15532 ;; Make the tags matcher
15534 (setq tagsmatcher t)
15535 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15536 (while (setq term (pop orterms))
15538 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15539 (while (string-match re term)
15540 (setq minus (and (match-end 1)
15541 (equal (match-string 1 term) "-"))
15542 tag (match-string 2 term)
15543 re-p (equal (string-to-char tag) ?{)
15544 level-p (match-end 3)
15545 prop-p (match-end 4)
15546 mm (cond
15547 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15548 (level-p `(= level ,(string-to-number
15549 (match-string 3 term))))
15550 (prop-p
15551 (setq pn (match-string 4 term)
15552 pv (match-string 5 term)
15553 cat-p (equal pn "CATEGORY")
15554 re-p (equal (string-to-char pv) ?{)
15555 pv (substring pv 1 -1))
15556 (if (equal pn "CATEGORY")
15557 (setq gv '(get-text-property (point) 'org-category))
15558 (setq gv `(org-cached-entry-get nil ,pn)))
15559 (if re-p
15560 `(string-match ,pv (or ,gv ""))
15561 `(equal ,pv (or ,gv ""))))
15562 (t `(member ,(downcase tag) tags-list)))
15563 mm (if minus (list 'not mm) mm)
15564 term (substring term (match-end 0)))
15565 (push mm tagsmatcher))
15566 (push (if (> (length tagsmatcher) 1)
15567 (cons 'and tagsmatcher)
15568 (car tagsmatcher))
15569 orlist)
15570 (setq tagsmatcher nil))
15571 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15572 (setq tagsmatcher
15573 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15575 ;; Make the todo matcher
15577 (setq todomatcher t)
15578 (setq orterms (org-split-string todomatch "|") orlist nil)
15579 (while (setq term (pop orterms))
15580 (while (string-match re term)
15581 (setq minus (and (match-end 1)
15582 (equal (match-string 1 term) "-"))
15583 kwd (match-string 2 term)
15584 re-p (equal (string-to-char kwd) ?{)
15585 term (substring term (match-end 0))
15586 mm (if re-p
15587 `(string-match ,(substring kwd 1 -1) todo)
15588 (list 'equal 'todo kwd))
15589 mm (if minus (list 'not mm) mm))
15590 (push mm todomatcher))
15591 (push (if (> (length todomatcher) 1)
15592 (cons 'and todomatcher)
15593 (car todomatcher))
15594 orlist)
15595 (setq todomatcher nil))
15596 (setq todomatcher (if (> (length orlist) 1)
15597 (cons 'or orlist) (car orlist))))
15599 ;; Return the string and lisp forms of the matcher
15600 (setq matcher (if todomatcher
15601 (list 'and tagsmatcher todomatcher)
15602 tagsmatcher))
15603 (cons match0 matcher)))
15605 (defun org-match-any-p (re list)
15606 "Does re match any element of list?"
15607 (setq list (mapcar (lambda (x) (string-match re x)) list))
15608 (delq nil list))
15610 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15611 (defvar org-tags-overlay (org-make-overlay 1 1))
15612 (org-detach-overlay org-tags-overlay)
15614 (defun org-align-tags-here (to-col)
15615 ;; Assumes that this is a headline
15616 (let ((pos (point)) (col (current-column)) tags)
15617 (beginning-of-line 1)
15619 (< pos (match-beginning 2)))
15620 (progn
15621 (setq tags (match-string 2))
15622 (goto-char (match-beginning 1))
15623 (insert " ")
15624 (delete-region (point) (1+ (match-end 0)))
15625 (backward-char 1)
15626 (move-to-column
15627 (max (1+ (current-column))
15628 (1+ col)
15629 (if (> to-col 0)
15630 to-col
15631 (- (abs to-col) (length tags))))
15632 t)
15633 (insert tags)
15634 (move-to-column (min (current-column) col) t))
15635 (goto-char pos))))
15637 (defun org-set-tags (&optional arg just-align)
15638 "Set the tags for the current headline.
15639 With prefix ARG, realign all tags in headings in the current buffer."
15640 (interactive "P")
15641 (let* ((re (concat "^" outline-regexp))
15642 (current (org-get-tags-string))
15643 (col (current-column))
15644 (org-setting-tags t)
15645 table current-tags inherited-tags ; computed below when needed
15646 tags p0 c0 c1 rpl)
15647 (if arg
15648 (save-excursion
15649 (goto-char (point-min))
15650 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15651 (while (re-search-forward re nil t)
15652 (org-set-tags nil t)
15653 (end-of-line 1)))
15654 (message "All tags realigned to column %d" org-tags-column))
15655 (if just-align
15656 (setq tags current)
15657 ;; Get a new set of tags from the user
15658 (save-excursion
15659 (setq table (or org-tag-alist (org-get-buffer-tags))
15660 org-last-tags-completion-table table
15661 current-tags (org-split-string current ":")
15662 inherited-tags (nreverse
15663 (nthcdr (length current-tags)
15664 (nreverse (org-get-tags-at))))
15665 tags
15666 (if (or (eq t org-use-fast-tag-selection)
15667 (and org-use-fast-tag-selection
15668 (delq nil (mapcar 'cdr table))))
15669 (org-fast-tag-selection
15670 current-tags inherited-tags table
15671 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15672 (let ((org-add-colon-after-tag-completion t))
15673 (org-trim
15674 (org-without-partial-completion
15675 (completing-read "Tags: " 'org-tags-completion-function
15676 nil nil current 'org-tags-history)))))))
15677 (while (string-match "[-+&]+" tags)
15678 ;; No boolean logic, just a list
15679 (setq tags (replace-match ":" t t tags))))
15682 (setq tags "")
15683 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15684 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15686 ;; Insert new tags at the correct column
15687 (beginning-of-line 1)
15688 (cond
15689 ((and (equal current "") (equal tags "")))
15690 ((re-search-forward
15692 (point-at-eol) t)
15693 (if (equal tags "")
15694 (setq rpl "")
15695 (goto-char (match-beginning 0))
15696 (setq c0 (current-column) p0 (point)
15697 c1 (max (1+ c0) (if (> org-tags-column 0)
15698 org-tags-column
15699 (- (- org-tags-column) (length tags))))
15700 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15701 (replace-match rpl t t)
15702 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15703 tags)
15704 (t (error "Tags alignment failed")))
15705 (move-to-column col)
15706 (unless just-align
15707 (run-hooks 'org-after-tags-change-hook)))))
15709 (defun org-change-tag-in-region (beg end tag off)
15710 "Add or remove TAG for each entry in the region.
15711 This works in the agenda, and also in an org-mode buffer."
15712 (interactive
15713 (list (region-beginning) (region-end)
15714 (let ((org-last-tags-completion-table
15715 (if (org-mode-p)
15716 (org-get-buffer-tags)
15717 (org-global-tags-completion-table))))
15718 (completing-read
15719 "Tag: " 'org-tags-completion-function nil nil nil
15720 'org-tags-history))
15721 (progn
15722 (message "[s]et or [r]emove? ")
15723 (equal (read-char-exclusive) ?r))))
15724 (if (fboundp 'deactivate-mark) (deactivate-mark))
15725 (let ((agendap (equal major-mode 'org-agenda-mode))
15726 l1 l2 m buf pos newhead (cnt 0))
15727 (goto-char end)
15728 (setq l2 (1- (org-current-line)))
15729 (goto-char beg)
15730 (setq l1 (org-current-line))
15731 (loop for l from l1 to l2 do
15732 (goto-line l)
15733 (setq m (get-text-property (point) 'org-hd-marker))
15734 (when (or (and (org-mode-p) (org-on-heading-p))
15735 (and agendap m))
15736 (setq buf (if agendap (marker-buffer m) (current-buffer))
15737 pos (if agendap m (point)))
15738 (with-current-buffer buf
15739 (save-excursion
15740 (save-restriction
15741 (goto-char pos)
15742 (setq cnt (1+ cnt))
15743 (org-toggle-tag tag (if off 'off 'on))
15744 (setq newhead (org-get-heading)))))
15745 (and agendap (org-agenda-change-all-lines newhead m))))
15746 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15748 (defun org-tags-completion-function (string predicate &optional flag)
15749 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15750 (confirm (lambda (x) (stringp (car x)))))
15752 (setq s1 (match-string 1 string)
15753 s2 (match-string 2 string))
15754 (setq s1 "" s2 string))
15755 (cond
15756 ((eq flag nil)
15757 ;; try completion
15758 (setq rtn (try-completion s2 ctable confirm))
15759 (if (stringp rtn)
15760 (setq rtn
15761 (concat s1 s2 (substring rtn (length s2))
15762 (if (and org-add-colon-after-tag-completion
15763 (assoc rtn ctable))
15764 ":" ""))))
15765 rtn)
15766 ((eq flag t)
15767 ;; all-completions
15768 (all-completions s2 ctable confirm)
15769 )
15770 ((eq flag 'lambda)
15771 ;; exact match?
15772 (assoc s2 ctable)))
15773 ))
15775 (defun org-fast-tag-insert (kwd tags face &optional end)
15776 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15777 (insert (format "%-12s" (concat kwd ":"))
15778 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15779 (or end "")))
15781 (defun org-fast-tag-show-exit (flag)
15782 (save-excursion
15783 (goto-line 3)
15785 (replace-match ""))
15786 (when flag
15787 (end-of-line 1)
15788 (move-to-column (- (window-width) 19) t)
15789 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15791 (defun org-set-current-tags-overlay (current prefix)
15792 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15793 (if (featurep 'xemacs)
15794 (org-overlay-display org-tags-overlay (concat prefix s)
15795 'secondary-selection)
15796 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15797 (org-overlay-display org-tags-overlay (concat prefix s)))))
15799 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15800 "Fast tag selection with single keys.
15801 CURRENT is the current list of tags in the headline, INHERITED is the
15802 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15803 possibly with grouping information. TODO-TABLE is a similar table with
15804 TODO keywords, should these have keys assigned to them.
15805 If the keys are nil, a-z are automatically assigned.
15806 Returns the new tags string, or nil to not change the current settings."
15807 (let* ((fulltable (append table todo-table))
15808 (maxlen (apply 'max (mapcar
15809 (lambda (x)
15810 (if (stringp (car x)) (string-width (car x)) 0))
15811 fulltable)))
15812 (buf (current-buffer))
15813 (expert (eq org-fast-tag-selection-single-key 'expert))
15814 (buffer-tags nil)
15815 (fwidth (+ maxlen 3 1 3))
15816 (ncol (/ (- (window-width) 4) fwidth))
15817 (i-face 'org-done)
15818 (c-face 'org-todo)
15819 tg cnt e c char c1 c2 ntable tbl rtn
15820 ov-start ov-end ov-prefix
15821 (exit-after-next org-fast-tag-selection-single-key)
15822 (done-keywords org-done-keywords)
15823 groups ingroup)
15824 (save-excursion
15825 (beginning-of-line 1)
15826 (if (looking-at
15828 (setq ov-start (match-beginning 1)
15829 ov-end (match-end 1)
15830 ov-prefix "")
15831 (setq ov-start (1- (point-at-eol))
15832 ov-end (1+ ov-start))
15834 (setq ov-prefix
15835 (concat
15836 (buffer-substring (1- (point)) (point))
15837 (if (> (current-column) org-tags-column)
15838 " "
15839 (make-string (- org-tags-column (current-column)) ?\ ))))))
15840 (org-move-overlay org-tags-overlay ov-start ov-end)
15841 (save-window-excursion
15842 (if expert
15843 (set-buffer (get-buffer-create " *Org tags*"))
15844 (delete-other-windows)
15845 (split-window-vertically)
15846 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15847 (erase-buffer)
15848 (org-set-local 'org-done-keywords done-keywords)
15851 (org-fast-tag-show-exit exit-after-next)
15852 (org-set-current-tags-overlay current ov-prefix)
15853 (setq tbl fulltable char ?a cnt 0)
15854 (while (setq e (pop tbl))
15855 (cond
15856 ((equal e '(:startgroup))
15857 (push '() groups) (setq ingroup t)
15858 (when (not (= cnt 0))
15859 (setq cnt 0)
15861 (insert "{ "))
15862 ((equal e '(:endgroup))
15863 (setq ingroup nil cnt 0)
15865 (t
15866 (setq tg (car e) c2 nil)
15867 (if (cdr e)
15868 (setq c (cdr e))
15869 ;; automatically assign a character.
15870 (setq c1 (string-to-char
15871 (downcase (substring
15872 tg (if (= (string-to-char tg) ?@) 1 0)))))
15873 (if (or (rassoc c1 ntable) (rassoc c1 table))
15874 (while (or (rassoc char ntable) (rassoc char table))
15875 (setq char (1+ char)))
15876 (setq c2 c1))
15877 (setq c (or c2 char)))
15878 (if ingroup (push tg (car groups)))
15879 (setq tg (org-add-props tg nil 'face
15880 (cond
15881 ((not (assoc tg table))
15882 (org-get-todo-face tg))
15883 ((member tg current) c-face)
15884 ((member tg inherited) i-face)
15885 (t nil))))
15886 (if (and (= cnt 0) (not ingroup)) (insert " "))
15887 (insert "[" c "] " tg (make-string
15888 (- fwidth 4 (length tg)) ?\ ))
15889 (push (cons tg c) ntable)
15890 (when (= (setq cnt (1+ cnt)) ncol)
15892 (if ingroup (insert " "))
15893 (setq cnt 0)))))
15894 (setq ntable (nreverse ntable))
15896 (goto-char (point-min))
15897 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15898 (fit-window-to-buffer))
15899 (setq rtn
15900 (catch 'exit
15901 (while t
15902 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15903 (if groups " [!] no groups" " [!]groups")
15904 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15905 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15906 (cond
15908 ((= c ?!)
15909 (setq groups (not groups))
15910 (goto-char (point-min))
15911 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15912 ((= c ?\C-c)
15913 (if (not expert)
15914 (org-fast-tag-show-exit
15915 (setq exit-after-next (not exit-after-next)))
15916 (setq expert nil)
15917 (delete-other-windows)
15918 (split-window-vertically)
15919 (org-switch-to-buffer-other-window " *Org tags*")
15920 (and (fboundp 'fit-window-to-buffer)
15921 (fit-window-to-buffer))))
15922 ((or (= c ?\C-g)
15923 (and (= c ?q) (not (rassoc c ntable))))
15924 (org-detach-overlay org-tags-overlay)
15925 (setq quit-flag t))
15926 ((= c ?\ )
15927 (setq current nil)
15928 (if exit-after-next (setq exit-after-next 'now)))
15930 (condition-case nil
15931 (setq tg (completing-read
15932 "Tag: "
15933 (or buffer-tags
15934 (with-current-buffer buf
15935 (org-get-buffer-tags)))))
15936 (quit (setq tg "")))
15938 (add-to-list 'buffer-tags (list tg))
15939 (if (member tg current)
15940 (setq current (delete tg current))
15941 (push tg current)))
15942 (if exit-after-next (setq exit-after-next 'now)))
15943 ((setq e (rassoc c todo-table) tg (car e))
15944 (with-current-buffer buf
15945 (save-excursion (org-todo tg)))
15946 (if exit-after-next (setq exit-after-next 'now)))
15947 ((setq e (rassoc c ntable) tg (car e))
15948 (if (member tg current)
15949 (setq current (delete tg current))
15950 (loop for g in groups do
15951 (if (member tg g)
15952 (mapc (lambda (x)
15953 (setq current (delete x current)))
15954 g)))
15955 (push tg current))
15956 (if exit-after-next (setq exit-after-next 'now))))
15958 ;; Create a sorted list
15959 (setq current
15960 (sort current
15961 (lambda (a b)
15962 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15963 (if (eq exit-after-next 'now) (throw 'exit t))
15964 (goto-char (point-min))
15965 (beginning-of-line 2)
15966 (delete-region (point) (point-at-eol))
15967 (org-fast-tag-insert "Current" current c-face)
15968 (org-set-current-tags-overlay current ov-prefix)
15969 (while (re-search-forward
15971 (setq tg (match-string 1))
15972 (add-text-properties
15973 (match-beginning 1) (match-end 1)
15974 (list 'face
15975 (cond
15976 ((member tg current) c-face)
15977 ((member tg inherited) i-face)
15978 (t (get-text-property (match-beginning 1) 'face))))))
15979 (goto-char (point-min)))))
15980 (org-detach-overlay org-tags-overlay)
15981 (if rtn
15982 (mapconcat 'identity current ":")
15983 nil))))
15985 (defun org-get-tags-string ()
15986 "Get the TAGS string in the current headline."
15987 (unless (org-on-heading-p t)
15988 (error "Not on a heading"))
15989 (save-excursion
15990 (beginning-of-line 1)
15992 (org-match-string-no-properties 1)
15993 "")))
15995 (defun org-get-tags ()
15996 "Get the list of tags specified in the current headline."
15997 (org-split-string (org-get-tags-string) ":"))
15999 (defun org-get-buffer-tags ()
16000 "Get a table of all tags used in the buffer, for completion."
16001 (let (tags)
16002 (save-excursion
16003 (goto-char (point-min))
16004 (while (re-search-forward
16006 (when (equal (char-after (point-at-bol 0)) ?*)
16007 (mapc (lambda (x) (add-to-list 'tags x))
16008 (org-split-string (org-match-string-no-properties 1) ":")))))
16009 (mapcar 'list tags)))
16012 ;;;; Properties
16014 ;;; Setting and retrieving properties
16016 (defconst org-special-properties
16017 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
16018 "TIMESTAMP" "TIMESTAMP_IA")
16019 "The special properties valid in Org-mode.
16021 These are properties that are not defined in the property drawer,
16022 but in some other way.")
16024 (defconst org-default-properties
16025 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
16026 "LOCATION" "LOGGING" "COLUMNS")
16027 "Some properties that are used by Org-mode for various purposes.
16028 Being in this list makes sure that they are offered for completion.")
16031 "Regular expression matching the first line of a property drawer.")
16034 "Regular expression matching the first line of a property drawer.")
16036 (defun org-property-action ()
16037 "Do an action on properties."
16038 (interactive)
16039 (let (c)
16040 (org-at-property-p)
16041 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
16042 (setq c (read-char-exclusive))
16043 (cond
16044 ((equal c ?s)
16045 (call-interactively 'org-set-property))
16046 ((equal c ?d)
16047 (call-interactively 'org-delete-property))
16048 ((equal c ?D)
16049 (call-interactively 'org-delete-property-globally))
16050 ((equal c ?c)
16051 (call-interactively 'org-compute-property-at-point))
16052 (t (error "No such property action %c" c)))))
16054 (defun org-at-property-p ()
16055 "Is the cursor in a property line?"
16056 ;; FIXME: Does not check if we are actually in the drawer.
16057 ;; FIXME: also returns true on any drawers.....
16058 ;; This is used by C-c C-c for property action.
16059 (save-excursion
16060 (beginning-of-line 1)
16063 (defmacro org-with-point-at (pom &rest body)
16064 "Move to buffer and point of point-or-marker POM for the duration of BODY."
16065 (declare (indent 1) (debug t))
16066 `(save-excursion
16067 (if (markerp pom) (set-buffer (marker-buffer pom)))
16068 (save-excursion
16069 (goto-char (or pom (point)))
16070 ,@body)))
16072 (defun org-get-property-block (&optional beg end force)
16073 "Return the (beg . end) range of the body of the property drawer.
16074 BEG and END can be beginning and end of subtree, if not given
16075 they will be found.
16076 If the drawer does not exist and FORCE is non-nil, create the drawer."
16077 (catch 'exit
16078 (save-excursion
16079 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
16080 (end (or end (progn (outline-next-heading) (point)))))
16081 (goto-char beg)
16082 (if (re-search-forward org-property-start-re end t)
16083 (setq beg (1+ (match-end 0)))
16084 (if force
16085 (save-excursion
16086 (org-insert-property-drawer)
16087 (setq end (progn (outline-next-heading) (point))))
16088 (throw 'exit nil))
16089 (goto-char beg)
16090 (if (re-search-forward org-property-start-re end t)
16091 (setq beg (1+ (match-end 0)))))
16092 (if (re-search-forward org-property-end-re end t)
16093 (setq end (match-beginning 0))
16094 (or force (throw 'exit nil))
16095 (goto-char beg)
16096 (setq end beg)
16097 (org-indent-line-function)
16099 (cons beg end)))))
16101 (defun org-entry-properties (&optional pom which)
16102 "Get all properties of the entry at point-or-marker POM.
16103 This includes the TODO keyword, the tags, time strings for deadline,
16104 scheduled, and clocking, and any additional properties defined in the
16105 entry. The return value is an alist, keys may occur multiple times
16106 if the property key was used several times.
16107 POM may also be nil, in which case the current entry is used.
16108 If WHICH is nil or `all', get all properties. If WHICH is
16109 `special' or `standard', only get that subclass."
16110 (setq which (or which 'all))
16111 (org-with-point-at pom
16112 (let ((clockstr (substring org-clock-string 0 -1))
16113 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
16114 beg end range props sum-props key value string clocksum)
16115 (save-excursion
16116 (when (condition-case nil (org-back-to-heading t) (error nil))
16117 (setq beg (point))
16118 (setq sum-props (get-text-property (point) 'org-summaries))
16119 (setq clocksum (get-text-property (point) :org-clock-minutes))
16120 (outline-next-heading)
16121 (setq end (point))
16122 (when (memq which '(all special))
16123 ;; Get the special properties, like TODO and tags
16124 (goto-char beg)
16125 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16126 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16127 (when (looking-at org-priority-regexp)
16128 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16129 (when (and (setq value (org-get-tags-string))
16131 (push (cons "TAGS" value) props))
16132 (when (setq value (org-get-tags-at))
16133 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16134 props))
16135 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16136 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16137 string (if (equal key clockstr)
16138 (org-no-properties
16139 (org-trim
16140 (buffer-substring
16141 (match-beginning 3) (goto-char (point-at-eol)))))
16142 (substring (org-match-string-no-properties 3) 1 -1)))
16143 (unless key
16144 (if (= (char-after (match-beginning 3)) ?\[)
16145 (setq key "TIMESTAMP_IA")
16146 (setq key "TIMESTAMP")))
16147 (when (or (equal key clockstr) (not (assoc key props)))
16148 (push (cons key string) props)))
16150 )
16152 (when (memq which '(all standard))
16153 ;; Get the standard properties, like :PORP: ...
16154 (setq range (org-get-property-block beg end))
16155 (when range
16156 (goto-char (car range))
16157 (while (re-search-forward
16159 (cdr range) t)
16160 (setq key (org-match-string-no-properties 1)
16161 value (org-trim (or (org-match-string-no-properties 2) "")))
16162 (unless (member key excluded)
16163 (push (cons key (or value "")) props)))))
16164 (if clocksum
16165 (push (cons "CLOCKSUM"
16166 (org-column-number-to-string (/ (float clocksum) 60.)
16167 'add_times))
16168 props))
16169 (append sum-props (nreverse props)))))))
16171 (defun org-entry-get (pom property &optional inherit)
16172 "Get value of PROPERTY for entry at point-or-marker POM.
16173 If INHERIT is non-nil and the entry does not have the property,
16174 then also check higher levels of the hierarchy.
16175 If the property is present but empty, the return value is the empty string.
16176 If the property is not present at all, nil is returned."
16177 (org-with-point-at pom
16178 (if inherit
16179 (org-entry-get-with-inheritance property)
16180 (if (member property org-special-properties)
16181 ;; We need a special property. Use brute force, get all properties.
16182 (cdr (assoc property (org-entry-properties nil 'special)))
16183 (let ((range (org-get-property-block)))
16184 (if (and range
16185 (goto-char (car range))
16186 (re-search-forward
16188 (cdr range) t))
16189 ;; Found the property, return it.
16190 (if (match-end 1)
16191 (org-match-string-no-properties 1)
16192 "")))))))
16194 (defun org-entry-delete (pom property)
16195 "Delete the property PROPERTY from entry at point-or-marker POM."
16196 (org-with-point-at pom
16197 (if (member property org-special-properties)
16198 nil ; cannot delete these properties.
16199 (let ((range (org-get-property-block)))
16200 (if (and range
16201 (goto-char (car range))
16202 (re-search-forward
16204 (cdr range) t))
16205 (progn
16206 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16207 t)
16208 nil)))))
16210 ;; Multi-values properties are properties that contain multiple values
16211 ;; These values are assumed to be single words, separated by whitespace.
16212 (defun org-entry-add-to-multivalued-property (pom property value)
16213 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16214 (let* ((old (org-entry-get pom property))
16216 (unless (member value values)
16217 (setq values (cons value values))
16218 (org-entry-put pom property
16219 (mapconcat 'identity values " ")))))
16221 (defun org-entry-remove-from-multivalued-property (pom property value)
16222 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16223 (let* ((old (org-entry-get pom property))
16225 (when (member value values)
16226 (setq values (delete value values))
16227 (org-entry-put pom property
16228 (mapconcat 'identity values " ")))))
16230 (defun org-entry-member-in-multivalued-property (pom property value)
16231 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16232 (let* ((old (org-entry-get pom property))
16234 (member value values)))
16236 (defvar org-entry-property-inherited-from (make-marker))
16238 (defun org-entry-get-with-inheritance (property)
16239 "Get entry property, and search higher levels if not present."
16240 (let (tmp)
16241 (save-excursion
16242 (save-restriction
16243 (widen)
16244 (catch 'ex
16245 (while t
16246 (when (setq tmp (org-entry-get nil property))
16247 (org-back-to-heading t)
16248 (move-marker org-entry-property-inherited-from (point))
16249 (throw 'ex tmp))
16250 (or (org-up-heading-safe) (throw 'ex nil)))))
16251 (or tmp (cdr (assoc property org-local-properties))
16252 (cdr (assoc property org-global-properties))))))
16254 (defun org-entry-put (pom property value)
16255 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16256 (org-with-point-at pom
16257 (org-back-to-heading t)
16258 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16259 range)
16260 (cond
16261 ((equal property "TODO")
16263 (not (member value org-todo-keywords-1)))
16265 (if (or (not value)
16267 (setq value 'none))
16268 (org-todo value)
16269 (org-set-tags nil 'align))
16270 ((equal property "PRIORITY")
16272 (string-to-char value) ?\ ))
16273 (org-set-tags nil 'align))
16274 ((equal property "SCHEDULED")
16275 (if (re-search-forward org-scheduled-time-regexp end t)
16276 (cond
16277 ((eq value 'earlier) (org-timestamp-change -1 'day))
16278 ((eq value 'later) (org-timestamp-change 1 'day))
16279 (t (call-interactively 'org-schedule)))
16280 (call-interactively 'org-schedule)))
16281 ((equal property "DEADLINE")
16282 (if (re-search-forward org-deadline-time-regexp end t)
16283 (cond
16284 ((eq value 'earlier) (org-timestamp-change -1 'day))
16285 ((eq value 'later) (org-timestamp-change 1 'day))
16286 (t (call-interactively 'org-deadline)))
16287 (call-interactively 'org-deadline)))
16288 ((member property org-special-properties)
16289 (error "The %s property can not yet be set with `org-entry-put'"
16290 property))
16291 (t ; a non-special property
16292 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16293 (setq range (org-get-property-block beg end 'force))
16294 (goto-char (car range))
16295 (if (re-search-forward
16297 (progn
16298 (delete-region (match-beginning 1) (match-end 1))
16299 (goto-char (match-beginning 1)))
16300 (goto-char (cdr range))
16302 (backward-char 1)
16303 (org-indent-line-function)
16304 (insert ":" property ":"))
16305 (and value (insert " " value))
16306 (org-indent-line-function)))))))
16308 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16309 "Get all property keys in the current buffer.
16310 With INCLUDE-SPECIALS, also list the special properties that relect things
16311 like tags and TODO state.
16312 With INCLUDE-DEFAULTS, also include properties that has special meaning
16313 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16314 With INCLUDE-COLUMNS, also include property names given in COLUMN
16315 formats in the current buffer."
16316 (let (rtn range cfmt cols s p)
16317 (save-excursion
16318 (save-restriction
16319 (widen)
16320 (goto-char (point-min))
16321 (while (re-search-forward org-property-start-re nil t)
16322 (setq range (org-get-property-block))
16323 (goto-char (car range))
16324 (while (re-search-forward
16326 (cdr range) t)
16327 (add-to-list 'rtn (org-match-string-no-properties 1)))
16328 (outline-next-heading))))
16330 (when include-specials
16331 (setq rtn (append org-special-properties rtn)))
16333 (when include-defaults
16334 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16336 (when include-columns
16337 (save-excursion
16338 (save-restriction
16339 (widen)
16340 (goto-char (point-min))
16341 (while (re-search-forward
16343 nil t)
16344 (setq cfmt (match-string 2) s 0)
16346 cfmt s)
16347 (setq s (match-end 0)
16348 p (match-string 1 cfmt))
16349 (unless (or (equal p "ITEM")
16350 (member p org-special-properties))
16351 (add-to-list 'rtn (match-string 1 cfmt))))))))
16353 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16355 (defun org-property-values (key)
16356 "Return a list of all values of property KEY."
16357 (save-excursion
16358 (save-restriction
16359 (widen)
16360 (goto-char (point-min))
16362 values)
16363 (while (re-search-forward re nil t)
16364 (add-to-list 'values (org-trim (match-string 1))))
16365 (delete "" values)))))
16367 (defun org-insert-property-drawer ()
16368 "Insert a property drawer into the current entry."
16369 (interactive)
16370 (org-back-to-heading t)
16371 (looking-at outline-regexp)
16372 (let ((indent (- (match-end 0)(match-beginning 0)))
16373 (beg (point))
16375 end hiddenp)
16376 (outline-next-heading)
16377 (setq end (point))
16378 (goto-char beg)
16379 (while (re-search-forward re end t))
16380 (setq hiddenp (org-invisible-p))
16381 (end-of-line 1)
16383 (org-skip-over-state-notes)
16385 (if (eq (char-before) ?*) (forward-char 1))
16387 (beginning-of-line 0)
16388 (indent-to-column indent)
16389 (beginning-of-line 2)
16390 (indent-to-column indent)
16391 (beginning-of-line 0)
16392 (if hiddenp
16393 (save-excursion
16394 (org-back-to-heading t)
16395 (hide-entry))
16396 (org-flag-drawer t))))
16398 (defun org-set-property (property value)
16399 "In the current entry, set PROPERTY to VALUE.
16400 When called interactively, this will prompt for a property name, offering
16401 completion on existing and default properties. And then it will prompt
16402 for a value, offering competion either on allowed values (via an inherited
16403 xxx_ALL property) or on existing values in other instances of this property
16404 in the current file."
16405 (interactive
16406 (let* ((prop (completing-read
16407 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16408 (cur (org-entry-get nil prop))
16409 (allowed (org-property-get-allowed-values nil prop 'table))
16410 (existing (mapcar 'list (org-property-values prop)))
16411 (val (if allowed
16412 (completing-read "Value: " allowed nil 'req-match)
16413 (completing-read
16415 (concat "[" cur "]") "")
16416 ": ")
16417 existing nil nil "" nil cur))))
16418 (list prop (if (equal val "") cur val))))
16419 (unless (equal (org-entry-get nil property) value)
16420 (org-entry-put nil property value)))
16422 (defun org-delete-property (property)
16423 "In the current entry, delete PROPERTY."
16424 (interactive
16425 (let* ((prop (completing-read
16426 "Property: " (org-entry-properties nil 'standard))))
16427 (list prop)))
16428 (message "Property %s %s" property
16429 (if (org-entry-delete nil property)
16430 "deleted"
16431 "was not present in the entry")))
16433 (defun org-delete-property-globally (property)
16434 "Remove PROPERTY globally, from all entries."
16435 (interactive
16436 (let* ((prop (completing-read
16437 "Globally remove property: "
16438 (mapcar 'list (org-buffer-property-keys)))))
16439 (list prop)))
16440 (save-excursion
16441 (save-restriction
16442 (widen)
16443 (goto-char (point-min))
16444 (let ((cnt 0))
16445 (while (re-search-forward
16447 nil t)
16448 (setq cnt (1+ cnt))
16449 (replace-match ""))
16452 (defvar org-columns-current-fmt-compiled) ; defined below
16454 (defun org-compute-property-at-point ()
16455 "Compute the property at point.
16456 This looks for an enclosing column format, extracts the operator and
16457 then applies it to the proerty in the column format's scope."
16458 (interactive)
16459 (unless (org-at-property-p)
16460 (error "Not at a property"))
16461 (let ((prop (org-match-string-no-properties 2)))
16462 (org-columns-get-format-and-top-level)
16463 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16464 (error "No operator defined for property %s" prop))
16465 (org-columns-compute prop)))
16467 (defun org-property-get-allowed-values (pom property &optional table)
16468 "Get allowed values for the property PROPERTY.
16469 When TABLE is non-nil, return an alist that can directly be used for
16470 completion."
16471 (let (vals)
16472 (cond
16473 ((equal property "TODO")
16474 (setq vals (org-with-point-at pom
16475 (append org-todo-keywords-1 '("")))))
16476 ((equal property "PRIORITY")
16477 (let ((n org-lowest-priority))
16478 (while (>= n org-highest-priority)
16479 (push (char-to-string n) vals)
16480 (setq n (1- n)))))
16481 ((member property org-special-properties))
16482 (t
16483 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16486 (setq vals (car (read-from-string (concat "(" vals ")"))))
16487 (setq vals (mapcar (lambda (x)
16488 (cond ((stringp x) x)
16489 ((numberp x) (number-to-string x))
16490 ((symbolp x) (symbol-name x))
16491 (t "???")))
16492 vals)))))
16493 (if table (mapcar 'list vals) vals)))
16495 (defun org-property-previous-allowed-value (&optional previous)
16496 "Switch to the next allowed value for this property."
16497 (interactive)
16498 (org-property-next-allowed-value t))
16500 (defun org-property-next-allowed-value (&optional previous)
16501 "Switch to the next allowed value for this property."
16502 (interactive)
16503 (unless (org-at-property-p)
16504 (error "Not at a property"))
16505 (let* ((key (match-string 2))
16506 (value (match-string 3))
16507 (allowed (or (org-property-get-allowed-values (point) key)
16508 (and (member value '("[ ]" "[-]" "[X]"))
16509 '("[ ]" "[X]"))))
16510 nval)
16511 (unless allowed
16512 (error "Allowed values for this property have not been defined"))
16513 (if previous (setq allowed (reverse allowed)))
16514 (if (member value allowed)
16515 (setq nval (car (cdr (member value allowed)))))
16516 (setq nval (or nval (car allowed)))
16517 (if (equal nval value)
16518 (error "Only one allowed value for this property"))
16519 (org-at-property-p)
16520 (replace-match (concat " :" key ": " nval) t t)
16521 (org-indent-line-function)
16522 (beginning-of-line 1)
16525 (defun org-find-entry-with-id (ident)
16526 "Locate the entry that contains the ID property with exact value IDENT.
16527 IDENT can be a string, a symbol or a number, this function will search for
16528 the string representation of it.
16529 Return the position where this entry starts, or nil if there is no such entry."
16530 (let ((id (cond
16531 ((stringp ident) ident)
16532 ((symbol-name ident) (symbol-name ident))
16533 ((numberp ident) (number-to-string ident))
16534 (t (error "IDENT %s must be a string, symbol or number" ident))))
16535 (case-fold-search nil))
16536 (save-excursion
16537 (save-restriction
16538 (widen)
16539 (goto-char (point-min))
16540 (when (re-search-forward
16542 nil t)
16543 (org-back-to-heading)
16544 (point))))))
16546 ;;; Column View
16548 (defvar org-columns-overlays nil
16549 "Holds the list of current column overlays.")
16551 (defvar org-columns-current-fmt nil
16552 "Local variable, holds the currently active column format.")
16553 (defvar org-columns-current-fmt-compiled nil
16554 "Local variable, holds the currently active column format.
16555 This is the compiled version of the format.")
16556 (defvar org-columns-current-widths nil
16557 "Loval variable, holds the currently widths of fields.")
16558 (defvar org-columns-current-maxwidths nil
16559 "Loval variable, holds the currently active maximum column widths.")
16560 (defvar org-columns-begin-marker (make-marker)
16561 "Points to the position where last a column creation command was called.")
16562 (defvar org-columns-top-level-marker (make-marker)
16563 "Points to the position where current columns region starts.")
16565 (defvar org-columns-map (make-sparse-keymap)
16566 "The keymap valid in column display.")
16568 (defun org-columns-content ()
16569 "Switch to contents view while in columns view."
16570 (interactive)
16571 (org-overview)
16572 (org-content))
16574 (org-defkey org-columns-map "c" 'org-columns-content)
16575 (org-defkey org-columns-map "o" 'org-overview)
16576 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16577 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16578 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16579 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16580 (org-defkey org-columns-map "v" 'org-columns-show-value)
16581 (org-defkey org-columns-map "q" 'org-columns-quit)
16582 (org-defkey org-columns-map "r" 'org-columns-redo)
16583 (org-defkey org-columns-map "g" 'org-columns-redo)
16584 (org-defkey org-columns-map [left] 'backward-char)
16585 (org-defkey org-columns-map "\M-b" 'backward-char)
16586 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16587 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16588 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16589 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16590 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16591 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16592 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16593 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16594 (org-defkey org-columns-map "<" 'org-columns-narrow)
16595 (org-defkey org-columns-map ">" 'org-columns-widen)
16596 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16597 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16598 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16599 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16601 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16602 '("Column"
16603 ["Edit property" org-columns-edit-value t]
16604 ["Next allowed value" org-columns-next-allowed-value t]
16605 ["Previous allowed value" org-columns-previous-allowed-value t]
16606 ["Show full value" org-columns-show-value t]
16607 ["Edit allowed values" org-columns-edit-allowed t]
16608 "--"
16609 ["Edit column attributes" org-columns-edit-attributes t]
16610 ["Increase column width" org-columns-widen t]
16611 ["Decrease column width" org-columns-narrow t]
16612 "--"
16613 ["Move column right" org-columns-move-right t]
16614 ["Move column left" org-columns-move-left t]
16615 ["Add column" org-columns-new t]
16616 ["Delete column" org-columns-delete t]
16617 "--"
16618 ["CONTENTS" org-columns-content t]
16619 ["OVERVIEW" org-overview t]
16620 ["Refresh columns display" org-columns-redo t]
16621 "--"
16622 ["Open link" org-columns-open-link t]
16623 "--"
16624 ["Quit" org-columns-quit t]))
16626 (defun org-columns-new-overlay (beg end &optional string face)
16627 "Create a new column overlay and add it to the list."
16628 (let ((ov (org-make-overlay beg end)))
16629 (org-overlay-put ov 'face (or face 'secondary-selection))
16630 (org-overlay-display ov string face)
16631 (push ov org-columns-overlays)
16632 ov))
16634 (defun org-columns-display-here (&optional props)
16635 "Overlay the current line with column display."
16636 (interactive)
16637 (let* ((fmt org-columns-current-fmt-compiled)
16638 (beg (point-at-bol))
16639 (level-face (save-excursion
16640 (beginning-of-line 1)
16642 (org-get-level-face 2))))
16643 (color (list :foreground
16644 (face-attribute (or level-face 'default) :foreground)))
16645 props pom property ass width f string ov column val modval)
16646 ;; Check if the entry is in another buffer.
16647 (unless props
16648 (if (eq major-mode 'org-agenda-mode)
16649 (setq pom (or (get-text-property (point) 'org-hd-marker)
16650 (get-text-property (point) 'org-marker))
16651 props (if pom (org-entry-properties pom) nil))
16652 (setq props (org-entry-properties nil))))
16653 ;; Walk the format
16654 (while (setq column (pop fmt))
16655 (setq property (car column)
16656 ass (if (equal property "ITEM")
16657 (cons "ITEM"
16658 (save-match-data
16659 (org-no-properties
16660 (org-remove-tabs
16661 (buffer-substring-no-properties
16662 (point-at-bol) (point-at-eol))))))
16663 (assoc property props))
16664 width (or (cdr (assoc property org-columns-current-maxwidths))
16665 (nth 2 column)
16666 (length property))
16667 f (format "%%-%d.%ds | " width width)
16668 val (or (cdr ass) "")
16669 modval (if (equal property "ITEM")
16670 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16671 string (format f (or modval val)))
16672 ;; Create the overlay
16673 (org-unmodified
16674 (setq ov (org-columns-new-overlay
16675 beg (setq beg (1+ beg)) string
16676 (list color 'org-column)))
16677 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16678 (org-overlay-put ov 'keymap org-columns-map)
16679 (org-overlay-put ov 'org-columns-key property)
16680 (org-overlay-put ov 'org-columns-value (cdr ass))
16681 (org-overlay-put ov 'org-columns-value-modified modval)
16682 (org-overlay-put ov 'org-columns-pom pom)
16683 (org-overlay-put ov 'org-columns-format f))
16684 (if (or (not (char-after beg))
16686 (let ((inhibit-read-only t))
16687 (save-excursion
16688 (goto-char beg)
16689 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16690 ;; Make the rest of the line disappear.
16691 (org-unmodified
16692 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16693 (org-overlay-put ov 'invisible t)
16694 (org-overlay-put ov 'keymap org-columns-map)
16695 (org-overlay-put ov 'intangible t)
16696 (push ov org-columns-overlays)
16697 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16698 (org-overlay-put ov 'keymap org-columns-map)
16699 (push ov org-columns-overlays)
16700 (let ((inhibit-read-only t))
16701 (put-text-property (max (point-min) (1- (point-at-bol)))
16702 (min (point-max) (1+ (point-at-eol)))
16703 'read-only "Type `e' to edit property")))))
16705 (defvar org-previous-header-line-format nil
16706 "The header line format before column view was turned on.")
16707 (defvar org-columns-inhibit-recalculation nil
16708 "Inhibit recomputing of columns on column view startup.")
16711 (defvar header-line-format)
16712 (defun org-columns-display-here-title ()
16713 "Overlay the newline before the current line with the table title."
16714 (interactive)
16715 (let ((fmt org-columns-current-fmt-compiled)
16716 string (title "")
16717 property width f column str widths)
16718 (while (setq column (pop fmt))
16719 (setq property (car column)
16720 str (or (nth 1 column) property)
16721 width (or (cdr (assoc property org-columns-current-maxwidths))
16722 (nth 2 column)
16723 (length str))
16724 widths (push width widths)
16725 f (format "%%-%d.%ds | " width width)
16726 string (format f str)
16727 title (concat title string)))
16728 (setq title (concat
16729 (org-add-props " " nil 'display '(space :align-to 0))
16730 (org-add-props title nil 'face '(:weight bold :underline t))))
16731 (org-set-local 'org-previous-header-line-format header-line-format)
16732 (org-set-local 'org-columns-current-widths (nreverse widths))
16733 (setq header-line-format title)))
16735 (defun org-columns-remove-overlays ()
16736 "Remove all currently active column overlays."
16737 (interactive)
16738 (when (marker-buffer org-columns-begin-marker)
16739 (with-current-buffer (marker-buffer org-columns-begin-marker)
16740 (when (local-variable-p 'org-previous-header-line-format)
16741 (setq header-line-format org-previous-header-line-format)
16742 (kill-local-variable 'org-previous-header-line-format))
16743 (move-marker org-columns-begin-marker nil)
16744 (move-marker org-columns-top-level-marker nil)
16745 (org-unmodified
16746 (mapc 'org-delete-overlay org-columns-overlays)
16747 (setq org-columns-overlays nil)
16748 (let ((inhibit-read-only t))
16749 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16751 (defun org-columns-cleanup-item (item fmt)
16752 "Remove from ITEM what is a column in the format FMT."
16753 (if (not org-complex-heading-regexp)
16754 item
16755 (when (string-match org-complex-heading-regexp item)
16756 (concat
16757 (org-add-props (concat (match-string 1 item) " ") nil
16758 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16759 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16760 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16761 " " (match-string 4 item)
16762 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16764 (defun org-columns-show-value ()
16765 "Show the full value of the property."
16766 (interactive)
16767 (let ((value (get-char-property (point) 'org-columns-value)))
16768 (message "Value is: %s" (or value ""))))
16770 (defun org-columns-quit ()
16771 "Remove the column overlays and in this way exit column editing."
16772 (interactive)
16773 (org-unmodified
16774 (org-columns-remove-overlays)
16775 (let ((inhibit-read-only t))
16776 (remove-text-properties (point-min) (point-max) '(read-only t))))
16777 (when (eq major-mode 'org-agenda-mode)
16778 (message
16779 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16781 (defun org-columns-check-computed ()
16782 "Check if this column value is computed.
16783 If yes, throw an error indicating that changing it does not make sense."
16784 (let ((val (get-char-property (point) 'org-columns-value)))
16785 (when (and (stringp val)
16786 (get-char-property 0 'org-computed val))
16787 (error "This value is computed from the entry's children"))))
16789 (defun org-columns-todo (&optional arg)
16790 "Change the TODO state during column view."
16791 (interactive "P")
16792 (org-columns-edit-value "TODO"))
16794 (defun org-columns-set-tags-or-toggle (&optional arg)
16795 "Toggle checkbox at point, or set tags for current headline."
16796 (interactive "P")
16798 (get-char-property (point) 'org-columns-value))
16799 (org-columns-next-allowed-value)
16800 (org-columns-edit-value "TAGS")))
16802 (defun org-columns-edit-value (&optional key)
16803 "Edit the value of the property at point in column view.
16804 Where possible, use the standard interface for changing this line."
16805 (interactive)
16806 (org-columns-check-computed)
16807 (let* ((external-key key)
16808 (col (current-column))
16809 (key (or key (get-char-property (point) 'org-columns-key)))
16810 (value (get-char-property (point) 'org-columns-value))
16811 (bol (point-at-bol)) (eol (point-at-eol))
16812 (pom (or (get-text-property bol 'org-hd-marker)
16813 (point))) ; keep despite of compiler waring
16814 (line-overlays
16815 (delq nil (mapcar (lambda (x)
16816 (and (eq (overlay-buffer x) (current-buffer))
16817 (>= (overlay-start x) bol)
16818 (<= (overlay-start x) eol)
16819 x))
16820 org-columns-overlays)))
16821 nval eval allowed)
16822 (cond
16823 ((equal key "CLOCKSUM")
16824 (error "This special column cannot be edited"))
16825 ((equal key "ITEM")
16826 (setq eval '(org-with-point-at pom
16827 (org-edit-headline))))
16828 ((equal key "TODO")
16829 (setq eval '(org-with-point-at pom
16830 (let ((current-prefix-arg
16831 (if external-key current-prefix-arg '(4))))
16832 (call-interactively 'org-todo)))))
16833 ((equal key "PRIORITY")
16834 (setq eval '(org-with-point-at pom
16835 (call-interactively 'org-priority))))
16836 ((equal key "TAGS")
16837 (setq eval '(org-with-point-at pom
16838 (let ((org-fast-tag-selection-single-key
16839 (if (eq org-fast-tag-selection-single-key 'expert)
16840 t org-fast-tag-selection-single-key)))
16841 (call-interactively 'org-set-tags)))))
16842 ((equal key "DEADLINE")
16843 (setq eval '(org-with-point-at pom
16844 (call-interactively 'org-deadline))))
16845 ((equal key "SCHEDULED")
16846 (setq eval '(org-with-point-at pom
16847 (call-interactively 'org-schedule))))
16848 (t
16849 (setq allowed (org-property-get-allowed-values pom key 'table))
16850 (if allowed
16851 (setq nval (completing-read "Value: " allowed nil t))
16852 (setq nval (read-string "Edit: " value)))
16853 (setq nval (org-trim nval))
16854 (when (not (equal nval value))
16855 (setq eval '(org-entry-put pom key nval)))))
16856 (when eval
16857 (let ((inhibit-read-only t))
16858 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16859 (unwind-protect
16860 (progn
16861 (setq org-columns-overlays
16862 (org-delete-all line-overlays org-columns-overlays))
16863 (mapc 'org-delete-overlay line-overlays)
16864 (org-columns-eval eval))
16865 (org-columns-display-here))))
16866 (move-to-column col)
16867 (if (and (org-mode-p)
16868 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16869 (org-columns-update key))))
16871 (defun org-edit-headline () ; FIXME: this is not columns specific
16872 "Edit the current headline, the part without TODO keyword, TAGS."
16873 (org-back-to-heading)
16874 (when (looking-at org-todo-line-regexp)
16875 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16876 (txt (match-string 3))
16877 (post "")
16878 txt2)
16880 (setq post (match-string 0 txt)
16881 txt (substring txt 0 (match-beginning 0))))
16882 (setq txt2 (read-string "Edit: " txt))
16883 (when (not (equal txt txt2))
16884 (beginning-of-line 1)
16885 (insert pre txt2 post)
16886 (delete-region (point) (point-at-eol))
16887 (org-set-tags nil t)))))
16889 (defun org-columns-edit-allowed ()
16890 "Edit the list of allowed values for the current property."
16891 (interactive)
16892 (let* ((key (get-char-property (point) 'org-columns-key))
16893 (key1 (concat key "_ALL"))
16894 (allowed (org-entry-get (point) key1 t))
16895 nval)
16896 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16897 (setq nval (read-string "Allowed: " allowed))
16898 (org-entry-put
16899 (cond ((marker-position org-entry-property-inherited-from)
16900 org-entry-property-inherited-from)
16901 ((marker-position org-columns-top-level-marker)
16902 org-columns-top-level-marker))
16903 key1 nval)))
16905 (defmacro org-no-warnings (&rest body)
16906 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16908 (defun org-columns-eval (form)
16909 (let (hidep)
16910 (save-excursion
16911 (beginning-of-line 1)
16912 ;; `next-line' is needed here, because it skips invisible line.
16913 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16914 (setq hidep (org-on-heading-p 1)))
16915 (eval form)
16916 (and hidep (hide-entry))))
16918 (defun org-columns-previous-allowed-value ()
16919 "Switch to the previous allowed value for this column."
16920 (interactive)
16921 (org-columns-next-allowed-value t))
16923 (defun org-columns-next-allowed-value (&optional previous)
16924 "Switch to the next allowed value for this column."
16925 (interactive)
16926 (org-columns-check-computed)
16927 (let* ((col (current-column))
16928 (key (get-char-property (point) 'org-columns-key))
16929 (value (get-char-property (point) 'org-columns-value))
16930 (bol (point-at-bol)) (eol (point-at-eol))
16931 (pom (or (get-text-property bol 'org-hd-marker)
16932 (point))) ; keep despite of compiler waring
16933 (line-overlays
16934 (delq nil (mapcar (lambda (x)
16935 (and (eq (overlay-buffer x) (current-buffer))
16936 (>= (overlay-start x) bol)
16937 (<= (overlay-start x) eol)
16938 x))
16939 org-columns-overlays)))
16940 (allowed (or (org-property-get-allowed-values pom key)
16941 (and (memq
16942 (nth 4 (assoc key org-columns-current-fmt-compiled))
16943 '(checkbox checkbox-n-of-m checkbox-percent))
16944 '("[ ]" "[X]"))))
16945 nval)
16946 (when (equal key "ITEM")
16947 (error "Cannot edit item headline from here"))
16948 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16949 (error "Allowed values for this property have not been defined"))
16950 (if (member key '("SCHEDULED" "DEADLINE"))
16951 (setq nval (if previous 'earlier 'later))
16952 (if previous (setq allowed (reverse allowed)))
16953 (if (member value allowed)
16954 (setq nval (car (cdr (member value allowed)))))
16955 (setq nval (or nval (car allowed)))
16956 (if (equal nval value)
16957 (error "Only one allowed value for this property")))
16958 (let ((inhibit-read-only t))
16959 (remove-text-properties (1- bol) eol '(read-only t))
16960 (unwind-protect
16961 (progn
16962 (setq org-columns-overlays
16963 (org-delete-all line-overlays org-columns-overlays))
16964 (mapc 'org-delete-overlay line-overlays)
16965 (org-columns-eval '(org-entry-put pom key nval)))
16966 (org-columns-display-here)))
16967 (move-to-column col)
16968 (if (and (org-mode-p)
16969 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16970 (org-columns-update key))))
16972 (defun org-verify-version (task)
16973 (cond
16974 ((eq task 'columns)
16975 (if (or (featurep 'xemacs)
16976 (< emacs-major-version 22))
16977 (error "Emacs 22 is required for the columns feature")))))
16979 (defun org-columns-open-link (&optional arg)
16980 (interactive "P")
16981 (let ((value (get-char-property (point) 'org-columns-value)))
16982 (org-open-link-from-string value arg)))
16984 (defun org-open-link-from-string (s &optional arg)
16985 "Open a link in the string S, as if it was in Org-mode."
16986 (interactive)
16987 (with-temp-buffer
16988 (let ((org-inhibit-startup t))
16989 (org-mode)
16990 (insert s)
16991 (goto-char (point-min))
16992 (org-open-at-point arg))))
16994 (defun org-columns-get-format-and-top-level ()
16995 (let (fmt)
16996 (when (condition-case nil (org-back-to-heading) (error nil))
16997 (move-marker org-entry-property-inherited-from nil)
16998 (setq fmt (org-entry-get nil "COLUMNS" t)))
16999 (setq fmt (or fmt org-columns-default-format))
17000 (org-set-local 'org-columns-current-fmt fmt)
17001 (org-columns-compile-format fmt)
17002 (if (marker-position org-entry-property-inherited-from)
17003 (move-marker org-columns-top-level-marker
17004 org-entry-property-inherited-from)
17005 (move-marker org-columns-top-level-marker (point)))
17006 fmt))
17008 (defun org-columns ()
17009 "Turn on column view on an org-mode file."
17010 (interactive)
17011 (org-verify-version 'columns)
17012 (org-columns-remove-overlays)
17013 (move-marker org-columns-begin-marker (point))
17014 (let (beg end fmt cache maxwidths)
17015 (setq fmt (org-columns-get-format-and-top-level))
17016 (save-excursion
17017 (goto-char org-columns-top-level-marker)
17018 (setq beg (point))
17019 (unless org-columns-inhibit-recalculation
17020 (org-columns-compute-all))
17021 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
17022 (point-max)))
17023 ;; Get and cache the properties
17024 (goto-char beg)
17025 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
17026 (save-excursion
17027 (save-restriction
17028 (narrow-to-region beg end)
17029 (org-clock-sum))))
17030 (while (re-search-forward (concat "^" outline-regexp) end t)
17031 (push (cons (org-current-line) (org-entry-properties)) cache))
17032 (when cache
17033 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17034 (org-set-local 'org-columns-current-maxwidths maxwidths)
17035 (org-columns-display-here-title)
17036 (mapc (lambda (x)
17037 (goto-line (car x))
17038 (org-columns-display-here (cdr x)))
17039 cache)))))
17041 (defun org-columns-new (&optional prop title width op fmt &rest rest)
17042 "Insert a new column, to the leeft o the current column."
17043 (interactive)
17044 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
17045 cell)
17046 (setq prop (completing-read
17047 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
17048 nil nil prop))
17049 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
17050 (setq width (read-string "Column width: " (if width (number-to-string width))))
17052 (setq width (string-to-number width))
17053 (setq width nil))
17054 (setq fmt (completing-read "Summary [none]: "
17055 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
17056 nil t))
17058 (setq fmt (intern fmt))
17059 (setq fmt nil))
17060 (if (eq fmt 'none) (setq fmt nil))
17061 (if editp
17062 (progn
17063 (setcar editp prop)
17064 (setcdr editp (list title width nil fmt)))
17065 (setq cell (nthcdr (1- (current-column))
17066 org-columns-current-fmt-compiled))
17067 (setcdr cell (cons (list prop title width nil fmt)
17068 (cdr cell))))
17069 (org-columns-store-format)
17070 (org-columns-redo)))
17072 (defun org-columns-delete ()
17073 "Delete the column at point from columns view."
17074 (interactive)
17075 (let* ((n (current-column))
17076 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
17077 (when (y-or-n-p
17079 (setq org-columns-current-fmt-compiled
17080 (delq (nth n org-columns-current-fmt-compiled)
17081 org-columns-current-fmt-compiled))
17082 (org-columns-store-format)
17083 (org-columns-redo)
17084 (if (>= (current-column) (length org-columns-current-fmt-compiled))
17085 (backward-char 1)))))
17087 (defun org-columns-edit-attributes ()
17088 "Edit the attributes of the current column."
17089 (interactive)
17090 (let* ((n (current-column))
17091 (info (nth n org-columns-current-fmt-compiled)))
17092 (apply 'org-columns-new info)))
17094 (defun org-columns-widen (arg)
17095 "Make the column wider by ARG characters."
17096 (interactive "p")
17097 (let* ((n (current-column))
17098 (entry (nth n org-columns-current-fmt-compiled))
17099 (width (or (nth 2 entry)
17100 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
17101 (setq width (max 1 (+ width arg)))
17102 (setcar (nthcdr 2 entry) width)
17103 (org-columns-store-format)
17104 (org-columns-redo)))
17106 (defun org-columns-narrow (arg)
17107 "Make the column nrrower by ARG characters."
17108 (interactive "p")
17109 (org-columns-widen (- arg)))
17111 (defun org-columns-move-right ()
17112 "Swap this column with the one to the right."
17113 (interactive)
17114 (let* ((n (current-column))
17115 (cell (nthcdr n org-columns-current-fmt-compiled))
17116 e)
17117 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17118 (error "Cannot shift this column further to the right"))
17119 (setq e (car cell))
17120 (setcar cell (car (cdr cell)))
17121 (setcdr cell (cons e (cdr (cdr cell))))
17122 (org-columns-store-format)
17123 (org-columns-redo)
17124 (forward-char 1)))
17126 (defun org-columns-move-left ()
17127 "Swap this column with the one to the left."
17128 (interactive)
17129 (let* ((n (current-column)))
17130 (when (= n 0)
17131 (error "Cannot shift this column further to the left"))
17132 (backward-char 1)
17133 (org-columns-move-right)
17134 (backward-char 1)))
17136 (defun org-columns-store-format ()
17137 "Store the text version of the current columns format in appropriate place.
17138 This is either in the COLUMNS property of the node starting the current column
17139 display, or in the #+COLUMNS line of the current buffer."
17140 (let (fmt (cnt 0))
17141 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17142 (org-set-local 'org-columns-current-fmt fmt)
17143 (if (marker-position org-columns-top-level-marker)
17144 (save-excursion
17145 (goto-char org-columns-top-level-marker)
17146 (if (and (org-at-heading-p)
17147 (org-entry-get nil "COLUMNS"))
17148 (org-entry-put nil "COLUMNS" fmt)
17149 (goto-char (point-min))
17150 ;; Overwrite all #+COLUMNS lines....
17152 (setq cnt (1+ cnt))
17153 (replace-match (concat "#+COLUMNS: " fmt) t t))
17154 (unless (> cnt 0)
17155 (goto-char (point-min))
17156 (or (org-on-heading-p t) (outline-next-heading))
17157 (let ((inhibit-read-only t))
17159 (org-set-local 'org-columns-default-format fmt))))))
17161 (defvar org-overriding-columns-format nil
17162 "When set, overrides any other definition.")
17163 (defvar org-agenda-view-columns-initially nil
17164 "When set, switch to columns view immediately after creating the agenda.")
17166 (defun org-agenda-columns ()
17167 "Turn on column view in the agenda."
17168 (interactive)
17169 (org-verify-version 'columns)
17170 (org-columns-remove-overlays)
17171 (move-marker org-columns-begin-marker (point))
17172 (let (fmt cache maxwidths m)
17173 (cond
17174 ((and (local-variable-p 'org-overriding-columns-format)
17175 org-overriding-columns-format)
17176 (setq fmt org-overriding-columns-format))
17177 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17178 (setq fmt (org-entry-get m "COLUMNS" t)))
17179 ((and (boundp 'org-columns-current-fmt)
17180 (local-variable-p 'org-columns-current-fmt)
17181 org-columns-current-fmt)
17182 (setq fmt org-columns-current-fmt))
17183 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17184 (setq m (get-text-property m 'org-hd-marker))
17185 (setq fmt (org-entry-get m "COLUMNS" t))))
17186 (setq fmt (or fmt org-columns-default-format))
17187 (org-set-local 'org-columns-current-fmt fmt)
17188 (org-columns-compile-format fmt)
17189 (save-excursion
17190 ;; Get and cache the properties
17191 (goto-char (point-min))
17192 (while (not (eobp))
17193 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17194 (get-text-property (point) 'org-marker)))
17195 (push (cons (org-current-line) (org-entry-properties m)) cache))
17196 (beginning-of-line 2))
17197 (when cache
17198 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17199 (org-set-local 'org-columns-current-maxwidths maxwidths)
17200 (org-columns-display-here-title)
17201 (mapc (lambda (x)
17202 (goto-line (car x))
17203 (org-columns-display-here (cdr x)))
17204 cache)))))
17206 (defun org-columns-get-autowidth-alist (s cache)
17207 "Derive the maximum column widths from the format and the cache."
17208 (let ((start 0) rtn)
17210 (push (cons (match-string 1 s) 1) rtn)
17211 (setq start (match-end 0)))
17212 (mapc (lambda (x)
17213 (setcdr x (apply 'max
17214 (mapcar
17215 (lambda (y)
17216 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17217 cache))))
17218 rtn)
17219 rtn))
17221 (defun org-columns-compute-all ()
17222 "Compute all columns that have operators defined."
17223 (org-unmodified
17224 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17225 (let ((columns org-columns-current-fmt-compiled) col)
17226 (while (setq col (pop columns))
17227 (when (nth 3 col)
17228 (save-excursion
17229 (org-columns-compute (car col)))))))
17231 (defun org-columns-update (property)
17232 "Recompute PROPERTY, and update the columns display for it."
17233 (org-columns-compute property)
17234 (let (fmt val pos)
17235 (save-excursion
17236 (mapc (lambda (ov)
17237 (when (equal (org-overlay-get ov 'org-columns-key) property)
17238 (setq pos (org-overlay-start ov))
17239 (goto-char pos)
17240 (when (setq val (cdr (assoc property
17241 (get-text-property
17242 (point-at-bol) 'org-summaries))))
17243 (setq fmt (org-overlay-get ov 'org-columns-format))
17244 (org-overlay-put ov 'org-columns-value val)
17245 (org-overlay-put ov 'display (format fmt val)))))
17246 org-columns-overlays))))
17248 (defun org-columns-compute (property)
17249 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17250 (interactive)
17251 (let* ((re (concat "^" outline-regexp))
17252 (lmax 30) ; Does anyone use deeper levels???
17253 (lsum (make-vector lmax 0))
17254 (lflag (make-vector lmax nil))
17255 (level 0)
17256 (ass (assoc property org-columns-current-fmt-compiled))
17257 (format (nth 4 ass))
17258 (printf (nth 5 ass))
17259 (beg org-columns-top-level-marker)
17260 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17261 (save-excursion
17262 ;; Find the region to compute
17263 (goto-char beg)
17264 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17265 (goto-char end)
17266 ;; Walk the tree from the back and do the computations
17267 (while (re-search-backward re beg t)
17268 (setq sumpos (match-beginning 0)
17269 last-level level
17270 level (org-outline-level)
17271 val (org-entry-get nil property)
17273 (cond
17274 ((< level last-level)
17275 ;; put the sum of lower levels here as a property
17276 (setq sum (aref lsum last-level) ; current sum
17277 flag (aref lflag last-level) ; any valid entries from children?
17278 str (org-column-number-to-string sum format printf)
17279 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17280 useval (if flag str1 (if valflag val ""))
17281 sum-alist (get-text-property sumpos 'org-summaries))
17282 (if (assoc property sum-alist)
17283 (setcdr (assoc property sum-alist) useval)
17284 (push (cons property useval) sum-alist)
17285 (org-unmodified
17286 (add-text-properties sumpos (1+ sumpos)
17287 (list 'org-summaries sum-alist))))
17288 (when val
17289 (org-entry-put nil property (if flag str val)))
17290 ;; add current to current level accumulator
17291 (when (or flag valflag)
17292 (aset lsum level (+ (aref lsum level)
17293 (if flag sum (org-column-string-to-number
17294 (if flag str val) format))))
17295 (aset lflag level t))
17296 ;; clear accumulators for deeper levels
17297 (loop for l from (1+ level) to (1- lmax) do
17298 (aset lsum l 0)
17299 (aset lflag l nil)))
17300 ((>= level last-level)
17301 ;; add what we have here to the accumulator for this level
17302 (aset lsum level (+ (aref lsum level)
17303 (org-column-string-to-number (or val "0") format)))
17304 (and valflag (aset lflag level t)))
17305 (t (error "This should not happen")))))))
17307 (defun org-columns-redo ()
17308 "Construct the column display again."
17309 (interactive)
17310 (message "Recomputing columns...")
17311 (save-excursion
17312 (if (marker-position org-columns-begin-marker)
17313 (goto-char org-columns-begin-marker))
17314 (org-columns-remove-overlays)
17315 (if (org-mode-p)
17316 (call-interactively 'org-columns)
17317 (call-interactively 'org-agenda-columns)))
17318 (message "Recomputing columns...done"))
17320 (defun org-columns-not-in-agenda ()
17321 (if (eq major-mode 'org-agenda-mode)
17322 (error "This command is only allowed in Org-mode buffers")))
17325 (defun org-string-to-number (s)
17326 "Convert string to number, and interpret hh:mm:ss."
17327 (if (not (string-match ":" s))
17328 (string-to-number s)
17329 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17330 (while l
17331 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17332 sum)))
17334 (defun org-column-number-to-string (n fmt &optional printf)
17335 "Convert a computed column number to a string value, according to FMT."
17336 (cond
17337 ((eq fmt 'add_times)
17338 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17339 (format "%d:%02d" h m)))
17340 ((eq fmt 'checkbox)
17341 (cond ((= n (floor n)) "[X]")
17342 ((> n 1.) "[-]")
17343 (t "[ ]")))
17344 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17345 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17346 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17347 (printf (format printf n))
17348 ((eq fmt 'currency)
17349 (format "%.2f" n))
17350 (t (number-to-string n))))
17352 (defun org-nofm-to-completion (n m &optional percent)
17353 (if (not percent)
17354 (format "[%d/%d]" n m)
17355 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17357 (defun org-column-string-to-number (s fmt)
17358 "Convert a column value to a number that can be used for column computing."
17359 (cond
17360 ((string-match ":" s)
17361 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17362 (while l
17363 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17364 sum))
17365 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17366 (if (equal s "[X]") 1. 0.000001))
17367 (t (string-to-number s))))
17369 (defun org-columns-uncompile-format (cfmt)
17370 "Turn the compiled columns format back into a string representation."
17371 (let ((rtn "") e s prop title op width fmt printf)
17372 (while (setq e (pop cfmt))
17373 (setq prop (car e)
17374 title (nth 1 e)
17375 width (nth 2 e)
17376 op (nth 3 e)
17377 fmt (nth 4 e)
17378 printf (nth 5 e))
17379 (cond
17380 ((eq fmt 'add_times) (setq op ":"))
17381 ((eq fmt 'checkbox) (setq op "X"))
17382 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17383 ((eq fmt 'checkbox-percent) (setq op "X%"))
17384 ((eq fmt 'add_numbers) (setq op "+"))
17385 ((eq fmt 'currency) (setq op "$")))
17386 (if (and op printf) (setq op (concat op ";" printf)))
17387 (if (equal title prop) (setq title nil))
17388 (setq s (concat "%" (if width (number-to-string width))
17389 prop
17390 (if title (concat "(" title ")"))
17391 (if op (concat "{" op "}"))))
17392 (setq rtn (concat rtn " " s)))
17393 (org-trim rtn)))
17395 (defun org-columns-compile-format (fmt)
17396 "Turn a column format string into an alist of specifications.
17397 The alist has one entry for each column in the format. The elements of
17398 that list are:
17399 property the property
17400 title the title field for the columns
17401 width the column width in characters, can be nil for automatic
17402 operator the operator if any
17403 format the output format for computed results, derived from operator
17404 printf a printf format for computed values"
17405 (let ((start 0) width prop title op f printf)
17406 (setq org-columns-current-fmt-compiled nil)
17407 (while (string-match
17408 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17409 fmt start)
17410 (setq start (match-end 0)
17411 width (match-string 1 fmt)
17412 prop (match-string 2 fmt)
17413 title (or (match-string 3 fmt) prop)
17414 op (match-string 4 fmt)
17415 f nil
17416 printf nil)
17417 (if width (setq width (string-to-number width)))
17418 (when (and op (string-match ";" op))
17419 (setq printf (substring op (match-end 0))
17420 op (substring op 0 (match-beginning 0))))
17421 (cond
17422 ((equal op "+") (setq f 'add_numbers))
17423 ((equal op "$") (setq f 'currency))
17424 ((equal op ":") (setq f 'add_times))
17425 ((equal op "X") (setq f 'checkbox))
17426 ((equal op "X/") (setq f 'checkbox-n-of-m))
17427 ((equal op "X%") (setq f 'checkbox-percent))
17428 )
17429 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17430 (setq org-columns-current-fmt-compiled
17431 (nreverse org-columns-current-fmt-compiled))))
17434 ;;; Dynamic block for Column view
17436 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
17437 "Get the column view of the current buffer or subtree.
17438 The first optional argument MAXLEVEL sets the level limit. A
17439 second optional argument SKIP-EMPTY-ROWS tells whether to skip
17440 empty rows, an empty row being one where all the column view
17441 specifiers except ITEM are empty. This function returns a list
17442 containing the title row and all other rows. Each row is a list
17443 of fields."
17444 (save-excursion
17445 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17446 (n (length title)) row tbl)
17447 (goto-char (point-min))
17449 (or (null maxlevel)
17450 (>= maxlevel
17451 (if org-odd-levels-only
17452 (/ (1+ (length (match-string 1))) 2)
17453 (length (match-string 1))))))
17454 (when (get-char-property (match-beginning 0) 'org-columns-key)
17455 (setq row nil)
17456 (loop for i from 0 to (1- n) do
17457 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17458 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17459 "")
17460 row))
17461 (setq row (nreverse row))
17462 (unless (and skip-empty-rows
17463 (eq 1 (length (delete "" (delete-dups row)))))
17464 (push row tbl))))
17465 (append (list title 'hline) (nreverse tbl)))))
17467 (defun org-dblock-write:columnview (params)
17468 "Write the column view table.
17469 PARAMS is a property list of parameters:
17471 :width enforce same column widths with <N> specifiers.
17472 :id the :ID: property of the entry where the columns view
17473 should be built, as a string. When `local', call locally.
17474 When `global' call column view with the cursor at the beginning
17475 of the buffer (usually this means that the whole buffer switches
17476 to column view).
17477 :hlines When t, insert a hline before each item. When a number, insert
17478 a hline before each level <= that number.
17479 :vlines When t, make each column a colgroup to enforce vertical lines.
17480 :maxlevel When set to a number, don't capture headlines below this level.
17481 :skip-empty-rows
17482 When t, skip rows where all specifiers other than ITEM are empty."
17483 (let ((pos (move-marker (make-marker) (point)))
17484 (hlines (plist-get params :hlines))
17485 (vlines (plist-get params :vlines))
17486 (maxlevel (plist-get params :maxlevel))
17487 (skip-empty-rows (plist-get params :skip-empty-rows))
17488 tbl id idpos nfields tmp)
17489 (save-excursion
17490 (save-restriction
17491 (when (setq id (plist-get params :id))
17492 (cond ((not id) nil)
17493 ((eq id 'global) (goto-char (point-min)))
17494 ((eq id 'local) nil)
17495 ((setq idpos (org-find-entry-with-id id))
17496 (goto-char idpos))
17497 (t (error "Cannot find entry with :ID: %s" id))))
17498 (org-columns)
17499 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
17500 (setq nfields (length (car tbl)))
17501 (org-columns-quit)))
17502 (goto-char pos)
17503 (move-marker pos nil)
17504 (when tbl
17505 (when (plist-get params :hlines)
17506 (setq tmp nil)
17507 (while tbl
17508 (if (eq (car tbl) 'hline)
17509 (push (pop tbl) tmp)
17511 (if (and (not (eq (car tmp) 'hline))
17512 (or (eq hlines t)
17513 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17514 (push 'hline tmp)))
17515 (push (pop tbl) tmp)))
17516 (setq tbl (nreverse tmp)))
17517 (when vlines
17518 (setq tbl (mapcar (lambda (x)
17519 (if (eq 'hline x) x (cons "" x)))
17520 tbl))
17521 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17522 (setq pos (point))
17523 (insert (org-listtable-to-string tbl))
17524 (when (plist-get params :width)
17526 org-columns-current-widths "|")))
17527 (goto-char pos)
17528 (org-table-align))))
17530 (defun org-listtable-to-string (tbl)
17531 "Convert a listtable TBL to a string that contains the Org-mode table.
17532 The table still need to be alligned. The resulting string has no leading
17533 and tailing newline characters."
17534 (mapconcat
17535 (lambda (x)
17536 (cond
17537 ((listp x)
17538 (concat "|" (mapconcat 'identity x "|") "|"))
17539 ((eq x 'hline) "|-|")
17540 (t (error "Garbage in listtable: %s" x))))
17543 (defun org-insert-columns-dblock ()
17544 "Create a dynamic block capturing a column view table."
17545 (interactive)
17546 (let ((defaults '(:name "columnview" :hlines 1))
17547 (id (completing-read
17548 "Capture columns (local, global, entry with :ID: property) [local]: "
17549 (append '(("global") ("local"))
17550 (mapcar 'list (org-property-values "ID"))))))
17551 (if (equal id "") (setq id 'local))
17552 (if (equal id "global") (setq id 'global))
17553 (setq defaults (append defaults (list :id id)))
17554 (org-create-dblock defaults)
17555 (org-update-dblock)))
17557 ;;;; Timestamps
17559 (defvar org-last-changed-timestamp nil)
17560 (defvar org-time-was-given) ; dynamically scoped parameter
17561 (defvar org-end-time-was-given) ; dynamically scoped parameter
17562 (defvar org-ts-what) ; dynamically scoped parameter
17564 (defun org-time-stamp (arg)
17565 "Prompt for a date/time and insert a time stamp.
17566 If the user specifies a time like HH:MM, or if this command is called
17567 with a prefix argument, the time stamp will contain date and time.
17568 Otherwise, only the date will be included. All parts of a date not
17569 specified by the user will be filled in from the current date/time.
17570 So if you press just return without typing anything, the time stamp
17571 will represent the current date/time. If there is already a timestamp
17572 at the cursor, it will be modified."
17573 (interactive "P")
17574 (let* ((ts nil)
17575 (default-time
17576 ;; Default time is either today, or, when entering a range,
17577 ;; the range start.
17578 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17579 (save-excursion
17580 (re-search-backward
17582 (- (point) 20) t)))
17583 (apply 'encode-time (org-parse-time-string (match-string 1)))
17584 (current-time)))
17585 (default-input (and ts (org-get-compact-tod ts)))
17586 org-time-was-given org-end-time-was-given time)
17587 (cond
17588 ((and (org-at-timestamp-p)
17589 (eq last-command 'org-time-stamp)
17590 (eq this-command 'org-time-stamp))
17591 (insert "--")
17592 (setq time (let ((this-command this-command))
17593 (org-read-date arg 'totime nil nil default-time default-input)))
17594 (org-insert-time-stamp time (or org-time-was-given arg)))
17595 ((org-at-timestamp-p)
17596 (setq time (let ((this-command this-command))
17597 (org-read-date arg 'totime nil nil default-time default-input)))
17598 (when (org-at-timestamp-p) ; just to get the match data
17599 (replace-match "")
17600 (setq org-last-changed-timestamp
17601 (org-insert-time-stamp
17602 time (or org-time-was-given arg)
17603 nil nil nil (list org-end-time-was-given))))
17604 (message "Timestamp updated"))
17605 (t
17606 (setq time (let ((this-command this-command))
17607 (org-read-date arg 'totime nil nil default-time default-input)))
17608 (org-insert-time-stamp time (or org-time-was-given arg)
17609 nil nil nil (list org-end-time-was-given))))))
17611 ;; FIXME: can we use this for something else????
17612 ;; like computing time differences?????
17613 (defun org-get-compact-tod (s)
17614 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17615 (let* ((t1 (match-string 1 s))
17616 (h1 (string-to-number (match-string 2 s)))
17617 (m1 (string-to-number (match-string 3 s)))
17618 (t2 (and (match-end 4) (match-string 5 s)))
17619 (h2 (and t2 (string-to-number (match-string 6 s))))
17620 (m2 (and t2 (string-to-number (match-string 7 s))))
17621 dh dm)
17622 (if (not t2)
17623 t1
17624 (setq dh (- h2 h1) dm (- m2 m1))
17625 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17626 (concat t1 "+" (number-to-string dh)
17627 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17629 (defun org-time-stamp-inactive (&optional arg)
17630 "Insert an inactive time stamp.
17631 An inactive time stamp is enclosed in square brackets instead of angle
17632 brackets. It is inactive in the sense that it does not trigger agenda entries,
17633 does not link to the calendar and cannot be changed with the S-cursor keys.
17634 So these are more for recording a certain time/date."
17635 (interactive "P")
17636 (let (org-time-was-given org-end-time-was-given time)
17637 (setq time (org-read-date arg 'totime))
17638 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17639 nil nil (list org-end-time-was-given))))
17641 (defvar org-date-ovl (org-make-overlay 1 1))
17642 (org-overlay-put org-date-ovl 'face 'org-warning)
17643 (org-detach-overlay org-date-ovl)
17645 (defvar org-ans1) ; dynamically scoped parameter
17646 (defvar org-ans2) ; dynamically scoped parameter
17648 (defvar org-plain-time-of-day-regexp) ; defined below
17650 (defvar org-read-date-overlay nil)
17651 (defvar org-dcst nil) ; dynamically scoped
17653 (defun org-read-date (&optional with-time to-time from-string prompt
17654 default-time default-input)
17655 "Read a date, possibly a time, and make things smooth for the user.
17656 The prompt will suggest to enter an ISO date, but you can also enter anything
17657 which will at least partially be understood by `parse-time-string'.
17658 Unrecognized parts of the date will default to the current day, month, year,
17659 hour and minute. If this command is called to replace a timestamp at point,
17660 of to enter the second timestamp of a range, the default time is taken from the
17661 existing stamp. For example,
17662 3-2-5 --> 2003-02-05
17663 feb 15 --> currentyear-02-15
17664 sep 12 9 --> 2009-09-12
17665 12:45 --> today 12:45
17666 22 sept 0:34 --> currentyear-09-22 0:34
17667 12 --> currentyear-currentmonth-12
17668 Fri --> nearest Friday (today or later)
17669 etc.
17671 Furthermore you can specify a relative date by giving, as the *first* thing
17672 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17673 change in days weeks, months, years.
17674 With a single plus or minus, the date is relative to today. With a double
17675 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17676 +4d --> four days from today
17677 +4 --> same as above
17678 +2w --> two weeks from today
17679 ++5 --> five days from default date
17681 The function understands only English month and weekday abbreviations,
17682 but this can be configured with the variables `parse-time-months' and
17683 `parse-time-weekdays'.
17685 While prompting, a calendar is popped up - you can also select the
17686 date with the mouse (button 1). The calendar shows a period of three
17687 months. To scroll it to other months, use the keys `>' and `<'.
17688 If you don't like the calendar, turn it off with
17689 \(setq org-read-date-popup-calendar nil)
17691 With optional argument TO-TIME, the date will immediately be converted
17692 to an internal time.
17693 With an optional argument WITH-TIME, the prompt will suggest to also
17694 insert a time. Note that when WITH-TIME is not set, you can still
17695 enter a time, and this function will inform the calling routine about
17696 this change. The calling routine may then choose to change the format
17697 used to insert the time stamp into the buffer to include the time.
17698 With optional argument FROM-STRING, read from this string instead from
17699 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17700 the time/date that is used for everything that is not specified by the
17701 user."
17702 (require 'parse-time)
17703 (let* ((org-time-stamp-rounding-minutes
17704 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17705 (org-dcst org-display-custom-times)
17706 (ct (org-current-time))
17707 (def (or default-time ct))
17708 (defdecode (decode-time def))
17709 (dummy (progn
17710 (when (< (nth 2 defdecode) org-extend-today-until)
17711 (setcar (nthcdr 2 defdecode) -1)
17712 (setcar (nthcdr 1 defdecode) 59)
17713 (setq def (apply 'encode-time defdecode)
17714 defdecode (decode-time def)))))
17715 (calendar-move-hook nil)
17716 (view-diary-entries-initially nil)
17717 (view-calendar-holidays-initially nil)
17718 (timestr (format-time-string
17719 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17720 (prompt (concat (if prompt (concat prompt " ") "")
17721 (format "Date+time [%s]: " timestr)))
17722 ans (org-ans0 "") org-ans1 org-ans2 final)
17724 (cond
17725 (from-string (setq ans from-string))
17726 (org-read-date-popup-calendar
17727 (save-excursion
17728 (save-window-excursion
17729 (calendar)
17730 (calendar-forward-day (- (time-to-days def)
17731 (calendar-absolute-from-gregorian
17732 (calendar-current-date))))
17733 (org-eval-in-calendar nil t)
17734 (let* ((old-map (current-local-map))
17735 (map (copy-keymap calendar-mode-map))
17736 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17737 (org-defkey map (kbd "RET") 'org-calendar-select)
17738 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17739 'org-calendar-select-mouse)
17777 ;; org-ans0: from prompt
17778 ;; org-ans1: from mouse click
17779 ;; org-ans2: from calendar motion
17807 "Display the currrent date prompt interpretation in the minibuffer."
17823 org-time-stamp-custom-formats
17824 org-time-stamp-formats))
17833 org-end-time-was-given
17840 "Analyze the combined answer of the date prompt."
17841 ;; FIXME: cleanup and comment
17843 hour minute second wday pm h2 m2 tl wday1)
17851 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17861 t nil ans)))
17862 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17863 ;; If there is a time with am/pm, and *no* time without it, we convert
17864 ;; so that matching will be successful.
17878 t t ans))))
17880 ;; Check if a time range is given as a duration
17881 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17889 ;; Check if there is a time range
17923 ;; Weekday was given, but no day, so pick that day in the week
17924 ;; on or after the derived date.
17938 "Check string S for special relative date string.
17939 TODAY and DEFAULT are internal times, for today and for a default.
17940 Return shift list (N what def-flag)
17942 N is the number of WHATs to shift.
17943 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17944 the DEFAULT date rather than TODAY."
17953 ?+))
17960 delta)
17970 "Eval FORM in the calendar window and return to current window.
17971 Also, store the cursor date in variable org-ans2."
17982 ; ;; Update the prompt to show new default date
17983 ; (save-excursion
17984 ; (goto-char (point-min))
17985 ; (when (and org-ans2
17986 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17987 ; (get-text-property (match-end 0) 'field))
17988 ; (let ((inhibit-read-only t))
17989 ; (replace-match (concat "[" org-ans2 "]") t t)
17990 ; (add-text-properties (point-min) (1+ (match-end 0))
17991 ; (text-properties-at (1+ (point-min)))))))))
17994 "Return to `org-read-date' with the date currently selected.
17995 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18004 "Insert a date stamp for the date given by the internal TIME.
18005 WITH-HM means, use the stamp format that includes the time of the day.
18006 INACTIVE means use square brackets instead of angular ones, so that the
18007 stamp will not contribute to the agenda.
18008 PRE and POST are optional strings to be inserted before and after the
18009 stamp.
18010 The command returns the inserted time stamp."
18012 stamp)
18029 stamp))
18032 "Toggle the use of custom time stamp formats."
18053 "Overlay modified time stamp format over timestamp between BED and END."
18080 "Translate all timestamps in STRING to custom format.
18081 But do this only if the variable `org-display-custom-times' is set."
18086 t1 with-hm inactive tf time str beg end)
18095 org-time-stamp-custom-formats)
18104 string)
18107 "Set 0 instead of nil for the first 6 elements of time.
18108 Don't touch the rest."
18113 "Difference between TIMESTAMP-STRING and now in days."
18118 "Is the time in TIMESTAMP-STRING close to the current date?"
18124 "Get the deadline lead time appropriate for timestring TS."
18127 ;; 0 or negative, enforce this value no matter what
18130 ;; lead time is specified.
18135 ;; go for the default.
18139 "Return to `org-read-date' with the date currently selected.
18140 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18150 "Check if there are any deadlines due or past due.
18151 A deadline is considered due if it happens within `org-deadline-warning-days'
18152 days from today's date. If the deadline appears in an entry marked DONE,
18153 it is not shown. The prefix arg NDAYS can be used to test that many
18168 org-warn-days)))
18171 "Check if there are deadlines or scheduled entries before DATE."
18185 "Evaluate a time range by computing the difference between start and end.
18186 Normally the result is just printed in the echo area, but with prefix arg
18187 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18188 If the time range is actually in a table, the result is inserted into the
18189 next column.
18190 For time difference computation, a year is assumed to be exactly 365
18191 days in order to avoid rounding problems."
18211 ;; (ys (floor (* 365 24 60 60)))
18219 y d h m align)
18222 y 0
18227 y 0
18265 "Convert a time stamp to an absolute day number.
18266 If there is a specifyer for a cyclic time stamp, get the closest date to
18267 DAYNR."
18271 daynr
18276 prefer))
18280 "Return the time corresponding to date D.
18281 D may be an absolute day number, or a calendar-type list (month day year)."
18286 "List of holidays, for Diary display in Org-mode."
18294 "Process a SEXP diary ENTRY for DATE."
18314 "Get iCalendar entries from diary entries in buffer FROMBUF.
18315 This uses the icalendar.el library."
18318 temporary-file-directory))
18321 buf rtn b e)
18337 rtn))
18340 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18341 When PREFER is `past' return a date that is either CURRENT or past.
18342 When PREFER is `future', return a date that is either CURRENT or future."
18343 ;; Make the proper lists from the dates
18346 dn dw sday cday n1 n2
18347 d m y y1 y2 date1 date2 nmonths nm ny m2)
18352 current
18376 ;; approx number of month between the tow dates
18378 ;; How often does dn fit in there?
18407 "Turn any specification of DATE into a gregorian date for the calendar."
18417 "Parse the standard Org-mode time string.
18418 This should be a lot faster than the normal `parse-time-string'.
18419 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18420 hour and minute fields will be nil if not given."
18430 nil nil nil)
18434 "Increase the date item at the cursor by one.
18435 If the cursor is on the year, change the year. If it is on the month or
18436 the day, change that.
18437 With prefix ARG, change by that many units."
18442 "Decrease the date item at the cursor by one.
18443 If the cursor is on the year, change the year. If it is on the month or
18444 the day, change that.
18445 With prefix ARG, change by that many units."
18450 "Increase the date in the time stamp by one day.
18451 With prefix ARG, change that many days."
18459 "Decrease the date in the time stamp by one day.
18460 With prefix ARG, change that many days."
18473 "Determine if the cursor is in or at a timestamp."
18499 ans))
18502 ""
18514 "Change the date in the time stamp at point.
18515 The date will be changed by N times WHAT. WHAT can be `day', `month',
18516 `year', `minute', `second'. If WHAT is not given, the cursor position
18517 in the timestamp determines what will be changed."
18519 with-hm inactive
18520 org-ts-what
18521 extra
18522 ts time time0)
18528 org-display-custom-times
18538 ts)
18566 ;; Try to recenter the calendar window, if any
18572 ;; FIXME: does not yet work for lead times
18574 "Change the different parts of the lead-time and repeat fields in timestamp."
18576 ng h m new)
18577 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18598 new
18600 s))
18603 "If the calendar is visible, recenter it to DATE."
18614 "Go to the Emacs calendar at the current date.
18615 If there is a time stamp in the current line, go to that date.
18616 A prefix ARG can be used to force the current date."
18635 "Return a list (month day year) of date at point in calendar."
18641 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18642 If there is already a time stamp at the cursor position, update it."
18652 ;;;###autoload
18654 "Activate appointments found in `org-agenda-files'.
18656 appointements.
18658 If FILTER is t, interactively prompt the user for a regular
18659 expression, and filter out entries that don't match it.
18661 If FILTER is a string, use this string as a regular expression
18662 for filtering entries out.
18664 FILTER can also be an alist with the car of each cell being
18665 either 'headline or 'category. For example:
18670 will only add headlines containing IMPORTANT or headlines
18683 ;; Get all entries which may contain an appt
18690 ;; Map thru entries and find if we should filter them out
18703 ;; FIXME: Shall we remove text-properties for the appt text?
18704 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18718 ;;; The clock for measuring work time.
18743 "Start the clock on the current item.
18744 If necessary, clock-out of the currently active clock."
18752 org-clock-in-switch-to-state
18779 "Find the location where the next clock line should be inserted."
18785 first last)
18789 ;; we seem to have a CLOCK drawer, so go there.
18792 ;; Lets count the CLOCK lines
18800 ;; Wrap current entries into a new drawer
18818 ;; Planning info, skip to after it
18830 "Stop the currently running clock.
18831 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18868 "Cancel the running clock be removing the start timestamp."
18882 "Go to the currently clocked-in entry."
18899 "Sum the times for each subtree.
18900 Puts the resulting times in minutes as a text property on each headline."
18904 org-clock-string
18910 ts te dt
18911 time)
18918 ;; Two time stamps
18930 ;; A naket time
18947 "Show subtree times in the entire buffer.
18948 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18949 in the echo area."
18966 ;; Arrange to remove the overlays upon next change.
18976 "Put an overlays on the current line, displaying TIME.
18977 If LEVEL is given, prefix time with a corresponding number of stars.
18978 This creates a new overlay and stores it in `org-clock-overlays', so that it
18979 will be easy to remove."
18983 ov tx)
19002 "Remove the occur highlights from the buffer.
19003 BEG and END are ignored. If NOREMOVE is nil, remove this function
19004 from the `before-change-functions' in the current buffer."
19014 "Clock out if the current entry contains the running clock.
19015 This is used to stop the clock after a TODO entry is marked DONE,
19016 and is only done if the variable `org-clock-out-when-done' is not nil."
19022 org-clock-marker))
19023 ;; Clock out, but don't accept a logging message for this.
19031 "Check if the current buffer contains the running clock.
19032 If yes, offer to stop it and to save the buffer with the changes."
19041 "Create a table containing a report about clocked time.
19042 If the cursor is inside an existing clocktable block, then the table
19043 will be updated. If not, a new clocktable will be inserted.
19044 When called with a prefix argument, move to the first clock table in the
19045 buffer and update it."
19058 "Check if the cursor is in a clocktable."
19066 start))))
19069 "If this is a CLOCK line, update it and return t.
19070 Otherwise, return nil."
19079 ts te h m s)
19081 nil
19095 t)))))
19098 "Return two times bordering a special time range.
19099 Key is a symbol specifying the range and can be one of `today', `yesterday',
19100 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
19101 A week starts Monday 0:00 and ends Sunday 24:00.
19102 The range is determined relative to TIME. TIME defaults to the current time.
19103 The return value is a cons cell with two internal times like the ones
19104 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
19105 the returned times will be formatted strings."
19110 s1 m1 h1 d1 month1 y1 diff ts te fm)
19140 "Write the standard clocktable."
19155 ipos time h m p level hlc hdl
19156 cc beg end pos tbl)
19170 ;; Get the right scope
19193 file)
19203 org-clock-file-total-minutes)))))))
19214 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19235 "Clock summary at ["
19239 "]."
19252 "|"
19253 "*Total time*| "
19275 cc)
19309 x))
19310 lines)
19313 ;; FIXME: I don't think anybody uses this, ask David
19315 "Return an internal list with clocking information.
19316 This list has one entry for each CLOCK interval.
19317 FIXME: describe the elements."
19321 rtn beg end next cont level title total closedp leafp
19322 clockpos titlepos h m donep)
19347 total title titlepos level leafp)
19348 rtn)
19352 ;;;; Agenda, and Diary Integration
19354 ;;; Define the Org-agenda-mode
19369 "Mode for time-sorted view on action items in Org-mode files.
19371 The following commands are available:
19377 org-agenda-pending-undo-list nil)
19379 ;; Keep global-font-lock-mode from turning on font-lock-mode
19387 ;; Make sure properties are removed when copying text
19392 buffer-substring-filters)))
19395 org-agenda-show-log nil))
19402 "Restricted to single file"
19414 org-agenda-mode-map global-map)
19517 "--"
19524 "--"
19528 "--"
19533 "--"
19538 "--"
19543 "--"
19560 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19564 "--"
19566 "--"
19576 "--"
19578 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19582 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19586 "--"
19588 "--"
19591 ))
19593 ;;; Agenda undo
19605 "Execute BODY if there is no `org-protected' text property at point."
19611 "Execute BODY while recording undo information in two buffers."
19619 _c1 _c2)
19620 ,@_body
19627 ;; make sure there are undo boundaries
19630 ;; remember which buffer to undo
19632 org-agenda-undo-list)))))
19635 "Undo a remote editing step in the agenda.
19636 This undoes changes both in the agenda buffer and in the remote buffer
19637 that have been changed along."
19643 org-agenda-pending-undo-list org-agenda-undo-list))
19647 buf line cmd rembuf)
19669 "Verify that a real change occurred between the undo lists L1 and L2."
19674 ;;; Agenda dispatch
19682 ;;;###autoload
19684 "Dispatch agenda commands to collect entries to the agenda buffer.
19685 Prompts for a command to execute. Any prefix arg will be passed
19686 on to the selected command. The default selections are:
19688 a Call `org-agenda-list' to display the agenda for current day or week.
19689 t Call `org-todo-list' to display the global todo list.
19690 T Call `org-todo-list' to display the global todo list, select only
19691 entries with a specific TODO keyword (the user gets a prompt).
19692 m Call `org-tags-view' to display headlines with tags matching
19693 a condition (the user is prompted for the condition).
19694 M Like `m', but select only TODO entries, no ordinary headlines.
19695 L Create a timeline for the current buffer.
19696 e Export views to associated files.
19698 More commands can be added by configuring the variable
19699 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19700 searches can be pre-defined in this way.
19702 If the current buffer is in Org-mode and visiting a file, you can also
19703 first press `<' once to indicate that the agenda should be temporarily
19705 Pressing `<' twice means to restrict to the current subtree or region
19706 \(if active)."
19712 ;; normalize different versions
19718 nil)
19722 org-agenda-custom-commands)))
19725 entry key type match lprops ans)
19726 ;; Turn off restriction unless there is an overriding one
19732 ;; Delete old local properties
19734 ;; Remember where this call originated
19740 ;; Estabish the restriction, if any
19757 ;; For example the todo list should not need it (but does...)
19773 current-prefix-arg)))
19826 cmds)))
19829 "The user interface for selecting an agenda command."
19836 restriction second-time
19837 c entry key type match prefixes rmheader header-end custom1 desc)
19844 "
19845 Press key for an agenda command: < Buffer,subtree/region restriction
19846 -------------------------------- > Remove restriction
19847 a Agenda for current week or day e Export agenda views
19848 t List of all TODO entries T Entries with special TODO kwd
19849 m Match a TAGS query M Like m, but only TODO entries
19850 L Timeline for current buffer # List stuck projects (!=configure)
19851 s Search for keywords C Configure custom agenda commands
19852 / Multi-occur
19857 header start)
19861 header)))
19914 prefix-descriptions))
19916 prefixes))
19927 " (restriction lock active)"
19940 prefixes nil
19946 nil
19948 custom))))
19965 nil)
19985 match ;; The byte compiler incorrectly complains about this. Keep it!
19986 cmd type lprops)
20020 ;;;###autoload
20022 "Run an agenda command in batch mode and send the result to STDOUT.
20023 If CMD-KEY is a string of length 1, it is used as a key in
20024 `org-agenda-custom-commands' and triggers this command. If it is a
20025 longer string it is used as a tags/todo match string.
20026 Paramters are alternating variable names and values that will be bound
20027 before running the agenda command."
20041 string))
20045 ;;;###autoload
20047 "Run an agenda command in batch mode and send the result to STDOUT.
20048 If CMD-KEY is a string of length 1, it is used as a key in
20049 `org-agenda-custom-commands' and triggers this command. If it is a
20050 longer string it is used as a tags/todo match string.
20051 Paramters are alternating variable names and values that will be bound
20052 before running the agenda command.
20054 The output gives a line for each selected agenda item. Each
20055 item is a list of comma-separated values, like this:
20057 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
20059 category The category of the item
20060 head The headline, without TODO kwd, TAGS and PRIORITY
20061 type The type of the agenda entry, can be
20062 todo selected in TODO match
20063 tagsmatch selected in tags match
20064 diary imported from diary
20065 deadline a deadline on given date
20066 scheduled scheduled on given date
20067 timestamp entry has timestamp on given date
20068 closed entry was closed on given date
20069 upcoming-deadline warning about deadline
20070 past-scheduled forwarded scheduled item
20071 block entry has date block including g. date
20072 todo The todo keyword, if any
20073 tags All tags including inherited ones, separated by colons
20074 date The relevant date, like 2007-2-14
20075 time The time, like 15:00-16:50
20076 extra Sting with extra planning info
20077 priority-l The priority letter if any was given
20078 priority-n The computed numerical priority
20079 agenda-day The day in the agenda where this is listed"
20091 line)
20101 priority-letter priority agenda-day)
20106 "Make sure all properties on an agenda item have a canonical form,
20107 so the export commands can easily use it."
20134 props)
20148 ;;;###autoload
20153 ;; FIXME, why is this a macro?????
20154 ;;;###autoload
20156 "Run all custom agenda commands that have a file argument."
20160 pars cmd thiscmdkey files opts)
20183 "Write the current buffer (an agenda view) as a file.
20184 Depending on the extension of the file name, plain text (.txt),
20185 HTML (.html or .htm) or Postscript (.ps) is produced.
20186 If NOSETTINGS is given, do not scope the settings of
20187 `org-agenda-exporter-settings' into the export commands. This is used when
20188 the settings have already been scoped and we do not wish to overrule other,
20189 higher priority settings."
20205 ;; replace <style> section with org-agenda-export-html-style
20226 "Inhibit read-only for BODY."
20230 "Make sure current buffer is in org-mode. Error if not."
20233 major-mode)))
20236 "Fit the window to the buffer size."
20240 nil
20244 ;;; Agenda file list
20247 "Get the list of agenda files.
20248 Optional UNRESTRICTED means return the full list even if a restriction
20249 is currently in place."
20260 org-agenda-file-regexp)
20262 files)))
20268 files))
20272 "Edit the list of agenda files.
20273 Depending on setup, this either uses customize to edit the variable
20274 `org-agenda-files', or it visits the file that is holding the list. In the
20275 latter case, the buffer is set up in a way that saving it automatically kills
20276 the buffer and restores the previous window configuration."
20295 "Set new value for the agenda file list and save it correcly."
20306 "Read the list of agenda files from a file."
20313 ;;;###autoload
20315 "Cycle through the files in `org-agenda-files'.
20316 If the current buffer visits an agenda file, find the next one in the list.
20317 If the current buffer does not, find the first agenda file."
20322 file)
20334 "Move/add the current file to the top of the agenda file list.
20335 If the file is not present in the list, it is added to the front. If it is
20336 present, it is moved there. With optional argument TO-END, add/move to the
20337 end of the list."
20344 x had)
20357 "Remove current file from the list of files in variable `org-agenda-files'.
20358 These are the files which are being checked for agenda entries.
20359 Optional argument FILE means, use this file instead of the current."
20369 nil x))
20382 "Make sure FILE exists. If not, ask user what to do."
20393 ;;; Agenda prepare and finalize
20438 "Finishing touch for the agenda buffer, called just before displaying it."
20450 org-overriding-columns-format)
20452 org-overriding-columns-format))
20454 org-agenda-view-columns-initially)
20460 )))
20463 "Make highest priority lines bold, and lowest italic."
20470 b e p ov h l)
20474 org-highest-priority)
20476 org-lowest-priority)
20481 ov 'face
20489 "Create buffers for all agenda files, protect archived trees and comments."
20496 bmp file re)
20526 "Function to be called at each match during agenda construction.
20527 If this function returns nil, the current match should not be skipped.
20528 Otherwise, the function must return a position from where the search
20529 should be continued.
20530 This may also be a Lisp form, it will be evaluated.
20531 Never set this variable using `setq' or so, because then it will apply
20532 to all future agenda commands. Instead, bind it with `let' to scope
20533 it dynamically into the agenda-constructing command. A good way to set
20537 "Throw to `:skip' in places that should be skipped.
20538 Also moves point to the end of the skipped region, so that search can
20539 continue from there."
20565 "Return a new agenda marker.
20566 Org-mode keeps a list of these markers and resets them when they are
20567 no longer in use."
20571 m))
20574 "Reset markers created by `org-agenda'."
20579 "Get a buffer visiting FILE. If the buffer needs to be created, add
20580 it to the list of buffers which might be released later."
20583 buf ; just return it
20584 ;; Make a new buffer and remember it
20587 buf)))
20590 "Release all buffers in list, asking the user for confirmation when needed.
20591 When a buffer is unmodified, it is just killed. When modified, it is saved
20592 \(if the user agrees) and then killed."
20597 file
20603 "Get the category applying to position POS."
20606 ;;; Agenda timeline
20611 "Show a time-sorted view of the entries in the current org file.
20612 Only entries with a time stamp of today or later will be listed. With
20614 under the current date.
20615 If the buffer contains an active region, only check the region for
20616 dates."
20629 t doclosed ; always include today
20630 org-timeline-show-empty-dates))
20635 args
20636 s e rtn d emptyp)
20642 ;; Remove past dates from the list of dates.
20645 day-numbers))))
20662 dopast
20663 past)
20671 date args)))
20694 "Return a list of all relevant day numbers from BEG to END buffer positions.
20695 If NO-RANGES is non-nil, include only the start and end dates of a range,
20696 not every single day in the range. If FORCE-TODAY is non-nil, make
20697 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20698 inactive time stamps (those in square brackets) are included.
20699 When EMPTY is non-nil, also include days without any entries."
20703 dates dates1 date day day1 day2 ts1 ts2)
20733 dates)))
20735 ;;; Agenda Daily/Weekly
20746 ;;;###autoload
20748 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20749 The view will be for the current day or week, but from the overview buffer
20750 you will be able to go to other days/weeks.
20753 all unfinished TODO items will also be shown, before the agenda.
20754 This feature is considered obsolete, please use the TODO list or a block
20755 agenda instead.
20757 With a numeric prefix argument in an interactive call, the agenda will
20758 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20759 the number of days. NDAYS defaults to `org-agenda-ndays'.
20761 START-DAY defaults to TODAY, or to the most recent match for the weekday
20762 given in `org-agenda-start-on-weekday'."
20773 ;; Convert to an absolute day number
20781 org-agenda-start-on-weekday nil))
20790 sd
20799 s e rtn rtnall file date d start-pos end-pos todayp nd)
20802 ;; Make the list of days
20804 nd ndays)
20817 rtnall nil)
20845 rtnall nil)
20851 file date
20854 file date
20878 rtnall nd todayp))
20901 ;;; Agenda word search
20905 ;;;###autoload
20907 "Show all entries that contain words or regular expressions.
20908 If the first character of the search string is an asterisks,
20909 search only the headlines.
20912 The individual words are then interpreted as a boolean expression with
20913 logical AND. Words prefixed with a minus must not occur in the entry.
20914 Words without a prefix or prefixed with a plus must occur in the entry.
20915 Matching is case-insensitive and the words are enclosed by word delimiters.
20917 Words enclosed by curly braces are interpreted as regular expressions
20918 that must or must not match in the entry.
20920 This command searches the agenda files, and in addition the files listed
20921 in `org-agenda-text-search-extra-files'."
20928 'org-not-done-regexp org-not-done-regexp
20929 'org-todo-regexp org-todo-regexp
20931 'keymap org-agenda-keymap
20933 regexp rtn rtnall files file pos
20934 marker priority category tags c neg re
20964 words)
20970 regexp))))
20972 rtnall nil)
20981 ;; If file does not exist, make sure an error message is sent
20983 file))))
20992 org-agenda-restrict-end)
21014 regexps-)
21018 regexps+)
21024 ""
21027 category tags))
21058 ;;; Agenda TODO list
21063 ;;;###autoload
21065 "Show all TODO entries from all agenda file in a single list.
21066 The prefix arg can be used to select a specific TODO keyword and limit
21068 for a keyword. A numeric prefix directly selects the Nth keyword in
21069 `org-todo-keywords-1'."
21083 rtn rtnall files file pos)
21093 rtnall nil)
21117 kwds))
21128 ;;; Agenda tags match
21130 ;;;###autoload
21132 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
21133 The prefix arg TODO-ONLY limits the search to TODO entries."
21140 rtn rtnall files file pos matcher
21141 buffer)
21149 rtnall nil)
21157 ;; If file does not exist, merror message to agenda
21168 org-agenda-restrict-end)
21193 ;;; Agenda Finding stuck projects
21196 "Regular expression used in skipping subtrees for the agenda.
21197 This is basically a temporary global variable that can be set and then
21204 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
21205 If yes, it returns the end position of this tree, causing agenda commands
21206 to skip this subtree. This is a function that can be put into
21207 `org-agenda-skip-function' for the duration of a command."
21209 skip)
21215 "Skip entry if any of CONDITIONS is true.
21216 See `org-agenda-skip-if' for details."
21220 "Skip entry if any of CONDITIONS is true.
21221 See `org-agenda-skip-if' for details."
21225 "Checks current entity for CONDITIONS.
21226 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
21227 the entry, i.e. the text before the next heading is checked.
21229 CONDITIONS is a list of symbols, boolean OR is used to combine the results
21230 from different tests. Valid conditions are:
21232 scheduled Check if there is a scheduled cookie
21233 notscheduled Check if there is no scheduled cookie
21234 deadline Check if there is a deadline
21235 notdeadline Check if there is no deadline
21236 regexp Check if regexp matches
21237 notregexp Check if regexp does not match.
21239 The regexp is taken from the conditions list, it must come right after
21240 the `regexp' or `notregexp' element.
21242 If any of these conditions is met, this function returns the end point of
21243 the entity, causing the search to continue from there. This is a function
21244 that can be put into `org-agenda-skip-function' for the duration of a command."
21268 end)))
21270 ;;;###autoload
21272 "Create agenda view for projects that are stuck.
21273 Stuck projects are project that have no next actions. For the definitions
21274 of what a project is and how to check if it stuck, customize the variable
21275 `org-stuck-projects'.
21276 MATCH is being ignored."
21279 ;; FIXME: we could have used org-agenda-skip-if here.
21287 org-done-keywords-for-agenda
21289 todo))
21306 gen-re)))))
21317 ;;; Diary integration
21322 "Get the (Emacs Calendar) diary entries for DATE."
21330 entries
21342 ;; No entries
21344 ;; Omit the date and other unnecessary stuff
21346 ;; Add prefix to each line and extend the text properties
21358 ;; Extend the text properties to the beginning of the line
21361 entries)))))
21364 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21365 This gets rid of the date, the underline under the date, and
21366 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21367 date. It also removes lines that contain only whitespace."
21384 ;; Make sure entries from the diary have the right text properties.
21387 ;; We can rely on the hook, nothing to do
21388 nil
21389 ;; Hook not avaiable, must use advice to make this work
21391 "Make the position visible."
21394 buffer-file-name)
21398 "Add text properties to string, allowing org-mode to act on it."
21401 'keymap org-agenda-keymap
21406 'org-agenda-diary-link t
21410 "Add a dummy entry to the diary.
21411 Needed to avoid empty dates which mess up holiday display."
21412 ;; Catch the error if dealing with the new add-to-diary-alist
21419 ;;;###autoload
21421 "Return diary information from org-files.
21423 It accesses org files and extracts information from those files to be
21424 listed in the diary. The function accepts arguments specifying what
21425 items should be listed. The following arguments are allowed:
21427 :timestamp List the headlines of items containing a date stamp or
21428 date range matching the selected date. Deadlines will
21429 also be listed, on the expiration day.
21431 :sexp List entries resulting from diary-like sexps.
21433 :deadline List any deadlines past due, or due within
21434 `org-deadline-warning-days'. The listing occurs only
21435 in the diary for *today*, not at any other date. If
21436 an entry is marked DONE, it is no longer listed.
21438 :scheduled List all items which are scheduled for the given date.
21439 The diary for *today* also contains items which were
21440 scheduled earlier and are not yet marked DONE.
21442 :todo List all TODO items from the org-file. This may be a
21443 long list - so this is not turned on by default.
21444 Like deadlines, these entries only show up in the
21445 diary for *today*, not at any other date.
21447 The call in the diary file should look like this:
21449 &%%(org-diary) ~/path/to/some/orgfile.org
21451 Use a separate line for each org file to check. Or, if you omit the file name,
21452 all files listed in `org-agenda-files' will be checked automatically:
21454 &%%(org-diary)
21456 If you don't give any arguments (as in the example above), the default
21457 arguments (:deadline :scheduled :timestamp :sexp) are used.
21458 So the example above may also be written as
21460 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21462 The function expects the lisp variables `entry' and `date' to be provided
21463 by the caller, because this is how the calendar works. Don't use this
21464 function from a program - use `org-agenda-get-day-entries' instead."
21466 org-agenda-last-marker-time)
21475 file rtn results)
21477 ;; If this is called during org-agenda, don't return any entries to
21478 ;; the calendar. Org Agenda will list these entries itself.
21486 ;;; Agenda entry finders
21489 "Does the work for `org-diary' and `org-agenda'.
21490 FILE is the path to a file to be checked for entries. DATE is date like
21491 the one returned by `calendar-current-date'. ARGS are symbols indicating
21492 which kind of entries should be extracted. For details about these, see
21493 the documentation of `org-diary'."
21500 arg results rtn)
21502 ;; If file does not exist, make sure an error message ends up in diary
21512 org-agenda-restrict-end)
21514 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21538 results))))
21554 "Is the cursor inside a date range?"
21569 nil)))
21572 "Return the TODO information for agenda display."
21575 'org-not-done-regexp org-not-done-regexp
21576 'org-todo-regexp org-todo-regexp
21578 'keymap org-agenda-keymap
21579 'help-echo
21582 ;; FIXME: get rid of the \n at some point but watch out
21586 org-todo-regexp
21590 org-not-done-regexp)
21592 marker priority category tags
21593 ee txt beg end)
21632 "Return the date stamp information for agenda display."
21634 'org-not-done-regexp org-not-done-regexp
21635 'org-todo-regexp org-todo-regexp
21637 'keymap org-agenda-keymap
21638 'help-echo
21646 "<%Y-%m-%d"
21660 marker hdmarker deadlinep scheduledp donep tmp priority category
21661 ee txt timestr tags b0 b3 e3 head)
21679 b0)
21686 ;; substring should only run to end of time stamp
21698 nil head category tags timestr nil
21699 remove-re)))
21712 "Return the sexp information for agenda display."
21716 'keymap org-agenda-keymap
21717 'help-echo
21721 marker category ee txt tags entry result beg b sexp sexp-entry)
21753 "Return the logged TODO entries for agenda display."
21755 'org-not-done-regexp org-not-done-regexp
21756 'org-todo-regexp org-todo-regexp
21757 'keymap org-agenda-keymap
21758 'help-echo
21770 marker hdmarker priority category tags closedp
21771 ee txt timestr)
21780 ;; donep (org-entry-is-done-p)
21781 )
21783 ;; substring should only run to end of time stamp
21807 "Return the deadline information for agenda display."
21809 'org-not-done-regexp org-not-done-regexp
21810 'org-todo-regexp org-todo-regexp
21811 'keymap org-agenda-keymap
21812 'help-echo
21818 d2 diff dfrac wdays pos pos1 category tags
21819 ee txt head face s upcomingp donep timestr)
21831 ;; When to show a deadline in the calendar:
21832 ;; If the expiration is within wdays warning time.
21833 ;; Past-due deadlines are only shown on the current date
21861 diff))
21862 head category tags timestr))))
21871 'org-category category
21880 "Return the face to displaying a deadline item.
21881 FRACTION is what fraction of the head-warning time has passed."
21889 "Return the scheduled information for agenda display."
21891 'org-todo-regexp org-todo-regexp
21894 'keymap org-agenda-keymap
21895 'help-echo
21901 d2 diff pos pos1 category tags
21902 ee txt head pastschedp donep face timestr s)
21910 ;;; is this right?
21911 ;;; do we need to do this for deadleine too????
21912 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21915 ;; When to show a scheduled item in the calendar:
21916 ;; If it is on or past the date.
21944 head category tags timestr))))
21948 'org-scheduled-previously
21951 'undone-face face
21963 "Return the date-range information for agenda display."
21965 'org-not-done-regexp org-not-done-regexp
21966 'org-todo-regexp org-todo-regexp
21968 'keymap org-agenda-keymap
21969 'help-echo
21974 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21975 donep head)
21987 ;; Only allow days between the limits, because the normal
21988 ;; date stamps will catch the limits.
22005 head category tags
22014 ;; Sort the entries by expiration date.
22017 ;;; Agenda presentation and sorting
22027 "Regular expression to match a plain time or time range.
22028 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22029 groups carry important information:
22030 0 the full match
22031 1 the first time, range or not
22039 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
22040 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22041 groups carry important information:
22042 0 the full match
22043 7 hours of duration
22052 "Regular expression to match a timestamp time or time range.
22053 After a match, the following groups carry important information:
22054 0 the full match
22055 1 date plus weekday, for backreferencing to make sure both times on same day
22056 2 the first time, range or not
22060 "A flag, set by `org-compile-prefix-format'.
22063 "A flag, set by `org-compile-prefix-format'.
22067 noprefix remove-re)
22068 "Format TXT to be inserted into the agenda buffer.
22069 In particular, it adds the prefix and corresponding text properties. EXTRA
22070 must be a string and replaces the `%s' specifier in the prefix format.
22071 CATEGORY (string, symbol or nil) may be used to overrule the default
22072 category taken from local variable or file name. It will replace the `%c'
22073 specifier in the format. DOTIME, when non-nil, indicates that a
22074 time-of-day should be extracted from TXT for sorting of this entry, and for
22075 the `%t' specifier in the format. When DOTIME is a string, this string is
22076 searched for a time before TXT is. NOPREFIX is a flag and indicates that
22077 only the correctly processes TXT should be returned - this is used by
22078 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
22079 Any match of REMOVE-RE will be removed from TXT."
22081 ;; Diary entries sometimes have extra whitespace at the beginning
22084 org-category
22090 time ; time and tag are needed for the eval of the prefix format
22093 stamp plain s0 s1 s2 rtn srp)
22095 ;; Extract starting and ending time and move them to prefix
22103 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
22104 ;; them, we might want to remove them there to avoid duplication.
22105 ;; The user can turn this off with a variable.
22111 t))
22113 ;; Normalize the time(s) to 24 hour
22121 org-agenda-default-appointment-duration))
22122 h)
22127 txt)
22128 ;; Tags are in the string
22131 org-prefix-has-tag))
22136 t t txt))))
22142 ;; Create the final string
22145 ;; Prepare the variables needed in the eval of the compiled format
22151 ;; Evaluate the compiled format
22154 ;; And finally add the text properties
22157 'org-highest-priority org-highest-priority
22158 'org-lowest-priority org-lowest-priority
22160 'time-of-day time-of-day
22161 'txt txt
22162 'time time
22163 'extra extra
22178 list)))
22183 new time)
22185 ;; don't show empty grid
22191 nil string "" nil
22193 new)
22201 "Compile the prefix format into a Lisp form that can be evaluated.
22202 The resulting form is returned and stored in the variable
22203 `org-prefix-format-compiled'."
22207 org-agenda-prefix-format)
22212 varform vars var e c f opt)
22214 s start)
22227 ""
22237 ;; the old format
22245 "Check string S for a time of day.
22246 If found, return it as a military time number between 0 and 2400.
22247 If not found, return nil.
22248 The optional STRING argument forces conversion into a 5 character wide string
22249 HH:MM."
22271 "Sort and concatenate the agenda items."
22274 list
22299 x)
22303 " "
22305 x)))
22308 "Compare the priorities of string A and B."
22316 "Compare the string values of categories of strings A and B."
22324 "Compare the string values of categories of strings A and B."
22334 "Compare the time-of-day values of strings A and B."
22343 "Predicate for sorting agenda entries."
22344 ;; The following variables will be used when the form is evaluated.
22345 ;; So even though the compiler complains, keep them.
22359 ;;; Agenda restriction lock
22377 "Set restriction lock for agenda, to current subtree or file.
22378 Restriction will be the file if TYPE is `file', or if type is the
22379 universal prefix '(4), or if the cursor is before the first headline
22380 in the file. Otherwise, restriction will be to the current subtree."
22412 "Remove the agenda restriction lock."
22426 "If there is any window showing the agenda view, update it."
22435 org-agenda-overriding-restriction)
22438 ;;; Agenda commands
22441 "Check if agenda buffer is of allowed type.
22442 If ERROR is non-nil, throw an error, otherwise just return nil."
22444 t
22447 nil)))
22450 "Exit agenda by removing the window or the buffer."
22457 ;; Maybe restore the pre-agenda window configuration.
22460 org-pre-agenda-window-conf
22464 "Exit agenda by removing the window or the buffer.
22465 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22466 Org-mode buffers visited directly by the user will not be touched."
22480 "Save all Org-mode buffers without user confirmation."
22487 "Rebuild Agenda.
22488 When this is the global TODO list, a prefix argument will be interpreted."
22497 org-agenda-pending-undo-list nil)
22503 "Manipulate the query by adding a search term with positive selection.
22504 Positive selection means, the term must be matched for selection of an entry."
22508 "Manipulate the query by adding a search term with negative selection.
22509 Negative selection means, term must not be matched for selection of an entry."
22513 "Manipulate the query by adding a search regexp with positive selection.
22514 Positive selection means, the regexp must match for selection of an entry."
22518 "Manipulate the query by adding a search regexp with negative selection.
22519 Negative selection means, regexp must not match for selection of an entry."
22526 'org-agenda-query-string
22533 org-agenda-query-string))
22537 org-agenda-type))))
22543 "Jump to DATE in agenda."
22548 "Go to today."
22574 "Go forward in time by thee current span.
22575 With prefix ARG, go forward that many times the current span."
22582 greg2 nd)
22604 "Go backward in time by the current span.
22605 With prefix ARG, go backward that many times the current span."
22610 "Switch to daily view for agenda."
22615 "Switch to daily view for agenda."
22620 "Switch to daily view for agenda."
22624 "Switch to daily view for agenda."
22631 "Change the agenda view to SPAN.
22632 SPAN may be `day', `week', `month', `year'."
22637 org-starting-day))
22648 "Compute starting date and number of days for agenda.
22649 SPAN may be `day', `week', `month', `year'. The return value
22650 is a cons cell with the starting date and the number of days,
22651 so that the date SD will be in that range."
22653 nd)
22670 sd)))
22676 sd))))
22679 ;; FIXME: does not work if user makes date format that starts with a blank
22681 "Jump to the next line indicating a date in agenda buffer."
22693 "Jump to the previous line indicating a date in agenda buffer."
22700 ;; Initialize the highlight
22705 "Highlight a region with overlay."
22710 "Detach overlay INDEX."
22713 ;; FIXME this is currently not used.
22722 "Toggle follow mode in an agenda buffer."
22730 "Toggle log mode in an agenda buffer."
22740 "Toggle diary inclusion in an agenda buffer."
22750 "Toggle time grid in an agenda buffer."
22760 "Set the mode name to indicate all the small mode settings."
22779 "Show the priority of the current item.
22780 This priority is composed of the main priority given with the [#A] cookies,
22781 and by additional input from the age of a schedules or deadline entry."
22787 "Show the tags applicable to the current item."
22796 "Go to the Org-mode file which contains the item at point."
22815 "Normal hook run after an item has been shown from the agenda.
22819 "Kill the entry or subtree belonging to the current agenda entry."
22852 "Kill the entry or subtree belonging to the current agenda entry."
22870 "Remove all lines in the agenda that correspond to a given subtree.
22871 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22872 If this information is not given, the function uses the tree at point."
22895 "Follow the link in the current line, if any."
22904 "Get a variable from a referenced buffer and install it here."
22911 "Go to the Org-mode file which contains the item at point."
22928 "Go to the Org-mode file which contains the item at the mouse click."
22934 "Display the Org-mode file which contains the item at point."
22941 "Display the Org-mode file which contains the item at point and recenter."
22949 "Display the Org-mode file which contains the item at the mouse click."
22955 "Check if the entry is a diary link and abort if yes."
22963 "Show the subtree corresponding to the current entry in an indirect buffer.
22964 This calls the command `org-tree-to-indirect-buffer' from the original
22965 Org-mode buffer.
22966 With numerical prefix arg ARG, go up to this level and then take that tree.
22967 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22968 dedicated frame)."
22981 "Marker pointing to the headline that last changed its TODO state
22985 "Switch TODO entry to next sequence."
22990 "Switch TODO entry to previous sequence."
22995 "Cycle TODO state of line at point, also in Org-mode file.
22996 This changes the line at point, all other lines in the agenda referring to
22997 the same tree node, and the headline of the tree node in the Org-mode file."
23007 newhead)
23028 "Change all lines in the agenda buffer which match HDMARKER.
23029 The new content of the line will be NEWHEAD (as modified by
23030 `org-format-agenda-item'). HDMARKER is checked with
23031 `equal' against all `org-hd-marker' text properties in the file.
23032 If FIXFACE is non-nil, the face of each item is modified acording to
23033 the new TODO state."
23035 props m pl undone-face done-face finish new dotime cat tags)
23065 undone-face done-face))))
23073 "Align all tags in agenda items to `org-agenda-tags-column'."
23086 org-agenda-tags-column))
23094 "Increase the priority of line at point, also in Org-mode file."
23099 "Decrease the priority of line at point, also in Org-mode file."
23104 "Set the priority of line at point, also in Org-mode file.
23105 This changes the line at point, all other lines in the agenda referring to
23106 the same tree node, and the headline of the tree node in the Org-mode file."
23115 newhead)
23131 "Get a list of all headline tags applicable at POS.
23132 POS defaults to point. If tags are inherited, the list contains
23133 the targets in the same sequence as the headlines appear, i.e.
23134 the tags of the current headline come last."
23149 tags)))
23153 tags)))
23155 ;; FIXME: should fix the tags property of the agenda line.
23157 "Set tags for the current headline."
23168 newhead)
23186 "Toggle the archive tag for the current entry."
23195 newhead)
23211 "Change the date of this item to one day later."
23230 "Change the date of this item to one day earlier."
23235 "Show new date stamp via text properties."
23236 ;; We use text properties to make this undoable
23245 ;; Use `duplicable' property to trigger undo recording
23260 "Change the date of this item. Date is prompted for, with default today.
23261 The prefix ARG is passed to the `org-time-stamp' command and can therefore
23262 be used to request time specification in the time stamp."
23280 "Schedule the item at point."
23289 ts)
23301 "Schedule the item at point."
23310 ts)
23320 "Return the heading of the current entry, without the stars."
23330 "Start the clock on the currently selected item."
23343 "Stop the currently running clock."
23351 "Cancel the currently running clock."
23359 "Make a diary entry, like the `i' command from the calendar.
23360 All the standard commands work: block, weekly etc."
23376 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23385 ;; We implement this by hacking the `calendar-cursor-to-date' function
23386 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23402 "Execute a calendar command from the agenda, with the date associated to
23403 the cursor position."
23412 ;; the following 3 vars are needed in the calendar
23426 "Display the phases of the moon for the 3 months around the cursor date."
23431 "Display the holidays for the 3 months around the cursor date."
23436 "Display sunrise and sunset for the cursor date.
23437 Latitude and longitude can be specified with the variables
23438 `calendar-latitude' and `calendar-longitude'. When called with prefix
23439 argument, latitude and longitude will be prompted for."
23448 "Open the Emacs calendar with the date at the cursor."
23461 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23462 This is a command that has to be installed in `calendar-mode-map'."
23466 nil))
23472 date s)
23498 ;;;; Embedded LaTeX
23513 "Toggle the minor `org-cdlatex-mode'.
23514 This mode supports entering LaTeX environment and math in LaTeX fragments
23515 in Org-mode.
23517 nil " OCDL" nil
23522 "Always return t in org-mode buffers.
23523 This is because we want to insert math symbols without dollars even outside
23524 the LaTeX math segments. If Orgmode thinks that point is actually inside
23525 en embedded LaTeX fragement, let texmathp do its job.
23542 "Unconditionally turn on `org-cdlatex-mode'."
23546 "Test if point is inside a LaTeX fragment.
23548 sequence appearing also before point.
23549 Even though the matchers for math are configurable, this function assumes
23551 delimiters are skipped when they have been removed by customization.
23552 The return value is nil, or a cons cell with the delimiter and
23553 and the position of this delimiter.
23555 This function does a reasonably good job, but can locally be fooled by
23556 for example currency specifications. For example it will assume being in
23558 fragments that are properly closed, but during editing, we have to live
23559 with the uncertainty caused by missing closing delimiters. This function
23560 looks only before point, not after."
23579 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23583 ;; count $$
23591 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23592 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23593 - inside a LaTeX fragment, or
23594 - after the first word in a line, where an abbreviation expansion could
23595 insert a LaTeX environment."
23608 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23609 Revert to the normal definition outside of these fragments."
23617 "Execute `cdlatex-math-modify' in LaTeX fragments.
23618 Revert to the normal definition outside of these fragments."
23630 "Remove all overlays with LaTeX fragment images in current buffer."
23635 "Preview the LaTeX fragment at point, or all locally or globally.
23636 If the cursor is in a LaTeX fragment, create the image and overlay
23637 it over the source code. If there is no fragment at point, display
23638 all fragments in the current text, from one headline to the next. With
23639 prefix SUBTREE, display all fragments in the current subtree. With a
23640 double prefix `C-u C-u', or when the cursor is before the first headline,
23641 display all fragments in the buffer.
23671 buffer-file-name)))
23677 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23678 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23679 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23686 "Replace LaTeX fragments with links to an image, and produce images."
23695 m n block linkfile movefile ov)
23696 ;; Check if there are old images files with this prefix, and remove them
23700 todir 'full
23702 ;; Check the different regular expressions
23722 txt movefile opt forbuffer)
23730 ov 'end-glyph
23733 ov 'display
23740 ;; This function borrows from Ganesh Swami's latex2png.el
23744 temporary-file-directory))
23773 "-D" dpi
23774 ;;"-x" scale "-y" scale
23776 "-o" pngfile
23777 dvifile)
23780 ;; Use the requested file name and clean up
23784 pngfile))))
23787 "Return an rgb color specification for dvipng."
23793 "Return string to be used as color value for an RGB component."
23796 ;;;; Exporting
23798 ;;; Variables, constants, and parameter plists
23854 "Return the property list with default settings for the export variables."
23858 rtn))
23861 "Return the property list with file-local settings for export."
23868 p key val text options)
23901 o)
23905 options)
23909 p))))
23915 val)))
23916 dir))
23923 rtn line level)
23928 ;; Beginning of a COMMENT subtree. Skip it.
23934 ;; an ordinary comment line
23935 )
23941 ;; a special table line that should be removed
23942 )
23949 \[v] limit export to visible part of outline tree
23951 \[a] export as ASCII
23953 \[h] export as HTML
23954 \[H] export as HTML to temporary buffer
23955 \[R] export region as HTML
23956 \[b] export as HTML and browse immediately
23957 \[x] export as XOXO
23959 \[l] export as LaTeX
23960 \[L] export as LaTeX to temporary buffer
23962 \[i] export current file as iCalendar file
23963 \[I] export all agenda files as iCalendar files
23964 \[c] export agenda files into combined iCalendar file
23966 \[F] publish current file
23967 \[P] publish current project
23968 \[X] publish... (project will be prompted for)
23988 r1 r2 ass)
24291 )
24292 "Entities for TeX->HTML translation.
24296 The list contains HTML entities for Latin-1, Greek and other symbols.
24297 It is supplemented by a number of commonly used TeX macros with appropriate
24300 ;;; General functions for all backends
24303 "Cleanup a buffer STRING so that links can be created safely."
24321 a b xx
24322 rtn p)
24326 ;; Remove license-to-kill stuff
24334 ;; Get rid of drawers
24339 'identity
24347 ;; Get the correct stuff before the first headline
24358 ;; Get rid of archived trees
24370 ;; Find targets in comments and move them out of comments,
24371 ;; but mark them as targets that should be invisible
24376 ;; Protect backend specific stuff, throw away the others.
24381 fmt)
24412 ;; Protect quoted subtrees
24420 ;; Protect verbatim elements
24427 ;; Remove subtrees that are commented
24433 ;; Remove special table lines
24445 ;; Specific LaTeX stuff
24453 ;; Specific HTML stuff
24455 ;; Convert LaTeX fragments to images
24460 org-current-export-file)))
24464 ;; Remove or replace comments
24473 ;; Find matches for radio targets and turn them into internal links
24480 ;; Find all links that contain a newline and put them into a single line
24482 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24488 ;; Normalize links: Convert angle and plain links into bracket links
24489 ;; Expand link abbreviations
24496 ;; added 'org-link face to links
24512 "]"
24520 ;; Find multiline emphasis and put them into single line
24534 rtn))
24537 "Get a title for the current document, from looking at the buffer."
24543 ;; Mark the line so that it will not be exported as normal text.
24547 ;; Return the title string
24551 "Return subtree title and exclude it from export."
24557 ;; This is a subtree, we take the title from the first heading
24564 title))
24567 "Take link text and make a safe target out of it."
24571 'identity
24577 "Get the minimum level in LINES."
24585 ;; Variable holding the vector with section numbers
24589 "Initialize the vector for the section numbers."
24606 "Return a string with the current section number.
24607 When LEVEL is non-nil, increase section numbers on that level."
24629 string))
24631 ;;; ASCII export
24639 "Export the outline as a pretty ASCII file.
24640 If there is an active region, export only the region.
24641 The prefix ARG specifies how many levels of the outline should become
24642 underlined headlines. The default is 3."
24671 filename))
24687 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24696 region
24697 :for-ascii t
24698 :skip-before-1st-heading
24701 :verbatim-multiline t
24702 :archived-trees
24706 thetoc have-headings first-heading-pos
24707 table-open table-buffer)
24725 ;; create local variables for all options, to make sure all called
24726 ;; functions get the correct information
24730 org-export-plist-vars)
24733 org-export-headline-levels))
24736 umax))
24738 ;; File header
24742 org-export-author-info)
24764 line)
24765 ;; This is a headline
24771 todo
24775 org-done-keywords)))
24776 ; TODO, not DONE
24780 line lines level))))
24787 t t txt)))
24792 txt))
24807 thetoc)
24809 ))))
24810 lines)
24815 ;; Remove the quoted HTML tags.
24817 ;; Remove targets
24820 ;; Replace internal links
24824 t nil line)))
24829 ;; a Headline
24838 ;; New table starts
24840 ;; Accumulate lines
24861 ;; insert the table of contents
24873 ;; Convert whitespace place holders
24883 ;; remove display and invisible chars
24899 "Do extra work for ASCII export"
24909 "Search the subtree below LINE for any TODO entries."
24912 line lv todo)
24920 org-done-keywords))))
24921 ; TODO, not DONE
24926 "Handle quoted HTML for ASCII export."
24929 ;; We just remove the tags for now.
24931 line)
24934 "Insert the string S centered and underline it with character UNDERLINE."
24943 "Insert a new level in ASCII export."
24949 org-export-ascii-bullets))
24951 ;; find the indentation of the next non-empty line
24972 "Create a copy of the visible part of the current buffer, and export it.
24973 The copy is created in a temporary buffer and removed after use.
24974 TYPE is the final key (as a string) that also select the export command in
24975 the `C-c C-e' export dispatcher.
24976 As a special case, if the you type SPC at the prompt, the temporary
24977 org-mode file will not be removed but presented to you so that you can
24978 continue to use it. The prefix arg ARG is passed through to the exporting
24979 command."
24982 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24984 current-prefix-arg))
24999 s e)
25000 ;; Need to hack the drawers here.
25016 ;; Copy all comment lines to the end, to make sure #+ settings are
25017 ;; still available for the second export step. Kind of a hack, but
25018 ;; does do the trick.
25039 s))
25044 s))
25046 ;;; HTML export
25049 "Return a string with current options as keyword options.
25050 Does include HTML export options as well as TODO and CATEGORY stuff."
25052 "#+TITLE: %s
25053 #+AUTHOR: %s
25054 #+EMAIL: %s
25055 #+LANGUAGE: %s
25056 #+TEXT: Some descriptive text to be emitted. Several lines OK.
25057 #+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
25058 #+CATEGORY: %s
25059 #+SEQ_TODO: %s
25060 #+TYP_TODO: %s
25061 #+PRIORITIES: %c %c %c
25062 #+DRAWERS: %s
25063 #+STARTUP: %s %s %s %s %s
25064 #+TAGS: %s
25065 #+ARCHIVE: %s
25066 #+LINK: %s
25067 "
25069 org-export-headline-levels
25070 org-export-with-section-numbers
25071 org-export-with-toc
25072 org-export-preserve-breaks
25073 org-export-html-expand
25074 org-export-with-fixed-width
25075 org-export-with-tables
25076 org-export-with-sub-superscripts
25077 org-export-with-special-strings
25078 org-export-with-footnotes
25079 org-export-with-emphasize
25080 org-export-with-TeX-macros
25081 org-export-with-LaTeX-fragments
25082 org-export-skip-text-before-1st-heading
25083 org-export-with-drawers
25084 org-export-with-tags
25086 "TODO FEEDBACK VERIFY DONE"
25087 "Me Jason Marie DONE"
25088 org-highest-priority org-lowest-priority org-default-priority
25105 org-archive-location
25106 "org file:~/org/%s.org"
25107 ))
25110 "Insert into the buffer a template with information for exporting."
25119 "Toggle the fixed-width export.
25120 If there is no active region, the QUOTE keyword at the current headline is
25121 inserted or removed. When present, it causes the text between this headline
25122 and the next to be exported as fixed-width text, and unmodified.
25123 If there is an active region, this command adds or removes a colon as the
25124 first character of this line. If the first character of a line is a colon,
25125 this line is also exported in fixed-width font."
25134 off)
25164 "Export the outline as HTML and immediately open it with a browser.
25165 If there is an active region, export only the region.
25166 The prefix ARG specifies how many levels of the outline should become
25167 headlines. The default is 3. Lower levels will become bulleted lists."
25173 "Call `org-export-as-html', may be used in batch processing as
25174 emacs --batch
25175 --load=$HOME/lib/emacs/org.el
25177 --visit=MyFile --funcall org-export-as-html-batch"
25181 "Call `org-exort-as-html` with output to a temporary buffer.
25182 No file is created. The prefix ARG is passed through to `org-export-as-html'."
25188 "Assume the current region has org-mode syntax, and convert it to HTML.
25189 This can be used in any buffer. For example, you could write an
25190 itemized list in org-mode syntax in an HTML buffer and then use this
25191 command to convert it."
25211 "Convert region from BEG to END in org-mode buffer to HTML.
25212 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
25213 contents, and only produce the region of converted text, useful for
25214 cut-and-paste operations.
25215 If BUFFER is a buffer or a string, use/create that buffer as a target
25216 of the converted HTML. If BUFFER is the symbol `string', return the
25217 produced HTML as a string and leave not buffer behind. For example,
25218 a Lisp program could call this function in the following way:
25220 (setq html (org-export-region-as-html beg end t 'string))
25222 When called interactively, the output buffer is selected, and shown
25223 in a window. A non-interactive call will only retunr the buffer."
25228 rtn)
25233 nil nil nil
25234 buffer body-only))
25238 rtn)))
25242 to-buffer body-only pub-dir)
25243 "Export the outline as a pretty HTML file.
25244 If there is an active region, export only the region. The prefix
25245 ARG specifies how many levels of the outline should become
25246 headlines. The default is 3. Lower levels will become bulleted
25247 lists. When HIDDEN is non-nil, don't display the HTML buffer.
25248 EXT-PLIST is a property list with external parameters overriding
25249 org-mode's default settings, but still inferior to file-local
25250 settings. When TO-BUFFER is non-nil, create a buffer with that
25251 name and export to that buffer. If TO-BUFFER is the symbol
25252 `string', don't leave any buffer behind but just return the
25253 resulting HTML as a string. When BODY-ONLY is set, don't produce
25254 the file header and footer, simply return the content of
25255 <body>...</body>, without even the body tags themselves. When
25256 PUB-DIR is set, use this as the publishing directory."
25259 ;; Make sure we have a file name when we need it.
25265 buffer-file-name))
25274 ext-plist
25280 valid thetoc have-headings first-heading-pos
25289 ;; The following two are dynamically scoped into other
25290 ;; routines below.
25310 default-directory))
25344 buffer-file-coding-system))
25346 coding-system))
25348 coding-system))
25360 region
25361 :emph-multiline t
25362 :for-html t
25363 :skip-before-1st-heading
25366 :archived-trees
25368 :add-text
25370 :LaTeX-fragments
25373 table-open type
25374 table-buffer table-orig-buffer
25375 ind start-is-num starter didclose
25376 rpl path desc descp desc1 desc2 link
25377 )
25396 ;; Get the language-dependent settings
25400 ;; Switch to the output buffer
25410 ;; create local variables for all options, to make sure all called
25411 ;; functions get the correct information
25415 org-export-plist-vars)
25417 org-export-headline-levels))
25420 umax))
25422 ;; File header
25428 <head>
25429 <title>%s</title>
25434 %s
25435 </head><body>
25436 "
25449 org-export-html-toplevel-hlevel
25451 org-export-html-toplevel-hlevel)
25452 thetoc)
25457 ;; This is a headline
25466 todo
25470 org-done-keywords)))
25471 ; TODO, not DONE
25475 line lines level))))
25500 ;; Check for targets
25505 t t line))
25508 target-alist))
25519 )))
25520 line)
25521 lines))
25533 ;; end of quote section?
25537 ;; inside a quote section?
25542 ;; verbatim lines
25556 ;; Protected HTML
25571 ;; Horizontal line
25576 ;; make targets to anchors
25584 t t line)))
25588 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25589 t t line)))
25595 t t line)))))
25599 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25600 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25601 ;; Also handle sub_superscripts and checkboxes
25605 ;; Format the links
25615 ;; Make an image out of the description if that is so wanted
25621 ;; FIXME: do we need to unescape here somewhere?
25631 ;; standard URL, just check if we need to inline an image
25639 ;; standard URL
25643 ;; FILE link
25646 thefile file-is-image-p search)
25654 t))
25663 ;; make sure this is can be used as target search
25688 ;; TODO items
25696 org-done-keywords)
25701 ;; Does this contain a reference to a footnote?
25713 t t line))))))
25717 ;; This is a headline
25725 ;; Close any local lists before inserting a new header line
25731 in-local-list nil))
25735 head-count)
25736 ;; QUOTES
25744 ;; New table starts
25746 ;; Accumulate lines
25758 ;; Normal lines
25761 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25762 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25765 line)
25772 ;; empty line. Pretend indentation is large.
25774 0
25790 ;; Start new (level of) list
25797 ;; continue current list
25801 ;; we did close a list, normal text follows: need <p>
25807 "<b>[X]</b>"
25809 t t line))))
25811 ;; Empty lines start a new paragraph. If hand-formatted lists
25812 ;; are not fully interpreted, lines starting with "-", "+", "*"
25813 ;; also start a new paragraph.
25816 ;; Is this the start of a footnote?
25822 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25824 ;; Check if the line break needs to be conserved
25833 ;; Properly close all local lists and other lists
25836 ;; Close any local lists before inserting a new header line
25842 in-local-list nil))
25845 head-count)
25876 ;; insert the table of contents
25893 ;; remove empty paragraphs and lists
25903 ;; Convert whitespace place holders
25924 "Format a table for ascii export."
25928 ;; Table made by table.el - test for spanning
25929 lines
25931 ;; A normal org table
25932 ;; Get rid of hlines at beginning and end
25938 ;; Check if the table has a marking column. If yes remove the
25939 ;; column and the special lines
25941 ;; Get rid of the vertical lines except for grouping
25943 rtn line vl1 start)
25965 vl))
25968 "Find out which HTML converter to use and return the HTML code."
25972 ;; A normal org table
25974 ;; Table made by table.el - test for spanning
25978 nil))
25979 lines)))
25985 hlines))))
25988 ;; We can use my own converter with HTML conversions
25990 ;; Need to use the code generator in table.el, with the original text.
25994 "Format a table into HTML."
25995 ;; Get rid of hlines at beginning and end
26001 ;; Check if the table has a marking column. If yes remove the
26002 ;; column and the special lines
26010 tbopen line fields html gr colgropen)
26022 ;; ignore this line
26024 ;; Break the line into fields
26042 html)))
26047 ;; Put in col tags with the alignment (unfortuntely often ignored...)
26063 html)
26069 "Check if the table has a marking column.
26070 If yes remove the column and the special lines."
26076 lines))
26091 nil)
26093 lines)))
26107 nil)
26112 ;; remove the first column
26114 lines))))
26117 "Format a table generated by table.el into HTML.
26118 This conversion does *not* use `table-generate-source' from table.el.
26119 This has the advantage that Org-mode's HTML conversions can be used.
26120 But it has the disadvantage, that no cell- or row-spanning is allowed."
26123 fields html empty)
26133 html
26135 html
26136 "<tr>"
26149 ;; Ignore this line
26151 ;; Break the line into fields and store the fields
26157 field-buffer))
26160 html))
26163 "Format a table into html, using `table-generate-source' from table.el.
26164 This has the advantage that cell- or row-spanning is allowed.
26165 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
26180 "Format time stamps in string S, or remove them."
26185 ;; never export CLOCK
26200 ;; Line break if line started and ended with time stamp stuff
26202 s
26206 r))))
26209 ;; convert & to &, < to < and > to >
26218 s)
26221 "Remove tags and time staps from lines going into the toc."
26230 t t s)))
26231 s)
26234 "Prepare STRING for HTML export. Applies all active conversions.
26235 If there are links in the string, don't modify these."
26238 m s l res)
26249 "Apply all active conversions to translate special ASCII to HTML."
26270 t t s))
26272 s)
26275 "Create a regular expression which will match a balanced sexp.
26276 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
26277 as single character strings.
26278 The regexp returned will match the entire expression including the
26279 delimiters. It will also define a single group which contains the
26280 match except for the outermost delimiters. The maximum depth of
26281 stacked delimiters is N. Escaping delimiters is not possible."
26317 "Convert special characters in STRING to HTML."
26319 e a re rpl start)
26326 string))
26329 "Convert sub- and superscripts in STRING to HTML."
26345 t t string)))))
26348 string))
26351 "Apply emphasis."
26358 rpl
26364 org-emphasis-alist))
26369 string))
26373 "Insert <p>, but first close previous paragraph if any."
26378 "Close paragraph if there is one open."
26383 "Close <li> if necessary."
26389 "Insert a new level in HTML export.
26390 When TITLE is nil, just close all open levels."
26400 ;; If title is nil, this means this function is called to close
26401 ;; all levels, so the rest is done only if title is given
26413 t t title)))
26429 level level head-count title level))
26434 "Terminate one level in HTML export."
26440 ;;; iCalendar export
26442 ;;;###autoload
26444 "Export current file as an iCalendar file.
26445 The iCalendar file will be located in the same directory as the Org-mode
26446 file, but with extension `.ics'."
26450 ;;;###autoload
26452 "Export all files in `org-agenda-files' to iCalendar .ics files.
26453 Each iCalendar file will be located in the same directory as the Org-mode
26454 file, but with extension `.ics'."
26458 ;;;###autoload
26460 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26461 The file is stored under the name `org-combined-agenda-icalendar-file'."
26466 "Create iCalendar files for all elements of FILES.
26467 If COMBINE is non-nil, combine all calendar entries into a single large
26468 file and store it under the name `org-combined-agenda-icalendar-file'."
26473 org-export-publishing-directory)))
26474 file ical-file ical-buffer category started org-agenda-new-buffers)
26480 org-combined-agenda-icalendar-file
26513 "Hook run after an iCalendar file has been saved.
26514 The iCalendar buffer is still current when this hook is run.
26515 A good way to use this is to tell a desktop calenndar application to re-read
26519 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26520 When COMBINE is non nil, add the category to each line."
26527 scheduledp deadlinep tmp pri category entry location summary desc
26537 inc t
26544 t org-icalendar-include-body)
26554 pos)
26559 ts)
26562 ;; donep (org-entry-is-done-p)
26563 ))
26582 t t summary)))
26589 %s
26590 %s%s
26591 SUMMARY:%s%s%s
26592 CATEGORIES:%s
26596 rrule summary
26601 category)))))
26606 ;; Get all the literal sexps
26632 )
26639 t org-icalendar-include-body)
26645 t t hd)))
26655 %s
26656 SUMMARY:%s%s%s
26657 CATEGORIES:%s
26658 SEQUENCE:1
26659 PRIORITY:%d
26660 STATUS:%s
26662 dts
26668 category pri status)))))))))
26671 "Take out stuff and quote what needs to be quoted.
26672 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26673 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26674 characters."
26676 nil
26695 s))
26698 "Clean-up description string."
26704 "Start an iCalendar file by inserting the header."
26710 VERSION:2.0
26711 X-WR-CALNAME:%s
26712 PRODID:-//%s//Emacs with Org-mode//EN
26713 X-WR-TIMEZONE:%s
26717 "Finish an iCalendar file by inserting the END statement."
26721 "Take a time string S and convert it to iCalendar format.
26722 KEYWORD is added in front, to make a complete line like DTSTART....
26723 When INC is non-nil, increase the hour by two (if time string contains
26724 a time), or the day by one (if it does not contain a time)."
26726 t2 fmt have-time time)
26742 ;;; XOXO export
26750 "Export the org buffer as XOXO.
26751 The XOXO buffer is named *xoxo-<source buffer name>*"
26753 ;; A quickie abstraction
26755 ;; Output everything as XOXO
26769 ;; Check the output buffer is empty.
26771 ;; Kick off the output
26788 ;; Handle level rendering
26805 )
26809 ;; And output the new li
26815 ;; Finally finish off the ol
26822 ;; Finish the buffer off and clean it up.
26827 )))
26830 ;;;; Key bindings
26832 ;; Make `C-c C-x' a prefix key
26835 ;; TAB key with modifiers
26842 ;; The following line is necessary under Suse GNU/Linux
26848 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26849 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26850 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26852 ;; Cursor keys with modifiers
26853 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26854 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26855 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26856 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26858 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26859 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26860 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26861 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26863 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26864 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26865 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26866 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26868 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26869 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26871 ;;; Extra keys for tty access.
26872 ;; We only set them when really needed because otherwise the
26873 ;; menus don't show the simple keys
26875 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26876 (not window-system))
26877 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26878 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26879 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26880 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26881 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26882 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26883 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26884 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26885 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26886 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26887 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26888 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26889 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26890 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26891 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26892 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26893 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26894 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26895 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26896 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26897 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26898 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26900 ;; All the other keys
26902 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26903 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26904 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26905 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26906 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26907 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26908 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26909 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26910 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26911 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26912 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26913 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26914 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26915 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26916 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26918 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26919 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26920 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26921 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26922 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26923 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26924 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26925 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26926 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26927 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26928 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26929 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26930 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26931 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26932 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26933 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26934 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26936 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26937 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26938 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26939 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26940 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26941 (org-defkey org-mode-map "\C-c^" 'org-sort)
26942 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26943 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26944 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26945 (org-defkey org-mode-map "\C-m" 'org-return)
26946 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26947 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26948 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26949 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26950 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26951 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26952 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26953 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26954 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26955 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26956 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26957 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26958 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26959 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26960 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26961 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26962 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26964 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26965 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26966 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26967 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26969 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26970 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26971 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26972 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26973 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26974 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26975 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26976 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26977 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26978 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26979 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26980 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26982 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26984 (when (featurep 'xemacs)
26985 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26987 (defsubst org-table-p () (org-at-table-p))
26989 (defun org-self-insert-command (N)
26990 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26991 If the cursor is in a table looking at whitespace, the whitespace is
26992 overwritten, and the table is not marked as requiring realignment."
26993 (interactive "p")
26994 (if (and (org-table-p)
26995 (progn
26996 ;; check if we blank the field, and if that triggers align
26997 (and org-table-auto-blank-field
26998 (member last-command
26999 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
27001 ;; got extra space, this field does not determine column width
27002 (let (org-table-may-need-update) (org-table-blank-field))
27003 ;; no extra space, this field may determine column width
27004 (org-table-blank-field)))
27005 t)
27006 (eq N 1)
27008 (let (org-table-may-need-update)
27009 (goto-char (1- (match-end 0)))
27010 (delete-backward-char 1)
27011 (goto-char (match-beginning 0))
27012 (self-insert-command N))
27013 (setq org-table-may-need-update t)
27014 (self-insert-command N)
27015 (org-fix-tags-on-the-fly)))
27017 (defun org-fix-tags-on-the-fly ()
27018 (when (and (equal (char-after (point-at-bol)) ?*)
27019 (org-on-heading-p))
27020 (org-align-tags-here org-tags-column)))
27022 (defun org-delete-backward-char (N)
27023 "Like `delete-backward-char', insert whitespace at field end in tables.
27024 When deleting backwards, in tables this function will insert whitespace in
27026 still be marked for re-alignment if the field did fill the entire column,
27027 because, in this case the deletion might narrow the column."
27028 (interactive "p")
27029 (if (and (org-table-p)
27030 (eq N 1)
27031 (string-match "|" (buffer-substring (point-at-bol) (point)))
27032 (looking-at ".*?|"))
27033 (let ((pos (point))
27035 (c org-table-may-need-update))
27036 (backward-delete-char N)
27037 (skip-chars-forward "^|")
27038 (insert " ")
27039 (goto-char (1- pos))
27040 ;; noalign: if there were two spaces at the end, this field
27041 ;; does not determine the width of the column.
27042 (if noalign (setq org-table-may-need-update c)))
27043 (backward-delete-char N)
27044 (org-fix-tags-on-the-fly)))
27046 (defun org-delete-char (N)
27047 "Like `delete-char', but insert whitespace at field end in tables.
27048 When deleting characters, in tables this function will insert whitespace in
27050 still be marked for re-alignment if the field did fill the entire column,
27051 because, in this case the deletion might narrow the column."
27052 (interactive "p")
27053 (if (and (org-table-p)
27054 (not (bolp))
27055 (not (= (char-after) ?|))
27056 (eq N 1))
27057 (if (looking-at ".*?|")
27058 (let ((pos (point))
27060 (c org-table-may-need-update))
27061 (replace-match (concat
27062 (substring (match-string 0) 1 -1)
27063 " |"))
27064 (goto-char pos)
27065 ;; noalign: if there were two spaces at the end, this field
27066 ;; does not determine the width of the column.
27067 (if noalign (setq org-table-may-need-update c)))
27068 (delete-char N))
27069 (delete-char N)
27070 (org-fix-tags-on-the-fly)))
27072 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
27073 (put 'org-self-insert-command 'delete-selection t)
27074 (put 'orgtbl-self-insert-command 'delete-selection t)
27075 (put 'org-delete-char 'delete-selection 'supersede)
27076 (put 'org-delete-backward-char 'delete-selection 'supersede)
27078 ;; Make `flyspell-mode' delay after some commands
27079 (put 'org-self-insert-command 'flyspell-delayed t)
27080 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
27081 (put 'org-delete-char 'flyspell-delayed t)
27082 (put 'org-delete-backward-char 'flyspell-delayed t)
27084 ;; Make pabbrev-mode expand after org-mode commands
27085 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
27086 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
27088 ;; How to do this: Measure non-white length of current string
27089 ;; If equal to column width, we should realign.
27091 (defun org-remap (map &rest commands)
27092 "In MAP, remap the functions given in COMMANDS.
27093 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
27094 (let (new old)
27095 (while commands
27096 (setq old (pop commands) new (pop commands))
27097 (if (fboundp 'command-remapping)
27098 (org-defkey map (vector 'remap old) new)
27099 (substitute-key-definition old new map global-map)))))
27101 (when (eq org-enable-table-editor 'optimized)
27102 ;; If the user wants maximum table support, we need to hijack
27103 ;; some standard editing functions
27104 (org-remap org-mode-map
27105 'self-insert-command 'org-self-insert-command
27106 'delete-char 'org-delete-char
27107 'delete-backward-char 'org-delete-backward-char)
27108 (org-defkey org-mode-map "|" 'org-force-self-insert))
27110 (defun org-shiftcursor-error ()
27111 "Throw an error because Shift-Cursor command was applied in wrong context."
27112 (error "This command is active in special context like tables, headlines or timestamps"))
27114 (defun org-shifttab (&optional arg)
27115 "Global visibility cycling or move to previous table field.
27116 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
27117 on context.
27118 See the individual commands for more information."
27119 (interactive "P")
27120 (cond
27121 ((org-at-table-p) (call-interactively 'org-table-previous-field))
27122 (arg (message "Content view to level: ")
27123 (org-content (prefix-numeric-value arg))
27124 (setq org-cycle-global-status 'overview))
27125 (t (call-interactively 'org-global-cycle))))
27127 (defun org-shiftmetaleft ()
27128 "Promote subtree or delete table column.
27129 Calls `org-promote-subtree', `org-outdent-item',
27130 or `org-table-delete-column', depending on context.
27131 See the individual commands for more information."
27132 (interactive)
27133 (cond
27134 ((org-at-table-p) (call-interactively 'org-table-delete-column))
27135 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
27136 ((org-at-item-p) (call-interactively 'org-outdent-item))
27137 (t (org-shiftcursor-error))))
27139 (defun org-shiftmetaright ()
27140 "Demote subtree or insert table column.
27141 Calls `org-demote-subtree', `org-indent-item',
27142 or `org-table-insert-column', depending on context.
27143 See the individual commands for more information."
27144 (interactive)
27145 (cond
27146 ((org-at-table-p) (call-interactively 'org-table-insert-column))
27147 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
27148 ((org-at-item-p) (call-interactively 'org-indent-item))
27149 (t (org-shiftcursor-error))))
27151 (defun org-shiftmetaup (&optional arg)
27152 "Move subtree up or kill table row.
27153 Calls `org-move-subtree-up' or `org-table-kill-row' or
27154 `org-move-item-up' depending on context. See the individual commands
27155 for more information."
27156 (interactive "P")
27157 (cond
27158 ((org-at-table-p) (call-interactively 'org-table-kill-row))
27159 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27160 ((org-at-item-p) (call-interactively 'org-move-item-up))
27161 (t (org-shiftcursor-error))))
27162 (defun org-shiftmetadown (&optional arg)
27163 "Move subtree down or insert table row.
27164 Calls `org-move-subtree-down' or `org-table-insert-row' or
27165 `org-move-item-down', depending on context. See the individual
27166 commands for more information."
27167 (interactive "P")
27168 (cond
27169 ((org-at-table-p) (call-interactively 'org-table-insert-row))
27170 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27171 ((org-at-item-p) (call-interactively 'org-move-item-down))
27172 (t (org-shiftcursor-error))))
27174 (defun org-metaleft (&optional arg)
27175 "Promote heading or move table column to left.
27176 Calls `org-do-promote' or `org-table-move-column', depending on context.
27177 With no specific context, calls the Emacs default `backward-word'.
27178 See the individual commands for more information."
27179 (interactive "P")
27180 (cond
27181 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
27182 ((or (org-on-heading-p) (org-region-active-p))
27183 (call-interactively 'org-do-promote))
27184 ((org-at-item-p) (call-interactively 'org-outdent-item))
27185 (t (call-interactively 'backward-word))))
27187 (defun org-metaright (&optional arg)
27188 "Demote subtree or move table column to right.
27189 Calls `org-do-demote' or `org-table-move-column', depending on context.
27190 With no specific context, calls the Emacs default `forward-word'.
27191 See the individual commands for more information."
27192 (interactive "P")
27193 (cond
27194 ((org-at-table-p) (call-interactively 'org-table-move-column))
27195 ((or (org-on-heading-p) (org-region-active-p))
27196 (call-interactively 'org-do-demote))
27197 ((org-at-item-p) (call-interactively 'org-indent-item))
27198 (t (call-interactively 'forward-word))))
27200 (defun org-metaup (&optional arg)
27201 "Move subtree up or move table row up.
27202 Calls `org-move-subtree-up' or `org-table-move-row' or
27203 `org-move-item-up', depending on context. See the individual commands
27204 for more information."
27205 (interactive "P")
27206 (cond
27207 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
27208 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27209 ((org-at-item-p) (call-interactively 'org-move-item-up))
27210 (t (transpose-lines 1) (beginning-of-line -1))))
27212 (defun org-metadown (&optional arg)
27213 "Move subtree down or move table row down.
27214 Calls `org-move-subtree-down' or `org-table-move-row' or
27215 `org-move-item-down', depending on context. See the individual
27216 commands for more information."
27217 (interactive "P")
27218 (cond
27219 ((org-at-table-p) (call-interactively 'org-table-move-row))
27220 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27221 ((org-at-item-p) (call-interactively 'org-move-item-down))
27222 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
27224 (defun org-shiftup (&optional arg)
27225 "Increase item in timestamp or increase priority of current headline.
27226 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
27227 depending on context. See the individual commands for more information."
27228 (interactive "P")
27229 (cond
27230 ((org-at-timestamp-p t)
27231 (call-interactively (if org-edit-timestamp-down-means-later
27232 'org-timestamp-down 'org-timestamp-up)))
27233 ((org-on-heading-p) (call-interactively 'org-priority-up))
27234 ((org-at-item-p) (call-interactively 'org-previous-item))
27235 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
27237 (defun org-shiftdown (&optional arg)
27238 "Decrease item in timestamp or decrease priority of current headline.
27239 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
27240 depending on context. See the individual commands for more information."
27241 (interactive "P")
27242 (cond
27243 ((org-at-timestamp-p t)
27244 (call-interactively (if org-edit-timestamp-down-means-later
27245 'org-timestamp-up 'org-timestamp-down)))
27246 ((org-on-heading-p) (call-interactively 'org-priority-down))
27247 (t (call-interactively 'org-next-item))))
27249 (defun org-shiftright ()
27250 "Next TODO keyword or timestamp one day later, depending on context."
27251 (interactive)
27252 (cond
27253 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
27254 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
27255 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
27256 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
27257 (t (org-shiftcursor-error))))
27259 (defun org-shiftleft ()
27260 "Previous TODO keyword or timestamp one day earlier, depending on context."
27261 (interactive)
27262 (cond
27263 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
27264 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
27265 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
27266 ((org-at-property-p)
27267 (call-interactively 'org-property-previous-allowed-value))
27268 (t (org-shiftcursor-error))))
27270 (defun org-shiftcontrolright ()
27271 "Switch to next TODO set."
27272 (interactive)
27273 (cond
27274 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
27275 (t (org-shiftcursor-error))))
27277 (defun org-shiftcontrolleft ()
27278 "Switch to previous TODO set."
27279 (interactive)
27280 (cond
27281 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
27282 (t (org-shiftcursor-error))))
27284 (defun org-ctrl-c-ret ()
27285 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
27286 (interactive)
27287 (cond
27288 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27289 (t (call-interactively 'org-insert-heading))))
27291 (defun org-copy-special ()
27292 "Copy region in table or copy current subtree.
27293 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27294 See the individual commands for more information."
27295 (interactive)
27296 (call-interactively
27297 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27299 (defun org-cut-special ()
27300 "Cut region in table or cut current subtree.
27301 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27302 See the individual commands for more information."
27303 (interactive)
27304 (call-interactively
27305 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27307 (defun org-paste-special (arg)
27308 "Paste rectangular region into table, or past subtree relative to level.
27309 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27310 See the individual commands for more information."
27311 (interactive "P")
27312 (if (org-at-table-p)
27313 (org-table-paste-rectangle)
27314 (org-paste-subtree arg)))
27316 (defun org-ctrl-c-ctrl-c (&optional arg)
27317 "Set tags in headline, or update according to changed information at point.
27319 This command does many different things, depending on context:
27321 - If the cursor is in a headline, prompt for tags and insert them
27322 into the current line, aligned to `org-tags-column'. When called
27323 with prefix arg, realign all tags in the current buffer.
27325 - If the cursor is in one of the special #+KEYWORD lines, this
27326 triggers scanning the buffer for these lines and updating the
27327 information.
27329 - If the cursor is inside a table, realign the table. This command
27330 works even if the automatic table editor has been turned off.
27332 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27333 the entire table.
27335 - If the cursor is a the beginning of a dynamic block, update it.
27337 - If the cursor is inside a table created by the table.el package,
27338 activate that table.
27340 - If the current buffer is a remember buffer, close note and file it.
27341 with a prefix argument, file it without further interaction to the default
27342 location.
27344 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27345 links in this buffer.
27347 - If the cursor is on a numbered item in a plain list, renumber the
27348 ordered list.
27350 - If the cursor is on a checkbox, toggle it."
27351 (interactive "P")
27352 (let ((org-enable-table-editor t))
27353 (cond
27354 ((or org-clock-overlays
27355 org-occur-highlights
27356 org-latex-fragment-image-overlays)
27357 (org-remove-clock-overlays)
27358 (org-remove-occur-highlights)
27359 (org-remove-latex-fragment-image-overlays)
27360 (message "Temporary highlights/overlays removed from current buffer"))
27361 ((and (local-variable-p 'org-finish-function (current-buffer))
27362 (fboundp org-finish-function))
27363 (funcall org-finish-function))
27364 ((org-at-property-p)
27365 (call-interactively 'org-property-action))
27366 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27367 ((org-on-heading-p) (call-interactively 'org-set-tags))
27368 ((org-at-table.el-p)
27369 (require 'table)
27370 (beginning-of-line 1)
27371 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27372 (call-interactively 'table-recognize-table))
27373 ((org-at-table-p)
27374 (org-table-maybe-eval-formula)
27375 (if arg
27376 (call-interactively 'org-table-recalculate)
27377 (org-table-maybe-recalculate-line))
27378 (call-interactively 'org-table-align))
27379 ((org-at-item-checkbox-p)
27380 (call-interactively 'org-toggle-checkbox))
27381 ((org-at-item-p)
27382 (call-interactively 'org-maybe-renumber-ordered-list))
27384 ;; Dynamic block
27385 (beginning-of-line 1)
27386 (org-update-dblock))
27388 (cond
27389 ((equal (match-string 1) "TBLFM")
27390 ;; Recalculate the table before this line
27391 (save-excursion
27392 (beginning-of-line 1)
27394 (if (org-at-table-p)
27395 (org-call-with-arg 'org-table-recalculate t))))
27396 (t
27397 (call-interactively 'org-mode-restart))))
27398 (t (error "C-c C-c can do nothing useful at this location.")))))
27400 (defun org-mode-restart ()
27401 "Restart Org-mode, to scan again for special lines.
27402 Also updates the keyword regular expressions."
27403 (interactive)
27404 (let ((org-inhibit-startup t)) (org-mode))
27405 (message "Org-mode restarted to refresh keyword and special line setup"))
27407 (defun org-kill-note-or-show-branches ()
27408 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27409 (interactive)
27410 (if (not org-finish-function)
27411 (call-interactively 'show-branches)
27412 (let ((org-note-abort t))
27413 (funcall org-finish-function))))
27415 (defun org-return (&optional indent)
27416 "Goto next table row or insert a newline.
27417 Calls `org-table-next-row' or `newline', depending on context.
27418 See the individual commands for more information."
27419 (interactive)
27420 (cond
27421 ((bobp) (if indent (newline-and-indent) (newline)))
27422 ((and (org-at-heading-p)
27423 (looking-at
27425 (org-show-entry)
27426 (end-of-line 1)
27427 (newline))
27428 ((org-at-table-p)
27429 (org-table-justify-field-maybe)
27430 (call-interactively 'org-table-next-row))
27431 (t (if indent (newline-and-indent) (newline)))))
27433 (defun org-return-indent ()
27434 (interactive)
27435 "Goto next table row or insert a newline and indent.
27436 Calls `org-table-next-row' or `newline-and-indent', depending on
27437 context. See the individual commands for more information."
27438 (org-return t))
27440 (defun org-ctrl-c-minus ()
27441 "Insert separator line in table or modify bullet type in list.
27442 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
27443 depending on context."
27444 (interactive)
27445 (cond
27446 ((org-at-table-p)
27447 (call-interactively 'org-table-insert-hline))
27448 ((org-on-heading-p)
27449 ;; Convert to item
27450 (save-excursion
27451 (beginning-of-line 1)
27453 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27454 ((org-in-item-p)
27455 (call-interactively 'org-cycle-list-bullet))
27456 (t (error "`C-c -' does have no function here."))))
27458 (defun org-meta-return (&optional arg)
27459 "Insert a new heading or wrap a region in a table.
27460 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27461 See the individual commands for more information."
27462 (interactive "P")
27463 (cond
27464 ((org-at-table-p)
27465 (call-interactively 'org-table-wrap-region))
27466 (t (call-interactively 'org-insert-heading))))
27468 ;;; Menu entries
27470 ;; Define the Org-mode menus
27471 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27472 '("Tbl"
27473 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27474 ["Next Field" org-cycle (org-at-table-p)]
27475 ["Previous Field" org-shifttab (org-at-table-p)]
27476 ["Next Row" org-return (org-at-table-p)]
27477 "--"
27478 ["Blank Field" org-table-blank-field (org-at-table-p)]
27479 ["Edit Field" org-table-edit-field (org-at-table-p)]
27480 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27481 "--"
27482 ("Column"
27483 ["Move Column Left" org-metaleft (org-at-table-p)]
27484 ["Move Column Right" org-metaright (org-at-table-p)]
27485 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27486 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27487 ("Row"
27488 ["Move Row Up" org-metaup (org-at-table-p)]
27489 ["Move Row Down" org-metadown (org-at-table-p)]
27490 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27491 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27492 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27493 "--"
27494 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27495 ("Rectangle"
27496 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27497 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27498 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27499 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27500 "--"
27501 ("Calculate"
27502 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27503 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27504 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27505 "--"
27506 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27507 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27508 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27509 "--"
27510 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27511 "--"
27512 ["Sum Column/Rectangle" org-table-sum
27513 (or (org-at-table-p) (org-region-active-p))]
27514 ["Which Column?" org-table-current-column (org-at-table-p)])
27515 ["Debug Formulas"
27516 org-table-toggle-formula-debugger
27517 :style toggle :selected org-table-formula-debug]
27518 ["Show Col/Row Numbers"
27519 org-table-toggle-coordinate-overlays
27520 :style toggle :selected org-table-overlay-coordinates]
27521 "--"
27522 ["Create" org-table-create (and (not (org-at-table-p))
27523 org-enable-table-editor)]
27524 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27525 ["Import from File" org-table-import (not (org-at-table-p))]
27526 ["Export to File" org-table-export (org-at-table-p)]
27527 "--"
27528 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27530 (easy-menu-define org-org-menu org-mode-map "Org menu"
27531 '("Org"
27532 ("Show/Hide"
27533 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27534 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27535 ["Sparse Tree" org-occur t]
27536 ["Reveal Context" org-reveal t]
27537 ["Show All" show-all t]
27538 "--"
27539 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27540 "--"
27541 ["New Heading" org-insert-heading t]
27542 ("Navigate Headings"
27543 ["Up" outline-up-heading t]
27544 ["Next" outline-next-visible-heading t]
27545 ["Previous" outline-previous-visible-heading t]
27546 ["Next Same Level" outline-forward-same-level t]
27547 ["Previous Same Level" outline-backward-same-level t]
27548 "--"
27549 ["Jump" org-goto t])
27550 ("Edit Structure"
27551 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27552 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27553 "--"
27554 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27555 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27556 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27557 "--"
27558 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27559 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27560 ["Demote Heading" org-metaright (not (org-at-table-p))]
27561 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27562 "--"
27563 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27564 "--"
27565 ["Convert to odd levels" org-convert-to-odd-levels t]
27566 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27567 ("Editing"
27568 ["Emphasis..." org-emphasize t])
27569 ("Archive"
27570 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27571 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27572 ; :active t :keys "C-u C-c C-x C-a"]
27573 ["Sparse trees open ARCHIVE trees"
27574 (setq org-sparse-tree-open-archived-trees
27575 (not org-sparse-tree-open-archived-trees))
27576 :style toggle :selected org-sparse-tree-open-archived-trees]
27577 ["Cycling opens ARCHIVE trees"
27578 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27579 :style toggle :selected org-cycle-open-archived-trees]
27580 ["Agenda includes ARCHIVE trees"
27581 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27582 :style toggle :selected (not org-agenda-skip-archived-trees)]
27583 "--"
27584 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27585 ; ["Check and Move Children" (org-archive-subtree '(4))
27586 ; :active t :keys "C-u C-c C-x C-s"]
27587 )
27588 "--"
27589 ("TODO Lists"
27590 ["TODO/DONE/-" org-todo t]
27591 ("Select keyword"
27592 ["Next keyword" org-shiftright (org-on-heading-p)]
27593 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27594 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27595 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27596 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27597 ["Show TODO Tree" org-show-todo-tree t]
27598 ["Global TODO list" org-todo-list t]
27599 "--"
27600 ["Set Priority" org-priority t]
27601 ["Priority Up" org-shiftup t]
27602 ["Priority Down" org-shiftdown t])
27603 ("TAGS and Properties"
27604 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27605 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27606 "--"
27607 ["Set property" 'org-set-property t]
27608 ["Column view of properties" org-columns t]
27609 ["Insert Column View DBlock" org-insert-columns-dblock t])
27610 ("Dates and Scheduling"
27611 ["Timestamp" org-time-stamp t]
27612 ["Timestamp (inactive)" org-time-stamp-inactive t]
27613 ("Change Date"
27614 ["1 Day Later" org-shiftright t]
27615 ["1 Day Earlier" org-shiftleft t]
27616 ["1 ... Later" org-shiftup t]
27617 ["1 ... Earlier" org-shiftdown t])
27618 ["Compute Time Range" org-evaluate-time-range t]
27619 ["Schedule Item" org-schedule t]
27620 ["Deadline" org-deadline t]
27621 "--"
27622 ["Custom time format" org-toggle-time-stamp-overlays
27623 :style radio :selected org-display-custom-times]
27624 "--"
27625 ["Goto Calendar" org-goto-calendar t]
27626 ["Date from Calendar" org-date-from-calendar t])
27627 ("Logging work"
27628 ["Clock in" org-clock-in t]
27629 ["Clock out" org-clock-out t]
27630 ["Clock cancel" org-clock-cancel t]
27631 ["Goto running clock" org-clock-goto t]
27632 ["Display times" org-clock-display t]
27633 ["Create clock table" org-clock-report t]
27634 "--"
27635 ["Record DONE time"
27636 (progn (setq org-log-done (not org-log-done))
27637 (message "Switching to %s will %s record a timestamp"
27638 (car org-done-keywords)
27639 (if org-log-done "automatically" "not")))
27640 :style toggle :selected org-log-done])
27641 "--"
27642 ["Agenda Command..." org-agenda t]
27643 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27644 ("File List for Agenda")
27645 ("Special views current file"
27646 ["TODO Tree" org-show-todo-tree t]
27647 ["Check Deadlines" org-check-deadlines t]
27648 ["Timeline" org-timeline t]
27649 ["Tags Tree" org-tags-sparse-tree t])
27650 "--"
27651 ("Hyperlinks"
27652 ["Store Link (Global)" org-store-link t]
27653 ["Insert Link" org-insert-link t]
27654 ["Follow Link" org-open-at-point t]
27655 "--"
27656 ["Next link" org-next-link t]
27657 ["Previous link" org-previous-link t]
27658 "--"
27659 ["Descriptive Links"
27660 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27661 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27662 ["Literal Links"
27663 (progn
27664 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27665 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27666 "--"
27667 ["Export/Publish..." org-export t]
27668 ("LaTeX"
27669 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27670 :selected org-cdlatex-mode]
27671 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27672 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27673 ["Modify math symbol" org-cdlatex-math-modify
27674 (org-inside-LaTeX-fragment-p)]
27675 ["Export LaTeX fragments as images"
27676 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27677 :style toggle :selected org-export-with-LaTeX-fragments])
27678 "--"
27679 ("Documentation"
27680 ["Show Version" org-version t]
27681 ["Info Documentation" org-info t])
27682 ("Customize"
27683 ["Browse Org Group" org-customize t]
27684 "--"
27685 ["Expand This Menu" org-create-customize-menu
27686 (fboundp 'customize-menu-create)])
27687 "--"
27688 ["Refresh setup" org-mode-restart t]
27689 ))
27691 (defun org-info (&optional node)
27692 "Read documentation for Org-mode in the info system.
27693 With optional NODE, go directly to that node."
27694 (interactive)
27695 (require 'info)
27696 (info (format "(org)%s" (or node ""))))
27698 (defun org-install-agenda-files-menu ()
27699 (let ((bl (buffer-list)))
27700 (save-excursion
27701 (while bl
27702 (set-buffer (pop bl))
27703 (if (org-mode-p) (setq bl nil)))
27704 (when (org-mode-p)
27705 (easy-menu-change
27706 '("Org") "File List for Agenda"
27707 (append
27708 (list
27709 ["Edit File List" (org-edit-agenda-file-list) t]
27710 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27711 ["Remove Current File from List" org-remove-file t]
27712 ["Cycle through agenda files" org-cycle-agenda-files t]
27713 ["Occur in all agenda files" org-occur-in-agenda-files t]
27714 "--")
27715 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27717 ;;;; Documentation
27719 (defun org-customize ()
27720 "Call the customize function with org as argument."
27721 (interactive)
27722 (customize-browse 'org))
27724 (defun org-create-customize-menu ()
27725 "Create a full customization menu for Org-mode, insert it into the menu."
27726 (interactive)
27727 (if (fboundp 'customize-menu-create)
27728 (progn
27729 (easy-menu-change
27730 '("Org") "Customize"
27731 `(["Browse Org group" org-customize t]
27732 "--"
27733 ,(customize-menu-create 'org)
27734 ["Set" Custom-set t]
27735 ["Save" Custom-save t]
27736 ["Reset to Current" Custom-reset-current t]
27737 ["Reset to Saved" Custom-reset-saved t]
27738 ["Reset to Standard Settings" Custom-reset-standard t]))
27740 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27742 ;;;; Miscellaneous stuff
27745 ;;; Generally useful functions
27747 (defun org-context ()
27748 "Return a list of contexts of the current cursor position.
27749 If several contexts apply, all are returned.
27750 Each context entry is a list with a symbol naming the context, and
27751 two positions indicating start and end of the context. Possible
27752 contexts are:
27754 :headline anywhere in a headline
27755 :headline-stars on the leading stars in a headline
27756 :todo-keyword on a TODO keyword (including DONE) in a headline
27757 :tags on the TAGS in a headline
27758 :priority on the priority cookie in a headline
27759 :item on the first line of a plain list item
27760 :item-bullet on the bullet/number of a plain list item
27761 :checkbox on the checkbox in a plain list item
27762 :table in an org-mode table
27763 :table-special on a special filed in a table
27764 :table-table in a table.el table
27765 :link on a hyperlink
27766 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27767 :target on a <<target>>
27768 :radio-target on a <<<radio-target>>>
27769 :latex-fragment on a LaTeX fragment
27770 :latex-preview on a LaTeX fragment with overlayed preview image
27772 This function expects the position to be visible because it uses font-lock
27773 faces as a help to recognize the following contexts: :table-special, :link,
27774 and :keyword."
27775 (let* ((f (get-text-property (point) 'face))
27776 (faces (if (listp f) f (list f)))
27777 (p (point)) clist o)
27778 ;; First the large context
27779 (cond
27780 ((org-on-heading-p t)
27781 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27782 (when (progn
27783 (beginning-of-line 1)
27784 (looking-at org-todo-line-tags-regexp))
27785 (push (org-point-in-group p 1 :headline-stars) clist)
27786 (push (org-point-in-group p 2 :todo-keyword) clist)
27787 (push (org-point-in-group p 4 :tags) clist))
27788 (goto-char p)
27791 (push (org-point-in-group p 0 :priority) clist)))
27793 ((org-at-item-p)
27794 (push (org-point-in-group p 2 :item-bullet) clist)
27795 (push (list :item (point-at-bol)
27796 (save-excursion (org-end-of-item) (point)))
27797 clist)
27798 (and (org-at-item-checkbox-p)
27799 (push (org-point-in-group p 0 :checkbox) clist)))
27801 ((org-at-table-p)
27802 (push (list :table (org-table-begin) (org-table-end)) clist)
27803 (if (memq 'org-formula faces)
27804 (push (list :table-special
27805 (previous-single-property-change p 'face)
27806 (next-single-property-change p 'face)) clist)))
27807 ((org-at-table-p 'any)
27808 (push (list :table-table) clist)))
27809 (goto-char p)
27811 ;; Now the small context
27812 (cond
27813 ((org-at-timestamp-p)
27814 (push (org-point-in-group p 0 :timestamp) clist))
27815 ((memq 'org-link faces)
27816 (push (list :link
27817 (previous-single-property-change p 'face)
27818 (next-single-property-change p 'face)) clist))
27819 ((memq 'org-special-keyword faces)
27820 (push (list :keyword
27821 (previous-single-property-change p 'face)
27822 (next-single-property-change p 'face)) clist))
27823 ((org-on-target-p)
27824 (push (org-point-in-group p 0 :target) clist)
27825 (goto-char (1- (match-beginning 0)))
27826 (if (looking-at org-radio-target-regexp)
27827 (push (org-point-in-group p 0 :radio-target) clist))
27828 (goto-char p))
27829 ((setq o (car (delq nil
27830 (mapcar
27831 (lambda (x)
27832 (if (memq x org-latex-fragment-image-overlays) x))
27833 (org-overlays-at (point))))))
27834 (push (list :latex-fragment
27835 (org-overlay-start o) (org-overlay-end o)) clist)
27836 (push (list :latex-preview
27837 (org-overlay-start o) (org-overlay-end o)) clist))
27838 ((org-inside-LaTeX-fragment-p)
27839 ;; FIXME: positions wrong.
27840 (push (list :latex-fragment (point) (point)) clist)))
27842 (setq clist (nreverse (delq nil clist)))
27843 clist))
27845 ;; FIXME: Compare with at-regexp-p Do we need both?
27846 (defun org-in-regexp (re &optional nlines visually)
27847 "Check if point is inside a match of regexp.
27848 Normally only the current line is checked, but you can include NLINES extra
27849 lines both before and after point into the search.
27850 If VISUALLY is set, require that the cursor is not after the match but
27851 really on, so that the block visually is on the match."
27852 (catch 'exit
27853 (let ((pos (point))
27854 (eol (point-at-eol (+ 1 (or nlines 0))))
27855 (inc (if visually 1 0)))
27856 (save-excursion
27857 (beginning-of-line (- 1 (or nlines 0)))
27858 (while (re-search-forward re eol t)
27859 (if (and (<= (match-beginning 0) pos)
27860 (>= (+ inc (match-end 0)) pos))
27861 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27863 (defun org-at-regexp-p (regexp)
27864 "Is point inside a match of REGEXP in the current line?"
27865 (catch 'exit
27866 (save-excursion
27867 (let ((pos (point)) (end (point-at-eol)))
27868 (beginning-of-line 1)
27869 (while (re-search-forward regexp end t)
27870 (if (and (<= (match-beginning 0) pos)
27871 (>= (match-end 0) pos))
27872 (throw 'exit t)))
27873 nil))))
27875 (defun org-occur-in-agenda-files (regexp &optional nlines)
27876 "Call `multi-occur' with buffers for all agenda files."
27878 (let* ((files (org-agenda-files))
27879 (tnames (mapcar 'file-truename files))
27880 (extra org-agenda-text-search-extra-files)
27881 f)
27882 (while (setq f (pop extra))
27883 (unless (member (file-truename f) tnames)
27884 (add-to-list 'files f 'append)
27885 (add-to-list 'tnames (file-truename f) 'append)))
27886 (multi-occur
27887 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27888 regexp)))
27890 (if (boundp 'occur-mode-find-occurrence-hook)
27891 ;; Emacs 23
27892 (add-hook 'occur-mode-find-occurrence-hook
27893 (lambda ()
27894 (when (org-mode-p)
27895 (org-reveal))))
27896 ;; Emacs 22
27897 (defadvice occur-mode-goto-occurrence
27898 (after org-occur-reveal activate)
27899 (and (org-mode-p) (org-reveal)))
27900 (defadvice occur-mode-goto-occurrence-other-window
27901 (after org-occur-reveal activate)
27902 (and (org-mode-p) (org-reveal)))
27903 (defadvice occur-mode-display-occurrence
27904 (after org-occur-reveal activate)
27905 (when (org-mode-p)
27906 (let ((pos (occur-mode-find-occurrence)))
27907 (with-current-buffer (marker-buffer pos)
27908 (save-excursion
27909 (goto-char pos)
27910 (org-reveal)))))))
27912 (defun org-uniquify (list)
27913 "Remove duplicate elements from LIST."
27914 (let (res)
27915 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27916 res))
27918 (defun org-delete-all (elts list)
27919 "Remove all elements in ELTS from LIST."
27920 (while elts
27921 (setq list (delete (pop elts) list)))
27922 list)
27924 (defun org-back-over-empty-lines ()
27925 "Move backwards over witespace, to the beginning of the first empty line.
27926 Returns the number o empty lines passed."
27927 (let ((pos (point)))
27929 (beginning-of-line 2)
27930 (goto-char (min (point) pos))
27931 (count-lines (point) pos)))
27933 (defun org-skip-whitespace ()
27936 (defun org-point-in-group (point group &optional context)
27937 "Check if POINT is in match-group GROUP.
27938 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27939 match. If the match group does ot exist or point is not inside it,
27940 return nil."
27941 (and (match-beginning group)
27942 (>= point (match-beginning group))
27943 (<= point (match-end group))
27944 (if context
27945 (list context (match-beginning group) (match-end group))
27946 t)))
27948 (defun org-switch-to-buffer-other-window (&rest args)
27949 "Switch to buffer in a second window on the current frame.
27950 In particular, do not allow pop-up frames."
27951 (let (pop-up-frames special-display-buffer-names special-display-regexps
27952 special-display-function)
27953 (apply 'switch-to-buffer-other-window args)))
27955 (defun org-combine-plists (&rest plists)
27956 "Create a single property list from all plists in PLISTS.
27957 The process starts by copying the first list, and then setting properties
27958 from the other lists. Settings in the last list are the most significant
27959 ones and overrule settings in the other lists."
27960 (let ((rtn (copy-sequence (pop plists)))
27961 p v ls)
27962 (while plists
27963 (setq ls (pop plists))
27964 (while ls
27965 (setq p (pop ls) v (pop ls))
27966 (setq rtn (plist-put rtn p v))))
27967 rtn))
27969 (defun org-move-line-down (arg)
27970 "Move the current line down. With prefix argument, move it past ARG lines."
27971 (interactive "p")
27972 (let ((col (current-column))
27973 beg end pos)
27974 (beginning-of-line 1) (setq beg (point))
27975 (beginning-of-line 2) (setq end (point))
27976 (beginning-of-line (+ 1 arg))
27977 (setq pos (move-marker (make-marker) (point)))
27978 (insert (delete-and-extract-region beg end))
27979 (goto-char pos)
27980 (move-to-column col)))
27982 (defun org-move-line-up (arg)
27983 "Move the current line up. With prefix argument, move it past ARG lines."
27984 (interactive "p")
27985 (let ((col (current-column))
27986 beg end pos)
27987 (beginning-of-line 1) (setq beg (point))
27988 (beginning-of-line 2) (setq end (point))
27989 (beginning-of-line (- arg))
27990 (setq pos (move-marker (make-marker) (point)))
27991 (insert (delete-and-extract-region beg end))
27992 (goto-char pos)
27993 (move-to-column col)))
27995 (defun org-replace-escapes (string table)
27996 "Replace %-escapes in STRING with values in TABLE.
27998 The sequences in STRING may contain normal field width and padding information,
28000 so values can contain further %-escapes if they are define later in TABLE."
28001 (let ((case-fold-search nil)
28002 e re rpl)
28003 (while (setq e (pop table))
28004 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
28005 (while (string-match re string)
28006 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
28007 (cdr e)))
28008 (setq string (replace-match rpl t t string))))
28009 string))
28012 (defun org-sublist (list start end)
28013 "Return a section of LIST, from START to END.
28014 Counting starts at 1."
28015 (let (rtn (c start))
28016 (setq list (nthcdr (1- start) list))
28017 (while (and list (<= c end))
28018 (push (pop list) rtn)
28019 (setq c (1+ c)))
28020 (nreverse rtn)))
28022 (defun org-find-base-buffer-visiting (file)
28023 "Like `find-buffer-visiting' but alway return the base buffer and
28024 not an indirect buffer"
28025 (let ((buf (find-buffer-visiting file)))
28026 (if buf
28027 (or (buffer-base-buffer buf) buf)
28028 nil)))
28030 (defun org-image-file-name-regexp ()
28031 "Return regexp matching the file names of images."
28032 (if (fboundp 'image-file-name-regexp)
28033 (image-file-name-regexp)
28034 (let ((image-file-name-extensions
28035 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
28036 "xbm" "xpm" "pbm" "pgm" "ppm")))
28038 (regexp-opt (nconc (mapcar 'upcase
28039 image-file-name-extensions)
28040 image-file-name-extensions)
28041 t)
28044 (defun org-file-image-p (file)
28045 "Return non-nil if FILE is an image."
28046 (save-match-data
28047 (string-match (org-image-file-name-regexp) file)))
28049 ;;; Paragraph filling stuff.
28050 ;; We want this to be just right, so use the full arsenal.
28052 (defun org-indent-line-function ()
28053 "Indent line like previous, but further if previous was headline or item."
28054 (interactive)
28055 (let* ((pos (point))
28056 (itemp (org-at-item-p))
28057 column bpos bcol tpos tcol bullet btype bullet-type)
28058 ;; Find the previous relevant line
28059 (beginning-of-line 1)
28060 (cond
28061 ((looking-at "#") (setq column 0))
28063 (t
28064 (beginning-of-line 0)
28066 (beginning-of-line 0))
28067 (cond
28069 (goto-char (match-end 0))
28070 (setq column (current-column)))
28071 ((org-in-item-p)
28072 (org-beginning-of-item)
28075 (setq bpos (match-beginning 1) tpos (match-end 0)
28076 bcol (progn (goto-char bpos) (current-column))
28077 tcol (progn (goto-char tpos) (current-column))
28078 bullet (match-string 1)
28079 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
28080 (if (not itemp)
28081 (setq column tcol)
28082 (goto-char pos)
28083 (beginning-of-line 1)
28085 (progn
28087 (setq bullet (match-string 1)
28088 btype (if (string-match "[0-9]" bullet) "n" bullet))
28089 (setq column (if (equal btype bullet-type) bcol tcol)))
28090 (setq column (org-get-indentation)))))
28091 (t (setq column (org-get-indentation))))))
28092 (goto-char pos)
28093 (if (<= (current-column) (current-indentation))
28094 (indent-line-to column)
28095 (save-excursion (indent-line-to column)))
28096 (setq column (current-column))
28097 (beginning-of-line 1)
28098 (if (looking-at
28101 (match-string 2) (match-string 3)))
28102 t nil))
28103 (move-to-column column)))
28105 (defun org-set-autofill-regexps ()
28106 (interactive)
28107 ;; In the paragraph separator we include headlines, because filling
28108 ;; text in a line directly attached to a headline would otherwise
28109 ;; fill the headline as well.
28112 ;; The paragraph starter includes hand-formatted lists.
28113 (org-set-local 'paragraph-start
28115 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
28116 ;; But only if the user has not turned off tables or fixed-width regions
28117 (org-set-local
28118 'auto-fill-inhibit-regexp
28121 (if (or org-enable-table-editor org-enable-fixed-width-editor)
28122 (concat
28124 (if org-enable-table-editor "|" "")
28125 (if org-enable-fixed-width-editor ":" "")
28126 "]"))))
28127 ;; We use our own fill-paragraph function, to make sure that tables
28128 ;; and fixed-width regions are not wrapped. That function will pass
28129 ;; through to `fill-paragraph' when appropriate.
28130 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
28131 ; Adaptive filling: To get full control, first make sure that
28132 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
28134 (org-set-local 'adaptive-fill-function
28135 'org-adaptive-fill-function)
28136 (org-set-local
28137 'align-mode-rules-list
28138 '((org-in-buffer-settings
28140 (modes . '(org-mode))))))
28142 (defun org-fill-paragraph (&optional justify)
28143 "Re-align a table, pass through to fill-paragraph if no table."
28144 (let ((table-p (org-at-table-p))
28145 (table.el-p (org-at-table.el-p)))
28146 (cond ((and (equal (char-after (point-at-bol)) ?*)
28147 (save-excursion (goto-char (point-at-bol))
28148 (looking-at outline-regexp)))
28149 t) ; skip headlines
28150 (table.el-p t) ; skip table.el tables
28151 (table-p (org-table-align) t) ; align org-mode tables
28152 (t nil)))) ; call paragraph-fill
28154 ;; For reference, this is the default value of adaptive-fill-regexp
28157 (defun org-adaptive-fill-function ()
28158 "Return a fill prefix for org-mode files.
28159 In particular, this makes sure hanging paragraphs for hand-formatted lists
28160 work correctly."
28162 (match-string 0))
28164 (save-excursion
28165 (goto-char (match-end 0))
28166 (make-string (current-column) ?\ )))
28167 (t nil)))
28169 ;;;; Functions extending outline functionality
28172 (defun org-beginning-of-line (&optional arg)
28173 "Go to the beginning of the current line. If that is invisible, continue
28174 to a visible line beginning. This makes the function of C-a more intuitive.
28175 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28176 first attempt, and only move to after the tags when the cursor is already
28177 beyond the end of the headline."
28178 (interactive "P")
28179 (let ((pos (point)))
28180 (beginning-of-line 1)
28181 (if (bobp)
28182 nil
28183 (backward-char 1)
28184 (if (org-invisible-p)
28185 (while (and (not (bobp)) (org-invisible-p))
28186 (backward-char 1)
28187 (beginning-of-line 1))
28188 (forward-char 1)))
28189 (when org-special-ctrl-a/e
28190 (cond
28191 ((and (looking-at org-todo-line-regexp)
28192 (= (char-after (match-end 1)) ?\ ))
28193 (goto-char
28194 (if (eq org-special-ctrl-a/e t)
28195 (cond ((> pos (match-beginning 3)) (match-beginning 3))
28196 ((= pos (point)) (match-beginning 3))
28197 (t (point)))
28198 (cond ((> pos (point)) (point))
28199 ((not (eq last-command this-command)) (point))
28200 (t (match-beginning 3))))))
28201 ((org-at-item-p)
28202 (goto-char
28203 (if (eq org-special-ctrl-a/e t)
28204 (cond ((> pos (match-end 4)) (match-end 4))
28205 ((= pos (point)) (match-end 4))
28206 (t (point)))
28207 (cond ((> pos (point)) (point))
28208 ((not (eq last-command this-command)) (point))
28209 (t (match-end 4))))))))))
28211 (defun org-end-of-line (&optional arg)
28212 "Go to the end of the line.
28213 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28214 first attempt, and only move to after the tags when the cursor is already
28215 beyond the end of the headline."
28216 (interactive "P")
28217 (if (or (not org-special-ctrl-a/e)
28218 (not (org-on-heading-p)))
28219 (end-of-line arg)
28220 (let ((pos (point)))
28221 (beginning-of-line 1)
28223 (if (eq org-special-ctrl-a/e t)
28224 (if (or (< pos (match-beginning 1))
28225 (= pos (match-end 0)))
28226 (goto-char (match-beginning 1))
28227 (goto-char (match-end 0)))
28228 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
28229 (goto-char (match-end 0))
28230 (goto-char (match-beginning 1))))
28231 (end-of-line arg)))))
28233 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
28234 (define-key org-mode-map "\C-e" 'org-end-of-line)
28236 (defun org-kill-line (&optional arg)
28237 "Kill line, to tags or end of line."
28238 (interactive "P")
28239 (cond
28240 ((or (not org-special-ctrl-k)
28241 (bolp)
28242 (not (org-on-heading-p)))
28243 (call-interactively 'kill-line))
28245 (kill-region (point) (match-beginning 1))
28246 (org-set-tags nil t))
28247 (t (kill-region (point) (point-at-eol)))))
28249 (define-key org-mode-map "\C-k" 'org-kill-line)
28251 (defun org-invisible-p ()
28252 "Check if point is at a character currently not visible."
28253 ;; Early versions of noutline don't have `outline-invisible-p'.
28254 (if (fboundp 'outline-invisible-p)
28255 (outline-invisible-p)
28256 (get-char-property (point) 'invisible)))
28258 (defun org-invisible-p2 ()
28259 "Check if point is at a character currently not visible."
28260 (save-excursion
28261 (if (and (eolp) (not (bobp))) (backward-char 1))
28262 ;; Early versions of noutline don't have `outline-invisible-p'.
28263 (if (fboundp 'outline-invisible-p)
28264 (outline-invisible-p)
28265 (get-char-property (point) 'invisible))))
28267 (defalias 'org-back-to-heading 'outline-back-to-heading)
28268 (defalias 'org-on-heading-p 'outline-on-heading-p)
28269 (defalias 'org-at-heading-p 'outline-on-heading-p)
28270 (defun org-at-heading-or-item-p ()
28271 (or (org-on-heading-p) (org-at-item-p)))
28273 (defun org-on-target-p ()
28274 (or (org-in-regexp org-radio-target-regexp)
28275 (org-in-regexp org-target-regexp)))
28277 (defun org-up-heading-all (arg)
28278 "Move to the heading line of which the present line is a subheading.
28279 This function considers both visible and invisible heading lines.
28280 With argument, move up ARG levels."
28281 (if (fboundp 'outline-up-heading-all)
28282 (outline-up-heading-all arg) ; emacs 21 version of outline.el
28283 (outline-up-heading arg t))) ; emacs 22 version of outline.el
28285 (defun org-up-heading-safe ()
28286 "Move to the heading line of which the present line is a subheading.
28287 This version will not throw an error. It will return the level of the
28288 headline found, or nil if no higher level is found."
28289 (let ((pos (point)) start-level level
28290 (re (concat "^" outline-regexp)))
28291 (catch 'exit
28292 (outline-back-to-heading t)
28293 (setq start-level (funcall outline-level))
28294 (if (equal start-level 1) (throw 'exit nil))
28295 (while (re-search-backward re nil t)
28296 (setq level (funcall outline-level))
28297 (if (< level start-level) (throw 'exit level)))
28298 nil)))
28300 (defun org-first-sibling-p ()
28301 "Is this heading the first child of its parents?"
28302 (interactive)
28303 (let ((re (concat "^" outline-regexp))
28304 level l)
28305 (unless (org-at-heading-p t)
28306 (error "Not at a heading"))
28307 (setq level (funcall outline-level))
28308 (save-excursion
28309 (if (not (re-search-backward re nil t))
28310 t
28311 (setq l (funcall outline-level))
28312 (< l level)))))
28314 (defun org-goto-sibling (&optional previous)
28315 "Goto the next sibling, even if it is invisible.
28316 When PREVIOUS is set, go to the previous sibling instead. Returns t
28317 when a sibling was found. When none is found, return nil and don't
28318 move point."
28319 (let ((fun (if previous 're-search-backward 're-search-forward))
28320 (pos (point))
28321 (re (concat "^" outline-regexp))
28322 level l)
28323 (when (condition-case nil (org-back-to-heading t) (error nil))
28324 (setq level (funcall outline-level))
28325 (catch 'exit
28326 (or previous (forward-char 1))
28327 (while (funcall fun re nil t)
28328 (setq l (funcall outline-level))
28329 (when (< l level) (goto-char pos) (throw 'exit nil))
28330 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28331 (goto-char pos)
28332 nil))))
28334 (defun org-show-siblings ()
28335 "Show all siblings of the current headline."
28336 (save-excursion
28337 (while (org-goto-sibling) (org-flag-heading nil)))
28338 (save-excursion
28339 (while (org-goto-sibling 'previous)
28340 (org-flag-heading nil))))
28342 (defun org-show-hidden-entry ()
28343 "Show an entry where even the heading is hidden."
28344 (save-excursion
28345 (org-show-entry)))
28347 (defun org-flag-heading (flag &optional entry)
28348 "Flag the current heading. FLAG non-nil means make invisible.
28349 When ENTRY is non-nil, show the entire entry."
28350 (save-excursion
28351 (org-back-to-heading t)
28352 ;; Check if we should show the entire entry
28353 (if entry
28354 (progn
28355 (org-show-entry)
28356 (save-excursion
28357 (and (outline-next-heading)
28358 (org-flag-heading nil))))
28359 (outline-flag-region (max (point-min) (1- (point)))
28360 (save-excursion (outline-end-of-heading) (point))
28361 flag))))
28363 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28364 ;; This is an exact copy of the original function, but it uses
28365 ;; `org-back-to-heading', to make it work also in invisible
28366 ;; trees. And is uses an invisible-OK argument.
28367 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28368 (org-back-to-heading invisible-OK)
28369 (let ((first t)
28370 (level (funcall outline-level)))
28371 (while (and (not (eobp))
28372 (or first (> (funcall outline-level) level)))
28373 (setq first nil)
28374 (outline-next-heading))
28375 (unless to-heading
28377 (progn
28378 ;; Go to end of line before heading
28379 (forward-char -1)
28381 ;; leave blank line before heading
28382 (forward-char -1))))))
28383 (point))
28385 (defun org-show-subtree ()
28386 "Show everything after this heading at deeper levels."
28387 (outline-flag-region
28388 (point)
28389 (save-excursion
28390 (outline-end-of-subtree) (outline-next-heading) (point))
28391 nil))
28393 (defun org-show-entry ()
28394 "Show the body directly following this heading.
28395 Show the heading too, if it is currently invisible."
28396 (interactive)
28397 (save-excursion
28398 (condition-case nil
28399 (progn
28400 (org-back-to-heading t)
28401 (outline-flag-region
28402 (max (point-min) (1- (point)))
28403 (save-excursion
28404 (re-search-forward
28406 (or (match-beginning 1) (point-max)))
28407 nil))
28408 (error nil))))
28410 (defun org-make-options-regexp (kwds)
28411 "Make a regular expression for keyword lines."
28412 (concat
28413 "^"
28419 ;; Make isearch reveal the necessary context
28420 (defun org-isearch-end ()
28421 "Reveal context after isearch exits."
28422 (when isearch-success ; only if search was successful
28423 (if (featurep 'xemacs)
28424 ;; Under XEmacs, the hook is run in the correct place,
28425 ;; we directly show the context.
28426 (org-show-context 'isearch)
28427 ;; In Emacs the hook runs *before* restoring the overlays.
28428 ;; So we have to use a one-time post-command-hook to do this.
28429 ;; (Emacs 22 has a special variable, see function `org-mode')
28430 (unless (and (boundp 'isearch-mode-end-hook-quit)
28431 isearch-mode-end-hook-quit)
28432 ;; Only when the isearch was not quitted.
28433 (org-add-hook 'post-command-hook 'org-isearch-post-command
28434 'append 'local)))))
28436 (defun org-isearch-post-command ()
28437 "Remove self from hook, and show context."
28438 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28439 (org-show-context 'isearch))
28442 ;;;; Integration with and fixes for other packages
28444 ;;; Imenu support
28446 (defvar org-imenu-markers nil
28447 "All markers currently used by Imenu.")
28448 (make-variable-buffer-local 'org-imenu-markers)
28450 (defun org-imenu-new-marker (&optional pos)
28451 "Return a new marker for use by Imenu, and remember the marker."
28452 (let ((m (make-marker)))
28453 (move-marker m (or pos (point)))
28454 (push m org-imenu-markers)
28455 m))
28457 (defun org-imenu-get-tree ()
28458 "Produce the index for Imenu."
28459 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28460 (setq org-imenu-markers nil)
28461 (let* ((n org-imenu-depth)
28462 (re (concat "^" outline-regexp))
28463 (subs (make-vector (1+ n) nil))
28464 (last-level 0)
28465 m tree level head)
28466 (save-excursion
28467 (save-restriction
28468 (widen)
28469 (goto-char (point-max))
28470 (while (re-search-backward re nil t)
28471 (setq level (org-reduced-level (funcall outline-level)))
28472 (when (<= level n)
28473 (looking-at org-complex-heading-regexp)
28474 (setq head (org-match-string-no-properties 4)
28475 m (org-imenu-new-marker))
28476 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28477 (if (>= level last-level)
28478 (push (cons head m) (aref subs level))
28479 (push (cons head (aref subs (1+ level))) (aref subs level))
28480 (loop for i from (1+ level) to n do (aset subs i nil)))
28481 (setq last-level level)))))
28482 (aref subs 1)))
28484 (eval-after-load "imenu"
28485 '(progn
28486 (add-hook 'imenu-after-jump-hook
28487 (lambda () (org-show-context 'org-goto)))))
28489 ;; Speedbar support
28491 (defun org-speedbar-set-agenda-restriction ()
28492 "Restrict future agenda commands to the location at point in speedbar.
28494 (interactive)
28495 (let (p m tp np dir txt w)
28496 (cond
28497 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28498 'org-imenu t))
28499 (setq m (get-text-property p 'org-imenu-marker))
28500 (save-excursion
28501 (save-restriction
28502 (set-buffer (marker-buffer m))
28503 (goto-char m)
28504 (org-agenda-set-restriction-lock 'subtree))))
28505 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28506 'speedbar-function 'speedbar-find-file))
28507 (setq tp (previous-single-property-change
28508 (1+ p) 'speedbar-function)
28509 np (next-single-property-change
28510 tp 'speedbar-function)
28511 dir (speedbar-line-directory)
28512 txt (buffer-substring-no-properties (or tp (point-min))
28513 (or np (point-max))))
28514 (save-excursion
28515 (save-restriction
28516 (set-buffer (find-file-noselect
28517 (let ((default-directory dir))
28518 (expand-file-name txt))))
28519 (unless (org-mode-p)
28520 (error "Cannot restrict to non-Org-mode file"))
28521 (org-agenda-set-restriction-lock 'file))))
28522 (t (error "Don't know how to restrict Org-mode's agenda")))
28523 (org-move-overlay org-speedbar-restriction-lock-overlay
28524 (point-at-bol) (point-at-eol))
28525 (setq current-prefix-arg nil)
28526 (org-agenda-maybe-redo)))
28528 (eval-after-load "speedbar"
28529 '(progn
28530 (speedbar-add-supported-extension ".org")
28531 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28532 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28533 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28534 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28535 (add-hook 'speedbar-visiting-tag-hook
28536 (lambda () (org-show-context 'org-goto)))))
28539 ;;; Fixes and Hacks
28541 ;; Make flyspell not check words in links, to not mess up our keymap
28542 (defun org-mode-flyspell-verify ()
28543 "Don't let flyspell put overlays at active buttons."
28544 (not (get-text-property (point) 'keymap)))
28546 ;; Make `bookmark-jump' show the jump location if it was hidden.
28547 (eval-after-load "bookmark"
28548 '(if (boundp 'bookmark-after-jump-hook)
28549 ;; We can use the hook
28550 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28551 ;; Hook not available, use advice
28552 (defadvice bookmark-jump (after org-make-visible activate)
28553 "Make the position visible."
28554 (org-bookmark-jump-unhide))))
28556 (defun org-bookmark-jump-unhide ()
28557 "Unhide the current position, to show the bookmark location."
28558 (and (org-mode-p)
28559 (or (org-invisible-p)
28560 (save-excursion (goto-char (max (point-min) (1- (point))))
28561 (org-invisible-p)))
28562 (org-show-context 'bookmark-jump)))
28564 ;; Fix a bug in htmlize where there are text properties (face nil)
28565 (eval-after-load "htmlize"
28566 '(progn
28567 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28568 "Make sure there are no nil faces"
28569 (setq ad-return-value (delq nil ad-return-value)))))
28571 ;; Make session.el ignore our circular variable
28572 (eval-after-load "session"
28573 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28575 ;;;; Experimental code
28577 (defun org-closed-in-range ()
28578 "Sparse tree of items closed in a certain time range.
28579 Still experimental, may disappear in the future."
28580 (interactive)
28581 ;; Get the time interval from the user.
28582 (let* ((time1 (time-to-seconds
28583 (org-read-date nil 'to-time nil "Starting date: ")))
28584 (time2 (time-to-seconds
28585 (org-read-date nil 'to-time nil "End date:")))
28586 ;; callback function
28587 (callback (lambda ()
28588 (let ((time
28589 (time-to-seconds
28590 (apply 'encode-time
28591 (org-parse-time-string
28592 (match-string 1))))))
28593 ;; check if time in interval
28594 (and (>= time time1) (<= time time2))))))
28595 ;; make tree, check each match with the callback
28598 ;;;; Finish up
28600 (provide 'org)
28602 (run-hooks 'org-load-hook)
28604 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28605 ;;; org.el ends here