| blob | 4498a171583bf6a02148966fd20234605b09c556 |
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."
160 "Extensions that should always be loaded together with org.el.
161 If the description starts with <A>, this means the extension
162 will be autoloaded when needed, preloading is not necessary."
164 :type
173 "Load all extensions listed in `org-default-extensions'."
177 org-default-extensions))
181 ;; FIXME: Needs a separate group...
184 Normal means, no org-mode-specific context."
189 "Options concerning startup of Org-mode."
194 "Non-nil means, entering Org-mode will switch to OVERVIEW.
195 This can also be configured on a per-file basis by adding one of
196 the following lines anywhere in the buffer:
198 #+STARTUP: fold
199 #+STARTUP: nofold
200 #+STARTUP: content"
208 "Non-nil means, entering Org-mode will set `truncate-lines'.
209 This is useful since some lines containing links can be very long and
210 uninteresting. Also tables look terrible when wrapped."
215 "Non-nil means, align all tables when visiting a file.
216 This is useful when the column width in tables is forced with <N> cookies
217 in table fields. Such tables will look correct only after the first re-align.
218 This can also be configured on a per-file basis by adding one of
219 the following lines anywhere in the buffer:
220 #+STARTUP: align
221 #+STARTUP: noalign"
226 "Non-nil means insert the first line setting Org-mode in empty files.
227 When the function `org-mode' is called interactively in an empty file, this
228 normally means that the file name does not automatically trigger Org-mode.
229 To ensure that the file will always be in Org-mode in the future, a
230 line enforcing Org-mode will be inserted into the buffer, if this option
231 has been set."
236 "Non-nil means use alternative key bindings for some keys.
237 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
238 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
239 If you want to use Org-mode together with one of these other modes,
240 or more generally if you would like to move some Org-mode commands to
241 other keys, set this variable and configure the keys with the variable
242 `org-disputed-keys'.
244 This option is only relevant at load-time of Org-mode, and must be set
245 *before* org.el is loaded. Changing it requires a restart of Emacs to
246 become effective."
260 "Keys for which Org-mode and other modes compete.
261 This is an alist, cars are the default keys, second element specifies
262 the alternative to use when `org-replace-disputed-keys' is t.
264 Keys can be specified in any syntax supported by `define-key'.
265 The value of this option takes effect only at Org-mode's startup,
266 therefore you'll have to restart Emacs to apply it after changing."
271 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
272 Or return the original if not disputed."
277 org-disputed-keys)))
279 key))
289 "Define a key, possibly translated, as returned by `org-key'."
293 "The ellipsis to use in the Org-mode outline.
294 When nil, just use the standard three dots. When a string, use that instead,
295 When a face, use the standart 3 dots, but with the specified face.
296 The change affects only Org-mode (which will then use its own display table).
297 Changing this requires executing `M-x org-mode' in a buffer to become
298 effective."
308 "Keywords in Org-mode."
313 "String to mark deadline entries.
314 A deadline is this string, followed by a time stamp. Should be a word,
315 terminated by a colon. You can insert a schedule keyword and
317 Changes become only effective after restarting Emacs."
322 "String to mark scheduled TODO entries.
323 A schedule is this string, followed by a time stamp. Should be a word,
324 terminated by a colon. You can insert a schedule keyword and
326 Changes become only effective after restarting Emacs."
331 "String used as the prefix for timestamps logging closing a TODO entry."
336 "String used as prefix for timestamps clocking work hours on an item."
341 "Entries starting with this keyword will never be exported.
342 An entry can be toggled between COMMENT and normal with
344 Changes become only effective after restarting Emacs."
349 "Entries starting with this keyword will be exported in fixed-width font.
350 Quoting applies only to the text in the entry following the headline, and does
351 not extend beyond the next headline, even if that is lower level.
352 An entry can be toggled between QUOTE and normal with
359 "Regular expression for specifying repeated events.
363 "Options concerning the general structure of Org-mode files."
368 "Options about how to make context of a location visible."
392 "Non-nil means, show full hierarchy when revealing a location.
393 Org-mode often shows locations in an org-mode file which might have
394 been invisible before. When this is set, the hierarchy of headings
395 above the exposed location is shown.
396 Turning this off for example for sparse trees makes them very compact.
397 Instead of t, this can also be an alist specifying this option for different
398 contexts. Valid contexts are
399 agenda when exposing an entry from the agenda
400 org-goto when using the command `org-goto' on key C-c C-j
401 occur-tree when using the command `org-occur' on key C-c /
402 tags-tree when constructing a sparse tree based on tags matches
403 link-search when exposing search matches associated with a link
404 mark-goto when exposing the jump goal of a mark
405 bookmark-jump when exposing a bookmark location
406 isearch when exiting from an incremental search
407 default default for all contexts not set explicitly"
412 "Non-nil means, show following heading when revealing a location.
413 Org-mode often shows locations in an org-mode file which might have
414 been invisible before. When this is set, the heading following the
415 match is shown.
416 Turning this off for example for sparse trees makes them very compact,
417 but makes it harder to edit the location of the match. In such a case,
419 Instead of t, this can also be an alist specifying this option for different
420 contexts. See `org-show-hierarchy-above' for valid contexts."
425 "Non-nil means, show all sibling heading when revealing a location.
426 Org-mode often shows locations in an org-mode file which might have
427 been invisible before. When this is set, the sibling of the current entry
428 heading are all made visible. If `org-show-hierarchy-above' is t,
429 the same happens on each level of the hierarchy above the current entry.
431 By default this is on for the isearch context, off for all other contexts.
432 Turning this off for example for sparse trees makes them very compact,
433 but makes it harder to edit the location of the match. In such a case,
435 Instead of t, this can also be an alist specifying this option for different
436 contexts. See `org-show-hierarchy-above' for valid contexts."
441 "Non-nil means, show the entry below a headline when revealing a location.
442 Org-mode often shows locations in an org-mode file which might have
443 been invisible before. When this is set, the text below the headline that is
444 exposed is also shown.
446 By default this is off for all contexts.
447 Instead of t, this can also be an alist specifying this option for different
448 contexts. See `org-show-hierarchy-above' for valid contexts."
453 "Options concerning visibility cycling in Org-mode."
458 "Names of drawers. Drawers are not opened by cycling on the headline above.
459 Drawers only open with a TAB on the drawer line itself. A drawer looks like
460 this:
461 :DRAWERNAME:
462 .....
463 :END:
465 the property API.
467 Drawers can be defined on the per-file basis with a line like:
469 #+DRAWERS: HIDDEN STATE PROPERTIES"
474 "Cycle globally if cursor is at beginning of buffer and not at a headline.
475 This makes it possible to do global cycling without having to use S-TAB or
476 C-u TAB. For this special case to work, the first line of the buffer
477 must not be a headline - it may be empty ot some other text. When used in
478 this way, `org-cycle-hook' is disables temporarily, to make sure the
479 cursor stays at the beginning of the buffer.
480 When this option is nil, don't do anything special at the beginning
481 of the buffer."
486 "Where should `org-cycle' emulate TAB.
487 nil Never
488 white Only in completely white lines
489 whitestart Only at the beginning of lines, before the first non-white char
490 t Everywhere except in headlines
491 exc-hl-bol Everywhere except at the start of a headline
492 If TAB is used in a place where it does not emulate TAB, the current subtree
493 visibility is cycled."
500 ))
503 "Number of empty lines needed to keep an empty line between collapsed trees.
504 If you leave an empty line between the end of a subtree and the following
505 headline, this empty line is hidden when the subtree is folded.
506 Org-mode will leave (exactly) one empty line visible if the number of
507 empty lines is equal or larger to the number given in this variable.
508 So the default 2 means, at least 2 empty lines after the end of a subtree
509 are needed to produce free space between a collapsed subtree and the
510 following headline.
512 Special case: when 0, never leave empty lines in collapsed view."
517 org-cycle-hide-drawers
518 org-cycle-show-empty-lines
519 org-optimize-window-after-visibility-change)
520 "Hook that is run after `org-cycle' has changed the buffer visibility.
521 The function(s) in this hook must accept a single argument which indicates
522 the new state that was set by the most recent `org-cycle' command. The
523 argument is a symbol. After a global state change, it can have the values
524 `overview', `content', or `all'. After a local state change, it can have
525 the values `folded', `children', or `subtree'."
530 "Options concerning structure editing in Org-mode."
535 "Non-nil means, skip even levels and only use odd levels for the outline.
536 This has the effect that two stars are being added/taken away in
537 promotion/demotion commands. It also influences how levels are
538 handled by the exporters.
539 Changing it requires restart of `font-lock-mode' to become effective
540 for fontification also in regions already fontified.
541 You may also set this on a per-file basis by adding one of the following
542 lines to the buffer:
544 #+STARTUP: odd
545 #+STARTUP: oddeven"
551 "Non-nil means, adapt indentation when promoting and demoting.
552 When this is set and the *entire* text in an entry is indented, the
553 indentation is increased by one space in a demotion command, and
554 decreased by one in a promotion command. If any line in the entry
555 body starts at column 0, indentation is not changed at all."
560 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
561 When t, `C-a' will bring back the cursor to the beginning of the
562 headline text, i.e. after the stars and after a possible TODO keyword.
563 In an item, this will be the position after the bullet.
564 When the cursor is already at that position, another `C-a' will bring
565 it to the beginning of the line.
566 `C-e' will jump to the end of the headline, ignoring the presence of tags
567 in the headline. A second `C-e' will then jump to the true end of the
568 line, after any tags.
569 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
570 and only a directly following, identical keypress will bring the cursor
571 to the special positions."
582 "Non-nil means `C-k' will behave specially in headlines.
583 When nil, `C-k' will call the default `kill-line' command.
584 When t, the following will happen while the cursor is in the headline:
586 - When the cursor is at the beginning of a headline, kill the entire
587 line and possible the folded subtree below the line.
588 - When in the middle of the headline text, kill the headline up to the tags.
589 - When after the headline text, kill the tags."
594 "Non-nil means, M-RET will split the line at the cursor position.
595 When nil, it will go to the end of the line before making a
596 new line.
597 You may also set this option in a different way for different
598 contexts. Valid contexts are:
600 headline when creating a new headline
601 item when creating a new item
602 table in a table field
603 default the value to be used for all contexts not explicitly
604 customized"
622 "Should `org-insert-heading' leave a blank line before new heading/item?
623 The value is an alist, with `heading' and `plain-list-item' as car,
624 and a boolean flag as cdr."
631 "Hook being run after inserting a new heading."
637 This currently only means, they are never auto-wrapped.
638 When nil, such lines will be treated like ordinary lines.
639 See also the QUOTE keyword."
644 "Non-nil means, typing characters in org-goto starts incremental search."
649 "Options concerning sparse trees in Org-mode."
654 "Non-nil means, highlight all matches that define a sparse tree.
655 The highlights will automatically disappear the next time the buffer is
656 changed by an edit command."
661 "Non-nil means, any change to the buffer will remove temporary highlights.
662 Such highlights are created by `org-occur' and `org-clock-display'.
663 When nil, `C-c C-c needs to be used to get rid of the highlights.
664 The highlights created by `org-preview-latex-fragment' always need
665 `C-c C-c' to be removed."
672 "Hook that is run after `org-occur' has constructed a sparse tree.
673 This can be used to recenter the window to show as much of the structure
674 as possible."
679 "Options concerning plain lists in Org-mode."
684 "Non-nil means, include plain lists into visibility cycling.
685 This means that during cycling, plain list items will *temporarily* be
686 interpreted as outline headlines with a level given by 1000+i where i is the
687 indentation of the bullet. In all other operations, plain list items are
688 not seen as headlines. For example, you cannot assign a TODO keyword to
689 such an item."
694 "The character that makes a line with leading number an ordered list item.
695 Valid values are ?. and ?\). To get both terminators, use t. While
696 ?. may look nicer, it creates the danger that a line with leading
697 number may be incorrectly interpreted as an item. ?\) therefore is
698 the safe choice."
705 "Non-nil means, automatically renumber ordered plain lists.
706 Renumbering happens when the sequence have been changed with
713 "Non-nil means, update checkbox statistics after insert and toggle.
714 When this is set, checkbox statistics is updated each time you either insert
721 "Options concerning archiving in Org-mode."
726 "The tag that marks a subtree as archived.
727 An archived subtree does not open during visibility cycling, and does
728 not contribute to the agenda listings.
729 After changing this, font-lock must be restarted in the relevant buffers to
730 get the proper fontification."
736 "Non-nil means, the agenda will skip any items located in archived trees.
737 An archived tree is a tree marked with the tag ARCHIVE."
743 "Non-nil means, `org-cycle' will open archived trees.
744 An archived tree is a tree marked with the tag ARCHIVE.
745 When nil, archived trees will stay folded. You can still open them with
746 normal outline commands like `show-all', but not with the cycling commands."
752 "Non-nil means sparse tree construction shows matches in archived trees.
753 When nil, matches in these trees are highlighted, but the trees are kept in
754 collapsed state."
760 "The location where subtrees should be archived.
761 This string consists of two parts, separated by a double-colon.
763 The first part is a file name - when omitted, archiving happens in the same
764 file. %s will be replaced by the current file name (without directory part).
765 Archiving to a different file is useful to keep archived entries from
766 contributing to the Org-mode Agenda.
768 The part after the double colon is a headline. The archived entries will be
769 filed under that headline. When omitted, the subtrees are simply filed away
770 at the end of the file, as top-level entries.
772 Here are a few examples:
774 If the current file is Projects.org, archive in file
775 Projects.org_archive, as top-level trees. This is the default.
778 Archive in the current file, under the top-level headline
782 Archive in file ~/org/archive.org (absolute path), as top-level trees.
785 Archive in file ./basement (relative path), as level 3 trees
788 You may set this option on a per-file basis by adding to the buffer a
789 line like
791 #+ARCHIVE: basement::** Finished Tasks"
796 "Non-nil means, mark entries as DONE when they are moved to the archive file.
797 This can be a string to set the keyword to use. When t, Org-mode will
798 use the first keyword in its list that means done."
806 "Non-nil means, add a time stamp to entries moved to an archive file.
807 This variable is obsolete and has no effect anymore, instead add ot remove
808 `time' from the variablle `org-archive-save-context-info'."
813 "Parts of context info that should be stored as properties when archiving.
814 When a subtree is moved to an archive file, it looses information given by
815 context, like inherited tags, the category, and possibly also the TODO
816 state (depending on the variable `org-archive-mark-done').
817 This variable can be a list of any of the following symbols:
819 time The time of archiving.
820 file The file where the entry originates.
821 itags The local tags, in the headline of the subtree.
822 ltags The tags the subtree inherits from further up the hierarchy.
823 todo The pre-archive TODO state.
824 category The category, taken from file name or #+CATEGORY lines.
825 olpath The outline path to the item. These are all headlines above
826 the current item, separated by /, like a file path.
828 For each symbol present in the list, a property will be created in
830 information."
843 "Options concerning imenu and speedbar in Org-mode."
848 "The maximum level for Imenu access to Org-mode headlines.
849 This also applied for speedbar access."
854 "Options concerning tables in Org-mode."
860 When nil, such lines will be treated like ordinary lines.
862 When equal to the symbol `optimized', the table editor will be optimized to
863 do the following:
864 - Automatic overwrite mode in front of whitespace in table fields.
865 This makes the structure of the table stay in tact as long as the edited
866 field does not exceed the column width.
867 - Minimize the number of realigns. Normally, the table is aligned each time
868 TAB or RET are pressed to move to another field. With optimization this
869 happens only if changes to a field might have changed the column width.
870 Optimization requires replacing the functions `self-insert-command',
871 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
872 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
873 very good at guessing when a re-align will be necessary, but you can always
876 If you would like to use the optimized version in Org-mode, but the
877 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
879 This variable can be used to turn on and off the table editor during a session,
880 but in order to toggle optimization, a restart is required.
882 See also the variable `org-table-auto-blank-field'."
890 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
891 In the optimized version, the table editor takes over all simple keys that
892 normally just insert a character. In tables, the characters are inserted
893 in a way to minimize disturbing the table structure (i.e. in overwrite mode
894 for empty fields). Outside tables, the correct binding of the keys is
895 restored.
897 The default for this option is t if the optimized version is also used in
898 Org-mode. See the variable `org-enable-table-editor' for details. Changing
899 this variable requires a restart of Emacs to become effective."
905 % END RECEIVE ORGTBL %n
907 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
908 | | |
911 @c END RECEIVE ORGTBL %n
912 @ignore
913 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
914 | | |
917 <!-- END RECEIVE ORGTBL %n -->
918 <!--
919 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
920 | | |
922 "Templates for radio tables in different major modes.
923 All occurrences of %n in a template will be replaced with the name of the
924 table, obtained by prompting the user."
931 "Settings for tables in Org-mode."
936 "The default size for newly created tables, Columns x Rows."
942 "Regular expression for recognizing numbers in table columns.
943 If a table column contains mostly numbers, it will be aligned to the
944 right. If not, it will be aligned to the left.
946 The default value of this option is a regular expression which allows
947 anything which looks remotely like a number as used in scientific
948 context. For example, all of the following will be considered a
949 number:
950 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
952 Other options offered by the customize interface are more restrictive."
970 "Fraction of numbers in a column required to make the column align right.
971 In a column all non-white fields are considered. If at least this
972 fraction of fields is matched by `org-table-number-fraction',
973 alignment to the right border applies."
978 "Behavior of tables during editing in Org-mode."
983 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
985 removal/insertion."
990 "Non-nil means, automatically blank table field when starting to type into it.
991 This only happens when typing immediately after a field motion
992 command (TAB, S-TAB or RET).
993 Only relevant when `org-enable-table-editor' is equal to `optimized'."
998 "Non-nil means, tab in the last column of a table with jump over a hline.
999 If a horizontal separator line is following the current line,
1000 `org-table-next-field' can either create a new row before that line, or jump
1001 over the line. When this option is nil, a new line will be created before
1002 this line."
1007 "Non-nil means, TAB will automatically notice a table.el table.
1008 When it sees such a table, it moves point into it and - if necessary -
1009 calls `table-recognize-table'."
1014 "Options concerning tables in Org-mode."
1019 "Should org-mode work with table refrences like B3 instead of @3$2?
1020 Possible values are:
1021 nil never use them
1022 from accept as input, do not present for editing
1023 t: accept as input and present for editing"
1038 calc-angle-mode deg
1039 calc-prefer-frac nil
1040 calc-symbolic-mode nil
1042 calc-display-working-message t
1043 )
1044 "List with Calc mode settings for use in calc-eval for table formulas.
1045 The list must contain alternating symbols (Calc modes variables and values).
1046 Don't remove any of the default settings, just change the values. Org-mode
1047 relies on the variables to be present in the list."
1052 "Non-nil means, TAB and RET evaluate a formula in current table field.
1053 If the current field starts with an equal sign, it is assumed to be a formula
1054 which should be evaluated as described in the manual and in the documentation
1055 string of the command `org-table-eval-formula'. This feature requires the
1056 Emacs calc package.
1057 When this variable is nil, formula calculation is only available through
1063 "Non-nil means, interpret constants in formulas in tables.
1064 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1065 by the value given in `org-table-formula-constants', or by a value obtained
1066 from the `constants.el' package."
1071 "Alist with constant names and values, for use in table formulas.
1072 The car of each element is a name of a constant, without the `$' before it.
1073 The cdr is the value as a string. For example, if you'd like to use the
1074 speed of light in a formula, you would configure
1078 and then use it in an equation like `$1*$c'.
1080 Constants can also be defined on a per-file basis using a line like
1082 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1093 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1094 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1099 "Options concerning links in Org-mode."
1104 "Buffer-local version of `org-link-abbrev-alist', which see.
1109 "Alist of link abbreviations.
1110 The car of each element is a string, to be replaced at the start of a link.
1112 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1114 [[linkkey:tag][description]]
1116 If REPLACE is a string, the tag will simply be appended to create the link.
1119 REPLACE may also be a function that will be called with the tag as the
1120 only argument to create the link, which should be returned as a string.
1122 See the manual for examples."
1127 "Non-nil means, hide link part and only show description of bracket links.
1128 Bracket links are like [[link][descritpion]]. This variable sets the initial
1129 state in new org-mode buffers. The setting can then be toggled on a
1130 per-buffer basis from the Org->Hyperlinks menu."
1135 "How the path name in file links should be stored.
1136 Valid values are:
1138 relative Relative to the current directory, i.e. the directory of the file
1139 into which the link is being inserted.
1140 absolute Absolute path, if possible with ~ for home directory.
1141 noabbrev Absolute path, no abbreviation of home directory.
1142 adaptive Use relative path for files in the current directory and sub-
1143 directories of it. For other files, use an absolute path."
1152 "Types of links that should be activated in Org-mode files.
1153 This is a list of symbols, each leading to the activation of a certain link
1154 type. In principle, it does not hurt to turn on most link types - there may
1155 be a small gain when turning off unused link types. The types are:
1157 bracket The recommended [[link][description]] or [[link]] links with hiding.
1158 angular Links in angular brackes that may contain whitespace like
1159 <bbdb:Carsten Dominik>.
1160 plain Plain links in normal text, no whitespace, like http://google.com.
1161 radio Text that is matched by a radio target, see manual for details.
1162 tag Tag settings in a headline (link to tag search).
1163 date Time stamps (link to calendar).
1165 Changing this variable requires a restart of Emacs to become effective."
1175 "Options concerning storing links in Org-mode"
1180 "Format of the description part of a link to an email or usenet message.
1181 The following %-excapes will be replaced by corresponding information:
1189 %s subject
1190 %m message-id.
1192 You may use normal field width specification between the % and the letter.
1193 This is for example useful to limit the length of the subject.
1207 It should match if the message is from the user him/herself."
1212 "Non-nil means, file links from `org-store-link' contain context.
1213 A search string will be added to the file name with :: as separator and
1214 used to find the context when the link is activated by the command
1215 `org-open-at-point'.
1217 negates this setting for the duration of the command."
1222 "Non-nil means, keep link in list for entire session.
1224 The command `org-store-link' adds a link pointing to the current
1225 location to an internal list. These links accumulate during a session.
1226 The command `org-insert-link' can be used to insert links into any
1227 Org-mode file (offering completion for all stored links). When this
1229 will be removed from the list, to make completing the unused links
1230 more efficient."
1235 "Non-nil means, `org-store-link' will create web links to Google groups.
1236 When nil, Gnus will be used for such links.
1238 negates this setting for the duration of the command."
1243 "Options concerning following links in Org-mode"
1248 "Hook that is run after a link has been followed."
1253 "Non-nil means, on links TAB will follow the link.
1254 Needs to be set before org.el is loaded."
1259 "Non-nil means, on links RET will follow the link.
1260 Needs to be set before org.el is loaded."
1266 "Non-nil means, mouse-1 on a link will follow the link.
1267 A longer mouse click will still set point. Does not work on XEmacs.
1268 Needs to be set before org.el is loaded."
1273 "Number of different positions to be recorded in the ring
1274 Changing this requires a restart of Emacs to work correctly."
1282 "Setup the frame configuration for following links.
1283 When following a link with Emacs, it may often be useful to display
1284 this link in another window or frame. This variable can be used to
1285 set this up for the different types of links.
1286 For VM, use any of
1287 `vm-visit-folder'
1288 `vm-visit-folder-other-frame'
1289 For Gnus, use any of
1290 `gnus'
1291 `gnus-other-frame'
1292 For FILE, use any of
1293 `find-file'
1294 `find-file-other-window'
1295 `find-file-other-frame'
1296 For the calendar, use the variable `calendar-setup'.
1297 For BBDB, it is currently only possible to display the matches in
1298 another window."
1317 "Non-nil means, use indirect buffer to display infile links.
1318 Activating internal links (from one location in a file to another location
1319 in the same file) normally just jumps to the location. When the link is
1320 activated with a C-u prefix (or with mouse-3), the link is displayed in
1321 another window. When this option is set, the other window actually displays
1322 an indirect buffer clone of the current buffer, to avoid any visibility
1323 changes to the current buffer."
1328 "Non-nil means, `org-open-file' will open non-existing files.
1329 When nil, an error will be generated."
1334 "Function and arguments to call for following mailto links.
1335 This is a list with the first element being a lisp function, and the
1336 remaining elements being arguments to the function. In string arguments,
1337 %a will be replaced by the address, and %s will be replaced by the subject
1338 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1347 "Non-nil means, ask for confirmation before executing shell links.
1348 Shell links can be dangerous: just think about a link
1350 [[shell:rm -rf ~/*][Google Search]]
1353 but really it would remove your entire home directory.
1354 Therefore we advise against setting this variable to nil.
1355 Just change it to `y-or-n-p' of you want to confirm with a
1364 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1365 Elisp links can be dangerous: just think about a link
1370 but really it would remove your entire home directory.
1371 Therefore we advise against setting this variable to nil.
1372 Just change it to `y-or-n-p' of you want to confirm with a
1383 "Default file applications on a UNIX or GNU/Linux system.
1395 "Default file applications on a MacOS X system.
1397 for some files for which the OS does not have a good default.
1405 'mswindows-shell-execute
1408 "Default file applications on a Windows NT system.
1413 '(
1420 )
1421 "External applications for opening `file:path' items in a document.
1422 Org-mode uses system defaults for different file types, but
1423 you can use this variable to set the application for a given file
1424 extension. The entries in this list are cons cells where the car identifies
1425 files and the cdr the corresponding command. Possible values for the
1426 file identifier are
1428 `directory' Matches a directory
1429 `remote' Matches a remote file, accessible through tramp or efs.
1430 Remote files most likely should be visited through Emacs
1431 because external applications cannot handle such paths.
1432 t Default for all remaining files
1434 Possible values for the command are:
1435 `emacs' The file will be visited by the current Emacs process.
1436 `default' Use the default application for this file type.
1437 string A command to be executed by a shell; %s will be replaced
1438 by the path to the file.
1439 sexp A Lisp form which will be evaluated. The file path will
1440 be available in the Lisp variable `file'.
1441 For more examples, see the system specific constants
1442 `org-file-apps-defaults-macosx'
1443 `org-file-apps-defaults-windowsnt'
1444 `org-file-apps-defaults-gnu'."
1459 "Non-nil means, that the search for the mh-message will be extended to
1460 all folders if the message cannot be found in the folder given in the link.
1461 Searching all folders is very efficient with one of the search engines
1462 supported by MH-E, but will be slow with pick."
1467 "Options concerning interaction with remember.el."
1472 "Directory with org files.
1473 This directory will be used as default to prompt for org files.
1474 Used by the hooks for remember.el."
1479 "Default target for storing notes.
1480 Used by the hooks for remember.el. This can be a string, or nil to mean
1481 the value of `remember-data-file'.
1482 You can set this on a per-template basis with the variable
1483 `org-remember-templates'."
1487 file))
1490 "Non-nil means, `C-c C-c' stores remember note without further promts.
1491 In this case, you need `C-u C-c C-c' to get the prompts for
1492 note file and headline.
1493 When this variable is nil, `C-c C-c' give you the prompts, and
1494 `C-u C-c C-c' trigger the fasttrack."
1499 "The interface to be used for interactive filing of remember notes.
1500 This is only used when the interactive mode for selecting a filing
1501 location is used (see the variable `org-remember-store-without-prompt').
1502 Allowed vaues are:
1503 outline The interface shows an outline of the relevant file
1504 and the correct heading is found by moving through
1505 the outline or by searching with incremental search.
1506 outline-path-completion Headlines in the current buffer are offered via
1507 completion.
1508 refile Use the refile interface, and offer headlines,
1509 possibly from different buffers."
1517 "The default interface to be used for `org-goto'.
1518 Allowed vaues are:
1519 outline The interface shows an outline of the relevant file
1520 and the correct heading is found by moving through
1521 the outline or by searching with incremental search.
1522 outline-path-completion Headlines in the current buffer are offered via
1523 completion."
1530 "The headline that should be the default location in the notes file.
1531 When filing remember notes, the cursor will start at that position.
1532 You can set this on a per-template basis with the variable
1533 `org-remember-templates'."
1538 "Templates for the creation of remember buffers.
1539 When nil, just let remember make the buffer.
1540 When not nil, this is a list of 5-element lists. In each entry, the first
1541 element is the name of the template, which should be a single short word.
1542 The second element is a character, a unique key to select this template.
1543 The third element is the template. The fourth element is optional and can
1544 specify a destination file for remember items created with this template.
1545 The default file is given by `org-default-notes-file'. An optional fifth
1546 element can specify the headline in that file that should be offered
1547 first when the user is asked to file the entry. The default headline is
1548 given in the variable `org-remember-default-headline'.
1550 An optional sixth element can specify the context in which the user should
1551 be able to select this template. If this element is a list of major modes,
1552 the template will only be available while invoking `org-remember' from a
1553 buffer in one of these modes. If it is a function, the template will only
1554 be selected if the function returns `t'. A value of `t' means select
1555 this template in any context. When the element is `nil', the template
1556 will be selected by default, i.e. when all contextual checks failed.
1558 The template specifies the structure of the remember buffer. It should have
1559 a first line starting with a star, to act as the org-mode headline.
1560 Furthermore, the following %-escapes will be replaced with content:
1562 %^{prompt} Prompt the user for a string and replace this sequence with it.
1563 A default value and a completion table ca be specified like this:
1564 %^{prompt|default|completion2|completion3|...}
1565 %t time stamp, date only
1566 %T time stamp with date and time
1567 %u, %U like the above, but inactive time stamps
1568 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1569 You may define a prompt like %^{Please specify birthday}t
1570 %n user name (taken from `user-full-name')
1571 %a annotation, normally the link created with org-store-link
1572 %i initial content, the region active. If %i is indented,
1573 the entire inserted text will be indented as well.
1574 %c content of the clipboard, or current kill ring head
1575 %^g prompt for tags, with completion on tags in target file
1576 %^G prompt for tags, with completion all tags in all agenda files
1577 %:keyword specific information for certain link types, see below
1578 %[pathname] insert the contents of the file given by `pathname'
1579 %(sexp) evaluate elisp `(sexp)' and replace with the result
1580 %! Store this note immediately after filling the template
1582 %? After completing the template, position cursor here.
1584 Apart from these general escapes, you can access information specific to the
1585 link type that is created. For example, calling `remember' in emails or gnus
1586 will record the author and the subject of the message, which you can access
1587 with %:author and %:subject, respectively. Here is a complete list of what
1588 is recorded for each link type.
1590 Link type | Available information
1591 -------------------+------------------------------------------------------
1592 bbdb | %:type %:name %:company
1593 vm, wl, mh, rmail | %:type %:subject %:message-id
1594 | %:from %:fromname %:fromaddress
1595 | %:to %:toname %:toaddress
1597 gnus | %:group, for messages also all email fields
1598 w3, w3m | %:type %:url
1599 info | %:type %:file %:node
1600 calendar | %:type %:date"
1629 "Non-nil means, store new notes at the beginning of a file or entry.
1630 When nil, new notes will be filed to the end of a file or entry.
1631 This can also be a list with cons cells of regular expressions that
1632 are matched against file names, and values."
1642 This is list of cons cells. Each cell contains:
1643 - a specification of the files to be considered, either a list of files,
1644 or a symbol whose function or value fields will be used to retrieve
1645 a file name or a list of file names. Nil means, refile to a different
1646 heading in the current buffer.
1647 - A specification of how to find candidate refile targets. This may be
1648 any of
1650 This tag has to be present in all target headlines, inheritance will
1651 not be considered.
1653 todo keyword.
1655 headlines that are refiling targets.
1656 - a cons cell (:level . N). Any headline of level N is considered a target.
1657 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1658 ;; FIXME: what if there are a var and func with same name???
1674 "Non-nil means, provide refile targets as paths.
1675 So a level 3 headline will be available as level1/level2/level3.
1676 When the value is `file', also include the file name (without directory)
1677 into the path. When `full-file-path', include the full file path."
1686 "Options concerning TODO items in Org-mode."
1691 "Options concerning Progress logging in Org-mode."
1696 "List of TODO entry keyword sequences and their interpretation.
1699 Each sequence starts with a symbol, either `sequence' or `type',
1700 indicating if the keywords should be interpreted as a sequence of
1701 action steps, or as different types of TODO items. The first
1702 keywords are states requiring action - these states will select a headline
1703 for inclusion into the global TODO list Org-mode produces. If one of
1706 the last keyword is treated as the only DONE state of the sequence.
1709 additional state where no keyword is present. For details about this
1710 cycling, see the manual.
1712 TODO keywords and interpretation can also be set on a per-file basis with
1713 the special #+SEQ_TODO and #+TYP_TODO lines.
1715 Each keyword can optionally specify a character for fast state selection
1716 \(in combination with the variable `org-use-fast-todo-selection')
1717 and specifiers for state change logging, using the same syntax
1720 indicates to record a time stamp each time this state is selected.
1722 Each keyword may also specify if a timestamp or a note should be
1723 recorded when entering or leaving the state, by adding additional
1724 characters in the parenthesis after the keyword. This looks like this:
1726 record only the time of the state change. With X and Y being either
1728 Y when leaving the state if and only if the *target* state does not
1729 define X. You may omit any of the fast-selection key or X or /Y,
1730 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1732 For backward compatibility, this variable may also be just a list
1733 of keywords - in this case the interptetation (sequence or type) will be
1734 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1772 "Controls how TODO keywords are interpreted.
1773 This variable is in principle obsolete and is only used for
1774 backward compatibility, if the interpretation of todo keywords is
1775 not given already in `org-todo-keywords'. See that variable for
1776 more information."
1783 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1784 This variable describes if and under what circumstances the cycling
1785 mechanism for TODO keywords will be replaced by a single-key, direct
1786 selection scheme.
1788 When nil, fast selection is never used.
1790 When the symbol `prefix', it will be used when `org-todo' is called with
1791 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1792 in an agenda buffer.
1794 When t, fast selection is used by default. In this case, the prefix
1795 argument forces cycling instead.
1797 In all cases, the special interface is only used if access keys have actually
1798 been assigned by the user, i.e. if keywords in the configuration are followed
1799 by a letter in parenthesis, like TODO(t)."
1807 "Hook which is run after the state of a TODO item was changed.
1808 The new state (a string with a TODO keyword, or nil) is available in the
1809 Lisp variable `state'."
1814 "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
1815 When equal to the list (done), also prompt for a closing note.
1816 This can also be configured on a per-file basis by adding one of
1817 the following lines anywhere in the buffer:
1819 #+STARTUP: logdone
1820 #+STARTUP: lognotedone
1821 #+STARTUP: nologdone"
1829 ;; Normalize old uses of org-log-done.
1835 ;; FIXME: document
1837 "Non-nil means, recored a note when clocking out of an item.
1838 This can also be configured on a per-file basis by adding one of
1839 the following lines anywhere in the buffer:
1841 #+STARTUP: lognoteclock-out
1842 #+STARTUP: nolognoteclock-out"
1848 "Non-nil means, the CLOSED time stamp will contain date and time.
1849 When nil, only the date will be recorded."
1857 "Headings for notes added when clocking out or closing TODO items.
1858 The value is an alist, with the car being a symbol indicating the note
1859 context, and the cdr is the heading to be used. The heading may also be the
1860 empty string.
1861 %t in the heading will be replaced by a time stamp.
1862 %s will be replaced by the new TODO state, in double quotes.
1863 %u will be replaced by the user name.
1864 %U will be replaced by the full user name."
1870 "Heading when changing todo state (todo sequence only)"
1875 "Non-nil means, the latest state change note will be directly after heading.
1876 When nil, the notes will be orderer according to time."
1882 "Non-nil means, record moving through the DONE state when triggering repeat.
1883 An auto-repeating tasks is immediately switched back to TODO when marked
1885 the TODO keyword definition, or recording a cloing note by setting
1886 `org-log-done', there will be no record of the task moving trhough DONE.
1887 This variable forces taking a note anyway. Possible values are:
1889 nil Don't force a record
1890 time Record a time stamp
1891 note Record a note
1893 This option can also be set with on a per-file-basis with
1895 #+STARTUP: logrepeat
1896 #+STARTUP: lognoterepeat
1897 #+STARTUP: nologrepeat
1899 You can have local logging settings for a subtree by setting the LOGGING
1900 property to one or more of these keywords."
1909 "Should clocking info be wrapped into a drawer?
1910 When t, clocking info will always be inserted into a :CLOCK: drawer.
1911 If necessary, the drawer will be created.
1912 When nil, the drawer will not be created, but used when present.
1913 When an integer and the number of clocking entries in an item
1914 reaches or exceeds this number, a drawer will be created."
1923 "When t, the clock will be stopped when the relevant entry is marked DONE.
1924 Nil means, clock will keep running until stopped explicitly with
1925 `C-c C-x C-o', or until the clock is started in a different item."
1930 "Set task to a special todo state while clocking it.
1931 The value should be the state to which the entry should be switched."
1939 "Priorities in Org-mode."
1944 "The highest priority of TODO items. A character like ?A, ?B etc.
1945 Must have a smaller ASCII number than `org-lowest-priority'."
1950 "The lowest priority of TODO items. A character like ?A, ?B etc.
1951 Must have a larger ASCII number than `org-highest-priority'."
1956 "The default priority of TODO items.
1957 This is the priority an item get if no explicit priority is given."
1962 "Non-nil means, start with default priority when starting to cycle.
1963 When this is nil, the first step in the cycle will be (depending on the
1964 command used) one higher or lower that the default priority."
1969 "Options concerning time stamps and deadlines in Org-mode."
1974 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1975 When nil, these labeled time stamps are forces into the second line of an
1976 entry, just after the headline. When scheduling from the global TODO list,
1977 the time stamp will always be forced into the second line."
1982 "Formats for `format-time-string' which are used for time stamps.
1986 "Number of minutes to round time stamps to.
1987 These are two values, the first applies when first creating a time stamp.
1988 The second applies when changing it with the commands `S-up' and `S-down'.
1989 When changing the time stamp, this means that it will change in steps
1990 of N minues, as given by the second value.
1992 When a setting is 0 or 1, insert the time unmodified. Useful rounding
1993 numbers should be factors of 60, so for example 5, 10, 15.
1995 When this is larger than 1, you can still force an exact time-stamp by using
1996 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
1997 and by using a prefix arg to `S-up/down' to specify the exact number
1998 of minutes to shift."
2009 "Non-nil means, overlay custom formats over all time stamps.
2010 The formats are defined through the variable `org-time-stamp-custom-formats'.
2011 To turn this on on a per-file basis, insert anywhere in the file:
2012 #+STARTUP: customtime"
2020 "Custom formats for time stamps. See `format-time-string' for the syntax.
2021 These are overlayed over the default ISO format if the variable
2022 `org-display-custom-times' is set. Time like %H:%M should be at the
2023 end of the second format."
2028 "Get the right format for a time string."
2033 f)))
2036 "Non-nil means, assume future for incomplete date input from user.
2037 This affects the following situations:
2038 1. The user gives a day, but no month.
2041 it will be considered as *this* month.
2042 2. The user gives a month but not a year.
2046 When this option is nil, the current month and year will always be used
2047 as defaults."
2052 "Non-nil means, display current interpretation of date prompt live.
2053 This display will be in an overlay, in the minibuffer."
2058 "Non-nil means, pop up a calendar when prompting for a date.
2059 In the calendar, the date can be selected with mouse-1. However, the
2060 minibuffer will also be active, and you can simply enter the date as well.
2061 When nil, only the minibuffer will be available."
2069 "The hour when your day really ends.
2070 This has influence for the following applications:
2072 the time given here, the day recognized as TODAY is actually yesterday.
2073 - When a date is read from the user and it is still before the time given
2074 here, the current date and time will be assumed to be yesterday, 23:59.
2076 FIXME:
2077 IMPORTANT: This is still a very experimental feature, it may disappear
2078 again or it may be extended to mean more things."
2083 "Non-nil means, S-down will increase the time in a time stamp.
2084 When nil, S-up will increase."
2089 "Non-nil means, make the calendar window follow timestamp changes.
2090 When a timestamp is modified and the calendar window is visible, it will be
2091 moved to the new date."
2096 "When non-nil, should be a function to create `org-clock-heading'.
2097 This is the string shown in the mode line when a clock is running.
2098 The function is called with point at the beginning of the headline."
2103 "Options concerning tags in Org-mode."
2108 "List of tags allowed in Org-mode files.
2109 When this list is nil, Org-mode will base TAG input on what is already in the
2110 buffer.
2111 The value of this variable is an alist, the car of each entry must be a
2112 keyword as a string, the cdr may be a character that is used to select
2113 that tag through the fast-tag-selection interface.
2114 See the manual for details."
2124 "Non-nil means, use fast tag selection scheme.
2125 This is a special interface to select and deselect tags with single keys.
2126 When nil, fast selection is never used.
2127 When the symbol `auto', fast selection is used if and only if selection
2128 characters for tags have been configured, either through the variable
2129 `org-tag-alist' or through a #+TAGS line in the buffer.
2130 When t, fast selection is always used and selection keys are assigned
2131 automatically if necessary."
2139 "Non-nil means, fast tag selection exits after first change.
2140 When nil, you have to press RET to exit it.
2141 During fast tag selection, you can toggle this flag with `C-c'.
2142 This variable can also have the value `expert'. In this case, the window
2143 displaying the tags menu is not even shown, until you press C-c again."
2151 "Non-nil means, fast tags selection interface will also offer TODO states.
2155 "The column to which tags should be indented in a headline.
2156 If this number is positive, it specifies the column. If it is negative,
2157 it means that the tags should be flushright to that column. For example,
2158 -80 works well for a normal 80 character screen."
2163 "Non-nil means, realign tags after pro/demotion of TODO state change.
2164 These operations change the length of a headline and therefore shift
2165 the tags around. With this options turned on, after each such operation
2166 the tags are again aligned to `org-tags-column'."
2171 "Non-nil means, tags in levels apply also for sublevels.
2172 When nil, only the tags directly given in a specific line apply there.
2173 If you turn off this option, you very likely want to turn on the
2174 companion option `org-tags-match-list-sublevels'."
2179 "Non-nil means list also sublevels of headlines matching tag search.
2180 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2181 the sublevels of a headline matching a tag search often also match
2182 the same search. Listing all of them can create very long lists.
2183 Setting this variable to nil causes subtrees of a match to be skipped.
2184 This option is off by default, because inheritance in on. If you turn
2185 inheritance off, you very likely want to turn this option on.
2187 As a special case, if the tag search is restricted to TODO items, the
2188 value of this variable is ignored and sublevels are always checked, to
2189 make sure all corresponding TODO items find their way into the list."
2201 "Options concerning properties in Org-mode."
2206 "How property key/value pairs should be formatted by `indent-line'.
2207 When `indent-line' hits a property definition, it will format the line
2208 according to this format, mainly to make sure that the values are
2209 lined-up with respect to each other."
2214 "Non-nil means, properties apply also for sublevels.
2215 This setting is only relevant during property searches, not when querying
2216 an entry with `org-entry-get'. To retrieve a property with inheritance,
2217 you need to call `org-entry-get' with the inheritance flag.
2218 Turning this on can cause significant overhead when doing a search, so
2219 this is turned off by default.
2220 When nil, only the properties directly given in the current entry count.
2221 The value may also be a list of properties that shouldhave inheritance.
2223 However, note that some special properties use inheritance under special
2224 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2226 for valid values of a property."
2234 "The default column format, if no other format has been defined.
2235 This variable can be set on the per-file basis by inserting a line
2237 #+COLUMNS: %25ITEM ....."
2242 "List of property/value pairs that can be inherited by any entry.
2243 You can set buffer-local values for this by adding lines like
2245 #+PROPERTY: NAME VALUE"
2252 "List of property/value pairs that can be inherited by any entry.
2253 Valid for the current buffer.
2257 "Options concerning agenda views in Org-mode."
2262 "Variable used by org files to set a category for agenda display.
2263 Such files should use a file variable to set it, for example
2267 or contain a special line
2269 #+CATEGORY: ELisp
2271 If the file does not specify a category, then file's base name
2276 "The files to be used for agenda display.
2280 If an entry is a directory, all files in that directory that are matched by
2281 `org-agenda-file-regexp' will be part of the file list.
2283 If the value of the variable is not a list but a single file name, then
2284 the list of agenda files is actually stored and maintained in that file, one
2285 agenda file per line."
2292 "Regular expression to match files for `org-agenda-files'.
2293 If any element in the list in that variable contains a directory instead
2294 of a normal file, all files in that directory that are matched by this
2295 regular expression will be included."
2300 "t means to just skip non-reachable files in `org-agenda-files'.
2301 Nil means to remove them, after a query, from the list."
2306 "List of extra files to be searched by text search commands.
2307 These files will be search in addition to the agenda files bu the
2308 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2309 Note that these files will only be searched for text search commands,
2310 not for the other agenda views like todo lists, tag earches or the weekly
2311 agenda. This variable is intended to list notes and possibly archive files
2312 that should also be searched by these two commands."
2321 "When set, remote killing from the agenda buffer needs confirmation.
2322 When t, a confirmation is always needed. When a number N, confirmation is
2323 only needed when the text to be killed contains more than N non-white lines."
2331 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2332 The command `org-calendar-goto-agenda' will be bound to this key. The
2333 default is the character `c' because then `c' can be used to switch back and
2334 forth between agenda and calendar."
2339 "Non-nil means, make the block agenda more compact.
2340 This is done by leaving out unnecessary lines."
2345 "Options concerning exporting agenda views in Org-mode."
2350 "Non-nil means, use colors in agenda views."
2355 "Alist of variable/value pairs that should be active during agenda export.
2356 This is a good place to set uptions for ps-print and for htmlize."
2364 "The style specification for exported HTML Agenda files.
2365 If this variable contains a string, it will replace the default <style>
2366 section as produced by `htmlize'.
2367 Since there are different ways of setting style information, this variable
2368 needs to contain the full HTML structure to provide a style, including the
2369 surrounding HTML tags. The style specifications should include definitions
2370 the fonts used by the agenda, here is an example:
2373 p { font-weight: normal; color: gray; }
2374 .org-agenda-structure {
2375 font-size: 110%;
2376 color: #003399;
2377 font-weight: 600;
2378 }
2379 .org-todo {
2380 color: #cc6666;Week-agenda:
2381 font-weight: bold;
2382 }
2383 .org-done {
2384 color: #339933;
2385 }
2386 .title { text-align: center; }
2387 .todo, .deadline { color: red; }
2388 .done { color: green; }
2389 </style>
2391 or, if you want to keep the style in a file,
2395 As the value of this option simply gets inserted into the HTML <head> header,
2397 <style>...</style> is required, if not present the variable will be ignored."
2403 "Options concerning agenda views in Org-mode."
2477 "Selection of examples for agenda command settings.
2478 This will be spliced into the custom type of
2483 "Custom commands for the agenda.
2484 These commands will be offered on the splash screen displayed by the
2487 (key desc type match settings files)
2489 key The key (one or more characters as a string) to be associated
2490 with the command.
2491 desc A description of the command, when omitted or nil, a default
2492 description is built using MATCH.
2493 type The command type, any of the following symbols:
2494 agenda The daily/weekly agenda.
2495 todo Entries with a specific TODO keyword, in all agenda files.
2496 search Entries containing search words entry or headline.
2497 tags Tags/Property/TODO match in all agenda files.
2498 tags-todo Tags/P/T match in all agenda files, TODO entries only.
2499 todo-tree Sparse tree of specific TODO keyword in *current* file.
2500 tags-tree Sparse tree with all tags matches in *current* file.
2501 occur-tree Occur sparse tree for *current* file.
2502 ... A user-defined function.
2503 match What to search for:
2504 - a single keyword for TODO keyword searches
2505 - a tags match expression for tags searches
2506 - a word search expression for text searches.
2507 - a regular expression for occur searches
2508 For all other commands, this should be the empty string.
2509 settings A list of option settings, similar to that in a let form, so like
2510 this: ((opt1 val1) (opt2 val2) ...). The values will be
2511 evaluated at the moment of execution, so quote them when needed.
2512 files A list of files file to write the produced agenda buffer to
2513 with the command `org-store-agenda-views'.
2516 produced. Otherwide, only the plain text is written to the file.
2518 You can also define a set of commands, to create a composite agenda buffer.
2519 In this case, an entry looks like this:
2521 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
2523 where
2525 desc A description string to be displayed in the dispatcher menu.
2526 cmd An agenda command, similar to the above. However, tree commands
2527 are no allowed, but instead you can get agenda and global todo list.
2528 So valid commands for a set are:
2537 Each command can carry a list of options, and another set of options can be
2538 given for the whole set of commands. Individual command options take
2539 precedence over the general options.
2541 When using several characters as key to a command, the first characters
2542 are prefix commands. For the dispatcher to display useful information, you
2543 should provide a description for the prefix, like
2545 (setq org-agenda-custom-commands
2569 ,org-agenda-custom-commands-local-options
2618 "The register holding the current query string.
2619 The prupose of this is that if you construct a query string interactively,
2620 you can then use it to define a custom command."
2626 "How to identify stuck projects.
2627 This is a list of four items:
2628 1. A tags/todo matcher string that is used to identify a project.
2629 The entire tree below a headline matched by this is considered one project.
2630 2. A list of TODO keywords identifying non-stuck projects.
2631 If the project subtree contains any headline with one of these todo
2632 keywords, the project is considered to be not stuck. If you specify
2634 3. A list of tags identifying non-stuck projects.
2635 If the project subtree contains any headline with one of these tags,
2637 a tag, any tag will mark the project unstuck.
2638 4. An arbitrary regular expression matching non-stuck projects.
2641 or `C-c a #' to produce the list."
2645 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2651 "Options concerning skipping parts of agenda files."
2656 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2657 When nil, the sublevels of a TODO entry are not checked, resulting in
2658 potentially much shorter TODO lists."
2664 "Non-nil means, don't show entries with a date in the global todo list.
2665 You can use this if you prefer to mark mere appointments with a TODO keyword,
2666 but don't want them to show up in the TODO list.
2667 When this is set, it also covers deadlines and scheduled items, the settings
2668 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2669 will be ignored."
2675 "Non-nil means, don't show scheduled entries in the global todo list.
2676 The idea behind this is that by scheduling it, you have already taken care
2677 of this item.
2678 See also `org-agenda-todo-ignore-with-date'."
2684 "Non-nil means, don't show near deadline entries in the global todo list.
2685 Near means closer than `org-deadline-warning-days' days.
2686 The idea behind this is that such items will appear in the agenda anyway.
2687 See also `org-agenda-todo-ignore-with-date'."
2693 "Non-nil means don't show scheduled items in agenda when they are done.
2694 This is relevant for the daily/weekly agenda, not for the TODO list. And
2695 it applies only to the actual date of the scheduling. Warnings about
2696 an item with a past scheduling dates are always turned off when the item
2697 is DONE."
2702 "Non-nil means don't show deadines when the corresponding item is done.
2703 When nil, the deadline is still shown and should give you a happy feeling.
2704 This is relevant for the daily/weekly agenda. And it applied only to the
2705 actualy date of the deadline. Warnings about approching and past-due
2706 deadlines are always turned off when the item is DONE."
2711 "Non-nil means don't select item by timestamp or -range if it is DONE."
2716 "Non-nil means, `org-timeline' also shows dates without an entry.
2717 When nil, only the days which actually have entries are shown.
2718 When t, all days between the first and the last date are shown.
2719 When an integer, show also empty dates, but if there is a gap of more than
2720 N days, just insert a special line indicating the size of the gap."
2729 "Options concerning initial settings in the Agenda in Org Mode."
2734 "Hook run just before displaying an agenda buffer."
2739 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2740 A longer mouse click will still set point. Does not work on XEmacs.
2741 Needs to be set before org.el is loaded."
2746 "The initial value of follow-mode in a newly created agenda window."
2751 "Options concerning the windows used by the Agenda in Org Mode."
2756 "How the agenda buffer should be displayed.
2757 Possible values for this option are:
2759 current-window Show agenda in the current window, keeping all other windows.
2760 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2761 other-window Use `switch-to-buffer-other-window' to display agenda.
2762 reorganize-frame Show only two windows on the current frame, the current
2763 window and the agenda.
2764 See also the variable `org-agenda-restore-windows-after-quit'."
2773 "The min and max height of the agenda window as a fraction of frame height.
2774 The value of the variable is a cons cell with two numbers between 0 and 1.
2775 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2780 "Non-nil means, restore window configuration open exiting agenda.
2781 Before the window configuration is changed for displaying the agenda,
2782 the current status is recorded. When the agenda is exited with
2783 `q' or `x' and this option is set, the old state is restored. If
2784 `org-agenda-window-setup' is `other-frame', the value of this
2785 option will be ignored.."
2790 "How should indirect tree buffers be displayed?
2791 This applies to indirect buffers created with the commands
2793 Valid values are:
2794 current-window Display in the current window
2795 other-window Just display in another window.
2796 dedicated-frame Create one new frame, and re-use it each time.
2797 new-frame Make a new frame each time. Note that in this case
2798 previously-made indirect buffers are kept, and you need to
2799 kill these buffers yourself."
2809 "Options concerning the daily/weekly agenda."
2814 "Number of days to include in overview display.
2815 Should be 1 or 7."
2820 "Non-nil means, start the overview always on the specified weekday.
2821 0 denotes Sunday, 1 denotes Monday etc.
2822 When nil, always start on the current day."
2828 "Non-nil means, `org-agenda' shows every day in the selected range.
2829 When nil, only the days which actually have entries are shown."
2834 "Format string for displaying dates in the agenda.
2835 Used by the daily/weekly agenda and by the timeline. This should be
2836 a format string understood by `format-time-string', or a function returning
2837 the formatted date as a string. The function must take a single argument,
2838 a calendar-style date list like (month day year)."
2845 "Format a date string for display in the daily/weekly agenda, or timeline.
2846 This function makes sure that dates are aligned for easy reading."
2854 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2859 "Set means weekly/daily agenda will always contain all TODO entries.
2860 The TODO entries will be listed at the top of the agenda, before
2861 the entries for specific days."
2866 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2867 When nil, only one occurence is shown, either today or the
2868 nearest into the future."
2873 "No. of days before expiration during which a deadline becomes active.
2874 This variable governs the display in sparse trees and in the agenda.
2875 When 0 or negative, it means use this number (the absolute value of it)
2876 even if a deadline has a different individual lead time specified."
2882 "No. of days to continue listing scheduled items that are not marked DONE.
2883 When an item is scheduled on a date, it shows up in the agenda on this
2884 day and will be listed until it is marked done for the number of days
2885 given here."
2890 "Options concerning the time grid in the Org-mode Agenda."
2895 "Non-nil means, show a time grid in the agenda schedule.
2896 A time grid is a set of lines for specific times (like every two hours between
2897 8:00 and 20:00). The items scheduled for a day at specific times are
2898 sorted in between these lines.
2899 For details about when the grid will be shown, and what it will look like, see
2900 the variable `org-agenda-time-grid'."
2906 "----------------"
2909 "The settings for time grid for agenda display.
2910 This is a list of three items. The first item is again a list. It contains
2911 symbols specifying conditions when the grid should be displayed:
2913 daily if the agenda shows a single day
2914 weekly if the agenda shows an entire week
2915 today show grid on current date, independent of daily/weekly display
2916 require-timed show grid only if at least one item has a time specification
2918 The second item is a string which will be places behing the grid time.
2920 The third item is a list of integers, indicating the times that should have
2921 a grid line."
2923 :type
2930 require-timed)
2932 remove-match))
2937 "Options concerning sorting in the Org-mode Agenda."
2946 "Sorting structure for the agenda items of a single day.
2947 This is a list of symbols which will be used in sequence to determine
2948 if an entry should be listed before another entry. The following
2949 symbols are recognized:
2951 time-up Put entries with time-of-day indications first, early first
2952 time-down Put entries with time-of-day indications first, late first
2953 category-keep Keep the default order of categories, corresponding to the
2954 sequence in `org-agenda-files'.
2955 category-up Sort alphabetically by category, A-Z.
2956 category-down Sort alphabetically by category, Z-A.
2957 tag-up Sort alphabetically by last tag, A-Z.
2958 tag-down Sort alphabetically by last tag, Z-A.
2959 priority-up Sort numerically by priority, high priority last.
2960 priority-down Sort numerically by priority, high priority first.
2962 The different possibilities will be tried in sequence, and testing stops
2964 '(time-up category-keep priority-down)
2965 means: Pull out all entries having a specified time of day and sort them,
2966 in order to make a time schedule for the current day the first thing in the
2967 agenda listing for the day. Of the entries without a time indication, keep
2968 the grouped in categories, don't sort the categories, but keep them in
2969 the sequence given in `org-agenda-files'. Within each category sort by
2970 priority.
2972 Leaving out `category-keep' would mean that items will be sorted across
2973 categories by priority.
2975 Instead of a single list, this can also be a set of list for specific
2976 contents, with a context symbol in the car of the list, any of
2977 `agenda', `todo', `tags' for the corresponding agenda views."
2990 "Non-nil means, items without time are considered late.
2991 This is only relevant for sorting. When t, items which have no explicit
2992 time like 15:30 will be considered as 99:01, i.e. later than any items which
2993 do have a time. When nil, the default time is before 0:00. You can use this
2994 option to decide if the schedule for today should come before or after timeless
2995 agenda entries."
3000 "Options concerning the entry prefix in the Org-mode agenda display."
3010 "Format specifications for the prefix of items in the agenda views.
3011 An alist with four entries, for the different agenda types. The keys to the
3012 sublists are `agenda', `timeline', `todo', and `tags'. The values
3013 are format strings.
3014 This format works similar to a printf format, with the following meaning:
3017 as given by the CATEGORY keyword or derived from the file name.
3018 %T the *last* tag of the item. Last because inherited tags come
3019 first in the list.
3020 %t the time-of-day specification if one applies to the entry, in the
3021 format HH:MM
3022 %s Scheduling/Deadline information, a short string
3024 All specifiers work basically like the standard `%s' of printf, but may
3025 contain two additional characters: A question mark just after the `%' and
3026 a whitespace/punctuation character just before the final letter.
3028 If the first character after `%' is a question mark, the entire field
3029 will only be included if the corresponding value applies to the
3030 current entry. This is useful for fields which should have fixed
3031 width when present, but zero width when absent. For example,
3033 day is specified, but will completely disappear in entries which do
3034 not contain a time.
3036 If there is punctuation or whitespace character just before the final
3037 format letter, this character will be appended to the field value if
3040 empty, no additional colon would be interted.
3043 - Indent the line with two space characters
3044 - Give the category in a 12 chars wide field, padded with whitespace on
3045 the right (because of `-'). Append a colon if there is a category
3046 (because of `:').
3047 - If there is a time-of-day, put it into a 12 chars wide field. If no
3048 time, don't put in an empty field, just skip it (because of '?').
3049 - Finally, put the scheduling information and append a whitespace.
3051 As another example, if you don't want the time-of-day of entries in
3052 the prefix, you could use:
3056 See also the variables `org-agenda-remove-times-when-in-prefix' and
3057 `org-agenda-remove-tags'."
3069 "The compiled version of the most recently used prefix format.
3073 "Format for the TODO keyword in agenda lines.
3075 to occupy a fixed space in the agenda display."
3080 "Text preceeding scheduled items in the agenda view.
3081 This is a list with two strings. The first applies when the item is
3082 scheduled on the current day. The second applies when it has been scheduled
3083 previously, it may contain a %d to capture how many days ago the item was
3084 scheduled."
3091 "Text preceeding deadline items in the agenda view.
3092 This is a list with two strings. The first applies when the item has its
3093 deadline on the current day. The second applies when it is in the past or
3094 in the future, it may contain %d to capture how many days away the deadline
3095 is (was)."
3102 "Non-nil means, remove duplicate time specifications in agenda items.
3103 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
3104 time-of-day specification in a headline or diary entry is extracted and
3105 placed into the prefix. If this option is non-nil, the original specification
3106 \(a timestamp or -range, or just a plain time(range) specification like
3107 11:30-4pm) will be removed for agenda display. This makes the agenda less
3108 cluttered.
3109 The option can be t or nil. It may also be the symbol `beg', indicating
3110 that the time should only be removed what it is located at the beginning of
3111 the headline/diary entry."
3120 "Default duration for appointments that only have a starting time.
3121 When nil, no duration is specified in such cases.
3122 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
3130 "Non-nil means, remove the tags from the headline copy in the agenda.
3131 When this is the symbol `prefix', only remove tags when
3132 `org-agenda-prefix-format' contains a `%T' specifier."
3144 "Shift tags in agenda items to this column.
3145 If this number is positive, it specifies the column. If it is negative,
3146 it means that the tags should be flushright to that column. For example,
3147 -80 works well for a normal 80 character screen."
3155 "Non-nil means, highlight low and high priorities in agenda.
3156 When t, the highest priority entries are bold, lowest priority italic.
3157 This may also be an association list of priority faces. The face may be
3168 "Options for embedding LaTeX code into Org-mode"
3176 "Options for creating images from LaTeX fragments.
3177 This is a property list with the following properties:
3179 `default' means use the forground of the default face.
3181 `default' means use the background of the default face.
3182 :scale a scaling factor for the size of the images
3183 :html-foreground, :html-background, :html-scale
3184 The same numbers for HTML export.
3185 :matchers a list indicating which matchers should be used to
3186 find LaTeX fragments. Valid members of this list are:
3203 "The document header used for processing LaTeX fragments."
3208 "Options for exporting org-listings."
3213 "General options for exporting Org-mode files."
3217 ;; FIXME
3222 When this option is turned on, these strings will be exported as:
3224 Org HTML LaTeX
3225 -----+----------+--------
3227 -- – --
3228 --- — ---
3229 ... … \ldots
3246 "Terms used in export text, translated to different languages.
3247 Use the variable `org-export-default-language' to set the language,
3248 or use the +OPTION lines for a per-file setting."
3258 "The default language of HTML export, as a string.
3259 This should have an association in `org-export-language-setup'."
3264 "Non-nil means, skip all text before the first headline when exporting.
3265 When nil, that text is exported as well."
3270 "The last level which is still exported as a headline.
3271 Inferior levels will produce itemize lists when exported.
3272 Note that a numeric prefix argument to an exporter function overrides
3273 this setting.
3280 "Non-nil means, add section numbers to headlines when exporting.
3287 "Non-nil means, create a table of contents in exported files.
3288 The TOC contains headlines with levels up to`org-export-headline-levels'.
3289 When an integer, include levels up to N in the toc, this may then be
3290 different from `org-export-headline-levels', but it will not be allowed
3291 to be larger than the number of headline levels.
3292 When nil, no table of contents is made.
3295 ASCII export, and with red color in HTML output, if the option
3296 `org-export-mark-todo-in-toc' is set.
3298 In HTML output, the TOC will be clickable.
3309 "Non-nil means, mark TOC lines that contain any open TODO items."
3314 "Non-nil means, preserve all line breaks when exporting.
3315 Normally, in HTML output paragraphs will be reformatted. In ASCII
3316 export, line breaks will always be preserved, regardless of this variable.
3323 "Whether subtrees with the ARCHIVE tag should be exported.
3324 This can have three different values
3325 nil Do not export, pretend this tree is not present
3326 t Do export the entire tree
3327 headline Only export the headline, but skip the tree below it."
3336 "Non-nil means, insert author name and email into the exported file.
3338 This option can also be set with the +OPTIONS line,
3344 "Non-nil means, insert a time stamp into the exported file.
3345 The time stamp shows when the file was created.
3347 This option can also be set with the +OPTIONS line,
3353 "If nil, do not export time stamps and associated keywords."
3358 "If nil, remove timestamps from the table of contents entries."
3363 "If nil, do not export tags, just remove them from headlines.
3364 If this is the symbol `not-in-toc', tags will be removed from table of
3365 contents entries, but still be shown in the headlines of the document.
3375 "Non-nil means, export with drawers like the property drawer.
3376 When t, all drawers are exported. This may also be a list of
3377 drawer names to export."
3386 "Options for translating special ascii sequences for the export backends."
3391 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3392 If the export target supports emphasizing text, the word will be
3393 typeset in bold, italic, or underlined, respectively. Works only for
3394 single words, but you can say: I *really* *mean* *this*.
3395 Not all export backends support this.
3402 "If nil, export [1] as a footnote marker.
3403 Lines starting with [1] will be formatted as footnotes.
3411 When this option is turned on, you can use TeX-like syntax for sub- and
3413 considered as a single item - so grouping with {} is normally not
3414 needed. For example, the following things will be parsed as single
3415 sub- or superscripts.
3417 10^24 or 10^tau several digits will be considered 1 item.
3418 10^-12 or 10^-tau a leading sign with digits or a word
3419 x^2-y^3 will be read as x^2 - y^3, because items are
3420 terminated by almost any nonword/nondigit char.
3421 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3423 Still, ambiguity is possible - so when in doubt use {} to enclose the
3424 sub/superscript. If you set this variable to the symbol `{}',
3425 the braces are *required* in order to trigger interpretations as
3427 frequently in plain text.
3429 Not all export backends support this, but HTML does.
3440 When this option is turned on, these strings will be exported as:
3443 -- : –
3444 --- : —
3446 Not all export backends support this, but HTML does.
3453 "Non-nil means, interpret simple TeX-like macros when exporting.
3455 No only real TeX macros will work here, but the standard HTML entities
3456 for math can be used as macro names as well. For a list of supported
3457 names in HTML export, see the constant `org-html-entities'.
3458 Not all export backends support this.
3466 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3468 the first non-white thing on a line. It will also find the math delimiters
3470 display math.
3479 This can be used to have pre-formatted text, fragments of code etc. For
3480 example:
3481 : ;; Some Lisp examples
3482 : (while (defc cnt)
3483 : (ding))
3484 will be looking just like this in also HTML. See also the QUOTE keyword.
3485 Not all export backends support this.
3492 "Number of stacked braces for sub/superscript matching.
3493 This has to be set before loading org.el to be effective."
3498 "Options for exporting tables in Org-mode."
3504 For example:
3506 | Name | Address | Birthday |
3507 |-------------+----------+-----------|
3508 | Arthur Dent | England | 29.2.2100 |
3510 Not all export backends support this.
3517 "Non-nil means, highlight the first table line.
3518 In HTML export, this means use <th> instead of <td>.
3519 In tables created with table.el, this applies to the first table line.
3520 In Org-mode tables, all lines before the first horizontal separator
3521 line will be formatted with <th> tags."
3526 "Remove special lines and marking characters in calculating tables.
3527 This removes the special marking character column from tables that are set
3528 up for spreadsheet calculations. It also removes the entire lines
3529 marked with `!', `_', or `^'. The lines with `$' are kept, because
3530 the values of constants may be useful to have."
3535 "Non-nil means, always export tables created with table.el natively.
3536 Natively means, use the HTML code generator in table.el.
3537 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3538 the table does not use row- or column-spanning). This has the
3539 advantage, that the automatic HTML conversions for math symbols and
3540 sub/superscripts can be applied. Org-mode's HTML generator is also
3541 much faster."
3546 "Options specific for ASCII export of Org-mode files."
3551 "Characters for underlining headings in ASCII export.
3552 In the given sequence, these characters will be used for level 1, 2, ..."
3557 "Bullet characters for headlines converted to lists in ASCII export.
3558 The first character is used for the first lest level generated in this
3559 way, and so on. If there are more levels than characters given here,
3560 the list will be repeated.
3561 Note that plain lists will keep the same bullets as the have in the
3562 Org-mode file."
3567 "Options specific for XML export of Org-mode files."
3572 "Options specific for HTML export of Org-mode files."
3577 ""
3582 "The extension for exported HTML files."
3588 html {
3589 font-family: Times, serif;
3590 font-size: 12pt;
3591 }
3592 .title { text-align: center; }
3593 .todo { color: red; }
3594 .done { color: green; }
3595 .timestamp { color: grey }
3596 .timestamp-kwd { color: CadetBlue }
3597 .tag { background-color:lightblue; font-weight:normal }
3598 .target { background-color: lavender; }
3599 pre {
3600 border: 1pt solid #AEBDCC;
3601 background-color: #F3F5F7;
3602 padding: 5pt;
3603 font-family: courier, monospace;
3604 }
3605 table { border-collapse: collapse; }
3606 td, th {
3607 vertical-align: top;
3608 <!--border: 1pt solid #ADB9CC;-->
3609 }
3610 </style>"
3611 "The default style specification for exported HTML files.
3612 Since there are different ways of setting style information, this variable
3613 needs to contain the full HTML structure to provide a style, including the
3614 surrounding HTML tags. The style specifications should include definitions
3615 for new classes todo, done, title, and deadline. For example, valid values
3616 would be:
3619 p { font-weight: normal; color: gray; }
3620 h1 { color: black; }
3621 .title { text-align: center; }
3622 .todo, .deadline { color: red; }
3623 .done { color: green; }
3624 </style>
3626 or, if you want to keep the style in a file,
3630 As the value of this option simply gets inserted into the HTML <head> header,
3637 "Format for typesetting the document title in HTML export."
3642 "The <H> level for level 1 headings in HTML export."
3647 "Non-nil means, make file links to `file.org' point to `file.html'.
3648 When org-mode is exporting an org-mode file to HTML, links to
3649 non-html files are directly put into a href tag in HTML.
3650 However, links to other Org-mode files (recognized by the
3651 extension `.org.) should become links to the corresponding html
3652 file, assuming that the linked org-mode file will also be
3653 converted to HTML.
3654 When nil, the links still point to the plain `.org' file."
3659 "Non-nil means, inline images into exported HTML pages.
3660 This is done using an <img> tag. When nil, an anchor with href is used to
3661 link to the image. If this option is `maybe', then images in links with
3662 an empty description will be inlined, while images with a description will
3663 be linked only."
3669 ;; FIXME: rename
3671 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3672 When nil, these tags will be exported as plain text and therefore
3673 not be interpreted by a browser.
3681 "The HTML tag that is used to start a table.
3682 This must be a <table> tag, but you may change the options like
3683 borders and spacing."
3688 "The opening tag for table header fields.
3689 This is customizable so that alignment options can be specified."
3694 "The opening tag for table data fields.
3695 This is customizable so that alignment options can be specified."
3700 "If non-nil, write `org-export-html-html-helper-timestamp'
3701 into the exported HTML text. Otherwise, the buffer will just be saved
3702 to a file."
3708 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3713 "Options specific for iCalendar export of Org-mode files."
3718 "The file name for the iCalendar file covering all agenda files.
3720 The file name should be absolute, the file will be overwritten without warning."
3725 "Non-nil means, export to iCalendar files should also cover TODO items."
3733 "Non-nil means, export to iCalendar files should also cover sexp entries.
3734 These are entries like in the diary, but directly in an Org-mode file."
3739 "Amount of text below headline to be included in iCalendar export.
3740 This is a number of characters that should maximally be included.
3741 Properties, scheduling and clocking lines will always be removed.
3742 The text will be inserted into the DESCRIPTION field."
3750 "Calendar name for the combined iCalendar representing all agenda files."
3755 "Font-lock settings for highlighting in Org-mode."
3760 "Non-nil means fontify only the stars in each headline.
3761 When nil, the entire headline is fontified.
3762 Changing it requires restart of `font-lock-mode' to become effective
3763 also in regions already fontified."
3768 "Non-nil means, hide the first N-1 stars in a headline.
3769 This works by using the face `org-hide' for these stars. This
3770 face is white for a light background, and black for a dark
3771 background. You may have to customize the face `org-hide' to
3772 make this work.
3773 Changing it requires restart of `font-lock-mode' to become effective
3774 also in regions already fontified.
3775 You may also set this on a per-file basis by adding one of the following
3776 lines to the buffer:
3778 #+STARTUP: hidestars
3779 #+STARTUP: showstars"
3784 "Non-nil means, change the face of a headline if it is marked DONE.
3785 Normally, only the TODO/DONE keyword indicates the state of a headline.
3786 When this is non-nil, the headline after the keyword is set to the
3787 `org-headline-done' as an additional indication."
3792 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3793 Changing this variable requires a restart of Emacs to take effect."
3798 "Non-nil means, fontify what is treated specially by the exporters."
3803 "Non-nil mean font-lock should hide the emphasis marker characters."
3814 "Set variable and compute the emphasis regular expression."
3818 org-emphasis-alist org-emphasis-regexp-components)
3831 ;; make sure special characters appear at the right position in the class
3843 ;; Make the regexp
3851 body1
3863 body1
3871 "Components used to build the regular expression for emphasis.
3872 This is a list with 6 entries. Terminology: In an emphasis string
3876 specify what is allowed/forbidden in each part:
3878 pre Chars allowed as prematch. Beginning of line will be allowed too.
3879 post Chars allowed as postmatch. End of line will be allowed too.
3880 border The chars *forbidden* as border characters.
3882 non-shy groups here, and don't allow newline here.
3883 newline The maximum number of newlines allowed in an emphasis exp.
3885 Use customize to modify this, or restart Emacs after changing it."
3903 )
3904 "Special syntax for emphasized text.
3905 Text starting and ending with a special character will be emphasized, for
3906 example *bold*, _underlined_ and /italic/. This variable sets the marker
3907 characters, the face to be used by font-lock for highlighting in Org-mode
3908 Emacs buffers, and the HTML tags to be used for this.
3909 Use customize to modify this, or restart Emacs after changing it."
3922 ;;; The faces
3925 "Faces in Org-mode."
3930 "Make a compatible face specification.
3931 If INHERITS is an existing face and if the Emacs version supports it,
3932 just inherit the face. If not, use SPECS to define the face.
3933 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3934 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3935 to the top of the list. The `min-colors' attribute will be removed from
3936 any other entries, and any resulting duplicates will be removed entirely."
3940 ;; In Emacs 23, we use inheritance where possible.
3941 ;; We only do this in Emacs 23, because only there the outline
3942 ;; faces have been changed to the original org-mode-level-faces.
3945 ;; These do not understand the `min-colors' attribute.
3964 "Face used to hide leading stars in headlines.
3965 The forground color of this face should be equal to the background
3966 color of the frame."
3977 "Face used for level 1 headlines."
3987 "Face used for level 2 headlines."
3999 "Face used for level 3 headlines."
4011 "Face used for level 4 headlines."
4019 "Face used for level 5 headlines."
4027 "Face used for level 6 headlines."
4035 "Face used for level 7 headlines."
4043 "Face used for level 8 headlines."
4051 "Face used for special keywords."
4062 "Face used for drawers."
4066 "Face used for the value of a property."
4078 "Face for column display of entry properties."
4082 ;; Make sure that a fixed-width face is used when we have a column table.
4094 "Face for deadlines and TODO keywords."
4107 "Face for headline with the ARCHIVE tag."
4114 "Face for links."
4121 "Face for the ellipsis in folded text."
4128 "Face for links."
4135 "Face for links."
4142 "Face for links."
4147 "Face for tags."
4157 "Face for TODO keywords."
4166 "Face used for todo keywords that indicate DONE items."
4174 "Face used to indicate that a headline is DONE.
4175 This face is only used if `org-fontify-done-headline' is set. If applies
4176 to the part of the headline after the DONE keyword."
4180 "Faces for specific TODO keywords.
4181 This is a list of cons cells, with TODO keywords in the car
4182 and faces in the cdr. The face can be a symbol, or a property
4199 "Face used for tables."
4209 "Face for formulas."
4222 "Face for fixed-with text like code snippets."
4236 "Face for fixed-with text like code snippets."
4248 "Face used in agenda for captions and dates."
4257 "Face for items scheduled for a certain day."
4267 "Face for items scheduled previously, and not yet done."
4277 "Face for items scheduled previously, and not yet done."
4284 "Faces for showing deadlines in the agenda.
4285 This is a list of cons cells. The cdr of each cell is a face to be used,
4287 Each car is a fraction of the head-warning time that must have passed for
4288 this the face in the cdr to be used for display. The numbers must be
4289 given in descending order. The head-warning time is normally taken
4290 from `org-deadline-warning-days', but can also be specified in the deadline
4291 timestamp itself, like this:
4293 DEADLINE: <2007-08-13 Mon -8d>
4295 You may use d for days, w for weeks, m for months and y for years. Months
4296 and years will only be treated in an approximate fashion (30.4 days for a
4297 month and 365.24 days for a year)."
4305 ;; FIXME: this is not a good face yet.
4314 "Face for showing the agenda restriction lock."
4322 "Face used for time grids."
4327 org-level-5 org-level-6 org-level-7 org-level-8
4328 ))
4331 "The number of different faces to be used for headlines.
4332 Org-mode defines 8 different headline faces, so this can be at most 8.
4333 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4337 ;;; Functions and variables from ther packages
4338 ;; Declared here to avoid compiler warnings
4344 ;; XEmacs only
4350 ;; Emacs only
4353 ;; Various packages
4354 ;; FIXME: get the argument lists for the UNKNOWN stuff
4409 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4410 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4441 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4452 ;; backward compatibility to old version of wl
4455 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4468 ;;; Variables for pre-computed regular expressions, all buffer local
4483 "Matches a headline and puts everything into groups:
4484 group 1: the stars
4485 group 2: The todo keyword, maybe
4486 group 3: Priority cookie
4487 group 4: True headline
4491 "Matches a headline and puts TODO state into group 2 if present.
4536 rear-nonsticky t mouse-map t fontified t)
4543 s)
4550 s)
4559 "Modified `buffer-invisibility-spec' for Emacs 21.
4560 Some ops with invisible text do not work correctly on Emacs 21. For these
4561 we turn off invisibility temporarily. Use this in a `let' form."
4565 "Make VAR local in current buffer and set it to VALUE."
4569 "Check if the current buffer is in Org-mode."
4573 "Return the last element of LIST."
4606 "Variable associated with STARTUP options for org-mode.
4607 Each element is a list of three items: The startup options as written
4608 in the #+STARTUP line, the corresponding variable, and the value to
4609 set this variable to if the option is found. An optional forth element PUSH
4613 "Precompute regular expressions for current buffer."
4628 kwds kws0 kwsa key log value cat arch tags const links hw dws
4629 tail sep kws1 prio props drawers)
4653 links)))
4659 props)))
4666 l var val)
4681 )))
4695 ;; Process the TODO keywords
4697 ;; Use the global values as if they had been given locally.
4708 kwsa nil
4711 ;; 1 2
4719 kw)
4721 kws0)
4738 ;; Process the constants
4746 ;; Process the tags.
4756 tgs))
4764 ;; Compute the regular expressions and other local variables
4769 org-drawer-regexp
4773 org-not-done-keywords
4775 org-todo-regexp
4778 org-not-done-regexp
4782 org-todo-line-regexp
4786 org-complex-heading-regexp
4791 org-nl-done-regexp
4795 org-todo-line-tags-regexp
4800 org-looking-at-done-regexp
4805 org-deadline-time-regexp
4807 org-deadline-line-regexp
4809 org-scheduled-regexp
4811 org-scheduled-time-regexp
4813 org-closed-time-regexp
4815 org-keyword-time-regexp
4821 org-keyword-time-not-clock-regexp
4827 org-maybe-keyword-time-regexp
4833 org-planning-or-clock-line-re
4838 )
4843 "Extract the log state setting from a TODO keyword string.
4857 "Remove a pair of parenthesis at the end of each string in LIST."
4861 x))
4862 list))
4864 ;; FIXME: this could be done much better, using second characters etc.
4866 "Assign fast keys to a keyword-key alist.
4867 Respect keys that are already there."
4877 ;; automatically assign a character.
4889 ;;; Some variables ujsed in various places
4894 "Function to be called when `C-c C-c' is used.
4898 ;; FIXME: Occasionally check by commenting these, to make sure
4899 ;; no other functions uses these, forgetting to let-bind them.
4906 ;; Defined somewhere in this file, but used before definition.
4919 ;;;; Emacs/XEmacs compatibility
4921 ;; Overlay compatibility functions
4939 "Make overlay OVL display TEXT with face FACE."
4949 "Make overlay OVL display TEXT with face FACE."
4972 "Find all overlays specifying PROP at POS or point.
4973 If DELETE is non-nil, delete all those overlays."
4975 ov found)
4979 found))
4981 ;; Region compatibility
4984 "Add-hook, compatible with both Emacsen."
4993 "Is `transient-mark-mode' on and the region active?
4994 Works on both Emacs and XEmacs."
4996 nil
5003 ;; Invisibility compatibility
5006 "Add elements to `buffer-invisibility-spec'.
5007 See documentation for `buffer-invisibility-spec' for the kind of elements
5008 that can be added."
5019 "Remove elements from `buffer-invisibility-spec'."
5027 "Is ARG a member of `buffer-invisibility-spec'?"
5030 nil))
5032 ;;;; Define the Org-mode
5035 (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."))
5038 ;; We use a before-change function to check if a table might need
5039 ;; an update.
5041 "Indicates that a table might need an update.
5042 This variable is set by `org-before-change-function'.
5051 ;;;###autoload
5053 "Outline-based notes management and organizer, alias
5056 Org-mode develops organizational tasks around a NOTES file which
5057 contains information about projects as plain text. Org-mode is
5058 implemented on top of outline-mode, which is ideal to keep the content
5059 of large files well structured. It supports ToDo items, deadlines and
5060 time stamps, which magically appear in the diary listing of the Emacs
5061 calendar. Tables are easily created with a built-in table editor.
5062 Plain text URL-like links connect to websites, emails (VM), Usenet
5063 messages (Gnus), BBDB entries, and any files related to the project.
5064 For printing and sharing of notes, an Org-mode file (or a part of it)
5065 can be exported as a structured ASCII or HTML file.
5067 The following commands are available:
5071 ;; Get rid of Outline menus, they are not needed
5072 ;; Need to do this here because define-derived-mode sets up
5073 ;; the keymap so late. Still, it is a waste to call this each time
5074 ;; we switch another buffer into org-mode.
5077 ;; Assume this is Greg's port, it used easymenu
5100 org-display-table 4
5103 org-ellipsis)))
5107 ;; Calc embedded
5114 ;; Activate before-change-function
5118 ;; Check for running clock before killing a buffer
5120 ;; Paragraphs and auto-filling
5125 ;; Comment characters
5126 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
5129 ;; Align options lines
5131 'align-mode-rules-list
5136 ;; Imenu
5140 ;; Make isearch reveal context
5143 ;; Emacs 21 and XEmacs make use of the hook
5145 ;; Emacs 22 deals with this through a special variable
5149 ;; If empty file that did not turn on org-mode automatically, make it to.
5171 "Call COMMAND interactively, but pretend prefix are was ARG."
5177 ;; works also in narrowed buffer, because we start at 1, not point-min
5181 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5191 "Add text properties to entire string, from beginning to end.
5192 PLIST may be a list of properties, PROPS are individual properties and values
5193 that will be added to PLIST. Returns the string that was modified."
5196 string)
5200 ;;;; Font-Lock stuff, including the activators
5205 (org-defkey org-mouse-map
5206 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5207 (when org-mouse-1-follows-link
5208 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5209 (when org-tab-follows-link
5210 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5211 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5212 (when org-return-follows-link
5213 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5214 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5216 (require 'font-lock)
5219 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5220 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5221 (defvar org-link-re-with-space nil
5222 "Matches a link with spaces, optional angular brackets around it.")
5223 (defvar org-link-re-with-space2 nil
5224 "Matches a link with spaces, optional angular brackets around it.")
5225 (defvar org-angle-link-re nil
5226 "Matches link with angular brackets, spaces are allowed.")
5227 (defvar org-plain-link-re nil
5228 "Matches plain link, without spaces.")
5229 (defvar org-bracket-link-regexp nil
5230 "Matches a link in double brackets.")
5231 (defvar org-bracket-link-analytic-regexp nil
5232 "Regular expression used to analyze links.
5233 Here is what the match groups contain after a match:
5234 1: http:
5235 2: http
5236 3: path
5237 4: [desc]
5238 5: desc")
5239 (defvar org-any-link-re nil
5240 "Regular expression matching any link.")
5242 (defun org-make-link-regexps ()
5243 "Update the link regular expressions.
5244 This should be called after the variable `org-link-types' has changed."
5245 (setq org-link-re-with-space
5246 (concat
5249 "[^" org-non-link-chars "]*"
5251 org-link-re-with-space2
5252 (concat
5257 org-angle-link-re
5258 (concat
5261 "[^" org-non-link-chars "]*"
5263 org-plain-link-re
5264 (concat
5267 org-bracket-link-regexp
5269 org-bracket-link-analytic-regexp
5270 (concat
5277 org-any-link-re
5282 (org-make-link-regexps)
5285 "Regular expression for fast time stamp matching.")
5287 "Regular expression for fast time stamp matching.")
5288 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5289 "Regular expression matching time strings for analysis.
5290 This one does not require the space after the date, so it can be used
5291 on a string that terminates immediately after the date.")
5292 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5293 "Regular expression matching time strings for analysis.")
5295 "Regular expression matching time stamps, with groups.")
5297 "Regular expression matching time stamps (also [..]), with groups.")
5298 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5299 "Regular expression matching a time stamp range.")
5300 (defconst org-tr-regexp-both
5301 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5302 "Regular expression matching a time stamp range.")
5305 "Regular expression matching a time stamp or time stamp range.")
5308 "Regular expression matching a time stamp or time stamp range.
5309 The time stamps may be either active or inactive.")
5311 (defvar org-emph-face nil)
5313 (defun org-do-emphasis-faces (limit)
5314 "Run through the buffer and add overlays to links."
5315 (let (rtn)
5316 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5317 (if (not (= (char-after (match-beginning 3))
5318 (char-after (match-beginning 4))))
5319 (progn
5320 (setq rtn t)
5321 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5322 'face
5323 (nth 1 (assoc (match-string 3)
5324 org-emphasis-alist)))
5325 (add-text-properties (match-beginning 2) (match-end 2)
5326 '(font-lock-multiline t))
5327 (when org-hide-emphasis-markers
5328 (add-text-properties (match-end 4) (match-beginning 5)
5329 '(invisible org-link))
5330 (add-text-properties (match-beginning 3) (match-end 3)
5331 '(invisible org-link)))))
5332 (backward-char 1))
5333 rtn))
5335 (defun org-emphasize (&optional char)
5336 "Insert or change an emphasis, i.e. a font like bold or italic.
5337 If there is an active region, change that region to a new emphasis.
5338 If there is no region, just insert the marker characters and position
5339 the cursor between them.
5340 CHAR should be either the marker character, or the first character of the
5341 HTML tag associated with that emphasis. If CHAR is a space, the means
5342 to remove the emphasis of the selected region.
5343 If char is not given (for example in an interactive call) it
5344 will be prompted for."
5345 (interactive)
5346 (let ((eal org-emphasis-alist) e det
5347 (erc org-emphasis-regexp-components)
5348 (prompt "")
5349 (string "") beg end move tag c s)
5350 (if (org-region-active-p)
5351 (setq beg (region-beginning) end (region-end)
5352 string (buffer-substring beg end))
5353 (setq move t))
5355 (while (setq e (pop eal))
5356 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5357 c (aref tag 0))
5358 (push (cons c (string-to-char (car e))) det)
5359 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5360 (substring tag 1)))))
5361 (unless char
5362 (message "%s" (concat "Emphasis marker or tag:" prompt))
5363 (setq char (read-char-exclusive)))
5364 (setq char (or (cdr (assoc char det)) char))
5365 (if (equal char ?\ )
5366 (setq s "" move nil)
5367 (unless (assoc (char-to-string char) org-emphasis-alist)
5369 (setq s (char-to-string char)))
5370 (while (and (> (length string) 1)
5371 (equal (substring string 0 1) (substring string -1))
5372 (assoc (substring string 0 1) org-emphasis-alist))
5373 (setq string (substring string 1 -1)))
5374 (setq string (concat s string s))
5375 (if beg (delete-region beg end))
5376 (unless (or (bolp)
5378 (char-to-string (char-before (point)))))
5379 (insert " "))
5381 (char-to-string (char-after (point))))
5382 (insert " ") (backward-char 1))
5383 (insert string)
5384 (and move (backward-char 1))))
5386 (defconst org-nonsticky-props
5387 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5390 (defun org-activate-plain-links (limit)
5391 "Run through the buffer and add overlays to links."
5392 (catch 'exit
5393 (let (f)
5394 (while (re-search-forward org-plain-link-re limit t)
5395 (setq f (get-text-property (match-beginning 0) 'face))
5396 (if (or (eq f 'org-tag)
5397 (and (listp f) (memq 'org-tag f)))
5398 nil
5399 (add-text-properties (match-beginning 0) (match-end 0)
5400 (list 'mouse-face 'highlight
5401 'rear-nonsticky org-nonsticky-props
5402 'keymap org-mouse-map
5403 ))
5404 (throw 'exit t))))))
5406 (defun org-activate-code (limit)
5408 (unless (get-text-property (match-beginning 1) 'face)
5409 (remove-text-properties (match-beginning 0) (match-end 0)
5410 '(display t invisible t intangible t))
5411 t)))
5413 (defun org-activate-angle-links (limit)
5414 "Run through the buffer and add overlays to links."
5415 (if (re-search-forward org-angle-link-re limit t)
5416 (progn
5417 (add-text-properties (match-beginning 0) (match-end 0)
5418 (list 'mouse-face 'highlight
5419 'rear-nonsticky org-nonsticky-props
5420 'keymap org-mouse-map
5421 ))
5422 t)))
5424 (defmacro org-maybe-intangible (props)
5425 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5426 In emacs 21, invisible text is not avoided by the command loop, so the
5427 intangible property is needed to make sure point skips this text.
5428 In Emacs 22, this is not necessary. The intangible text property has
5429 led to problems with flyspell. These problems are fixed in flyspell.el,
5430 but we still avoid setting the property in Emacs 22 and later.
5431 We use a macro so that the test can happen at compilation time."
5432 (if (< emacs-major-version 22)
5433 `(append '(intangible t) ,props)
5434 props))
5436 (defun org-activate-bracket-links (limit)
5437 "Run through the buffer and add overlays to bracketed links."
5438 (if (re-search-forward org-bracket-link-regexp limit t)
5439 (let* ((help (concat "LINK: "
5440 (org-match-string-no-properties 1)))
5441 ;; FIXME: above we should remove the escapes.
5442 ;; but that requires another match, protecting match data,
5443 ;; a lot of overhead for font-lock.
5444 (ip (org-maybe-intangible
5445 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5446 'keymap org-mouse-map 'mouse-face 'highlight
5447 'font-lock-multiline t 'help-echo help)))
5448 (vp (list 'rear-nonsticky org-nonsticky-props
5449 'keymap org-mouse-map 'mouse-face 'highlight
5450 ' font-lock-multiline t 'help-echo help)))
5451 ;; We need to remove the invisible property here. Table narrowing
5452 ;; may have made some of this invisible.
5453 (remove-text-properties (match-beginning 0) (match-end 0)
5454 '(invisible nil))
5455 (if (match-end 3)
5456 (progn
5457 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5458 (add-text-properties (match-beginning 3) (match-end 3) vp)
5459 (add-text-properties (match-end 3) (match-end 0) ip))
5460 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5461 (add-text-properties (match-beginning 1) (match-end 1) vp)
5462 (add-text-properties (match-end 1) (match-end 0) ip))
5463 t)))
5465 (defun org-activate-dates (limit)
5466 "Run through the buffer and add overlays to dates."
5467 (if (re-search-forward org-tsr-regexp-both limit t)
5468 (progn
5469 (add-text-properties (match-beginning 0) (match-end 0)
5470 (list 'mouse-face 'highlight
5471 'rear-nonsticky org-nonsticky-props
5472 'keymap org-mouse-map))
5473 (when org-display-custom-times
5474 (if (match-end 3)
5475 (org-display-custom-time (match-beginning 3) (match-end 3)))
5476 (org-display-custom-time (match-beginning 1) (match-end 1)))
5477 t)))
5479 (defvar org-target-link-regexp nil
5480 "Regular expression matching radio targets in plain text.")
5482 "Regular expression matching a link target.")
5484 "Regular expression matching a radio target.")
5485 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5486 "Regular expression matching any target.")
5488 (defun org-activate-target-links (limit)
5489 "Run through the buffer and add overlays to target matches."
5490 (when org-target-link-regexp
5491 (let ((case-fold-search t))
5492 (if (re-search-forward org-target-link-regexp limit t)
5493 (progn
5494 (add-text-properties (match-beginning 0) (match-end 0)
5495 (list 'mouse-face 'highlight
5496 'rear-nonsticky org-nonsticky-props
5497 'keymap org-mouse-map
5498 'help-echo "Radio target link"
5499 'org-linked-text t))
5500 t)))))
5502 (defun org-update-radio-target-regexp ()
5503 "Find all radio targets in this file and update the regular expression."
5504 (interactive)
5505 (when (memq 'radio org-activate-links)
5506 (setq org-target-link-regexp
5507 (org-make-target-link-regexp (org-all-targets 'radio)))
5508 (org-restart-font-lock)))
5510 (defun org-hide-wide-columns (limit)
5511 (let (s e)
5512 (setq s (text-property-any (point) (or limit (point-max))
5513 'org-cwidth t))
5514 (when s
5515 (setq e (next-single-property-change s 'org-cwidth))
5516 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5517 (goto-char e)
5518 t)))
5520 (defvar org-latex-and-specials-regexp nil
5521 "Regular expression for highlighting export special stuff.")
5522 (defvar org-match-substring-regexp)
5523 (defvar org-match-substring-with-braces-regexp)
5524 (defvar org-export-html-special-string-regexps)
5526 (defun org-compute-latex-and-specials-regexp ()
5527 "Compute regular expression for stuff treated specially by exporters."
5528 (if (not org-highlight-latex-fragments-and-specials)
5529 (org-set-local 'org-latex-and-specials-regexp nil)
5530 (let*
5531 ((matchers (plist-get org-format-latex-options :matchers))
5532 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5533 org-latex-regexps)))
5534 (options (org-combine-plists (org-default-export-plist)
5535 (org-infile-export-plist)))
5536 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5537 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5538 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5539 (org-export-html-expand (plist-get options :expand-quoted-html))
5540 (org-export-with-special-strings (plist-get options :special-strings))
5541 (re-sub
5542 (cond
5543 ((equal org-export-with-sub-superscripts '{})
5544 (list org-match-substring-with-braces-regexp))
5545 (org-export-with-sub-superscripts
5546 (list org-match-substring-regexp))
5547 (t nil)))
5548 (re-latex
5549 (if org-export-with-LaTeX-fragments
5550 (mapcar (lambda (x) (nth 1 x)) latexs)))
5551 (re-macros
5552 (if org-export-with-TeX-macros
5554 (regexp-opt
5555 (append (mapcar 'car org-html-entities)
5556 (if (boundp 'org-latex-entities)
5557 org-latex-entities nil))
5558 'words))) ; FIXME
5559 ))
5561 (re-special (if org-export-with-special-strings
5562 (mapcar (lambda (x) (car x))
5563 org-export-html-special-string-regexps)))
5564 (re-rest
5565 (delq nil
5566 (list
5568 ))))
5569 (org-set-local
5570 'org-latex-and-specials-regexp
5571 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5574 (defface org-latex-and-export-specials
5575 (let ((font (cond ((assq :inherit custom-face-attributes)
5576 '(:inherit underline))
5577 (t '(:underline t)))))
5578 `((((class grayscale) (background light))
5579 (:foreground "DimGray" ,@font))
5580 (((class grayscale) (background dark))
5581 (:foreground "LightGray" ,@font))
5582 (((class color) (background light))
5583 (:foreground "SaddleBrown"))
5584 (((class color) (background dark))
5585 (:foreground "burlywood"))
5586 (t (,@font))))
5587 "Face used to highlight math latex and other special exporter stuff."
5588 :group 'org-faces)
5590 (defun org-do-latex-and-special-faces (limit)
5591 "Run through the buffer and add overlays to links."
5592 (when org-latex-and-specials-regexp
5593 (let (rtn d)
5594 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5595 limit t))
5596 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5597 'face))
5598 '(org-code org-verbatim underline)))
5599 (progn
5600 (setq rtn t
5601 d (cond ((member (char-after (1+ (match-beginning 0)))
5602 '(?_ ?^)) 1)
5603 (t 0)))
5604 (font-lock-prepend-text-property
5605 (+ d (match-beginning 0)) (match-end 0)
5606 'face 'org-latex-and-export-specials)
5607 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5608 '(font-lock-multiline t)))))
5609 rtn)))
5611 (defun org-restart-font-lock ()
5612 "Restart font-lock-mode, to force refontification."
5613 (when (and (boundp 'font-lock-mode) font-lock-mode)
5614 (font-lock-mode -1)
5615 (font-lock-mode 1)))
5617 (defun org-all-targets (&optional radio)
5618 "Return a list of all targets in this file.
5619 With optional argument RADIO, only find radio targets."
5620 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5621 rtn)
5622 (save-excursion
5623 (goto-char (point-min))
5624 (while (re-search-forward re nil t)
5625 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5626 rtn)))
5628 (defun org-make-target-link-regexp (targets)
5629 "Make regular expression matching all strings in TARGETS.
5630 The regular expression finds the targets also if there is a line break
5631 between words."
5632 (and targets
5633 (concat
5635 (mapconcat
5636 (lambda (x)
5637 (while (string-match " +" x)
5639 x)
5640 targets
5644 (defun org-activate-tags (limit)
5646 (progn
5647 (add-text-properties (match-beginning 1) (match-end 1)
5648 (list 'mouse-face 'highlight
5649 'rear-nonsticky org-nonsticky-props
5650 'keymap org-mouse-map))
5651 t)))
5653 (defun org-outline-level ()
5654 (save-excursion
5655 (looking-at outline-regexp)
5656 (if (match-beginning 1)
5657 (+ (org-get-string-indentation (match-string 1)) 1000)
5658 (1- (- (match-end 0) (match-beginning 0))))))
5660 (defvar org-font-lock-keywords nil)
5663 "Regular expression matching a property line.")
5665 (defun org-set-font-lock-defaults ()
5666 (let* ((em org-fontify-emphasized-text)
5667 (lk org-activate-links)
5668 (org-font-lock-extra-keywords
5669 (list
5670 ;; Headlines
5672 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5673 ;; Table lines
5675 (1 'org-table t))
5676 ;; Table internals
5680 ;; Drawers
5681 (list org-drawer-regexp '(0 'org-special-keyword t))
5683 ;; Properties
5684 (list org-property-re
5685 '(1 'org-special-keyword t)
5686 '(3 'org-property-value t))
5687 (if org-format-transports-properties-p
5689 ;; Links
5690 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5691 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5692 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5693 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5694 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5695 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5697 '(org-hide-wide-columns (0 nil append))
5698 ;; TODO lines
5700 '(1 (org-get-todo-face 1) t))
5701 ;; DONE
5702 (if org-fontify-done-headline
5706 '(2 'org-headline-done t))
5707 nil)
5708 ;; Priorities
5710 ;; Special keywords
5715 ;; Emphasis
5716 (if em
5717 (if (featurep 'xemacs)
5718 '(org-do-emphasis-faces (0 nil append))
5719 '(org-do-emphasis-faces)))
5720 ;; Checkboxes
5722 2 'bold prepend)
5723 (if org-provide-checkbox-statistics
5725 (0 (org-get-checkbox-statistics-face) t)))
5727 '(1 'org-archived prepend))
5728 ;; Specials
5729 '(org-do-latex-and-special-faces)
5730 ;; Code
5731 '(org-activate-code (1 'org-code t))
5732 ;; COMMENT
5735 '(1 'org-special-keyword t))
5736 '("^#.*" (0 'font-lock-comment-face t))
5737 )))
5738 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5739 ;; Now set the full font-lock-keywords
5740 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5741 (org-set-local 'font-lock-defaults
5742 '(org-font-lock-keywords t nil nil backward-paragraph))
5743 (kill-local-variable 'font-lock-keywords) nil))
5745 (defvar org-m nil)
5746 (defvar org-l nil)
5747 (defvar org-f nil)
5748 (defun org-get-level-face (n)
5749 "Get the right face for match N in font-lock matching of healdines."
5750 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5751 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5752 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5753 (cond
5754 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5755 ((eq n 2) org-f)
5756 (t (if org-level-color-stars-only nil org-f))))
5758 (defun org-get-todo-face (kwd)
5759 "Get the right face for a TODO keyword KWD.
5760 If KWD is a number, get the corresponding match group."
5761 (if (numberp kwd) (setq kwd (match-string kwd)))
5762 (or (cdr (assoc kwd org-todo-keyword-faces))
5763 (and (member kwd org-done-keywords) 'org-done)
5764 'org-todo))
5766 (defun org-unfontify-region (beg end &optional maybe_loudly)
5767 "Remove fontification and activation overlays from links."
5768 (font-lock-default-unfontify-region beg end)
5769 (let* ((buffer-undo-list t)
5770 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5771 (inhibit-modification-hooks t)
5772 deactivate-mark buffer-file-name buffer-file-truename)
5773 (remove-text-properties beg end
5774 '(mouse-face t keymap t org-linked-text t
5775 invisible t intangible t))))
5777 ;;;; Visibility cycling, including org-goto and indirect buffer
5779 ;;; Cycling
5781 (defvar org-cycle-global-status nil)
5782 (make-variable-buffer-local 'org-cycle-global-status)
5783 (defvar org-cycle-subtree-status nil)
5784 (make-variable-buffer-local 'org-cycle-subtree-status)
5786 ;;;###autoload
5787 (defun org-cycle (&optional arg)
5788 "Visibility cycling for Org-mode.
5790 - When this function is called with a prefix argument, rotate the entire
5791 buffer through 3 states (global cycling)
5792 1. OVERVIEW: Show only top-level headlines.
5793 2. CONTENTS: Show all headlines of all levels, but no body text.
5794 3. SHOW ALL: Show everything.
5796 - When point is at the beginning of a headline, rotate the subtree started
5797 by this line through 3 different states (local cycling)
5798 1. FOLDED: Only the main headline is shown.
5799 2. CHILDREN: The main headline and the direct children are shown.
5800 From this state, you can move to one of the children
5801 and zoom in further.
5802 3. SUBTREE: Show the entire subtree, including body text.
5804 - When there is a numeric prefix, go up to a heading with level ARG, do
5805 a `show-subtree' and return to the previous cursor position. If ARG
5806 is negative, go up that many levels.
5808 - When point is not at the beginning of a headline, execute
5809 `indent-relative', like TAB normally does. See the option
5810 `org-cycle-emulate-tab' for details.
5812 - Special case: if point is at the beginning of the buffer and there is
5813 no headline in line 1, this function will act as if called with prefix arg.
5814 But only if also the variable `org-cycle-global-at-bob' is t."
5815 (interactive "P")
5816 (let* ((outline-regexp
5817 (if (and (org-mode-p) org-cycle-include-plain-lists)
5819 outline-regexp))
5820 (bob-special (and org-cycle-global-at-bob (bobp)
5821 (not (looking-at outline-regexp))))
5822 (org-cycle-hook
5823 (if bob-special
5824 (delq 'org-optimize-window-after-visibility-change
5825 (copy-sequence org-cycle-hook))
5826 org-cycle-hook))
5827 (pos (point)))
5829 (if (or bob-special (equal arg '(4)))
5830 ;; special case: use global cycling
5831 (setq arg t))
5833 (cond
5835 ((org-at-table-p 'any)
5836 ;; Enter the table or move to the next field in the table
5837 (or (org-table-recognize-table.el)
5838 (progn
5839 (if arg (org-table-edit-field t)
5840 (org-table-justify-field-maybe)
5841 (call-interactively 'org-table-next-field)))))
5843 ((eq arg t) ;; Global cycling
5845 (cond
5846 ((and (eq last-command this-command)
5847 (eq org-cycle-global-status 'overview))
5848 ;; We just created the overview - now do table of contents
5849 ;; This can be slow in very large buffers, so indicate action
5850 (message "CONTENTS...")
5851 (org-content)
5852 (message "CONTENTS...done")
5853 (setq org-cycle-global-status 'contents)
5854 (run-hook-with-args 'org-cycle-hook 'contents))
5856 ((and (eq last-command this-command)
5857 (eq org-cycle-global-status 'contents))
5858 ;; We just showed the table of contents - now show everything
5859 (show-all)
5860 (message "SHOW ALL")
5861 (setq org-cycle-global-status 'all)
5862 (run-hook-with-args 'org-cycle-hook 'all))
5864 (t
5865 ;; Default action: go to overview
5866 (org-overview)
5867 (message "OVERVIEW")
5868 (setq org-cycle-global-status 'overview)
5869 (run-hook-with-args 'org-cycle-hook 'overview))))
5871 ((and org-drawers org-drawer-regexp
5872 (save-excursion
5873 (beginning-of-line 1)
5874 (looking-at org-drawer-regexp)))
5875 ;; Toggle block visibility
5876 (org-flag-drawer
5877 (not (get-char-property (match-end 0) 'invisible))))
5879 ((integerp arg)
5880 ;; Show-subtree, ARG levels up from here.
5881 (save-excursion
5882 (org-back-to-heading)
5883 (outline-up-heading (if (< arg 0) (- arg)
5884 (- (funcall outline-level) arg)))
5885 (org-show-subtree)))
5887 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5888 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5889 ;; At a heading: rotate between three different views
5890 (org-back-to-heading)
5891 (let ((goal-column 0) eoh eol eos)
5892 ;; First, some boundaries
5893 (save-excursion
5894 (org-back-to-heading)
5895 (save-excursion
5896 (beginning-of-line 2)
5897 (while (and (not (eobp)) ;; this is like `next-line'
5898 (get-char-property (1- (point)) 'invisible))
5899 (beginning-of-line 2)) (setq eol (point)))
5900 (outline-end-of-heading) (setq eoh (point))
5901 (org-end-of-subtree t)
5902 (unless (eobp)
5904 (beginning-of-line 1) ; in case this is an item
5905 )
5906 (setq eos (1- (point))))
5907 ;; Find out what to do next and set `this-command'
5908 (cond
5909 ((= eos eoh)
5910 ;; Nothing is hidden behind this heading
5911 (message "EMPTY ENTRY")
5912 (setq org-cycle-subtree-status nil)
5913 (save-excursion
5914 (goto-char eos)
5915 (outline-next-heading)
5916 (if (org-invisible-p) (org-flag-heading nil))))
5917 ((or (>= eol eos)
5919 ;; Entire subtree is hidden in one line: open it
5920 (org-show-entry)
5921 (show-children)
5922 (message "CHILDREN")
5923 (save-excursion
5924 (goto-char eos)
5925 (outline-next-heading)
5926 (if (org-invisible-p) (org-flag-heading nil)))
5927 (setq org-cycle-subtree-status 'children)
5928 (run-hook-with-args 'org-cycle-hook 'children))
5929 ((and (eq last-command this-command)
5930 (eq org-cycle-subtree-status 'children))
5931 ;; We just showed the children, now show everything.
5932 (org-show-subtree)
5933 (message "SUBTREE")
5934 (setq org-cycle-subtree-status 'subtree)
5935 (run-hook-with-args 'org-cycle-hook 'subtree))
5936 (t
5937 ;; Default action: hide the subtree.
5938 (hide-subtree)
5939 (message "FOLDED")
5940 (setq org-cycle-subtree-status 'folded)
5941 (run-hook-with-args 'org-cycle-hook 'folded)))))
5943 ;; TAB emulation
5944 (buffer-read-only (org-back-to-heading))
5946 ((org-try-cdlatex-tab))
5948 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5949 (or (not (bolp))
5950 (not (looking-at outline-regexp))))
5953 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5955 (or (and (eq org-cycle-emulate-tab 'white)
5956 (= (match-end 0) (point-at-eol)))
5957 (and (eq org-cycle-emulate-tab 'whitestart)
5958 (>= (match-end 0) pos))))
5959 t
5960 (eq org-cycle-emulate-tab t))
5963 ; (point-at-bol) (point))))
5964 ; (progn
5965 ; (beginning-of-line 1)
5969 (t (save-excursion
5970 (org-back-to-heading)
5971 (org-cycle))))))
5973 ;;;###autoload
5974 (defun org-global-cycle (&optional arg)
5975 "Cycle the global visibility. For details see `org-cycle'."
5976 (interactive "P")
5977 (let ((org-cycle-include-plain-lists
5978 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5979 (if (integerp arg)
5980 (progn
5981 (show-all)
5982 (hide-sublevels arg)
5983 (setq org-cycle-global-status 'contents))
5984 (org-cycle '(4)))))
5986 (defun org-overview ()
5987 "Switch to overview mode, shoing only top-level headlines.
5988 Really, this shows all headlines with level equal or greater than the level
5989 of the first headline in the buffer. This is important, because if the
5990 first headline is not level one, then (hide-sublevels 1) gives confusing
5991 results."
5992 (interactive)
5993 (let ((level (save-excursion
5994 (goto-char (point-min))
5995 (if (re-search-forward (concat "^" outline-regexp) nil t)
5996 (progn
5997 (goto-char (match-beginning 0))
5998 (funcall outline-level))))))
5999 (and level (hide-sublevels level))))
6001 (defun org-content (&optional arg)
6002 "Show all headlines in the buffer, like a table of contents.
6003 With numerical argument N, show content up to level N."
6004 (interactive "P")
6005 (save-excursion
6006 ;; Visit all headings and show their offspring
6007 (and (integerp arg) (org-overview))
6008 (goto-char (point-max))
6009 (catch 'exit
6010 (while (and (progn (condition-case nil
6011 (outline-previous-visible-heading 1)
6012 (error (goto-char (point-min))))
6013 t)
6014 (looking-at outline-regexp))
6015 (if (integerp arg)
6016 (show-children (1- arg))
6017 (show-branches))
6018 (if (bobp) (throw 'exit nil))))))
6021 (defun org-optimize-window-after-visibility-change (state)
6022 "Adjust the window after a change in outline visibility.
6023 This function is the default value of the hook `org-cycle-hook'."
6024 (when (get-buffer-window (current-buffer))
6025 (cond
6026 ; ((eq state 'overview) (org-first-headline-recenter 1))
6027 ; ((eq state 'overview) (org-beginning-of-line))
6028 ((eq state 'content) nil)
6029 ((eq state 'all) nil)
6030 ((eq state 'folded) nil)
6031 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6032 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6034 (defun org-compact-display-after-subtree-move ()
6035 (let (beg end)
6036 (save-excursion
6037 (if (org-up-heading-safe)
6038 (progn
6039 (hide-subtree)
6040 (show-entry)
6041 (show-children)
6042 (org-cycle-show-empty-lines 'children)
6043 (org-cycle-hide-drawers 'children))
6044 (org-overview)))))
6046 (defun org-cycle-show-empty-lines (state)
6047 "Show empty lines above all visible headlines.
6048 The region to be covered depends on STATE when called through
6049 `org-cycle-hook'. Lisp program can use t for STATE to get the
6050 entire buffer covered. Note that an empty line is only shown if there
6051 are at least `org-cycle-separator-lines' empty lines before the headeline."
6052 (when (> org-cycle-separator-lines 0)
6053 (save-excursion
6054 (let* ((n org-cycle-separator-lines)
6055 (re (cond
6058 (t (let ((ns (number-to-string (- n 2))))
6061 beg end)
6062 (cond
6063 ((memq state '(overview contents t))
6064 (setq beg (point-min) end (point-max)))
6065 ((memq state '(children folded))
6066 (setq beg (point) end (progn (org-end-of-subtree t t)
6067 (beginning-of-line 2)
6068 (point)))))
6069 (when beg
6070 (goto-char beg)
6071 (while (re-search-forward re end t)
6072 (if (not (get-char-property (match-end 1) 'invisible))
6073 (outline-flag-region
6074 (match-beginning 1) (match-end 1) nil)))))))
6075 ;; Never hide empty lines at the end of the file.
6076 (save-excursion
6077 (goto-char (point-max))
6078 (outline-previous-heading)
6079 (outline-end-of-heading)
6081 (= (match-end 0) (point-max)))
6082 (outline-flag-region (point) (match-end 0) nil))))
6084 (defun org-subtree-end-visible-p ()
6085 "Is the end of the current subtree visible?"
6086 (pos-visible-in-window-p
6087 (save-excursion (org-end-of-subtree t) (point))))
6089 (defun org-first-headline-recenter (&optional N)
6090 "Move cursor to the first headline and recenter the headline.
6091 Optional argument N means, put the headline into the Nth line of the window."
6092 (goto-char (point-min))
6094 (beginning-of-line)
6095 (recenter (prefix-numeric-value N))))
6097 ;;; Org-goto
6099 (defvar org-goto-window-configuration nil)
6100 (defvar org-goto-marker nil)
6101 (defvar org-goto-map
6102 (let ((map (make-sparse-keymap)))
6103 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6104 (while (setq cmd (pop cmds))
6105 (substitute-key-definition cmd cmd map global-map)))
6106 (suppress-keymap map)
6107 (org-defkey map "\C-m" 'org-goto-ret)
6108 (org-defkey map [(return)] 'org-goto-ret)
6109 (org-defkey map [(left)] 'org-goto-left)
6110 (org-defkey map [(right)] 'org-goto-right)
6111 (org-defkey map [(control ?g)] 'org-goto-quit)
6112 (org-defkey map "\C-i" 'org-cycle)
6113 (org-defkey map [(tab)] 'org-cycle)
6114 (org-defkey map [(down)] 'outline-next-visible-heading)
6115 (org-defkey map [(up)] 'outline-previous-visible-heading)
6116 (if org-goto-auto-isearch
6117 (if (fboundp 'define-key-after)
6118 (define-key-after map [t] 'org-goto-local-auto-isearch)
6119 nil)
6120 (org-defkey map "q" 'org-goto-quit)
6121 (org-defkey map "n" 'outline-next-visible-heading)
6122 (org-defkey map "p" 'outline-previous-visible-heading)
6123 (org-defkey map "f" 'outline-forward-same-level)
6124 (org-defkey map "b" 'outline-backward-same-level)
6125 (org-defkey map "u" 'outline-up-heading))
6126 (org-defkey map "/" 'org-occur)
6127 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6128 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6129 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6130 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6131 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6132 map))
6134 (defconst org-goto-help
6135 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6136 RET=jump to location [Q]uit and return to previous location
6137 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6139 (defvar org-goto-start-pos) ; dynamically scoped parameter
6141 (defun org-goto (&optional alternative-interface)
6142 "Look up a different location in the current file, keeping current visibility.
6144 When you want look-up or go to a different location in a document, the
6145 fastest way is often to fold the entire buffer and then dive into the tree.
6146 This method has the disadvantage, that the previous location will be folded,
6147 which may not be what you want.
6149 This command works around this by showing a copy of the current buffer
6150 in an indirect buffer, in overview mode. You can dive into the tree in
6151 that copy, use org-occur and incremental search to find a location.
6152 When pressing RET or `Q', the command returns to the original buffer in
6153 which the visibility is still unchanged. After RET is will also jump to
6154 the location selected in the indirect buffer and expose the
6155 the headline hierarchy above."
6156 (interactive "P")
6157 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
6158 (org-refile-use-outline-path t)
6159 (interface
6160 (if (not alternative-interface)
6161 org-goto-interface
6162 (if (eq org-goto-interface 'outline)
6163 'outline-path-completion
6164 'outline)))
6165 (org-goto-start-pos (point))
6166 (selected-point
6167 (if (eq interface 'outline)
6168 (car (org-get-location (current-buffer) org-goto-help))
6169 (nth 3 (org-refile-get-location "Goto: ")))))
6170 (if selected-point
6171 (progn
6172 (org-mark-ring-push org-goto-start-pos)
6173 (goto-char selected-point)
6174 (if (or (org-invisible-p) (org-invisible-p2))
6175 (org-show-context 'org-goto)))
6176 (message "Quit"))))
6178 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6179 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6180 (defvar org-goto-local-auto-isearch-map) ; defined below
6182 (defun org-get-location (buf help)
6183 "Let the user select a location in the Org-mode buffer BUF.
6184 This function uses a recursive edit. It returns the selected position
6185 or nil."
6186 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6187 (isearch-hide-immediately nil)
6188 (isearch-search-fun-function
6189 (lambda () 'org-goto-local-search-forward-headings))
6190 (org-goto-selected-point org-goto-exit-command))
6191 (save-excursion
6192 (save-window-excursion
6193 (delete-other-windows)
6194 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6195 (switch-to-buffer
6196 (condition-case nil
6197 (make-indirect-buffer (current-buffer) "*org-goto*")
6198 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6199 (with-output-to-temp-buffer "*Help*"
6200 (princ help))
6201 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6202 (setq buffer-read-only nil)
6203 (let ((org-startup-truncated t)
6204 (org-startup-folded nil)
6205 (org-startup-align-all-tables nil))
6206 (org-mode)
6207 (org-overview))
6208 (setq buffer-read-only t)
6209 (if (and (boundp 'org-goto-start-pos)
6210 (integer-or-marker-p org-goto-start-pos))
6211 (let ((org-show-hierarchy-above t)
6212 (org-show-siblings t)
6213 (org-show-following-heading t))
6214 (goto-char org-goto-start-pos)
6215 (and (org-invisible-p) (org-show-context)))
6216 (goto-char (point-min)))
6217 (org-beginning-of-line)
6218 (message "Select location and press RET")
6219 (use-local-map org-goto-map)
6220 (recursive-edit)
6221 ))
6222 (kill-buffer "*org-goto*")
6223 (cons org-goto-selected-point org-goto-exit-command)))
6225 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6226 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6227 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6228 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6230 (defun org-goto-local-search-forward-headings (string bound noerror)
6231 "Search and make sure that anu matches are in headlines."
6232 (catch 'return
6233 (while (search-forward string bound noerror)
6234 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6235 (and (member :headline context)
6236 (not (member :tags context))))
6237 (throw 'return (point))))))
6239 (defun org-goto-local-auto-isearch ()
6240 "Start isearch."
6241 (interactive)
6242 (goto-char (point-min))
6243 (let ((keys (this-command-keys)))
6244 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6245 (isearch-mode t)
6246 (isearch-process-search-char (string-to-char keys)))))
6248 (defun org-goto-ret (&optional arg)
6249 "Finish `org-goto' by going to the new location."
6250 (interactive "P")
6251 (setq org-goto-selected-point (point)
6252 org-goto-exit-command 'return)
6253 (throw 'exit nil))
6255 (defun org-goto-left ()
6256 "Finish `org-goto' by going to the new location."
6257 (interactive)
6258 (if (org-on-heading-p)
6259 (progn
6260 (beginning-of-line 1)
6261 (setq org-goto-selected-point (point)
6262 org-goto-exit-command 'left)
6263 (throw 'exit nil))
6264 (error "Not on a heading")))
6266 (defun org-goto-right ()
6267 "Finish `org-goto' by going to the new location."
6268 (interactive)
6269 (if (org-on-heading-p)
6270 (progn
6271 (setq org-goto-selected-point (point)
6272 org-goto-exit-command 'right)
6273 (throw 'exit nil))
6274 (error "Not on a heading")))
6276 (defun org-goto-quit ()
6277 "Finish `org-goto' without cursor motion."
6278 (interactive)
6279 (setq org-goto-selected-point nil)
6280 (setq org-goto-exit-command 'quit)
6281 (throw 'exit nil))
6283 ;;; Indirect buffer display of subtrees
6285 (defvar org-indirect-dedicated-frame nil
6286 "This is the frame being used for indirect tree display.")
6287 (defvar org-last-indirect-buffer nil)
6289 (defun org-tree-to-indirect-buffer (&optional arg)
6290 "Create indirect buffer and narrow it to current subtree.
6291 With numerical prefix ARG, go up to this level and then take that tree.
6292 If ARG is negative, go up that many levels.
6293 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6294 indirect buffer previously made with this command, to avoid proliferation of
6295 indirect buffers. However, when you call the command with a `C-u' prefix, or
6296 when `org-indirect-buffer-display' is `new-frame', the last buffer
6297 is kept so that you can work with several indirect buffers at the same time.
6298 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6299 requests that a new frame be made for the new buffer, so that the dedicated
6300 frame is not changed."
6301 (interactive "P")
6302 (let ((cbuf (current-buffer))
6303 (cwin (selected-window))
6304 (pos (point))
6305 beg end level heading ibuf)
6306 (save-excursion
6307 (org-back-to-heading t)
6308 (when (numberp arg)
6309 (setq level (org-outline-level))
6310 (if (< arg 0) (setq arg (+ level arg)))
6311 (while (> (setq level (org-outline-level)) arg)
6312 (outline-up-heading 1 t)))
6313 (setq beg (point)
6314 heading (org-get-heading))
6315 (org-end-of-subtree t) (setq end (point)))
6316 (if (and (buffer-live-p org-last-indirect-buffer)
6317 (not (eq org-indirect-buffer-display 'new-frame))
6318 (not arg))
6319 (kill-buffer org-last-indirect-buffer))
6320 (setq ibuf (org-get-indirect-buffer cbuf)
6321 org-last-indirect-buffer ibuf)
6322 (cond
6323 ((or (eq org-indirect-buffer-display 'new-frame)
6324 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6325 (select-frame (make-frame))
6326 (delete-other-windows)
6327 (switch-to-buffer ibuf)
6328 (org-set-frame-title heading))
6329 ((eq org-indirect-buffer-display 'dedicated-frame)
6330 (raise-frame
6331 (select-frame (or (and org-indirect-dedicated-frame
6332 (frame-live-p org-indirect-dedicated-frame)
6333 org-indirect-dedicated-frame)
6334 (setq org-indirect-dedicated-frame (make-frame)))))
6335 (delete-other-windows)
6336 (switch-to-buffer ibuf)
6337 (org-set-frame-title (concat "Indirect: " heading)))
6338 ((eq org-indirect-buffer-display 'current-window)
6339 (switch-to-buffer ibuf))
6340 ((eq org-indirect-buffer-display 'other-window)
6341 (pop-to-buffer ibuf))
6342 (t (error "Invalid value.")))
6343 (if (featurep 'xemacs)
6344 (save-excursion (org-mode) (turn-on-font-lock)))
6345 (narrow-to-region beg end)
6346 (show-all)
6347 (goto-char pos)
6348 (and (window-live-p cwin) (select-window cwin))))
6350 (defun org-get-indirect-buffer (&optional buffer)
6351 (setq buffer (or buffer (current-buffer)))
6352 (let ((n 1) (base (buffer-name buffer)) bname)
6353 (while (buffer-live-p
6354 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6355 (setq n (1+ n)))
6356 (condition-case nil
6357 (make-indirect-buffer buffer bname 'clone)
6358 (error (make-indirect-buffer buffer bname)))))
6360 (defun org-set-frame-title (title)
6361 "Set the title of the current frame to the string TITLE."
6362 ;; FIXME: how to name a single frame in XEmacs???
6363 (unless (featurep 'xemacs)
6364 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6366 ;;;; Structure editing
6368 ;;; Inserting headlines
6370 (defun org-insert-heading (&optional force-heading)
6371 "Insert a new heading or item with same depth at point.
6372 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6373 If point is at the beginning of a headline, insert a sibling before the
6374 current headline. If point is not at the beginning, do not split the line,
6375 but create the new hedline after the current line."
6376 (interactive "P")
6377 (if (= (buffer-size) 0)
6379 (when (or force-heading (not (org-insert-item)))
6380 (let* ((head (save-excursion
6381 (condition-case nil
6382 (progn
6383 (org-back-to-heading)
6384 (match-string 0))
6385 (error "*"))))
6386 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6387 pos)
6388 (cond
6389 ((and (org-on-heading-p) (bolp)
6390 (or (bobp)
6391 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6392 ;; insert before the current line
6393 (open-line (if blank 2 1)))
6394 ((and (bolp)
6395 (or (bobp)
6396 (save-excursion
6397 (backward-char 1) (not (org-invisible-p)))))
6398 ;; insert right here
6399 nil)
6400 (t
6401 ; ;; in the middle of the line
6402 ; (org-show-entry)
6403 ; (if (org-get-alist-option org-M-RET-may-split-line 'headline)
6404 ; (if (and
6405 ; (org-on-heading-p)
6407 ; ;; protect the tags
6408 ;; (let ((tags (match-string 2)) pos)
6409 ; (delete-region (match-beginning 1) (match-end 1))
6410 ; (setq pos (point-at-bol))
6411 ; (newline (if blank 2 1))
6412 ; (save-excursion
6413 ; (goto-char pos)
6414 ; (end-of-line 1)
6415 ; (insert " " tags)
6416 ; (org-set-tags nil 'align)))
6417 ; (newline (if blank 2 1)))
6418 ; (newline (if blank 2 1))))
6421 ;; in the middle of the line
6422 (org-show-entry)
6423 (let ((split
6424 (org-get-alist-option org-M-RET-may-split-line 'headline))
6425 tags pos)
6426 (if (org-on-heading-p)
6427 (progn
6429 (setq tags (and (match-end 2) (match-string 2)))
6430 (and (match-end 1)
6431 (delete-region (match-beginning 1) (match-end 1)))
6432 (setq pos (point-at-bol))
6433 (or split (end-of-line 1))
6434 (delete-horizontal-space)
6435 (newline (if blank 2 1))
6436 (when tags
6437 (save-excursion
6438 (goto-char pos)
6439 (end-of-line 1)
6440 (insert " " tags)
6441 (org-set-tags nil 'align))))
6442 (or split (end-of-line 1))
6443 (newline (if blank 2 1))))))
6444 (insert head) (just-one-space)
6445 (setq pos (point))
6446 (end-of-line 1)
6447 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6448 (run-hooks 'org-insert-heading-hook)))))
6450 (defun org-insert-heading-after-current ()
6451 "Insert a new heading with same level as current, after current subtree."
6452 (interactive)
6453 (org-back-to-heading)
6454 (org-insert-heading)
6455 (org-move-subtree-down)
6456 (end-of-line 1))
6458 (defun org-insert-todo-heading (arg)
6459 "Insert a new heading with the same level and TODO state as current heading.
6460 If the heading has no TODO state, or if the state is DONE, use the first
6461 state (TODO by default). Also with prefix arg, force first state."
6462 (interactive "P")
6463 (when (not (org-insert-item 'checkbox))
6464 (org-insert-heading)
6465 (save-excursion
6466 (org-back-to-heading)
6467 (outline-previous-heading)
6468 (looking-at org-todo-line-regexp))
6469 (if (or arg
6470 (not (match-beginning 2))
6471 (member (match-string 2) org-done-keywords))
6472 (insert (car org-todo-keywords-1) " ")
6473 (insert (match-string 2) " "))))
6475 (defun org-insert-subheading (arg)
6476 "Insert a new subheading and demote it.
6477 Works for outline headings and for plain lists alike."
6478 (interactive "P")
6479 (org-insert-heading arg)
6480 (cond
6481 ((org-on-heading-p) (org-do-demote))
6482 ((org-at-item-p) (org-indent-item 1))))
6484 (defun org-insert-todo-subheading (arg)
6485 "Insert a new subheading with TODO keyword or checkbox and demote it.
6486 Works for outline headings and for plain lists alike."
6487 (interactive "P")
6488 (org-insert-todo-heading arg)
6489 (cond
6490 ((org-on-heading-p) (org-do-demote))
6491 ((org-at-item-p) (org-indent-item 1))))
6493 ;;; Promotion and Demotion
6495 (defun org-promote-subtree ()
6496 "Promote the entire subtree.
6497 See also `org-promote'."
6498 (interactive)
6499 (save-excursion
6500 (org-map-tree 'org-promote))
6501 (org-fix-position-after-promote))
6503 (defun org-demote-subtree ()
6504 "Demote the entire subtree. See `org-demote'.
6505 See also `org-promote'."
6506 (interactive)
6507 (save-excursion
6508 (org-map-tree 'org-demote))
6509 (org-fix-position-after-promote))
6512 (defun org-do-promote ()
6513 "Promote the current heading higher up the tree.
6514 If the region is active in `transient-mark-mode', promote all headings
6515 in the region."
6516 (interactive)
6517 (save-excursion
6518 (if (org-region-active-p)
6519 (org-map-region 'org-promote (region-beginning) (region-end))
6520 (org-promote)))
6521 (org-fix-position-after-promote))
6523 (defun org-do-demote ()
6524 "Demote the current heading lower down the tree.
6525 If the region is active in `transient-mark-mode', demote all headings
6526 in the region."
6527 (interactive)
6528 (save-excursion
6529 (if (org-region-active-p)
6530 (org-map-region 'org-demote (region-beginning) (region-end))
6531 (org-demote)))
6532 (org-fix-position-after-promote))
6534 (defun org-fix-position-after-promote ()
6535 "Make sure that after pro/demotion cursor position is right."
6536 (let ((pos (point)))
6537 (when (save-excursion
6538 (beginning-of-line 1)
6539 (looking-at org-todo-line-regexp)
6540 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6541 (cond ((eobp) (insert " "))
6542 ((eolp) (insert " "))
6543 ((equal (char-after) ?\ ) (forward-char 1))))))
6545 (defun org-reduced-level (l)
6546 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6548 (defun org-get-valid-level (level &optional change)
6549 "Rectify a level change under the influence of `org-odd-levels-only'
6550 LEVEL is a current level, CHANGE is by how much the level should be
6551 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6552 even level numbers will become the next higher odd number."
6553 (if org-odd-levels-only
6554 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6555 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6556 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6557 (max 1 (+ level change))))
6559 (define-obsolete-function-alias 'org-get-legal-level
6560 'org-get-valid-level "23.1")
6562 (defun org-promote ()
6563 "Promote the current heading higher up the tree.
6564 If the region is active in `transient-mark-mode', promote all headings
6565 in the region."
6566 (org-back-to-heading t)
6567 (let* ((level (save-match-data (funcall outline-level)))
6568 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6569 (diff (abs (- level (length up-head) -1))))
6570 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6571 (replace-match up-head nil t)
6572 ;; Fixup tag positioning
6573 (and org-auto-align-tags (org-set-tags nil t))
6574 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6576 (defun org-demote ()
6577 "Demote the current heading lower down the tree.
6578 If the region is active in `transient-mark-mode', demote all headings
6579 in the region."
6580 (org-back-to-heading t)
6581 (let* ((level (save-match-data (funcall outline-level)))
6582 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6583 (diff (abs (- level (length down-head) -1))))
6584 (replace-match down-head nil t)
6585 ;; Fixup tag positioning
6586 (and org-auto-align-tags (org-set-tags nil t))
6587 (if org-adapt-indentation (org-fixup-indentation diff))))
6589 (defun org-map-tree (fun)
6590 "Call FUN for every heading underneath the current one."
6591 (org-back-to-heading)
6592 (let ((level (funcall outline-level)))
6593 (save-excursion
6594 (funcall fun)
6595 (while (and (progn
6596 (outline-next-heading)
6597 (> (funcall outline-level) level))
6598 (not (eobp)))
6599 (funcall fun)))))
6601 (defun org-map-region (fun beg end)
6602 "Call FUN for every heading between BEG and END."
6603 (let ((org-ignore-region t))
6604 (save-excursion
6605 (setq end (copy-marker end))
6606 (goto-char beg)
6607 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6608 (< (point) end))
6609 (funcall fun))
6610 (while (and (progn
6611 (outline-next-heading)
6612 (< (point) end))
6613 (not (eobp)))
6614 (funcall fun)))))
6616 (defun org-fixup-indentation (diff)
6617 "Change the indentation in the current entry by DIFF
6618 However, if any line in the current entry has no indentation, or if it
6619 would end up with no indentation after the change, nothing at all is done."
6620 (save-excursion
6621 (let ((end (save-excursion (outline-next-heading)
6622 (point-marker)))
6623 (prohibit (if (> diff 0)
6626 col)
6627 (unless (save-excursion (end-of-line 1)
6628 (re-search-forward prohibit end t))
6629 (while (and (< (point) end)
6631 (goto-char (match-end 0))
6632 (setq col (current-column))
6633 (if (< diff 0) (replace-match ""))
6634 (indent-to (+ diff col))))
6635 (move-marker end nil))))
6637 (defun org-convert-to-odd-levels ()
6638 "Convert an org-mode file with all levels allowed to one with odd levels.
6639 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6640 level 5 etc."
6641 (interactive)
6642 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6643 (let ((org-odd-levels-only nil) n)
6644 (save-excursion
6645 (goto-char (point-min))
6647 (setq n (- (length (match-string 0)) 2))
6648 (while (>= (setq n (1- n)) 0)
6649 (org-demote))
6650 (end-of-line 1))))))
6653 (defun org-convert-to-oddeven-levels ()
6654 "Convert an org-mode file with only odd levels to one with odd and even levels.
6655 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6656 section with an even level, conversion would destroy the structure of the file. An error
6657 is signaled in this case."
6658 (interactive)
6659 (goto-char (point-min))
6660 ;; First check if there are no even levels
6662 (org-show-context t)
6663 (error "Not all levels are odd in this file. Conversion not possible."))
6664 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6665 (let ((org-odd-levels-only nil) n)
6666 (save-excursion
6667 (goto-char (point-min))
6669 (setq n (/ (1- (length (match-string 0))) 2))
6670 (while (>= (setq n (1- n)) 0)
6671 (org-promote))
6672 (end-of-line 1))))))
6674 (defun org-tr-level (n)
6675 "Make N odd if required."
6676 (if org-odd-levels-only (1+ (/ n 2)) n))
6678 ;;; Vertical tree motion, cutting and pasting of subtrees
6680 (defun org-move-subtree-up (&optional arg)
6681 "Move the current subtree up past ARG headlines of the same level."
6682 (interactive "p")
6683 (org-move-subtree-down (- (prefix-numeric-value arg))))
6685 (defun org-move-subtree-down (&optional arg)
6686 "Move the current subtree down past ARG headlines of the same level."
6687 (interactive "p")
6688 (setq arg (prefix-numeric-value arg))
6689 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6690 'outline-get-last-sibling))
6691 (ins-point (make-marker))
6692 (cnt (abs arg))
6693 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6694 ;; Select the tree
6695 (org-back-to-heading)
6696 (setq beg0 (point))
6697 (save-excursion
6698 (setq ne-beg (org-back-over-empty-lines))
6699 (setq beg (point)))
6700 (save-match-data
6701 (save-excursion (outline-end-of-heading)
6702 (setq folded (org-invisible-p)))
6703 (outline-end-of-subtree))
6704 (outline-next-heading)
6705 (setq ne-end (org-back-over-empty-lines))
6706 (setq end (point))
6707 (goto-char beg0)
6708 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6709 ;; include less whitespace
6710 (save-excursion
6711 (goto-char beg)
6712 (forward-line (- ne-beg ne-end))
6713 (setq beg (point))))
6714 ;; Find insertion point, with error handling
6715 (while (> cnt 0)
6716 (or (and (funcall movfunc) (looking-at outline-regexp))
6717 (progn (goto-char beg0)
6718 (error "Cannot move past superior level or buffer limit")))
6719 (setq cnt (1- cnt)))
6720 (if (> arg 0)
6721 ;; Moving forward - still need to move over subtree
6722 (progn (org-end-of-subtree t t)
6723 (save-excursion
6724 (org-back-over-empty-lines)
6725 (or (bolp) (newline)))))
6726 (setq ne-ins (org-back-over-empty-lines))
6727 (move-marker ins-point (point))
6728 (setq txt (buffer-substring beg end))
6729 (delete-region beg end)
6730 (outline-flag-region (1- beg) beg nil)
6731 (outline-flag-region (1- (point)) (point) nil)
6732 (insert txt)
6734 (setq ins-end (point))
6735 (goto-char ins-point)
6736 (org-skip-whitespace)
6737 (when (and (< arg 0)
6738 (org-first-sibling-p)
6739 (> ne-ins ne-beg))
6740 ;; Move whitespace back to beginning
6741 (save-excursion
6742 (goto-char ins-end)
6743 (let ((kill-whole-line t))
6744 (kill-line (- ne-ins ne-beg)) (point)))
6746 (move-marker ins-point nil)
6747 (org-compact-display-after-subtree-move)
6748 (unless folded
6749 (org-show-entry)
6750 (show-children)
6751 (org-cycle-hide-drawers 'children))))
6753 (defvar org-subtree-clip ""
6754 "Clipboard for cut and paste of subtrees.
6755 This is actually only a copy of the kill, because we use the normal kill
6756 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6758 (defvar org-subtree-clip-folded nil
6759 "Was the last copied subtree folded?
6760 This is used to fold the tree back after pasting.")
6762 (defun org-cut-subtree (&optional n)
6763 "Cut the current subtree into the clipboard.
6764 With prefix arg N, cut this many sequential subtrees.
6765 This is a short-hand for marking the subtree and then cutting it."
6766 (interactive "p")
6767 (org-copy-subtree n 'cut))
6769 (defun org-copy-subtree (&optional n cut)
6770 "Cut the current subtree into the clipboard.
6771 With prefix arg N, cut this many sequential subtrees.
6772 This is a short-hand for marking the subtree and then copying it.
6773 If CUT is non-nil, actually cut the subtree."
6774 (interactive "p")
6775 (let (beg end folded (beg0 (point)))
6776 (if (interactive-p)
6777 (org-back-to-heading nil) ; take what looks like a subtree
6778 (org-back-to-heading t)) ; take what is really there
6779 (org-back-over-empty-lines)
6780 (setq beg (point))
6782 (save-match-data
6783 (save-excursion (outline-end-of-heading)
6784 (setq folded (org-invisible-p)))
6785 (condition-case nil
6786 (outline-forward-same-level (1- n))
6787 (error nil))
6788 (org-end-of-subtree t t))
6789 (org-back-over-empty-lines)
6790 (setq end (point))
6791 (goto-char beg0)
6792 (when (> end beg)
6793 (setq org-subtree-clip-folded folded)
6794 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6795 (setq org-subtree-clip (current-kill 0))
6796 (message "%s: Subtree(s) with %d characters"
6797 (if cut "Cut" "Copied")
6798 (length org-subtree-clip)))))
6800 (defun org-paste-subtree (&optional level tree)
6801 "Paste the clipboard as a subtree, with modification of headline level.
6802 The entire subtree is promoted or demoted in order to match a new headline
6803 level. By default, the new level is derived from the visible headings
6804 before and after the insertion point, and taken to be the inferior headline
6805 level of the two. So if the previous visible heading is level 3 and the
6806 next is level 4 (or vice versa), level 4 will be used for insertion.
6807 This makes sure that the subtree remains an independent subtree and does
6808 not swallow low level entries.
6810 You can also force a different level, either by using a numeric prefix
6811 argument, or by inserting the heading marker by hand. For example, if the
6816 If optional TREE is given, use this text instead of the kill ring."
6817 (interactive "P")
6818 (unless (org-kill-is-subtree-p tree)
6819 (error "%s"
6820 (substitute-command-keys
6822 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6827 (old-level (if (string-match ^re txt)
6828 (- (match-end 0) (match-beginning 0) 1)
6829 -1))
6830 (force-level (cond (level (prefix-numeric-value level))
6831 ((string-match
6832 ^re_ (buffer-substring (point-at-bol) (point)))
6833 (- (match-end 1) (match-beginning 1)))
6834 (t nil)))
6835 (previous-level (save-excursion
6836 (condition-case nil
6837 (progn
6838 (outline-previous-visible-heading 1)
6839 (if (looking-at re)
6840 (- (match-end 0) (match-beginning 0) 1)
6841 1))
6842 (error 1))))
6843 (next-level (save-excursion
6844 (condition-case nil
6845 (progn
6846 (or (looking-at outline-regexp)
6847 (outline-next-visible-heading 1))
6848 (if (looking-at re)
6849 (- (match-end 0) (match-beginning 0) 1)
6850 1))
6851 (error 1))))
6852 (new-level (or force-level (max previous-level next-level)))
6853 (shift (if (or (= old-level -1)
6854 (= new-level -1)
6855 (= old-level new-level))
6856 0
6857 (- new-level old-level)))
6858 (delta (if (> shift 0) -1 1))
6859 (func (if (> shift 0) 'org-demote 'org-promote))
6860 (org-odd-levels-only nil)
6861 beg end)
6862 ;; Remove the forced level indicator
6863 (if force-level
6864 (delete-region (point-at-bol) (point)))
6865 ;; Paste
6866 (beginning-of-line 1)
6867 (org-back-over-empty-lines) ;; FIXME: correct fix????
6868 (setq beg (point))
6869 (insert-before-markers txt) ;; FIXME: correct fix????
6871 (setq end (point))
6872 (goto-char beg)
6874 (setq beg (point))
6875 ;; Shift if necessary
6876 (unless (= shift 0)
6877 (save-restriction
6878 (narrow-to-region beg end)
6879 (while (not (= shift 0))
6880 (org-map-region func (point-min) (point-max))
6881 (setq shift (+ delta shift)))
6882 (goto-char (point-min))))
6883 (when (interactive-p)
6884 (message "Clipboard pasted as level %d subtree" new-level))
6885 (if (and kill-ring
6886 (eq org-subtree-clip (current-kill 0))
6887 org-subtree-clip-folded)
6888 ;; The tree was folded before it was killed/copied
6889 (hide-subtree))))
6891 (defun org-kill-is-subtree-p (&optional txt)
6892 "Check if the current kill is an outline subtree, or a set of trees.
6893 Returns nil if kill does not start with a headline, or if the first
6894 headline level is not the largest headline level in the tree.
6895 So this will actually accept several entries of equal levels as well,
6896 which is OK for `org-paste-subtree'.
6897 If optional TXT is given, check this string instead of the current kill."
6898 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6899 (start-level (and kill
6902 kill)
6903 (- (match-end 2) (match-beginning 2) 1)))
6904 (re (concat "^" org-outline-regexp))
6905 (start (1+ (match-beginning 2))))
6906 (if (not start-level)
6907 (progn
6908 nil) ;; does not even start with a heading
6909 (catch 'exit
6910 (while (setq start (string-match re kill (1+ start)))
6911 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6912 (throw 'exit nil)))
6913 t))))
6915 (defun org-narrow-to-subtree ()
6916 "Narrow buffer to the current subtree."
6917 (interactive)
6918 (save-excursion
6919 (save-match-data
6920 (narrow-to-region
6921 (progn (org-back-to-heading) (point))
6922 (progn (org-end-of-subtree t t) (point))))))
6925 ;;; Outline Sorting
6927 (defun org-sort (with-case)
6928 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6929 Optional argument WITH-CASE means sort case-sensitively."
6930 (interactive "P")
6931 (if (org-at-table-p)
6932 (org-call-with-arg 'org-table-sort-lines with-case)
6933 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6935 (defvar org-priority-regexp) ; defined later in the file
6937 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6938 "Sort entries on a certain level of an outline tree.
6939 If there is an active region, the entries in the region are sorted.
6940 Else, if the cursor is before the first entry, sort the top-level items.
6941 Else, the children of the entry at point are sorted.
6943 Sorting can be alphabetically, numerically, and by date/time as given by
6944 the first time stamp in the entry. The command prompts for the sorting
6945 type unless it has been given to the function through the SORTING-TYPE
6946 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6947 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6948 called with point at the beginning of the record. It must return either
6949 a string or a number that should serve as the sorting key for that record.
6951 Comparing entries ignores case by default. However, with an optional argument
6952 WITH-CASE, the sorting considers case as well."
6953 (interactive "P")
6954 (let ((case-func (if with-case 'identity 'downcase))
6955 start beg end stars re re2
6956 txt what tmp plain-list-p)
6957 ;; Find beginning and end of region to sort
6958 (cond
6959 ((org-region-active-p)
6960 ;; we will sort the region
6961 (setq end (region-end)
6962 what "region")
6963 (goto-char (region-beginning))
6964 (if (not (org-on-heading-p)) (outline-next-heading))
6965 (setq start (point)))
6966 ((org-at-item-p)
6967 ;; we will sort this plain list
6968 (org-beginning-of-item-list) (setq start (point))
6969 (org-end-of-item-list) (setq end (point))
6970 (goto-char start)
6971 (setq plain-list-p t
6972 what "plain list"))
6973 ((or (org-on-heading-p)
6974 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6975 ;; we will sort the children of the current headline
6976 (org-back-to-heading)
6977 (setq start (point)
6978 end (progn (org-end-of-subtree t t)
6979 (org-back-over-empty-lines)
6980 (point))
6981 what "children")
6982 (goto-char start)
6983 (show-subtree)
6984 (outline-next-heading))
6985 (t
6986 ;; we will sort the top-level entries in this file
6987 (goto-char (point-min))
6988 (or (org-on-heading-p) (outline-next-heading))
6989 (setq start (point) end (point-max) what "top-level")
6990 (goto-char start)
6991 (show-all)))
6993 (setq beg (point))
6994 (if (>= beg end) (error "Nothing to sort"))
6996 (unless plain-list-p
6998 (setq stars (match-string 1)
6999 re (concat "^" (regexp-quote stars) " +")
7000 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7001 txt (buffer-substring beg end))
7003 (if (and (not (equal stars "*")) (string-match re2 txt))
7004 (error "Region to sort contains a level above the first entry")))
7006 (unless sorting-type
7007 (message
7008 (if plain-list-p
7009 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
7010 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
7011 what)
7012 (setq sorting-type (read-char-exclusive))
7014 (and (= (downcase sorting-type) ?f)
7015 (setq getkey-func
7016 (completing-read "Sort using function: "
7017 obarray 'fboundp t nil nil))
7018 (setq getkey-func (intern getkey-func)))
7020 (and (= (downcase sorting-type) ?r)
7021 (setq property
7022 (completing-read "Property: "
7023 (mapcar 'list (org-buffer-property-keys t))
7024 nil t))))
7026 (message "Sorting entries...")
7028 (save-restriction
7029 (narrow-to-region start end)
7031 (let ((dcst (downcase sorting-type))
7032 (now (current-time)))
7033 (sort-subr
7034 (/= dcst sorting-type)
7035 ;; This function moves to the beginning character of the "record" to
7036 ;; be sorted.
7037 (if plain-list-p
7038 (lambda nil
7039 (if (org-at-item-p) t (goto-char (point-max))))
7040 (lambda nil
7041 (if (re-search-forward re nil t)
7042 (goto-char (match-beginning 0))
7043 (goto-char (point-max)))))
7044 ;; This function moves to the last character of the "record" being
7045 ;; sorted.
7046 (if plain-list-p
7047 'org-end-of-item
7048 (lambda nil
7049 (save-match-data
7050 (condition-case nil
7051 (outline-forward-same-level 1)
7052 (error
7053 (goto-char (point-max)))))))
7055 ;; This function returns the value that gets sorted against.
7056 (if plain-list-p
7057 (lambda nil
7059 (cond
7060 ((= dcst ?n)
7061 (string-to-number (buffer-substring (match-end 0)
7062 (point-at-eol))))
7063 ((= dcst ?a)
7064 (buffer-substring (match-end 0) (point-at-eol)))
7065 ((= dcst ?t)
7066 (if (re-search-forward org-ts-regexp
7067 (point-at-eol) t)
7068 (org-time-string-to-time (match-string 0))
7069 now))
7070 ((= dcst ?f)
7071 (if getkey-func
7072 (progn
7073 (setq tmp (funcall getkey-func))
7074 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7075 tmp)
7076 (error "Invalid key function `%s'" getkey-func)))
7077 (t (error "Invalid sorting type `%c'" sorting-type)))))
7078 (lambda nil
7079 (cond
7080 ((= dcst ?n)
7081 (if (looking-at outline-regexp)
7082 (string-to-number (buffer-substring (match-end 0)
7083 (point-at-eol)))
7084 nil))
7085 ((= dcst ?a)
7086 (funcall case-func (buffer-substring (point-at-bol)
7087 (point-at-eol))))
7088 ((= dcst ?t)
7089 (if (re-search-forward org-ts-regexp
7090 (save-excursion
7091 (forward-line 2)
7092 (point)) t)
7093 (org-time-string-to-time (match-string 0))
7094 now))
7095 ((= dcst ?p)
7096 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7097 (string-to-char (match-string 2))
7098 org-default-priority))
7099 ((= dcst ?r)
7100 (or (org-entry-get nil property) ""))
7101 ((= dcst ?f)
7102 (if getkey-func
7103 (progn
7104 (setq tmp (funcall getkey-func))
7105 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7106 tmp)
7107 (error "Invalid key function `%s'" getkey-func)))
7108 (t (error "Invalid sorting type `%c'" sorting-type)))))
7109 nil
7110 (cond
7111 ((= dcst ?a) 'string<)
7112 ((= dcst ?t) 'time-less-p)
7113 (t nil)))))
7114 (message "Sorting entries...done")))
7116 (defun org-do-sort (table what &optional with-case sorting-type)
7117 "Sort TABLE of WHAT according to SORTING-TYPE.
7118 The user will be prompted for the SORTING-TYPE if the call to this
7119 function does not specify it. WHAT is only for the prompt, to indicate
7120 what is being sorted. The sorting key will be extracted from
7121 the car of the elements of the table.
7122 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7123 (unless sorting-type
7124 (message
7125 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7126 what)
7127 (setq sorting-type (read-char-exclusive)))
7128 (let ((dcst (downcase sorting-type))
7129 extractfun comparefun)
7130 ;; Define the appropriate functions
7131 (cond
7132 ((= dcst ?n)
7133 (setq extractfun 'string-to-number
7134 comparefun (if (= dcst sorting-type) '< '>)))
7135 ((= dcst ?a)
7136 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7137 (lambda(x) (downcase (org-sort-remove-invisible x))))
7138 comparefun (if (= dcst sorting-type)
7139 'string<
7140 (lambda (a b) (and (not (string< a b))
7141 (not (string= a b)))))))
7142 ((= dcst ?t)
7143 (setq extractfun
7144 (lambda (x)
7145 (if (string-match org-ts-regexp x)
7146 (time-to-seconds
7147 (org-time-string-to-time (match-string 0 x)))
7148 0))
7149 comparefun (if (= dcst sorting-type) '< '>)))
7150 (t (error "Invalid sorting type `%c'" sorting-type)))
7152 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7153 table)
7154 (lambda (a b) (funcall comparefun (car a) (car b))))))
7156 ;;;; Plain list items, including checkboxes
7158 ;;; Plain list items
7160 (defun org-at-item-p ()
7161 "Is point in a line starting a hand-formatted item?"
7162 (let ((llt org-plain-list-ordered-item-terminator))
7163 (save-excursion
7164 (goto-char (point-at-bol))
7165 (looking-at
7166 (cond
7170 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7172 (defun org-in-item-p ()
7173 "It the cursor inside a plain list item.
7174 Does not have to be the first line."
7175 (save-excursion
7176 (condition-case nil
7177 (progn
7178 (org-beginning-of-item)
7179 (org-at-item-p)
7180 t)
7181 (error nil))))
7183 (defun org-insert-item (&optional checkbox)
7184 "Insert a new item at the current level.
7185 Return t when things worked, nil when we are not in an item."
7186 (when (save-excursion
7187 (condition-case nil
7188 (progn
7189 (org-beginning-of-item)
7190 (org-at-item-p)
7191 (if (org-invisible-p) (error "Invisible item"))
7192 t)
7193 (error nil)))
7194 (let* ((bul (match-string 0))
7196 (match-end 0)))
7197 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7198 pos)
7199 (cond
7200 ((and (org-at-item-p) (<= (point) eow))
7201 ;; before the bullet
7202 (beginning-of-line 1)
7203 (open-line (if blank 2 1)))
7204 ((<= (point) eow)
7205 (beginning-of-line 1))
7206 (t
7207 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7208 (end-of-line 1)
7209 (delete-horizontal-space))
7210 (newline (if blank 2 1))))
7211 (insert bul (if checkbox "[ ]" ""))
7212 (just-one-space)
7213 (setq pos (point))
7214 (end-of-line 1)
7215 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7216 (org-maybe-renumber-ordered-list)
7217 (and checkbox (org-update-checkbox-count-maybe))
7218 t))
7220 ;;; Checkboxes
7222 (defun org-at-item-checkbox-p ()
7223 "Is point at a line starting a plain-list item with a checklet?"
7224 (and (org-at-item-p)
7225 (save-excursion
7226 (goto-char (match-end 0))
7230 (defun org-toggle-checkbox (&optional arg)
7231 "Toggle the checkbox in the current line."
7232 (interactive "P")
7233 (catch 'exit
7234 (let (beg end status (firstnew 'unknown))
7235 (cond
7236 ((org-region-active-p)
7237 (setq beg (region-beginning) end (region-end)))
7238 ((org-on-heading-p)
7239 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7240 ((org-at-item-checkbox-p)
7241 (let ((pos (point)))
7242 (replace-match
7243 (cond (arg "[-]")
7244 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7245 (t "[ ]"))
7246 t t)
7247 (goto-char pos))
7248 (throw 'exit t))
7249 (t (error "Not at a checkbox or heading, and no active region")))
7250 (save-excursion
7251 (goto-char beg)
7252 (while (< (point) end)
7253 (when (org-at-item-checkbox-p)
7254 (setq status (equal (match-string 0) "[X]"))
7255 (when (eq firstnew 'unknown)
7256 (setq firstnew (not status)))
7257 (replace-match
7258 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7259 (beginning-of-line 2)))))
7260 (org-update-checkbox-count-maybe))
7262 (defun org-update-checkbox-count-maybe ()
7263 "Update checkbox statistics unless turned off by user."
7264 (when org-provide-checkbox-statistics
7265 (org-update-checkbox-count)))
7267 (defun org-update-checkbox-count (&optional all)
7268 "Update the checkbox statistics in the current section.
7269 This will find all statistic cookies like [57%] and [6/12] and update them
7270 with the current numbers. With optional prefix argument ALL, do this for
7271 the whole buffer."
7272 (interactive "P")
7273 (save-excursion
7274 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7275 (beg (condition-case nil
7276 (progn (outline-back-to-heading) (point))
7277 (error (point-min))))
7278 (end (move-marker (make-marker)
7279 (progn (outline-next-heading) (point))))
7283 beg-cookie end-cookie is-percent c-on c-off lim
7284 eline curr-ind next-ind continue-from startsearch
7285 (cstat 0)
7286 )
7287 (when all
7288 (goto-char (point-min))
7289 (outline-next-heading)
7290 (setq beg (point) end (point-max)))
7291 (goto-char end)
7292 ;; find each statistic cookie
7293 (while (re-search-backward re-find beg t)
7294 (setq beg-cookie (match-beginning 1)
7295 end-cookie (match-end 1)
7296 cstat (+ cstat (if end-cookie 1 0))
7297 startsearch (point-at-eol)
7298 continue-from (point-at-bol)
7299 is-percent (match-beginning 2)
7300 lim (cond
7301 ((org-on-heading-p) (outline-next-heading) (point))
7302 ((org-at-item-p) (org-end-of-item) (point))
7303 (t nil))
7304 c-on 0
7305 c-off 0)
7306 (when lim
7307 ;; find first checkbox for this cookie and gather
7308 ;; statistics from all that are at this indentation level
7309 (goto-char startsearch)
7310 (if (re-search-forward re-box lim t)
7311 (progn
7312 (org-beginning-of-item)
7313 (setq curr-ind (org-get-indentation))
7314 (setq next-ind curr-ind)
7315 (while (= curr-ind next-ind)
7316 (save-excursion (end-of-line) (setq eline (point)))
7317 (if (re-search-forward re-box eline t)
7318 (if (member (match-string 2) '("[ ]" "[-]"))
7319 (setq c-off (1+ c-off))
7320 (setq c-on (1+ c-on))
7321 )
7322 )
7323 (org-end-of-item)
7324 (setq next-ind (org-get-indentation))
7325 )))
7326 (goto-char continue-from)
7327 ;; update cookie
7328 (when end-cookie
7329 (delete-region beg-cookie end-cookie)
7330 (goto-char beg-cookie)
7331 (insert
7332 (if is-percent
7333 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7334 (format "[%d/%d]" c-on (+ c-on c-off)))))
7335 ;; update items checkbox if it has one
7336 (when (org-at-item-p)
7337 (org-beginning-of-item)
7338 (when (and (> (+ c-on c-off) 0)
7339 (re-search-forward re-box (point-at-eol) t))
7340 (setq beg-cookie (match-beginning 2)
7341 end-cookie (match-end 2))
7342 (delete-region beg-cookie end-cookie)
7343 (goto-char beg-cookie)
7344 (cond ((= c-off 0) (insert "[X]"))
7345 ((= c-on 0) (insert "[ ]"))
7346 (t (insert "[-]")))
7347 )))
7348 (goto-char continue-from))
7349 (when (interactive-p)
7350 (message "Checkbox satistics updated %s (%d places)"
7351 (if all "in entire file" "in current outline entry") cstat)))))
7353 (defun org-get-checkbox-statistics-face ()
7354 "Select the face for checkbox statistics.
7355 The face will be `org-done' when all relevant boxes are checked. Otherwise
7356 it will be `org-todo'."
7357 (if (match-end 1)
7358 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7359 (if (and (> (match-end 2) (match-beginning 2))
7360 (equal (match-string 2) (match-string 3)))
7361 'org-done
7362 'org-todo)))
7364 (defun org-get-indentation (&optional line)
7365 "Get the indentation of the current line, interpreting tabs.
7366 When LINE is given, assume it represents a line and compute its indentation."
7367 (if line
7368 (if (string-match "^ *" (org-remove-tabs line))
7369 (match-end 0))
7370 (save-excursion
7371 (beginning-of-line 1)
7373 (current-column))))
7375 (defun org-remove-tabs (s &optional width)
7376 "Replace tabulators in S with spaces.
7377 Assumes that s is a single line, starting in column 0."
7378 (setq width (or width tab-width))
7380 (setq s (replace-match
7381 (make-string
7382 (- (* width (/ (+ (match-beginning 0) width) width))
7383 (match-beginning 0)) ?\ )
7384 t t s)))
7385 s)
7387 (defun org-fix-indentation (line ind)
7388 "Fix indentation in LINE.
7389 IND is a cons cell with target and minimum indentation.
7390 If the current indenation in LINE is smaller than the minimum,
7391 leave it alone. If it is larger than ind, set it to the target."
7392 (let* ((l (org-remove-tabs line))
7393 (i (org-get-indentation l))
7394 (i1 (car ind)) (i2 (cdr ind)))
7395 (if (>= i i2) (setq l (substring line i2)))
7396 (if (> i1 0)
7397 (concat (make-string i1 ?\ ) l)
7398 l)))
7400 (defcustom org-empty-line-terminates-plain-lists nil
7401 "Non-nil means, an empty line ends all plain list levels.
7402 When nil, empty lines are part of the preceeding item."
7403 :group 'org-plain-lists
7404 :type 'boolean)
7406 (defun org-beginning-of-item ()
7407 "Go to the beginning of the current hand-formatted item.
7408 If the cursor is not in an item, throw an error."
7409 (interactive)
7410 (let ((pos (point))
7411 (limit (save-excursion
7412 (condition-case nil
7413 (progn
7414 (org-back-to-heading)
7415 (beginning-of-line 2) (point))
7416 (error (point-min)))))
7417 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7418 ind ind1)
7419 (if (org-at-item-p)
7420 (beginning-of-line 1)
7421 (beginning-of-line 1)
7423 (setq ind (current-column))
7424 (if (catch 'exit
7425 (while t
7426 (beginning-of-line 0)
7427 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7430 (setq ind1 ind-empty)
7432 (setq ind1 (current-column)))
7433 (if (< ind1 ind)
7434 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7435 nil
7436 (goto-char pos)
7437 (error "Not in an item")))))
7439 (defun org-end-of-item ()
7440 "Go to the end of the current hand-formatted item.
7441 If the cursor is not in an item, throw an error."
7442 (interactive)
7443 (let* ((pos (point))
7444 ind1
7445 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7446 (limit (save-excursion (outline-next-heading) (point)))
7447 (ind (save-excursion
7448 (org-beginning-of-item)
7450 (current-column)))
7451 (end (catch 'exit
7452 (while t
7453 (beginning-of-line 2)
7454 (if (eobp) (throw 'exit (point)))
7455 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7457 (setq ind1 ind-empty)
7459 (setq ind1 (current-column)))
7460 (if (<= ind1 ind)
7461 (throw 'exit (point-at-bol)))))))
7462 (if end
7463 (goto-char end)
7464 (goto-char pos)
7465 (error "Not in an item"))))
7467 (defun org-next-item ()
7468 "Move to the beginning of the next item in the current plain list.
7469 Error if not at a plain list, or if this is the last item in the list."
7470 (interactive)
7471 (let (ind ind1 (pos (point)))
7472 (org-beginning-of-item)
7473 (setq ind (org-get-indentation))
7474 (org-end-of-item)
7475 (setq ind1 (org-get-indentation))
7476 (unless (and (org-at-item-p) (= ind ind1))
7477 (goto-char pos)
7478 (error "On last item"))))
7480 (defun org-previous-item ()
7481 "Move to the beginning of the previous item in the current plain list.
7482 Error if not at a plain list, or if this is the first item in the list."
7483 (interactive)
7484 (let (beg ind ind1 (pos (point)))
7485 (org-beginning-of-item)
7486 (setq beg (point))
7487 (setq ind (org-get-indentation))
7488 (goto-char beg)
7489 (catch 'exit
7490 (while t
7491 (beginning-of-line 0)
7493 nil
7494 (if (<= (setq ind1 (org-get-indentation)) ind)
7495 (throw 'exit t)))))
7496 (condition-case nil
7497 (if (or (not (org-at-item-p))
7498 (< ind1 (1- ind)))
7499 (error "")
7500 (org-beginning-of-item))
7501 (error (goto-char pos)
7502 (error "On first item")))))
7504 (defun org-first-list-item-p ()
7505 "Is this heading the item in a plain list?"
7506 (unless (org-at-item-p)
7507 (error "Not at a plain list item"))
7508 (org-beginning-of-item)
7509 (= (point) (save-excursion (org-beginning-of-item-list))))
7511 (defun org-move-item-down ()
7512 "Move the plain list item at point down, i.e. swap with following item.
7513 Subitems (items with larger indentation) are considered part of the item,
7514 so this really moves item trees."
7515 (interactive)
7516 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7517 (org-beginning-of-item)
7518 (setq beg0 (point))
7519 (save-excursion
7520 (setq ne-beg (org-back-over-empty-lines))
7521 (setq beg (point)))
7522 (goto-char beg0)
7523 (setq ind (org-get-indentation))
7524 (org-end-of-item)
7525 (setq end0 (point))
7526 (setq ind1 (org-get-indentation))
7527 (setq ne-end (org-back-over-empty-lines))
7528 (setq end (point))
7529 (goto-char beg0)
7530 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7531 ;; include less whitespace
7532 (save-excursion
7533 (goto-char beg)
7534 (forward-line (- ne-beg ne-end))
7535 (setq beg (point))))
7536 (goto-char end0)
7537 (if (and (org-at-item-p) (= ind ind1))
7538 (progn
7539 (org-end-of-item)
7540 (org-back-over-empty-lines)
7541 (setq txt (buffer-substring beg end))
7542 (save-excursion
7543 (delete-region beg end))
7544 (setq pos (point))
7545 (insert txt)
7546 (goto-char pos) (org-skip-whitespace)
7547 (org-maybe-renumber-ordered-list))
7548 (goto-char pos)
7549 (error "Cannot move this item further down"))))
7551 (defun org-move-item-up (arg)
7552 "Move the plain list item at point up, i.e. swap with previous item.
7553 Subitems (items with larger indentation) are considered part of the item,
7554 so this really moves item trees."
7555 (interactive "p")
7556 (let (beg beg0 end ind ind1 (pos (point)) txt
7557 ne-beg ne-ins ins-end)
7558 (org-beginning-of-item)
7559 (setq beg0 (point))
7560 (setq ind (org-get-indentation))
7561 (save-excursion
7562 (setq ne-beg (org-back-over-empty-lines))
7563 (setq beg (point)))
7564 (goto-char beg0)
7565 (org-end-of-item)
7566 (setq end (point))
7567 (goto-char beg0)
7568 (catch 'exit
7569 (while t
7570 (beginning-of-line 0)
7572 (if org-empty-line-terminates-plain-lists
7573 (progn
7574 (goto-char pos)
7575 (error "Cannot move this item further up"))
7576 nil)
7577 (if (<= (setq ind1 (org-get-indentation)) ind)
7578 (throw 'exit t)))))
7579 (condition-case nil
7580 (org-beginning-of-item)
7581 (error (goto-char beg)
7582 (error "Cannot move this item further up")))
7583 (setq ind1 (org-get-indentation))
7584 (if (and (org-at-item-p) (= ind ind1))
7585 (progn
7586 (setq ne-ins (org-back-over-empty-lines))
7587 (setq txt (buffer-substring beg end))
7588 (save-excursion
7589 (delete-region beg end))
7590 (setq pos (point))
7591 (insert txt)
7592 (setq ins-end (point))
7593 (goto-char pos) (org-skip-whitespace)
7595 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7596 ;; Move whitespace back to beginning
7597 (save-excursion
7598 (goto-char ins-end)
7599 (let ((kill-whole-line t))
7600 (kill-line (- ne-ins ne-beg)) (point)))
7603 (org-maybe-renumber-ordered-list))
7604 (goto-char pos)
7605 (error "Cannot move this item further up"))))
7607 (defun org-maybe-renumber-ordered-list ()
7608 "Renumber the ordered list at point if setup allows it.
7609 This tests the user option `org-auto-renumber-ordered-lists' before
7610 doing the renumbering."
7611 (interactive)
7612 (when (and org-auto-renumber-ordered-lists
7613 (org-at-item-p))
7614 (if (match-beginning 3)
7615 (org-renumber-ordered-list 1)
7616 (org-fix-bullet-type))))
7618 (defun org-maybe-renumber-ordered-list-safe ()
7619 (condition-case nil
7620 (save-excursion
7621 (org-maybe-renumber-ordered-list))
7622 (error nil)))
7624 (defun org-cycle-list-bullet (&optional which)
7625 "Cycle through the different itemize/enumerate bullets.
7626 This cycle the entire list level through the sequence:
7628 `-' -> `+' -> `*' -> `1.' -> `1)'
7630 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7631 0 meand `-', 1 means `+' etc."
7632 (interactive "P")
7633 (org-preserve-lc
7634 (org-beginning-of-item-list)
7635 (org-at-item-p)
7636 (beginning-of-line 1)
7637 (let ((current (match-string 0))
7638 (prevp (eq which 'previous))
7639 new)
7640 (setq new (cond
7641 ((and (numberp which)
7642 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7643 ((string-match "-" current) (if prevp "1)" "+"))
7648 ((string-match ")" current) (if prevp "1." "-"))
7649 (t (error "This should not happen"))))
7651 (org-fix-bullet-type)
7652 (org-maybe-renumber-ordered-list))))
7654 (defun org-get-string-indentation (s)
7655 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7656 (let ((n -1) (i 0) (w tab-width) c)
7657 (catch 'exit
7658 (while (< (setq n (1+ n)) (length s))
7659 (setq c (aref s n))
7660 (cond ((= c ?\ ) (setq i (1+ i)))
7662 (t (throw 'exit t)))))
7663 i))
7665 (defun org-renumber-ordered-list (arg)
7666 "Renumber an ordered plain list.
7667 Cursor needs to be in the first line of an item, the line that starts
7669 (interactive "p")
7670 (unless (and (org-at-item-p)
7671 (match-beginning 3))
7672 (error "This is not an ordered list"))
7673 (let ((line (org-current-line))
7674 (col (current-column))
7675 (ind (org-get-string-indentation
7676 (buffer-substring (point-at-bol) (match-beginning 3))))
7677 ;; (term (substring (match-string 3) -1))
7678 ind1 (n (1- arg))
7679 fmt)
7680 ;; find where this list begins
7681 (org-beginning-of-item-list)
7683 (setq fmt (concat "%d" (match-string 1)))
7684 (beginning-of-line 0)
7685 ;; walk forward and replace these numbers
7686 (catch 'exit
7687 (while t
7688 (catch 'next
7689 (beginning-of-line 2)
7690 (if (eobp) (throw 'exit nil))
7693 (if (> ind1 ind) (throw 'next t))
7694 (if (< ind1 ind) (throw 'exit t))
7695 (if (not (org-at-item-p)) (throw 'exit nil))
7696 (delete-region (match-beginning 2) (match-end 2))
7697 (goto-char (match-beginning 2))
7698 (insert (format fmt (setq n (1+ n)))))))
7699 (goto-line line)
7700 (move-to-column col)))
7702 (defun org-fix-bullet-type ()
7703 "Make sure all items in this list have the same bullet as the firsst item."
7704 (interactive)
7705 (unless (org-at-item-p) (error "This is not a list"))
7706 (let ((line (org-current-line))
7707 (col (current-column))
7708 (ind (current-indentation))
7709 ind1 bullet)
7710 ;; find where this list begins
7711 (org-beginning-of-item-list)
7712 (beginning-of-line 1)
7713 ;; find out what the bullet type is
7715 (setq bullet (match-string 1))
7716 ;; walk forward and replace these numbers
7717 (beginning-of-line 0)
7718 (catch 'exit
7719 (while t
7720 (catch 'next
7721 (beginning-of-line 2)
7722 (if (eobp) (throw 'exit nil))
7725 (if (> ind1 ind) (throw 'next t))
7726 (if (< ind1 ind) (throw 'exit t))
7727 (if (not (org-at-item-p)) (throw 'exit nil))
7730 (replace-match bullet))))
7731 (goto-line line)
7732 (move-to-column col)
7733 (if (string-match "[0-9]" bullet)
7734 (org-renumber-ordered-list 1))))
7736 (defun org-beginning-of-item-list ()
7737 "Go to the beginning of the current item list.
7738 I.e. to the first item in this list."
7739 (interactive)
7740 (org-beginning-of-item)
7741 (let ((pos (point-at-bol))
7742 (ind (org-get-indentation))
7743 ind1)
7744 ;; find where this list begins
7745 (catch 'exit
7746 (while t
7747 (catch 'next
7748 (beginning-of-line 0)
7750 (throw (if (bobp) 'exit 'next) t))
7752 (if (or (< ind1 ind)
7753 (and (= ind1 ind)
7754 (not (org-at-item-p)))
7755 (bobp))
7756 (throw 'exit t)
7757 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7758 (goto-char pos)))
7761 (defun org-end-of-item-list ()
7762 "Go to the end of the current item list.
7763 I.e. to the text after the last item."
7764 (interactive)
7765 (org-beginning-of-item)
7766 (let ((pos (point-at-bol))
7767 (ind (org-get-indentation))
7768 ind1)
7769 ;; find where this list begins
7770 (catch 'exit
7771 (while t
7772 (catch 'next
7773 (beginning-of-line 2)
7775 (throw (if (eobp) 'exit 'next) t))
7777 (if (or (< ind1 ind)
7778 (and (= ind1 ind)
7779 (not (org-at-item-p)))
7780 (eobp))
7781 (progn
7782 (setq pos (point-at-bol))
7783 (throw 'exit t))))))
7784 (goto-char pos)))
7787 (defvar org-last-indent-begin-marker (make-marker))
7788 (defvar org-last-indent-end-marker (make-marker))
7790 (defun org-outdent-item (arg)
7791 "Outdent a local list item."
7792 (interactive "p")
7793 (org-indent-item (- arg)))
7795 (defun org-indent-item (arg)
7796 "Indent a local list item."
7797 (interactive "p")
7798 (unless (org-at-item-p)
7799 (error "Not on an item"))
7800 (save-excursion
7801 (let (beg end ind ind1 tmp delta ind-down ind-up)
7802 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7803 (setq beg org-last-indent-begin-marker
7804 end org-last-indent-end-marker)
7805 (org-beginning-of-item)
7806 (setq beg (move-marker org-last-indent-begin-marker (point)))
7807 (org-end-of-item)
7808 (setq end (move-marker org-last-indent-end-marker (point))))
7809 (goto-char beg)
7810 (setq tmp (org-item-indent-positions)
7811 ind (car tmp)
7812 ind-down (nth 2 tmp)
7813 ind-up (nth 1 tmp)
7814 delta (if (> arg 0)
7815 (if ind-down (- ind-down ind) 2)
7816 (if ind-up (- ind-up ind) -2)))
7817 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7818 (while (< (point) end)
7819 (beginning-of-line 1)
7821 (delete-region (point-at-bol) (point))
7822 (or (eolp) (indent-to-column (+ ind1 delta)))
7823 (beginning-of-line 2))))
7824 (org-fix-bullet-type)
7825 (org-maybe-renumber-ordered-list-safe)
7826 (save-excursion
7827 (beginning-of-line 0)
7828 (condition-case nil (org-beginning-of-item) (error nil))
7829 (org-maybe-renumber-ordered-list-safe)))
7831 (defun org-item-indent-positions ()
7832 "Return indentation for plain list items.
7833 This returns a list with three values: The current indentation, the
7834 parent indentation and the indentation a child should habe.
7835 Assumes cursor in item line."
7836 (let* ((bolpos (point-at-bol))
7837 (ind (org-get-indentation))
7838 ind-down ind-up pos)
7839 (save-excursion
7840 (org-beginning-of-item-list)
7842 (when (org-in-item-p)
7843 (org-beginning-of-item)
7844 (setq ind-up (org-get-indentation))))
7845 (setq pos (point))
7846 (save-excursion
7847 (cond
7848 ((and (condition-case nil (progn (org-previous-item) t)
7849 (error nil))
7850 (or (forward-char 1) t)
7851 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7852 (setq ind-down (org-get-indentation)))
7853 ((and (goto-char pos)
7854 (org-at-item-p))
7855 (goto-char (match-end 0))
7857 (setq ind-down (current-column)))))
7858 (list ind ind-up ind-down)))
7860 ;;; The orgstruct minor mode
7862 ;; Define a minor mode which can be used in other modes in order to
7863 ;; integrate the org-mode structure editing commands.
7865 ;; This is really a hack, because the org-mode structure commands use
7866 ;; keys which normally belong to the major mode. Here is how it
7867 ;; works: The minor mode defines all the keys necessary to operate the
7868 ;; structure commands, but wraps the commands into a function which
7869 ;; tests if the cursor is currently at a headline or a plain list
7870 ;; item. If that is the case, the structure command is used,
7871 ;; temporarily setting many Org-mode variables like regular
7872 ;; expressions for filling etc. However, when any of those keys is
7873 ;; used at a different location, function uses `key-binding' to look
7874 ;; up if the key has an associated command in another currently active
7875 ;; keymap (minor modes, major mode, global), and executes that
7876 ;; command. There might be problems if any of the keys is otherwise
7877 ;; used as a prefix key.
7879 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7880 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7881 ;; addresses this by checking explicitly for both bindings.
7883 (defvar orgstruct-mode-map (make-sparse-keymap)
7884 "Keymap for the minor `orgstruct-mode'.")
7886 (defvar org-local-vars nil
7887 "List of local variables, for use by `orgstruct-mode'")
7889 ;;;###autoload
7890 (define-minor-mode orgstruct-mode
7891 "Toggle the minor more `orgstruct-mode'.
7892 This mode is for using Org-mode structure commands in other modes.
7893 The following key behave as if Org-mode was active, if the cursor
7894 is on a headline, or on a plain list item (both in the definition
7895 of Org-mode).
7897 M-up Move entry/item up
7898 M-down Move entry/item down
7899 M-left Promote
7900 M-right Demote
7901 M-S-up Move entry/item up
7902 M-S-down Move entry/item down
7903 M-S-left Promote subtree
7904 M-S-right Demote subtree
7905 M-q Fill paragraph and items like in Org-mode
7906 C-c ^ Sort entries
7907 C-c - Cycle list bullet
7908 TAB Cycle item visibility
7909 M-RET Insert new heading/item
7910 S-M-RET Insert new TODO heading / Chekbox item
7911 C-c C-c Set tags / toggle checkbox"
7912 nil " OrgStruct" nil
7913 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7915 ;;;###autoload
7916 (defun turn-on-orgstruct ()
7917 "Unconditionally turn on `orgstruct-mode'."
7918 (orgstruct-mode 1))
7920 ;;;###autoload
7921 (defun turn-on-orgstruct++ ()
7922 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7923 In addition to setting orgstruct-mode, this also exports all indentation and
7924 autofilling variables from org-mode into the buffer. Note that turning
7925 off orgstruct-mode will *not* remove these additional settings."
7926 (orgstruct-mode 1)
7927 (let (var val)
7928 (mapc
7929 (lambda (x)
7930 (when (string-match
7932 (symbol-name (car x)))
7933 (setq var (car x) val (nth 1 x))
7934 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7935 org-local-vars)))
7937 (defun orgstruct-error ()
7938 "Error when there is no default binding for a structure key."
7939 (interactive)
7940 (error "This key has no function outside structure elements"))
7942 (defun orgstruct-setup ()
7943 "Setup orgstruct keymaps."
7944 (let ((nfunc 0)
7945 (bindings
7946 (list
7947 '([(meta up)] org-metaup)
7948 '([(meta down)] org-metadown)
7949 '([(meta left)] org-metaleft)
7950 '([(meta right)] org-metaright)
7951 '([(meta shift up)] org-shiftmetaup)
7952 '([(meta shift down)] org-shiftmetadown)
7953 '([(meta shift left)] org-shiftmetaleft)
7954 '([(meta shift right)] org-shiftmetaright)
7955 '([(shift up)] org-shiftup)
7956 '([(shift down)] org-shiftdown)
7957 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7958 '("\M-q" fill-paragraph)
7959 '("\C-c^" org-sort)
7960 '("\C-c-" org-cycle-list-bullet)))
7961 elt key fun cmd)
7962 (while (setq elt (pop bindings))
7963 (setq nfunc (1+ nfunc))
7964 (setq key (org-key (car elt))
7965 fun (nth 1 elt)
7966 cmd (orgstruct-make-binding fun nfunc key))
7967 (org-defkey orgstruct-mode-map key cmd))
7969 ;; Special treatment needed for TAB and RET
7970 (org-defkey orgstruct-mode-map [(tab)]
7971 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7972 (org-defkey orgstruct-mode-map "\C-i"
7973 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7975 (org-defkey orgstruct-mode-map "\M-\C-m"
7976 (orgstruct-make-binding 'org-insert-heading 105
7977 "\M-\C-m" [(meta return)]))
7978 (org-defkey orgstruct-mode-map [(meta return)]
7979 (orgstruct-make-binding 'org-insert-heading 106
7980 [(meta return)] "\M-\C-m"))
7982 (org-defkey orgstruct-mode-map [(shift meta return)]
7983 (orgstruct-make-binding 'org-insert-todo-heading 107
7984 [(meta return)] "\M-\C-m"))
7986 (unless org-local-vars
7987 (setq org-local-vars (org-get-local-variables)))
7989 t))
7991 (defun orgstruct-make-binding (fun n &rest keys)
7992 "Create a function for binding in the structure minor mode.
7993 FUN is the command to call inside a table. N is used to create a unique
7994 command name. KEYS are keys that should be checked in for a command
7995 to execute outside of tables."
7996 (eval
7997 (list 'defun
7998 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7999 '(arg)
8001 "Outside of structure, run the binding of `"
8002 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8003 "'.")
8004 '(interactive "p")
8005 (list 'if
8006 '(org-context-p 'headline 'item)
8007 (list 'org-run-like-in-org-mode (list 'quote fun))
8008 (list 'let '(orgstruct-mode)
8009 (list 'call-interactively
8010 (append '(or)
8011 (mapcar (lambda (k)
8012 (list 'key-binding k))
8013 keys)
8014 '('orgstruct-error))))))))
8016 (defun org-context-p (&rest contexts)
8017 "Check if local context is and of CONTEXTS.
8018 Possible values in the list of contexts are `table', `headline', and `item'."
8019 (let ((pos (point)))
8020 (goto-char (point-at-bol))
8021 (prog1 (or (and (memq 'table contexts)
8023 (and (memq 'headline contexts)
8025 (and (memq 'item contexts)
8027 (goto-char pos))))
8029 (defun org-get-local-variables ()
8030 "Return a list of all local variables in an org-mode buffer."
8031 (let (varlist)
8032 (with-current-buffer (get-buffer-create "*Org tmp*")
8033 (erase-buffer)
8034 (org-mode)
8035 (setq varlist (buffer-local-variables)))
8036 (kill-buffer "*Org tmp*")
8037 (delq nil
8038 (mapcar
8039 (lambda (x)
8040 (setq x
8041 (if (symbolp x)
8042 (list x)
8043 (list (car x) (list 'quote (cdr x)))))
8044 (if (string-match
8045 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8046 (symbol-name (car x)))
8047 x nil))
8048 varlist))))
8050 ;;;###autoload
8051 (defun org-run-like-in-org-mode (cmd)
8052 (unless org-local-vars
8053 (setq org-local-vars (org-get-local-variables)))
8054 (eval (list 'let org-local-vars
8055 (list 'call-interactively (list 'quote cmd)))))
8057 ;;;; Archiving
8059 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
8061 (defun org-archive-subtree (&optional find-done)
8062 "Move the current subtree to the archive.
8063 The archive can be a certain top-level heading in the current file, or in
8064 a different file. The tree will be moved to that location, the subtree
8065 heading be marked DONE, and the current time will be added.
8067 When called with prefix argument FIND-DONE, find whole trees without any
8068 open TODO items and archive them (after getting confirmation from the user).
8069 If the cursor is not at a headline when this comand is called, try all level
8070 1 trees. If the cursor is on a headline, only try the direct children of
8071 this heading."
8072 (interactive "P")
8073 (if find-done
8074 (org-archive-all-done)
8075 ;; Save all relevant TODO keyword-relatex variables
8077 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
8078 (tr-org-todo-keywords-1 org-todo-keywords-1)
8079 (tr-org-todo-kwd-alist org-todo-kwd-alist)
8080 (tr-org-done-keywords org-done-keywords)
8081 (tr-org-todo-regexp org-todo-regexp)
8082 (tr-org-todo-line-regexp org-todo-line-regexp)
8083 (tr-org-odd-levels-only org-odd-levels-only)
8084 (this-buffer (current-buffer))
8085 (org-archive-location org-archive-location)
8087 ;; start of variables that will be used for saving context
8088 ;; The compiler complains about them - keep them anyway!
8089 (file (abbreviate-file-name (buffer-file-name)))
8090 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
8091 (time (format-time-string
8092 (substring (cdr org-time-stamp-formats) 1 -1)
8093 (current-time)))
8094 afile heading buffer level newfile-p
8095 category todo priority
8096 ;; start of variables that will be used for savind context
8097 ltags itags prop)
8099 ;; Try to find a local archive location
8100 (save-excursion
8101 (save-restriction
8102 (widen)
8103 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
8105 (setq org-archive-location prop)
8106 (if (or (re-search-backward re nil t)
8107 (re-search-forward re nil t))
8108 (setq org-archive-location (match-string 1))))))
8111 (progn
8112 (setq afile (format (match-string 1 org-archive-location)
8113 (file-name-nondirectory buffer-file-name))
8114 heading (match-string 2 org-archive-location)))
8115 (error "Invalid `org-archive-location'"))
8116 (if (> (length afile) 0)
8117 (setq newfile-p (not (file-exists-p afile))
8118 buffer (find-file-noselect afile))
8119 (setq buffer (current-buffer)))
8120 (unless buffer
8122 (if (and (> (length heading) 0)
8124 (setq level (match-end 0))
8125 (setq heading nil level 0))
8126 (save-excursion
8127 (org-back-to-heading t)
8128 ;; Get context information that will be lost by moving the tree
8129 (org-refresh-category-properties)
8130 (setq category (org-get-category)
8131 todo (and (looking-at org-todo-line-regexp)
8132 (match-string 2))
8133 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
8134 ltags (org-get-tags)
8135 itags (org-delete-all ltags (org-get-tags-at)))
8136 (setq ltags (mapconcat 'identity ltags " ")
8137 itags (mapconcat 'identity itags " "))
8138 ;; We first only copy, in case something goes wrong
8139 ;; we need to protect this-command, to avoid kill-region sets it,
8140 ;; which would lead to duplication of subtrees
8141 (let (this-command) (org-copy-subtree))
8142 (set-buffer buffer)
8143 ;; Enforce org-mode for the archive buffer
8144 (if (not (org-mode-p))
8145 ;; Force the mode for future visits.
8146 (let ((org-insert-mode-line-in-empty-file t)
8147 (org-inhibit-startup t))
8148 (call-interactively 'org-mode)))
8149 (when newfile-p
8150 (goto-char (point-max))
8152 (buffer-file-name this-buffer))))
8153 ;; Force the TODO keywords of the original buffer
8154 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
8155 (org-todo-keywords-1 tr-org-todo-keywords-1)
8156 (org-todo-kwd-alist tr-org-todo-kwd-alist)
8157 (org-done-keywords tr-org-done-keywords)
8158 (org-todo-regexp tr-org-todo-regexp)
8159 (org-todo-line-regexp tr-org-todo-line-regexp)
8160 (org-odd-levels-only
8161 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8162 org-odd-levels-only
8163 tr-org-odd-levels-only)))
8164 (goto-char (point-min))
8165 (show-all)
8166 (if heading
8167 (progn
8168 (if (re-search-forward
8169 (concat "^" (regexp-quote heading)
8171 nil t)
8172 (goto-char (match-end 0))
8173 ;; Heading not found, just insert it at the end
8174 (goto-char (point-max))
8177 (end-of-line 0))
8178 ;; Make the subtree visible
8179 (show-subtree)
8180 (org-end-of-subtree t)
8184 ;; No specific heading, just go to end of file.
8186 ;; Paste
8187 (org-paste-subtree (org-get-valid-level level 1))
8189 ;; Mark the entry as done
8190 (when (and org-archive-mark-done
8191 (looking-at org-todo-line-regexp)
8192 (or (not (match-end 2))
8193 (not (member (match-string 2) org-done-keywords))))
8194 (let (org-log-done org-todo-log-states)
8195 (org-todo
8196 (car (or (member org-archive-mark-done org-done-keywords)
8197 org-done-keywords)))))
8199 ;; Add the context info
8200 (when org-archive-save-context-info
8201 (let ((l org-archive-save-context-info) e n v)
8202 (while (setq e (pop l))
8203 (when (and (setq v (symbol-value e))
8205 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8206 (org-entry-put (point) n v)))))
8208 ;; Save and kill the buffer, if it is not the same buffer.
8209 (if (not (eq this-buffer buffer))
8210 (progn (save-buffer) (kill-buffer buffer)))))
8211 ;; Here we are back in the original buffer. Everything seems to have
8212 ;; worked. So now cut the tree and finish up.
8213 (let (this-command) (org-cut-subtree))
8215 (message "Subtree archived %s"
8216 (if (eq this-buffer buffer)
8217 (concat "under heading: " heading)
8218 (concat "in file: " (abbreviate-file-name afile)))))))
8220 (defun org-refresh-category-properties ()
8221 "Refresh category text properties in teh buffer."
8222 (let ((def-cat (cond
8223 ((null org-category)
8224 (if buffer-file-name
8225 (file-name-sans-extension
8226 (file-name-nondirectory buffer-file-name))
8227 "???"))
8228 ((symbolp org-category) (symbol-name org-category))
8229 (t org-category)))
8230 beg end cat pos optionp)
8231 (org-unmodified
8232 (save-excursion
8233 (save-restriction
8234 (widen)
8235 (goto-char (point-min))
8236 (put-text-property (point) (point-max) 'org-category def-cat)
8237 (while (re-search-forward
8239 (setq pos (match-end 0)
8240 optionp (equal (char-after (match-beginning 0)) ?#)
8241 cat (org-trim (match-string 2)))
8242 (if optionp
8243 (setq beg (point-at-bol) end (point-max))
8244 (org-back-to-heading t)
8245 (setq beg (point) end (org-end-of-subtree t t)))
8246 (put-text-property beg end 'org-category cat)
8247 (goto-char pos)))))))
8249 (defun org-archive-all-done (&optional tag)
8250 "Archive sublevels of the current tree without open TODO items.
8251 If the cursor is not on a headline, try all level 1 trees. If
8252 it is on a headline, try all direct children.
8253 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8255 (rea (concat ".*:" org-archive-tag ":"))
8256 (begm (make-marker))
8257 (endm (make-marker))
8258 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8259 "Move subtree to archive (no open TODO items)? "))
8260 beg end (cntarch 0))
8261 (if (org-on-heading-p)
8262 (progn
8263 (setq re1 (concat "^" (regexp-quote
8264 (make-string
8265 (1+ (- (match-end 0) (match-beginning 0) 1))
8266 ?*))
8267 " "))
8268 (move-marker begm (point))
8269 (move-marker endm (org-end-of-subtree t)))
8270 (setq re1 "^* ")
8271 (move-marker begm (point-min))
8272 (move-marker endm (point-max)))
8273 (save-excursion
8274 (goto-char begm)
8275 (while (re-search-forward re1 endm t)
8276 (setq beg (match-beginning 0)
8277 end (save-excursion (org-end-of-subtree t) (point)))
8278 (goto-char beg)
8279 (if (re-search-forward re end t)
8280 (goto-char end)
8281 (goto-char beg)
8282 (if (and (or (not tag) (not (looking-at rea)))
8283 (y-or-n-p question))
8284 (progn
8285 (if tag
8286 (org-toggle-tag org-archive-tag 'on)
8287 (org-archive-subtree))
8288 (setq cntarch (1+ cntarch)))
8289 (goto-char end)))))
8290 (message "%d trees archived" cntarch)))
8292 (defun org-cycle-hide-drawers (state)
8293 "Re-hide all drawers after a visibility state change."
8294 (when (and (org-mode-p)
8295 (not (memq state '(overview folded))))
8296 (save-excursion
8297 (let* ((globalp (memq state '(contents all)))
8298 (beg (if globalp (point-min) (point)))
8299 (end (if globalp (point-max) (org-end-of-subtree t))))
8300 (goto-char beg)
8301 (while (re-search-forward org-drawer-regexp end t)
8302 (org-flag-drawer t))))))
8304 (defun org-flag-drawer (flag)
8305 (save-excursion
8306 (beginning-of-line 1)
8308 (let ((b (match-end 0))
8309 (outline-regexp org-outline-regexp))
8310 (if (re-search-forward
8312 (save-excursion (outline-next-heading) (point)) t)
8313 (outline-flag-region b (point-at-eol) flag)
8314 (error ":END: line missing"))))))
8316 (defun org-cycle-hide-archived-subtrees (state)
8317 "Re-hide all archived subtrees after a visibility state change."
8318 (when (and (not org-cycle-open-archived-trees)
8319 (not (memq state '(overview folded))))
8320 (save-excursion
8321 (let* ((globalp (memq state '(contents all)))
8322 (beg (if globalp (point-min) (point)))
8323 (end (if globalp (point-max) (org-end-of-subtree t))))
8324 (org-hide-archived-subtrees beg end)
8325 (goto-char beg)
8326 (if (looking-at (concat ".*:" org-archive-tag ":"))
8327 (message "%s" (substitute-command-keys
8328 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8330 (defun org-force-cycle-archived ()
8331 "Cycle subtree even if it is archived."
8332 (interactive)
8333 (setq this-command 'org-cycle)
8334 (let ((org-cycle-open-archived-trees t))
8335 (call-interactively 'org-cycle)))
8337 (defun org-hide-archived-subtrees (beg end)
8338 "Re-hide all archived subtrees after a visibility state change."
8339 (save-excursion
8340 (let* ((re (concat ":" org-archive-tag ":")))
8341 (goto-char beg)
8342 (while (re-search-forward re end t)
8343 (and (org-on-heading-p) (hide-subtree))
8344 (org-end-of-subtree t)))))
8346 (defun org-toggle-tag (tag &optional onoff)
8347 "Toggle the tag TAG for the current line.
8348 If ONOFF is `on' or `off', don't toggle but set to this state."
8349 (unless (org-on-heading-p t) (error "Not on headling"))
8350 (let (res current)
8351 (save-excursion
8352 (beginning-of-line)
8354 (point-at-eol) t)
8355 (progn
8356 (setq current (match-string 1))
8357 (replace-match ""))
8358 (setq current ""))
8359 (setq current (nreverse (org-split-string current ":")))
8360 (cond
8361 ((eq onoff 'on)
8362 (setq res t)
8363 (or (member tag current) (push tag current)))
8364 ((eq onoff 'off)
8365 (or (not (member tag current)) (setq current (delete tag current))))
8366 (t (if (member tag current)
8367 (setq current (delete tag current))
8368 (setq res t)
8369 (push tag current))))
8370 (end-of-line 1)
8371 (if current
8372 (progn
8373 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8374 (org-set-tags nil t))
8375 (delete-horizontal-space))
8376 (run-hooks 'org-after-tags-change-hook))
8377 res))
8379 (defun org-toggle-archive-tag (&optional arg)
8380 "Toggle the archive tag for the current headline.
8381 With prefix ARG, check all children of current headline and offer tagging
8382 the children that do not contain any open TODO items."
8383 (interactive "P")
8384 (if arg
8385 (org-archive-all-done 'tag)
8386 (let (set)
8387 (save-excursion
8388 (org-back-to-heading t)
8389 (setq set (org-toggle-tag org-archive-tag))
8390 (when set (hide-subtree)))
8391 (and set (beginning-of-line 1))
8392 (message "Subtree %s" (if set "archived" "unarchived")))))
8395 ;;;; Tables
8397 ;;; The table editor
8399 ;; Watch out: Here we are talking about two different kind of tables.
8400 ;; Most of the code is for the tables created with the Org-mode table editor.
8401 ;; Sometimes, we talk about tables created and edited with the table.el
8402 ;; Emacs package. We call the former org-type tables, and the latter
8403 ;; table.el-type tables.
8405 (defun org-before-change-function (beg end)
8406 "Every change indicates that a table might need an update."
8407 (setq org-table-may-need-update t))
8410 "Detects an org-type table line.")
8412 "Detects an org-type table line.")
8414 "Detects a table line marked for automatic recalculation.")
8416 "Detects a table line marked for automatic recalculation.")
8418 "Detects a table line marked for automatic recalculation.")
8420 "Detects an org-type table hline.")
8422 "Detects a table-type table hline.")
8424 "Detects an org-type or table-type table.")
8426 "Searching from within a table (any type) this finds the first line
8427 outside the table.")
8429 "Searching from within a table (any type) this finds the first line
8430 outside the table.")
8432 (defvar org-table-last-highlighted-reference nil)
8433 (defvar org-table-formula-history nil)
8435 (defvar org-table-column-names nil
8436 "Alist with column names, derived from the `!' line.")
8437 (defvar org-table-column-name-regexp nil
8438 "Regular expression matching the current column names.")
8439 (defvar org-table-local-parameters nil
8440 "Alist with parameter names, derived from the `$' line.")
8441 (defvar org-table-named-field-locations nil
8442 "Alist with locations of named fields.")
8444 (defvar org-table-current-line-types nil
8445 "Table row types, non-nil only for the duration of a comand.")
8446 (defvar org-table-current-begin-line nil
8447 "Table begin line, non-nil only for the duration of a comand.")
8448 (defvar org-table-current-begin-pos nil
8449 "Table begin position, non-nil only for the duration of a comand.")
8450 (defvar org-table-dlines nil
8451 "Vector of data line line numbers in the current table.")
8452 (defvar org-table-hlines nil
8453 "Vector of hline line numbers in the current table.")
8455 (defconst org-table-range-regexp
8456 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8457 ;; 1 2 3 4 5
8458 "Regular expression for matching ranges in formulas.")
8460 (defconst org-table-range-regexp2
8461 (concat
8465 "Match a range for reference display.")
8467 (defconst org-table-translate-regexp
8469 "Match a reference that needs translation, for reference display.")
8471 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8473 (defun org-table-create-with-table.el ()
8474 "Use the table.el package to insert a new table.
8475 If there is already a table at point, convert between Org-mode tables
8476 and table.el tables."
8477 (interactive)
8478 (require 'table)
8479 (cond
8480 ((org-at-table.el-p)
8481 (if (y-or-n-p "Convert table to Org-mode table? ")
8482 (org-table-convert)))
8483 ((org-at-table-p)
8484 (if (y-or-n-p "Convert table to table.el table? ")
8485 (org-table-convert)))
8486 (t (call-interactively 'table-insert))))
8488 (defun org-table-create-or-convert-from-region (arg)
8489 "Convert region to table, or create an empty table.
8490 If there is an active region, convert it to a table, using the function
8491 `org-table-convert-region'. See the documentation of that function
8492 to learn how the prefix argument is interpreted to determine the field
8493 separator.
8494 If there is no such region, create an empty table with `org-table-create'."
8495 (interactive "P")
8496 (if (org-region-active-p)
8497 (org-table-convert-region (region-beginning) (region-end) arg)
8498 (org-table-create arg)))
8500 (defun org-table-create (&optional size)
8501 "Query for a size and insert a table skeleton.
8503 (interactive "P")
8504 (unless size
8505 (setq size (read-string
8506 (concat "Table size Columns x Rows [e.g. "
8507 org-table-default-size "]: ")
8508 "" nil org-table-default-size)))
8510 (let* ((pos (point))
8511 (indent (make-string (current-column) ?\ ))
8512 (split (org-split-string size " *x *"))
8513 (rows (string-to-number (nth 1 split)))
8514 (columns (string-to-number (car split)))
8515 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8518 (point-at-bol) (point)))
8519 (beginning-of-line 1)
8520 (newline))
8521 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8522 (dotimes (i rows) (insert line))
8523 (goto-char pos)
8524 (if (> rows 1)
8525 ;; Insert a hline after the first row.
8526 (progn
8527 (end-of-line 1)
8529 (goto-char pos)))
8530 (org-table-align)))
8532 (defun org-table-convert-region (beg0 end0 &optional separator)
8533 "Convert region to a table.
8534 The region goes from BEG0 to END0, but these borders will be moved
8535 slightly, to make sure a beginning of line in the first line is included.
8537 SEPARATOR specifies the field separator in the lines. It can have the
8538 following values:
8540 '(4) Use the comma as a field separator
8541 '(16) Use a TAB as field separator
8542 integer When a number, use that many spaces as field separator
8543 nil When nil, the command tries to be smart and figure out the
8544 separator in the following way:
8545 - when each line contains a TAB, assume TAB-separated material
8546 - when each line contains a comme, assume CSV material
8547 - else, assume one or more SPACE charcters as separator."
8548 (interactive "rP")
8549 (let* ((beg (min beg0 end0))
8550 (end (max beg0 end0))
8551 re)
8552 (goto-char beg)
8553 (beginning-of-line 1)
8554 (setq beg (move-marker (make-marker) (point)))
8555 (goto-char end)
8556 (if (bolp) (backward-char 1) (end-of-line 1))
8557 (setq end (move-marker (make-marker) (point)))
8558 ;; Get the right field separator
8559 (unless separator
8560 (goto-char beg)
8561 (setq separator
8562 (cond
8565 (t 1))))
8566 (setq re (cond
8569 ((integerp separator)
8571 (t (error "This should not happen"))))
8572 (goto-char beg)
8573 (while (re-search-forward re end t)
8574 (replace-match "| " t t))
8575 (goto-char beg)
8576 (insert " ")
8577 (org-table-align)))
8579 (defun org-table-import (file arg)
8580 "Import FILE as a table.
8581 The file is assumed to be tab-separated. Such files can be produced by most
8582 spreadsheet and database applications. If no tabs (at least one per line)
8583 are found, lines will be split on whitespace into fields."
8585 (or (bolp) (newline))
8586 (let ((beg (point))
8587 (pm (point-max)))
8588 (insert-file-contents file)
8589 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8591 (defun org-table-export ()
8592 "Export table as a tab-separated file.
8593 Such a file can be imported into a spreadsheet program like Excel."
8594 (interactive)
8595 (let* ((beg (org-table-begin))
8596 (end (org-table-end))
8597 (table (buffer-substring beg end))
8598 (file (read-file-name "Export table to: "))
8599 buf)
8600 (unless (or (not (file-exists-p file))
8601 (y-or-n-p (format "Overwrite file %s? " file)))
8602 (error "Abort"))
8603 (with-current-buffer (find-file-noselect file)
8604 (setq buf (current-buffer))
8605 (erase-buffer)
8606 (fundamental-mode)
8607 (insert table)
8608 (goto-char (point-min))
8610 (replace-match "" t t)
8611 (end-of-line 1))
8612 (goto-char (point-min))
8614 (replace-match "" t t)
8615 (goto-char (min (1+ (point)) (point-max))))
8616 (goto-char (point-min))
8617 (while (re-search-forward "^-[-+]*$" nil t)
8618 (replace-match "")
8620 (delete-char 1)))
8621 (goto-char (point-min))
8624 (save-buffer))
8625 (kill-buffer buf)))
8627 (defvar org-table-aligned-begin-marker (make-marker)
8628 "Marker at the beginning of the table last aligned.
8629 Used to check if cursor still is in that table, to minimize realignment.")
8630 (defvar org-table-aligned-end-marker (make-marker)
8631 "Marker at the end of the table last aligned.
8632 Used to check if cursor still is in that table, to minimize realignment.")
8633 (defvar org-table-last-alignment nil
8634 "List of flags for flushright alignment, from the last re-alignment.
8635 This is being used to correctly align a single field after TAB or RET.")
8636 (defvar org-table-last-column-widths nil
8637 "List of max width of fields in each column.
8638 This is being used to correctly align a single field after TAB or RET.")
8639 (defvar org-table-overlay-coordinates nil
8640 "Overlay coordinates after each align of a table.")
8641 (make-variable-buffer-local 'org-table-overlay-coordinates)
8643 (defvar org-last-recalc-line nil)
8644 (defconst org-narrow-column-arrow "=>"
8645 "Used as display property in narrowed table columns.")
8647 (defun org-table-align ()
8648 "Align the table at point by aligning all vertical bars."
8649 (interactive)
8650 (let* (
8651 ;; Limits of table
8652 (beg (org-table-begin))
8653 (end (org-table-end))
8654 ;; Current cursor position
8655 (linepos (org-current-line))
8656 (colpos (org-table-current-column))
8657 (winstart (window-start))
8658 (winstartline (org-current-line (min winstart (1- (point-max)))))
8659 lines (new "") lengths l typenums ty fields maxfields i
8660 column
8661 (indent "") cnt frac
8662 rfmt hfmt
8663 (spaces '(1 . 1))
8664 (sp1 (car spaces))
8665 (sp2 (cdr spaces))
8666 (rfmt1 (concat
8667 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8668 (hfmt1 (concat
8669 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8670 emptystrings links dates emph narrow fmax f1 len c e)
8671 (untabify beg end)
8672 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8673 ;; Check if we have links or dates
8674 (goto-char beg)
8675 (setq links (re-search-forward org-bracket-link-regexp end t))
8676 (goto-char beg)
8677 (setq emph (and org-hide-emphasis-markers
8678 (re-search-forward org-emph-re end t)))
8679 (goto-char beg)
8680 (setq dates (and org-display-custom-times
8681 (re-search-forward org-ts-regexp-both end t)))
8682 ;; Make sure the link properties are right
8683 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8684 ;; Make sure the date properties are right
8685 (when dates (goto-char beg) (while (org-activate-dates end)))
8686 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8688 ;; Check if we are narrowing any columns
8689 (goto-char beg)
8690 (setq narrow (and org-format-transports-properties-p
8691 (re-search-forward "<[0-9]+>" end t)))
8692 ;; Get the rows
8693 (setq lines (org-split-string
8695 ;; Store the indentation of the first line
8696 (if (string-match "^ *" (car lines))
8697 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8698 ;; Mark the hlines by setting the corresponding element to nil
8699 ;; At the same time, we remove trailing space.
8700 (setq lines (mapcar (lambda (l)
8701 (if (string-match "^ *|-" l)
8702 nil
8704 (substring l 0 (match-beginning 0))
8705 l)))
8706 lines))
8707 ;; Get the data fields by splitting the lines.
8708 (setq fields (mapcar
8709 (lambda (l)
8710 (org-split-string l " *| *"))
8711 (delq nil (copy-sequence lines))))
8712 ;; How many fields in the longest line?
8713 (condition-case nil
8714 (setq maxfields (apply 'max (mapcar 'length fields)))
8715 (error
8716 (kill-region beg end)
8717 (org-table-create org-table-default-size)
8718 (error "Empty table - created default table")))
8719 ;; A list of empty strings to fill any short rows on output
8720 (setq emptystrings (make-list maxfields ""))
8721 ;; Check for special formatting.
8722 (setq i -1)
8723 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8724 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8725 ;; Check if there is an explicit width specified
8726 (when narrow
8727 (setq c column fmax nil)
8728 (while c
8729 (setq e (pop c))
8731 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8732 ;; Find fields that are wider than fmax, and shorten them
8733 (when fmax
8734 (loop for xx in column do
8735 (when (and (stringp xx)
8736 (> (org-string-width xx) fmax))
8737 (org-add-props xx nil
8738 'help-echo
8739 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8740 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8741 (unless (> f1 1)
8743 (match-string 0 xx)))
8744 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8745 (add-text-properties (- f1 2) f1
8746 (list 'display org-narrow-column-arrow)
8747 xx)))))
8748 ;; Get the maximum width for each column
8749 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8750 ;; Get the fraction of numbers, to decide about alignment of the column
8751 (setq cnt 0 frac 0.0)
8752 (loop for x in column do
8753 (if (equal x "")
8754 nil
8755 (setq frac ( / (+ (* frac cnt)
8756 (if (string-match org-table-number-regexp x) 1 0))
8757 (setq cnt (1+ cnt))))))
8758 (push (>= frac org-table-number-fraction) typenums))
8759 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8761 ;; Store the alignment of this table, for later editing of single fields
8762 (setq org-table-last-alignment typenums
8763 org-table-last-column-widths lengths)
8765 ;; With invisible characters, `format' does not get the field width right
8766 ;; So we need to make these fields wide by hand.
8767 (when (or links emph)
8768 (loop for i from 0 upto (1- maxfields) do
8769 (setq len (nth i lengths))
8770 (loop for j from 0 upto (1- (length fields)) do
8771 (setq c (nthcdr i (car (nthcdr j fields))))
8772 (if (and (stringp (car c))
8773 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8774 ; (string-match org-bracket-link-regexp (car c))
8775 (< (org-string-width (car c)) len))
8776 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8778 ;; Compute the formats needed for output of the table
8779 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8780 (while (setq l (pop lengths))
8781 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8782 (setq rfmt (concat rfmt (format rfmt1 ty l))
8783 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8787 (setq new (mapconcat
8788 (lambda (l)
8789 (if l (apply 'format rfmt
8790 (append (pop fields) emptystrings))
8791 hfmt))
8792 lines ""))
8793 ;; Replace the old one
8794 (delete-region beg end)
8795 (move-marker end nil)
8796 (move-marker org-table-aligned-begin-marker (point))
8797 (insert new)
8798 (move-marker org-table-aligned-end-marker (point))
8799 (when (and orgtbl-mode (not (org-mode-p)))
8800 (goto-char org-table-aligned-begin-marker)
8801 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8802 ;; Try to move to the old location
8803 (goto-line winstartline)
8804 (setq winstart (point-at-bol))
8805 (goto-line linepos)
8806 (set-window-start (selected-window) winstart 'noforce)
8807 (org-table-goto-column colpos)
8808 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8809 (setq org-table-may-need-update nil)
8810 ))
8812 (defun org-string-width (s)
8813 "Compute width of string, ignoring invisible characters.
8814 This ignores character with invisibility property `org-link', and also
8815 characters with property `org-cwidth', because these will become invisible
8816 upon the next fontification round."
8817 (let (b l)
8818 (when (or (eq t buffer-invisibility-spec)
8819 (assq 'org-link buffer-invisibility-spec))
8820 (while (setq b (text-property-any 0 (length s)
8821 'invisible 'org-link s))
8822 (setq s (concat (substring s 0 b)
8823 (substring s (or (next-single-property-change
8824 b 'invisible s) (length s)))))))
8825 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8826 (setq s (concat (substring s 0 b)
8827 (substring s (or (next-single-property-change
8828 b 'org-cwidth s) (length s))))))
8829 (setq l (string-width s) b -1)
8830 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8831 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8832 l))
8834 (defun org-table-begin (&optional table-type)
8835 "Find the beginning of the table and return its position.
8836 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8837 (save-excursion
8838 (if (not (re-search-backward
8839 (if table-type org-table-any-border-regexp
8840 org-table-border-regexp)
8841 nil t))
8842 (progn (goto-char (point-min)) (point))
8843 (goto-char (match-beginning 0))
8844 (beginning-of-line 2)
8845 (point))))
8847 (defun org-table-end (&optional table-type)
8848 "Find the end of the table and return its position.
8849 With argument TABLE-TYPE, go to the end of a table.el-type table."
8850 (save-excursion
8851 (if (not (re-search-forward
8852 (if table-type org-table-any-border-regexp
8853 org-table-border-regexp)
8854 nil t))
8855 (goto-char (point-max))
8856 (goto-char (match-beginning 0)))
8857 (point-marker)))
8859 (defun org-table-justify-field-maybe (&optional new)
8860 "Justify the current field, text to left, number to right.
8861 Optional argument NEW may specify text to replace the current field content."
8862 (cond
8863 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8864 ((org-at-table-hline-p))
8865 ((and (not new)
8866 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8867 (current-buffer)))
8868 (< (point) org-table-aligned-begin-marker)
8869 (>= (point) org-table-aligned-end-marker)))
8870 ;; This is not the same table, force a full re-align
8871 (setq org-table-may-need-update t))
8872 (t ;; realign the current field, based on previous full realign
8873 (let* ((pos (point)) s
8874 (col (org-table-current-column))
8875 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8876 l f n o e)
8877 (when (> col 0)
8880 (progn
8881 (setq s (match-string 1)
8882 o (match-string 0)
8883 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8884 e (not (= (match-beginning 2) (match-end 2))))
8885 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8886 l (if e "|" (setq org-table-may-need-update t) ""))
8887 n (format f s))
8888 (if new
8889 (if (<= (length new) l) ;; FIXME: length -> str-width?
8890 (setq n (format f new))
8891 (setq n (concat new "|") org-table-may-need-update t)))
8892 (or (equal n o)
8893 (let (org-table-may-need-update)
8894 (replace-match n t t))))
8895 (setq org-table-may-need-update t))
8896 (goto-char pos))))))
8898 (defun org-table-next-field ()
8899 "Go to the next field in the current table, creating new lines as needed.
8900 Before doing so, re-align the table if necessary."
8901 (interactive)
8902 (org-table-maybe-eval-formula)
8903 (org-table-maybe-recalculate-line)
8904 (if (and org-table-automatic-realign
8905 org-table-may-need-update)
8906 (org-table-align))
8907 (let ((end (org-table-end)))
8908 (if (org-at-table-hline-p)
8909 (end-of-line 1))
8910 (condition-case nil
8911 (progn
8912 (re-search-forward "|" end)
8914 (re-search-forward "|" end))
8915 (if (and (looking-at "-")
8916 org-table-tab-jumps-over-hlines
8918 (goto-char (match-beginning 1)))
8919 (if (looking-at "-")
8920 (progn
8921 (beginning-of-line 0)
8922 (org-table-insert-row 'below))
8923 (if (looking-at " ") (forward-char 1))))
8924 (error
8925 (org-table-insert-row 'below)))))
8927 (defun org-table-previous-field ()
8928 "Go to the previous field in the table.
8929 Before doing so, re-align the table if necessary."
8930 (interactive)
8931 (org-table-justify-field-maybe)
8932 (org-table-maybe-recalculate-line)
8933 (if (and org-table-automatic-realign
8934 org-table-may-need-update)
8935 (org-table-align))
8936 (if (org-at-table-hline-p)
8937 (end-of-line 1))
8938 (re-search-backward "|" (org-table-begin))
8939 (re-search-backward "|" (org-table-begin))
8941 (re-search-backward "|" (org-table-begin)))
8942 (if (looking-at "| ?")
8943 (goto-char (match-end 0))))
8945 (defun org-table-next-row ()
8946 "Go to the next row (same column) in the current table.
8947 Before doing so, re-align the table if necessary."
8948 (interactive)
8949 (org-table-maybe-eval-formula)
8950 (org-table-maybe-recalculate-line)
8953 (newline)
8954 (if (and org-table-automatic-realign
8955 org-table-may-need-update)
8956 (org-table-align))
8957 (let ((col (org-table-current-column)))
8958 (beginning-of-line 2)
8959 (if (or (not (org-at-table-p))
8960 (org-at-table-hline-p))
8961 (progn
8962 (beginning-of-line 0)
8963 (org-table-insert-row 'below)))
8964 (org-table-goto-column col)
8966 (if (looking-at " ") (forward-char 1)))))
8968 (defun org-table-copy-down (n)
8969 "Copy a field down in the current column.
8970 If the field at the cursor is empty, copy into it the content of the nearest
8971 non-empty field above. With argument N, use the Nth non-empty field.
8972 If the current field is not empty, it is copied down to the next row, and
8973 the cursor is moved with it. Therefore, repeating this command causes the
8974 column to be filled row-by-row.
8975 If the variable `org-table-copy-increment' is non-nil and the field is an
8976 integer or a timestamp, it will be incremented while copying. In the case of
8977 a timestamp, if the cursor is on the year, change the year. If it is on the
8978 month or the day, change that. Point will stay on the current date field
8979 in order to easily repeat the interval."
8980 (interactive "p")
8981 (let* ((colpos (org-table-current-column))
8982 (col (current-column))
8983 (field (org-table-get-field))
8985 (beg (org-table-begin))
8986 txt)
8987 (org-table-check-inside-data-field)
8988 (if non-empty
8989 (progn
8990 (setq txt (org-trim field))
8991 (org-table-next-row)
8992 (org-table-blank-field))
8993 (save-excursion
8994 (setq txt
8995 (catch 'exit
8996 (while (progn (beginning-of-line 1)
8997 (re-search-backward org-table-dataline-regexp
8998 beg t))
8999 (org-table-goto-column colpos t)
9000 (if (and (looking-at
9002 (= (setq n (1- n)) 0))
9003 (throw 'exit (match-string 1))))))))
9004 (if txt
9005 (progn
9006 (if (and org-table-copy-increment
9007 (string-match "^[0-9]+$" txt))
9008 (setq txt (format "%d" (+ (string-to-number txt) 1))))
9009 (insert txt)
9010 (move-to-column col)
9011 (if (and org-table-copy-increment (org-at-timestamp-p t))
9012 (org-timestamp-up 1)
9013 (org-table-maybe-recalculate-line))
9014 (org-table-align)
9015 (move-to-column col))
9016 (error "No non-empty field found"))))
9018 (defun org-table-check-inside-data-field ()
9019 "Is point inside a table data field?
9020 I.e. not on a hline or before the first or after the last column?
9021 This actually throws an error, so it aborts the current command."
9022 (if (or (not (org-at-table-p))
9023 (= (org-table-current-column) 0)
9024 (org-at-table-hline-p)
9026 (error "Not in table data field")))
9028 (defvar org-table-clip nil
9029 "Clipboard for table regions.")
9031 (defun org-table-blank-field ()
9032 "Blank the current table field or active region."
9033 (interactive)
9034 (org-table-check-inside-data-field)
9035 (if (and (interactive-p) (org-region-active-p))
9036 (let (org-table-clip)
9037 (org-table-cut-region (region-beginning) (region-end)))
9038 (skip-chars-backward "^|")
9039 (backward-char 1)
9041 (let* ((pos (match-beginning 0))
9042 (match (match-string 0))
9043 (len (org-string-width match)))
9044 (replace-match (concat "|" (make-string (1- len) ?\ )))
9045 (goto-char (+ 2 pos))
9046 (substring match 1)))))
9048 (defun org-table-get-field (&optional n replace)
9049 "Return the value of the field in column N of current row.
9050 N defaults to current field.
9051 If REPLACE is a string, replace field with this value. The return value
9052 is always the old value."
9053 (and n (org-table-goto-column n))
9055 (backward-char 1)
9057 (let* ((pos (match-beginning 0))
9058 (val (buffer-substring (1+ pos) (match-end 0))))
9059 (if replace
9060 (replace-match (concat "|" replace) t t))
9061 (goto-char (min (point-at-eol) (+ 2 pos)))
9062 val)
9063 (forward-char 1) ""))
9065 (defun org-table-field-info (arg)
9066 "Show info about the current field, and highlight any reference at point."
9067 (interactive "P")
9068 (org-table-get-specials)
9069 (save-excursion
9070 (let* ((pos (point))
9071 (col (org-table-current-column))
9072 (cname (car (rassoc (int-to-string col) org-table-column-names)))
9073 (name (car (rassoc (list (org-current-line) col)
9074 org-table-named-field-locations)))
9075 (eql (org-table-get-stored-formulas))
9076 (dline (org-table-current-dline))
9077 (ref (format "@%d$%d" dline col))
9078 (ref1 (org-table-convert-refs-to-an ref))
9079 (fequation (or (assoc name eql) (assoc ref eql)))
9080 (cequation (assoc (int-to-string col) eql))
9081 (eqn (or fequation cequation)))
9082 (goto-char pos)
9083 (condition-case nil
9084 (org-table-show-reference 'local)
9085 (error nil))
9086 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
9087 dline col
9088 (if cname (concat " or $" cname) "")
9089 dline col ref1
9090 (if name (concat " or $" name) "")
9091 ;; FIXME: formula info not correct if special table line
9092 (if eqn
9093 (concat ", formula: "
9094 (org-table-formula-to-user
9095 (concat
9096 (if (string-match "^[$@]"(car eqn)) "" "$")
9097 (car eqn) "=" (cdr eqn))))
9098 "")))))
9100 (defun org-table-current-column ()
9101 "Find out which column we are in.
9102 When called interactively, column is also displayed in echo area."
9103 (interactive)
9104 (if (interactive-p) (org-table-check-inside-data-field))
9105 (save-excursion
9106 (let ((cnt 0) (pos (point)))
9107 (beginning-of-line 1)
9108 (while (search-forward "|" pos t)
9109 (setq cnt (1+ cnt)))
9110 (if (interactive-p) (message "This is table column %d" cnt))
9111 cnt)))
9113 (defun org-table-current-dline ()
9114 "Find out what table data line we are in.
9115 Only datalins count for this."
9116 (interactive)
9117 (if (interactive-p) (org-table-check-inside-data-field))
9118 (save-excursion
9119 (let ((cnt 0) (pos (point)))
9120 (goto-char (org-table-begin))
9121 (while (<= (point) pos)
9122 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
9123 (beginning-of-line 2))
9124 (if (interactive-p) (message "This is table line %d" cnt))
9125 cnt)))
9127 (defun org-table-goto-column (n &optional on-delim force)
9128 "Move the cursor to the Nth column in the current table line.
9129 With optional argument ON-DELIM, stop with point before the left delimiter
9130 of the field.
9131 If there are less than N fields, just go to after the last delimiter.
9132 However, when FORCE is non-nil, create new columns if necessary."
9133 (interactive "p")
9134 (let ((pos (point-at-eol)))
9135 (beginning-of-line 1)
9136 (when (> n 0)
9137 (while (and (> (setq n (1- n)) -1)
9138 (or (search-forward "|" pos t)
9139 (and force
9140 (progn (end-of-line 1)
9141 (skip-chars-backward "^|")
9142 (insert " | "))))))
9143 ; (backward-char 2) t)))))
9144 (when (and force (not (looking-at ".*|")))
9145 (save-excursion (end-of-line 1) (insert " | ")))
9146 (if on-delim
9147 (backward-char 1)
9148 (if (looking-at " ") (forward-char 1))))))
9150 (defun org-at-table-p (&optional table-type)
9151 "Return t if the cursor is inside an org-type table.
9152 If TABLE-TYPE is non-nil, also check for table.el-type tables."
9153 (if org-enable-table-editor
9154 (save-excursion
9155 (beginning-of-line 1)
9156 (looking-at (if table-type org-table-any-line-regexp
9157 org-table-line-regexp)))
9158 nil))
9160 (defun org-at-table.el-p ()
9161 "Return t if and only if we are at a table.el table."
9162 (and (org-at-table-p 'any)
9163 (save-excursion
9164 (goto-char (org-table-begin 'any))
9165 (looking-at org-table1-hline-regexp))))
9167 (defun org-table-recognize-table.el ()
9168 "If there is a table.el table nearby, recognize it and move into it."
9169 (if org-table-tab-recognizes-table.el
9170 (if (org-at-table.el-p)
9171 (progn
9172 (beginning-of-line 1)
9173 (if (looking-at org-table-dataline-regexp)
9174 nil
9175 (if (looking-at org-table1-hline-regexp)
9176 (progn
9177 (beginning-of-line 2)
9178 (if (looking-at org-table-any-border-regexp)
9179 (beginning-of-line -1)))))
9180 (if (re-search-forward "|" (org-table-end t) t)
9181 (progn
9182 (require 'table)
9183 (if (table--at-cell-p (point))
9184 t
9185 (message "recognizing table.el table...")
9186 (table-recognize-table)
9187 (message "recognizing table.el table...done")))
9188 (error "This should not happen..."))
9189 t)
9190 nil)
9191 nil))
9193 (defun org-at-table-hline-p ()
9194 "Return t if the cursor is inside a hline in a table."
9195 (if org-enable-table-editor
9196 (save-excursion
9197 (beginning-of-line 1)
9198 (looking-at org-table-hline-regexp))
9199 nil))
9201 (defun org-table-insert-column ()
9202 "Insert a new column into the table."
9203 (interactive)
9204 (if (not (org-at-table-p))
9205 (error "Not at a table"))
9206 (org-table-find-dataline)
9207 (let* ((col (max 1 (org-table-current-column)))
9208 (beg (org-table-begin))
9209 (end (org-table-end))
9210 ;; Current cursor position
9211 (linepos (org-current-line))
9212 (colpos col))
9213 (goto-char beg)
9214 (while (< (point) end)
9215 (if (org-at-table-hline-p)
9216 nil
9217 (org-table-goto-column col t)
9218 (insert "| "))
9219 (beginning-of-line 2))
9220 (move-marker end nil)
9221 (goto-line linepos)
9222 (org-table-goto-column colpos)
9223 (org-table-align)
9224 (org-table-fix-formulas "$" nil (1- col) 1)))
9226 (defun org-table-find-dataline ()
9227 "Find a dataline in the current table, which is needed for column commands."
9228 (if (and (org-at-table-p)
9229 (not (org-at-table-hline-p)))
9230 t
9231 (let ((col (current-column))
9232 (end (org-table-end)))
9233 (move-to-column col)
9234 (while (and (< (point) end)
9235 (or (not (= (current-column) col))
9236 (org-at-table-hline-p)))
9237 (beginning-of-line 2)
9238 (move-to-column col))
9239 (if (and (org-at-table-p)
9240 (not (org-at-table-hline-p)))
9241 t
9242 (error
9243 "Please position cursor in a data line for column operations")))))
9245 (defun org-table-delete-column ()
9246 "Delete a column from the table."
9247 (interactive)
9248 (if (not (org-at-table-p))
9249 (error "Not at a table"))
9250 (org-table-find-dataline)
9251 (org-table-check-inside-data-field)
9252 (let* ((col (org-table-current-column))
9253 (beg (org-table-begin))
9254 (end (org-table-end))
9255 ;; Current cursor position
9256 (linepos (org-current-line))
9257 (colpos col))
9258 (goto-char beg)
9259 (while (< (point) end)
9260 (if (org-at-table-hline-p)
9261 nil
9262 (org-table-goto-column col t)
9264 (replace-match "|")))
9265 (beginning-of-line 2))
9266 (move-marker end nil)
9267 (goto-line linepos)
9268 (org-table-goto-column colpos)
9269 (org-table-align)
9270 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9271 col -1 col)))
9273 (defun org-table-move-column-right ()
9274 "Move column to the right."
9275 (interactive)
9276 (org-table-move-column nil))
9277 (defun org-table-move-column-left ()
9278 "Move column to the left."
9279 (interactive)
9280 (org-table-move-column 'left))
9282 (defun org-table-move-column (&optional left)
9283 "Move the current column to the right. With arg LEFT, move to the left."
9284 (interactive "P")
9285 (if (not (org-at-table-p))
9286 (error "Not at a table"))
9287 (org-table-find-dataline)
9288 (org-table-check-inside-data-field)
9289 (let* ((col (org-table-current-column))
9290 (col1 (if left (1- col) col))
9291 (beg (org-table-begin))
9292 (end (org-table-end))
9293 ;; Current cursor position
9294 (linepos (org-current-line))
9295 (colpos (if left (1- col) (1+ col))))
9296 (if (and left (= col 1))
9297 (error "Cannot move column further left"))
9299 (error "Cannot move column further right"))
9300 (goto-char beg)
9301 (while (< (point) end)
9302 (if (org-at-table-hline-p)
9303 nil
9304 (org-table-goto-column col1 t)
9307 (beginning-of-line 2))
9308 (move-marker end nil)
9309 (goto-line linepos)
9310 (org-table-goto-column colpos)
9311 (org-table-align)
9312 (org-table-fix-formulas
9313 "$" (list (cons (number-to-string col) (number-to-string colpos))
9314 (cons (number-to-string colpos) (number-to-string col))))))
9316 (defun org-table-move-row-down ()
9317 "Move table row down."
9318 (interactive)
9319 (org-table-move-row nil))
9320 (defun org-table-move-row-up ()
9321 "Move table row up."
9322 (interactive)
9323 (org-table-move-row 'up))
9325 (defun org-table-move-row (&optional up)
9326 "Move the current table line down. With arg UP, move it up."
9327 (interactive "P")
9328 (let* ((col (current-column))
9329 (pos (point))
9330 (hline1p (save-excursion (beginning-of-line 1)
9331 (looking-at org-table-hline-regexp)))
9332 (dline1 (org-table-current-dline))
9333 (dline2 (+ dline1 (if up -1 1)))
9334 (tonew (if up 0 2))
9335 txt hline2p)
9336 (beginning-of-line tonew)
9337 (unless (org-at-table-p)
9338 (goto-char pos)
9339 (error "Cannot move row further"))
9340 (setq hline2p (looking-at org-table-hline-regexp))
9341 (goto-char pos)
9342 (beginning-of-line 1)
9343 (setq pos (point))
9344 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9345 (delete-region (point) (1+ (point-at-eol)))
9346 (beginning-of-line tonew)
9347 (insert txt)
9348 (beginning-of-line 0)
9349 (move-to-column col)
9350 (unless (or hline1p hline2p)
9351 (org-table-fix-formulas
9352 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9353 (cons (number-to-string dline2) (number-to-string dline1)))))))
9355 (defun org-table-insert-row (&optional arg)
9356 "Insert a new row above the current line into the table.
9357 With prefix ARG, insert below the current line."
9358 (interactive "P")
9359 (if (not (org-at-table-p))
9360 (error "Not at a table"))
9361 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9362 (new (org-table-clean-line line)))
9363 ;; Fix the first field if necessary
9365 (setq new (replace-match (match-string 0 line) t t new)))
9366 (beginning-of-line (if arg 2 1))
9368 (beginning-of-line 0)
9369 (re-search-forward "| ?" (point-at-eol) t)
9370 (and (or org-table-may-need-update org-table-overlay-coordinates)
9371 (org-table-align))
9372 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9374 (defun org-table-insert-hline (&optional above)
9375 "Insert a horizontal-line below the current line into the table.
9376 With prefix ABOVE, insert above the current line."
9377 (interactive "P")
9378 (if (not (org-at-table-p))
9379 (error "Not at a table"))
9380 (let ((line (org-table-clean-line
9381 (buffer-substring (point-at-bol) (point-at-eol))))
9382 (col (current-column)))
9384 (setq line (replace-match
9385 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9386 ?-) "|") t t line)))
9388 (beginning-of-line (if above 1 2))
9390 (beginning-of-line (if above 1 -1))
9391 (move-to-column col)
9392 (and org-table-overlay-coordinates (org-table-align))))
9394 (defun org-table-hline-and-move (&optional same-column)
9395 "Insert a hline and move to the row below that line."
9396 (interactive "P")
9397 (let ((col (org-table-current-column)))
9398 (org-table-maybe-eval-formula)
9399 (org-table-maybe-recalculate-line)
9400 (org-table-insert-hline)
9401 (end-of-line 2)
9404 (org-table-next-field))
9405 (if same-column (org-table-goto-column col))))
9407 (defun org-table-clean-line (s)
9409 In particular, this does handle wide and invisible characters."
9411 ;; It's a hline, just map the characters
9412 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9414 (setq s (replace-match
9415 (concat "|" (make-string (org-string-width (match-string 1 s))
9416 ?\ ) "|")
9417 t t s)))
9418 s))
9420 (defun org-table-kill-row ()
9421 "Delete the current row or horizontal line from the table."
9422 (interactive)
9423 (if (not (org-at-table-p))
9424 (error "Not at a table"))
9425 (let ((col (current-column))
9426 (dline (org-table-current-dline)))
9427 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9428 (if (not (org-at-table-p)) (beginning-of-line 0))
9429 (move-to-column col)
9430 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9431 dline -1 dline)))
9433 (defun org-table-sort-lines (with-case &optional sorting-type)
9434 "Sort table lines according to the column at point.
9436 The position of point indicates the column to be used for
9437 sorting, and the range of lines is the range between the nearest
9438 horizontal separator lines, or the entire table of no such lines
9439 exist. If point is before the first column, you will be prompted
9440 for the sorting column. If there is an active region, the mark
9441 specifies the first line and the sorting column, while point
9442 should be in the last line to be included into the sorting.
9444 The command then prompts for the sorting type which can be
9445 alphabetically, numerically, or by time (as given in a time stamp
9446 in the field). Sorting in reverse order is also possible.
9448 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9450 If SORTING-TYPE is specified when this function is called from a Lisp
9451 program, no prompting will take place. SORTING-TYPE must be a character,
9452 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9453 should be done in reverse order."
9454 (interactive "P")
9455 (let* ((thisline (org-current-line))
9456 (thiscol (org-table-current-column))
9457 beg end bcol ecol tend tbeg column lns pos)
9458 (when (equal thiscol 0)
9459 (if (interactive-p)
9460 (setq thiscol
9461 (string-to-number
9462 (read-string "Use column N for sorting: ")))
9463 (setq thiscol 1))
9464 (org-table-goto-column thiscol))
9465 (org-table-check-inside-data-field)
9466 (if (org-region-active-p)
9467 (progn
9468 (setq beg (region-beginning) end (region-end))
9469 (goto-char beg)
9470 (setq column (org-table-current-column)
9471 beg (point-at-bol))
9472 (goto-char end)
9473 (setq end (point-at-bol 2)))
9474 (setq column (org-table-current-column)
9475 pos (point)
9476 tbeg (org-table-begin)
9477 tend (org-table-end))
9478 (if (re-search-backward org-table-hline-regexp tbeg t)
9479 (setq beg (point-at-bol 2))
9480 (goto-char tbeg)
9481 (setq beg (point-at-bol 1)))
9482 (goto-char pos)
9483 (if (re-search-forward org-table-hline-regexp tend t)
9484 (setq end (point-at-bol 1))
9485 (goto-char tend)
9486 (setq end (point-at-bol))))
9487 (setq beg (move-marker (make-marker) beg)
9488 end (move-marker (make-marker) end))
9489 (untabify beg end)
9490 (goto-char beg)
9491 (org-table-goto-column column)
9492 (skip-chars-backward "^|")
9493 (setq bcol (current-column))
9494 (org-table-goto-column (1+ column))
9495 (skip-chars-backward "^|")
9496 (setq ecol (1- (current-column)))
9497 (org-table-goto-column column)
9498 (setq lns (mapcar (lambda(x) (cons
9499 (org-sort-remove-invisible
9500 (nth (1- column)
9502 x))
9504 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9505 (delete-region beg end)
9506 (move-marker beg nil)
9507 (move-marker end nil)
9509 (goto-line thisline)
9510 (org-table-goto-column thiscol)
9511 (message "%d lines sorted, based on column %d" (length lns) column)))
9513 ;; FIXME: maybe we will not need this? Table sorting is broken....
9514 (defun org-sort-remove-invisible (s)
9515 (remove-text-properties 0 (length s) org-rm-props s)
9516 (while (string-match org-bracket-link-regexp s)
9517 (setq s (replace-match (if (match-end 2)
9518 (match-string 3 s)
9519 (match-string 1 s)) t t s)))
9520 s)
9522 (defun org-table-cut-region (beg end)
9523 "Copy region in table to the clipboard and blank all relevant fields."
9524 (interactive "r")
9525 (org-table-copy-region beg end 'cut))
9527 (defun org-table-copy-region (beg end &optional cut)
9528 "Copy rectangular region in table to clipboard.
9529 A special clipboard is used which can only be accessed
9530 with `org-table-paste-rectangle'."
9531 (interactive "rP")
9532 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9533 region cols
9534 (rpl (if cut " " nil)))
9535 (goto-char beg)
9536 (org-table-check-inside-data-field)
9537 (setq l01 (org-current-line)
9538 c01 (org-table-current-column))
9539 (goto-char end)
9540 (org-table-check-inside-data-field)
9541 (setq l02 (org-current-line)
9542 c02 (org-table-current-column))
9543 (setq l1 (min l01 l02) l2 (max l01 l02)
9544 c1 (min c01 c02) c2 (max c01 c02))
9545 (catch 'exit
9546 (while t
9547 (catch 'nextline
9548 (if (> l1 l2) (throw 'exit t))
9549 (goto-line l1)
9550 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9551 (setq cols nil ic1 c1 ic2 c2)
9552 (while (< ic1 (1+ ic2))
9553 (push (org-table-get-field ic1 rpl) cols)
9554 (setq ic1 (1+ ic1)))
9555 (push (nreverse cols) region)
9556 (setq l1 (1+ l1)))))
9557 (setq org-table-clip (nreverse region))
9558 (if cut (org-table-align))
9559 org-table-clip))
9561 (defun org-table-paste-rectangle ()
9562 "Paste a rectangular region into a table.
9563 The upper right corner ends up in the current field. All involved fields
9564 will be overwritten. If the rectangle does not fit into the present table,
9565 the table is enlarged as needed. The process ignores horizontal separator
9566 lines."
9567 (interactive)
9568 (unless (and org-table-clip (listp org-table-clip))
9569 (error "First cut/copy a region to paste!"))
9570 (org-table-check-inside-data-field)
9571 (let* ((clip org-table-clip)
9572 (line (org-current-line))
9573 (col (org-table-current-column))
9574 (org-enable-table-editor t)
9575 (org-table-automatic-realign nil)
9576 c cols field)
9577 (while (setq cols (pop clip))
9578 (while (org-at-table-hline-p) (beginning-of-line 2))
9579 (if (not (org-at-table-p))
9580 (progn (end-of-line 0) (org-table-next-field)))
9581 (setq c col)
9582 (while (setq field (pop cols))
9583 (org-table-goto-column c nil 'force)
9584 (org-table-get-field nil field)
9585 (setq c (1+ c)))
9586 (beginning-of-line 2))
9587 (goto-line line)
9588 (org-table-goto-column col)
9589 (org-table-align)))
9591 (defun org-table-convert ()
9592 "Convert from `org-mode' table to table.el and back.
9593 Obviously, this only works within limits. When an Org-mode table is
9594 converted to table.el, all horizontal separator lines get lost, because
9595 table.el uses these as cell boundaries and has no notion of horizontal lines.
9596 A table.el table can be converted to an Org-mode table only if it does not
9597 do row or column spanning. Multiline cells will become multiple cells.
9598 Beware, Org-mode does not test if the table can be successfully converted - it
9599 blindly applies a recipe that works for simple tables."
9600 (interactive)
9601 (require 'table)
9602 (if (org-at-table.el-p)
9603 ;; convert to Org-mode table
9604 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9605 (end (move-marker (make-marker) (org-table-end t))))
9606 (table-unrecognize-region beg end)
9607 (goto-char beg)
9609 (replace-match ""))
9610 (goto-char beg))
9611 (if (org-at-table-p)
9612 ;; convert to table.el table
9613 (let ((beg (move-marker (make-marker) (org-table-begin)))
9614 (end (move-marker (make-marker) (org-table-end))))
9615 ;; first, get rid of all horizontal lines
9616 (goto-char beg)
9618 (replace-match ""))
9619 ;; insert a hline before first
9620 (goto-char beg)
9621 (org-table-insert-hline 'above)
9622 (beginning-of-line -1)
9623 ;; insert a hline after each line
9624 (while (progn (beginning-of-line 3) (< (point) end))
9625 (org-table-insert-hline))
9626 (goto-char beg)
9627 (setq end (move-marker end (org-table-end)))
9628 ;; replace "+" at beginning and ending of hlines
9631 (goto-char beg)
9633 (replace-match "-+"))
9634 (goto-char beg)))))
9636 (defun org-table-wrap-region (arg)
9637 "Wrap several fields in a column like a paragraph.
9638 This is useful if you'd like to spread the contents of a field over several
9639 lines, in order to keep the table compact.
9641 If there is an active region, and both point and mark are in the same column,
9642 the text in the column is wrapped to minimum width for the given number of
9643 lines. Generally, this makes the table more compact. A prefix ARG may be
9645 formats the selected text to two lines. If the region was longer than two
9646 lines, the remaining lines remain empty. A negative prefix argument reduces
9647 the current number of lines by that amount. The wrapped text is pasted back
9648 into the table. If you formatted it to more lines than it was before, fields
9649 further down in the table get overwritten - so you might need to make space in
9650 the table first.
9652 If there is no region, the current field is split at the cursor position and
9653 the text fragment to the right of the cursor is prepended to the field one
9654 line down.
9656 If there is no region, but you specify a prefix ARG, the current field gets
9657 blank, and the content is appended to the field above."
9658 (interactive "P")
9659 (org-table-check-inside-data-field)
9660 (if (org-region-active-p)
9661 ;; There is a region: fill as a paragraph
9662 (let* ((beg (region-beginning))
9663 (cline (save-excursion (goto-char beg) (org-current-line)))
9664 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9665 nlines)
9666 (org-table-cut-region (region-beginning) (region-end))
9667 (if (> (length (car org-table-clip)) 1)
9668 (error "Region must be limited to single column"))
9669 (setq nlines (if arg
9670 (if (< arg 1)
9671 (+ (length org-table-clip) arg)
9672 arg)
9673 (length org-table-clip)))
9674 (setq org-table-clip
9675 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9676 nil nlines)))
9677 (goto-line cline)
9678 (org-table-goto-column ccol)
9679 (org-table-paste-rectangle))
9680 ;; No region, split the current field at point
9681 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9683 (if arg
9684 ;; combine with field above
9685 (let ((s (org-table-blank-field))
9686 (col (org-table-current-column)))
9687 (beginning-of-line 0)
9688 (while (org-at-table-hline-p) (beginning-of-line 0))
9689 (org-table-goto-column col)
9690 (skip-chars-forward "^|")
9691 (skip-chars-backward " ")
9692 (insert " " (org-trim s))
9693 (org-table-align))
9694 ;; split field
9696 (let ((s (match-string 1)))
9697 (replace-match " |")
9698 (goto-char (match-beginning 0))
9699 (org-table-next-row)
9700 (insert (org-trim s) " ")
9701 (org-table-align))
9702 (org-table-next-row)))))
9704 (defvar org-field-marker nil)
9706 (defun org-table-edit-field (arg)
9707 "Edit table field in a different window.
9708 This is mainly useful for fields that contain hidden parts.
9710 it can be edited in place."
9711 (interactive "P")
9712 (if arg
9713 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9715 (remove-text-properties b e '(org-cwidth t invisible t
9716 display t intangible t))
9717 (if (and (boundp 'font-lock-mode) font-lock-mode)
9718 (font-lock-fontify-block)))
9719 (let ((pos (move-marker (make-marker) (point)))
9720 (field (org-table-get-field))
9721 (cw (current-window-configuration))
9722 p)
9723 (org-switch-to-buffer-other-window "*Org tmp*")
9724 (erase-buffer)
9726 (let ((org-inhibit-startup t)) (org-mode))
9727 (goto-char (setq p (point-max)))
9728 (insert (org-trim field))
9729 (remove-text-properties p (point-max)
9730 '(invisible t org-cwidth t display t
9731 intangible t))
9732 (goto-char p)
9733 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9734 (org-set-local 'org-window-configuration cw)
9735 (org-set-local 'org-field-marker pos)
9736 (message "Edit and finish with C-c C-c"))))
9738 (defun org-table-finish-edit-field ()
9739 "Finish editing a table data field.
9740 Remove all newline characters, insert the result into the table, realign
9741 the table and kill the editing buffer."
9742 (let ((pos org-field-marker)
9743 (cw org-window-configuration)
9744 (cb (current-buffer))
9745 text)
9746 (goto-char (point-min))
9749 (replace-match " "))
9750 (setq text (org-trim (buffer-string)))
9751 (set-window-configuration cw)
9752 (kill-buffer cb)
9753 (select-window (get-buffer-window (marker-buffer pos)))
9754 (goto-char pos)
9755 (move-marker pos nil)
9756 (org-table-check-inside-data-field)
9757 (org-table-get-field nil text)
9758 (org-table-align)
9759 (message "New field value inserted")))
9761 (defun org-trim (s)
9762 "Remove whitespace at beginning and end of string."
9765 s)
9767 (defun org-wrap (string &optional width lines)
9768 "Wrap string to either a number of lines, or a width in characters.
9769 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9770 that costs. If there is a word longer than WIDTH, the text is actually
9771 wrapped to the length of that word.
9772 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9773 many lines, whatever width that takes.
9774 The return value is a list of lines, without newlines at the end."
9776 (maxword (apply 'max (mapcar 'org-string-width words)))
9777 w ll)
9778 (cond (width
9779 (org-do-wrap words (max maxword width)))
9780 (lines
9781 (setq w maxword)
9782 (setq ll (org-do-wrap words maxword))
9783 (if (<= (length ll) lines)
9784 ll
9785 (setq ll words)
9786 (while (> (length ll) lines)
9787 (setq w (1+ w))
9788 (setq ll (org-do-wrap words w)))
9789 ll))
9790 (t (error "Cannot wrap this")))))
9793 (defun org-do-wrap (words width)
9794 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9795 (let (lines line)
9796 (while words
9797 (setq line (pop words))
9798 (while (and words (< (+ (length line) (length (car words))) width))
9799 (setq line (concat line " " (pop words))))
9800 (setq lines (push line lines)))
9801 (nreverse lines)))
9803 (defun org-split-string (string &optional separators)
9804 "Splits STRING into substrings at SEPARATORS.
9805 No empty strings are returned if there are matches at the beginning
9806 and end of string."
9808 (start 0)
9809 notfirst
9810 (list nil))
9811 (while (and (string-match rexp string
9812 (if (and notfirst
9813 (= start (match-beginning 0))
9814 (< start (length string)))
9815 (1+ start) start))
9816 (< (match-beginning 0) (length string)))
9817 (setq notfirst t)
9818 (or (eq (match-beginning 0) 0)
9819 (and (eq (match-beginning 0) (match-end 0))
9820 (eq (match-beginning 0) start))
9821 (setq list
9822 (cons (substring string start (match-beginning 0))
9823 list)))
9824 (setq start (match-end 0)))
9825 (or (eq start (length string))
9826 (setq list
9827 (cons (substring string start)
9828 list)))
9829 (nreverse list)))
9831 (defun org-table-map-tables (function)
9832 "Apply FUNCTION to the start of all tables in the buffer."
9833 (save-excursion
9834 (save-restriction
9835 (widen)
9836 (goto-char (point-min))
9837 (while (re-search-forward org-table-any-line-regexp nil t)
9838 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9839 (beginning-of-line 1)
9840 (if (looking-at org-table-line-regexp)
9841 (save-excursion (funcall function)))
9842 (re-search-forward org-table-any-border-regexp nil 1))))
9843 (message "Mapping tables: done"))
9845 (defvar org-timecnt) ; dynamically scoped parameter
9847 (defun org-table-sum (&optional beg end nlast)
9848 "Sum numbers in region of current table column.
9849 The result will be displayed in the echo area, and will be available
9852 If there is an active region, it is interpreted as a rectangle and all
9853 numbers in that rectangle will be summed. If there is no active
9854 region and point is located in a table column, sum all numbers in that
9855 column.
9857 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9858 numbers are assumed to be times as well (in decimal hours) and the
9859 numbers are added as such.
9861 If NLAST is a number, only the NLAST fields will actually be summed."
9862 (interactive)
9863 (save-excursion
9864 (let (col (org-timecnt 0) diff h m s org-table-clip)
9865 (cond
9866 ((and beg end)) ; beg and end given explicitly
9867 ((org-region-active-p)
9868 (setq beg (region-beginning) end (region-end)))
9869 (t
9870 (setq col (org-table-current-column))
9871 (goto-char (org-table-begin))
9873 (error "No table data"))
9874 (org-table-goto-column col)
9875 (setq beg (point))
9876 (goto-char (org-table-end))
9878 (error "No table data"))
9879 (org-table-goto-column col)
9880 (setq end (point))))
9881 (let* ((items (apply 'append (org-table-copy-region beg end)))
9882 (items1 (cond ((not nlast) items)
9883 ((>= nlast (length items)) items)
9884 (t (setq items (reverse items))
9885 (setcdr (nthcdr (1- nlast) items) nil)
9886 (nreverse items))))
9887 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9888 items1)))
9889 (res (apply '+ numbers))
9890 (sres (if (= org-timecnt 0)
9891 (format "%g" res)
9892 (setq diff (* 3600 res)
9893 h (floor (/ diff 3600)) diff (mod diff 3600)
9894 m (floor (/ diff 60)) diff (mod diff 60)
9895 s diff)
9896 (format "%d:%02d:%02d" h m s))))
9897 (kill-new sres)
9898 (if (interactive-p)
9899 (message "%s"
9900 (substitute-command-keys
9902 (length numbers) sres))))
9903 sres))))
9905 (defun org-table-get-number-for-summing (s)
9906 (let (n)
9907 (if (string-match "^ *|? *" s)
9908 (setq s (replace-match "" nil nil s)))
9909 (if (string-match " *|? *$" s)
9910 (setq s (replace-match "" nil nil s)))
9911 (setq n (string-to-number s))
9912 (cond
9913 ((and (string-match "0" s)
9917 (let ((h (string-to-number (or (match-string 1 s) "0")))
9918 (m (string-to-number (or (match-string 2 s) "0")))
9919 (s (string-to-number (or (match-string 4 s) "0"))))
9920 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9921 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9922 ((equal n 0) nil)
9923 (t n))))
9925 (defun org-table-current-field-formula (&optional key noerror)
9926 "Return the formula active for the current field.
9927 Assumes that specials are in place.
9928 If KEY is given, return the key to this formula.
9930 (let* ((name (car (rassoc (list (org-current-line)
9931 (org-table-current-column))
9932 org-table-named-field-locations)))
9933 (col (org-table-current-column))
9934 (scol (int-to-string col))
9935 (ref (format "@%d$%d" (org-table-current-dline) col))
9936 (stored-list (org-table-get-stored-formulas noerror))
9937 (ass (or (assoc name stored-list)
9938 (assoc ref stored-list)
9939 (assoc scol stored-list))))
9940 (if key
9941 (car ass)
9942 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9943 (cdr ass))))))
9945 (defun org-table-get-formula (&optional equation named)
9946 "Read a formula from the minibuffer, offer stored formula as default.
9947 When NAMED is non-nil, look for a named equation."
9948 (let* ((stored-list (org-table-get-stored-formulas))
9949 (name (car (rassoc (list (org-current-line)
9950 (org-table-current-column))
9951 org-table-named-field-locations)))
9952 (ref (format "@%d$%d" (org-table-current-dline)
9953 (org-table-current-column)))
9954 (refass (assoc ref stored-list))
9955 (scol (if named
9956 (if name name ref)
9957 (int-to-string (org-table-current-column))))
9958 (dummy (and (or name refass) (not named)
9959 (not (y-or-n-p "Replace field formula with column formula? " ))
9960 (error "Abort")))
9961 (name (or name ref))
9962 (org-table-may-need-update nil)
9963 (stored (cdr (assoc scol stored-list)))
9964 (eq (cond
9965 ((and stored equation (string-match "^ *=? *$" equation))
9966 stored)
9967 ((stringp equation)
9968 equation)
9969 (t (org-table-formula-from-user
9970 (read-string
9971 (org-table-formula-to-user
9972 (format "%s formula %s%s="
9973 (if named "Field" "Column")
9974 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9975 scol))
9976 (if stored (org-table-formula-to-user stored) "")
9977 'org-table-formula-history
9978 )))))
9979 mustsave)
9981 ;; remove formula
9982 (setq stored-list (delq (assoc scol stored-list) stored-list))
9983 (org-table-store-formulas stored-list)
9984 (error "Formula removed"))
9985 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9986 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9987 (if (and name (not named))
9988 ;; We set the column equation, delete the named one.
9989 (setq stored-list (delq (assoc name stored-list) stored-list)
9990 mustsave t))
9991 (if stored
9992 (setcdr (assoc scol stored-list) eq)
9993 (setq stored-list (cons (cons scol eq) stored-list)))
9994 (if (or mustsave (not (equal stored eq)))
9995 (org-table-store-formulas stored-list))
9996 eq))
9998 (defun org-table-store-formulas (alist)
9999 "Store the list of formulas below the current table."
10000 (setq alist (sort alist 'org-table-formula-less-p))
10001 (save-excursion
10002 (goto-char (org-table-end))
10004 (progn
10005 ;; don't overwrite TBLFM, we might use text properties to store stuff
10006 (goto-char (match-beginning 2))
10007 (delete-region (match-beginning 2) (match-end 0)))
10008 (insert "#+TBLFM:"))
10009 (insert " "
10010 (mapconcat (lambda (x)
10011 (concat
10012 (if (equal (string-to-char (car x)) ?@) "" "$")
10013 (car x) "=" (cdr x)))
10014 alist "::")
10017 (defsubst org-table-formula-make-cmp-string (a)
10019 (concat
10020 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
10021 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
10022 (if (match-end 5) (concat "@@" (match-string 5 a))))))
10024 (defun org-table-formula-less-p (a b)
10025 "Compare two formulas for sorting."
10026 (let ((as (org-table-formula-make-cmp-string (car a)))
10027 (bs (org-table-formula-make-cmp-string (car b))))
10028 (and as bs (string< as bs))))
10030 (defun org-table-get-stored-formulas (&optional noerror)
10031 "Return an alist with the stored formulas directly after current table."
10032 (interactive)
10033 (let (scol eq eq-alist strings string seen)
10034 (save-excursion
10035 (goto-char (org-table-end))
10037 (setq strings (org-split-string (match-string 2) " *:: *"))
10038 (while (setq string (pop strings))
10039 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
10040 (setq scol (if (match-end 2)
10041 (match-string 2 string)
10042 (match-string 1 string))
10043 eq (match-string 3 string)
10044 eq-alist (cons (cons scol eq) eq-alist))
10045 (if (member scol seen)
10046 (if noerror
10047 (progn
10048 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
10049 (ding)
10050 (sit-for 2))
10051 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
10052 (push scol seen))))))
10053 (nreverse eq-alist)))
10055 (defun org-table-fix-formulas (key replace &optional limit delta remove)
10056 "Modify the equations after the table structure has been edited.
10058 For all numbers larger than LIMIT, shift them by DELTA."
10059 (save-excursion
10060 (goto-char (org-table-end))
10063 (re2
10064 (when remove
10065 (if (equal key "$")
10068 s n a)
10069 (when remove
10070 (while (re-search-forward re2 (point-at-eol) t)
10071 (replace-match "")))
10072 (while (re-search-forward re (point-at-eol) t)
10073 (setq s (match-string 1) n (string-to-number s))
10074 (cond
10075 ((setq a (assoc s replace))
10076 (replace-match (concat key (cdr a)) t t))
10077 ((and limit (> n limit))
10078 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
10080 (defun org-table-get-specials ()
10081 "Get the column names and local parameters for this table."
10082 (save-excursion
10083 (let ((beg (org-table-begin)) (end (org-table-end))
10084 names name fields fields1 field cnt
10085 c v l line col types dlines hlines)
10086 (setq org-table-column-names nil
10087 org-table-local-parameters nil
10088 org-table-named-field-locations nil
10089 org-table-current-begin-line nil
10090 org-table-current-begin-pos nil
10091 org-table-current-line-types nil)
10092 (goto-char beg)
10094 (setq names (org-split-string (match-string 1) " *| *")
10095 cnt 1)
10096 (while (setq name (pop names))
10097 (setq cnt (1+ cnt))
10098 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
10099 (push (cons name (int-to-string cnt)) org-table-column-names))))
10100 (setq org-table-column-names (nreverse org-table-column-names))
10101 (setq org-table-column-name-regexp
10103 (goto-char beg)
10105 (setq fields (org-split-string (match-string 1) " *| *"))
10106 (while (setq field (pop fields))
10108 (push (cons (match-string 1 field) (match-string 2 field))
10109 org-table-local-parameters))))
10110 (goto-char beg)
10112 (setq c (match-string 1)
10113 fields (org-split-string (match-string 2) " *| *"))
10114 (save-excursion
10115 (beginning-of-line (if (equal c "_") 2 0))
10116 (setq line (org-current-line) col 1)
10118 (setq fields1 (org-split-string (match-string 1) " *| *"))))
10119 (while (and fields1 (setq field (pop fields)))
10120 (setq v (pop fields1) col (1+ col))
10121 (when (and (stringp field) (stringp v)
10122 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
10123 (push (cons field v) org-table-local-parameters)
10124 (push (list field line col) org-table-named-field-locations))))
10125 ;; Analyse the line types
10126 (goto-char beg)
10127 (setq org-table-current-begin-line (org-current-line)
10128 org-table-current-begin-pos (point)
10129 l org-table-current-begin-line)
10131 (push (if (match-end 1) 'hline 'dline) types)
10132 (if (match-end 1) (push l hlines) (push l dlines))
10133 (beginning-of-line 2)
10134 (setq l (1+ l)))
10135 (setq org-table-current-line-types (apply 'vector (nreverse types))
10136 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
10137 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
10139 (defun org-table-maybe-eval-formula ()
10141 If yes, store the formula and apply it."
10142 ;; We already know we are in a table. Get field will only return a formula
10143 ;; when appropriate. It might return a separator line, but no problem.
10144 (when org-table-formula-evaluate-inline
10145 (let* ((field (org-trim (or (org-table-get-field) "")))
10146 named eq)
10148 (setq named (equal (string-to-char field) ?:)
10149 eq (match-string 1 field))
10150 (if (or (fboundp 'calc-eval)
10151 (equal (substring eq 0 (min 2 (length eq))) "'("))
10152 (org-table-eval-formula (if named '(4) nil)
10153 (org-table-formula-from-user eq))
10154 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
10156 (defvar org-recalc-commands nil
10157 "List of commands triggering the recalculation of a line.
10158 Will be filled automatically during use.")
10160 (defvar org-recalc-marks
10161 '((" " . "Unmarked: no special line, no automatic recalculation")
10162 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10163 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10164 ("!" . "Column name definition line. Reference in formula as $name.")
10165 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10166 ("_" . "Names for values in row below this one.")
10167 ("^" . "Names for values in row above this one.")))
10169 (defun org-table-rotate-recalc-marks (&optional newchar)
10170 "Rotate the recalculation mark in the first column.
10171 If in any row, the first field is not consistent with a mark,
10172 insert a new column for the markers.
10173 When there is an active region, change all the lines in the region,
10174 after prompting for the marking character.
10175 After each change, a message will be displayed indicating the meaning
10176 of the new mark."
10177 (interactive)
10178 (unless (org-at-table-p) (error "Not at a table"))
10179 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10180 (beg (org-table-begin))
10181 (end (org-table-end))
10182 (l (org-current-line))
10183 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10184 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10185 (have-col
10186 (save-excursion
10187 (goto-char beg)
10189 (col (org-table-current-column))
10190 (forcenew (car (assoc newchar org-recalc-marks)))
10191 epos new)
10192 (when l1
10193 (message "Change region to what mark? Type # * ! $ or SPC: ")
10194 (setq newchar (char-to-string (read-char-exclusive))
10195 forcenew (car (assoc newchar org-recalc-marks))))
10196 (if (and newchar (not forcenew))
10197 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10198 newchar))
10199 (if l1 (goto-line l1))
10200 (save-excursion
10201 (beginning-of-line 1)
10202 (unless (looking-at org-table-dataline-regexp)
10203 (error "Not at a table data line")))
10204 (unless have-col
10205 (org-table-goto-column 1)
10206 (org-table-insert-column)
10207 (org-table-goto-column (1+ col)))
10208 (setq epos (point-at-eol))
10209 (save-excursion
10210 (beginning-of-line 1)
10211 (org-table-get-field
10213 (concat " "
10214 (setq new (or forcenew
10215 (cadr (member (match-string 1) marks))))
10216 " ")
10217 " # ")))
10218 (if (and l1 l2)
10219 (progn
10220 (goto-line l1)
10221 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10222 (and (looking-at org-table-dataline-regexp)
10223 (org-table-get-field 1 (concat " " new " "))))
10224 (goto-line l1)))
10225 (if (not (= epos (point-at-eol))) (org-table-align))
10226 (goto-line l)
10227 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10229 (defun org-table-maybe-recalculate-line ()
10230 "Recompute the current line if marked for it, and if we haven't just done it."
10231 (interactive)
10232 (and org-table-allow-automatic-line-recalculation
10233 (not (and (memq last-command org-recalc-commands)
10234 (equal org-last-recalc-line (org-current-line))))
10235 (save-excursion (beginning-of-line 1)
10236 (looking-at org-table-auto-recalculate-regexp))
10237 (org-table-recalculate) t))
10239 (defvar org-table-formula-debug nil
10240 "Non-nil means, debug table formulas.
10242 (make-variable-buffer-local 'org-table-formula-debug)
10244 (defvar modes)
10245 (defsubst org-set-calc-mode (var &optional value)
10246 (if (stringp var)
10247 (setq var (assoc var '(("D" calc-angle-mode deg)
10248 ("R" calc-angle-mode rad)
10249 ("F" calc-prefer-frac t)
10250 ("S" calc-symbolic-mode t)))
10251 value (nth 2 var) var (nth 1 var)))
10252 (if (memq var modes)
10253 (setcar (cdr (memq var modes)) value)
10254 (cons var (cons value modes)))
10255 modes)
10257 (defun org-table-eval-formula (&optional arg equation
10258 suppress-align suppress-const
10259 suppress-store suppress-analysis)
10260 "Replace the table field value at the cursor by the result of a calculation.
10262 This function makes use of Dave Gillespie's Calc package, in my view the
10263 most exciting program ever written for GNU Emacs. So you need to have Calc
10264 installed in order to use this function.
10266 In a table, this command replaces the value in the current field with the
10268 formula, by storing it in a special line below the table. When called
10269 with a `C-u' prefix, the current field must ba a named field, and the
10270 formula is installed as valid in only this specific field.
10272 When called with two `C-u' prefixes, insert the active equation
10273 for the field back into the current field, so that it can be
10275 to check the referenced fields.
10277 When called, the command first prompts for a formula, which is read in
10278 the minibuffer. Previously entered formulas are available through the
10279 history list, and the last used formula is offered as a default.
10280 These stored formulas are adapted correctly when moving, inserting, or
10281 deleting columns with the corresponding commands.
10283 The formula can be any algebraic expression understood by the Calc package.
10284 For details, see the Org-mode manual.
10286 This function can also be called from Lisp programs and offers
10287 additional arguments: EQUATION can be the formula to apply. If this
10288 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10289 used to speed-up recursive calls by by-passing unnecessary aligns.
10290 SUPPRESS-CONST suppresses the interpretation of constants in the
10291 formula, assuming that this has been done already outside the function.
10292 SUPPRESS-STORE means the formula should not be stored, either because
10293 it is already stored, or because it is a modified equation that should
10294 not overwrite the stored one."
10295 (interactive "P")
10296 (org-table-check-inside-data-field)
10297 (or suppress-analysis (org-table-get-specials))
10298 (if (equal arg '(16))
10299 (let ((eq (org-table-current-field-formula)))
10300 (or eq (error "No equation active for current field"))
10301 (org-table-get-field nil eq)
10302 (org-table-align)
10303 (setq org-table-may-need-update t))
10304 (let* (fields
10305 (ndown (if (integerp arg) arg 1))
10306 (org-table-automatic-realign nil)
10307 (case-fold-search nil)
10308 (down (> ndown 1))
10309 (formula (if (and equation suppress-store)
10310 equation
10311 (org-table-get-formula equation (equal arg '(4)))))
10312 (n0 (org-table-current-column))
10313 (modes (copy-sequence org-calc-default-modes))
10314 (numbers nil) ; was a variable, now fixed default
10315 (keep-empty nil)
10316 n form form0 bw fmt x ev orig c lispp literal)
10317 ;; Parse the format string. Since we have a lot of modes, this is
10318 ;; a lot of work. However, I think calc still uses most of the time.
10319 (if (string-match ";" formula)
10320 (let ((tmp (org-split-string formula ";")))
10321 (setq formula (car tmp)
10322 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10323 (nth 1 tmp)))
10325 (setq c (string-to-char (match-string 1 fmt))
10326 n (string-to-number (match-string 2 fmt)))
10327 (if (= c ?p)
10328 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10329 (setq modes (org-set-calc-mode
10330 'calc-float-format
10331 (list (cdr (assoc c '((?n . float) (?f . fix)
10332 (?s . sci) (?e . eng))))
10333 n))))
10334 (setq fmt (replace-match "" t t fmt)))
10335 (if (string-match "[NT]" fmt)
10336 (setq numbers (equal (match-string 0 fmt) "N")
10337 fmt (replace-match "" t t fmt)))
10338 (if (string-match "L" fmt)
10339 (setq literal t
10340 fmt (replace-match "" t t fmt)))
10341 (if (string-match "E" fmt)
10342 (setq keep-empty t
10343 fmt (replace-match "" t t fmt)))
10344 (while (string-match "[DRFS]" fmt)
10345 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10346 (setq fmt (replace-match "" t t fmt)))
10348 (setq fmt nil))))
10349 (if (and (not suppress-const) org-table-formula-use-constants)
10350 (setq formula (org-table-formula-substitute-names formula)))
10351 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10352 (while (> ndown 0)
10353 (setq fields (org-split-string
10354 (org-no-properties
10355 (buffer-substring (point-at-bol) (point-at-eol)))
10356 " *| *"))
10357 (if (eq numbers t)
10358 (setq fields (mapcar
10359 (lambda (x) (number-to-string (string-to-number x)))
10360 fields)))
10361 (setq ndown (1- ndown))
10362 (setq form (copy-sequence formula)
10363 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10364 (if (and lispp literal) (setq lispp 'literal))
10365 ;; Check for old vertical references
10366 (setq form (org-rewrite-old-row-references form))
10367 ;; Insert complex ranges
10368 (while (string-match org-table-range-regexp form)
10369 (setq form
10370 (replace-match
10371 (save-match-data
10372 (org-table-make-reference
10373 (org-table-get-range (match-string 0 form) nil n0)
10374 keep-empty numbers lispp))
10375 t t form)))
10376 ;; Insert simple ranges
10378 (setq form
10379 (replace-match
10380 (save-match-data
10381 (org-table-make-reference
10382 (org-sublist
10383 fields (string-to-number (match-string 1 form))
10384 (string-to-number (match-string 2 form)))
10385 keep-empty numbers lispp))
10386 t t form)))
10387 (setq form0 form)
10388 ;; Insert the references to fields in same row
10390 (setq n (string-to-number (match-string 1 form))
10391 x (nth (1- (if (= n 0) n0 n)) fields))
10393 (match-string 0 form)))
10394 (setq form (replace-match
10395 (save-match-data
10396 (org-table-make-reference x nil numbers lispp))
10397 t t form)))
10399 (if lispp
10400 (setq ev (condition-case nil
10401 (eval (eval (read form)))
10402 (error "#ERROR"))
10403 ev (if (numberp ev) (number-to-string ev) ev))
10404 (or (fboundp 'calc-eval)
10405 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10406 (setq ev (calc-eval (cons form modes)
10407 (if numbers 'num))))
10409 (when org-table-formula-debug
10410 (with-output-to-temp-buffer "*Substitution History*"
10411 (princ (format "Substitution history of formula
10412 Orig: %s
10413 $xyz-> %s
10414 @r$c-> %s
10416 (if (listp ev)
10418 (make-string (car ev) ?\-) (nth 1 ev)))
10420 ev (or fmt "NONE")
10421 (if fmt (format fmt (string-to-number ev)) ev)))))
10422 (setq bw (get-buffer-window "*Substitution History*"))
10423 (shrink-window-if-larger-than-buffer bw)
10424 (unless (and (interactive-p) (not ndown))
10425 (unless (let (inhibit-redisplay)
10426 (y-or-n-p "Debugging Formula. Continue to next? "))
10427 (org-table-align)
10428 (error "Abort"))
10429 (delete-window bw)
10430 (message "")))
10431 (if (listp ev) (setq fmt nil ev "#ERROR"))
10432 (org-table-justify-field-maybe
10433 (if fmt (format fmt (string-to-number ev)) ev))
10435 (call-interactively 'org-return)
10436 (setq ndown 0)))
10437 (and down (org-table-maybe-recalculate-line))
10438 (or suppress-align (and org-table-may-need-update
10439 (org-table-align))))))
10441 (defun org-table-put-field-property (prop value)
10442 (save-excursion
10443 (put-text-property (progn (skip-chars-backward "^|") (point))
10444 (progn (skip-chars-forward "^|") (point))
10445 prop value)))
10447 (defun org-table-get-range (desc &optional tbeg col highlight)
10448 "Get a calc vector from a column, accorting to descriptor DESC.
10449 Optional arguments TBEG and COL can give the beginning of the table and
10450 the current column, to avoid unnecessary parsing.
10451 HIGHLIGHT means, just highlight the range."
10452 (if (not (equal (string-to-char desc) ?@))
10453 (setq desc (concat "@" desc)))
10454 (save-excursion
10455 (or tbeg (setq tbeg (org-table-begin)))
10456 (or col (setq col (org-table-current-column)))
10457 (let ((thisline (org-current-line))
10458 beg end c1 c2 r1 r2 rangep tmp)
10459 (unless (string-match org-table-range-regexp desc)
10460 (error "Invalid table range specifier `%s'" desc))
10461 (setq rangep (match-end 3)
10462 r1 (and (match-end 1) (match-string 1 desc))
10463 r2 (and (match-end 4) (match-string 4 desc))
10464 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10465 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10467 (and c1 (setq c1 (+ (string-to-number c1)
10468 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10469 (and c2 (setq c2 (+ (string-to-number c2)
10470 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10471 (if (equal r1 "") (setq r1 nil))
10472 (if (equal r2 "") (setq r2 nil))
10473 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10474 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10475 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10476 (if (not r1) (setq r1 thisline))
10477 (if (not r2) (setq r2 thisline))
10478 (if (not c1) (setq c1 col))
10479 (if (not c2) (setq c2 col))
10480 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10481 ;; just one field
10482 (progn
10483 (goto-line r1)
10484 (while (not (looking-at org-table-dataline-regexp))
10485 (beginning-of-line 2))
10486 (prog1 (org-trim (org-table-get-field c1))
10487 (if highlight (org-table-highlight-rectangle (point) (point)))))
10488 ;; A range, return a vector
10489 ;; First sort the numbers to get a regular ractangle
10490 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10491 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10492 (goto-line r1)
10493 (while (not (looking-at org-table-dataline-regexp))
10494 (beginning-of-line 2))
10495 (org-table-goto-column c1)
10496 (setq beg (point))
10497 (goto-line r2)
10498 (while (not (looking-at org-table-dataline-regexp))
10499 (beginning-of-line 0))
10500 (org-table-goto-column c2)
10501 (setq end (point))
10502 (if highlight
10503 (org-table-highlight-rectangle
10505 ;; return string representation of calc vector
10506 (mapcar 'org-trim
10507 (apply 'append (org-table-copy-region beg end)))))))
10509 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10510 "Analyze descriptor DESC and retrieve the corresponding line number.
10511 The cursor is currently in line CLINE, the table begins in line BLINE,
10512 and TABLE is a vector with line types."
10513 (if (string-match "^[0-9]+$" desc)
10514 (aref org-table-dlines (string-to-number desc))
10515 (setq cline (or cline (org-current-line))
10516 bline (or bline org-table-current-begin-line)
10517 table (or table org-table-current-line-types))
10518 (if (or
10520 ;; 1 2 3 4 5 6
10521 (and (not (match-end 3)) (not (match-end 6)))
10522 (and (match-end 3) (match-end 6) (not (match-end 5))))
10523 (error "invalid row descriptor `%s'" desc))
10524 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10525 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10526 (odir (and (match-end 5) (match-string 5 desc)))
10527 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10528 (i (- cline bline))
10529 (rel (and (match-end 6)
10530 (or (and (match-end 1) (not (match-end 3)))
10531 (match-end 5)))))
10532 (if (and hn (not hdir))
10533 (progn
10534 (setq i 0 hdir "+")
10535 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10536 (if (and (not hn) on (not odir))
10537 (error "should never happen");;(aref org-table-dlines on)
10538 (if (and hn (> hn 0))
10539 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10540 (if on
10541 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10542 (+ bline i)))))
10544 (defun org-find-row-type (table i type backwards relative n)
10545 (let ((l (length table)))
10546 (while (> n 0)
10547 (while (and (setq i (+ i (if backwards -1 1)))
10548 (>= i 0) (< i l)
10549 (not (eq (aref table i) type))
10550 (if (and relative (eq (aref table i) 'hline))
10551 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10552 t)))
10553 (setq n (1- n)))
10554 (if (or (< i 0) (>= i l))
10555 (error "Row descriptior leads outside table")
10556 i)))
10558 (defun org-rewrite-old-row-references (s)
10559 (if (string-match "&[-+0-9I]" s)
10560 (error "Formula contains old &row reference, please rewrite using @-syntax")
10561 s))
10563 (defun org-table-make-reference (elements keep-empty numbers lispp)
10564 "Convert list ELEMENTS to something appropriate to insert into formula.
10565 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10566 NUMBERS indicates that everything should be converted to numbers.
10567 LISPP means to return something appropriate for a Lisp list."
10568 (if (stringp elements) ; just a single val
10569 (if lispp
10570 (if (eq lispp 'literal)
10571 elements
10572 (prin1-to-string (if numbers (string-to-number elements) elements)))
10573 (if (equal elements "") (setq elements "0"))
10574 (if numbers (number-to-string (string-to-number elements)) elements))
10575 (unless keep-empty
10576 (setq elements
10577 (delq nil
10579 elements))))
10580 (setq elements (or elements '("0")))
10581 (if lispp
10582 (mapconcat
10583 (lambda (x)
10584 (if (eq lispp 'literal)
10585 x
10586 (prin1-to-string (if numbers (string-to-number x) x))))
10587 elements " ")
10588 (concat "[" (mapconcat
10589 (lambda (x)
10590 (if numbers (number-to-string (string-to-number x)) x))
10591 elements
10592 ",") "]"))))
10594 (defun org-table-recalculate (&optional all noalign)
10595 "Recalculate the current table line by applying all stored formulas.
10596 With prefix arg ALL, do this for all lines in the table."
10597 (interactive "P")
10598 (or (memq this-command org-recalc-commands)
10599 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10600 (unless (org-at-table-p) (error "Not at a table"))
10601 (if (equal all '(16))
10602 (org-table-iterate)
10603 (org-table-get-specials)
10604 (let* ((eqlist (sort (org-table-get-stored-formulas)
10605 (lambda (a b) (string< (car a) (car b)))))
10606 (inhibit-redisplay (not debug-on-error))
10607 (line-re org-table-dataline-regexp)
10608 (thisline (org-current-line))
10609 (thiscol (org-table-current-column))
10610 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10611 ;; Insert constants in all formulas
10612 (setq eqlist
10613 (mapcar (lambda (x)
10614 (setcdr x (org-table-formula-substitute-names (cdr x)))
10615 x)
10616 eqlist))
10617 ;; Split the equation list
10618 (while (setq eq (pop eqlist))
10619 (if (<= (string-to-char (car eq)) ?9)
10620 (push eq eqlnum)
10621 (push eq eqlname)))
10622 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10623 (if all
10624 (progn
10625 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10626 (goto-char (setq beg (org-table-begin)))
10627 (if (re-search-forward org-table-calculate-mark-regexp end t)
10628 ;; This is a table with marked lines, compute selected lines
10629 (setq line-re org-table-recalculate-regexp)
10630 ;; Move forward to the first non-header line
10631 (if (and (re-search-forward org-table-dataline-regexp end t)
10632 (re-search-forward org-table-hline-regexp end t)
10633 (re-search-forward org-table-dataline-regexp end t))
10634 (setq beg (match-beginning 0))
10635 nil))) ;; just leave beg where it is
10636 (setq beg (point-at-bol)
10637 end (move-marker (make-marker) (1+ (point-at-eol)))))
10638 (goto-char beg)
10639 (and all (message "Re-applying formulas to full table..."))
10641 ;; First find the named fields, and mark them untouchanble
10642 (remove-text-properties beg end '(org-untouchable t))
10643 (while (setq eq (pop eqlname))
10644 (setq name (car eq)
10645 a (assoc name org-table-named-field-locations))
10646 (and (not a)
10648 (setq a (list name
10649 (aref org-table-dlines
10650 (string-to-number (match-string 1 name)))
10651 (string-to-number (match-string 2 name)))))
10652 (when (and a (or all (equal (nth 1 a) thisline)))
10653 (message "Re-applying formula to field: %s" name)
10654 (goto-line (nth 1 a))
10655 (org-table-goto-column (nth 2 a))
10656 (push (append a (list (cdr eq))) eqlname1)
10657 (org-table-put-field-property :org-untouchable t)))
10659 ;; Now evauluate the column formulas, but skip fields covered by
10660 ;; field formulas
10661 (goto-char beg)
10662 (while (re-search-forward line-re end t)
10663 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10664 ;; Unprotected line, recalculate
10665 (and all (message "Re-applying formulas to full table...(line %d)"
10666 (setq cnt (1+ cnt))))
10667 (setq org-last-recalc-line (org-current-line))
10668 (setq eql eqlnum)
10669 (while (setq entry (pop eql))
10670 (goto-line org-last-recalc-line)
10671 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10672 (unless (get-text-property (point) :org-untouchable)
10673 (org-table-eval-formula nil (cdr entry)
10674 'noalign 'nocst 'nostore 'noanalysis)))))
10676 ;; Now evaluate the field formulas
10677 (while (setq eq (pop eqlname1))
10678 (message "Re-applying formula to field: %s" (car eq))
10679 (goto-line (nth 1 eq))
10680 (org-table-goto-column (nth 2 eq))
10681 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10682 'nostore 'noanalysis))
10684 (goto-line thisline)
10685 (org-table-goto-column thiscol)
10686 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10687 (or noalign (and org-table-may-need-update (org-table-align))
10688 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10690 ;; back to initial position
10691 (message "Re-applying formulas...done")
10692 (goto-line thisline)
10693 (org-table-goto-column thiscol)
10694 (or noalign (and org-table-may-need-update (org-table-align))
10695 (and all (message "Re-applying formulas...done"))))))
10697 (defun org-table-iterate (&optional arg)
10698 "Recalculate the table until it does not change anymore."
10699 (interactive "P")
10700 (let ((imax (if arg (prefix-numeric-value arg) 10))
10701 (i 0)
10702 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10703 thistbl)
10704 (catch 'exit
10705 (while (< i imax)
10706 (setq i (1+ i))
10707 (org-table-recalculate 'all)
10708 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10709 (if (not (string= lasttbl thistbl))
10710 (setq lasttbl thistbl)
10711 (if (> i 1)
10712 (message "Convergence after %d iterations" i)
10713 (message "Table was already stable"))
10714 (throw 'exit t)))
10715 (error "No convergence after %d iterations" i))))
10717 (defun org-table-formula-substitute-names (f)
10718 "Replace $const with values in string F."
10719 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10720 ;; First, check for column names
10721 (while (setq start (string-match org-table-column-name-regexp f start))
10722 (setq start (1+ start))
10723 (setq a (assoc (match-string 1 f) org-table-column-names))
10724 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10725 ;; Parameters and constants
10726 (setq start 0)
10728 (setq start (1+ start))
10729 (if (setq a (save-match-data
10730 (org-table-get-constant (match-string 1 f))))
10731 (setq f (replace-match
10732 (concat (if pp "(") a (if pp ")")) t t f))))
10733 (if org-table-formula-debug
10734 (put-text-property 0 (length f) :orig-formula f1 f))
10735 f))
10737 (defun org-table-get-constant (const)
10738 "Find the value for a parameter or constant in a formula.
10739 Parameters get priority."
10740 (or (cdr (assoc const org-table-local-parameters))
10741 (cdr (assoc const org-table-formula-constants-local))
10742 (cdr (assoc const org-table-formula-constants))
10743 (and (fboundp 'constants-get) (constants-get const))
10744 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10745 (org-entry-get nil (substring const 5) 'inherit))
10746 "#UNDEFINED_NAME"))
10748 (defvar org-table-fedit-map
10749 (let ((map (make-sparse-keymap)))
10750 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10751 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10752 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10753 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10754 (org-defkey map "\C-c?" 'org-table-show-reference)
10755 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10756 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10757 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10758 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10759 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10760 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10761 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10762 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10763 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10764 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10765 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10766 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10767 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10768 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10769 map))
10771 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10772 '("Edit-Formulas"
10773 ["Finish and Install" org-table-fedit-finish t]
10774 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10775 ["Abort" org-table-fedit-abort t]
10776 "--"
10777 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10778 ["Complete Lisp Symbol" lisp-complete-symbol t]
10779 "--"
10780 "Shift Reference at Point"
10781 ["Up" org-table-fedit-ref-up t]
10782 ["Down" org-table-fedit-ref-down t]
10783 ["Left" org-table-fedit-ref-left t]
10784 ["Right" org-table-fedit-ref-right t]
10785 "-"
10786 "Change Test Row for Column Formulas"
10787 ["Up" org-table-fedit-line-up t]
10788 ["Down" org-table-fedit-line-down t]
10789 "--"
10790 ["Scroll Table Window" org-table-fedit-scroll t]
10791 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10792 ["Show Table Grid" org-table-fedit-toggle-coordinates
10793 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10794 org-table-overlay-coordinates)]
10795 "--"
10796 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10797 :style toggle :selected org-table-buffer-is-an]))
10799 (defvar org-pos)
10801 (defun org-table-edit-formulas ()
10802 "Edit the formulas of the current table in a separate buffer."
10803 (interactive)
10805 (beginning-of-line 0))
10806 (unless (org-at-table-p) (error "Not at a table"))
10807 (org-table-get-specials)
10808 (let ((key (org-table-current-field-formula 'key 'noerror))
10809 (eql (sort (org-table-get-stored-formulas 'noerror)
10810 'org-table-formula-less-p))
10811 (pos (move-marker (make-marker) (point)))
10812 (startline 1)
10813 (wc (current-window-configuration))
10817 entry s type title)
10818 (org-switch-to-buffer-other-window "*Edit Formulas*")
10819 (erase-buffer)
10820 ;; Keep global-font-lock-mode from turning on font-lock-mode
10821 (let ((font-lock-global-modes '(not fundamental-mode)))
10822 (fundamental-mode))
10823 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10824 (org-set-local 'org-pos pos)
10825 (org-set-local 'org-window-configuration wc)
10826 (use-local-map org-table-fedit-map)
10827 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10828 (easy-menu-add org-table-fedit-menu)
10829 (setq startline (org-current-line))
10830 (while (setq entry (pop eql))
10831 (setq type (cond
10832 ((equal (string-to-char (car entry)) ?@) 'field)
10833 ((string-match "^[0-9]" (car entry)) 'column)
10834 (t 'named)))
10835 (when (setq title (assq type titles))
10837 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10838 (setq titles (delq title titles)))
10839 (if (equal key (car entry)) (setq startline (org-current-line)))
10840 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10842 (remove-text-properties 0 (length s) '(face nil) s)
10843 (insert s))
10844 (if (eq org-table-use-standard-references t)
10845 (org-table-fedit-toggle-ref-type))
10846 (goto-line startline)
10847 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10849 (defun org-table-fedit-post-command ()
10850 (when (not (memq this-command '(lisp-complete-symbol)))
10851 (let ((win (selected-window)))
10852 (save-excursion
10853 (condition-case nil
10854 (org-table-show-reference)
10855 (error nil))
10856 (select-window win)))))
10858 (defun org-table-formula-to-user (s)
10859 "Convert a formula from internal to user representation."
10860 (if (eq org-table-use-standard-references t)
10861 (org-table-convert-refs-to-an s)
10862 s))
10864 (defun org-table-formula-from-user (s)
10865 "Convert a formula from user to internal representation."
10866 (if org-table-use-standard-references
10867 (org-table-convert-refs-to-rc s)
10868 s))
10870 (defun org-table-convert-refs-to-rc (s)
10871 "Convert spreadsheet references from AB7 to @7$28.
10872 Works for single references, but also for entire formulas and even the
10873 full TBLFM line."
10874 (let ((start 0))
10876 (cond
10877 ((match-end 3)
10878 ;; format match, just advance
10879 (setq start (match-end 0)))
10880 ((and (> (match-beginning 0) 0)
10881 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10882 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10883 ;; 3.e5 or something like this.
10884 (setq start (match-end 0)))
10885 (t
10886 (setq start (match-beginning 0)
10887 s (replace-match
10888 (if (equal (match-string 2 s) "&")
10889 (format "$%d" (org-letters-to-number (match-string 1 s)))
10890 (format "@%d$%d"
10891 (string-to-number (match-string 2 s))
10892 (org-letters-to-number (match-string 1 s))))
10893 t t s)))))
10894 s))
10896 (defun org-table-convert-refs-to-an (s)
10897 "Convert spreadsheet references from to @7$28 to AB7.
10898 Works for single references, but also for entire formulas and even the
10899 full TBLFM line."
10901 (setq s (replace-match
10902 (format "%s%d"
10903 (org-number-to-letters
10904 (string-to-number (match-string 2 s)))
10905 (string-to-number (match-string 1 s)))
10906 t t s)))
10909 (org-number-to-letters
10910 (string-to-number (match-string 2 s))) "&")
10911 t nil s)))
10912 s)
10914 (defun org-letters-to-number (s)
10915 "Convert a base 26 number represented by letters into an integer.
10916 For example: AB -> 28."
10917 (let ((n 0))
10918 (setq s (upcase s))
10919 (while (> (length s) 0)
10920 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10921 s (substring s 1)))
10922 n))
10924 (defun org-number-to-letters (n)
10925 "Convert an integer into a base 26 number represented by letters.
10926 For example: 28 -> AB."
10927 (let ((s ""))
10928 (while (> n 0)
10929 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10930 n (/ (1- n) 26)))
10931 s))
10933 (defun org-table-fedit-convert-buffer (function)
10934 "Convert all references in this buffer, using FUNTION."
10935 (let ((line (org-current-line)))
10936 (goto-char (point-min))
10937 (while (not (eobp))
10938 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10939 (delete-region (point) (point-at-eol))
10940 (or (eobp) (forward-char 1)))
10941 (goto-line line)))
10943 (defun org-table-fedit-toggle-ref-type ()
10944 "Convert all references in the buffer from B3 to @3$2 and back."
10945 (interactive)
10946 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10947 (org-table-fedit-convert-buffer
10948 (if org-table-buffer-is-an
10949 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10950 (message "Reference type switched to %s"
10951 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10953 (defun org-table-fedit-ref-up ()
10954 "Shift the reference at point one row/hline up."
10955 (interactive)
10956 (org-table-fedit-shift-reference 'up))
10957 (defun org-table-fedit-ref-down ()
10958 "Shift the reference at point one row/hline down."
10959 (interactive)
10960 (org-table-fedit-shift-reference 'down))
10961 (defun org-table-fedit-ref-left ()
10962 "Shift the reference at point one field to the left."
10963 (interactive)
10964 (org-table-fedit-shift-reference 'left))
10965 (defun org-table-fedit-ref-right ()
10966 "Shift the reference at point one field to the right."
10967 (interactive)
10968 (org-table-fedit-shift-reference 'right))
10970 (defun org-table-fedit-shift-reference (dir)
10971 (cond
10973 (if (memq dir '(left right))
10974 (org-rematch-and-replace 1 (eq dir 'left))
10975 (error "Cannot shift reference in this direction")))
10977 ;; A B3-like reference
10978 (if (memq dir '(up down))
10979 (org-rematch-and-replace 2 (eq dir 'up))
10980 (org-rematch-and-replace 1 (eq dir 'left))))
10981 ((org-at-regexp-p
10983 ;; An internal reference
10984 (if (memq dir '(up down))
10985 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10986 (org-rematch-and-replace 5 (eq dir 'left))))))
10988 (defun org-rematch-and-replace (n &optional decr hline)
10989 "Re-match the group N, and replace it with the shifted refrence."
10990 (or (match-end n) (error "Cannot shift reference in this direction"))
10991 (goto-char (match-beginning n))
10992 (and (looking-at (regexp-quote (match-string n)))
10993 (replace-match (org-shift-refpart (match-string 0) decr hline)
10994 t t)))
10996 (defun org-shift-refpart (ref &optional decr hline)
10997 "Shift a refrence part REF.
10998 If DECR is set, decrease the references row/column, else increase.
10999 If HLINE is set, this may be a hline reference, it certainly is not
11000 a translation reference."
11001 (save-match-data
11002 (let* ((sign (string-match "^[-+]" ref)) n)
11004 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
11005 (cond
11006 ((and hline (string-match "^I+" ref))
11007 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
11008 (setq n (+ n (if decr -1 1)))
11009 (if (= n 0) (setq n (+ n (if decr -1 1))))
11010 (if sign
11011 (setq sign (if (< n 0) "-" "+") n (abs n))
11012 (setq n (max 1 n)))
11013 (concat sign (make-string n ?I)))
11015 ((string-match "^[0-9]+" ref)
11016 (setq n (string-to-number (concat sign ref)))
11017 (setq n (+ n (if decr -1 1)))
11018 (if sign
11019 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
11020 (number-to-string (max 1 n))))
11022 ((string-match "^[a-zA-Z]+" ref)
11023 (org-number-to-letters
11024 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
11026 (t (error "Cannot shift reference"))))))
11028 (defun org-table-fedit-toggle-coordinates ()
11029 "Toggle the display of coordinates in the refrenced table."
11030 (interactive)
11031 (let ((pos (marker-position org-pos)))
11032 (with-current-buffer (marker-buffer org-pos)
11033 (save-excursion
11034 (goto-char pos)
11035 (org-table-toggle-coordinate-overlays)))))
11037 (defun org-table-fedit-finish (&optional arg)
11038 "Parse the buffer for formula definitions and install them.
11039 With prefix ARG, apply the new formulas to the table."
11040 (interactive "P")
11041 (org-table-remove-rectangle-highlight)
11042 (if org-table-use-standard-references
11043 (progn
11044 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
11045 (setq org-table-buffer-is-an nil)))
11046 (let ((pos org-pos) eql var form)
11047 (goto-char (point-min))
11048 (while (re-search-forward
11050 nil t)
11051 (setq var (if (match-end 2) (match-string 2) (match-string 1))
11052 form (match-string 3))
11053 (setq form (org-trim form))
11054 (when (not (equal form ""))
11056 (setq form (replace-match " " t t form)))
11057 (when (assoc var eql)
11058 (error "Double formulas for %s" var))
11059 (push (cons var form) eql)))
11060 (setq org-pos nil)
11061 (set-window-configuration org-window-configuration)
11062 (select-window (get-buffer-window (marker-buffer pos)))
11063 (goto-char pos)
11064 (unless (org-at-table-p)
11065 (error "Lost table position - cannot install formulae"))
11066 (org-table-store-formulas eql)
11067 (move-marker pos nil)
11068 (kill-buffer "*Edit Formulas*")
11069 (if arg
11070 (org-table-recalculate 'all)
11071 (message "New formulas installed - press C-u C-c C-c to apply."))))
11073 (defun org-table-fedit-abort ()
11074 "Abort editing formulas, without installing the changes."
11075 (interactive)
11076 (org-table-remove-rectangle-highlight)
11077 (let ((pos org-pos))
11078 (set-window-configuration org-window-configuration)
11079 (select-window (get-buffer-window (marker-buffer pos)))
11080 (goto-char pos)
11081 (move-marker pos nil)
11082 (message "Formula editing aborted without installing changes")))
11084 (defun org-table-fedit-lisp-indent ()
11085 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
11086 (interactive)
11087 (let ((pos (point)) beg end ind)
11088 (beginning-of-line 1)
11089 (cond
11091 (goto-char pos)
11092 (call-interactively 'lisp-indent-line))
11094 ((not (fboundp 'pp-buffer))
11095 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
11096 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
11097 (goto-char (- (match-end 0) 2))
11098 (setq beg (point))
11099 (setq ind (make-string (current-column) ?\ ))
11100 (condition-case nil (forward-sexp 1)
11101 (error
11102 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
11103 (setq end (point))
11104 (save-restriction
11105 (narrow-to-region beg end)
11106 (if (eq last-command this-command)
11107 (progn
11108 (goto-char (point-min))
11109 (setq this-command nil)
11111 (replace-match " ")))
11112 (pp-buffer)
11113 (untabify (point-min) (point-max))
11114 (goto-char (1+ (point-min)))
11115 (while (re-search-forward "^." nil t)
11116 (beginning-of-line 1)
11117 (insert ind))
11118 (goto-char (point-max))
11119 (backward-delete-char 1)))
11120 (goto-char beg))
11121 (t nil))))
11123 (defvar org-show-positions nil)
11125 (defun org-table-show-reference (&optional local)
11126 "Show the location/value of the $ expression at point."
11127 (interactive)
11128 (org-table-remove-rectangle-highlight)
11129 (catch 'exit
11130 (let ((pos (if local (point) org-pos))
11131 (face2 'highlight)
11132 (org-inhibit-highlight-removal t)
11133 (win (selected-window))
11134 (org-show-positions nil)
11135 var name e what match dest)
11136 (if local (org-table-get-specials))
11137 (setq what (cond
11138 ((or (org-at-regexp-p org-table-range-regexp2)
11139 (org-at-regexp-p org-table-translate-regexp)
11140 (org-at-regexp-p org-table-range-regexp))
11141 (setq match
11142 (save-match-data
11143 (org-table-convert-refs-to-rc (match-string 0))))
11144 'range)
11147 ((not local) nil)
11148 (t (error "No reference at point")))
11149 match (and what (or match (match-string 0))))
11150 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
11151 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
11152 'secondary-selection))
11153 (org-add-hook 'before-change-functions
11154 'org-table-remove-rectangle-highlight)
11155 (if (eq what 'name) (setq var (substring match 1)))
11156 (when (eq what 'range)
11157 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
11158 (setq match (org-table-formula-substitute-names match)))
11159 (unless local
11160 (save-excursion
11161 (end-of-line 1)
11163 (beginning-of-line 1)
11165 (setq dest
11166 (save-match-data
11167 (org-table-convert-refs-to-rc (match-string 1))))
11168 (org-table-add-rectangle-overlay
11169 (match-beginning 1) (match-end 1) face2))))
11170 (if (and (markerp pos) (marker-buffer pos))
11171 (if (get-buffer-window (marker-buffer pos))
11172 (select-window (get-buffer-window (marker-buffer pos)))
11173 (org-switch-to-buffer-other-window (get-buffer-window
11174 (marker-buffer pos)))))
11175 (goto-char pos)
11176 (org-table-force-dataline)
11177 (when dest
11178 (setq name (substring dest 1))
11179 (cond
11181 (setq e (assoc name org-table-named-field-locations))
11182 (goto-line (nth 1 e))
11183 (org-table-goto-column (nth 2 e)))
11185 (let ((l (string-to-number (match-string 1 dest)))
11186 (c (string-to-number (match-string 2 dest))))
11187 (goto-line (aref org-table-dlines l))
11188 (org-table-goto-column c)))
11189 (t (org-table-goto-column (string-to-number name))))
11190 (move-marker pos (point))
11191 (org-table-highlight-rectangle nil nil face2))
11192 (cond
11193 ((equal dest match))
11194 ((not match))
11195 ((eq what 'range)
11196 (condition-case nil
11197 (save-excursion
11198 (org-table-get-range match nil nil 'highlight))
11199 (error nil)))
11200 ((setq e (assoc var org-table-named-field-locations))
11201 (goto-line (nth 1 e))
11202 (org-table-goto-column (nth 2 e))
11203 (org-table-highlight-rectangle (point) (point))
11204 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11205 ((setq e (assoc var org-table-column-names))
11206 (org-table-goto-column (string-to-number (cdr e)))
11207 (org-table-highlight-rectangle (point) (point))
11208 (goto-char (org-table-begin))
11210 (org-table-end) t)
11211 (progn
11212 (goto-char (match-beginning 1))
11213 (org-table-highlight-rectangle)
11214 (message "Named column (column %s)" (cdr e)))
11215 (error "Column name not found")))
11216 ((eq what 'column)
11217 ;; column number
11218 (org-table-goto-column (string-to-number (substring match 1)))
11219 (org-table-highlight-rectangle (point) (point))
11220 (message "Column %s" (substring match 1)))
11221 ((setq e (assoc var org-table-local-parameters))
11222 (goto-char (org-table-begin))
11224 (progn
11225 (goto-char (match-beginning 1))
11226 (org-table-highlight-rectangle)
11227 (message "Local parameter."))
11228 (error "Parameter not found")))
11229 (t
11230 (cond
11231 ((not var) (error "No reference at point"))
11232 ((setq e (assoc var org-table-formula-constants-local))
11233 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11234 var (cdr e)))
11235 ((setq e (assoc var org-table-formula-constants))
11236 (message "Constant: $%s=%s in `org-table-formula-constants'."
11237 var (cdr e)))
11238 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11239 (message "Constant: $%s=%s, from `constants.el'%s."
11240 var e (format " (%s units)" constants-unit-system)))
11241 (t (error "Undefined name $%s" var)))))
11242 (goto-char pos)
11243 (when (and org-show-positions
11244 (not (memq this-command '(org-table-fedit-scroll
11245 org-table-fedit-scroll-down))))
11246 (push pos org-show-positions)
11247 (push org-table-current-begin-pos org-show-positions)
11248 (let ((min (apply 'min org-show-positions))
11249 (max (apply 'max org-show-positions)))
11250 (goto-char min) (recenter 0)
11251 (goto-char max)
11252 (or (pos-visible-in-window-p max) (recenter -1))))
11253 (select-window win))))
11255 (defun org-table-force-dataline ()
11256 "Make sure the cursor is in a dataline in a table."
11257 (unless (save-excursion
11258 (beginning-of-line 1)
11259 (looking-at org-table-dataline-regexp))
11260 (let* ((re org-table-dataline-regexp)
11261 (p1 (save-excursion (re-search-forward re nil 'move)))
11262 (p2 (save-excursion (re-search-backward re nil 'move))))
11263 (cond ((and p1 p2)
11264 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11265 p1 p2)))
11266 ((or p1 p2) (goto-char (or p1 p2)))
11267 (t (error "No table dataline around here"))))))
11269 (defun org-table-fedit-line-up ()
11270 "Move cursor one line up in the window showing the table."
11271 (interactive)
11272 (org-table-fedit-move 'previous-line))
11274 (defun org-table-fedit-line-down ()
11275 "Move cursor one line down in the window showing the table."
11276 (interactive)
11277 (org-table-fedit-move 'next-line))
11279 (defun org-table-fedit-move (command)
11280 "Move the cursor in the window shoinw the table.
11281 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11282 (let ((org-table-allow-automatic-line-recalculation nil)
11283 (pos org-pos) (win (selected-window)) p)
11284 (select-window (get-buffer-window (marker-buffer org-pos)))
11285 (setq p (point))
11286 (call-interactively command)
11287 (while (and (org-at-table-p)
11288 (org-at-table-hline-p))
11289 (call-interactively command))
11290 (or (org-at-table-p) (goto-char p))
11291 (move-marker pos (point))
11292 (select-window win)))
11294 (defun org-table-fedit-scroll (N)
11295 (interactive "p")
11296 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11297 (scroll-other-window N)))
11299 (defun org-table-fedit-scroll-down (N)
11300 (interactive "p")
11301 (org-table-fedit-scroll (- N)))
11303 (defvar org-table-rectangle-overlays nil)
11305 (defun org-table-add-rectangle-overlay (beg end &optional face)
11306 "Add a new overlay."
11307 (let ((ov (org-make-overlay beg end)))
11308 (org-overlay-put ov 'face (or face 'secondary-selection))
11309 (push ov org-table-rectangle-overlays)))
11311 (defun org-table-highlight-rectangle (&optional beg end face)
11312 "Highlight rectangular region in a table."
11313 (setq beg (or beg (point)) end (or end (point)))
11314 (let ((b (min beg end))
11315 (e (max beg end))
11316 l1 c1 l2 c2 tmp)
11317 (and (boundp 'org-show-positions)
11318 (setq org-show-positions (cons b (cons e org-show-positions))))
11319 (goto-char (min beg end))
11320 (setq l1 (org-current-line)
11321 c1 (org-table-current-column))
11322 (goto-char (max beg end))
11323 (setq l2 (org-current-line)
11324 c2 (org-table-current-column))
11325 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11326 (goto-line l1)
11327 (beginning-of-line 1)
11328 (loop for line from l1 to l2 do
11329 (when (looking-at org-table-dataline-regexp)
11330 (org-table-goto-column c1)
11332 (org-table-goto-column c2)
11334 (org-table-add-rectangle-overlay beg end face))
11335 (beginning-of-line 2))
11336 (goto-char b))
11337 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11339 (defun org-table-remove-rectangle-highlight (&rest ignore)
11340 "Remove the rectangle overlays."
11341 (unless org-inhibit-highlight-removal
11342 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11343 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11344 (setq org-table-rectangle-overlays nil)))
11346 (defvar org-table-coordinate-overlays nil
11347 "Collects the cooordinate grid overlays, so that they can be removed.")
11348 (make-variable-buffer-local 'org-table-coordinate-overlays)
11350 (defun org-table-overlay-coordinates ()
11351 "Add overlays to the table at point, to show row/column coordinates."
11352 (interactive)
11353 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11354 (setq org-table-coordinate-overlays nil)
11355 (save-excursion
11356 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11357 (goto-char (org-table-begin))
11358 (while (org-at-table-p)
11359 (setq eol (point-at-eol))
11360 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11361 (push ov org-table-coordinate-overlays)
11362 (setq hline (looking-at org-table-hline-regexp))
11363 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11364 (format "%4d" (setq id (1+ id)))))
11365 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11366 (when hline
11367 (setq ic 0)
11369 (setq beg (1+ (match-beginning 0))
11370 ic (1+ ic)
11371 s1 (concat "$" (int-to-string ic))
11372 s2 (org-number-to-letters ic)
11373 str (if (eq org-table-use-standard-references t) s2 s1))
11374 (setq ov (org-make-overlay beg (+ beg (length str))))
11375 (push ov org-table-coordinate-overlays)
11376 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11377 (beginning-of-line 2)))))
11379 (defun org-table-toggle-coordinate-overlays ()
11380 "Toggle the display of Row/Column numbers in tables."
11381 (interactive)
11382 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11383 (message "Row/Column number display turned %s"
11384 (if org-table-overlay-coordinates "on" "off"))
11385 (if (and (org-at-table-p) org-table-overlay-coordinates)
11386 (org-table-align))
11387 (unless org-table-overlay-coordinates
11388 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11389 (setq org-table-coordinate-overlays nil)))
11391 (defun org-table-toggle-formula-debugger ()
11392 "Toggle the formula debugger in tables."
11393 (interactive)
11394 (setq org-table-formula-debug (not org-table-formula-debug))
11395 (message "Formula debugging has been turned %s"
11396 (if org-table-formula-debug "on" "off")))
11398 ;;; The orgtbl minor mode
11400 ;; Define a minor mode which can be used in other modes in order to
11401 ;; integrate the org-mode table editor.
11403 ;; This is really a hack, because the org-mode table editor uses several
11404 ;; keys which normally belong to the major mode, for example the TAB and
11405 ;; RET keys. Here is how it works: The minor mode defines all the keys
11406 ;; necessary to operate the table editor, but wraps the commands into a
11407 ;; function which tests if the cursor is currently inside a table. If that
11408 ;; is the case, the table editor command is executed. However, when any of
11409 ;; those keys is used outside a table, the function uses `key-binding' to
11410 ;; look up if the key has an associated command in another currently active
11411 ;; keymap (minor modes, major mode, global), and executes that command.
11412 ;; There might be problems if any of the keys used by the table editor is
11413 ;; otherwise used as a prefix key.
11415 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11416 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11417 ;; addresses this by checking explicitly for both bindings.
11419 ;; The optimized version (see variable `orgtbl-optimized') takes over
11420 ;; all keys which are bound to `self-insert-command' in the *global map*.
11421 ;; Some modes bind other commands to simple characters, for example
11422 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11423 ;; active, this binding is ignored inside tables and replaced with a
11424 ;; modified self-insert.
11426 (defvar orgtbl-mode nil
11427 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11428 table editor in arbitrary modes.")
11429 (make-variable-buffer-local 'orgtbl-mode)
11431 (defvar orgtbl-mode-map (make-keymap)
11432 "Keymap for `orgtbl-mode'.")
11434 ;;;###autoload
11435 (defun turn-on-orgtbl ()
11436 "Unconditionally turn on `orgtbl-mode'."
11437 (orgtbl-mode 1))
11439 (defvar org-old-auto-fill-inhibit-regexp nil
11440 "Local variable used by `orgtbl-mode'")
11443 "Matches a line belonging to an orgtbl.")
11445 (defconst orgtbl-extra-font-lock-keywords
11446 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11447 0 (quote 'org-table) 'prepend))
11448 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11450 ;;;###autoload
11451 (defun orgtbl-mode (&optional arg)
11452 "The `org-mode' table editor as a minor mode for use in other modes."
11453 (interactive)
11454 (if (org-mode-p)
11455 ;; Exit without error, in case some hook functions calls this
11456 ;; by accident in org-mode.
11457 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11458 (setq orgtbl-mode
11459 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11460 (if orgtbl-mode
11461 (progn
11462 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11463 ;; Make sure we are first in minor-mode-map-alist
11464 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11465 (and c (setq minor-mode-map-alist
11466 (cons c (delq c minor-mode-map-alist)))))
11467 (org-set-local (quote org-table-may-need-update) t)
11468 (org-add-hook 'before-change-functions 'org-before-change-function
11469 nil 'local)
11470 (org-set-local 'org-old-auto-fill-inhibit-regexp
11471 auto-fill-inhibit-regexp)
11472 (org-set-local 'auto-fill-inhibit-regexp
11473 (if auto-fill-inhibit-regexp
11475 auto-fill-inhibit-regexp)
11476 orgtbl-line-start-regexp))
11477 (org-add-to-invisibility-spec '(org-cwidth))
11478 (when (fboundp 'font-lock-add-keywords)
11479 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11480 (org-restart-font-lock))
11481 (easy-menu-add orgtbl-mode-menu)
11482 (run-hooks 'orgtbl-mode-hook))
11483 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11484 (org-cleanup-narrow-column-properties)
11485 (org-remove-from-invisibility-spec '(org-cwidth))
11486 (remove-hook 'before-change-functions 'org-before-change-function t)
11487 (when (fboundp 'font-lock-remove-keywords)
11488 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11489 (org-restart-font-lock))
11490 (easy-menu-remove orgtbl-mode-menu)
11491 (force-mode-line-update 'all))))
11493 (defun org-cleanup-narrow-column-properties ()
11494 "Remove all properties related to narrow-column invisibility."
11495 (let ((s 1))
11496 (while (setq s (text-property-any s (point-max)
11497 'display org-narrow-column-arrow))
11498 (remove-text-properties s (1+ s) '(display t)))
11499 (setq s 1)
11500 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11501 (remove-text-properties s (1+ s) '(org-cwidth t)))
11502 (setq s 1)
11503 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11504 (remove-text-properties s (1+ s) '(invisible t)))))
11506 ;; Install it as a minor mode.
11507 (put 'orgtbl-mode :included t)
11508 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11509 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11511 (defun orgtbl-make-binding (fun n &rest keys)
11512 "Create a function for binding in the table minor mode.
11513 FUN is the command to call inside a table. N is used to create a unique
11514 command name. KEYS are keys that should be checked in for a command
11515 to execute outside of tables."
11516 (eval
11517 (list 'defun
11518 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11519 '(arg)
11521 "Outside of tables, run the binding of `"
11522 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11523 "'.")
11524 '(interactive "p")
11525 (list 'if
11526 '(org-at-table-p)
11527 (list 'call-interactively (list 'quote fun))
11528 (list 'let '(orgtbl-mode)
11529 (list 'call-interactively
11530 (append '(or)
11531 (mapcar (lambda (k)
11532 (list 'key-binding k))
11533 keys)
11534 '('orgtbl-error))))))))
11536 (defun orgtbl-error ()
11537 "Error when there is no default binding for a table key."
11538 (interactive)
11539 (error "This key has no function outside tables"))
11541 (defun orgtbl-setup ()
11542 "Setup orgtbl keymaps."
11543 (let ((nfunc 0)
11544 (bindings
11545 (list
11546 '([(meta shift left)] org-table-delete-column)
11547 '([(meta left)] org-table-move-column-left)
11548 '([(meta right)] org-table-move-column-right)
11549 '([(meta shift right)] org-table-insert-column)
11550 '([(meta shift up)] org-table-kill-row)
11551 '([(meta shift down)] org-table-insert-row)
11552 '([(meta up)] org-table-move-row-up)
11553 '([(meta down)] org-table-move-row-down)
11554 '("\C-c\C-w" org-table-cut-region)
11555 '("\C-c\M-w" org-table-copy-region)
11556 '("\C-c\C-y" org-table-paste-rectangle)
11557 '("\C-c-" org-table-insert-hline)
11558 '("\C-c}" org-table-toggle-coordinate-overlays)
11559 '("\C-c{" org-table-toggle-formula-debugger)
11560 '("\C-m" org-table-next-row)
11561 '([(shift return)] org-table-copy-down)
11562 '("\C-c\C-q" org-table-wrap-region)
11563 '("\C-c?" org-table-field-info)
11564 '("\C-c " org-table-blank-field)
11565 '("\C-c+" org-table-sum)
11566 '("\C-c=" org-table-eval-formula)
11567 '("\C-c'" org-table-edit-formulas)
11568 '("\C-c`" org-table-edit-field)
11569 '("\C-c*" org-table-recalculate)
11570 '("\C-c|" org-table-create-or-convert-from-region)
11571 '("\C-c^" org-table-sort-lines)
11572 '([(control ?#)] org-table-rotate-recalc-marks)))
11573 elt key fun cmd)
11574 (while (setq elt (pop bindings))
11575 (setq nfunc (1+ nfunc))
11576 (setq key (org-key (car elt))
11577 fun (nth 1 elt)
11578 cmd (orgtbl-make-binding fun nfunc key))
11579 (org-defkey orgtbl-mode-map key cmd))
11581 ;; Special treatment needed for TAB and RET
11582 (org-defkey orgtbl-mode-map [(return)]
11583 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11584 (org-defkey orgtbl-mode-map "\C-m"
11585 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11587 (org-defkey orgtbl-mode-map [(tab)]
11588 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11589 (org-defkey orgtbl-mode-map "\C-i"
11590 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11592 (org-defkey orgtbl-mode-map [(shift tab)]
11593 (orgtbl-make-binding 'org-table-previous-field 104
11594 [(shift tab)] [(tab)] "\C-i"))
11596 (org-defkey orgtbl-mode-map "\M-\C-m"
11597 (orgtbl-make-binding 'org-table-wrap-region 105
11598 "\M-\C-m" [(meta return)]))
11599 (org-defkey orgtbl-mode-map [(meta return)]
11600 (orgtbl-make-binding 'org-table-wrap-region 106
11601 [(meta return)] "\M-\C-m"))
11603 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11604 (when orgtbl-optimized
11605 ;; If the user wants maximum table support, we need to hijack
11606 ;; some standard editing functions
11607 (org-remap orgtbl-mode-map
11608 'self-insert-command 'orgtbl-self-insert-command
11609 'delete-char 'org-delete-char
11610 'delete-backward-char 'org-delete-backward-char)
11611 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11612 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11613 '("OrgTbl"
11614 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11615 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11616 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11617 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11618 "--"
11619 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11620 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11621 ["Copy Field from Above"
11622 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11623 "--"
11624 ("Column"
11625 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11626 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11627 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11628 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11629 ("Row"
11630 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11631 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11632 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11633 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11634 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
11635 "--"
11636 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11637 ("Rectangle"
11638 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11639 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11640 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11641 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11642 "--"
11643 ("Radio tables"
11644 ["Insert table template" orgtbl-insert-radio-table
11645 (assq major-mode orgtbl-radio-table-templates)]
11646 ["Comment/uncomment table" orgtbl-toggle-comment t])
11647 "--"
11648 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11649 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11650 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11651 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11652 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11653 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11654 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11655 ["Sum Column/Rectangle" org-table-sum
11656 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11657 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11658 ["Debug Formulas"
11659 org-table-toggle-formula-debugger :active (org-at-table-p)
11660 :keys "C-c {"
11661 :style toggle :selected org-table-formula-debug]
11662 ["Show Col/Row Numbers"
11663 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11664 :keys "C-c }"
11665 :style toggle :selected org-table-overlay-coordinates]
11666 ))
11667 t))
11669 (defun orgtbl-ctrl-c-ctrl-c (arg)
11670 "If the cursor is inside a table, realign the table.
11671 It it is a table to be sent away to a receiver, do it.
11672 With prefix arg, also recompute table."
11673 (interactive "P")
11674 (let ((pos (point)) action)
11675 (save-excursion
11676 (beginning-of-line 1)
11680 (cond
11681 ((integerp action)
11682 (goto-char action)
11683 (org-table-maybe-eval-formula)
11684 (if arg
11685 (call-interactively 'org-table-recalculate)
11686 (org-table-maybe-recalculate-line))
11687 (call-interactively 'org-table-align)
11688 (orgtbl-send-table 'maybe))
11689 ((eq action 'recalc)
11690 (save-excursion
11691 (beginning-of-line 1)
11693 (if (org-at-table-p)
11694 (org-call-with-arg 'org-table-recalculate t))))
11695 (t (let (orgtbl-mode)
11696 (call-interactively (key-binding "\C-c\C-c")))))))
11698 (defun orgtbl-tab (arg)
11699 "Justification and field motion for `orgtbl-mode'."
11700 (interactive "P")
11701 (if arg (org-table-edit-field t)
11702 (org-table-justify-field-maybe)
11703 (org-table-next-field)))
11705 (defun orgtbl-ret ()
11706 "Justification and field motion for `orgtbl-mode'."
11707 (interactive)
11708 (org-table-justify-field-maybe)
11709 (org-table-next-row))
11711 (defun orgtbl-self-insert-command (N)
11712 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11713 If the cursor is in a table looking at whitespace, the whitespace is
11714 overwritten, and the table is not marked as requiring realignment."
11715 (interactive "p")
11716 (if (and (org-at-table-p)
11717 (or
11718 (and org-table-auto-blank-field
11719 (member last-command
11720 '(orgtbl-hijacker-command-100
11721 orgtbl-hijacker-command-101
11722 orgtbl-hijacker-command-102
11723 orgtbl-hijacker-command-103
11724 orgtbl-hijacker-command-104
11725 orgtbl-hijacker-command-105))
11726 (org-table-blank-field))
11727 t)
11728 (eq N 1)
11730 (let (org-table-may-need-update)
11731 (goto-char (1- (match-end 0)))
11732 (delete-backward-char 1)
11733 (goto-char (match-beginning 0))
11734 (self-insert-command N))
11735 (setq org-table-may-need-update t)
11736 (let (orgtbl-mode)
11737 (call-interactively (key-binding (vector last-input-event))))))
11739 (defun org-force-self-insert (N)
11740 "Needed to enforce self-insert under remapping."
11741 (interactive "p")
11742 (self-insert-command N))
11745 "Regula expression matching exponentials as produced by calc.")
11747 (defvar org-table-clean-did-remove-column nil)
11749 (defun orgtbl-export (table target)
11750 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11752 org-table-last-alignment org-table-last-column-widths
11753 maxcol column)
11754 (if (not (fboundp func))
11755 (error "Cannot export orgtbl table to %s" target))
11756 (setq lines (org-table-clean-before-export lines))
11757 (setq table
11758 (mapcar
11759 (lambda (x)
11760 (if (string-match org-table-hline-regexp x)
11761 'hline
11763 lines))
11764 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11765 table)))
11766 (loop for i from (1- maxcol) downto 0 do
11767 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11768 (setq column (delq nil column))
11769 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11770 (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))
11771 (funcall func table nil)))
11773 (defun orgtbl-send-table (&optional maybe)
11774 "Send a tranformed version of this table to the receiver position.
11775 With argument MAYBE, fail quietly if no transformation is defined for
11776 this table."
11777 (interactive)
11778 (catch 'exit
11779 (unless (org-at-table-p) (error "Not at a table"))
11780 ;; when non-interactive, we assume align has just happened.
11781 (when (interactive-p) (org-table-align))
11782 (save-excursion
11783 (goto-char (org-table-begin))
11784 (beginning-of-line 0)
11786 (if maybe
11787 (throw 'exit nil)
11788 (error "Don't know how to transform this table."))))
11789 (let* ((name (match-string 1))
11790 beg
11791 (transform (intern (match-string 2)))
11792 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11793 (skip (plist-get params :skip))
11794 (skipcols (plist-get params :skipcols))
11795 (txt (buffer-substring-no-properties
11796 (org-table-begin) (org-table-end)))
11798 (lines (org-table-clean-before-export lines))
11799 (i0 (if org-table-clean-did-remove-column 2 1))
11800 (table (mapcar
11801 (lambda (x)
11802 (if (string-match org-table-hline-regexp x)
11803 'hline
11804 (org-remove-by-index
11806 skipcols i0)))
11807 lines))
11808 (fun (if (= i0 2) 'cdr 'identity))
11809 (org-table-last-alignment
11810 (org-remove-by-index (funcall fun org-table-last-alignment)
11811 skipcols i0))
11812 (org-table-last-column-widths
11813 (org-remove-by-index (funcall fun org-table-last-column-widths)
11814 skipcols i0)))
11816 (unless (fboundp transform)
11817 (error "No such transformation function %s" transform))
11818 (setq txt (funcall transform table params))
11819 ;; Find the insertion place
11820 (save-excursion
11821 (goto-char (point-min))
11822 (unless (re-search-forward
11824 (error "Don't know where to insert translated table"))
11825 (goto-char (match-beginning 0))
11826 (beginning-of-line 2)
11827 (setq beg (point))
11828 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11829 (error "Cannot find end of insertion region"))
11830 (beginning-of-line 1)
11831 (delete-region beg (point))
11832 (goto-char beg)
11834 (message "Table converted and installed at receiver location"))))
11836 (defun org-remove-by-index (list indices &optional i0)
11837 "Remove the elements in LIST with indices in INDICES.
11838 First element has index 0, or I0 if given."
11839 (if (not indices)
11840 list
11841 (if (integerp indices) (setq indices (list indices)))
11842 (setq i0 (1- (or i0 0)))
11843 (delq :rm (mapcar (lambda (x)
11844 (setq i0 (1+ i0))
11845 (if (memq i0 indices) :rm x))
11846 list))))
11848 (defun orgtbl-toggle-comment ()
11849 "Comment or uncomment the orgtbl at point."
11850 (interactive)
11851 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11852 (re2 (concat "^" orgtbl-line-start-regexp))
11853 (commented (save-excursion (beginning-of-line 1)
11854 (cond ((looking-at re1) t)
11855 ((looking-at re2) nil)
11856 (t (error "Not at an org table")))))
11857 (re (if commented re1 re2))
11858 beg end)
11859 (save-excursion
11860 (beginning-of-line 1)
11861 (while (looking-at re) (beginning-of-line 0))
11862 (beginning-of-line 2)
11863 (setq beg (point))
11864 (while (looking-at re) (beginning-of-line 2))
11865 (setq end (point)))
11866 (comment-region beg end (if commented '(4) nil))))
11868 (defun orgtbl-insert-radio-table ()
11869 "Insert a radio table template appropriate for this major mode."
11870 (interactive)
11871 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11872 (txt (nth 1 e))
11873 name pos)
11874 (unless e (error "No radio table setup defined for %s" major-mode))
11875 (setq name (read-string "Table name: "))
11876 (while (string-match "%n" txt)
11877 (setq txt (replace-match name t t txt)))
11879 (setq pos (point))
11880 (insert txt)
11881 (goto-char pos)))
11883 (defun org-get-param (params header i sym &optional hsym)
11884 "Get parameter value for symbol SYM.
11885 If this is a header line, actually get the value for the symbol with an
11887 If the value is a protperty list, get the element for the current column.
11888 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11889 (let ((val (plist-get params sym)))
11890 (and hsym header (setq val (or (plist-get params hsym) val)))
11891 (if (consp val) (plist-get val i) val)))
11893 (defun orgtbl-to-generic (table params)
11894 "Convert the orgtbl-mode TABLE to some other format.
11895 This generic routine can be used for many standard cases.
11896 TABLE is a list, each entry either the symbol `hline' for a horizontal
11897 separator line, or a list of fields for that line.
11898 PARAMS is a property list of parameters that can influence the conversion.
11899 For the generic converter, some parameters are obligatory: You need to
11900 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11901 :splice, you must have :tstart and :tend.
11903 Valid parameters are
11905 :tstart String to start the table. Ignored when :splice is t.
11906 :tend String to end the table. Ignored when :splice is t.
11908 :splice When set to t, return only table body lines, don't wrap
11909 them into :tstart and :tend. Default is nil.
11911 :hline String to be inserted on horizontal separation lines.
11912 May be nil to ignore hlines.
11914 :lstart String to start a new table line.
11915 :lend String to end a table line
11916 :sep Separator between two fields
11917 :lfmt Format for entire line, with enough %s to capture all fields.
11918 If this is present, :lstart, :lend, and :sep are ignored.
11919 :fmt A format to be used to wrap the field, should contain
11920 %s for the original field value. For example, to wrap
11922 This may also be a property list with column numbers and
11925 :hlstart :hlend :hlsep :hlfmt :hfmt
11926 Same as above, specific for the header lines in the table.
11927 All lines before the first hline are treated as header.
11928 If any of these is not present, the data line value is used.
11930 :efmt Use this format to print numbers with exponentials.
11931 The format should have %s twice for inserting mantissa
11933 may also be a property list with column numbers and
11934 formats. :fmt will still be applied after :efmt.
11936 In addition to this, the parameters :skip and :skipcols are always handled
11937 directly by `orgtbl-send-table'. See manual."
11938 (interactive)
11939 (let* ((p params)
11940 (splicep (plist-get p :splice))
11941 (hline (plist-get p :hline))
11942 rtn line i fm efm lfmt h)
11944 ;; Do we have a header?
11945 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11946 (setq h t))
11948 ;; Put header
11949 (unless splicep
11950 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11952 ;; Now loop over all lines
11953 (while (setq line (pop table))
11954 (if (eq line 'hline)
11955 ;; A horizontal separator line
11956 (progn (if hline (push hline rtn))
11957 (setq h nil)) ; no longer in header
11958 ;; A normal line. Convert the fields, push line onto the result list
11959 (setq i 0)
11960 (setq line
11961 (mapcar
11962 (lambda (f)
11963 (setq i (1+ i)
11964 fm (org-get-param p h i :fmt :hfmt)
11965 efm (org-get-param p h i :efmt))
11966 (if (and efm (string-match orgtbl-exp-regexp f))
11967 (setq f (format
11968 efm (match-string 1 f) (match-string 2 f))))
11969 (if fm (setq f (format fm f)))
11970 f)
11971 line))
11972 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11973 (push (apply 'format lfmt line) rtn)
11974 (push (concat
11975 (org-get-param p h i :lstart :hlstart)
11976 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11977 (org-get-param p h i :lend :hlend))
11978 rtn))))
11980 (unless splicep
11981 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11985 (defun orgtbl-to-latex (table params)
11986 "Convert the orgtbl-mode TABLE to LaTeX.
11987 TABLE is a list, each entry either the symbol `hline' for a horizontal
11988 separator line, or a list of fields for that line.
11989 PARAMS is a property list of parameters that can influence the conversion.
11990 Supports all parameters from `orgtbl-to-generic'. Most important for
11991 LaTeX are:
11993 :splice When set to t, return only table body lines, don't wrap
11994 them into a tabular environment. Default is nil.
11996 :fmt A format to be used to wrap the field, should contain %s for the
11997 original field value. For example, to wrap everything in dollars,
12001 :efmt Format for transforming numbers with exponentials. The format
12002 should have %s twice for inserting mantissa and exponent, for
12004 This may also be a property list with column numbers and formats.
12006 The general parameters :skip and :skipcols have already been applied when
12007 this function is called."
12008 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
12009 org-table-last-alignment ""))
12010 (params2
12011 (list
12016 (orgtbl-to-generic table (org-combine-plists params2 params))))
12018 (defun orgtbl-to-html (table params)
12019 "Convert the orgtbl-mode TABLE to LaTeX.
12020 TABLE is a list, each entry either the symbol `hline' for a horizontal
12021 separator line, or a list of fields for that line.
12022 PARAMS is a property list of parameters that can influence the conversion.
12023 Currently this function recognizes the following parameters:
12025 :splice When set to t, return only table body lines, don't wrap
12026 them into a <table> environment. Default is nil.
12028 The general parameters :skip and :skipcols have already been applied when
12029 this function is called. The function does *not* use `orgtbl-to-generic',
12030 so you cannot specify parameters for it."
12031 (let* ((splicep (plist-get params :splice))
12032 html)
12033 ;; Just call the formatter we already have
12034 ;; We need to make text lines for it, so put the fields back together.
12035 (setq html (org-format-org-table-html
12036 (mapcar
12037 (lambda (x)
12038 (if (eq x 'hline)
12039 "|----+----|"
12040 (concat "| " (mapconcat 'identity x " | ") " |")))
12041 table)
12042 splicep))
12044 (setq html (replace-match "" t t html)))
12045 html))
12047 (defun orgtbl-to-texinfo (table params)
12048 "Convert the orgtbl-mode TABLE to TeXInfo.
12049 TABLE is a list, each entry either the symbol `hline' for a horizontal
12050 separator line, or a list of fields for that line.
12051 PARAMS is a property list of parameters that can influence the conversion.
12052 Supports all parameters from `orgtbl-to-generic'. Most important for
12053 TeXInfo are:
12055 :splice nil/t When set to t, return only table body lines, don't wrap
12056 them into a multitable environment. Default is nil.
12058 :fmt fmt A format to be used to wrap the field, should contain
12059 %s for the original field value. For example, to wrap
12061 This may also be a property list with column numbers and
12065 are computed automatically from the width of the columns
12066 under org-mode.
12068 The general parameters :skip and :skipcols have already been applied when
12069 this function is called."
12070 (let* ((total (float (apply '+ org-table-last-column-widths)))
12071 (colfrac (or (plist-get params :cf)
12072 (mapconcat
12073 (lambda (x) (format "%.3f" (/ (float x) total)))
12074 org-table-last-column-widths " ")))
12075 (params2
12076 (list
12077 :tstart (concat "@multitable @columnfractions " colfrac)
12078 :tend "@end multitable"
12079 :lstart "@item " :lend "" :sep " @tab "
12080 :hlstart "@headitem ")))
12081 (orgtbl-to-generic table (org-combine-plists params2 params))))
12083 ;;;; Link Stuff
12085 ;;; Link abbreviations
12087 (defun org-link-expand-abbrev (link)
12088 "Apply replacements as defined in `org-link-abbrev-alist."
12090 (let* ((key (match-string 1 link))
12091 (as (or (assoc key org-link-abbrev-alist-local)
12092 (assoc key org-link-abbrev-alist)))
12093 (tag (and (match-end 2) (match-string 3 link)))
12094 rpl)
12095 (if (not as)
12096 link
12097 (setq rpl (cdr as))
12098 (cond
12099 ((symbolp rpl) (funcall rpl tag))
12100 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
12101 (t (concat rpl tag)))))
12102 link))
12104 ;;; Storing and inserting links
12106 (defvar org-insert-link-history nil
12107 "Minibuffer history for links inserted with `org-insert-link'.")
12109 (defvar org-stored-links nil
12110 "Contains the links stored with `org-store-link'.")
12112 (defvar org-store-link-plist nil
12113 "Plist with info about the most recently link created with `org-store-link'.")
12115 (defvar org-link-protocols nil
12116 "Link protocols added to Org-mode using `org-add-link-type'.")
12118 (defvar org-store-link-functions nil
12119 "List of functions that are called to create and store a link.
12120 Each function will be called in turn until one returns a non-nil
12121 value. Each function should check if it is responsible for creating
12122 this link (for example by looking at the major mode).
12123 If not, it must exit and return nil.
12124 If yes, it should return a non-nil value after a calling
12125 `org-store-link-props' with a list of properties and values.
12126 Special properties are:
12130 This is obligatory as well.
12131 :description Optional default description for the second pair
12132 of brackets in an Org-mode link. The user can still change
12133 this when inserting this link into an Org-mode buffer.
12135 In addition to these, any additional properties can be specified
12136 and then used in remember templates.")
12138 (defun org-add-link-type (type &optional follow publish)
12139 "Add TYPE to the list of `org-link-types'.
12140 Re-compute all regular expressions depending on `org-link-types'
12141 FOLLOW and PUBLISH are two functions. Both take the link path as
12142 an argument.
12143 FOLLOW should do whatever is necessary to follow the link, for example
12144 to find a file or display a mail message.
12146 PUBLISH takes the path and retuns the string that should be used when
12147 this document is published. FIMXE: This is actually not yet implemented."
12148 (add-to-list 'org-link-types type t)
12149 (org-make-link-regexps)
12150 (add-to-list 'org-link-protocols
12151 (list type follow publish)))
12153 (defun org-add-agenda-custom-command (entry)
12154 "Replace or add a command in `org-agenda-custom-commands'.
12155 This is mostly for hacking and trying a new command - once the command
12156 works you probably want to add it to `org-agenda-custom-commands' for good."
12157 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
12158 (if ass
12159 (setcdr ass (cdr entry))
12160 (push entry org-agenda-custom-commands))))
12162 ;;;###autoload
12163 (defun org-store-link (arg)
12165 This link is added to `org-stored-links' and can later be inserted
12168 For some link types, a prefix arg is interpreted:
12169 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12170 For file links, arg negates `org-context-in-file-links'."
12171 (interactive "P")
12172 (setq org-store-link-plist nil) ; reset
12173 (let (link cpltxt desc description search txt)
12174 (cond
12176 ((run-hook-with-args-until-success 'org-store-link-functions)
12177 (setq link (plist-get org-store-link-plist :link)
12178 desc (or (plist-get org-store-link-plist :description) link)))
12180 ((eq major-mode 'bbdb-mode)
12181 (let ((name (bbdb-record-name (bbdb-current-record)))
12182 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
12183 (setq cpltxt (concat "bbdb:" (or name company))
12184 link (org-make-link cpltxt))
12185 (org-store-link-props :type "bbdb" :name name :company company)))
12187 ((eq major-mode 'Info-mode)
12188 (setq link (org-make-link "info:"
12189 (file-name-nondirectory Info-current-file)
12190 ":" Info-current-node))
12191 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
12192 ":" Info-current-node))
12193 (org-store-link-props :type "info" :file Info-current-file
12194 :node Info-current-node))
12196 ((eq major-mode 'calendar-mode)
12197 (let ((cd (calendar-cursor-to-date)))
12198 (setq link
12199 (format-time-string
12200 (car org-time-stamp-formats)
12201 (apply 'encode-time
12202 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12203 nil nil nil))))
12204 (org-store-link-props :type "calendar" :date cd)))
12206 ((or (eq major-mode 'vm-summary-mode)
12207 (eq major-mode 'vm-presentation-mode))
12208 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
12209 (vm-follow-summary-cursor)
12210 (save-excursion
12211 (vm-select-folder-buffer)
12212 (let* ((message (car vm-message-pointer))
12213 (folder buffer-file-name)
12214 (subject (vm-su-subject message))
12215 (to (vm-get-header-contents message "To"))
12216 (from (vm-get-header-contents message "From"))
12217 (message-id (vm-su-message-id message)))
12218 (org-store-link-props :type "vm" :from from :to to :subject subject
12219 :message-id message-id)
12220 (setq message-id (org-remove-angle-brackets message-id))
12221 (setq folder (abbreviate-file-name folder))
12222 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
12223 folder)
12224 (setq folder (replace-match "" t t folder)))
12225 (setq cpltxt (org-email-link-description))
12226 (setq link (org-make-link "vm:" folder "#" message-id)))))
12228 ((eq major-mode 'wl-summary-mode)
12229 (let* ((msgnum (wl-summary-message-number))
12230 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12231 msgnum 'message-id))
12232 (wl-message-entity
12233 (if (fboundp 'elmo-message-entity)
12234 (elmo-message-entity
12235 wl-summary-buffer-elmo-folder msgnum)
12236 (elmo-msgdb-overview-get-entity
12237 msgnum (wl-summary-buffer-msgdb))))
12238 (from (wl-summary-line-from))
12239 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12240 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12241 (wl-summary-line-subject))))
12242 (org-store-link-props :type "wl" :from from :to to
12243 :subject subject :message-id message-id)
12244 (setq message-id (org-remove-angle-brackets message-id))
12245 (setq cpltxt (org-email-link-description))
12246 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12247 "#" message-id))))
12249 ((or (equal major-mode 'mh-folder-mode)
12250 (equal major-mode 'mh-show-mode))
12251 (let ((from (org-mhe-get-header "From:"))
12252 (to (org-mhe-get-header "To:"))
12253 (message-id (org-mhe-get-header "Message-Id:"))
12254 (subject (org-mhe-get-header "Subject:")))
12255 (org-store-link-props :type "mh" :from from :to to
12256 :subject subject :message-id message-id)
12257 (setq cpltxt (org-email-link-description))
12258 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12259 (org-remove-angle-brackets message-id)))))
12261 ((or (eq major-mode 'rmail-mode)
12262 (eq major-mode 'rmail-summary-mode))
12263 (save-window-excursion
12264 (save-restriction
12265 (when (eq major-mode 'rmail-summary-mode)
12266 (rmail-show-message rmail-current-message))
12267 (rmail-narrow-to-non-pruned-header)
12268 (let ((folder buffer-file-name)
12269 (message-id (mail-fetch-field "message-id"))
12270 (from (mail-fetch-field "from"))
12271 (to (mail-fetch-field "to"))
12272 (subject (mail-fetch-field "subject")))
12273 (org-store-link-props
12274 :type "rmail" :from from :to to
12275 :subject subject :message-id message-id)
12276 (setq message-id (org-remove-angle-brackets message-id))
12277 (setq cpltxt (org-email-link-description))
12278 (setq link (org-make-link "rmail:" folder "#" message-id)))
12279 (rmail-show-message rmail-current-message))))
12281 ((eq major-mode 'gnus-group-mode)
12282 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12283 (gnus-group-group-name)) ; version
12284 ((fboundp 'gnus-group-name)
12285 (gnus-group-name))
12286 (t "???"))))
12287 (unless group (error "Not on a group"))
12288 (org-store-link-props :type "gnus" :group group)
12289 (setq cpltxt (concat
12290 (if (org-xor arg org-usenet-links-prefer-google)
12291 "http://groups.google.com/groups?group="
12292 "gnus:")
12293 group)
12294 link (org-make-link cpltxt))))
12296 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12297 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12298 (let* ((group gnus-newsgroup-name)
12299 (article (gnus-summary-article-number))
12300 (header (gnus-summary-article-header article))
12301 (from (mail-header-from header))
12302 (message-id (mail-header-id header))
12303 (date (mail-header-date header))
12304 (subject (gnus-summary-subject-string)))
12305 (org-store-link-props :type "gnus" :from from :subject subject
12306 :message-id message-id :group group)
12307 (setq cpltxt (org-email-link-description))
12308 (if (org-xor arg org-usenet-links-prefer-google)
12309 (setq link
12310 (concat
12312 (format "http://groups.google.com/groups?as_umsgid=%s"
12313 (org-fixup-message-id-for-http message-id))))
12314 (setq link (org-make-link "gnus:" group
12315 "#" (number-to-string article))))))
12317 ((eq major-mode 'w3-mode)
12318 (setq cpltxt (url-view-url t)
12319 link (org-make-link cpltxt))
12320 (org-store-link-props :type "w3" :url (url-view-url t)))
12322 ((eq major-mode 'w3m-mode)
12323 (setq cpltxt (or w3m-current-title w3m-current-url)
12324 link (org-make-link w3m-current-url))
12325 (org-store-link-props :type "w3m" :url (url-view-url t)))
12327 ((setq search (run-hook-with-args-until-success
12328 'org-create-file-search-functions))
12329 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12330 "::" search))
12331 (setq cpltxt (or description link)))
12333 ((eq major-mode 'image-mode)
12334 (setq cpltxt (concat "file:"
12335 (abbreviate-file-name buffer-file-name))
12336 link (org-make-link cpltxt))
12337 (org-store-link-props :type "image" :file buffer-file-name))
12339 ((eq major-mode 'dired-mode)
12340 ;; link to the file in the current line
12341 (setq cpltxt (concat "file:"
12342 (abbreviate-file-name
12343 (expand-file-name
12344 (dired-get-filename nil t))))
12345 link (org-make-link cpltxt)))
12347 ((and buffer-file-name (org-mode-p))
12348 ;; Just link to current headline
12349 (setq cpltxt (concat "file:"
12350 (abbreviate-file-name buffer-file-name)))
12351 ;; Add a context search string
12352 (when (org-xor org-context-in-file-links arg)
12353 ;; Check if we are on a target
12355 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12356 (setq txt (cond
12357 ((org-on-heading-p) nil)
12358 ((org-region-active-p)
12359 (buffer-substring (region-beginning) (region-end)))
12360 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12362 (setq cpltxt
12363 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12364 desc "NONE"))))
12366 (setq cpltxt (substring cpltxt 0 -2)))
12367 (setq link (org-make-link cpltxt)))
12369 ((buffer-file-name (buffer-base-buffer))
12370 ;; Just link to this file here.
12371 (setq cpltxt (concat "file:"
12372 (abbreviate-file-name
12373 (buffer-file-name (buffer-base-buffer)))))
12374 ;; Add a context string
12375 (when (org-xor org-context-in-file-links arg)
12376 (setq txt (if (org-region-active-p)
12377 (buffer-substring (region-beginning) (region-end))
12378 (buffer-substring (point-at-bol) (point-at-eol))))
12379 ;; Only use search option if there is some text.
12381 (setq cpltxt
12382 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12383 desc "NONE")))
12384 (setq link (org-make-link cpltxt)))
12386 ((interactive-p)
12387 (error "Cannot link to a buffer which is not visiting a file"))
12389 (t (setq link nil)))
12391 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12392 (setq link (or link cpltxt)
12393 desc (or desc cpltxt))
12394 (if (equal desc "NONE") (setq desc nil))
12396 (if (and (interactive-p) link)
12397 (progn
12398 (setq org-stored-links
12399 (cons (list link desc) org-stored-links))
12400 (message "Stored: %s" (or desc link)))
12401 (and link (org-make-link-string link desc)))))
12403 (defun org-store-link-props (&rest plist)
12404 "Store link properties, extract names and addresses."
12405 (let (x adr)
12406 (when (setq x (plist-get plist :from))
12407 (setq adr (mail-extract-address-components x))
12408 (plist-put plist :fromname (car adr))
12409 (plist-put plist :fromaddress (nth 1 adr)))
12410 (when (setq x (plist-get plist :to))
12411 (setq adr (mail-extract-address-components x))
12412 (plist-put plist :toname (car adr))
12413 (plist-put plist :toaddress (nth 1 adr))))
12414 (let ((from (plist-get plist :from))
12415 (to (plist-get plist :to)))
12416 (when (and from to org-from-is-user-regexp)
12417 (plist-put plist :fromto
12418 (if (string-match org-from-is-user-regexp from)
12419 (concat "to %t")
12420 (concat "from %f")))))
12421 (setq org-store-link-plist plist))
12423 (defun org-email-link-description (&optional fmt)
12424 "Return the description part of an email link.
12425 This takes information from `org-store-link-plist' and formats it
12426 according to FMT (default from `org-email-link-description-format')."
12427 (setq fmt (or fmt org-email-link-description-format))
12428 (let* ((p org-store-link-plist)
12429 (to (plist-get p :toaddress))
12430 (from (plist-get p :fromaddress))
12431 (table
12432 (list
12433 (cons "%c" (plist-get p :fromto))
12434 (cons "%F" (plist-get p :from))
12435 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12436 (cons "%T" (plist-get p :to))
12437 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12438 (cons "%s" (plist-get p :subject))
12439 (cons "%m" (plist-get p :message-id)))))
12440 (when (string-match "%c" fmt)
12441 ;; Check if the user wrote this message
12442 (if (and org-from-is-user-regexp from to
12443 (save-match-data (string-match org-from-is-user-regexp from)))
12444 (setq fmt (replace-match "to %t" t t fmt))
12445 (setq fmt (replace-match "from %f" t t fmt))))
12446 (org-replace-escapes fmt table)))
12448 (defun org-make-org-heading-search-string (&optional string heading)
12449 "Make search string for STRING or current headline."
12450 (interactive)
12451 (let ((s (or string (org-get-heading))))
12452 (unless (and string (not heading))
12453 ;; We are using a headline, clean up garbage in there.
12454 (if (string-match org-todo-regexp s)
12455 (setq s (replace-match "" t t s)))
12457 (setq s (replace-match "" t t s)))
12458 (setq s (org-trim s))
12461 (setq s (replace-match "" t t s)))
12462 (while (string-match org-ts-regexp s)
12463 (setq s (replace-match "" t t s))))
12465 (setq s (replace-match " " t t s)))
12466 (or string (setq s (concat "*" s))) ; Add * for headlines
12469 (defun org-make-link (&rest strings)
12470 "Concatenate STRINGS."
12471 (apply 'concat strings))
12473 (defun org-make-link-string (link &optional description)
12474 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12476 (error "Empty link"))
12477 (when (stringp description)
12478 ;; Remove brackets from the description, they are fatal.
12480 (setq description (replace-match "{" t t description)))
12482 (setq description (replace-match "}" t t description))))
12483 (when (equal (org-link-escape link) description)
12484 ;; No description needed, it is identical
12485 (setq description nil))
12486 (when (and (not description)
12487 (not (equal link (org-link-escape link))))
12488 (setq description link))
12489 (concat "[[" (org-link-escape link) "]"
12490 (if description (concat "[" description "]") "")
12491 "]"))
12493 (defconst org-link-escape-chars
12494 '((?\ . "%20")
12495 (?\[ . "%5B")
12496 (?\] . "%5D")
12507 (?\; . "%3B")
12508 (?? . "%3F")
12509 (?= . "%3D")
12510 (?+ . "%2B")
12511 )
12512 "Association list of escapes for some characters problematic in links.
12513 This is the list that is used for internal purposes.")
12515 (defconst org-link-escape-chars-browser
12516 '((?\ . "%20")) ; 32 for the SPC char
12517 "Association list of escapes for some characters problematic in links.
12518 This is the list that is used before handing over to the browser.")
12520 (defun org-link-escape (text &optional table)
12521 "Escape charaters in TEXT that are problematic for links."
12522 (setq table (or table org-link-escape-chars))
12523 (when text
12524 (let ((re (mapconcat (lambda (x) (regexp-quote
12525 (char-to-string (car x))))
12527 (while (string-match re text)
12528 (setq text
12529 (replace-match
12530 (cdr (assoc (string-to-char (match-string 0 text))
12531 table))
12532 t t text)))
12533 text)))
12535 (defun org-link-unescape (text &optional table)
12536 "Reverse the action of `org-link-escape'."
12537 (setq table (or table org-link-escape-chars))
12538 (when text
12539 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12541 (while (string-match re text)
12542 (setq text
12543 (replace-match
12544 (char-to-string (car (rassoc (match-string 0 text) table)))
12545 t t text)))
12546 text)))
12548 (defun org-xor (a b)
12549 "Exclusive or."
12550 (if a (not b) b))
12552 (defun org-get-header (header)
12553 "Find a header field in the current buffer."
12554 (save-excursion
12555 (goto-char (point-min))
12556 (let ((case-fold-search t) s)
12557 (cond
12558 ((eq header 'from)
12560 (setq s (match-string 1)))
12562 (setq s (replace-match "" t t s)))
12563 (if (string-match "[<(].*" s)
12564 (setq s (replace-match "" t t s))))
12565 ((eq header 'message-id)
12567 (setq s (match-string 1))))
12568 ((eq header 'subject)
12570 (setq s (match-string 1)))))
12573 s)))
12576 (defun org-fixup-message-id-for-http (s)
12577 "Replace special characters in a message id, so it can be used in an http query."
12578 (while (string-match "<" s)
12579 (setq s (replace-match "%3C" t t s)))
12580 (while (string-match ">" s)
12581 (setq s (replace-match "%3E" t t s)))
12582 (while (string-match "@" s)
12583 (setq s (replace-match "%40" t t s)))
12584 s)
12586 ;;;###autoload
12587 (defun org-insert-link-global ()
12588 "Insert a link like Org-mode does.
12589 This command can be called in any mode to insert a link in Org-mode syntax."
12590 (interactive)
12591 (org-run-like-in-org-mode 'org-insert-link))
12593 (defun org-insert-link (&optional complete-file)
12594 "Insert a link. At the prompt, enter the link.
12596 Completion can be used to select a link previously stored with
12597 `org-store-link'. When the empty string is entered (i.e. if you just
12598 press RET at the prompt), the link defaults to the most recently
12599 stored link. As SPC triggers completion in the minibuffer, you need to
12600 use M-SPC or C-q SPC to force the insertion of a space character.
12602 You will also be prompted for a description, and if one is given, it will
12603 be displayed in the buffer instead of the link.
12605 If there is already a link at point, this command will allow you to edit link
12606 and description parts.
12609 selected using completion. The path to the file will be relative to
12610 the current directory if the file is in the current directory or a
12611 subdirectory. Otherwise, the link will be the absolute path as
12612 completed in the minibuffer (i.e. normally ~/path/to/file).
12615 is in the current directory or below.
12617 `org-keep-stored-link-after-insertion'."
12618 (interactive "P")
12619 (let* ((wcf (current-window-configuration))
12620 (region (if (org-region-active-p)
12621 (buffer-substring (region-beginning) (region-end))))
12622 (remove (and region (list (region-beginning) (region-end))))
12623 (desc region)
12624 tmphist ; byte-compile incorrectly complains about this
12625 link entry file)
12626 (cond
12627 ((org-in-regexp org-bracket-link-regexp 1)
12628 ;; We do have a link at point, and we are going to edit it.
12629 (setq remove (list (match-beginning 0) (match-end 0)))
12630 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12631 (setq link (read-string "Link: "
12632 (org-link-unescape
12633 (org-match-string-no-properties 1)))))
12634 ((or (org-in-regexp org-angle-link-re)
12635 (org-in-regexp org-plain-link-re))
12636 ;; Convert to bracket link
12637 (setq remove (list (match-beginning 0) (match-end 0))
12638 link (read-string "Link: "
12639 (org-remove-angle-brackets (match-string 0)))))
12640 ((equal complete-file '(4))
12641 ;; Completing read for file names.
12642 (setq file (read-file-name "File: "))
12643 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12644 (pwd1 (file-name-as-directory (abbreviate-file-name
12645 (expand-file-name ".")))))
12646 (cond
12647 ((equal complete-file '(16))
12648 (setq link (org-make-link
12649 "file:"
12650 (abbreviate-file-name (expand-file-name file)))))
12652 (setq link (org-make-link "file:" (match-string 1 file))))
12654 (expand-file-name file))
12655 (setq link (org-make-link
12656 "file:" (match-string 1 (expand-file-name file)))))
12657 (t (setq link (org-make-link "file:" file))))))
12658 (t
12659 ;; Read link, with completion for stored links.
12660 (with-output-to-temp-buffer "*Org Links*"
12662 (when org-stored-links
12664 (princ (mapconcat
12665 (lambda (x)
12666 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12668 (let ((cw (selected-window)))
12669 (select-window (get-buffer-window "*Org Links*"))
12670 (shrink-window-if-larger-than-buffer)
12671 (setq truncate-lines t)
12672 (select-window cw))
12673 ;; Fake a link history, containing the stored links.
12674 (setq tmphist (append (mapcar 'car org-stored-links)
12675 org-insert-link-history))
12676 (unwind-protect
12677 (setq link (org-completing-read
12678 "Link: "
12679 (append
12680 (mapcar (lambda (x) (list (concat (car x) ":")))
12681 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12682 (mapcar (lambda (x) (list (concat x ":")))
12683 org-link-types))
12684 nil nil nil
12685 'tmphist
12686 (or (car (car org-stored-links)))))
12687 (set-window-configuration wcf)
12688 (kill-buffer "*Org Links*"))
12689 (setq entry (assoc link org-stored-links))
12690 (or entry (push link org-insert-link-history))
12691 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12692 (not org-keep-stored-link-after-insertion))
12693 (setq org-stored-links (delq (assoc link org-stored-links)
12694 org-stored-links)))
12695 (setq desc (or desc (nth 1 entry)))))
12697 (if (string-match org-plain-link-re link)
12698 ;; URL-like link, normalize the use of angular brackets.
12699 (setq link (org-make-link (org-remove-angle-brackets link))))
12701 ;; Check if we are linking to the current file with a search option
12702 ;; If yes, simplify the link by using only the search option.
12703 (when (and buffer-file-name
12705 (let* ((path (match-string 1 link))
12706 (case-fold-search nil)
12707 (search (match-string 2 link)))
12708 (save-match-data
12709 (if (equal (file-truename buffer-file-name) (file-truename path))
12710 ;; We are linking to this same file, with a search option
12711 (setq link search)))))
12713 ;; Check if we can/should use a relative path. If yes, simplify the link
12715 (let* ((path (match-string 1 link))
12716 (origpath path)
12717 (case-fold-search nil))
12718 (cond
12719 ((eq org-link-file-path-type 'absolute)
12720 (setq path (abbreviate-file-name (expand-file-name path))))
12721 ((eq org-link-file-path-type 'noabbrev)
12722 (setq path (expand-file-name path)))
12723 ((eq org-link-file-path-type 'relative)
12724 (setq path (file-relative-name path)))
12725 (t
12726 (save-match-data
12727 (if (string-match (concat "^" (regexp-quote
12728 (file-name-as-directory
12729 (expand-file-name "."))))
12730 (expand-file-name path))
12731 ;; We are linking a file with relative path name.
12732 (setq path (substring (expand-file-name path)
12733 (match-end 0)))))))
12734 (setq link (concat "file:" path))
12735 (if (equal desc origpath)
12736 (setq desc path))))
12738 (setq desc (read-string "Description: " desc))
12740 (if remove (apply 'delete-region remove))
12741 (insert (org-make-link-string link desc))))
12743 (defun org-completing-read (&rest args)
12744 (let ((minibuffer-local-completion-map
12745 (copy-keymap minibuffer-local-completion-map)))
12746 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12747 (apply 'completing-read args)))
12749 ;;; Opening/following a link
12750 (defvar org-link-search-failed nil)
12752 (defun org-next-link ()
12753 "Move forward to the next link.
12754 If the link is in hidden text, expose it."
12755 (interactive)
12756 (when (and org-link-search-failed (eq this-command last-command))
12757 (goto-char (point-min))
12758 (message "Link search wrapped back to beginning of buffer"))
12759 (setq org-link-search-failed nil)
12760 (let* ((pos (point))
12761 (ct (org-context))
12762 (a (assoc :link ct)))
12763 (if a (goto-char (nth 2 a)))
12764 (if (re-search-forward org-any-link-re nil t)
12765 (progn
12766 (goto-char (match-beginning 0))
12767 (if (org-invisible-p) (org-show-context)))
12768 (goto-char pos)
12769 (setq org-link-search-failed t)
12770 (error "No further link found"))))
12772 (defun org-previous-link ()
12773 "Move backward to the previous link.
12774 If the link is in hidden text, expose it."
12775 (interactive)
12776 (when (and org-link-search-failed (eq this-command last-command))
12777 (goto-char (point-max))
12778 (message "Link search wrapped back to end of buffer"))
12779 (setq org-link-search-failed nil)
12780 (let* ((pos (point))
12781 (ct (org-context))
12782 (a (assoc :link ct)))
12783 (if a (goto-char (nth 1 a)))
12784 (if (re-search-backward org-any-link-re nil t)
12785 (progn
12786 (goto-char (match-beginning 0))
12787 (if (org-invisible-p) (org-show-context)))
12788 (goto-char pos)
12789 (setq org-link-search-failed t)
12790 (error "No further link found"))))
12792 (defun org-find-file-at-mouse (ev)
12793 "Open file link or URL at mouse."
12794 (interactive "e")
12795 (mouse-set-point ev)
12796 (org-open-at-point 'in-emacs))
12798 (defun org-open-at-mouse (ev)
12799 "Open file link or URL at mouse."
12800 (interactive "e")
12801 (mouse-set-point ev)
12802 (org-open-at-point))
12804 (defvar org-window-config-before-follow-link nil
12805 "The window configuration before following a link.
12806 This is saved in case the need arises to restore it.")
12808 (defvar org-open-link-marker (make-marker)
12809 "Marker pointing to the location where `org-open-at-point; was called.")
12811 ;;;###autoload
12812 (defun org-open-at-point-global ()
12813 "Follow a link like Org-mode does.
12814 This command can be called in any mode to follow a link that has
12815 Org-mode syntax."
12816 (interactive)
12817 (org-run-like-in-org-mode 'org-open-at-point))
12819 (defun org-open-at-point (&optional in-emacs)
12820 "Open link at or after point.
12821 If there is no link at point, this function will search forward up to
12822 the end of the current subtree.
12823 Normally, files will be opened by an appropriate application. If the
12824 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12825 (interactive "P")
12826 (move-marker org-open-link-marker (point))
12827 (setq org-window-config-before-follow-link (current-window-configuration))
12828 (org-remove-occur-highlights nil nil t)
12829 (if (org-at-timestamp-p t)
12830 (org-follow-timestamp-link)
12831 (let (type path link line search (pos (point)))
12832 (catch 'match
12833 (save-excursion
12835 (when (org-in-regexp org-bracket-link-regexp)
12836 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12838 (setq link (replace-match " " t t link)))
12839 (setq link (org-link-expand-abbrev link))
12840 (if (string-match org-link-re-with-space2 link)
12841 (setq type (match-string 1 link) path (match-string 2 link))
12842 (setq type "thisfile" path link))
12843 (throw 'match t)))
12845 (when (get-text-property (point) 'org-linked-text)
12846 (setq type "thisfile"
12847 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12848 (1+ (point)) (point))
12849 path (buffer-substring
12850 (previous-single-property-change pos 'org-linked-text)
12851 (next-single-property-change pos 'org-linked-text)))
12852 (throw 'match t))
12854 (save-excursion
12855 (when (or (org-in-regexp org-angle-link-re)
12856 (org-in-regexp org-plain-link-re))
12857 (setq type (match-string 1) path (match-string 2))
12858 (throw 'match t)))
12860 (setq type "tree-match"
12861 path (match-string 1))
12862 (throw 'match t))
12863 (save-excursion
12865 (setq type "tags"
12866 path (match-string 1))
12867 (while (string-match ":" path)
12868 (setq path (replace-match "+" t t path)))
12869 (throw 'match t))))
12870 (unless path
12871 (error "No link found"))
12872 ;; Remove any trailing spaces in path
12874 (setq path (replace-match "" t t path)))
12876 (cond
12878 ((assoc type org-link-protocols)
12879 (funcall (nth 1 (assoc type org-link-protocols)) path))
12881 ((equal type "mailto")
12882 (let ((cmd (car org-link-mailto-program))
12883 (args (cdr org-link-mailto-program)) args1
12884 (address path) (subject "") a)
12886 (setq address (match-string 1 path)
12887 subject (org-link-escape (match-string 2 path))))
12888 (while args
12889 (cond
12890 ((not (stringp (car args))) (push (pop args) args1))
12891 (t (setq a (pop args))
12892 (if (string-match "%a" a)
12893 (setq a (replace-match address t t a)))
12894 (if (string-match "%s" a)
12895 (setq a (replace-match subject t t a)))
12896 (push a args1))))
12897 (apply cmd (nreverse args1))))
12899 ((member type '("http" "https" "ftp" "news"))
12900 (browse-url (concat type ":" (org-link-escape
12901 path org-link-escape-chars-browser))))
12903 ((member type '("message"))
12904 (browse-url (concat type ":" path)))
12906 ((string= type "tags")
12907 (org-tags-view in-emacs path))
12908 ((string= type "thisfile")
12909 (if in-emacs
12910 (switch-to-buffer-other-window
12911 (org-get-buffer-for-internal-link (current-buffer)))
12912 (org-mark-ring-push))
12913 (let ((cmd `(org-link-search
12914 ,path
12915 ,(cond ((equal in-emacs '(4)) 'occur)
12916 ((equal in-emacs '(16)) 'org-occur)
12917 (t nil))
12918 ,pos)))
12919 (condition-case nil (eval cmd)
12920 (error (progn (widen) (eval cmd))))))
12922 ((string= type "tree-match")
12925 ((string= type "file")
12927 (setq line (string-to-number (match-string 1 path))
12928 path (substring path 0 (match-beginning 0)))
12930 (setq search (match-string 1 path)
12931 path (substring path 0 (match-beginning 0)))))
12932 (if (string-match "[*?{]" (file-name-nondirectory path))
12933 (dired path)
12934 (org-open-file path in-emacs line search)))
12936 ((string= type "news")
12937 (org-follow-gnus-link path))
12939 ((string= type "bbdb")
12940 (org-follow-bbdb-link path))
12942 ((string= type "info")
12943 (org-follow-info-link path))
12945 ((string= type "gnus")
12946 (let (group article)
12948 (error "Error in Gnus link"))
12949 (setq group (match-string 1 path)
12950 article (match-string 3 path))
12951 (org-follow-gnus-link group article)))
12953 ((string= type "vm")
12954 (let (folder article)
12956 (error "Error in VM link"))
12957 (setq folder (match-string 1 path)
12958 article (match-string 3 path))
12959 ;; in-emacs is the prefix arg, will be interpreted as read-only
12960 (org-follow-vm-link folder article in-emacs)))
12962 ((string= type "wl")
12963 (let (folder article)
12965 (error "Error in Wanderlust link"))
12966 (setq folder (match-string 1 path)
12967 article (match-string 3 path))
12968 (org-follow-wl-link folder article)))
12970 ((string= type "mhe")
12971 (let (folder article)
12973 (error "Error in MHE link"))
12974 (setq folder (match-string 1 path)
12975 article (match-string 3 path))
12976 (org-follow-mhe-link folder article)))
12978 ((string= type "rmail")
12979 (let (folder article)
12981 (error "Error in RMAIL link"))
12982 (setq folder (match-string 1 path)
12983 article (match-string 3 path))
12984 (org-follow-rmail-link folder article)))
12986 ((string= type "shell")
12987 (let ((cmd path))
12988 (if (or (not org-confirm-shell-link-function)
12989 (funcall org-confirm-shell-link-function
12991 (org-add-props cmd nil
12992 'face 'org-warning))))
12993 (progn
12994 (message "Executing %s" cmd)
12995 (shell-command cmd))
12996 (error "Abort"))))
12998 ((string= type "elisp")
12999 (let ((cmd path))
13000 (if (or (not org-confirm-elisp-link-function)
13001 (funcall org-confirm-elisp-link-function
13003 (org-add-props cmd nil
13004 'face 'org-warning))))
13005 (message "%s => %s" cmd (eval (read cmd)))
13006 (error "Abort"))))
13008 (t
13009 (browse-url-at-point)))))
13010 (move-marker org-open-link-marker nil)
13011 (run-hook-with-args 'org-follow-link-hook))
13013 ;;; File search
13015 (defvar org-create-file-search-functions nil
13016 "List of functions to construct the right search string for a file link.
13017 These functions are called in turn with point at the location to
13018 which the link should point.
13020 A function in the hook should first test if it would like to
13021 handle this file type, for example by checking the major-mode or
13022 the file extension. If it decides not to handle this file, it
13023 should just return nil to give other functions a chance. If it
13024 does handle the file, it must return the search string to be used
13025 when following the link. The search string will be part of the
13026 file link, given after a double colon, and `org-open-at-point'
13027 will automatically search for it. If special measures must be
13028 taken to make the search successful, another function should be
13029 added to the companion hook `org-execute-file-search-functions',
13030 which see.
13032 A function in this hook may also use `setq' to set the variable
13033 `description' to provide a suggestion for the descriptive text to
13034 be used for this link when it gets inserted into an Org-mode
13037 (defvar org-execute-file-search-functions nil
13038 "List of functions to execute a file search triggered by a link.
13040 Functions added to this hook must accept a single argument, the
13041 search string that was part of the file link, the part after the
13042 double colon. The function must first check if it would like to
13043 handle this search, for example by checking the major-mode or the
13044 file extension. If it decides not to handle this search, it
13045 should just return nil to give other functions a chance. If it
13046 does handle the search, it must return a non-nil value to keep
13047 other functions from trying.
13049 Each function can access the current prefix argument through the
13050 variable `current-prefix-argument'. Note that a single prefix is
13051 used to force opening a link in Emacs, so it may be good to only
13052 use a numeric or double prefix to guide the search function.
13054 In case this is needed, a function in this hook can also restore
13055 the window configuration before `org-open-at-point' was called using:
13057 (set-window-configuration org-window-config-before-follow-link)")
13059 (defun org-link-search (s &optional type avoid-pos)
13060 "Search for a link search option.
13061 If S is surrounded by forward slashes, it is interpreted as a
13062 regular expression. In org-mode files, this will create an `org-occur'
13063 sparse tree. In ordinary files, `occur' will be used to list matches.
13064 If the current buffer is in `dired-mode', grep will be used to search
13065 in all files. If AVOID-POS is given, ignore matches near that position."
13066 (let ((case-fold-search t)
13070 org-emphasis-alist)
13072 (pos (point))
13073 (pre "") (post "")
13074 words re0 re1 re2 re3 re4 re5 re2a reall)
13075 (cond
13076 ;; First check if there are any special
13077 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
13078 ;; Now try the builtin stuff
13079 ((save-excursion
13080 (goto-char (point-min))
13081 (and
13082 (re-search-forward
13083 (concat "<<" (regexp-quote s0) ">>") nil t)
13084 (setq pos (match-beginning 0))))
13085 ;; There is an exact target for this
13086 (goto-char pos))
13088 ;; A regular expression
13089 (cond
13090 ((org-mode-p)
13091 (org-occur (match-string 1 s)))
13092 ;;((eq major-mode 'dired-mode)
13093 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
13094 (t (org-do-occur (match-string 1 s)))))
13095 (t
13096 ;; A normal search strings
13097 (when (equal (string-to-char s) ?*)
13098 ;; Anchor on headlines, post may include tags.
13101 s (substring s 1)))
13102 (remove-text-properties
13103 0 (length s)
13104 '(face nil mouse-face nil keymap nil fontified nil) s)
13105 ;; Make a series of regular expressions to find a match
13112 re1 (concat pre re2 post)
13113 re3 (concat pre re4 post)
13114 re5 (concat pre ".*" re4)
13115 re2 (concat pre re2)
13116 re2a (concat pre re2a)
13117 re4 (concat pre re4)
13121 ))
13122 (cond
13123 ((eq type 'org-occur) (org-occur reall))
13124 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
13125 (t (goto-char (point-min))
13126 (if (or (org-search-not-self 1 re0 nil t)
13127 (org-search-not-self 1 re1 nil t)
13128 (org-search-not-self 1 re2 nil t)
13129 (org-search-not-self 1 re2a nil t)
13130 (org-search-not-self 1 re3 nil t)
13131 (org-search-not-self 1 re4 nil t)
13132 (org-search-not-self 1 re5 nil t)
13133 )
13134 (goto-char (match-beginning 1))
13135 (goto-char pos)
13136 (error "No match")))))
13137 (t
13138 ;; Normal string-search
13139 (goto-char (point-min))
13140 (if (search-forward s nil t)
13141 (goto-char (match-beginning 0))
13142 (error "No match"))))
13143 (and (org-mode-p) (org-show-context 'link-search))))
13145 (defun org-search-not-self (group &rest args)
13146 "Execute `re-search-forward', but only accept matches that do not
13147 enclose the position of `org-open-link-marker'."
13148 (let ((m org-open-link-marker))
13149 (catch 'exit
13150 (while (apply 're-search-forward args)
13151 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
13152 (goto-char (match-end group))
13153 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
13154 (> (match-beginning 0) (marker-position m))
13155 (< (match-end 0) (marker-position m)))
13156 (save-match-data
13157 (or (not (org-in-regexp
13158 org-bracket-link-analytic-regexp 1))
13159 (not (match-end 4)) ; no description
13160 (and (<= (match-beginning 4) (point))
13161 (>= (match-end 4) (point))))))
13162 (throw 'exit (point))))))))
13164 (defun org-get-buffer-for-internal-link (buffer)
13165 "Return a buffer to be used for displaying the link target of internal links."
13166 (cond
13167 ((not org-display-internal-link-with-indirect-buffer)
13168 buffer)
13169 ((string-match "(Clone)$" (buffer-name buffer))
13170 (message "Buffer is already a clone, not making another one")
13171 ;; we also do not modify visibility in this case
13172 buffer)
13173 (t ; make a new indirect buffer for displaying the link
13174 (let* ((bn (buffer-name buffer))
13175 (ibn (concat bn "(Clone)"))
13176 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13177 (with-current-buffer ib (org-overview))
13178 ib))))
13180 (defun org-do-occur (regexp &optional cleanup)
13181 "Call the Emacs command `occur'.
13182 If CLEANUP is non-nil, remove the printout of the regular expression
13183 in the *Occur* buffer. This is useful if the regex is long and not useful
13184 to read."
13185 (occur regexp)
13186 (when cleanup
13187 (let ((cwin (selected-window)) win beg end)
13188 (when (setq win (get-buffer-window "*Occur*"))
13189 (select-window win))
13190 (goto-char (point-min))
13191 (when (re-search-forward "match[a-z]+" nil t)
13192 (setq beg (match-end 0))
13194 (setq end (1- (match-beginning 0)))))
13195 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13196 (goto-char (point-min))
13197 (select-window cwin))))
13199 ;;; The mark ring for links jumps
13201 (defvar org-mark-ring nil
13202 "Mark ring for positions before jumps in Org-mode.")
13203 (defvar org-mark-ring-last-goto nil
13204 "Last position in the mark ring used to go back.")
13205 ;; Fill and close the ring
13206 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13207 (loop for i from 1 to org-mark-ring-length do
13208 (push (make-marker) org-mark-ring))
13209 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13210 org-mark-ring)
13212 (defun org-mark-ring-push (&optional pos buffer)
13213 "Put the current position or POS into the mark ring and rotate it."
13214 (interactive)
13215 (setq pos (or pos (point)))
13216 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13217 (move-marker (car org-mark-ring)
13218 (or pos (point))
13219 (or buffer (current-buffer)))
13220 (message "%s"
13221 (substitute-command-keys
13224 (defun org-mark-ring-goto (&optional n)
13225 "Jump to the previous position in the mark ring.
13226 With prefix arg N, jump back that many stored positions. When
13227 called several times in succession, walk through the entire ring.
13228 Org-mode commands jumping to a different position in the current file,
13229 or to another Org-mode file, automatically push the old position
13230 onto the ring."
13231 (interactive "p")
13232 (let (p m)
13233 (if (eq last-command this-command)
13234 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13235 (setq p org-mark-ring))
13236 (setq org-mark-ring-last-goto p)
13237 (setq m (car p))
13238 (switch-to-buffer (marker-buffer m))
13239 (goto-char m)
13240 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13242 (defun org-remove-angle-brackets (s)
13243 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13244 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13245 s)
13246 (defun org-add-angle-brackets (s)
13247 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13248 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13249 s)
13251 ;;; Following specific links
13253 (defun org-follow-timestamp-link ()
13254 (cond
13255 ((org-at-date-range-p t)
13256 (let ((org-agenda-start-on-weekday)
13257 (t1 (match-string 1))
13258 (t2 (match-string 2)))
13259 (setq t1 (time-to-days (org-time-string-to-time t1))
13260 t2 (time-to-days (org-time-string-to-time t2)))
13261 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13262 ((org-at-timestamp-p t)
13263 (org-agenda-list nil (time-to-days (org-time-string-to-time
13264 (substring (match-string 1) 0 10)))
13265 1))
13266 (t (error "This should not happen"))))
13269 (defun org-follow-bbdb-link (name)
13270 "Follow a BBDB link to NAME."
13271 (require 'bbdb)
13272 (let ((inhibit-redisplay (not debug-on-error))
13273 (bbdb-electric-p nil))
13274 (catch 'exit
13275 ;; Exact match on name
13277 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13278 ;; Exact match on name
13280 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13281 ;; Partial match on name
13282 (bbdb-name name nil)
13283 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13284 ;; Partial match on company
13285 (bbdb-company name nil)
13286 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13287 ;; General match including network address and notes
13288 (bbdb name nil)
13289 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13290 (delete-window (get-buffer-window "*BBDB*"))
13291 (error "No matching BBDB record")))))
13293 (defun org-follow-info-link (name)
13294 "Follow an info file & node link to NAME."
13297 (progn
13298 (require 'info)
13299 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13300 (Info-find-node (match-string 1 name) (match-string 2 name))
13301 (Info-find-node (match-string 1 name) "Top")))
13302 (message "Could not open: %s" name)))
13304 (defun org-follow-gnus-link (&optional group article)
13305 "Follow a Gnus link to GROUP and ARTICLE."
13306 (require 'gnus)
13307 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13308 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13309 (cond ((and group article)
13310 (gnus-group-read-group 1 nil group)
13311 (gnus-summary-goto-article (string-to-number article) nil t))
13312 (group (gnus-group-jump-to-group group))))
13314 (defun org-follow-vm-link (&optional folder article readonly)
13315 "Follow a VM link to FOLDER and ARTICLE."
13316 (require 'vm)
13317 (setq article (org-add-angle-brackets article))
13319 ;; ange-ftp or efs or tramp access
13320 (let ((user (or (match-string 1 folder) (user-login-name)))
13321 (host (match-string 2 folder))
13322 (file (match-string 3 folder)))
13323 (cond
13324 ((featurep 'tramp)
13325 ;; use tramp to access the file
13326 (if (featurep 'xemacs)
13327 (setq folder (format "[%s@%s]%s" user host file))
13328 (setq folder (format "/%s@%s:%s" user host file))))
13329 (t
13330 ;; use ange-ftp or efs
13331 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13332 (setq folder (format "/%s@%s:%s" user host file))))))
13333 (when folder
13334 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13335 (sit-for 0.1)
13336 (when article
13337 (vm-select-folder-buffer)
13338 (widen)
13339 (let ((case-fold-search t))
13340 (goto-char (point-min))
13341 (if (not (re-search-forward
13342 (concat "^" "message-id: *" (regexp-quote article))))
13343 (error "Could not find the specified message in this folder"))
13344 (vm-isearch-update)
13345 (vm-isearch-narrow)
13346 (vm-beginning-of-message)
13347 (vm-summarize)))))
13349 (defun org-follow-wl-link (folder article)
13350 "Follow a Wanderlust link to FOLDER and ARTICLE."
13351 (if (and (string= folder "%")
13352 article
13354 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13355 ;; Thus, we recompose folder and article ids.
13356 (setq folder (format "%s#%s" folder (match-string 1 article))
13357 article (match-string 3 article)))
13358 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13359 (error "No such folder: %s" folder))
13360 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13361 (and article
13362 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13363 (wl-summary-redisplay)))
13365 (defun org-follow-rmail-link (folder article)
13366 "Follow an RMAIL link to FOLDER and ARTICLE."
13367 (setq article (org-add-angle-brackets article))
13368 (let (message-number)
13369 (save-excursion
13370 (save-window-excursion
13371 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13372 (setq message-number
13373 (save-restriction
13374 (widen)
13375 (goto-char (point-max))
13376 (if (re-search-backward
13378 (or article "")))
13379 nil t)
13380 (rmail-what-message))))))
13381 (if message-number
13382 (progn
13383 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13384 (rmail-show-message message-number)
13385 message-number)
13386 (error "Message not found"))))
13388 ;;; mh-e integration based on planner-mode
13389 (defun org-mhe-get-message-real-folder ()
13390 "Return the name of the current message real folder, so if you use
13391 sequences, it will now work."
13392 (save-excursion
13393 (let* ((folder
13394 (if (equal major-mode 'mh-folder-mode)
13395 mh-current-folder
13396 ;; Refer to the show buffer
13397 mh-show-folder-buffer))
13398 (end-index
13399 (if (boundp 'mh-index-folder)
13400 (min (length mh-index-folder) (length folder))))
13401 )
13402 ;; a simple test on mh-index-data does not work, because
13403 ;; mh-index-data is always nil in a show buffer.
13404 (if (and (boundp 'mh-index-folder)
13405 (string= mh-index-folder (substring folder 0 end-index)))
13406 (if (equal major-mode 'mh-show-mode)
13407 (save-window-excursion
13408 (let (pop-up-frames)
13409 (when (buffer-live-p (get-buffer folder))
13410 (progn
13411 (pop-to-buffer folder)
13412 (org-mhe-get-message-folder-from-index)
13413 )
13414 )))
13415 (org-mhe-get-message-folder-from-index)
13416 )
13417 folder
13418 )
13419 )))
13421 (defun org-mhe-get-message-folder-from-index ()
13422 "Returns the name of the message folder in a index folder buffer."
13423 (save-excursion
13424 (mh-index-previous-folder)
13426 (message "%s" (match-string 1))))
13428 (defun org-mhe-get-message-folder ()
13429 "Return the name of the current message folder. Be careful if you
13430 use sequences."
13431 (save-excursion
13432 (if (equal major-mode 'mh-folder-mode)
13433 mh-current-folder
13434 ;; Refer to the show buffer
13435 mh-show-folder-buffer)))
13437 (defun org-mhe-get-message-num ()
13438 "Return the number of the current message. Be careful if you
13439 use sequences."
13440 (save-excursion
13441 (if (equal major-mode 'mh-folder-mode)
13442 (mh-get-msg-num nil)
13443 ;; Refer to the show buffer
13444 (mh-show-buffer-message-number))))
13446 (defun org-mhe-get-header (header)
13447 "Return a header of the message in folder mode. This will create a
13448 show buffer for the corresponding message. If you have a more clever
13449 idea..."
13450 (let* ((folder (org-mhe-get-message-folder))
13451 (num (org-mhe-get-message-num))
13452 (buffer (get-buffer-create (concat "show-" folder)))
13453 (header-field))
13454 (with-current-buffer buffer
13455 (mh-display-msg num folder)
13456 (if (equal major-mode 'mh-folder-mode)
13457 (mh-header-display)
13458 (mh-show-header-display))
13459 (set-buffer buffer)
13460 (setq header-field (mh-get-header-field header))
13461 (if (equal major-mode 'mh-folder-mode)
13462 (mh-show)
13463 (mh-show-show))
13464 header-field)))
13466 (defun org-follow-mhe-link (folder article)
13467 "Follow an MHE link to FOLDER and ARTICLE.
13468 If ARTICLE is nil FOLDER is shown. If the configuration variable
13469 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13470 ARTICLE is searched in all folders. Indexed searches (swish++,
13471 namazu, and others supported by MH-E) will always search in all
13472 folders."
13473 (require 'mh-e)
13474 (require 'mh-search)
13475 (require 'mh-utils)
13476 (mh-find-path)
13477 (if (not article)
13478 (mh-visit-folder (mh-normalize-folder-name folder))
13479 (setq article (org-add-angle-brackets article))
13480 (mh-search-choose)
13481 (if (equal mh-searcher 'pick)
13482 (progn
13483 (mh-search folder (list "--message-id" article))
13484 (when (and org-mhe-search-all-folders
13485 (not (org-mhe-get-message-real-folder)))
13486 (kill-this-buffer)
13487 (mh-search "+" (list "--message-id" article))))
13488 (mh-search "+" article))
13489 (if (org-mhe-get-message-real-folder)
13490 (mh-show-msg 1)
13491 (kill-this-buffer)
13492 (error "Message not found"))))
13494 ;;; BibTeX links
13496 ;; Use the custom search meachnism to construct and use search strings for
13497 ;; file links to BibTeX database entries.
13499 (defun org-create-file-search-in-bibtex ()
13500 "Create the search string and description for a BibTeX database entry."
13501 (when (eq major-mode 'bibtex-mode)
13502 ;; yes, we want to construct this search string.
13503 ;; Make a good description for this entry, using names, year and the title
13504 ;; Put it into the `description' variable which is dynamically scoped.
13505 (let ((bibtex-autokey-names 1)
13506 (bibtex-autokey-names-stretch 1)
13507 (bibtex-autokey-name-case-convert-function 'identity)
13508 (bibtex-autokey-name-separator " & ")
13509 (bibtex-autokey-additional-names " et al.")
13510 (bibtex-autokey-year-length 4)
13511 (bibtex-autokey-name-year-separator " ")
13512 (bibtex-autokey-titlewords 3)
13513 (bibtex-autokey-titleword-separator " ")
13514 (bibtex-autokey-titleword-case-convert-function 'identity)
13515 (bibtex-autokey-titleword-length 'infty)
13516 (bibtex-autokey-year-title-separator ": "))
13517 (setq description (bibtex-generate-autokey)))
13518 ;; Now parse the entry, get the key and return it.
13519 (save-excursion
13520 (bibtex-beginning-of-entry)
13521 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13523 (defun org-execute-file-search-in-bibtex (s)
13524 "Find the link search string S as a key for a database entry."
13525 (when (eq major-mode 'bibtex-mode)
13526 ;; Yes, we want to do the search in this file.
13527 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13528 (goto-char (point-min))
13531 (goto-char (match-beginning 0)))
13532 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13533 ;; Use double prefix to indicate that any web link should be browsed
13534 (let ((b (current-buffer)) (p (point)))
13535 ;; Restore the window configuration because we just use the web link
13536 (set-window-configuration org-window-config-before-follow-link)
13537 (save-excursion (set-buffer b) (goto-char p)
13538 (bibtex-url)))
13539 (recenter 0)) ; Move entry start to beginning of window
13540 ;; return t to indicate that the search is done.
13541 t))
13543 ;; Finally add the functions to the right hooks.
13544 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13545 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13547 ;; end of Bibtex link setup
13549 ;;; Following file links
13551 (defun org-open-file (path &optional in-emacs line search)
13552 "Open the file at PATH.
13553 First, this expands any special file name abbreviations. Then the
13554 configuration variable `org-file-apps' is checked if it contains an
13555 entry for this file type, and if yes, the corresponding command is launched.
13556 If no application is found, Emacs simply visits the file.
13557 With optional argument IN-EMACS, Emacs will visit the file.
13558 Optional LINE specifies a line to go to, optional SEARCH a string to
13559 search for. If LINE or SEARCH is given, the file will always be
13560 opened in Emacs.
13561 If the file does not exist, an error is thrown."
13562 (setq in-emacs (or in-emacs line search))
13563 (let* ((file (if (equal path "")
13564 buffer-file-name
13565 (substitute-in-file-name (expand-file-name path))))
13566 (apps (append org-file-apps (org-default-apps)))
13567 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13568 (dirp (if remp nil (file-directory-p file)))
13569 (dfile (downcase file))
13570 (old-buffer (current-buffer))
13571 (old-pos (point))
13572 (old-mode major-mode)
13573 ext cmd)
13575 (setq ext (match-string 1 dfile))
13577 (setq ext (match-string 1 dfile))))
13578 (if in-emacs
13579 (setq cmd 'emacs)
13580 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13581 (and dirp (cdr (assoc 'directory apps)))
13582 (cdr (assoc ext apps))
13583 (cdr (assoc t apps)))))
13584 (when (eq cmd 'mailcap)
13585 (require 'mailcap)
13586 (mailcap-parse-mailcaps)
13587 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13588 (command (mailcap-mime-info mime-type)))
13589 (if (stringp command)
13590 (setq cmd command)
13591 (setq cmd 'emacs))))
13592 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13593 (not (file-exists-p file))
13594 (not org-open-non-existing-files))
13595 (error "No such file: %s" file))
13596 (cond
13598 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13600 (setq cmd (replace-match "%s" t t cmd)))
13601 (while (string-match "%s" cmd)
13602 (setq cmd (replace-match
13603 (save-match-data (shell-quote-argument file))
13604 t t cmd)))
13605 (save-window-excursion
13606 (start-process-shell-command cmd nil cmd)))
13607 ((or (stringp cmd)
13608 (eq cmd 'emacs))
13609 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13610 (widen)
13611 (if line (goto-line line)
13612 (if search (org-link-search search))))
13613 ((consp cmd)
13614 (eval cmd))
13615 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13616 (and (org-mode-p) (eq old-mode 'org-mode)
13617 (or (not (equal old-buffer (current-buffer)))
13618 (not (equal old-pos (point))))
13619 (org-mark-ring-push old-pos old-buffer))))
13621 (defun org-default-apps ()
13622 "Return the default applications for this operating system."
13623 (cond
13624 ((eq system-type 'darwin)
13625 org-file-apps-defaults-macosx)
13626 ((eq system-type 'windows-nt)
13627 org-file-apps-defaults-windowsnt)
13628 (t org-file-apps-defaults-gnu)))
13630 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13631 (defun org-file-remote-p (file)
13632 "Test whether FILE specifies a location on a remote system.
13633 Return non-nil if the location is indeed remote.
13637 (cond ((fboundp 'file-remote-p)
13638 (file-remote-p file))
13639 ((fboundp 'tramp-handle-file-remote-p)
13640 (tramp-handle-file-remote-p file))
13641 ((and (boundp 'ange-ftp-name-format)
13642 (string-match (car ange-ftp-name-format) file))
13643 t)
13644 (t nil)))
13647 ;;;; Hooks for remember.el, and refiling
13649 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13650 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13652 ;;;###autoload
13653 (defun org-remember-insinuate ()
13654 "Setup remember.el for use wiht Org-mode."
13655 (require 'remember)
13656 (setq remember-annotation-functions '(org-remember-annotation))
13657 (setq remember-handler-functions '(org-remember-handler))
13658 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13660 ;;;###autoload
13661 (defun org-remember-annotation ()
13662 "Return a link to the current location as an annotation for remember.el.
13663 If you are using Org-mode files as target for data storage with
13664 remember.el, then the annotations should include a link compatible with the
13665 conventions in Org-mode. This function returns such a link."
13666 (org-store-link nil))
13668 (defconst org-remember-help
13669 "Select a destination location for the note.
13670 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13671 RET on headline -> Store as sublevel entry to current headline
13672 RET at beg-of-buf -> Append to file as level 2 headline
13673 <left>/<right> -> before/after current headline, same headings level")
13675 (defvar org-remember-previous-location nil)
13676 (defvar org-force-remember-template-char) ;; dynamically scoped
13678 ;; Save the major mode of the buffer we called remember from
13679 (defvar org-select-template-temp-major-mode nil)
13681 ;; Temporary store the buffer where remember was called from
13682 (defvar org-select-template-original-buffer nil)
13684 (defun org-select-remember-template (&optional use-char)
13685 (when org-remember-templates
13686 (let* ((pre-selected-templates
13687 (mapcar
13688 (lambda (tpl)
13689 (let ((ctxt (nth 5 tpl))
13690 (mode org-select-template-temp-major-mode)
13691 (buf org-select-template-original-buffer))
13692 (if (or (and (functionp ctxt)
13693 (save-excursion
13694 (set-buffer buf)
13695 ;; Protect the user-defined function from error
13696 (condition-case nil (funcall ctxt) (error nil))))
13697 (and ctxt (listp ctxt)
13698 (delq nil (mapcar (lambda(x) (eq mode x)) ctxt))))
13699 tpl)))
13700 org-remember-templates))
13701 ;; If no template at this point, add the default templates:
13702 (pre-selected-templates1
13703 (if (not (delq nil pre-selected-templates))
13704 (mapcar (lambda(x) (if (not (nth 5 x)) x))
13705 org-remember-templates)
13706 pre-selected-templates))
13707 ;; Then unconditionnally add template for any contexts
13708 (pre-selected-templates2
13709 (append (mapcar (lambda(x) (if (eq (nth 5 x) t) x))
13710 org-remember-templates)
13711 (delq nil pre-selected-templates1)))
13712 (templates (mapcar (lambda (x)
13713 (if (stringp (car x))
13714 (append (list (nth 1 x) (car x)) (cddr x))
13715 (append (list (car x) "") (cdr x))))
13716 (delq nil pre-selected-templates2)))
13717 (char (or use-char
13718 (cond
13719 ((= (length templates) 1)
13720 (caar templates))
13721 ((and (boundp 'org-force-remember-template-char)
13722 org-force-remember-template-char)
13723 (if (stringp org-force-remember-template-char)
13724 (string-to-char org-force-remember-template-char)
13725 org-force-remember-template-char))
13726 (t
13727 (message "Select template: %s"
13728 (mapconcat
13729 (lambda (x)
13730 (cond
13732 (format "[%c]" (car x)))
13733 ((equal (downcase (car x))
13734 (downcase (aref (nth 1 x) 0)))
13735 (format "[%c]%s" (car x)
13736 (substring (nth 1 x) 1)))
13737 (t (format "[%c]%s" (car x) (nth 1 x)))))
13738 templates " "))
13739 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13740 (when (equal char0 ?\C-g)
13741 (jump-to-register remember-register)
13742 (kill-buffer remember-buffer))
13743 char0))))))
13744 (cddr (assoc char templates)))))
13746 (defvar x-last-selected-text)
13747 (defvar x-last-selected-text-primary)
13749 ;;;###autoload
13750 (defun org-remember-apply-template (&optional use-char skip-interactive)
13751 "Initialize *remember* buffer with template, invoke `org-mode'.
13752 This function should be placed into `remember-mode-hook' and in fact requires
13753 to be run from that hook to function properly."
13754 (if org-remember-templates
13755 (let* ((entry (org-select-remember-template use-char))
13756 (tpl (car entry))
13757 (plist-p (if org-store-link-plist t nil))
13758 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13760 (nth 1 entry)
13761 org-default-notes-file))
13762 (headline (nth 2 entry))
13763 (v-c (or (and (eq window-system 'x)
13764 (fboundp 'x-cut-buffer-or-selection-value)
13765 (x-cut-buffer-or-selection-value))
13766 (org-bound-and-true-p x-last-selected-text)
13767 (org-bound-and-true-p x-last-selected-text-primary)
13768 (and (> (length kill-ring) 0) (current-kill 0))))
13769 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13770 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13771 (v-u (concat "[" (substring v-t 1 -1) "]"))
13772 (v-U (concat "[" (substring v-T 1 -1) "]"))
13773 ;; `initial' and `annotation' are bound in `remember'
13774 (v-i (if (boundp 'initial) initial))
13775 (v-a (if (and (boundp 'annotation) annotation)
13776 (if (equal annotation "[[]]") "" annotation)
13777 ""))
13778 (v-A (if (and v-a
13781 v-a))
13782 (v-n user-full-name)
13783 (org-startup-folded nil)
13784 org-time-was-given org-end-time-was-given x
13785 prompt completions char time pos default histvar)
13786 (setq org-store-link-plist
13787 (append (list :annotation v-a :initial v-i)
13788 org-store-link-plist))
13789 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13790 (erase-buffer)
13791 (insert (substitute-command-keys
13792 (format
13793 "## Filing location: Select interactively, default, or last used:
13794 ## %s to select file and header location interactively.
13798 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13799 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13800 (abbreviate-file-name (or file org-default-notes-file))
13801 (or headline "")
13802 (or (car org-remember-previous-location) "???")
13803 (or (cdr org-remember-previous-location) "???"))))
13804 (insert tpl) (goto-char (point-min))
13805 ;; Simple %-escapes
13807 (when (and initial (equal (match-string 0) "%i"))
13808 (save-match-data
13809 (let* ((lead (buffer-substring
13810 (point-at-bol) (match-beginning 0))))
13811 (setq v-i (mapconcat 'identity
13814 (replace-match
13815 (or (eval (intern (concat "v-" (match-string 1)))) "")
13816 t t))
13818 ;; %[] Insert contents of a file.
13819 (goto-char (point-min))
13821 (let ((start (match-beginning 0))
13822 (end (match-end 0))
13823 (filename (expand-file-name (match-string 1))))
13824 (goto-char start)
13825 (delete-region start end)
13826 (condition-case error
13827 (insert-file-contents filename)
13828 (error (insert (format "%%![Couldn't insert %s: %s]"
13829 filename error))))))
13830 ;; %() embedded elisp
13831 (goto-char (point-min))
13833 (goto-char (match-beginning 0))
13834 (let ((template-start (point)))
13835 (forward-char 1)
13836 (let ((result
13837 (condition-case error
13838 (eval (read (current-buffer)))
13839 (error (format "%%![Error: %s]" error)))))
13840 (delete-region template-start (point))
13841 (insert result))))
13843 ;; From the property list
13844 (when plist-p
13845 (goto-char (point-min))
13847 (and (setq x (or (plist-get org-store-link-plist
13848 (intern (match-string 1))) ""))
13849 (replace-match x t t))))
13851 ;; Turn on org-mode in the remember buffer, set local variables
13852 (org-mode)
13853 (org-set-local 'org-finish-function 'org-remember-finalize)
13855 (org-set-local 'org-default-notes-file file))
13857 (org-set-local 'org-remember-default-headline headline))
13858 ;; Interactive template entries
13859 (goto-char (point-min))
13861 (setq char (if (match-end 3) (match-string 3))
13862 prompt (if (match-end 2) (match-string 2)))
13863 (goto-char (match-beginning 0))
13864 (replace-match "")
13865 (setq completions nil default nil)
13866 (when prompt
13867 (setq completions (org-split-string prompt "|")
13868 prompt (pop completions)
13869 default (car completions)
13870 histvar (intern (concat
13871 "org-remember-template-prompt-history::"
13872 (or prompt "")))
13873 completions (mapcar 'list completions)))
13874 (cond
13875 ((member char '("G" "g"))
13876 (let* ((org-last-tags-completion-table
13877 (org-global-tags-completion-table
13878 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13879 (org-add-colon-after-tag-completion t)
13880 (ins (completing-read
13881 (if prompt (concat prompt ": ") "Tags: ")
13882 'org-tags-completion-function nil nil nil
13883 'org-tags-history)))
13884 (setq ins (mapconcat 'identity
13885 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13886 ":"))
13888 (or (equal (char-before) ?:) (insert ":"))
13889 (insert ins)
13890 (or (equal (char-after) ?:) (insert ":")))))
13891 (char
13892 (setq org-time-was-given (equal (upcase char) char))
13893 (setq time (org-read-date (equal (upcase char) "U") t nil
13894 prompt))
13895 (org-insert-time-stamp time org-time-was-given
13896 (member char '("u" "U"))
13897 nil nil (list org-end-time-was-given)))
13898 (t
13899 (insert (org-completing-read
13900 (concat (if prompt prompt "Enter string")
13901 (if default (concat " [" default "]"))
13902 ": ")
13903 completions nil nil nil histvar default)))))
13904 (goto-char (point-min))
13906 (replace-match "")
13908 (org-mode)
13909 (org-set-local 'org-finish-function 'org-remember-finalize))
13910 (when (save-excursion
13911 (goto-char (point-min))
13912 (re-search-forward "%!" nil t))
13913 (replace-match "")
13914 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13916 (defun org-remember-finish-immediately ()
13917 "File remember note immediately.
13918 This should be run in `post-command-hook' and will remove itself
13919 from that hook."
13920 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13921 (when org-finish-function
13922 (funcall org-finish-function)))
13924 (defvar org-clock-marker) ; Defined below
13925 (defun org-remember-finalize ()
13926 "Finalize the remember process."
13927 (unless (fboundp 'remember-finalize)
13928 (defalias 'remember-finalize 'remember-buffer))
13929 (when (and org-clock-marker
13930 (equal (marker-buffer org-clock-marker) (current-buffer)))
13931 ;; FIXME: test this, this is w/o notetaking!
13932 (let (org-log-note-clock-out) (org-clock-out)))
13933 (when buffer-file-name
13934 (save-buffer)
13935 (setq buffer-file-name nil))
13936 (remember-finalize))
13938 ;;;###autoload
13939 (defun org-remember (&optional goto org-force-remember-template-char)
13940 "Call `remember'. If this is already a remember buffer, re-apply template.
13941 If there is an active region, make sure remember uses it as initial content
13942 of the remember buffer.
13944 When called interactively with a `C-u' prefix argument GOTO, don't remember
13945 anything, just go to the file/headline where the selected template usually
13946 stores its notes. With a double prefix arg `C-u C-u', go to the last
13947 note stored by remember.
13949 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13950 associated with a template in `org-remember-templates'."
13951 (interactive "P")
13952 (cond
13953 ((equal goto '(4)) (org-go-to-remember-target))
13954 ((equal goto '(16)) (org-remember-goto-last-stored))
13955 (t
13956 ;; set temporary variables that will be needed in
13957 ;; `org-select-remember-template'
13958 (setq org-select-template-temp-major-mode major-mode)
13959 (setq org-select-template-original-buffer (current-buffer))
13960 (if (memq org-finish-function '(remember-buffer remember-finalize))
13961 (progn
13962 (when (< (length org-remember-templates) 2)
13963 (error "No other template available"))
13964 (erase-buffer)
13965 (let ((annotation (plist-get org-store-link-plist :annotation))
13966 (initial (plist-get org-store-link-plist :initial)))
13967 (org-remember-apply-template))
13968 (message "Press C-c C-c to remember data"))
13969 (if (org-region-active-p)
13970 (remember (buffer-substring (point) (mark)))
13971 (call-interactively 'remember))))))
13973 (defun org-remember-goto-last-stored ()
13974 "Go to the location where the last remember note was stored."
13975 (interactive)
13976 (bookmark-jump "org-remember-last-stored")
13977 (message "This is the last note stored by remember"))
13979 (defun org-go-to-remember-target (&optional template-key)
13980 "Go to the target location of a remember template.
13981 The user is queried for the template."
13982 (interactive)
13983 (let* (org-select-template-temp-major-mode
13984 (entry (org-select-remember-template template-key))
13985 (file (nth 1 entry))
13986 (heading (nth 2 entry))
13987 visiting)
13989 (setq file org-default-notes-file))
13991 (setq heading org-remember-default-headline))
13992 (setq visiting (org-find-base-buffer-visiting file))
13993 (if (not visiting) (find-file-noselect file))
13994 (switch-to-buffer (or visiting (get-file-buffer file)))
13995 (widen)
13996 (goto-char (point-min))
13997 (if (re-search-forward
14000 nil t)
14001 (goto-char (match-beginning 0))
14002 (error "Target headline not found: %s" heading))))
14004 (defvar org-note-abort nil) ; dynamically scoped
14006 ;;;###autoload
14007 (defun org-remember-handler ()
14008 "Store stuff from remember.el into an org file.
14009 First prompts for an org file. If the user just presses return, the value
14010 of `org-default-notes-file' is used.
14011 Then the command offers the headings tree of the selected file in order to
14012 file the text at a specific location.
14013 You can either immediately press RET to get the note appended to the
14014 file, or you can use vertical cursor motion and visibility cycling (TAB) to
14015 find a better place. Then press RET or <left> or <right> in insert the note.
14017 Key Cursor position Note gets inserted
14018 -----------------------------------------------------------------------------
14019 RET buffer-start as level 1 heading at end of file
14020 RET on headline as sublevel of the heading at cursor
14021 RET no heading at cursor position, level taken from context.
14022 Or use prefix arg to specify level manually.
14023 <left> on headline as same level, before current heading
14024 <right> on headline as same level, after current heading
14026 So the fastest way to store the note is to press RET RET to append it to
14027 the default file. This way your current train of thought is not
14028 interrupted, in accordance with the principles of remember.el.
14029 You can also get the fast execution without prompting by using
14030 C-u C-c C-c to exit the remember buffer. See also the variable
14031 `org-remember-store-without-prompt'.
14033 Before being stored away, the function ensures that the text has a
14035 is constructed from the current date and some additional data.
14037 If the variable `org-adapt-indentation' is non-nil, the entire text is
14038 also indented so that it starts in the same column as the headline
14039 \(i.e. after the stars).
14041 See also the variable `org-reverse-note-order'."
14042 (goto-char (point-min))
14044 (replace-match ""))
14045 (goto-char (point-max))
14046 (beginning-of-line 1)
14048 (delete-region (1- (point)) (point-max))
14049 (beginning-of-line 1))
14050 (catch 'quit
14051 (if org-note-abort (throw 'quit nil))
14052 (let* ((txt (buffer-substring (point-min) (point-max)))
14053 (fastp (org-xor (equal current-prefix-arg '(4))
14054 org-remember-store-without-prompt))
14055 (file (cond
14056 (fastp org-default-notes-file)
14057 ((and (eq org-remember-interactive-interface 'refile)
14058 org-refile-targets)
14059 org-default-notes-file)
14060 ((not (and (equal current-prefix-arg '(16))
14061 org-remember-previous-location))
14062 (org-get-org-file))))
14063 (heading org-remember-default-headline)
14064 (visiting (and file (org-find-base-buffer-visiting file)))
14065 (org-startup-folded nil)
14066 (org-startup-align-all-tables nil)
14067 (org-goto-start-pos 1)
14068 spos exitcmd level indent reversed)
14069 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
14070 (setq file (car org-remember-previous-location)
14071 heading (cdr org-remember-previous-location)
14072 fastp t))
14073 (setq current-prefix-arg nil)
14075 (setq txt (replace-match "" t t txt)))
14076 ;; Modify text so that it becomes a nice subtree which can be inserted
14077 ;; into an org tree.
14079 first)
14080 (setq first (car lines) lines (cdr lines))
14082 ;; Is already a headline
14083 (setq indent nil)
14084 ;; We need to add a headline: Use time and first buffer line
14085 (setq lines (cons first lines)
14086 first (concat "* " (current-time-string)
14087 " (" (remember-buffer-desc) ")")
14088 indent " "))
14089 (if (and org-adapt-indentation indent)
14090 (setq lines (mapcar
14091 (lambda (x)
14093 (concat indent x) x))
14094 lines)))
14101 ;; Put the modified text back into the remember buffer, for refile.
14102 (erase-buffer)
14103 (insert txt)
14104 (goto-char (point-min))
14105 (when (and (eq org-remember-interactive-interface 'refile)
14106 (not fastp))
14107 (org-refile nil (or visiting (find-file-noselect file)))
14108 (throw 'quit t))
14109 ;; Find the file
14110 (if (not visiting) (find-file-noselect file))
14111 (with-current-buffer (or visiting (get-file-buffer file))
14112 (unless (org-mode-p)
14113 (error "Target files for remember notes must be in Org-mode"))
14114 (save-excursion
14115 (save-restriction
14116 (widen)
14117 (and (goto-char (point-min))
14120 (setq reversed (org-notes-order-reversed-p))
14122 ;; Find the default location
14124 (goto-char (point-min))
14125 (if (re-search-forward
14128 nil t)
14129 (setq org-goto-start-pos (match-beginning 0))
14130 (when fastp
14131 (goto-char (point-max))
14132 (unless (bolp) (newline))
14134 (setq org-goto-start-pos (point-at-bol 0)))))
14136 ;; Ask the User for a location, using the appropriate interface
14137 (cond
14138 (fastp (setq spos org-goto-start-pos
14139 exitcmd 'return))
14140 ((eq org-remember-interactive-interface 'outline)
14141 (setq spos (org-get-location (current-buffer)
14142 org-remember-help)
14143 exitcmd (cdr spos)
14144 spos (car spos)))
14145 ((eq org-remember-interactive-interface 'outline-path-completion)
14146 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
14147 (org-refile-use-outline-path t))
14148 (setq spos (org-refile-get-location "Heading: ")
14149 exitcmd 'return
14150 spos (nth 3 spos))))
14151 (t (error "this should not hapen")))
14152 (if (not spos) (throw 'quit nil)) ; return nil to show we did
14153 ; not handle this note
14154 (goto-char spos)
14155 (cond ((org-on-heading-p t)
14156 (org-back-to-heading t)
14157 (setq level (funcall outline-level))
14158 (cond
14159 ((eq exitcmd 'return)
14160 ;; sublevel of current
14161 (setq org-remember-previous-location
14162 (cons (abbreviate-file-name file)
14163 (org-get-heading 'notags)))
14164 (if reversed
14165 (outline-next-heading)
14166 (org-end-of-subtree t)
14167 (if (not (bolp))
14169 (beginning-of-line 2)
14170 (end-of-line 1)
14172 (bookmark-set "org-remember-last-stored")
14173 (org-paste-subtree (org-get-valid-level level 1) txt))
14174 ((eq exitcmd 'left)
14175 ;; before current
14176 (bookmark-set "org-remember-last-stored")
14177 (org-paste-subtree level txt))
14178 ((eq exitcmd 'right)
14179 ;; after current
14180 (org-end-of-subtree t)
14181 (bookmark-set "org-remember-last-stored")
14182 (org-paste-subtree level txt))
14183 (t (error "This should not happen"))))
14185 ((and (bobp) (not reversed))
14186 ;; Put it at the end, one level below level 1
14187 (save-restriction
14188 (widen)
14189 (goto-char (point-max))
14190 (if (not (bolp)) (newline))
14191 (bookmark-set "org-remember-last-stored")
14192 (org-paste-subtree (org-get-valid-level 1 1) txt)))
14194 ((and (bobp) reversed)
14195 ;; Put it at the start, as level 1
14196 (save-restriction
14197 (widen)
14198 (goto-char (point-min))
14200 (beginning-of-line 1)
14201 (bookmark-set "org-remember-last-stored")
14202 (org-paste-subtree 1 txt)))
14203 (t
14204 ;; Put it right there, with automatic level determined by
14205 ;; org-paste-subtree or from prefix arg
14206 (bookmark-set "org-remember-last-stored")
14207 (org-paste-subtree
14208 (if (numberp current-prefix-arg) current-prefix-arg)
14209 txt)))
14210 (when remember-save-after-remembering
14211 (save-buffer)
14212 (if (not visiting) (kill-buffer (current-buffer)))))))))
14214 t) ;; return t to indicate that we took care of this note.
14216 (defun org-get-org-file ()
14217 "Read a filename, with default directory `org-directory'."
14218 (let ((default (or org-default-notes-file remember-data-file)))
14219 (read-file-name (format "File name [%s]: " default)
14220 (file-name-as-directory org-directory)
14221 default)))
14223 (defun org-notes-order-reversed-p ()
14224 "Check if the current file should receive notes in reversed order."
14225 (cond
14226 ((not org-reverse-note-order) nil)
14227 ((eq t org-reverse-note-order) t)
14228 ((not (listp org-reverse-note-order)) nil)
14229 (t (catch 'exit
14230 (let ((all org-reverse-note-order)
14231 entry)
14232 (while (setq entry (pop all))
14233 (if (string-match (car entry) buffer-file-name)
14234 (throw 'exit (cdr entry))))
14235 nil)))))
14237 ;;; Refiling
14239 (defvar org-refile-target-table nil
14240 "The list of refile targets, created by `org-refile'.")
14242 (defvar org-agenda-new-buffers nil
14243 "Buffers created to visit agenda files.")
14245 (defun org-get-refile-targets (&optional default-buffer)
14246 "Produce a table with refile targets."
14247 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
14248 targets txt re files f desc descre)
14249 (with-current-buffer (or default-buffer (current-buffer))
14250 (while (setq entry (pop entries))
14251 (setq files (car entry) desc (cdr entry))
14252 (cond
14253 ((null files) (setq files (list (current-buffer))))
14254 ((eq files 'org-agenda-files)
14255 (setq files (org-agenda-files 'unrestricted)))
14256 ((and (symbolp files) (fboundp files))
14257 (setq files (funcall files)))
14258 ((and (symbolp files) (boundp files))
14259 (setq files (symbol-value files))))
14260 (if (stringp files) (setq files (list files)))
14261 (cond
14262 ((eq (car desc) :tag)
14264 ((eq (car desc) :todo)
14266 ((eq (car desc) :regexp)
14267 (setq descre (cdr desc)))
14268 ((eq (car desc) :level)
14270 (if org-odd-levels-only
14271 (1- (* 2 (cdr desc)))
14272 (cdr desc)))
14274 ((eq (car desc) :maxlevel)
14276 (if org-odd-levels-only
14277 (1- (* 2 (cdr desc)))
14278 (cdr desc)))
14280 (t (error "Bad refiling target description %s" desc)))
14281 (while (setq f (pop files))
14282 (save-excursion
14283 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14284 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14285 (save-excursion
14286 (save-restriction
14287 (widen)
14288 (goto-char (point-min))
14289 (while (re-search-forward descre nil t)
14290 (goto-char (point-at-bol))
14291 (when (looking-at org-complex-heading-regexp)
14292 (setq txt (match-string 4)
14293 re (concat "^" (regexp-quote
14294 (buffer-substring (match-beginning 1)
14295 (match-end 4)))))
14297 (regexp-quote
14298 (match-string 5)))))
14300 (when org-refile-use-outline-path
14301 (setq txt (mapconcat 'identity
14302 (append
14303 (if (eq org-refile-use-outline-path 'file)
14304 (list (file-name-nondirectory
14305 (buffer-file-name (buffer-base-buffer))))
14306 (if (eq org-refile-use-outline-path 'full-file-path)
14307 (list (buffer-file-name (buffer-base-buffer)))))
14308 (org-get-outline-path)
14309 (list txt))
14310 "/")))
14311 (push (list txt f re (point)) targets))
14312 (goto-char (point-at-eol))))))))
14313 (nreverse targets))))
14315 (defun org-get-outline-path ()
14316 "Return the outline path to the current entry, as a list."
14317 (let (rtn)
14318 (save-excursion
14319 (while (org-up-heading-safe)
14320 (when (looking-at org-complex-heading-regexp)
14321 (push (org-match-string-no-properties 4) rtn)))
14322 rtn)))
14324 (defvar org-refile-history nil
14325 "History for refiling operations.")
14327 (defun org-refile (&optional goto default-buffer)
14328 "Move the entry at point to another heading.
14329 The list of target headings is compiled using the information in
14330 `org-refile-targets', which see. This list is created upon first use, and
14331 you can update it by calling this command with a double prefix (`C-u C-u').
14332 FIXME: Can we find a better way of updating?
14334 At the target location, the entry is filed as a subitem of the target heading.
14335 Depending on `org-reverse-note-order', the new subitem will either be the
14336 first of the last subitem.
14338 With prefix arg GOTO, the command will only visit the target location,
14339 not actually move anything.
14340 With a double prefix `C-c C-c', go to the location where the last refiling
14341 operation has put the subtree.
14343 With a double prefix argument, the command can be used to jump to any
14344 heading in the current buffer."
14345 (interactive "P")
14346 (let* ((cbuf (current-buffer))
14347 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14348 pos it nbuf file re level reversed)
14349 (if (equal goto '(16))
14350 (org-refile-goto-last-stored)
14351 (when (setq it (org-refile-get-location
14352 (if goto "Goto: " "Refile to: ") default-buffer))
14353 (setq file (nth 1 it)
14354 re (nth 2 it)
14355 pos (nth 3 it))
14356 (setq nbuf (or (find-buffer-visiting file)
14357 (find-file-noselect file)))
14358 (if goto
14359 (progn
14360 (switch-to-buffer nbuf)
14361 (goto-char pos)
14362 (org-show-context 'org-goto))
14363 (org-copy-special)
14364 (save-excursion
14365 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14366 (find-file-noselect file))))
14367 (setq reversed (org-notes-order-reversed-p))
14368 (save-excursion
14369 (save-restriction
14370 (widen)
14371 (goto-char pos)
14372 (looking-at outline-regexp)
14373 (setq level (org-get-valid-level (funcall outline-level) 1))
14374 (goto-char
14375 (if reversed
14376 (outline-next-heading)
14377 (or (save-excursion (outline-get-next-sibling))
14378 (org-end-of-subtree t t)
14379 (point-max))))
14380 (bookmark-set "org-refile-last-stored")
14381 (org-paste-subtree level))))
14382 (org-cut-special)
14385 (defun org-refile-goto-last-stored ()
14386 "Go to the location where the last refile was stored."
14387 (interactive)
14388 (bookmark-jump "org-refile-last-stored")
14389 (message "This is the location of the last refile"))
14391 (defun org-refile-get-location (&optional prompt default-buffer)
14392 "Prompt the user for a refile location, using PROMPT."
14393 (let ((org-refile-targets org-refile-targets)
14394 (org-refile-use-outline-path org-refile-use-outline-path))
14395 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14396 (unless org-refile-target-table
14397 (error "No refile targets"))
14398 (let* ((cbuf (current-buffer))
14399 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14400 (fname (and filename (file-truename filename)))
14401 (tbl (mapcar
14402 (lambda (x)
14403 (if (not (equal fname (file-truename (nth 1 x))))
14404 (cons (concat (car x) " (" (file-name-nondirectory
14405 (nth 1 x)) ")")
14406 (cdr x))
14407 x))
14408 org-refile-target-table))
14409 (completion-ignore-case t))
14410 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14411 tbl)))
14413 ;;;; Dynamic blocks
14415 (defun org-find-dblock (name)
14416 "Find the first dynamic block with name NAME in the buffer.
14417 If not found, stay at current position and return nil."
14418 (let (pos)
14419 (save-excursion
14420 (goto-char (point-min))
14422 nil t)
14423 (match-beginning 0))))
14424 (if pos (goto-char pos))
14425 pos))
14427 (defconst org-dblock-start-re
14429 "Matches the startline of a dynamic block, with parameters.")
14432 "Matches the end of a dyhamic block.")
14434 (defun org-create-dblock (plist)
14435 "Create a dynamic block section, with parameters taken from PLIST.
14436 PLIST must containe a :name entry which is used as name of the block."
14437 (unless (bolp) (newline))
14438 (let ((name (plist-get plist :name)))
14439 (insert "#+BEGIN: " name)
14440 (while plist
14441 (if (eq (car plist) :name)
14442 (setq plist (cddr plist))
14443 (insert " " (prin1-to-string (pop plist)))))
14445 (beginning-of-line -2)))
14447 (defun org-prepare-dblock ()
14448 "Prepare dynamic block for refresh.
14449 This empties the block, puts the cursor at the insert position and returns
14450 the property list including an extra property :name with the block name."
14451 (unless (looking-at org-dblock-start-re)
14452 (error "Not at a dynamic block"))
14453 (let* ((begdel (1+ (match-end 0)))
14454 (name (org-no-properties (match-string 1)))
14455 (params (append (list :name name)
14456 (read (concat "(" (match-string 3) ")")))))
14457 (unless (re-search-forward org-dblock-end-re nil t)
14458 (error "Dynamic block not terminated"))
14459 (delete-region begdel (match-beginning 0))
14460 (goto-char begdel)
14461 (open-line 1)
14462 params))
14464 (defun org-map-dblocks (&optional command)
14465 "Apply COMMAND to all dynamic blocks in the current buffer.
14466 If COMMAND is not given, use `org-update-dblock'."
14467 (let ((cmd (or command 'org-update-dblock))
14468 pos)
14469 (save-excursion
14470 (goto-char (point-min))
14471 (while (re-search-forward org-dblock-start-re nil t)
14472 (goto-char (setq pos (match-beginning 0)))
14473 (condition-case nil
14474 (funcall cmd)
14475 (error (message "Error during update of dynamic block")))
14476 (goto-char pos)
14477 (unless (re-search-forward org-dblock-end-re nil t)
14478 (error "Dynamic block not terminated"))))))
14480 (defun org-dblock-update (&optional arg)
14481 "User command for updating dynamic blocks.
14482 Update the dynamic block at point. With prefix ARG, update all dynamic
14483 blocks in the buffer."
14484 (interactive "P")
14485 (if arg
14486 (org-update-all-dblocks)
14487 (or (looking-at org-dblock-start-re)
14488 (org-beginning-of-dblock))
14489 (org-update-dblock)))
14491 (defun org-update-dblock ()
14492 "Update the dynamic block at point
14493 This means to empty the block, parse for parameters and then call
14494 the correct writing function."
14495 (save-window-excursion
14496 (let* ((pos (point))
14497 (line (org-current-line))
14498 (params (org-prepare-dblock))
14499 (name (plist-get params :name))
14500 (cmd (intern (concat "org-dblock-write:" name))))
14501 (message "Updating dynamic block `%s' at line %d..." name line)
14502 (funcall cmd params)
14503 (message "Updating dynamic block `%s' at line %d...done" name line)
14504 (goto-char pos))))
14506 (defun org-beginning-of-dblock ()
14507 "Find the beginning of the dynamic block at point.
14508 Error if there is no scuh block at point."
14509 (let ((pos (point))
14510 beg)
14511 (end-of-line 1)
14512 (if (and (re-search-backward org-dblock-start-re nil t)
14513 (setq beg (match-beginning 0))
14514 (re-search-forward org-dblock-end-re nil t)
14515 (> (match-end 0) pos))
14516 (goto-char beg)
14517 (goto-char pos)
14518 (error "Not in a dynamic block"))))
14520 (defun org-update-all-dblocks ()
14521 "Update all dynamic blocks in the buffer.
14522 This function can be used in a hook."
14523 (when (org-mode-p)
14524 (org-map-dblocks 'org-update-dblock)))
14527 ;;;; Completion
14529 (defconst org-additional-option-like-keywords
14530 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14531 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14532 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14534 (defun org-complete (&optional arg)
14535 "Perform completion on word at point.
14536 At the beginning of a headline, this completes TODO keywords as given in
14537 `org-todo-keywords'.
14538 If the current word is preceded by a backslash, completes the TeX symbols
14539 that are supported for HTML support.
14541 setting file options.
14543 At all other locations, this simply calls the value of
14544 `org-completion-fallback-command'."
14545 (interactive "P")
14546 (org-without-partial-completion
14547 (catch 'exit
14548 (let* ((end (point))
14549 (beg1 (save-excursion
14550 (skip-chars-backward (org-re "[:alnum:]_@"))
14551 (point)))
14552 (beg (save-excursion
14553 (skip-chars-backward "a-zA-Z0-9_:$")
14554 (point)))
14555 (confirm (lambda (x) (stringp (car x))))
14556 (searchhead (equal (char-before beg) ?*))
14557 (tag (and (equal (char-before beg1) ?:)
14558 (equal (char-after (point-at-bol)) ?*)))
14559 (prop (and (equal (char-before beg1) ?:)
14560 (not (equal (char-after (point-at-bol)) ?*))))
14562 (link (equal (char-before beg) ?\[))
14563 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14564 beg)
14565 "#+"))
14567 (buffer-substring (point-at-bol) (point))))
14568 (completion-ignore-case opt)
14569 (type nil)
14570 (tbl nil)
14571 (table (cond
14572 (opt
14573 (setq type :opt)
14574 (append
14575 (mapcar
14576 (lambda (x)
14578 (cons (match-string 2 x) (match-string 1 x)))
14580 (mapcar 'list org-additional-option-like-keywords)))
14581 (startup
14582 (setq type :startup)
14583 org-startup-options)
14584 (link (append org-link-abbrev-alist-local
14585 org-link-abbrev-alist))
14586 (texp
14587 (setq type :tex)
14588 org-html-entities)
14590 (buffer-substring (point-at-bol) beg))
14591 (setq type :todo)
14592 (mapcar 'list org-todo-keywords-1))
14593 (searchhead
14594 (setq type :searchhead)
14595 (save-excursion
14596 (goto-char (point-min))
14597 (while (re-search-forward org-todo-line-regexp nil t)
14598 (push (list
14599 (org-make-org-heading-search-string
14600 (match-string 3) t))
14601 tbl)))
14602 tbl)
14603 (tag (setq type :tag beg beg1)
14604 (or org-tag-alist (org-get-buffer-tags)))
14605 (prop (setq type :prop beg beg1)
14606 (mapcar 'list (org-buffer-property-keys nil t t)))
14607 (t (progn
14608 (call-interactively org-completion-fallback-command)
14609 (throw 'exit nil)))))
14610 (pattern (buffer-substring-no-properties beg end))
14611 (completion (try-completion pattern table confirm)))
14612 (cond ((eq completion t)
14613 (if (not (assoc (upcase pattern) table))
14614 (message "Already complete")
14615 (if (equal type :opt)
14616 (insert (substring (cdr (assoc (upcase pattern) table))
14617 (length pattern)))
14618 (if (memq type '(:tag :prop)) (insert ":")))))
14619 ((null completion)
14621 (ding))
14622 ((not (string= pattern completion))
14623 (delete-region beg end)
14624 (if (string-match " +$" completion)
14625 (setq completion (replace-match "" t t completion)))
14626 (insert completion)
14627 (if (get-buffer-window "*Completions*")
14628 (delete-window (get-buffer-window "*Completions*")))
14629 (if (assoc completion table)
14630 (if (eq type :todo) (insert " ")
14631 (if (memq type '(:tag :prop)) (insert ":"))))
14632 (if (and (equal type :opt) (assoc completion table))
14633 (message "%s" (substitute-command-keys
14635 (t
14636 (message "Making completion list...")
14637 (let ((list (sort (all-completions pattern table confirm)
14638 'string<)))
14639 (with-output-to-temp-buffer "*Completions*"
14640 (condition-case nil
14641 ;; Protection needed for XEmacs and emacs 21
14642 (display-completion-list list pattern)
14643 (error (display-completion-list list)))))
14644 (message "Making completion list...%s" "done")))))))
14646 ;;;; TODO, DEADLINE, Comments
14648 (defun org-toggle-comment ()
14649 "Change the COMMENT state of an entry."
14650 (interactive)
14651 (save-excursion
14652 (org-back-to-heading)
14653 (let (case-fold-search)
14654 (if (looking-at (concat outline-regexp
14656 (replace-match "" t t nil 1)
14657 (if (looking-at outline-regexp)
14658 (progn
14659 (goto-char (match-end 0))
14660 (insert org-comment-string " ")))))))
14662 (defvar org-last-todo-state-is-todo nil
14663 "This is non-nil when the last TODO state change led to a TODO state.
14664 If the last change removed the TODO tag or switched to DONE, then
14665 this is nil.")
14667 (defvar org-setting-tags nil) ; dynamically skiped
14669 ;; FIXME: better place
14670 (defun org-property-or-variable-value (var &optional inherit)
14671 "Check if there is a property fixing the value of VAR.
14672 If yes, return this value. If not, return the current value of the variable."
14673 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14675 (read prop)
14676 (symbol-value var))))
14678 (defun org-parse-local-options (string var)
14679 "Parse STRING for startup setting relevant for variable VAR."
14680 (let ((rtn (symbol-value var))
14681 e opts)
14682 (save-match-data
14684 rtn
14685 (setq opts (delq nil (mapcar (lambda (x)
14686 (setq e (assoc x org-startup-options))
14687 (if (eq (nth 1 e) var) e nil))
14689 (if (not opts)
14690 rtn
14691 (setq rtn nil)
14692 (while (setq e (pop opts))
14693 (if (not (nth 3 e))
14694 (setq rtn (nth 2 e))
14695 (if (not (listp rtn)) (setq rtn nil))
14696 (push (nth 2 e) rtn)))
14697 rtn)))))
14699 (defvar org-blocker-hook nil
14700 "Hook for functions that are allowed to block a state change.
14702 Each function gets as its single argument a property list, see
14703 `org-trigger-hook' for more information about this list.
14705 If any of the functions in this hook returns nil, the state change
14706 is blocked.")
14708 (defvar org-trigger-hook nil
14709 "Hook for functions that are triggered by a state change.
14711 Each function gets as its single argument a property list with at least
14712 the following elements:
14714 (:type type-of-change :position pos-at-entry-start
14715 :from old-state :to new-state)
14717 Depending on the type, more properties may be present.
14719 This mechanism is currently implemented for:
14721 TODO state changes
14722 ------------------
14723 :type todo-state-change
14724 :from previous state (keyword as a string), or nil
14725 :to new state (keyword as a string), or nil")
14728 (defun org-todo (&optional arg)
14729 "Change the TODO state of an item.
14730 The state of an item is given by a keyword at the start of the heading,
14731 like
14732 *** TODO Write paper
14733 *** DONE Call mom
14735 The different keywords are specified in the variable `org-todo-keywords'.
14737 So for this example: when the item starts with TODO, it is changed to DONE.
14738 When it starts with DONE, the DONE is removed. And when neither TODO nor
14739 DONE are present, add TODO at the beginning of the heading.
14741 With C-u prefix arg, use completion to determine the new state.
14742 With numeric prefix arg, switch to that state.
14744 For calling through lisp, arg is also interpreted in the following way:
14745 'none -> empty state
14747 'done -> switch to DONE
14748 'nextset -> switch to the next set of keywords
14749 'previousset -> switch to the previous set of keywords
14751 really is a member of `org-todo-keywords'."
14752 (interactive "P")
14753 (save-excursion
14754 (catch 'exit
14755 (org-back-to-heading)
14756 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14757 (or (looking-at (concat " +" org-todo-regexp " *"))
14758 (looking-at " *"))
14759 (let* ((match-data (match-data))
14760 (startpos (point-at-bol))
14761 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14762 (org-log-done org-log-done)
14763 (org-log-repeat org-log-repeat)
14764 (org-todo-log-states org-todo-log-states)
14765 (this (match-string 1))
14766 (hl-pos (match-beginning 0))
14767 (head (org-get-todo-sequence-head this))
14768 (ass (assoc head org-todo-kwd-alist))
14769 (interpret (nth 1 ass))
14770 (done-word (nth 3 ass))
14771 (final-done-word (nth 4 ass))
14772 (last-state (or this ""))
14773 (completion-ignore-case t)
14774 (member (member this org-todo-keywords-1))
14775 (tail (cdr member))
14776 (state (cond
14777 ((and org-todo-key-trigger
14778 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14779 (and (not arg) org-use-fast-todo-selection
14780 (not (eq org-use-fast-todo-selection 'prefix)))))
14781 ;; Use fast selection
14782 (org-fast-todo-selection))
14783 ((and (equal arg '(4))
14784 (or (not org-use-fast-todo-selection)
14785 (not org-todo-key-trigger)))
14786 ;; Read a state with completion
14787 (completing-read "State: " (mapcar (lambda(x) (list x))
14788 org-todo-keywords-1)
14789 nil t))
14790 ((eq arg 'right)
14791 (if this
14792 (if tail (car tail) nil)
14793 (car org-todo-keywords-1)))
14794 ((eq arg 'left)
14795 (if (equal member org-todo-keywords-1)
14796 nil
14797 (if this
14798 (nth (- (length org-todo-keywords-1) (length tail) 2)
14799 org-todo-keywords-1)
14800 (org-last org-todo-keywords-1))))
14801 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14802 (setq arg nil))) ; hack to fall back to cycling
14803 (arg
14804 ;; user or caller requests a specific state
14805 (cond
14806 ((equal arg "") nil)
14807 ((eq arg 'none) nil)
14808 ((eq arg 'done) (or done-word (car org-done-keywords)))
14809 ((eq arg 'nextset)
14810 (or (car (cdr (member head org-todo-heads)))
14811 (car org-todo-heads)))
14812 ((eq arg 'previousset)
14813 (let ((org-todo-heads (reverse org-todo-heads)))
14814 (or (car (cdr (member head org-todo-heads)))
14815 (car org-todo-heads))))
14816 ((car (member arg org-todo-keywords-1)))
14817 ((nth (1- (prefix-numeric-value arg))
14818 org-todo-keywords-1))))
14819 ((null member) (or head (car org-todo-keywords-1)))
14820 ((equal this final-done-word) nil) ;; -> make empty
14821 ((null tail) nil) ;; -> first entry
14822 ((eq interpret 'sequence)
14823 (car tail))
14824 ((memq interpret '(type priority))
14825 (if (eq this-command last-command)
14826 (car tail)
14827 (if (> (length tail) 0)
14828 (or done-word (car org-done-keywords))
14829 nil)))
14830 (t nil)))
14831 (next (if state (concat " " state " ") " "))
14832 (change-plist (list :type 'todo-state-change :from this :to state
14833 :position startpos))
14834 dolog now-done-p)
14835 (when org-blocker-hook
14836 (unless (save-excursion
14837 (save-match-data
14838 (run-hook-with-args-until-failure
14839 'org-blocker-hook change-plist)))
14840 (if (interactive-p)
14841 (error "TODO state change from %s to %s blocked" this state)
14842 ;; fail silently
14843 (message "TODO state change from %s to %s blocked" this state)
14844 (throw 'exit nil))))
14845 (store-match-data match-data)
14846 (replace-match next t t)
14847 (unless (pos-visible-in-window-p hl-pos)
14848 (message "TODO state changed to %s" (org-trim next)))
14849 (unless head
14850 (setq head (org-get-todo-sequence-head state)
14851 ass (assoc head org-todo-kwd-alist)
14852 interpret (nth 1 ass)
14853 done-word (nth 3 ass)
14854 final-done-word (nth 4 ass)))
14855 (when (memq arg '(nextset previousset))
14856 (message "Keyword-Set %d/%d: %s"
14857 (- (length org-todo-sets) -1
14858 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14859 (length org-todo-sets)
14860 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14861 (setq org-last-todo-state-is-todo
14862 (not (member state org-done-keywords)))
14863 (setq now-done-p (and (member state org-done-keywords)
14864 (not (member this org-done-keywords))))
14865 (and logging (org-local-logging logging))
14866 (when (and (or org-todo-log-states org-log-done)
14867 (not (memq arg '(nextset previousset))))
14868 ;; we need to look at recording a time and note
14869 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14870 (nth 2 (assoc this org-todo-log-states))))
14871 (when (and state
14872 (member state org-not-done-keywords)
14873 (not (member this org-not-done-keywords)))
14874 ;; This is now a todo state and was not one before
14875 ;; If there was a CLOSED time stamp, get rid of it.
14876 (org-add-planning-info nil nil 'closed))
14877 (when (and now-done-p org-log-done)
14878 ;; It is now done, and it was not done before
14879 (org-add-planning-info 'closed (org-current-time))
14880 (if (and (not dolog) (eq 'note org-log-done))
14881 (org-add-log-maybe 'done state 'findpos 'note)))
14882 (when (and state dolog)
14883 ;; This is a non-nil state, and we need to log it
14884 (org-add-log-maybe 'state state 'findpos dolog)))
14885 ;; Fixup tag positioning
14886 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14887 (run-hooks 'org-after-todo-state-change-hook)
14888 (if (and arg (not (member state org-done-keywords)))
14889 (setq head (org-get-todo-sequence-head state)))
14890 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14891 ;; Do we need to trigger a repeat?
14892 (when now-done-p (org-auto-repeat-maybe state))
14893 ;; Fixup cursor location if close to the keyword
14894 (if (and (outline-on-heading-p)
14895 (not (bolp))
14896 (save-excursion (beginning-of-line 1)
14897 (looking-at org-todo-line-regexp))
14898 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14899 (progn
14900 (goto-char (or (match-end 2) (match-end 1)))
14901 (just-one-space)))
14902 (when org-trigger-hook
14903 (save-excursion
14904 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14906 (defun org-local-logging (value)
14907 "Get logging settings from a property VALUE."
14908 (let* (words w a)
14909 ;; directly set the variables, they are already local.
14910 (setq org-log-done nil
14911 org-log-repeat nil
14912 org-todo-log-states nil)
14913 (setq words (org-split-string value))
14914 (while (setq w (pop words))
14915 (cond
14916 ((setq a (assoc w org-startup-options))
14917 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14918 (set (nth 1 a) (nth 2 a))))
14919 ((setq a (org-extract-log-state-settings w))
14920 (and (member (car a) org-todo-keywords-1)
14921 (push a org-todo-log-states)))))))
14923 (defun org-get-todo-sequence-head (kwd)
14924 "Return the head of the TODO sequence to which KWD belongs.
14925 If KWD is not set, check if there is a text property remembering the
14926 right sequence."
14927 (let (p)
14928 (cond
14929 ((not kwd)
14930 (or (get-text-property (point-at-bol) 'org-todo-head)
14931 (progn
14932 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14933 nil (point-at-eol)))
14934 (get-text-property p 'org-todo-head))))
14935 ((not (member kwd org-todo-keywords-1))
14936 (car org-todo-keywords-1))
14937 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14939 (defun org-fast-todo-selection ()
14940 "Fast TODO keyword selection with single keys.
14941 Returns the new TODO keyword, or nil if no state change should occur."
14942 (let* ((fulltable org-todo-key-alist)
14943 (done-keywords org-done-keywords) ;; needed for the faces.
14944 (maxlen (apply 'max (mapcar
14945 (lambda (x)
14946 (if (stringp (car x)) (string-width (car x)) 0))
14947 fulltable)))
14948 (expert nil)
14949 (fwidth (+ maxlen 3 1 3))
14950 (ncol (/ (- (window-width) 4) fwidth))
14951 tg cnt e c tbl
14952 groups ingroup)
14953 (save-window-excursion
14954 (if expert
14955 (set-buffer (get-buffer-create " *Org todo*"))
14956 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14957 (erase-buffer)
14958 (org-set-local 'org-done-keywords done-keywords)
14959 (setq tbl fulltable cnt 0)
14960 (while (setq e (pop tbl))
14961 (cond
14962 ((equal e '(:startgroup))
14963 (push '() groups) (setq ingroup t)
14964 (when (not (= cnt 0))
14965 (setq cnt 0)
14967 (insert "{ "))
14968 ((equal e '(:endgroup))
14969 (setq ingroup nil cnt 0)
14971 (t
14972 (setq tg (car e) c (cdr e))
14973 (if ingroup (push tg (car groups)))
14974 (setq tg (org-add-props tg nil 'face
14975 (org-get-todo-face tg)))
14976 (if (and (= cnt 0) (not ingroup)) (insert " "))
14977 (insert "[" c "] " tg (make-string
14978 (- fwidth 4 (length tg)) ?\ ))
14979 (when (= (setq cnt (1+ cnt)) ncol)
14981 (if ingroup (insert " "))
14982 (setq cnt 0)))))
14984 (goto-char (point-min))
14985 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14986 (fit-window-to-buffer))
14987 (message "[a-z..]:Set [SPC]:clear")
14988 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14989 (cond
14990 ((or (= c ?\C-g)
14991 (and (= c ?q) (not (rassoc c fulltable))))
14992 (setq quit-flag t))
14993 ((= c ?\ ) nil)
14994 ((setq e (rassoc c fulltable) tg (car e))
14995 tg)
14996 (t (setq quit-flag t))))))
14998 (defun org-get-repeat ()
14999 "Check if tere is a deadline/schedule with repeater in this entry."
15000 (save-match-data
15001 (save-excursion
15002 (org-back-to-heading t)
15003 (if (re-search-forward
15004 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
15005 (match-string 1)))))
15007 (defvar org-last-changed-timestamp)
15008 (defvar org-log-post-message)
15009 (defvar org-log-note-purpose)
15010 (defun org-auto-repeat-maybe (done-word)
15011 "Check if the current headline contains a repeated deadline/schedule.
15012 If yes, set TODO state back to what it was and change the base date
15013 of repeating deadline/scheduled time stamps to new date.
15014 This function is run automatically after each state change to a DONE state."
15015 ;; last-state is dynamically scoped into this function
15016 (let* ((repeat (org-get-repeat))
15017 (aa (assoc last-state org-todo-kwd-alist))
15018 (interpret (nth 1 aa))
15019 (head (nth 2 aa))
15020 (whata '(("d" . day) ("m" . month) ("y" . year)))
15021 (msg "Entry repeats: ")
15022 (org-log-done nil)
15023 (org-todo-log-states nil)
15024 (nshiftmax 10) (nshift 0)
15025 re type n what ts mb0 time)
15026 (when repeat
15027 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
15028 (org-todo (if (eq interpret 'type) last-state head))
15029 (when (and org-log-repeat
15030 (or (not (memq 'org-add-log-note
15031 (default-value 'post-command-hook)))
15032 (eq org-log-note-purpose 'done)))
15033 ;; Make sure a note is taken;
15034 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
15035 'findpos org-log-repeat))
15036 (org-back-to-heading t)
15037 (org-add-planning-info nil nil 'closed)
15041 (while (re-search-forward
15042 re (save-excursion (outline-next-heading) (point)) t)
15043 (setq type (if (match-end 1) org-scheduled-string
15044 (if (match-end 3) org-deadline-string "Plain:"))
15045 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0)))
15046 mb0 (match-beginning 0))
15048 (setq n (string-to-number (match-string 2 ts))
15049 what (match-string 3 ts))
15050 (if (equal what "w") (setq n (* n 7) what "d"))
15051 ;; Preparation, see if we need to modify the start date for the change
15052 (when (match-end 1)
15053 (setq time (save-match-data (org-time-string-to-time ts)))
15054 (cond
15055 ((equal (match-string 1 ts) ".")
15056 ;; Shift starting date to today
15057 (org-timestamp-change
15058 (- (time-to-days (current-time)) (time-to-days time))
15059 'day))
15060 ((equal (match-string 1 ts) "+")
15061 (while (< (time-to-days time) (time-to-days (current-time)))
15062 (when (= (incf nshift) nshiftmax)
15063 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
15064 (error "Abort")))
15065 (org-timestamp-change n (cdr (assoc what whata)))
15066 (sit-for .0001) ;; so we can watch the date shifting
15067 (org-at-timestamp-p t)
15068 (setq ts (match-string 1))
15069 (setq time (save-match-data (org-time-string-to-time ts))))
15070 (org-timestamp-change (- n) (cdr (assoc what whata)))
15071 ;; rematch, so that we have everything in place for the real shift
15072 (org-at-timestamp-p t)
15073 (setq ts (match-string 1))
15075 (org-timestamp-change n (cdr (assoc what whata)))
15076 (setq msg (concat msg type org-last-changed-timestamp " "))))
15077 (setq org-log-post-message msg)
15078 (message "%s" msg))))
15080 (defun org-show-todo-tree (arg)
15081 "Make a compact tree which shows all headlines marked with TODO.
15082 The tree will show the lines where the regexp matches, and all higher
15083 headlines above the match.
15085 With a numeric prefix N, construct a sparse tree for the Nth element
15086 of `org-todo-keywords-1'."
15087 (interactive "P")
15088 (let ((case-fold-search nil)
15089 (kwd-re
15090 (cond ((null arg) org-not-done-regexp)
15091 ((equal arg '(4))
15092 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
15093 (mapcar 'list org-todo-keywords-1))))
15097 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
15098 (regexp-quote (nth (1- (prefix-numeric-value arg))
15099 org-todo-keywords-1)))
15100 (t (error "Invalid prefix argument: %s" arg)))))
15101 (message "%d TODO entries found"
15102 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
15104 (defun org-deadline (&optional remove)
15106 With argument REMOVE, remove any deadline from the item."
15107 (interactive "P")
15108 (if remove
15109 (progn
15110 (org-remove-timestamp-with-keyword org-deadline-string)
15111 (message "Item no longer has a deadline."))
15112 (org-add-planning-info 'deadline nil 'closed)))
15114 (defun org-schedule (&optional remove)
15115 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
15116 With argument REMOVE, remove any scheduling date from the item."
15117 (interactive "P")
15118 (if remove
15119 (progn
15120 (org-remove-timestamp-with-keyword org-scheduled-string)
15121 (message "Item is no longer scheduled."))
15122 (org-add-planning-info 'scheduled nil 'closed)))
15124 (defun org-remove-timestamp-with-keyword (keyword)
15125 "Remove all time stamps with KEYWORD in the current entry."
15127 beg)
15128 (save-excursion
15129 (org-back-to-heading t)
15130 (setq beg (point))
15131 (org-end-of-subtree t t)
15132 (while (re-search-backward re beg t)
15133 (replace-match "")
15135 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
15137 (defun org-add-planning-info (what &optional time &rest remove)
15138 "Insert new timestamp with keyword in the line directly after the headline.
15139 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
15140 If non is given, the user is prompted for a date.
15141 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
15142 be removed."
15143 (interactive)
15144 (let (org-time-was-given org-end-time-was-given)
15145 (when what (setq time (or time (org-read-date nil 'to-time))))
15146 (when (and org-insert-labeled-timestamps-at-point
15147 (member what '(scheduled deadline)))
15148 (insert
15149 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
15150 (org-insert-time-stamp time org-time-was-given
15151 nil nil nil (list org-end-time-was-given))
15152 (setq what nil))
15153 (save-excursion
15154 (save-restriction
15155 (let (col list elt ts buffer-invisibility-spec)
15156 (org-back-to-heading t)
15158 (goto-char (match-end 1))
15159 (setq col (current-column))
15160 (goto-char (match-end 0))
15162 (if (and (not (looking-at outline-regexp))
15165 (not (equal (match-string 1) org-clock-string)))
15166 (narrow-to-region (match-beginning 0) (match-end 0))
15168 (backward-char 1)
15169 (narrow-to-region (point) (point))
15170 (indent-to-column col))
15171 ;; Check if we have to remove something.
15172 (setq list (cons what remove))
15173 (while list
15174 (setq elt (pop list))
15175 (goto-char (point-min))
15176 (when (or (and (eq elt 'scheduled)
15177 (re-search-forward org-scheduled-time-regexp nil t))
15178 (and (eq elt 'deadline)
15179 (re-search-forward org-deadline-time-regexp nil t))
15180 (and (eq elt 'closed)
15181 (re-search-forward org-closed-time-regexp nil t)))
15182 (replace-match "")
15183 (if (looking-at "--+<[^>]+>") (replace-match ""))
15184 (if (looking-at " +") (replace-match ""))))
15185 (goto-char (point-max))
15186 (when what
15187 (insert
15188 (if (not (equal (char-before) ?\ )) " " "")
15189 (cond ((eq what 'scheduled) org-scheduled-string)
15190 ((eq what 'deadline) org-deadline-string)
15191 ((eq what 'closed) org-closed-string))
15192 " ")
15193 (setq ts (org-insert-time-stamp
15194 time
15195 (or org-time-was-given
15196 (and (eq what 'closed) org-log-done-with-time))
15197 (eq what 'closed)
15198 nil nil (list org-end-time-was-given)))
15199 (end-of-line 1))
15200 (goto-char (point-min))
15201 (widen)
15203 (replace-match ""))
15204 ts)))))
15206 (defvar org-log-note-marker (make-marker))
15207 (defvar org-log-note-purpose nil)
15208 (defvar org-log-note-state nil)
15209 (defvar org-log-note-how nil)
15210 (defvar org-log-note-window-configuration nil)
15211 (defvar org-log-note-return-to (make-marker))
15212 (defvar org-log-post-message nil
15213 "Message to be displayed after a log note has been stored.
15214 The auto-repeater uses this.")
15216 (defun org-add-log-maybe (&optional purpose state findpos how)
15217 "Set up the post command hook to take a note.
15218 If this is about to TODO state change, the new state is expected in STATE.
15219 When FINDPOS is non-nil, find the correct position for the note in
15220 the current entry. If not, assume that it can be inserted at point."
15221 (save-excursion
15222 (when findpos
15223 (org-back-to-heading t)
15227 (goto-char (match-end 0))
15228 (unless org-log-states-order-reversed
15230 (org-skip-over-state-notes)
15232 (move-marker org-log-note-marker (point))
15233 (setq org-log-note-purpose purpose
15234 org-log-note-state state
15235 org-log-note-how how)
15236 (add-hook 'post-command-hook 'org-add-log-note 'append)))
15238 (defun org-skip-over-state-notes ()
15239 "Skip past the list of State notes in an entry."
15242 (condition-case nil
15243 (org-next-item)
15244 (error (org-end-of-item)))))
15246 (defun org-add-log-note (&optional purpose)
15247 "Pop up a window for taking a note, and add this note later at point."
15248 (remove-hook 'post-command-hook 'org-add-log-note)
15249 (setq org-log-note-window-configuration (current-window-configuration))
15250 (delete-other-windows)
15251 (move-marker org-log-note-return-to (point))
15252 (switch-to-buffer (marker-buffer org-log-note-marker))
15253 (goto-char org-log-note-marker)
15254 (org-switch-to-buffer-other-window "*Org Note*")
15255 (erase-buffer)
15256 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
15257 (org-store-log-note)
15258 (let ((org-inhibit-startup t)) (org-mode))
15259 (insert (format "# Insert note for %s.
15261 (cond
15262 ((eq org-log-note-purpose 'clock-out) "stopped clock")
15263 ((eq org-log-note-purpose 'done) "closed todo item")
15264 ((eq org-log-note-purpose 'state)
15266 (t (error "This should not happen")))))
15267 (org-set-local 'org-finish-function 'org-store-log-note)))
15269 (defun org-store-log-note ()
15270 "Finish taking a log note, and insert it to where it belongs."
15271 (let ((txt (buffer-string))
15272 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
15273 lines ind)
15274 (kill-buffer (current-buffer))
15276 (setq txt (replace-match "" t t txt)))
15278 (setq txt (replace-match "" t t txt)))
15281 (setq note
15282 (org-replace-escapes
15283 note
15284 (list (cons "%u" (user-login-name))
15285 (cons "%U" user-full-name)
15286 (cons "%t" (format-time-string
15287 (org-time-stamp-format 'long 'inactive)
15288 (current-time)))
15289 (cons "%s" (if org-log-note-state
15291 "")))))
15293 (push note lines))
15294 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15295 (when lines
15296 (save-excursion
15297 (set-buffer (marker-buffer org-log-note-marker))
15298 (save-excursion
15299 (goto-char org-log-note-marker)
15300 (move-marker org-log-note-marker nil)
15301 (end-of-line 1)
15303 (indent-relative nil)
15304 (insert "- " (pop lines))
15305 (org-indent-line-function)
15306 (beginning-of-line 1)
15308 (setq ind (concat (match-string 0) " "))
15309 (end-of-line 1)
15311 (set-window-configuration org-log-note-window-configuration)
15312 (with-current-buffer (marker-buffer org-log-note-return-to)
15313 (goto-char org-log-note-return-to))
15314 (move-marker org-log-note-return-to nil)
15315 (and org-log-post-message (message "%s" org-log-post-message)))
15317 ;; FIXME: what else would be useful?
15318 ;; - priority
15319 ;; - date
15321 (defun org-sparse-tree (&optional arg)
15322 "Create a sparse tree, prompt for the details.
15323 This command can create sparse trees. You first need to select the type
15324 of match used to create the tree:
15326 t Show entries with a specific TODO keyword.
15327 T Show entries selected by a tags match.
15328 p Enter a property name and its value (both with completion on existing
15329 names/values) and show entries with that property.
15330 r Show entries matching a regular expression
15331 d Show deadlines due within `org-deadline-warning-days'."
15332 (interactive "P")
15333 (let (ans kwd value)
15334 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15335 (setq ans (read-char-exclusive))
15336 (cond
15337 ((equal ans ?d)
15338 (call-interactively 'org-check-deadlines))
15339 ((equal ans ?b)
15340 (call-interactively 'org-check-before-date))
15341 ((equal ans ?t)
15342 (org-show-todo-tree '(4)))
15343 ((equal ans ?T)
15344 (call-interactively 'org-tags-sparse-tree))
15345 ((member ans '(?p ?P))
15346 (setq kwd (completing-read "Property: "
15347 (mapcar 'list (org-buffer-property-keys))))
15348 (setq value (completing-read "Value: "
15349 (mapcar 'list (org-property-values kwd))))
15352 (org-tags-sparse-tree arg (concat kwd "=" value)))
15353 ((member ans '(?r ?R ?/))
15354 (call-interactively 'org-occur))
15357 (defvar org-occur-highlights nil
15358 "List of overlays used for occur matches.")
15359 (make-variable-buffer-local 'org-occur-highlights)
15360 (defvar org-occur-parameters nil
15361 "Parameters of the active org-occur calls.
15362 This is a list, each call to org-occur pushes as cons cell,
15363 containing the regular expression and the callback, onto the list.
15364 The list can contain several entries if `org-occur' has been called
15365 several time with the KEEP-PREVIOUS argument. Otherwise, this list
15366 will only contain one set of parameters. When the highlights are
15367 removed (for example with `C-c C-c', or with the next edit (depending
15368 on `org-remove-highlights-with-change'), this variable is emptied
15369 as well.")
15370 (make-variable-buffer-local 'org-occur-parameters)
15372 (defun org-occur (regexp &optional keep-previous callback)
15373 "Make a compact tree which shows all matches of REGEXP.
15374 The tree will show the lines where the regexp matches, and all higher
15375 headlines above the match. It will also show the heading after the match,
15376 to make sure editing the matching entry is easy.
15377 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15378 call to `org-occur' will be kept, to allow stacking of calls to this
15379 command.
15380 If CALLBACK is non-nil, it is a function which is called to confirm
15381 that the match should indeed be shown."
15383 (unless keep-previous
15384 (org-remove-occur-highlights nil nil t))
15385 (push (cons regexp callback) org-occur-parameters)
15386 (let ((cnt 0))
15387 (save-excursion
15388 (goto-char (point-min))
15389 (if (or (not keep-previous) ; do not want to keep
15390 (not org-occur-highlights)) ; no previous matches
15391 ;; hide everything
15392 (org-overview))
15393 (while (re-search-forward regexp nil t)
15394 (when (or (not callback)
15395 (save-match-data (funcall callback)))
15396 (setq cnt (1+ cnt))
15397 (when org-highlight-sparse-tree-matches
15398 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15399 (org-show-context 'occur-tree))))
15400 (when org-remove-highlights-with-change
15401 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15402 nil 'local))
15403 (unless org-sparse-tree-open-archived-trees
15404 (org-hide-archived-subtrees (point-min) (point-max)))
15405 (run-hooks 'org-occur-hook)
15406 (if (interactive-p)
15407 (message "%d match(es) for regexp %s" cnt regexp))
15408 cnt))
15410 (defun org-show-context (&optional key)
15411 "Make sure point and context and visible.
15412 How much context is shown depends upon the variables
15413 `org-show-hierarchy-above', `org-show-following-heading'. and
15414 `org-show-siblings'."
15415 (let ((heading-p (org-on-heading-p t))
15416 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15417 (following-p (org-get-alist-option org-show-following-heading key))
15418 (entry-p (org-get-alist-option org-show-entry-below key))
15419 (siblings-p (org-get-alist-option org-show-siblings key)))
15420 (catch 'exit
15421 ;; Show heading or entry text
15422 (if (and heading-p (not entry-p))
15423 (org-flag-heading nil) ; only show the heading
15424 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15425 (org-show-hidden-entry))) ; show entire entry
15426 (when following-p
15427 ;; Show next sibling, or heading below text
15428 (save-excursion
15429 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15430 (org-flag-heading nil))))
15431 (when siblings-p (org-show-siblings))
15432 (when hierarchy-p
15433 ;; show all higher headings, possibly with siblings
15434 (save-excursion
15435 (while (and (condition-case nil
15436 (progn (org-up-heading-all 1) t)
15437 (error nil))
15438 (not (bobp)))
15439 (org-flag-heading nil)
15440 (when siblings-p (org-show-siblings))))))))
15442 (defun org-reveal (&optional siblings)
15443 "Show current entry, hierarchy above it, and the following headline.
15444 This can be used to show a consistent set of context around locations
15445 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15446 not t for the search context.
15448 With optional argument SIBLINGS, on each level of the hierarchy all
15449 siblings are shown. This repairs the tree structure to what it would
15450 look like when opened with hierarchical calls to `org-cycle'."
15451 (interactive "P")
15452 (let ((org-show-hierarchy-above t)
15453 (org-show-following-heading t)
15454 (org-show-siblings (if siblings t org-show-siblings)))
15455 (org-show-context nil)))
15457 (defun org-highlight-new-match (beg end)
15458 "Highlight from BEG to END and mark the highlight is an occur headline."
15459 (let ((ov (org-make-overlay beg end)))
15460 (org-overlay-put ov 'face 'secondary-selection)
15461 (push ov org-occur-highlights)))
15463 (defun org-remove-occur-highlights (&optional beg end noremove)
15464 "Remove the occur highlights from the buffer.
15465 BEG and END are ignored. If NOREMOVE is nil, remove this function
15466 from the `before-change-functions' in the current buffer."
15467 (interactive)
15468 (unless org-inhibit-highlight-removal
15469 (mapc 'org-delete-overlay org-occur-highlights)
15470 (setq org-occur-highlights nil)
15471 (setq org-occur-parameters nil)
15472 (unless noremove
15473 (remove-hook 'before-change-functions
15474 'org-remove-occur-highlights 'local))))
15476 ;;;; Priorities
15479 "Regular expression matching the priority indicator.")
15481 (defvar org-remove-priority-next-time nil)
15483 (defun org-priority-up ()
15484 "Increase the priority of the current item."
15485 (interactive)
15486 (org-priority 'up))
15488 (defun org-priority-down ()
15489 "Decrease the priority of the current item."
15490 (interactive)
15491 (org-priority 'down))
15493 (defun org-priority (&optional action)
15494 "Change the priority of an item by ARG.
15495 ACTION can be `set', `up', `down', or a character."
15496 (interactive)
15497 (setq action (or action 'set))
15498 (let (current new news have remove)
15499 (save-excursion
15500 (org-back-to-heading)
15501 (if (looking-at org-priority-regexp)
15502 (setq current (string-to-char (match-string 2))
15503 have t)
15504 (setq current org-default-priority))
15505 (cond
15506 ((or (eq action 'set) (integerp action))
15507 (if (integerp action)
15508 (setq new action)
15509 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15510 (setq new (read-char-exclusive)))
15511 (if (and (= (upcase org-highest-priority) org-highest-priority)
15512 (= (upcase org-lowest-priority) org-lowest-priority))
15513 (setq new (upcase new)))
15514 (cond ((equal new ?\ ) (setq remove t))
15515 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15516 (error "Priority must be between `%c' and `%c'"
15517 org-highest-priority org-lowest-priority))))
15518 ((eq action 'up)
15519 (if (and (not have) (eq last-command this-command))
15520 (setq new org-lowest-priority)
15521 (setq new (if (and org-priority-start-cycle-with-default (not have))
15522 org-default-priority (1- current)))))
15523 ((eq action 'down)
15524 (if (and (not have) (eq last-command this-command))
15525 (setq new org-highest-priority)
15526 (setq new (if (and org-priority-start-cycle-with-default (not have))
15527 org-default-priority (1+ current)))))
15528 (t (error "Invalid action")))
15529 (if (or (< (upcase new) org-highest-priority)
15530 (> (upcase new) org-lowest-priority))
15531 (setq remove t))
15532 (setq news (format "%c" new))
15533 (if have
15534 (if remove
15535 (replace-match "" t t nil 1)
15536 (replace-match news t t nil 2))
15537 (if remove
15538 (error "No priority cookie found in line")
15539 (looking-at org-todo-line-regexp)
15540 (if (match-end 2)
15541 (progn
15542 (goto-char (match-end 2))
15543 (insert " [#" news "]"))
15544 (goto-char (match-beginning 3))
15545 (insert "[#" news "] ")))))
15546 (org-preserve-lc (org-set-tags nil 'align))
15547 (if remove
15548 (message "Priority removed")
15549 (message "Priority of current item set to %s" news))))
15552 (defun org-get-priority (s)
15553 "Find priority cookie and return priority."
15554 (save-match-data
15555 (if (not (string-match org-priority-regexp s))
15556 (* 1000 (- org-lowest-priority org-default-priority))
15557 (* 1000 (- org-lowest-priority
15558 (string-to-char (match-string 2 s)))))))
15560 ;;;; Tags
15562 (defun org-scan-tags (action matcher &optional todo-only)
15563 "Scan headline tags with inheritance and produce output ACTION.
15564 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15565 evaluated, testing if a given set of tags qualifies a headline for
15566 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15567 are included in the output."
15570 (org-re
15572 (props (list 'face nil
15573 'done-face 'org-done
15574 'undone-face nil
15575 'mouse-face 'highlight
15576 'org-not-done-regexp org-not-done-regexp
15577 'org-todo-regexp org-todo-regexp
15578 'keymap org-agenda-keymap
15579 'help-echo
15580 (format "mouse-2 or RET jump to org file %s"
15581 (abbreviate-file-name
15582 (or (buffer-file-name (buffer-base-buffer))
15583 (buffer-name (buffer-base-buffer)))))))
15584 (case-fold-search nil)
15585 lspos
15586 tags tags-list tags-alist (llast 0) rtn level category i txt
15587 todo marker entry priority)
15588 (save-excursion
15589 (goto-char (point-min))
15590 (when (eq action 'sparse-tree)
15591 (org-overview)
15592 (org-remove-occur-highlights))
15593 (while (re-search-forward re nil t)
15594 (catch :skip
15595 (setq todo (if (match-end 1) (match-string 2))
15596 tags (if (match-end 4) (match-string 4)))
15597 (goto-char (setq lspos (1+ (match-beginning 0))))
15598 (setq level (org-reduced-level (funcall outline-level))
15599 category (org-get-category))
15600 (setq i llast llast level)
15601 ;; remove tag lists from same and sublevels
15602 (while (>= i level)
15603 (when (setq entry (assoc i tags-alist))
15604 (setq tags-alist (delete entry tags-alist)))
15605 (setq i (1- i)))
15606 ;; add the nex tags
15607 (when tags
15608 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15609 tags-alist
15610 (cons (cons level tags) tags-alist)))
15611 ;; compile tags for current headline
15612 (setq tags-list
15613 (if org-use-tag-inheritance
15614 (apply 'append (mapcar 'cdr tags-alist))
15615 tags))
15616 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15617 (eval matcher)
15618 (or (not org-agenda-skip-archived-trees)
15619 (not (member org-archive-tag tags-list))))
15620 (and (eq action 'agenda) (org-agenda-skip))
15621 ;; list this headline
15623 (if (eq action 'sparse-tree)
15624 (progn
15625 (and org-highlight-sparse-tree-matches
15626 (org-get-heading) (match-end 0)
15627 (org-highlight-new-match
15628 (match-beginning 0) (match-beginning 1)))
15629 (org-show-context 'tags-tree))
15630 (setq txt (org-format-agenda-item
15631 ""
15632 (concat
15633 (if org-tags-match-list-sublevels
15634 (make-string (1- level) ?.) "")
15635 (org-get-heading))
15636 category tags-list)
15637 priority (org-get-priority txt))
15638 (goto-char lspos)
15639 (setq marker (org-agenda-new-marker))
15640 (org-add-props txt props
15641 'org-marker marker 'org-hd-marker marker 'org-category category
15642 'priority priority 'type "tagsmatch")
15643 (push txt rtn))
15644 ;; if we are to skip sublevels, jump to end of subtree
15645 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15646 (when (and (eq action 'sparse-tree)
15647 (not org-sparse-tree-open-archived-trees))
15648 (org-hide-archived-subtrees (point-min) (point-max)))
15649 (nreverse rtn)))
15651 (defvar todo-only) ;; dynamically scoped
15653 (defun org-tags-sparse-tree (&optional todo-only match)
15654 "Create a sparse tree according to tags string MATCH.
15655 MATCH can contain positive and negative selection of tags, like
15657 If optional argument TODO_ONLY is non-nil, only select lines that are
15658 also TODO lines."
15659 (interactive "P")
15660 (org-prepare-agenda-buffers (list (current-buffer)))
15661 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15663 (defvar org-cached-props nil)
15664 (defun org-cached-entry-get (pom property)
15665 (if (or (eq t org-use-property-inheritance)
15666 (member property org-use-property-inheritance))
15667 ;; Caching is not possible, check it directly
15668 (org-entry-get pom property 'inherit)
15669 ;; Get all properties, so that we can do complicated checks easily
15670 (cdr (assoc property (or org-cached-props
15671 (setq org-cached-props
15672 (org-entry-properties pom)))))))
15674 (defun org-global-tags-completion-table (&optional files)
15675 "Return the list of all tags in all agenda buffer/files."
15676 (save-excursion
15677 (org-uniquify
15678 (delq nil
15679 (apply 'append
15680 (mapcar
15681 (lambda (file)
15682 (set-buffer (find-file-noselect file))
15683 (append (org-get-buffer-tags)
15684 (mapcar (lambda (x) (if (stringp (car-safe x))
15685 (list (car-safe x)) nil))
15686 org-tag-alist)))
15687 (if (and files (car files))
15688 files
15689 (org-agenda-files))))))))
15691 (defun org-make-tags-matcher (match)
15692 "Create the TAGS//TODO matcher form for the selection string MATCH."
15693 ;; todo-only is scoped dynamically into this function, and the function
15694 ;; may change it it the matcher asksk for it.
15695 (unless match
15696 ;; Get a new match request, with completion
15697 (let ((org-last-tags-completion-table
15698 (org-global-tags-completion-table)))
15699 (setq match (completing-read
15700 "Match: " 'org-tags-completion-function nil nil nil
15701 'org-tags-history))))
15703 ;; Parse the string and create a lisp form
15704 (let ((match0 match)
15705 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15706 minus tag mm
15707 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15708 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15709 (if (string-match "/+" match)
15710 ;; match contains also a todo-matching request
15711 (progn
15712 (setq tagsmatch (substring match 0 (match-beginning 0))
15713 todomatch (substring match (match-end 0)))
15714 (if (string-match "^!" todomatch)
15715 (setq todo-only t todomatch (substring todomatch 1)))
15717 (setq todomatch nil)))
15718 ;; only matching tags
15719 (setq tagsmatch match todomatch nil))
15721 ;; Make the tags matcher
15723 (setq tagsmatcher t)
15724 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15725 (while (setq term (pop orterms))
15727 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15728 (while (string-match re term)
15729 (setq minus (and (match-end 1)
15730 (equal (match-string 1 term) "-"))
15731 tag (match-string 2 term)
15732 re-p (equal (string-to-char tag) ?{)
15733 level-p (match-end 3)
15734 prop-p (match-end 4)
15735 mm (cond
15736 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15737 (level-p `(= level ,(string-to-number
15738 (match-string 3 term))))
15739 (prop-p
15740 (setq pn (match-string 4 term)
15741 pv (match-string 5 term)
15742 cat-p (equal pn "CATEGORY")
15743 re-p (equal (string-to-char pv) ?{)
15744 pv (substring pv 1 -1))
15745 (if (equal pn "CATEGORY")
15746 (setq gv '(get-text-property (point) 'org-category))
15747 (setq gv `(org-cached-entry-get nil ,pn)))
15748 (if re-p
15749 `(string-match ,pv (or ,gv ""))
15750 `(equal ,pv (or ,gv ""))))
15751 (t `(member ,(downcase tag) tags-list)))
15752 mm (if minus (list 'not mm) mm)
15753 term (substring term (match-end 0)))
15754 (push mm tagsmatcher))
15755 (push (if (> (length tagsmatcher) 1)
15756 (cons 'and tagsmatcher)
15757 (car tagsmatcher))
15758 orlist)
15759 (setq tagsmatcher nil))
15760 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15761 (setq tagsmatcher
15762 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15764 ;; Make the todo matcher
15766 (setq todomatcher t)
15767 (setq orterms (org-split-string todomatch "|") orlist nil)
15768 (while (setq term (pop orterms))
15769 (while (string-match re term)
15770 (setq minus (and (match-end 1)
15771 (equal (match-string 1 term) "-"))
15772 kwd (match-string 2 term)
15773 re-p (equal (string-to-char kwd) ?{)
15774 term (substring term (match-end 0))
15775 mm (if re-p
15776 `(string-match ,(substring kwd 1 -1) todo)
15777 (list 'equal 'todo kwd))
15778 mm (if minus (list 'not mm) mm))
15779 (push mm todomatcher))
15780 (push (if (> (length todomatcher) 1)
15781 (cons 'and todomatcher)
15782 (car todomatcher))
15783 orlist)
15784 (setq todomatcher nil))
15785 (setq todomatcher (if (> (length orlist) 1)
15786 (cons 'or orlist) (car orlist))))
15788 ;; Return the string and lisp forms of the matcher
15789 (setq matcher (if todomatcher
15790 (list 'and tagsmatcher todomatcher)
15791 tagsmatcher))
15792 (cons match0 matcher)))
15794 (defun org-match-any-p (re list)
15795 "Does re match any element of list?"
15796 (setq list (mapcar (lambda (x) (string-match re x)) list))
15797 (delq nil list))
15799 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15800 (defvar org-tags-overlay (org-make-overlay 1 1))
15801 (org-detach-overlay org-tags-overlay)
15803 (defun org-align-tags-here (to-col)
15804 ;; Assumes that this is a headline
15805 (let ((pos (point)) (col (current-column)) tags)
15806 (beginning-of-line 1)
15808 (< pos (match-beginning 2)))
15809 (progn
15810 (setq tags (match-string 2))
15811 (goto-char (match-beginning 1))
15812 (insert " ")
15813 (delete-region (point) (1+ (match-end 0)))
15814 (backward-char 1)
15815 (move-to-column
15816 (max (1+ (current-column))
15817 (1+ col)
15818 (if (> to-col 0)
15819 to-col
15820 (- (abs to-col) (length tags))))
15821 t)
15822 (insert tags)
15823 (move-to-column (min (current-column) col) t))
15824 (goto-char pos))))
15826 (defun org-set-tags (&optional arg just-align)
15827 "Set the tags for the current headline.
15828 With prefix ARG, realign all tags in headings in the current buffer."
15829 (interactive "P")
15830 (let* ((re (concat "^" outline-regexp))
15831 (current (org-get-tags-string))
15832 (col (current-column))
15833 (org-setting-tags t)
15834 table current-tags inherited-tags ; computed below when needed
15835 tags p0 c0 c1 rpl)
15836 (if arg
15837 (save-excursion
15838 (goto-char (point-min))
15839 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15840 (while (re-search-forward re nil t)
15841 (org-set-tags nil t)
15842 (end-of-line 1)))
15843 (message "All tags realigned to column %d" org-tags-column))
15844 (if just-align
15845 (setq tags current)
15846 ;; Get a new set of tags from the user
15847 (save-excursion
15848 (setq table (or org-tag-alist (org-get-buffer-tags))
15849 org-last-tags-completion-table table
15850 current-tags (org-split-string current ":")
15851 inherited-tags (nreverse
15852 (nthcdr (length current-tags)
15853 (nreverse (org-get-tags-at))))
15854 tags
15855 (if (or (eq t org-use-fast-tag-selection)
15856 (and org-use-fast-tag-selection
15857 (delq nil (mapcar 'cdr table))))
15858 (org-fast-tag-selection
15859 current-tags inherited-tags table
15860 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15861 (let ((org-add-colon-after-tag-completion t))
15862 (org-trim
15863 (org-without-partial-completion
15864 (completing-read "Tags: " 'org-tags-completion-function
15865 nil nil current 'org-tags-history)))))))
15866 (while (string-match "[-+&]+" tags)
15867 ;; No boolean logic, just a list
15868 (setq tags (replace-match ":" t t tags))))
15871 (setq tags "")
15872 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15873 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15875 ;; Insert new tags at the correct column
15876 (beginning-of-line 1)
15877 (cond
15878 ((and (equal current "") (equal tags "")))
15879 ((re-search-forward
15881 (point-at-eol) t)
15882 (if (equal tags "")
15883 (setq rpl "")
15884 (goto-char (match-beginning 0))
15885 (setq c0 (current-column) p0 (point)
15886 c1 (max (1+ c0) (if (> org-tags-column 0)
15887 org-tags-column
15888 (- (- org-tags-column) (length tags))))
15889 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15890 (replace-match rpl t t)
15891 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15892 tags)
15893 (t (error "Tags alignment failed")))
15894 (move-to-column col)
15895 (unless just-align
15896 (run-hooks 'org-after-tags-change-hook)))))
15898 (defun org-change-tag-in-region (beg end tag off)
15899 "Add or remove TAG for each entry in the region.
15900 This works in the agenda, and also in an org-mode buffer."
15901 (interactive
15902 (list (region-beginning) (region-end)
15903 (let ((org-last-tags-completion-table
15904 (if (org-mode-p)
15905 (org-get-buffer-tags)
15906 (org-global-tags-completion-table))))
15907 (completing-read
15908 "Tag: " 'org-tags-completion-function nil nil nil
15909 'org-tags-history))
15910 (progn
15911 (message "[s]et or [r]emove? ")
15912 (equal (read-char-exclusive) ?r))))
15913 (if (fboundp 'deactivate-mark) (deactivate-mark))
15914 (let ((agendap (equal major-mode 'org-agenda-mode))
15915 l1 l2 m buf pos newhead (cnt 0))
15916 (goto-char end)
15917 (setq l2 (1- (org-current-line)))
15918 (goto-char beg)
15919 (setq l1 (org-current-line))
15920 (loop for l from l1 to l2 do
15921 (goto-line l)
15922 (setq m (get-text-property (point) 'org-hd-marker))
15923 (when (or (and (org-mode-p) (org-on-heading-p))
15924 (and agendap m))
15925 (setq buf (if agendap (marker-buffer m) (current-buffer))
15926 pos (if agendap m (point)))
15927 (with-current-buffer buf
15928 (save-excursion
15929 (save-restriction
15930 (goto-char pos)
15931 (setq cnt (1+ cnt))
15932 (org-toggle-tag tag (if off 'off 'on))
15933 (setq newhead (org-get-heading)))))
15934 (and agendap (org-agenda-change-all-lines newhead m))))
15935 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15937 (defun org-tags-completion-function (string predicate &optional flag)
15938 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15939 (confirm (lambda (x) (stringp (car x)))))
15941 (setq s1 (match-string 1 string)
15942 s2 (match-string 2 string))
15943 (setq s1 "" s2 string))
15944 (cond
15945 ((eq flag nil)
15946 ;; try completion
15947 (setq rtn (try-completion s2 ctable confirm))
15948 (if (stringp rtn)
15949 (setq rtn
15950 (concat s1 s2 (substring rtn (length s2))
15951 (if (and org-add-colon-after-tag-completion
15952 (assoc rtn ctable))
15953 ":" ""))))
15954 rtn)
15955 ((eq flag t)
15956 ;; all-completions
15957 (all-completions s2 ctable confirm)
15958 )
15959 ((eq flag 'lambda)
15960 ;; exact match?
15961 (assoc s2 ctable)))
15962 ))
15964 (defun org-fast-tag-insert (kwd tags face &optional end)
15965 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15966 (insert (format "%-12s" (concat kwd ":"))
15967 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15968 (or end "")))
15970 (defun org-fast-tag-show-exit (flag)
15971 (save-excursion
15972 (goto-line 3)
15974 (replace-match ""))
15975 (when flag
15976 (end-of-line 1)
15977 (move-to-column (- (window-width) 19) t)
15978 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15980 (defun org-set-current-tags-overlay (current prefix)
15981 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15982 (if (featurep 'xemacs)
15983 (org-overlay-display org-tags-overlay (concat prefix s)
15984 'secondary-selection)
15985 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15986 (org-overlay-display org-tags-overlay (concat prefix s)))))
15988 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15989 "Fast tag selection with single keys.
15990 CURRENT is the current list of tags in the headline, INHERITED is the
15991 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15992 possibly with grouping information. TODO-TABLE is a similar table with
15993 TODO keywords, should these have keys assigned to them.
15994 If the keys are nil, a-z are automatically assigned.
15995 Returns the new tags string, or nil to not change the current settings."
15996 (let* ((fulltable (append table todo-table))
15997 (maxlen (apply 'max (mapcar
15998 (lambda (x)
15999 (if (stringp (car x)) (string-width (car x)) 0))
16000 fulltable)))
16001 (buf (current-buffer))
16002 (expert (eq org-fast-tag-selection-single-key 'expert))
16003 (buffer-tags nil)
16004 (fwidth (+ maxlen 3 1 3))
16005 (ncol (/ (- (window-width) 4) fwidth))
16006 (i-face 'org-done)
16007 (c-face 'org-todo)
16008 tg cnt e c char c1 c2 ntable tbl rtn
16009 ov-start ov-end ov-prefix
16010 (exit-after-next org-fast-tag-selection-single-key)
16011 (done-keywords org-done-keywords)
16012 groups ingroup)
16013 (save-excursion
16014 (beginning-of-line 1)
16015 (if (looking-at
16017 (setq ov-start (match-beginning 1)
16018 ov-end (match-end 1)
16019 ov-prefix "")
16020 (setq ov-start (1- (point-at-eol))
16021 ov-end (1+ ov-start))
16023 (setq ov-prefix
16024 (concat
16025 (buffer-substring (1- (point)) (point))
16026 (if (> (current-column) org-tags-column)
16027 " "
16028 (make-string (- org-tags-column (current-column)) ?\ ))))))
16029 (org-move-overlay org-tags-overlay ov-start ov-end)
16030 (save-window-excursion
16031 (if expert
16032 (set-buffer (get-buffer-create " *Org tags*"))
16033 (delete-other-windows)
16034 (split-window-vertically)
16035 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
16036 (erase-buffer)
16037 (org-set-local 'org-done-keywords done-keywords)
16040 (org-fast-tag-show-exit exit-after-next)
16041 (org-set-current-tags-overlay current ov-prefix)
16042 (setq tbl fulltable char ?a cnt 0)
16043 (while (setq e (pop tbl))
16044 (cond
16045 ((equal e '(:startgroup))
16046 (push '() groups) (setq ingroup t)
16047 (when (not (= cnt 0))
16048 (setq cnt 0)
16050 (insert "{ "))
16051 ((equal e '(:endgroup))
16052 (setq ingroup nil cnt 0)
16054 (t
16055 (setq tg (car e) c2 nil)
16056 (if (cdr e)
16057 (setq c (cdr e))
16058 ;; automatically assign a character.
16059 (setq c1 (string-to-char
16060 (downcase (substring
16061 tg (if (= (string-to-char tg) ?@) 1 0)))))
16062 (if (or (rassoc c1 ntable) (rassoc c1 table))
16063 (while (or (rassoc char ntable) (rassoc char table))
16064 (setq char (1+ char)))
16065 (setq c2 c1))
16066 (setq c (or c2 char)))
16067 (if ingroup (push tg (car groups)))
16068 (setq tg (org-add-props tg nil 'face
16069 (cond
16070 ((not (assoc tg table))
16071 (org-get-todo-face tg))
16072 ((member tg current) c-face)
16073 ((member tg inherited) i-face)
16074 (t nil))))
16075 (if (and (= cnt 0) (not ingroup)) (insert " "))
16076 (insert "[" c "] " tg (make-string
16077 (- fwidth 4 (length tg)) ?\ ))
16078 (push (cons tg c) ntable)
16079 (when (= (setq cnt (1+ cnt)) ncol)
16081 (if ingroup (insert " "))
16082 (setq cnt 0)))))
16083 (setq ntable (nreverse ntable))
16085 (goto-char (point-min))
16086 (if (and (not expert) (fboundp 'fit-window-to-buffer))
16087 (fit-window-to-buffer))
16088 (setq rtn
16089 (catch 'exit
16090 (while t
16091 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
16092 (if groups " [!] no groups" " [!]groups")
16093 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
16094 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
16095 (cond
16097 ((= c ?!)
16098 (setq groups (not groups))
16099 (goto-char (point-min))
16100 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
16101 ((= c ?\C-c)
16102 (if (not expert)
16103 (org-fast-tag-show-exit
16104 (setq exit-after-next (not exit-after-next)))
16105 (setq expert nil)
16106 (delete-other-windows)
16107 (split-window-vertically)
16108 (org-switch-to-buffer-other-window " *Org tags*")
16109 (and (fboundp 'fit-window-to-buffer)
16110 (fit-window-to-buffer))))
16111 ((or (= c ?\C-g)
16112 (and (= c ?q) (not (rassoc c ntable))))
16113 (org-detach-overlay org-tags-overlay)
16114 (setq quit-flag t))
16115 ((= c ?\ )
16116 (setq current nil)
16117 (if exit-after-next (setq exit-after-next 'now)))
16119 (condition-case nil
16120 (setq tg (completing-read
16121 "Tag: "
16122 (or buffer-tags
16123 (with-current-buffer buf
16124 (org-get-buffer-tags)))))
16125 (quit (setq tg "")))
16127 (add-to-list 'buffer-tags (list tg))
16128 (if (member tg current)
16129 (setq current (delete tg current))
16130 (push tg current)))
16131 (if exit-after-next (setq exit-after-next 'now)))
16132 ((setq e (rassoc c todo-table) tg (car e))
16133 (with-current-buffer buf
16134 (save-excursion (org-todo tg)))
16135 (if exit-after-next (setq exit-after-next 'now)))
16136 ((setq e (rassoc c ntable) tg (car e))
16137 (if (member tg current)
16138 (setq current (delete tg current))
16139 (loop for g in groups do
16140 (if (member tg g)
16141 (mapc (lambda (x)
16142 (setq current (delete x current)))
16143 g)))
16144 (push tg current))
16145 (if exit-after-next (setq exit-after-next 'now))))
16147 ;; Create a sorted list
16148 (setq current
16149 (sort current
16150 (lambda (a b)
16151 (assoc b (cdr (memq (assoc a ntable) ntable))))))
16152 (if (eq exit-after-next 'now) (throw 'exit t))
16153 (goto-char (point-min))
16154 (beginning-of-line 2)
16155 (delete-region (point) (point-at-eol))
16156 (org-fast-tag-insert "Current" current c-face)
16157 (org-set-current-tags-overlay current ov-prefix)
16158 (while (re-search-forward
16160 (setq tg (match-string 1))
16161 (add-text-properties
16162 (match-beginning 1) (match-end 1)
16163 (list 'face
16164 (cond
16165 ((member tg current) c-face)
16166 ((member tg inherited) i-face)
16167 (t (get-text-property (match-beginning 1) 'face))))))
16168 (goto-char (point-min)))))
16169 (org-detach-overlay org-tags-overlay)
16170 (if rtn
16171 (mapconcat 'identity current ":")
16172 nil))))
16174 (defun org-get-tags-string ()
16175 "Get the TAGS string in the current headline."
16176 (unless (org-on-heading-p t)
16177 (error "Not on a heading"))
16178 (save-excursion
16179 (beginning-of-line 1)
16181 (org-match-string-no-properties 1)
16182 "")))
16184 (defun org-get-tags ()
16185 "Get the list of tags specified in the current headline."
16186 (org-split-string (org-get-tags-string) ":"))
16188 (defun org-get-buffer-tags ()
16189 "Get a table of all tags used in the buffer, for completion."
16190 (let (tags)
16191 (save-excursion
16192 (goto-char (point-min))
16193 (while (re-search-forward
16195 (when (equal (char-after (point-at-bol 0)) ?*)
16196 (mapc (lambda (x) (add-to-list 'tags x))
16197 (org-split-string (org-match-string-no-properties 1) ":")))))
16198 (mapcar 'list tags)))
16201 ;;;; Properties
16203 ;;; Setting and retrieving properties
16205 (defconst org-special-properties
16206 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
16207 "TIMESTAMP" "TIMESTAMP_IA")
16208 "The special properties valid in Org-mode.
16210 These are properties that are not defined in the property drawer,
16211 but in some other way.")
16213 (defconst org-default-properties
16214 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
16215 "LOCATION" "LOGGING" "COLUMNS")
16216 "Some properties that are used by Org-mode for various purposes.
16217 Being in this list makes sure that they are offered for completion.")
16220 "Regular expression matching the first line of a property drawer.")
16223 "Regular expression matching the first line of a property drawer.")
16225 (defun org-property-action ()
16226 "Do an action on properties."
16227 (interactive)
16228 (let (c)
16229 (org-at-property-p)
16230 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
16231 (setq c (read-char-exclusive))
16232 (cond
16233 ((equal c ?s)
16234 (call-interactively 'org-set-property))
16235 ((equal c ?d)
16236 (call-interactively 'org-delete-property))
16237 ((equal c ?D)
16238 (call-interactively 'org-delete-property-globally))
16239 ((equal c ?c)
16240 (call-interactively 'org-compute-property-at-point))
16241 (t (error "No such property action %c" c)))))
16243 (defun org-at-property-p ()
16244 "Is the cursor in a property line?"
16245 ;; FIXME: Does not check if we are actually in the drawer.
16246 ;; FIXME: also returns true on any drawers.....
16247 ;; This is used by C-c C-c for property action.
16248 (save-excursion
16249 (beginning-of-line 1)
16252 (defmacro org-with-point-at (pom &rest body)
16253 "Move to buffer and point of point-or-marker POM for the duration of BODY."
16254 (declare (indent 1) (debug t))
16255 `(save-excursion
16256 (if (markerp pom) (set-buffer (marker-buffer pom)))
16257 (save-excursion
16258 (goto-char (or pom (point)))
16259 ,@body)))
16261 (defun org-get-property-block (&optional beg end force)
16262 "Return the (beg . end) range of the body of the property drawer.
16263 BEG and END can be beginning and end of subtree, if not given
16264 they will be found.
16265 If the drawer does not exist and FORCE is non-nil, create the drawer."
16266 (catch 'exit
16267 (save-excursion
16268 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
16269 (end (or end (progn (outline-next-heading) (point)))))
16270 (goto-char beg)
16271 (if (re-search-forward org-property-start-re end t)
16272 (setq beg (1+ (match-end 0)))
16273 (if force
16274 (save-excursion
16275 (org-insert-property-drawer)
16276 (setq end (progn (outline-next-heading) (point))))
16277 (throw 'exit nil))
16278 (goto-char beg)
16279 (if (re-search-forward org-property-start-re end t)
16280 (setq beg (1+ (match-end 0)))))
16281 (if (re-search-forward org-property-end-re end t)
16282 (setq end (match-beginning 0))
16283 (or force (throw 'exit nil))
16284 (goto-char beg)
16285 (setq end beg)
16286 (org-indent-line-function)
16288 (cons beg end)))))
16290 (defun org-entry-properties (&optional pom which)
16291 "Get all properties of the entry at point-or-marker POM.
16292 This includes the TODO keyword, the tags, time strings for deadline,
16293 scheduled, and clocking, and any additional properties defined in the
16294 entry. The return value is an alist, keys may occur multiple times
16295 if the property key was used several times.
16296 POM may also be nil, in which case the current entry is used.
16297 If WHICH is nil or `all', get all properties. If WHICH is
16298 `special' or `standard', only get that subclass."
16299 (setq which (or which 'all))
16300 (org-with-point-at pom
16301 (let ((clockstr (substring org-clock-string 0 -1))
16302 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
16303 beg end range props sum-props key value string clocksum)
16304 (save-excursion
16305 (when (condition-case nil (org-back-to-heading t) (error nil))
16306 (setq beg (point))
16307 (setq sum-props (get-text-property (point) 'org-summaries))
16308 (setq clocksum (get-text-property (point) :org-clock-minutes))
16309 (outline-next-heading)
16310 (setq end (point))
16311 (when (memq which '(all special))
16312 ;; Get the special properties, like TODO and tags
16313 (goto-char beg)
16314 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16315 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16316 (when (looking-at org-priority-regexp)
16317 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16318 (when (and (setq value (org-get-tags-string))
16320 (push (cons "TAGS" value) props))
16321 (when (setq value (org-get-tags-at))
16322 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16323 props))
16324 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16325 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16326 string (if (equal key clockstr)
16327 (org-no-properties
16328 (org-trim
16329 (buffer-substring
16330 (match-beginning 3) (goto-char (point-at-eol)))))
16331 (substring (org-match-string-no-properties 3) 1 -1)))
16332 (unless key
16333 (if (= (char-after (match-beginning 3)) ?\[)
16334 (setq key "TIMESTAMP_IA")
16335 (setq key "TIMESTAMP")))
16336 (when (or (equal key clockstr) (not (assoc key props)))
16337 (push (cons key string) props)))
16339 )
16341 (when (memq which '(all standard))
16342 ;; Get the standard properties, like :PORP: ...
16343 (setq range (org-get-property-block beg end))
16344 (when range
16345 (goto-char (car range))
16346 (while (re-search-forward
16348 (cdr range) t)
16349 (setq key (org-match-string-no-properties 1)
16350 value (org-trim (or (org-match-string-no-properties 2) "")))
16351 (unless (member key excluded)
16352 (push (cons key (or value "")) props)))))
16353 (if clocksum
16354 (push (cons "CLOCKSUM"
16355 (org-column-number-to-string (/ (float clocksum) 60.)
16356 'add_times))
16357 props))
16358 (append sum-props (nreverse props)))))))
16360 (defun org-entry-get (pom property &optional inherit)
16361 "Get value of PROPERTY for entry at point-or-marker POM.
16362 If INHERIT is non-nil and the entry does not have the property,
16363 then also check higher levels of the hierarchy.
16364 If the property is present but empty, the return value is the empty string.
16365 If the property is not present at all, nil is returned."
16366 (org-with-point-at pom
16367 (if inherit
16368 (org-entry-get-with-inheritance property)
16369 (if (member property org-special-properties)
16370 ;; We need a special property. Use brute force, get all properties.
16371 (cdr (assoc property (org-entry-properties nil 'special)))
16372 (let ((range (org-get-property-block)))
16373 (if (and range
16374 (goto-char (car range))
16375 (re-search-forward
16377 (cdr range) t))
16378 ;; Found the property, return it.
16379 (if (match-end 1)
16380 (org-match-string-no-properties 1)
16381 "")))))))
16383 (defun org-entry-delete (pom property)
16384 "Delete the property PROPERTY from entry at point-or-marker POM."
16385 (org-with-point-at pom
16386 (if (member property org-special-properties)
16387 nil ; cannot delete these properties.
16388 (let ((range (org-get-property-block)))
16389 (if (and range
16390 (goto-char (car range))
16391 (re-search-forward
16393 (cdr range) t))
16394 (progn
16395 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16396 t)
16397 nil)))))
16399 ;; Multi-values properties are properties that contain multiple values
16400 ;; These values are assumed to be single words, separated by whitespace.
16401 (defun org-entry-add-to-multivalued-property (pom property value)
16402 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16403 (let* ((old (org-entry-get pom property))
16405 (unless (member value values)
16406 (setq values (cons value values))
16407 (org-entry-put pom property
16408 (mapconcat 'identity values " ")))))
16410 (defun org-entry-remove-from-multivalued-property (pom property value)
16411 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16412 (let* ((old (org-entry-get pom property))
16414 (when (member value values)
16415 (setq values (delete value values))
16416 (org-entry-put pom property
16417 (mapconcat 'identity values " ")))))
16419 (defun org-entry-member-in-multivalued-property (pom property value)
16420 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16421 (let* ((old (org-entry-get pom property))
16423 (member value values)))
16425 (defvar org-entry-property-inherited-from (make-marker))
16427 (defun org-entry-get-with-inheritance (property)
16428 "Get entry property, and search higher levels if not present."
16429 (let (tmp)
16430 (save-excursion
16431 (save-restriction
16432 (widen)
16433 (catch 'ex
16434 (while t
16435 (when (setq tmp (org-entry-get nil property))
16436 (org-back-to-heading t)
16437 (move-marker org-entry-property-inherited-from (point))
16438 (throw 'ex tmp))
16439 (or (org-up-heading-safe) (throw 'ex nil)))))
16440 (or tmp (cdr (assoc property org-local-properties))
16441 (cdr (assoc property org-global-properties))))))
16443 (defun org-entry-put (pom property value)
16444 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16445 (org-with-point-at pom
16446 (org-back-to-heading t)
16447 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16448 range)
16449 (cond
16450 ((equal property "TODO")
16452 (not (member value org-todo-keywords-1)))
16454 (if (or (not value)
16456 (setq value 'none))
16457 (org-todo value)
16458 (org-set-tags nil 'align))
16459 ((equal property "PRIORITY")
16461 (string-to-char value) ?\ ))
16462 (org-set-tags nil 'align))
16463 ((equal property "SCHEDULED")
16464 (if (re-search-forward org-scheduled-time-regexp end t)
16465 (cond
16466 ((eq value 'earlier) (org-timestamp-change -1 'day))
16467 ((eq value 'later) (org-timestamp-change 1 'day))
16468 (t (call-interactively 'org-schedule)))
16469 (call-interactively 'org-schedule)))
16470 ((equal property "DEADLINE")
16471 (if (re-search-forward org-deadline-time-regexp end t)
16472 (cond
16473 ((eq value 'earlier) (org-timestamp-change -1 'day))
16474 ((eq value 'later) (org-timestamp-change 1 'day))
16475 (t (call-interactively 'org-deadline)))
16476 (call-interactively 'org-deadline)))
16477 ((member property org-special-properties)
16478 (error "The %s property can not yet be set with `org-entry-put'"
16479 property))
16480 (t ; a non-special property
16481 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16482 (setq range (org-get-property-block beg end 'force))
16483 (goto-char (car range))
16484 (if (re-search-forward
16486 (progn
16487 (delete-region (match-beginning 1) (match-end 1))
16488 (goto-char (match-beginning 1)))
16489 (goto-char (cdr range))
16491 (backward-char 1)
16492 (org-indent-line-function)
16493 (insert ":" property ":"))
16494 (and value (insert " " value))
16495 (org-indent-line-function)))))))
16497 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16498 "Get all property keys in the current buffer.
16499 With INCLUDE-SPECIALS, also list the special properties that relect things
16500 like tags and TODO state.
16501 With INCLUDE-DEFAULTS, also include properties that has special meaning
16502 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16503 With INCLUDE-COLUMNS, also include property names given in COLUMN
16504 formats in the current buffer."
16505 (let (rtn range cfmt cols s p)
16506 (save-excursion
16507 (save-restriction
16508 (widen)
16509 (goto-char (point-min))
16510 (while (re-search-forward org-property-start-re nil t)
16511 (setq range (org-get-property-block))
16512 (goto-char (car range))
16513 (while (re-search-forward
16515 (cdr range) t)
16516 (add-to-list 'rtn (org-match-string-no-properties 1)))
16517 (outline-next-heading))))
16519 (when include-specials
16520 (setq rtn (append org-special-properties rtn)))
16522 (when include-defaults
16523 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16525 (when include-columns
16526 (save-excursion
16527 (save-restriction
16528 (widen)
16529 (goto-char (point-min))
16530 (while (re-search-forward
16532 nil t)
16533 (setq cfmt (match-string 2) s 0)
16535 cfmt s)
16536 (setq s (match-end 0)
16537 p (match-string 1 cfmt))
16538 (unless (or (equal p "ITEM")
16539 (member p org-special-properties))
16540 (add-to-list 'rtn (match-string 1 cfmt))))))))
16542 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16544 (defun org-property-values (key)
16545 "Return a list of all values of property KEY."
16546 (save-excursion
16547 (save-restriction
16548 (widen)
16549 (goto-char (point-min))
16551 values)
16552 (while (re-search-forward re nil t)
16553 (add-to-list 'values (org-trim (match-string 1))))
16554 (delete "" values)))))
16556 (defun org-insert-property-drawer ()
16557 "Insert a property drawer into the current entry."
16558 (interactive)
16559 (org-back-to-heading t)
16560 (looking-at outline-regexp)
16561 (let ((indent (- (match-end 0)(match-beginning 0)))
16562 (beg (point))
16564 end hiddenp)
16565 (outline-next-heading)
16566 (setq end (point))
16567 (goto-char beg)
16568 (while (re-search-forward re end t))
16569 (setq hiddenp (org-invisible-p))
16570 (end-of-line 1)
16572 (org-skip-over-state-notes)
16574 (if (eq (char-before) ?*) (forward-char 1))
16576 (beginning-of-line 0)
16577 (indent-to-column indent)
16578 (beginning-of-line 2)
16579 (indent-to-column indent)
16580 (beginning-of-line 0)
16581 (if hiddenp
16582 (save-excursion
16583 (org-back-to-heading t)
16584 (hide-entry))
16585 (org-flag-drawer t))))
16587 (defun org-set-property (property value)
16588 "In the current entry, set PROPERTY to VALUE.
16589 When called interactively, this will prompt for a property name, offering
16590 completion on existing and default properties. And then it will prompt
16591 for a value, offering competion either on allowed values (via an inherited
16592 xxx_ALL property) or on existing values in other instances of this property
16593 in the current file."
16594 (interactive
16595 (let* ((prop (completing-read
16596 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16597 (cur (org-entry-get nil prop))
16598 (allowed (org-property-get-allowed-values nil prop 'table))
16599 (existing (mapcar 'list (org-property-values prop)))
16600 (val (if allowed
16601 (completing-read "Value: " allowed nil 'req-match)
16602 (completing-read
16604 (concat "[" cur "]") "")
16605 ": ")
16606 existing nil nil "" nil cur))))
16607 (list prop (if (equal val "") cur val))))
16608 (unless (equal (org-entry-get nil property) value)
16609 (org-entry-put nil property value)))
16611 (defun org-delete-property (property)
16612 "In the current entry, delete PROPERTY."
16613 (interactive
16614 (let* ((prop (completing-read
16615 "Property: " (org-entry-properties nil 'standard))))
16616 (list prop)))
16617 (message "Property %s %s" property
16618 (if (org-entry-delete nil property)
16619 "deleted"
16620 "was not present in the entry")))
16622 (defun org-delete-property-globally (property)
16623 "Remove PROPERTY globally, from all entries."
16624 (interactive
16625 (let* ((prop (completing-read
16626 "Globally remove property: "
16627 (mapcar 'list (org-buffer-property-keys)))))
16628 (list prop)))
16629 (save-excursion
16630 (save-restriction
16631 (widen)
16632 (goto-char (point-min))
16633 (let ((cnt 0))
16634 (while (re-search-forward
16636 nil t)
16637 (setq cnt (1+ cnt))
16638 (replace-match ""))
16641 (defvar org-columns-current-fmt-compiled) ; defined below
16643 (defun org-compute-property-at-point ()
16644 "Compute the property at point.
16645 This looks for an enclosing column format, extracts the operator and
16646 then applies it to the proerty in the column format's scope."
16647 (interactive)
16648 (unless (org-at-property-p)
16649 (error "Not at a property"))
16650 (let ((prop (org-match-string-no-properties 2)))
16651 (org-columns-get-format-and-top-level)
16652 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16653 (error "No operator defined for property %s" prop))
16654 (org-columns-compute prop)))
16656 (defun org-property-get-allowed-values (pom property &optional table)
16657 "Get allowed values for the property PROPERTY.
16658 When TABLE is non-nil, return an alist that can directly be used for
16659 completion."
16660 (let (vals)
16661 (cond
16662 ((equal property "TODO")
16663 (setq vals (org-with-point-at pom
16664 (append org-todo-keywords-1 '("")))))
16665 ((equal property "PRIORITY")
16666 (let ((n org-lowest-priority))
16667 (while (>= n org-highest-priority)
16668 (push (char-to-string n) vals)
16669 (setq n (1- n)))))
16670 ((member property org-special-properties))
16671 (t
16672 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16675 (setq vals (car (read-from-string (concat "(" vals ")"))))
16676 (setq vals (mapcar (lambda (x)
16677 (cond ((stringp x) x)
16678 ((numberp x) (number-to-string x))
16679 ((symbolp x) (symbol-name x))
16680 (t "???")))
16681 vals)))))
16682 (if table (mapcar 'list vals) vals)))
16684 (defun org-property-previous-allowed-value (&optional previous)
16685 "Switch to the next allowed value for this property."
16686 (interactive)
16687 (org-property-next-allowed-value t))
16689 (defun org-property-next-allowed-value (&optional previous)
16690 "Switch to the next allowed value for this property."
16691 (interactive)
16692 (unless (org-at-property-p)
16693 (error "Not at a property"))
16694 (let* ((key (match-string 2))
16695 (value (match-string 3))
16696 (allowed (or (org-property-get-allowed-values (point) key)
16697 (and (member value '("[ ]" "[-]" "[X]"))
16698 '("[ ]" "[X]"))))
16699 nval)
16700 (unless allowed
16701 (error "Allowed values for this property have not been defined"))
16702 (if previous (setq allowed (reverse allowed)))
16703 (if (member value allowed)
16704 (setq nval (car (cdr (member value allowed)))))
16705 (setq nval (or nval (car allowed)))
16706 (if (equal nval value)
16707 (error "Only one allowed value for this property"))
16708 (org-at-property-p)
16709 (replace-match (concat " :" key ": " nval) t t)
16710 (org-indent-line-function)
16711 (beginning-of-line 1)
16714 (defun org-find-entry-with-id (ident)
16715 "Locate the entry that contains the ID property with exact value IDENT.
16716 IDENT can be a string, a symbol or a number, this function will search for
16717 the string representation of it.
16718 Return the position where this entry starts, or nil if there is no such entry."
16719 (let ((id (cond
16720 ((stringp ident) ident)
16721 ((symbol-name ident) (symbol-name ident))
16722 ((numberp ident) (number-to-string ident))
16723 (t (error "IDENT %s must be a string, symbol or number" ident))))
16724 (case-fold-search nil))
16725 (save-excursion
16726 (save-restriction
16727 (widen)
16728 (goto-char (point-min))
16729 (when (re-search-forward
16731 nil t)
16732 (org-back-to-heading)
16733 (point))))))
16735 ;;; Column View
16737 (defvar org-columns-overlays nil
16738 "Holds the list of current column overlays.")
16740 (defvar org-columns-current-fmt nil
16741 "Local variable, holds the currently active column format.")
16742 (defvar org-columns-current-fmt-compiled nil
16743 "Local variable, holds the currently active column format.
16744 This is the compiled version of the format.")
16745 (defvar org-columns-current-widths nil
16746 "Loval variable, holds the currently widths of fields.")
16747 (defvar org-columns-current-maxwidths nil
16748 "Loval variable, holds the currently active maximum column widths.")
16749 (defvar org-columns-begin-marker (make-marker)
16750 "Points to the position where last a column creation command was called.")
16751 (defvar org-columns-top-level-marker (make-marker)
16752 "Points to the position where current columns region starts.")
16754 (defvar org-columns-map (make-sparse-keymap)
16755 "The keymap valid in column display.")
16757 (defun org-columns-content ()
16758 "Switch to contents view while in columns view."
16759 (interactive)
16760 (org-overview)
16761 (org-content))
16763 (org-defkey org-columns-map "c" 'org-columns-content)
16764 (org-defkey org-columns-map "o" 'org-overview)
16765 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16766 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16767 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16768 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16769 (org-defkey org-columns-map "v" 'org-columns-show-value)
16770 (org-defkey org-columns-map "q" 'org-columns-quit)
16771 (org-defkey org-columns-map "r" 'org-columns-redo)
16772 (org-defkey org-columns-map "g" 'org-columns-redo)
16773 (org-defkey org-columns-map [left] 'backward-char)
16774 (org-defkey org-columns-map "\M-b" 'backward-char)
16775 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16776 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16777 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16778 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16779 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16780 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16781 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16782 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16783 (org-defkey org-columns-map "<" 'org-columns-narrow)
16784 (org-defkey org-columns-map ">" 'org-columns-widen)
16785 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16786 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16787 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16788 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16790 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16791 '("Column"
16792 ["Edit property" org-columns-edit-value t]
16793 ["Next allowed value" org-columns-next-allowed-value t]
16794 ["Previous allowed value" org-columns-previous-allowed-value t]
16795 ["Show full value" org-columns-show-value t]
16796 ["Edit allowed values" org-columns-edit-allowed t]
16797 "--"
16798 ["Edit column attributes" org-columns-edit-attributes t]
16799 ["Increase column width" org-columns-widen t]
16800 ["Decrease column width" org-columns-narrow t]
16801 "--"
16802 ["Move column right" org-columns-move-right t]
16803 ["Move column left" org-columns-move-left t]
16804 ["Add column" org-columns-new t]
16805 ["Delete column" org-columns-delete t]
16806 "--"
16807 ["CONTENTS" org-columns-content t]
16808 ["OVERVIEW" org-overview t]
16809 ["Refresh columns display" org-columns-redo t]
16810 "--"
16811 ["Open link" org-columns-open-link t]
16812 "--"
16813 ["Quit" org-columns-quit t]))
16815 (defun org-columns-new-overlay (beg end &optional string face)
16816 "Create a new column overlay and add it to the list."
16817 (let ((ov (org-make-overlay beg end)))
16818 (org-overlay-put ov 'face (or face 'secondary-selection))
16819 (org-overlay-display ov string face)
16820 (push ov org-columns-overlays)
16821 ov))
16823 (defun org-columns-display-here (&optional props)
16824 "Overlay the current line with column display."
16825 (interactive)
16826 (let* ((fmt org-columns-current-fmt-compiled)
16827 (beg (point-at-bol))
16828 (level-face (save-excursion
16829 (beginning-of-line 1)
16831 (org-get-level-face 2))))
16832 (color (list :foreground
16833 (face-attribute (or level-face 'default) :foreground)))
16834 props pom property ass width f string ov column val modval)
16835 ;; Check if the entry is in another buffer.
16836 (unless props
16837 (if (eq major-mode 'org-agenda-mode)
16838 (setq pom (or (get-text-property (point) 'org-hd-marker)
16839 (get-text-property (point) 'org-marker))
16840 props (if pom (org-entry-properties pom) nil))
16841 (setq props (org-entry-properties nil))))
16842 ;; Walk the format
16843 (while (setq column (pop fmt))
16844 (setq property (car column)
16845 ass (if (equal property "ITEM")
16846 (cons "ITEM"
16847 (save-match-data
16848 (org-no-properties
16849 (org-remove-tabs
16850 (buffer-substring-no-properties
16851 (point-at-bol) (point-at-eol))))))
16852 (assoc property props))
16853 width (or (cdr (assoc property org-columns-current-maxwidths))
16854 (nth 2 column)
16855 (length property))
16856 f (format "%%-%d.%ds | " width width)
16857 val (or (cdr ass) "")
16858 modval (if (equal property "ITEM")
16859 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16860 string (format f (or modval val)))
16861 ;; Create the overlay
16862 (org-unmodified
16863 (setq ov (org-columns-new-overlay
16864 beg (setq beg (1+ beg)) string
16865 (list color 'org-column)))
16866 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16867 (org-overlay-put ov 'keymap org-columns-map)
16868 (org-overlay-put ov 'org-columns-key property)
16869 (org-overlay-put ov 'org-columns-value (cdr ass))
16870 (org-overlay-put ov 'org-columns-value-modified modval)
16871 (org-overlay-put ov 'org-columns-pom pom)
16872 (org-overlay-put ov 'org-columns-format f))
16873 (if (or (not (char-after beg))
16875 (let ((inhibit-read-only t))
16876 (save-excursion
16877 (goto-char beg)
16878 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16879 ;; Make the rest of the line disappear.
16880 (org-unmodified
16881 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16882 (org-overlay-put ov 'invisible t)
16883 (org-overlay-put ov 'keymap org-columns-map)
16884 (org-overlay-put ov 'intangible t)
16885 (push ov org-columns-overlays)
16886 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16887 (org-overlay-put ov 'keymap org-columns-map)
16888 (push ov org-columns-overlays)
16889 (let ((inhibit-read-only t))
16890 (put-text-property (max (point-min) (1- (point-at-bol)))
16891 (min (point-max) (1+ (point-at-eol)))
16892 'read-only "Type `e' to edit property")))))
16894 (defvar org-previous-header-line-format nil
16895 "The header line format before column view was turned on.")
16896 (defvar org-columns-inhibit-recalculation nil
16897 "Inhibit recomputing of columns on column view startup.")
16900 (defvar header-line-format)
16901 (defun org-columns-display-here-title ()
16902 "Overlay the newline before the current line with the table title."
16903 (interactive)
16904 (let ((fmt org-columns-current-fmt-compiled)
16905 string (title "")
16906 property width f column str widths)
16907 (while (setq column (pop fmt))
16908 (setq property (car column)
16909 str (or (nth 1 column) property)
16910 width (or (cdr (assoc property org-columns-current-maxwidths))
16911 (nth 2 column)
16912 (length str))
16913 widths (push width widths)
16914 f (format "%%-%d.%ds | " width width)
16915 string (format f str)
16916 title (concat title string)))
16917 (setq title (concat
16918 (org-add-props " " nil 'display '(space :align-to 0))
16919 (org-add-props title nil 'face '(:weight bold :underline t))))
16920 (org-set-local 'org-previous-header-line-format header-line-format)
16921 (org-set-local 'org-columns-current-widths (nreverse widths))
16922 (setq header-line-format title)))
16924 (defun org-columns-remove-overlays ()
16925 "Remove all currently active column overlays."
16926 (interactive)
16927 (when (marker-buffer org-columns-begin-marker)
16928 (with-current-buffer (marker-buffer org-columns-begin-marker)
16929 (when (local-variable-p 'org-previous-header-line-format)
16930 (setq header-line-format org-previous-header-line-format)
16931 (kill-local-variable 'org-previous-header-line-format))
16932 (move-marker org-columns-begin-marker nil)
16933 (move-marker org-columns-top-level-marker nil)
16934 (org-unmodified
16935 (mapc 'org-delete-overlay org-columns-overlays)
16936 (setq org-columns-overlays nil)
16937 (let ((inhibit-read-only t))
16938 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16940 (defun org-columns-cleanup-item (item fmt)
16941 "Remove from ITEM what is a column in the format FMT."
16942 (if (not org-complex-heading-regexp)
16943 item
16944 (when (string-match org-complex-heading-regexp item)
16945 (concat
16946 (org-add-props (concat (match-string 1 item) " ") nil
16947 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16948 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16949 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16950 " " (match-string 4 item)
16951 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16953 (defun org-columns-show-value ()
16954 "Show the full value of the property."
16955 (interactive)
16956 (let ((value (get-char-property (point) 'org-columns-value)))
16957 (message "Value is: %s" (or value ""))))
16959 (defun org-columns-quit ()
16960 "Remove the column overlays and in this way exit column editing."
16961 (interactive)
16962 (org-unmodified
16963 (org-columns-remove-overlays)
16964 (let ((inhibit-read-only t))
16965 (remove-text-properties (point-min) (point-max) '(read-only t))))
16966 (when (eq major-mode 'org-agenda-mode)
16967 (message
16968 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16970 (defun org-columns-check-computed ()
16971 "Check if this column value is computed.
16972 If yes, throw an error indicating that changing it does not make sense."
16973 (let ((val (get-char-property (point) 'org-columns-value)))
16974 (when (and (stringp val)
16975 (get-char-property 0 'org-computed val))
16976 (error "This value is computed from the entry's children"))))
16978 (defun org-columns-todo (&optional arg)
16979 "Change the TODO state during column view."
16980 (interactive "P")
16981 (org-columns-edit-value "TODO"))
16983 (defun org-columns-set-tags-or-toggle (&optional arg)
16984 "Toggle checkbox at point, or set tags for current headline."
16985 (interactive "P")
16987 (get-char-property (point) 'org-columns-value))
16988 (org-columns-next-allowed-value)
16989 (org-columns-edit-value "TAGS")))
16991 (defun org-columns-edit-value (&optional key)
16992 "Edit the value of the property at point in column view.
16993 Where possible, use the standard interface for changing this line."
16994 (interactive)
16995 (org-columns-check-computed)
16996 (let* ((external-key key)
16997 (col (current-column))
16998 (key (or key (get-char-property (point) 'org-columns-key)))
16999 (value (get-char-property (point) 'org-columns-value))
17000 (bol (point-at-bol)) (eol (point-at-eol))
17001 (pom (or (get-text-property bol 'org-hd-marker)
17002 (point))) ; keep despite of compiler waring
17003 (line-overlays
17004 (delq nil (mapcar (lambda (x)
17005 (and (eq (overlay-buffer x) (current-buffer))
17006 (>= (overlay-start x) bol)
17007 (<= (overlay-start x) eol)
17008 x))
17009 org-columns-overlays)))
17010 nval eval allowed)
17011 (cond
17012 ((equal key "CLOCKSUM")
17013 (error "This special column cannot be edited"))
17014 ((equal key "ITEM")
17015 (setq eval '(org-with-point-at pom
17016 (org-edit-headline))))
17017 ((equal key "TODO")
17018 (setq eval '(org-with-point-at pom
17019 (let ((current-prefix-arg
17020 (if external-key current-prefix-arg '(4))))
17021 (call-interactively 'org-todo)))))
17022 ((equal key "PRIORITY")
17023 (setq eval '(org-with-point-at pom
17024 (call-interactively 'org-priority))))
17025 ((equal key "TAGS")
17026 (setq eval '(org-with-point-at pom
17027 (let ((org-fast-tag-selection-single-key
17028 (if (eq org-fast-tag-selection-single-key 'expert)
17029 t org-fast-tag-selection-single-key)))
17030 (call-interactively 'org-set-tags)))))
17031 ((equal key "DEADLINE")
17032 (setq eval '(org-with-point-at pom
17033 (call-interactively 'org-deadline))))
17034 ((equal key "SCHEDULED")
17035 (setq eval '(org-with-point-at pom
17036 (call-interactively 'org-schedule))))
17037 (t
17038 (setq allowed (org-property-get-allowed-values pom key 'table))
17039 (if allowed
17040 (setq nval (completing-read "Value: " allowed nil t))
17041 (setq nval (read-string "Edit: " value)))
17042 (setq nval (org-trim nval))
17043 (when (not (equal nval value))
17044 (setq eval '(org-entry-put pom key nval)))))
17045 (when eval
17046 (let ((inhibit-read-only t))
17047 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
17048 (unwind-protect
17049 (progn
17050 (setq org-columns-overlays
17051 (org-delete-all line-overlays org-columns-overlays))
17052 (mapc 'org-delete-overlay line-overlays)
17053 (org-columns-eval eval))
17054 (org-columns-display-here))))
17055 (move-to-column col)
17056 (if (and (org-mode-p)
17057 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17058 (org-columns-update key))))
17060 (defun org-edit-headline () ; FIXME: this is not columns specific
17061 "Edit the current headline, the part without TODO keyword, TAGS."
17062 (org-back-to-heading)
17063 (when (looking-at org-todo-line-regexp)
17064 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
17065 (txt (match-string 3))
17066 (post "")
17067 txt2)
17069 (setq post (match-string 0 txt)
17070 txt (substring txt 0 (match-beginning 0))))
17071 (setq txt2 (read-string "Edit: " txt))
17072 (when (not (equal txt txt2))
17073 (beginning-of-line 1)
17074 (insert pre txt2 post)
17075 (delete-region (point) (point-at-eol))
17076 (org-set-tags nil t)))))
17078 (defun org-columns-edit-allowed ()
17079 "Edit the list of allowed values for the current property."
17080 (interactive)
17081 (let* ((key (get-char-property (point) 'org-columns-key))
17082 (key1 (concat key "_ALL"))
17083 (allowed (org-entry-get (point) key1 t))
17084 nval)
17085 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
17086 (setq nval (read-string "Allowed: " allowed))
17087 (org-entry-put
17088 (cond ((marker-position org-entry-property-inherited-from)
17089 org-entry-property-inherited-from)
17090 ((marker-position org-columns-top-level-marker)
17091 org-columns-top-level-marker))
17092 key1 nval)))
17094 (defmacro org-no-warnings (&rest body)
17095 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
17097 (defun org-columns-eval (form)
17098 (let (hidep)
17099 (save-excursion
17100 (beginning-of-line 1)
17101 ;; `next-line' is needed here, because it skips invisible line.
17102 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
17103 (setq hidep (org-on-heading-p 1)))
17104 (eval form)
17105 (and hidep (hide-entry))))
17107 (defun org-columns-previous-allowed-value ()
17108 "Switch to the previous allowed value for this column."
17109 (interactive)
17110 (org-columns-next-allowed-value t))
17112 (defun org-columns-next-allowed-value (&optional previous)
17113 "Switch to the next allowed value for this column."
17114 (interactive)
17115 (org-columns-check-computed)
17116 (let* ((col (current-column))
17117 (key (get-char-property (point) 'org-columns-key))
17118 (value (get-char-property (point) 'org-columns-value))
17119 (bol (point-at-bol)) (eol (point-at-eol))
17120 (pom (or (get-text-property bol 'org-hd-marker)
17121 (point))) ; keep despite of compiler waring
17122 (line-overlays
17123 (delq nil (mapcar (lambda (x)
17124 (and (eq (overlay-buffer x) (current-buffer))
17125 (>= (overlay-start x) bol)
17126 (<= (overlay-start x) eol)
17127 x))
17128 org-columns-overlays)))
17129 (allowed (or (org-property-get-allowed-values pom key)
17130 (and (memq
17131 (nth 4 (assoc key org-columns-current-fmt-compiled))
17132 '(checkbox checkbox-n-of-m checkbox-percent))
17133 '("[ ]" "[X]"))))
17134 nval)
17135 (when (equal key "ITEM")
17136 (error "Cannot edit item headline from here"))
17137 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
17138 (error "Allowed values for this property have not been defined"))
17139 (if (member key '("SCHEDULED" "DEADLINE"))
17140 (setq nval (if previous 'earlier 'later))
17141 (if previous (setq allowed (reverse allowed)))
17142 (if (member value allowed)
17143 (setq nval (car (cdr (member value allowed)))))
17144 (setq nval (or nval (car allowed)))
17145 (if (equal nval value)
17146 (error "Only one allowed value for this property")))
17147 (let ((inhibit-read-only t))
17148 (remove-text-properties (1- bol) eol '(read-only t))
17149 (unwind-protect
17150 (progn
17151 (setq org-columns-overlays
17152 (org-delete-all line-overlays org-columns-overlays))
17153 (mapc 'org-delete-overlay line-overlays)
17154 (org-columns-eval '(org-entry-put pom key nval)))
17155 (org-columns-display-here)))
17156 (move-to-column col)
17157 (if (and (org-mode-p)
17158 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17159 (org-columns-update key))))
17161 (defun org-verify-version (task)
17162 (cond
17163 ((eq task 'columns)
17164 (if (or (featurep 'xemacs)
17165 (< emacs-major-version 22))
17166 (error "Emacs 22 is required for the columns feature")))))
17168 (defun org-columns-open-link (&optional arg)
17169 (interactive "P")
17170 (let ((value (get-char-property (point) 'org-columns-value)))
17171 (org-open-link-from-string value arg)))
17173 (defun org-open-link-from-string (s &optional arg)
17174 "Open a link in the string S, as if it was in Org-mode."
17175 (interactive)
17176 (with-temp-buffer
17177 (let ((org-inhibit-startup t))
17178 (org-mode)
17179 (insert s)
17180 (goto-char (point-min))
17181 (org-open-at-point arg))))
17183 (defun org-columns-get-format-and-top-level ()
17184 (let (fmt)
17185 (when (condition-case nil (org-back-to-heading) (error nil))
17186 (move-marker org-entry-property-inherited-from nil)
17187 (setq fmt (org-entry-get nil "COLUMNS" t)))
17188 (setq fmt (or fmt org-columns-default-format))
17189 (org-set-local 'org-columns-current-fmt fmt)
17190 (org-columns-compile-format fmt)
17191 (if (marker-position org-entry-property-inherited-from)
17192 (move-marker org-columns-top-level-marker
17193 org-entry-property-inherited-from)
17194 (move-marker org-columns-top-level-marker (point)))
17195 fmt))
17197 (defun org-columns ()
17198 "Turn on column view on an org-mode file."
17199 (interactive)
17200 (org-verify-version 'columns)
17201 (org-columns-remove-overlays)
17202 (move-marker org-columns-begin-marker (point))
17203 (let (beg end fmt cache maxwidths)
17204 (setq fmt (org-columns-get-format-and-top-level))
17205 (save-excursion
17206 (goto-char org-columns-top-level-marker)
17207 (setq beg (point))
17208 (unless org-columns-inhibit-recalculation
17209 (org-columns-compute-all))
17210 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
17211 (point-max)))
17212 ;; Get and cache the properties
17213 (goto-char beg)
17214 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
17215 (save-excursion
17216 (save-restriction
17217 (narrow-to-region beg end)
17218 (org-clock-sum))))
17219 (while (re-search-forward (concat "^" outline-regexp) end t)
17220 (push (cons (org-current-line) (org-entry-properties)) cache))
17221 (when cache
17222 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17223 (org-set-local 'org-columns-current-maxwidths maxwidths)
17224 (org-columns-display-here-title)
17225 (mapc (lambda (x)
17226 (goto-line (car x))
17227 (org-columns-display-here (cdr x)))
17228 cache)))))
17230 (defun org-columns-new (&optional prop title width op fmt &rest rest)
17231 "Insert a new column, to the leeft o the current column."
17232 (interactive)
17233 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
17234 cell)
17235 (setq prop (completing-read
17236 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
17237 nil nil prop))
17238 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
17239 (setq width (read-string "Column width: " (if width (number-to-string width))))
17241 (setq width (string-to-number width))
17242 (setq width nil))
17243 (setq fmt (completing-read "Summary [none]: "
17244 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
17245 nil t))
17247 (setq fmt (intern fmt))
17248 (setq fmt nil))
17249 (if (eq fmt 'none) (setq fmt nil))
17250 (if editp
17251 (progn
17252 (setcar editp prop)
17253 (setcdr editp (list title width nil fmt)))
17254 (setq cell (nthcdr (1- (current-column))
17255 org-columns-current-fmt-compiled))
17256 (setcdr cell (cons (list prop title width nil fmt)
17257 (cdr cell))))
17258 (org-columns-store-format)
17259 (org-columns-redo)))
17261 (defun org-columns-delete ()
17262 "Delete the column at point from columns view."
17263 (interactive)
17264 (let* ((n (current-column))
17265 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
17266 (when (y-or-n-p
17268 (setq org-columns-current-fmt-compiled
17269 (delq (nth n org-columns-current-fmt-compiled)
17270 org-columns-current-fmt-compiled))
17271 (org-columns-store-format)
17272 (org-columns-redo)
17273 (if (>= (current-column) (length org-columns-current-fmt-compiled))
17274 (backward-char 1)))))
17276 (defun org-columns-edit-attributes ()
17277 "Edit the attributes of the current column."
17278 (interactive)
17279 (let* ((n (current-column))
17280 (info (nth n org-columns-current-fmt-compiled)))
17281 (apply 'org-columns-new info)))
17283 (defun org-columns-widen (arg)
17284 "Make the column wider by ARG characters."
17285 (interactive "p")
17286 (let* ((n (current-column))
17287 (entry (nth n org-columns-current-fmt-compiled))
17288 (width (or (nth 2 entry)
17289 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
17290 (setq width (max 1 (+ width arg)))
17291 (setcar (nthcdr 2 entry) width)
17292 (org-columns-store-format)
17293 (org-columns-redo)))
17295 (defun org-columns-narrow (arg)
17296 "Make the column nrrower by ARG characters."
17297 (interactive "p")
17298 (org-columns-widen (- arg)))
17300 (defun org-columns-move-right ()
17301 "Swap this column with the one to the right."
17302 (interactive)
17303 (let* ((n (current-column))
17304 (cell (nthcdr n org-columns-current-fmt-compiled))
17305 e)
17306 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17307 (error "Cannot shift this column further to the right"))
17308 (setq e (car cell))
17309 (setcar cell (car (cdr cell)))
17310 (setcdr cell (cons e (cdr (cdr cell))))
17311 (org-columns-store-format)
17312 (org-columns-redo)
17313 (forward-char 1)))
17315 (defun org-columns-move-left ()
17316 "Swap this column with the one to the left."
17317 (interactive)
17318 (let* ((n (current-column)))
17319 (when (= n 0)
17320 (error "Cannot shift this column further to the left"))
17321 (backward-char 1)
17322 (org-columns-move-right)
17323 (backward-char 1)))
17325 (defun org-columns-store-format ()
17326 "Store the text version of the current columns format in appropriate place.
17327 This is either in the COLUMNS property of the node starting the current column
17328 display, or in the #+COLUMNS line of the current buffer."
17329 (let (fmt (cnt 0))
17330 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17331 (org-set-local 'org-columns-current-fmt fmt)
17332 (if (marker-position org-columns-top-level-marker)
17333 (save-excursion
17334 (goto-char org-columns-top-level-marker)
17335 (if (and (org-at-heading-p)
17336 (org-entry-get nil "COLUMNS"))
17337 (org-entry-put nil "COLUMNS" fmt)
17338 (goto-char (point-min))
17339 ;; Overwrite all #+COLUMNS lines....
17341 (setq cnt (1+ cnt))
17342 (replace-match (concat "#+COLUMNS: " fmt) t t))
17343 (unless (> cnt 0)
17344 (goto-char (point-min))
17345 (or (org-on-heading-p t) (outline-next-heading))
17346 (let ((inhibit-read-only t))
17348 (org-set-local 'org-columns-default-format fmt))))))
17350 (defvar org-overriding-columns-format nil
17351 "When set, overrides any other definition.")
17352 (defvar org-agenda-view-columns-initially nil
17353 "When set, switch to columns view immediately after creating the agenda.")
17355 (defun org-agenda-columns ()
17356 "Turn on column view in the agenda."
17357 (interactive)
17358 (org-verify-version 'columns)
17359 (org-columns-remove-overlays)
17360 (move-marker org-columns-begin-marker (point))
17361 (let (fmt cache maxwidths m)
17362 (cond
17363 ((and (local-variable-p 'org-overriding-columns-format)
17364 org-overriding-columns-format)
17365 (setq fmt org-overriding-columns-format))
17366 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17367 (setq fmt (org-entry-get m "COLUMNS" t)))
17368 ((and (boundp 'org-columns-current-fmt)
17369 (local-variable-p 'org-columns-current-fmt)
17370 org-columns-current-fmt)
17371 (setq fmt org-columns-current-fmt))
17372 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17373 (setq m (get-text-property m 'org-hd-marker))
17374 (setq fmt (org-entry-get m "COLUMNS" t))))
17375 (setq fmt (or fmt org-columns-default-format))
17376 (org-set-local 'org-columns-current-fmt fmt)
17377 (org-columns-compile-format fmt)
17378 (save-excursion
17379 ;; Get and cache the properties
17380 (goto-char (point-min))
17381 (while (not (eobp))
17382 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17383 (get-text-property (point) 'org-marker)))
17384 (push (cons (org-current-line) (org-entry-properties m)) cache))
17385 (beginning-of-line 2))
17386 (when cache
17387 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17388 (org-set-local 'org-columns-current-maxwidths maxwidths)
17389 (org-columns-display-here-title)
17390 (mapc (lambda (x)
17391 (goto-line (car x))
17392 (org-columns-display-here (cdr x)))
17393 cache)))))
17395 (defun org-columns-get-autowidth-alist (s cache)
17396 "Derive the maximum column widths from the format and the cache."
17397 (let ((start 0) rtn)
17399 (push (cons (match-string 1 s) 1) rtn)
17400 (setq start (match-end 0)))
17401 (mapc (lambda (x)
17402 (setcdr x (apply 'max
17403 (mapcar
17404 (lambda (y)
17405 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17406 cache))))
17407 rtn)
17408 rtn))
17410 (defun org-columns-compute-all ()
17411 "Compute all columns that have operators defined."
17412 (org-unmodified
17413 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17414 (let ((columns org-columns-current-fmt-compiled) col)
17415 (while (setq col (pop columns))
17416 (when (nth 3 col)
17417 (save-excursion
17418 (org-columns-compute (car col)))))))
17420 (defun org-columns-update (property)
17421 "Recompute PROPERTY, and update the columns display for it."
17422 (org-columns-compute property)
17423 (let (fmt val pos)
17424 (save-excursion
17425 (mapc (lambda (ov)
17426 (when (equal (org-overlay-get ov 'org-columns-key) property)
17427 (setq pos (org-overlay-start ov))
17428 (goto-char pos)
17429 (when (setq val (cdr (assoc property
17430 (get-text-property
17431 (point-at-bol) 'org-summaries))))
17432 (setq fmt (org-overlay-get ov 'org-columns-format))
17433 (org-overlay-put ov 'org-columns-value val)
17434 (org-overlay-put ov 'display (format fmt val)))))
17435 org-columns-overlays))))
17437 (defun org-columns-compute (property)
17438 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17439 (interactive)
17440 (let* ((re (concat "^" outline-regexp))
17441 (lmax 30) ; Does anyone use deeper levels???
17442 (lsum (make-vector lmax 0))
17443 (lflag (make-vector lmax nil))
17444 (level 0)
17445 (ass (assoc property org-columns-current-fmt-compiled))
17446 (format (nth 4 ass))
17447 (printf (nth 5 ass))
17448 (beg org-columns-top-level-marker)
17449 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17450 (save-excursion
17451 ;; Find the region to compute
17452 (goto-char beg)
17453 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17454 (goto-char end)
17455 ;; Walk the tree from the back and do the computations
17456 (while (re-search-backward re beg t)
17457 (setq sumpos (match-beginning 0)
17458 last-level level
17459 level (org-outline-level)
17460 val (org-entry-get nil property)
17462 (cond
17463 ((< level last-level)
17464 ;; put the sum of lower levels here as a property
17465 (setq sum (aref lsum last-level) ; current sum
17466 flag (aref lflag last-level) ; any valid entries from children?
17467 str (org-column-number-to-string sum format printf)
17468 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17469 useval (if flag str1 (if valflag val ""))
17470 sum-alist (get-text-property sumpos 'org-summaries))
17471 (if (assoc property sum-alist)
17472 (setcdr (assoc property sum-alist) useval)
17473 (push (cons property useval) sum-alist)
17474 (org-unmodified
17475 (add-text-properties sumpos (1+ sumpos)
17476 (list 'org-summaries sum-alist))))
17477 (when val
17478 (org-entry-put nil property (if flag str val)))
17479 ;; add current to current level accumulator
17480 (when (or flag valflag)
17481 (aset lsum level (+ (aref lsum level)
17482 (if flag sum (org-column-string-to-number
17483 (if flag str val) format))))
17484 (aset lflag level t))
17485 ;; clear accumulators for deeper levels
17486 (loop for l from (1+ level) to (1- lmax) do
17487 (aset lsum l 0)
17488 (aset lflag l nil)))
17489 ((>= level last-level)
17490 ;; add what we have here to the accumulator for this level
17491 (aset lsum level (+ (aref lsum level)
17492 (org-column-string-to-number (or val "0") format)))
17493 (and valflag (aset lflag level t)))
17494 (t (error "This should not happen")))))))
17496 (defun org-columns-redo ()
17497 "Construct the column display again."
17498 (interactive)
17499 (message "Recomputing columns...")
17500 (save-excursion
17501 (if (marker-position org-columns-begin-marker)
17502 (goto-char org-columns-begin-marker))
17503 (org-columns-remove-overlays)
17504 (if (org-mode-p)
17505 (call-interactively 'org-columns)
17506 (call-interactively 'org-agenda-columns)))
17507 (message "Recomputing columns...done"))
17509 (defun org-columns-not-in-agenda ()
17510 (if (eq major-mode 'org-agenda-mode)
17511 (error "This command is only allowed in Org-mode buffers")))
17514 (defun org-string-to-number (s)
17515 "Convert string to number, and interpret hh:mm:ss."
17516 (if (not (string-match ":" s))
17517 (string-to-number s)
17518 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17519 (while l
17520 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17521 sum)))
17523 (defun org-column-number-to-string (n fmt &optional printf)
17524 "Convert a computed column number to a string value, according to FMT."
17525 (cond
17526 ((eq fmt 'add_times)
17527 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17528 (format "%d:%02d" h m)))
17529 ((eq fmt 'checkbox)
17530 (cond ((= n (floor n)) "[X]")
17531 ((> n 1.) "[-]")
17532 (t "[ ]")))
17533 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17534 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17535 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17536 (printf (format printf n))
17537 ((eq fmt 'currency)
17538 (format "%.2f" n))
17539 (t (number-to-string n))))
17541 (defun org-nofm-to-completion (n m &optional percent)
17542 (if (not percent)
17543 (format "[%d/%d]" n m)
17544 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17546 (defun org-column-string-to-number (s fmt)
17547 "Convert a column value to a number that can be used for column computing."
17548 (cond
17549 ((string-match ":" s)
17550 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17551 (while l
17552 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17553 sum))
17554 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17555 (if (equal s "[X]") 1. 0.000001))
17556 (t (string-to-number s))))
17558 (defun org-columns-uncompile-format (cfmt)
17559 "Turn the compiled columns format back into a string representation."
17560 (let ((rtn "") e s prop title op width fmt printf)
17561 (while (setq e (pop cfmt))
17562 (setq prop (car e)
17563 title (nth 1 e)
17564 width (nth 2 e)
17565 op (nth 3 e)
17566 fmt (nth 4 e)
17567 printf (nth 5 e))
17568 (cond
17569 ((eq fmt 'add_times) (setq op ":"))
17570 ((eq fmt 'checkbox) (setq op "X"))
17571 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17572 ((eq fmt 'checkbox-percent) (setq op "X%"))
17573 ((eq fmt 'add_numbers) (setq op "+"))
17574 ((eq fmt 'currency) (setq op "$")))
17575 (if (and op printf) (setq op (concat op ";" printf)))
17576 (if (equal title prop) (setq title nil))
17577 (setq s (concat "%" (if width (number-to-string width))
17578 prop
17579 (if title (concat "(" title ")"))
17580 (if op (concat "{" op "}"))))
17581 (setq rtn (concat rtn " " s)))
17582 (org-trim rtn)))
17584 (defun org-columns-compile-format (fmt)
17585 "Turn a column format string into an alist of specifications.
17586 The alist has one entry for each column in the format. The elements of
17587 that list are:
17588 property the property
17589 title the title field for the columns
17590 width the column width in characters, can be nil for automatic
17591 operator the operator if any
17592 format the output format for computed results, derived from operator
17593 printf a printf format for computed values"
17594 (let ((start 0) width prop title op f printf)
17595 (setq org-columns-current-fmt-compiled nil)
17596 (while (string-match
17597 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17598 fmt start)
17599 (setq start (match-end 0)
17600 width (match-string 1 fmt)
17601 prop (match-string 2 fmt)
17602 title (or (match-string 3 fmt) prop)
17603 op (match-string 4 fmt)
17604 f nil
17605 printf nil)
17606 (if width (setq width (string-to-number width)))
17607 (when (and op (string-match ";" op))
17608 (setq printf (substring op (match-end 0))
17609 op (substring op 0 (match-beginning 0))))
17610 (cond
17611 ((equal op "+") (setq f 'add_numbers))
17612 ((equal op "$") (setq f 'currency))
17613 ((equal op ":") (setq f 'add_times))
17614 ((equal op "X") (setq f 'checkbox))
17615 ((equal op "X/") (setq f 'checkbox-n-of-m))
17616 ((equal op "X%") (setq f 'checkbox-percent))
17617 )
17618 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17619 (setq org-columns-current-fmt-compiled
17620 (nreverse org-columns-current-fmt-compiled))))
17623 ;;; Dynamic block for Column view
17625 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
17626 "Get the column view of the current buffer or subtree.
17627 The first optional argument MAXLEVEL sets the level limit. A
17628 second optional argument SKIP-EMPTY-ROWS tells whether to skip
17629 empty rows, an empty row being one where all the column view
17630 specifiers except ITEM are empty. This function returns a list
17631 containing the title row and all other rows. Each row is a list
17632 of fields."
17633 (save-excursion
17634 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17635 (n (length title)) row tbl)
17636 (goto-char (point-min))
17638 (or (null maxlevel)
17639 (>= maxlevel
17640 (if org-odd-levels-only
17641 (/ (1+ (length (match-string 1))) 2)
17642 (length (match-string 1))))))
17643 (when (get-char-property (match-beginning 0) 'org-columns-key)
17644 (setq row nil)
17645 (loop for i from 0 to (1- n) do
17646 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17647 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17648 "")
17649 row))
17650 (setq row (nreverse row))
17651 (unless (and skip-empty-rows
17652 (eq 1 (length (delete "" (delete-dups row)))))
17653 (push row tbl))))
17654 (append (list title 'hline) (nreverse tbl)))))
17656 (defun org-dblock-write:columnview (params)
17657 "Write the column view table.
17658 PARAMS is a property list of parameters:
17660 :width enforce same column widths with <N> specifiers.
17661 :id the :ID: property of the entry where the columns view
17662 should be built, as a string. When `local', call locally.
17663 When `global' call column view with the cursor at the beginning
17664 of the buffer (usually this means that the whole buffer switches
17665 to column view).
17666 :hlines When t, insert a hline before each item. When a number, insert
17667 a hline before each level <= that number.
17668 :vlines When t, make each column a colgroup to enforce vertical lines.
17669 :maxlevel When set to a number, don't capture headlines below this level.
17670 :skip-empty-rows
17671 When t, skip rows where all specifiers other than ITEM are empty."
17672 (let ((pos (move-marker (make-marker) (point)))
17673 (hlines (plist-get params :hlines))
17674 (vlines (plist-get params :vlines))
17675 (maxlevel (plist-get params :maxlevel))
17676 (skip-empty-rows (plist-get params :skip-empty-rows))
17677 tbl id idpos nfields tmp)
17678 (save-excursion
17679 (save-restriction
17680 (when (setq id (plist-get params :id))
17681 (cond ((not id) nil)
17682 ((eq id 'global) (goto-char (point-min)))
17683 ((eq id 'local) nil)
17684 ((setq idpos (org-find-entry-with-id id))
17685 (goto-char idpos))
17686 (t (error "Cannot find entry with :ID: %s" id))))
17687 (org-columns)
17688 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
17689 (setq nfields (length (car tbl)))
17690 (org-columns-quit)))
17691 (goto-char pos)
17692 (move-marker pos nil)
17693 (when tbl
17694 (when (plist-get params :hlines)
17695 (setq tmp nil)
17696 (while tbl
17697 (if (eq (car tbl) 'hline)
17698 (push (pop tbl) tmp)
17700 (if (and (not (eq (car tmp) 'hline))
17701 (or (eq hlines t)
17702 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17703 (push 'hline tmp)))
17704 (push (pop tbl) tmp)))
17705 (setq tbl (nreverse tmp)))
17706 (when vlines
17707 (setq tbl (mapcar (lambda (x)
17708 (if (eq 'hline x) x (cons "" x)))
17709 tbl))
17710 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17711 (setq pos (point))
17712 (insert (org-listtable-to-string tbl))
17713 (when (plist-get params :width)
17715 org-columns-current-widths "|")))
17716 (goto-char pos)
17717 (org-table-align))))
17719 (defun org-listtable-to-string (tbl)
17720 "Convert a listtable TBL to a string that contains the Org-mode table.
17721 The table still need to be alligned. The resulting string has no leading
17722 and tailing newline characters."
17723 (mapconcat
17724 (lambda (x)
17725 (cond
17726 ((listp x)
17727 (concat "|" (mapconcat 'identity x "|") "|"))
17728 ((eq x 'hline) "|-|")
17729 (t (error "Garbage in listtable: %s" x))))
17732 (defun org-insert-columns-dblock ()
17733 "Create a dynamic block capturing a column view table."
17734 (interactive)
17735 (let ((defaults '(:name "columnview" :hlines 1))
17736 (id (completing-read
17737 "Capture columns (local, global, entry with :ID: property) [local]: "
17738 (append '(("global") ("local"))
17739 (mapcar 'list (org-property-values "ID"))))))
17740 (if (equal id "") (setq id 'local))
17741 (if (equal id "global") (setq id 'global))
17742 (setq defaults (append defaults (list :id id)))
17743 (org-create-dblock defaults)
17744 (org-update-dblock)))
17746 ;;;; Timestamps
17748 (defvar org-last-changed-timestamp nil)
17749 (defvar org-time-was-given) ; dynamically scoped parameter
17750 (defvar org-end-time-was-given) ; dynamically scoped parameter
17751 (defvar org-ts-what) ; dynamically scoped parameter
17753 (defun org-time-stamp (arg)
17754 "Prompt for a date/time and insert a time stamp.
17755 If the user specifies a time like HH:MM, or if this command is called
17756 with a prefix argument, the time stamp will contain date and time.
17757 Otherwise, only the date will be included. All parts of a date not
17758 specified by the user will be filled in from the current date/time.
17759 So if you press just return without typing anything, the time stamp
17760 will represent the current date/time. If there is already a timestamp
17761 at the cursor, it will be modified."
17762 (interactive "P")
17763 (let* ((ts nil)
17764 (default-time
17765 ;; Default time is either today, or, when entering a range,
17766 ;; the range start.
17767 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17768 (save-excursion
17769 (re-search-backward
17771 (- (point) 20) t)))
17772 (apply 'encode-time (org-parse-time-string (match-string 1)))
17773 (current-time)))
17774 (default-input (and ts (org-get-compact-tod ts)))
17775 org-time-was-given org-end-time-was-given time)
17776 (cond
17777 ((and (org-at-timestamp-p)
17778 (eq last-command 'org-time-stamp)
17779 (eq this-command 'org-time-stamp))
17780 (insert "--")
17781 (setq time (let ((this-command this-command))
17782 (org-read-date arg 'totime nil nil default-time default-input)))
17783 (org-insert-time-stamp time (or org-time-was-given arg)))
17784 ((org-at-timestamp-p)
17785 (setq time (let ((this-command this-command))
17786 (org-read-date arg 'totime nil nil default-time default-input)))
17787 (when (org-at-timestamp-p) ; just to get the match data
17788 (replace-match "")
17789 (setq org-last-changed-timestamp
17790 (org-insert-time-stamp
17791 time (or org-time-was-given arg)
17792 nil nil nil (list org-end-time-was-given))))
17793 (message "Timestamp updated"))
17794 (t
17795 (setq time (let ((this-command this-command))
17796 (org-read-date arg 'totime nil nil default-time default-input)))
17797 (org-insert-time-stamp time (or org-time-was-given arg)
17798 nil nil nil (list org-end-time-was-given))))))
17800 ;; FIXME: can we use this for something else????
17801 ;; like computing time differences?????
17802 (defun org-get-compact-tod (s)
17803 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17804 (let* ((t1 (match-string 1 s))
17805 (h1 (string-to-number (match-string 2 s)))
17806 (m1 (string-to-number (match-string 3 s)))
17807 (t2 (and (match-end 4) (match-string 5 s)))
17808 (h2 (and t2 (string-to-number (match-string 6 s))))
17809 (m2 (and t2 (string-to-number (match-string 7 s))))
17810 dh dm)
17811 (if (not t2)
17812 t1
17813 (setq dh (- h2 h1) dm (- m2 m1))
17814 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17815 (concat t1 "+" (number-to-string dh)
17816 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17818 (defun org-time-stamp-inactive (&optional arg)
17819 "Insert an inactive time stamp.
17820 An inactive time stamp is enclosed in square brackets instead of angle
17821 brackets. It is inactive in the sense that it does not trigger agenda entries,
17822 does not link to the calendar and cannot be changed with the S-cursor keys.
17823 So these are more for recording a certain time/date."
17824 (interactive "P")
17825 (let (org-time-was-given org-end-time-was-given time)
17826 (setq time (org-read-date arg 'totime))
17827 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17828 nil nil (list org-end-time-was-given))))
17830 (defvar org-date-ovl (org-make-overlay 1 1))
17831 (org-overlay-put org-date-ovl 'face 'org-warning)
17832 (org-detach-overlay org-date-ovl)
17834 (defvar org-ans1) ; dynamically scoped parameter
17835 (defvar org-ans2) ; dynamically scoped parameter
17837 (defvar org-plain-time-of-day-regexp) ; defined below
17839 (defvar org-read-date-overlay nil)
17840 (defvar org-dcst nil) ; dynamically scoped
17842 (defun org-read-date (&optional with-time to-time from-string prompt
17843 default-time default-input)
17844 "Read a date, possibly a time, and make things smooth for the user.
17845 The prompt will suggest to enter an ISO date, but you can also enter anything
17846 which will at least partially be understood by `parse-time-string'.
17847 Unrecognized parts of the date will default to the current day, month, year,
17848 hour and minute. If this command is called to replace a timestamp at point,
17849 of to enter the second timestamp of a range, the default time is taken from the
17850 existing stamp. For example,
17851 3-2-5 --> 2003-02-05
17852 feb 15 --> currentyear-02-15
17853 sep 12 9 --> 2009-09-12
17854 12:45 --> today 12:45
17855 22 sept 0:34 --> currentyear-09-22 0:34
17856 12 --> currentyear-currentmonth-12
17857 Fri --> nearest Friday (today or later)
17858 etc.
17860 Furthermore you can specify a relative date by giving, as the *first* thing
17861 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17862 change in days weeks, months, years.
17863 With a single plus or minus, the date is relative to today. With a double
17864 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17865 +4d --> four days from today
17866 +4 --> same as above
17867 +2w --> two weeks from today
17868 ++5 --> five days from default date
17870 The function understands only English month and weekday abbreviations,
17871 but this can be configured with the variables `parse-time-months' and
17872 `parse-time-weekdays'.
17874 While prompting, a calendar is popped up - you can also select the
17875 date with the mouse (button 1). The calendar shows a period of three
17876 months. To scroll it to other months, use the keys `>' and `<'.
17877 If you don't like the calendar, turn it off with
17878 \(setq org-read-date-popup-calendar nil)
17880 With optional argument TO-TIME, the date will immediately be converted
17881 to an internal time.
17882 With an optional argument WITH-TIME, the prompt will suggest to also
17883 insert a time. Note that when WITH-TIME is not set, you can still
17884 enter a time, and this function will inform the calling routine about
17885 this change. The calling routine may then choose to change the format
17886 used to insert the time stamp into the buffer to include the time.
17887 With optional argument FROM-STRING, read from this string instead from
17888 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17889 the time/date that is used for everything that is not specified by the
17890 user."
17891 (require 'parse-time)
17892 (let* ((org-time-stamp-rounding-minutes
17893 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
17894 (org-dcst org-display-custom-times)
17895 (ct (org-current-time))
17896 (def (or default-time ct))
17897 (defdecode (decode-time def))
17898 (dummy (progn
17899 (when (< (nth 2 defdecode) org-extend-today-until)
17900 (setcar (nthcdr 2 defdecode) -1)
17901 (setcar (nthcdr 1 defdecode) 59)
17902 (setq def (apply 'encode-time defdecode)
17903 defdecode (decode-time def)))))
17904 (calendar-move-hook nil)
17905 (view-diary-entries-initially nil)
17906 (view-calendar-holidays-initially nil)
17907 (timestr (format-time-string
17908 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17909 (prompt (concat (if prompt (concat prompt " ") "")
17910 (format "Date+time [%s]: " timestr)))
17911 ans (org-ans0 "") org-ans1 org-ans2 final)
17913 (cond
17914 (from-string (setq ans from-string))
17915 (org-read-date-popup-calendar
17916 (save-excursion
17917 (save-window-excursion
17918 (calendar)
17919 (calendar-forward-day (- (time-to-days def)
17920 (calendar-absolute-from-gregorian
17921 (calendar-current-date))))
17922 (org-eval-in-calendar nil t)
17923 (let* ((old-map (current-local-map))
17924 (map (copy-keymap calendar-mode-map))
17925 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17926 (org-defkey map (kbd "RET") 'org-calendar-select)
17927 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17928 'org-calendar-select-mouse)
17966 ;; org-ans0: from prompt
17967 ;; org-ans1: from mouse click
17968 ;; org-ans2: from calendar motion
17996 "Display the currrent date prompt interpretation in the minibuffer."
18012 org-time-stamp-custom-formats
18013 org-time-stamp-formats))
18022 org-end-time-was-given
18029 "Analyze the combined answer of the date prompt."
18030 ;; FIXME: cleanup and comment
18032 hour minute second wday pm h2 m2 tl wday1)
18040 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
18050 t nil ans)))
18051 ;; Help matching am/pm times, because `parse-time-string' does not do that.
18052 ;; If there is a time with am/pm, and *no* time without it, we convert
18053 ;; so that matching will be successful.
18067 t t ans))))
18069 ;; Check if a time range is given as a duration
18070 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
18078 ;; Check if there is a time range
18112 ;; Weekday was given, but no day, so pick that day in the week
18113 ;; on or after the derived date.
18127 "Check string S for special relative date string.
18128 TODAY and DEFAULT are internal times, for today and for a default.
18129 Return shift list (N what def-flag)
18131 N is the number of WHATs to shift.
18132 DEF-FLAG is t when a double ++ or -- indicates shift relative to
18133 the DEFAULT date rather than TODAY."
18142 ?+))
18149 delta)
18159 "Eval FORM in the calendar window and return to current window.
18160 Also, store the cursor date in variable org-ans2."
18171 ; ;; Update the prompt to show new default date
18172 ; (save-excursion
18173 ; (goto-char (point-min))
18174 ; (when (and org-ans2
18175 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
18176 ; (get-text-property (match-end 0) 'field))
18177 ; (let ((inhibit-read-only t))
18178 ; (replace-match (concat "[" org-ans2 "]") t t)
18179 ; (add-text-properties (point-min) (1+ (match-end 0))
18180 ; (text-properties-at (1+ (point-min)))))))))
18183 "Return to `org-read-date' with the date currently selected.
18184 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18193 "Insert a date stamp for the date given by the internal TIME.
18194 WITH-HM means, use the stamp format that includes the time of the day.
18195 INACTIVE means use square brackets instead of angular ones, so that the
18196 stamp will not contribute to the agenda.
18197 PRE and POST are optional strings to be inserted before and after the
18198 stamp.
18199 The command returns the inserted time stamp."
18201 stamp)
18218 stamp))
18221 "Toggle the use of custom time stamp formats."
18242 "Overlay modified time stamp format over timestamp between BED and END."
18269 "Translate all timestamps in STRING to custom format.
18270 But do this only if the variable `org-display-custom-times' is set."
18275 t1 with-hm inactive tf time str beg end)
18284 org-time-stamp-custom-formats)
18293 string)
18296 "Set 0 instead of nil for the first 6 elements of time.
18297 Don't touch the rest."
18302 "Difference between TIMESTAMP-STRING and now in days."
18307 "Is the time in TIMESTAMP-STRING close to the current date?"
18313 "Get the deadline lead time appropriate for timestring TS."
18316 ;; 0 or negative, enforce this value no matter what
18319 ;; lead time is specified.
18324 ;; go for the default.
18328 "Return to `org-read-date' with the date currently selected.
18329 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18339 "Check if there are any deadlines due or past due.
18340 A deadline is considered due if it happens within `org-deadline-warning-days'
18341 days from today's date. If the deadline appears in an entry marked DONE,
18342 it is not shown. The prefix arg NDAYS can be used to test that many
18357 org-warn-days)))
18360 "Check if there are deadlines or scheduled entries before DATE."
18374 "Evaluate a time range by computing the difference between start and end.
18375 Normally the result is just printed in the echo area, but with prefix arg
18376 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18377 If the time range is actually in a table, the result is inserted into the
18378 next column.
18379 For time difference computation, a year is assumed to be exactly 365
18380 days in order to avoid rounding problems."
18400 ;; (ys (floor (* 365 24 60 60)))
18408 y d h m align)
18411 y 0
18416 y 0
18454 "Convert a time stamp to an absolute day number.
18455 If there is a specifyer for a cyclic time stamp, get the closest date to
18456 DAYNR."
18460 daynr
18465 prefer))
18469 "Return the time corresponding to date D.
18470 D may be an absolute day number, or a calendar-type list (month day year)."
18475 "List of holidays, for Diary display in Org-mode."
18483 "Process a SEXP diary ENTRY for DATE."
18503 "Get iCalendar entries from diary entries in buffer FROMBUF.
18504 This uses the icalendar.el library."
18507 temporary-file-directory))
18510 buf rtn b e)
18526 rtn))
18529 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18530 When PREFER is `past' return a date that is either CURRENT or past.
18531 When PREFER is `future', return a date that is either CURRENT or future."
18532 ;; Make the proper lists from the dates
18535 dn dw sday cday n1 n2
18536 d m y y1 y2 date1 date2 nmonths nm ny m2)
18541 current
18565 ;; approx number of month between the tow dates
18567 ;; How often does dn fit in there?
18596 "Turn any specification of DATE into a gregorian date for the calendar."
18606 "Parse the standard Org-mode time string.
18607 This should be a lot faster than the normal `parse-time-string'.
18608 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18609 hour and minute fields will be nil if not given."
18619 nil nil nil)
18623 "Increase the date item at the cursor by one.
18624 If the cursor is on the year, change the year. If it is on the month or
18625 the day, change that.
18626 With prefix ARG, change by that many units."
18631 "Decrease the date item at the cursor by one.
18632 If the cursor is on the year, change the year. If it is on the month or
18633 the day, change that.
18634 With prefix ARG, change by that many units."
18639 "Increase the date in the time stamp by one day.
18640 With prefix ARG, change that many days."
18648 "Decrease the date in the time stamp by one day.
18649 With prefix ARG, change that many days."
18662 "Determine if the cursor is in or at a timestamp."
18688 ans))
18691 "Toggle the type (<active> or [inactive]) of a time stamp."
18703 "Change the date in the time stamp at point.
18704 The date will be changed by N times WHAT. WHAT can be `day', `month',
18705 `year', `minute', `second'. If WHAT is not given, the cursor position
18706 in the timestamp determines what will be changed."
18708 with-hm inactive
18710 org-ts-what
18711 extra rem
18712 ts time time0)
18718 org-display-custom-times
18728 ts)
18762 ;; Try to recenter the calendar window, if any
18768 ;; FIXME: does not yet work for lead times
18770 "Change the different parts of the lead-time and repeat fields in timestamp."
18772 ng h m new rem)
18773 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18802 new
18804 s))
18807 "If the calendar is visible, recenter it to DATE."
18818 "Go to the Emacs calendar at the current date.
18819 If there is a time stamp in the current line, go to that date.
18820 A prefix ARG can be used to force the current date."
18839 "Return a list (month day year) of date at point in calendar."
18845 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18846 If there is already a time stamp at the cursor position, update it."
18856 ;;;###autoload
18858 "Activate appointments found in `org-agenda-files'.
18860 appointements.
18862 If FILTER is t, interactively prompt the user for a regular
18863 expression, and filter out entries that don't match it.
18865 If FILTER is a string, use this string as a regular expression
18866 for filtering entries out.
18868 FILTER can also be an alist with the car of each cell being
18869 either 'headline or 'category. For example:
18874 will only add headlines containing IMPORTANT or headlines
18887 ;; Get all entries which may contain an appt
18894 ;; Map thru entries and find if we should filter them out
18907 ;; FIXME: Shall we remove text-properties for the appt text?
18908 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18922 ;;; The clock for measuring work time.
18947 "Start the clock on the current item.
18948 If necessary, clock-out of the currently active clock."
18956 org-clock-in-switch-to-state
18983 "Find the location where the next clock line should be inserted."
18989 first last)
18993 ;; we seem to have a CLOCK drawer, so go there.
18996 ;; Lets count the CLOCK lines
19004 ;; Wrap current entries into a new drawer
19022 ;; Planning info, skip to after it
19034 "Stop the currently running clock.
19035 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
19072 "Cancel the running clock be removing the start timestamp."
19086 "Go to the currently clocked-in entry."
19103 "Sum the times for each subtree.
19104 Puts the resulting times in minutes as a text property on each headline."
19108 org-clock-string
19114 ts te dt
19115 time)
19122 ;; Two time stamps
19134 ;; A naket time
19151 "Show subtree times in the entire buffer.
19152 If TOTAL-ONLY is non-nil, only show the total time for the entire file
19153 in the echo area."
19170 ;; Arrange to remove the overlays upon next change.
19180 "Put an overlays on the current line, displaying TIME.
19181 If LEVEL is given, prefix time with a corresponding number of stars.
19182 This creates a new overlay and stores it in `org-clock-overlays', so that it
19183 will be easy to remove."
19187 ov tx)
19206 "Remove the occur highlights from the buffer.
19207 BEG and END are ignored. If NOREMOVE is nil, remove this function
19208 from the `before-change-functions' in the current buffer."
19218 "Clock out if the current entry contains the running clock.
19219 This is used to stop the clock after a TODO entry is marked DONE,
19220 and is only done if the variable `org-clock-out-when-done' is not nil."
19226 org-clock-marker))
19227 ;; Clock out, but don't accept a logging message for this.
19235 "Check if the current buffer contains the running clock.
19236 If yes, offer to stop it and to save the buffer with the changes."
19245 "Create a table containing a report about clocked time.
19246 If the cursor is inside an existing clocktable block, then the table
19247 will be updated. If not, a new clocktable will be inserted.
19248 When called with a prefix argument, move to the first clock table in the
19249 buffer and update it."
19262 "Check if the cursor is in a clocktable."
19270 start))))
19273 "If this is a CLOCK line, update it and return t.
19274 Otherwise, return nil."
19283 ts te h m s)
19285 nil
19299 t)))))
19302 "Return two times bordering a special time range.
19303 Key is a symbol specifying the range and can be one of `today', `yesterday',
19304 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
19305 A week starts Monday 0:00 and ends Sunday 24:00.
19306 The range is determined relative to TIME. TIME defaults to the current time.
19307 The return value is a cons cell with two internal times like the ones
19308 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
19309 the returned times will be formatted strings."
19314 s1 m1 h1 d1 month1 y1 diff ts te fm)
19344 "Write the standard clocktable."
19360 ipos time h m p level hlc hdl
19361 cc beg end pos tbl)
19375 ;; Get the right scope
19398 file)
19408 org-clock-file-total-minutes)))))))
19419 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19448 "Clock summary at ["
19452 "]."
19465 "|"
19466 "*Total time*| "
19488 cc)
19522 x))
19523 lines)
19526 ;; FIXME: I don't think anybody uses this, ask David
19528 "Return an internal list with clocking information.
19529 This list has one entry for each CLOCK interval.
19530 FIXME: describe the elements."
19534 rtn beg end next cont level title total closedp leafp
19535 clockpos titlepos h m donep)
19560 total title titlepos level leafp)
19561 rtn)
19565 ;;;; Agenda, and Diary Integration
19567 ;;; Define the Org-agenda-mode
19582 "Mode for time-sorted view on action items in Org-mode files.
19584 The following commands are available:
19590 org-agenda-pending-undo-list nil)
19592 ;; Keep global-font-lock-mode from turning on font-lock-mode
19600 ;; Make sure properties are removed when copying text
19605 buffer-substring-filters)))
19608 org-agenda-show-log nil))
19615 "Restricted to single file"
19627 org-agenda-mode-map global-map)
19730 "--"
19737 "--"
19741 "--"
19746 "--"
19751 "--"
19756 "--"
19773 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19777 "--"
19779 "--"
19789 "--"
19791 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19795 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19799 "--"
19801 "--"
19804 ))
19806 ;;; Agenda undo
19818 "Execute BODY if there is no `org-protected' text property at point."
19824 "Execute BODY while recording undo information in two buffers."
19832 _c1 _c2)
19833 ,@_body
19840 ;; make sure there are undo boundaries
19843 ;; remember which buffer to undo
19845 org-agenda-undo-list)))))
19848 "Undo a remote editing step in the agenda.
19849 This undoes changes both in the agenda buffer and in the remote buffer
19850 that have been changed along."
19856 org-agenda-pending-undo-list org-agenda-undo-list))
19860 buf line cmd rembuf)
19882 "Verify that a real change occurred between the undo lists L1 and L2."
19887 ;;; Agenda dispatch
19895 ;;;###autoload
19897 "Dispatch agenda commands to collect entries to the agenda buffer.
19898 Prompts for a command to execute. Any prefix arg will be passed
19899 on to the selected command. The default selections are:
19901 a Call `org-agenda-list' to display the agenda for current day or week.
19902 t Call `org-todo-list' to display the global todo list.
19903 T Call `org-todo-list' to display the global todo list, select only
19904 entries with a specific TODO keyword (the user gets a prompt).
19905 m Call `org-tags-view' to display headlines with tags matching
19906 a condition (the user is prompted for the condition).
19907 M Like `m', but select only TODO entries, no ordinary headlines.
19908 L Create a timeline for the current buffer.
19909 e Export views to associated files.
19911 More commands can be added by configuring the variable
19912 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19913 searches can be pre-defined in this way.
19915 If the current buffer is in Org-mode and visiting a file, you can also
19916 first press `<' once to indicate that the agenda should be temporarily
19918 Pressing `<' twice means to restrict to the current subtree or region
19919 \(if active)."
19925 ;; normalize different versions
19931 nil)
19935 org-agenda-custom-commands)))
19938 entry key type match lprops ans)
19939 ;; Turn off restriction unless there is an overriding one
19945 ;; Delete old local properties
19947 ;; Remember where this call originated
19953 ;; Estabish the restriction, if any
19970 ;; For example the todo list should not need it (but does...)
19986 current-prefix-arg)))
20039 cmds)))
20042 "The user interface for selecting an agenda command."
20049 restriction second-time
20050 c entry key type match prefixes rmheader header-end custom1 desc)
20057 "
20058 Press key for an agenda command: < Buffer,subtree/region restriction
20059 -------------------------------- > Remove restriction
20060 a Agenda for current week or day e Export agenda views
20061 t List of all TODO entries T Entries with special TODO kwd
20062 m Match a TAGS query M Like m, but only TODO entries
20063 L Timeline for current buffer # List stuck projects (!=configure)
20064 s Search for keywords C Configure custom agenda commands
20065 / Multi-occur
20070 header start)
20074 header)))
20127 prefix-descriptions))
20129 prefixes))
20140 " (restriction lock active)"
20153 prefixes nil
20159 nil
20161 custom))))
20178 nil)
20198 match ;; The byte compiler incorrectly complains about this. Keep it!
20199 cmd type lprops)
20233 ;;;###autoload
20235 "Run an agenda command in batch mode and send the result to STDOUT.
20236 If CMD-KEY is a string of length 1, it is used as a key in
20237 `org-agenda-custom-commands' and triggers this command. If it is a
20238 longer string it is used as a tags/todo match string.
20239 Paramters are alternating variable names and values that will be bound
20240 before running the agenda command."
20254 string))
20258 ;;;###autoload
20260 "Run an agenda command in batch mode and send the result to STDOUT.
20261 If CMD-KEY is a string of length 1, it is used as a key in
20262 `org-agenda-custom-commands' and triggers this command. If it is a
20263 longer string it is used as a tags/todo match string.
20264 Paramters are alternating variable names and values that will be bound
20265 before running the agenda command.
20267 The output gives a line for each selected agenda item. Each
20268 item is a list of comma-separated values, like this:
20270 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
20272 category The category of the item
20273 head The headline, without TODO kwd, TAGS and PRIORITY
20274 type The type of the agenda entry, can be
20275 todo selected in TODO match
20276 tagsmatch selected in tags match
20277 diary imported from diary
20278 deadline a deadline on given date
20279 scheduled scheduled on given date
20280 timestamp entry has timestamp on given date
20281 closed entry was closed on given date
20282 upcoming-deadline warning about deadline
20283 past-scheduled forwarded scheduled item
20284 block entry has date block including g. date
20285 todo The todo keyword, if any
20286 tags All tags including inherited ones, separated by colons
20287 date The relevant date, like 2007-2-14
20288 time The time, like 15:00-16:50
20289 extra Sting with extra planning info
20290 priority-l The priority letter if any was given
20291 priority-n The computed numerical priority
20292 agenda-day The day in the agenda where this is listed"
20304 line)
20314 priority-letter priority agenda-day)
20319 "Make sure all properties on an agenda item have a canonical form,
20320 so the export commands can easily use it."
20347 props)
20361 ;;;###autoload
20366 ;; FIXME, why is this a macro?????
20367 ;;;###autoload
20369 "Run all custom agenda commands that have a file argument."
20373 pars cmd thiscmdkey files opts)
20396 "Write the current buffer (an agenda view) as a file.
20397 Depending on the extension of the file name, plain text (.txt),
20398 HTML (.html or .htm) or Postscript (.ps) is produced.
20399 If NOSETTINGS is given, do not scope the settings of
20400 `org-agenda-exporter-settings' into the export commands. This is used when
20401 the settings have already been scoped and we do not wish to overrule other,
20402 higher priority settings."
20418 ;; replace <style> section with org-agenda-export-html-style
20439 "Inhibit read-only for BODY."
20443 "Make sure current buffer is in org-mode. Error if not."
20446 major-mode)))
20449 "Fit the window to the buffer size."
20453 nil
20457 ;;; Agenda file list
20460 "Get the list of agenda files.
20461 Optional UNRESTRICTED means return the full list even if a restriction
20462 is currently in place."
20473 org-agenda-file-regexp)
20475 files)))
20481 files))
20485 "Edit the list of agenda files.
20486 Depending on setup, this either uses customize to edit the variable
20487 `org-agenda-files', or it visits the file that is holding the list. In the
20488 latter case, the buffer is set up in a way that saving it automatically kills
20489 the buffer and restores the previous window configuration."
20508 "Set new value for the agenda file list and save it correcly."
20519 "Read the list of agenda files from a file."
20526 ;;;###autoload
20528 "Cycle through the files in `org-agenda-files'.
20529 If the current buffer visits an agenda file, find the next one in the list.
20530 If the current buffer does not, find the first agenda file."
20535 file)
20547 "Move/add the current file to the top of the agenda file list.
20548 If the file is not present in the list, it is added to the front. If it is
20549 present, it is moved there. With optional argument TO-END, add/move to the
20550 end of the list."
20557 x had)
20570 "Remove current file from the list of files in variable `org-agenda-files'.
20571 These are the files which are being checked for agenda entries.
20572 Optional argument FILE means, use this file instead of the current."
20582 nil x))
20595 "Make sure FILE exists. If not, ask user what to do."
20606 ;;; Agenda prepare and finalize
20651 "Finishing touch for the agenda buffer, called just before displaying it."
20663 org-overriding-columns-format)
20665 org-overriding-columns-format))
20667 org-agenda-view-columns-initially)
20673 )))
20676 "Make highest priority lines bold, and lowest italic."
20683 b e p ov h l)
20687 org-highest-priority)
20689 org-lowest-priority)
20694 ov 'face
20702 "Create buffers for all agenda files, protect archived trees and comments."
20709 bmp file re)
20739 "Function to be called at each match during agenda construction.
20740 If this function returns nil, the current match should not be skipped.
20741 Otherwise, the function must return a position from where the search
20742 should be continued.
20743 This may also be a Lisp form, it will be evaluated.
20744 Never set this variable using `setq' or so, because then it will apply
20745 to all future agenda commands. Instead, bind it with `let' to scope
20746 it dynamically into the agenda-constructing command. A good way to set
20750 "Throw to `:skip' in places that should be skipped.
20751 Also moves point to the end of the skipped region, so that search can
20752 continue from there."
20778 "Return a new agenda marker.
20779 Org-mode keeps a list of these markers and resets them when they are
20780 no longer in use."
20784 m))
20787 "Reset markers created by `org-agenda'."
20792 "Get a buffer visiting FILE. If the buffer needs to be created, add
20793 it to the list of buffers which might be released later."
20796 buf ; just return it
20797 ;; Make a new buffer and remember it
20800 buf)))
20803 "Release all buffers in list, asking the user for confirmation when needed.
20804 When a buffer is unmodified, it is just killed. When modified, it is saved
20805 \(if the user agrees) and then killed."
20810 file
20816 "Get the category applying to position POS."
20819 ;;; Agenda timeline
20824 "Show a time-sorted view of the entries in the current org file.
20825 Only entries with a time stamp of today or later will be listed. With
20827 under the current date.
20828 If the buffer contains an active region, only check the region for
20829 dates."
20842 t doclosed ; always include today
20843 org-timeline-show-empty-dates))
20848 args
20849 s e rtn d emptyp)
20855 ;; Remove past dates from the list of dates.
20858 day-numbers))))
20875 dopast
20876 past)
20884 date args)))
20907 "Return a list of all relevant day numbers from BEG to END buffer positions.
20908 If NO-RANGES is non-nil, include only the start and end dates of a range,
20909 not every single day in the range. If FORCE-TODAY is non-nil, make
20910 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20911 inactive time stamps (those in square brackets) are included.
20912 When EMPTY is non-nil, also include days without any entries."
20916 dates dates1 date day day1 day2 ts1 ts2)
20946 dates)))
20948 ;;; Agenda Daily/Weekly
20959 ;;;###autoload
20961 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20962 The view will be for the current day or week, but from the overview buffer
20963 you will be able to go to other days/weeks.
20966 all unfinished TODO items will also be shown, before the agenda.
20967 This feature is considered obsolete, please use the TODO list or a block
20968 agenda instead.
20970 With a numeric prefix argument in an interactive call, the agenda will
20971 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20972 the number of days. NDAYS defaults to `org-agenda-ndays'.
20974 START-DAY defaults to TODAY, or to the most recent match for the weekday
20975 given in `org-agenda-start-on-weekday'."
20986 ;; Convert to an absolute day number
20994 org-agenda-start-on-weekday nil))
21003 sd
21012 s e rtn rtnall file date d start-pos end-pos todayp nd)
21015 ;; Make the list of days
21017 nd ndays)
21030 rtnall nil)
21058 rtnall nil)
21064 file date
21067 file date
21091 rtnall nd todayp))
21114 ;;; Agenda word search
21118 ;;;###autoload
21120 "Show all entries that contain words or regular expressions.
21121 If the first character of the search string is an asterisks,
21122 search only the headlines.
21125 The individual words are then interpreted as a boolean expression with
21126 logical AND. Words prefixed with a minus must not occur in the entry.
21127 Words without a prefix or prefixed with a plus must occur in the entry.
21128 Matching is case-insensitive and the words are enclosed by word delimiters.
21130 Words enclosed by curly braces are interpreted as regular expressions
21131 that must or must not match in the entry.
21133 This command searches the agenda files, and in addition the files listed
21134 in `org-agenda-text-search-extra-files'."
21141 'org-not-done-regexp org-not-done-regexp
21142 'org-todo-regexp org-todo-regexp
21144 'keymap org-agenda-keymap
21146 regexp rtn rtnall files file pos
21147 marker priority category tags c neg re
21177 words)
21183 regexp))))
21185 rtnall nil)
21194 ;; If file does not exist, make sure an error message is sent
21196 file))))
21205 org-agenda-restrict-end)
21227 regexps-)
21231 regexps+)
21237 ""
21240 category tags))
21271 ;;; Agenda TODO list
21276 ;;;###autoload
21278 "Show all TODO entries from all agenda file in a single list.
21279 The prefix arg can be used to select a specific TODO keyword and limit
21281 for a keyword. A numeric prefix directly selects the Nth keyword in
21282 `org-todo-keywords-1'."
21296 rtn rtnall files file pos)
21306 rtnall nil)
21330 kwds))
21341 ;;; Agenda tags match
21343 ;;;###autoload
21345 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
21346 The prefix arg TODO-ONLY limits the search to TODO entries."
21353 rtn rtnall files file pos matcher
21354 buffer)
21363 rtnall nil)
21371 ;; If file does not exist, merror message to agenda
21382 org-agenda-restrict-end)
21407 ;;; Agenda Finding stuck projects
21410 "Regular expression used in skipping subtrees for the agenda.
21411 This is basically a temporary global variable that can be set and then
21418 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
21419 If yes, it returns the end position of this tree, causing agenda commands
21420 to skip this subtree. This is a function that can be put into
21421 `org-agenda-skip-function' for the duration of a command."
21423 skip)
21429 "Skip entry if any of CONDITIONS is true.
21430 See `org-agenda-skip-if' for details."
21434 "Skip entry if any of CONDITIONS is true.
21435 See `org-agenda-skip-if' for details."
21439 "Checks current entity for CONDITIONS.
21440 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
21441 the entry, i.e. the text before the next heading is checked.
21443 CONDITIONS is a list of symbols, boolean OR is used to combine the results
21444 from different tests. Valid conditions are:
21446 scheduled Check if there is a scheduled cookie
21447 notscheduled Check if there is no scheduled cookie
21448 deadline Check if there is a deadline
21449 notdeadline Check if there is no deadline
21450 regexp Check if regexp matches
21451 notregexp Check if regexp does not match.
21453 The regexp is taken from the conditions list, it must come right after
21454 the `regexp' or `notregexp' element.
21456 If any of these conditions is met, this function returns the end point of
21457 the entity, causing the search to continue from there. This is a function
21458 that can be put into `org-agenda-skip-function' for the duration of a command."
21482 end)))
21484 ;;;###autoload
21486 "Create agenda view for projects that are stuck.
21487 Stuck projects are project that have no next actions. For the definitions
21488 of what a project is and how to check if it stuck, customize the variable
21489 `org-stuck-projects'.
21490 MATCH is being ignored."
21493 ;; FIXME: we could have used org-agenda-skip-if here.
21501 org-done-keywords-for-agenda
21503 todo))
21520 gen-re)))))
21531 ;;; Diary integration
21536 "Get the (Emacs Calendar) diary entries for DATE."
21544 entries
21556 ;; No entries
21558 ;; Omit the date and other unnecessary stuff
21560 ;; Add prefix to each line and extend the text properties
21572 ;; Extend the text properties to the beginning of the line
21575 entries)))))
21578 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21579 This gets rid of the date, the underline under the date, and
21580 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21581 date. It also removes lines that contain only whitespace."
21598 ;; Make sure entries from the diary have the right text properties.
21601 ;; We can rely on the hook, nothing to do
21602 nil
21603 ;; Hook not avaiable, must use advice to make this work
21605 "Make the position visible."
21608 buffer-file-name)
21612 "Add text properties to string, allowing org-mode to act on it."
21615 'keymap org-agenda-keymap
21620 'org-agenda-diary-link t
21624 "Add a dummy entry to the diary.
21625 Needed to avoid empty dates which mess up holiday display."
21626 ;; Catch the error if dealing with the new add-to-diary-alist
21633 ;;;###autoload
21635 "Return diary information from org-files.
21637 It accesses org files and extracts information from those files to be
21638 listed in the diary. The function accepts arguments specifying what
21639 items should be listed. The following arguments are allowed:
21641 :timestamp List the headlines of items containing a date stamp or
21642 date range matching the selected date. Deadlines will
21643 also be listed, on the expiration day.
21645 :sexp List entries resulting from diary-like sexps.
21647 :deadline List any deadlines past due, or due within
21648 `org-deadline-warning-days'. The listing occurs only
21649 in the diary for *today*, not at any other date. If
21650 an entry is marked DONE, it is no longer listed.
21652 :scheduled List all items which are scheduled for the given date.
21653 The diary for *today* also contains items which were
21654 scheduled earlier and are not yet marked DONE.
21656 :todo List all TODO items from the org-file. This may be a
21657 long list - so this is not turned on by default.
21658 Like deadlines, these entries only show up in the
21659 diary for *today*, not at any other date.
21661 The call in the diary file should look like this:
21663 &%%(org-diary) ~/path/to/some/orgfile.org
21665 Use a separate line for each org file to check. Or, if you omit the file name,
21666 all files listed in `org-agenda-files' will be checked automatically:
21668 &%%(org-diary)
21670 If you don't give any arguments (as in the example above), the default
21671 arguments (:deadline :scheduled :timestamp :sexp) are used.
21672 So the example above may also be written as
21674 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21676 The function expects the lisp variables `entry' and `date' to be provided
21677 by the caller, because this is how the calendar works. Don't use this
21678 function from a program - use `org-agenda-get-day-entries' instead."
21680 org-agenda-last-marker-time)
21689 file rtn results)
21691 ;; If this is called during org-agenda, don't return any entries to
21692 ;; the calendar. Org Agenda will list these entries itself.
21700 ;;; Agenda entry finders
21703 "Does the work for `org-diary' and `org-agenda'.
21704 FILE is the path to a file to be checked for entries. DATE is date like
21705 the one returned by `calendar-current-date'. ARGS are symbols indicating
21706 which kind of entries should be extracted. For details about these, see
21707 the documentation of `org-diary'."
21714 arg results rtn)
21716 ;; If file does not exist, make sure an error message ends up in diary
21726 org-agenda-restrict-end)
21728 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21752 results))))
21768 "Is the cursor inside a date range?"
21783 nil)))
21786 "Return the TODO information for agenda display."
21789 'org-not-done-regexp org-not-done-regexp
21790 'org-todo-regexp org-todo-regexp
21792 'keymap org-agenda-keymap
21793 'help-echo
21796 ;; FIXME: get rid of the \n at some point but watch out
21800 org-todo-regexp
21804 org-not-done-regexp)
21806 marker priority category tags
21807 ee txt beg end)
21846 "Return the date stamp information for agenda display."
21848 'org-not-done-regexp org-not-done-regexp
21849 'org-todo-regexp org-todo-regexp
21851 'keymap org-agenda-keymap
21852 'help-echo
21860 "<%Y-%m-%d"
21874 marker hdmarker deadlinep scheduledp donep tmp priority category
21875 ee txt timestr tags b0 b3 e3 head)
21893 b0)
21900 ;; substring should only run to end of time stamp
21912 nil head category tags timestr nil
21913 remove-re)))
21926 "Return the sexp information for agenda display."
21930 'keymap org-agenda-keymap
21931 'help-echo
21935 marker category ee txt tags entry result beg b sexp sexp-entry)
21967 "Return the logged TODO entries for agenda display."
21969 'org-not-done-regexp org-not-done-regexp
21970 'org-todo-regexp org-todo-regexp
21971 'keymap org-agenda-keymap
21972 'help-echo
21984 marker hdmarker priority category tags closedp
21985 ee txt timestr)
21994 ;; donep (org-entry-is-done-p)
21995 )
21997 ;; substring should only run to end of time stamp
22021 "Return the deadline information for agenda display."
22023 'org-not-done-regexp org-not-done-regexp
22024 'org-todo-regexp org-todo-regexp
22025 'keymap org-agenda-keymap
22026 'help-echo
22032 d2 diff dfrac wdays pos pos1 category tags
22033 ee txt head face s upcomingp donep timestr)
22045 ;; When to show a deadline in the calendar:
22046 ;; If the expiration is within wdays warning time.
22047 ;; Past-due deadlines are only shown on the current date
22075 diff))
22076 head category tags timestr))))
22085 'org-category category
22094 "Return the face to displaying a deadline item.
22095 FRACTION is what fraction of the head-warning time has passed."
22103 "Return the scheduled information for agenda display."
22105 'org-todo-regexp org-todo-regexp
22108 'keymap org-agenda-keymap
22109 'help-echo
22115 d2 diff pos pos1 category tags
22116 ee txt head pastschedp donep face timestr s)
22124 ;;; is this right?
22125 ;;; do we need to do this for deadleine too????
22126 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
22129 ;; When to show a scheduled item in the calendar:
22130 ;; If it is on or past the date.
22158 head category tags timestr))))
22162 'org-scheduled-previously
22165 'undone-face face
22177 "Return the date-range information for agenda display."
22179 'org-not-done-regexp org-not-done-regexp
22180 'org-todo-regexp org-todo-regexp
22182 'keymap org-agenda-keymap
22183 'help-echo
22188 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
22189 donep head)
22201 ;; Only allow days between the limits, because the normal
22202 ;; date stamps will catch the limits.
22219 head category tags
22228 ;; Sort the entries by expiration date.
22231 ;;; Agenda presentation and sorting
22241 "Regular expression to match a plain time or time range.
22242 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22243 groups carry important information:
22244 0 the full match
22245 1 the first time, range or not
22253 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
22254 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22255 groups carry important information:
22256 0 the full match
22257 7 hours of duration
22266 "Regular expression to match a timestamp time or time range.
22267 After a match, the following groups carry important information:
22268 0 the full match
22269 1 date plus weekday, for backreferencing to make sure both times on same day
22270 2 the first time, range or not
22274 "A flag, set by `org-compile-prefix-format'.
22277 "A flag, set by `org-compile-prefix-format'.
22281 noprefix remove-re)
22282 "Format TXT to be inserted into the agenda buffer.
22283 In particular, it adds the prefix and corresponding text properties. EXTRA
22284 must be a string and replaces the `%s' specifier in the prefix format.
22285 CATEGORY (string, symbol or nil) may be used to overrule the default
22286 category taken from local variable or file name. It will replace the `%c'
22287 specifier in the format. DOTIME, when non-nil, indicates that a
22288 time-of-day should be extracted from TXT for sorting of this entry, and for
22289 the `%t' specifier in the format. When DOTIME is a string, this string is
22290 searched for a time before TXT is. NOPREFIX is a flag and indicates that
22291 only the correctly processes TXT should be returned - this is used by
22292 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
22293 Any match of REMOVE-RE will be removed from TXT."
22295 ;; Diary entries sometimes have extra whitespace at the beginning
22298 org-category
22304 time ; time and tag are needed for the eval of the prefix format
22307 stamp plain s0 s1 s2 rtn srp)
22309 ;; Extract starting and ending time and move them to prefix
22317 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
22318 ;; them, we might want to remove them there to avoid duplication.
22319 ;; The user can turn this off with a variable.
22325 t))
22327 ;; Normalize the time(s) to 24 hour
22335 org-agenda-default-appointment-duration))
22336 h)
22341 txt)
22342 ;; Tags are in the string
22345 org-prefix-has-tag))
22350 t t txt))))
22356 ;; Create the final string
22359 ;; Prepare the variables needed in the eval of the compiled format
22365 ;; Evaluate the compiled format
22368 ;; And finally add the text properties
22371 'org-highest-priority org-highest-priority
22372 'org-lowest-priority org-lowest-priority
22374 'time-of-day time-of-day
22375 'txt txt
22376 'time time
22377 'extra extra
22392 list)))
22397 new time)
22399 ;; don't show empty grid
22405 nil string "" nil
22407 new)
22415 "Compile the prefix format into a Lisp form that can be evaluated.
22416 The resulting form is returned and stored in the variable
22417 `org-prefix-format-compiled'."
22421 org-agenda-prefix-format)
22426 varform vars var e c f opt)
22428 s start)
22441 ""
22451 ;; the old format
22459 "Check string S for a time of day.
22460 If found, return it as a military time number between 0 and 2400.
22461 If not found, return nil.
22462 The optional STRING argument forces conversion into a 5 character wide string
22463 HH:MM."
22485 "Sort and concatenate the agenda items."
22488 list
22513 x)
22517 " "
22519 x)))
22522 "Compare the priorities of string A and B."
22530 "Compare the string values of categories of strings A and B."
22538 "Compare the string values of categories of strings A and B."
22548 "Compare the time-of-day values of strings A and B."
22557 "Predicate for sorting agenda entries."
22558 ;; The following variables will be used when the form is evaluated.
22559 ;; So even though the compiler complains, keep them.
22573 ;;; Agenda restriction lock
22591 "Set restriction lock for agenda, to current subtree or file.
22592 Restriction will be the file if TYPE is `file', or if type is the
22593 universal prefix '(4), or if the cursor is before the first headline
22594 in the file. Otherwise, restriction will be to the current subtree."
22626 "Remove the agenda restriction lock."
22640 "If there is any window showing the agenda view, update it."
22649 org-agenda-overriding-restriction)
22652 ;;; Agenda commands
22655 "Check if agenda buffer is of allowed type.
22656 If ERROR is non-nil, throw an error, otherwise just return nil."
22658 t
22661 nil)))
22664 "Exit agenda by removing the window or the buffer."
22671 ;; Maybe restore the pre-agenda window configuration.
22674 org-pre-agenda-window-conf
22678 "Exit agenda by removing the window or the buffer.
22679 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22680 Org-mode buffers visited directly by the user will not be touched."
22694 "Save all Org-mode buffers without user confirmation."
22701 "Rebuild Agenda.
22702 When this is the global TODO list, a prefix argument will be interpreted."
22711 org-agenda-pending-undo-list nil)
22717 "Manipulate the query by adding a search term with positive selection.
22718 Positive selection means, the term must be matched for selection of an entry."
22722 "Manipulate the query by adding a search term with negative selection.
22723 Negative selection means, term must not be matched for selection of an entry."
22727 "Manipulate the query by adding a search regexp with positive selection.
22728 Positive selection means, the regexp must match for selection of an entry."
22732 "Manipulate the query by adding a search regexp with negative selection.
22733 Negative selection means, regexp must not match for selection of an entry."
22740 'org-agenda-query-string
22747 org-agenda-query-string))
22751 org-agenda-type))))
22757 "Jump to DATE in agenda."
22762 "Go to today."
22788 "Go forward in time by thee current span.
22789 With prefix ARG, go forward that many times the current span."
22796 greg2 nd)
22818 "Go backward in time by the current span.
22819 With prefix ARG, go backward that many times the current span."
22824 "Switch to daily view for agenda."
22829 "Switch to daily view for agenda."
22834 "Switch to daily view for agenda."
22838 "Switch to daily view for agenda."
22845 "Change the agenda view to SPAN.
22846 SPAN may be `day', `week', `month', `year'."
22851 org-starting-day))
22862 "Compute starting date and number of days for agenda.
22863 SPAN may be `day', `week', `month', `year'. The return value
22864 is a cons cell with the starting date and the number of days,
22865 so that the date SD will be in that range."
22867 nd)
22884 sd)))
22890 sd))))
22893 ;; FIXME: does not work if user makes date format that starts with a blank
22895 "Jump to the next line indicating a date in agenda buffer."
22907 "Jump to the previous line indicating a date in agenda buffer."
22914 ;; Initialize the highlight
22919 "Highlight a region with overlay."
22924 "Detach overlay INDEX."
22927 ;; FIXME this is currently not used.
22936 "Toggle follow mode in an agenda buffer."
22944 "Toggle log mode in an agenda buffer."
22954 "Toggle diary inclusion in an agenda buffer."
22964 "Toggle time grid in an agenda buffer."
22974 "Set the mode name to indicate all the small mode settings."
22993 "Show the priority of the current item.
22994 This priority is composed of the main priority given with the [#A] cookies,
22995 and by additional input from the age of a schedules or deadline entry."
23001 "Show the tags applicable to the current item."
23010 "Go to the Org-mode file which contains the item at point."
23029 "Normal hook run after an item has been shown from the agenda.
23033 "Kill the entry or subtree belonging to the current agenda entry."
23066 "Kill the entry or subtree belonging to the current agenda entry."
23084 "Remove all lines in the agenda that correspond to a given subtree.
23085 The subtree is the one in buffer BUF, starting at BEG and ending at END.
23086 If this information is not given, the function uses the tree at point."
23109 "Follow the link in the current line, if any."
23118 "Get a variable from a referenced buffer and install it here."
23125 "Go to the Org-mode file which contains the item at point."
23142 "Go to the Org-mode file which contains the item at the mouse click."
23148 "Display the Org-mode file which contains the item at point."
23155 "Display the Org-mode file which contains the item at point and recenter."
23163 "Display the Org-mode file which contains the item at the mouse click."
23169 "Check if the entry is a diary link and abort if yes."
23177 "Show the subtree corresponding to the current entry in an indirect buffer.
23178 This calls the command `org-tree-to-indirect-buffer' from the original
23179 Org-mode buffer.
23180 With numerical prefix arg ARG, go up to this level and then take that tree.
23181 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
23182 dedicated frame)."
23195 "Marker pointing to the headline that last changed its TODO state
23199 "Switch TODO entry to next sequence."
23204 "Switch TODO entry to previous sequence."
23209 "Cycle TODO state of line at point, also in Org-mode file.
23210 This changes the line at point, all other lines in the agenda referring to
23211 the same tree node, and the headline of the tree node in the Org-mode file."
23221 newhead)
23242 "Change all lines in the agenda buffer which match HDMARKER.
23243 The new content of the line will be NEWHEAD (as modified by
23244 `org-format-agenda-item'). HDMARKER is checked with
23245 `equal' against all `org-hd-marker' text properties in the file.
23246 If FIXFACE is non-nil, the face of each item is modified acording to
23247 the new TODO state."
23249 props m pl undone-face done-face finish new dotime cat tags)
23279 undone-face done-face))))
23287 "Align all tags in agenda items to `org-agenda-tags-column'."
23300 org-agenda-tags-column))
23308 "Increase the priority of line at point, also in Org-mode file."
23313 "Decrease the priority of line at point, also in Org-mode file."
23318 "Set the priority of line at point, also in Org-mode file.
23319 This changes the line at point, all other lines in the agenda referring to
23320 the same tree node, and the headline of the tree node in the Org-mode file."
23329 newhead)
23345 "Get a list of all headline tags applicable at POS.
23346 POS defaults to point. If tags are inherited, the list contains
23347 the targets in the same sequence as the headlines appear, i.e.
23348 the tags of the current headline come last."
23364 tags)))
23368 tags)))
23370 ;; FIXME: should fix the tags property of the agenda line.
23372 "Set tags for the current headline."
23383 newhead)
23401 "Toggle the archive tag for the current entry."
23410 newhead)
23426 "Change the date of this item to one day later."
23445 "Change the date of this item to one day earlier."
23450 "Show new date stamp via text properties."
23451 ;; We use text properties to make this undoable
23460 ;; Use `duplicable' property to trigger undo recording
23475 "Change the date of this item. Date is prompted for, with default today.
23476 The prefix ARG is passed to the `org-time-stamp' command and can therefore
23477 be used to request time specification in the time stamp."
23495 "Schedule the item at point."
23505 ts)
23517 "Schedule the item at point."
23526 ts)
23536 "Return the heading of the current entry, without the stars."
23546 "Start the clock on the currently selected item."
23559 "Stop the currently running clock."
23567 "Cancel the currently running clock."
23575 "Make a diary entry, like the `i' command from the calendar.
23576 All the standard commands work: block, weekly etc."
23592 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23601 ;; We implement this by hacking the `calendar-cursor-to-date' function
23602 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23618 "Execute a calendar command from the agenda, with the date associated to
23619 the cursor position."
23628 ;; the following 3 vars are needed in the calendar
23642 "Display the phases of the moon for the 3 months around the cursor date."
23647 "Display the holidays for the 3 months around the cursor date."
23656 "Display sunrise and sunset for the cursor date.
23657 Latitude and longitude can be specified with the variables
23658 `calendar-latitude' and `calendar-longitude'. When called with prefix
23659 argument, latitude and longitude will be prompted for."
23669 "Open the Emacs calendar with the date at the cursor."
23682 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23683 This is a command that has to be installed in `calendar-mode-map'."
23687 nil))
23693 date s)
23719 ;;;; Embedded LaTeX
23734 "Toggle the minor `org-cdlatex-mode'.
23735 This mode supports entering LaTeX environment and math in LaTeX fragments
23736 in Org-mode.
23738 nil " OCDL" nil
23743 "Always return t in org-mode buffers.
23744 This is because we want to insert math symbols without dollars even outside
23745 the LaTeX math segments. If Orgmode thinks that point is actually inside
23746 en embedded LaTeX fragement, let texmathp do its job.
23763 "Unconditionally turn on `org-cdlatex-mode'."
23767 "Test if point is inside a LaTeX fragment.
23769 sequence appearing also before point.
23770 Even though the matchers for math are configurable, this function assumes
23772 delimiters are skipped when they have been removed by customization.
23773 The return value is nil, or a cons cell with the delimiter and
23774 and the position of this delimiter.
23776 This function does a reasonably good job, but can locally be fooled by
23777 for example currency specifications. For example it will assume being in
23779 fragments that are properly closed, but during editing, we have to live
23780 with the uncertainty caused by missing closing delimiters. This function
23781 looks only before point, not after."
23800 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23804 ;; count $$
23812 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23813 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23814 - inside a LaTeX fragment, or
23815 - after the first word in a line, where an abbreviation expansion could
23816 insert a LaTeX environment."
23829 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23830 Revert to the normal definition outside of these fragments."
23838 "Execute `cdlatex-math-modify' in LaTeX fragments.
23839 Revert to the normal definition outside of these fragments."
23851 "Remove all overlays with LaTeX fragment images in current buffer."
23856 "Preview the LaTeX fragment at point, or all locally or globally.
23857 If the cursor is in a LaTeX fragment, create the image and overlay
23858 it over the source code. If there is no fragment at point, display
23859 all fragments in the current text, from one headline to the next. With
23860 prefix SUBTREE, display all fragments in the current subtree. With a
23861 double prefix `C-u C-u', or when the cursor is before the first headline,
23862 display all fragments in the buffer.
23892 buffer-file-name)))
23898 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23899 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23900 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23907 "Replace LaTeX fragments with links to an image, and produce images."
23916 m n block linkfile movefile ov)
23917 ;; Check if there are old images files with this prefix, and remove them
23921 todir 'full
23923 ;; Check the different regular expressions
23943 txt movefile opt forbuffer)
23951 ov 'end-glyph
23954 ov 'display
23961 ;; This function borrows from Ganesh Swami's latex2png.el
23965 temporary-file-directory))
23994 "-D" dpi
23995 ;;"-x" scale "-y" scale
23997 "-o" pngfile
23998 dvifile)
24001 ;; Use the requested file name and clean up
24005 pngfile))))
24008 "Return an rgb color specification for dvipng."
24014 "Return string to be used as color value for an RGB component."
24017 ;;;; Exporting
24019 ;;; Variables, constants, and parameter plists
24075 "Return the property list with default settings for the export variables."
24079 rtn))
24082 "Return the property list with file-local settings for export."
24089 p key val text options)
24122 o)
24126 options)
24130 p))))
24136 val)))
24137 dir))
24144 rtn line level)
24149 ;; Beginning of a COMMENT subtree. Skip it.
24155 ;; an ordinary comment line
24156 )
24162 ;; a special table line that should be removed
24163 )
24170 \[v] limit export to visible part of outline tree
24172 \[a] export as ASCII
24174 \[h] export as HTML
24175 \[H] export as HTML to temporary buffer
24176 \[R] export region as HTML
24177 \[b] export as HTML and browse immediately
24178 \[x] export as XOXO
24180 \[l] export as LaTeX
24181 \[L] export as LaTeX to temporary buffer
24183 \[i] export current file as iCalendar file
24184 \[I] export all agenda files as iCalendar files
24185 \[c] export agenda files into combined iCalendar file
24187 \[F] publish current file
24188 \[P] publish current project
24189 \[X] publish... (project will be prompted for)
24209 r1 r2 ass)
24512 )
24513 "Entities for TeX->HTML translation.
24517 The list contains HTML entities for Latin-1, Greek and other symbols.
24518 It is supplemented by a number of commonly used TeX macros with appropriate
24521 ;;; General functions for all backends
24524 "Cleanup a buffer STRING so that links can be created safely."
24542 a b xx
24543 rtn p)
24547 ;; Remove license-to-kill stuff
24555 ;; Get rid of drawers
24560 'identity
24568 ;; Get the correct stuff before the first headline
24579 ;; Get rid of archived trees
24591 ;; Find targets in comments and move them out of comments,
24592 ;; but mark them as targets that should be invisible
24597 ;; Protect backend specific stuff, throw away the others.
24602 fmt)
24633 ;; Protect quoted subtrees
24641 ;; Protect verbatim elements
24648 ;; Remove subtrees that are commented
24654 ;; Remove special table lines
24666 ;; Specific LaTeX stuff
24674 ;; Specific HTML stuff
24676 ;; Convert LaTeX fragments to images
24681 org-current-export-file)))
24685 ;; Remove or replace comments
24694 ;; Find matches for radio targets and turn them into internal links
24701 ;; Find all links that contain a newline and put them into a single line
24703 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24709 ;; Normalize links: Convert angle and plain links into bracket links
24710 ;; Expand link abbreviations
24717 ;; added 'org-link face to links
24733 "]"
24741 ;; Find multiline emphasis and put them into single line
24755 rtn))
24758 "Get a title for the current document, from looking at the buffer."
24764 ;; Mark the line so that it will not be exported as normal text.
24768 ;; Return the title string
24772 "Return subtree title and exclude it from export."
24778 ;; This is a subtree, we take the title from the first heading
24785 title))
24788 "Take link text and make a safe target out of it."
24792 'identity
24798 "Get the minimum level in LINES."
24806 ;; Variable holding the vector with section numbers
24810 "Initialize the vector for the section numbers."
24827 "Return a string with the current section number.
24828 When LEVEL is non-nil, increase section numbers on that level."
24850 string))
24852 ;;; ASCII export
24860 "Export the outline as a pretty ASCII file.
24861 If there is an active region, export only the region.
24862 The prefix ARG specifies how many levels of the outline should become
24863 underlined headlines. The default is 3."
24892 filename))
24908 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24917 region
24918 :for-ascii t
24919 :skip-before-1st-heading
24922 :verbatim-multiline t
24923 :archived-trees
24927 thetoc have-headings first-heading-pos
24928 table-open table-buffer)
24946 ;; create local variables for all options, to make sure all called
24947 ;; functions get the correct information
24951 org-export-plist-vars)
24954 org-export-headline-levels))
24957 umax))
24959 ;; File header
24963 org-export-author-info)
24985 line)
24986 ;; This is a headline
24992 todo
24996 org-done-keywords)))
24997 ; TODO, not DONE
25001 line lines level))))
25008 t t txt)))
25013 txt))
25028 thetoc)
25030 ))))
25031 lines)
25036 ;; Remove the quoted HTML tags.
25038 ;; Remove targets
25041 ;; Replace internal links
25045 t nil line)))
25050 ;; a Headline
25059 ;; New table starts
25061 ;; Accumulate lines
25082 ;; insert the table of contents
25094 ;; Convert whitespace place holders
25104 ;; remove display and invisible chars
25120 "Do extra work for ASCII export"
25130 "Search the subtree below LINE for any TODO entries."
25133 line lv todo)
25141 org-done-keywords))))
25142 ; TODO, not DONE
25147 "Handle quoted HTML for ASCII export."
25150 ;; We just remove the tags for now.
25152 line)
25155 "Insert the string S centered and underline it with character UNDERLINE."
25164 "Insert a new level in ASCII export."
25170 org-export-ascii-bullets))
25172 ;; find the indentation of the next non-empty line
25193 "Create a copy of the visible part of the current buffer, and export it.
25194 The copy is created in a temporary buffer and removed after use.
25195 TYPE is the final key (as a string) that also select the export command in
25196 the `C-c C-e' export dispatcher.
25197 As a special case, if the you type SPC at the prompt, the temporary
25198 org-mode file will not be removed but presented to you so that you can
25199 continue to use it. The prefix arg ARG is passed through to the exporting
25200 command."
25203 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
25205 current-prefix-arg))
25220 s e)
25221 ;; Need to hack the drawers here.
25237 ;; Copy all comment lines to the end, to make sure #+ settings are
25238 ;; still available for the second export step. Kind of a hack, but
25239 ;; does do the trick.
25260 s))
25265 s))
25267 ;;; HTML export
25270 "Return a string with current options as keyword options.
25271 Does include HTML export options as well as TODO and CATEGORY stuff."
25273 "#+TITLE: %s
25274 #+AUTHOR: %s
25275 #+EMAIL: %s
25276 #+LANGUAGE: %s
25277 #+TEXT: Some descriptive text to be emitted. Several lines OK.
25278 #+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
25279 #+CATEGORY: %s
25280 #+SEQ_TODO: %s
25281 #+TYP_TODO: %s
25282 #+PRIORITIES: %c %c %c
25283 #+DRAWERS: %s
25284 #+STARTUP: %s %s %s %s %s
25285 #+TAGS: %s
25286 #+ARCHIVE: %s
25287 #+LINK: %s
25288 "
25290 org-export-headline-levels
25291 org-export-with-section-numbers
25292 org-export-with-toc
25293 org-export-preserve-breaks
25294 org-export-html-expand
25295 org-export-with-fixed-width
25296 org-export-with-tables
25297 org-export-with-sub-superscripts
25298 org-export-with-special-strings
25299 org-export-with-footnotes
25300 org-export-with-emphasize
25301 org-export-with-TeX-macros
25302 org-export-with-LaTeX-fragments
25303 org-export-skip-text-before-1st-heading
25304 org-export-with-drawers
25305 org-export-with-tags
25307 "TODO FEEDBACK VERIFY DONE"
25308 "Me Jason Marie DONE"
25309 org-highest-priority org-lowest-priority org-default-priority
25326 org-archive-location
25327 "org file:~/org/%s.org"
25328 ))
25331 "Insert into the buffer a template with information for exporting."
25340 "Toggle the fixed-width export.
25341 If there is no active region, the QUOTE keyword at the current headline is
25342 inserted or removed. When present, it causes the text between this headline
25343 and the next to be exported as fixed-width text, and unmodified.
25344 If there is an active region, this command adds or removes a colon as the
25345 first character of this line. If the first character of a line is a colon,
25346 this line is also exported in fixed-width font."
25355 off)
25385 "Export the outline as HTML and immediately open it with a browser.
25386 If there is an active region, export only the region.
25387 The prefix ARG specifies how many levels of the outline should become
25388 headlines. The default is 3. Lower levels will become bulleted lists."
25394 "Call `org-export-as-html', may be used in batch processing as
25395 emacs --batch
25396 --load=$HOME/lib/emacs/org.el
25398 --visit=MyFile --funcall org-export-as-html-batch"
25402 "Call `org-exort-as-html` with output to a temporary buffer.
25403 No file is created. The prefix ARG is passed through to `org-export-as-html'."
25409 "Assume the current region has org-mode syntax, and convert it to HTML.
25410 This can be used in any buffer. For example, you could write an
25411 itemized list in org-mode syntax in an HTML buffer and then use this
25412 command to convert it."
25432 "Convert region from BEG to END in org-mode buffer to HTML.
25433 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
25434 contents, and only produce the region of converted text, useful for
25435 cut-and-paste operations.
25436 If BUFFER is a buffer or a string, use/create that buffer as a target
25437 of the converted HTML. If BUFFER is the symbol `string', return the
25438 produced HTML as a string and leave not buffer behind. For example,
25439 a Lisp program could call this function in the following way:
25441 (setq html (org-export-region-as-html beg end t 'string))
25443 When called interactively, the output buffer is selected, and shown
25444 in a window. A non-interactive call will only retunr the buffer."
25449 rtn)
25454 nil nil nil
25455 buffer body-only))
25459 rtn)))
25463 to-buffer body-only pub-dir)
25464 "Export the outline as a pretty HTML file.
25465 If there is an active region, export only the region. The prefix
25466 ARG specifies how many levels of the outline should become
25467 headlines. The default is 3. Lower levels will become bulleted
25468 lists. When HIDDEN is non-nil, don't display the HTML buffer.
25469 EXT-PLIST is a property list with external parameters overriding
25470 org-mode's default settings, but still inferior to file-local
25471 settings. When TO-BUFFER is non-nil, create a buffer with that
25472 name and export to that buffer. If TO-BUFFER is the symbol
25473 `string', don't leave any buffer behind but just return the
25474 resulting HTML as a string. When BODY-ONLY is set, don't produce
25475 the file header and footer, simply return the content of
25476 <body>...</body>, without even the body tags themselves. When
25477 PUB-DIR is set, use this as the publishing directory."
25480 ;; Make sure we have a file name when we need it.
25486 buffer-file-name))
25495 ext-plist
25501 valid thetoc have-headings first-heading-pos
25510 ;; The following two are dynamically scoped into other
25511 ;; routines below.
25531 default-directory))
25565 buffer-file-coding-system))
25567 coding-system))
25569 coding-system))
25581 region
25582 :emph-multiline t
25583 :for-html t
25584 :skip-before-1st-heading
25587 :archived-trees
25589 :add-text
25591 :LaTeX-fragments
25594 table-open type
25595 table-buffer table-orig-buffer
25596 ind start-is-num starter didclose
25597 rpl path desc descp desc1 desc2 link
25598 )
25617 ;; Get the language-dependent settings
25621 ;; Switch to the output buffer
25631 ;; create local variables for all options, to make sure all called
25632 ;; functions get the correct information
25636 org-export-plist-vars)
25638 org-export-headline-levels))
25641 umax))
25643 ;; File header
25649 <head>
25650 <title>%s</title>
25655 %s
25656 </head><body>
25657 "
25670 org-export-html-toplevel-hlevel
25672 org-export-html-toplevel-hlevel)
25673 thetoc)
25678 ;; This is a headline
25687 todo
25691 org-done-keywords)))
25692 ; TODO, not DONE
25696 line lines level))))
25721 ;; Check for targets
25726 t t line))
25729 target-alist))
25740 )))
25741 line)
25742 lines))
25754 ;; end of quote section?
25758 ;; inside a quote section?
25763 ;; verbatim lines
25777 ;; Protected HTML
25792 ;; Horizontal line
25797 ;; make targets to anchors
25805 t t line)))
25809 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25810 t t line)))
25816 t t line)))))
25820 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25821 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25822 ;; Also handle sub_superscripts and checkboxes
25826 ;; Format the links
25836 ;; Make an image out of the description if that is so wanted
25842 ;; FIXME: do we need to unescape here somewhere?
25852 ;; standard URL, just check if we need to inline an image
25860 ;; standard URL
25864 ;; FILE link
25867 thefile file-is-image-p search)
25875 t))
25884 ;; make sure this is can be used as target search
25909 ;; TODO items
25917 org-done-keywords)
25922 ;; Does this contain a reference to a footnote?
25934 t t line))))))
25938 ;; This is a headline
25946 ;; Close any local lists before inserting a new header line
25952 in-local-list nil))
25956 head-count)
25957 ;; QUOTES
25965 ;; New table starts
25967 ;; Accumulate lines
25979 ;; Normal lines
25982 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25983 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25986 line)
25993 ;; empty line. Pretend indentation is large.
25995 0
26011 ;; Start new (level of) list
26018 ;; continue current list
26022 ;; we did close a list, normal text follows: need <p>
26028 "<b>[X]</b>"
26030 t t line))))
26032 ;; Empty lines start a new paragraph. If hand-formatted lists
26033 ;; are not fully interpreted, lines starting with "-", "+", "*"
26034 ;; also start a new paragraph.
26037 ;; Is this the start of a footnote?
26043 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
26045 ;; Check if the line break needs to be conserved
26054 ;; Properly close all local lists and other lists
26057 ;; Close any local lists before inserting a new header line
26063 in-local-list nil))
26066 head-count)
26097 ;; insert the table of contents
26114 ;; remove empty paragraphs and lists
26124 ;; Convert whitespace place holders
26144 "Format a table for ascii export."
26148 ;; Table made by table.el - test for spanning
26149 lines
26151 ;; A normal org table
26152 ;; Get rid of hlines at beginning and end
26158 ;; Check if the table has a marking column. If yes remove the
26159 ;; column and the special lines
26161 ;; Get rid of the vertical lines except for grouping
26163 rtn line vl1 start)
26185 vl))
26188 "Find out which HTML converter to use and return the HTML code."
26192 ;; A normal org table
26194 ;; Table made by table.el - test for spanning
26198 nil))
26199 lines)))
26205 hlines))))
26208 ;; We can use my own converter with HTML conversions
26210 ;; Need to use the code generator in table.el, with the original text.
26214 "Format a table into HTML."
26215 ;; Get rid of hlines at beginning and end
26221 ;; Check if the table has a marking column. If yes remove the
26222 ;; column and the special lines
26230 tbopen line fields html gr colgropen)
26242 ;; ignore this line
26244 ;; Break the line into fields
26262 html)))
26267 ;; Put in col tags with the alignment (unfortuntely often ignored...)
26283 html)
26289 "Check if the table has a marking column.
26290 If yes remove the column and the special lines."
26296 lines))
26311 nil)
26313 lines)))
26327 nil)
26332 ;; remove the first column
26334 lines))))
26337 "Format a table generated by table.el into HTML.
26338 This conversion does *not* use `table-generate-source' from table.el.
26339 This has the advantage that Org-mode's HTML conversions can be used.
26340 But it has the disadvantage, that no cell- or row-spanning is allowed."
26343 fields html empty)
26353 html
26355 html
26356 "<tr>"
26369 ;; Ignore this line
26371 ;; Break the line into fields and store the fields
26377 field-buffer))
26380 html))
26383 "Format a table into html, using `table-generate-source' from table.el.
26384 This has the advantage that cell- or row-spanning is allowed.
26385 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
26400 "Format time stamps in string S, or remove them."
26405 ;; never export CLOCK
26420 ;; Line break if line started and ended with time stamp stuff
26422 s
26426 r))))
26429 ;; convert & to &, < to < and > to >
26438 s)
26441 "Remove tags and time staps from lines going into the toc."
26450 t t s)))
26451 s)
26454 "Prepare STRING for HTML export. Applies all active conversions.
26455 If there are links in the string, don't modify these."
26458 m s l res)
26469 "Apply all active conversions to translate special ASCII to HTML."
26490 t t s))
26492 s)
26495 "Create a regular expression which will match a balanced sexp.
26496 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
26497 as single character strings.
26498 The regexp returned will match the entire expression including the
26499 delimiters. It will also define a single group which contains the
26500 match except for the outermost delimiters. The maximum depth of
26501 stacked delimiters is N. Escaping delimiters is not possible."
26537 "Convert special characters in STRING to HTML."
26539 e a re rpl start)
26546 string))
26549 "Convert sub- and superscripts in STRING to HTML."
26565 t t string)))))
26568 string))
26571 "Apply emphasis."
26578 rpl
26584 org-emphasis-alist))
26589 string))
26593 "Insert <p>, but first close previous paragraph if any."
26598 "Close paragraph if there is one open."
26603 "Close <li> if necessary."
26609 "Insert a new level in HTML export.
26610 When TITLE is nil, just close all open levels."
26620 ;; If title is nil, this means this function is called to close
26621 ;; all levels, so the rest is done only if title is given
26633 t t title)))
26649 level level head-count title level))
26654 "Terminate one level in HTML export."
26660 ;;; iCalendar export
26662 ;;;###autoload
26664 "Export current file as an iCalendar file.
26665 The iCalendar file will be located in the same directory as the Org-mode
26666 file, but with extension `.ics'."
26670 ;;;###autoload
26672 "Export all files in `org-agenda-files' to iCalendar .ics files.
26673 Each iCalendar file will be located in the same directory as the Org-mode
26674 file, but with extension `.ics'."
26678 ;;;###autoload
26680 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26681 The file is stored under the name `org-combined-agenda-icalendar-file'."
26686 "Create iCalendar files for all elements of FILES.
26687 If COMBINE is non-nil, combine all calendar entries into a single large
26688 file and store it under the name `org-combined-agenda-icalendar-file'."
26693 org-export-publishing-directory)))
26694 file ical-file ical-buffer category started org-agenda-new-buffers)
26700 org-combined-agenda-icalendar-file
26733 "Hook run after an iCalendar file has been saved.
26734 The iCalendar buffer is still current when this hook is run.
26735 A good way to use this is to tell a desktop calenndar application to re-read
26739 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26740 When COMBINE is non nil, add the category to each line."
26747 scheduledp deadlinep tmp pri category entry location summary desc
26757 inc t
26764 t org-icalendar-include-body)
26774 pos)
26779 ts)
26782 ;; donep (org-entry-is-done-p)
26783 ))
26802 t t summary)))
26809 %s
26810 %s%s
26811 SUMMARY:%s%s%s
26812 CATEGORIES:%s
26816 rrule summary
26821 category)))))
26826 ;; Get all the literal sexps
26852 )
26859 t org-icalendar-include-body)
26865 t t hd)))
26875 %s
26876 SUMMARY:%s%s%s
26877 CATEGORIES:%s
26878 SEQUENCE:1
26879 PRIORITY:%d
26880 STATUS:%s
26882 dts
26888 category pri status)))))))))
26891 "Take out stuff and quote what needs to be quoted.
26892 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26893 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26894 characters."
26896 nil
26915 s))
26918 "Clean-up description string."
26924 "Start an iCalendar file by inserting the header."
26930 VERSION:2.0
26931 X-WR-CALNAME:%s
26932 PRODID:-//%s//Emacs with Org-mode//EN
26933 X-WR-TIMEZONE:%s
26937 "Finish an iCalendar file by inserting the END statement."
26941 "Take a time string S and convert it to iCalendar format.
26942 KEYWORD is added in front, to make a complete line like DTSTART....
26943 When INC is non-nil, increase the hour by two (if time string contains
26944 a time), or the day by one (if it does not contain a time)."
26946 t2 fmt have-time time)
26962 ;;; XOXO export
26970 "Export the org buffer as XOXO.
26971 The XOXO buffer is named *xoxo-<source buffer name>*"
26973 ;; A quickie abstraction
26975 ;; Output everything as XOXO
26989 ;; Check the output buffer is empty.
26991 ;; Kick off the output
27008 ;; Handle level rendering
27025 )
27029 ;; And output the new li
27035 ;; Finally finish off the ol
27042 ;; Finish the buffer off and clean it up.
27047 )))
27050 ;;;; Key bindings
27052 ;; Make `C-c C-x' a prefix key
27055 ;; TAB key with modifiers
27062 ;; The following line is necessary under Suse GNU/Linux
27068 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
27069 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
27070 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
27072 ;; Cursor keys with modifiers
27073 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
27074 (org-defkey org-mode-map [(meta right)] 'org-metaright)
27075 (org-defkey org-mode-map [(meta up)] 'org-metaup)
27076 (org-defkey org-mode-map [(meta down)] 'org-metadown)
27078 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
27079 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
27080 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
27081 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
27083 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
27084 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
27085 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
27086 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
27088 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
27089 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
27091 ;;; Extra keys for tty access.
27092 ;; We only set them when really needed because otherwise the
27093 ;; menus don't show the simple keys
27095 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
27096 (not window-system))
27097 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
27098 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
27099 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
27100 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
27101 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
27102 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
27103 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
27104 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
27105 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
27106 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
27107 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
27108 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
27109 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
27110 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
27111 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
27112 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
27113 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
27114 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
27115 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
27116 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
27117 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
27118 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
27120 ;; All the other keys
27122 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
27123 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
27124 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
27125 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
27126 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
27127 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
27128 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
27129 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
27130 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
27131 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
27132 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
27133 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
27134 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
27135 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
27136 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
27138 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
27139 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
27140 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
27141 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
27142 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
27143 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
27144 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
27145 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
27146 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
27147 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
27148 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
27149 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
27150 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
27151 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
27152 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
27153 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
27154 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
27156 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
27157 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
27158 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
27159 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27160 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
27161 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
27162 (org-defkey org-mode-map "\C-c^" 'org-sort)
27163 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
27164 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
27165 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
27166 (org-defkey org-mode-map "\C-m" 'org-return)
27167 (org-defkey org-mode-map "\C-j" 'org-return-indent)
27168 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
27169 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
27170 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
27171 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
27172 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
27173 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
27174 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
27175 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
27176 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
27177 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
27178 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
27179 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
27180 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
27181 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
27182 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
27184 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
27185 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
27186 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
27187 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
27189 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
27190 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
27191 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
27192 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
27193 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
27194 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
27195 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
27196 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
27197 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
27198 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
27199 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
27200 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
27202 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
27204 (when (featurep 'xemacs)
27205 (org-defkey org-mode-map 'button3 'popup-mode-menu))
27207 (defsubst org-table-p () (org-at-table-p))
27209 (defun org-self-insert-command (N)
27210 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
27211 If the cursor is in a table looking at whitespace, the whitespace is
27212 overwritten, and the table is not marked as requiring realignment."
27213 (interactive "p")
27214 (if (and (org-table-p)
27215 (progn
27216 ;; check if we blank the field, and if that triggers align
27217 (and org-table-auto-blank-field
27218 (member last-command
27219 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
27221 ;; got extra space, this field does not determine column width
27222 (let (org-table-may-need-update) (org-table-blank-field))
27223 ;; no extra space, this field may determine column width
27224 (org-table-blank-field)))
27225 t)
27226 (eq N 1)
27228 (let (org-table-may-need-update)
27229 (goto-char (1- (match-end 0)))
27230 (delete-backward-char 1)
27231 (goto-char (match-beginning 0))
27232 (self-insert-command N))
27233 (setq org-table-may-need-update t)
27234 (self-insert-command N)
27235 (org-fix-tags-on-the-fly)))
27237 (defun org-fix-tags-on-the-fly ()
27238 (when (and (equal (char-after (point-at-bol)) ?*)
27239 (org-on-heading-p))
27240 (org-align-tags-here org-tags-column)))
27242 (defun org-delete-backward-char (N)
27243 "Like `delete-backward-char', insert whitespace at field end in tables.
27244 When deleting backwards, in tables this function will insert whitespace in
27246 still be marked for re-alignment if the field did fill the entire column,
27247 because, in this case the deletion might narrow the column."
27248 (interactive "p")
27249 (if (and (org-table-p)
27250 (eq N 1)
27251 (string-match "|" (buffer-substring (point-at-bol) (point)))
27252 (looking-at ".*?|"))
27253 (let ((pos (point))
27255 (c org-table-may-need-update))
27256 (backward-delete-char N)
27257 (skip-chars-forward "^|")
27258 (insert " ")
27259 (goto-char (1- pos))
27260 ;; noalign: if there were two spaces at the end, this field
27261 ;; does not determine the width of the column.
27262 (if noalign (setq org-table-may-need-update c)))
27263 (backward-delete-char N)
27264 (org-fix-tags-on-the-fly)))
27266 (defun org-delete-char (N)
27267 "Like `delete-char', but insert whitespace at field end in tables.
27268 When deleting characters, in tables this function will insert whitespace in
27270 still be marked for re-alignment if the field did fill the entire column,
27271 because, in this case the deletion might narrow the column."
27272 (interactive "p")
27273 (if (and (org-table-p)
27274 (not (bolp))
27275 (not (= (char-after) ?|))
27276 (eq N 1))
27277 (if (looking-at ".*?|")
27278 (let ((pos (point))
27280 (c org-table-may-need-update))
27281 (replace-match (concat
27282 (substring (match-string 0) 1 -1)
27283 " |"))
27284 (goto-char pos)
27285 ;; noalign: if there were two spaces at the end, this field
27286 ;; does not determine the width of the column.
27287 (if noalign (setq org-table-may-need-update c)))
27288 (delete-char N))
27289 (delete-char N)
27290 (org-fix-tags-on-the-fly)))
27292 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
27293 (put 'org-self-insert-command 'delete-selection t)
27294 (put 'orgtbl-self-insert-command 'delete-selection t)
27295 (put 'org-delete-char 'delete-selection 'supersede)
27296 (put 'org-delete-backward-char 'delete-selection 'supersede)
27298 ;; Make `flyspell-mode' delay after some commands
27299 (put 'org-self-insert-command 'flyspell-delayed t)
27300 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
27301 (put 'org-delete-char 'flyspell-delayed t)
27302 (put 'org-delete-backward-char 'flyspell-delayed t)
27304 ;; Make pabbrev-mode expand after org-mode commands
27305 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
27306 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
27308 ;; How to do this: Measure non-white length of current string
27309 ;; If equal to column width, we should realign.
27311 (defun org-remap (map &rest commands)
27312 "In MAP, remap the functions given in COMMANDS.
27313 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
27314 (let (new old)
27315 (while commands
27316 (setq old (pop commands) new (pop commands))
27317 (if (fboundp 'command-remapping)
27318 (org-defkey map (vector 'remap old) new)
27319 (substitute-key-definition old new map global-map)))))
27321 (when (eq org-enable-table-editor 'optimized)
27322 ;; If the user wants maximum table support, we need to hijack
27323 ;; some standard editing functions
27324 (org-remap org-mode-map
27325 'self-insert-command 'org-self-insert-command
27326 'delete-char 'org-delete-char
27327 'delete-backward-char 'org-delete-backward-char)
27328 (org-defkey org-mode-map "|" 'org-force-self-insert))
27330 (defun org-shiftcursor-error ()
27331 "Throw an error because Shift-Cursor command was applied in wrong context."
27332 (error "This command is active in special context like tables, headlines or timestamps"))
27334 (defun org-shifttab (&optional arg)
27335 "Global visibility cycling or move to previous table field.
27336 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
27337 on context.
27338 See the individual commands for more information."
27339 (interactive "P")
27340 (cond
27341 ((org-at-table-p) (call-interactively 'org-table-previous-field))
27342 (arg (message "Content view to level: ")
27343 (org-content (prefix-numeric-value arg))
27344 (setq org-cycle-global-status 'overview))
27345 (t (call-interactively 'org-global-cycle))))
27347 (defun org-shiftmetaleft ()
27348 "Promote subtree or delete table column.
27349 Calls `org-promote-subtree', `org-outdent-item',
27350 or `org-table-delete-column', depending on context.
27351 See the individual commands for more information."
27352 (interactive)
27353 (cond
27354 ((org-at-table-p) (call-interactively 'org-table-delete-column))
27355 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
27356 ((org-at-item-p) (call-interactively 'org-outdent-item))
27357 (t (org-shiftcursor-error))))
27359 (defun org-shiftmetaright ()
27360 "Demote subtree or insert table column.
27361 Calls `org-demote-subtree', `org-indent-item',
27362 or `org-table-insert-column', depending on context.
27363 See the individual commands for more information."
27364 (interactive)
27365 (cond
27366 ((org-at-table-p) (call-interactively 'org-table-insert-column))
27367 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
27368 ((org-at-item-p) (call-interactively 'org-indent-item))
27369 (t (org-shiftcursor-error))))
27371 (defun org-shiftmetaup (&optional arg)
27372 "Move subtree up or kill table row.
27373 Calls `org-move-subtree-up' or `org-table-kill-row' or
27374 `org-move-item-up' depending on context. See the individual commands
27375 for more information."
27376 (interactive "P")
27377 (cond
27378 ((org-at-table-p) (call-interactively 'org-table-kill-row))
27379 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27380 ((org-at-item-p) (call-interactively 'org-move-item-up))
27381 (t (org-shiftcursor-error))))
27382 (defun org-shiftmetadown (&optional arg)
27383 "Move subtree down or insert table row.
27384 Calls `org-move-subtree-down' or `org-table-insert-row' or
27385 `org-move-item-down', depending on context. See the individual
27386 commands for more information."
27387 (interactive "P")
27388 (cond
27389 ((org-at-table-p) (call-interactively 'org-table-insert-row))
27390 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27391 ((org-at-item-p) (call-interactively 'org-move-item-down))
27392 (t (org-shiftcursor-error))))
27394 (defun org-metaleft (&optional arg)
27395 "Promote heading or move table column to left.
27396 Calls `org-do-promote' or `org-table-move-column', depending on context.
27397 With no specific context, calls the Emacs default `backward-word'.
27398 See the individual commands for more information."
27399 (interactive "P")
27400 (cond
27401 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
27402 ((or (org-on-heading-p) (org-region-active-p))
27403 (call-interactively 'org-do-promote))
27404 ((org-at-item-p) (call-interactively 'org-outdent-item))
27405 (t (call-interactively 'backward-word))))
27407 (defun org-metaright (&optional arg)
27408 "Demote subtree or move table column to right.
27409 Calls `org-do-demote' or `org-table-move-column', depending on context.
27410 With no specific context, calls the Emacs default `forward-word'.
27411 See the individual commands for more information."
27412 (interactive "P")
27413 (cond
27414 ((org-at-table-p) (call-interactively 'org-table-move-column))
27415 ((or (org-on-heading-p) (org-region-active-p))
27416 (call-interactively 'org-do-demote))
27417 ((org-at-item-p) (call-interactively 'org-indent-item))
27418 (t (call-interactively 'forward-word))))
27420 (defun org-metaup (&optional arg)
27421 "Move subtree up or move table row up.
27422 Calls `org-move-subtree-up' or `org-table-move-row' or
27423 `org-move-item-up', depending on context. See the individual commands
27424 for more information."
27425 (interactive "P")
27426 (cond
27427 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
27428 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27429 ((org-at-item-p) (call-interactively 'org-move-item-up))
27430 (t (transpose-lines 1) (beginning-of-line -1))))
27432 (defun org-metadown (&optional arg)
27433 "Move subtree down or move table row down.
27434 Calls `org-move-subtree-down' or `org-table-move-row' or
27435 `org-move-item-down', depending on context. See the individual
27436 commands for more information."
27437 (interactive "P")
27438 (cond
27439 ((org-at-table-p) (call-interactively 'org-table-move-row))
27440 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27441 ((org-at-item-p) (call-interactively 'org-move-item-down))
27442 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
27444 (defun org-shiftup (&optional arg)
27445 "Increase item in timestamp or increase priority of current headline.
27446 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
27447 depending on context. See the individual commands for more information."
27448 (interactive "P")
27449 (cond
27450 ((org-at-timestamp-p t)
27451 (call-interactively (if org-edit-timestamp-down-means-later
27452 'org-timestamp-down 'org-timestamp-up)))
27453 ((org-on-heading-p) (call-interactively 'org-priority-up))
27454 ((org-at-item-p) (call-interactively 'org-previous-item))
27455 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
27457 (defun org-shiftdown (&optional arg)
27458 "Decrease item in timestamp or decrease priority of current headline.
27459 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
27460 depending on context. See the individual commands for more information."
27461 (interactive "P")
27462 (cond
27463 ((org-at-timestamp-p t)
27464 (call-interactively (if org-edit-timestamp-down-means-later
27465 'org-timestamp-up 'org-timestamp-down)))
27466 ((org-on-heading-p) (call-interactively 'org-priority-down))
27467 (t (call-interactively 'org-next-item))))
27469 (defun org-shiftright ()
27470 "Next TODO keyword or timestamp one day later, depending on context."
27471 (interactive)
27472 (cond
27473 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
27474 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
27475 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
27476 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
27477 (t (org-shiftcursor-error))))
27479 (defun org-shiftleft ()
27480 "Previous TODO keyword or timestamp one day earlier, depending on context."
27481 (interactive)
27482 (cond
27483 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
27484 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
27485 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
27486 ((org-at-property-p)
27487 (call-interactively 'org-property-previous-allowed-value))
27488 (t (org-shiftcursor-error))))
27490 (defun org-shiftcontrolright ()
27491 "Switch to next TODO set."
27492 (interactive)
27493 (cond
27494 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
27495 (t (org-shiftcursor-error))))
27497 (defun org-shiftcontrolleft ()
27498 "Switch to previous TODO set."
27499 (interactive)
27500 (cond
27501 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
27502 (t (org-shiftcursor-error))))
27504 (defun org-ctrl-c-ret ()
27505 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
27506 (interactive)
27507 (cond
27508 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27509 (t (call-interactively 'org-insert-heading))))
27511 (defun org-copy-special ()
27512 "Copy region in table or copy current subtree.
27513 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27514 See the individual commands for more information."
27515 (interactive)
27516 (call-interactively
27517 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27519 (defun org-cut-special ()
27520 "Cut region in table or cut current subtree.
27521 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27522 See the individual commands for more information."
27523 (interactive)
27524 (call-interactively
27525 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27527 (defun org-paste-special (arg)
27528 "Paste rectangular region into table, or past subtree relative to level.
27529 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27530 See the individual commands for more information."
27531 (interactive "P")
27532 (if (org-at-table-p)
27533 (org-table-paste-rectangle)
27534 (org-paste-subtree arg)))
27536 (defun org-ctrl-c-ctrl-c (&optional arg)
27537 "Set tags in headline, or update according to changed information at point.
27539 This command does many different things, depending on context:
27541 - If the cursor is in a headline, prompt for tags and insert them
27542 into the current line, aligned to `org-tags-column'. When called
27543 with prefix arg, realign all tags in the current buffer.
27545 - If the cursor is in one of the special #+KEYWORD lines, this
27546 triggers scanning the buffer for these lines and updating the
27547 information.
27549 - If the cursor is inside a table, realign the table. This command
27550 works even if the automatic table editor has been turned off.
27552 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27553 the entire table.
27555 - If the cursor is a the beginning of a dynamic block, update it.
27557 - If the cursor is inside a table created by the table.el package,
27558 activate that table.
27560 - If the current buffer is a remember buffer, close note and file it.
27561 with a prefix argument, file it without further interaction to the default
27562 location.
27564 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27565 links in this buffer.
27567 - If the cursor is on a numbered item in a plain list, renumber the
27568 ordered list.
27570 - If the cursor is on a checkbox, toggle it."
27571 (interactive "P")
27572 (let ((org-enable-table-editor t))
27573 (cond
27574 ((or org-clock-overlays
27575 org-occur-highlights
27576 org-latex-fragment-image-overlays)
27577 (org-remove-clock-overlays)
27578 (org-remove-occur-highlights)
27579 (org-remove-latex-fragment-image-overlays)
27580 (message "Temporary highlights/overlays removed from current buffer"))
27581 ((and (local-variable-p 'org-finish-function (current-buffer))
27582 (fboundp org-finish-function))
27583 (funcall org-finish-function))
27584 ((org-at-property-p)
27585 (call-interactively 'org-property-action))
27586 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27587 ((org-on-heading-p) (call-interactively 'org-set-tags))
27588 ((org-at-table.el-p)
27589 (require 'table)
27590 (beginning-of-line 1)
27591 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27592 (call-interactively 'table-recognize-table))
27593 ((org-at-table-p)
27594 (org-table-maybe-eval-formula)
27595 (if arg
27596 (call-interactively 'org-table-recalculate)
27597 (org-table-maybe-recalculate-line))
27598 (call-interactively 'org-table-align))
27599 ((org-at-item-checkbox-p)
27600 (call-interactively 'org-toggle-checkbox))
27601 ((org-at-item-p)
27602 (call-interactively 'org-maybe-renumber-ordered-list))
27604 ;; Dynamic block
27605 (beginning-of-line 1)
27606 (org-update-dblock))
27608 (cond
27609 ((equal (match-string 1) "TBLFM")
27610 ;; Recalculate the table before this line
27611 (save-excursion
27612 (beginning-of-line 1)
27614 (if (org-at-table-p)
27615 (org-call-with-arg 'org-table-recalculate t))))
27616 (t
27617 (call-interactively 'org-mode-restart))))
27618 (t (error "C-c C-c can do nothing useful at this location.")))))
27620 (defun org-mode-restart ()
27621 "Restart Org-mode, to scan again for special lines.
27622 Also updates the keyword regular expressions."
27623 (interactive)
27624 (let ((org-inhibit-startup t)) (org-mode))
27625 (message "Org-mode restarted to refresh keyword and special line setup"))
27627 (defun org-kill-note-or-show-branches ()
27628 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27629 (interactive)
27630 (if (not org-finish-function)
27631 (call-interactively 'show-branches)
27632 (let ((org-note-abort t))
27633 (funcall org-finish-function))))
27635 (defun org-return (&optional indent)
27636 "Goto next table row or insert a newline.
27637 Calls `org-table-next-row' or `newline', depending on context.
27638 See the individual commands for more information."
27639 (interactive)
27640 (cond
27641 ((bobp) (if indent (newline-and-indent) (newline)))
27642 ((and (org-at-heading-p)
27643 (looking-at
27645 (org-show-entry)
27646 (end-of-line 1)
27647 (newline))
27648 ((org-at-table-p)
27649 (org-table-justify-field-maybe)
27650 (call-interactively 'org-table-next-row))
27651 (t (if indent (newline-and-indent) (newline)))))
27653 (defun org-return-indent ()
27654 "Goto next table row or insert a newline and indent.
27655 Calls `org-table-next-row' or `newline-and-indent', depending on
27656 context. See the individual commands for more information."
27657 (interactive)
27658 (org-return t))
27660 (defun org-ctrl-c-star ()
27661 "Compute table, or change heading status of lines.
27662 Calls `org-table-recalculate' or `org-toggle-region-headlines',
27663 depending on context. This will also turn a plain list item or a normal
27664 line into a subheading."
27665 (interactive)
27666 (cond
27667 ((org-at-table-p)
27668 (call-interactively 'org-table-recalculate))
27669 ((org-region-active-p)
27670 ;; Convert all lines in region to list items
27671 (call-interactively 'org-toggle-region-headings))
27672 ((org-on-heading-p)
27673 (org-toggle-region-headings (point-at-bol)
27674 (min (1+ (point-at-eol)) (point-max))))
27675 ((org-at-item-p)
27676 ;; Convert to heading
27677 ;; FIXME: not yet implemented
27678 )
27679 (t (org-toggle-region-headings (point-at-bol)
27680 (min (1+ (point-at-eol)) (point-max))))))
27682 (defun org-ctrl-c-minus ()
27683 "Insert separator line in table or modify bullet status of line.
27684 Also turns a plain line or a region of lines into list items.
27685 Calls `org-table-insert-hline', `org-toggle-region-items', or
27686 `org-cycle-list-bullet', depending on context."
27687 (interactive)
27688 (cond
27689 ((org-at-table-p)
27690 (call-interactively 'org-table-insert-hline))
27691 ((org-on-heading-p)
27692 ;; Convert to item
27693 (save-excursion
27694 (beginning-of-line 1)
27696 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27697 ((org-region-active-p)
27698 ;; Convert all lines in region to list items
27699 (call-interactively 'org-toggle-region-items))
27700 ((org-in-item-p)
27701 (call-interactively 'org-cycle-list-bullet))
27702 (t (org-toggle-region-items (point-at-bol)
27703 (min (1+ (point-at-eol)) (point-max))))))
27705 (defun org-toggle-region-items (beg end)
27706 "Convert all lines in region to list items.
27707 If the first line is already an item, convert all list items in the region
27708 to normal lines."
27709 (interactive "r")
27710 (let (l2 l)
27711 (save-excursion
27712 (goto-char end)
27713 (setq l2 (org-current-line))
27714 (goto-char beg)
27715 (beginning-of-line 1)
27716 (setq l (1- (org-current-line)))
27717 (if (org-at-item-p)
27718 ;; We already have items, de-itemize
27719 (while (< (setq l (1+ l)) l2)
27720 (when (org-at-item-p)
27721 (goto-char (match-beginning 2))
27722 (delete-region (match-beginning 2) (match-end 2))
27724 (beginning-of-line 2))
27725 (while (< (setq l (1+ l)) l2)
27726 (unless (org-at-item-p)
27729 (beginning-of-line 2))))))
27731 (defun org-toggle-region-headings (beg end)
27732 "Convert all lines in region to list items.
27733 If the first line is already an item, convert all list items in the region
27734 to normal lines."
27735 (interactive "r")
27736 (let (l2 l)
27737 (save-excursion
27738 (goto-char end)
27739 (setq l2 (org-current-line))
27740 (goto-char beg)
27741 (beginning-of-line 1)
27742 (setq l (1- (org-current-line)))
27743 (if (org-on-heading-p)
27744 ;; We already have headlines, de-star them
27745 (while (< (setq l (1+ l)) l2)
27746 (when (org-on-heading-p t)
27747 (and (looking-at outline-regexp) (replace-match "")))
27748 (beginning-of-line 2))
27749 (let* ((stars (save-excursion
27750 (re-search-backward org-complex-heading-regexp nil t)
27751 (or (match-string 1) "*")))
27752 (add-stars (if org-odd-levels-only "**" "*"))
27754 (while (< (setq l (1+ l)) l2)
27755 (unless (org-on-heading-p)
27757 (replace-match rpl)))
27758 (beginning-of-line 2)))))))
27760 (defun org-meta-return (&optional arg)
27761 "Insert a new heading or wrap a region in a table.
27762 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27763 See the individual commands for more information."
27764 (interactive "P")
27765 (cond
27766 ((org-at-table-p)
27767 (call-interactively 'org-table-wrap-region))
27768 (t (call-interactively 'org-insert-heading))))
27770 ;;; Menu entries
27772 ;; Define the Org-mode menus
27773 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27774 '("Tbl"
27775 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27776 ["Next Field" org-cycle (org-at-table-p)]
27777 ["Previous Field" org-shifttab (org-at-table-p)]
27778 ["Next Row" org-return (org-at-table-p)]
27779 "--"
27780 ["Blank Field" org-table-blank-field (org-at-table-p)]
27781 ["Edit Field" org-table-edit-field (org-at-table-p)]
27782 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27783 "--"
27784 ("Column"
27785 ["Move Column Left" org-metaleft (org-at-table-p)]
27786 ["Move Column Right" org-metaright (org-at-table-p)]
27787 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27788 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27789 ("Row"
27790 ["Move Row Up" org-metaup (org-at-table-p)]
27791 ["Move Row Down" org-metadown (org-at-table-p)]
27792 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27793 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27794 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27795 "--"
27796 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27797 ("Rectangle"
27798 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27799 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27800 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27801 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27802 "--"
27803 ("Calculate"
27804 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27805 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27806 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27807 "--"
27808 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27809 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27810 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27811 "--"
27812 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27813 "--"
27814 ["Sum Column/Rectangle" org-table-sum
27815 (or (org-at-table-p) (org-region-active-p))]
27816 ["Which Column?" org-table-current-column (org-at-table-p)])
27817 ["Debug Formulas"
27818 org-table-toggle-formula-debugger
27819 :style toggle :selected org-table-formula-debug]
27820 ["Show Col/Row Numbers"
27821 org-table-toggle-coordinate-overlays
27822 :style toggle :selected org-table-overlay-coordinates]
27823 "--"
27824 ["Create" org-table-create (and (not (org-at-table-p))
27825 org-enable-table-editor)]
27826 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27827 ["Import from File" org-table-import (not (org-at-table-p))]
27828 ["Export to File" org-table-export (org-at-table-p)]
27829 "--"
27830 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27832 (easy-menu-define org-org-menu org-mode-map "Org menu"
27833 '("Org"
27834 ("Show/Hide"
27835 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27836 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27837 ["Sparse Tree" org-occur t]
27838 ["Reveal Context" org-reveal t]
27839 ["Show All" show-all t]
27840 "--"
27841 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27842 "--"
27843 ["New Heading" org-insert-heading t]
27844 ("Navigate Headings"
27845 ["Up" outline-up-heading t]
27846 ["Next" outline-next-visible-heading t]
27847 ["Previous" outline-previous-visible-heading t]
27848 ["Next Same Level" outline-forward-same-level t]
27849 ["Previous Same Level" outline-backward-same-level t]
27850 "--"
27851 ["Jump" org-goto t])
27852 ("Edit Structure"
27853 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27854 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27855 "--"
27856 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27857 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27858 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27859 "--"
27860 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27861 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27862 ["Demote Heading" org-metaright (not (org-at-table-p))]
27863 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27864 "--"
27865 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27866 "--"
27867 ["Convert to odd levels" org-convert-to-odd-levels t]
27868 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27869 ("Editing"
27870 ["Emphasis..." org-emphasize t])
27871 ("Archive"
27872 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27873 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27874 ; :active t :keys "C-u C-c C-x C-a"]
27875 ["Sparse trees open ARCHIVE trees"
27876 (setq org-sparse-tree-open-archived-trees
27877 (not org-sparse-tree-open-archived-trees))
27878 :style toggle :selected org-sparse-tree-open-archived-trees]
27879 ["Cycling opens ARCHIVE trees"
27880 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27881 :style toggle :selected org-cycle-open-archived-trees]
27882 ["Agenda includes ARCHIVE trees"
27883 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27884 :style toggle :selected (not org-agenda-skip-archived-trees)]
27885 "--"
27886 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27887 ; ["Check and Move Children" (org-archive-subtree '(4))
27888 ; :active t :keys "C-u C-c C-x C-s"]
27889 )
27890 "--"
27891 ("TODO Lists"
27892 ["TODO/DONE/-" org-todo t]
27893 ("Select keyword"
27894 ["Next keyword" org-shiftright (org-on-heading-p)]
27895 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27896 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27897 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27898 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27899 ["Show TODO Tree" org-show-todo-tree t]
27900 ["Global TODO list" org-todo-list t]
27901 "--"
27902 ["Set Priority" org-priority t]
27903 ["Priority Up" org-shiftup t]
27904 ["Priority Down" org-shiftdown t])
27905 ("TAGS and Properties"
27906 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27907 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27908 "--"
27909 ["Set property" 'org-set-property t]
27910 ["Column view of properties" org-columns t]
27911 ["Insert Column View DBlock" org-insert-columns-dblock t])
27912 ("Dates and Scheduling"
27913 ["Timestamp" org-time-stamp t]
27914 ["Timestamp (inactive)" org-time-stamp-inactive t]
27915 ("Change Date"
27916 ["1 Day Later" org-shiftright t]
27917 ["1 Day Earlier" org-shiftleft t]
27918 ["1 ... Later" org-shiftup t]
27919 ["1 ... Earlier" org-shiftdown t])
27920 ["Compute Time Range" org-evaluate-time-range t]
27921 ["Schedule Item" org-schedule t]
27922 ["Deadline" org-deadline t]
27923 "--"
27924 ["Custom time format" org-toggle-time-stamp-overlays
27925 :style radio :selected org-display-custom-times]
27926 "--"
27927 ["Goto Calendar" org-goto-calendar t]
27928 ["Date from Calendar" org-date-from-calendar t])
27929 ("Logging work"
27930 ["Clock in" org-clock-in t]
27931 ["Clock out" org-clock-out t]
27932 ["Clock cancel" org-clock-cancel t]
27933 ["Goto running clock" org-clock-goto t]
27934 ["Display times" org-clock-display t]
27935 ["Create clock table" org-clock-report t]
27936 "--"
27937 ["Record DONE time"
27938 (progn (setq org-log-done (not org-log-done))
27939 (message "Switching to %s will %s record a timestamp"
27940 (car org-done-keywords)
27941 (if org-log-done "automatically" "not")))
27942 :style toggle :selected org-log-done])
27943 "--"
27944 ["Agenda Command..." org-agenda t]
27945 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27946 ("File List for Agenda")
27947 ("Special views current file"
27948 ["TODO Tree" org-show-todo-tree t]
27949 ["Check Deadlines" org-check-deadlines t]
27950 ["Timeline" org-timeline t]
27951 ["Tags Tree" org-tags-sparse-tree t])
27952 "--"
27953 ("Hyperlinks"
27954 ["Store Link (Global)" org-store-link t]
27955 ["Insert Link" org-insert-link t]
27956 ["Follow Link" org-open-at-point t]
27957 "--"
27958 ["Next link" org-next-link t]
27959 ["Previous link" org-previous-link t]
27960 "--"
27961 ["Descriptive Links"
27962 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27963 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27964 ["Literal Links"
27965 (progn
27966 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27967 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27968 "--"
27969 ["Export/Publish..." org-export t]
27970 ("LaTeX"
27971 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27972 :selected org-cdlatex-mode]
27973 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27974 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27975 ["Modify math symbol" org-cdlatex-math-modify
27976 (org-inside-LaTeX-fragment-p)]
27977 ["Export LaTeX fragments as images"
27978 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27979 :style toggle :selected org-export-with-LaTeX-fragments])
27980 "--"
27981 ("Documentation"
27982 ["Show Version" org-version t]
27983 ["Info Documentation" org-info t])
27984 ("Customize"
27985 ["Browse Org Group" org-customize t]
27986 "--"
27987 ["Expand This Menu" org-create-customize-menu
27988 (fboundp 'customize-menu-create)])
27989 "--"
27990 ["Refresh setup" org-mode-restart t]
27991 ))
27993 (defun org-info (&optional node)
27994 "Read documentation for Org-mode in the info system.
27995 With optional NODE, go directly to that node."
27996 (interactive)
27997 (info (format "(org)%s" (or node ""))))
27999 (defun org-install-agenda-files-menu ()
28000 (let ((bl (buffer-list)))
28001 (save-excursion
28002 (while bl
28003 (set-buffer (pop bl))
28004 (if (org-mode-p) (setq bl nil)))
28005 (when (org-mode-p)
28006 (easy-menu-change
28007 '("Org") "File List for Agenda"
28008 (append
28009 (list
28010 ["Edit File List" (org-edit-agenda-file-list) t]
28011 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
28012 ["Remove Current File from List" org-remove-file t]
28013 ["Cycle through agenda files" org-cycle-agenda-files t]
28014 ["Occur in all agenda files" org-occur-in-agenda-files t]
28015 "--")
28016 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
28018 ;;;; Documentation
28020 (defun org-customize ()
28021 "Call the customize function with org as argument."
28022 (interactive)
28023 (customize-browse 'org))
28025 (defun org-create-customize-menu ()
28026 "Create a full customization menu for Org-mode, insert it into the menu."
28027 (interactive)
28028 (if (fboundp 'customize-menu-create)
28029 (progn
28030 (easy-menu-change
28031 '("Org") "Customize"
28032 `(["Browse Org group" org-customize t]
28033 "--"
28034 ,(customize-menu-create 'org)
28035 ["Set" Custom-set t]
28036 ["Save" Custom-save t]
28037 ["Reset to Current" Custom-reset-current t]
28038 ["Reset to Saved" Custom-reset-saved t]
28039 ["Reset to Standard Settings" Custom-reset-standard t]))
28041 (error "Cannot expand menu (outdated version of cus-edit.el)")))
28043 ;;;; Miscellaneous stuff
28046 ;;; Generally useful functions
28048 (defun org-context ()
28049 "Return a list of contexts of the current cursor position.
28050 If several contexts apply, all are returned.
28051 Each context entry is a list with a symbol naming the context, and
28052 two positions indicating start and end of the context. Possible
28053 contexts are:
28055 :headline anywhere in a headline
28056 :headline-stars on the leading stars in a headline
28057 :todo-keyword on a TODO keyword (including DONE) in a headline
28058 :tags on the TAGS in a headline
28059 :priority on the priority cookie in a headline
28060 :item on the first line of a plain list item
28061 :item-bullet on the bullet/number of a plain list item
28062 :checkbox on the checkbox in a plain list item
28063 :table in an org-mode table
28064 :table-special on a special filed in a table
28065 :table-table in a table.el table
28066 :link on a hyperlink
28067 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
28068 :target on a <<target>>
28069 :radio-target on a <<<radio-target>>>
28070 :latex-fragment on a LaTeX fragment
28071 :latex-preview on a LaTeX fragment with overlayed preview image
28073 This function expects the position to be visible because it uses font-lock
28074 faces as a help to recognize the following contexts: :table-special, :link,
28075 and :keyword."
28076 (let* ((f (get-text-property (point) 'face))
28077 (faces (if (listp f) f (list f)))
28078 (p (point)) clist o)
28079 ;; First the large context
28080 (cond
28081 ((org-on-heading-p t)
28082 (push (list :headline (point-at-bol) (point-at-eol)) clist)
28083 (when (progn
28084 (beginning-of-line 1)
28085 (looking-at org-todo-line-tags-regexp))
28086 (push (org-point-in-group p 1 :headline-stars) clist)
28087 (push (org-point-in-group p 2 :todo-keyword) clist)
28088 (push (org-point-in-group p 4 :tags) clist))
28089 (goto-char p)
28092 (push (org-point-in-group p 0 :priority) clist)))
28094 ((org-at-item-p)
28095 (push (org-point-in-group p 2 :item-bullet) clist)
28096 (push (list :item (point-at-bol)
28097 (save-excursion (org-end-of-item) (point)))
28098 clist)
28099 (and (org-at-item-checkbox-p)
28100 (push (org-point-in-group p 0 :checkbox) clist)))
28102 ((org-at-table-p)
28103 (push (list :table (org-table-begin) (org-table-end)) clist)
28104 (if (memq 'org-formula faces)
28105 (push (list :table-special
28106 (previous-single-property-change p 'face)
28107 (next-single-property-change p 'face)) clist)))
28108 ((org-at-table-p 'any)
28109 (push (list :table-table) clist)))
28110 (goto-char p)
28112 ;; Now the small context
28113 (cond
28114 ((org-at-timestamp-p)
28115 (push (org-point-in-group p 0 :timestamp) clist))
28116 ((memq 'org-link faces)
28117 (push (list :link
28118 (previous-single-property-change p 'face)
28119 (next-single-property-change p 'face)) clist))
28120 ((memq 'org-special-keyword faces)
28121 (push (list :keyword
28122 (previous-single-property-change p 'face)
28123 (next-single-property-change p 'face)) clist))
28124 ((org-on-target-p)
28125 (push (org-point-in-group p 0 :target) clist)
28126 (goto-char (1- (match-beginning 0)))
28127 (if (looking-at org-radio-target-regexp)
28128 (push (org-point-in-group p 0 :radio-target) clist))
28129 (goto-char p))
28130 ((setq o (car (delq nil
28131 (mapcar
28132 (lambda (x)
28133 (if (memq x org-latex-fragment-image-overlays) x))
28134 (org-overlays-at (point))))))
28135 (push (list :latex-fragment
28136 (org-overlay-start o) (org-overlay-end o)) clist)
28137 (push (list :latex-preview
28138 (org-overlay-start o) (org-overlay-end o)) clist))
28139 ((org-inside-LaTeX-fragment-p)
28140 ;; FIXME: positions wrong.
28141 (push (list :latex-fragment (point) (point)) clist)))
28143 (setq clist (nreverse (delq nil clist)))
28144 clist))
28146 ;; FIXME: Compare with at-regexp-p Do we need both?
28147 (defun org-in-regexp (re &optional nlines visually)
28148 "Check if point is inside a match of regexp.
28149 Normally only the current line is checked, but you can include NLINES extra
28150 lines both before and after point into the search.
28151 If VISUALLY is set, require that the cursor is not after the match but
28152 really on, so that the block visually is on the match."
28153 (catch 'exit
28154 (let ((pos (point))
28155 (eol (point-at-eol (+ 1 (or nlines 0))))
28156 (inc (if visually 1 0)))
28157 (save-excursion
28158 (beginning-of-line (- 1 (or nlines 0)))
28159 (while (re-search-forward re eol t)
28160 (if (and (<= (match-beginning 0) pos)
28161 (>= (+ inc (match-end 0)) pos))
28162 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
28164 (defun org-at-regexp-p (regexp)
28165 "Is point inside a match of REGEXP in the current line?"
28166 (catch 'exit
28167 (save-excursion
28168 (let ((pos (point)) (end (point-at-eol)))
28169 (beginning-of-line 1)
28170 (while (re-search-forward regexp end t)
28171 (if (and (<= (match-beginning 0) pos)
28172 (>= (match-end 0) pos))
28173 (throw 'exit t)))
28174 nil))))
28176 (defun org-occur-in-agenda-files (regexp &optional nlines)
28177 "Call `multi-occur' with buffers for all agenda files."
28179 (let* ((files (org-agenda-files))
28180 (tnames (mapcar 'file-truename files))
28181 (extra org-agenda-text-search-extra-files)
28182 f)
28183 (while (setq f (pop extra))
28184 (unless (member (file-truename f) tnames)
28185 (add-to-list 'files f 'append)
28186 (add-to-list 'tnames (file-truename f) 'append)))
28187 (multi-occur
28188 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
28189 regexp)))
28191 (if (boundp 'occur-mode-find-occurrence-hook)
28192 ;; Emacs 23
28193 (add-hook 'occur-mode-find-occurrence-hook
28194 (lambda ()
28195 (when (org-mode-p)
28196 (org-reveal))))
28197 ;; Emacs 22
28198 (defadvice occur-mode-goto-occurrence
28199 (after org-occur-reveal activate)
28200 (and (org-mode-p) (org-reveal)))
28201 (defadvice occur-mode-goto-occurrence-other-window
28202 (after org-occur-reveal activate)
28203 (and (org-mode-p) (org-reveal)))
28204 (defadvice occur-mode-display-occurrence
28205 (after org-occur-reveal activate)
28206 (when (org-mode-p)
28207 (let ((pos (occur-mode-find-occurrence)))
28208 (with-current-buffer (marker-buffer pos)
28209 (save-excursion
28210 (goto-char pos)
28211 (org-reveal)))))))
28213 (defun org-uniquify (list)
28214 "Remove duplicate elements from LIST."
28215 (let (res)
28216 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
28217 res))
28219 (defun org-delete-all (elts list)
28220 "Remove all elements in ELTS from LIST."
28221 (while elts
28222 (setq list (delete (pop elts) list)))
28223 list)
28225 (defun org-back-over-empty-lines ()
28226 "Move backwards over witespace, to the beginning of the first empty line.
28227 Returns the number o empty lines passed."
28228 (let ((pos (point)))
28230 (beginning-of-line 2)
28231 (goto-char (min (point) pos))
28232 (count-lines (point) pos)))
28234 (defun org-skip-whitespace ()
28237 (defun org-point-in-group (point group &optional context)
28238 "Check if POINT is in match-group GROUP.
28239 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
28240 match. If the match group does ot exist or point is not inside it,
28241 return nil."
28242 (and (match-beginning group)
28243 (>= point (match-beginning group))
28244 (<= point (match-end group))
28245 (if context
28246 (list context (match-beginning group) (match-end group))
28247 t)))
28249 (defun org-switch-to-buffer-other-window (&rest args)
28250 "Switch to buffer in a second window on the current frame.
28251 In particular, do not allow pop-up frames."
28252 (let (pop-up-frames special-display-buffer-names special-display-regexps
28253 special-display-function)
28254 (apply 'switch-to-buffer-other-window args)))
28256 (defun org-combine-plists (&rest plists)
28257 "Create a single property list from all plists in PLISTS.
28258 The process starts by copying the first list, and then setting properties
28259 from the other lists. Settings in the last list are the most significant
28260 ones and overrule settings in the other lists."
28261 (let ((rtn (copy-sequence (pop plists)))
28262 p v ls)
28263 (while plists
28264 (setq ls (pop plists))
28265 (while ls
28266 (setq p (pop ls) v (pop ls))
28267 (setq rtn (plist-put rtn p v))))
28268 rtn))
28270 (defun org-move-line-down (arg)
28271 "Move the current line down. With prefix argument, move it past ARG lines."
28272 (interactive "p")
28273 (let ((col (current-column))
28274 beg end pos)
28275 (beginning-of-line 1) (setq beg (point))
28276 (beginning-of-line 2) (setq end (point))
28277 (beginning-of-line (+ 1 arg))
28278 (setq pos (move-marker (make-marker) (point)))
28279 (insert (delete-and-extract-region beg end))
28280 (goto-char pos)
28281 (move-to-column col)))
28283 (defun org-move-line-up (arg)
28284 "Move the current line up. With prefix argument, move it past ARG lines."
28285 (interactive "p")
28286 (let ((col (current-column))
28287 beg end pos)
28288 (beginning-of-line 1) (setq beg (point))
28289 (beginning-of-line 2) (setq end (point))
28290 (beginning-of-line (- arg))
28291 (setq pos (move-marker (make-marker) (point)))
28292 (insert (delete-and-extract-region beg end))
28293 (goto-char pos)
28294 (move-to-column col)))
28296 (defun org-replace-escapes (string table)
28297 "Replace %-escapes in STRING with values in TABLE.
28299 The sequences in STRING may contain normal field width and padding information,
28301 so values can contain further %-escapes if they are define later in TABLE."
28302 (let ((case-fold-search nil)
28303 e re rpl)
28304 (while (setq e (pop table))
28305 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
28306 (while (string-match re string)
28307 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
28308 (cdr e)))
28309 (setq string (replace-match rpl t t string))))
28310 string))
28313 (defun org-sublist (list start end)
28314 "Return a section of LIST, from START to END.
28315 Counting starts at 1."
28316 (let (rtn (c start))
28317 (setq list (nthcdr (1- start) list))
28318 (while (and list (<= c end))
28319 (push (pop list) rtn)
28320 (setq c (1+ c)))
28321 (nreverse rtn)))
28323 (defun org-find-base-buffer-visiting (file)
28324 "Like `find-buffer-visiting' but alway return the base buffer and
28325 not an indirect buffer"
28326 (let ((buf (find-buffer-visiting file)))
28327 (if buf
28328 (or (buffer-base-buffer buf) buf)
28329 nil)))
28331 (defun org-image-file-name-regexp ()
28332 "Return regexp matching the file names of images."
28333 (if (fboundp 'image-file-name-regexp)
28334 (image-file-name-regexp)
28335 (let ((image-file-name-extensions
28336 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
28337 "xbm" "xpm" "pbm" "pgm" "ppm")))
28339 (regexp-opt (nconc (mapcar 'upcase
28340 image-file-name-extensions)
28341 image-file-name-extensions)
28342 t)
28345 (defun org-file-image-p (file)
28346 "Return non-nil if FILE is an image."
28347 (save-match-data
28348 (string-match (org-image-file-name-regexp) file)))
28350 ;;; Paragraph filling stuff.
28351 ;; We want this to be just right, so use the full arsenal.
28353 (defun org-indent-line-function ()
28354 "Indent line like previous, but further if previous was headline or item."
28355 (interactive)
28356 (let* ((pos (point))
28357 (itemp (org-at-item-p))
28358 column bpos bcol tpos tcol bullet btype bullet-type)
28359 ;; Find the previous relevant line
28360 (beginning-of-line 1)
28361 (cond
28362 ((looking-at "#") (setq column 0))
28364 (t
28365 (beginning-of-line 0)
28367 (beginning-of-line 0))
28368 (cond
28370 (goto-char (match-end 0))
28371 (setq column (current-column)))
28372 ((org-in-item-p)
28373 (org-beginning-of-item)
28376 (setq bpos (match-beginning 1) tpos (match-end 0)
28377 bcol (progn (goto-char bpos) (current-column))
28378 tcol (progn (goto-char tpos) (current-column))
28379 bullet (match-string 1)
28380 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
28381 (if (not itemp)
28382 (setq column tcol)
28383 (goto-char pos)
28384 (beginning-of-line 1)
28386 (progn
28388 (setq bullet (match-string 1)
28389 btype (if (string-match "[0-9]" bullet) "n" bullet))
28390 (setq column (if (equal btype bullet-type) bcol tcol)))
28391 (setq column (org-get-indentation)))))
28392 (t (setq column (org-get-indentation))))))
28393 (goto-char pos)
28394 (if (<= (current-column) (current-indentation))
28395 (indent-line-to column)
28396 (save-excursion (indent-line-to column)))
28397 (setq column (current-column))
28398 (beginning-of-line 1)
28399 (if (looking-at
28402 (match-string 2) (match-string 3)))
28403 t nil))
28404 (move-to-column column)))
28406 (defun org-set-autofill-regexps ()
28407 (interactive)
28408 ;; In the paragraph separator we include headlines, because filling
28409 ;; text in a line directly attached to a headline would otherwise
28410 ;; fill the headline as well.
28413 ;; The paragraph starter includes hand-formatted lists.
28414 (org-set-local 'paragraph-start
28416 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
28417 ;; But only if the user has not turned off tables or fixed-width regions
28418 (org-set-local
28419 'auto-fill-inhibit-regexp
28422 (if (or org-enable-table-editor org-enable-fixed-width-editor)
28423 (concat
28425 (if org-enable-table-editor "|" "")
28426 (if org-enable-fixed-width-editor ":" "")
28427 "]"))))
28428 ;; We use our own fill-paragraph function, to make sure that tables
28429 ;; and fixed-width regions are not wrapped. That function will pass
28430 ;; through to `fill-paragraph' when appropriate.
28431 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
28432 ; Adaptive filling: To get full control, first make sure that
28433 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
28435 (org-set-local 'adaptive-fill-function
28436 'org-adaptive-fill-function)
28437 (org-set-local
28438 'align-mode-rules-list
28439 '((org-in-buffer-settings
28441 (modes . '(org-mode))))))
28443 (defun org-fill-paragraph (&optional justify)
28444 "Re-align a table, pass through to fill-paragraph if no table."
28445 (let ((table-p (org-at-table-p))
28446 (table.el-p (org-at-table.el-p)))
28447 (cond ((and (equal (char-after (point-at-bol)) ?*)
28448 (save-excursion (goto-char (point-at-bol))
28449 (looking-at outline-regexp)))
28450 t) ; skip headlines
28451 (table.el-p t) ; skip table.el tables
28452 (table-p (org-table-align) t) ; align org-mode tables
28453 (t nil)))) ; call paragraph-fill
28455 ;; For reference, this is the default value of adaptive-fill-regexp
28458 (defun org-adaptive-fill-function ()
28459 "Return a fill prefix for org-mode files.
28460 In particular, this makes sure hanging paragraphs for hand-formatted lists
28461 work correctly."
28463 (match-string 0))
28465 (save-excursion
28466 (goto-char (match-end 0))
28467 (make-string (current-column) ?\ )))
28468 (t nil)))
28470 ;;;; Functions extending outline functionality
28473 (defun org-beginning-of-line (&optional arg)
28474 "Go to the beginning of the current line. If that is invisible, continue
28475 to a visible line beginning. This makes the function of C-a more intuitive.
28476 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28477 first attempt, and only move to after the tags when the cursor is already
28478 beyond the end of the headline."
28479 (interactive "P")
28480 (let ((pos (point)))
28481 (beginning-of-line 1)
28482 (if (bobp)
28483 nil
28484 (backward-char 1)
28485 (if (org-invisible-p)
28486 (while (and (not (bobp)) (org-invisible-p))
28487 (backward-char 1)
28488 (beginning-of-line 1))
28489 (forward-char 1)))
28490 (when org-special-ctrl-a/e
28491 (cond
28492 ((and (looking-at org-todo-line-regexp)
28493 (= (char-after (match-end 1)) ?\ ))
28494 (goto-char
28495 (if (eq org-special-ctrl-a/e t)
28496 (cond ((> pos (match-beginning 3)) (match-beginning 3))
28497 ((= pos (point)) (match-beginning 3))
28498 (t (point)))
28499 (cond ((> pos (point)) (point))
28500 ((not (eq last-command this-command)) (point))
28501 (t (match-beginning 3))))))
28502 ((org-at-item-p)
28503 (goto-char
28504 (if (eq org-special-ctrl-a/e t)
28505 (cond ((> pos (match-end 4)) (match-end 4))
28506 ((= pos (point)) (match-end 4))
28507 (t (point)))
28508 (cond ((> pos (point)) (point))
28509 ((not (eq last-command this-command)) (point))
28510 (t (match-end 4))))))))))
28512 (defun org-end-of-line (&optional arg)
28513 "Go to the end of the line.
28514 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28515 first attempt, and only move to after the tags when the cursor is already
28516 beyond the end of the headline."
28517 (interactive "P")
28518 (if (or (not org-special-ctrl-a/e)
28519 (not (org-on-heading-p)))
28520 (end-of-line arg)
28521 (let ((pos (point)))
28522 (beginning-of-line 1)
28524 (if (eq org-special-ctrl-a/e t)
28525 (if (or (< pos (match-beginning 1))
28526 (= pos (match-end 0)))
28527 (goto-char (match-beginning 1))
28528 (goto-char (match-end 0)))
28529 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
28530 (goto-char (match-end 0))
28531 (goto-char (match-beginning 1))))
28532 (end-of-line arg)))))
28534 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
28535 (define-key org-mode-map "\C-e" 'org-end-of-line)
28537 (defun org-kill-line (&optional arg)
28538 "Kill line, to tags or end of line."
28539 (interactive "P")
28540 (cond
28541 ((or (not org-special-ctrl-k)
28542 (bolp)
28543 (not (org-on-heading-p)))
28544 (call-interactively 'kill-line))
28546 (kill-region (point) (match-beginning 1))
28547 (org-set-tags nil t))
28548 (t (kill-region (point) (point-at-eol)))))
28550 (define-key org-mode-map "\C-k" 'org-kill-line)
28552 (defun org-invisible-p ()
28553 "Check if point is at a character currently not visible."
28554 ;; Early versions of noutline don't have `outline-invisible-p'.
28555 (if (fboundp 'outline-invisible-p)
28556 (outline-invisible-p)
28557 (get-char-property (point) 'invisible)))
28559 (defun org-invisible-p2 ()
28560 "Check if point is at a character currently not visible."
28561 (save-excursion
28562 (if (and (eolp) (not (bobp))) (backward-char 1))
28563 ;; Early versions of noutline don't have `outline-invisible-p'.
28564 (if (fboundp 'outline-invisible-p)
28565 (outline-invisible-p)
28566 (get-char-property (point) 'invisible))))
28568 (defalias 'org-back-to-heading 'outline-back-to-heading)
28569 (defalias 'org-on-heading-p 'outline-on-heading-p)
28570 (defalias 'org-at-heading-p 'outline-on-heading-p)
28571 (defun org-at-heading-or-item-p ()
28572 (or (org-on-heading-p) (org-at-item-p)))
28574 (defun org-on-target-p ()
28575 (or (org-in-regexp org-radio-target-regexp)
28576 (org-in-regexp org-target-regexp)))
28578 (defun org-up-heading-all (arg)
28579 "Move to the heading line of which the present line is a subheading.
28580 This function considers both visible and invisible heading lines.
28581 With argument, move up ARG levels."
28582 (if (fboundp 'outline-up-heading-all)
28583 (outline-up-heading-all arg) ; emacs 21 version of outline.el
28584 (outline-up-heading arg t))) ; emacs 22 version of outline.el
28586 (defun org-up-heading-safe ()
28587 "Move to the heading line of which the present line is a subheading.
28588 This version will not throw an error. It will return the level of the
28589 headline found, or nil if no higher level is found."
28590 (let ((pos (point)) start-level level
28591 (re (concat "^" outline-regexp)))
28592 (catch 'exit
28593 (outline-back-to-heading t)
28594 (setq start-level (funcall outline-level))
28595 (if (equal start-level 1) (throw 'exit nil))
28596 (while (re-search-backward re nil t)
28597 (setq level (funcall outline-level))
28598 (if (< level start-level) (throw 'exit level)))
28599 nil)))
28601 (defun org-first-sibling-p ()
28602 "Is this heading the first child of its parents?"
28603 (interactive)
28604 (let ((re (concat "^" outline-regexp))
28605 level l)
28606 (unless (org-at-heading-p t)
28607 (error "Not at a heading"))
28608 (setq level (funcall outline-level))
28609 (save-excursion
28610 (if (not (re-search-backward re nil t))
28611 t
28612 (setq l (funcall outline-level))
28613 (< l level)))))
28615 (defun org-goto-sibling (&optional previous)
28616 "Goto the next sibling, even if it is invisible.
28617 When PREVIOUS is set, go to the previous sibling instead. Returns t
28618 when a sibling was found. When none is found, return nil and don't
28619 move point."
28620 (let ((fun (if previous 're-search-backward 're-search-forward))
28621 (pos (point))
28622 (re (concat "^" outline-regexp))
28623 level l)
28624 (when (condition-case nil (org-back-to-heading t) (error nil))
28625 (setq level (funcall outline-level))
28626 (catch 'exit
28627 (or previous (forward-char 1))
28628 (while (funcall fun re nil t)
28629 (setq l (funcall outline-level))
28630 (when (< l level) (goto-char pos) (throw 'exit nil))
28631 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28632 (goto-char pos)
28633 nil))))
28635 (defun org-show-siblings ()
28636 "Show all siblings of the current headline."
28637 (save-excursion
28638 (while (org-goto-sibling) (org-flag-heading nil)))
28639 (save-excursion
28640 (while (org-goto-sibling 'previous)
28641 (org-flag-heading nil))))
28643 (defun org-show-hidden-entry ()
28644 "Show an entry where even the heading is hidden."
28645 (save-excursion
28646 (org-show-entry)))
28648 (defun org-flag-heading (flag &optional entry)
28649 "Flag the current heading. FLAG non-nil means make invisible.
28650 When ENTRY is non-nil, show the entire entry."
28651 (save-excursion
28652 (org-back-to-heading t)
28653 ;; Check if we should show the entire entry
28654 (if entry
28655 (progn
28656 (org-show-entry)
28657 (save-excursion
28658 (and (outline-next-heading)
28659 (org-flag-heading nil))))
28660 (outline-flag-region (max (point-min) (1- (point)))
28661 (save-excursion (outline-end-of-heading) (point))
28662 flag))))
28664 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28665 ;; This is an exact copy of the original function, but it uses
28666 ;; `org-back-to-heading', to make it work also in invisible
28667 ;; trees. And is uses an invisible-OK argument.
28668 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28669 (org-back-to-heading invisible-OK)
28670 (let ((first t)
28671 (level (funcall outline-level)))
28672 (while (and (not (eobp))
28673 (or first (> (funcall outline-level) level)))
28674 (setq first nil)
28675 (outline-next-heading))
28676 (unless to-heading
28678 (progn
28679 ;; Go to end of line before heading
28680 (forward-char -1)
28682 ;; leave blank line before heading
28683 (forward-char -1))))))
28684 (point))
28686 (defun org-show-subtree ()
28687 "Show everything after this heading at deeper levels."
28688 (outline-flag-region
28689 (point)
28690 (save-excursion
28691 (outline-end-of-subtree) (outline-next-heading) (point))
28692 nil))
28694 (defun org-show-entry ()
28695 "Show the body directly following this heading.
28696 Show the heading too, if it is currently invisible."
28697 (interactive)
28698 (save-excursion
28699 (condition-case nil
28700 (progn
28701 (org-back-to-heading t)
28702 (outline-flag-region
28703 (max (point-min) (1- (point)))
28704 (save-excursion
28705 (re-search-forward
28707 (or (match-beginning 1) (point-max)))
28708 nil))
28709 (error nil))))
28711 (defun org-make-options-regexp (kwds)
28712 "Make a regular expression for keyword lines."
28713 (concat
28714 "^"
28720 ;; Make isearch reveal the necessary context
28721 (defun org-isearch-end ()
28722 "Reveal context after isearch exits."
28723 (when isearch-success ; only if search was successful
28724 (if (featurep 'xemacs)
28725 ;; Under XEmacs, the hook is run in the correct place,
28726 ;; we directly show the context.
28727 (org-show-context 'isearch)
28728 ;; In Emacs the hook runs *before* restoring the overlays.
28729 ;; So we have to use a one-time post-command-hook to do this.
28730 ;; (Emacs 22 has a special variable, see function `org-mode')
28731 (unless (and (boundp 'isearch-mode-end-hook-quit)
28732 isearch-mode-end-hook-quit)
28733 ;; Only when the isearch was not quitted.
28734 (org-add-hook 'post-command-hook 'org-isearch-post-command
28735 'append 'local)))))
28737 (defun org-isearch-post-command ()
28738 "Remove self from hook, and show context."
28739 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28740 (org-show-context 'isearch))
28743 ;;;; Integration with and fixes for other packages
28745 ;;; Imenu support
28747 (defvar org-imenu-markers nil
28748 "All markers currently used by Imenu.")
28749 (make-variable-buffer-local 'org-imenu-markers)
28751 (defun org-imenu-new-marker (&optional pos)
28752 "Return a new marker for use by Imenu, and remember the marker."
28753 (let ((m (make-marker)))
28754 (move-marker m (or pos (point)))
28755 (push m org-imenu-markers)
28756 m))
28758 (defun org-imenu-get-tree ()
28759 "Produce the index for Imenu."
28760 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28761 (setq org-imenu-markers nil)
28762 (let* ((n org-imenu-depth)
28763 (re (concat "^" outline-regexp))
28764 (subs (make-vector (1+ n) nil))
28765 (last-level 0)
28766 m tree level head)
28767 (save-excursion
28768 (save-restriction
28769 (widen)
28770 (goto-char (point-max))
28771 (while (re-search-backward re nil t)
28772 (setq level (org-reduced-level (funcall outline-level)))
28773 (when (<= level n)
28774 (looking-at org-complex-heading-regexp)
28775 (setq head (org-match-string-no-properties 4)
28776 m (org-imenu-new-marker))
28777 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28778 (if (>= level last-level)
28779 (push (cons head m) (aref subs level))
28780 (push (cons head (aref subs (1+ level))) (aref subs level))
28781 (loop for i from (1+ level) to n do (aset subs i nil)))
28782 (setq last-level level)))))
28783 (aref subs 1)))
28785 (eval-after-load "imenu"
28786 '(progn
28787 (add-hook 'imenu-after-jump-hook
28788 (lambda () (org-show-context 'org-goto)))))
28790 ;; Speedbar support
28792 (defun org-speedbar-set-agenda-restriction ()
28793 "Restrict future agenda commands to the location at point in speedbar.
28795 (interactive)
28796 (let (p m tp np dir txt w)
28797 (cond
28798 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28799 'org-imenu t))
28800 (setq m (get-text-property p 'org-imenu-marker))
28801 (save-excursion
28802 (save-restriction
28803 (set-buffer (marker-buffer m))
28804 (goto-char m)
28805 (org-agenda-set-restriction-lock 'subtree))))
28806 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28807 'speedbar-function 'speedbar-find-file))
28808 (setq tp (previous-single-property-change
28809 (1+ p) 'speedbar-function)
28810 np (next-single-property-change
28811 tp 'speedbar-function)
28812 dir (speedbar-line-directory)
28813 txt (buffer-substring-no-properties (or tp (point-min))
28814 (or np (point-max))))
28815 (save-excursion
28816 (save-restriction
28817 (set-buffer (find-file-noselect
28818 (let ((default-directory dir))
28819 (expand-file-name txt))))
28820 (unless (org-mode-p)
28821 (error "Cannot restrict to non-Org-mode file"))
28822 (org-agenda-set-restriction-lock 'file))))
28823 (t (error "Don't know how to restrict Org-mode's agenda")))
28824 (org-move-overlay org-speedbar-restriction-lock-overlay
28825 (point-at-bol) (point-at-eol))
28826 (setq current-prefix-arg nil)
28827 (org-agenda-maybe-redo)))
28829 (eval-after-load "speedbar"
28830 '(progn
28831 (speedbar-add-supported-extension ".org")
28832 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28833 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28834 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28835 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28836 (add-hook 'speedbar-visiting-tag-hook
28837 (lambda () (org-show-context 'org-goto)))))
28840 ;;; Fixes and Hacks
28842 ;; Make flyspell not check words in links, to not mess up our keymap
28843 (defun org-mode-flyspell-verify ()
28844 "Don't let flyspell put overlays at active buttons."
28845 (not (get-text-property (point) 'keymap)))
28847 ;; Make `bookmark-jump' show the jump location if it was hidden.
28848 (eval-after-load "bookmark"
28849 '(if (boundp 'bookmark-after-jump-hook)
28850 ;; We can use the hook
28851 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28852 ;; Hook not available, use advice
28853 (defadvice bookmark-jump (after org-make-visible activate)
28854 "Make the position visible."
28855 (org-bookmark-jump-unhide))))
28857 (defun org-bookmark-jump-unhide ()
28858 "Unhide the current position, to show the bookmark location."
28859 (and (org-mode-p)
28860 (or (org-invisible-p)
28861 (save-excursion (goto-char (max (point-min) (1- (point))))
28862 (org-invisible-p)))
28863 (org-show-context 'bookmark-jump)))
28865 ;; Make session.el ignore our circular variable
28866 (eval-after-load "session"
28867 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28869 ;;;; Experimental code
28871 (defun org-closed-in-range ()
28872 "Sparse tree of items closed in a certain time range.
28873 Still experimental, may disappear in the future."
28874 (interactive)
28875 ;; Get the time interval from the user.
28876 (let* ((time1 (time-to-seconds
28877 (org-read-date nil 'to-time nil "Starting date: ")))
28878 (time2 (time-to-seconds
28879 (org-read-date nil 'to-time nil "End date:")))
28880 ;; callback function
28881 (callback (lambda ()
28882 (let ((time
28883 (time-to-seconds
28884 (apply 'encode-time
28885 (org-parse-time-string
28886 (match-string 1))))))
28887 ;; check if time in interval
28888 (and (>= time time1) (<= time time2))))))
28889 ;; make tree, check each match with the callback
28892 ;;;; Finish up
28894 (provide 'org)
28896 (run-hooks 'org-load-hook)
28898 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28899 ;;; org.el ends here