| blob | 3baab04d02aa2bb9b8bee14de9069149d2a5c494 |
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
358 ; (concat "\\(?:\\<\\(?:" org-scheduled-string "\\|" org-deadline-string "\\)"
359 ; " +<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\)\\(\\+[0-9]+[dwmy]\\)")
361 "Regular expression for specifying repeated events.
365 "Options concerning the general structure of Org-mode files."
370 "Options about how to make context of a location visible."
394 "Non-nil means, show full hierarchy when revealing a location.
395 Org-mode often shows locations in an org-mode file which might have
396 been invisible before. When this is set, the hierarchy of headings
397 above the exposed location is shown.
398 Turning this off for example for sparse trees makes them very compact.
399 Instead of t, this can also be an alist specifying this option for different
400 contexts. Valid contexts are
401 agenda when exposing an entry from the agenda
402 org-goto when using the command `org-goto' on key C-c C-j
403 occur-tree when using the command `org-occur' on key C-c /
404 tags-tree when constructing a sparse tree based on tags matches
405 link-search when exposing search matches associated with a link
406 mark-goto when exposing the jump goal of a mark
407 bookmark-jump when exposing a bookmark location
408 isearch when exiting from an incremental search
409 default default for all contexts not set explicitly"
414 "Non-nil means, show following heading when revealing a location.
415 Org-mode often shows locations in an org-mode file which might have
416 been invisible before. When this is set, the heading following the
417 match is shown.
418 Turning this off for example for sparse trees makes them very compact,
419 but makes it harder to edit the location of the match. In such a case,
421 Instead of t, this can also be an alist specifying this option for different
422 contexts. See `org-show-hierarchy-above' for valid contexts."
427 "Non-nil means, show all sibling heading when revealing a location.
428 Org-mode often shows locations in an org-mode file which might have
429 been invisible before. When this is set, the sibling of the current entry
430 heading are all made visible. If `org-show-hierarchy-above' is t,
431 the same happens on each level of the hierarchy above the current entry.
433 By default this is on for the isearch context, off for all other contexts.
434 Turning this off for example for sparse trees makes them very compact,
435 but makes it harder to edit the location of the match. In such a case,
437 Instead of t, this can also be an alist specifying this option for different
438 contexts. See `org-show-hierarchy-above' for valid contexts."
443 "Non-nil means, show the entry below a headline when revealing a location.
444 Org-mode often shows locations in an org-mode file which might have
445 been invisible before. When this is set, the text below the headline that is
446 exposed is also shown.
448 By default this is off for all contexts.
449 Instead of t, this can also be an alist specifying this option for different
450 contexts. See `org-show-hierarchy-above' for valid contexts."
455 "Options concerning visibility cycling in Org-mode."
460 "Names of drawers. Drawers are not opened by cycling on the headline above.
461 Drawers only open with a TAB on the drawer line itself. A drawer looks like
462 this:
463 :DRAWERNAME:
464 .....
465 :END:
467 the property API.
469 Drawers can be defined on the per-file basis with a line like:
471 #+DRAWERS: HIDDEN STATE PROPERTIES"
476 "Cycle globally if cursor is at beginning of buffer and not at a headline.
477 This makes it possible to do global cycling without having to use S-TAB or
478 C-u TAB. For this special case to work, the first line of the buffer
479 must not be a headline - it may be empty ot some other text. When used in
480 this way, `org-cycle-hook' is disables temporarily, to make sure the
481 cursor stays at the beginning of the buffer.
482 When this option is nil, don't do anything special at the beginning
483 of the buffer."
488 "Where should `org-cycle' emulate TAB.
489 nil Never
490 white Only in completely white lines
491 whitestart Only at the beginning of lines, before the first non-white char
492 t Everywhere except in headlines
493 exc-hl-bol Everywhere except at the start of a headline
494 If TAB is used in a place where it does not emulate TAB, the current subtree
495 visibility is cycled."
502 ))
505 "Number of empty lines needed to keep an empty line between collapsed trees.
506 If you leave an empty line between the end of a subtree and the following
507 headline, this empty line is hidden when the subtree is folded.
508 Org-mode will leave (exactly) one empty line visible if the number of
509 empty lines is equal or larger to the number given in this variable.
510 So the default 2 means, at least 2 empty lines after the end of a subtree
511 are needed to produce free space between a collapsed subtree and the
512 following headline.
514 Special case: when 0, never leave empty lines in collapsed view."
519 org-cycle-hide-drawers
520 org-cycle-show-empty-lines
521 org-optimize-window-after-visibility-change)
522 "Hook that is run after `org-cycle' has changed the buffer visibility.
523 The function(s) in this hook must accept a single argument which indicates
524 the new state that was set by the most recent `org-cycle' command. The
525 argument is a symbol. After a global state change, it can have the values
526 `overview', `content', or `all'. After a local state change, it can have
527 the values `folded', `children', or `subtree'."
532 "Options concerning structure editing in Org-mode."
537 "Non-nil means, skip even levels and only use odd levels for the outline.
538 This has the effect that two stars are being added/taken away in
539 promotion/demotion commands. It also influences how levels are
540 handled by the exporters.
541 Changing it requires restart of `font-lock-mode' to become effective
542 for fontification also in regions already fontified.
543 You may also set this on a per-file basis by adding one of the following
544 lines to the buffer:
546 #+STARTUP: odd
547 #+STARTUP: oddeven"
553 "Non-nil means, adapt indentation when promoting and demoting.
554 When this is set and the *entire* text in an entry is indented, the
555 indentation is increased by one space in a demotion command, and
556 decreased by one in a promotion command. If any line in the entry
557 body starts at column 0, indentation is not changed at all."
562 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
563 When t, `C-a' will bring back the cursor to the beginning of the
564 headline text, i.e. after the stars and after a possible TODO keyword.
565 In an item, this will be the position after the bullet.
566 When the cursor is already at that position, another `C-a' will bring
567 it to the beginning of the line.
568 `C-e' will jump to the end of the headline, ignoring the presence of tags
569 in the headline. A second `C-e' will then jump to the true end of the
570 line, after any tags.
571 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
572 and only a directly following, identical keypress will bring the cursor
573 to the special positions."
584 "Non-nil means `C-k' will behave specially in headlines.
585 When nil, `C-k' will call the default `kill-line' command.
586 When t, the following will happen while the cursor is in the headline:
588 - When the cursor is at the beginning of a headline, kill the entire
589 line and possible the folded subtree below the line.
590 - When in the middle of the headline text, kill the headline up to the tags.
591 - When after the headline text, kill the tags."
596 "Non-nil means, M-RET will split the line at the cursor position.
597 When nil, it will go to the end of the line before making a
598 new line.
599 You may also set this option in a different way for different
600 contexts. Valid contexts are:
602 headline when creating a new headline
603 item when creating a new item
604 table in a table field
605 default the value to be used for all contexts not explicitly
606 customized"
624 "Should `org-insert-heading' leave a blank line before new heading/item?
625 The value is an alist, with `heading' and `plain-list-item' as car,
626 and a boolean flag as cdr."
633 "Hook being run after inserting a new heading."
639 This currently only means, they are never auto-wrapped.
640 When nil, such lines will be treated like ordinary lines.
641 See also the QUOTE keyword."
646 "Non-nil means, typing characters in org-goto starts incremental search."
651 "Options concerning sparse trees in Org-mode."
656 "Non-nil means, highlight all matches that define a sparse tree.
657 The highlights will automatically disappear the next time the buffer is
658 changed by an edit command."
663 "Non-nil means, any change to the buffer will remove temporary highlights.
664 Such highlights are created by `org-occur' and `org-clock-display'.
665 When nil, `C-c C-c needs to be used to get rid of the highlights.
666 The highlights created by `org-preview-latex-fragment' always need
667 `C-c C-c' to be removed."
674 "Hook that is run after `org-occur' has constructed a sparse tree.
675 This can be used to recenter the window to show as much of the structure
676 as possible."
681 "Options concerning plain lists in Org-mode."
686 "Non-nil means, include plain lists into visibility cycling.
687 This means that during cycling, plain list items will *temporarily* be
688 interpreted as outline headlines with a level given by 1000+i where i is the
689 indentation of the bullet. In all other operations, plain list items are
690 not seen as headlines. For example, you cannot assign a TODO keyword to
691 such an item."
696 "The character that makes a line with leading number an ordered list item.
697 Valid values are ?. and ?\). To get both terminators, use t. While
698 ?. may look nicer, it creates the danger that a line with leading
699 number may be incorrectly interpreted as an item. ?\) therefore is
700 the safe choice."
707 "Non-nil means, automatically renumber ordered plain lists.
708 Renumbering happens when the sequence have been changed with
715 "Non-nil means, update checkbox statistics after insert and toggle.
716 When this is set, checkbox statistics is updated each time you either insert
723 "Options concerning archiving in Org-mode."
728 "The tag that marks a subtree as archived.
729 An archived subtree does not open during visibility cycling, and does
730 not contribute to the agenda listings.
731 After changing this, font-lock must be restarted in the relevant buffers to
732 get the proper fontification."
738 "Non-nil means, the agenda will skip any items located in archived trees.
739 An archived tree is a tree marked with the tag ARCHIVE."
745 "Non-nil means, `org-cycle' will open archived trees.
746 An archived tree is a tree marked with the tag ARCHIVE.
747 When nil, archived trees will stay folded. You can still open them with
748 normal outline commands like `show-all', but not with the cycling commands."
754 "Non-nil means sparse tree construction shows matches in archived trees.
755 When nil, matches in these trees are highlighted, but the trees are kept in
756 collapsed state."
762 "The location where subtrees should be archived.
763 This string consists of two parts, separated by a double-colon.
765 The first part is a file name - when omitted, archiving happens in the same
766 file. %s will be replaced by the current file name (without directory part).
767 Archiving to a different file is useful to keep archived entries from
768 contributing to the Org-mode Agenda.
770 The part after the double colon is a headline. The archived entries will be
771 filed under that headline. When omitted, the subtrees are simply filed away
772 at the end of the file, as top-level entries.
774 Here are a few examples:
776 If the current file is Projects.org, archive in file
777 Projects.org_archive, as top-level trees. This is the default.
780 Archive in the current file, under the top-level headline
784 Archive in file ~/org/archive.org (absolute path), as top-level trees.
787 Archive in file ./basement (relative path), as level 3 trees
790 You may set this option on a per-file basis by adding to the buffer a
791 line like
793 #+ARCHIVE: basement::** Finished Tasks"
798 "Non-nil means, mark entries as DONE when they are moved to the archive file.
799 This can be a string to set the keyword to use. When t, Org-mode will
800 use the first keyword in its list that means done."
808 "Non-nil means, add a time stamp to entries moved to an archive file.
809 This variable is obsolete and has no effect anymore, instead add ot remove
810 `time' from the variablle `org-archive-save-context-info'."
815 "Parts of context info that should be stored as properties when archiving.
816 When a subtree is moved to an archive file, it looses information given by
817 context, like inherited tags, the category, and possibly also the TODO
818 state (depending on the variable `org-archive-mark-done').
819 This variable can be a list of any of the following symbols:
821 time The time of archiving.
822 file The file where the entry originates.
823 itags The local tags, in the headline of the subtree.
824 ltags The tags the subtree inherits from further up the hierarchy.
825 todo The pre-archive TODO state.
826 category The category, taken from file name or #+CATEGORY lines.
827 olpath The outline path to the item. These are all headlines above
828 the current item, separated by /, like a file path.
830 For each symbol present in the list, a property will be created in
832 information."
845 "Options concerning imenu and speedbar in Org-mode."
850 "The maximum level for Imenu access to Org-mode headlines.
851 This also applied for speedbar access."
856 "Options concerning tables in Org-mode."
862 When nil, such lines will be treated like ordinary lines.
864 When equal to the symbol `optimized', the table editor will be optimized to
865 do the following:
866 - Automatic overwrite mode in front of whitespace in table fields.
867 This makes the structure of the table stay in tact as long as the edited
868 field does not exceed the column width.
869 - Minimize the number of realigns. Normally, the table is aligned each time
870 TAB or RET are pressed to move to another field. With optimization this
871 happens only if changes to a field might have changed the column width.
872 Optimization requires replacing the functions `self-insert-command',
873 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
874 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
875 very good at guessing when a re-align will be necessary, but you can always
878 If you would like to use the optimized version in Org-mode, but the
879 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
881 This variable can be used to turn on and off the table editor during a session,
882 but in order to toggle optimization, a restart is required.
884 See also the variable `org-table-auto-blank-field'."
892 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
893 In the optimized version, the table editor takes over all simple keys that
894 normally just insert a character. In tables, the characters are inserted
895 in a way to minimize disturbing the table structure (i.e. in overwrite mode
896 for empty fields). Outside tables, the correct binding of the keys is
897 restored.
899 The default for this option is t if the optimized version is also used in
900 Org-mode. See the variable `org-enable-table-editor' for details. Changing
901 this variable requires a restart of Emacs to become effective."
907 % END RECEIVE ORGTBL %n
909 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
910 | | |
913 @c END RECEIVE ORGTBL %n
914 @ignore
915 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
916 | | |
919 <!-- END RECEIVE ORGTBL %n -->
920 <!--
921 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
922 | | |
924 "Templates for radio tables in different major modes.
925 All occurrences of %n in a template will be replaced with the name of the
926 table, obtained by prompting the user."
933 "Settings for tables in Org-mode."
938 "The default size for newly created tables, Columns x Rows."
944 "Regular expression for recognizing numbers in table columns.
945 If a table column contains mostly numbers, it will be aligned to the
946 right. If not, it will be aligned to the left.
948 The default value of this option is a regular expression which allows
949 anything which looks remotely like a number as used in scientific
950 context. For example, all of the following will be considered a
951 number:
952 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
954 Other options offered by the customize interface are more restrictive."
972 "Fraction of numbers in a column required to make the column align right.
973 In a column all non-white fields are considered. If at least this
974 fraction of fields is matched by `org-table-number-fraction',
975 alignment to the right border applies."
980 "Behavior of tables during editing in Org-mode."
985 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
987 removal/insertion."
992 "Non-nil means, automatically blank table field when starting to type into it.
993 This only happens when typing immediately after a field motion
994 command (TAB, S-TAB or RET).
995 Only relevant when `org-enable-table-editor' is equal to `optimized'."
1000 "Non-nil means, tab in the last column of a table with jump over a hline.
1001 If a horizontal separator line is following the current line,
1002 `org-table-next-field' can either create a new row before that line, or jump
1003 over the line. When this option is nil, a new line will be created before
1004 this line."
1009 "Non-nil means, TAB will automatically notice a table.el table.
1010 When it sees such a table, it moves point into it and - if necessary -
1011 calls `table-recognize-table'."
1016 "Options concerning tables in Org-mode."
1021 "Should org-mode work with table refrences like B3 instead of @3$2?
1022 Possible values are:
1023 nil never use them
1024 from accept as input, do not present for editing
1025 t: accept as input and present for editing"
1040 calc-angle-mode deg
1041 calc-prefer-frac nil
1042 calc-symbolic-mode nil
1044 calc-display-working-message t
1045 )
1046 "List with Calc mode settings for use in calc-eval for table formulas.
1047 The list must contain alternating symbols (Calc modes variables and values).
1048 Don't remove any of the default settings, just change the values. Org-mode
1049 relies on the variables to be present in the list."
1054 "Non-nil means, TAB and RET evaluate a formula in current table field.
1055 If the current field starts with an equal sign, it is assumed to be a formula
1056 which should be evaluated as described in the manual and in the documentation
1057 string of the command `org-table-eval-formula'. This feature requires the
1058 Emacs calc package.
1059 When this variable is nil, formula calculation is only available through
1065 "Non-nil means, interpret constants in formulas in tables.
1066 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1067 by the value given in `org-table-formula-constants', or by a value obtained
1068 from the `constants.el' package."
1073 "Alist with constant names and values, for use in table formulas.
1074 The car of each element is a name of a constant, without the `$' before it.
1075 The cdr is the value as a string. For example, if you'd like to use the
1076 speed of light in a formula, you would configure
1080 and then use it in an equation like `$1*$c'.
1082 Constants can also be defined on a per-file basis using a line like
1084 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1095 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1096 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1101 "Options concerning links in Org-mode."
1106 "Buffer-local version of `org-link-abbrev-alist', which see.
1111 "Alist of link abbreviations.
1112 The car of each element is a string, to be replaced at the start of a link.
1114 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1116 [[linkkey:tag][description]]
1118 If REPLACE is a string, the tag will simply be appended to create the link.
1121 REPLACE may also be a function that will be called with the tag as the
1122 only argument to create the link, which should be returned as a string.
1124 See the manual for examples."
1129 "Non-nil means, hide link part and only show description of bracket links.
1130 Bracket links are like [[link][descritpion]]. This variable sets the initial
1131 state in new org-mode buffers. The setting can then be toggled on a
1132 per-buffer basis from the Org->Hyperlinks menu."
1137 "How the path name in file links should be stored.
1138 Valid values are:
1140 relative Relative to the current directory, i.e. the directory of the file
1141 into which the link is being inserted.
1142 absolute Absolute path, if possible with ~ for home directory.
1143 noabbrev Absolute path, no abbreviation of home directory.
1144 adaptive Use relative path for files in the current directory and sub-
1145 directories of it. For other files, use an absolute path."
1154 "Types of links that should be activated in Org-mode files.
1155 This is a list of symbols, each leading to the activation of a certain link
1156 type. In principle, it does not hurt to turn on most link types - there may
1157 be a small gain when turning off unused link types. The types are:
1159 bracket The recommended [[link][description]] or [[link]] links with hiding.
1160 angular Links in angular brackes that may contain whitespace like
1161 <bbdb:Carsten Dominik>.
1162 plain Plain links in normal text, no whitespace, like http://google.com.
1163 radio Text that is matched by a radio target, see manual for details.
1164 tag Tag settings in a headline (link to tag search).
1165 date Time stamps (link to calendar).
1167 Changing this variable requires a restart of Emacs to become effective."
1177 "Options concerning storing links in Org-mode"
1182 "Format of the description part of a link to an email or usenet message.
1183 The following %-excapes will be replaced by corresponding information:
1191 %s subject
1192 %m message-id.
1194 You may use normal field width specification between the % and the letter.
1195 This is for example useful to limit the length of the subject.
1209 It should match if the message is from the user him/herself."
1214 "Non-nil means, file links from `org-store-link' contain context.
1215 A search string will be added to the file name with :: as separator and
1216 used to find the context when the link is activated by the command
1217 `org-open-at-point'.
1219 negates this setting for the duration of the command."
1224 "Non-nil means, keep link in list for entire session.
1226 The command `org-store-link' adds a link pointing to the current
1227 location to an internal list. These links accumulate during a session.
1228 The command `org-insert-link' can be used to insert links into any
1229 Org-mode file (offering completion for all stored links). When this
1231 will be removed from the list, to make completing the unused links
1232 more efficient."
1237 "Non-nil means, `org-store-link' will create web links to Google groups.
1238 When nil, Gnus will be used for such links.
1240 negates this setting for the duration of the command."
1245 "Options concerning following links in Org-mode"
1250 "Hook that is run after a link has been followed."
1255 "Non-nil means, on links TAB will follow the link.
1256 Needs to be set before org.el is loaded."
1261 "Non-nil means, on links RET will follow the link.
1262 Needs to be set before org.el is loaded."
1268 "Non-nil means, mouse-1 on a link will follow the link.
1269 A longer mouse click will still set point. Does not work on XEmacs.
1270 Needs to be set before org.el is loaded."
1275 "Number of different positions to be recorded in the ring
1276 Changing this requires a restart of Emacs to work correctly."
1284 "Setup the frame configuration for following links.
1285 When following a link with Emacs, it may often be useful to display
1286 this link in another window or frame. This variable can be used to
1287 set this up for the different types of links.
1288 For VM, use any of
1289 `vm-visit-folder'
1290 `vm-visit-folder-other-frame'
1291 For Gnus, use any of
1292 `gnus'
1293 `gnus-other-frame'
1294 For FILE, use any of
1295 `find-file'
1296 `find-file-other-window'
1297 `find-file-other-frame'
1298 For the calendar, use the variable `calendar-setup'.
1299 For BBDB, it is currently only possible to display the matches in
1300 another window."
1319 "Non-nil means, use indirect buffer to display infile links.
1320 Activating internal links (from one location in a file to another location
1321 in the same file) normally just jumps to the location. When the link is
1322 activated with a C-u prefix (or with mouse-3), the link is displayed in
1323 another window. When this option is set, the other window actually displays
1324 an indirect buffer clone of the current buffer, to avoid any visibility
1325 changes to the current buffer."
1330 "Non-nil means, `org-open-file' will open non-existing files.
1331 When nil, an error will be generated."
1336 "Function and arguments to call for following mailto links.
1337 This is a list with the first element being a lisp function, and the
1338 remaining elements being arguments to the function. In string arguments,
1339 %a will be replaced by the address, and %s will be replaced by the subject
1340 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1349 "Non-nil means, ask for confirmation before executing shell links.
1350 Shell links can be dangerous: just think about a link
1352 [[shell:rm -rf ~/*][Google Search]]
1355 but really it would remove your entire home directory.
1356 Therefore we advise against setting this variable to nil.
1357 Just change it to `y-or-n-p' of you want to confirm with a
1366 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1367 Elisp links can be dangerous: just think about a link
1372 but really it would remove your entire home directory.
1373 Therefore we advise against setting this variable to nil.
1374 Just change it to `y-or-n-p' of you want to confirm with a
1385 "Default file applications on a UNIX or GNU/Linux system.
1397 "Default file applications on a MacOS X system.
1399 for some files for which the OS does not have a good default.
1407 'mswindows-shell-execute
1410 "Default file applications on a Windows NT system.
1415 '(
1422 )
1423 "External applications for opening `file:path' items in a document.
1424 Org-mode uses system defaults for different file types, but
1425 you can use this variable to set the application for a given file
1426 extension. The entries in this list are cons cells where the car identifies
1427 files and the cdr the corresponding command. Possible values for the
1428 file identifier are
1430 `directory' Matches a directory
1431 `remote' Matches a remote file, accessible through tramp or efs.
1432 Remote files most likely should be visited through Emacs
1433 because external applications cannot handle such paths.
1434 t Default for all remaining files
1436 Possible values for the command are:
1437 `emacs' The file will be visited by the current Emacs process.
1438 `default' Use the default application for this file type.
1439 string A command to be executed by a shell; %s will be replaced
1440 by the path to the file.
1441 sexp A Lisp form which will be evaluated. The file path will
1442 be available in the Lisp variable `file'.
1443 For more examples, see the system specific constants
1444 `org-file-apps-defaults-macosx'
1445 `org-file-apps-defaults-windowsnt'
1446 `org-file-apps-defaults-gnu'."
1461 "Non-nil means, that the search for the mh-message will be extended to
1462 all folders if the message cannot be found in the folder given in the link.
1463 Searching all folders is very efficient with one of the search engines
1464 supported by MH-E, but will be slow with pick."
1469 "Options concerning interaction with remember.el."
1474 "Directory with org files.
1475 This directory will be used as default to prompt for org files.
1476 Used by the hooks for remember.el."
1481 "Default target for storing notes.
1482 Used by the hooks for remember.el. This can be a string, or nil to mean
1483 the value of `remember-data-file'.
1484 You can set this on a per-template basis with the variable
1485 `org-remember-templates'."
1489 file))
1492 "Non-nil means, `C-c C-c' stores remember note without further promts.
1493 In this case, you need `C-u C-c C-c' to get the prompts for
1494 note file and headline.
1495 When this variable is nil, `C-c C-c' give you the prompts, and
1496 `C-u C-c C-c' trigger the fasttrack."
1501 "The interface to be used for interactive filing of remember notes.
1502 This is only used when the interactive mode for selecting a filing
1503 location is used (see the variable `org-remember-store-without-prompt').
1504 Allowed vaues are:
1505 outline The interface shows an outline of the relevant file
1506 and the correct heading is found by moving through
1507 the outline or by searching with incremental search.
1508 outline-path-completion Headlines in the current buffer are offered via
1509 completion.
1510 refile Use the refile interface, and offer headlines,
1511 possibly from different buffers."
1519 "The default interface to be used for `org-goto'.
1520 Allowed vaues are:
1521 outline The interface shows an outline of the relevant file
1522 and the correct heading is found by moving through
1523 the outline or by searching with incremental search.
1524 outline-path-completion Headlines in the current buffer are offered via
1525 completion."
1532 "The headline that should be the default location in the notes file.
1533 When filing remember notes, the cursor will start at that position.
1534 You can set this on a per-template basis with the variable
1535 `org-remember-templates'."
1540 "Templates for the creation of remember buffers.
1541 When nil, just let remember make the buffer.
1542 When not nil, this is a list of 5-element lists. In each entry, the first
1543 element is the name of the template, which should be a single short word.
1544 The second element is a character, a unique key to select this template.
1545 The third element is the template. The fourth element is optional and can
1546 specify a destination file for remember items created with this template.
1547 The default file is given by `org-default-notes-file'. An optional fifth
1548 element can specify the headline in that file that should be offered
1549 first when the user is asked to file the entry. The default headline is
1550 given in the variable `org-remember-default-headline'.
1552 An optional sixth element can specify the context in which the user should
1553 be able to select this template. If this element is a list of major modes,
1554 the template will only be available while invoking `org-remember' from a
1555 buffer in one of these modes. If it is a function, the template will only
1556 be selected if the function returns `t'. A value of `t' means select
1557 this template in any context. When the element is `nil', the template
1558 will be selected by default, i.e. when all contextual checks failed.
1560 The template specifies the structure of the remember buffer. It should have
1561 a first line starting with a star, to act as the org-mode headline.
1562 Furthermore, the following %-escapes will be replaced with content:
1564 %^{prompt} Prompt the user for a string and replace this sequence with it.
1565 A default value and a completion table ca be specified like this:
1566 %^{prompt|default|completion2|completion3|...}
1567 %t time stamp, date only
1568 %T time stamp with date and time
1569 %u, %U like the above, but inactive time stamps
1570 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1571 You may define a prompt like %^{Please specify birthday}t
1572 %n user name (taken from `user-full-name')
1573 %a annotation, normally the link created with org-store-link
1574 %i initial content, the region active. If %i is indented,
1575 the entire inserted text will be indented as well.
1576 %c content of the clipboard, or current kill ring head
1577 %^g prompt for tags, with completion on tags in target file
1578 %^G prompt for tags, with completion all tags in all agenda files
1579 %:keyword specific information for certain link types, see below
1580 %[pathname] insert the contents of the file given by `pathname'
1581 %(sexp) evaluate elisp `(sexp)' and replace with the result
1582 %! Store this note immediately after filling the template
1584 %? After completing the template, position cursor here.
1586 Apart from these general escapes, you can access information specific to the
1587 link type that is created. For example, calling `remember' in emails or gnus
1588 will record the author and the subject of the message, which you can access
1589 with %:author and %:subject, respectively. Here is a complete list of what
1590 is recorded for each link type.
1592 Link type | Available information
1593 -------------------+------------------------------------------------------
1594 bbdb | %:type %:name %:company
1595 vm, wl, mh, rmail | %:type %:subject %:message-id
1596 | %:from %:fromname %:fromaddress
1597 | %:to %:toname %:toaddress
1599 gnus | %:group, for messages also all email fields
1600 w3, w3m | %:type %:url
1601 info | %:type %:file %:node
1602 calendar | %:type %:date"
1631 "Non-nil means, store new notes at the beginning of a file or entry.
1632 When nil, new notes will be filed to the end of a file or entry.
1633 This can also be a list with cons cells of regular expressions that
1634 are matched against file names, and values."
1644 This is list of cons cells. Each cell contains:
1645 - a specification of the files to be considered, either a list of files,
1646 or a symbol whose function or value fields will be used to retrieve
1647 a file name or a list of file names. Nil means, refile to a different
1648 heading in the current buffer.
1649 - A specification of how to find candidate refile targets. This may be
1650 any of
1652 This tag has to be present in all target headlines, inheritance will
1653 not be considered.
1655 todo keyword.
1657 headlines that are refiling targets.
1658 - a cons cell (:level . N). Any headline of level N is considered a target.
1659 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1660 ;; FIXME: what if there are a var and func with same name???
1676 "Non-nil means, provide refile targets as paths.
1677 So a level 3 headline will be available as level1/level2/level3.
1678 When the value is `file', also include the file name (without directory)
1679 into the path. When `full-file-path', include the full file path."
1688 "Options concerning TODO items in Org-mode."
1693 "Options concerning Progress logging in Org-mode."
1698 "List of TODO entry keyword sequences and their interpretation.
1701 Each sequence starts with a symbol, either `sequence' or `type',
1702 indicating if the keywords should be interpreted as a sequence of
1703 action steps, or as different types of TODO items. The first
1704 keywords are states requiring action - these states will select a headline
1705 for inclusion into the global TODO list Org-mode produces. If one of
1708 the last keyword is treated as the only DONE state of the sequence.
1711 additional state where no keyword is present. For details about this
1712 cycling, see the manual.
1714 TODO keywords and interpretation can also be set on a per-file basis with
1715 the special #+SEQ_TODO and #+TYP_TODO lines.
1717 Each keyword can optionally specify a character for fast state selection
1718 \(in combination with the variable `org-use-fast-todo-selection')
1719 and specifiers for state change logging, using the same syntax
1722 indicates to record a time stamp each time this state is selected.
1724 Each keyword may also specify if a timestamp or a note should be
1725 recorded when entering or leaving the state, by adding additional
1726 characters in the parenthesis after the keyword. This looks like this:
1728 record only the time of the state change. With X and Y being either
1730 Y when leaving the state if and only if the *target* state does not
1731 define X. You may omit any of the fast-selection key or X or /Y,
1732 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1734 For backward compatibility, this variable may also be just a list
1735 of keywords - in this case the interptetation (sequence or type) will be
1736 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1774 "Controls how TODO keywords are interpreted.
1775 This variable is in principle obsolete and is only used for
1776 backward compatibility, if the interpretation of todo keywords is
1777 not given already in `org-todo-keywords'. See that variable for
1778 more information."
1785 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1786 This variable describes if and under what circumstances the cycling
1787 mechanism for TODO keywords will be replaced by a single-key, direct
1788 selection scheme.
1790 When nil, fast selection is never used.
1792 When the symbol `prefix', it will be used when `org-todo' is called with
1793 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1794 in an agenda buffer.
1796 When t, fast selection is used by default. In this case, the prefix
1797 argument forces cycling instead.
1799 In all cases, the special interface is only used if access keys have actually
1800 been assigned by the user, i.e. if keywords in the configuration are followed
1801 by a letter in parenthesis, like TODO(t)."
1809 "Hook which is run after the state of a TODO item was changed.
1810 The new state (a string with a TODO keyword, or nil) is available in the
1811 Lisp variable `state'."
1816 "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
1817 When equal to the list (done), also prompt for a closing note.
1818 This can also be configured on a per-file basis by adding one of
1819 the following lines anywhere in the buffer:
1821 #+STARTUP: logdone
1822 #+STARTUP: lognotedone
1823 #+STARTUP: nologdone"
1831 ;; Normalize old uses of org-log-done.
1837 ;; FIXME: document
1839 "Non-nil means, recored a note when clocking out of an item.
1840 This can also be configured on a per-file basis by adding one of
1841 the following lines anywhere in the buffer:
1843 #+STARTUP: lognoteclock-out
1844 #+STARTUP: nolognoteclock-out"
1850 "Non-nil means, the CLOSED time stamp will contain date and time.
1851 When nil, only the date will be recorded."
1859 "Headings for notes added when clocking out or closing TODO items.
1860 The value is an alist, with the car being a symbol indicating the note
1861 context, and the cdr is the heading to be used. The heading may also be the
1862 empty string.
1863 %t in the heading will be replaced by a time stamp.
1864 %s will be replaced by the new TODO state, in double quotes.
1865 %u will be replaced by the user name.
1866 %U will be replaced by the full user name."
1872 "Heading when changing todo state (todo sequence only)"
1877 "Non-nil means, the latest state change note will be directly after heading.
1878 When nil, the notes will be orderer according to time."
1884 "Non-nil means, record moving through the DONE state when triggering repeat.
1885 An auto-repeating tasks is immediately switched back to TODO when marked
1887 the TODO keyword definition, or recording a cloing note by setting
1888 `org-log-done', there will be no record of the task moving trhough DONE.
1889 This variable forces taking a note anyway. Possible values are:
1891 nil Don't force a record
1892 time Record a time stamp
1893 note Record a note
1895 This option can also be set with on a per-file-basis with
1897 #+STARTUP: logrepeat
1898 #+STARTUP: lognoterepeat
1899 #+STARTUP: nologrepeat
1901 You can have local logging settings for a subtree by setting the LOGGING
1902 property to one or more of these keywords."
1911 "Should clocking info be wrapped into a drawer?
1912 When t, clocking info will always be inserted into a :CLOCK: drawer.
1913 If necessary, the drawer will be created.
1914 When nil, the drawer will not be created, but used when present.
1915 When an integer and the number of clocking entries in an item
1916 reaches or exceeds this number, a drawer will be created."
1925 "When t, the clock will be stopped when the relevant entry is marked DONE.
1926 Nil means, clock will keep running until stopped explicitly with
1927 `C-c C-x C-o', or until the clock is started in a different item."
1932 "Set task to a special todo state while clocking it.
1933 The value should be the state to which the entry should be switched."
1941 "Priorities in Org-mode."
1946 "The highest priority of TODO items. A character like ?A, ?B etc.
1947 Must have a smaller ASCII number than `org-lowest-priority'."
1952 "The lowest priority of TODO items. A character like ?A, ?B etc.
1953 Must have a larger ASCII number than `org-highest-priority'."
1958 "The default priority of TODO items.
1959 This is the priority an item get if no explicit priority is given."
1964 "Non-nil means, start with default priority when starting to cycle.
1965 When this is nil, the first step in the cycle will be (depending on the
1966 command used) one higher or lower that the default priority."
1971 "Options concerning time stamps and deadlines in Org-mode."
1976 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1977 When nil, these labeled time stamps are forces into the second line of an
1978 entry, just after the headline. When scheduling from the global TODO list,
1979 the time stamp will always be forced into the second line."
1984 "Formats for `format-time-string' which are used for time stamps.
1988 "Number of minutes to round time stamps to.
1989 These are two values, the first applies when first creating a time stamp.
1990 The second applies when changing it with the commands `S-up' and `S-down'.
1991 When changing the time stamp, this means that it will change in steps
1992 of N minues, as given by the second value.
1994 When a setting is 0 or 1, insert the time unmodified. Useful rounding
1995 numbers should be factors of 60, so for example 5, 10, 15.
1997 When this is larger than 1, you can still force an exact time-stamp by using
1998 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
1999 and by using a prefix arg to `S-up/down' to specify the exact number
2000 of minutes to shift."
2011 "Non-nil means, overlay custom formats over all time stamps.
2012 The formats are defined through the variable `org-time-stamp-custom-formats'.
2013 To turn this on on a per-file basis, insert anywhere in the file:
2014 #+STARTUP: customtime"
2022 "Custom formats for time stamps. See `format-time-string' for the syntax.
2023 These are overlayed over the default ISO format if the variable
2024 `org-display-custom-times' is set. Time like %H:%M should be at the
2025 end of the second format."
2030 "Get the right format for a time string."
2035 f)))
2038 "Non-nil means, assume future for incomplete date input from user.
2039 This affects the following situations:
2040 1. The user gives a day, but no month.
2043 it will be considered as *this* month.
2044 2. The user gives a month but not a year.
2048 When this option is nil, the current month and year will always be used
2049 as defaults."
2054 "Non-nil means, display current interpretation of date prompt live.
2055 This display will be in an overlay, in the minibuffer."
2060 "Non-nil means, pop up a calendar when prompting for a date.
2061 In the calendar, the date can be selected with mouse-1. However, the
2062 minibuffer will also be active, and you can simply enter the date as well.
2063 When nil, only the minibuffer will be available."
2071 "The hour when your day really ends.
2072 This has influence for the following applications:
2074 the time given here, the day recognized as TODAY is actually yesterday.
2075 - When a date is read from the user and it is still before the time given
2076 here, the current date and time will be assumed to be yesterday, 23:59.
2078 FIXME:
2079 IMPORTANT: This is still a very experimental feature, it may disappear
2080 again or it may be extended to mean more things."
2085 "Non-nil means, S-down will increase the time in a time stamp.
2086 When nil, S-up will increase."
2091 "Non-nil means, make the calendar window follow timestamp changes.
2092 When a timestamp is modified and the calendar window is visible, it will be
2093 moved to the new date."
2098 "When non-nil, should be a function to create `org-clock-heading'.
2099 This is the string shown in the mode line when a clock is running.
2100 The function is called with point at the beginning of the headline."
2105 "Options concerning tags in Org-mode."
2110 "List of tags allowed in Org-mode files.
2111 When this list is nil, Org-mode will base TAG input on what is already in the
2112 buffer.
2113 The value of this variable is an alist, the car of each entry must be a
2114 keyword as a string, the cdr may be a character that is used to select
2115 that tag through the fast-tag-selection interface.
2116 See the manual for details."
2126 "Non-nil means, use fast tag selection scheme.
2127 This is a special interface to select and deselect tags with single keys.
2128 When nil, fast selection is never used.
2129 When the symbol `auto', fast selection is used if and only if selection
2130 characters for tags have been configured, either through the variable
2131 `org-tag-alist' or through a #+TAGS line in the buffer.
2132 When t, fast selection is always used and selection keys are assigned
2133 automatically if necessary."
2141 "Non-nil means, fast tag selection exits after first change.
2142 When nil, you have to press RET to exit it.
2143 During fast tag selection, you can toggle this flag with `C-c'.
2144 This variable can also have the value `expert'. In this case, the window
2145 displaying the tags menu is not even shown, until you press C-c again."
2153 "Non-nil means, fast tags selection interface will also offer TODO states.
2157 "The column to which tags should be indented in a headline.
2158 If this number is positive, it specifies the column. If it is negative,
2159 it means that the tags should be flushright to that column. For example,
2160 -80 works well for a normal 80 character screen."
2165 "Non-nil means, realign tags after pro/demotion of TODO state change.
2166 These operations change the length of a headline and therefore shift
2167 the tags around. With this options turned on, after each such operation
2168 the tags are again aligned to `org-tags-column'."
2173 "Non-nil means, tags in levels apply also for sublevels.
2174 When nil, only the tags directly given in a specific line apply there.
2175 If you turn off this option, you very likely want to turn on the
2176 companion option `org-tags-match-list-sublevels'."
2181 "Non-nil means list also sublevels of headlines matching tag search.
2182 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2183 the sublevels of a headline matching a tag search often also match
2184 the same search. Listing all of them can create very long lists.
2185 Setting this variable to nil causes subtrees of a match to be skipped.
2186 This option is off by default, because inheritance in on. If you turn
2187 inheritance off, you very likely want to turn this option on.
2189 As a special case, if the tag search is restricted to TODO items, the
2190 value of this variable is ignored and sublevels are always checked, to
2191 make sure all corresponding TODO items find their way into the list."
2203 "Options concerning properties in Org-mode."
2208 "How property key/value pairs should be formatted by `indent-line'.
2209 When `indent-line' hits a property definition, it will format the line
2210 according to this format, mainly to make sure that the values are
2211 lined-up with respect to each other."
2216 "Non-nil means, properties apply also for sublevels.
2217 This setting is only relevant during property searches, not when querying
2218 an entry with `org-entry-get'. To retrieve a property with inheritance,
2219 you need to call `org-entry-get' with the inheritance flag.
2220 Turning this on can cause significant overhead when doing a search, so
2221 this is turned off by default.
2222 When nil, only the properties directly given in the current entry count.
2223 The value may also be a list of properties that shouldhave inheritance.
2225 However, note that some special properties use inheritance under special
2226 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2228 for valid values of a property."
2236 "The default column format, if no other format has been defined.
2237 This variable can be set on the per-file basis by inserting a line
2239 #+COLUMNS: %25ITEM ....."
2244 "List of property/value pairs that can be inherited by any entry.
2245 You can set buffer-local values for this by adding lines like
2247 #+PROPERTY: NAME VALUE"
2254 "List of property/value pairs that can be inherited by any entry.
2255 Valid for the current buffer.
2259 "Options concerning agenda views in Org-mode."
2264 "Variable used by org files to set a category for agenda display.
2265 Such files should use a file variable to set it, for example
2269 or contain a special line
2271 #+CATEGORY: ELisp
2273 If the file does not specify a category, then file's base name
2278 "The files to be used for agenda display.
2282 If an entry is a directory, all files in that directory that are matched by
2283 `org-agenda-file-regexp' will be part of the file list.
2285 If the value of the variable is not a list but a single file name, then
2286 the list of agenda files is actually stored and maintained in that file, one
2287 agenda file per line."
2294 "Regular expression to match files for `org-agenda-files'.
2295 If any element in the list in that variable contains a directory instead
2296 of a normal file, all files in that directory that are matched by this
2297 regular expression will be included."
2302 "t means to just skip non-reachable files in `org-agenda-files'.
2303 Nil means to remove them, after a query, from the list."
2308 "List of extra files to be searched by text search commands.
2309 These files will be search in addition to the agenda files bu the
2310 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2311 Note that these files will only be searched for text search commands,
2312 not for the other agenda views like todo lists, tag earches or the weekly
2313 agenda. This variable is intended to list notes and possibly archive files
2314 that should also be searched by these two commands."
2323 "When set, remote killing from the agenda buffer needs confirmation.
2324 When t, a confirmation is always needed. When a number N, confirmation is
2325 only needed when the text to be killed contains more than N non-white lines."
2333 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2334 The command `org-calendar-goto-agenda' will be bound to this key. The
2335 default is the character `c' because then `c' can be used to switch back and
2336 forth between agenda and calendar."
2341 "Non-nil means, make the block agenda more compact.
2342 This is done by leaving out unnecessary lines."
2347 "Options concerning exporting agenda views in Org-mode."
2352 "Non-nil means, use colors in agenda views."
2357 "Alist of variable/value pairs that should be active during agenda export.
2358 This is a good place to set uptions for ps-print and for htmlize."
2366 "The style specification for exported HTML Agenda files.
2367 If this variable contains a string, it will replace the default <style>
2368 section as produced by `htmlize'.
2369 Since there are different ways of setting style information, this variable
2370 needs to contain the full HTML structure to provide a style, including the
2371 surrounding HTML tags. The style specifications should include definitions
2372 the fonts used by the agenda, here is an example:
2375 p { font-weight: normal; color: gray; }
2376 .org-agenda-structure {
2377 font-size: 110%;
2378 color: #003399;
2379 font-weight: 600;
2380 }
2381 .org-todo {
2382 color: #cc6666;Week-agenda:
2383 font-weight: bold;
2384 }
2385 .org-done {
2386 color: #339933;
2387 }
2388 .title { text-align: center; }
2389 .todo, .deadline { color: red; }
2390 .done { color: green; }
2391 </style>
2393 or, if you want to keep the style in a file,
2397 As the value of this option simply gets inserted into the HTML <head> header,
2399 <style>...</style> is required, if not present the variable will be ignored."
2405 "Options concerning agenda views in Org-mode."
2479 "Selection of examples for agenda command settings.
2480 This will be spliced into the custom type of
2485 "Custom commands for the agenda.
2486 These commands will be offered on the splash screen displayed by the
2489 (key desc type match settings files)
2491 key The key (one or more characters as a string) to be associated
2492 with the command.
2493 desc A description of the command, when omitted or nil, a default
2494 description is built using MATCH.
2495 type The command type, any of the following symbols:
2496 agenda The daily/weekly agenda.
2497 todo Entries with a specific TODO keyword, in all agenda files.
2498 search Entries containing search words entry or headline.
2499 tags Tags/Property/TODO match in all agenda files.
2500 tags-todo Tags/P/T match in all agenda files, TODO entries only.
2501 todo-tree Sparse tree of specific TODO keyword in *current* file.
2502 tags-tree Sparse tree with all tags matches in *current* file.
2503 occur-tree Occur sparse tree for *current* file.
2504 ... A user-defined function.
2505 match What to search for:
2506 - a single keyword for TODO keyword searches
2507 - a tags match expression for tags searches
2508 - a word search expression for text searches.
2509 - a regular expression for occur searches
2510 For all other commands, this should be the empty string.
2511 settings A list of option settings, similar to that in a let form, so like
2512 this: ((opt1 val1) (opt2 val2) ...). The values will be
2513 evaluated at the moment of execution, so quote them when needed.
2514 files A list of files file to write the produced agenda buffer to
2515 with the command `org-store-agenda-views'.
2518 produced. Otherwide, only the plain text is written to the file.
2520 You can also define a set of commands, to create a composite agenda buffer.
2521 In this case, an entry looks like this:
2523 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
2525 where
2527 desc A description string to be displayed in the dispatcher menu.
2528 cmd An agenda command, similar to the above. However, tree commands
2529 are no allowed, but instead you can get agenda and global todo list.
2530 So valid commands for a set are:
2539 Each command can carry a list of options, and another set of options can be
2540 given for the whole set of commands. Individual command options take
2541 precedence over the general options.
2543 When using several characters as key to a command, the first characters
2544 are prefix commands. For the dispatcher to display useful information, you
2545 should provide a description for the prefix, like
2547 (setq org-agenda-custom-commands
2571 ,org-agenda-custom-commands-local-options
2620 "The register holding the current query string.
2621 The prupose of this is that if you construct a query string interactively,
2622 you can then use it to define a custom command."
2628 "How to identify stuck projects.
2629 This is a list of four items:
2630 1. A tags/todo matcher string that is used to identify a project.
2631 The entire tree below a headline matched by this is considered one project.
2632 2. A list of TODO keywords identifying non-stuck projects.
2633 If the project subtree contains any headline with one of these todo
2634 keywords, the project is considered to be not stuck. If you specify
2636 3. A list of tags identifying non-stuck projects.
2637 If the project subtree contains any headline with one of these tags,
2639 a tag, any tag will mark the project unstuck.
2640 4. An arbitrary regular expression matching non-stuck projects.
2643 or `C-c a #' to produce the list."
2647 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2653 "Options concerning skipping parts of agenda files."
2658 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2659 When nil, the sublevels of a TODO entry are not checked, resulting in
2660 potentially much shorter TODO lists."
2666 "Non-nil means, don't show entries with a date in the global todo list.
2667 You can use this if you prefer to mark mere appointments with a TODO keyword,
2668 but don't want them to show up in the TODO list.
2669 When this is set, it also covers deadlines and scheduled items, the settings
2670 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2671 will be ignored."
2677 "Non-nil means, don't show scheduled entries in the global todo list.
2678 The idea behind this is that by scheduling it, you have already taken care
2679 of this item.
2680 See also `org-agenda-todo-ignore-with-date'."
2686 "Non-nil means, don't show near deadline entries in the global todo list.
2687 Near means closer than `org-deadline-warning-days' days.
2688 The idea behind this is that such items will appear in the agenda anyway.
2689 See also `org-agenda-todo-ignore-with-date'."
2695 "Non-nil means don't show scheduled items in agenda when they are done.
2696 This is relevant for the daily/weekly agenda, not for the TODO list. And
2697 it applies only to the actual date of the scheduling. Warnings about
2698 an item with a past scheduling dates are always turned off when the item
2699 is DONE."
2704 "Non-nil means don't show deadines when the corresponding item is done.
2705 When nil, the deadline is still shown and should give you a happy feeling.
2706 This is relevant for the daily/weekly agenda. And it applied only to the
2707 actualy date of the deadline. Warnings about approching and past-due
2708 deadlines are always turned off when the item is DONE."
2713 "Non-nil means don't select item by timestamp or -range if it is DONE."
2718 "Non-nil means, `org-timeline' also shows dates without an entry.
2719 When nil, only the days which actually have entries are shown.
2720 When t, all days between the first and the last date are shown.
2721 When an integer, show also empty dates, but if there is a gap of more than
2722 N days, just insert a special line indicating the size of the gap."
2731 "Options concerning initial settings in the Agenda in Org Mode."
2736 "Hook run just before displaying an agenda buffer."
2741 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2742 A longer mouse click will still set point. Does not work on XEmacs.
2743 Needs to be set before org.el is loaded."
2748 "The initial value of follow-mode in a newly created agenda window."
2753 "Options concerning the windows used by the Agenda in Org Mode."
2758 "How the agenda buffer should be displayed.
2759 Possible values for this option are:
2761 current-window Show agenda in the current window, keeping all other windows.
2762 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2763 other-window Use `switch-to-buffer-other-window' to display agenda.
2764 reorganize-frame Show only two windows on the current frame, the current
2765 window and the agenda.
2766 See also the variable `org-agenda-restore-windows-after-quit'."
2775 "The min and max height of the agenda window as a fraction of frame height.
2776 The value of the variable is a cons cell with two numbers between 0 and 1.
2777 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2782 "Non-nil means, restore window configuration open exiting agenda.
2783 Before the window configuration is changed for displaying the agenda,
2784 the current status is recorded. When the agenda is exited with
2785 `q' or `x' and this option is set, the old state is restored. If
2786 `org-agenda-window-setup' is `other-frame', the value of this
2787 option will be ignored.."
2792 "How should indirect tree buffers be displayed?
2793 This applies to indirect buffers created with the commands
2795 Valid values are:
2796 current-window Display in the current window
2797 other-window Just display in another window.
2798 dedicated-frame Create one new frame, and re-use it each time.
2799 new-frame Make a new frame each time. Note that in this case
2800 previously-made indirect buffers are kept, and you need to
2801 kill these buffers yourself."
2811 "Options concerning the daily/weekly agenda."
2816 "Number of days to include in overview display.
2817 Should be 1 or 7."
2822 "Non-nil means, start the overview always on the specified weekday.
2823 0 denotes Sunday, 1 denotes Monday etc.
2824 When nil, always start on the current day."
2830 "Non-nil means, `org-agenda' shows every day in the selected range.
2831 When nil, only the days which actually have entries are shown."
2836 "Format string for displaying dates in the agenda.
2837 Used by the daily/weekly agenda and by the timeline. This should be
2838 a format string understood by `format-time-string', or a function returning
2839 the formatted date as a string. The function must take a single argument,
2840 a calendar-style date list like (month day year)."
2847 "Format a date string for display in the daily/weekly agenda, or timeline.
2848 This function makes sure that dates are aligned for easy reading."
2856 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2861 "Set means weekly/daily agenda will always contain all TODO entries.
2862 The TODO entries will be listed at the top of the agenda, before
2863 the entries for specific days."
2868 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2869 When nil, only one occurence is shown, either today or the
2870 nearest into the future."
2875 "No. of days before expiration during which a deadline becomes active.
2876 This variable governs the display in sparse trees and in the agenda.
2877 When 0 or negative, it means use this number (the absolute value of it)
2878 even if a deadline has a different individual lead time specified."
2884 "No. of days to continue listing scheduled items that are not marked DONE.
2885 When an item is scheduled on a date, it shows up in the agenda on this
2886 day and will be listed until it is marked done for the number of days
2887 given here."
2892 "Options concerning the time grid in the Org-mode Agenda."
2897 "Non-nil means, show a time grid in the agenda schedule.
2898 A time grid is a set of lines for specific times (like every two hours between
2899 8:00 and 20:00). The items scheduled for a day at specific times are
2900 sorted in between these lines.
2901 For details about when the grid will be shown, and what it will look like, see
2902 the variable `org-agenda-time-grid'."
2908 "----------------"
2911 "The settings for time grid for agenda display.
2912 This is a list of three items. The first item is again a list. It contains
2913 symbols specifying conditions when the grid should be displayed:
2915 daily if the agenda shows a single day
2916 weekly if the agenda shows an entire week
2917 today show grid on current date, independent of daily/weekly display
2918 require-timed show grid only if at least one item has a time specification
2920 The second item is a string which will be places behing the grid time.
2922 The third item is a list of integers, indicating the times that should have
2923 a grid line."
2925 :type
2932 require-timed)
2934 remove-match))
2939 "Options concerning sorting in the Org-mode Agenda."
2948 "Sorting structure for the agenda items of a single day.
2949 This is a list of symbols which will be used in sequence to determine
2950 if an entry should be listed before another entry. The following
2951 symbols are recognized:
2953 time-up Put entries with time-of-day indications first, early first
2954 time-down Put entries with time-of-day indications first, late first
2955 category-keep Keep the default order of categories, corresponding to the
2956 sequence in `org-agenda-files'.
2957 category-up Sort alphabetically by category, A-Z.
2958 category-down Sort alphabetically by category, Z-A.
2959 tag-up Sort alphabetically by last tag, A-Z.
2960 tag-down Sort alphabetically by last tag, Z-A.
2961 priority-up Sort numerically by priority, high priority last.
2962 priority-down Sort numerically by priority, high priority first.
2964 The different possibilities will be tried in sequence, and testing stops
2966 '(time-up category-keep priority-down)
2967 means: Pull out all entries having a specified time of day and sort them,
2968 in order to make a time schedule for the current day the first thing in the
2969 agenda listing for the day. Of the entries without a time indication, keep
2970 the grouped in categories, don't sort the categories, but keep them in
2971 the sequence given in `org-agenda-files'. Within each category sort by
2972 priority.
2974 Leaving out `category-keep' would mean that items will be sorted across
2975 categories by priority.
2977 Instead of a single list, this can also be a set of list for specific
2978 contents, with a context symbol in the car of the list, any of
2979 `agenda', `todo', `tags' for the corresponding agenda views."
2992 "Non-nil means, items without time are considered late.
2993 This is only relevant for sorting. When t, items which have no explicit
2994 time like 15:30 will be considered as 99:01, i.e. later than any items which
2995 do have a time. When nil, the default time is before 0:00. You can use this
2996 option to decide if the schedule for today should come before or after timeless
2997 agenda entries."
3002 "Options concerning the entry prefix in the Org-mode agenda display."
3012 "Format specifications for the prefix of items in the agenda views.
3013 An alist with four entries, for the different agenda types. The keys to the
3014 sublists are `agenda', `timeline', `todo', and `tags'. The values
3015 are format strings.
3016 This format works similar to a printf format, with the following meaning:
3019 as given by the CATEGORY keyword or derived from the file name.
3020 %T the *last* tag of the item. Last because inherited tags come
3021 first in the list.
3022 %t the time-of-day specification if one applies to the entry, in the
3023 format HH:MM
3024 %s Scheduling/Deadline information, a short string
3026 All specifiers work basically like the standard `%s' of printf, but may
3027 contain two additional characters: A question mark just after the `%' and
3028 a whitespace/punctuation character just before the final letter.
3030 If the first character after `%' is a question mark, the entire field
3031 will only be included if the corresponding value applies to the
3032 current entry. This is useful for fields which should have fixed
3033 width when present, but zero width when absent. For example,
3035 day is specified, but will completely disappear in entries which do
3036 not contain a time.
3038 If there is punctuation or whitespace character just before the final
3039 format letter, this character will be appended to the field value if
3042 empty, no additional colon would be interted.
3045 - Indent the line with two space characters
3046 - Give the category in a 12 chars wide field, padded with whitespace on
3047 the right (because of `-'). Append a colon if there is a category
3048 (because of `:').
3049 - If there is a time-of-day, put it into a 12 chars wide field. If no
3050 time, don't put in an empty field, just skip it (because of '?').
3051 - Finally, put the scheduling information and append a whitespace.
3053 As another example, if you don't want the time-of-day of entries in
3054 the prefix, you could use:
3058 See also the variables `org-agenda-remove-times-when-in-prefix' and
3059 `org-agenda-remove-tags'."
3071 "The compiled version of the most recently used prefix format.
3075 "Format for the TODO keyword in agenda lines.
3077 to occupy a fixed space in the agenda display."
3082 "Text preceeding scheduled items in the agenda view.
3083 This is a list with two strings. The first applies when the item is
3084 scheduled on the current day. The second applies when it has been scheduled
3085 previously, it may contain a %d to capture how many days ago the item was
3086 scheduled."
3093 "Text preceeding deadline items in the agenda view.
3094 This is a list with two strings. The first applies when the item has its
3095 deadline on the current day. The second applies when it is in the past or
3096 in the future, it may contain %d to capture how many days away the deadline
3097 is (was)."
3104 "Non-nil means, remove duplicate time specifications in agenda items.
3105 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
3106 time-of-day specification in a headline or diary entry is extracted and
3107 placed into the prefix. If this option is non-nil, the original specification
3108 \(a timestamp or -range, or just a plain time(range) specification like
3109 11:30-4pm) will be removed for agenda display. This makes the agenda less
3110 cluttered.
3111 The option can be t or nil. It may also be the symbol `beg', indicating
3112 that the time should only be removed what it is located at the beginning of
3113 the headline/diary entry."
3122 "Default duration for appointments that only have a starting time.
3123 When nil, no duration is specified in such cases.
3124 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
3132 "Non-nil means, remove the tags from the headline copy in the agenda.
3133 When this is the symbol `prefix', only remove tags when
3134 `org-agenda-prefix-format' contains a `%T' specifier."
3146 "Shift tags in agenda items to this column.
3147 If this number is positive, it specifies the column. If it is negative,
3148 it means that the tags should be flushright to that column. For example,
3149 -80 works well for a normal 80 character screen."
3157 "Non-nil means, highlight low and high priorities in agenda.
3158 When t, the highest priority entries are bold, lowest priority italic.
3159 This may also be an association list of priority faces. The face may be
3170 "Options for embedding LaTeX code into Org-mode"
3178 "Options for creating images from LaTeX fragments.
3179 This is a property list with the following properties:
3181 `default' means use the forground of the default face.
3183 `default' means use the background of the default face.
3184 :scale a scaling factor for the size of the images
3185 :html-foreground, :html-background, :html-scale
3186 The same numbers for HTML export.
3187 :matchers a list indicating which matchers should be used to
3188 find LaTeX fragments. Valid members of this list are:
3205 "The document header used for processing LaTeX fragments."
3210 "Options for exporting org-listings."
3215 "General options for exporting Org-mode files."
3219 ;; FIXME
3224 When this option is turned on, these strings will be exported as:
3226 Org HTML LaTeX
3227 -----+----------+--------
3229 -- – --
3230 --- — ---
3231 ... … \ldots
3248 "Terms used in export text, translated to different languages.
3249 Use the variable `org-export-default-language' to set the language,
3250 or use the +OPTION lines for a per-file setting."
3260 "The default language of HTML export, as a string.
3261 This should have an association in `org-export-language-setup'."
3266 "Non-nil means, skip all text before the first headline when exporting.
3267 When nil, that text is exported as well."
3272 "The last level which is still exported as a headline.
3273 Inferior levels will produce itemize lists when exported.
3274 Note that a numeric prefix argument to an exporter function overrides
3275 this setting.
3282 "Non-nil means, add section numbers to headlines when exporting.
3289 "Non-nil means, create a table of contents in exported files.
3290 The TOC contains headlines with levels up to`org-export-headline-levels'.
3291 When an integer, include levels up to N in the toc, this may then be
3292 different from `org-export-headline-levels', but it will not be allowed
3293 to be larger than the number of headline levels.
3294 When nil, no table of contents is made.
3297 ASCII export, and with red color in HTML output, if the option
3298 `org-export-mark-todo-in-toc' is set.
3300 In HTML output, the TOC will be clickable.
3311 "Non-nil means, mark TOC lines that contain any open TODO items."
3316 "Non-nil means, preserve all line breaks when exporting.
3317 Normally, in HTML output paragraphs will be reformatted. In ASCII
3318 export, line breaks will always be preserved, regardless of this variable.
3325 "Whether subtrees with the ARCHIVE tag should be exported.
3326 This can have three different values
3327 nil Do not export, pretend this tree is not present
3328 t Do export the entire tree
3329 headline Only export the headline, but skip the tree below it."
3338 "Non-nil means, insert author name and email into the exported file.
3340 This option can also be set with the +OPTIONS line,
3346 "Non-nil means, insert a time stamp into the exported file.
3347 The time stamp shows when the file was created.
3349 This option can also be set with the +OPTIONS line,
3355 "If nil, do not export time stamps and associated keywords."
3360 "If nil, remove timestamps from the table of contents entries."
3365 "If nil, do not export tags, just remove them from headlines.
3366 If this is the symbol `not-in-toc', tags will be removed from table of
3367 contents entries, but still be shown in the headlines of the document.
3377 "Non-nil means, export with drawers like the property drawer.
3378 When t, all drawers are exported. This may also be a list of
3379 drawer names to export."
3388 "Options for translating special ascii sequences for the export backends."
3393 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3394 If the export target supports emphasizing text, the word will be
3395 typeset in bold, italic, or underlined, respectively. Works only for
3396 single words, but you can say: I *really* *mean* *this*.
3397 Not all export backends support this.
3404 "If nil, export [1] as a footnote marker.
3405 Lines starting with [1] will be formatted as footnotes.
3413 When this option is turned on, you can use TeX-like syntax for sub- and
3415 considered as a single item - so grouping with {} is normally not
3416 needed. For example, the following things will be parsed as single
3417 sub- or superscripts.
3419 10^24 or 10^tau several digits will be considered 1 item.
3420 10^-12 or 10^-tau a leading sign with digits or a word
3421 x^2-y^3 will be read as x^2 - y^3, because items are
3422 terminated by almost any nonword/nondigit char.
3423 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3425 Still, ambiguity is possible - so when in doubt use {} to enclose the
3426 sub/superscript. If you set this variable to the symbol `{}',
3427 the braces are *required* in order to trigger interpretations as
3429 frequently in plain text.
3431 Not all export backends support this, but HTML does.
3442 When this option is turned on, these strings will be exported as:
3445 -- : –
3446 --- : —
3448 Not all export backends support this, but HTML does.
3455 "Non-nil means, interpret simple TeX-like macros when exporting.
3457 No only real TeX macros will work here, but the standard HTML entities
3458 for math can be used as macro names as well. For a list of supported
3459 names in HTML export, see the constant `org-html-entities'.
3460 Not all export backends support this.
3468 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3470 the first non-white thing on a line. It will also find the math delimiters
3472 display math.
3481 This can be used to have pre-formatted text, fragments of code etc. For
3482 example:
3483 : ;; Some Lisp examples
3484 : (while (defc cnt)
3485 : (ding))
3486 will be looking just like this in also HTML. See also the QUOTE keyword.
3487 Not all export backends support this.
3494 "Number of stacked braces for sub/superscript matching.
3495 This has to be set before loading org.el to be effective."
3500 "Options for exporting tables in Org-mode."
3506 For example:
3508 | Name | Address | Birthday |
3509 |-------------+----------+-----------|
3510 | Arthur Dent | England | 29.2.2100 |
3512 Not all export backends support this.
3519 "Non-nil means, highlight the first table line.
3520 In HTML export, this means use <th> instead of <td>.
3521 In tables created with table.el, this applies to the first table line.
3522 In Org-mode tables, all lines before the first horizontal separator
3523 line will be formatted with <th> tags."
3528 "Remove special lines and marking characters in calculating tables.
3529 This removes the special marking character column from tables that are set
3530 up for spreadsheet calculations. It also removes the entire lines
3531 marked with `!', `_', or `^'. The lines with `$' are kept, because
3532 the values of constants may be useful to have."
3537 "Non-nil means, always export tables created with table.el natively.
3538 Natively means, use the HTML code generator in table.el.
3539 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3540 the table does not use row- or column-spanning). This has the
3541 advantage, that the automatic HTML conversions for math symbols and
3542 sub/superscripts can be applied. Org-mode's HTML generator is also
3543 much faster."
3548 "Options specific for ASCII export of Org-mode files."
3553 "Characters for underlining headings in ASCII export.
3554 In the given sequence, these characters will be used for level 1, 2, ..."
3559 "Bullet characters for headlines converted to lists in ASCII export.
3560 The first character is used for the first lest level generated in this
3561 way, and so on. If there are more levels than characters given here,
3562 the list will be repeated.
3563 Note that plain lists will keep the same bullets as the have in the
3564 Org-mode file."
3569 "Options specific for XML export of Org-mode files."
3574 "Options specific for HTML export of Org-mode files."
3579 ""
3584 "The extension for exported HTML files."
3590 html {
3591 font-family: Times, serif;
3592 font-size: 12pt;
3593 }
3594 .title { text-align: center; }
3595 .todo { color: red; }
3596 .done { color: green; }
3597 .timestamp { color: grey }
3598 .timestamp-kwd { color: CadetBlue }
3599 .tag { background-color:lightblue; font-weight:normal }
3600 .target { background-color: lavender; }
3601 pre {
3602 border: 1pt solid #AEBDCC;
3603 background-color: #F3F5F7;
3604 padding: 5pt;
3605 font-family: courier, monospace;
3606 }
3607 table { border-collapse: collapse; }
3608 td, th {
3609 vertical-align: top;
3610 <!--border: 1pt solid #ADB9CC;-->
3611 }
3612 </style>"
3613 "The default style specification for exported HTML files.
3614 Since there are different ways of setting style information, this variable
3615 needs to contain the full HTML structure to provide a style, including the
3616 surrounding HTML tags. The style specifications should include definitions
3617 for new classes todo, done, title, and deadline. For example, legal values
3618 would be:
3621 p { font-weight: normal; color: gray; }
3622 h1 { color: black; }
3623 .title { text-align: center; }
3624 .todo, .deadline { color: red; }
3625 .done { color: green; }
3626 </style>
3628 or, if you want to keep the style in a file,
3632 As the value of this option simply gets inserted into the HTML <head> header,
3639 "Format for typesetting the document title in HTML export."
3644 "The <H> level for level 1 headings in HTML export."
3649 "Non-nil means, make file links to `file.org' point to `file.html'.
3650 When org-mode is exporting an org-mode file to HTML, links to
3651 non-html files are directly put into a href tag in HTML.
3652 However, links to other Org-mode files (recognized by the
3653 extension `.org.) should become links to the corresponding html
3654 file, assuming that the linked org-mode file will also be
3655 converted to HTML.
3656 When nil, the links still point to the plain `.org' file."
3661 "Non-nil means, inline images into exported HTML pages.
3662 This is done using an <img> tag. When nil, an anchor with href is used to
3663 link to the image. If this option is `maybe', then images in links with
3664 an empty description will be inlined, while images with a description will
3665 be linked only."
3671 ;; FIXME: rename
3673 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3674 When nil, these tags will be exported as plain text and therefore
3675 not be interpreted by a browser.
3683 "The HTML tag that is used to start a table.
3684 This must be a <table> tag, but you may change the options like
3685 borders and spacing."
3690 "The opening tag for table header fields.
3691 This is customizable so that alignment options can be specified."
3696 "The opening tag for table data fields.
3697 This is customizable so that alignment options can be specified."
3702 "If non-nil, write `org-export-html-html-helper-timestamp'
3703 into the exported HTML text. Otherwise, the buffer will just be saved
3704 to a file."
3710 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3715 "Options specific for iCalendar export of Org-mode files."
3720 "The file name for the iCalendar file covering all agenda files.
3722 The file name should be absolute, the file will be overwritten without warning."
3727 "Non-nil means, export to iCalendar files should also cover TODO items."
3735 "Non-nil means, export to iCalendar files should also cover sexp entries.
3736 These are entries like in the diary, but directly in an Org-mode file."
3741 "Amount of text below headline to be included in iCalendar export.
3742 This is a number of characters that should maximally be included.
3743 Properties, scheduling and clocking lines will always be removed.
3744 The text will be inserted into the DESCRIPTION field."
3752 "Calendar name for the combined iCalendar representing all agenda files."
3757 "Font-lock settings for highlighting in Org-mode."
3762 "Non-nil means fontify only the stars in each headline.
3763 When nil, the entire headline is fontified.
3764 Changing it requires restart of `font-lock-mode' to become effective
3765 also in regions already fontified."
3770 "Non-nil means, hide the first N-1 stars in a headline.
3771 This works by using the face `org-hide' for these stars. This
3772 face is white for a light background, and black for a dark
3773 background. You may have to customize the face `org-hide' to
3774 make this work.
3775 Changing it requires restart of `font-lock-mode' to become effective
3776 also in regions already fontified.
3777 You may also set this on a per-file basis by adding one of the following
3778 lines to the buffer:
3780 #+STARTUP: hidestars
3781 #+STARTUP: showstars"
3786 "Non-nil means, change the face of a headline if it is marked DONE.
3787 Normally, only the TODO/DONE keyword indicates the state of a headline.
3788 When this is non-nil, the headline after the keyword is set to the
3789 `org-headline-done' as an additional indication."
3794 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3795 Changing this variable requires a restart of Emacs to take effect."
3800 "Non-nil means, fontify what is treated specially by the exporters."
3805 "Non-nil mean font-lock should hide the emphasis marker characters."
3816 "Set variable and compute the emphasis regular expression."
3820 org-emphasis-alist org-emphasis-regexp-components)
3833 ;; make sure special characters appear at the right position in the class
3845 ;; Make the regexp
3853 body1
3865 body1
3873 "Components used to build the regular expression for emphasis.
3874 This is a list with 6 entries. Terminology: In an emphasis string
3878 specify what is allowed/forbidden in each part:
3880 pre Chars allowed as prematch. Beginning of line will be allowed too.
3881 post Chars allowed as postmatch. End of line will be allowed too.
3882 border The chars *forbidden* as border characters.
3884 non-shy groups here, and don't allow newline here.
3885 newline The maximum number of newlines allowed in an emphasis exp.
3887 Use customize to modify this, or restart Emacs after changing it."
3905 )
3906 "Special syntax for emphasized text.
3907 Text starting and ending with a special character will be emphasized, for
3908 example *bold*, _underlined_ and /italic/. This variable sets the marker
3909 characters, the face to be used by font-lock for highlighting in Org-mode
3910 Emacs buffers, and the HTML tags to be used for this.
3911 Use customize to modify this, or restart Emacs after changing it."
3924 ;;; The faces
3927 "Faces in Org-mode."
3932 "Make a compatible face specification.
3933 If INHERITS is an existing face and if the Emacs version supports it,
3934 just inherit the face. If not, use SPECS to define the face.
3935 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3936 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3937 to the top of the list. The `min-colors' attribute will be removed from
3938 any other entries, and any resulting duplicates will be removed entirely."
3942 ;; In Emacs 23, we use inheritance where possible.
3943 ;; We only do this in Emacs 23, because only there the outline
3944 ;; faces have been changed to the original org-mode-level-faces.
3947 ;; These do not understand the `min-colors' attribute.
3966 "Face used to hide leading stars in headlines.
3967 The forground color of this face should be equal to the background
3968 color of the frame."
3979 "Face used for level 1 headlines."
3989 "Face used for level 2 headlines."
4001 "Face used for level 3 headlines."
4013 "Face used for level 4 headlines."
4021 "Face used for level 5 headlines."
4029 "Face used for level 6 headlines."
4037 "Face used for level 7 headlines."
4045 "Face used for level 8 headlines."
4053 "Face used for special keywords."
4064 "Face used for drawers."
4068 "Face used for the value of a property."
4080 "Face for column display of entry properties."
4084 ;; Make sure that a fixed-width face is used when we have a column table.
4096 "Face for deadlines and TODO keywords."
4109 "Face for headline with the ARCHIVE tag."
4116 "Face for links."
4123 "Face for the ellipsis in folded text."
4130 "Face for links."
4137 "Face for links."
4144 "Face for links."
4149 "Face for tags."
4159 "Face for TODO keywords."
4168 "Face used for todo keywords that indicate DONE items."
4176 "Face used to indicate that a headline is DONE.
4177 This face is only used if `org-fontify-done-headline' is set. If applies
4178 to the part of the headline after the DONE keyword."
4182 "Faces for specific TODO keywords.
4183 This is a list of cons cells, with TODO keywords in the car
4184 and faces in the cdr. The face can be a symbol, or a property
4201 "Face used for tables."
4211 "Face for formulas."
4224 "Face for fixed-with text like code snippets."
4238 "Face for fixed-with text like code snippets."
4250 "Face used in agenda for captions and dates."
4259 "Face for items scheduled for a certain day."
4269 "Face for items scheduled previously, and not yet done."
4279 "Face for items scheduled previously, and not yet done."
4286 "Faces for showing deadlines in the agenda.
4287 This is a list of cons cells. The cdr of each cell is a face to be used,
4289 Each car is a fraction of the head-warning time that must have passed for
4290 this the face in the cdr to be used for display. The numbers must be
4291 given in descending order. The head-warning time is normally taken
4292 from `org-deadline-warning-days', but can also be specified in the deadline
4293 timestamp itself, like this:
4295 DEADLINE: <2007-08-13 Mon -8d>
4297 You may use d for days, w for weeks, m for months and y for years. Months
4298 and years will only be treated in an approximate fashion (30.4 days for a
4299 month and 365.24 days for a year)."
4307 ;; FIXME: this is not a good face yet.
4316 "Face for showing the agenda restriction lock."
4324 "Face used for time grids."
4329 org-level-5 org-level-6 org-level-7 org-level-8
4330 ))
4333 "The number of different faces to be used for headlines.
4334 Org-mode defines 8 different headline faces, so this can be at most 8.
4335 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4339 ;;; Functions and variables from ther packages
4340 ;; Declared here to avoid compiler warnings
4346 ;; XEmacs only
4352 ;; Emacs only
4355 ;; Various packages
4356 ;; FIXME: get the argument lists for the UNKNOWN stuff
4411 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4412 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4443 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4454 ;; backward compatibility to old version of wl
4457 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4470 ;;; Variables for pre-computed regular expressions, all buffer local
4485 "Matches a headline and puts everything into groups:
4486 group 1: the stars
4487 group 2: The todo keyword, maybe
4488 group 3: Priority cookie
4489 group 4: True headline
4493 "Matches a headline and puts TODO state into group 2 if present.
4538 rear-nonsticky t mouse-map t fontified t)
4545 s)
4552 s)
4561 "Modified `buffer-invisibility-spec' for Emacs 21.
4562 Some ops with invisible text do not work correctly on Emacs 21. For these
4563 we turn off invisibility temporarily. Use this in a `let' form."
4567 "Make VAR local in current buffer and set it to VALUE."
4571 "Check if the current buffer is in Org-mode."
4575 "Return the last element of LIST."
4608 "Variable associated with STARTUP options for org-mode.
4609 Each element is a list of three items: The startup options as written
4610 in the #+STARTUP line, the corresponding variable, and the value to
4611 set this variable to if the option is found. An optional forth element PUSH
4615 "Precompute regular expressions for current buffer."
4630 kwds kws0 kwsa key log value cat arch tags const links hw dws
4631 tail sep kws1 prio props drawers)
4655 links)))
4661 props)))
4668 l var val)
4683 )))
4697 ;; Process the TODO keywords
4699 ;; Use the global values as if they had been given locally.
4710 kwsa nil
4713 ;; 1 2
4721 kw)
4723 kws0)
4740 ;; Process the constants
4748 ;; Process the tags.
4758 tgs))
4766 ;; Compute the regular expressions and other local variables
4771 org-drawer-regexp
4775 org-not-done-keywords
4777 org-todo-regexp
4780 org-not-done-regexp
4784 org-todo-line-regexp
4788 org-complex-heading-regexp
4793 org-nl-done-regexp
4797 org-todo-line-tags-regexp
4802 org-looking-at-done-regexp
4807 org-deadline-time-regexp
4809 org-deadline-line-regexp
4811 org-scheduled-regexp
4813 org-scheduled-time-regexp
4815 org-closed-time-regexp
4817 org-keyword-time-regexp
4823 org-keyword-time-not-clock-regexp
4829 org-maybe-keyword-time-regexp
4835 org-planning-or-clock-line-re
4840 )
4845 "Extract the log state setting from a TODO keyword string.
4859 "Remove a pair of parenthesis at the end of each string in LIST."
4863 x))
4864 list))
4866 ;; FIXME: this could be done much better, using second characters etc.
4868 "Assign fast keys to a keyword-key alist.
4869 Respect keys that are already there."
4879 ;; automatically assign a character.
4891 ;;; Some variables ujsed in various places
4896 "Function to be called when `C-c C-c' is used.
4900 ;; FIXME: Occasionally check by commenting these, to make sure
4901 ;; no other functions uses these, forgetting to let-bind them.
4908 ;; Defined somewhere in this file, but used before definition.
4921 ;;;; Emacs/XEmacs compatibility
4923 ;; Overlay compatibility functions
4941 "Make overlay OVL display TEXT with face FACE."
4951 "Make overlay OVL display TEXT with face FACE."
4974 "Find all overlays specifying PROP at POS or point.
4975 If DELETE is non-nil, delete all those overlays."
4977 ov found)
4981 found))
4983 ;; Region compatibility
4986 "Add-hook, compatible with both Emacsen."
4995 "Is `transient-mark-mode' on and the region active?
4996 Works on both Emacs and XEmacs."
4998 nil
5005 ;; Invisibility compatibility
5008 "Add elements to `buffer-invisibility-spec'.
5009 See documentation for `buffer-invisibility-spec' for the kind of elements
5010 that can be added."
5021 "Remove elements from `buffer-invisibility-spec'."
5029 "Is ARG a member of `buffer-invisibility-spec'?"
5032 nil))
5034 ;;;; Define the Org-mode
5037 (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."))
5040 ;; We use a before-change function to check if a table might need
5041 ;; an update.
5043 "Indicates that a table might need an update.
5044 This variable is set by `org-before-change-function'.
5053 ;;;###autoload
5055 "Outline-based notes management and organizer, alias
5058 Org-mode develops organizational tasks around a NOTES file which
5059 contains information about projects as plain text. Org-mode is
5060 implemented on top of outline-mode, which is ideal to keep the content
5061 of large files well structured. It supports ToDo items, deadlines and
5062 time stamps, which magically appear in the diary listing of the Emacs
5063 calendar. Tables are easily created with a built-in table editor.
5064 Plain text URL-like links connect to websites, emails (VM), Usenet
5065 messages (Gnus), BBDB entries, and any files related to the project.
5066 For printing and sharing of notes, an Org-mode file (or a part of it)
5067 can be exported as a structured ASCII or HTML file.
5069 The following commands are available:
5073 ;; Get rid of Outline menus, they are not needed
5074 ;; Need to do this here because define-derived-mode sets up
5075 ;; the keymap so late. Still, it is a waste to call this each time
5076 ;; we switch another buffer into org-mode.
5079 ;; Assume this is Greg's port, it used easymenu
5102 org-display-table 4
5105 org-ellipsis)))
5109 ;; Calc embedded
5116 ;; Activate before-change-function
5120 ;; Check for running clock before killing a buffer
5122 ;; Paragraphs and auto-filling
5127 ;; Comment characters
5128 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
5131 ;; Align options lines
5133 'align-mode-rules-list
5138 ;; Imenu
5142 ;; Make isearch reveal context
5145 ;; Emacs 21 and XEmacs make use of the hook
5147 ;; Emacs 22 deals with this through a special variable
5151 ;; If empty file that did not turn on org-mode automatically, make it to.
5173 "Call COMMAND interactively, but pretend prefix are was ARG."
5179 ;; works also in narrowed buffer, because we start at 1, not point-min
5183 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5193 "Add text properties to entire string, from beginning to end.
5194 PLIST may be a list of properties, PROPS are individual properties and values
5195 that will be added to PLIST. Returns the string that was modified."
5198 string)
5202 ;;;; Font-Lock stuff, including the activators
5207 (org-defkey org-mouse-map
5208 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5209 (when org-mouse-1-follows-link
5210 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5211 (when org-tab-follows-link
5212 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5213 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5214 (when org-return-follows-link
5215 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5216 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5218 (require 'font-lock)
5221 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5222 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5223 (defvar org-link-re-with-space nil
5224 "Matches a link with spaces, optional angular brackets around it.")
5225 (defvar org-link-re-with-space2 nil
5226 "Matches a link with spaces, optional angular brackets around it.")
5227 (defvar org-angle-link-re nil
5228 "Matches link with angular brackets, spaces are allowed.")
5229 (defvar org-plain-link-re nil
5230 "Matches plain link, without spaces.")
5231 (defvar org-bracket-link-regexp nil
5232 "Matches a link in double brackets.")
5233 (defvar org-bracket-link-analytic-regexp nil
5234 "Regular expression used to analyze links.
5235 Here is what the match groups contain after a match:
5236 1: http:
5237 2: http
5238 3: path
5239 4: [desc]
5240 5: desc")
5241 (defvar org-any-link-re nil
5242 "Regular expression matching any link.")
5244 (defun org-make-link-regexps ()
5245 "Update the link regular expressions.
5246 This should be called after the variable `org-link-types' has changed."
5247 (setq org-link-re-with-space
5248 (concat
5251 "[^" org-non-link-chars "]*"
5253 org-link-re-with-space2
5254 (concat
5259 org-angle-link-re
5260 (concat
5263 "[^" org-non-link-chars "]*"
5265 org-plain-link-re
5266 (concat
5269 org-bracket-link-regexp
5271 org-bracket-link-analytic-regexp
5272 (concat
5279 org-any-link-re
5284 (org-make-link-regexps)
5287 "Regular expression for fast time stamp matching.")
5289 "Regular expression for fast time stamp matching.")
5290 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5291 "Regular expression matching time strings for analysis.
5292 This one does not require the space after the date.")
5293 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5294 "Regular expression matching time strings for analysis.")
5296 "Regular expression matching time stamps, with groups.")
5298 "Regular expression matching time stamps (also [..]), with groups.")
5299 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5300 "Regular expression matching a time stamp range.")
5301 (defconst org-tr-regexp-both
5302 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5303 "Regular expression matching a time stamp range.")
5306 "Regular expression matching a time stamp or time stamp range.")
5309 "Regular expression matching a time stamp or time stamp range.
5310 The time stamps may be either active or inactive.")
5312 (defvar org-emph-face nil)
5314 (defun org-do-emphasis-faces (limit)
5315 "Run through the buffer and add overlays to links."
5316 (let (rtn)
5317 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5318 (if (not (= (char-after (match-beginning 3))
5319 (char-after (match-beginning 4))))
5320 (progn
5321 (setq rtn t)
5322 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5323 'face
5324 (nth 1 (assoc (match-string 3)
5325 org-emphasis-alist)))
5326 (add-text-properties (match-beginning 2) (match-end 2)
5327 '(font-lock-multiline t))
5328 (when org-hide-emphasis-markers
5329 (add-text-properties (match-end 4) (match-beginning 5)
5330 '(invisible org-link))
5331 (add-text-properties (match-beginning 3) (match-end 3)
5332 '(invisible org-link)))))
5333 (backward-char 1))
5334 rtn))
5336 (defun org-emphasize (&optional char)
5337 "Insert or change an emphasis, i.e. a font like bold or italic.
5338 If there is an active region, change that region to a new emphasis.
5339 If there is no region, just insert the marker characters and position
5340 the cursor between them.
5341 CHAR should be either the marker character, or the first character of the
5342 HTML tag associated with that emphasis. If CHAR is a space, the means
5343 to remove the emphasis of the selected region.
5344 If char is not given (for example in an interactive call) it
5345 will be prompted for."
5346 (interactive)
5347 (let ((eal org-emphasis-alist) e det
5348 (erc org-emphasis-regexp-components)
5349 (prompt "")
5350 (string "") beg end move tag c s)
5351 (if (org-region-active-p)
5352 (setq beg (region-beginning) end (region-end)
5353 string (buffer-substring beg end))
5354 (setq move t))
5356 (while (setq e (pop eal))
5357 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5358 c (aref tag 0))
5359 (push (cons c (string-to-char (car e))) det)
5360 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5361 (substring tag 1)))))
5362 (unless char
5363 (message "%s" (concat "Emphasis marker or tag:" prompt))
5364 (setq char (read-char-exclusive)))
5365 (setq char (or (cdr (assoc char det)) char))
5366 (if (equal char ?\ )
5367 (setq s "" move nil)
5368 (unless (assoc (char-to-string char) org-emphasis-alist)
5370 (setq s (char-to-string char)))
5371 (while (and (> (length string) 1)
5372 (equal (substring string 0 1) (substring string -1))
5373 (assoc (substring string 0 1) org-emphasis-alist))
5374 (setq string (substring string 1 -1)))
5375 (setq string (concat s string s))
5376 (if beg (delete-region beg end))
5377 (unless (or (bolp)
5379 (char-to-string (char-before (point)))))
5380 (insert " "))
5382 (char-to-string (char-after (point))))
5383 (insert " ") (backward-char 1))
5384 (insert string)
5385 (and move (backward-char 1))))
5387 (defconst org-nonsticky-props
5388 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5391 (defun org-activate-plain-links (limit)
5392 "Run through the buffer and add overlays to links."
5393 (catch 'exit
5394 (let (f)
5395 (while (re-search-forward org-plain-link-re limit t)
5396 (setq f (get-text-property (match-beginning 0) 'face))
5397 (if (or (eq f 'org-tag)
5398 (and (listp f) (memq 'org-tag f)))
5399 nil
5400 (add-text-properties (match-beginning 0) (match-end 0)
5401 (list 'mouse-face 'highlight
5402 'rear-nonsticky org-nonsticky-props
5403 'keymap org-mouse-map
5404 ))
5405 (throw 'exit t))))))
5407 (defun org-activate-code (limit)
5409 (unless (get-text-property (match-beginning 1) 'face)
5410 (remove-text-properties (match-beginning 0) (match-end 0)
5411 '(display t invisible t intangible t))
5412 t)))
5414 (defun org-activate-angle-links (limit)
5415 "Run through the buffer and add overlays to links."
5416 (if (re-search-forward org-angle-link-re limit t)
5417 (progn
5418 (add-text-properties (match-beginning 0) (match-end 0)
5419 (list 'mouse-face 'highlight
5420 'rear-nonsticky org-nonsticky-props
5421 'keymap org-mouse-map
5422 ))
5423 t)))
5425 (defmacro org-maybe-intangible (props)
5426 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5427 In emacs 21, invisible text is not avoided by the command loop, so the
5428 intangible property is needed to make sure point skips this text.
5429 In Emacs 22, this is not necessary. The intangible text property has
5430 led to problems with flyspell. These problems are fixed in flyspell.el,
5431 but we still avoid setting the property in Emacs 22 and later.
5432 We use a macro so that the test can happen at compilation time."
5433 (if (< emacs-major-version 22)
5434 `(append '(intangible t) ,props)
5435 props))
5437 (defun org-activate-bracket-links (limit)
5438 "Run through the buffer and add overlays to bracketed links."
5439 (if (re-search-forward org-bracket-link-regexp limit t)
5440 (let* ((help (concat "LINK: "
5441 (org-match-string-no-properties 1)))
5442 ;; FIXME: above we should remove the escapes.
5443 ;; but that requires another match, protecting match data,
5444 ;; a lot of overhead for font-lock.
5445 (ip (org-maybe-intangible
5446 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5447 'keymap org-mouse-map 'mouse-face 'highlight
5448 'font-lock-multiline t 'help-echo help)))
5449 (vp (list 'rear-nonsticky org-nonsticky-props
5450 'keymap org-mouse-map 'mouse-face 'highlight
5451 ' font-lock-multiline t 'help-echo help)))
5452 ;; We need to remove the invisible property here. Table narrowing
5453 ;; may have made some of this invisible.
5454 (remove-text-properties (match-beginning 0) (match-end 0)
5455 '(invisible nil))
5456 (if (match-end 3)
5457 (progn
5458 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5459 (add-text-properties (match-beginning 3) (match-end 3) vp)
5460 (add-text-properties (match-end 3) (match-end 0) ip))
5461 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5462 (add-text-properties (match-beginning 1) (match-end 1) vp)
5463 (add-text-properties (match-end 1) (match-end 0) ip))
5464 t)))
5466 (defun org-activate-dates (limit)
5467 "Run through the buffer and add overlays to dates."
5468 (if (re-search-forward org-tsr-regexp-both limit t)
5469 (progn
5470 (add-text-properties (match-beginning 0) (match-end 0)
5471 (list 'mouse-face 'highlight
5472 'rear-nonsticky org-nonsticky-props
5473 'keymap org-mouse-map))
5474 (when org-display-custom-times
5475 (if (match-end 3)
5476 (org-display-custom-time (match-beginning 3) (match-end 3)))
5477 (org-display-custom-time (match-beginning 1) (match-end 1)))
5478 t)))
5480 (defvar org-target-link-regexp nil
5481 "Regular expression matching radio targets in plain text.")
5483 "Regular expression matching a link target.")
5485 "Regular expression matching a radio target.")
5486 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5487 "Regular expression matching any target.")
5489 (defun org-activate-target-links (limit)
5490 "Run through the buffer and add overlays to target matches."
5491 (when org-target-link-regexp
5492 (let ((case-fold-search t))
5493 (if (re-search-forward org-target-link-regexp limit t)
5494 (progn
5495 (add-text-properties (match-beginning 0) (match-end 0)
5496 (list 'mouse-face 'highlight
5497 'rear-nonsticky org-nonsticky-props
5498 'keymap org-mouse-map
5499 'help-echo "Radio target link"
5500 'org-linked-text t))
5501 t)))))
5503 (defun org-update-radio-target-regexp ()
5504 "Find all radio targets in this file and update the regular expression."
5505 (interactive)
5506 (when (memq 'radio org-activate-links)
5507 (setq org-target-link-regexp
5508 (org-make-target-link-regexp (org-all-targets 'radio)))
5509 (org-restart-font-lock)))
5511 (defun org-hide-wide-columns (limit)
5512 (let (s e)
5513 (setq s (text-property-any (point) (or limit (point-max))
5514 'org-cwidth t))
5515 (when s
5516 (setq e (next-single-property-change s 'org-cwidth))
5517 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5518 (goto-char e)
5519 t)))
5521 (defvar org-latex-and-specials-regexp nil
5522 "Regular expression for highlighting export special stuff.")
5523 (defvar org-match-substring-regexp)
5524 (defvar org-match-substring-with-braces-regexp)
5525 (defvar org-export-html-special-string-regexps)
5527 (defun org-compute-latex-and-specials-regexp ()
5528 "Compute regular expression for stuff treated specially by exporters."
5529 (if (not org-highlight-latex-fragments-and-specials)
5530 (org-set-local 'org-latex-and-specials-regexp nil)
5531 (let*
5532 ((matchers (plist-get org-format-latex-options :matchers))
5533 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5534 org-latex-regexps)))
5535 (options (org-combine-plists (org-default-export-plist)
5536 (org-infile-export-plist)))
5537 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5538 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5539 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5540 (org-export-html-expand (plist-get options :expand-quoted-html))
5541 (org-export-with-special-strings (plist-get options :special-strings))
5542 (re-sub
5543 (cond
5544 ((equal org-export-with-sub-superscripts '{})
5545 (list org-match-substring-with-braces-regexp))
5546 (org-export-with-sub-superscripts
5547 (list org-match-substring-regexp))
5548 (t nil)))
5549 (re-latex
5550 (if org-export-with-LaTeX-fragments
5551 (mapcar (lambda (x) (nth 1 x)) latexs)))
5552 (re-macros
5553 (if org-export-with-TeX-macros
5555 (regexp-opt
5556 (append (mapcar 'car org-html-entities)
5557 (if (boundp 'org-latex-entities)
5558 org-latex-entities nil))
5559 'words))) ; FIXME
5560 ))
5562 (re-special (if org-export-with-special-strings
5563 (mapcar (lambda (x) (car x))
5564 org-export-html-special-string-regexps)))
5565 (re-rest
5566 (delq nil
5567 (list
5569 ))))
5570 (org-set-local
5571 'org-latex-and-specials-regexp
5572 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5575 (defface org-latex-and-export-specials
5576 (let ((font (cond ((assq :inherit custom-face-attributes)
5577 '(:inherit underline))
5578 (t '(:underline t)))))
5579 `((((class grayscale) (background light))
5580 (:foreground "DimGray" ,@font))
5581 (((class grayscale) (background dark))
5582 (:foreground "LightGray" ,@font))
5583 (((class color) (background light))
5584 (:foreground "SaddleBrown"))
5585 (((class color) (background dark))
5586 (:foreground "burlywood"))
5587 (t (,@font))))
5588 "Face used to highlight math latex and other special exporter stuff."
5589 :group 'org-faces)
5591 (defun org-do-latex-and-special-faces (limit)
5592 "Run through the buffer and add overlays to links."
5593 (when org-latex-and-specials-regexp
5594 (let (rtn d)
5595 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5596 limit t))
5597 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5598 'face))
5599 '(org-code org-verbatim underline)))
5600 (progn
5601 (setq rtn t
5602 d (cond ((member (char-after (1+ (match-beginning 0)))
5603 '(?_ ?^)) 1)
5604 (t 0)))
5605 (font-lock-prepend-text-property
5606 (+ d (match-beginning 0)) (match-end 0)
5607 'face 'org-latex-and-export-specials)
5608 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5609 '(font-lock-multiline t)))))
5610 rtn)))
5612 (defun org-restart-font-lock ()
5613 "Restart font-lock-mode, to force refontification."
5614 (when (and (boundp 'font-lock-mode) font-lock-mode)
5615 (font-lock-mode -1)
5616 (font-lock-mode 1)))
5618 (defun org-all-targets (&optional radio)
5619 "Return a list of all targets in this file.
5620 With optional argument RADIO, only find radio targets."
5621 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5622 rtn)
5623 (save-excursion
5624 (goto-char (point-min))
5625 (while (re-search-forward re nil t)
5626 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5627 rtn)))
5629 (defun org-make-target-link-regexp (targets)
5630 "Make regular expression matching all strings in TARGETS.
5631 The regular expression finds the targets also if there is a line break
5632 between words."
5633 (and targets
5634 (concat
5636 (mapconcat
5637 (lambda (x)
5638 (while (string-match " +" x)
5640 x)
5641 targets
5645 (defun org-activate-tags (limit)
5647 (progn
5648 (add-text-properties (match-beginning 1) (match-end 1)
5649 (list 'mouse-face 'highlight
5650 'rear-nonsticky org-nonsticky-props
5651 'keymap org-mouse-map))
5652 t)))
5654 (defun org-outline-level ()
5655 (save-excursion
5656 (looking-at outline-regexp)
5657 (if (match-beginning 1)
5658 (+ (org-get-string-indentation (match-string 1)) 1000)
5659 (1- (- (match-end 0) (match-beginning 0))))))
5661 (defvar org-font-lock-keywords nil)
5664 "Regular expression matching a property line.")
5666 (defun org-set-font-lock-defaults ()
5667 (let* ((em org-fontify-emphasized-text)
5668 (lk org-activate-links)
5669 (org-font-lock-extra-keywords
5670 (list
5671 ;; Headlines
5673 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5674 ;; Table lines
5676 (1 'org-table t))
5677 ;; Table internals
5681 ;; Drawers
5682 (list org-drawer-regexp '(0 'org-special-keyword t))
5684 ;; Properties
5685 (list org-property-re
5686 '(1 'org-special-keyword t)
5687 '(3 'org-property-value t))
5688 (if org-format-transports-properties-p
5690 ;; Links
5691 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5692 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5693 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5694 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5695 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5696 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5698 '(org-hide-wide-columns (0 nil append))
5699 ;; TODO lines
5701 '(1 (org-get-todo-face 1) t))
5702 ;; DONE
5703 (if org-fontify-done-headline
5707 '(2 'org-headline-done t))
5708 nil)
5709 ;; Priorities
5711 ;; Special keywords
5716 ;; Emphasis
5717 (if em
5718 (if (featurep 'xemacs)
5719 '(org-do-emphasis-faces (0 nil append))
5720 '(org-do-emphasis-faces)))
5721 ;; Checkboxes
5723 2 'bold prepend)
5724 (if org-provide-checkbox-statistics
5726 (0 (org-get-checkbox-statistics-face) t)))
5728 '(1 'org-archived prepend))
5729 ;; Specials
5730 '(org-do-latex-and-special-faces)
5731 ;; Code
5732 '(org-activate-code (1 'org-code t))
5733 ;; COMMENT
5736 '(1 'org-special-keyword t))
5737 '("^#.*" (0 'font-lock-comment-face t))
5738 )))
5739 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5740 ;; Now set the full font-lock-keywords
5741 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5742 (org-set-local 'font-lock-defaults
5743 '(org-font-lock-keywords t nil nil backward-paragraph))
5744 (kill-local-variable 'font-lock-keywords) nil))
5746 (defvar org-m nil)
5747 (defvar org-l nil)
5748 (defvar org-f nil)
5749 (defun org-get-level-face (n)
5750 "Get the right face for match N in font-lock matching of healdines."
5751 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5752 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5753 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5754 (cond
5755 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5756 ((eq n 2) org-f)
5757 (t (if org-level-color-stars-only nil org-f))))
5759 (defun org-get-todo-face (kwd)
5760 "Get the right face for a TODO keyword KWD.
5761 If KWD is a number, get the corresponding match group."
5762 (if (numberp kwd) (setq kwd (match-string kwd)))
5763 (or (cdr (assoc kwd org-todo-keyword-faces))
5764 (and (member kwd org-done-keywords) 'org-done)
5765 'org-todo))
5767 (defun org-unfontify-region (beg end &optional maybe_loudly)
5768 "Remove fontification and activation overlays from links."
5769 (font-lock-default-unfontify-region beg end)
5770 (let* ((buffer-undo-list t)
5771 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5772 (inhibit-modification-hooks t)
5773 deactivate-mark buffer-file-name buffer-file-truename)
5774 (remove-text-properties beg end
5775 '(mouse-face t keymap t org-linked-text t
5776 invisible t intangible t))))
5778 ;;;; Visibility cycling, including org-goto and indirect buffer
5780 ;;; Cycling
5782 (defvar org-cycle-global-status nil)
5783 (make-variable-buffer-local 'org-cycle-global-status)
5784 (defvar org-cycle-subtree-status nil)
5785 (make-variable-buffer-local 'org-cycle-subtree-status)
5787 ;;;###autoload
5788 (defun org-cycle (&optional arg)
5789 "Visibility cycling for Org-mode.
5791 - When this function is called with a prefix argument, rotate the entire
5792 buffer through 3 states (global cycling)
5793 1. OVERVIEW: Show only top-level headlines.
5794 2. CONTENTS: Show all headlines of all levels, but no body text.
5795 3. SHOW ALL: Show everything.
5797 - When point is at the beginning of a headline, rotate the subtree started
5798 by this line through 3 different states (local cycling)
5799 1. FOLDED: Only the main headline is shown.
5800 2. CHILDREN: The main headline and the direct children are shown.
5801 From this state, you can move to one of the children
5802 and zoom in further.
5803 3. SUBTREE: Show the entire subtree, including body text.
5805 - When there is a numeric prefix, go up to a heading with level ARG, do
5806 a `show-subtree' and return to the previous cursor position. If ARG
5807 is negative, go up that many levels.
5809 - When point is not at the beginning of a headline, execute
5810 `indent-relative', like TAB normally does. See the option
5811 `org-cycle-emulate-tab' for details.
5813 - Special case: if point is at the beginning of the buffer and there is
5814 no headline in line 1, this function will act as if called with prefix arg.
5815 But only if also the variable `org-cycle-global-at-bob' is t."
5816 (interactive "P")
5817 (let* ((outline-regexp
5818 (if (and (org-mode-p) org-cycle-include-plain-lists)
5820 outline-regexp))
5821 (bob-special (and org-cycle-global-at-bob (bobp)
5822 (not (looking-at outline-regexp))))
5823 (org-cycle-hook
5824 (if bob-special
5825 (delq 'org-optimize-window-after-visibility-change
5826 (copy-sequence org-cycle-hook))
5827 org-cycle-hook))
5828 (pos (point)))
5830 (if (or bob-special (equal arg '(4)))
5831 ;; special case: use global cycling
5832 (setq arg t))
5834 (cond
5836 ((org-at-table-p 'any)
5837 ;; Enter the table or move to the next field in the table
5838 (or (org-table-recognize-table.el)
5839 (progn
5840 (if arg (org-table-edit-field t)
5841 (org-table-justify-field-maybe)
5842 (call-interactively 'org-table-next-field)))))
5844 ((eq arg t) ;; Global cycling
5846 (cond
5847 ((and (eq last-command this-command)
5848 (eq org-cycle-global-status 'overview))
5849 ;; We just created the overview - now do table of contents
5850 ;; This can be slow in very large buffers, so indicate action
5851 (message "CONTENTS...")
5852 (org-content)
5853 (message "CONTENTS...done")
5854 (setq org-cycle-global-status 'contents)
5855 (run-hook-with-args 'org-cycle-hook 'contents))
5857 ((and (eq last-command this-command)
5858 (eq org-cycle-global-status 'contents))
5859 ;; We just showed the table of contents - now show everything
5860 (show-all)
5861 (message "SHOW ALL")
5862 (setq org-cycle-global-status 'all)
5863 (run-hook-with-args 'org-cycle-hook 'all))
5865 (t
5866 ;; Default action: go to overview
5867 (org-overview)
5868 (message "OVERVIEW")
5869 (setq org-cycle-global-status 'overview)
5870 (run-hook-with-args 'org-cycle-hook 'overview))))
5872 ((and org-drawers org-drawer-regexp
5873 (save-excursion
5874 (beginning-of-line 1)
5875 (looking-at org-drawer-regexp)))
5876 ;; Toggle block visibility
5877 (org-flag-drawer
5878 (not (get-char-property (match-end 0) 'invisible))))
5880 ((integerp arg)
5881 ;; Show-subtree, ARG levels up from here.
5882 (save-excursion
5883 (org-back-to-heading)
5884 (outline-up-heading (if (< arg 0) (- arg)
5885 (- (funcall outline-level) arg)))
5886 (org-show-subtree)))
5888 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5889 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5890 ;; At a heading: rotate between three different views
5891 (org-back-to-heading)
5892 (let ((goal-column 0) eoh eol eos)
5893 ;; First, some boundaries
5894 (save-excursion
5895 (org-back-to-heading)
5896 (save-excursion
5897 (beginning-of-line 2)
5898 (while (and (not (eobp)) ;; this is like `next-line'
5899 (get-char-property (1- (point)) 'invisible))
5900 (beginning-of-line 2)) (setq eol (point)))
5901 (outline-end-of-heading) (setq eoh (point))
5902 (org-end-of-subtree t)
5903 (unless (eobp)
5905 (beginning-of-line 1) ; in case this is an item
5906 )
5907 (setq eos (1- (point))))
5908 ;; Find out what to do next and set `this-command'
5909 (cond
5910 ((= eos eoh)
5911 ;; Nothing is hidden behind this heading
5912 (message "EMPTY ENTRY")
5913 (setq org-cycle-subtree-status nil)
5914 (save-excursion
5915 (goto-char eos)
5916 (outline-next-heading)
5917 (if (org-invisible-p) (org-flag-heading nil))))
5918 ((or (>= eol eos)
5920 ;; Entire subtree is hidden in one line: open it
5921 (org-show-entry)
5922 (show-children)
5923 (message "CHILDREN")
5924 (save-excursion
5925 (goto-char eos)
5926 (outline-next-heading)
5927 (if (org-invisible-p) (org-flag-heading nil)))
5928 (setq org-cycle-subtree-status 'children)
5929 (run-hook-with-args 'org-cycle-hook 'children))
5930 ((and (eq last-command this-command)
5931 (eq org-cycle-subtree-status 'children))
5932 ;; We just showed the children, now show everything.
5933 (org-show-subtree)
5934 (message "SUBTREE")
5935 (setq org-cycle-subtree-status 'subtree)
5936 (run-hook-with-args 'org-cycle-hook 'subtree))
5937 (t
5938 ;; Default action: hide the subtree.
5939 (hide-subtree)
5940 (message "FOLDED")
5941 (setq org-cycle-subtree-status 'folded)
5942 (run-hook-with-args 'org-cycle-hook 'folded)))))
5944 ;; TAB emulation
5945 (buffer-read-only (org-back-to-heading))
5947 ((org-try-cdlatex-tab))
5949 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5950 (or (not (bolp))
5951 (not (looking-at outline-regexp))))
5954 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5956 (or (and (eq org-cycle-emulate-tab 'white)
5957 (= (match-end 0) (point-at-eol)))
5958 (and (eq org-cycle-emulate-tab 'whitestart)
5959 (>= (match-end 0) pos))))
5960 t
5961 (eq org-cycle-emulate-tab t))
5964 ; (point-at-bol) (point))))
5965 ; (progn
5966 ; (beginning-of-line 1)
5970 (t (save-excursion
5971 (org-back-to-heading)
5972 (org-cycle))))))
5974 ;;;###autoload
5975 (defun org-global-cycle (&optional arg)
5976 "Cycle the global visibility. For details see `org-cycle'."
5977 (interactive "P")
5978 (let ((org-cycle-include-plain-lists
5979 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5980 (if (integerp arg)
5981 (progn
5982 (show-all)
5983 (hide-sublevels arg)
5984 (setq org-cycle-global-status 'contents))
5985 (org-cycle '(4)))))
5987 (defun org-overview ()
5988 "Switch to overview mode, shoing only top-level headlines.
5989 Really, this shows all headlines with level equal or greater than the level
5990 of the first headline in the buffer. This is important, because if the
5991 first headline is not level one, then (hide-sublevels 1) gives confusing
5992 results."
5993 (interactive)
5994 (let ((level (save-excursion
5995 (goto-char (point-min))
5996 (if (re-search-forward (concat "^" outline-regexp) nil t)
5997 (progn
5998 (goto-char (match-beginning 0))
5999 (funcall outline-level))))))
6000 (and level (hide-sublevels level))))
6002 (defun org-content (&optional arg)
6003 "Show all headlines in the buffer, like a table of contents.
6004 With numerical argument N, show content up to level N."
6005 (interactive "P")
6006 (save-excursion
6007 ;; Visit all headings and show their offspring
6008 (and (integerp arg) (org-overview))
6009 (goto-char (point-max))
6010 (catch 'exit
6011 (while (and (progn (condition-case nil
6012 (outline-previous-visible-heading 1)
6013 (error (goto-char (point-min))))
6014 t)
6015 (looking-at outline-regexp))
6016 (if (integerp arg)
6017 (show-children (1- arg))
6018 (show-branches))
6019 (if (bobp) (throw 'exit nil))))))
6022 (defun org-optimize-window-after-visibility-change (state)
6023 "Adjust the window after a change in outline visibility.
6024 This function is the default value of the hook `org-cycle-hook'."
6025 (when (get-buffer-window (current-buffer))
6026 (cond
6027 ; ((eq state 'overview) (org-first-headline-recenter 1))
6028 ; ((eq state 'overview) (org-beginning-of-line))
6029 ((eq state 'content) nil)
6030 ((eq state 'all) nil)
6031 ((eq state 'folded) nil)
6032 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6033 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6035 (defun org-compact-display-after-subtree-move ()
6036 (let (beg end)
6037 (save-excursion
6038 (if (org-up-heading-safe)
6039 (progn
6040 (hide-subtree)
6041 (show-entry)
6042 (show-children)
6043 (org-cycle-show-empty-lines 'children)
6044 (org-cycle-hide-drawers 'children))
6045 (org-overview)))))
6047 (defun org-cycle-show-empty-lines (state)
6048 "Show empty lines above all visible headlines.
6049 The region to be covered depends on STATE when called through
6050 `org-cycle-hook'. Lisp program can use t for STATE to get the
6051 entire buffer covered. Note that an empty line is only shown if there
6052 are at least `org-cycle-separator-lines' empty lines before the headeline."
6053 (when (> org-cycle-separator-lines 0)
6054 (save-excursion
6055 (let* ((n org-cycle-separator-lines)
6056 (re (cond
6059 (t (let ((ns (number-to-string (- n 2))))
6062 beg end)
6063 (cond
6064 ((memq state '(overview contents t))
6065 (setq beg (point-min) end (point-max)))
6066 ((memq state '(children folded))
6067 (setq beg (point) end (progn (org-end-of-subtree t t)
6068 (beginning-of-line 2)
6069 (point)))))
6070 (when beg
6071 (goto-char beg)
6072 (while (re-search-forward re end t)
6073 (if (not (get-char-property (match-end 1) 'invisible))
6074 (outline-flag-region
6075 (match-beginning 1) (match-end 1) nil)))))))
6076 ;; Never hide empty lines at the end of the file.
6077 (save-excursion
6078 (goto-char (point-max))
6079 (outline-previous-heading)
6080 (outline-end-of-heading)
6082 (= (match-end 0) (point-max)))
6083 (outline-flag-region (point) (match-end 0) nil))))
6085 (defun org-subtree-end-visible-p ()
6086 "Is the end of the current subtree visible?"
6087 (pos-visible-in-window-p
6088 (save-excursion (org-end-of-subtree t) (point))))
6090 (defun org-first-headline-recenter (&optional N)
6091 "Move cursor to the first headline and recenter the headline.
6092 Optional argument N means, put the headline into the Nth line of the window."
6093 (goto-char (point-min))
6095 (beginning-of-line)
6096 (recenter (prefix-numeric-value N))))
6098 ;;; Org-goto
6100 (defvar org-goto-window-configuration nil)
6101 (defvar org-goto-marker nil)
6102 (defvar org-goto-map
6103 (let ((map (make-sparse-keymap)))
6104 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6105 (while (setq cmd (pop cmds))
6106 (substitute-key-definition cmd cmd map global-map)))
6107 (suppress-keymap map)
6108 (org-defkey map "\C-m" 'org-goto-ret)
6109 (org-defkey map [(return)] 'org-goto-ret)
6110 (org-defkey map [(left)] 'org-goto-left)
6111 (org-defkey map [(right)] 'org-goto-right)
6112 (org-defkey map [(control ?g)] 'org-goto-quit)
6113 (org-defkey map "\C-i" 'org-cycle)
6114 (org-defkey map [(tab)] 'org-cycle)
6115 (org-defkey map [(down)] 'outline-next-visible-heading)
6116 (org-defkey map [(up)] 'outline-previous-visible-heading)
6117 (if org-goto-auto-isearch
6118 (if (fboundp 'define-key-after)
6119 (define-key-after map [t] 'org-goto-local-auto-isearch)
6120 nil)
6121 (org-defkey map "q" 'org-goto-quit)
6122 (org-defkey map "n" 'outline-next-visible-heading)
6123 (org-defkey map "p" 'outline-previous-visible-heading)
6124 (org-defkey map "f" 'outline-forward-same-level)
6125 (org-defkey map "b" 'outline-backward-same-level)
6126 (org-defkey map "u" 'outline-up-heading))
6127 (org-defkey map "/" 'org-occur)
6128 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6129 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6130 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6131 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6132 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6133 map))
6135 (defconst org-goto-help
6136 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6137 RET=jump to location [Q]uit and return to previous location
6138 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6140 (defvar org-goto-start-pos) ; dynamically scoped parameter
6142 (defun org-goto (&optional alternative-interface)
6143 "Look up a different location in the current file, keeping current visibility.
6145 When you want look-up or go to a different location in a document, the
6146 fastest way is often to fold the entire buffer and then dive into the tree.
6147 This method has the disadvantage, that the previous location will be folded,
6148 which may not be what you want.
6150 This command works around this by showing a copy of the current buffer
6151 in an indirect buffer, in overview mode. You can dive into the tree in
6152 that copy, use org-occur and incremental search to find a location.
6153 When pressing RET or `Q', the command returns to the original buffer in
6154 which the visibility is still unchanged. After RET is will also jump to
6155 the location selected in the indirect buffer and expose the
6156 the headline hierarchy above."
6157 (interactive "P")
6158 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
6159 (org-refile-use-outline-path t)
6160 (interface
6161 (if (not alternative-interface)
6162 org-goto-interface
6163 (if (eq org-goto-interface 'outline)
6164 'outline-path-completion
6165 'outline)))
6166 (org-goto-start-pos (point))
6167 (selected-point
6168 (if (eq interface 'outline)
6169 (car (org-get-location (current-buffer) org-goto-help))
6170 (nth 3 (org-refile-get-location "Goto: ")))))
6171 (if selected-point
6172 (progn
6173 (org-mark-ring-push org-goto-start-pos)
6174 (goto-char selected-point)
6175 (if (or (org-invisible-p) (org-invisible-p2))
6176 (org-show-context 'org-goto)))
6177 (message "Quit"))))
6179 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6180 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6181 (defvar org-goto-local-auto-isearch-map) ; defined below
6183 (defun org-get-location (buf help)
6184 "Let the user select a location in the Org-mode buffer BUF.
6185 This function uses a recursive edit. It returns the selected position
6186 or nil."
6187 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6188 (isearch-hide-immediately nil)
6189 (isearch-search-fun-function
6190 (lambda () 'org-goto-local-search-forward-headings))
6191 (org-goto-selected-point org-goto-exit-command))
6192 (save-excursion
6193 (save-window-excursion
6194 (delete-other-windows)
6195 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6196 (switch-to-buffer
6197 (condition-case nil
6198 (make-indirect-buffer (current-buffer) "*org-goto*")
6199 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6200 (with-output-to-temp-buffer "*Help*"
6201 (princ help))
6202 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6203 (setq buffer-read-only nil)
6204 (let ((org-startup-truncated t)
6205 (org-startup-folded nil)
6206 (org-startup-align-all-tables nil))
6207 (org-mode)
6208 (org-overview))
6209 (setq buffer-read-only t)
6210 (if (and (boundp 'org-goto-start-pos)
6211 (integer-or-marker-p org-goto-start-pos))
6212 (let ((org-show-hierarchy-above t)
6213 (org-show-siblings t)
6214 (org-show-following-heading t))
6215 (goto-char org-goto-start-pos)
6216 (and (org-invisible-p) (org-show-context)))
6217 (goto-char (point-min)))
6218 (org-beginning-of-line)
6219 (message "Select location and press RET")
6220 (use-local-map org-goto-map)
6221 (recursive-edit)
6222 ))
6223 (kill-buffer "*org-goto*")
6224 (cons org-goto-selected-point org-goto-exit-command)))
6226 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6227 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6228 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6229 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6231 (defun org-goto-local-search-forward-headings (string bound noerror)
6232 "Search and make sure that anu matches are in headlines."
6233 (catch 'return
6234 (while (search-forward string bound noerror)
6235 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6236 (and (member :headline context)
6237 (not (member :tags context))))
6238 (throw 'return (point))))))
6240 (defun org-goto-local-auto-isearch ()
6241 "Start isearch."
6242 (interactive)
6243 (goto-char (point-min))
6244 (let ((keys (this-command-keys)))
6245 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6246 (isearch-mode t)
6247 (isearch-process-search-char (string-to-char keys)))))
6249 (defun org-goto-ret (&optional arg)
6250 "Finish `org-goto' by going to the new location."
6251 (interactive "P")
6252 (setq org-goto-selected-point (point)
6253 org-goto-exit-command 'return)
6254 (throw 'exit nil))
6256 (defun org-goto-left ()
6257 "Finish `org-goto' by going to the new location."
6258 (interactive)
6259 (if (org-on-heading-p)
6260 (progn
6261 (beginning-of-line 1)
6262 (setq org-goto-selected-point (point)
6263 org-goto-exit-command 'left)
6264 (throw 'exit nil))
6265 (error "Not on a heading")))
6267 (defun org-goto-right ()
6268 "Finish `org-goto' by going to the new location."
6269 (interactive)
6270 (if (org-on-heading-p)
6271 (progn
6272 (setq org-goto-selected-point (point)
6273 org-goto-exit-command 'right)
6274 (throw 'exit nil))
6275 (error "Not on a heading")))
6277 (defun org-goto-quit ()
6278 "Finish `org-goto' without cursor motion."
6279 (interactive)
6280 (setq org-goto-selected-point nil)
6281 (setq org-goto-exit-command 'quit)
6282 (throw 'exit nil))
6284 ;;; Indirect buffer display of subtrees
6286 (defvar org-indirect-dedicated-frame nil
6287 "This is the frame being used for indirect tree display.")
6288 (defvar org-last-indirect-buffer nil)
6290 (defun org-tree-to-indirect-buffer (&optional arg)
6291 "Create indirect buffer and narrow it to current subtree.
6292 With numerical prefix ARG, go up to this level and then take that tree.
6293 If ARG is negative, go up that many levels.
6294 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6295 indirect buffer previously made with this command, to avoid proliferation of
6296 indirect buffers. However, when you call the command with a `C-u' prefix, or
6297 when `org-indirect-buffer-display' is `new-frame', the last buffer
6298 is kept so that you can work with several indirect buffers at the same time.
6299 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6300 requests that a new frame be made for the new buffer, so that the dedicated
6301 frame is not changed."
6302 (interactive "P")
6303 (let ((cbuf (current-buffer))
6304 (cwin (selected-window))
6305 (pos (point))
6306 beg end level heading ibuf)
6307 (save-excursion
6308 (org-back-to-heading t)
6309 (when (numberp arg)
6310 (setq level (org-outline-level))
6311 (if (< arg 0) (setq arg (+ level arg)))
6312 (while (> (setq level (org-outline-level)) arg)
6313 (outline-up-heading 1 t)))
6314 (setq beg (point)
6315 heading (org-get-heading))
6316 (org-end-of-subtree t) (setq end (point)))
6317 (if (and (buffer-live-p org-last-indirect-buffer)
6318 (not (eq org-indirect-buffer-display 'new-frame))
6319 (not arg))
6320 (kill-buffer org-last-indirect-buffer))
6321 (setq ibuf (org-get-indirect-buffer cbuf)
6322 org-last-indirect-buffer ibuf)
6323 (cond
6324 ((or (eq org-indirect-buffer-display 'new-frame)
6325 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6326 (select-frame (make-frame))
6327 (delete-other-windows)
6328 (switch-to-buffer ibuf)
6329 (org-set-frame-title heading))
6330 ((eq org-indirect-buffer-display 'dedicated-frame)
6331 (raise-frame
6332 (select-frame (or (and org-indirect-dedicated-frame
6333 (frame-live-p org-indirect-dedicated-frame)
6334 org-indirect-dedicated-frame)
6335 (setq org-indirect-dedicated-frame (make-frame)))))
6336 (delete-other-windows)
6337 (switch-to-buffer ibuf)
6338 (org-set-frame-title (concat "Indirect: " heading)))
6339 ((eq org-indirect-buffer-display 'current-window)
6340 (switch-to-buffer ibuf))
6341 ((eq org-indirect-buffer-display 'other-window)
6342 (pop-to-buffer ibuf))
6343 (t (error "Invalid value.")))
6344 (if (featurep 'xemacs)
6345 (save-excursion (org-mode) (turn-on-font-lock)))
6346 (narrow-to-region beg end)
6347 (show-all)
6348 (goto-char pos)
6349 (and (window-live-p cwin) (select-window cwin))))
6351 (defun org-get-indirect-buffer (&optional buffer)
6352 (setq buffer (or buffer (current-buffer)))
6353 (let ((n 1) (base (buffer-name buffer)) bname)
6354 (while (buffer-live-p
6355 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6356 (setq n (1+ n)))
6357 (condition-case nil
6358 (make-indirect-buffer buffer bname 'clone)
6359 (error (make-indirect-buffer buffer bname)))))
6361 (defun org-set-frame-title (title)
6362 "Set the title of the current frame to the string TITLE."
6363 ;; FIXME: how to name a single frame in XEmacs???
6364 (unless (featurep 'xemacs)
6365 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6367 ;;;; Structure editing
6369 ;;; Inserting headlines
6371 (defun org-insert-heading (&optional force-heading)
6372 "Insert a new heading or item with same depth at point.
6373 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6374 If point is at the beginning of a headline, insert a sibling before the
6375 current headline. If point is not at the beginning, do not split the line,
6376 but create the new hedline after the current line."
6377 (interactive "P")
6378 (if (= (buffer-size) 0)
6380 (when (or force-heading (not (org-insert-item)))
6381 (let* ((head (save-excursion
6382 (condition-case nil
6383 (progn
6384 (org-back-to-heading)
6385 (match-string 0))
6386 (error "*"))))
6387 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6388 pos)
6389 (cond
6390 ((and (org-on-heading-p) (bolp)
6391 (or (bobp)
6392 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6393 ;; insert before the current line
6394 (open-line (if blank 2 1)))
6395 ((and (bolp)
6396 (or (bobp)
6397 (save-excursion
6398 (backward-char 1) (not (org-invisible-p)))))
6399 ;; insert right here
6400 nil)
6401 (t
6402 ; ;; in the middle of the line
6403 ; (org-show-entry)
6404 ; (if (org-get-alist-option org-M-RET-may-split-line 'headline)
6405 ; (if (and
6406 ; (org-on-heading-p)
6408 ; ;; protect the tags
6409 ;; (let ((tags (match-string 2)) pos)
6410 ; (delete-region (match-beginning 1) (match-end 1))
6411 ; (setq pos (point-at-bol))
6412 ; (newline (if blank 2 1))
6413 ; (save-excursion
6414 ; (goto-char pos)
6415 ; (end-of-line 1)
6416 ; (insert " " tags)
6417 ; (org-set-tags nil 'align)))
6418 ; (newline (if blank 2 1)))
6419 ; (newline (if blank 2 1))))
6422 ;; in the middle of the line
6423 (org-show-entry)
6424 (let ((split
6425 (org-get-alist-option org-M-RET-may-split-line 'headline))
6426 tags pos)
6427 (if (org-on-heading-p)
6428 (progn
6430 (setq tags (and (match-end 2) (match-string 2)))
6431 (and (match-end 1)
6432 (delete-region (match-beginning 1) (match-end 1)))
6433 (setq pos (point-at-bol))
6434 (or split (end-of-line 1))
6435 (delete-horizontal-space)
6436 (newline (if blank 2 1))
6437 (when tags
6438 (save-excursion
6439 (goto-char pos)
6440 (end-of-line 1)
6441 (insert " " tags)
6442 (org-set-tags nil 'align))))
6443 (or split (end-of-line 1))
6444 (newline (if blank 2 1))))))
6445 (insert head) (just-one-space)
6446 (setq pos (point))
6447 (end-of-line 1)
6448 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6449 (run-hooks 'org-insert-heading-hook)))))
6451 (defun org-insert-heading-after-current ()
6452 "Insert a new heading with same level as current, after current subtree."
6453 (interactive)
6454 (org-back-to-heading)
6455 (org-insert-heading)
6456 (org-move-subtree-down)
6457 (end-of-line 1))
6459 (defun org-insert-todo-heading (arg)
6460 "Insert a new heading with the same level and TODO state as current heading.
6461 If the heading has no TODO state, or if the state is DONE, use the first
6462 state (TODO by default). Also with prefix arg, force first state."
6463 (interactive "P")
6464 (when (not (org-insert-item 'checkbox))
6465 (org-insert-heading)
6466 (save-excursion
6467 (org-back-to-heading)
6468 (outline-previous-heading)
6469 (looking-at org-todo-line-regexp))
6470 (if (or arg
6471 (not (match-beginning 2))
6472 (member (match-string 2) org-done-keywords))
6473 (insert (car org-todo-keywords-1) " ")
6474 (insert (match-string 2) " "))))
6476 (defun org-insert-subheading (arg)
6477 "Insert a new subheading and demote it.
6478 Works for outline headings and for plain lists alike."
6479 (interactive "P")
6480 (org-insert-heading arg)
6481 (cond
6482 ((org-on-heading-p) (org-do-demote))
6483 ((org-at-item-p) (org-indent-item 1))))
6485 (defun org-insert-todo-subheading (arg)
6486 "Insert a new subheading with TODO keyword or checkbox and demote it.
6487 Works for outline headings and for plain lists alike."
6488 (interactive "P")
6489 (org-insert-todo-heading arg)
6490 (cond
6491 ((org-on-heading-p) (org-do-demote))
6492 ((org-at-item-p) (org-indent-item 1))))
6494 ;;; Promotion and Demotion
6496 (defun org-promote-subtree ()
6497 "Promote the entire subtree.
6498 See also `org-promote'."
6499 (interactive)
6500 (save-excursion
6501 (org-map-tree 'org-promote))
6502 (org-fix-position-after-promote))
6504 (defun org-demote-subtree ()
6505 "Demote the entire subtree. See `org-demote'.
6506 See also `org-promote'."
6507 (interactive)
6508 (save-excursion
6509 (org-map-tree 'org-demote))
6510 (org-fix-position-after-promote))
6513 (defun org-do-promote ()
6514 "Promote the current heading higher up the tree.
6515 If the region is active in `transient-mark-mode', promote all headings
6516 in the region."
6517 (interactive)
6518 (save-excursion
6519 (if (org-region-active-p)
6520 (org-map-region 'org-promote (region-beginning) (region-end))
6521 (org-promote)))
6522 (org-fix-position-after-promote))
6524 (defun org-do-demote ()
6525 "Demote the current heading lower down the tree.
6526 If the region is active in `transient-mark-mode', demote all headings
6527 in the region."
6528 (interactive)
6529 (save-excursion
6530 (if (org-region-active-p)
6531 (org-map-region 'org-demote (region-beginning) (region-end))
6532 (org-demote)))
6533 (org-fix-position-after-promote))
6535 (defun org-fix-position-after-promote ()
6536 "Make sure that after pro/demotion cursor position is right."
6537 (let ((pos (point)))
6538 (when (save-excursion
6539 (beginning-of-line 1)
6540 (looking-at org-todo-line-regexp)
6541 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6542 (cond ((eobp) (insert " "))
6543 ((eolp) (insert " "))
6544 ((equal (char-after) ?\ ) (forward-char 1))))))
6546 (defun org-reduced-level (l)
6547 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6549 (defun org-get-legal-level (level &optional change)
6550 "Rectify a level change under the influence of `org-odd-levels-only'
6551 LEVEL is a current level, CHANGE is by how much the level should be
6552 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6553 even level numbers will become the next higher odd number."
6554 (if org-odd-levels-only
6555 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6556 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6557 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6558 (max 1 (+ level change))))
6560 (defun org-promote ()
6561 "Promote the current heading higher up the tree.
6562 If the region is active in `transient-mark-mode', promote all headings
6563 in the region."
6564 (org-back-to-heading t)
6565 (let* ((level (save-match-data (funcall outline-level)))
6566 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6567 (diff (abs (- level (length up-head) -1))))
6568 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6569 (replace-match up-head nil t)
6570 ;; Fixup tag positioning
6571 (and org-auto-align-tags (org-set-tags nil t))
6572 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6574 (defun org-demote ()
6575 "Demote the current heading lower down the tree.
6576 If the region is active in `transient-mark-mode', demote all headings
6577 in the region."
6578 (org-back-to-heading t)
6579 (let* ((level (save-match-data (funcall outline-level)))
6580 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6581 (diff (abs (- level (length down-head) -1))))
6582 (replace-match down-head nil t)
6583 ;; Fixup tag positioning
6584 (and org-auto-align-tags (org-set-tags nil t))
6585 (if org-adapt-indentation (org-fixup-indentation diff))))
6587 (defun org-map-tree (fun)
6588 "Call FUN for every heading underneath the current one."
6589 (org-back-to-heading)
6590 (let ((level (funcall outline-level)))
6591 (save-excursion
6592 (funcall fun)
6593 (while (and (progn
6594 (outline-next-heading)
6595 (> (funcall outline-level) level))
6596 (not (eobp)))
6597 (funcall fun)))))
6599 (defun org-map-region (fun beg end)
6600 "Call FUN for every heading between BEG and END."
6601 (let ((org-ignore-region t))
6602 (save-excursion
6603 (setq end (copy-marker end))
6604 (goto-char beg)
6605 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6606 (< (point) end))
6607 (funcall fun))
6608 (while (and (progn
6609 (outline-next-heading)
6610 (< (point) end))
6611 (not (eobp)))
6612 (funcall fun)))))
6614 (defun org-fixup-indentation (diff)
6615 "Change the indentation in the current entry by DIFF
6616 However, if any line in the current entry has no indentation, or if it
6617 would end up with no indentation after the change, nothing at all is done."
6618 (save-excursion
6619 (let ((end (save-excursion (outline-next-heading)
6620 (point-marker)))
6621 (prohibit (if (> diff 0)
6624 col)
6625 (unless (save-excursion (end-of-line 1)
6626 (re-search-forward prohibit end t))
6627 (while (and (< (point) end)
6629 (goto-char (match-end 0))
6630 (setq col (current-column))
6631 (if (< diff 0) (replace-match ""))
6632 (indent-to (+ diff col))))
6633 (move-marker end nil))))
6635 (defun org-convert-to-odd-levels ()
6636 "Convert an org-mode file with all levels allowed to one with odd levels.
6637 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6638 level 5 etc."
6639 (interactive)
6640 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6641 (let ((org-odd-levels-only nil) n)
6642 (save-excursion
6643 (goto-char (point-min))
6645 (setq n (- (length (match-string 0)) 2))
6646 (while (>= (setq n (1- n)) 0)
6647 (org-demote))
6648 (end-of-line 1))))))
6651 (defun org-convert-to-oddeven-levels ()
6652 "Convert an org-mode file with only odd levels to one with odd and even levels.
6653 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6654 section with an even level, conversion would destroy the structure of the file. An error
6655 is signaled in this case."
6656 (interactive)
6657 (goto-char (point-min))
6658 ;; First check if there are no even levels
6660 (org-show-context t)
6661 (error "Not all levels are odd in this file. Conversion not possible."))
6662 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6663 (let ((org-odd-levels-only nil) n)
6664 (save-excursion
6665 (goto-char (point-min))
6667 (setq n (/ (1- (length (match-string 0))) 2))
6668 (while (>= (setq n (1- n)) 0)
6669 (org-promote))
6670 (end-of-line 1))))))
6672 (defun org-tr-level (n)
6673 "Make N odd if required."
6674 (if org-odd-levels-only (1+ (/ n 2)) n))
6676 ;;; Vertical tree motion, cutting and pasting of subtrees
6678 (defun org-move-subtree-up (&optional arg)
6679 "Move the current subtree up past ARG headlines of the same level."
6680 (interactive "p")
6681 (org-move-subtree-down (- (prefix-numeric-value arg))))
6683 (defun org-move-subtree-down (&optional arg)
6684 "Move the current subtree down past ARG headlines of the same level."
6685 (interactive "p")
6686 (setq arg (prefix-numeric-value arg))
6687 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6688 'outline-get-last-sibling))
6689 (ins-point (make-marker))
6690 (cnt (abs arg))
6691 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6692 ;; Select the tree
6693 (org-back-to-heading)
6694 (setq beg0 (point))
6695 (save-excursion
6696 (setq ne-beg (org-back-over-empty-lines))
6697 (setq beg (point)))
6698 (save-match-data
6699 (save-excursion (outline-end-of-heading)
6700 (setq folded (org-invisible-p)))
6701 (outline-end-of-subtree))
6702 (outline-next-heading)
6703 (setq ne-end (org-back-over-empty-lines))
6704 (setq end (point))
6705 (goto-char beg0)
6706 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6707 ;; include less whitespace
6708 (save-excursion
6709 (goto-char beg)
6710 (forward-line (- ne-beg ne-end))
6711 (setq beg (point))))
6712 ;; Find insertion point, with error handling
6713 (while (> cnt 0)
6714 (or (and (funcall movfunc) (looking-at outline-regexp))
6715 (progn (goto-char beg0)
6716 (error "Cannot move past superior level or buffer limit")))
6717 (setq cnt (1- cnt)))
6718 (if (> arg 0)
6719 ;; Moving forward - still need to move over subtree
6720 (progn (org-end-of-subtree t t)
6721 (save-excursion
6722 (org-back-over-empty-lines)
6723 (or (bolp) (newline)))))
6724 (setq ne-ins (org-back-over-empty-lines))
6725 (move-marker ins-point (point))
6726 (setq txt (buffer-substring beg end))
6727 (delete-region beg end)
6728 (outline-flag-region (1- beg) beg nil)
6729 (outline-flag-region (1- (point)) (point) nil)
6730 (insert txt)
6732 (setq ins-end (point))
6733 (goto-char ins-point)
6734 (org-skip-whitespace)
6735 (when (and (< arg 0)
6736 (org-first-sibling-p)
6737 (> ne-ins ne-beg))
6738 ;; Move whitespace back to beginning
6739 (save-excursion
6740 (goto-char ins-end)
6741 (let ((kill-whole-line t))
6742 (kill-line (- ne-ins ne-beg)) (point)))
6744 (move-marker ins-point nil)
6745 (org-compact-display-after-subtree-move)
6746 (unless folded
6747 (org-show-entry)
6748 (show-children)
6749 (org-cycle-hide-drawers 'children))))
6751 (defvar org-subtree-clip ""
6752 "Clipboard for cut and paste of subtrees.
6753 This is actually only a copy of the kill, because we use the normal kill
6754 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6756 (defvar org-subtree-clip-folded nil
6757 "Was the last copied subtree folded?
6758 This is used to fold the tree back after pasting.")
6760 (defun org-cut-subtree (&optional n)
6761 "Cut the current subtree into the clipboard.
6762 With prefix arg N, cut this many sequential subtrees.
6763 This is a short-hand for marking the subtree and then cutting it."
6764 (interactive "p")
6765 (org-copy-subtree n 'cut))
6767 (defun org-copy-subtree (&optional n cut)
6768 "Cut the current subtree into the clipboard.
6769 With prefix arg N, cut this many sequential subtrees.
6770 This is a short-hand for marking the subtree and then copying it.
6771 If CUT is non-nil, actually cut the subtree."
6772 (interactive "p")
6773 (let (beg end folded (beg0 (point)))
6774 (if (interactive-p)
6775 (org-back-to-heading nil) ; take what looks like a subtree
6776 (org-back-to-heading t)) ; take what is really there
6777 (org-back-over-empty-lines)
6778 (setq beg (point))
6780 (save-match-data
6781 (save-excursion (outline-end-of-heading)
6782 (setq folded (org-invisible-p)))
6783 (condition-case nil
6784 (outline-forward-same-level (1- n))
6785 (error nil))
6786 (org-end-of-subtree t t))
6787 (org-back-over-empty-lines)
6788 (setq end (point))
6789 (goto-char beg0)
6790 (when (> end beg)
6791 (setq org-subtree-clip-folded folded)
6792 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6793 (setq org-subtree-clip (current-kill 0))
6794 (message "%s: Subtree(s) with %d characters"
6795 (if cut "Cut" "Copied")
6796 (length org-subtree-clip)))))
6798 (defun org-paste-subtree (&optional level tree)
6799 "Paste the clipboard as a subtree, with modification of headline level.
6800 The entire subtree is promoted or demoted in order to match a new headline
6801 level. By default, the new level is derived from the visible headings
6802 before and after the insertion point, and taken to be the inferior headline
6803 level of the two. So if the previous visible heading is level 3 and the
6804 next is level 4 (or vice versa), level 4 will be used for insertion.
6805 This makes sure that the subtree remains an independent subtree and does
6806 not swallow low level entries.
6808 You can also force a different level, either by using a numeric prefix
6809 argument, or by inserting the heading marker by hand. For example, if the
6814 If optional TREE is given, use this text instead of the kill ring."
6815 (interactive "P")
6816 (unless (org-kill-is-subtree-p tree)
6817 (error "%s"
6818 (substitute-command-keys
6820 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6825 (old-level (if (string-match ^re txt)
6826 (- (match-end 0) (match-beginning 0) 1)
6827 -1))
6828 (force-level (cond (level (prefix-numeric-value level))
6829 ((string-match
6830 ^re_ (buffer-substring (point-at-bol) (point)))
6831 (- (match-end 1) (match-beginning 1)))
6832 (t nil)))
6833 (previous-level (save-excursion
6834 (condition-case nil
6835 (progn
6836 (outline-previous-visible-heading 1)
6837 (if (looking-at re)
6838 (- (match-end 0) (match-beginning 0) 1)
6839 1))
6840 (error 1))))
6841 (next-level (save-excursion
6842 (condition-case nil
6843 (progn
6844 (or (looking-at outline-regexp)
6845 (outline-next-visible-heading 1))
6846 (if (looking-at re)
6847 (- (match-end 0) (match-beginning 0) 1)
6848 1))
6849 (error 1))))
6850 (new-level (or force-level (max previous-level next-level)))
6851 (shift (if (or (= old-level -1)
6852 (= new-level -1)
6853 (= old-level new-level))
6854 0
6855 (- new-level old-level)))
6856 (delta (if (> shift 0) -1 1))
6857 (func (if (> shift 0) 'org-demote 'org-promote))
6858 (org-odd-levels-only nil)
6859 beg end)
6860 ;; Remove the forced level indicator
6861 (if force-level
6862 (delete-region (point-at-bol) (point)))
6863 ;; Paste
6864 (beginning-of-line 1)
6865 (org-back-over-empty-lines) ;; FIXME: correct fix????
6866 (setq beg (point))
6867 (insert-before-markers txt) ;; FIXME: correct fix????
6869 (setq end (point))
6870 (goto-char beg)
6872 (setq beg (point))
6873 ;; Shift if necessary
6874 (unless (= shift 0)
6875 (save-restriction
6876 (narrow-to-region beg end)
6877 (while (not (= shift 0))
6878 (org-map-region func (point-min) (point-max))
6879 (setq shift (+ delta shift)))
6880 (goto-char (point-min))))
6881 (when (interactive-p)
6882 (message "Clipboard pasted as level %d subtree" new-level))
6883 (if (and kill-ring
6884 (eq org-subtree-clip (current-kill 0))
6885 org-subtree-clip-folded)
6886 ;; The tree was folded before it was killed/copied
6887 (hide-subtree))))
6889 (defun org-kill-is-subtree-p (&optional txt)
6890 "Check if the current kill is an outline subtree, or a set of trees.
6891 Returns nil if kill does not start with a headline, or if the first
6892 headline level is not the largest headline level in the tree.
6893 So this will actually accept several entries of equal levels as well,
6894 which is OK for `org-paste-subtree'.
6895 If optional TXT is given, check this string instead of the current kill."
6896 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6897 (start-level (and kill
6900 kill)
6901 (- (match-end 2) (match-beginning 2) 1)))
6902 (re (concat "^" org-outline-regexp))
6903 (start (1+ (match-beginning 2))))
6904 (if (not start-level)
6905 (progn
6906 nil) ;; does not even start with a heading
6907 (catch 'exit
6908 (while (setq start (string-match re kill (1+ start)))
6909 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6910 (throw 'exit nil)))
6911 t))))
6913 (defun org-narrow-to-subtree ()
6914 "Narrow buffer to the current subtree."
6915 (interactive)
6916 (save-excursion
6917 (save-match-data
6918 (narrow-to-region
6919 (progn (org-back-to-heading) (point))
6920 (progn (org-end-of-subtree t t) (point))))))
6923 ;;; Outline Sorting
6925 (defun org-sort (with-case)
6926 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6927 Optional argument WITH-CASE means sort case-sensitively."
6928 (interactive "P")
6929 (if (org-at-table-p)
6930 (org-call-with-arg 'org-table-sort-lines with-case)
6931 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6933 (defvar org-priority-regexp) ; defined later in the file
6935 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6936 "Sort entries on a certain level of an outline tree.
6937 If there is an active region, the entries in the region are sorted.
6938 Else, if the cursor is before the first entry, sort the top-level items.
6939 Else, the children of the entry at point are sorted.
6941 Sorting can be alphabetically, numerically, and by date/time as given by
6942 the first time stamp in the entry. The command prompts for the sorting
6943 type unless it has been given to the function through the SORTING-TYPE
6944 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6945 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6946 called with point at the beginning of the record. It must return either
6947 a string or a number that should serve as the sorting key for that record.
6949 Comparing entries ignores case by default. However, with an optional argument
6950 WITH-CASE, the sorting considers case as well."
6951 (interactive "P")
6952 (let ((case-func (if with-case 'identity 'downcase))
6953 start beg end stars re re2
6954 txt what tmp plain-list-p)
6955 ;; Find beginning and end of region to sort
6956 (cond
6957 ((org-region-active-p)
6958 ;; we will sort the region
6959 (setq end (region-end)
6960 what "region")
6961 (goto-char (region-beginning))
6962 (if (not (org-on-heading-p)) (outline-next-heading))
6963 (setq start (point)))
6964 ((org-at-item-p)
6965 ;; we will sort this plain list
6966 (org-beginning-of-item-list) (setq start (point))
6967 (org-end-of-item-list) (setq end (point))
6968 (goto-char start)
6969 (setq plain-list-p t
6970 what "plain list"))
6971 ((or (org-on-heading-p)
6972 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6973 ;; we will sort the children of the current headline
6974 (org-back-to-heading)
6975 (setq start (point)
6976 end (progn (org-end-of-subtree t t)
6977 (org-back-over-empty-lines)
6978 (point))
6979 what "children")
6980 (goto-char start)
6981 (show-subtree)
6982 (outline-next-heading))
6983 (t
6984 ;; we will sort the top-level entries in this file
6985 (goto-char (point-min))
6986 (or (org-on-heading-p) (outline-next-heading))
6987 (setq start (point) end (point-max) what "top-level")
6988 (goto-char start)
6989 (show-all)))
6991 (setq beg (point))
6992 (if (>= beg end) (error "Nothing to sort"))
6994 (unless plain-list-p
6996 (setq stars (match-string 1)
6997 re (concat "^" (regexp-quote stars) " +")
6998 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6999 txt (buffer-substring beg end))
7001 (if (and (not (equal stars "*")) (string-match re2 txt))
7002 (error "Region to sort contains a level above the first entry")))
7004 (unless sorting-type
7005 (message
7006 (if plain-list-p
7007 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
7008 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
7009 what)
7010 (setq sorting-type (read-char-exclusive))
7012 (and (= (downcase sorting-type) ?f)
7013 (setq getkey-func
7014 (completing-read "Sort using function: "
7015 obarray 'fboundp t nil nil))
7016 (setq getkey-func (intern getkey-func)))
7018 (and (= (downcase sorting-type) ?r)
7019 (setq property
7020 (completing-read "Property: "
7021 (mapcar 'list (org-buffer-property-keys t))
7022 nil t))))
7024 (message "Sorting entries...")
7026 (save-restriction
7027 (narrow-to-region start end)
7029 (let ((dcst (downcase sorting-type))
7030 (now (current-time)))
7031 (sort-subr
7032 (/= dcst sorting-type)
7033 ;; This function moves to the beginning character of the "record" to
7034 ;; be sorted.
7035 (if plain-list-p
7036 (lambda nil
7037 (if (org-at-item-p) t (goto-char (point-max))))
7038 (lambda nil
7039 (if (re-search-forward re nil t)
7040 (goto-char (match-beginning 0))
7041 (goto-char (point-max)))))
7042 ;; This function moves to the last character of the "record" being
7043 ;; sorted.
7044 (if plain-list-p
7045 'org-end-of-item
7046 (lambda nil
7047 (save-match-data
7048 (condition-case nil
7049 (outline-forward-same-level 1)
7050 (error
7051 (goto-char (point-max)))))))
7053 ;; This function returns the value that gets sorted against.
7054 (if plain-list-p
7055 (lambda nil
7057 (cond
7058 ((= dcst ?n)
7059 (string-to-number (buffer-substring (match-end 0)
7060 (point-at-eol))))
7061 ((= dcst ?a)
7062 (buffer-substring (match-end 0) (point-at-eol)))
7063 ((= dcst ?t)
7064 (if (re-search-forward org-ts-regexp
7065 (point-at-eol) t)
7066 (org-time-string-to-time (match-string 0))
7067 now))
7068 ((= dcst ?f)
7069 (if getkey-func
7070 (progn
7071 (setq tmp (funcall getkey-func))
7072 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7073 tmp)
7074 (error "Invalid key function `%s'" getkey-func)))
7075 (t (error "Invalid sorting type `%c'" sorting-type)))))
7076 (lambda nil
7077 (cond
7078 ((= dcst ?n)
7079 (if (looking-at outline-regexp)
7080 (string-to-number (buffer-substring (match-end 0)
7081 (point-at-eol)))
7082 nil))
7083 ((= dcst ?a)
7084 (funcall case-func (buffer-substring (point-at-bol)
7085 (point-at-eol))))
7086 ((= dcst ?t)
7087 (if (re-search-forward org-ts-regexp
7088 (save-excursion
7089 (forward-line 2)
7090 (point)) t)
7091 (org-time-string-to-time (match-string 0))
7092 now))
7093 ((= dcst ?p)
7094 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7095 (string-to-char (match-string 2))
7096 org-default-priority))
7097 ((= dcst ?r)
7098 (or (org-entry-get nil property) ""))
7099 ((= dcst ?f)
7100 (if getkey-func
7101 (progn
7102 (setq tmp (funcall getkey-func))
7103 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7104 tmp)
7105 (error "Invalid key function `%s'" getkey-func)))
7106 (t (error "Invalid sorting type `%c'" sorting-type)))))
7107 nil
7108 (cond
7109 ((= dcst ?a) 'string<)
7110 ((= dcst ?t) 'time-less-p)
7111 (t nil)))))
7112 (message "Sorting entries...done")))
7114 (defun org-do-sort (table what &optional with-case sorting-type)
7115 "Sort TABLE of WHAT according to SORTING-TYPE.
7116 The user will be prompted for the SORTING-TYPE if the call to this
7117 function does not specify it. WHAT is only for the prompt, to indicate
7118 what is being sorted. The sorting key will be extracted from
7119 the car of the elements of the table.
7120 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7121 (unless sorting-type
7122 (message
7123 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7124 what)
7125 (setq sorting-type (read-char-exclusive)))
7126 (let ((dcst (downcase sorting-type))
7127 extractfun comparefun)
7128 ;; Define the appropriate functions
7129 (cond
7130 ((= dcst ?n)
7131 (setq extractfun 'string-to-number
7132 comparefun (if (= dcst sorting-type) '< '>)))
7133 ((= dcst ?a)
7134 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7135 (lambda(x) (downcase (org-sort-remove-invisible x))))
7136 comparefun (if (= dcst sorting-type)
7137 'string<
7138 (lambda (a b) (and (not (string< a b))
7139 (not (string= a b)))))))
7140 ((= dcst ?t)
7141 (setq extractfun
7142 (lambda (x)
7143 (if (string-match org-ts-regexp x)
7144 (time-to-seconds
7145 (org-time-string-to-time (match-string 0 x)))
7146 0))
7147 comparefun (if (= dcst sorting-type) '< '>)))
7148 (t (error "Invalid sorting type `%c'" sorting-type)))
7150 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7151 table)
7152 (lambda (a b) (funcall comparefun (car a) (car b))))))
7154 ;;;; Plain list items, including checkboxes
7156 ;;; Plain list items
7158 (defun org-at-item-p ()
7159 "Is point in a line starting a hand-formatted item?"
7160 (let ((llt org-plain-list-ordered-item-terminator))
7161 (save-excursion
7162 (goto-char (point-at-bol))
7163 (looking-at
7164 (cond
7168 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7170 (defun org-in-item-p ()
7171 "It the cursor inside a plain list item.
7172 Does not have to be the first line."
7173 (save-excursion
7174 (condition-case nil
7175 (progn
7176 (org-beginning-of-item)
7177 (org-at-item-p)
7178 t)
7179 (error nil))))
7181 (defun org-insert-item (&optional checkbox)
7182 "Insert a new item at the current level.
7183 Return t when things worked, nil when we are not in an item."
7184 (when (save-excursion
7185 (condition-case nil
7186 (progn
7187 (org-beginning-of-item)
7188 (org-at-item-p)
7189 (if (org-invisible-p) (error "Invisible item"))
7190 t)
7191 (error nil)))
7192 (let* ((bul (match-string 0))
7194 (match-end 0)))
7195 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7196 pos)
7197 (cond
7198 ((and (org-at-item-p) (<= (point) eow))
7199 ;; before the bullet
7200 (beginning-of-line 1)
7201 (open-line (if blank 2 1)))
7202 ((<= (point) eow)
7203 (beginning-of-line 1))
7204 (t
7205 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7206 (end-of-line 1)
7207 (delete-horizontal-space))
7208 (newline (if blank 2 1))))
7209 (insert bul (if checkbox "[ ]" ""))
7210 (just-one-space)
7211 (setq pos (point))
7212 (end-of-line 1)
7213 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7214 (org-maybe-renumber-ordered-list)
7215 (and checkbox (org-update-checkbox-count-maybe))
7216 t))
7218 ;;; Checkboxes
7220 (defun org-at-item-checkbox-p ()
7221 "Is point at a line starting a plain-list item with a checklet?"
7222 (and (org-at-item-p)
7223 (save-excursion
7224 (goto-char (match-end 0))
7228 (defun org-toggle-checkbox (&optional arg)
7229 "Toggle the checkbox in the current line."
7230 (interactive "P")
7231 (catch 'exit
7232 (let (beg end status (firstnew 'unknown))
7233 (cond
7234 ((org-region-active-p)
7235 (setq beg (region-beginning) end (region-end)))
7236 ((org-on-heading-p)
7237 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7238 ((org-at-item-checkbox-p)
7239 (let ((pos (point)))
7240 (replace-match
7241 (cond (arg "[-]")
7242 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7243 (t "[ ]"))
7244 t t)
7245 (goto-char pos))
7246 (throw 'exit t))
7247 (t (error "Not at a checkbox or heading, and no active region")))
7248 (save-excursion
7249 (goto-char beg)
7250 (while (< (point) end)
7251 (when (org-at-item-checkbox-p)
7252 (setq status (equal (match-string 0) "[X]"))
7253 (when (eq firstnew 'unknown)
7254 (setq firstnew (not status)))
7255 (replace-match
7256 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7257 (beginning-of-line 2)))))
7258 (org-update-checkbox-count-maybe))
7260 (defun org-update-checkbox-count-maybe ()
7261 "Update checkbox statistics unless turned off by user."
7262 (when org-provide-checkbox-statistics
7263 (org-update-checkbox-count)))
7265 (defun org-update-checkbox-count (&optional all)
7266 "Update the checkbox statistics in the current section.
7267 This will find all statistic cookies like [57%] and [6/12] and update them
7268 with the current numbers. With optional prefix argument ALL, do this for
7269 the whole buffer."
7270 (interactive "P")
7271 (save-excursion
7272 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7273 (beg (condition-case nil
7274 (progn (outline-back-to-heading) (point))
7275 (error (point-min))))
7276 (end (move-marker (make-marker)
7277 (progn (outline-next-heading) (point))))
7281 beg-cookie end-cookie is-percent c-on c-off lim
7282 eline curr-ind next-ind continue-from startsearch
7283 (cstat 0)
7284 )
7285 (when all
7286 (goto-char (point-min))
7287 (outline-next-heading)
7288 (setq beg (point) end (point-max)))
7289 (goto-char end)
7290 ;; find each statistic cookie
7291 (while (re-search-backward re-find beg t)
7292 (setq beg-cookie (match-beginning 1)
7293 end-cookie (match-end 1)
7294 cstat (+ cstat (if end-cookie 1 0))
7295 startsearch (point-at-eol)
7296 continue-from (point-at-bol)
7297 is-percent (match-beginning 2)
7298 lim (cond
7299 ((org-on-heading-p) (outline-next-heading) (point))
7300 ((org-at-item-p) (org-end-of-item) (point))
7301 (t nil))
7302 c-on 0
7303 c-off 0)
7304 (when lim
7305 ;; find first checkbox for this cookie and gather
7306 ;; statistics from all that are at this indentation level
7307 (goto-char startsearch)
7308 (if (re-search-forward re-box lim t)
7309 (progn
7310 (org-beginning-of-item)
7311 (setq curr-ind (org-get-indentation))
7312 (setq next-ind curr-ind)
7313 (while (= curr-ind next-ind)
7314 (save-excursion (end-of-line) (setq eline (point)))
7315 (if (re-search-forward re-box eline t)
7316 (if (member (match-string 2) '("[ ]" "[-]"))
7317 (setq c-off (1+ c-off))
7318 (setq c-on (1+ c-on))
7319 )
7320 )
7321 (org-end-of-item)
7322 (setq next-ind (org-get-indentation))
7323 )))
7324 (goto-char continue-from)
7325 ;; update cookie
7326 (when end-cookie
7327 (delete-region beg-cookie end-cookie)
7328 (goto-char beg-cookie)
7329 (insert
7330 (if is-percent
7331 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7332 (format "[%d/%d]" c-on (+ c-on c-off)))))
7333 ;; update items checkbox if it has one
7334 (when (org-at-item-p)
7335 (org-beginning-of-item)
7336 (when (and (> (+ c-on c-off) 0)
7337 (re-search-forward re-box (point-at-eol) t))
7338 (setq beg-cookie (match-beginning 2)
7339 end-cookie (match-end 2))
7340 (delete-region beg-cookie end-cookie)
7341 (goto-char beg-cookie)
7342 (cond ((= c-off 0) (insert "[X]"))
7343 ((= c-on 0) (insert "[ ]"))
7344 (t (insert "[-]")))
7345 )))
7346 (goto-char continue-from))
7347 (when (interactive-p)
7348 (message "Checkbox satistics updated %s (%d places)"
7349 (if all "in entire file" "in current outline entry") cstat)))))
7351 (defun org-get-checkbox-statistics-face ()
7352 "Select the face for checkbox statistics.
7353 The face will be `org-done' when all relevant boxes are checked. Otherwise
7354 it will be `org-todo'."
7355 (if (match-end 1)
7356 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7357 (if (and (> (match-end 2) (match-beginning 2))
7358 (equal (match-string 2) (match-string 3)))
7359 'org-done
7360 'org-todo)))
7362 (defun org-get-indentation (&optional line)
7363 "Get the indentation of the current line, interpreting tabs.
7364 When LINE is given, assume it represents a line and compute its indentation."
7365 (if line
7366 (if (string-match "^ *" (org-remove-tabs line))
7367 (match-end 0))
7368 (save-excursion
7369 (beginning-of-line 1)
7371 (current-column))))
7373 (defun org-remove-tabs (s &optional width)
7374 "Replace tabulators in S with spaces.
7375 Assumes that s is a single line, starting in column 0."
7376 (setq width (or width tab-width))
7378 (setq s (replace-match
7379 (make-string
7380 (- (* width (/ (+ (match-beginning 0) width) width))
7381 (match-beginning 0)) ?\ )
7382 t t s)))
7383 s)
7385 (defun org-fix-indentation (line ind)
7386 "Fix indentation in LINE.
7387 IND is a cons cell with target and minimum indentation.
7388 If the current indenation in LINE is smaller than the minimum,
7389 leave it alone. If it is larger than ind, set it to the target."
7390 (let* ((l (org-remove-tabs line))
7391 (i (org-get-indentation l))
7392 (i1 (car ind)) (i2 (cdr ind)))
7393 (if (>= i i2) (setq l (substring line i2)))
7394 (if (> i1 0)
7395 (concat (make-string i1 ?\ ) l)
7396 l)))
7398 (defcustom org-empty-line-terminates-plain-lists nil
7399 "Non-nil means, an empty line ends all plain list levels.
7400 When nil, empty lines are part of the preceeding item."
7401 :group 'org-plain-lists
7402 :type 'boolean)
7404 (defun org-beginning-of-item ()
7405 "Go to the beginning of the current hand-formatted item.
7406 If the cursor is not in an item, throw an error."
7407 (interactive)
7408 (let ((pos (point))
7409 (limit (save-excursion
7410 (condition-case nil
7411 (progn
7412 (org-back-to-heading)
7413 (beginning-of-line 2) (point))
7414 (error (point-min)))))
7415 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7416 ind ind1)
7417 (if (org-at-item-p)
7418 (beginning-of-line 1)
7419 (beginning-of-line 1)
7421 (setq ind (current-column))
7422 (if (catch 'exit
7423 (while t
7424 (beginning-of-line 0)
7425 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7428 (setq ind1 ind-empty)
7430 (setq ind1 (current-column)))
7431 (if (< ind1 ind)
7432 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7433 nil
7434 (goto-char pos)
7435 (error "Not in an item")))))
7437 (defun org-end-of-item ()
7438 "Go to the end of the current hand-formatted item.
7439 If the cursor is not in an item, throw an error."
7440 (interactive)
7441 (let* ((pos (point))
7442 ind1
7443 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7444 (limit (save-excursion (outline-next-heading) (point)))
7445 (ind (save-excursion
7446 (org-beginning-of-item)
7448 (current-column)))
7449 (end (catch 'exit
7450 (while t
7451 (beginning-of-line 2)
7452 (if (eobp) (throw 'exit (point)))
7453 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7455 (setq ind1 ind-empty)
7457 (setq ind1 (current-column)))
7458 (if (<= ind1 ind)
7459 (throw 'exit (point-at-bol)))))))
7460 (if end
7461 (goto-char end)
7462 (goto-char pos)
7463 (error "Not in an item"))))
7465 (defun org-next-item ()
7466 "Move to the beginning of the next item in the current plain list.
7467 Error if not at a plain list, or if this is the last item in the list."
7468 (interactive)
7469 (let (ind ind1 (pos (point)))
7470 (org-beginning-of-item)
7471 (setq ind (org-get-indentation))
7472 (org-end-of-item)
7473 (setq ind1 (org-get-indentation))
7474 (unless (and (org-at-item-p) (= ind ind1))
7475 (goto-char pos)
7476 (error "On last item"))))
7478 (defun org-previous-item ()
7479 "Move to the beginning of the previous item in the current plain list.
7480 Error if not at a plain list, or if this is the first item in the list."
7481 (interactive)
7482 (let (beg ind ind1 (pos (point)))
7483 (org-beginning-of-item)
7484 (setq beg (point))
7485 (setq ind (org-get-indentation))
7486 (goto-char beg)
7487 (catch 'exit
7488 (while t
7489 (beginning-of-line 0)
7491 nil
7492 (if (<= (setq ind1 (org-get-indentation)) ind)
7493 (throw 'exit t)))))
7494 (condition-case nil
7495 (if (or (not (org-at-item-p))
7496 (< ind1 (1- ind)))
7497 (error "")
7498 (org-beginning-of-item))
7499 (error (goto-char pos)
7500 (error "On first item")))))
7502 (defun org-first-list-item-p ()
7503 "Is this heading the item in a plain list?"
7504 (unless (org-at-item-p)
7505 (error "Not at a plain list item"))
7506 (org-beginning-of-item)
7507 (= (point) (save-excursion (org-beginning-of-item-list))))
7509 (defun org-move-item-down ()
7510 "Move the plain list item at point down, i.e. swap with following item.
7511 Subitems (items with larger indentation) are considered part of the item,
7512 so this really moves item trees."
7513 (interactive)
7514 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7515 (org-beginning-of-item)
7516 (setq beg0 (point))
7517 (save-excursion
7518 (setq ne-beg (org-back-over-empty-lines))
7519 (setq beg (point)))
7520 (goto-char beg0)
7521 (setq ind (org-get-indentation))
7522 (org-end-of-item)
7523 (setq end0 (point))
7524 (setq ind1 (org-get-indentation))
7525 (setq ne-end (org-back-over-empty-lines))
7526 (setq end (point))
7527 (goto-char beg0)
7528 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7529 ;; include less whitespace
7530 (save-excursion
7531 (goto-char beg)
7532 (forward-line (- ne-beg ne-end))
7533 (setq beg (point))))
7534 (goto-char end0)
7535 (if (and (org-at-item-p) (= ind ind1))
7536 (progn
7537 (org-end-of-item)
7538 (org-back-over-empty-lines)
7539 (setq txt (buffer-substring beg end))
7540 (save-excursion
7541 (delete-region beg end))
7542 (setq pos (point))
7543 (insert txt)
7544 (goto-char pos) (org-skip-whitespace)
7545 (org-maybe-renumber-ordered-list))
7546 (goto-char pos)
7547 (error "Cannot move this item further down"))))
7549 (defun org-move-item-up (arg)
7550 "Move the plain list item at point up, i.e. swap with previous item.
7551 Subitems (items with larger indentation) are considered part of the item,
7552 so this really moves item trees."
7553 (interactive "p")
7554 (let (beg beg0 end ind ind1 (pos (point)) txt
7555 ne-beg ne-ins ins-end)
7556 (org-beginning-of-item)
7557 (setq beg0 (point))
7558 (setq ind (org-get-indentation))
7559 (save-excursion
7560 (setq ne-beg (org-back-over-empty-lines))
7561 (setq beg (point)))
7562 (goto-char beg0)
7563 (org-end-of-item)
7564 (setq end (point))
7565 (goto-char beg0)
7566 (catch 'exit
7567 (while t
7568 (beginning-of-line 0)
7570 (if org-empty-line-terminates-plain-lists
7571 (progn
7572 (goto-char pos)
7573 (error "Cannot move this item further up"))
7574 nil)
7575 (if (<= (setq ind1 (org-get-indentation)) ind)
7576 (throw 'exit t)))))
7577 (condition-case nil
7578 (org-beginning-of-item)
7579 (error (goto-char beg)
7580 (error "Cannot move this item further up")))
7581 (setq ind1 (org-get-indentation))
7582 (if (and (org-at-item-p) (= ind ind1))
7583 (progn
7584 (setq ne-ins (org-back-over-empty-lines))
7585 (setq txt (buffer-substring beg end))
7586 (save-excursion
7587 (delete-region beg end))
7588 (setq pos (point))
7589 (insert txt)
7590 (setq ins-end (point))
7591 (goto-char pos) (org-skip-whitespace)
7593 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7594 ;; Move whitespace back to beginning
7595 (save-excursion
7596 (goto-char ins-end)
7597 (let ((kill-whole-line t))
7598 (kill-line (- ne-ins ne-beg)) (point)))
7601 (org-maybe-renumber-ordered-list))
7602 (goto-char pos)
7603 (error "Cannot move this item further up"))))
7605 (defun org-maybe-renumber-ordered-list ()
7606 "Renumber the ordered list at point if setup allows it.
7607 This tests the user option `org-auto-renumber-ordered-lists' before
7608 doing the renumbering."
7609 (interactive)
7610 (when (and org-auto-renumber-ordered-lists
7611 (org-at-item-p))
7612 (if (match-beginning 3)
7613 (org-renumber-ordered-list 1)
7614 (org-fix-bullet-type))))
7616 (defun org-maybe-renumber-ordered-list-safe ()
7617 (condition-case nil
7618 (save-excursion
7619 (org-maybe-renumber-ordered-list))
7620 (error nil)))
7622 (defun org-cycle-list-bullet (&optional which)
7623 "Cycle through the different itemize/enumerate bullets.
7624 This cycle the entire list level through the sequence:
7626 `-' -> `+' -> `*' -> `1.' -> `1)'
7628 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7629 0 meand `-', 1 means `+' etc."
7630 (interactive "P")
7631 (org-preserve-lc
7632 (org-beginning-of-item-list)
7633 (org-at-item-p)
7634 (beginning-of-line 1)
7635 (let ((current (match-string 0))
7636 (prevp (eq which 'previous))
7637 new)
7638 (setq new (cond
7639 ((and (numberp which)
7640 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7641 ((string-match "-" current) (if prevp "1)" "+"))
7646 ((string-match ")" current) (if prevp "1." "-"))
7647 (t (error "This should not happen"))))
7649 (org-fix-bullet-type)
7650 (org-maybe-renumber-ordered-list))))
7652 (defun org-get-string-indentation (s)
7653 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7654 (let ((n -1) (i 0) (w tab-width) c)
7655 (catch 'exit
7656 (while (< (setq n (1+ n)) (length s))
7657 (setq c (aref s n))
7658 (cond ((= c ?\ ) (setq i (1+ i)))
7660 (t (throw 'exit t)))))
7661 i))
7663 (defun org-renumber-ordered-list (arg)
7664 "Renumber an ordered plain list.
7665 Cursor needs to be in the first line of an item, the line that starts
7667 (interactive "p")
7668 (unless (and (org-at-item-p)
7669 (match-beginning 3))
7670 (error "This is not an ordered list"))
7671 (let ((line (org-current-line))
7672 (col (current-column))
7673 (ind (org-get-string-indentation
7674 (buffer-substring (point-at-bol) (match-beginning 3))))
7675 ;; (term (substring (match-string 3) -1))
7676 ind1 (n (1- arg))
7677 fmt)
7678 ;; find where this list begins
7679 (org-beginning-of-item-list)
7681 (setq fmt (concat "%d" (match-string 1)))
7682 (beginning-of-line 0)
7683 ;; walk forward and replace these numbers
7684 (catch 'exit
7685 (while t
7686 (catch 'next
7687 (beginning-of-line 2)
7688 (if (eobp) (throw 'exit nil))
7691 (if (> ind1 ind) (throw 'next t))
7692 (if (< ind1 ind) (throw 'exit t))
7693 (if (not (org-at-item-p)) (throw 'exit nil))
7694 (delete-region (match-beginning 2) (match-end 2))
7695 (goto-char (match-beginning 2))
7696 (insert (format fmt (setq n (1+ n)))))))
7697 (goto-line line)
7698 (move-to-column col)))
7700 (defun org-fix-bullet-type ()
7701 "Make sure all items in this list have the same bullet as the firsst item."
7702 (interactive)
7703 (unless (org-at-item-p) (error "This is not a list"))
7704 (let ((line (org-current-line))
7705 (col (current-column))
7706 (ind (current-indentation))
7707 ind1 bullet)
7708 ;; find where this list begins
7709 (org-beginning-of-item-list)
7710 (beginning-of-line 1)
7711 ;; find out what the bullet type is
7713 (setq bullet (match-string 1))
7714 ;; walk forward and replace these numbers
7715 (beginning-of-line 0)
7716 (catch 'exit
7717 (while t
7718 (catch 'next
7719 (beginning-of-line 2)
7720 (if (eobp) (throw 'exit nil))
7723 (if (> ind1 ind) (throw 'next t))
7724 (if (< ind1 ind) (throw 'exit t))
7725 (if (not (org-at-item-p)) (throw 'exit nil))
7728 (replace-match bullet))))
7729 (goto-line line)
7730 (move-to-column col)
7731 (if (string-match "[0-9]" bullet)
7732 (org-renumber-ordered-list 1))))
7734 (defun org-beginning-of-item-list ()
7735 "Go to the beginning of the current item list.
7736 I.e. to the first item in this list."
7737 (interactive)
7738 (org-beginning-of-item)
7739 (let ((pos (point-at-bol))
7740 (ind (org-get-indentation))
7741 ind1)
7742 ;; find where this list begins
7743 (catch 'exit
7744 (while t
7745 (catch 'next
7746 (beginning-of-line 0)
7748 (throw (if (bobp) 'exit 'next) t))
7750 (if (or (< ind1 ind)
7751 (and (= ind1 ind)
7752 (not (org-at-item-p)))
7753 (bobp))
7754 (throw 'exit t)
7755 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7756 (goto-char pos)))
7759 (defun org-end-of-item-list ()
7760 "Go to the end of the current item list.
7761 I.e. to the text after the last item."
7762 (interactive)
7763 (org-beginning-of-item)
7764 (let ((pos (point-at-bol))
7765 (ind (org-get-indentation))
7766 ind1)
7767 ;; find where this list begins
7768 (catch 'exit
7769 (while t
7770 (catch 'next
7771 (beginning-of-line 2)
7773 (throw (if (eobp) 'exit 'next) t))
7775 (if (or (< ind1 ind)
7776 (and (= ind1 ind)
7777 (not (org-at-item-p)))
7778 (eobp))
7779 (progn
7780 (setq pos (point-at-bol))
7781 (throw 'exit t))))))
7782 (goto-char pos)))
7785 (defvar org-last-indent-begin-marker (make-marker))
7786 (defvar org-last-indent-end-marker (make-marker))
7788 (defun org-outdent-item (arg)
7789 "Outdent a local list item."
7790 (interactive "p")
7791 (org-indent-item (- arg)))
7793 (defun org-indent-item (arg)
7794 "Indent a local list item."
7795 (interactive "p")
7796 (unless (org-at-item-p)
7797 (error "Not on an item"))
7798 (save-excursion
7799 (let (beg end ind ind1 tmp delta ind-down ind-up)
7800 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7801 (setq beg org-last-indent-begin-marker
7802 end org-last-indent-end-marker)
7803 (org-beginning-of-item)
7804 (setq beg (move-marker org-last-indent-begin-marker (point)))
7805 (org-end-of-item)
7806 (setq end (move-marker org-last-indent-end-marker (point))))
7807 (goto-char beg)
7808 (setq tmp (org-item-indent-positions)
7809 ind (car tmp)
7810 ind-down (nth 2 tmp)
7811 ind-up (nth 1 tmp)
7812 delta (if (> arg 0)
7813 (if ind-down (- ind-down ind) 2)
7814 (if ind-up (- ind-up ind) -2)))
7815 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7816 (while (< (point) end)
7817 (beginning-of-line 1)
7819 (delete-region (point-at-bol) (point))
7820 (or (eolp) (indent-to-column (+ ind1 delta)))
7821 (beginning-of-line 2))))
7822 (org-fix-bullet-type)
7823 (org-maybe-renumber-ordered-list-safe)
7824 (save-excursion
7825 (beginning-of-line 0)
7826 (condition-case nil (org-beginning-of-item) (error nil))
7827 (org-maybe-renumber-ordered-list-safe)))
7829 (defun org-item-indent-positions ()
7830 "Return indentation for plain list items.
7831 This returns a list with three values: The current indentation, the
7832 parent indentation and the indentation a child should habe.
7833 Assumes cursor in item line."
7834 (let* ((bolpos (point-at-bol))
7835 (ind (org-get-indentation))
7836 ind-down ind-up pos)
7837 (save-excursion
7838 (org-beginning-of-item-list)
7840 (when (org-in-item-p)
7841 (org-beginning-of-item)
7842 (setq ind-up (org-get-indentation))))
7843 (setq pos (point))
7844 (save-excursion
7845 (cond
7846 ((and (condition-case nil (progn (org-previous-item) t)
7847 (error nil))
7848 (or (forward-char 1) t)
7849 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7850 (setq ind-down (org-get-indentation)))
7851 ((and (goto-char pos)
7852 (org-at-item-p))
7853 (goto-char (match-end 0))
7855 (setq ind-down (current-column)))))
7856 (list ind ind-up ind-down)))
7858 ;;; The orgstruct minor mode
7860 ;; Define a minor mode which can be used in other modes in order to
7861 ;; integrate the org-mode structure editing commands.
7863 ;; This is really a hack, because the org-mode structure commands use
7864 ;; keys which normally belong to the major mode. Here is how it
7865 ;; works: The minor mode defines all the keys necessary to operate the
7866 ;; structure commands, but wraps the commands into a function which
7867 ;; tests if the cursor is currently at a headline or a plain list
7868 ;; item. If that is the case, the structure command is used,
7869 ;; temporarily setting many Org-mode variables like regular
7870 ;; expressions for filling etc. However, when any of those keys is
7871 ;; used at a different location, function uses `key-binding' to look
7872 ;; up if the key has an associated command in another currently active
7873 ;; keymap (minor modes, major mode, global), and executes that
7874 ;; command. There might be problems if any of the keys is otherwise
7875 ;; used as a prefix key.
7877 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7878 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7879 ;; addresses this by checking explicitly for both bindings.
7881 (defvar orgstruct-mode-map (make-sparse-keymap)
7882 "Keymap for the minor `orgstruct-mode'.")
7884 (defvar org-local-vars nil
7885 "List of local variables, for use by `orgstruct-mode'")
7887 ;;;###autoload
7888 (define-minor-mode orgstruct-mode
7889 "Toggle the minor more `orgstruct-mode'.
7890 This mode is for using Org-mode structure commands in other modes.
7891 The following key behave as if Org-mode was active, if the cursor
7892 is on a headline, or on a plain list item (both in the definition
7893 of Org-mode).
7895 M-up Move entry/item up
7896 M-down Move entry/item down
7897 M-left Promote
7898 M-right Demote
7899 M-S-up Move entry/item up
7900 M-S-down Move entry/item down
7901 M-S-left Promote subtree
7902 M-S-right Demote subtree
7903 M-q Fill paragraph and items like in Org-mode
7904 C-c ^ Sort entries
7905 C-c - Cycle list bullet
7906 TAB Cycle item visibility
7907 M-RET Insert new heading/item
7908 S-M-RET Insert new TODO heading / Chekbox item
7909 C-c C-c Set tags / toggle checkbox"
7910 nil " OrgStruct" nil
7911 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7913 ;;;###autoload
7914 (defun turn-on-orgstruct ()
7915 "Unconditionally turn on `orgstruct-mode'."
7916 (orgstruct-mode 1))
7918 ;;;###autoload
7919 (defun turn-on-orgstruct++ ()
7920 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7921 In addition to setting orgstruct-mode, this also exports all indentation and
7922 autofilling variables from org-mode into the buffer. Note that turning
7923 off orgstruct-mode will *not* remove these additional settings."
7924 (orgstruct-mode 1)
7925 (let (var val)
7926 (mapc
7927 (lambda (x)
7928 (when (string-match
7930 (symbol-name (car x)))
7931 (setq var (car x) val (nth 1 x))
7932 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7933 org-local-vars)))
7935 (defun orgstruct-error ()
7936 "Error when there is no default binding for a structure key."
7937 (interactive)
7938 (error "This key has no function outside structure elements"))
7940 (defun orgstruct-setup ()
7941 "Setup orgstruct keymaps."
7942 (let ((nfunc 0)
7943 (bindings
7944 (list
7945 '([(meta up)] org-metaup)
7946 '([(meta down)] org-metadown)
7947 '([(meta left)] org-metaleft)
7948 '([(meta right)] org-metaright)
7949 '([(meta shift up)] org-shiftmetaup)
7950 '([(meta shift down)] org-shiftmetadown)
7951 '([(meta shift left)] org-shiftmetaleft)
7952 '([(meta shift right)] org-shiftmetaright)
7953 '([(shift up)] org-shiftup)
7954 '([(shift down)] org-shiftdown)
7955 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7956 '("\M-q" fill-paragraph)
7957 '("\C-c^" org-sort)
7958 '("\C-c-" org-cycle-list-bullet)))
7959 elt key fun cmd)
7960 (while (setq elt (pop bindings))
7961 (setq nfunc (1+ nfunc))
7962 (setq key (org-key (car elt))
7963 fun (nth 1 elt)
7964 cmd (orgstruct-make-binding fun nfunc key))
7965 (org-defkey orgstruct-mode-map key cmd))
7967 ;; Special treatment needed for TAB and RET
7968 (org-defkey orgstruct-mode-map [(tab)]
7969 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7970 (org-defkey orgstruct-mode-map "\C-i"
7971 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7973 (org-defkey orgstruct-mode-map "\M-\C-m"
7974 (orgstruct-make-binding 'org-insert-heading 105
7975 "\M-\C-m" [(meta return)]))
7976 (org-defkey orgstruct-mode-map [(meta return)]
7977 (orgstruct-make-binding 'org-insert-heading 106
7978 [(meta return)] "\M-\C-m"))
7980 (org-defkey orgstruct-mode-map [(shift meta return)]
7981 (orgstruct-make-binding 'org-insert-todo-heading 107
7982 [(meta return)] "\M-\C-m"))
7984 (unless org-local-vars
7985 (setq org-local-vars (org-get-local-variables)))
7987 t))
7989 (defun orgstruct-make-binding (fun n &rest keys)
7990 "Create a function for binding in the structure minor mode.
7991 FUN is the command to call inside a table. N is used to create a unique
7992 command name. KEYS are keys that should be checked in for a command
7993 to execute outside of tables."
7994 (eval
7995 (list 'defun
7996 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7997 '(arg)
7999 "Outside of structure, run the binding of `"
8000 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8001 "'.")
8002 '(interactive "p")
8003 (list 'if
8004 '(org-context-p 'headline 'item)
8005 (list 'org-run-like-in-org-mode (list 'quote fun))
8006 (list 'let '(orgstruct-mode)
8007 (list 'call-interactively
8008 (append '(or)
8009 (mapcar (lambda (k)
8010 (list 'key-binding k))
8011 keys)
8012 '('orgstruct-error))))))))
8014 (defun org-context-p (&rest contexts)
8015 "Check if local context is and of CONTEXTS.
8016 Possible values in the list of contexts are `table', `headline', and `item'."
8017 (let ((pos (point)))
8018 (goto-char (point-at-bol))
8019 (prog1 (or (and (memq 'table contexts)
8021 (and (memq 'headline contexts)
8023 (and (memq 'item contexts)
8025 (goto-char pos))))
8027 (defun org-get-local-variables ()
8028 "Return a list of all local variables in an org-mode buffer."
8029 (let (varlist)
8030 (with-current-buffer (get-buffer-create "*Org tmp*")
8031 (erase-buffer)
8032 (org-mode)
8033 (setq varlist (buffer-local-variables)))
8034 (kill-buffer "*Org tmp*")
8035 (delq nil
8036 (mapcar
8037 (lambda (x)
8038 (setq x
8039 (if (symbolp x)
8040 (list x)
8041 (list (car x) (list 'quote (cdr x)))))
8042 (if (string-match
8043 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8044 (symbol-name (car x)))
8045 x nil))
8046 varlist))))
8048 ;;;###autoload
8049 (defun org-run-like-in-org-mode (cmd)
8050 (unless org-local-vars
8051 (setq org-local-vars (org-get-local-variables)))
8052 (eval (list 'let org-local-vars
8053 (list 'call-interactively (list 'quote cmd)))))
8055 ;;;; Archiving
8057 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
8059 (defun org-archive-subtree (&optional find-done)
8060 "Move the current subtree to the archive.
8061 The archive can be a certain top-level heading in the current file, or in
8062 a different file. The tree will be moved to that location, the subtree
8063 heading be marked DONE, and the current time will be added.
8065 When called with prefix argument FIND-DONE, find whole trees without any
8066 open TODO items and archive them (after getting confirmation from the user).
8067 If the cursor is not at a headline when this comand is called, try all level
8068 1 trees. If the cursor is on a headline, only try the direct children of
8069 this heading."
8070 (interactive "P")
8071 (if find-done
8072 (org-archive-all-done)
8073 ;; Save all relevant TODO keyword-relatex variables
8075 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
8076 (tr-org-todo-keywords-1 org-todo-keywords-1)
8077 (tr-org-todo-kwd-alist org-todo-kwd-alist)
8078 (tr-org-done-keywords org-done-keywords)
8079 (tr-org-todo-regexp org-todo-regexp)
8080 (tr-org-todo-line-regexp org-todo-line-regexp)
8081 (tr-org-odd-levels-only org-odd-levels-only)
8082 (this-buffer (current-buffer))
8083 (org-archive-location org-archive-location)
8085 ;; start of variables that will be used for saving context
8086 ;; The compiler complains about them - keep them anyway!
8087 (file (abbreviate-file-name (buffer-file-name)))
8088 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
8089 (time (format-time-string
8090 (substring (cdr org-time-stamp-formats) 1 -1)
8091 (current-time)))
8092 afile heading buffer level newfile-p
8093 category todo priority
8094 ;; start of variables that will be used for savind context
8095 ltags itags prop)
8097 ;; Try to find a local archive location
8098 (save-excursion
8099 (save-restriction
8100 (widen)
8101 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
8103 (setq org-archive-location prop)
8104 (if (or (re-search-backward re nil t)
8105 (re-search-forward re nil t))
8106 (setq org-archive-location (match-string 1))))))
8109 (progn
8110 (setq afile (format (match-string 1 org-archive-location)
8111 (file-name-nondirectory buffer-file-name))
8112 heading (match-string 2 org-archive-location)))
8113 (error "Invalid `org-archive-location'"))
8114 (if (> (length afile) 0)
8115 (setq newfile-p (not (file-exists-p afile))
8116 buffer (find-file-noselect afile))
8117 (setq buffer (current-buffer)))
8118 (unless buffer
8120 (if (and (> (length heading) 0)
8122 (setq level (match-end 0))
8123 (setq heading nil level 0))
8124 (save-excursion
8125 (org-back-to-heading t)
8126 ;; Get context information that will be lost by moving the tree
8127 (org-refresh-category-properties)
8128 (setq category (org-get-category)
8129 todo (and (looking-at org-todo-line-regexp)
8130 (match-string 2))
8131 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
8132 ltags (org-get-tags)
8133 itags (org-delete-all ltags (org-get-tags-at)))
8134 (setq ltags (mapconcat 'identity ltags " ")
8135 itags (mapconcat 'identity itags " "))
8136 ;; We first only copy, in case something goes wrong
8137 ;; we need to protect this-command, to avoid kill-region sets it,
8138 ;; which would lead to duplication of subtrees
8139 (let (this-command) (org-copy-subtree))
8140 (set-buffer buffer)
8141 ;; Enforce org-mode for the archive buffer
8142 (if (not (org-mode-p))
8143 ;; Force the mode for future visits.
8144 (let ((org-insert-mode-line-in-empty-file t)
8145 (org-inhibit-startup t))
8146 (call-interactively 'org-mode)))
8147 (when newfile-p
8148 (goto-char (point-max))
8150 (buffer-file-name this-buffer))))
8151 ;; Force the TODO keywords of the original buffer
8152 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
8153 (org-todo-keywords-1 tr-org-todo-keywords-1)
8154 (org-todo-kwd-alist tr-org-todo-kwd-alist)
8155 (org-done-keywords tr-org-done-keywords)
8156 (org-todo-regexp tr-org-todo-regexp)
8157 (org-todo-line-regexp tr-org-todo-line-regexp)
8158 (org-odd-levels-only
8159 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8160 org-odd-levels-only
8161 tr-org-odd-levels-only)))
8162 (goto-char (point-min))
8163 (show-all)
8164 (if heading
8165 (progn
8166 (if (re-search-forward
8167 (concat "^" (regexp-quote heading)
8169 nil t)
8170 (goto-char (match-end 0))
8171 ;; Heading not found, just insert it at the end
8172 (goto-char (point-max))
8175 (end-of-line 0))
8176 ;; Make the subtree visible
8177 (show-subtree)
8178 (org-end-of-subtree t)
8182 ;; No specific heading, just go to end of file.
8184 ;; Paste
8185 (org-paste-subtree (org-get-legal-level level 1))
8187 ;; Mark the entry as done
8188 (when (and org-archive-mark-done
8189 (looking-at org-todo-line-regexp)
8190 (or (not (match-end 2))
8191 (not (member (match-string 2) org-done-keywords))))
8192 (let (org-log-done org-todo-log-states)
8193 (org-todo
8194 (car (or (member org-archive-mark-done org-done-keywords)
8195 org-done-keywords)))))
8197 ;; Add the context info
8198 (when org-archive-save-context-info
8199 (let ((l org-archive-save-context-info) e n v)
8200 (while (setq e (pop l))
8201 (when (and (setq v (symbol-value e))
8203 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8204 (org-entry-put (point) n v)))))
8206 ;; Save and kill the buffer, if it is not the same buffer.
8207 (if (not (eq this-buffer buffer))
8208 (progn (save-buffer) (kill-buffer buffer)))))
8209 ;; Here we are back in the original buffer. Everything seems to have
8210 ;; worked. So now cut the tree and finish up.
8211 (let (this-command) (org-cut-subtree))
8213 (message "Subtree archived %s"
8214 (if (eq this-buffer buffer)
8215 (concat "under heading: " heading)
8216 (concat "in file: " (abbreviate-file-name afile)))))))
8218 (defun org-refresh-category-properties ()
8219 "Refresh category text properties in teh buffer."
8220 (let ((def-cat (cond
8221 ((null org-category)
8222 (if buffer-file-name
8223 (file-name-sans-extension
8224 (file-name-nondirectory buffer-file-name))
8225 "???"))
8226 ((symbolp org-category) (symbol-name org-category))
8227 (t org-category)))
8228 beg end cat pos optionp)
8229 (org-unmodified
8230 (save-excursion
8231 (save-restriction
8232 (widen)
8233 (goto-char (point-min))
8234 (put-text-property (point) (point-max) 'org-category def-cat)
8235 (while (re-search-forward
8237 (setq pos (match-end 0)
8238 optionp (equal (char-after (match-beginning 0)) ?#)
8239 cat (org-trim (match-string 2)))
8240 (if optionp
8241 (setq beg (point-at-bol) end (point-max))
8242 (org-back-to-heading t)
8243 (setq beg (point) end (org-end-of-subtree t t)))
8244 (put-text-property beg end 'org-category cat)
8245 (goto-char pos)))))))
8247 (defun org-archive-all-done (&optional tag)
8248 "Archive sublevels of the current tree without open TODO items.
8249 If the cursor is not on a headline, try all level 1 trees. If
8250 it is on a headline, try all direct children.
8251 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8253 (rea (concat ".*:" org-archive-tag ":"))
8254 (begm (make-marker))
8255 (endm (make-marker))
8256 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8257 "Move subtree to archive (no open TODO items)? "))
8258 beg end (cntarch 0))
8259 (if (org-on-heading-p)
8260 (progn
8261 (setq re1 (concat "^" (regexp-quote
8262 (make-string
8263 (1+ (- (match-end 0) (match-beginning 0) 1))
8264 ?*))
8265 " "))
8266 (move-marker begm (point))
8267 (move-marker endm (org-end-of-subtree t)))
8268 (setq re1 "^* ")
8269 (move-marker begm (point-min))
8270 (move-marker endm (point-max)))
8271 (save-excursion
8272 (goto-char begm)
8273 (while (re-search-forward re1 endm t)
8274 (setq beg (match-beginning 0)
8275 end (save-excursion (org-end-of-subtree t) (point)))
8276 (goto-char beg)
8277 (if (re-search-forward re end t)
8278 (goto-char end)
8279 (goto-char beg)
8280 (if (and (or (not tag) (not (looking-at rea)))
8281 (y-or-n-p question))
8282 (progn
8283 (if tag
8284 (org-toggle-tag org-archive-tag 'on)
8285 (org-archive-subtree))
8286 (setq cntarch (1+ cntarch)))
8287 (goto-char end)))))
8288 (message "%d trees archived" cntarch)))
8290 (defun org-cycle-hide-drawers (state)
8291 "Re-hide all drawers after a visibility state change."
8292 (when (and (org-mode-p)
8293 (not (memq state '(overview folded))))
8294 (save-excursion
8295 (let* ((globalp (memq state '(contents all)))
8296 (beg (if globalp (point-min) (point)))
8297 (end (if globalp (point-max) (org-end-of-subtree t))))
8298 (goto-char beg)
8299 (while (re-search-forward org-drawer-regexp end t)
8300 (org-flag-drawer t))))))
8302 (defun org-flag-drawer (flag)
8303 (save-excursion
8304 (beginning-of-line 1)
8306 (let ((b (match-end 0))
8307 (outline-regexp org-outline-regexp))
8308 (if (re-search-forward
8310 (save-excursion (outline-next-heading) (point)) t)
8311 (outline-flag-region b (point-at-eol) flag)
8312 (error ":END: line missing"))))))
8314 (defun org-cycle-hide-archived-subtrees (state)
8315 "Re-hide all archived subtrees after a visibility state change."
8316 (when (and (not org-cycle-open-archived-trees)
8317 (not (memq state '(overview folded))))
8318 (save-excursion
8319 (let* ((globalp (memq state '(contents all)))
8320 (beg (if globalp (point-min) (point)))
8321 (end (if globalp (point-max) (org-end-of-subtree t))))
8322 (org-hide-archived-subtrees beg end)
8323 (goto-char beg)
8324 (if (looking-at (concat ".*:" org-archive-tag ":"))
8325 (message "%s" (substitute-command-keys
8326 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8328 (defun org-force-cycle-archived ()
8329 "Cycle subtree even if it is archived."
8330 (interactive)
8331 (setq this-command 'org-cycle)
8332 (let ((org-cycle-open-archived-trees t))
8333 (call-interactively 'org-cycle)))
8335 (defun org-hide-archived-subtrees (beg end)
8336 "Re-hide all archived subtrees after a visibility state change."
8337 (save-excursion
8338 (let* ((re (concat ":" org-archive-tag ":")))
8339 (goto-char beg)
8340 (while (re-search-forward re end t)
8341 (and (org-on-heading-p) (hide-subtree))
8342 (org-end-of-subtree t)))))
8344 (defun org-toggle-tag (tag &optional onoff)
8345 "Toggle the tag TAG for the current line.
8346 If ONOFF is `on' or `off', don't toggle but set to this state."
8347 (unless (org-on-heading-p t) (error "Not on headling"))
8348 (let (res current)
8349 (save-excursion
8350 (beginning-of-line)
8352 (point-at-eol) t)
8353 (progn
8354 (setq current (match-string 1))
8355 (replace-match ""))
8356 (setq current ""))
8357 (setq current (nreverse (org-split-string current ":")))
8358 (cond
8359 ((eq onoff 'on)
8360 (setq res t)
8361 (or (member tag current) (push tag current)))
8362 ((eq onoff 'off)
8363 (or (not (member tag current)) (setq current (delete tag current))))
8364 (t (if (member tag current)
8365 (setq current (delete tag current))
8366 (setq res t)
8367 (push tag current))))
8368 (end-of-line 1)
8369 (if current
8370 (progn
8371 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8372 (org-set-tags nil t))
8373 (delete-horizontal-space))
8374 (run-hooks 'org-after-tags-change-hook))
8375 res))
8377 (defun org-toggle-archive-tag (&optional arg)
8378 "Toggle the archive tag for the current headline.
8379 With prefix ARG, check all children of current headline and offer tagging
8380 the children that do not contain any open TODO items."
8381 (interactive "P")
8382 (if arg
8383 (org-archive-all-done 'tag)
8384 (let (set)
8385 (save-excursion
8386 (org-back-to-heading t)
8387 (setq set (org-toggle-tag org-archive-tag))
8388 (when set (hide-subtree)))
8389 (and set (beginning-of-line 1))
8390 (message "Subtree %s" (if set "archived" "unarchived")))))
8393 ;;;; Tables
8395 ;;; The table editor
8397 ;; Watch out: Here we are talking about two different kind of tables.
8398 ;; Most of the code is for the tables created with the Org-mode table editor.
8399 ;; Sometimes, we talk about tables created and edited with the table.el
8400 ;; Emacs package. We call the former org-type tables, and the latter
8401 ;; table.el-type tables.
8403 (defun org-before-change-function (beg end)
8404 "Every change indicates that a table might need an update."
8405 (setq org-table-may-need-update t))
8408 "Detects an org-type table line.")
8410 "Detects an org-type table line.")
8412 "Detects a table line marked for automatic recalculation.")
8414 "Detects a table line marked for automatic recalculation.")
8416 "Detects a table line marked for automatic recalculation.")
8418 "Detects an org-type table hline.")
8420 "Detects a table-type table hline.")
8422 "Detects an org-type or table-type table.")
8424 "Searching from within a table (any type) this finds the first line
8425 outside the table.")
8427 "Searching from within a table (any type) this finds the first line
8428 outside the table.")
8430 (defvar org-table-last-highlighted-reference nil)
8431 (defvar org-table-formula-history nil)
8433 (defvar org-table-column-names nil
8434 "Alist with column names, derived from the `!' line.")
8435 (defvar org-table-column-name-regexp nil
8436 "Regular expression matching the current column names.")
8437 (defvar org-table-local-parameters nil
8438 "Alist with parameter names, derived from the `$' line.")
8439 (defvar org-table-named-field-locations nil
8440 "Alist with locations of named fields.")
8442 (defvar org-table-current-line-types nil
8443 "Table row types, non-nil only for the duration of a comand.")
8444 (defvar org-table-current-begin-line nil
8445 "Table begin line, non-nil only for the duration of a comand.")
8446 (defvar org-table-current-begin-pos nil
8447 "Table begin position, non-nil only for the duration of a comand.")
8448 (defvar org-table-dlines nil
8449 "Vector of data line line numbers in the current table.")
8450 (defvar org-table-hlines nil
8451 "Vector of hline line numbers in the current table.")
8453 (defconst org-table-range-regexp
8454 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8455 ;; 1 2 3 4 5
8456 "Regular expression for matching ranges in formulas.")
8458 (defconst org-table-range-regexp2
8459 (concat
8463 "Match a range for reference display.")
8465 (defconst org-table-translate-regexp
8467 "Match a reference that needs translation, for reference display.")
8469 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8471 (defun org-table-create-with-table.el ()
8472 "Use the table.el package to insert a new table.
8473 If there is already a table at point, convert between Org-mode tables
8474 and table.el tables."
8475 (interactive)
8476 (require 'table)
8477 (cond
8478 ((org-at-table.el-p)
8479 (if (y-or-n-p "Convert table to Org-mode table? ")
8480 (org-table-convert)))
8481 ((org-at-table-p)
8482 (if (y-or-n-p "Convert table to table.el table? ")
8483 (org-table-convert)))
8484 (t (call-interactively 'table-insert))))
8486 (defun org-table-create-or-convert-from-region (arg)
8487 "Convert region to table, or create an empty table.
8488 If there is an active region, convert it to a table, using the function
8489 `org-table-convert-region'. See the documentation of that function
8490 to learn how the prefix argument is interpreted to determine the field
8491 separator.
8492 If there is no such region, create an empty table with `org-table-create'."
8493 (interactive "P")
8494 (if (org-region-active-p)
8495 (org-table-convert-region (region-beginning) (region-end) arg)
8496 (org-table-create arg)))
8498 (defun org-table-create (&optional size)
8499 "Query for a size and insert a table skeleton.
8501 (interactive "P")
8502 (unless size
8503 (setq size (read-string
8504 (concat "Table size Columns x Rows [e.g. "
8505 org-table-default-size "]: ")
8506 "" nil org-table-default-size)))
8508 (let* ((pos (point))
8509 (indent (make-string (current-column) ?\ ))
8510 (split (org-split-string size " *x *"))
8511 (rows (string-to-number (nth 1 split)))
8512 (columns (string-to-number (car split)))
8513 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8516 (point-at-bol) (point)))
8517 (beginning-of-line 1)
8518 (newline))
8519 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8520 (dotimes (i rows) (insert line))
8521 (goto-char pos)
8522 (if (> rows 1)
8523 ;; Insert a hline after the first row.
8524 (progn
8525 (end-of-line 1)
8527 (goto-char pos)))
8528 (org-table-align)))
8530 (defun org-table-convert-region (beg0 end0 &optional separator)
8531 "Convert region to a table.
8532 The region goes from BEG0 to END0, but these borders will be moved
8533 slightly, to make sure a beginning of line in the first line is included.
8535 SEPARATOR specifies the field separator in the lines. It can have the
8536 following values:
8538 '(4) Use the comma as a field separator
8539 '(16) Use a TAB as field separator
8540 integer When a number, use that many spaces as field separator
8541 nil When nil, the command tries to be smart and figure out the
8542 separator in the following way:
8543 - when each line contains a TAB, assume TAB-separated material
8544 - when each line contains a comme, assume CSV material
8545 - else, assume one or more SPACE charcters as separator."
8546 (interactive "rP")
8547 (let* ((beg (min beg0 end0))
8548 (end (max beg0 end0))
8549 re)
8550 (goto-char beg)
8551 (beginning-of-line 1)
8552 (setq beg (move-marker (make-marker) (point)))
8553 (goto-char end)
8554 (if (bolp) (backward-char 1) (end-of-line 1))
8555 (setq end (move-marker (make-marker) (point)))
8556 ;; Get the right field separator
8557 (unless separator
8558 (goto-char beg)
8559 (setq separator
8560 (cond
8563 (t 1))))
8564 (setq re (cond
8567 ((integerp separator)
8569 (t (error "This should not happen"))))
8570 (goto-char beg)
8571 (while (re-search-forward re end t)
8572 (replace-match "| " t t))
8573 (goto-char beg)
8574 (insert " ")
8575 (org-table-align)))
8577 (defun org-table-import (file arg)
8578 "Import FILE as a table.
8579 The file is assumed to be tab-separated. Such files can be produced by most
8580 spreadsheet and database applications. If no tabs (at least one per line)
8581 are found, lines will be split on whitespace into fields."
8583 (or (bolp) (newline))
8584 (let ((beg (point))
8585 (pm (point-max)))
8586 (insert-file-contents file)
8587 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8589 (defun org-table-export ()
8590 "Export table as a tab-separated file.
8591 Such a file can be imported into a spreadsheet program like Excel."
8592 (interactive)
8593 (let* ((beg (org-table-begin))
8594 (end (org-table-end))
8595 (table (buffer-substring beg end))
8596 (file (read-file-name "Export table to: "))
8597 buf)
8598 (unless (or (not (file-exists-p file))
8599 (y-or-n-p (format "Overwrite file %s? " file)))
8600 (error "Abort"))
8601 (with-current-buffer (find-file-noselect file)
8602 (setq buf (current-buffer))
8603 (erase-buffer)
8604 (fundamental-mode)
8605 (insert table)
8606 (goto-char (point-min))
8608 (replace-match "" t t)
8609 (end-of-line 1))
8610 (goto-char (point-min))
8612 (replace-match "" t t)
8613 (goto-char (min (1+ (point)) (point-max))))
8614 (goto-char (point-min))
8615 (while (re-search-forward "^-[-+]*$" nil t)
8616 (replace-match "")
8618 (delete-char 1)))
8619 (goto-char (point-min))
8622 (save-buffer))
8623 (kill-buffer buf)))
8625 (defvar org-table-aligned-begin-marker (make-marker)
8626 "Marker at the beginning of the table last aligned.
8627 Used to check if cursor still is in that table, to minimize realignment.")
8628 (defvar org-table-aligned-end-marker (make-marker)
8629 "Marker at the end of the table last aligned.
8630 Used to check if cursor still is in that table, to minimize realignment.")
8631 (defvar org-table-last-alignment nil
8632 "List of flags for flushright alignment, from the last re-alignment.
8633 This is being used to correctly align a single field after TAB or RET.")
8634 (defvar org-table-last-column-widths nil
8635 "List of max width of fields in each column.
8636 This is being used to correctly align a single field after TAB or RET.")
8637 (defvar org-table-overlay-coordinates nil
8638 "Overlay coordinates after each align of a table.")
8639 (make-variable-buffer-local 'org-table-overlay-coordinates)
8641 (defvar org-last-recalc-line nil)
8642 (defconst org-narrow-column-arrow "=>"
8643 "Used as display property in narrowed table columns.")
8645 (defun org-table-align ()
8646 "Align the table at point by aligning all vertical bars."
8647 (interactive)
8648 (let* (
8649 ;; Limits of table
8650 (beg (org-table-begin))
8651 (end (org-table-end))
8652 ;; Current cursor position
8653 (linepos (org-current-line))
8654 (colpos (org-table-current-column))
8655 (winstart (window-start))
8656 (winstartline (org-current-line (min winstart (1- (point-max)))))
8657 lines (new "") lengths l typenums ty fields maxfields i
8658 column
8659 (indent "") cnt frac
8660 rfmt hfmt
8661 (spaces '(1 . 1))
8662 (sp1 (car spaces))
8663 (sp2 (cdr spaces))
8664 (rfmt1 (concat
8665 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8666 (hfmt1 (concat
8667 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8668 emptystrings links dates emph narrow fmax f1 len c e)
8669 (untabify beg end)
8670 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8671 ;; Check if we have links or dates
8672 (goto-char beg)
8673 (setq links (re-search-forward org-bracket-link-regexp end t))
8674 (goto-char beg)
8675 (setq emph (and org-hide-emphasis-markers
8676 (re-search-forward org-emph-re end t)))
8677 (goto-char beg)
8678 (setq dates (and org-display-custom-times
8679 (re-search-forward org-ts-regexp-both end t)))
8680 ;; Make sure the link properties are right
8681 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8682 ;; Make sure the date properties are right
8683 (when dates (goto-char beg) (while (org-activate-dates end)))
8684 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8686 ;; Check if we are narrowing any columns
8687 (goto-char beg)
8688 (setq narrow (and org-format-transports-properties-p
8689 (re-search-forward "<[0-9]+>" end t)))
8690 ;; Get the rows
8691 (setq lines (org-split-string
8693 ;; Store the indentation of the first line
8694 (if (string-match "^ *" (car lines))
8695 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8696 ;; Mark the hlines by setting the corresponding element to nil
8697 ;; At the same time, we remove trailing space.
8698 (setq lines (mapcar (lambda (l)
8699 (if (string-match "^ *|-" l)
8700 nil
8702 (substring l 0 (match-beginning 0))
8703 l)))
8704 lines))
8705 ;; Get the data fields by splitting the lines.
8706 (setq fields (mapcar
8707 (lambda (l)
8708 (org-split-string l " *| *"))
8709 (delq nil (copy-sequence lines))))
8710 ;; How many fields in the longest line?
8711 (condition-case nil
8712 (setq maxfields (apply 'max (mapcar 'length fields)))
8713 (error
8714 (kill-region beg end)
8715 (org-table-create org-table-default-size)
8716 (error "Empty table - created default table")))
8717 ;; A list of empty strings to fill any short rows on output
8718 (setq emptystrings (make-list maxfields ""))
8719 ;; Check for special formatting.
8720 (setq i -1)
8721 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8722 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8723 ;; Check if there is an explicit width specified
8724 (when narrow
8725 (setq c column fmax nil)
8726 (while c
8727 (setq e (pop c))
8729 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8730 ;; Find fields that are wider than fmax, and shorten them
8731 (when fmax
8732 (loop for xx in column do
8733 (when (and (stringp xx)
8734 (> (org-string-width xx) fmax))
8735 (org-add-props xx nil
8736 'help-echo
8737 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8738 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8739 (unless (> f1 1)
8741 (match-string 0 xx)))
8742 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8743 (add-text-properties (- f1 2) f1
8744 (list 'display org-narrow-column-arrow)
8745 xx)))))
8746 ;; Get the maximum width for each column
8747 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8748 ;; Get the fraction of numbers, to decide about alignment of the column
8749 (setq cnt 0 frac 0.0)
8750 (loop for x in column do
8751 (if (equal x "")
8752 nil
8753 (setq frac ( / (+ (* frac cnt)
8754 (if (string-match org-table-number-regexp x) 1 0))
8755 (setq cnt (1+ cnt))))))
8756 (push (>= frac org-table-number-fraction) typenums))
8757 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8759 ;; Store the alignment of this table, for later editing of single fields
8760 (setq org-table-last-alignment typenums
8761 org-table-last-column-widths lengths)
8763 ;; With invisible characters, `format' does not get the field width right
8764 ;; So we need to make these fields wide by hand.
8765 (when (or links emph)
8766 (loop for i from 0 upto (1- maxfields) do
8767 (setq len (nth i lengths))
8768 (loop for j from 0 upto (1- (length fields)) do
8769 (setq c (nthcdr i (car (nthcdr j fields))))
8770 (if (and (stringp (car c))
8771 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8772 ; (string-match org-bracket-link-regexp (car c))
8773 (< (org-string-width (car c)) len))
8774 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8776 ;; Compute the formats needed for output of the table
8777 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8778 (while (setq l (pop lengths))
8779 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8780 (setq rfmt (concat rfmt (format rfmt1 ty l))
8781 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8785 (setq new (mapconcat
8786 (lambda (l)
8787 (if l (apply 'format rfmt
8788 (append (pop fields) emptystrings))
8789 hfmt))
8790 lines ""))
8791 ;; Replace the old one
8792 (delete-region beg end)
8793 (move-marker end nil)
8794 (move-marker org-table-aligned-begin-marker (point))
8795 (insert new)
8796 (move-marker org-table-aligned-end-marker (point))
8797 (when (and orgtbl-mode (not (org-mode-p)))
8798 (goto-char org-table-aligned-begin-marker)
8799 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8800 ;; Try to move to the old location
8801 (goto-line winstartline)
8802 (setq winstart (point-at-bol))
8803 (goto-line linepos)
8804 (set-window-start (selected-window) winstart 'noforce)
8805 (org-table-goto-column colpos)
8806 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8807 (setq org-table-may-need-update nil)
8808 ))
8810 (defun org-string-width (s)
8811 "Compute width of string, ignoring invisible characters.
8812 This ignores character with invisibility property `org-link', and also
8813 characters with property `org-cwidth', because these will become invisible
8814 upon the next fontification round."
8815 (let (b l)
8816 (when (or (eq t buffer-invisibility-spec)
8817 (assq 'org-link buffer-invisibility-spec))
8818 (while (setq b (text-property-any 0 (length s)
8819 'invisible 'org-link s))
8820 (setq s (concat (substring s 0 b)
8821 (substring s (or (next-single-property-change
8822 b 'invisible s) (length s)))))))
8823 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8824 (setq s (concat (substring s 0 b)
8825 (substring s (or (next-single-property-change
8826 b 'org-cwidth s) (length s))))))
8827 (setq l (string-width s) b -1)
8828 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8829 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8830 l))
8832 (defun org-table-begin (&optional table-type)
8833 "Find the beginning of the table and return its position.
8834 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8835 (save-excursion
8836 (if (not (re-search-backward
8837 (if table-type org-table-any-border-regexp
8838 org-table-border-regexp)
8839 nil t))
8840 (progn (goto-char (point-min)) (point))
8841 (goto-char (match-beginning 0))
8842 (beginning-of-line 2)
8843 (point))))
8845 (defun org-table-end (&optional table-type)
8846 "Find the end of the table and return its position.
8847 With argument TABLE-TYPE, go to the end of a table.el-type table."
8848 (save-excursion
8849 (if (not (re-search-forward
8850 (if table-type org-table-any-border-regexp
8851 org-table-border-regexp)
8852 nil t))
8853 (goto-char (point-max))
8854 (goto-char (match-beginning 0)))
8855 (point-marker)))
8857 (defun org-table-justify-field-maybe (&optional new)
8858 "Justify the current field, text to left, number to right.
8859 Optional argument NEW may specify text to replace the current field content."
8860 (cond
8861 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8862 ((org-at-table-hline-p))
8863 ((and (not new)
8864 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8865 (current-buffer)))
8866 (< (point) org-table-aligned-begin-marker)
8867 (>= (point) org-table-aligned-end-marker)))
8868 ;; This is not the same table, force a full re-align
8869 (setq org-table-may-need-update t))
8870 (t ;; realign the current field, based on previous full realign
8871 (let* ((pos (point)) s
8872 (col (org-table-current-column))
8873 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8874 l f n o e)
8875 (when (> col 0)
8878 (progn
8879 (setq s (match-string 1)
8880 o (match-string 0)
8881 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8882 e (not (= (match-beginning 2) (match-end 2))))
8883 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8884 l (if e "|" (setq org-table-may-need-update t) ""))
8885 n (format f s))
8886 (if new
8887 (if (<= (length new) l) ;; FIXME: length -> str-width?
8888 (setq n (format f new))
8889 (setq n (concat new "|") org-table-may-need-update t)))
8890 (or (equal n o)
8891 (let (org-table-may-need-update)
8892 (replace-match n t t))))
8893 (setq org-table-may-need-update t))
8894 (goto-char pos))))))
8896 (defun org-table-next-field ()
8897 "Go to the next field in the current table, creating new lines as needed.
8898 Before doing so, re-align the table if necessary."
8899 (interactive)
8900 (org-table-maybe-eval-formula)
8901 (org-table-maybe-recalculate-line)
8902 (if (and org-table-automatic-realign
8903 org-table-may-need-update)
8904 (org-table-align))
8905 (let ((end (org-table-end)))
8906 (if (org-at-table-hline-p)
8907 (end-of-line 1))
8908 (condition-case nil
8909 (progn
8910 (re-search-forward "|" end)
8912 (re-search-forward "|" end))
8913 (if (and (looking-at "-")
8914 org-table-tab-jumps-over-hlines
8916 (goto-char (match-beginning 1)))
8917 (if (looking-at "-")
8918 (progn
8919 (beginning-of-line 0)
8920 (org-table-insert-row 'below))
8921 (if (looking-at " ") (forward-char 1))))
8922 (error
8923 (org-table-insert-row 'below)))))
8925 (defun org-table-previous-field ()
8926 "Go to the previous field in the table.
8927 Before doing so, re-align the table if necessary."
8928 (interactive)
8929 (org-table-justify-field-maybe)
8930 (org-table-maybe-recalculate-line)
8931 (if (and org-table-automatic-realign
8932 org-table-may-need-update)
8933 (org-table-align))
8934 (if (org-at-table-hline-p)
8935 (end-of-line 1))
8936 (re-search-backward "|" (org-table-begin))
8937 (re-search-backward "|" (org-table-begin))
8939 (re-search-backward "|" (org-table-begin)))
8940 (if (looking-at "| ?")
8941 (goto-char (match-end 0))))
8943 (defun org-table-next-row ()
8944 "Go to the next row (same column) in the current table.
8945 Before doing so, re-align the table if necessary."
8946 (interactive)
8947 (org-table-maybe-eval-formula)
8948 (org-table-maybe-recalculate-line)
8951 (newline)
8952 (if (and org-table-automatic-realign
8953 org-table-may-need-update)
8954 (org-table-align))
8955 (let ((col (org-table-current-column)))
8956 (beginning-of-line 2)
8957 (if (or (not (org-at-table-p))
8958 (org-at-table-hline-p))
8959 (progn
8960 (beginning-of-line 0)
8961 (org-table-insert-row 'below)))
8962 (org-table-goto-column col)
8964 (if (looking-at " ") (forward-char 1)))))
8966 (defun org-table-copy-down (n)
8967 "Copy a field down in the current column.
8968 If the field at the cursor is empty, copy into it the content of the nearest
8969 non-empty field above. With argument N, use the Nth non-empty field.
8970 If the current field is not empty, it is copied down to the next row, and
8971 the cursor is moved with it. Therefore, repeating this command causes the
8972 column to be filled row-by-row.
8973 If the variable `org-table-copy-increment' is non-nil and the field is an
8974 integer or a timestamp, it will be incremented while copying. In the case of
8975 a timestamp, if the cursor is on the year, change the year. If it is on the
8976 month or the day, change that. Point will stay on the current date field
8977 in order to easily repeat the interval."
8978 (interactive "p")
8979 (let* ((colpos (org-table-current-column))
8980 (col (current-column))
8981 (field (org-table-get-field))
8983 (beg (org-table-begin))
8984 txt)
8985 (org-table-check-inside-data-field)
8986 (if non-empty
8987 (progn
8988 (setq txt (org-trim field))
8989 (org-table-next-row)
8990 (org-table-blank-field))
8991 (save-excursion
8992 (setq txt
8993 (catch 'exit
8994 (while (progn (beginning-of-line 1)
8995 (re-search-backward org-table-dataline-regexp
8996 beg t))
8997 (org-table-goto-column colpos t)
8998 (if (and (looking-at
9000 (= (setq n (1- n)) 0))
9001 (throw 'exit (match-string 1))))))))
9002 (if txt
9003 (progn
9004 (if (and org-table-copy-increment
9005 (string-match "^[0-9]+$" txt))
9006 (setq txt (format "%d" (+ (string-to-number txt) 1))))
9007 (insert txt)
9008 (move-to-column col)
9009 (if (and org-table-copy-increment (org-at-timestamp-p t))
9010 (org-timestamp-up 1)
9011 (org-table-maybe-recalculate-line))
9012 (org-table-align)
9013 (move-to-column col))
9014 (error "No non-empty field found"))))
9016 (defun org-table-check-inside-data-field ()
9017 "Is point inside a table data field?
9018 I.e. not on a hline or before the first or after the last column?
9019 This actually throws an error, so it aborts the current command."
9020 (if (or (not (org-at-table-p))
9021 (= (org-table-current-column) 0)
9022 (org-at-table-hline-p)
9024 (error "Not in table data field")))
9026 (defvar org-table-clip nil
9027 "Clipboard for table regions.")
9029 (defun org-table-blank-field ()
9030 "Blank the current table field or active region."
9031 (interactive)
9032 (org-table-check-inside-data-field)
9033 (if (and (interactive-p) (org-region-active-p))
9034 (let (org-table-clip)
9035 (org-table-cut-region (region-beginning) (region-end)))
9036 (skip-chars-backward "^|")
9037 (backward-char 1)
9039 (let* ((pos (match-beginning 0))
9040 (match (match-string 0))
9041 (len (org-string-width match)))
9042 (replace-match (concat "|" (make-string (1- len) ?\ )))
9043 (goto-char (+ 2 pos))
9044 (substring match 1)))))
9046 (defun org-table-get-field (&optional n replace)
9047 "Return the value of the field in column N of current row.
9048 N defaults to current field.
9049 If REPLACE is a string, replace field with this value. The return value
9050 is always the old value."
9051 (and n (org-table-goto-column n))
9053 (backward-char 1)
9055 (let* ((pos (match-beginning 0))
9056 (val (buffer-substring (1+ pos) (match-end 0))))
9057 (if replace
9058 (replace-match (concat "|" replace) t t))
9059 (goto-char (min (point-at-eol) (+ 2 pos)))
9060 val)
9061 (forward-char 1) ""))
9063 (defun org-table-field-info (arg)
9064 "Show info about the current field, and highlight any reference at point."
9065 (interactive "P")
9066 (org-table-get-specials)
9067 (save-excursion
9068 (let* ((pos (point))
9069 (col (org-table-current-column))
9070 (cname (car (rassoc (int-to-string col) org-table-column-names)))
9071 (name (car (rassoc (list (org-current-line) col)
9072 org-table-named-field-locations)))
9073 (eql (org-table-get-stored-formulas))
9074 (dline (org-table-current-dline))
9075 (ref (format "@%d$%d" dline col))
9076 (ref1 (org-table-convert-refs-to-an ref))
9077 (fequation (or (assoc name eql) (assoc ref eql)))
9078 (cequation (assoc (int-to-string col) eql))
9079 (eqn (or fequation cequation)))
9080 (goto-char pos)
9081 (condition-case nil
9082 (org-table-show-reference 'local)
9083 (error nil))
9084 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
9085 dline col
9086 (if cname (concat " or $" cname) "")
9087 dline col ref1
9088 (if name (concat " or $" name) "")
9089 ;; FIXME: formula info not correct if special table line
9090 (if eqn
9091 (concat ", formula: "
9092 (org-table-formula-to-user
9093 (concat
9094 (if (string-match "^[$@]"(car eqn)) "" "$")
9095 (car eqn) "=" (cdr eqn))))
9096 "")))))
9098 (defun org-table-current-column ()
9099 "Find out which column we are in.
9100 When called interactively, column is also displayed in echo area."
9101 (interactive)
9102 (if (interactive-p) (org-table-check-inside-data-field))
9103 (save-excursion
9104 (let ((cnt 0) (pos (point)))
9105 (beginning-of-line 1)
9106 (while (search-forward "|" pos t)
9107 (setq cnt (1+ cnt)))
9108 (if (interactive-p) (message "This is table column %d" cnt))
9109 cnt)))
9111 (defun org-table-current-dline ()
9112 "Find out what table data line we are in.
9113 Only datalins count for this."
9114 (interactive)
9115 (if (interactive-p) (org-table-check-inside-data-field))
9116 (save-excursion
9117 (let ((cnt 0) (pos (point)))
9118 (goto-char (org-table-begin))
9119 (while (<= (point) pos)
9120 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
9121 (beginning-of-line 2))
9122 (if (interactive-p) (message "This is table line %d" cnt))
9123 cnt)))
9125 (defun org-table-goto-column (n &optional on-delim force)
9126 "Move the cursor to the Nth column in the current table line.
9127 With optional argument ON-DELIM, stop with point before the left delimiter
9128 of the field.
9129 If there are less than N fields, just go to after the last delimiter.
9130 However, when FORCE is non-nil, create new columns if necessary."
9131 (interactive "p")
9132 (let ((pos (point-at-eol)))
9133 (beginning-of-line 1)
9134 (when (> n 0)
9135 (while (and (> (setq n (1- n)) -1)
9136 (or (search-forward "|" pos t)
9137 (and force
9138 (progn (end-of-line 1)
9139 (skip-chars-backward "^|")
9140 (insert " | "))))))
9141 ; (backward-char 2) t)))))
9142 (when (and force (not (looking-at ".*|")))
9143 (save-excursion (end-of-line 1) (insert " | ")))
9144 (if on-delim
9145 (backward-char 1)
9146 (if (looking-at " ") (forward-char 1))))))
9148 (defun org-at-table-p (&optional table-type)
9149 "Return t if the cursor is inside an org-type table.
9150 If TABLE-TYPE is non-nil, also check for table.el-type tables."
9151 (if org-enable-table-editor
9152 (save-excursion
9153 (beginning-of-line 1)
9154 (looking-at (if table-type org-table-any-line-regexp
9155 org-table-line-regexp)))
9156 nil))
9158 (defun org-at-table.el-p ()
9159 "Return t if and only if we are at a table.el table."
9160 (and (org-at-table-p 'any)
9161 (save-excursion
9162 (goto-char (org-table-begin 'any))
9163 (looking-at org-table1-hline-regexp))))
9165 (defun org-table-recognize-table.el ()
9166 "If there is a table.el table nearby, recognize it and move into it."
9167 (if org-table-tab-recognizes-table.el
9168 (if (org-at-table.el-p)
9169 (progn
9170 (beginning-of-line 1)
9171 (if (looking-at org-table-dataline-regexp)
9172 nil
9173 (if (looking-at org-table1-hline-regexp)
9174 (progn
9175 (beginning-of-line 2)
9176 (if (looking-at org-table-any-border-regexp)
9177 (beginning-of-line -1)))))
9178 (if (re-search-forward "|" (org-table-end t) t)
9179 (progn
9180 (require 'table)
9181 (if (table--at-cell-p (point))
9182 t
9183 (message "recognizing table.el table...")
9184 (table-recognize-table)
9185 (message "recognizing table.el table...done")))
9186 (error "This should not happen..."))
9187 t)
9188 nil)
9189 nil))
9191 (defun org-at-table-hline-p ()
9192 "Return t if the cursor is inside a hline in a table."
9193 (if org-enable-table-editor
9194 (save-excursion
9195 (beginning-of-line 1)
9196 (looking-at org-table-hline-regexp))
9197 nil))
9199 (defun org-table-insert-column ()
9200 "Insert a new column into the table."
9201 (interactive)
9202 (if (not (org-at-table-p))
9203 (error "Not at a table"))
9204 (org-table-find-dataline)
9205 (let* ((col (max 1 (org-table-current-column)))
9206 (beg (org-table-begin))
9207 (end (org-table-end))
9208 ;; Current cursor position
9209 (linepos (org-current-line))
9210 (colpos col))
9211 (goto-char beg)
9212 (while (< (point) end)
9213 (if (org-at-table-hline-p)
9214 nil
9215 (org-table-goto-column col t)
9216 (insert "| "))
9217 (beginning-of-line 2))
9218 (move-marker end nil)
9219 (goto-line linepos)
9220 (org-table-goto-column colpos)
9221 (org-table-align)
9222 (org-table-fix-formulas "$" nil (1- col) 1)))
9224 (defun org-table-find-dataline ()
9225 "Find a dataline in the current table, which is needed for column commands."
9226 (if (and (org-at-table-p)
9227 (not (org-at-table-hline-p)))
9228 t
9229 (let ((col (current-column))
9230 (end (org-table-end)))
9231 (move-to-column col)
9232 (while (and (< (point) end)
9233 (or (not (= (current-column) col))
9234 (org-at-table-hline-p)))
9235 (beginning-of-line 2)
9236 (move-to-column col))
9237 (if (and (org-at-table-p)
9238 (not (org-at-table-hline-p)))
9239 t
9240 (error
9241 "Please position cursor in a data line for column operations")))))
9243 (defun org-table-delete-column ()
9244 "Delete a column from the table."
9245 (interactive)
9246 (if (not (org-at-table-p))
9247 (error "Not at a table"))
9248 (org-table-find-dataline)
9249 (org-table-check-inside-data-field)
9250 (let* ((col (org-table-current-column))
9251 (beg (org-table-begin))
9252 (end (org-table-end))
9253 ;; Current cursor position
9254 (linepos (org-current-line))
9255 (colpos col))
9256 (goto-char beg)
9257 (while (< (point) end)
9258 (if (org-at-table-hline-p)
9259 nil
9260 (org-table-goto-column col t)
9262 (replace-match "|")))
9263 (beginning-of-line 2))
9264 (move-marker end nil)
9265 (goto-line linepos)
9266 (org-table-goto-column colpos)
9267 (org-table-align)
9268 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9269 col -1 col)))
9271 (defun org-table-move-column-right ()
9272 "Move column to the right."
9273 (interactive)
9274 (org-table-move-column nil))
9275 (defun org-table-move-column-left ()
9276 "Move column to the left."
9277 (interactive)
9278 (org-table-move-column 'left))
9280 (defun org-table-move-column (&optional left)
9281 "Move the current column to the right. With arg LEFT, move to the left."
9282 (interactive "P")
9283 (if (not (org-at-table-p))
9284 (error "Not at a table"))
9285 (org-table-find-dataline)
9286 (org-table-check-inside-data-field)
9287 (let* ((col (org-table-current-column))
9288 (col1 (if left (1- col) col))
9289 (beg (org-table-begin))
9290 (end (org-table-end))
9291 ;; Current cursor position
9292 (linepos (org-current-line))
9293 (colpos (if left (1- col) (1+ col))))
9294 (if (and left (= col 1))
9295 (error "Cannot move column further left"))
9297 (error "Cannot move column further right"))
9298 (goto-char beg)
9299 (while (< (point) end)
9300 (if (org-at-table-hline-p)
9301 nil
9302 (org-table-goto-column col1 t)
9305 (beginning-of-line 2))
9306 (move-marker end nil)
9307 (goto-line linepos)
9308 (org-table-goto-column colpos)
9309 (org-table-align)
9310 (org-table-fix-formulas
9311 "$" (list (cons (number-to-string col) (number-to-string colpos))
9312 (cons (number-to-string colpos) (number-to-string col))))))
9314 (defun org-table-move-row-down ()
9315 "Move table row down."
9316 (interactive)
9317 (org-table-move-row nil))
9318 (defun org-table-move-row-up ()
9319 "Move table row up."
9320 (interactive)
9321 (org-table-move-row 'up))
9323 (defun org-table-move-row (&optional up)
9324 "Move the current table line down. With arg UP, move it up."
9325 (interactive "P")
9326 (let* ((col (current-column))
9327 (pos (point))
9328 (hline1p (save-excursion (beginning-of-line 1)
9329 (looking-at org-table-hline-regexp)))
9330 (dline1 (org-table-current-dline))
9331 (dline2 (+ dline1 (if up -1 1)))
9332 (tonew (if up 0 2))
9333 txt hline2p)
9334 (beginning-of-line tonew)
9335 (unless (org-at-table-p)
9336 (goto-char pos)
9337 (error "Cannot move row further"))
9338 (setq hline2p (looking-at org-table-hline-regexp))
9339 (goto-char pos)
9340 (beginning-of-line 1)
9341 (setq pos (point))
9342 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9343 (delete-region (point) (1+ (point-at-eol)))
9344 (beginning-of-line tonew)
9345 (insert txt)
9346 (beginning-of-line 0)
9347 (move-to-column col)
9348 (unless (or hline1p hline2p)
9349 (org-table-fix-formulas
9350 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9351 (cons (number-to-string dline2) (number-to-string dline1)))))))
9353 (defun org-table-insert-row (&optional arg)
9354 "Insert a new row above the current line into the table.
9355 With prefix ARG, insert below the current line."
9356 (interactive "P")
9357 (if (not (org-at-table-p))
9358 (error "Not at a table"))
9359 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9360 (new (org-table-clean-line line)))
9361 ;; Fix the first field if necessary
9363 (setq new (replace-match (match-string 0 line) t t new)))
9364 (beginning-of-line (if arg 2 1))
9366 (beginning-of-line 0)
9367 (re-search-forward "| ?" (point-at-eol) t)
9368 (and (or org-table-may-need-update org-table-overlay-coordinates)
9369 (org-table-align))
9370 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9372 (defun org-table-insert-hline (&optional above)
9373 "Insert a horizontal-line below the current line into the table.
9374 With prefix ABOVE, insert above the current line."
9375 (interactive "P")
9376 (if (not (org-at-table-p))
9377 (error "Not at a table"))
9378 (let ((line (org-table-clean-line
9379 (buffer-substring (point-at-bol) (point-at-eol))))
9380 (col (current-column)))
9382 (setq line (replace-match
9383 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9384 ?-) "|") t t line)))
9386 (beginning-of-line (if above 1 2))
9388 (beginning-of-line (if above 1 -1))
9389 (move-to-column col)
9390 (and org-table-overlay-coordinates (org-table-align))))
9392 (defun org-table-hline-and-move (&optional same-column)
9393 "Insert a hline and move to the row below that line."
9394 (interactive "P")
9395 (let ((col (org-table-current-column)))
9396 (org-table-maybe-eval-formula)
9397 (org-table-maybe-recalculate-line)
9398 (org-table-insert-hline)
9399 (end-of-line 2)
9402 (org-table-next-field))
9403 (if same-column (org-table-goto-column col))))
9405 (defun org-table-clean-line (s)
9407 In particular, this does handle wide and invisible characters."
9409 ;; It's a hline, just map the characters
9410 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9412 (setq s (replace-match
9413 (concat "|" (make-string (org-string-width (match-string 1 s))
9414 ?\ ) "|")
9415 t t s)))
9416 s))
9418 (defun org-table-kill-row ()
9419 "Delete the current row or horizontal line from the table."
9420 (interactive)
9421 (if (not (org-at-table-p))
9422 (error "Not at a table"))
9423 (let ((col (current-column))
9424 (dline (org-table-current-dline)))
9425 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9426 (if (not (org-at-table-p)) (beginning-of-line 0))
9427 (move-to-column col)
9428 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9429 dline -1 dline)))
9431 (defun org-table-sort-lines (with-case &optional sorting-type)
9432 "Sort table lines according to the column at point.
9434 The position of point indicates the column to be used for
9435 sorting, and the range of lines is the range between the nearest
9436 horizontal separator lines, or the entire table of no such lines
9437 exist. If point is before the first column, you will be prompted
9438 for the sorting column. If there is an active region, the mark
9439 specifies the first line and the sorting column, while point
9440 should be in the last line to be included into the sorting.
9442 The command then prompts for the sorting type which can be
9443 alphabetically, numerically, or by time (as given in a time stamp
9444 in the field). Sorting in reverse order is also possible.
9446 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9448 If SORTING-TYPE is specified when this function is called from a Lisp
9449 program, no prompting will take place. SORTING-TYPE must be a character,
9450 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9451 should be done in reverse order."
9452 (interactive "P")
9453 (let* ((thisline (org-current-line))
9454 (thiscol (org-table-current-column))
9455 beg end bcol ecol tend tbeg column lns pos)
9456 (when (equal thiscol 0)
9457 (if (interactive-p)
9458 (setq thiscol
9459 (string-to-number
9460 (read-string "Use column N for sorting: ")))
9461 (setq thiscol 1))
9462 (org-table-goto-column thiscol))
9463 (org-table-check-inside-data-field)
9464 (if (org-region-active-p)
9465 (progn
9466 (setq beg (region-beginning) end (region-end))
9467 (goto-char beg)
9468 (setq column (org-table-current-column)
9469 beg (point-at-bol))
9470 (goto-char end)
9471 (setq end (point-at-bol 2)))
9472 (setq column (org-table-current-column)
9473 pos (point)
9474 tbeg (org-table-begin)
9475 tend (org-table-end))
9476 (if (re-search-backward org-table-hline-regexp tbeg t)
9477 (setq beg (point-at-bol 2))
9478 (goto-char tbeg)
9479 (setq beg (point-at-bol 1)))
9480 (goto-char pos)
9481 (if (re-search-forward org-table-hline-regexp tend t)
9482 (setq end (point-at-bol 1))
9483 (goto-char tend)
9484 (setq end (point-at-bol))))
9485 (setq beg (move-marker (make-marker) beg)
9486 end (move-marker (make-marker) end))
9487 (untabify beg end)
9488 (goto-char beg)
9489 (org-table-goto-column column)
9490 (skip-chars-backward "^|")
9491 (setq bcol (current-column))
9492 (org-table-goto-column (1+ column))
9493 (skip-chars-backward "^|")
9494 (setq ecol (1- (current-column)))
9495 (org-table-goto-column column)
9496 (setq lns (mapcar (lambda(x) (cons
9497 (org-sort-remove-invisible
9498 (nth (1- column)
9500 x))
9502 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9503 (delete-region beg end)
9504 (move-marker beg nil)
9505 (move-marker end nil)
9507 (goto-line thisline)
9508 (org-table-goto-column thiscol)
9509 (message "%d lines sorted, based on column %d" (length lns) column)))
9511 ;; FIXME: maybe we will not need this? Table sorting is broken....
9512 (defun org-sort-remove-invisible (s)
9513 (remove-text-properties 0 (length s) org-rm-props s)
9514 (while (string-match org-bracket-link-regexp s)
9515 (setq s (replace-match (if (match-end 2)
9516 (match-string 3 s)
9517 (match-string 1 s)) t t s)))
9518 s)
9520 (defun org-table-cut-region (beg end)
9521 "Copy region in table to the clipboard and blank all relevant fields."
9522 (interactive "r")
9523 (org-table-copy-region beg end 'cut))
9525 (defun org-table-copy-region (beg end &optional cut)
9526 "Copy rectangular region in table to clipboard.
9527 A special clipboard is used which can only be accessed
9528 with `org-table-paste-rectangle'."
9529 (interactive "rP")
9530 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9531 region cols
9532 (rpl (if cut " " nil)))
9533 (goto-char beg)
9534 (org-table-check-inside-data-field)
9535 (setq l01 (org-current-line)
9536 c01 (org-table-current-column))
9537 (goto-char end)
9538 (org-table-check-inside-data-field)
9539 (setq l02 (org-current-line)
9540 c02 (org-table-current-column))
9541 (setq l1 (min l01 l02) l2 (max l01 l02)
9542 c1 (min c01 c02) c2 (max c01 c02))
9543 (catch 'exit
9544 (while t
9545 (catch 'nextline
9546 (if (> l1 l2) (throw 'exit t))
9547 (goto-line l1)
9548 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9549 (setq cols nil ic1 c1 ic2 c2)
9550 (while (< ic1 (1+ ic2))
9551 (push (org-table-get-field ic1 rpl) cols)
9552 (setq ic1 (1+ ic1)))
9553 (push (nreverse cols) region)
9554 (setq l1 (1+ l1)))))
9555 (setq org-table-clip (nreverse region))
9556 (if cut (org-table-align))
9557 org-table-clip))
9559 (defun org-table-paste-rectangle ()
9560 "Paste a rectangular region into a table.
9561 The upper right corner ends up in the current field. All involved fields
9562 will be overwritten. If the rectangle does not fit into the present table,
9563 the table is enlarged as needed. The process ignores horizontal separator
9564 lines."
9565 (interactive)
9566 (unless (and org-table-clip (listp org-table-clip))
9567 (error "First cut/copy a region to paste!"))
9568 (org-table-check-inside-data-field)
9569 (let* ((clip org-table-clip)
9570 (line (org-current-line))
9571 (col (org-table-current-column))
9572 (org-enable-table-editor t)
9573 (org-table-automatic-realign nil)
9574 c cols field)
9575 (while (setq cols (pop clip))
9576 (while (org-at-table-hline-p) (beginning-of-line 2))
9577 (if (not (org-at-table-p))
9578 (progn (end-of-line 0) (org-table-next-field)))
9579 (setq c col)
9580 (while (setq field (pop cols))
9581 (org-table-goto-column c nil 'force)
9582 (org-table-get-field nil field)
9583 (setq c (1+ c)))
9584 (beginning-of-line 2))
9585 (goto-line line)
9586 (org-table-goto-column col)
9587 (org-table-align)))
9589 (defun org-table-convert ()
9590 "Convert from `org-mode' table to table.el and back.
9591 Obviously, this only works within limits. When an Org-mode table is
9592 converted to table.el, all horizontal separator lines get lost, because
9593 table.el uses these as cell boundaries and has no notion of horizontal lines.
9594 A table.el table can be converted to an Org-mode table only if it does not
9595 do row or column spanning. Multiline cells will become multiple cells.
9596 Beware, Org-mode does not test if the table can be successfully converted - it
9597 blindly applies a recipe that works for simple tables."
9598 (interactive)
9599 (require 'table)
9600 (if (org-at-table.el-p)
9601 ;; convert to Org-mode table
9602 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9603 (end (move-marker (make-marker) (org-table-end t))))
9604 (table-unrecognize-region beg end)
9605 (goto-char beg)
9607 (replace-match ""))
9608 (goto-char beg))
9609 (if (org-at-table-p)
9610 ;; convert to table.el table
9611 (let ((beg (move-marker (make-marker) (org-table-begin)))
9612 (end (move-marker (make-marker) (org-table-end))))
9613 ;; first, get rid of all horizontal lines
9614 (goto-char beg)
9616 (replace-match ""))
9617 ;; insert a hline before first
9618 (goto-char beg)
9619 (org-table-insert-hline 'above)
9620 (beginning-of-line -1)
9621 ;; insert a hline after each line
9622 (while (progn (beginning-of-line 3) (< (point) end))
9623 (org-table-insert-hline))
9624 (goto-char beg)
9625 (setq end (move-marker end (org-table-end)))
9626 ;; replace "+" at beginning and ending of hlines
9629 (goto-char beg)
9631 (replace-match "-+"))
9632 (goto-char beg)))))
9634 (defun org-table-wrap-region (arg)
9635 "Wrap several fields in a column like a paragraph.
9636 This is useful if you'd like to spread the contents of a field over several
9637 lines, in order to keep the table compact.
9639 If there is an active region, and both point and mark are in the same column,
9640 the text in the column is wrapped to minimum width for the given number of
9641 lines. Generally, this makes the table more compact. A prefix ARG may be
9643 formats the selected text to two lines. If the region was longer than two
9644 lines, the remaining lines remain empty. A negative prefix argument reduces
9645 the current number of lines by that amount. The wrapped text is pasted back
9646 into the table. If you formatted it to more lines than it was before, fields
9647 further down in the table get overwritten - so you might need to make space in
9648 the table first.
9650 If there is no region, the current field is split at the cursor position and
9651 the text fragment to the right of the cursor is prepended to the field one
9652 line down.
9654 If there is no region, but you specify a prefix ARG, the current field gets
9655 blank, and the content is appended to the field above."
9656 (interactive "P")
9657 (org-table-check-inside-data-field)
9658 (if (org-region-active-p)
9659 ;; There is a region: fill as a paragraph
9660 (let* ((beg (region-beginning))
9661 (cline (save-excursion (goto-char beg) (org-current-line)))
9662 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9663 nlines)
9664 (org-table-cut-region (region-beginning) (region-end))
9665 (if (> (length (car org-table-clip)) 1)
9666 (error "Region must be limited to single column"))
9667 (setq nlines (if arg
9668 (if (< arg 1)
9669 (+ (length org-table-clip) arg)
9670 arg)
9671 (length org-table-clip)))
9672 (setq org-table-clip
9673 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9674 nil nlines)))
9675 (goto-line cline)
9676 (org-table-goto-column ccol)
9677 (org-table-paste-rectangle))
9678 ;; No region, split the current field at point
9679 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9681 (if arg
9682 ;; combine with field above
9683 (let ((s (org-table-blank-field))
9684 (col (org-table-current-column)))
9685 (beginning-of-line 0)
9686 (while (org-at-table-hline-p) (beginning-of-line 0))
9687 (org-table-goto-column col)
9688 (skip-chars-forward "^|")
9689 (skip-chars-backward " ")
9690 (insert " " (org-trim s))
9691 (org-table-align))
9692 ;; split field
9694 (let ((s (match-string 1)))
9695 (replace-match " |")
9696 (goto-char (match-beginning 0))
9697 (org-table-next-row)
9698 (insert (org-trim s) " ")
9699 (org-table-align))
9700 (org-table-next-row)))))
9702 (defvar org-field-marker nil)
9704 (defun org-table-edit-field (arg)
9705 "Edit table field in a different window.
9706 This is mainly useful for fields that contain hidden parts.
9708 it can be edited in place."
9709 (interactive "P")
9710 (if arg
9711 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9713 (remove-text-properties b e '(org-cwidth t invisible t
9714 display t intangible t))
9715 (if (and (boundp 'font-lock-mode) font-lock-mode)
9716 (font-lock-fontify-block)))
9717 (let ((pos (move-marker (make-marker) (point)))
9718 (field (org-table-get-field))
9719 (cw (current-window-configuration))
9720 p)
9721 (org-switch-to-buffer-other-window "*Org tmp*")
9722 (erase-buffer)
9724 (let ((org-inhibit-startup t)) (org-mode))
9725 (goto-char (setq p (point-max)))
9726 (insert (org-trim field))
9727 (remove-text-properties p (point-max)
9728 '(invisible t org-cwidth t display t
9729 intangible t))
9730 (goto-char p)
9731 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9732 (org-set-local 'org-window-configuration cw)
9733 (org-set-local 'org-field-marker pos)
9734 (message "Edit and finish with C-c C-c"))))
9736 (defun org-table-finish-edit-field ()
9737 "Finish editing a table data field.
9738 Remove all newline characters, insert the result into the table, realign
9739 the table and kill the editing buffer."
9740 (let ((pos org-field-marker)
9741 (cw org-window-configuration)
9742 (cb (current-buffer))
9743 text)
9744 (goto-char (point-min))
9747 (replace-match " "))
9748 (setq text (org-trim (buffer-string)))
9749 (set-window-configuration cw)
9750 (kill-buffer cb)
9751 (select-window (get-buffer-window (marker-buffer pos)))
9752 (goto-char pos)
9753 (move-marker pos nil)
9754 (org-table-check-inside-data-field)
9755 (org-table-get-field nil text)
9756 (org-table-align)
9757 (message "New field value inserted")))
9759 (defun org-trim (s)
9760 "Remove whitespace at beginning and end of string."
9763 s)
9765 (defun org-wrap (string &optional width lines)
9766 "Wrap string to either a number of lines, or a width in characters.
9767 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9768 that costs. If there is a word longer than WIDTH, the text is actually
9769 wrapped to the length of that word.
9770 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9771 many lines, whatever width that takes.
9772 The return value is a list of lines, without newlines at the end."
9774 (maxword (apply 'max (mapcar 'org-string-width words)))
9775 w ll)
9776 (cond (width
9777 (org-do-wrap words (max maxword width)))
9778 (lines
9779 (setq w maxword)
9780 (setq ll (org-do-wrap words maxword))
9781 (if (<= (length ll) lines)
9782 ll
9783 (setq ll words)
9784 (while (> (length ll) lines)
9785 (setq w (1+ w))
9786 (setq ll (org-do-wrap words w)))
9787 ll))
9788 (t (error "Cannot wrap this")))))
9791 (defun org-do-wrap (words width)
9792 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9793 (let (lines line)
9794 (while words
9795 (setq line (pop words))
9796 (while (and words (< (+ (length line) (length (car words))) width))
9797 (setq line (concat line " " (pop words))))
9798 (setq lines (push line lines)))
9799 (nreverse lines)))
9801 (defun org-split-string (string &optional separators)
9802 "Splits STRING into substrings at SEPARATORS.
9803 No empty strings are returned if there are matches at the beginning
9804 and end of string."
9806 (start 0)
9807 notfirst
9808 (list nil))
9809 (while (and (string-match rexp string
9810 (if (and notfirst
9811 (= start (match-beginning 0))
9812 (< start (length string)))
9813 (1+ start) start))
9814 (< (match-beginning 0) (length string)))
9815 (setq notfirst t)
9816 (or (eq (match-beginning 0) 0)
9817 (and (eq (match-beginning 0) (match-end 0))
9818 (eq (match-beginning 0) start))
9819 (setq list
9820 (cons (substring string start (match-beginning 0))
9821 list)))
9822 (setq start (match-end 0)))
9823 (or (eq start (length string))
9824 (setq list
9825 (cons (substring string start)
9826 list)))
9827 (nreverse list)))
9829 (defun org-table-map-tables (function)
9830 "Apply FUNCTION to the start of all tables in the buffer."
9831 (save-excursion
9832 (save-restriction
9833 (widen)
9834 (goto-char (point-min))
9835 (while (re-search-forward org-table-any-line-regexp nil t)
9836 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9837 (beginning-of-line 1)
9838 (if (looking-at org-table-line-regexp)
9839 (save-excursion (funcall function)))
9840 (re-search-forward org-table-any-border-regexp nil 1))))
9841 (message "Mapping tables: done"))
9843 (defvar org-timecnt) ; dynamically scoped parameter
9845 (defun org-table-sum (&optional beg end nlast)
9846 "Sum numbers in region of current table column.
9847 The result will be displayed in the echo area, and will be available
9850 If there is an active region, it is interpreted as a rectangle and all
9851 numbers in that rectangle will be summed. If there is no active
9852 region and point is located in a table column, sum all numbers in that
9853 column.
9855 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9856 numbers are assumed to be times as well (in decimal hours) and the
9857 numbers are added as such.
9859 If NLAST is a number, only the NLAST fields will actually be summed."
9860 (interactive)
9861 (save-excursion
9862 (let (col (org-timecnt 0) diff h m s org-table-clip)
9863 (cond
9864 ((and beg end)) ; beg and end given explicitly
9865 ((org-region-active-p)
9866 (setq beg (region-beginning) end (region-end)))
9867 (t
9868 (setq col (org-table-current-column))
9869 (goto-char (org-table-begin))
9871 (error "No table data"))
9872 (org-table-goto-column col)
9873 (setq beg (point))
9874 (goto-char (org-table-end))
9876 (error "No table data"))
9877 (org-table-goto-column col)
9878 (setq end (point))))
9879 (let* ((items (apply 'append (org-table-copy-region beg end)))
9880 (items1 (cond ((not nlast) items)
9881 ((>= nlast (length items)) items)
9882 (t (setq items (reverse items))
9883 (setcdr (nthcdr (1- nlast) items) nil)
9884 (nreverse items))))
9885 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9886 items1)))
9887 (res (apply '+ numbers))
9888 (sres (if (= org-timecnt 0)
9889 (format "%g" res)
9890 (setq diff (* 3600 res)
9891 h (floor (/ diff 3600)) diff (mod diff 3600)
9892 m (floor (/ diff 60)) diff (mod diff 60)
9893 s diff)
9894 (format "%d:%02d:%02d" h m s))))
9895 (kill-new sres)
9896 (if (interactive-p)
9897 (message "%s"
9898 (substitute-command-keys
9900 (length numbers) sres))))
9901 sres))))
9903 (defun org-table-get-number-for-summing (s)
9904 (let (n)
9905 (if (string-match "^ *|? *" s)
9906 (setq s (replace-match "" nil nil s)))
9907 (if (string-match " *|? *$" s)
9908 (setq s (replace-match "" nil nil s)))
9909 (setq n (string-to-number s))
9910 (cond
9911 ((and (string-match "0" s)
9915 (let ((h (string-to-number (or (match-string 1 s) "0")))
9916 (m (string-to-number (or (match-string 2 s) "0")))
9917 (s (string-to-number (or (match-string 4 s) "0"))))
9918 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9919 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9920 ((equal n 0) nil)
9921 (t n))))
9923 (defun org-table-current-field-formula (&optional key noerror)
9924 "Return the formula active for the current field.
9925 Assumes that specials are in place.
9926 If KEY is given, return the key to this formula.
9928 (let* ((name (car (rassoc (list (org-current-line)
9929 (org-table-current-column))
9930 org-table-named-field-locations)))
9931 (col (org-table-current-column))
9932 (scol (int-to-string col))
9933 (ref (format "@%d$%d" (org-table-current-dline) col))
9934 (stored-list (org-table-get-stored-formulas noerror))
9935 (ass (or (assoc name stored-list)
9936 (assoc ref stored-list)
9937 (assoc scol stored-list))))
9938 (if key
9939 (car ass)
9940 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9941 (cdr ass))))))
9943 (defun org-table-get-formula (&optional equation named)
9944 "Read a formula from the minibuffer, offer stored formula as default.
9945 When NAMED is non-nil, look for a named equation."
9946 (let* ((stored-list (org-table-get-stored-formulas))
9947 (name (car (rassoc (list (org-current-line)
9948 (org-table-current-column))
9949 org-table-named-field-locations)))
9950 (ref (format "@%d$%d" (org-table-current-dline)
9951 (org-table-current-column)))
9952 (refass (assoc ref stored-list))
9953 (scol (if named
9954 (if name name ref)
9955 (int-to-string (org-table-current-column))))
9956 (dummy (and (or name refass) (not named)
9957 (not (y-or-n-p "Replace field formula with column formula? " ))
9958 (error "Abort")))
9959 (name (or name ref))
9960 (org-table-may-need-update nil)
9961 (stored (cdr (assoc scol stored-list)))
9962 (eq (cond
9963 ((and stored equation (string-match "^ *=? *$" equation))
9964 stored)
9965 ((stringp equation)
9966 equation)
9967 (t (org-table-formula-from-user
9968 (read-string
9969 (org-table-formula-to-user
9970 (format "%s formula %s%s="
9971 (if named "Field" "Column")
9972 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9973 scol))
9974 (if stored (org-table-formula-to-user stored) "")
9975 'org-table-formula-history
9976 )))))
9977 mustsave)
9979 ;; remove formula
9980 (setq stored-list (delq (assoc scol stored-list) stored-list))
9981 (org-table-store-formulas stored-list)
9982 (error "Formula removed"))
9983 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9984 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9985 (if (and name (not named))
9986 ;; We set the column equation, delete the named one.
9987 (setq stored-list (delq (assoc name stored-list) stored-list)
9988 mustsave t))
9989 (if stored
9990 (setcdr (assoc scol stored-list) eq)
9991 (setq stored-list (cons (cons scol eq) stored-list)))
9992 (if (or mustsave (not (equal stored eq)))
9993 (org-table-store-formulas stored-list))
9994 eq))
9996 (defun org-table-store-formulas (alist)
9997 "Store the list of formulas below the current table."
9998 (setq alist (sort alist 'org-table-formula-less-p))
9999 (save-excursion
10000 (goto-char (org-table-end))
10002 (progn
10003 ;; don't overwrite TBLFM, we might use text properties to store stuff
10004 (goto-char (match-beginning 2))
10005 (delete-region (match-beginning 2) (match-end 0)))
10006 (insert "#+TBLFM:"))
10007 (insert " "
10008 (mapconcat (lambda (x)
10009 (concat
10010 (if (equal (string-to-char (car x)) ?@) "" "$")
10011 (car x) "=" (cdr x)))
10012 alist "::")
10015 (defsubst org-table-formula-make-cmp-string (a)
10017 (concat
10018 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
10019 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
10020 (if (match-end 5) (concat "@@" (match-string 5 a))))))
10022 (defun org-table-formula-less-p (a b)
10023 "Compare two formulas for sorting."
10024 (let ((as (org-table-formula-make-cmp-string (car a)))
10025 (bs (org-table-formula-make-cmp-string (car b))))
10026 (and as bs (string< as bs))))
10028 (defun org-table-get-stored-formulas (&optional noerror)
10029 "Return an alist with the stored formulas directly after current table."
10030 (interactive)
10031 (let (scol eq eq-alist strings string seen)
10032 (save-excursion
10033 (goto-char (org-table-end))
10035 (setq strings (org-split-string (match-string 2) " *:: *"))
10036 (while (setq string (pop strings))
10037 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
10038 (setq scol (if (match-end 2)
10039 (match-string 2 string)
10040 (match-string 1 string))
10041 eq (match-string 3 string)
10042 eq-alist (cons (cons scol eq) eq-alist))
10043 (if (member scol seen)
10044 (if noerror
10045 (progn
10046 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
10047 (ding)
10048 (sit-for 2))
10049 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
10050 (push scol seen))))))
10051 (nreverse eq-alist)))
10053 (defun org-table-fix-formulas (key replace &optional limit delta remove)
10054 "Modify the equations after the table structure has been edited.
10056 For all numbers larger than LIMIT, shift them by DELTA."
10057 (save-excursion
10058 (goto-char (org-table-end))
10061 (re2
10062 (when remove
10063 (if (equal key "$")
10066 s n a)
10067 (when remove
10068 (while (re-search-forward re2 (point-at-eol) t)
10069 (replace-match "")))
10070 (while (re-search-forward re (point-at-eol) t)
10071 (setq s (match-string 1) n (string-to-number s))
10072 (cond
10073 ((setq a (assoc s replace))
10074 (replace-match (concat key (cdr a)) t t))
10075 ((and limit (> n limit))
10076 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
10078 (defun org-table-get-specials ()
10079 "Get the column names and local parameters for this table."
10080 (save-excursion
10081 (let ((beg (org-table-begin)) (end (org-table-end))
10082 names name fields fields1 field cnt
10083 c v l line col types dlines hlines)
10084 (setq org-table-column-names nil
10085 org-table-local-parameters nil
10086 org-table-named-field-locations nil
10087 org-table-current-begin-line nil
10088 org-table-current-begin-pos nil
10089 org-table-current-line-types nil)
10090 (goto-char beg)
10092 (setq names (org-split-string (match-string 1) " *| *")
10093 cnt 1)
10094 (while (setq name (pop names))
10095 (setq cnt (1+ cnt))
10096 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
10097 (push (cons name (int-to-string cnt)) org-table-column-names))))
10098 (setq org-table-column-names (nreverse org-table-column-names))
10099 (setq org-table-column-name-regexp
10101 (goto-char beg)
10103 (setq fields (org-split-string (match-string 1) " *| *"))
10104 (while (setq field (pop fields))
10106 (push (cons (match-string 1 field) (match-string 2 field))
10107 org-table-local-parameters))))
10108 (goto-char beg)
10110 (setq c (match-string 1)
10111 fields (org-split-string (match-string 2) " *| *"))
10112 (save-excursion
10113 (beginning-of-line (if (equal c "_") 2 0))
10114 (setq line (org-current-line) col 1)
10116 (setq fields1 (org-split-string (match-string 1) " *| *"))))
10117 (while (and fields1 (setq field (pop fields)))
10118 (setq v (pop fields1) col (1+ col))
10119 (when (and (stringp field) (stringp v)
10120 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
10121 (push (cons field v) org-table-local-parameters)
10122 (push (list field line col) org-table-named-field-locations))))
10123 ;; Analyse the line types
10124 (goto-char beg)
10125 (setq org-table-current-begin-line (org-current-line)
10126 org-table-current-begin-pos (point)
10127 l org-table-current-begin-line)
10129 (push (if (match-end 1) 'hline 'dline) types)
10130 (if (match-end 1) (push l hlines) (push l dlines))
10131 (beginning-of-line 2)
10132 (setq l (1+ l)))
10133 (setq org-table-current-line-types (apply 'vector (nreverse types))
10134 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
10135 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
10137 (defun org-table-maybe-eval-formula ()
10139 If yes, store the formula and apply it."
10140 ;; We already know we are in a table. Get field will only return a formula
10141 ;; when appropriate. It might return a separator line, but no problem.
10142 (when org-table-formula-evaluate-inline
10143 (let* ((field (org-trim (or (org-table-get-field) "")))
10144 named eq)
10146 (setq named (equal (string-to-char field) ?:)
10147 eq (match-string 1 field))
10148 (if (or (fboundp 'calc-eval)
10149 (equal (substring eq 0 (min 2 (length eq))) "'("))
10150 (org-table-eval-formula (if named '(4) nil)
10151 (org-table-formula-from-user eq))
10152 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
10154 (defvar org-recalc-commands nil
10155 "List of commands triggering the recalculation of a line.
10156 Will be filled automatically during use.")
10158 (defvar org-recalc-marks
10159 '((" " . "Unmarked: no special line, no automatic recalculation")
10160 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10161 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10162 ("!" . "Column name definition line. Reference in formula as $name.")
10163 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10164 ("_" . "Names for values in row below this one.")
10165 ("^" . "Names for values in row above this one.")))
10167 (defun org-table-rotate-recalc-marks (&optional newchar)
10168 "Rotate the recalculation mark in the first column.
10169 If in any row, the first field is not consistent with a mark,
10170 insert a new column for the markers.
10171 When there is an active region, change all the lines in the region,
10172 after prompting for the marking character.
10173 After each change, a message will be displayed indicating the meaning
10174 of the new mark."
10175 (interactive)
10176 (unless (org-at-table-p) (error "Not at a table"))
10177 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10178 (beg (org-table-begin))
10179 (end (org-table-end))
10180 (l (org-current-line))
10181 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10182 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10183 (have-col
10184 (save-excursion
10185 (goto-char beg)
10187 (col (org-table-current-column))
10188 (forcenew (car (assoc newchar org-recalc-marks)))
10189 epos new)
10190 (when l1
10191 (message "Change region to what mark? Type # * ! $ or SPC: ")
10192 (setq newchar (char-to-string (read-char-exclusive))
10193 forcenew (car (assoc newchar org-recalc-marks))))
10194 (if (and newchar (not forcenew))
10195 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10196 newchar))
10197 (if l1 (goto-line l1))
10198 (save-excursion
10199 (beginning-of-line 1)
10200 (unless (looking-at org-table-dataline-regexp)
10201 (error "Not at a table data line")))
10202 (unless have-col
10203 (org-table-goto-column 1)
10204 (org-table-insert-column)
10205 (org-table-goto-column (1+ col)))
10206 (setq epos (point-at-eol))
10207 (save-excursion
10208 (beginning-of-line 1)
10209 (org-table-get-field
10211 (concat " "
10212 (setq new (or forcenew
10213 (cadr (member (match-string 1) marks))))
10214 " ")
10215 " # ")))
10216 (if (and l1 l2)
10217 (progn
10218 (goto-line l1)
10219 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10220 (and (looking-at org-table-dataline-regexp)
10221 (org-table-get-field 1 (concat " " new " "))))
10222 (goto-line l1)))
10223 (if (not (= epos (point-at-eol))) (org-table-align))
10224 (goto-line l)
10225 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10227 (defun org-table-maybe-recalculate-line ()
10228 "Recompute the current line if marked for it, and if we haven't just done it."
10229 (interactive)
10230 (and org-table-allow-automatic-line-recalculation
10231 (not (and (memq last-command org-recalc-commands)
10232 (equal org-last-recalc-line (org-current-line))))
10233 (save-excursion (beginning-of-line 1)
10234 (looking-at org-table-auto-recalculate-regexp))
10235 (org-table-recalculate) t))
10237 (defvar org-table-formula-debug nil
10238 "Non-nil means, debug table formulas.
10240 (make-variable-buffer-local 'org-table-formula-debug)
10242 (defvar modes)
10243 (defsubst org-set-calc-mode (var &optional value)
10244 (if (stringp var)
10245 (setq var (assoc var '(("D" calc-angle-mode deg)
10246 ("R" calc-angle-mode rad)
10247 ("F" calc-prefer-frac t)
10248 ("S" calc-symbolic-mode t)))
10249 value (nth 2 var) var (nth 1 var)))
10250 (if (memq var modes)
10251 (setcar (cdr (memq var modes)) value)
10252 (cons var (cons value modes)))
10253 modes)
10255 (defun org-table-eval-formula (&optional arg equation
10256 suppress-align suppress-const
10257 suppress-store suppress-analysis)
10258 "Replace the table field value at the cursor by the result of a calculation.
10260 This function makes use of Dave Gillespie's Calc package, in my view the
10261 most exciting program ever written for GNU Emacs. So you need to have Calc
10262 installed in order to use this function.
10264 In a table, this command replaces the value in the current field with the
10266 formula, by storing it in a special line below the table. When called
10267 with a `C-u' prefix, the current field must ba a named field, and the
10268 formula is installed as valid in only this specific field.
10270 When called with two `C-u' prefixes, insert the active equation
10271 for the field back into the current field, so that it can be
10273 to check the referenced fields.
10275 When called, the command first prompts for a formula, which is read in
10276 the minibuffer. Previously entered formulas are available through the
10277 history list, and the last used formula is offered as a default.
10278 These stored formulas are adapted correctly when moving, inserting, or
10279 deleting columns with the corresponding commands.
10281 The formula can be any algebraic expression understood by the Calc package.
10282 For details, see the Org-mode manual.
10284 This function can also be called from Lisp programs and offers
10285 additional arguments: EQUATION can be the formula to apply. If this
10286 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10287 used to speed-up recursive calls by by-passing unnecessary aligns.
10288 SUPPRESS-CONST suppresses the interpretation of constants in the
10289 formula, assuming that this has been done already outside the function.
10290 SUPPRESS-STORE means the formula should not be stored, either because
10291 it is already stored, or because it is a modified equation that should
10292 not overwrite the stored one."
10293 (interactive "P")
10294 (org-table-check-inside-data-field)
10295 (or suppress-analysis (org-table-get-specials))
10296 (if (equal arg '(16))
10297 (let ((eq (org-table-current-field-formula)))
10298 (or eq (error "No equation active for current field"))
10299 (org-table-get-field nil eq)
10300 (org-table-align)
10301 (setq org-table-may-need-update t))
10302 (let* (fields
10303 (ndown (if (integerp arg) arg 1))
10304 (org-table-automatic-realign nil)
10305 (case-fold-search nil)
10306 (down (> ndown 1))
10307 (formula (if (and equation suppress-store)
10308 equation
10309 (org-table-get-formula equation (equal arg '(4)))))
10310 (n0 (org-table-current-column))
10311 (modes (copy-sequence org-calc-default-modes))
10312 (numbers nil) ; was a variable, now fixed default
10313 (keep-empty nil)
10314 n form form0 bw fmt x ev orig c lispp literal)
10315 ;; Parse the format string. Since we have a lot of modes, this is
10316 ;; a lot of work. However, I think calc still uses most of the time.
10317 (if (string-match ";" formula)
10318 (let ((tmp (org-split-string formula ";")))
10319 (setq formula (car tmp)
10320 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10321 (nth 1 tmp)))
10323 (setq c (string-to-char (match-string 1 fmt))
10324 n (string-to-number (match-string 2 fmt)))
10325 (if (= c ?p)
10326 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10327 (setq modes (org-set-calc-mode
10328 'calc-float-format
10329 (list (cdr (assoc c '((?n . float) (?f . fix)
10330 (?s . sci) (?e . eng))))
10331 n))))
10332 (setq fmt (replace-match "" t t fmt)))
10333 (if (string-match "[NT]" fmt)
10334 (setq numbers (equal (match-string 0 fmt) "N")
10335 fmt (replace-match "" t t fmt)))
10336 (if (string-match "L" fmt)
10337 (setq literal t
10338 fmt (replace-match "" t t fmt)))
10339 (if (string-match "E" fmt)
10340 (setq keep-empty t
10341 fmt (replace-match "" t t fmt)))
10342 (while (string-match "[DRFS]" fmt)
10343 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10344 (setq fmt (replace-match "" t t fmt)))
10346 (setq fmt nil))))
10347 (if (and (not suppress-const) org-table-formula-use-constants)
10348 (setq formula (org-table-formula-substitute-names formula)))
10349 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10350 (while (> ndown 0)
10351 (setq fields (org-split-string
10352 (org-no-properties
10353 (buffer-substring (point-at-bol) (point-at-eol)))
10354 " *| *"))
10355 (if (eq numbers t)
10356 (setq fields (mapcar
10357 (lambda (x) (number-to-string (string-to-number x)))
10358 fields)))
10359 (setq ndown (1- ndown))
10360 (setq form (copy-sequence formula)
10361 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10362 (if (and lispp literal) (setq lispp 'literal))
10363 ;; Check for old vertical references
10364 (setq form (org-rewrite-old-row-references form))
10365 ;; Insert complex ranges
10366 (while (string-match org-table-range-regexp form)
10367 (setq form
10368 (replace-match
10369 (save-match-data
10370 (org-table-make-reference
10371 (org-table-get-range (match-string 0 form) nil n0)
10372 keep-empty numbers lispp))
10373 t t form)))
10374 ;; Insert simple ranges
10376 (setq form
10377 (replace-match
10378 (save-match-data
10379 (org-table-make-reference
10380 (org-sublist
10381 fields (string-to-number (match-string 1 form))
10382 (string-to-number (match-string 2 form)))
10383 keep-empty numbers lispp))
10384 t t form)))
10385 (setq form0 form)
10386 ;; Insert the references to fields in same row
10388 (setq n (string-to-number (match-string 1 form))
10389 x (nth (1- (if (= n 0) n0 n)) fields))
10391 (match-string 0 form)))
10392 (setq form (replace-match
10393 (save-match-data
10394 (org-table-make-reference x nil numbers lispp))
10395 t t form)))
10397 (if lispp
10398 (setq ev (condition-case nil
10399 (eval (eval (read form)))
10400 (error "#ERROR"))
10401 ev (if (numberp ev) (number-to-string ev) ev))
10402 (or (fboundp 'calc-eval)
10403 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10404 (setq ev (calc-eval (cons form modes)
10405 (if numbers 'num))))
10407 (when org-table-formula-debug
10408 (with-output-to-temp-buffer "*Substitution History*"
10409 (princ (format "Substitution history of formula
10410 Orig: %s
10411 $xyz-> %s
10412 @r$c-> %s
10414 (if (listp ev)
10416 (make-string (car ev) ?\-) (nth 1 ev)))
10418 ev (or fmt "NONE")
10419 (if fmt (format fmt (string-to-number ev)) ev)))))
10420 (setq bw (get-buffer-window "*Substitution History*"))
10421 (shrink-window-if-larger-than-buffer bw)
10422 (unless (and (interactive-p) (not ndown))
10423 (unless (let (inhibit-redisplay)
10424 (y-or-n-p "Debugging Formula. Continue to next? "))
10425 (org-table-align)
10426 (error "Abort"))
10427 (delete-window bw)
10428 (message "")))
10429 (if (listp ev) (setq fmt nil ev "#ERROR"))
10430 (org-table-justify-field-maybe
10431 (if fmt (format fmt (string-to-number ev)) ev))
10433 (call-interactively 'org-return)
10434 (setq ndown 0)))
10435 (and down (org-table-maybe-recalculate-line))
10436 (or suppress-align (and org-table-may-need-update
10437 (org-table-align))))))
10439 (defun org-table-put-field-property (prop value)
10440 (save-excursion
10441 (put-text-property (progn (skip-chars-backward "^|") (point))
10442 (progn (skip-chars-forward "^|") (point))
10443 prop value)))
10445 (defun org-table-get-range (desc &optional tbeg col highlight)
10446 "Get a calc vector from a column, accorting to descriptor DESC.
10447 Optional arguments TBEG and COL can give the beginning of the table and
10448 the current column, to avoid unnecessary parsing.
10449 HIGHLIGHT means, just highlight the range."
10450 (if (not (equal (string-to-char desc) ?@))
10451 (setq desc (concat "@" desc)))
10452 (save-excursion
10453 (or tbeg (setq tbeg (org-table-begin)))
10454 (or col (setq col (org-table-current-column)))
10455 (let ((thisline (org-current-line))
10456 beg end c1 c2 r1 r2 rangep tmp)
10457 (unless (string-match org-table-range-regexp desc)
10458 (error "Invalid table range specifier `%s'" desc))
10459 (setq rangep (match-end 3)
10460 r1 (and (match-end 1) (match-string 1 desc))
10461 r2 (and (match-end 4) (match-string 4 desc))
10462 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10463 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10465 (and c1 (setq c1 (+ (string-to-number c1)
10466 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10467 (and c2 (setq c2 (+ (string-to-number c2)
10468 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10469 (if (equal r1 "") (setq r1 nil))
10470 (if (equal r2 "") (setq r2 nil))
10471 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10472 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10473 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10474 (if (not r1) (setq r1 thisline))
10475 (if (not r2) (setq r2 thisline))
10476 (if (not c1) (setq c1 col))
10477 (if (not c2) (setq c2 col))
10478 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10479 ;; just one field
10480 (progn
10481 (goto-line r1)
10482 (while (not (looking-at org-table-dataline-regexp))
10483 (beginning-of-line 2))
10484 (prog1 (org-trim (org-table-get-field c1))
10485 (if highlight (org-table-highlight-rectangle (point) (point)))))
10486 ;; A range, return a vector
10487 ;; First sort the numbers to get a regular ractangle
10488 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10489 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10490 (goto-line r1)
10491 (while (not (looking-at org-table-dataline-regexp))
10492 (beginning-of-line 2))
10493 (org-table-goto-column c1)
10494 (setq beg (point))
10495 (goto-line r2)
10496 (while (not (looking-at org-table-dataline-regexp))
10497 (beginning-of-line 0))
10498 (org-table-goto-column c2)
10499 (setq end (point))
10500 (if highlight
10501 (org-table-highlight-rectangle
10503 ;; return string representation of calc vector
10504 (mapcar 'org-trim
10505 (apply 'append (org-table-copy-region beg end)))))))
10507 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10508 "Analyze descriptor DESC and retrieve the corresponding line number.
10509 The cursor is currently in line CLINE, the table begins in line BLINE,
10510 and TABLE is a vector with line types."
10511 (if (string-match "^[0-9]+$" desc)
10512 (aref org-table-dlines (string-to-number desc))
10513 (setq cline (or cline (org-current-line))
10514 bline (or bline org-table-current-begin-line)
10515 table (or table org-table-current-line-types))
10516 (if (or
10518 ;; 1 2 3 4 5 6
10519 (and (not (match-end 3)) (not (match-end 6)))
10520 (and (match-end 3) (match-end 6) (not (match-end 5))))
10521 (error "invalid row descriptor `%s'" desc))
10522 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10523 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10524 (odir (and (match-end 5) (match-string 5 desc)))
10525 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10526 (i (- cline bline))
10527 (rel (and (match-end 6)
10528 (or (and (match-end 1) (not (match-end 3)))
10529 (match-end 5)))))
10530 (if (and hn (not hdir))
10531 (progn
10532 (setq i 0 hdir "+")
10533 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10534 (if (and (not hn) on (not odir))
10535 (error "should never happen");;(aref org-table-dlines on)
10536 (if (and hn (> hn 0))
10537 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10538 (if on
10539 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10540 (+ bline i)))))
10542 (defun org-find-row-type (table i type backwards relative n)
10543 (let ((l (length table)))
10544 (while (> n 0)
10545 (while (and (setq i (+ i (if backwards -1 1)))
10546 (>= i 0) (< i l)
10547 (not (eq (aref table i) type))
10548 (if (and relative (eq (aref table i) 'hline))
10549 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10550 t)))
10551 (setq n (1- n)))
10552 (if (or (< i 0) (>= i l))
10553 (error "Row descriptior leads outside table")
10554 i)))
10556 (defun org-rewrite-old-row-references (s)
10557 (if (string-match "&[-+0-9I]" s)
10558 (error "Formula contains old &row reference, please rewrite using @-syntax")
10559 s))
10561 (defun org-table-make-reference (elements keep-empty numbers lispp)
10562 "Convert list ELEMENTS to something appropriate to insert into formula.
10563 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10564 NUMBERS indicates that everything should be converted to numbers.
10565 LISPP means to return something appropriate for a Lisp list."
10566 (if (stringp elements) ; just a single val
10567 (if lispp
10568 (if (eq lispp 'literal)
10569 elements
10570 (prin1-to-string (if numbers (string-to-number elements) elements)))
10571 (if (equal elements "") (setq elements "0"))
10572 (if numbers (number-to-string (string-to-number elements)) elements))
10573 (unless keep-empty
10574 (setq elements
10575 (delq nil
10577 elements))))
10578 (setq elements (or elements '("0")))
10579 (if lispp
10580 (mapconcat
10581 (lambda (x)
10582 (if (eq lispp 'literal)
10583 x
10584 (prin1-to-string (if numbers (string-to-number x) x))))
10585 elements " ")
10586 (concat "[" (mapconcat
10587 (lambda (x)
10588 (if numbers (number-to-string (string-to-number x)) x))
10589 elements
10590 ",") "]"))))
10592 (defun org-table-recalculate (&optional all noalign)
10593 "Recalculate the current table line by applying all stored formulas.
10594 With prefix arg ALL, do this for all lines in the table."
10595 (interactive "P")
10596 (or (memq this-command org-recalc-commands)
10597 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10598 (unless (org-at-table-p) (error "Not at a table"))
10599 (if (equal all '(16))
10600 (org-table-iterate)
10601 (org-table-get-specials)
10602 (let* ((eqlist (sort (org-table-get-stored-formulas)
10603 (lambda (a b) (string< (car a) (car b)))))
10604 (inhibit-redisplay (not debug-on-error))
10605 (line-re org-table-dataline-regexp)
10606 (thisline (org-current-line))
10607 (thiscol (org-table-current-column))
10608 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10609 ;; Insert constants in all formulas
10610 (setq eqlist
10611 (mapcar (lambda (x)
10612 (setcdr x (org-table-formula-substitute-names (cdr x)))
10613 x)
10614 eqlist))
10615 ;; Split the equation list
10616 (while (setq eq (pop eqlist))
10617 (if (<= (string-to-char (car eq)) ?9)
10618 (push eq eqlnum)
10619 (push eq eqlname)))
10620 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10621 (if all
10622 (progn
10623 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10624 (goto-char (setq beg (org-table-begin)))
10625 (if (re-search-forward org-table-calculate-mark-regexp end t)
10626 ;; This is a table with marked lines, compute selected lines
10627 (setq line-re org-table-recalculate-regexp)
10628 ;; Move forward to the first non-header line
10629 (if (and (re-search-forward org-table-dataline-regexp end t)
10630 (re-search-forward org-table-hline-regexp end t)
10631 (re-search-forward org-table-dataline-regexp end t))
10632 (setq beg (match-beginning 0))
10633 nil))) ;; just leave beg where it is
10634 (setq beg (point-at-bol)
10635 end (move-marker (make-marker) (1+ (point-at-eol)))))
10636 (goto-char beg)
10637 (and all (message "Re-applying formulas to full table..."))
10639 ;; First find the named fields, and mark them untouchanble
10640 (remove-text-properties beg end '(org-untouchable t))
10641 (while (setq eq (pop eqlname))
10642 (setq name (car eq)
10643 a (assoc name org-table-named-field-locations))
10644 (and (not a)
10646 (setq a (list name
10647 (aref org-table-dlines
10648 (string-to-number (match-string 1 name)))
10649 (string-to-number (match-string 2 name)))))
10650 (when (and a (or all (equal (nth 1 a) thisline)))
10651 (message "Re-applying formula to field: %s" name)
10652 (goto-line (nth 1 a))
10653 (org-table-goto-column (nth 2 a))
10654 (push (append a (list (cdr eq))) eqlname1)
10655 (org-table-put-field-property :org-untouchable t)))
10657 ;; Now evauluate the column formulas, but skip fields covered by
10658 ;; field formulas
10659 (goto-char beg)
10660 (while (re-search-forward line-re end t)
10661 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10662 ;; Unprotected line, recalculate
10663 (and all (message "Re-applying formulas to full table...(line %d)"
10664 (setq cnt (1+ cnt))))
10665 (setq org-last-recalc-line (org-current-line))
10666 (setq eql eqlnum)
10667 (while (setq entry (pop eql))
10668 (goto-line org-last-recalc-line)
10669 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10670 (unless (get-text-property (point) :org-untouchable)
10671 (org-table-eval-formula nil (cdr entry)
10672 'noalign 'nocst 'nostore 'noanalysis)))))
10674 ;; Now evaluate the field formulas
10675 (while (setq eq (pop eqlname1))
10676 (message "Re-applying formula to field: %s" (car eq))
10677 (goto-line (nth 1 eq))
10678 (org-table-goto-column (nth 2 eq))
10679 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10680 'nostore 'noanalysis))
10682 (goto-line thisline)
10683 (org-table-goto-column thiscol)
10684 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10685 (or noalign (and org-table-may-need-update (org-table-align))
10686 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10688 ;; back to initial position
10689 (message "Re-applying formulas...done")
10690 (goto-line thisline)
10691 (org-table-goto-column thiscol)
10692 (or noalign (and org-table-may-need-update (org-table-align))
10693 (and all (message "Re-applying formulas...done"))))))
10695 (defun org-table-iterate (&optional arg)
10696 "Recalculate the table until it does not change anymore."
10697 (interactive "P")
10698 (let ((imax (if arg (prefix-numeric-value arg) 10))
10699 (i 0)
10700 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10701 thistbl)
10702 (catch 'exit
10703 (while (< i imax)
10704 (setq i (1+ i))
10705 (org-table-recalculate 'all)
10706 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10707 (if (not (string= lasttbl thistbl))
10708 (setq lasttbl thistbl)
10709 (if (> i 1)
10710 (message "Convergence after %d iterations" i)
10711 (message "Table was already stable"))
10712 (throw 'exit t)))
10713 (error "No convergence after %d iterations" i))))
10715 (defun org-table-formula-substitute-names (f)
10716 "Replace $const with values in string F."
10717 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10718 ;; First, check for column names
10719 (while (setq start (string-match org-table-column-name-regexp f start))
10720 (setq start (1+ start))
10721 (setq a (assoc (match-string 1 f) org-table-column-names))
10722 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10723 ;; Parameters and constants
10724 (setq start 0)
10726 (setq start (1+ start))
10727 (if (setq a (save-match-data
10728 (org-table-get-constant (match-string 1 f))))
10729 (setq f (replace-match
10730 (concat (if pp "(") a (if pp ")")) t t f))))
10731 (if org-table-formula-debug
10732 (put-text-property 0 (length f) :orig-formula f1 f))
10733 f))
10735 (defun org-table-get-constant (const)
10736 "Find the value for a parameter or constant in a formula.
10737 Parameters get priority."
10738 (or (cdr (assoc const org-table-local-parameters))
10739 (cdr (assoc const org-table-formula-constants-local))
10740 (cdr (assoc const org-table-formula-constants))
10741 (and (fboundp 'constants-get) (constants-get const))
10742 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10743 (org-entry-get nil (substring const 5) 'inherit))
10744 "#UNDEFINED_NAME"))
10746 (defvar org-table-fedit-map
10747 (let ((map (make-sparse-keymap)))
10748 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10749 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10750 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10751 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10752 (org-defkey map "\C-c?" 'org-table-show-reference)
10753 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10754 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10755 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10756 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10757 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10758 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10759 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10760 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10761 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10762 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10763 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10764 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10765 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10766 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10767 map))
10769 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10770 '("Edit-Formulas"
10771 ["Finish and Install" org-table-fedit-finish t]
10772 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10773 ["Abort" org-table-fedit-abort t]
10774 "--"
10775 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10776 ["Complete Lisp Symbol" lisp-complete-symbol t]
10777 "--"
10778 "Shift Reference at Point"
10779 ["Up" org-table-fedit-ref-up t]
10780 ["Down" org-table-fedit-ref-down t]
10781 ["Left" org-table-fedit-ref-left t]
10782 ["Right" org-table-fedit-ref-right t]
10783 "-"
10784 "Change Test Row for Column Formulas"
10785 ["Up" org-table-fedit-line-up t]
10786 ["Down" org-table-fedit-line-down t]
10787 "--"
10788 ["Scroll Table Window" org-table-fedit-scroll t]
10789 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10790 ["Show Table Grid" org-table-fedit-toggle-coordinates
10791 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10792 org-table-overlay-coordinates)]
10793 "--"
10794 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10795 :style toggle :selected org-table-buffer-is-an]))
10797 (defvar org-pos)
10799 (defun org-table-edit-formulas ()
10800 "Edit the formulas of the current table in a separate buffer."
10801 (interactive)
10803 (beginning-of-line 0))
10804 (unless (org-at-table-p) (error "Not at a table"))
10805 (org-table-get-specials)
10806 (let ((key (org-table-current-field-formula 'key 'noerror))
10807 (eql (sort (org-table-get-stored-formulas 'noerror)
10808 'org-table-formula-less-p))
10809 (pos (move-marker (make-marker) (point)))
10810 (startline 1)
10811 (wc (current-window-configuration))
10815 entry s type title)
10816 (org-switch-to-buffer-other-window "*Edit Formulas*")
10817 (erase-buffer)
10818 ;; Keep global-font-lock-mode from turning on font-lock-mode
10819 (let ((font-lock-global-modes '(not fundamental-mode)))
10820 (fundamental-mode))
10821 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10822 (org-set-local 'org-pos pos)
10823 (org-set-local 'org-window-configuration wc)
10824 (use-local-map org-table-fedit-map)
10825 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10826 (easy-menu-add org-table-fedit-menu)
10827 (setq startline (org-current-line))
10828 (while (setq entry (pop eql))
10829 (setq type (cond
10830 ((equal (string-to-char (car entry)) ?@) 'field)
10831 ((string-match "^[0-9]" (car entry)) 'column)
10832 (t 'named)))
10833 (when (setq title (assq type titles))
10835 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10836 (setq titles (delq title titles)))
10837 (if (equal key (car entry)) (setq startline (org-current-line)))
10838 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10840 (remove-text-properties 0 (length s) '(face nil) s)
10841 (insert s))
10842 (if (eq org-table-use-standard-references t)
10843 (org-table-fedit-toggle-ref-type))
10844 (goto-line startline)
10845 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10847 (defun org-table-fedit-post-command ()
10848 (when (not (memq this-command '(lisp-complete-symbol)))
10849 (let ((win (selected-window)))
10850 (save-excursion
10851 (condition-case nil
10852 (org-table-show-reference)
10853 (error nil))
10854 (select-window win)))))
10856 (defun org-table-formula-to-user (s)
10857 "Convert a formula from internal to user representation."
10858 (if (eq org-table-use-standard-references t)
10859 (org-table-convert-refs-to-an s)
10860 s))
10862 (defun org-table-formula-from-user (s)
10863 "Convert a formula from user to internal representation."
10864 (if org-table-use-standard-references
10865 (org-table-convert-refs-to-rc s)
10866 s))
10868 (defun org-table-convert-refs-to-rc (s)
10869 "Convert spreadsheet references from AB7 to @7$28.
10870 Works for single references, but also for entire formulas and even the
10871 full TBLFM line."
10872 (let ((start 0))
10874 (cond
10875 ((match-end 3)
10876 ;; format match, just advance
10877 (setq start (match-end 0)))
10878 ((and (> (match-beginning 0) 0)
10879 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10880 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10881 ;; 3.e5 or something like this.
10882 (setq start (match-end 0)))
10883 (t
10884 (setq start (match-beginning 0)
10885 s (replace-match
10886 (if (equal (match-string 2 s) "&")
10887 (format "$%d" (org-letters-to-number (match-string 1 s)))
10888 (format "@%d$%d"
10889 (string-to-number (match-string 2 s))
10890 (org-letters-to-number (match-string 1 s))))
10891 t t s)))))
10892 s))
10894 (defun org-table-convert-refs-to-an (s)
10895 "Convert spreadsheet references from to @7$28 to AB7.
10896 Works for single references, but also for entire formulas and even the
10897 full TBLFM line."
10899 (setq s (replace-match
10900 (format "%s%d"
10901 (org-number-to-letters
10902 (string-to-number (match-string 2 s)))
10903 (string-to-number (match-string 1 s)))
10904 t t s)))
10907 (org-number-to-letters
10908 (string-to-number (match-string 2 s))) "&")
10909 t nil s)))
10910 s)
10912 (defun org-letters-to-number (s)
10913 "Convert a base 26 number represented by letters into an integer.
10914 For example: AB -> 28."
10915 (let ((n 0))
10916 (setq s (upcase s))
10917 (while (> (length s) 0)
10918 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10919 s (substring s 1)))
10920 n))
10922 (defun org-number-to-letters (n)
10923 "Convert an integer into a base 26 number represented by letters.
10924 For example: 28 -> AB."
10925 (let ((s ""))
10926 (while (> n 0)
10927 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10928 n (/ (1- n) 26)))
10929 s))
10931 (defun org-table-fedit-convert-buffer (function)
10932 "Convert all references in this buffer, using FUNTION."
10933 (let ((line (org-current-line)))
10934 (goto-char (point-min))
10935 (while (not (eobp))
10936 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10937 (delete-region (point) (point-at-eol))
10938 (or (eobp) (forward-char 1)))
10939 (goto-line line)))
10941 (defun org-table-fedit-toggle-ref-type ()
10942 "Convert all references in the buffer from B3 to @3$2 and back."
10943 (interactive)
10944 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10945 (org-table-fedit-convert-buffer
10946 (if org-table-buffer-is-an
10947 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10948 (message "Reference type switched to %s"
10949 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10951 (defun org-table-fedit-ref-up ()
10952 "Shift the reference at point one row/hline up."
10953 (interactive)
10954 (org-table-fedit-shift-reference 'up))
10955 (defun org-table-fedit-ref-down ()
10956 "Shift the reference at point one row/hline down."
10957 (interactive)
10958 (org-table-fedit-shift-reference 'down))
10959 (defun org-table-fedit-ref-left ()
10960 "Shift the reference at point one field to the left."
10961 (interactive)
10962 (org-table-fedit-shift-reference 'left))
10963 (defun org-table-fedit-ref-right ()
10964 "Shift the reference at point one field to the right."
10965 (interactive)
10966 (org-table-fedit-shift-reference 'right))
10968 (defun org-table-fedit-shift-reference (dir)
10969 (cond
10971 (if (memq dir '(left right))
10972 (org-rematch-and-replace 1 (eq dir 'left))
10973 (error "Cannot shift reference in this direction")))
10975 ;; A B3-like reference
10976 (if (memq dir '(up down))
10977 (org-rematch-and-replace 2 (eq dir 'up))
10978 (org-rematch-and-replace 1 (eq dir 'left))))
10979 ((org-at-regexp-p
10981 ;; An internal reference
10982 (if (memq dir '(up down))
10983 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10984 (org-rematch-and-replace 5 (eq dir 'left))))))
10986 (defun org-rematch-and-replace (n &optional decr hline)
10987 "Re-match the group N, and replace it with the shifted refrence."
10988 (or (match-end n) (error "Cannot shift reference in this direction"))
10989 (goto-char (match-beginning n))
10990 (and (looking-at (regexp-quote (match-string n)))
10991 (replace-match (org-shift-refpart (match-string 0) decr hline)
10992 t t)))
10994 (defun org-shift-refpart (ref &optional decr hline)
10995 "Shift a refrence part REF.
10996 If DECR is set, decrease the references row/column, else increase.
10997 If HLINE is set, this may be a hline reference, it certainly is not
10998 a translation reference."
10999 (save-match-data
11000 (let* ((sign (string-match "^[-+]" ref)) n)
11002 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
11003 (cond
11004 ((and hline (string-match "^I+" ref))
11005 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
11006 (setq n (+ n (if decr -1 1)))
11007 (if (= n 0) (setq n (+ n (if decr -1 1))))
11008 (if sign
11009 (setq sign (if (< n 0) "-" "+") n (abs n))
11010 (setq n (max 1 n)))
11011 (concat sign (make-string n ?I)))
11013 ((string-match "^[0-9]+" ref)
11014 (setq n (string-to-number (concat sign ref)))
11015 (setq n (+ n (if decr -1 1)))
11016 (if sign
11017 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
11018 (number-to-string (max 1 n))))
11020 ((string-match "^[a-zA-Z]+" ref)
11021 (org-number-to-letters
11022 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
11024 (t (error "Cannot shift reference"))))))
11026 (defun org-table-fedit-toggle-coordinates ()
11027 "Toggle the display of coordinates in the refrenced table."
11028 (interactive)
11029 (let ((pos (marker-position org-pos)))
11030 (with-current-buffer (marker-buffer org-pos)
11031 (save-excursion
11032 (goto-char pos)
11033 (org-table-toggle-coordinate-overlays)))))
11035 (defun org-table-fedit-finish (&optional arg)
11036 "Parse the buffer for formula definitions and install them.
11037 With prefix ARG, apply the new formulas to the table."
11038 (interactive "P")
11039 (org-table-remove-rectangle-highlight)
11040 (if org-table-use-standard-references
11041 (progn
11042 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
11043 (setq org-table-buffer-is-an nil)))
11044 (let ((pos org-pos) eql var form)
11045 (goto-char (point-min))
11046 (while (re-search-forward
11048 nil t)
11049 (setq var (if (match-end 2) (match-string 2) (match-string 1))
11050 form (match-string 3))
11051 (setq form (org-trim form))
11052 (when (not (equal form ""))
11054 (setq form (replace-match " " t t form)))
11055 (when (assoc var eql)
11056 (error "Double formulas for %s" var))
11057 (push (cons var form) eql)))
11058 (setq org-pos nil)
11059 (set-window-configuration org-window-configuration)
11060 (select-window (get-buffer-window (marker-buffer pos)))
11061 (goto-char pos)
11062 (unless (org-at-table-p)
11063 (error "Lost table position - cannot install formulae"))
11064 (org-table-store-formulas eql)
11065 (move-marker pos nil)
11066 (kill-buffer "*Edit Formulas*")
11067 (if arg
11068 (org-table-recalculate 'all)
11069 (message "New formulas installed - press C-u C-c C-c to apply."))))
11071 (defun org-table-fedit-abort ()
11072 "Abort editing formulas, without installing the changes."
11073 (interactive)
11074 (org-table-remove-rectangle-highlight)
11075 (let ((pos org-pos))
11076 (set-window-configuration org-window-configuration)
11077 (select-window (get-buffer-window (marker-buffer pos)))
11078 (goto-char pos)
11079 (move-marker pos nil)
11080 (message "Formula editing aborted without installing changes")))
11082 (defun org-table-fedit-lisp-indent ()
11083 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
11084 (interactive)
11085 (let ((pos (point)) beg end ind)
11086 (beginning-of-line 1)
11087 (cond
11089 (goto-char pos)
11090 (call-interactively 'lisp-indent-line))
11092 ((not (fboundp 'pp-buffer))
11093 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
11094 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
11095 (goto-char (- (match-end 0) 2))
11096 (setq beg (point))
11097 (setq ind (make-string (current-column) ?\ ))
11098 (condition-case nil (forward-sexp 1)
11099 (error
11100 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
11101 (setq end (point))
11102 (save-restriction
11103 (narrow-to-region beg end)
11104 (if (eq last-command this-command)
11105 (progn
11106 (goto-char (point-min))
11107 (setq this-command nil)
11109 (replace-match " ")))
11110 (pp-buffer)
11111 (untabify (point-min) (point-max))
11112 (goto-char (1+ (point-min)))
11113 (while (re-search-forward "^." nil t)
11114 (beginning-of-line 1)
11115 (insert ind))
11116 (goto-char (point-max))
11117 (backward-delete-char 1)))
11118 (goto-char beg))
11119 (t nil))))
11121 (defvar org-show-positions nil)
11123 (defun org-table-show-reference (&optional local)
11124 "Show the location/value of the $ expression at point."
11125 (interactive)
11126 (org-table-remove-rectangle-highlight)
11127 (catch 'exit
11128 (let ((pos (if local (point) org-pos))
11129 (face2 'highlight)
11130 (org-inhibit-highlight-removal t)
11131 (win (selected-window))
11132 (org-show-positions nil)
11133 var name e what match dest)
11134 (if local (org-table-get-specials))
11135 (setq what (cond
11136 ((or (org-at-regexp-p org-table-range-regexp2)
11137 (org-at-regexp-p org-table-translate-regexp)
11138 (org-at-regexp-p org-table-range-regexp))
11139 (setq match
11140 (save-match-data
11141 (org-table-convert-refs-to-rc (match-string 0))))
11142 'range)
11145 ((not local) nil)
11146 (t (error "No reference at point")))
11147 match (and what (or match (match-string 0))))
11148 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
11149 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
11150 'secondary-selection))
11151 (org-add-hook 'before-change-functions
11152 'org-table-remove-rectangle-highlight)
11153 (if (eq what 'name) (setq var (substring match 1)))
11154 (when (eq what 'range)
11155 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
11156 (setq match (org-table-formula-substitute-names match)))
11157 (unless local
11158 (save-excursion
11159 (end-of-line 1)
11161 (beginning-of-line 1)
11163 (setq dest
11164 (save-match-data
11165 (org-table-convert-refs-to-rc (match-string 1))))
11166 (org-table-add-rectangle-overlay
11167 (match-beginning 1) (match-end 1) face2))))
11168 (if (and (markerp pos) (marker-buffer pos))
11169 (if (get-buffer-window (marker-buffer pos))
11170 (select-window (get-buffer-window (marker-buffer pos)))
11171 (org-switch-to-buffer-other-window (get-buffer-window
11172 (marker-buffer pos)))))
11173 (goto-char pos)
11174 (org-table-force-dataline)
11175 (when dest
11176 (setq name (substring dest 1))
11177 (cond
11179 (setq e (assoc name org-table-named-field-locations))
11180 (goto-line (nth 1 e))
11181 (org-table-goto-column (nth 2 e)))
11183 (let ((l (string-to-number (match-string 1 dest)))
11184 (c (string-to-number (match-string 2 dest))))
11185 (goto-line (aref org-table-dlines l))
11186 (org-table-goto-column c)))
11187 (t (org-table-goto-column (string-to-number name))))
11188 (move-marker pos (point))
11189 (org-table-highlight-rectangle nil nil face2))
11190 (cond
11191 ((equal dest match))
11192 ((not match))
11193 ((eq what 'range)
11194 (condition-case nil
11195 (save-excursion
11196 (org-table-get-range match nil nil 'highlight))
11197 (error nil)))
11198 ((setq e (assoc var org-table-named-field-locations))
11199 (goto-line (nth 1 e))
11200 (org-table-goto-column (nth 2 e))
11201 (org-table-highlight-rectangle (point) (point))
11202 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11203 ((setq e (assoc var org-table-column-names))
11204 (org-table-goto-column (string-to-number (cdr e)))
11205 (org-table-highlight-rectangle (point) (point))
11206 (goto-char (org-table-begin))
11208 (org-table-end) t)
11209 (progn
11210 (goto-char (match-beginning 1))
11211 (org-table-highlight-rectangle)
11212 (message "Named column (column %s)" (cdr e)))
11213 (error "Column name not found")))
11214 ((eq what 'column)
11215 ;; column number
11216 (org-table-goto-column (string-to-number (substring match 1)))
11217 (org-table-highlight-rectangle (point) (point))
11218 (message "Column %s" (substring match 1)))
11219 ((setq e (assoc var org-table-local-parameters))
11220 (goto-char (org-table-begin))
11222 (progn
11223 (goto-char (match-beginning 1))
11224 (org-table-highlight-rectangle)
11225 (message "Local parameter."))
11226 (error "Parameter not found")))
11227 (t
11228 (cond
11229 ((not var) (error "No reference at point"))
11230 ((setq e (assoc var org-table-formula-constants-local))
11231 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11232 var (cdr e)))
11233 ((setq e (assoc var org-table-formula-constants))
11234 (message "Constant: $%s=%s in `org-table-formula-constants'."
11235 var (cdr e)))
11236 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11237 (message "Constant: $%s=%s, from `constants.el'%s."
11238 var e (format " (%s units)" constants-unit-system)))
11239 (t (error "Undefined name $%s" var)))))
11240 (goto-char pos)
11241 (when (and org-show-positions
11242 (not (memq this-command '(org-table-fedit-scroll
11243 org-table-fedit-scroll-down))))
11244 (push pos org-show-positions)
11245 (push org-table-current-begin-pos org-show-positions)
11246 (let ((min (apply 'min org-show-positions))
11247 (max (apply 'max org-show-positions)))
11248 (goto-char min) (recenter 0)
11249 (goto-char max)
11250 (or (pos-visible-in-window-p max) (recenter -1))))
11251 (select-window win))))
11253 (defun org-table-force-dataline ()
11254 "Make sure the cursor is in a dataline in a table."
11255 (unless (save-excursion
11256 (beginning-of-line 1)
11257 (looking-at org-table-dataline-regexp))
11258 (let* ((re org-table-dataline-regexp)
11259 (p1 (save-excursion (re-search-forward re nil 'move)))
11260 (p2 (save-excursion (re-search-backward re nil 'move))))
11261 (cond ((and p1 p2)
11262 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11263 p1 p2)))
11264 ((or p1 p2) (goto-char (or p1 p2)))
11265 (t (error "No table dataline around here"))))))
11267 (defun org-table-fedit-line-up ()
11268 "Move cursor one line up in the window showing the table."
11269 (interactive)
11270 (org-table-fedit-move 'previous-line))
11272 (defun org-table-fedit-line-down ()
11273 "Move cursor one line down in the window showing the table."
11274 (interactive)
11275 (org-table-fedit-move 'next-line))
11277 (defun org-table-fedit-move (command)
11278 "Move the cursor in the window shoinw the table.
11279 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11280 (let ((org-table-allow-automatic-line-recalculation nil)
11281 (pos org-pos) (win (selected-window)) p)
11282 (select-window (get-buffer-window (marker-buffer org-pos)))
11283 (setq p (point))
11284 (call-interactively command)
11285 (while (and (org-at-table-p)
11286 (org-at-table-hline-p))
11287 (call-interactively command))
11288 (or (org-at-table-p) (goto-char p))
11289 (move-marker pos (point))
11290 (select-window win)))
11292 (defun org-table-fedit-scroll (N)
11293 (interactive "p")
11294 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11295 (scroll-other-window N)))
11297 (defun org-table-fedit-scroll-down (N)
11298 (interactive "p")
11299 (org-table-fedit-scroll (- N)))
11301 (defvar org-table-rectangle-overlays nil)
11303 (defun org-table-add-rectangle-overlay (beg end &optional face)
11304 "Add a new overlay."
11305 (let ((ov (org-make-overlay beg end)))
11306 (org-overlay-put ov 'face (or face 'secondary-selection))
11307 (push ov org-table-rectangle-overlays)))
11309 (defun org-table-highlight-rectangle (&optional beg end face)
11310 "Highlight rectangular region in a table."
11311 (setq beg (or beg (point)) end (or end (point)))
11312 (let ((b (min beg end))
11313 (e (max beg end))
11314 l1 c1 l2 c2 tmp)
11315 (and (boundp 'org-show-positions)
11316 (setq org-show-positions (cons b (cons e org-show-positions))))
11317 (goto-char (min beg end))
11318 (setq l1 (org-current-line)
11319 c1 (org-table-current-column))
11320 (goto-char (max beg end))
11321 (setq l2 (org-current-line)
11322 c2 (org-table-current-column))
11323 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11324 (goto-line l1)
11325 (beginning-of-line 1)
11326 (loop for line from l1 to l2 do
11327 (when (looking-at org-table-dataline-regexp)
11328 (org-table-goto-column c1)
11330 (org-table-goto-column c2)
11332 (org-table-add-rectangle-overlay beg end face))
11333 (beginning-of-line 2))
11334 (goto-char b))
11335 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11337 (defun org-table-remove-rectangle-highlight (&rest ignore)
11338 "Remove the rectangle overlays."
11339 (unless org-inhibit-highlight-removal
11340 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11341 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11342 (setq org-table-rectangle-overlays nil)))
11344 (defvar org-table-coordinate-overlays nil
11345 "Collects the cooordinate grid overlays, so that they can be removed.")
11346 (make-variable-buffer-local 'org-table-coordinate-overlays)
11348 (defun org-table-overlay-coordinates ()
11349 "Add overlays to the table at point, to show row/column coordinates."
11350 (interactive)
11351 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11352 (setq org-table-coordinate-overlays nil)
11353 (save-excursion
11354 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11355 (goto-char (org-table-begin))
11356 (while (org-at-table-p)
11357 (setq eol (point-at-eol))
11358 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11359 (push ov org-table-coordinate-overlays)
11360 (setq hline (looking-at org-table-hline-regexp))
11361 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11362 (format "%4d" (setq id (1+ id)))))
11363 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11364 (when hline
11365 (setq ic 0)
11367 (setq beg (1+ (match-beginning 0))
11368 ic (1+ ic)
11369 s1 (concat "$" (int-to-string ic))
11370 s2 (org-number-to-letters ic)
11371 str (if (eq org-table-use-standard-references t) s2 s1))
11372 (setq ov (org-make-overlay beg (+ beg (length str))))
11373 (push ov org-table-coordinate-overlays)
11374 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11375 (beginning-of-line 2)))))
11377 (defun org-table-toggle-coordinate-overlays ()
11378 "Toggle the display of Row/Column numbers in tables."
11379 (interactive)
11380 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11381 (message "Row/Column number display turned %s"
11382 (if org-table-overlay-coordinates "on" "off"))
11383 (if (and (org-at-table-p) org-table-overlay-coordinates)
11384 (org-table-align))
11385 (unless org-table-overlay-coordinates
11386 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11387 (setq org-table-coordinate-overlays nil)))
11389 (defun org-table-toggle-formula-debugger ()
11390 "Toggle the formula debugger in tables."
11391 (interactive)
11392 (setq org-table-formula-debug (not org-table-formula-debug))
11393 (message "Formula debugging has been turned %s"
11394 (if org-table-formula-debug "on" "off")))
11396 ;;; The orgtbl minor mode
11398 ;; Define a minor mode which can be used in other modes in order to
11399 ;; integrate the org-mode table editor.
11401 ;; This is really a hack, because the org-mode table editor uses several
11402 ;; keys which normally belong to the major mode, for example the TAB and
11403 ;; RET keys. Here is how it works: The minor mode defines all the keys
11404 ;; necessary to operate the table editor, but wraps the commands into a
11405 ;; function which tests if the cursor is currently inside a table. If that
11406 ;; is the case, the table editor command is executed. However, when any of
11407 ;; those keys is used outside a table, the function uses `key-binding' to
11408 ;; look up if the key has an associated command in another currently active
11409 ;; keymap (minor modes, major mode, global), and executes that command.
11410 ;; There might be problems if any of the keys used by the table editor is
11411 ;; otherwise used as a prefix key.
11413 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11414 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11415 ;; addresses this by checking explicitly for both bindings.
11417 ;; The optimized version (see variable `orgtbl-optimized') takes over
11418 ;; all keys which are bound to `self-insert-command' in the *global map*.
11419 ;; Some modes bind other commands to simple characters, for example
11420 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11421 ;; active, this binding is ignored inside tables and replaced with a
11422 ;; modified self-insert.
11424 (defvar orgtbl-mode nil
11425 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11426 table editor in arbitrary modes.")
11427 (make-variable-buffer-local 'orgtbl-mode)
11429 (defvar orgtbl-mode-map (make-keymap)
11430 "Keymap for `orgtbl-mode'.")
11432 ;;;###autoload
11433 (defun turn-on-orgtbl ()
11434 "Unconditionally turn on `orgtbl-mode'."
11435 (orgtbl-mode 1))
11437 (defvar org-old-auto-fill-inhibit-regexp nil
11438 "Local variable used by `orgtbl-mode'")
11441 "Matches a line belonging to an orgtbl.")
11443 (defconst orgtbl-extra-font-lock-keywords
11444 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11445 0 (quote 'org-table) 'prepend))
11446 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11448 ;;;###autoload
11449 (defun orgtbl-mode (&optional arg)
11450 "The `org-mode' table editor as a minor mode for use in other modes."
11451 (interactive)
11452 (if (org-mode-p)
11453 ;; Exit without error, in case some hook functions calls this
11454 ;; by accident in org-mode.
11455 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11456 (setq orgtbl-mode
11457 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11458 (if orgtbl-mode
11459 (progn
11460 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11461 ;; Make sure we are first in minor-mode-map-alist
11462 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11463 (and c (setq minor-mode-map-alist
11464 (cons c (delq c minor-mode-map-alist)))))
11465 (org-set-local (quote org-table-may-need-update) t)
11466 (org-add-hook 'before-change-functions 'org-before-change-function
11467 nil 'local)
11468 (org-set-local 'org-old-auto-fill-inhibit-regexp
11469 auto-fill-inhibit-regexp)
11470 (org-set-local 'auto-fill-inhibit-regexp
11471 (if auto-fill-inhibit-regexp
11473 auto-fill-inhibit-regexp)
11474 orgtbl-line-start-regexp))
11475 (org-add-to-invisibility-spec '(org-cwidth))
11476 (when (fboundp 'font-lock-add-keywords)
11477 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11478 (org-restart-font-lock))
11479 (easy-menu-add orgtbl-mode-menu)
11480 (run-hooks 'orgtbl-mode-hook))
11481 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11482 (org-cleanup-narrow-column-properties)
11483 (org-remove-from-invisibility-spec '(org-cwidth))
11484 (remove-hook 'before-change-functions 'org-before-change-function t)
11485 (when (fboundp 'font-lock-remove-keywords)
11486 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11487 (org-restart-font-lock))
11488 (easy-menu-remove orgtbl-mode-menu)
11489 (force-mode-line-update 'all))))
11491 (defun org-cleanup-narrow-column-properties ()
11492 "Remove all properties related to narrow-column invisibility."
11493 (let ((s 1))
11494 (while (setq s (text-property-any s (point-max)
11495 'display org-narrow-column-arrow))
11496 (remove-text-properties s (1+ s) '(display t)))
11497 (setq s 1)
11498 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11499 (remove-text-properties s (1+ s) '(org-cwidth t)))
11500 (setq s 1)
11501 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11502 (remove-text-properties s (1+ s) '(invisible t)))))
11504 ;; Install it as a minor mode.
11505 (put 'orgtbl-mode :included t)
11506 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11507 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11509 (defun orgtbl-make-binding (fun n &rest keys)
11510 "Create a function for binding in the table minor mode.
11511 FUN is the command to call inside a table. N is used to create a unique
11512 command name. KEYS are keys that should be checked in for a command
11513 to execute outside of tables."
11514 (eval
11515 (list 'defun
11516 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11517 '(arg)
11519 "Outside of tables, run the binding of `"
11520 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11521 "'.")
11522 '(interactive "p")
11523 (list 'if
11524 '(org-at-table-p)
11525 (list 'call-interactively (list 'quote fun))
11526 (list 'let '(orgtbl-mode)
11527 (list 'call-interactively
11528 (append '(or)
11529 (mapcar (lambda (k)
11530 (list 'key-binding k))
11531 keys)
11532 '('orgtbl-error))))))))
11534 (defun orgtbl-error ()
11535 "Error when there is no default binding for a table key."
11536 (interactive)
11537 (error "This key has no function outside tables"))
11539 (defun orgtbl-setup ()
11540 "Setup orgtbl keymaps."
11541 (let ((nfunc 0)
11542 (bindings
11543 (list
11544 '([(meta shift left)] org-table-delete-column)
11545 '([(meta left)] org-table-move-column-left)
11546 '([(meta right)] org-table-move-column-right)
11547 '([(meta shift right)] org-table-insert-column)
11548 '([(meta shift up)] org-table-kill-row)
11549 '([(meta shift down)] org-table-insert-row)
11550 '([(meta up)] org-table-move-row-up)
11551 '([(meta down)] org-table-move-row-down)
11552 '("\C-c\C-w" org-table-cut-region)
11553 '("\C-c\M-w" org-table-copy-region)
11554 '("\C-c\C-y" org-table-paste-rectangle)
11555 '("\C-c-" org-table-insert-hline)
11556 '("\C-c}" org-table-toggle-coordinate-overlays)
11557 '("\C-c{" org-table-toggle-formula-debugger)
11558 '("\C-m" org-table-next-row)
11559 '([(shift return)] org-table-copy-down)
11560 '("\C-c\C-q" org-table-wrap-region)
11561 '("\C-c?" org-table-field-info)
11562 '("\C-c " org-table-blank-field)
11563 '("\C-c+" org-table-sum)
11564 '("\C-c=" org-table-eval-formula)
11565 '("\C-c'" org-table-edit-formulas)
11566 '("\C-c`" org-table-edit-field)
11567 '("\C-c*" org-table-recalculate)
11568 '("\C-c|" org-table-create-or-convert-from-region)
11569 '("\C-c^" org-table-sort-lines)
11570 '([(control ?#)] org-table-rotate-recalc-marks)))
11571 elt key fun cmd)
11572 (while (setq elt (pop bindings))
11573 (setq nfunc (1+ nfunc))
11574 (setq key (org-key (car elt))
11575 fun (nth 1 elt)
11576 cmd (orgtbl-make-binding fun nfunc key))
11577 (org-defkey orgtbl-mode-map key cmd))
11579 ;; Special treatment needed for TAB and RET
11580 (org-defkey orgtbl-mode-map [(return)]
11581 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11582 (org-defkey orgtbl-mode-map "\C-m"
11583 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11585 (org-defkey orgtbl-mode-map [(tab)]
11586 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11587 (org-defkey orgtbl-mode-map "\C-i"
11588 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11590 (org-defkey orgtbl-mode-map [(shift tab)]
11591 (orgtbl-make-binding 'org-table-previous-field 104
11592 [(shift tab)] [(tab)] "\C-i"))
11594 (org-defkey orgtbl-mode-map "\M-\C-m"
11595 (orgtbl-make-binding 'org-table-wrap-region 105
11596 "\M-\C-m" [(meta return)]))
11597 (org-defkey orgtbl-mode-map [(meta return)]
11598 (orgtbl-make-binding 'org-table-wrap-region 106
11599 [(meta return)] "\M-\C-m"))
11601 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11602 (when orgtbl-optimized
11603 ;; If the user wants maximum table support, we need to hijack
11604 ;; some standard editing functions
11605 (org-remap orgtbl-mode-map
11606 'self-insert-command 'orgtbl-self-insert-command
11607 'delete-char 'org-delete-char
11608 'delete-backward-char 'org-delete-backward-char)
11609 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11610 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11611 '("OrgTbl"
11612 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11613 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11614 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11615 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11616 "--"
11617 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11618 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11619 ["Copy Field from Above"
11620 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11621 "--"
11622 ("Column"
11623 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11624 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11625 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11626 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11627 ("Row"
11628 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11629 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11630 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11631 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11632 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
11633 "--"
11634 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11635 ("Rectangle"
11636 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11637 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11638 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11639 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11640 "--"
11641 ("Radio tables"
11642 ["Insert table template" orgtbl-insert-radio-table
11643 (assq major-mode orgtbl-radio-table-templates)]
11644 ["Comment/uncomment table" orgtbl-toggle-comment t])
11645 "--"
11646 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11647 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11648 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11649 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11650 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11651 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11652 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11653 ["Sum Column/Rectangle" org-table-sum
11654 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11655 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11656 ["Debug Formulas"
11657 org-table-toggle-formula-debugger :active (org-at-table-p)
11658 :keys "C-c {"
11659 :style toggle :selected org-table-formula-debug]
11660 ["Show Col/Row Numbers"
11661 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11662 :keys "C-c }"
11663 :style toggle :selected org-table-overlay-coordinates]
11664 ))
11665 t))
11667 (defun orgtbl-ctrl-c-ctrl-c (arg)
11668 "If the cursor is inside a table, realign the table.
11669 It it is a table to be sent away to a receiver, do it.
11670 With prefix arg, also recompute table."
11671 (interactive "P")
11672 (let ((pos (point)) action)
11673 (save-excursion
11674 (beginning-of-line 1)
11678 (cond
11679 ((integerp action)
11680 (goto-char action)
11681 (org-table-maybe-eval-formula)
11682 (if arg
11683 (call-interactively 'org-table-recalculate)
11684 (org-table-maybe-recalculate-line))
11685 (call-interactively 'org-table-align)
11686 (orgtbl-send-table 'maybe))
11687 ((eq action 'recalc)
11688 (save-excursion
11689 (beginning-of-line 1)
11691 (if (org-at-table-p)
11692 (org-call-with-arg 'org-table-recalculate t))))
11693 (t (let (orgtbl-mode)
11694 (call-interactively (key-binding "\C-c\C-c")))))))
11696 (defun orgtbl-tab (arg)
11697 "Justification and field motion for `orgtbl-mode'."
11698 (interactive "P")
11699 (if arg (org-table-edit-field t)
11700 (org-table-justify-field-maybe)
11701 (org-table-next-field)))
11703 (defun orgtbl-ret ()
11704 "Justification and field motion for `orgtbl-mode'."
11705 (interactive)
11706 (org-table-justify-field-maybe)
11707 (org-table-next-row))
11709 (defun orgtbl-self-insert-command (N)
11710 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11711 If the cursor is in a table looking at whitespace, the whitespace is
11712 overwritten, and the table is not marked as requiring realignment."
11713 (interactive "p")
11714 (if (and (org-at-table-p)
11715 (or
11716 (and org-table-auto-blank-field
11717 (member last-command
11718 '(orgtbl-hijacker-command-100
11719 orgtbl-hijacker-command-101
11720 orgtbl-hijacker-command-102
11721 orgtbl-hijacker-command-103
11722 orgtbl-hijacker-command-104
11723 orgtbl-hijacker-command-105))
11724 (org-table-blank-field))
11725 t)
11726 (eq N 1)
11728 (let (org-table-may-need-update)
11729 (goto-char (1- (match-end 0)))
11730 (delete-backward-char 1)
11731 (goto-char (match-beginning 0))
11732 (self-insert-command N))
11733 (setq org-table-may-need-update t)
11734 (let (orgtbl-mode)
11735 (call-interactively (key-binding (vector last-input-event))))))
11737 (defun org-force-self-insert (N)
11738 "Needed to enforce self-insert under remapping."
11739 (interactive "p")
11740 (self-insert-command N))
11743 "Regula expression matching exponentials as produced by calc.")
11745 (defvar org-table-clean-did-remove-column nil)
11747 (defun orgtbl-export (table target)
11748 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11750 org-table-last-alignment org-table-last-column-widths
11751 maxcol column)
11752 (if (not (fboundp func))
11753 (error "Cannot export orgtbl table to %s" target))
11754 (setq lines (org-table-clean-before-export lines))
11755 (setq table
11756 (mapcar
11757 (lambda (x)
11758 (if (string-match org-table-hline-regexp x)
11759 'hline
11761 lines))
11762 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11763 table)))
11764 (loop for i from (1- maxcol) downto 0 do
11765 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11766 (setq column (delq nil column))
11767 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11768 (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))
11769 (funcall func table nil)))
11771 (defun orgtbl-send-table (&optional maybe)
11772 "Send a tranformed version of this table to the receiver position.
11773 With argument MAYBE, fail quietly if no transformation is defined for
11774 this table."
11775 (interactive)
11776 (catch 'exit
11777 (unless (org-at-table-p) (error "Not at a table"))
11778 ;; when non-interactive, we assume align has just happened.
11779 (when (interactive-p) (org-table-align))
11780 (save-excursion
11781 (goto-char (org-table-begin))
11782 (beginning-of-line 0)
11784 (if maybe
11785 (throw 'exit nil)
11786 (error "Don't know how to transform this table."))))
11787 (let* ((name (match-string 1))
11788 beg
11789 (transform (intern (match-string 2)))
11790 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11791 (skip (plist-get params :skip))
11792 (skipcols (plist-get params :skipcols))
11793 (txt (buffer-substring-no-properties
11794 (org-table-begin) (org-table-end)))
11796 (lines (org-table-clean-before-export lines))
11797 (i0 (if org-table-clean-did-remove-column 2 1))
11798 (table (mapcar
11799 (lambda (x)
11800 (if (string-match org-table-hline-regexp x)
11801 'hline
11802 (org-remove-by-index
11804 skipcols i0)))
11805 lines))
11806 (fun (if (= i0 2) 'cdr 'identity))
11807 (org-table-last-alignment
11808 (org-remove-by-index (funcall fun org-table-last-alignment)
11809 skipcols i0))
11810 (org-table-last-column-widths
11811 (org-remove-by-index (funcall fun org-table-last-column-widths)
11812 skipcols i0)))
11814 (unless (fboundp transform)
11815 (error "No such transformation function %s" transform))
11816 (setq txt (funcall transform table params))
11817 ;; Find the insertion place
11818 (save-excursion
11819 (goto-char (point-min))
11820 (unless (re-search-forward
11822 (error "Don't know where to insert translated table"))
11823 (goto-char (match-beginning 0))
11824 (beginning-of-line 2)
11825 (setq beg (point))
11826 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11827 (error "Cannot find end of insertion region"))
11828 (beginning-of-line 1)
11829 (delete-region beg (point))
11830 (goto-char beg)
11832 (message "Table converted and installed at receiver location"))))
11834 (defun org-remove-by-index (list indices &optional i0)
11835 "Remove the elements in LIST with indices in INDICES.
11836 First element has index 0, or I0 if given."
11837 (if (not indices)
11838 list
11839 (if (integerp indices) (setq indices (list indices)))
11840 (setq i0 (1- (or i0 0)))
11841 (delq :rm (mapcar (lambda (x)
11842 (setq i0 (1+ i0))
11843 (if (memq i0 indices) :rm x))
11844 list))))
11846 (defun orgtbl-toggle-comment ()
11847 "Comment or uncomment the orgtbl at point."
11848 (interactive)
11849 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11850 (re2 (concat "^" orgtbl-line-start-regexp))
11851 (commented (save-excursion (beginning-of-line 1)
11852 (cond ((looking-at re1) t)
11853 ((looking-at re2) nil)
11854 (t (error "Not at an org table")))))
11855 (re (if commented re1 re2))
11856 beg end)
11857 (save-excursion
11858 (beginning-of-line 1)
11859 (while (looking-at re) (beginning-of-line 0))
11860 (beginning-of-line 2)
11861 (setq beg (point))
11862 (while (looking-at re) (beginning-of-line 2))
11863 (setq end (point)))
11864 (comment-region beg end (if commented '(4) nil))))
11866 (defun orgtbl-insert-radio-table ()
11867 "Insert a radio table template appropriate for this major mode."
11868 (interactive)
11869 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11870 (txt (nth 1 e))
11871 name pos)
11872 (unless e (error "No radio table setup defined for %s" major-mode))
11873 (setq name (read-string "Table name: "))
11874 (while (string-match "%n" txt)
11875 (setq txt (replace-match name t t txt)))
11877 (setq pos (point))
11878 (insert txt)
11879 (goto-char pos)))
11881 (defun org-get-param (params header i sym &optional hsym)
11882 "Get parameter value for symbol SYM.
11883 If this is a header line, actually get the value for the symbol with an
11885 If the value is a protperty list, get the element for the current column.
11886 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11887 (let ((val (plist-get params sym)))
11888 (and hsym header (setq val (or (plist-get params hsym) val)))
11889 (if (consp val) (plist-get val i) val)))
11891 (defun orgtbl-to-generic (table params)
11892 "Convert the orgtbl-mode TABLE to some other format.
11893 This generic routine can be used for many standard cases.
11894 TABLE is a list, each entry either the symbol `hline' for a horizontal
11895 separator line, or a list of fields for that line.
11896 PARAMS is a property list of parameters that can influence the conversion.
11897 For the generic converter, some parameters are obligatory: You need to
11898 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11899 :splice, you must have :tstart and :tend.
11901 Valid parameters are
11903 :tstart String to start the table. Ignored when :splice is t.
11904 :tend String to end the table. Ignored when :splice is t.
11906 :splice When set to t, return only table body lines, don't wrap
11907 them into :tstart and :tend. Default is nil.
11909 :hline String to be inserted on horizontal separation lines.
11910 May be nil to ignore hlines.
11912 :lstart String to start a new table line.
11913 :lend String to end a table line
11914 :sep Separator between two fields
11915 :lfmt Format for entire line, with enough %s to capture all fields.
11916 If this is present, :lstart, :lend, and :sep are ignored.
11917 :fmt A format to be used to wrap the field, should contain
11918 %s for the original field value. For example, to wrap
11920 This may also be a property list with column numbers and
11923 :hlstart :hlend :hlsep :hlfmt :hfmt
11924 Same as above, specific for the header lines in the table.
11925 All lines before the first hline are treated as header.
11926 If any of these is not present, the data line value is used.
11928 :efmt Use this format to print numbers with exponentials.
11929 The format should have %s twice for inserting mantissa
11931 may also be a property list with column numbers and
11932 formats. :fmt will still be applied after :efmt.
11934 In addition to this, the parameters :skip and :skipcols are always handled
11935 directly by `orgtbl-send-table'. See manual."
11936 (interactive)
11937 (let* ((p params)
11938 (splicep (plist-get p :splice))
11939 (hline (plist-get p :hline))
11940 rtn line i fm efm lfmt h)
11942 ;; Do we have a header?
11943 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11944 (setq h t))
11946 ;; Put header
11947 (unless splicep
11948 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11950 ;; Now loop over all lines
11951 (while (setq line (pop table))
11952 (if (eq line 'hline)
11953 ;; A horizontal separator line
11954 (progn (if hline (push hline rtn))
11955 (setq h nil)) ; no longer in header
11956 ;; A normal line. Convert the fields, push line onto the result list
11957 (setq i 0)
11958 (setq line
11959 (mapcar
11960 (lambda (f)
11961 (setq i (1+ i)
11962 fm (org-get-param p h i :fmt :hfmt)
11963 efm (org-get-param p h i :efmt))
11964 (if (and efm (string-match orgtbl-exp-regexp f))
11965 (setq f (format
11966 efm (match-string 1 f) (match-string 2 f))))
11967 (if fm (setq f (format fm f)))
11968 f)
11969 line))
11970 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11971 (push (apply 'format lfmt line) rtn)
11972 (push (concat
11973 (org-get-param p h i :lstart :hlstart)
11974 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11975 (org-get-param p h i :lend :hlend))
11976 rtn))))
11978 (unless splicep
11979 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11983 (defun orgtbl-to-latex (table params)
11984 "Convert the orgtbl-mode TABLE to LaTeX.
11985 TABLE is a list, each entry either the symbol `hline' for a horizontal
11986 separator line, or a list of fields for that line.
11987 PARAMS is a property list of parameters that can influence the conversion.
11988 Supports all parameters from `orgtbl-to-generic'. Most important for
11989 LaTeX are:
11991 :splice When set to t, return only table body lines, don't wrap
11992 them into a tabular environment. Default is nil.
11994 :fmt A format to be used to wrap the field, should contain %s for the
11995 original field value. For example, to wrap everything in dollars,
11999 :efmt Format for transforming numbers with exponentials. The format
12000 should have %s twice for inserting mantissa and exponent, for
12002 This may also be a property list with column numbers and formats.
12004 The general parameters :skip and :skipcols have already been applied when
12005 this function is called."
12006 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
12007 org-table-last-alignment ""))
12008 (params2
12009 (list
12014 (orgtbl-to-generic table (org-combine-plists params2 params))))
12016 (defun orgtbl-to-html (table params)
12017 "Convert the orgtbl-mode TABLE to LaTeX.
12018 TABLE is a list, each entry either the symbol `hline' for a horizontal
12019 separator line, or a list of fields for that line.
12020 PARAMS is a property list of parameters that can influence the conversion.
12021 Currently this function recognizes the following parameters:
12023 :splice When set to t, return only table body lines, don't wrap
12024 them into a <table> environment. Default is nil.
12026 The general parameters :skip and :skipcols have already been applied when
12027 this function is called. The function does *not* use `orgtbl-to-generic',
12028 so you cannot specify parameters for it."
12029 (let* ((splicep (plist-get params :splice))
12030 html)
12031 ;; Just call the formatter we already have
12032 ;; We need to make text lines for it, so put the fields back together.
12033 (setq html (org-format-org-table-html
12034 (mapcar
12035 (lambda (x)
12036 (if (eq x 'hline)
12037 "|----+----|"
12038 (concat "| " (mapconcat 'identity x " | ") " |")))
12039 table)
12040 splicep))
12042 (setq html (replace-match "" t t html)))
12043 html))
12045 (defun orgtbl-to-texinfo (table params)
12046 "Convert the orgtbl-mode TABLE to TeXInfo.
12047 TABLE is a list, each entry either the symbol `hline' for a horizontal
12048 separator line, or a list of fields for that line.
12049 PARAMS is a property list of parameters that can influence the conversion.
12050 Supports all parameters from `orgtbl-to-generic'. Most important for
12051 TeXInfo are:
12053 :splice nil/t When set to t, return only table body lines, don't wrap
12054 them into a multitable environment. Default is nil.
12056 :fmt fmt A format to be used to wrap the field, should contain
12057 %s for the original field value. For example, to wrap
12059 This may also be a property list with column numbers and
12063 are computed automatically from the width of the columns
12064 under org-mode.
12066 The general parameters :skip and :skipcols have already been applied when
12067 this function is called."
12068 (let* ((total (float (apply '+ org-table-last-column-widths)))
12069 (colfrac (or (plist-get params :cf)
12070 (mapconcat
12071 (lambda (x) (format "%.3f" (/ (float x) total)))
12072 org-table-last-column-widths " ")))
12073 (params2
12074 (list
12075 :tstart (concat "@multitable @columnfractions " colfrac)
12076 :tend "@end multitable"
12077 :lstart "@item " :lend "" :sep " @tab "
12078 :hlstart "@headitem ")))
12079 (orgtbl-to-generic table (org-combine-plists params2 params))))
12081 ;;;; Link Stuff
12083 ;;; Link abbreviations
12085 (defun org-link-expand-abbrev (link)
12086 "Apply replacements as defined in `org-link-abbrev-alist."
12088 (let* ((key (match-string 1 link))
12089 (as (or (assoc key org-link-abbrev-alist-local)
12090 (assoc key org-link-abbrev-alist)))
12091 (tag (and (match-end 2) (match-string 3 link)))
12092 rpl)
12093 (if (not as)
12094 link
12095 (setq rpl (cdr as))
12096 (cond
12097 ((symbolp rpl) (funcall rpl tag))
12098 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
12099 (t (concat rpl tag)))))
12100 link))
12102 ;;; Storing and inserting links
12104 (defvar org-insert-link-history nil
12105 "Minibuffer history for links inserted with `org-insert-link'.")
12107 (defvar org-stored-links nil
12108 "Contains the links stored with `org-store-link'.")
12110 (defvar org-store-link-plist nil
12111 "Plist with info about the most recently link created with `org-store-link'.")
12113 (defvar org-link-protocols nil
12114 "Link protocols added to Org-mode using `org-add-link-type'.")
12116 (defvar org-store-link-functions nil
12117 "List of functions that are called to create and store a link.
12118 Each function will be called in turn until one returns a non-nil
12119 value. Each function should check if it is responsible for creating
12120 this link (for example by looking at the major mode).
12121 If not, it must exit and return nil.
12122 If yes, it should return a non-nil value after a calling
12123 `org-store-link-props' with a list of properties and values.
12124 Special properties are:
12128 This is obligatory as well.
12129 :description Optional default description for the second pair
12130 of brackets in an Org-mode link. The user can still change
12131 this when inserting this link into an Org-mode buffer.
12133 In addition to these, any additional properties can be specified
12134 and then used in remember templates.")
12136 (defun org-add-link-type (type &optional follow publish)
12137 "Add TYPE to the list of `org-link-types'.
12138 Re-compute all regular expressions depending on `org-link-types'
12139 FOLLOW and PUBLISH are two functions. Both take the link path as
12140 an argument.
12141 FOLLOW should do whatever is necessary to follow the link, for example
12142 to find a file or display a mail message.
12144 PUBLISH takes the path and retuns the string that should be used when
12145 this document is published. FIMXE: This is actually not yet implemented."
12146 (add-to-list 'org-link-types type t)
12147 (org-make-link-regexps)
12148 (add-to-list 'org-link-protocols
12149 (list type follow publish)))
12151 (defun org-add-agenda-custom-command (entry)
12152 "Replace or add a command in `org-agenda-custom-commands'.
12153 This is mostly for hacking and trying a new command - once the command
12154 works you probably want to add it to `org-agenda-custom-commands' for good."
12155 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
12156 (if ass
12157 (setcdr ass (cdr entry))
12158 (push entry org-agenda-custom-commands))))
12160 ;;;###autoload
12161 (defun org-store-link (arg)
12163 This link is added to `org-stored-links' and can later be inserted
12166 For some link types, a prefix arg is interpreted:
12167 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12168 For file links, arg negates `org-context-in-file-links'."
12169 (interactive "P")
12170 (setq org-store-link-plist nil) ; reset
12171 (let (link cpltxt desc description search txt)
12172 (cond
12174 ((run-hook-with-args-until-success 'org-store-link-functions)
12175 (setq link (plist-get org-store-link-plist :link)
12176 desc (or (plist-get org-store-link-plist :description) link)))
12178 ((eq major-mode 'bbdb-mode)
12179 (let ((name (bbdb-record-name (bbdb-current-record)))
12180 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
12181 (setq cpltxt (concat "bbdb:" (or name company))
12182 link (org-make-link cpltxt))
12183 (org-store-link-props :type "bbdb" :name name :company company)))
12185 ((eq major-mode 'Info-mode)
12186 (setq link (org-make-link "info:"
12187 (file-name-nondirectory Info-current-file)
12188 ":" Info-current-node))
12189 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
12190 ":" Info-current-node))
12191 (org-store-link-props :type "info" :file Info-current-file
12192 :node Info-current-node))
12194 ((eq major-mode 'calendar-mode)
12195 (let ((cd (calendar-cursor-to-date)))
12196 (setq link
12197 (format-time-string
12198 (car org-time-stamp-formats)
12199 (apply 'encode-time
12200 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12201 nil nil nil))))
12202 (org-store-link-props :type "calendar" :date cd)))
12204 ((or (eq major-mode 'vm-summary-mode)
12205 (eq major-mode 'vm-presentation-mode))
12206 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
12207 (vm-follow-summary-cursor)
12208 (save-excursion
12209 (vm-select-folder-buffer)
12210 (let* ((message (car vm-message-pointer))
12211 (folder buffer-file-name)
12212 (subject (vm-su-subject message))
12213 (to (vm-get-header-contents message "To"))
12214 (from (vm-get-header-contents message "From"))
12215 (message-id (vm-su-message-id message)))
12216 (org-store-link-props :type "vm" :from from :to to :subject subject
12217 :message-id message-id)
12218 (setq message-id (org-remove-angle-brackets message-id))
12219 (setq folder (abbreviate-file-name folder))
12220 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
12221 folder)
12222 (setq folder (replace-match "" t t folder)))
12223 (setq cpltxt (org-email-link-description))
12224 (setq link (org-make-link "vm:" folder "#" message-id)))))
12226 ((eq major-mode 'wl-summary-mode)
12227 (let* ((msgnum (wl-summary-message-number))
12228 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12229 msgnum 'message-id))
12230 (wl-message-entity
12231 (if (fboundp 'elmo-message-entity)
12232 (elmo-message-entity
12233 wl-summary-buffer-elmo-folder msgnum)
12234 (elmo-msgdb-overview-get-entity
12235 msgnum (wl-summary-buffer-msgdb))))
12236 (from (wl-summary-line-from))
12237 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12238 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12239 (wl-summary-line-subject))))
12240 (org-store-link-props :type "wl" :from from :to to
12241 :subject subject :message-id message-id)
12242 (setq message-id (org-remove-angle-brackets message-id))
12243 (setq cpltxt (org-email-link-description))
12244 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12245 "#" message-id))))
12247 ((or (equal major-mode 'mh-folder-mode)
12248 (equal major-mode 'mh-show-mode))
12249 (let ((from (org-mhe-get-header "From:"))
12250 (to (org-mhe-get-header "To:"))
12251 (message-id (org-mhe-get-header "Message-Id:"))
12252 (subject (org-mhe-get-header "Subject:")))
12253 (org-store-link-props :type "mh" :from from :to to
12254 :subject subject :message-id message-id)
12255 (setq cpltxt (org-email-link-description))
12256 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12257 (org-remove-angle-brackets message-id)))))
12259 ((or (eq major-mode 'rmail-mode)
12260 (eq major-mode 'rmail-summary-mode))
12261 (save-window-excursion
12262 (save-restriction
12263 (when (eq major-mode 'rmail-summary-mode)
12264 (rmail-show-message rmail-current-message))
12265 (rmail-narrow-to-non-pruned-header)
12266 (let ((folder buffer-file-name)
12267 (message-id (mail-fetch-field "message-id"))
12268 (from (mail-fetch-field "from"))
12269 (to (mail-fetch-field "to"))
12270 (subject (mail-fetch-field "subject")))
12271 (org-store-link-props
12272 :type "rmail" :from from :to to
12273 :subject subject :message-id message-id)
12274 (setq message-id (org-remove-angle-brackets message-id))
12275 (setq cpltxt (org-email-link-description))
12276 (setq link (org-make-link "rmail:" folder "#" message-id)))
12277 (rmail-show-message rmail-current-message))))
12279 ((eq major-mode 'gnus-group-mode)
12280 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12281 (gnus-group-group-name)) ; version
12282 ((fboundp 'gnus-group-name)
12283 (gnus-group-name))
12284 (t "???"))))
12285 (unless group (error "Not on a group"))
12286 (org-store-link-props :type "gnus" :group group)
12287 (setq cpltxt (concat
12288 (if (org-xor arg org-usenet-links-prefer-google)
12289 "http://groups.google.com/groups?group="
12290 "gnus:")
12291 group)
12292 link (org-make-link cpltxt))))
12294 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12295 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12296 (let* ((group gnus-newsgroup-name)
12297 (article (gnus-summary-article-number))
12298 (header (gnus-summary-article-header article))
12299 (from (mail-header-from header))
12300 (message-id (mail-header-id header))
12301 (date (mail-header-date header))
12302 (subject (gnus-summary-subject-string)))
12303 (org-store-link-props :type "gnus" :from from :subject subject
12304 :message-id message-id :group group)
12305 (setq cpltxt (org-email-link-description))
12306 (if (org-xor arg org-usenet-links-prefer-google)
12307 (setq link
12308 (concat
12310 (format "http://groups.google.com/groups?as_umsgid=%s"
12311 (org-fixup-message-id-for-http message-id))))
12312 (setq link (org-make-link "gnus:" group
12313 "#" (number-to-string article))))))
12315 ((eq major-mode 'w3-mode)
12316 (setq cpltxt (url-view-url t)
12317 link (org-make-link cpltxt))
12318 (org-store-link-props :type "w3" :url (url-view-url t)))
12320 ((eq major-mode 'w3m-mode)
12321 (setq cpltxt (or w3m-current-title w3m-current-url)
12322 link (org-make-link w3m-current-url))
12323 (org-store-link-props :type "w3m" :url (url-view-url t)))
12325 ((setq search (run-hook-with-args-until-success
12326 'org-create-file-search-functions))
12327 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12328 "::" search))
12329 (setq cpltxt (or description link)))
12331 ((eq major-mode 'image-mode)
12332 (setq cpltxt (concat "file:"
12333 (abbreviate-file-name buffer-file-name))
12334 link (org-make-link cpltxt))
12335 (org-store-link-props :type "image" :file buffer-file-name))
12337 ((eq major-mode 'dired-mode)
12338 ;; link to the file in the current line
12339 (setq cpltxt (concat "file:"
12340 (abbreviate-file-name
12341 (expand-file-name
12342 (dired-get-filename nil t))))
12343 link (org-make-link cpltxt)))
12345 ((and buffer-file-name (org-mode-p))
12346 ;; Just link to current headline
12347 (setq cpltxt (concat "file:"
12348 (abbreviate-file-name buffer-file-name)))
12349 ;; Add a context search string
12350 (when (org-xor org-context-in-file-links arg)
12351 ;; Check if we are on a target
12353 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12354 (setq txt (cond
12355 ((org-on-heading-p) nil)
12356 ((org-region-active-p)
12357 (buffer-substring (region-beginning) (region-end)))
12358 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12360 (setq cpltxt
12361 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12362 desc "NONE"))))
12364 (setq cpltxt (substring cpltxt 0 -2)))
12365 (setq link (org-make-link cpltxt)))
12367 ((buffer-file-name (buffer-base-buffer))
12368 ;; Just link to this file here.
12369 (setq cpltxt (concat "file:"
12370 (abbreviate-file-name
12371 (buffer-file-name (buffer-base-buffer)))))
12372 ;; Add a context string
12373 (when (org-xor org-context-in-file-links arg)
12374 (setq txt (if (org-region-active-p)
12375 (buffer-substring (region-beginning) (region-end))
12376 (buffer-substring (point-at-bol) (point-at-eol))))
12377 ;; Only use search option if there is some text.
12379 (setq cpltxt
12380 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12381 desc "NONE")))
12382 (setq link (org-make-link cpltxt)))
12384 ((interactive-p)
12385 (error "Cannot link to a buffer which is not visiting a file"))
12387 (t (setq link nil)))
12389 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12390 (setq link (or link cpltxt)
12391 desc (or desc cpltxt))
12392 (if (equal desc "NONE") (setq desc nil))
12394 (if (and (interactive-p) link)
12395 (progn
12396 (setq org-stored-links
12397 (cons (list link desc) org-stored-links))
12398 (message "Stored: %s" (or desc link)))
12399 (and link (org-make-link-string link desc)))))
12401 (defun org-store-link-props (&rest plist)
12402 "Store link properties, extract names and addresses."
12403 (let (x adr)
12404 (when (setq x (plist-get plist :from))
12405 (setq adr (mail-extract-address-components x))
12406 (plist-put plist :fromname (car adr))
12407 (plist-put plist :fromaddress (nth 1 adr)))
12408 (when (setq x (plist-get plist :to))
12409 (setq adr (mail-extract-address-components x))
12410 (plist-put plist :toname (car adr))
12411 (plist-put plist :toaddress (nth 1 adr))))
12412 (let ((from (plist-get plist :from))
12413 (to (plist-get plist :to)))
12414 (when (and from to org-from-is-user-regexp)
12415 (plist-put plist :fromto
12416 (if (string-match org-from-is-user-regexp from)
12417 (concat "to %t")
12418 (concat "from %f")))))
12419 (setq org-store-link-plist plist))
12421 (defun org-email-link-description (&optional fmt)
12422 "Return the description part of an email link.
12423 This takes information from `org-store-link-plist' and formats it
12424 according to FMT (default from `org-email-link-description-format')."
12425 (setq fmt (or fmt org-email-link-description-format))
12426 (let* ((p org-store-link-plist)
12427 (to (plist-get p :toaddress))
12428 (from (plist-get p :fromaddress))
12429 (table
12430 (list
12431 (cons "%c" (plist-get p :fromto))
12432 (cons "%F" (plist-get p :from))
12433 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12434 (cons "%T" (plist-get p :to))
12435 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12436 (cons "%s" (plist-get p :subject))
12437 (cons "%m" (plist-get p :message-id)))))
12438 (when (string-match "%c" fmt)
12439 ;; Check if the user wrote this message
12440 (if (and org-from-is-user-regexp from to
12441 (save-match-data (string-match org-from-is-user-regexp from)))
12442 (setq fmt (replace-match "to %t" t t fmt))
12443 (setq fmt (replace-match "from %f" t t fmt))))
12444 (org-replace-escapes fmt table)))
12446 (defun org-make-org-heading-search-string (&optional string heading)
12447 "Make search string for STRING or current headline."
12448 (interactive)
12449 (let ((s (or string (org-get-heading))))
12450 (unless (and string (not heading))
12451 ;; We are using a headline, clean up garbage in there.
12452 (if (string-match org-todo-regexp s)
12453 (setq s (replace-match "" t t s)))
12455 (setq s (replace-match "" t t s)))
12456 (setq s (org-trim s))
12459 (setq s (replace-match "" t t s)))
12460 (while (string-match org-ts-regexp s)
12461 (setq s (replace-match "" t t s))))
12463 (setq s (replace-match " " t t s)))
12464 (or string (setq s (concat "*" s))) ; Add * for headlines
12467 (defun org-make-link (&rest strings)
12468 "Concatenate STRINGS."
12469 (apply 'concat strings))
12471 (defun org-make-link-string (link &optional description)
12472 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12474 (error "Empty link"))
12475 (when (stringp description)
12476 ;; Remove brackets from the description, they are fatal.
12478 (setq description (replace-match "{" t t description)))
12480 (setq description (replace-match "}" t t description))))
12481 (when (equal (org-link-escape link) description)
12482 ;; No description needed, it is identical
12483 (setq description nil))
12484 (when (and (not description)
12485 (not (equal link (org-link-escape link))))
12486 (setq description link))
12487 (concat "[[" (org-link-escape link) "]"
12488 (if description (concat "[" description "]") "")
12489 "]"))
12491 (defconst org-link-escape-chars
12492 '((?\ . "%20")
12493 (?\[ . "%5B")
12494 (?\] . "%5D")
12505 (?\; . "%3B")
12506 (?? . "%3F")
12507 (?= . "%3D")
12508 (?+ . "%2B")
12509 )
12510 "Association list of escapes for some characters problematic in links.
12511 This is the list that is used for internal purposes.")
12513 (defconst org-link-escape-chars-browser
12514 '((?\ . "%20")) ; 32 for the SPC char
12515 "Association list of escapes for some characters problematic in links.
12516 This is the list that is used before handing over to the browser.")
12518 (defun org-link-escape (text &optional table)
12519 "Escape charaters in TEXT that are problematic for links."
12520 (setq table (or table org-link-escape-chars))
12521 (when text
12522 (let ((re (mapconcat (lambda (x) (regexp-quote
12523 (char-to-string (car x))))
12525 (while (string-match re text)
12526 (setq text
12527 (replace-match
12528 (cdr (assoc (string-to-char (match-string 0 text))
12529 table))
12530 t t text)))
12531 text)))
12533 (defun org-link-unescape (text &optional table)
12534 "Reverse the action of `org-link-escape'."
12535 (setq table (or table org-link-escape-chars))
12536 (when text
12537 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12539 (while (string-match re text)
12540 (setq text
12541 (replace-match
12542 (char-to-string (car (rassoc (match-string 0 text) table)))
12543 t t text)))
12544 text)))
12546 (defun org-xor (a b)
12547 "Exclusive or."
12548 (if a (not b) b))
12550 (defun org-get-header (header)
12551 "Find a header field in the current buffer."
12552 (save-excursion
12553 (goto-char (point-min))
12554 (let ((case-fold-search t) s)
12555 (cond
12556 ((eq header 'from)
12558 (setq s (match-string 1)))
12560 (setq s (replace-match "" t t s)))
12561 (if (string-match "[<(].*" s)
12562 (setq s (replace-match "" t t s))))
12563 ((eq header 'message-id)
12565 (setq s (match-string 1))))
12566 ((eq header 'subject)
12568 (setq s (match-string 1)))))
12571 s)))
12574 (defun org-fixup-message-id-for-http (s)
12575 "Replace special characters in a message id, so it can be used in an http query."
12576 (while (string-match "<" s)
12577 (setq s (replace-match "%3C" t t s)))
12578 (while (string-match ">" s)
12579 (setq s (replace-match "%3E" t t s)))
12580 (while (string-match "@" s)
12581 (setq s (replace-match "%40" t t s)))
12582 s)
12584 ;;;###autoload
12585 (defun org-insert-link-global ()
12586 "Insert a link like Org-mode does.
12587 This command can be called in any mode to insert a link in Org-mode syntax."
12588 (interactive)
12589 (org-run-like-in-org-mode 'org-insert-link))
12591 (defun org-insert-link (&optional complete-file)
12592 "Insert a link. At the prompt, enter the link.
12594 Completion can be used to select a link previously stored with
12595 `org-store-link'. When the empty string is entered (i.e. if you just
12596 press RET at the prompt), the link defaults to the most recently
12597 stored link. As SPC triggers completion in the minibuffer, you need to
12598 use M-SPC or C-q SPC to force the insertion of a space character.
12600 You will also be prompted for a description, and if one is given, it will
12601 be displayed in the buffer instead of the link.
12603 If there is already a link at point, this command will allow you to edit link
12604 and description parts.
12607 selected using completion. The path to the file will be relative to
12608 the current directory if the file is in the current directory or a
12609 subdirectory. Otherwise, the link will be the absolute path as
12610 completed in the minibuffer (i.e. normally ~/path/to/file).
12613 is in the current directory or below.
12615 `org-keep-stored-link-after-insertion'."
12616 (interactive "P")
12617 (let* ((wcf (current-window-configuration))
12618 (region (if (org-region-active-p)
12619 (buffer-substring (region-beginning) (region-end))))
12620 (remove (and region (list (region-beginning) (region-end))))
12621 (desc region)
12622 tmphist ; byte-compile incorrectly complains about this
12623 link entry file)
12624 (cond
12625 ((org-in-regexp org-bracket-link-regexp 1)
12626 ;; We do have a link at point, and we are going to edit it.
12627 (setq remove (list (match-beginning 0) (match-end 0)))
12628 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12629 (setq link (read-string "Link: "
12630 (org-link-unescape
12631 (org-match-string-no-properties 1)))))
12632 ((or (org-in-regexp org-angle-link-re)
12633 (org-in-regexp org-plain-link-re))
12634 ;; Convert to bracket link
12635 (setq remove (list (match-beginning 0) (match-end 0))
12636 link (read-string "Link: "
12637 (org-remove-angle-brackets (match-string 0)))))
12638 ((equal complete-file '(4))
12639 ;; Completing read for file names.
12640 (setq file (read-file-name "File: "))
12641 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12642 (pwd1 (file-name-as-directory (abbreviate-file-name
12643 (expand-file-name ".")))))
12644 (cond
12645 ((equal complete-file '(16))
12646 (setq link (org-make-link
12647 "file:"
12648 (abbreviate-file-name (expand-file-name file)))))
12650 (setq link (org-make-link "file:" (match-string 1 file))))
12652 (expand-file-name file))
12653 (setq link (org-make-link
12654 "file:" (match-string 1 (expand-file-name file)))))
12655 (t (setq link (org-make-link "file:" file))))))
12656 (t
12657 ;; Read link, with completion for stored links.
12658 (with-output-to-temp-buffer "*Org Links*"
12660 (when org-stored-links
12662 (princ (mapconcat
12663 (lambda (x)
12664 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12666 (let ((cw (selected-window)))
12667 (select-window (get-buffer-window "*Org Links*"))
12668 (shrink-window-if-larger-than-buffer)
12669 (setq truncate-lines t)
12670 (select-window cw))
12671 ;; Fake a link history, containing the stored links.
12672 (setq tmphist (append (mapcar 'car org-stored-links)
12673 org-insert-link-history))
12674 (unwind-protect
12675 (setq link (org-completing-read
12676 "Link: "
12677 (append
12678 (mapcar (lambda (x) (list (concat (car x) ":")))
12679 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12680 (mapcar (lambda (x) (list (concat x ":")))
12681 org-link-types))
12682 nil nil nil
12683 'tmphist
12684 (or (car (car org-stored-links)))))
12685 (set-window-configuration wcf)
12686 (kill-buffer "*Org Links*"))
12687 (setq entry (assoc link org-stored-links))
12688 (or entry (push link org-insert-link-history))
12689 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12690 (not org-keep-stored-link-after-insertion))
12691 (setq org-stored-links (delq (assoc link org-stored-links)
12692 org-stored-links)))
12693 (setq desc (or desc (nth 1 entry)))))
12695 (if (string-match org-plain-link-re link)
12696 ;; URL-like link, normalize the use of angular brackets.
12697 (setq link (org-make-link (org-remove-angle-brackets link))))
12699 ;; Check if we are linking to the current file with a search option
12700 ;; If yes, simplify the link by using only the search option.
12701 (when (and buffer-file-name
12703 (let* ((path (match-string 1 link))
12704 (case-fold-search nil)
12705 (search (match-string 2 link)))
12706 (save-match-data
12707 (if (equal (file-truename buffer-file-name) (file-truename path))
12708 ;; We are linking to this same file, with a search option
12709 (setq link search)))))
12711 ;; Check if we can/should use a relative path. If yes, simplify the link
12713 (let* ((path (match-string 1 link))
12714 (origpath path)
12715 (case-fold-search nil))
12716 (cond
12717 ((eq org-link-file-path-type 'absolute)
12718 (setq path (abbreviate-file-name (expand-file-name path))))
12719 ((eq org-link-file-path-type 'noabbrev)
12720 (setq path (expand-file-name path)))
12721 ((eq org-link-file-path-type 'relative)
12722 (setq path (file-relative-name path)))
12723 (t
12724 (save-match-data
12725 (if (string-match (concat "^" (regexp-quote
12726 (file-name-as-directory
12727 (expand-file-name "."))))
12728 (expand-file-name path))
12729 ;; We are linking a file with relative path name.
12730 (setq path (substring (expand-file-name path)
12731 (match-end 0)))))))
12732 (setq link (concat "file:" path))
12733 (if (equal desc origpath)
12734 (setq desc path))))
12736 (setq desc (read-string "Description: " desc))
12738 (if remove (apply 'delete-region remove))
12739 (insert (org-make-link-string link desc))))
12741 (defun org-completing-read (&rest args)
12742 (let ((minibuffer-local-completion-map
12743 (copy-keymap minibuffer-local-completion-map)))
12744 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12745 (apply 'completing-read args)))
12747 ;;; Opening/following a link
12748 (defvar org-link-search-failed nil)
12750 (defun org-next-link ()
12751 "Move forward to the next link.
12752 If the link is in hidden text, expose it."
12753 (interactive)
12754 (when (and org-link-search-failed (eq this-command last-command))
12755 (goto-char (point-min))
12756 (message "Link search wrapped back to beginning of buffer"))
12757 (setq org-link-search-failed nil)
12758 (let* ((pos (point))
12759 (ct (org-context))
12760 (a (assoc :link ct)))
12761 (if a (goto-char (nth 2 a)))
12762 (if (re-search-forward org-any-link-re nil t)
12763 (progn
12764 (goto-char (match-beginning 0))
12765 (if (org-invisible-p) (org-show-context)))
12766 (goto-char pos)
12767 (setq org-link-search-failed t)
12768 (error "No further link found"))))
12770 (defun org-previous-link ()
12771 "Move backward to the previous link.
12772 If the link is in hidden text, expose it."
12773 (interactive)
12774 (when (and org-link-search-failed (eq this-command last-command))
12775 (goto-char (point-max))
12776 (message "Link search wrapped back to end of buffer"))
12777 (setq org-link-search-failed nil)
12778 (let* ((pos (point))
12779 (ct (org-context))
12780 (a (assoc :link ct)))
12781 (if a (goto-char (nth 1 a)))
12782 (if (re-search-backward org-any-link-re nil t)
12783 (progn
12784 (goto-char (match-beginning 0))
12785 (if (org-invisible-p) (org-show-context)))
12786 (goto-char pos)
12787 (setq org-link-search-failed t)
12788 (error "No further link found"))))
12790 (defun org-find-file-at-mouse (ev)
12791 "Open file link or URL at mouse."
12792 (interactive "e")
12793 (mouse-set-point ev)
12794 (org-open-at-point 'in-emacs))
12796 (defun org-open-at-mouse (ev)
12797 "Open file link or URL at mouse."
12798 (interactive "e")
12799 (mouse-set-point ev)
12800 (org-open-at-point))
12802 (defvar org-window-config-before-follow-link nil
12803 "The window configuration before following a link.
12804 This is saved in case the need arises to restore it.")
12806 (defvar org-open-link-marker (make-marker)
12807 "Marker pointing to the location where `org-open-at-point; was called.")
12809 ;;;###autoload
12810 (defun org-open-at-point-global ()
12811 "Follow a link like Org-mode does.
12812 This command can be called in any mode to follow a link that has
12813 Org-mode syntax."
12814 (interactive)
12815 (org-run-like-in-org-mode 'org-open-at-point))
12817 (defun org-open-at-point (&optional in-emacs)
12818 "Open link at or after point.
12819 If there is no link at point, this function will search forward up to
12820 the end of the current subtree.
12821 Normally, files will be opened by an appropriate application. If the
12822 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12823 (interactive "P")
12824 (move-marker org-open-link-marker (point))
12825 (setq org-window-config-before-follow-link (current-window-configuration))
12826 (org-remove-occur-highlights nil nil t)
12827 (if (org-at-timestamp-p t)
12828 (org-follow-timestamp-link)
12829 (let (type path link line search (pos (point)))
12830 (catch 'match
12831 (save-excursion
12833 (when (org-in-regexp org-bracket-link-regexp)
12834 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12836 (setq link (replace-match " " t t link)))
12837 (setq link (org-link-expand-abbrev link))
12838 (if (string-match org-link-re-with-space2 link)
12839 (setq type (match-string 1 link) path (match-string 2 link))
12840 (setq type "thisfile" path link))
12841 (throw 'match t)))
12843 (when (get-text-property (point) 'org-linked-text)
12844 (setq type "thisfile"
12845 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12846 (1+ (point)) (point))
12847 path (buffer-substring
12848 (previous-single-property-change pos 'org-linked-text)
12849 (next-single-property-change pos 'org-linked-text)))
12850 (throw 'match t))
12852 (save-excursion
12853 (when (or (org-in-regexp org-angle-link-re)
12854 (org-in-regexp org-plain-link-re))
12855 (setq type (match-string 1) path (match-string 2))
12856 (throw 'match t)))
12858 (setq type "tree-match"
12859 path (match-string 1))
12860 (throw 'match t))
12861 (save-excursion
12863 (setq type "tags"
12864 path (match-string 1))
12865 (while (string-match ":" path)
12866 (setq path (replace-match "+" t t path)))
12867 (throw 'match t))))
12868 (unless path
12869 (error "No link found"))
12870 ;; Remove any trailing spaces in path
12872 (setq path (replace-match "" t t path)))
12874 (cond
12876 ((assoc type org-link-protocols)
12877 (funcall (nth 1 (assoc type org-link-protocols)) path))
12879 ((equal type "mailto")
12880 (let ((cmd (car org-link-mailto-program))
12881 (args (cdr org-link-mailto-program)) args1
12882 (address path) (subject "") a)
12884 (setq address (match-string 1 path)
12885 subject (org-link-escape (match-string 2 path))))
12886 (while args
12887 (cond
12888 ((not (stringp (car args))) (push (pop args) args1))
12889 (t (setq a (pop args))
12890 (if (string-match "%a" a)
12891 (setq a (replace-match address t t a)))
12892 (if (string-match "%s" a)
12893 (setq a (replace-match subject t t a)))
12894 (push a args1))))
12895 (apply cmd (nreverse args1))))
12897 ((member type '("http" "https" "ftp" "news"))
12898 (browse-url (concat type ":" (org-link-escape
12899 path org-link-escape-chars-browser))))
12901 ((member type '("message"))
12902 (browse-url (concat type ":" path)))
12904 ((string= type "tags")
12905 (org-tags-view in-emacs path))
12906 ((string= type "thisfile")
12907 (if in-emacs
12908 (switch-to-buffer-other-window
12909 (org-get-buffer-for-internal-link (current-buffer)))
12910 (org-mark-ring-push))
12911 (let ((cmd `(org-link-search
12912 ,path
12913 ,(cond ((equal in-emacs '(4)) 'occur)
12914 ((equal in-emacs '(16)) 'org-occur)
12915 (t nil))
12916 ,pos)))
12917 (condition-case nil (eval cmd)
12918 (error (progn (widen) (eval cmd))))))
12920 ((string= type "tree-match")
12923 ((string= type "file")
12925 (setq line (string-to-number (match-string 1 path))
12926 path (substring path 0 (match-beginning 0)))
12928 (setq search (match-string 1 path)
12929 path (substring path 0 (match-beginning 0)))))
12930 (if (string-match "[*?{]" (file-name-nondirectory path))
12931 (dired path)
12932 (org-open-file path in-emacs line search)))
12934 ((string= type "news")
12935 (org-follow-gnus-link path))
12937 ((string= type "bbdb")
12938 (org-follow-bbdb-link path))
12940 ((string= type "info")
12941 (org-follow-info-link path))
12943 ((string= type "gnus")
12944 (let (group article)
12946 (error "Error in Gnus link"))
12947 (setq group (match-string 1 path)
12948 article (match-string 3 path))
12949 (org-follow-gnus-link group article)))
12951 ((string= type "vm")
12952 (let (folder article)
12954 (error "Error in VM link"))
12955 (setq folder (match-string 1 path)
12956 article (match-string 3 path))
12957 ;; in-emacs is the prefix arg, will be interpreted as read-only
12958 (org-follow-vm-link folder article in-emacs)))
12960 ((string= type "wl")
12961 (let (folder article)
12963 (error "Error in Wanderlust link"))
12964 (setq folder (match-string 1 path)
12965 article (match-string 3 path))
12966 (org-follow-wl-link folder article)))
12968 ((string= type "mhe")
12969 (let (folder article)
12971 (error "Error in MHE link"))
12972 (setq folder (match-string 1 path)
12973 article (match-string 3 path))
12974 (org-follow-mhe-link folder article)))
12976 ((string= type "rmail")
12977 (let (folder article)
12979 (error "Error in RMAIL link"))
12980 (setq folder (match-string 1 path)
12981 article (match-string 3 path))
12982 (org-follow-rmail-link folder article)))
12984 ((string= type "shell")
12985 (let ((cmd path))
12986 (if (or (not org-confirm-shell-link-function)
12987 (funcall org-confirm-shell-link-function
12989 (org-add-props cmd nil
12990 'face 'org-warning))))
12991 (progn
12992 (message "Executing %s" cmd)
12993 (shell-command cmd))
12994 (error "Abort"))))
12996 ((string= type "elisp")
12997 (let ((cmd path))
12998 (if (or (not org-confirm-elisp-link-function)
12999 (funcall org-confirm-elisp-link-function
13001 (org-add-props cmd nil
13002 'face 'org-warning))))
13003 (message "%s => %s" cmd (eval (read cmd)))
13004 (error "Abort"))))
13006 (t
13007 (browse-url-at-point)))))
13008 (move-marker org-open-link-marker nil)
13009 (run-hook-with-args 'org-follow-link-hook))
13011 ;;; File search
13013 (defvar org-create-file-search-functions nil
13014 "List of functions to construct the right search string for a file link.
13015 These functions are called in turn with point at the location to
13016 which the link should point.
13018 A function in the hook should first test if it would like to
13019 handle this file type, for example by checking the major-mode or
13020 the file extension. If it decides not to handle this file, it
13021 should just return nil to give other functions a chance. If it
13022 does handle the file, it must return the search string to be used
13023 when following the link. The search string will be part of the
13024 file link, given after a double colon, and `org-open-at-point'
13025 will automatically search for it. If special measures must be
13026 taken to make the search successful, another function should be
13027 added to the companion hook `org-execute-file-search-functions',
13028 which see.
13030 A function in this hook may also use `setq' to set the variable
13031 `description' to provide a suggestion for the descriptive text to
13032 be used for this link when it gets inserted into an Org-mode
13035 (defvar org-execute-file-search-functions nil
13036 "List of functions to execute a file search triggered by a link.
13038 Functions added to this hook must accept a single argument, the
13039 search string that was part of the file link, the part after the
13040 double colon. The function must first check if it would like to
13041 handle this search, for example by checking the major-mode or the
13042 file extension. If it decides not to handle this search, it
13043 should just return nil to give other functions a chance. If it
13044 does handle the search, it must return a non-nil value to keep
13045 other functions from trying.
13047 Each function can access the current prefix argument through the
13048 variable `current-prefix-argument'. Note that a single prefix is
13049 used to force opening a link in Emacs, so it may be good to only
13050 use a numeric or double prefix to guide the search function.
13052 In case this is needed, a function in this hook can also restore
13053 the window configuration before `org-open-at-point' was called using:
13055 (set-window-configuration org-window-config-before-follow-link)")
13057 (defun org-link-search (s &optional type avoid-pos)
13058 "Search for a link search option.
13059 If S is surrounded by forward slashes, it is interpreted as a
13060 regular expression. In org-mode files, this will create an `org-occur'
13061 sparse tree. In ordinary files, `occur' will be used to list matches.
13062 If the current buffer is in `dired-mode', grep will be used to search
13063 in all files. If AVOID-POS is given, ignore matches near that position."
13064 (let ((case-fold-search t)
13068 org-emphasis-alist)
13070 (pos (point))
13071 (pre "") (post "")
13072 words re0 re1 re2 re3 re4 re5 re2a reall)
13073 (cond
13074 ;; First check if there are any special
13075 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
13076 ;; Now try the builtin stuff
13077 ((save-excursion
13078 (goto-char (point-min))
13079 (and
13080 (re-search-forward
13081 (concat "<<" (regexp-quote s0) ">>") nil t)
13082 (setq pos (match-beginning 0))))
13083 ;; There is an exact target for this
13084 (goto-char pos))
13086 ;; A regular expression
13087 (cond
13088 ((org-mode-p)
13089 (org-occur (match-string 1 s)))
13090 ;;((eq major-mode 'dired-mode)
13091 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
13092 (t (org-do-occur (match-string 1 s)))))
13093 (t
13094 ;; A normal search strings
13095 (when (equal (string-to-char s) ?*)
13096 ;; Anchor on headlines, post may include tags.
13099 s (substring s 1)))
13100 (remove-text-properties
13101 0 (length s)
13102 '(face nil mouse-face nil keymap nil fontified nil) s)
13103 ;; Make a series of regular expressions to find a match
13110 re1 (concat pre re2 post)
13111 re3 (concat pre re4 post)
13112 re5 (concat pre ".*" re4)
13113 re2 (concat pre re2)
13114 re2a (concat pre re2a)
13115 re4 (concat pre re4)
13119 ))
13120 (cond
13121 ((eq type 'org-occur) (org-occur reall))
13122 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
13123 (t (goto-char (point-min))
13124 (if (or (org-search-not-self 1 re0 nil t)
13125 (org-search-not-self 1 re1 nil t)
13126 (org-search-not-self 1 re2 nil t)
13127 (org-search-not-self 1 re2a nil t)
13128 (org-search-not-self 1 re3 nil t)
13129 (org-search-not-self 1 re4 nil t)
13130 (org-search-not-self 1 re5 nil t)
13131 )
13132 (goto-char (match-beginning 1))
13133 (goto-char pos)
13134 (error "No match")))))
13135 (t
13136 ;; Normal string-search
13137 (goto-char (point-min))
13138 (if (search-forward s nil t)
13139 (goto-char (match-beginning 0))
13140 (error "No match"))))
13141 (and (org-mode-p) (org-show-context 'link-search))))
13143 (defun org-search-not-self (group &rest args)
13144 "Execute `re-search-forward', but only accept matches that do not
13145 enclose the position of `org-open-link-marker'."
13146 (let ((m org-open-link-marker))
13147 (catch 'exit
13148 (while (apply 're-search-forward args)
13149 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
13150 (goto-char (match-end group))
13151 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
13152 (> (match-beginning 0) (marker-position m))
13153 (< (match-end 0) (marker-position m)))
13154 (save-match-data
13155 (or (not (org-in-regexp
13156 org-bracket-link-analytic-regexp 1))
13157 (not (match-end 4)) ; no description
13158 (and (<= (match-beginning 4) (point))
13159 (>= (match-end 4) (point))))))
13160 (throw 'exit (point))))))))
13162 (defun org-get-buffer-for-internal-link (buffer)
13163 "Return a buffer to be used for displaying the link target of internal links."
13164 (cond
13165 ((not org-display-internal-link-with-indirect-buffer)
13166 buffer)
13167 ((string-match "(Clone)$" (buffer-name buffer))
13168 (message "Buffer is already a clone, not making another one")
13169 ;; we also do not modify visibility in this case
13170 buffer)
13171 (t ; make a new indirect buffer for displaying the link
13172 (let* ((bn (buffer-name buffer))
13173 (ibn (concat bn "(Clone)"))
13174 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13175 (with-current-buffer ib (org-overview))
13176 ib))))
13178 (defun org-do-occur (regexp &optional cleanup)
13179 "Call the Emacs command `occur'.
13180 If CLEANUP is non-nil, remove the printout of the regular expression
13181 in the *Occur* buffer. This is useful if the regex is long and not useful
13182 to read."
13183 (occur regexp)
13184 (when cleanup
13185 (let ((cwin (selected-window)) win beg end)
13186 (when (setq win (get-buffer-window "*Occur*"))
13187 (select-window win))
13188 (goto-char (point-min))
13189 (when (re-search-forward "match[a-z]+" nil t)
13190 (setq beg (match-end 0))
13192 (setq end (1- (match-beginning 0)))))
13193 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13194 (goto-char (point-min))
13195 (select-window cwin))))
13197 ;;; The mark ring for links jumps
13199 (defvar org-mark-ring nil
13200 "Mark ring for positions before jumps in Org-mode.")
13201 (defvar org-mark-ring-last-goto nil
13202 "Last position in the mark ring used to go back.")
13203 ;; Fill and close the ring
13204 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13205 (loop for i from 1 to org-mark-ring-length do
13206 (push (make-marker) org-mark-ring))
13207 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13208 org-mark-ring)
13210 (defun org-mark-ring-push (&optional pos buffer)
13211 "Put the current position or POS into the mark ring and rotate it."
13212 (interactive)
13213 (setq pos (or pos (point)))
13214 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13215 (move-marker (car org-mark-ring)
13216 (or pos (point))
13217 (or buffer (current-buffer)))
13218 (message "%s"
13219 (substitute-command-keys
13222 (defun org-mark-ring-goto (&optional n)
13223 "Jump to the previous position in the mark ring.
13224 With prefix arg N, jump back that many stored positions. When
13225 called several times in succession, walk through the entire ring.
13226 Org-mode commands jumping to a different position in the current file,
13227 or to another Org-mode file, automatically push the old position
13228 onto the ring."
13229 (interactive "p")
13230 (let (p m)
13231 (if (eq last-command this-command)
13232 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13233 (setq p org-mark-ring))
13234 (setq org-mark-ring-last-goto p)
13235 (setq m (car p))
13236 (switch-to-buffer (marker-buffer m))
13237 (goto-char m)
13238 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13240 (defun org-remove-angle-brackets (s)
13241 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13242 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13243 s)
13244 (defun org-add-angle-brackets (s)
13245 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13246 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13247 s)
13249 ;;; Following specific links
13251 (defun org-follow-timestamp-link ()
13252 (cond
13253 ((org-at-date-range-p t)
13254 (let ((org-agenda-start-on-weekday)
13255 (t1 (match-string 1))
13256 (t2 (match-string 2)))
13257 (setq t1 (time-to-days (org-time-string-to-time t1))
13258 t2 (time-to-days (org-time-string-to-time t2)))
13259 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13260 ((org-at-timestamp-p t)
13261 (org-agenda-list nil (time-to-days (org-time-string-to-time
13262 (substring (match-string 1) 0 10)))
13263 1))
13264 (t (error "This should not happen"))))
13267 (defun org-follow-bbdb-link (name)
13268 "Follow a BBDB link to NAME."
13269 (require 'bbdb)
13270 (let ((inhibit-redisplay (not debug-on-error))
13271 (bbdb-electric-p nil))
13272 (catch 'exit
13273 ;; Exact match on name
13275 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13276 ;; Exact match on name
13278 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13279 ;; Partial match on name
13280 (bbdb-name name nil)
13281 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13282 ;; Partial match on company
13283 (bbdb-company name nil)
13284 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13285 ;; General match including network address and notes
13286 (bbdb name nil)
13287 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13288 (delete-window (get-buffer-window "*BBDB*"))
13289 (error "No matching BBDB record")))))
13291 (defun org-follow-info-link (name)
13292 "Follow an info file & node link to NAME."
13295 (progn
13296 (require 'info)
13297 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13298 (Info-find-node (match-string 1 name) (match-string 2 name))
13299 (Info-find-node (match-string 1 name) "Top")))
13300 (message "Could not open: %s" name)))
13302 (defun org-follow-gnus-link (&optional group article)
13303 "Follow a Gnus link to GROUP and ARTICLE."
13304 (require 'gnus)
13305 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13306 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13307 (cond ((and group article)
13308 (gnus-group-read-group 1 nil group)
13309 (gnus-summary-goto-article (string-to-number article) nil t))
13310 (group (gnus-group-jump-to-group group))))
13312 (defun org-follow-vm-link (&optional folder article readonly)
13313 "Follow a VM link to FOLDER and ARTICLE."
13314 (require 'vm)
13315 (setq article (org-add-angle-brackets article))
13317 ;; ange-ftp or efs or tramp access
13318 (let ((user (or (match-string 1 folder) (user-login-name)))
13319 (host (match-string 2 folder))
13320 (file (match-string 3 folder)))
13321 (cond
13322 ((featurep 'tramp)
13323 ;; use tramp to access the file
13324 (if (featurep 'xemacs)
13325 (setq folder (format "[%s@%s]%s" user host file))
13326 (setq folder (format "/%s@%s:%s" user host file))))
13327 (t
13328 ;; use ange-ftp or efs
13329 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13330 (setq folder (format "/%s@%s:%s" user host file))))))
13331 (when folder
13332 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13333 (sit-for 0.1)
13334 (when article
13335 (vm-select-folder-buffer)
13336 (widen)
13337 (let ((case-fold-search t))
13338 (goto-char (point-min))
13339 (if (not (re-search-forward
13340 (concat "^" "message-id: *" (regexp-quote article))))
13341 (error "Could not find the specified message in this folder"))
13342 (vm-isearch-update)
13343 (vm-isearch-narrow)
13344 (vm-beginning-of-message)
13345 (vm-summarize)))))
13347 (defun org-follow-wl-link (folder article)
13348 "Follow a Wanderlust link to FOLDER and ARTICLE."
13349 (if (and (string= folder "%")
13350 article
13352 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13353 ;; Thus, we recompose folder and article ids.
13354 (setq folder (format "%s#%s" folder (match-string 1 article))
13355 article (match-string 3 article)))
13356 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13357 (error "No such folder: %s" folder))
13358 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13359 (and article
13360 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13361 (wl-summary-redisplay)))
13363 (defun org-follow-rmail-link (folder article)
13364 "Follow an RMAIL link to FOLDER and ARTICLE."
13365 (setq article (org-add-angle-brackets article))
13366 (let (message-number)
13367 (save-excursion
13368 (save-window-excursion
13369 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13370 (setq message-number
13371 (save-restriction
13372 (widen)
13373 (goto-char (point-max))
13374 (if (re-search-backward
13376 (or article "")))
13377 nil t)
13378 (rmail-what-message))))))
13379 (if message-number
13380 (progn
13381 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13382 (rmail-show-message message-number)
13383 message-number)
13384 (error "Message not found"))))
13386 ;;; mh-e integration based on planner-mode
13387 (defun org-mhe-get-message-real-folder ()
13388 "Return the name of the current message real folder, so if you use
13389 sequences, it will now work."
13390 (save-excursion
13391 (let* ((folder
13392 (if (equal major-mode 'mh-folder-mode)
13393 mh-current-folder
13394 ;; Refer to the show buffer
13395 mh-show-folder-buffer))
13396 (end-index
13397 (if (boundp 'mh-index-folder)
13398 (min (length mh-index-folder) (length folder))))
13399 )
13400 ;; a simple test on mh-index-data does not work, because
13401 ;; mh-index-data is always nil in a show buffer.
13402 (if (and (boundp 'mh-index-folder)
13403 (string= mh-index-folder (substring folder 0 end-index)))
13404 (if (equal major-mode 'mh-show-mode)
13405 (save-window-excursion
13406 (let (pop-up-frames)
13407 (when (buffer-live-p (get-buffer folder))
13408 (progn
13409 (pop-to-buffer folder)
13410 (org-mhe-get-message-folder-from-index)
13411 )
13412 )))
13413 (org-mhe-get-message-folder-from-index)
13414 )
13415 folder
13416 )
13417 )))
13419 (defun org-mhe-get-message-folder-from-index ()
13420 "Returns the name of the message folder in a index folder buffer."
13421 (save-excursion
13422 (mh-index-previous-folder)
13424 (message "%s" (match-string 1))))
13426 (defun org-mhe-get-message-folder ()
13427 "Return the name of the current message folder. Be careful if you
13428 use sequences."
13429 (save-excursion
13430 (if (equal major-mode 'mh-folder-mode)
13431 mh-current-folder
13432 ;; Refer to the show buffer
13433 mh-show-folder-buffer)))
13435 (defun org-mhe-get-message-num ()
13436 "Return the number of the current message. Be careful if you
13437 use sequences."
13438 (save-excursion
13439 (if (equal major-mode 'mh-folder-mode)
13440 (mh-get-msg-num nil)
13441 ;; Refer to the show buffer
13442 (mh-show-buffer-message-number))))
13444 (defun org-mhe-get-header (header)
13445 "Return a header of the message in folder mode. This will create a
13446 show buffer for the corresponding message. If you have a more clever
13447 idea..."
13448 (let* ((folder (org-mhe-get-message-folder))
13449 (num (org-mhe-get-message-num))
13450 (buffer (get-buffer-create (concat "show-" folder)))
13451 (header-field))
13452 (with-current-buffer buffer
13453 (mh-display-msg num folder)
13454 (if (equal major-mode 'mh-folder-mode)
13455 (mh-header-display)
13456 (mh-show-header-display))
13457 (set-buffer buffer)
13458 (setq header-field (mh-get-header-field header))
13459 (if (equal major-mode 'mh-folder-mode)
13460 (mh-show)
13461 (mh-show-show))
13462 header-field)))
13464 (defun org-follow-mhe-link (folder article)
13465 "Follow an MHE link to FOLDER and ARTICLE.
13466 If ARTICLE is nil FOLDER is shown. If the configuration variable
13467 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13468 ARTICLE is searched in all folders. Indexed searches (swish++,
13469 namazu, and others supported by MH-E) will always search in all
13470 folders."
13471 (require 'mh-e)
13472 (require 'mh-search)
13473 (require 'mh-utils)
13474 (mh-find-path)
13475 (if (not article)
13476 (mh-visit-folder (mh-normalize-folder-name folder))
13477 (setq article (org-add-angle-brackets article))
13478 (mh-search-choose)
13479 (if (equal mh-searcher 'pick)
13480 (progn
13481 (mh-search folder (list "--message-id" article))
13482 (when (and org-mhe-search-all-folders
13483 (not (org-mhe-get-message-real-folder)))
13484 (kill-this-buffer)
13485 (mh-search "+" (list "--message-id" article))))
13486 (mh-search "+" article))
13487 (if (org-mhe-get-message-real-folder)
13488 (mh-show-msg 1)
13489 (kill-this-buffer)
13490 (error "Message not found"))))
13492 ;;; BibTeX links
13494 ;; Use the custom search meachnism to construct and use search strings for
13495 ;; file links to BibTeX database entries.
13497 (defun org-create-file-search-in-bibtex ()
13498 "Create the search string and description for a BibTeX database entry."
13499 (when (eq major-mode 'bibtex-mode)
13500 ;; yes, we want to construct this search string.
13501 ;; Make a good description for this entry, using names, year and the title
13502 ;; Put it into the `description' variable which is dynamically scoped.
13503 (let ((bibtex-autokey-names 1)
13504 (bibtex-autokey-names-stretch 1)
13505 (bibtex-autokey-name-case-convert-function 'identity)
13506 (bibtex-autokey-name-separator " & ")
13507 (bibtex-autokey-additional-names " et al.")
13508 (bibtex-autokey-year-length 4)
13509 (bibtex-autokey-name-year-separator " ")
13510 (bibtex-autokey-titlewords 3)
13511 (bibtex-autokey-titleword-separator " ")
13512 (bibtex-autokey-titleword-case-convert-function 'identity)
13513 (bibtex-autokey-titleword-length 'infty)
13514 (bibtex-autokey-year-title-separator ": "))
13515 (setq description (bibtex-generate-autokey)))
13516 ;; Now parse the entry, get the key and return it.
13517 (save-excursion
13518 (bibtex-beginning-of-entry)
13519 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13521 (defun org-execute-file-search-in-bibtex (s)
13522 "Find the link search string S as a key for a database entry."
13523 (when (eq major-mode 'bibtex-mode)
13524 ;; Yes, we want to do the search in this file.
13525 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13526 (goto-char (point-min))
13529 (goto-char (match-beginning 0)))
13530 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13531 ;; Use double prefix to indicate that any web link should be browsed
13532 (let ((b (current-buffer)) (p (point)))
13533 ;; Restore the window configuration because we just use the web link
13534 (set-window-configuration org-window-config-before-follow-link)
13535 (save-excursion (set-buffer b) (goto-char p)
13536 (bibtex-url)))
13537 (recenter 0)) ; Move entry start to beginning of window
13538 ;; return t to indicate that the search is done.
13539 t))
13541 ;; Finally add the functions to the right hooks.
13542 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13543 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13545 ;; end of Bibtex link setup
13547 ;;; Following file links
13549 (defun org-open-file (path &optional in-emacs line search)
13550 "Open the file at PATH.
13551 First, this expands any special file name abbreviations. Then the
13552 configuration variable `org-file-apps' is checked if it contains an
13553 entry for this file type, and if yes, the corresponding command is launched.
13554 If no application is found, Emacs simply visits the file.
13555 With optional argument IN-EMACS, Emacs will visit the file.
13556 Optional LINE specifies a line to go to, optional SEARCH a string to
13557 search for. If LINE or SEARCH is given, the file will always be
13558 opened in Emacs.
13559 If the file does not exist, an error is thrown."
13560 (setq in-emacs (or in-emacs line search))
13561 (let* ((file (if (equal path "")
13562 buffer-file-name
13563 (substitute-in-file-name (expand-file-name path))))
13564 (apps (append org-file-apps (org-default-apps)))
13565 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13566 (dirp (if remp nil (file-directory-p file)))
13567 (dfile (downcase file))
13568 (old-buffer (current-buffer))
13569 (old-pos (point))
13570 (old-mode major-mode)
13571 ext cmd)
13573 (setq ext (match-string 1 dfile))
13575 (setq ext (match-string 1 dfile))))
13576 (if in-emacs
13577 (setq cmd 'emacs)
13578 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13579 (and dirp (cdr (assoc 'directory apps)))
13580 (cdr (assoc ext apps))
13581 (cdr (assoc t apps)))))
13582 (when (eq cmd 'mailcap)
13583 (require 'mailcap)
13584 (mailcap-parse-mailcaps)
13585 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13586 (command (mailcap-mime-info mime-type)))
13587 (if (stringp command)
13588 (setq cmd command)
13589 (setq cmd 'emacs))))
13590 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13591 (not (file-exists-p file))
13592 (not org-open-non-existing-files))
13593 (error "No such file: %s" file))
13594 (cond
13596 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13598 (setq cmd (replace-match "%s" t t cmd)))
13599 (while (string-match "%s" cmd)
13600 (setq cmd (replace-match
13601 (save-match-data (shell-quote-argument file))
13602 t t cmd)))
13603 (save-window-excursion
13604 (start-process-shell-command cmd nil cmd)))
13605 ((or (stringp cmd)
13606 (eq cmd 'emacs))
13607 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13608 (widen)
13609 (if line (goto-line line)
13610 (if search (org-link-search search))))
13611 ((consp cmd)
13612 (eval cmd))
13613 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13614 (and (org-mode-p) (eq old-mode 'org-mode)
13615 (or (not (equal old-buffer (current-buffer)))
13616 (not (equal old-pos (point))))
13617 (org-mark-ring-push old-pos old-buffer))))
13619 (defun org-default-apps ()
13620 "Return the default applications for this operating system."
13621 (cond
13622 ((eq system-type 'darwin)
13623 org-file-apps-defaults-macosx)
13624 ((eq system-type 'windows-nt)
13625 org-file-apps-defaults-windowsnt)
13626 (t org-file-apps-defaults-gnu)))
13628 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13629 (defun org-file-remote-p (file)
13630 "Test whether FILE specifies a location on a remote system.
13631 Return non-nil if the location is indeed remote.
13635 (cond ((fboundp 'file-remote-p)
13636 (file-remote-p file))
13637 ((fboundp 'tramp-handle-file-remote-p)
13638 (tramp-handle-file-remote-p file))
13639 ((and (boundp 'ange-ftp-name-format)
13640 (string-match (car ange-ftp-name-format) file))
13641 t)
13642 (t nil)))
13645 ;;;; Hooks for remember.el, and refiling
13647 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13648 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13650 ;;;###autoload
13651 (defun org-remember-insinuate ()
13652 "Setup remember.el for use wiht Org-mode."
13653 (require 'remember)
13654 (setq remember-annotation-functions '(org-remember-annotation))
13655 (setq remember-handler-functions '(org-remember-handler))
13656 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13658 ;;;###autoload
13659 (defun org-remember-annotation ()
13660 "Return a link to the current location as an annotation for remember.el.
13661 If you are using Org-mode files as target for data storage with
13662 remember.el, then the annotations should include a link compatible with the
13663 conventions in Org-mode. This function returns such a link."
13664 (org-store-link nil))
13666 (defconst org-remember-help
13667 "Select a destination location for the note.
13668 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13669 RET on headline -> Store as sublevel entry to current headline
13670 RET at beg-of-buf -> Append to file as level 2 headline
13671 <left>/<right> -> before/after current headline, same headings level")
13673 (defvar org-remember-previous-location nil)
13674 (defvar org-force-remember-template-char) ;; dynamically scoped
13676 ;; Save the major mode of the buffer we called remember from
13677 (defvar org-select-template-temp-major-mode nil)
13679 ;; Temporary store the buffer where remember was called from
13680 (defvar org-select-template-original-buffer nil)
13682 (defun org-select-remember-template (&optional use-char)
13683 (when org-remember-templates
13684 (let* ((pre-selected-templates
13685 (mapcar
13686 (lambda (tpl)
13687 (let ((ctxt (nth 5 tpl))
13688 (mode org-select-template-temp-major-mode)
13689 (buf org-select-template-original-buffer))
13690 (if (or (and (functionp ctxt)
13691 (save-excursion
13692 (set-buffer buf)
13693 ;; Protect the user-defined function from error
13694 (condition-case nil (funcall ctxt) (error nil))))
13695 (and ctxt (listp ctxt)
13696 (delq nil (mapcar (lambda(x) (eq mode x)) ctxt))))
13697 tpl)))
13698 org-remember-templates))
13699 ;; If no template at this point, add the default templates:
13700 (pre-selected-templates1
13701 (if (not (delq nil pre-selected-templates))
13702 (mapcar (lambda(x) (if (not (nth 5 x)) x))
13703 org-remember-templates)
13704 pre-selected-templates))
13705 ;; Then unconditionnally add template for any contexts
13706 (pre-selected-templates2
13707 (append (mapcar (lambda(x) (if (eq (nth 5 x) t) x))
13708 org-remember-templates)
13709 (delq nil pre-selected-templates1)))
13710 (templates (mapcar (lambda (x)
13711 (if (stringp (car x))
13712 (append (list (nth 1 x) (car x)) (cddr x))
13713 (append (list (car x) "") (cdr x))))
13714 (delq nil pre-selected-templates2)))
13715 (char (or use-char
13716 (cond
13717 ((= (length templates) 1)
13718 (caar templates))
13719 ((and (boundp 'org-force-remember-template-char)
13720 org-force-remember-template-char)
13721 (if (stringp org-force-remember-template-char)
13722 (string-to-char org-force-remember-template-char)
13723 org-force-remember-template-char))
13724 (t
13725 (message "Select template: %s"
13726 (mapconcat
13727 (lambda (x)
13728 (cond
13730 (format "[%c]" (car x)))
13731 ((equal (downcase (car x))
13732 (downcase (aref (nth 1 x) 0)))
13733 (format "[%c]%s" (car x)
13734 (substring (nth 1 x) 1)))
13735 (t (format "[%c]%s" (car x) (nth 1 x)))))
13736 templates " "))
13737 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13738 (when (equal char0 ?\C-g)
13739 (jump-to-register remember-register)
13740 (kill-buffer remember-buffer))
13741 char0))))))
13742 (cddr (assoc char templates)))))
13744 (defvar x-last-selected-text)
13745 (defvar x-last-selected-text-primary)
13747 ;;;###autoload
13748 (defun org-remember-apply-template (&optional use-char skip-interactive)
13749 "Initialize *remember* buffer with template, invoke `org-mode'.
13750 This function should be placed into `remember-mode-hook' and in fact requires
13751 to be run from that hook to function properly."
13752 (if org-remember-templates
13753 (let* ((entry (org-select-remember-template use-char))
13754 (tpl (car entry))
13755 (plist-p (if org-store-link-plist t nil))
13756 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13758 (nth 1 entry)
13759 org-default-notes-file))
13760 (headline (nth 2 entry))
13761 (v-c (or (and (eq window-system 'x)
13762 (fboundp 'x-cut-buffer-or-selection-value)
13763 (x-cut-buffer-or-selection-value))
13764 (org-bound-and-true-p x-last-selected-text)
13765 (org-bound-and-true-p x-last-selected-text-primary)
13766 (and (> (length kill-ring) 0) (current-kill 0))))
13767 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13768 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13769 (v-u (concat "[" (substring v-t 1 -1) "]"))
13770 (v-U (concat "[" (substring v-T 1 -1) "]"))
13771 ;; `initial' and `annotation' are bound in `remember'
13772 (v-i (if (boundp 'initial) initial))
13773 (v-a (if (and (boundp 'annotation) annotation)
13774 (if (equal annotation "[[]]") "" annotation)
13775 ""))
13776 (v-A (if (and v-a
13779 v-a))
13780 (v-n user-full-name)
13781 (org-startup-folded nil)
13782 org-time-was-given org-end-time-was-given x
13783 prompt completions char time pos default histvar)
13784 (setq org-store-link-plist
13785 (append (list :annotation v-a :initial v-i)
13786 org-store-link-plist))
13787 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13788 (erase-buffer)
13789 (insert (substitute-command-keys
13790 (format
13791 "## Filing location: Select interactively, default, or last used:
13792 ## %s to select file and header location interactively.
13796 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13797 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13798 (abbreviate-file-name (or file org-default-notes-file))
13799 (or headline "")
13800 (or (car org-remember-previous-location) "???")
13801 (or (cdr org-remember-previous-location) "???"))))
13802 (insert tpl) (goto-char (point-min))
13803 ;; Simple %-escapes
13805 (when (and initial (equal (match-string 0) "%i"))
13806 (save-match-data
13807 (let* ((lead (buffer-substring
13808 (point-at-bol) (match-beginning 0))))
13809 (setq v-i (mapconcat 'identity
13812 (replace-match
13813 (or (eval (intern (concat "v-" (match-string 1)))) "")
13814 t t))
13816 ;; %[] Insert contents of a file.
13817 (goto-char (point-min))
13819 (let ((start (match-beginning 0))
13820 (end (match-end 0))
13821 (filename (expand-file-name (match-string 1))))
13822 (goto-char start)
13823 (delete-region start end)
13824 (condition-case error
13825 (insert-file-contents filename)
13826 (error (insert (format "%%![Couldn't insert %s: %s]"
13827 filename error))))))
13828 ;; %() embedded elisp
13829 (goto-char (point-min))
13831 (goto-char (match-beginning 0))
13832 (let ((template-start (point)))
13833 (forward-char 1)
13834 (let ((result
13835 (condition-case error
13836 (eval (read (current-buffer)))
13837 (error (format "%%![Error: %s]" error)))))
13838 (delete-region template-start (point))
13839 (insert result))))
13841 ;; From the property list
13842 (when plist-p
13843 (goto-char (point-min))
13845 (and (setq x (or (plist-get org-store-link-plist
13846 (intern (match-string 1))) ""))
13847 (replace-match x t t))))
13849 ;; Turn on org-mode in the remember buffer, set local variables
13850 (org-mode)
13851 (org-set-local 'org-finish-function 'org-remember-finalize)
13853 (org-set-local 'org-default-notes-file file))
13855 (org-set-local 'org-remember-default-headline headline))
13856 ;; Interactive template entries
13857 (goto-char (point-min))
13859 (setq char (if (match-end 3) (match-string 3))
13860 prompt (if (match-end 2) (match-string 2)))
13861 (goto-char (match-beginning 0))
13862 (replace-match "")
13863 (setq completions nil default nil)
13864 (when prompt
13865 (setq completions (org-split-string prompt "|")
13866 prompt (pop completions)
13867 default (car completions)
13868 histvar (intern (concat
13869 "org-remember-template-prompt-history::"
13870 (or prompt "")))
13871 completions (mapcar 'list completions)))
13872 (cond
13873 ((member char '("G" "g"))
13874 (let* ((org-last-tags-completion-table
13875 (org-global-tags-completion-table
13876 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13877 (org-add-colon-after-tag-completion t)
13878 (ins (completing-read
13879 (if prompt (concat prompt ": ") "Tags: ")
13880 'org-tags-completion-function nil nil nil
13881 'org-tags-history)))
13882 (setq ins (mapconcat 'identity
13883 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13884 ":"))
13886 (or (equal (char-before) ?:) (insert ":"))
13887 (insert ins)
13888 (or (equal (char-after) ?:) (insert ":")))))
13889 (char
13890 (setq org-time-was-given (equal (upcase char) char))
13891 (setq time (org-read-date (equal (upcase char) "U") t nil
13892 prompt))
13893 (org-insert-time-stamp time org-time-was-given
13894 (member char '("u" "U"))
13895 nil nil (list org-end-time-was-given)))
13896 (t
13897 (insert (org-completing-read
13898 (concat (if prompt prompt "Enter string")
13899 (if default (concat " [" default "]"))
13900 ": ")
13901 completions nil nil nil histvar default)))))
13902 (goto-char (point-min))
13904 (replace-match "")
13906 (org-mode)
13907 (org-set-local 'org-finish-function 'org-remember-finalize))
13908 (when (save-excursion
13909 (goto-char (point-min))
13910 (re-search-forward "%!" nil t))
13911 (replace-match "")
13912 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13914 (defun org-remember-finish-immediately ()
13915 "File remember note immediately.
13916 This should be run in `post-command-hook' and will remove itself
13917 from that hook."
13918 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13919 (when org-finish-function
13920 (funcall org-finish-function)))
13922 (defvar org-clock-marker) ; Defined below
13923 (defun org-remember-finalize ()
13924 "Finalize the remember process."
13925 (unless (fboundp 'remember-finalize)
13926 (defalias 'remember-finalize 'remember-buffer))
13927 (when (and org-clock-marker
13928 (equal (marker-buffer org-clock-marker) (current-buffer)))
13929 ;; FIXME: test this, this is w/o notetaking!
13930 (let (org-log-note-clock-out) (org-clock-out)))
13931 (when buffer-file-name
13932 (save-buffer)
13933 (setq buffer-file-name nil))
13934 (remember-finalize))
13936 ;;;###autoload
13937 (defun org-remember (&optional goto org-force-remember-template-char)
13938 "Call `remember'. If this is already a remember buffer, re-apply template.
13939 If there is an active region, make sure remember uses it as initial content
13940 of the remember buffer.
13942 When called interactively with a `C-u' prefix argument GOTO, don't remember
13943 anything, just go to the file/headline where the selected template usually
13944 stores its notes. With a double prefix arg `C-u C-u', go to the last
13945 note stored by remember.
13947 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13948 associated with a template in `org-remember-templates'."
13949 (interactive "P")
13950 (cond
13951 ((equal goto '(4)) (org-go-to-remember-target))
13952 ((equal goto '(16)) (org-remember-goto-last-stored))
13953 (t
13954 ;; set temporary variables that will be needed in
13955 ;; `org-select-remember-template'
13956 (setq org-select-template-temp-major-mode major-mode)
13957 (setq org-select-template-original-buffer (current-buffer))
13958 (if (memq org-finish-function '(remember-buffer remember-finalize))
13959 (progn
13960 (when (< (length org-remember-templates) 2)
13961 (error "No other template available"))
13962 (erase-buffer)
13963 (let ((annotation (plist-get org-store-link-plist :annotation))
13964 (initial (plist-get org-store-link-plist :initial)))
13965 (org-remember-apply-template))
13966 (message "Press C-c C-c to remember data"))
13967 (if (org-region-active-p)
13968 (remember (buffer-substring (point) (mark)))
13969 (call-interactively 'remember))))))
13971 (defun org-remember-goto-last-stored ()
13972 "Go to the location where the last remember note was stored."
13973 (interactive)
13974 (bookmark-jump "org-remember-last-stored")
13975 (message "This is the last note stored by remember"))
13977 (defun org-go-to-remember-target (&optional template-key)
13978 "Go to the target location of a remember template.
13979 The user is queried for the template."
13980 (interactive)
13981 (let* (org-select-template-temp-major-mode
13982 (entry (org-select-remember-template template-key))
13983 (file (nth 1 entry))
13984 (heading (nth 2 entry))
13985 visiting)
13987 (setq file org-default-notes-file))
13989 (setq heading org-remember-default-headline))
13990 (setq visiting (org-find-base-buffer-visiting file))
13991 (if (not visiting) (find-file-noselect file))
13992 (switch-to-buffer (or visiting (get-file-buffer file)))
13993 (widen)
13994 (goto-char (point-min))
13995 (if (re-search-forward
13998 nil t)
13999 (goto-char (match-beginning 0))
14000 (error "Target headline not found: %s" heading))))
14002 (defvar org-note-abort nil) ; dynamically scoped
14004 ;;;###autoload
14005 (defun org-remember-handler ()
14006 "Store stuff from remember.el into an org file.
14007 First prompts for an org file. If the user just presses return, the value
14008 of `org-default-notes-file' is used.
14009 Then the command offers the headings tree of the selected file in order to
14010 file the text at a specific location.
14011 You can either immediately press RET to get the note appended to the
14012 file, or you can use vertical cursor motion and visibility cycling (TAB) to
14013 find a better place. Then press RET or <left> or <right> in insert the note.
14015 Key Cursor position Note gets inserted
14016 -----------------------------------------------------------------------------
14017 RET buffer-start as level 1 heading at end of file
14018 RET on headline as sublevel of the heading at cursor
14019 RET no heading at cursor position, level taken from context.
14020 Or use prefix arg to specify level manually.
14021 <left> on headline as same level, before current heading
14022 <right> on headline as same level, after current heading
14024 So the fastest way to store the note is to press RET RET to append it to
14025 the default file. This way your current train of thought is not
14026 interrupted, in accordance with the principles of remember.el.
14027 You can also get the fast execution without prompting by using
14028 C-u C-c C-c to exit the remember buffer. See also the variable
14029 `org-remember-store-without-prompt'.
14031 Before being stored away, the function ensures that the text has a
14033 is constructed from the current date and some additional data.
14035 If the variable `org-adapt-indentation' is non-nil, the entire text is
14036 also indented so that it starts in the same column as the headline
14037 \(i.e. after the stars).
14039 See also the variable `org-reverse-note-order'."
14040 (goto-char (point-min))
14042 (replace-match ""))
14043 (goto-char (point-max))
14044 (beginning-of-line 1)
14046 (delete-region (1- (point)) (point-max))
14047 (beginning-of-line 1))
14048 (catch 'quit
14049 (if org-note-abort (throw 'quit nil))
14050 (let* ((txt (buffer-substring (point-min) (point-max)))
14051 (fastp (org-xor (equal current-prefix-arg '(4))
14052 org-remember-store-without-prompt))
14053 (file (cond
14054 (fastp org-default-notes-file)
14055 ((and (eq org-remember-interactive-interface 'refile)
14056 org-refile-targets)
14057 org-default-notes-file)
14058 ((not (and (equal current-prefix-arg '(16))
14059 org-remember-previous-location))
14060 (org-get-org-file))))
14061 (heading org-remember-default-headline)
14062 (visiting (and file (org-find-base-buffer-visiting file)))
14063 (org-startup-folded nil)
14064 (org-startup-align-all-tables nil)
14065 (org-goto-start-pos 1)
14066 spos exitcmd level indent reversed)
14067 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
14068 (setq file (car org-remember-previous-location)
14069 heading (cdr org-remember-previous-location)
14070 fastp t))
14071 (setq current-prefix-arg nil)
14073 (setq txt (replace-match "" t t txt)))
14074 ;; Modify text so that it becomes a nice subtree which can be inserted
14075 ;; into an org tree.
14077 first)
14078 (setq first (car lines) lines (cdr lines))
14080 ;; Is already a headline
14081 (setq indent nil)
14082 ;; We need to add a headline: Use time and first buffer line
14083 (setq lines (cons first lines)
14084 first (concat "* " (current-time-string)
14085 " (" (remember-buffer-desc) ")")
14086 indent " "))
14087 (if (and org-adapt-indentation indent)
14088 (setq lines (mapcar
14089 (lambda (x)
14091 (concat indent x) x))
14092 lines)))
14099 ;; Put the modified text back into the remember buffer, for refile.
14100 (erase-buffer)
14101 (insert txt)
14102 (goto-char (point-min))
14103 (when (and (eq org-remember-interactive-interface 'refile)
14104 (not fastp))
14105 (org-refile nil (or visiting (find-file-noselect file)))
14106 (throw 'quit t))
14107 ;; Find the file
14108 (if (not visiting) (find-file-noselect file))
14109 (with-current-buffer (or visiting (get-file-buffer file))
14110 (unless (org-mode-p)
14111 (error "Target files for remember notes must be in Org-mode"))
14112 (save-excursion
14113 (save-restriction
14114 (widen)
14115 (and (goto-char (point-min))
14118 (setq reversed (org-notes-order-reversed-p))
14120 ;; Find the default location
14122 (goto-char (point-min))
14123 (if (re-search-forward
14126 nil t)
14127 (setq org-goto-start-pos (match-beginning 0))
14128 (when fastp
14129 (goto-char (point-max))
14130 (unless (bolp) (newline))
14132 (setq org-goto-start-pos (point-at-bol 0)))))
14134 ;; Ask the User for a location, using the appropriate interface
14135 (cond
14136 (fastp (setq spos org-goto-start-pos
14137 exitcmd 'return))
14138 ((eq org-remember-interactive-interface 'outline)
14139 (setq spos (org-get-location (current-buffer)
14140 org-remember-help)
14141 exitcmd (cdr spos)
14142 spos (car spos)))
14143 ((eq org-remember-interactive-interface 'outline-path-completion)
14144 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
14145 (org-refile-use-outline-path t))
14146 (setq spos (org-refile-get-location "Heading: ")
14147 exitcmd 'return
14148 spos (nth 3 spos))))
14149 (t (error "this should not hapen")))
14150 (if (not spos) (throw 'quit nil)) ; return nil to show we did
14151 ; not handle this note
14152 (goto-char spos)
14153 (cond ((org-on-heading-p t)
14154 (org-back-to-heading t)
14155 (setq level (funcall outline-level))
14156 (cond
14157 ((eq exitcmd 'return)
14158 ;; sublevel of current
14159 (setq org-remember-previous-location
14160 (cons (abbreviate-file-name file)
14161 (org-get-heading 'notags)))
14162 (if reversed
14163 (outline-next-heading)
14164 (org-end-of-subtree t)
14165 (if (not (bolp))
14167 (beginning-of-line 2)
14168 (end-of-line 1)
14170 (bookmark-set "org-remember-last-stored")
14171 (org-paste-subtree (org-get-legal-level level 1) txt))
14172 ((eq exitcmd 'left)
14173 ;; before current
14174 (bookmark-set "org-remember-last-stored")
14175 (org-paste-subtree level txt))
14176 ((eq exitcmd 'right)
14177 ;; after current
14178 (org-end-of-subtree t)
14179 (bookmark-set "org-remember-last-stored")
14180 (org-paste-subtree level txt))
14181 (t (error "This should not happen"))))
14183 ((and (bobp) (not reversed))
14184 ;; Put it at the end, one level below level 1
14185 (save-restriction
14186 (widen)
14187 (goto-char (point-max))
14188 (if (not (bolp)) (newline))
14189 (bookmark-set "org-remember-last-stored")
14190 (org-paste-subtree (org-get-legal-level 1 1) txt)))
14192 ((and (bobp) reversed)
14193 ;; Put it at the start, as level 1
14194 (save-restriction
14195 (widen)
14196 (goto-char (point-min))
14198 (beginning-of-line 1)
14199 (bookmark-set "org-remember-last-stored")
14200 (org-paste-subtree 1 txt)))
14201 (t
14202 ;; Put it right there, with automatic level determined by
14203 ;; org-paste-subtree or from prefix arg
14204 (bookmark-set "org-remember-last-stored")
14205 (org-paste-subtree
14206 (if (numberp current-prefix-arg) current-prefix-arg)
14207 txt)))
14208 (when remember-save-after-remembering
14209 (save-buffer)
14210 (if (not visiting) (kill-buffer (current-buffer)))))))))
14212 t) ;; return t to indicate that we took care of this note.
14214 (defun org-get-org-file ()
14215 "Read a filename, with default directory `org-directory'."
14216 (let ((default (or org-default-notes-file remember-data-file)))
14217 (read-file-name (format "File name [%s]: " default)
14218 (file-name-as-directory org-directory)
14219 default)))
14221 (defun org-notes-order-reversed-p ()
14222 "Check if the current file should receive notes in reversed order."
14223 (cond
14224 ((not org-reverse-note-order) nil)
14225 ((eq t org-reverse-note-order) t)
14226 ((not (listp org-reverse-note-order)) nil)
14227 (t (catch 'exit
14228 (let ((all org-reverse-note-order)
14229 entry)
14230 (while (setq entry (pop all))
14231 (if (string-match (car entry) buffer-file-name)
14232 (throw 'exit (cdr entry))))
14233 nil)))))
14235 ;;; Refiling
14237 (defvar org-refile-target-table nil
14238 "The list of refile targets, created by `org-refile'.")
14240 (defvar org-agenda-new-buffers nil
14241 "Buffers created to visit agenda files.")
14243 (defun org-get-refile-targets (&optional default-buffer)
14244 "Produce a table with refile targets."
14245 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
14246 targets txt re files f desc descre)
14247 (with-current-buffer (or default-buffer (current-buffer))
14248 (while (setq entry (pop entries))
14249 (setq files (car entry) desc (cdr entry))
14250 (cond
14251 ((null files) (setq files (list (current-buffer))))
14252 ((eq files 'org-agenda-files)
14253 (setq files (org-agenda-files 'unrestricted)))
14254 ((and (symbolp files) (fboundp files))
14255 (setq files (funcall files)))
14256 ((and (symbolp files) (boundp files))
14257 (setq files (symbol-value files))))
14258 (if (stringp files) (setq files (list files)))
14259 (cond
14260 ((eq (car desc) :tag)
14262 ((eq (car desc) :todo)
14264 ((eq (car desc) :regexp)
14265 (setq descre (cdr desc)))
14266 ((eq (car desc) :level)
14268 (if org-odd-levels-only
14269 (1- (* 2 (cdr desc)))
14270 (cdr desc)))
14272 ((eq (car desc) :maxlevel)
14274 (if org-odd-levels-only
14275 (1- (* 2 (cdr desc)))
14276 (cdr desc)))
14278 (t (error "Bad refiling target description %s" desc)))
14279 (while (setq f (pop files))
14280 (save-excursion
14281 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14282 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14283 (save-excursion
14284 (save-restriction
14285 (widen)
14286 (goto-char (point-min))
14287 (while (re-search-forward descre nil t)
14288 (goto-char (point-at-bol))
14289 (when (looking-at org-complex-heading-regexp)
14290 (setq txt (match-string 4)
14291 re (concat "^" (regexp-quote
14292 (buffer-substring (match-beginning 1)
14293 (match-end 4)))))
14295 (regexp-quote
14296 (match-string 5)))))
14298 (when org-refile-use-outline-path
14299 (setq txt (mapconcat 'identity
14300 (append
14301 (if (eq org-refile-use-outline-path 'file)
14302 (list (file-name-nondirectory
14303 (buffer-file-name (buffer-base-buffer))))
14304 (if (eq org-refile-use-outline-path 'full-file-path)
14305 (list (buffer-file-name (buffer-base-buffer)))))
14306 (org-get-outline-path)
14307 (list txt))
14308 "/")))
14309 (push (list txt f re (point)) targets))
14310 (goto-char (point-at-eol))))))))
14311 (nreverse targets))))
14313 (defun org-get-outline-path ()
14314 "Return the outline path to the current entry, as a list."
14315 (let (rtn)
14316 (save-excursion
14317 (while (org-up-heading-safe)
14318 (when (looking-at org-complex-heading-regexp)
14319 (push (org-match-string-no-properties 4) rtn)))
14320 rtn)))
14322 (defvar org-refile-history nil
14323 "History for refiling operations.")
14325 (defun org-refile (&optional goto default-buffer)
14326 "Move the entry at point to another heading.
14327 The list of target headings is compiled using the information in
14328 `org-refile-targets', which see. This list is created upon first use, and
14329 you can update it by calling this command with a double prefix (`C-u C-u').
14330 FIXME: Can we find a better way of updating?
14332 At the target location, the entry is filed as a subitem of the target heading.
14333 Depending on `org-reverse-note-order', the new subitem will either be the
14334 first of the last subitem.
14336 With prefix arg GOTO, the command will only visit the target location,
14337 not actually move anything.
14338 With a double prefix `C-c C-c', go to the location where the last refiling
14339 operation has put the subtree.
14341 With a double prefix argument, the command can be used to jump to any
14342 heading in the current buffer."
14343 (interactive "P")
14344 (let* ((cbuf (current-buffer))
14345 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14346 pos it nbuf file re level reversed)
14347 (if (equal goto '(16))
14348 (org-refile-goto-last-stored)
14349 (when (setq it (org-refile-get-location
14350 (if goto "Goto: " "Refile to: ") default-buffer))
14351 (setq file (nth 1 it)
14352 re (nth 2 it)
14353 pos (nth 3 it))
14354 (setq nbuf (or (find-buffer-visiting file)
14355 (find-file-noselect file)))
14356 (if goto
14357 (progn
14358 (switch-to-buffer nbuf)
14359 (goto-char pos)
14360 (org-show-context 'org-goto))
14361 (org-copy-special)
14362 (save-excursion
14363 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14364 (find-file-noselect file))))
14365 (setq reversed (org-notes-order-reversed-p))
14366 (save-excursion
14367 (save-restriction
14368 (widen)
14369 (goto-char pos)
14370 (looking-at outline-regexp)
14371 (setq level (org-get-legal-level (funcall outline-level) 1))
14372 (goto-char
14373 (if reversed
14374 (outline-next-heading)
14375 (or (save-excursion (outline-get-next-sibling))
14376 (org-end-of-subtree t t)
14377 (point-max))))
14378 (bookmark-set "org-refile-last-stored")
14379 (org-paste-subtree level))))
14380 (org-cut-special)
14383 (defun org-refile-goto-last-stored ()
14384 "Go to the location where the last refile was stored."
14385 (interactive)
14386 (bookmark-jump "org-refile-last-stored")
14387 (message "This is the location of the last refile"))
14389 (defun org-refile-get-location (&optional prompt default-buffer)
14390 "Prompt the user for a refile location, using PROMPT."
14391 (let ((org-refile-targets org-refile-targets)
14392 (org-refile-use-outline-path org-refile-use-outline-path))
14393 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14394 (unless org-refile-target-table
14395 (error "No refile targets"))
14396 (let* ((cbuf (current-buffer))
14397 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14398 (fname (and filename (file-truename filename)))
14399 (tbl (mapcar
14400 (lambda (x)
14401 (if (not (equal fname (file-truename (nth 1 x))))
14402 (cons (concat (car x) " (" (file-name-nondirectory
14403 (nth 1 x)) ")")
14404 (cdr x))
14405 x))
14406 org-refile-target-table))
14407 (completion-ignore-case t))
14408 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14409 tbl)))
14411 ;;;; Dynamic blocks
14413 (defun org-find-dblock (name)
14414 "Find the first dynamic block with name NAME in the buffer.
14415 If not found, stay at current position and return nil."
14416 (let (pos)
14417 (save-excursion
14418 (goto-char (point-min))
14420 nil t)
14421 (match-beginning 0))))
14422 (if pos (goto-char pos))
14423 pos))
14425 (defconst org-dblock-start-re
14427 "Matches the startline of a dynamic block, with parameters.")
14430 "Matches the end of a dyhamic block.")
14432 (defun org-create-dblock (plist)
14433 "Create a dynamic block section, with parameters taken from PLIST.
14434 PLIST must containe a :name entry which is used as name of the block."
14435 (unless (bolp) (newline))
14436 (let ((name (plist-get plist :name)))
14437 (insert "#+BEGIN: " name)
14438 (while plist
14439 (if (eq (car plist) :name)
14440 (setq plist (cddr plist))
14441 (insert " " (prin1-to-string (pop plist)))))
14443 (beginning-of-line -2)))
14445 (defun org-prepare-dblock ()
14446 "Prepare dynamic block for refresh.
14447 This empties the block, puts the cursor at the insert position and returns
14448 the property list including an extra property :name with the block name."
14449 (unless (looking-at org-dblock-start-re)
14450 (error "Not at a dynamic block"))
14451 (let* ((begdel (1+ (match-end 0)))
14452 (name (org-no-properties (match-string 1)))
14453 (params (append (list :name name)
14454 (read (concat "(" (match-string 3) ")")))))
14455 (unless (re-search-forward org-dblock-end-re nil t)
14456 (error "Dynamic block not terminated"))
14457 (delete-region begdel (match-beginning 0))
14458 (goto-char begdel)
14459 (open-line 1)
14460 params))
14462 (defun org-map-dblocks (&optional command)
14463 "Apply COMMAND to all dynamic blocks in the current buffer.
14464 If COMMAND is not given, use `org-update-dblock'."
14465 (let ((cmd (or command 'org-update-dblock))
14466 pos)
14467 (save-excursion
14468 (goto-char (point-min))
14469 (while (re-search-forward org-dblock-start-re nil t)
14470 (goto-char (setq pos (match-beginning 0)))
14471 (condition-case nil
14472 (funcall cmd)
14473 (error (message "Error during update of dynamic block")))
14474 (goto-char pos)
14475 (unless (re-search-forward org-dblock-end-re nil t)
14476 (error "Dynamic block not terminated"))))))
14478 (defun org-dblock-update (&optional arg)
14479 "User command for updating dynamic blocks.
14480 Update the dynamic block at point. With prefix ARG, update all dynamic
14481 blocks in the buffer."
14482 (interactive "P")
14483 (if arg
14484 (org-update-all-dblocks)
14485 (or (looking-at org-dblock-start-re)
14486 (org-beginning-of-dblock))
14487 (org-update-dblock)))
14489 (defun org-update-dblock ()
14490 "Update the dynamic block at point
14491 This means to empty the block, parse for parameters and then call
14492 the correct writing function."
14493 (save-window-excursion
14494 (let* ((pos (point))
14495 (line (org-current-line))
14496 (params (org-prepare-dblock))
14497 (name (plist-get params :name))
14498 (cmd (intern (concat "org-dblock-write:" name))))
14499 (message "Updating dynamic block `%s' at line %d..." name line)
14500 (funcall cmd params)
14501 (message "Updating dynamic block `%s' at line %d...done" name line)
14502 (goto-char pos))))
14504 (defun org-beginning-of-dblock ()
14505 "Find the beginning of the dynamic block at point.
14506 Error if there is no scuh block at point."
14507 (let ((pos (point))
14508 beg)
14509 (end-of-line 1)
14510 (if (and (re-search-backward org-dblock-start-re nil t)
14511 (setq beg (match-beginning 0))
14512 (re-search-forward org-dblock-end-re nil t)
14513 (> (match-end 0) pos))
14514 (goto-char beg)
14515 (goto-char pos)
14516 (error "Not in a dynamic block"))))
14518 (defun org-update-all-dblocks ()
14519 "Update all dynamic blocks in the buffer.
14520 This function can be used in a hook."
14521 (when (org-mode-p)
14522 (org-map-dblocks 'org-update-dblock)))
14525 ;;;; Completion
14527 (defconst org-additional-option-like-keywords
14528 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14529 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14530 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14532 (defun org-complete (&optional arg)
14533 "Perform completion on word at point.
14534 At the beginning of a headline, this completes TODO keywords as given in
14535 `org-todo-keywords'.
14536 If the current word is preceded by a backslash, completes the TeX symbols
14537 that are supported for HTML support.
14539 setting file options.
14541 At all other locations, this simply calls the value of
14542 `org-completion-fallback-command'."
14543 (interactive "P")
14544 (org-without-partial-completion
14545 (catch 'exit
14546 (let* ((end (point))
14547 (beg1 (save-excursion
14548 (skip-chars-backward (org-re "[:alnum:]_@"))
14549 (point)))
14550 (beg (save-excursion
14551 (skip-chars-backward "a-zA-Z0-9_:$")
14552 (point)))
14553 (confirm (lambda (x) (stringp (car x))))
14554 (searchhead (equal (char-before beg) ?*))
14555 (tag (and (equal (char-before beg1) ?:)
14556 (equal (char-after (point-at-bol)) ?*)))
14557 (prop (and (equal (char-before beg1) ?:)
14558 (not (equal (char-after (point-at-bol)) ?*))))
14560 (link (equal (char-before beg) ?\[))
14561 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14562 beg)
14563 "#+"))
14565 (buffer-substring (point-at-bol) (point))))
14566 (completion-ignore-case opt)
14567 (type nil)
14568 (tbl nil)
14569 (table (cond
14570 (opt
14571 (setq type :opt)
14572 (append
14573 (mapcar
14574 (lambda (x)
14576 (cons (match-string 2 x) (match-string 1 x)))
14578 (mapcar 'list org-additional-option-like-keywords)))
14579 (startup
14580 (setq type :startup)
14581 org-startup-options)
14582 (link (append org-link-abbrev-alist-local
14583 org-link-abbrev-alist))
14584 (texp
14585 (setq type :tex)
14586 org-html-entities)
14588 (buffer-substring (point-at-bol) beg))
14589 (setq type :todo)
14590 (mapcar 'list org-todo-keywords-1))
14591 (searchhead
14592 (setq type :searchhead)
14593 (save-excursion
14594 (goto-char (point-min))
14595 (while (re-search-forward org-todo-line-regexp nil t)
14596 (push (list
14597 (org-make-org-heading-search-string
14598 (match-string 3) t))
14599 tbl)))
14600 tbl)
14601 (tag (setq type :tag beg beg1)
14602 (or org-tag-alist (org-get-buffer-tags)))
14603 (prop (setq type :prop beg beg1)
14604 (mapcar 'list (org-buffer-property-keys nil t t)))
14605 (t (progn
14606 (call-interactively org-completion-fallback-command)
14607 (throw 'exit nil)))))
14608 (pattern (buffer-substring-no-properties beg end))
14609 (completion (try-completion pattern table confirm)))
14610 (cond ((eq completion t)
14611 (if (not (assoc (upcase pattern) table))
14612 (message "Already complete")
14613 (if (equal type :opt)
14614 (insert (substring (cdr (assoc (upcase pattern) table))
14615 (length pattern)))
14616 (if (memq type '(:tag :prop)) (insert ":")))))
14617 ((null completion)
14619 (ding))
14620 ((not (string= pattern completion))
14621 (delete-region beg end)
14622 (if (string-match " +$" completion)
14623 (setq completion (replace-match "" t t completion)))
14624 (insert completion)
14625 (if (get-buffer-window "*Completions*")
14626 (delete-window (get-buffer-window "*Completions*")))
14627 (if (assoc completion table)
14628 (if (eq type :todo) (insert " ")
14629 (if (memq type '(:tag :prop)) (insert ":"))))
14630 (if (and (equal type :opt) (assoc completion table))
14631 (message "%s" (substitute-command-keys
14633 (t
14634 (message "Making completion list...")
14635 (let ((list (sort (all-completions pattern table confirm)
14636 'string<)))
14637 (with-output-to-temp-buffer "*Completions*"
14638 (condition-case nil
14639 ;; Protection needed for XEmacs and emacs 21
14640 (display-completion-list list pattern)
14641 (error (display-completion-list list)))))
14642 (message "Making completion list...%s" "done")))))))
14644 ;;;; TODO, DEADLINE, Comments
14646 (defun org-toggle-comment ()
14647 "Change the COMMENT state of an entry."
14648 (interactive)
14649 (save-excursion
14650 (org-back-to-heading)
14651 (let (case-fold-search)
14652 (if (looking-at (concat outline-regexp
14654 (replace-match "" t t nil 1)
14655 (if (looking-at outline-regexp)
14656 (progn
14657 (goto-char (match-end 0))
14658 (insert org-comment-string " ")))))))
14660 (defvar org-last-todo-state-is-todo nil
14661 "This is non-nil when the last TODO state change led to a TODO state.
14662 If the last change removed the TODO tag or switched to DONE, then
14663 this is nil.")
14665 (defvar org-setting-tags nil) ; dynamically skiped
14667 ;; FIXME: better place
14668 (defun org-property-or-variable-value (var &optional inherit)
14669 "Check if there is a property fixing the value of VAR.
14670 If yes, return this value. If not, return the current value of the variable."
14671 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14673 (read prop)
14674 (symbol-value var))))
14676 (defun org-parse-local-options (string var)
14677 "Parse STRING for startup setting relevant for variable VAR."
14678 (let ((rtn (symbol-value var))
14679 e opts)
14680 (save-match-data
14682 rtn
14683 (setq opts (delq nil (mapcar (lambda (x)
14684 (setq e (assoc x org-startup-options))
14685 (if (eq (nth 1 e) var) e nil))
14687 (if (not opts)
14688 rtn
14689 (setq rtn nil)
14690 (while (setq e (pop opts))
14691 (if (not (nth 3 e))
14692 (setq rtn (nth 2 e))
14693 (if (not (listp rtn)) (setq rtn nil))
14694 (push (nth 2 e) rtn)))
14695 rtn)))))
14697 (defvar org-blocker-hook nil
14698 "Hook for functions that are allowed to block a state change.
14700 Each function gets as its single argument a property list, see
14701 `org-trigger-hook' for more information about this list.
14703 If any of the functions in this hook returns nil, the state change
14704 is blocked.")
14706 (defvar org-trigger-hook nil
14707 "Hook for functions that are triggered by a state change.
14709 Each function gets as its single argument a property list with at least
14710 the following elements:
14712 (:type type-of-change :position pos-at-entry-start
14713 :from old-state :to new-state)
14715 Depending on the type, more properties may be present.
14717 This mechanism is currently implemented for:
14719 TODO state changes
14720 ------------------
14721 :type todo-state-change
14722 :from previous state (keyword as a string), or nil
14723 :to new state (keyword as a string), or nil")
14726 (defun org-todo (&optional arg)
14727 "Change the TODO state of an item.
14728 The state of an item is given by a keyword at the start of the heading,
14729 like
14730 *** TODO Write paper
14731 *** DONE Call mom
14733 The different keywords are specified in the variable `org-todo-keywords'.
14735 So for this example: when the item starts with TODO, it is changed to DONE.
14736 When it starts with DONE, the DONE is removed. And when neither TODO nor
14737 DONE are present, add TODO at the beginning of the heading.
14739 With C-u prefix arg, use completion to determine the new state.
14740 With numeric prefix arg, switch to that state.
14742 For calling through lisp, arg is also interpreted in the following way:
14743 'none -> empty state
14745 'done -> switch to DONE
14746 'nextset -> switch to the next set of keywords
14747 'previousset -> switch to the previous set of keywords
14749 really is a member of `org-todo-keywords'."
14750 (interactive "P")
14751 (save-excursion
14752 (catch 'exit
14753 (org-back-to-heading)
14754 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14755 (or (looking-at (concat " +" org-todo-regexp " *"))
14756 (looking-at " *"))
14757 (let* ((match-data (match-data))
14758 (startpos (point-at-bol))
14759 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14760 (org-log-done org-log-done)
14761 (org-log-repeat org-log-repeat)
14762 (org-todo-log-states org-todo-log-states)
14763 (this (match-string 1))
14764 (hl-pos (match-beginning 0))
14765 (head (org-get-todo-sequence-head this))
14766 (ass (assoc head org-todo-kwd-alist))
14767 (interpret (nth 1 ass))
14768 (done-word (nth 3 ass))
14769 (final-done-word (nth 4 ass))
14770 (last-state (or this ""))
14771 (completion-ignore-case t)
14772 (member (member this org-todo-keywords-1))
14773 (tail (cdr member))
14774 (state (cond
14775 ((and org-todo-key-trigger
14776 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14777 (and (not arg) org-use-fast-todo-selection
14778 (not (eq org-use-fast-todo-selection 'prefix)))))
14779 ;; Use fast selection
14780 (org-fast-todo-selection))
14781 ((and (equal arg '(4))
14782 (or (not org-use-fast-todo-selection)
14783 (not org-todo-key-trigger)))
14784 ;; Read a state with completion
14785 (completing-read "State: " (mapcar (lambda(x) (list x))
14786 org-todo-keywords-1)
14787 nil t))
14788 ((eq arg 'right)
14789 (if this
14790 (if tail (car tail) nil)
14791 (car org-todo-keywords-1)))
14792 ((eq arg 'left)
14793 (if (equal member org-todo-keywords-1)
14794 nil
14795 (if this
14796 (nth (- (length org-todo-keywords-1) (length tail) 2)
14797 org-todo-keywords-1)
14798 (org-last org-todo-keywords-1))))
14799 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14800 (setq arg nil))) ; hack to fall back to cycling
14801 (arg
14802 ;; user or caller requests a specific state
14803 (cond
14804 ((equal arg "") nil)
14805 ((eq arg 'none) nil)
14806 ((eq arg 'done) (or done-word (car org-done-keywords)))
14807 ((eq arg 'nextset)
14808 (or (car (cdr (member head org-todo-heads)))
14809 (car org-todo-heads)))
14810 ((eq arg 'previousset)
14811 (let ((org-todo-heads (reverse org-todo-heads)))
14812 (or (car (cdr (member head org-todo-heads)))
14813 (car org-todo-heads))))
14814 ((car (member arg org-todo-keywords-1)))
14815 ((nth (1- (prefix-numeric-value arg))
14816 org-todo-keywords-1))))
14817 ((null member) (or head (car org-todo-keywords-1)))
14818 ((equal this final-done-word) nil) ;; -> make empty
14819 ((null tail) nil) ;; -> first entry
14820 ((eq interpret 'sequence)
14821 (car tail))
14822 ((memq interpret '(type priority))
14823 (if (eq this-command last-command)
14824 (car tail)
14825 (if (> (length tail) 0)
14826 (or done-word (car org-done-keywords))
14827 nil)))
14828 (t nil)))
14829 (next (if state (concat " " state " ") " "))
14830 (change-plist (list :type 'todo-state-change :from this :to state
14831 :position startpos))
14832 dolog now-done-p)
14833 (when org-blocker-hook
14834 (unless (save-excursion
14835 (save-match-data
14836 (run-hook-with-args-until-failure
14837 'org-blocker-hook change-plist)))
14838 (if (interactive-p)
14839 (error "TODO state change from %s to %s blocked" this state)
14840 ;; fail silently
14841 (message "TODO state change from %s to %s blocked" this state)
14842 (throw 'exit nil))))
14843 (store-match-data match-data)
14844 (replace-match next t t)
14845 (unless (pos-visible-in-window-p hl-pos)
14846 (message "TODO state changed to %s" (org-trim next)))
14847 (unless head
14848 (setq head (org-get-todo-sequence-head state)
14849 ass (assoc head org-todo-kwd-alist)
14850 interpret (nth 1 ass)
14851 done-word (nth 3 ass)
14852 final-done-word (nth 4 ass)))
14853 (when (memq arg '(nextset previousset))
14854 (message "Keyword-Set %d/%d: %s"
14855 (- (length org-todo-sets) -1
14856 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14857 (length org-todo-sets)
14858 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14859 (setq org-last-todo-state-is-todo
14860 (not (member state org-done-keywords)))
14861 (setq now-done-p (and (member state org-done-keywords)
14862 (not (member this org-done-keywords))))
14863 (and logging (org-local-logging logging))
14864 (when (and (or org-todo-log-states org-log-done)
14865 (not (memq arg '(nextset previousset))))
14866 ;; we need to look at recording a time and note
14867 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14868 (nth 2 (assoc this org-todo-log-states))))
14869 (when (and state
14870 (member state org-not-done-keywords)
14871 (not (member this org-not-done-keywords)))
14872 ;; This is now a todo state and was not one before
14873 ;; If there was a CLOSED time stamp, get rid of it.
14874 (org-add-planning-info nil nil 'closed))
14875 (when (and now-done-p org-log-done)
14876 ;; It is now done, and it was not done before
14877 (org-add-planning-info 'closed (org-current-time))
14878 (if (and (not dolog) (eq 'note org-log-done))
14879 (org-add-log-maybe 'done state 'findpos 'note)))
14880 (when (and state dolog)
14881 ;; This is a non-nil state, and we need to log it
14882 (org-add-log-maybe 'state state 'findpos dolog)))
14883 ;; Fixup tag positioning
14884 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14885 (run-hooks 'org-after-todo-state-change-hook)
14886 (if (and arg (not (member state org-done-keywords)))
14887 (setq head (org-get-todo-sequence-head state)))
14888 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14889 ;; Do we need to trigger a repeat?
14890 (when now-done-p (org-auto-repeat-maybe state))
14891 ;; Fixup cursor location if close to the keyword
14892 (if (and (outline-on-heading-p)
14893 (not (bolp))
14894 (save-excursion (beginning-of-line 1)
14895 (looking-at org-todo-line-regexp))
14896 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14897 (progn
14898 (goto-char (or (match-end 2) (match-end 1)))
14899 (just-one-space)))
14900 (when org-trigger-hook
14901 (save-excursion
14902 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14904 (defun org-local-logging (value)
14905 "Get logging settings from a property VALUE."
14906 (let* (words w a)
14907 ;; directly set the variables, they are already local.
14908 (setq org-log-done nil
14909 org-log-repeat nil
14910 org-todo-log-states nil)
14911 (setq words (org-split-string value))
14912 (while (setq w (pop words))
14913 (cond
14914 ((setq a (assoc w org-startup-options))
14915 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14916 (set (nth 1 a) (nth 2 a))))
14917 ((setq a (org-extract-log-state-settings w))
14918 (and (member (car a) org-todo-keywords-1)
14919 (push a org-todo-log-states)))))))
14921 (defun org-get-todo-sequence-head (kwd)
14922 "Return the head of the TODO sequence to which KWD belongs.
14923 If KWD is not set, check if there is a text property remembering the
14924 right sequence."
14925 (let (p)
14926 (cond
14927 ((not kwd)
14928 (or (get-text-property (point-at-bol) 'org-todo-head)
14929 (progn
14930 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14931 nil (point-at-eol)))
14932 (get-text-property p 'org-todo-head))))
14933 ((not (member kwd org-todo-keywords-1))
14934 (car org-todo-keywords-1))
14935 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14937 (defun org-fast-todo-selection ()
14938 "Fast TODO keyword selection with single keys.
14939 Returns the new TODO keyword, or nil if no state change should occur."
14940 (let* ((fulltable org-todo-key-alist)
14941 (done-keywords org-done-keywords) ;; needed for the faces.
14942 (maxlen (apply 'max (mapcar
14943 (lambda (x)
14944 (if (stringp (car x)) (string-width (car x)) 0))
14945 fulltable)))
14946 (expert nil)
14947 (fwidth (+ maxlen 3 1 3))
14948 (ncol (/ (- (window-width) 4) fwidth))
14949 tg cnt e c tbl
14950 groups ingroup)
14951 (save-window-excursion
14952 (if expert
14953 (set-buffer (get-buffer-create " *Org todo*"))
14954 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14955 (erase-buffer)
14956 (org-set-local 'org-done-keywords done-keywords)
14957 (setq tbl fulltable cnt 0)
14958 (while (setq e (pop tbl))
14959 (cond
14960 ((equal e '(:startgroup))
14961 (push '() groups) (setq ingroup t)
14962 (when (not (= cnt 0))
14963 (setq cnt 0)
14965 (insert "{ "))
14966 ((equal e '(:endgroup))
14967 (setq ingroup nil cnt 0)
14969 (t
14970 (setq tg (car e) c (cdr e))
14971 (if ingroup (push tg (car groups)))
14972 (setq tg (org-add-props tg nil 'face
14973 (org-get-todo-face tg)))
14974 (if (and (= cnt 0) (not ingroup)) (insert " "))
14975 (insert "[" c "] " tg (make-string
14976 (- fwidth 4 (length tg)) ?\ ))
14977 (when (= (setq cnt (1+ cnt)) ncol)
14979 (if ingroup (insert " "))
14980 (setq cnt 0)))))
14982 (goto-char (point-min))
14983 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14984 (fit-window-to-buffer))
14985 (message "[a-z..]:Set [SPC]:clear")
14986 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14987 (cond
14988 ((or (= c ?\C-g)
14989 (and (= c ?q) (not (rassoc c fulltable))))
14990 (setq quit-flag t))
14991 ((= c ?\ ) nil)
14992 ((setq e (rassoc c fulltable) tg (car e))
14993 tg)
14994 (t (setq quit-flag t))))))
14996 (defun org-get-repeat ()
14997 "Check if tere is a deadline/schedule with repeater in this entry."
14998 (save-match-data
14999 (save-excursion
15000 (org-back-to-heading t)
15001 (if (re-search-forward
15002 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
15003 (match-string 1)))))
15005 (defvar org-last-changed-timestamp)
15006 (defvar org-log-post-message)
15007 (defvar org-log-note-purpose)
15008 (defun org-auto-repeat-maybe (done-word)
15009 "Check if the current headline contains a repeated deadline/schedule.
15010 If yes, set TODO state back to what it was and change the base date
15011 of repeating deadline/scheduled time stamps to new date.
15012 This function is run automatically after each state change to a DONE state."
15013 ;; last-state is dynamically scoped into this function
15014 (let* ((repeat (org-get-repeat))
15015 (aa (assoc last-state org-todo-kwd-alist))
15016 (interpret (nth 1 aa))
15017 (head (nth 2 aa))
15018 (whata '(("d" . day) ("m" . month) ("y" . year)))
15019 (msg "Entry repeats: ")
15020 (org-log-done nil)
15021 (org-todo-log-states nil)
15022 re type n what ts)
15023 (when repeat
15024 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
15025 (org-todo (if (eq interpret 'type) last-state head))
15026 (when (and org-log-repeat
15027 (or (not (memq 'org-add-log-note
15028 (default-value 'post-command-hook)))
15029 (eq org-log-note-purpose 'done)))
15030 ;; Make sure a note is taken;
15031 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
15032 'findpos org-log-repeat))
15033 (org-back-to-heading t)
15034 (org-add-planning-info nil nil 'closed)
15038 (while (re-search-forward
15039 re (save-excursion (outline-next-heading) (point)) t)
15040 (setq type (if (match-end 1) org-scheduled-string
15041 (if (match-end 3) org-deadline-string "Plain:"))
15042 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
15044 (setq n (string-to-number (match-string 1 ts))
15045 what (match-string 2 ts))
15046 (if (equal what "w") (setq n (* n 7) what "d"))
15047 (org-timestamp-change n (cdr (assoc what whata)))
15048 (setq msg (concat msg type org-last-changed-timestamp " "))))
15049 (setq org-log-post-message msg)
15050 (message "%s" msg))))
15052 (defun org-show-todo-tree (arg)
15053 "Make a compact tree which shows all headlines marked with TODO.
15054 The tree will show the lines where the regexp matches, and all higher
15055 headlines above the match.
15057 With a numeric prefix N, construct a sparse tree for the Nth element
15058 of `org-todo-keywords-1'."
15059 (interactive "P")
15060 (let ((case-fold-search nil)
15061 (kwd-re
15062 (cond ((null arg) org-not-done-regexp)
15063 ((equal arg '(4))
15064 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
15065 (mapcar 'list org-todo-keywords-1))))
15069 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
15070 (regexp-quote (nth (1- (prefix-numeric-value arg))
15071 org-todo-keywords-1)))
15072 (t (error "Invalid prefix argument: %s" arg)))))
15073 (message "%d TODO entries found"
15074 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
15076 (defun org-deadline (&optional remove)
15078 With argument REMOVE, remove any deadline from the item."
15079 (interactive "P")
15080 (if remove
15081 (progn
15082 (org-remove-timestamp-with-keyword org-deadline-string)
15083 (message "Item no longer has a deadline."))
15084 (org-add-planning-info 'deadline nil 'closed)))
15086 (defun org-schedule (&optional remove)
15087 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
15088 With argument REMOVE, remove any scheduling date from the item."
15089 (interactive "P")
15090 (if remove
15091 (progn
15092 (org-remove-timestamp-with-keyword org-scheduled-string)
15093 (message "Item is no longer scheduled."))
15094 (org-add-planning-info 'scheduled nil 'closed)))
15096 (defun org-remove-timestamp-with-keyword (keyword)
15097 "Remove all time stamps with KEYWORD in the current entry."
15099 beg)
15100 (save-excursion
15101 (org-back-to-heading t)
15102 (setq beg (point))
15103 (org-end-of-subtree t t)
15104 (while (re-search-backward re beg t)
15105 (replace-match "")
15107 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
15109 (defun org-add-planning-info (what &optional time &rest remove)
15110 "Insert new timestamp with keyword in the line directly after the headline.
15111 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
15112 If non is given, the user is prompted for a date.
15113 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
15114 be removed."
15115 (interactive)
15116 (let (org-time-was-given org-end-time-was-given)
15117 (when what (setq time (or time (org-read-date nil 'to-time))))
15118 (when (and org-insert-labeled-timestamps-at-point
15119 (member what '(scheduled deadline)))
15120 (insert
15121 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
15122 (org-insert-time-stamp time org-time-was-given
15123 nil nil nil (list org-end-time-was-given))
15124 (setq what nil))
15125 (save-excursion
15126 (save-restriction
15127 (let (col list elt ts buffer-invisibility-spec)
15128 (org-back-to-heading t)
15130 (goto-char (match-end 1))
15131 (setq col (current-column))
15132 (goto-char (match-end 0))
15134 (if (and (not (looking-at outline-regexp))
15137 (not (equal (match-string 1) org-clock-string)))
15138 (narrow-to-region (match-beginning 0) (match-end 0))
15140 (backward-char 1)
15141 (narrow-to-region (point) (point))
15142 (indent-to-column col))
15143 ;; Check if we have to remove something.
15144 (setq list (cons what remove))
15145 (while list
15146 (setq elt (pop list))
15147 (goto-char (point-min))
15148 (when (or (and (eq elt 'scheduled)
15149 (re-search-forward org-scheduled-time-regexp nil t))
15150 (and (eq elt 'deadline)
15151 (re-search-forward org-deadline-time-regexp nil t))
15152 (and (eq elt 'closed)
15153 (re-search-forward org-closed-time-regexp nil t)))
15154 (replace-match "")
15155 (if (looking-at "--+<[^>]+>") (replace-match ""))
15156 (if (looking-at " +") (replace-match ""))))
15157 (goto-char (point-max))
15158 (when what
15159 (insert
15160 (if (not (equal (char-before) ?\ )) " " "")
15161 (cond ((eq what 'scheduled) org-scheduled-string)
15162 ((eq what 'deadline) org-deadline-string)
15163 ((eq what 'closed) org-closed-string))
15164 " ")
15165 (setq ts (org-insert-time-stamp
15166 time
15167 (or org-time-was-given
15168 (and (eq what 'closed) org-log-done-with-time))
15169 (eq what 'closed)
15170 nil nil (list org-end-time-was-given)))
15171 (end-of-line 1))
15172 (goto-char (point-min))
15173 (widen)
15175 (replace-match ""))
15176 ts)))))
15178 (defvar org-log-note-marker (make-marker))
15179 (defvar org-log-note-purpose nil)
15180 (defvar org-log-note-state nil)
15181 (defvar org-log-note-how nil)
15182 (defvar org-log-note-window-configuration nil)
15183 (defvar org-log-note-return-to (make-marker))
15184 (defvar org-log-post-message nil
15185 "Message to be displayed after a log note has been stored.
15186 The auto-repeater uses this.")
15188 (defun org-add-log-maybe (&optional purpose state findpos how)
15189 "Set up the post command hook to take a note.
15190 If this is about to TODO state change, the new state is expected in STATE.
15191 When FINDPOS is non-nil, find the correct position for the note in
15192 the current entry. If not, assume that it can be inserted at point."
15193 (save-excursion
15194 (when findpos
15195 (org-back-to-heading t)
15199 (goto-char (match-end 0))
15200 (unless org-log-states-order-reversed
15202 (org-skip-over-state-notes)
15204 (move-marker org-log-note-marker (point))
15205 (setq org-log-note-purpose purpose
15206 org-log-note-state state
15207 org-log-note-how how)
15208 (add-hook 'post-command-hook 'org-add-log-note 'append)))
15210 (defun org-skip-over-state-notes ()
15211 "Skip past the list of State notes in an entry."
15214 (condition-case nil
15215 (org-next-item)
15216 (error (org-end-of-item)))))
15218 (defun org-add-log-note (&optional purpose)
15219 "Pop up a window for taking a note, and add this note later at point."
15220 (remove-hook 'post-command-hook 'org-add-log-note)
15221 (setq org-log-note-window-configuration (current-window-configuration))
15222 (delete-other-windows)
15223 (move-marker org-log-note-return-to (point))
15224 (switch-to-buffer (marker-buffer org-log-note-marker))
15225 (goto-char org-log-note-marker)
15226 (org-switch-to-buffer-other-window "*Org Note*")
15227 (erase-buffer)
15228 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
15229 (org-store-log-note)
15230 (let ((org-inhibit-startup t)) (org-mode))
15231 (insert (format "# Insert note for %s.
15233 (cond
15234 ((eq org-log-note-purpose 'clock-out) "stopped clock")
15235 ((eq org-log-note-purpose 'done) "closed todo item")
15236 ((eq org-log-note-purpose 'state)
15238 (t (error "This should not happen")))))
15239 (org-set-local 'org-finish-function 'org-store-log-note)))
15241 (defun org-store-log-note ()
15242 "Finish taking a log note, and insert it to where it belongs."
15243 (let ((txt (buffer-string))
15244 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
15245 lines ind)
15246 (kill-buffer (current-buffer))
15248 (setq txt (replace-match "" t t txt)))
15250 (setq txt (replace-match "" t t txt)))
15253 (setq note
15254 (org-replace-escapes
15255 note
15256 (list (cons "%u" (user-login-name))
15257 (cons "%U" user-full-name)
15258 (cons "%t" (format-time-string
15259 (org-time-stamp-format 'long 'inactive)
15260 (current-time)))
15261 (cons "%s" (if org-log-note-state
15263 "")))))
15265 (push note lines))
15266 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15267 (when lines
15268 (save-excursion
15269 (set-buffer (marker-buffer org-log-note-marker))
15270 (save-excursion
15271 (goto-char org-log-note-marker)
15272 (move-marker org-log-note-marker nil)
15273 (end-of-line 1)
15275 (indent-relative nil)
15276 (insert "- " (pop lines))
15277 (org-indent-line-function)
15278 (beginning-of-line 1)
15280 (setq ind (concat (match-string 0) " "))
15281 (end-of-line 1)
15283 (set-window-configuration org-log-note-window-configuration)
15284 (with-current-buffer (marker-buffer org-log-note-return-to)
15285 (goto-char org-log-note-return-to))
15286 (move-marker org-log-note-return-to nil)
15287 (and org-log-post-message (message "%s" org-log-post-message)))
15289 ;; FIXME: what else would be useful?
15290 ;; - priority
15291 ;; - date
15293 (defun org-sparse-tree (&optional arg)
15294 "Create a sparse tree, prompt for the details.
15295 This command can create sparse trees. You first need to select the type
15296 of match used to create the tree:
15298 t Show entries with a specific TODO keyword.
15299 T Show entries selected by a tags match.
15300 p Enter a property name and its value (both with completion on existing
15301 names/values) and show entries with that property.
15302 r Show entries matching a regular expression
15303 d Show deadlines due within `org-deadline-warning-days'."
15304 (interactive "P")
15305 (let (ans kwd value)
15306 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15307 (setq ans (read-char-exclusive))
15308 (cond
15309 ((equal ans ?d)
15310 (call-interactively 'org-check-deadlines))
15311 ((equal ans ?b)
15312 (call-interactively 'org-check-before-date))
15313 ((equal ans ?t)
15314 (org-show-todo-tree '(4)))
15315 ((equal ans ?T)
15316 (call-interactively 'org-tags-sparse-tree))
15317 ((member ans '(?p ?P))
15318 (setq kwd (completing-read "Property: "
15319 (mapcar 'list (org-buffer-property-keys))))
15320 (setq value (completing-read "Value: "
15321 (mapcar 'list (org-property-values kwd))))
15324 (org-tags-sparse-tree arg (concat kwd "=" value)))
15325 ((member ans '(?r ?R ?/))
15326 (call-interactively 'org-occur))
15329 (defvar org-occur-highlights nil
15330 "List of overlays used for occur matches.")
15331 (make-variable-buffer-local 'org-occur-highlights)
15332 (defvar org-occur-parameters nil
15333 "Parameters of the active org-occur calls.
15334 This is a list, each call to org-occur pushes as cons cell,
15335 containing the regular expression and the callback, onto the list.
15336 The list can contain several entries if `org-occur' has been called
15337 several time with the KEEP-PREVIOUS argument. Otherwise, this list
15338 will only contain one set of parameters. When the highlights are
15339 removed (for example with `C-c C-c', or with the next edit (depending
15340 on `org-remove-highlights-with-change'), this variable is emptied
15341 as well.")
15342 (make-variable-buffer-local 'org-occur-parameters)
15344 (defun org-occur (regexp &optional keep-previous callback)
15345 "Make a compact tree which shows all matches of REGEXP.
15346 The tree will show the lines where the regexp matches, and all higher
15347 headlines above the match. It will also show the heading after the match,
15348 to make sure editing the matching entry is easy.
15349 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15350 call to `org-occur' will be kept, to allow stacking of calls to this
15351 command.
15352 If CALLBACK is non-nil, it is a function which is called to confirm
15353 that the match should indeed be shown."
15355 (unless keep-previous
15356 (org-remove-occur-highlights nil nil t))
15357 (push (cons regexp callback) org-occur-parameters)
15358 (let ((cnt 0))
15359 (save-excursion
15360 (goto-char (point-min))
15361 (if (or (not keep-previous) ; do not want to keep
15362 (not org-occur-highlights)) ; no previous matches
15363 ;; hide everything
15364 (org-overview))
15365 (while (re-search-forward regexp nil t)
15366 (when (or (not callback)
15367 (save-match-data (funcall callback)))
15368 (setq cnt (1+ cnt))
15369 (when org-highlight-sparse-tree-matches
15370 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15371 (org-show-context 'occur-tree))))
15372 (when org-remove-highlights-with-change
15373 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15374 nil 'local))
15375 (unless org-sparse-tree-open-archived-trees
15376 (org-hide-archived-subtrees (point-min) (point-max)))
15377 (run-hooks 'org-occur-hook)
15378 (if (interactive-p)
15379 (message "%d match(es) for regexp %s" cnt regexp))
15380 cnt))
15382 (defun org-show-context (&optional key)
15383 "Make sure point and context and visible.
15384 How much context is shown depends upon the variables
15385 `org-show-hierarchy-above', `org-show-following-heading'. and
15386 `org-show-siblings'."
15387 (let ((heading-p (org-on-heading-p t))
15388 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15389 (following-p (org-get-alist-option org-show-following-heading key))
15390 (entry-p (org-get-alist-option org-show-entry-below key))
15391 (siblings-p (org-get-alist-option org-show-siblings key)))
15392 (catch 'exit
15393 ;; Show heading or entry text
15394 (if (and heading-p (not entry-p))
15395 (org-flag-heading nil) ; only show the heading
15396 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15397 (org-show-hidden-entry))) ; show entire entry
15398 (when following-p
15399 ;; Show next sibling, or heading below text
15400 (save-excursion
15401 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15402 (org-flag-heading nil))))
15403 (when siblings-p (org-show-siblings))
15404 (when hierarchy-p
15405 ;; show all higher headings, possibly with siblings
15406 (save-excursion
15407 (while (and (condition-case nil
15408 (progn (org-up-heading-all 1) t)
15409 (error nil))
15410 (not (bobp)))
15411 (org-flag-heading nil)
15412 (when siblings-p (org-show-siblings))))))))
15414 (defun org-reveal (&optional siblings)
15415 "Show current entry, hierarchy above it, and the following headline.
15416 This can be used to show a consistent set of context around locations
15417 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15418 not t for the search context.
15420 With optional argument SIBLINGS, on each level of the hierarchy all
15421 siblings are shown. This repairs the tree structure to what it would
15422 look like when opened with hierarchical calls to `org-cycle'."
15423 (interactive "P")
15424 (let ((org-show-hierarchy-above t)
15425 (org-show-following-heading t)
15426 (org-show-siblings (if siblings t org-show-siblings)))
15427 (org-show-context nil)))
15429 (defun org-highlight-new-match (beg end)
15430 "Highlight from BEG to END and mark the highlight is an occur headline."
15431 (let ((ov (org-make-overlay beg end)))
15432 (org-overlay-put ov 'face 'secondary-selection)
15433 (push ov org-occur-highlights)))
15435 (defun org-remove-occur-highlights (&optional beg end noremove)
15436 "Remove the occur highlights from the buffer.
15437 BEG and END are ignored. If NOREMOVE is nil, remove this function
15438 from the `before-change-functions' in the current buffer."
15439 (interactive)
15440 (unless org-inhibit-highlight-removal
15441 (mapc 'org-delete-overlay org-occur-highlights)
15442 (setq org-occur-highlights nil)
15443 (setq org-occur-parameters nil)
15444 (unless noremove
15445 (remove-hook 'before-change-functions
15446 'org-remove-occur-highlights 'local))))
15448 ;;;; Priorities
15451 "Regular expression matching the priority indicator.")
15453 (defvar org-remove-priority-next-time nil)
15455 (defun org-priority-up ()
15456 "Increase the priority of the current item."
15457 (interactive)
15458 (org-priority 'up))
15460 (defun org-priority-down ()
15461 "Decrease the priority of the current item."
15462 (interactive)
15463 (org-priority 'down))
15465 (defun org-priority (&optional action)
15466 "Change the priority of an item by ARG.
15467 ACTION can be `set', `up', `down', or a character."
15468 (interactive)
15469 (setq action (or action 'set))
15470 (let (current new news have remove)
15471 (save-excursion
15472 (org-back-to-heading)
15473 (if (looking-at org-priority-regexp)
15474 (setq current (string-to-char (match-string 2))
15475 have t)
15476 (setq current org-default-priority))
15477 (cond
15478 ((or (eq action 'set) (integerp action))
15479 (if (integerp action)
15480 (setq new action)
15481 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15482 (setq new (read-char-exclusive)))
15483 (if (and (= (upcase org-highest-priority) org-highest-priority)
15484 (= (upcase org-lowest-priority) org-lowest-priority))
15485 (setq new (upcase new)))
15486 (cond ((equal new ?\ ) (setq remove t))
15487 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15488 (error "Priority must be between `%c' and `%c'"
15489 org-highest-priority org-lowest-priority))))
15490 ((eq action 'up)
15491 (if (and (not have) (eq last-command this-command))
15492 (setq new org-lowest-priority)
15493 (setq new (if (and org-priority-start-cycle-with-default (not have))
15494 org-default-priority (1- current)))))
15495 ((eq action 'down)
15496 (if (and (not have) (eq last-command this-command))
15497 (setq new org-highest-priority)
15498 (setq new (if (and org-priority-start-cycle-with-default (not have))
15499 org-default-priority (1+ current)))))
15500 (t (error "Invalid action")))
15501 (if (or (< (upcase new) org-highest-priority)
15502 (> (upcase new) org-lowest-priority))
15503 (setq remove t))
15504 (setq news (format "%c" new))
15505 (if have
15506 (if remove
15507 (replace-match "" t t nil 1)
15508 (replace-match news t t nil 2))
15509 (if remove
15510 (error "No priority cookie found in line")
15511 (looking-at org-todo-line-regexp)
15512 (if (match-end 2)
15513 (progn
15514 (goto-char (match-end 2))
15515 (insert " [#" news "]"))
15516 (goto-char (match-beginning 3))
15517 (insert "[#" news "] ")))))
15518 (org-preserve-lc (org-set-tags nil 'align))
15519 (if remove
15520 (message "Priority removed")
15521 (message "Priority of current item set to %s" news))))
15524 (defun org-get-priority (s)
15525 "Find priority cookie and return priority."
15526 (save-match-data
15527 (if (not (string-match org-priority-regexp s))
15528 (* 1000 (- org-lowest-priority org-default-priority))
15529 (* 1000 (- org-lowest-priority
15530 (string-to-char (match-string 2 s)))))))
15532 ;;;; Tags
15534 (defun org-scan-tags (action matcher &optional todo-only)
15535 "Scan headline tags with inheritance and produce output ACTION.
15536 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15537 evaluated, testing if a given set of tags qualifies a headline for
15538 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15539 are included in the output."
15542 (org-re
15544 (props (list 'face nil
15545 'done-face 'org-done
15546 'undone-face nil
15547 'mouse-face 'highlight
15548 'org-not-done-regexp org-not-done-regexp
15549 'org-todo-regexp org-todo-regexp
15550 'keymap org-agenda-keymap
15551 'help-echo
15552 (format "mouse-2 or RET jump to org file %s"
15553 (abbreviate-file-name
15554 (or (buffer-file-name (buffer-base-buffer))
15555 (buffer-name (buffer-base-buffer)))))))
15556 (case-fold-search nil)
15557 lspos
15558 tags tags-list tags-alist (llast 0) rtn level category i txt
15559 todo marker entry priority)
15560 (save-excursion
15561 (goto-char (point-min))
15562 (when (eq action 'sparse-tree)
15563 (org-overview)
15564 (org-remove-occur-highlights))
15565 (while (re-search-forward re nil t)
15566 (catch :skip
15567 (setq todo (if (match-end 1) (match-string 2))
15568 tags (if (match-end 4) (match-string 4)))
15569 (goto-char (setq lspos (1+ (match-beginning 0))))
15570 (setq level (org-reduced-level (funcall outline-level))
15571 category (org-get-category))
15572 (setq i llast llast level)
15573 ;; remove tag lists from same and sublevels
15574 (while (>= i level)
15575 (when (setq entry (assoc i tags-alist))
15576 (setq tags-alist (delete entry tags-alist)))
15577 (setq i (1- i)))
15578 ;; add the nex tags
15579 (when tags
15580 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15581 tags-alist
15582 (cons (cons level tags) tags-alist)))
15583 ;; compile tags for current headline
15584 (setq tags-list
15585 (if org-use-tag-inheritance
15586 (apply 'append (mapcar 'cdr tags-alist))
15587 tags))
15588 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15589 (eval matcher)
15590 (or (not org-agenda-skip-archived-trees)
15591 (not (member org-archive-tag tags-list))))
15592 (and (eq action 'agenda) (org-agenda-skip))
15593 ;; list this headline
15595 (if (eq action 'sparse-tree)
15596 (progn
15597 (and org-highlight-sparse-tree-matches
15598 (org-get-heading) (match-end 0)
15599 (org-highlight-new-match
15600 (match-beginning 0) (match-beginning 1)))
15601 (org-show-context 'tags-tree))
15602 (setq txt (org-format-agenda-item
15603 ""
15604 (concat
15605 (if org-tags-match-list-sublevels
15606 (make-string (1- level) ?.) "")
15607 (org-get-heading))
15608 category tags-list)
15609 priority (org-get-priority txt))
15610 (goto-char lspos)
15611 (setq marker (org-agenda-new-marker))
15612 (org-add-props txt props
15613 'org-marker marker 'org-hd-marker marker 'org-category category
15614 'priority priority 'type "tagsmatch")
15615 (push txt rtn))
15616 ;; if we are to skip sublevels, jump to end of subtree
15617 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15618 (when (and (eq action 'sparse-tree)
15619 (not org-sparse-tree-open-archived-trees))
15620 (org-hide-archived-subtrees (point-min) (point-max)))
15621 (nreverse rtn)))
15623 (defvar todo-only) ;; dynamically scoped
15625 (defun org-tags-sparse-tree (&optional todo-only match)
15626 "Create a sparse tree according to tags string MATCH.
15627 MATCH can contain positive and negative selection of tags, like
15629 If optional argument TODO_ONLY is non-nil, only select lines that are
15630 also TODO lines."
15631 (interactive "P")
15632 (org-prepare-agenda-buffers (list (current-buffer)))
15633 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15635 (defvar org-cached-props nil)
15636 (defun org-cached-entry-get (pom property)
15637 (if (or (eq t org-use-property-inheritance)
15638 (member property org-use-property-inheritance))
15639 ;; Caching is not possible, check it directly
15640 (org-entry-get pom property 'inherit)
15641 ;; Get all properties, so that we can do complicated checks easily
15642 (cdr (assoc property (or org-cached-props
15643 (setq org-cached-props
15644 (org-entry-properties pom)))))))
15646 (defun org-global-tags-completion-table (&optional files)
15647 "Return the list of all tags in all agenda buffer/files."
15648 (save-excursion
15649 (org-uniquify
15650 (delq nil
15651 (apply 'append
15652 (mapcar
15653 (lambda (file)
15654 (set-buffer (find-file-noselect file))
15655 (append (org-get-buffer-tags)
15656 (mapcar (lambda (x) (if (stringp (car-safe x))
15657 (list (car-safe x)) nil))
15658 org-tag-alist)))
15659 (if (and files (car files))
15660 files
15661 (org-agenda-files))))))))
15663 (defun org-make-tags-matcher (match)
15664 "Create the TAGS//TODO matcher form for the selection string MATCH."
15665 ;; todo-only is scoped dynamically into this function, and the function
15666 ;; may change it it the matcher asksk for it.
15667 (unless match
15668 ;; Get a new match request, with completion
15669 (let ((org-last-tags-completion-table
15670 (org-global-tags-completion-table)))
15671 (setq match (completing-read
15672 "Match: " 'org-tags-completion-function nil nil nil
15673 'org-tags-history))))
15675 ;; Parse the string and create a lisp form
15676 (let ((match0 match)
15677 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15678 minus tag mm
15679 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15680 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15681 (if (string-match "/+" match)
15682 ;; match contains also a todo-matching request
15683 (progn
15684 (setq tagsmatch (substring match 0 (match-beginning 0))
15685 todomatch (substring match (match-end 0)))
15686 (if (string-match "^!" todomatch)
15687 (setq todo-only t todomatch (substring todomatch 1)))
15689 (setq todomatch nil)))
15690 ;; only matching tags
15691 (setq tagsmatch match todomatch nil))
15693 ;; Make the tags matcher
15695 (setq tagsmatcher t)
15696 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15697 (while (setq term (pop orterms))
15699 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15700 (while (string-match re term)
15701 (setq minus (and (match-end 1)
15702 (equal (match-string 1 term) "-"))
15703 tag (match-string 2 term)
15704 re-p (equal (string-to-char tag) ?{)
15705 level-p (match-end 3)
15706 prop-p (match-end 4)
15707 mm (cond
15708 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15709 (level-p `(= level ,(string-to-number
15710 (match-string 3 term))))
15711 (prop-p
15712 (setq pn (match-string 4 term)
15713 pv (match-string 5 term)
15714 cat-p (equal pn "CATEGORY")
15715 re-p (equal (string-to-char pv) ?{)
15716 pv (substring pv 1 -1))
15717 (if (equal pn "CATEGORY")
15718 (setq gv '(get-text-property (point) 'org-category))
15719 (setq gv `(org-cached-entry-get nil ,pn)))
15720 (if re-p
15721 `(string-match ,pv (or ,gv ""))
15722 `(equal ,pv (or ,gv ""))))
15723 (t `(member ,(downcase tag) tags-list)))
15724 mm (if minus (list 'not mm) mm)
15725 term (substring term (match-end 0)))
15726 (push mm tagsmatcher))
15727 (push (if (> (length tagsmatcher) 1)
15728 (cons 'and tagsmatcher)
15729 (car tagsmatcher))
15730 orlist)
15731 (setq tagsmatcher nil))
15732 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15733 (setq tagsmatcher
15734 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15736 ;; Make the todo matcher
15738 (setq todomatcher t)
15739 (setq orterms (org-split-string todomatch "|") orlist nil)
15740 (while (setq term (pop orterms))
15741 (while (string-match re term)
15742 (setq minus (and (match-end 1)
15743 (equal (match-string 1 term) "-"))
15744 kwd (match-string 2 term)
15745 re-p (equal (string-to-char kwd) ?{)
15746 term (substring term (match-end 0))
15747 mm (if re-p
15748 `(string-match ,(substring kwd 1 -1) todo)
15749 (list 'equal 'todo kwd))
15750 mm (if minus (list 'not mm) mm))
15751 (push mm todomatcher))
15752 (push (if (> (length todomatcher) 1)
15753 (cons 'and todomatcher)
15754 (car todomatcher))
15755 orlist)
15756 (setq todomatcher nil))
15757 (setq todomatcher (if (> (length orlist) 1)
15758 (cons 'or orlist) (car orlist))))
15760 ;; Return the string and lisp forms of the matcher
15761 (setq matcher (if todomatcher
15762 (list 'and tagsmatcher todomatcher)
15763 tagsmatcher))
15764 (cons match0 matcher)))
15766 (defun org-match-any-p (re list)
15767 "Does re match any element of list?"
15768 (setq list (mapcar (lambda (x) (string-match re x)) list))
15769 (delq nil list))
15771 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15772 (defvar org-tags-overlay (org-make-overlay 1 1))
15773 (org-detach-overlay org-tags-overlay)
15775 (defun org-align-tags-here (to-col)
15776 ;; Assumes that this is a headline
15777 (let ((pos (point)) (col (current-column)) tags)
15778 (beginning-of-line 1)
15780 (< pos (match-beginning 2)))
15781 (progn
15782 (setq tags (match-string 2))
15783 (goto-char (match-beginning 1))
15784 (insert " ")
15785 (delete-region (point) (1+ (match-end 0)))
15786 (backward-char 1)
15787 (move-to-column
15788 (max (1+ (current-column))
15789 (1+ col)
15790 (if (> to-col 0)
15791 to-col
15792 (- (abs to-col) (length tags))))
15793 t)
15794 (insert tags)
15795 (move-to-column (min (current-column) col) t))
15796 (goto-char pos))))
15798 (defun org-set-tags (&optional arg just-align)
15799 "Set the tags for the current headline.
15800 With prefix ARG, realign all tags in headings in the current buffer."
15801 (interactive "P")
15802 (let* ((re (concat "^" outline-regexp))
15803 (current (org-get-tags-string))
15804 (col (current-column))
15805 (org-setting-tags t)
15806 table current-tags inherited-tags ; computed below when needed
15807 tags p0 c0 c1 rpl)
15808 (if arg
15809 (save-excursion
15810 (goto-char (point-min))
15811 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15812 (while (re-search-forward re nil t)
15813 (org-set-tags nil t)
15814 (end-of-line 1)))
15815 (message "All tags realigned to column %d" org-tags-column))
15816 (if just-align
15817 (setq tags current)
15818 ;; Get a new set of tags from the user
15819 (save-excursion
15820 (setq table (or org-tag-alist (org-get-buffer-tags))
15821 org-last-tags-completion-table table
15822 current-tags (org-split-string current ":")
15823 inherited-tags (nreverse
15824 (nthcdr (length current-tags)
15825 (nreverse (org-get-tags-at))))
15826 tags
15827 (if (or (eq t org-use-fast-tag-selection)
15828 (and org-use-fast-tag-selection
15829 (delq nil (mapcar 'cdr table))))
15830 (org-fast-tag-selection
15831 current-tags inherited-tags table
15832 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15833 (let ((org-add-colon-after-tag-completion t))
15834 (org-trim
15835 (org-without-partial-completion
15836 (completing-read "Tags: " 'org-tags-completion-function
15837 nil nil current 'org-tags-history)))))))
15838 (while (string-match "[-+&]+" tags)
15839 ;; No boolean logic, just a list
15840 (setq tags (replace-match ":" t t tags))))
15843 (setq tags "")
15844 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15845 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15847 ;; Insert new tags at the correct column
15848 (beginning-of-line 1)
15849 (cond
15850 ((and (equal current "") (equal tags "")))
15851 ((re-search-forward
15853 (point-at-eol) t)
15854 (if (equal tags "")
15855 (setq rpl "")
15856 (goto-char (match-beginning 0))
15857 (setq c0 (current-column) p0 (point)
15858 c1 (max (1+ c0) (if (> org-tags-column 0)
15859 org-tags-column
15860 (- (- org-tags-column) (length tags))))
15861 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15862 (replace-match rpl t t)
15863 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15864 tags)
15865 (t (error "Tags alignment failed")))
15866 (move-to-column col)
15867 (unless just-align
15868 (run-hooks 'org-after-tags-change-hook)))))
15870 (defun org-change-tag-in-region (beg end tag off)
15871 "Add or remove TAG for each entry in the region.
15872 This works in the agenda, and also in an org-mode buffer."
15873 (interactive
15874 (list (region-beginning) (region-end)
15875 (let ((org-last-tags-completion-table
15876 (if (org-mode-p)
15877 (org-get-buffer-tags)
15878 (org-global-tags-completion-table))))
15879 (completing-read
15880 "Tag: " 'org-tags-completion-function nil nil nil
15881 'org-tags-history))
15882 (progn
15883 (message "[s]et or [r]emove? ")
15884 (equal (read-char-exclusive) ?r))))
15885 (if (fboundp 'deactivate-mark) (deactivate-mark))
15886 (let ((agendap (equal major-mode 'org-agenda-mode))
15887 l1 l2 m buf pos newhead (cnt 0))
15888 (goto-char end)
15889 (setq l2 (1- (org-current-line)))
15890 (goto-char beg)
15891 (setq l1 (org-current-line))
15892 (loop for l from l1 to l2 do
15893 (goto-line l)
15894 (setq m (get-text-property (point) 'org-hd-marker))
15895 (when (or (and (org-mode-p) (org-on-heading-p))
15896 (and agendap m))
15897 (setq buf (if agendap (marker-buffer m) (current-buffer))
15898 pos (if agendap m (point)))
15899 (with-current-buffer buf
15900 (save-excursion
15901 (save-restriction
15902 (goto-char pos)
15903 (setq cnt (1+ cnt))
15904 (org-toggle-tag tag (if off 'off 'on))
15905 (setq newhead (org-get-heading)))))
15906 (and agendap (org-agenda-change-all-lines newhead m))))
15907 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15909 (defun org-tags-completion-function (string predicate &optional flag)
15910 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15911 (confirm (lambda (x) (stringp (car x)))))
15913 (setq s1 (match-string 1 string)
15914 s2 (match-string 2 string))
15915 (setq s1 "" s2 string))
15916 (cond
15917 ((eq flag nil)
15918 ;; try completion
15919 (setq rtn (try-completion s2 ctable confirm))
15920 (if (stringp rtn)
15921 (setq rtn
15922 (concat s1 s2 (substring rtn (length s2))
15923 (if (and org-add-colon-after-tag-completion
15924 (assoc rtn ctable))
15925 ":" ""))))
15926 rtn)
15927 ((eq flag t)
15928 ;; all-completions
15929 (all-completions s2 ctable confirm)
15930 )
15931 ((eq flag 'lambda)
15932 ;; exact match?
15933 (assoc s2 ctable)))
15934 ))
15936 (defun org-fast-tag-insert (kwd tags face &optional end)
15937 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15938 (insert (format "%-12s" (concat kwd ":"))
15939 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15940 (or end "")))
15942 (defun org-fast-tag-show-exit (flag)
15943 (save-excursion
15944 (goto-line 3)
15946 (replace-match ""))
15947 (when flag
15948 (end-of-line 1)
15949 (move-to-column (- (window-width) 19) t)
15950 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15952 (defun org-set-current-tags-overlay (current prefix)
15953 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15954 (if (featurep 'xemacs)
15955 (org-overlay-display org-tags-overlay (concat prefix s)
15956 'secondary-selection)
15957 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15958 (org-overlay-display org-tags-overlay (concat prefix s)))))
15960 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15961 "Fast tag selection with single keys.
15962 CURRENT is the current list of tags in the headline, INHERITED is the
15963 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15964 possibly with grouping information. TODO-TABLE is a similar table with
15965 TODO keywords, should these have keys assigned to them.
15966 If the keys are nil, a-z are automatically assigned.
15967 Returns the new tags string, or nil to not change the current settings."
15968 (let* ((fulltable (append table todo-table))
15969 (maxlen (apply 'max (mapcar
15970 (lambda (x)
15971 (if (stringp (car x)) (string-width (car x)) 0))
15972 fulltable)))
15973 (buf (current-buffer))
15974 (expert (eq org-fast-tag-selection-single-key 'expert))
15975 (buffer-tags nil)
15976 (fwidth (+ maxlen 3 1 3))
15977 (ncol (/ (- (window-width) 4) fwidth))
15978 (i-face 'org-done)
15979 (c-face 'org-todo)
15980 tg cnt e c char c1 c2 ntable tbl rtn
15981 ov-start ov-end ov-prefix
15982 (exit-after-next org-fast-tag-selection-single-key)
15983 (done-keywords org-done-keywords)
15984 groups ingroup)
15985 (save-excursion
15986 (beginning-of-line 1)
15987 (if (looking-at
15989 (setq ov-start (match-beginning 1)
15990 ov-end (match-end 1)
15991 ov-prefix "")
15992 (setq ov-start (1- (point-at-eol))
15993 ov-end (1+ ov-start))
15995 (setq ov-prefix
15996 (concat
15997 (buffer-substring (1- (point)) (point))
15998 (if (> (current-column) org-tags-column)
15999 " "
16000 (make-string (- org-tags-column (current-column)) ?\ ))))))
16001 (org-move-overlay org-tags-overlay ov-start ov-end)
16002 (save-window-excursion
16003 (if expert
16004 (set-buffer (get-buffer-create " *Org tags*"))
16005 (delete-other-windows)
16006 (split-window-vertically)
16007 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
16008 (erase-buffer)
16009 (org-set-local 'org-done-keywords done-keywords)
16012 (org-fast-tag-show-exit exit-after-next)
16013 (org-set-current-tags-overlay current ov-prefix)
16014 (setq tbl fulltable char ?a cnt 0)
16015 (while (setq e (pop tbl))
16016 (cond
16017 ((equal e '(:startgroup))
16018 (push '() groups) (setq ingroup t)
16019 (when (not (= cnt 0))
16020 (setq cnt 0)
16022 (insert "{ "))
16023 ((equal e '(:endgroup))
16024 (setq ingroup nil cnt 0)
16026 (t
16027 (setq tg (car e) c2 nil)
16028 (if (cdr e)
16029 (setq c (cdr e))
16030 ;; automatically assign a character.
16031 (setq c1 (string-to-char
16032 (downcase (substring
16033 tg (if (= (string-to-char tg) ?@) 1 0)))))
16034 (if (or (rassoc c1 ntable) (rassoc c1 table))
16035 (while (or (rassoc char ntable) (rassoc char table))
16036 (setq char (1+ char)))
16037 (setq c2 c1))
16038 (setq c (or c2 char)))
16039 (if ingroup (push tg (car groups)))
16040 (setq tg (org-add-props tg nil 'face
16041 (cond
16042 ((not (assoc tg table))
16043 (org-get-todo-face tg))
16044 ((member tg current) c-face)
16045 ((member tg inherited) i-face)
16046 (t nil))))
16047 (if (and (= cnt 0) (not ingroup)) (insert " "))
16048 (insert "[" c "] " tg (make-string
16049 (- fwidth 4 (length tg)) ?\ ))
16050 (push (cons tg c) ntable)
16051 (when (= (setq cnt (1+ cnt)) ncol)
16053 (if ingroup (insert " "))
16054 (setq cnt 0)))))
16055 (setq ntable (nreverse ntable))
16057 (goto-char (point-min))
16058 (if (and (not expert) (fboundp 'fit-window-to-buffer))
16059 (fit-window-to-buffer))
16060 (setq rtn
16061 (catch 'exit
16062 (while t
16063 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
16064 (if groups " [!] no groups" " [!]groups")
16065 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
16066 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
16067 (cond
16069 ((= c ?!)
16070 (setq groups (not groups))
16071 (goto-char (point-min))
16072 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
16073 ((= c ?\C-c)
16074 (if (not expert)
16075 (org-fast-tag-show-exit
16076 (setq exit-after-next (not exit-after-next)))
16077 (setq expert nil)
16078 (delete-other-windows)
16079 (split-window-vertically)
16080 (org-switch-to-buffer-other-window " *Org tags*")
16081 (and (fboundp 'fit-window-to-buffer)
16082 (fit-window-to-buffer))))
16083 ((or (= c ?\C-g)
16084 (and (= c ?q) (not (rassoc c ntable))))
16085 (org-detach-overlay org-tags-overlay)
16086 (setq quit-flag t))
16087 ((= c ?\ )
16088 (setq current nil)
16089 (if exit-after-next (setq exit-after-next 'now)))
16091 (condition-case nil
16092 (setq tg (completing-read
16093 "Tag: "
16094 (or buffer-tags
16095 (with-current-buffer buf
16096 (org-get-buffer-tags)))))
16097 (quit (setq tg "")))
16099 (add-to-list 'buffer-tags (list tg))
16100 (if (member tg current)
16101 (setq current (delete tg current))
16102 (push tg current)))
16103 (if exit-after-next (setq exit-after-next 'now)))
16104 ((setq e (rassoc c todo-table) tg (car e))
16105 (with-current-buffer buf
16106 (save-excursion (org-todo tg)))
16107 (if exit-after-next (setq exit-after-next 'now)))
16108 ((setq e (rassoc c ntable) tg (car e))
16109 (if (member tg current)
16110 (setq current (delete tg current))
16111 (loop for g in groups do
16112 (if (member tg g)
16113 (mapc (lambda (x)
16114 (setq current (delete x current)))
16115 g)))
16116 (push tg current))
16117 (if exit-after-next (setq exit-after-next 'now))))
16119 ;; Create a sorted list
16120 (setq current
16121 (sort current
16122 (lambda (a b)
16123 (assoc b (cdr (memq (assoc a ntable) ntable))))))
16124 (if (eq exit-after-next 'now) (throw 'exit t))
16125 (goto-char (point-min))
16126 (beginning-of-line 2)
16127 (delete-region (point) (point-at-eol))
16128 (org-fast-tag-insert "Current" current c-face)
16129 (org-set-current-tags-overlay current ov-prefix)
16130 (while (re-search-forward
16132 (setq tg (match-string 1))
16133 (add-text-properties
16134 (match-beginning 1) (match-end 1)
16135 (list 'face
16136 (cond
16137 ((member tg current) c-face)
16138 ((member tg inherited) i-face)
16139 (t (get-text-property (match-beginning 1) 'face))))))
16140 (goto-char (point-min)))))
16141 (org-detach-overlay org-tags-overlay)
16142 (if rtn
16143 (mapconcat 'identity current ":")
16144 nil))))
16146 (defun org-get-tags-string ()
16147 "Get the TAGS string in the current headline."
16148 (unless (org-on-heading-p t)
16149 (error "Not on a heading"))
16150 (save-excursion
16151 (beginning-of-line 1)
16153 (org-match-string-no-properties 1)
16154 "")))
16156 (defun org-get-tags ()
16157 "Get the list of tags specified in the current headline."
16158 (org-split-string (org-get-tags-string) ":"))
16160 (defun org-get-buffer-tags ()
16161 "Get a table of all tags used in the buffer, for completion."
16162 (let (tags)
16163 (save-excursion
16164 (goto-char (point-min))
16165 (while (re-search-forward
16167 (when (equal (char-after (point-at-bol 0)) ?*)
16168 (mapc (lambda (x) (add-to-list 'tags x))
16169 (org-split-string (org-match-string-no-properties 1) ":")))))
16170 (mapcar 'list tags)))
16173 ;;;; Properties
16175 ;;; Setting and retrieving properties
16177 (defconst org-special-properties
16178 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
16179 "TIMESTAMP" "TIMESTAMP_IA")
16180 "The special properties valid in Org-mode.
16182 These are properties that are not defined in the property drawer,
16183 but in some other way.")
16185 (defconst org-default-properties
16186 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
16187 "LOCATION" "LOGGING" "COLUMNS")
16188 "Some properties that are used by Org-mode for various purposes.
16189 Being in this list makes sure that they are offered for completion.")
16192 "Regular expression matching the first line of a property drawer.")
16195 "Regular expression matching the first line of a property drawer.")
16197 (defun org-property-action ()
16198 "Do an action on properties."
16199 (interactive)
16200 (let (c)
16201 (org-at-property-p)
16202 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
16203 (setq c (read-char-exclusive))
16204 (cond
16205 ((equal c ?s)
16206 (call-interactively 'org-set-property))
16207 ((equal c ?d)
16208 (call-interactively 'org-delete-property))
16209 ((equal c ?D)
16210 (call-interactively 'org-delete-property-globally))
16211 ((equal c ?c)
16212 (call-interactively 'org-compute-property-at-point))
16213 (t (error "No such property action %c" c)))))
16215 (defun org-at-property-p ()
16216 "Is the cursor in a property line?"
16217 ;; FIXME: Does not check if we are actually in the drawer.
16218 ;; FIXME: also returns true on any drawers.....
16219 ;; This is used by C-c C-c for property action.
16220 (save-excursion
16221 (beginning-of-line 1)
16224 (defmacro org-with-point-at (pom &rest body)
16225 "Move to buffer and point of point-or-marker POM for the duration of BODY."
16226 (declare (indent 1) (debug t))
16227 `(save-excursion
16228 (if (markerp pom) (set-buffer (marker-buffer pom)))
16229 (save-excursion
16230 (goto-char (or pom (point)))
16231 ,@body)))
16233 (defun org-get-property-block (&optional beg end force)
16234 "Return the (beg . end) range of the body of the property drawer.
16235 BEG and END can be beginning and end of subtree, if not given
16236 they will be found.
16237 If the drawer does not exist and FORCE is non-nil, create the drawer."
16238 (catch 'exit
16239 (save-excursion
16240 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
16241 (end (or end (progn (outline-next-heading) (point)))))
16242 (goto-char beg)
16243 (if (re-search-forward org-property-start-re end t)
16244 (setq beg (1+ (match-end 0)))
16245 (if force
16246 (save-excursion
16247 (org-insert-property-drawer)
16248 (setq end (progn (outline-next-heading) (point))))
16249 (throw 'exit nil))
16250 (goto-char beg)
16251 (if (re-search-forward org-property-start-re end t)
16252 (setq beg (1+ (match-end 0)))))
16253 (if (re-search-forward org-property-end-re end t)
16254 (setq end (match-beginning 0))
16255 (or force (throw 'exit nil))
16256 (goto-char beg)
16257 (setq end beg)
16258 (org-indent-line-function)
16260 (cons beg end)))))
16262 (defun org-entry-properties (&optional pom which)
16263 "Get all properties of the entry at point-or-marker POM.
16264 This includes the TODO keyword, the tags, time strings for deadline,
16265 scheduled, and clocking, and any additional properties defined in the
16266 entry. The return value is an alist, keys may occur multiple times
16267 if the property key was used several times.
16268 POM may also be nil, in which case the current entry is used.
16269 If WHICH is nil or `all', get all properties. If WHICH is
16270 `special' or `standard', only get that subclass."
16271 (setq which (or which 'all))
16272 (org-with-point-at pom
16273 (let ((clockstr (substring org-clock-string 0 -1))
16274 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
16275 beg end range props sum-props key value string clocksum)
16276 (save-excursion
16277 (when (condition-case nil (org-back-to-heading t) (error nil))
16278 (setq beg (point))
16279 (setq sum-props (get-text-property (point) 'org-summaries))
16280 (setq clocksum (get-text-property (point) :org-clock-minutes))
16281 (outline-next-heading)
16282 (setq end (point))
16283 (when (memq which '(all special))
16284 ;; Get the special properties, like TODO and tags
16285 (goto-char beg)
16286 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16287 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16288 (when (looking-at org-priority-regexp)
16289 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16290 (when (and (setq value (org-get-tags-string))
16292 (push (cons "TAGS" value) props))
16293 (when (setq value (org-get-tags-at))
16294 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16295 props))
16296 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16297 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16298 string (if (equal key clockstr)
16299 (org-no-properties
16300 (org-trim
16301 (buffer-substring
16302 (match-beginning 3) (goto-char (point-at-eol)))))
16303 (substring (org-match-string-no-properties 3) 1 -1)))
16304 (unless key
16305 (if (= (char-after (match-beginning 3)) ?\[)
16306 (setq key "TIMESTAMP_IA")
16307 (setq key "TIMESTAMP")))
16308 (when (or (equal key clockstr) (not (assoc key props)))
16309 (push (cons key string) props)))
16311 )
16313 (when (memq which '(all standard))
16314 ;; Get the standard properties, like :PORP: ...
16315 (setq range (org-get-property-block beg end))
16316 (when range
16317 (goto-char (car range))
16318 (while (re-search-forward
16320 (cdr range) t)
16321 (setq key (org-match-string-no-properties 1)
16322 value (org-trim (or (org-match-string-no-properties 2) "")))
16323 (unless (member key excluded)
16324 (push (cons key (or value "")) props)))))
16325 (if clocksum
16326 (push (cons "CLOCKSUM"
16327 (org-column-number-to-string (/ (float clocksum) 60.)
16328 'add_times))
16329 props))
16330 (append sum-props (nreverse props)))))))
16332 (defun org-entry-get (pom property &optional inherit)
16333 "Get value of PROPERTY for entry at point-or-marker POM.
16334 If INHERIT is non-nil and the entry does not have the property,
16335 then also check higher levels of the hierarchy.
16336 If the property is present but empty, the return value is the empty string.
16337 If the property is not present at all, nil is returned."
16338 (org-with-point-at pom
16339 (if inherit
16340 (org-entry-get-with-inheritance property)
16341 (if (member property org-special-properties)
16342 ;; We need a special property. Use brute force, get all properties.
16343 (cdr (assoc property (org-entry-properties nil 'special)))
16344 (let ((range (org-get-property-block)))
16345 (if (and range
16346 (goto-char (car range))
16347 (re-search-forward
16349 (cdr range) t))
16350 ;; Found the property, return it.
16351 (if (match-end 1)
16352 (org-match-string-no-properties 1)
16353 "")))))))
16355 (defun org-entry-delete (pom property)
16356 "Delete the property PROPERTY from entry at point-or-marker POM."
16357 (org-with-point-at pom
16358 (if (member property org-special-properties)
16359 nil ; cannot delete these properties.
16360 (let ((range (org-get-property-block)))
16361 (if (and range
16362 (goto-char (car range))
16363 (re-search-forward
16365 (cdr range) t))
16366 (progn
16367 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16368 t)
16369 nil)))))
16371 ;; Multi-values properties are properties that contain multiple values
16372 ;; These values are assumed to be single words, separated by whitespace.
16373 (defun org-entry-add-to-multivalued-property (pom property value)
16374 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16375 (let* ((old (org-entry-get pom property))
16377 (unless (member value values)
16378 (setq values (cons value values))
16379 (org-entry-put pom property
16380 (mapconcat 'identity values " ")))))
16382 (defun org-entry-remove-from-multivalued-property (pom property value)
16383 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16384 (let* ((old (org-entry-get pom property))
16386 (when (member value values)
16387 (setq values (delete value values))
16388 (org-entry-put pom property
16389 (mapconcat 'identity values " ")))))
16391 (defun org-entry-member-in-multivalued-property (pom property value)
16392 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16393 (let* ((old (org-entry-get pom property))
16395 (member value values)))
16397 (defvar org-entry-property-inherited-from (make-marker))
16399 (defun org-entry-get-with-inheritance (property)
16400 "Get entry property, and search higher levels if not present."
16401 (let (tmp)
16402 (save-excursion
16403 (save-restriction
16404 (widen)
16405 (catch 'ex
16406 (while t
16407 (when (setq tmp (org-entry-get nil property))
16408 (org-back-to-heading t)
16409 (move-marker org-entry-property-inherited-from (point))
16410 (throw 'ex tmp))
16411 (or (org-up-heading-safe) (throw 'ex nil)))))
16412 (or tmp (cdr (assoc property org-local-properties))
16413 (cdr (assoc property org-global-properties))))))
16415 (defun org-entry-put (pom property value)
16416 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16417 (org-with-point-at pom
16418 (org-back-to-heading t)
16419 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16420 range)
16421 (cond
16422 ((equal property "TODO")
16424 (not (member value org-todo-keywords-1)))
16426 (if (or (not value)
16428 (setq value 'none))
16429 (org-todo value)
16430 (org-set-tags nil 'align))
16431 ((equal property "PRIORITY")
16433 (string-to-char value) ?\ ))
16434 (org-set-tags nil 'align))
16435 ((equal property "SCHEDULED")
16436 (if (re-search-forward org-scheduled-time-regexp end t)
16437 (cond
16438 ((eq value 'earlier) (org-timestamp-change -1 'day))
16439 ((eq value 'later) (org-timestamp-change 1 'day))
16440 (t (call-interactively 'org-schedule)))
16441 (call-interactively 'org-schedule)))
16442 ((equal property "DEADLINE")
16443 (if (re-search-forward org-deadline-time-regexp end t)
16444 (cond
16445 ((eq value 'earlier) (org-timestamp-change -1 'day))
16446 ((eq value 'later) (org-timestamp-change 1 'day))
16447 (t (call-interactively 'org-deadline)))
16448 (call-interactively 'org-deadline)))
16449 ((member property org-special-properties)
16450 (error "The %s property can not yet be set with `org-entry-put'"
16451 property))
16452 (t ; a non-special property
16453 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16454 (setq range (org-get-property-block beg end 'force))
16455 (goto-char (car range))
16456 (if (re-search-forward
16458 (progn
16459 (delete-region (match-beginning 1) (match-end 1))
16460 (goto-char (match-beginning 1)))
16461 (goto-char (cdr range))
16463 (backward-char 1)
16464 (org-indent-line-function)
16465 (insert ":" property ":"))
16466 (and value (insert " " value))
16467 (org-indent-line-function)))))))
16469 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16470 "Get all property keys in the current buffer.
16471 With INCLUDE-SPECIALS, also list the special properties that relect things
16472 like tags and TODO state.
16473 With INCLUDE-DEFAULTS, also include properties that has special meaning
16474 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16475 With INCLUDE-COLUMNS, also include property names given in COLUMN
16476 formats in the current buffer."
16477 (let (rtn range cfmt cols s p)
16478 (save-excursion
16479 (save-restriction
16480 (widen)
16481 (goto-char (point-min))
16482 (while (re-search-forward org-property-start-re nil t)
16483 (setq range (org-get-property-block))
16484 (goto-char (car range))
16485 (while (re-search-forward
16487 (cdr range) t)
16488 (add-to-list 'rtn (org-match-string-no-properties 1)))
16489 (outline-next-heading))))
16491 (when include-specials
16492 (setq rtn (append org-special-properties rtn)))
16494 (when include-defaults
16495 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16497 (when include-columns
16498 (save-excursion
16499 (save-restriction
16500 (widen)
16501 (goto-char (point-min))
16502 (while (re-search-forward
16504 nil t)
16505 (setq cfmt (match-string 2) s 0)
16507 cfmt s)
16508 (setq s (match-end 0)
16509 p (match-string 1 cfmt))
16510 (unless (or (equal p "ITEM")
16511 (member p org-special-properties))
16512 (add-to-list 'rtn (match-string 1 cfmt))))))))
16514 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16516 (defun org-property-values (key)
16517 "Return a list of all values of property KEY."
16518 (save-excursion
16519 (save-restriction
16520 (widen)
16521 (goto-char (point-min))
16523 values)
16524 (while (re-search-forward re nil t)
16525 (add-to-list 'values (org-trim (match-string 1))))
16526 (delete "" values)))))
16528 (defun org-insert-property-drawer ()
16529 "Insert a property drawer into the current entry."
16530 (interactive)
16531 (org-back-to-heading t)
16532 (looking-at outline-regexp)
16533 (let ((indent (- (match-end 0)(match-beginning 0)))
16534 (beg (point))
16536 end hiddenp)
16537 (outline-next-heading)
16538 (setq end (point))
16539 (goto-char beg)
16540 (while (re-search-forward re end t))
16541 (setq hiddenp (org-invisible-p))
16542 (end-of-line 1)
16544 (org-skip-over-state-notes)
16546 (if (eq (char-before) ?*) (forward-char 1))
16548 (beginning-of-line 0)
16549 (indent-to-column indent)
16550 (beginning-of-line 2)
16551 (indent-to-column indent)
16552 (beginning-of-line 0)
16553 (if hiddenp
16554 (save-excursion
16555 (org-back-to-heading t)
16556 (hide-entry))
16557 (org-flag-drawer t))))
16559 (defun org-set-property (property value)
16560 "In the current entry, set PROPERTY to VALUE.
16561 When called interactively, this will prompt for a property name, offering
16562 completion on existing and default properties. And then it will prompt
16563 for a value, offering competion either on allowed values (via an inherited
16564 xxx_ALL property) or on existing values in other instances of this property
16565 in the current file."
16566 (interactive
16567 (let* ((prop (completing-read
16568 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16569 (cur (org-entry-get nil prop))
16570 (allowed (org-property-get-allowed-values nil prop 'table))
16571 (existing (mapcar 'list (org-property-values prop)))
16572 (val (if allowed
16573 (completing-read "Value: " allowed nil 'req-match)
16574 (completing-read
16576 (concat "[" cur "]") "")
16577 ": ")
16578 existing nil nil "" nil cur))))
16579 (list prop (if (equal val "") cur val))))
16580 (unless (equal (org-entry-get nil property) value)
16581 (org-entry-put nil property value)))
16583 (defun org-delete-property (property)
16584 "In the current entry, delete PROPERTY."
16585 (interactive
16586 (let* ((prop (completing-read
16587 "Property: " (org-entry-properties nil 'standard))))
16588 (list prop)))
16589 (message "Property %s %s" property
16590 (if (org-entry-delete nil property)
16591 "deleted"
16592 "was not present in the entry")))
16594 (defun org-delete-property-globally (property)
16595 "Remove PROPERTY globally, from all entries."
16596 (interactive
16597 (let* ((prop (completing-read
16598 "Globally remove property: "
16599 (mapcar 'list (org-buffer-property-keys)))))
16600 (list prop)))
16601 (save-excursion
16602 (save-restriction
16603 (widen)
16604 (goto-char (point-min))
16605 (let ((cnt 0))
16606 (while (re-search-forward
16608 nil t)
16609 (setq cnt (1+ cnt))
16610 (replace-match ""))
16613 (defvar org-columns-current-fmt-compiled) ; defined below
16615 (defun org-compute-property-at-point ()
16616 "Compute the property at point.
16617 This looks for an enclosing column format, extracts the operator and
16618 then applies it to the proerty in the column format's scope."
16619 (interactive)
16620 (unless (org-at-property-p)
16621 (error "Not at a property"))
16622 (let ((prop (org-match-string-no-properties 2)))
16623 (org-columns-get-format-and-top-level)
16624 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16625 (error "No operator defined for property %s" prop))
16626 (org-columns-compute prop)))
16628 (defun org-property-get-allowed-values (pom property &optional table)
16629 "Get allowed values for the property PROPERTY.
16630 When TABLE is non-nil, return an alist that can directly be used for
16631 completion."
16632 (let (vals)
16633 (cond
16634 ((equal property "TODO")
16635 (setq vals (org-with-point-at pom
16636 (append org-todo-keywords-1 '("")))))
16637 ((equal property "PRIORITY")
16638 (let ((n org-lowest-priority))
16639 (while (>= n org-highest-priority)
16640 (push (char-to-string n) vals)
16641 (setq n (1- n)))))
16642 ((member property org-special-properties))
16643 (t
16644 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16647 (setq vals (car (read-from-string (concat "(" vals ")"))))
16648 (setq vals (mapcar (lambda (x)
16649 (cond ((stringp x) x)
16650 ((numberp x) (number-to-string x))
16651 ((symbolp x) (symbol-name x))
16652 (t "???")))
16653 vals)))))
16654 (if table (mapcar 'list vals) vals)))
16656 (defun org-property-previous-allowed-value (&optional previous)
16657 "Switch to the next allowed value for this property."
16658 (interactive)
16659 (org-property-next-allowed-value t))
16661 (defun org-property-next-allowed-value (&optional previous)
16662 "Switch to the next allowed value for this property."
16663 (interactive)
16664 (unless (org-at-property-p)
16665 (error "Not at a property"))
16666 (let* ((key (match-string 2))
16667 (value (match-string 3))
16668 (allowed (or (org-property-get-allowed-values (point) key)
16669 (and (member value '("[ ]" "[-]" "[X]"))
16670 '("[ ]" "[X]"))))
16671 nval)
16672 (unless allowed
16673 (error "Allowed values for this property have not been defined"))
16674 (if previous (setq allowed (reverse allowed)))
16675 (if (member value allowed)
16676 (setq nval (car (cdr (member value allowed)))))
16677 (setq nval (or nval (car allowed)))
16678 (if (equal nval value)
16679 (error "Only one allowed value for this property"))
16680 (org-at-property-p)
16681 (replace-match (concat " :" key ": " nval) t t)
16682 (org-indent-line-function)
16683 (beginning-of-line 1)
16686 (defun org-find-entry-with-id (ident)
16687 "Locate the entry that contains the ID property with exact value IDENT.
16688 IDENT can be a string, a symbol or a number, this function will search for
16689 the string representation of it.
16690 Return the position where this entry starts, or nil if there is no such entry."
16691 (let ((id (cond
16692 ((stringp ident) ident)
16693 ((symbol-name ident) (symbol-name ident))
16694 ((numberp ident) (number-to-string ident))
16695 (t (error "IDENT %s must be a string, symbol or number" ident))))
16696 (case-fold-search nil))
16697 (save-excursion
16698 (save-restriction
16699 (widen)
16700 (goto-char (point-min))
16701 (when (re-search-forward
16703 nil t)
16704 (org-back-to-heading)
16705 (point))))))
16707 ;;; Column View
16709 (defvar org-columns-overlays nil
16710 "Holds the list of current column overlays.")
16712 (defvar org-columns-current-fmt nil
16713 "Local variable, holds the currently active column format.")
16714 (defvar org-columns-current-fmt-compiled nil
16715 "Local variable, holds the currently active column format.
16716 This is the compiled version of the format.")
16717 (defvar org-columns-current-widths nil
16718 "Loval variable, holds the currently widths of fields.")
16719 (defvar org-columns-current-maxwidths nil
16720 "Loval variable, holds the currently active maximum column widths.")
16721 (defvar org-columns-begin-marker (make-marker)
16722 "Points to the position where last a column creation command was called.")
16723 (defvar org-columns-top-level-marker (make-marker)
16724 "Points to the position where current columns region starts.")
16726 (defvar org-columns-map (make-sparse-keymap)
16727 "The keymap valid in column display.")
16729 (defun org-columns-content ()
16730 "Switch to contents view while in columns view."
16731 (interactive)
16732 (org-overview)
16733 (org-content))
16735 (org-defkey org-columns-map "c" 'org-columns-content)
16736 (org-defkey org-columns-map "o" 'org-overview)
16737 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16738 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16739 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16740 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16741 (org-defkey org-columns-map "v" 'org-columns-show-value)
16742 (org-defkey org-columns-map "q" 'org-columns-quit)
16743 (org-defkey org-columns-map "r" 'org-columns-redo)
16744 (org-defkey org-columns-map "g" 'org-columns-redo)
16745 (org-defkey org-columns-map [left] 'backward-char)
16746 (org-defkey org-columns-map "\M-b" 'backward-char)
16747 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16748 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16749 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16750 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16751 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16752 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16753 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16754 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16755 (org-defkey org-columns-map "<" 'org-columns-narrow)
16756 (org-defkey org-columns-map ">" 'org-columns-widen)
16757 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16758 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16759 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16760 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16762 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16763 '("Column"
16764 ["Edit property" org-columns-edit-value t]
16765 ["Next allowed value" org-columns-next-allowed-value t]
16766 ["Previous allowed value" org-columns-previous-allowed-value t]
16767 ["Show full value" org-columns-show-value t]
16768 ["Edit allowed values" org-columns-edit-allowed t]
16769 "--"
16770 ["Edit column attributes" org-columns-edit-attributes t]
16771 ["Increase column width" org-columns-widen t]
16772 ["Decrease column width" org-columns-narrow t]
16773 "--"
16774 ["Move column right" org-columns-move-right t]
16775 ["Move column left" org-columns-move-left t]
16776 ["Add column" org-columns-new t]
16777 ["Delete column" org-columns-delete t]
16778 "--"
16779 ["CONTENTS" org-columns-content t]
16780 ["OVERVIEW" org-overview t]
16781 ["Refresh columns display" org-columns-redo t]
16782 "--"
16783 ["Open link" org-columns-open-link t]
16784 "--"
16785 ["Quit" org-columns-quit t]))
16787 (defun org-columns-new-overlay (beg end &optional string face)
16788 "Create a new column overlay and add it to the list."
16789 (let ((ov (org-make-overlay beg end)))
16790 (org-overlay-put ov 'face (or face 'secondary-selection))
16791 (org-overlay-display ov string face)
16792 (push ov org-columns-overlays)
16793 ov))
16795 (defun org-columns-display-here (&optional props)
16796 "Overlay the current line with column display."
16797 (interactive)
16798 (let* ((fmt org-columns-current-fmt-compiled)
16799 (beg (point-at-bol))
16800 (level-face (save-excursion
16801 (beginning-of-line 1)
16803 (org-get-level-face 2))))
16804 (color (list :foreground
16805 (face-attribute (or level-face 'default) :foreground)))
16806 props pom property ass width f string ov column val modval)
16807 ;; Check if the entry is in another buffer.
16808 (unless props
16809 (if (eq major-mode 'org-agenda-mode)
16810 (setq pom (or (get-text-property (point) 'org-hd-marker)
16811 (get-text-property (point) 'org-marker))
16812 props (if pom (org-entry-properties pom) nil))
16813 (setq props (org-entry-properties nil))))
16814 ;; Walk the format
16815 (while (setq column (pop fmt))
16816 (setq property (car column)
16817 ass (if (equal property "ITEM")
16818 (cons "ITEM"
16819 (save-match-data
16820 (org-no-properties
16821 (org-remove-tabs
16822 (buffer-substring-no-properties
16823 (point-at-bol) (point-at-eol))))))
16824 (assoc property props))
16825 width (or (cdr (assoc property org-columns-current-maxwidths))
16826 (nth 2 column)
16827 (length property))
16828 f (format "%%-%d.%ds | " width width)
16829 val (or (cdr ass) "")
16830 modval (if (equal property "ITEM")
16831 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16832 string (format f (or modval val)))
16833 ;; Create the overlay
16834 (org-unmodified
16835 (setq ov (org-columns-new-overlay
16836 beg (setq beg (1+ beg)) string
16837 (list color 'org-column)))
16838 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16839 (org-overlay-put ov 'keymap org-columns-map)
16840 (org-overlay-put ov 'org-columns-key property)
16841 (org-overlay-put ov 'org-columns-value (cdr ass))
16842 (org-overlay-put ov 'org-columns-value-modified modval)
16843 (org-overlay-put ov 'org-columns-pom pom)
16844 (org-overlay-put ov 'org-columns-format f))
16845 (if (or (not (char-after beg))
16847 (let ((inhibit-read-only t))
16848 (save-excursion
16849 (goto-char beg)
16850 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16851 ;; Make the rest of the line disappear.
16852 (org-unmodified
16853 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16854 (org-overlay-put ov 'invisible t)
16855 (org-overlay-put ov 'keymap org-columns-map)
16856 (org-overlay-put ov 'intangible t)
16857 (push ov org-columns-overlays)
16858 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16859 (org-overlay-put ov 'keymap org-columns-map)
16860 (push ov org-columns-overlays)
16861 (let ((inhibit-read-only t))
16862 (put-text-property (max (point-min) (1- (point-at-bol)))
16863 (min (point-max) (1+ (point-at-eol)))
16864 'read-only "Type `e' to edit property")))))
16866 (defvar org-previous-header-line-format nil
16867 "The header line format before column view was turned on.")
16868 (defvar org-columns-inhibit-recalculation nil
16869 "Inhibit recomputing of columns on column view startup.")
16872 (defvar header-line-format)
16873 (defun org-columns-display-here-title ()
16874 "Overlay the newline before the current line with the table title."
16875 (interactive)
16876 (let ((fmt org-columns-current-fmt-compiled)
16877 string (title "")
16878 property width f column str widths)
16879 (while (setq column (pop fmt))
16880 (setq property (car column)
16881 str (or (nth 1 column) property)
16882 width (or (cdr (assoc property org-columns-current-maxwidths))
16883 (nth 2 column)
16884 (length str))
16885 widths (push width widths)
16886 f (format "%%-%d.%ds | " width width)
16887 string (format f str)
16888 title (concat title string)))
16889 (setq title (concat
16890 (org-add-props " " nil 'display '(space :align-to 0))
16891 (org-add-props title nil 'face '(:weight bold :underline t))))
16892 (org-set-local 'org-previous-header-line-format header-line-format)
16893 (org-set-local 'org-columns-current-widths (nreverse widths))
16894 (setq header-line-format title)))
16896 (defun org-columns-remove-overlays ()
16897 "Remove all currently active column overlays."
16898 (interactive)
16899 (when (marker-buffer org-columns-begin-marker)
16900 (with-current-buffer (marker-buffer org-columns-begin-marker)
16901 (when (local-variable-p 'org-previous-header-line-format)
16902 (setq header-line-format org-previous-header-line-format)
16903 (kill-local-variable 'org-previous-header-line-format))
16904 (move-marker org-columns-begin-marker nil)
16905 (move-marker org-columns-top-level-marker nil)
16906 (org-unmodified
16907 (mapc 'org-delete-overlay org-columns-overlays)
16908 (setq org-columns-overlays nil)
16909 (let ((inhibit-read-only t))
16910 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16912 (defun org-columns-cleanup-item (item fmt)
16913 "Remove from ITEM what is a column in the format FMT."
16914 (if (not org-complex-heading-regexp)
16915 item
16916 (when (string-match org-complex-heading-regexp item)
16917 (concat
16918 (org-add-props (concat (match-string 1 item) " ") nil
16919 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16920 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16921 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16922 " " (match-string 4 item)
16923 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16925 (defun org-columns-show-value ()
16926 "Show the full value of the property."
16927 (interactive)
16928 (let ((value (get-char-property (point) 'org-columns-value)))
16929 (message "Value is: %s" (or value ""))))
16931 (defun org-columns-quit ()
16932 "Remove the column overlays and in this way exit column editing."
16933 (interactive)
16934 (org-unmodified
16935 (org-columns-remove-overlays)
16936 (let ((inhibit-read-only t))
16937 (remove-text-properties (point-min) (point-max) '(read-only t))))
16938 (when (eq major-mode 'org-agenda-mode)
16939 (message
16940 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16942 (defun org-columns-check-computed ()
16943 "Check if this column value is computed.
16944 If yes, throw an error indicating that changing it does not make sense."
16945 (let ((val (get-char-property (point) 'org-columns-value)))
16946 (when (and (stringp val)
16947 (get-char-property 0 'org-computed val))
16948 (error "This value is computed from the entry's children"))))
16950 (defun org-columns-todo (&optional arg)
16951 "Change the TODO state during column view."
16952 (interactive "P")
16953 (org-columns-edit-value "TODO"))
16955 (defun org-columns-set-tags-or-toggle (&optional arg)
16956 "Toggle checkbox at point, or set tags for current headline."
16957 (interactive "P")
16959 (get-char-property (point) 'org-columns-value))
16960 (org-columns-next-allowed-value)
16961 (org-columns-edit-value "TAGS")))
16963 (defun org-columns-edit-value (&optional key)
16964 "Edit the value of the property at point in column view.
16965 Where possible, use the standard interface for changing this line."
16966 (interactive)
16967 (org-columns-check-computed)
16968 (let* ((external-key key)
16969 (col (current-column))
16970 (key (or key (get-char-property (point) 'org-columns-key)))
16971 (value (get-char-property (point) 'org-columns-value))
16972 (bol (point-at-bol)) (eol (point-at-eol))
16973 (pom (or (get-text-property bol 'org-hd-marker)
16974 (point))) ; keep despite of compiler waring
16975 (line-overlays
16976 (delq nil (mapcar (lambda (x)
16977 (and (eq (overlay-buffer x) (current-buffer))
16978 (>= (overlay-start x) bol)
16979 (<= (overlay-start x) eol)
16980 x))
16981 org-columns-overlays)))
16982 nval eval allowed)
16983 (cond
16984 ((equal key "CLOCKSUM")
16985 (error "This special column cannot be edited"))
16986 ((equal key "ITEM")
16987 (setq eval '(org-with-point-at pom
16988 (org-edit-headline))))
16989 ((equal key "TODO")
16990 (setq eval '(org-with-point-at pom
16991 (let ((current-prefix-arg
16992 (if external-key current-prefix-arg '(4))))
16993 (call-interactively 'org-todo)))))
16994 ((equal key "PRIORITY")
16995 (setq eval '(org-with-point-at pom
16996 (call-interactively 'org-priority))))
16997 ((equal key "TAGS")
16998 (setq eval '(org-with-point-at pom
16999 (let ((org-fast-tag-selection-single-key
17000 (if (eq org-fast-tag-selection-single-key 'expert)
17001 t org-fast-tag-selection-single-key)))
17002 (call-interactively 'org-set-tags)))))
17003 ((equal key "DEADLINE")
17004 (setq eval '(org-with-point-at pom
17005 (call-interactively 'org-deadline))))
17006 ((equal key "SCHEDULED")
17007 (setq eval '(org-with-point-at pom
17008 (call-interactively 'org-schedule))))
17009 (t
17010 (setq allowed (org-property-get-allowed-values pom key 'table))
17011 (if allowed
17012 (setq nval (completing-read "Value: " allowed nil t))
17013 (setq nval (read-string "Edit: " value)))
17014 (setq nval (org-trim nval))
17015 (when (not (equal nval value))
17016 (setq eval '(org-entry-put pom key nval)))))
17017 (when eval
17018 (let ((inhibit-read-only t))
17019 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
17020 (unwind-protect
17021 (progn
17022 (setq org-columns-overlays
17023 (org-delete-all line-overlays org-columns-overlays))
17024 (mapc 'org-delete-overlay line-overlays)
17025 (org-columns-eval eval))
17026 (org-columns-display-here))))
17027 (move-to-column col)
17028 (if (and (org-mode-p)
17029 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17030 (org-columns-update key))))
17032 (defun org-edit-headline () ; FIXME: this is not columns specific
17033 "Edit the current headline, the part without TODO keyword, TAGS."
17034 (org-back-to-heading)
17035 (when (looking-at org-todo-line-regexp)
17036 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
17037 (txt (match-string 3))
17038 (post "")
17039 txt2)
17041 (setq post (match-string 0 txt)
17042 txt (substring txt 0 (match-beginning 0))))
17043 (setq txt2 (read-string "Edit: " txt))
17044 (when (not (equal txt txt2))
17045 (beginning-of-line 1)
17046 (insert pre txt2 post)
17047 (delete-region (point) (point-at-eol))
17048 (org-set-tags nil t)))))
17050 (defun org-columns-edit-allowed ()
17051 "Edit the list of allowed values for the current property."
17052 (interactive)
17053 (let* ((key (get-char-property (point) 'org-columns-key))
17054 (key1 (concat key "_ALL"))
17055 (allowed (org-entry-get (point) key1 t))
17056 nval)
17057 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
17058 (setq nval (read-string "Allowed: " allowed))
17059 (org-entry-put
17060 (cond ((marker-position org-entry-property-inherited-from)
17061 org-entry-property-inherited-from)
17062 ((marker-position org-columns-top-level-marker)
17063 org-columns-top-level-marker))
17064 key1 nval)))
17066 (defmacro org-no-warnings (&rest body)
17067 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
17069 (defun org-columns-eval (form)
17070 (let (hidep)
17071 (save-excursion
17072 (beginning-of-line 1)
17073 ;; `next-line' is needed here, because it skips invisible line.
17074 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
17075 (setq hidep (org-on-heading-p 1)))
17076 (eval form)
17077 (and hidep (hide-entry))))
17079 (defun org-columns-previous-allowed-value ()
17080 "Switch to the previous allowed value for this column."
17081 (interactive)
17082 (org-columns-next-allowed-value t))
17084 (defun org-columns-next-allowed-value (&optional previous)
17085 "Switch to the next allowed value for this column."
17086 (interactive)
17087 (org-columns-check-computed)
17088 (let* ((col (current-column))
17089 (key (get-char-property (point) 'org-columns-key))
17090 (value (get-char-property (point) 'org-columns-value))
17091 (bol (point-at-bol)) (eol (point-at-eol))
17092 (pom (or (get-text-property bol 'org-hd-marker)
17093 (point))) ; keep despite of compiler waring
17094 (line-overlays
17095 (delq nil (mapcar (lambda (x)
17096 (and (eq (overlay-buffer x) (current-buffer))
17097 (>= (overlay-start x) bol)
17098 (<= (overlay-start x) eol)
17099 x))
17100 org-columns-overlays)))
17101 (allowed (or (org-property-get-allowed-values pom key)
17102 (and (memq
17103 (nth 4 (assoc key org-columns-current-fmt-compiled))
17104 '(checkbox checkbox-n-of-m checkbox-percent))
17105 '("[ ]" "[X]"))))
17106 nval)
17107 (when (equal key "ITEM")
17108 (error "Cannot edit item headline from here"))
17109 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
17110 (error "Allowed values for this property have not been defined"))
17111 (if (member key '("SCHEDULED" "DEADLINE"))
17112 (setq nval (if previous 'earlier 'later))
17113 (if previous (setq allowed (reverse allowed)))
17114 (if (member value allowed)
17115 (setq nval (car (cdr (member value allowed)))))
17116 (setq nval (or nval (car allowed)))
17117 (if (equal nval value)
17118 (error "Only one allowed value for this property")))
17119 (let ((inhibit-read-only t))
17120 (remove-text-properties (1- bol) eol '(read-only t))
17121 (unwind-protect
17122 (progn
17123 (setq org-columns-overlays
17124 (org-delete-all line-overlays org-columns-overlays))
17125 (mapc 'org-delete-overlay line-overlays)
17126 (org-columns-eval '(org-entry-put pom key nval)))
17127 (org-columns-display-here)))
17128 (move-to-column col)
17129 (if (and (org-mode-p)
17130 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17131 (org-columns-update key))))
17133 (defun org-verify-version (task)
17134 (cond
17135 ((eq task 'columns)
17136 (if (or (featurep 'xemacs)
17137 (< emacs-major-version 22))
17138 (error "Emacs 22 is required for the columns feature")))))
17140 (defun org-columns-open-link (&optional arg)
17141 (interactive "P")
17142 (let ((value (get-char-property (point) 'org-columns-value)))
17143 (org-open-link-from-string value arg)))
17145 (defun org-open-link-from-string (s &optional arg)
17146 "Open a link in the string S, as if it was in Org-mode."
17147 (interactive)
17148 (with-temp-buffer
17149 (let ((org-inhibit-startup t))
17150 (org-mode)
17151 (insert s)
17152 (goto-char (point-min))
17153 (org-open-at-point arg))))
17155 (defun org-columns-get-format-and-top-level ()
17156 (let (fmt)
17157 (when (condition-case nil (org-back-to-heading) (error nil))
17158 (move-marker org-entry-property-inherited-from nil)
17159 (setq fmt (org-entry-get nil "COLUMNS" t)))
17160 (setq fmt (or fmt org-columns-default-format))
17161 (org-set-local 'org-columns-current-fmt fmt)
17162 (org-columns-compile-format fmt)
17163 (if (marker-position org-entry-property-inherited-from)
17164 (move-marker org-columns-top-level-marker
17165 org-entry-property-inherited-from)
17166 (move-marker org-columns-top-level-marker (point)))
17167 fmt))
17169 (defun org-columns ()
17170 "Turn on column view on an org-mode file."
17171 (interactive)
17172 (org-verify-version 'columns)
17173 (org-columns-remove-overlays)
17174 (move-marker org-columns-begin-marker (point))
17175 (let (beg end fmt cache maxwidths)
17176 (setq fmt (org-columns-get-format-and-top-level))
17177 (save-excursion
17178 (goto-char org-columns-top-level-marker)
17179 (setq beg (point))
17180 (unless org-columns-inhibit-recalculation
17181 (org-columns-compute-all))
17182 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
17183 (point-max)))
17184 ;; Get and cache the properties
17185 (goto-char beg)
17186 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
17187 (save-excursion
17188 (save-restriction
17189 (narrow-to-region beg end)
17190 (org-clock-sum))))
17191 (while (re-search-forward (concat "^" outline-regexp) end t)
17192 (push (cons (org-current-line) (org-entry-properties)) cache))
17193 (when cache
17194 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17195 (org-set-local 'org-columns-current-maxwidths maxwidths)
17196 (org-columns-display-here-title)
17197 (mapc (lambda (x)
17198 (goto-line (car x))
17199 (org-columns-display-here (cdr x)))
17200 cache)))))
17202 (defun org-columns-new (&optional prop title width op fmt &rest rest)
17203 "Insert a new column, to the leeft o the current column."
17204 (interactive)
17205 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
17206 cell)
17207 (setq prop (completing-read
17208 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
17209 nil nil prop))
17210 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
17211 (setq width (read-string "Column width: " (if width (number-to-string width))))
17213 (setq width (string-to-number width))
17214 (setq width nil))
17215 (setq fmt (completing-read "Summary [none]: "
17216 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
17217 nil t))
17219 (setq fmt (intern fmt))
17220 (setq fmt nil))
17221 (if (eq fmt 'none) (setq fmt nil))
17222 (if editp
17223 (progn
17224 (setcar editp prop)
17225 (setcdr editp (list title width nil fmt)))
17226 (setq cell (nthcdr (1- (current-column))
17227 org-columns-current-fmt-compiled))
17228 (setcdr cell (cons (list prop title width nil fmt)
17229 (cdr cell))))
17230 (org-columns-store-format)
17231 (org-columns-redo)))
17233 (defun org-columns-delete ()
17234 "Delete the column at point from columns view."
17235 (interactive)
17236 (let* ((n (current-column))
17237 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
17238 (when (y-or-n-p
17240 (setq org-columns-current-fmt-compiled
17241 (delq (nth n org-columns-current-fmt-compiled)
17242 org-columns-current-fmt-compiled))
17243 (org-columns-store-format)
17244 (org-columns-redo)
17245 (if (>= (current-column) (length org-columns-current-fmt-compiled))
17246 (backward-char 1)))))
17248 (defun org-columns-edit-attributes ()
17249 "Edit the attributes of the current column."
17250 (interactive)
17251 (let* ((n (current-column))
17252 (info (nth n org-columns-current-fmt-compiled)))
17253 (apply 'org-columns-new info)))
17255 (defun org-columns-widen (arg)
17256 "Make the column wider by ARG characters."
17257 (interactive "p")
17258 (let* ((n (current-column))
17259 (entry (nth n org-columns-current-fmt-compiled))
17260 (width (or (nth 2 entry)
17261 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
17262 (setq width (max 1 (+ width arg)))
17263 (setcar (nthcdr 2 entry) width)
17264 (org-columns-store-format)
17265 (org-columns-redo)))
17267 (defun org-columns-narrow (arg)
17268 "Make the column nrrower by ARG characters."
17269 (interactive "p")
17270 (org-columns-widen (- arg)))
17272 (defun org-columns-move-right ()
17273 "Swap this column with the one to the right."
17274 (interactive)
17275 (let* ((n (current-column))
17276 (cell (nthcdr n org-columns-current-fmt-compiled))
17277 e)
17278 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17279 (error "Cannot shift this column further to the right"))
17280 (setq e (car cell))
17281 (setcar cell (car (cdr cell)))
17282 (setcdr cell (cons e (cdr (cdr cell))))
17283 (org-columns-store-format)
17284 (org-columns-redo)
17285 (forward-char 1)))
17287 (defun org-columns-move-left ()
17288 "Swap this column with the one to the left."
17289 (interactive)
17290 (let* ((n (current-column)))
17291 (when (= n 0)
17292 (error "Cannot shift this column further to the left"))
17293 (backward-char 1)
17294 (org-columns-move-right)
17295 (backward-char 1)))
17297 (defun org-columns-store-format ()
17298 "Store the text version of the current columns format in appropriate place.
17299 This is either in the COLUMNS property of the node starting the current column
17300 display, or in the #+COLUMNS line of the current buffer."
17301 (let (fmt (cnt 0))
17302 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17303 (org-set-local 'org-columns-current-fmt fmt)
17304 (if (marker-position org-columns-top-level-marker)
17305 (save-excursion
17306 (goto-char org-columns-top-level-marker)
17307 (if (and (org-at-heading-p)
17308 (org-entry-get nil "COLUMNS"))
17309 (org-entry-put nil "COLUMNS" fmt)
17310 (goto-char (point-min))
17311 ;; Overwrite all #+COLUMNS lines....
17313 (setq cnt (1+ cnt))
17314 (replace-match (concat "#+COLUMNS: " fmt) t t))
17315 (unless (> cnt 0)
17316 (goto-char (point-min))
17317 (or (org-on-heading-p t) (outline-next-heading))
17318 (let ((inhibit-read-only t))
17320 (org-set-local 'org-columns-default-format fmt))))))
17322 (defvar org-overriding-columns-format nil
17323 "When set, overrides any other definition.")
17324 (defvar org-agenda-view-columns-initially nil
17325 "When set, switch to columns view immediately after creating the agenda.")
17327 (defun org-agenda-columns ()
17328 "Turn on column view in the agenda."
17329 (interactive)
17330 (org-verify-version 'columns)
17331 (org-columns-remove-overlays)
17332 (move-marker org-columns-begin-marker (point))
17333 (let (fmt cache maxwidths m)
17334 (cond
17335 ((and (local-variable-p 'org-overriding-columns-format)
17336 org-overriding-columns-format)
17337 (setq fmt org-overriding-columns-format))
17338 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17339 (setq fmt (org-entry-get m "COLUMNS" t)))
17340 ((and (boundp 'org-columns-current-fmt)
17341 (local-variable-p 'org-columns-current-fmt)
17342 org-columns-current-fmt)
17343 (setq fmt org-columns-current-fmt))
17344 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17345 (setq m (get-text-property m 'org-hd-marker))
17346 (setq fmt (org-entry-get m "COLUMNS" t))))
17347 (setq fmt (or fmt org-columns-default-format))
17348 (org-set-local 'org-columns-current-fmt fmt)
17349 (org-columns-compile-format fmt)
17350 (save-excursion
17351 ;; Get and cache the properties
17352 (goto-char (point-min))
17353 (while (not (eobp))
17354 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17355 (get-text-property (point) 'org-marker)))
17356 (push (cons (org-current-line) (org-entry-properties m)) cache))
17357 (beginning-of-line 2))
17358 (when cache
17359 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17360 (org-set-local 'org-columns-current-maxwidths maxwidths)
17361 (org-columns-display-here-title)
17362 (mapc (lambda (x)
17363 (goto-line (car x))
17364 (org-columns-display-here (cdr x)))
17365 cache)))))
17367 (defun org-columns-get-autowidth-alist (s cache)
17368 "Derive the maximum column widths from the format and the cache."
17369 (let ((start 0) rtn)
17371 (push (cons (match-string 1 s) 1) rtn)
17372 (setq start (match-end 0)))
17373 (mapc (lambda (x)
17374 (setcdr x (apply 'max
17375 (mapcar
17376 (lambda (y)
17377 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17378 cache))))
17379 rtn)
17380 rtn))
17382 (defun org-columns-compute-all ()
17383 "Compute all columns that have operators defined."
17384 (org-unmodified
17385 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17386 (let ((columns org-columns-current-fmt-compiled) col)
17387 (while (setq col (pop columns))
17388 (when (nth 3 col)
17389 (save-excursion
17390 (org-columns-compute (car col)))))))
17392 (defun org-columns-update (property)
17393 "Recompute PROPERTY, and update the columns display for it."
17394 (org-columns-compute property)
17395 (let (fmt val pos)
17396 (save-excursion
17397 (mapc (lambda (ov)
17398 (when (equal (org-overlay-get ov 'org-columns-key) property)
17399 (setq pos (org-overlay-start ov))
17400 (goto-char pos)
17401 (when (setq val (cdr (assoc property
17402 (get-text-property
17403 (point-at-bol) 'org-summaries))))
17404 (setq fmt (org-overlay-get ov 'org-columns-format))
17405 (org-overlay-put ov 'org-columns-value val)
17406 (org-overlay-put ov 'display (format fmt val)))))
17407 org-columns-overlays))))
17409 (defun org-columns-compute (property)
17410 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17411 (interactive)
17412 (let* ((re (concat "^" outline-regexp))
17413 (lmax 30) ; Does anyone use deeper levels???
17414 (lsum (make-vector lmax 0))
17415 (lflag (make-vector lmax nil))
17416 (level 0)
17417 (ass (assoc property org-columns-current-fmt-compiled))
17418 (format (nth 4 ass))
17419 (printf (nth 5 ass))
17420 (beg org-columns-top-level-marker)
17421 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17422 (save-excursion
17423 ;; Find the region to compute
17424 (goto-char beg)
17425 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17426 (goto-char end)
17427 ;; Walk the tree from the back and do the computations
17428 (while (re-search-backward re beg t)
17429 (setq sumpos (match-beginning 0)
17430 last-level level
17431 level (org-outline-level)
17432 val (org-entry-get nil property)
17434 (cond
17435 ((< level last-level)
17436 ;; put the sum of lower levels here as a property
17437 (setq sum (aref lsum last-level) ; current sum
17438 flag (aref lflag last-level) ; any valid entries from children?
17439 str (org-column-number-to-string sum format printf)
17440 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17441 useval (if flag str1 (if valflag val ""))
17442 sum-alist (get-text-property sumpos 'org-summaries))
17443 (if (assoc property sum-alist)
17444 (setcdr (assoc property sum-alist) useval)
17445 (push (cons property useval) sum-alist)
17446 (org-unmodified
17447 (add-text-properties sumpos (1+ sumpos)
17448 (list 'org-summaries sum-alist))))
17449 (when val
17450 (org-entry-put nil property (if flag str val)))
17451 ;; add current to current level accumulator
17452 (when (or flag valflag)
17453 (aset lsum level (+ (aref lsum level)
17454 (if flag sum (org-column-string-to-number
17455 (if flag str val) format))))
17456 (aset lflag level t))
17457 ;; clear accumulators for deeper levels
17458 (loop for l from (1+ level) to (1- lmax) do
17459 (aset lsum l 0)
17460 (aset lflag l nil)))
17461 ((>= level last-level)
17462 ;; add what we have here to the accumulator for this level
17463 (aset lsum level (+ (aref lsum level)
17464 (org-column-string-to-number (or val "0") format)))
17465 (and valflag (aset lflag level t)))
17466 (t (error "This should not happen")))))))
17468 (defun org-columns-redo ()
17469 "Construct the column display again."
17470 (interactive)
17471 (message "Recomputing columns...")
17472 (save-excursion
17473 (if (marker-position org-columns-begin-marker)
17474 (goto-char org-columns-begin-marker))
17475 (org-columns-remove-overlays)
17476 (if (org-mode-p)
17477 (call-interactively 'org-columns)
17478 (call-interactively 'org-agenda-columns)))
17479 (message "Recomputing columns...done"))
17481 (defun org-columns-not-in-agenda ()
17482 (if (eq major-mode 'org-agenda-mode)
17483 (error "This command is only allowed in Org-mode buffers")))
17486 (defun org-string-to-number (s)
17487 "Convert string to number, and interpret hh:mm:ss."
17488 (if (not (string-match ":" s))
17489 (string-to-number s)
17490 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17491 (while l
17492 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17493 sum)))
17495 (defun org-column-number-to-string (n fmt &optional printf)
17496 "Convert a computed column number to a string value, according to FMT."
17497 (cond
17498 ((eq fmt 'add_times)
17499 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17500 (format "%d:%02d" h m)))
17501 ((eq fmt 'checkbox)
17502 (cond ((= n (floor n)) "[X]")
17503 ((> n 1.) "[-]")
17504 (t "[ ]")))
17505 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17506 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17507 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17508 (printf (format printf n))
17509 ((eq fmt 'currency)
17510 (format "%.2f" n))
17511 (t (number-to-string n))))
17513 (defun org-nofm-to-completion (n m &optional percent)
17514 (if (not percent)
17515 (format "[%d/%d]" n m)
17516 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17518 (defun org-column-string-to-number (s fmt)
17519 "Convert a column value to a number that can be used for column computing."
17520 (cond
17521 ((string-match ":" s)
17522 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17523 (while l
17524 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17525 sum))
17526 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17527 (if (equal s "[X]") 1. 0.000001))
17528 (t (string-to-number s))))
17530 (defun org-columns-uncompile-format (cfmt)
17531 "Turn the compiled columns format back into a string representation."
17532 (let ((rtn "") e s prop title op width fmt printf)
17533 (while (setq e (pop cfmt))
17534 (setq prop (car e)
17535 title (nth 1 e)
17536 width (nth 2 e)
17537 op (nth 3 e)
17538 fmt (nth 4 e)
17539 printf (nth 5 e))
17540 (cond
17541 ((eq fmt 'add_times) (setq op ":"))
17542 ((eq fmt 'checkbox) (setq op "X"))
17543 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17544 ((eq fmt 'checkbox-percent) (setq op "X%"))
17545 ((eq fmt 'add_numbers) (setq op "+"))
17546 ((eq fmt 'currency) (setq op "$")))
17547 (if (and op printf) (setq op (concat op ";" printf)))
17548 (if (equal title prop) (setq title nil))
17549 (setq s (concat "%" (if width (number-to-string width))
17550 prop
17551 (if title (concat "(" title ")"))
17552 (if op (concat "{" op "}"))))
17553 (setq rtn (concat rtn " " s)))
17554 (org-trim rtn)))
17556 (defun org-columns-compile-format (fmt)
17557 "Turn a column format string into an alist of specifications.
17558 The alist has one entry for each column in the format. The elements of
17559 that list are:
17560 property the property
17561 title the title field for the columns
17562 width the column width in characters, can be nil for automatic
17563 operator the operator if any
17564 format the output format for computed results, derived from operator
17565 printf a printf format for computed values"
17566 (let ((start 0) width prop title op f printf)
17567 (setq org-columns-current-fmt-compiled nil)
17568 (while (string-match
17569 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17570 fmt start)
17571 (setq start (match-end 0)
17572 width (match-string 1 fmt)
17573 prop (match-string 2 fmt)
17574 title (or (match-string 3 fmt) prop)
17575 op (match-string 4 fmt)
17576 f nil
17577 printf nil)
17578 (if width (setq width (string-to-number width)))
17579 (when (and op (string-match ";" op))
17580 (setq printf (substring op (match-end 0))
17581 op (substring op 0 (match-beginning 0))))
17582 (cond
17583 ((equal op "+") (setq f 'add_numbers))
17584 ((equal op "$") (setq f 'currency))
17585 ((equal op ":") (setq f 'add_times))
17586 ((equal op "X") (setq f 'checkbox))
17587 ((equal op "X/") (setq f 'checkbox-n-of-m))
17588 ((equal op "X%") (setq f 'checkbox-percent))
17589 )
17590 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17591 (setq org-columns-current-fmt-compiled
17592 (nreverse org-columns-current-fmt-compiled))))
17595 ;;; Dynamic block for Column view
17597 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
17598 "Get the column view of the current buffer or subtree.
17599 The first optional argument MAXLEVEL sets the level limit. A
17600 second optional argument SKIP-EMPTY-ROWS tells whether to skip
17601 empty rows, an empty row being one where all the column view
17602 specifiers except ITEM are empty. This function returns a list
17603 containing the title row and all other rows. Each row is a list
17604 of fields."
17605 (save-excursion
17606 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17607 (n (length title)) row tbl)
17608 (goto-char (point-min))
17610 (or (null maxlevel)
17611 (>= maxlevel
17612 (if org-odd-levels-only
17613 (/ (1+ (length (match-string 1))) 2)
17614 (length (match-string 1))))))
17615 (when (get-char-property (match-beginning 0) 'org-columns-key)
17616 (setq row nil)
17617 (loop for i from 0 to (1- n) do
17618 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17619 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17620 "")
17621 row))
17622 (setq row (nreverse row))
17623 (unless (and skip-empty-rows
17624 (eq 1 (length (delete "" (delete-dups row)))))
17625 (push row tbl))))
17626 (append (list title 'hline) (nreverse tbl)))))
17628 (defun org-dblock-write:columnview (params)
17629 "Write the column view table.
17630 PARAMS is a property list of parameters:
17632 :width enforce same column widths with <N> specifiers.
17633 :id the :ID: property of the entry where the columns view
17634 should be built, as a string. When `local', call locally.
17635 When `global' call column view with the cursor at the beginning
17636 of the buffer (usually this means that the whole buffer switches
17637 to column view).
17638 :hlines When t, insert a hline before each item. When a number, insert
17639 a hline before each level <= that number.
17640 :vlines When t, make each column a colgroup to enforce vertical lines.
17641 :maxlevel When set to a number, don't capture headlines below this level.
17642 :skip-empty-rows
17643 When t, skip rows where all specifiers other than ITEM are empty."
17644 (let ((pos (move-marker (make-marker) (point)))
17645 (hlines (plist-get params :hlines))
17646 (vlines (plist-get params :vlines))
17647 (maxlevel (plist-get params :maxlevel))
17648 (skip-empty-rows (plist-get params :skip-empty-rows))
17649 tbl id idpos nfields tmp)
17650 (save-excursion
17651 (save-restriction
17652 (when (setq id (plist-get params :id))
17653 (cond ((not id) nil)
17654 ((eq id 'global) (goto-char (point-min)))
17655 ((eq id 'local) nil)
17656 ((setq idpos (org-find-entry-with-id id))
17657 (goto-char idpos))
17658 (t (error "Cannot find entry with :ID: %s" id))))
17659 (org-columns)
17660 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
17661 (setq nfields (length (car tbl)))
17662 (org-columns-quit)))
17663 (goto-char pos)
17664 (move-marker pos nil)
17665 (when tbl
17666 (when (plist-get params :hlines)
17667 (setq tmp nil)
17668 (while tbl
17669 (if (eq (car tbl) 'hline)
17670 (push (pop tbl) tmp)
17672 (if (and (not (eq (car tmp) 'hline))
17673 (or (eq hlines t)
17674 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17675 (push 'hline tmp)))
17676 (push (pop tbl) tmp)))
17677 (setq tbl (nreverse tmp)))
17678 (when vlines
17679 (setq tbl (mapcar (lambda (x)
17680 (if (eq 'hline x) x (cons "" x)))
17681 tbl))
17682 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17683 (setq pos (point))
17684 (insert (org-listtable-to-string tbl))
17685 (when (plist-get params :width)
17687 org-columns-current-widths "|")))
17688 (goto-char pos)
17689 (org-table-align))))
17691 (defun org-listtable-to-string (tbl)
17692 "Convert a listtable TBL to a string that contains the Org-mode table.
17693 The table still need to be alligned. The resulting string has no leading
17694 and tailing newline characters."
17695 (mapconcat
17696 (lambda (x)
17697 (cond
17698 ((listp x)
17699 (concat "|" (mapconcat 'identity x "|") "|"))
17700 ((eq x 'hline) "|-|")
17701 (t (error "Garbage in listtable: %s" x))))
17704 (defun org-insert-columns-dblock ()
17705 "Create a dynamic block capturing a column view table."
17706 (interactive)
17707 (let ((defaults '(:name "columnview" :hlines 1))
17708 (id (completing-read
17709 "Capture columns (local, global, entry with :ID: property) [local]: "
17710 (append '(("global") ("local"))
17711 (mapcar 'list (org-property-values "ID"))))))
17712 (if (equal id "") (setq id 'local))
17713 (if (equal id "global") (setq id 'global))
17714 (setq defaults (append defaults (list :id id)))
17715 (org-create-dblock defaults)
17716 (org-update-dblock)))
17718 ;;;; Timestamps
17720 (defvar org-last-changed-timestamp nil)
17721 (defvar org-time-was-given) ; dynamically scoped parameter
17722 (defvar org-end-time-was-given) ; dynamically scoped parameter
17723 (defvar org-ts-what) ; dynamically scoped parameter
17725 (defun org-time-stamp (arg)
17726 "Prompt for a date/time and insert a time stamp.
17727 If the user specifies a time like HH:MM, or if this command is called
17728 with a prefix argument, the time stamp will contain date and time.
17729 Otherwise, only the date will be included. All parts of a date not
17730 specified by the user will be filled in from the current date/time.
17731 So if you press just return without typing anything, the time stamp
17732 will represent the current date/time. If there is already a timestamp
17733 at the cursor, it will be modified."
17734 (interactive "P")
17735 (let* ((ts nil)
17736 (default-time
17737 ;; Default time is either today, or, when entering a range,
17738 ;; the range start.
17739 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17740 (save-excursion
17741 (re-search-backward
17743 (- (point) 20) t)))
17744 (apply 'encode-time (org-parse-time-string (match-string 1)))
17745 (current-time)))
17746 (default-input (and ts (org-get-compact-tod ts)))
17747 org-time-was-given org-end-time-was-given time)
17748 (cond
17749 ((and (org-at-timestamp-p)
17750 (eq last-command 'org-time-stamp)
17751 (eq this-command 'org-time-stamp))
17752 (insert "--")
17753 (setq time (let ((this-command this-command))
17754 (org-read-date arg 'totime nil nil default-time default-input)))
17755 (org-insert-time-stamp time (or org-time-was-given arg)))
17756 ((org-at-timestamp-p)
17757 (setq time (let ((this-command this-command))
17758 (org-read-date arg 'totime nil nil default-time default-input)))
17759 (when (org-at-timestamp-p) ; just to get the match data
17760 (replace-match "")
17761 (setq org-last-changed-timestamp
17762 (org-insert-time-stamp
17763 time (or org-time-was-given arg)
17764 nil nil nil (list org-end-time-was-given))))
17765 (message "Timestamp updated"))
17766 (t
17767 (setq time (let ((this-command this-command))
17768 (org-read-date arg 'totime nil nil default-time default-input)))
17769 (org-insert-time-stamp time (or org-time-was-given arg)
17770 nil nil nil (list org-end-time-was-given))))))
17772 ;; FIXME: can we use this for something else????
17773 ;; like computing time differences?????
17774 (defun org-get-compact-tod (s)
17775 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17776 (let* ((t1 (match-string 1 s))
17777 (h1 (string-to-number (match-string 2 s)))
17778 (m1 (string-to-number (match-string 3 s)))
17779 (t2 (and (match-end 4) (match-string 5 s)))
17780 (h2 (and t2 (string-to-number (match-string 6 s))))
17781 (m2 (and t2 (string-to-number (match-string 7 s))))
17782 dh dm)
17783 (if (not t2)
17784 t1
17785 (setq dh (- h2 h1) dm (- m2 m1))
17786 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17787 (concat t1 "+" (number-to-string dh)
17788 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17790 (defun org-time-stamp-inactive (&optional arg)
17791 "Insert an inactive time stamp.
17792 An inactive time stamp is enclosed in square brackets instead of angle
17793 brackets. It is inactive in the sense that it does not trigger agenda entries,
17794 does not link to the calendar and cannot be changed with the S-cursor keys.
17795 So these are more for recording a certain time/date."
17796 (interactive "P")
17797 (let (org-time-was-given org-end-time-was-given time)
17798 (setq time (org-read-date arg 'totime))
17799 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17800 nil nil (list org-end-time-was-given))))
17802 (defvar org-date-ovl (org-make-overlay 1 1))
17803 (org-overlay-put org-date-ovl 'face 'org-warning)
17804 (org-detach-overlay org-date-ovl)
17806 (defvar org-ans1) ; dynamically scoped parameter
17807 (defvar org-ans2) ; dynamically scoped parameter
17809 (defvar org-plain-time-of-day-regexp) ; defined below
17811 (defvar org-read-date-overlay nil)
17812 (defvar org-dcst nil) ; dynamically scoped
17814 (defun org-read-date (&optional with-time to-time from-string prompt
17815 default-time default-input)
17816 "Read a date, possibly a time, and make things smooth for the user.
17817 The prompt will suggest to enter an ISO date, but you can also enter anything
17818 which will at least partially be understood by `parse-time-string'.
17819 Unrecognized parts of the date will default to the current day, month, year,
17820 hour and minute. If this command is called to replace a timestamp at point,
17821 of to enter the second timestamp of a range, the default time is taken from the
17822 existing stamp. For example,
17823 3-2-5 --> 2003-02-05
17824 feb 15 --> currentyear-02-15
17825 sep 12 9 --> 2009-09-12
17826 12:45 --> today 12:45
17827 22 sept 0:34 --> currentyear-09-22 0:34
17828 12 --> currentyear-currentmonth-12
17829 Fri --> nearest Friday (today or later)
17830 etc.
17832 Furthermore you can specify a relative date by giving, as the *first* thing
17833 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17834 change in days weeks, months, years.
17835 With a single plus or minus, the date is relative to today. With a double
17836 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17837 +4d --> four days from today
17838 +4 --> same as above
17839 +2w --> two weeks from today
17840 ++5 --> five days from default date
17842 The function understands only English month and weekday abbreviations,
17843 but this can be configured with the variables `parse-time-months' and
17844 `parse-time-weekdays'.
17846 While prompting, a calendar is popped up - you can also select the
17847 date with the mouse (button 1). The calendar shows a period of three
17848 months. To scroll it to other months, use the keys `>' and `<'.
17849 If you don't like the calendar, turn it off with
17850 \(setq org-read-date-popup-calendar nil)
17852 With optional argument TO-TIME, the date will immediately be converted
17853 to an internal time.
17854 With an optional argument WITH-TIME, the prompt will suggest to also
17855 insert a time. Note that when WITH-TIME is not set, you can still
17856 enter a time, and this function will inform the calling routine about
17857 this change. The calling routine may then choose to change the format
17858 used to insert the time stamp into the buffer to include the time.
17859 With optional argument FROM-STRING, read from this string instead from
17860 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17861 the time/date that is used for everything that is not specified by the
17862 user."
17863 (require 'parse-time)
17864 (let* ((org-time-stamp-rounding-minutes
17865 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
17866 (org-dcst org-display-custom-times)
17867 (ct (org-current-time))
17868 (def (or default-time ct))
17869 (defdecode (decode-time def))
17870 (dummy (progn
17871 (when (< (nth 2 defdecode) org-extend-today-until)
17872 (setcar (nthcdr 2 defdecode) -1)
17873 (setcar (nthcdr 1 defdecode) 59)
17874 (setq def (apply 'encode-time defdecode)
17875 defdecode (decode-time def)))))
17876 (calendar-move-hook nil)
17877 (view-diary-entries-initially nil)
17878 (view-calendar-holidays-initially nil)
17879 (timestr (format-time-string
17880 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17881 (prompt (concat (if prompt (concat prompt " ") "")
17882 (format "Date+time [%s]: " timestr)))
17883 ans (org-ans0 "") org-ans1 org-ans2 final)
17885 (cond
17886 (from-string (setq ans from-string))
17887 (org-read-date-popup-calendar
17888 (save-excursion
17889 (save-window-excursion
17890 (calendar)
17891 (calendar-forward-day (- (time-to-days def)
17892 (calendar-absolute-from-gregorian
17893 (calendar-current-date))))
17894 (org-eval-in-calendar nil t)
17895 (let* ((old-map (current-local-map))
17896 (map (copy-keymap calendar-mode-map))
17897 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17898 (org-defkey map (kbd "RET") 'org-calendar-select)
17899 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17900 'org-calendar-select-mouse)
17938 ;; org-ans0: from prompt
17939 ;; org-ans1: from mouse click
17940 ;; org-ans2: from calendar motion
17968 "Display the currrent date prompt interpretation in the minibuffer."
17984 org-time-stamp-custom-formats
17985 org-time-stamp-formats))
17994 org-end-time-was-given
18001 "Analyze the combined answer of the date prompt."
18002 ;; FIXME: cleanup and comment
18004 hour minute second wday pm h2 m2 tl wday1)
18012 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
18022 t nil ans)))
18023 ;; Help matching am/pm times, because `parse-time-string' does not do that.
18024 ;; If there is a time with am/pm, and *no* time without it, we convert
18025 ;; so that matching will be successful.
18039 t t ans))))
18041 ;; Check if a time range is given as a duration
18042 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
18050 ;; Check if there is a time range
18084 ;; Weekday was given, but no day, so pick that day in the week
18085 ;; on or after the derived date.
18099 "Check string S for special relative date string.
18100 TODAY and DEFAULT are internal times, for today and for a default.
18101 Return shift list (N what def-flag)
18103 N is the number of WHATs to shift.
18104 DEF-FLAG is t when a double ++ or -- indicates shift relative to
18105 the DEFAULT date rather than TODAY."
18114 ?+))
18121 delta)
18131 "Eval FORM in the calendar window and return to current window.
18132 Also, store the cursor date in variable org-ans2."
18143 ; ;; Update the prompt to show new default date
18144 ; (save-excursion
18145 ; (goto-char (point-min))
18146 ; (when (and org-ans2
18147 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
18148 ; (get-text-property (match-end 0) 'field))
18149 ; (let ((inhibit-read-only t))
18150 ; (replace-match (concat "[" org-ans2 "]") t t)
18151 ; (add-text-properties (point-min) (1+ (match-end 0))
18152 ; (text-properties-at (1+ (point-min)))))))))
18155 "Return to `org-read-date' with the date currently selected.
18156 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18165 "Insert a date stamp for the date given by the internal TIME.
18166 WITH-HM means, use the stamp format that includes the time of the day.
18167 INACTIVE means use square brackets instead of angular ones, so that the
18168 stamp will not contribute to the agenda.
18169 PRE and POST are optional strings to be inserted before and after the
18170 stamp.
18171 The command returns the inserted time stamp."
18173 stamp)
18190 stamp))
18193 "Toggle the use of custom time stamp formats."
18214 "Overlay modified time stamp format over timestamp between BED and END."
18241 "Translate all timestamps in STRING to custom format.
18242 But do this only if the variable `org-display-custom-times' is set."
18247 t1 with-hm inactive tf time str beg end)
18256 org-time-stamp-custom-formats)
18265 string)
18268 "Set 0 instead of nil for the first 6 elements of time.
18269 Don't touch the rest."
18274 "Difference between TIMESTAMP-STRING and now in days."
18279 "Is the time in TIMESTAMP-STRING close to the current date?"
18285 "Get the deadline lead time appropriate for timestring TS."
18288 ;; 0 or negative, enforce this value no matter what
18291 ;; lead time is specified.
18296 ;; go for the default.
18300 "Return to `org-read-date' with the date currently selected.
18301 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18311 "Check if there are any deadlines due or past due.
18312 A deadline is considered due if it happens within `org-deadline-warning-days'
18313 days from today's date. If the deadline appears in an entry marked DONE,
18314 it is not shown. The prefix arg NDAYS can be used to test that many
18329 org-warn-days)))
18332 "Check if there are deadlines or scheduled entries before DATE."
18346 "Evaluate a time range by computing the difference between start and end.
18347 Normally the result is just printed in the echo area, but with prefix arg
18348 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18349 If the time range is actually in a table, the result is inserted into the
18350 next column.
18351 For time difference computation, a year is assumed to be exactly 365
18352 days in order to avoid rounding problems."
18372 ;; (ys (floor (* 365 24 60 60)))
18380 y d h m align)
18383 y 0
18388 y 0
18426 "Convert a time stamp to an absolute day number.
18427 If there is a specifyer for a cyclic time stamp, get the closest date to
18428 DAYNR."
18432 daynr
18437 prefer))
18441 "Return the time corresponding to date D.
18442 D may be an absolute day number, or a calendar-type list (month day year)."
18447 "List of holidays, for Diary display in Org-mode."
18455 "Process a SEXP diary ENTRY for DATE."
18475 "Get iCalendar entries from diary entries in buffer FROMBUF.
18476 This uses the icalendar.el library."
18479 temporary-file-directory))
18482 buf rtn b e)
18498 rtn))
18501 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18502 When PREFER is `past' return a date that is either CURRENT or past.
18503 When PREFER is `future', return a date that is either CURRENT or future."
18504 ;; Make the proper lists from the dates
18507 dn dw sday cday n1 n2
18508 d m y y1 y2 date1 date2 nmonths nm ny m2)
18513 current
18537 ;; approx number of month between the tow dates
18539 ;; How often does dn fit in there?
18568 "Turn any specification of DATE into a gregorian date for the calendar."
18578 "Parse the standard Org-mode time string.
18579 This should be a lot faster than the normal `parse-time-string'.
18580 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18581 hour and minute fields will be nil if not given."
18591 nil nil nil)
18595 "Increase the date item at the cursor by one.
18596 If the cursor is on the year, change the year. If it is on the month or
18597 the day, change that.
18598 With prefix ARG, change by that many units."
18603 "Decrease the date item at the cursor by one.
18604 If the cursor is on the year, change the year. If it is on the month or
18605 the day, change that.
18606 With prefix ARG, change by that many units."
18611 "Increase the date in the time stamp by one day.
18612 With prefix ARG, change that many days."
18620 "Decrease the date in the time stamp by one day.
18621 With prefix ARG, change that many days."
18634 "Determine if the cursor is in or at a timestamp."
18660 ans))
18663 "Toggle the type (<active> or [inactive]) of a time stamp."
18675 "Change the date in the time stamp at point.
18676 The date will be changed by N times WHAT. WHAT can be `day', `month',
18677 `year', `minute', `second'. If WHAT is not given, the cursor position
18678 in the timestamp determines what will be changed."
18680 with-hm inactive
18682 org-ts-what
18683 extra rem
18684 ts time time0)
18690 org-display-custom-times
18700 ts)
18734 ;; Try to recenter the calendar window, if any
18740 ;; FIXME: does not yet work for lead times
18742 "Change the different parts of the lead-time and repeat fields in timestamp."
18744 ng h m new)
18745 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18766 new
18768 s))
18771 "If the calendar is visible, recenter it to DATE."
18782 "Go to the Emacs calendar at the current date.
18783 If there is a time stamp in the current line, go to that date.
18784 A prefix ARG can be used to force the current date."
18803 "Return a list (month day year) of date at point in calendar."
18809 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18810 If there is already a time stamp at the cursor position, update it."
18820 ;;;###autoload
18822 "Activate appointments found in `org-agenda-files'.
18824 appointements.
18826 If FILTER is t, interactively prompt the user for a regular
18827 expression, and filter out entries that don't match it.
18829 If FILTER is a string, use this string as a regular expression
18830 for filtering entries out.
18832 FILTER can also be an alist with the car of each cell being
18833 either 'headline or 'category. For example:
18838 will only add headlines containing IMPORTANT or headlines
18851 ;; Get all entries which may contain an appt
18858 ;; Map thru entries and find if we should filter them out
18871 ;; FIXME: Shall we remove text-properties for the appt text?
18872 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18886 ;;; The clock for measuring work time.
18911 "Start the clock on the current item.
18912 If necessary, clock-out of the currently active clock."
18920 org-clock-in-switch-to-state
18947 "Find the location where the next clock line should be inserted."
18953 first last)
18957 ;; we seem to have a CLOCK drawer, so go there.
18960 ;; Lets count the CLOCK lines
18968 ;; Wrap current entries into a new drawer
18986 ;; Planning info, skip to after it
18998 "Stop the currently running clock.
18999 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
19036 "Cancel the running clock be removing the start timestamp."
19050 "Go to the currently clocked-in entry."
19067 "Sum the times for each subtree.
19068 Puts the resulting times in minutes as a text property on each headline."
19072 org-clock-string
19078 ts te dt
19079 time)
19086 ;; Two time stamps
19098 ;; A naket time
19115 "Show subtree times in the entire buffer.
19116 If TOTAL-ONLY is non-nil, only show the total time for the entire file
19117 in the echo area."
19134 ;; Arrange to remove the overlays upon next change.
19144 "Put an overlays on the current line, displaying TIME.
19145 If LEVEL is given, prefix time with a corresponding number of stars.
19146 This creates a new overlay and stores it in `org-clock-overlays', so that it
19147 will be easy to remove."
19151 ov tx)
19170 "Remove the occur highlights from the buffer.
19171 BEG and END are ignored. If NOREMOVE is nil, remove this function
19172 from the `before-change-functions' in the current buffer."
19182 "Clock out if the current entry contains the running clock.
19183 This is used to stop the clock after a TODO entry is marked DONE,
19184 and is only done if the variable `org-clock-out-when-done' is not nil."
19190 org-clock-marker))
19191 ;; Clock out, but don't accept a logging message for this.
19199 "Check if the current buffer contains the running clock.
19200 If yes, offer to stop it and to save the buffer with the changes."
19209 "Create a table containing a report about clocked time.
19210 If the cursor is inside an existing clocktable block, then the table
19211 will be updated. If not, a new clocktable will be inserted.
19212 When called with a prefix argument, move to the first clock table in the
19213 buffer and update it."
19226 "Check if the cursor is in a clocktable."
19234 start))))
19237 "If this is a CLOCK line, update it and return t.
19238 Otherwise, return nil."
19247 ts te h m s)
19249 nil
19263 t)))))
19266 "Return two times bordering a special time range.
19267 Key is a symbol specifying the range and can be one of `today', `yesterday',
19268 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
19269 A week starts Monday 0:00 and ends Sunday 24:00.
19270 The range is determined relative to TIME. TIME defaults to the current time.
19271 The return value is a cons cell with two internal times like the ones
19272 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
19273 the returned times will be formatted strings."
19278 s1 m1 h1 d1 month1 y1 diff ts te fm)
19308 "Write the standard clocktable."
19323 ipos time h m p level hlc hdl
19324 cc beg end pos tbl)
19338 ;; Get the right scope
19361 file)
19371 org-clock-file-total-minutes)))))))
19382 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19403 "Clock summary at ["
19407 "]."
19420 "|"
19421 "*Total time*| "
19443 cc)
19477 x))
19478 lines)
19481 ;; FIXME: I don't think anybody uses this, ask David
19483 "Return an internal list with clocking information.
19484 This list has one entry for each CLOCK interval.
19485 FIXME: describe the elements."
19489 rtn beg end next cont level title total closedp leafp
19490 clockpos titlepos h m donep)
19515 total title titlepos level leafp)
19516 rtn)
19520 ;;;; Agenda, and Diary Integration
19522 ;;; Define the Org-agenda-mode
19537 "Mode for time-sorted view on action items in Org-mode files.
19539 The following commands are available:
19545 org-agenda-pending-undo-list nil)
19547 ;; Keep global-font-lock-mode from turning on font-lock-mode
19555 ;; Make sure properties are removed when copying text
19560 buffer-substring-filters)))
19563 org-agenda-show-log nil))
19570 "Restricted to single file"
19582 org-agenda-mode-map global-map)
19685 "--"
19692 "--"
19696 "--"
19701 "--"
19706 "--"
19711 "--"
19728 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19732 "--"
19734 "--"
19744 "--"
19746 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19750 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19754 "--"
19756 "--"
19759 ))
19761 ;;; Agenda undo
19773 "Execute BODY if there is no `org-protected' text property at point."
19779 "Execute BODY while recording undo information in two buffers."
19787 _c1 _c2)
19788 ,@_body
19795 ;; make sure there are undo boundaries
19798 ;; remember which buffer to undo
19800 org-agenda-undo-list)))))
19803 "Undo a remote editing step in the agenda.
19804 This undoes changes both in the agenda buffer and in the remote buffer
19805 that have been changed along."
19811 org-agenda-pending-undo-list org-agenda-undo-list))
19815 buf line cmd rembuf)
19837 "Verify that a real change occurred between the undo lists L1 and L2."
19842 ;;; Agenda dispatch
19850 ;;;###autoload
19852 "Dispatch agenda commands to collect entries to the agenda buffer.
19853 Prompts for a command to execute. Any prefix arg will be passed
19854 on to the selected command. The default selections are:
19856 a Call `org-agenda-list' to display the agenda for current day or week.
19857 t Call `org-todo-list' to display the global todo list.
19858 T Call `org-todo-list' to display the global todo list, select only
19859 entries with a specific TODO keyword (the user gets a prompt).
19860 m Call `org-tags-view' to display headlines with tags matching
19861 a condition (the user is prompted for the condition).
19862 M Like `m', but select only TODO entries, no ordinary headlines.
19863 L Create a timeline for the current buffer.
19864 e Export views to associated files.
19866 More commands can be added by configuring the variable
19867 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19868 searches can be pre-defined in this way.
19870 If the current buffer is in Org-mode and visiting a file, you can also
19871 first press `<' once to indicate that the agenda should be temporarily
19873 Pressing `<' twice means to restrict to the current subtree or region
19874 \(if active)."
19880 ;; normalize different versions
19886 nil)
19890 org-agenda-custom-commands)))
19893 entry key type match lprops ans)
19894 ;; Turn off restriction unless there is an overriding one
19900 ;; Delete old local properties
19902 ;; Remember where this call originated
19908 ;; Estabish the restriction, if any
19925 ;; For example the todo list should not need it (but does...)
19941 current-prefix-arg)))
19994 cmds)))
19997 "The user interface for selecting an agenda command."
20004 restriction second-time
20005 c entry key type match prefixes rmheader header-end custom1 desc)
20012 "
20013 Press key for an agenda command: < Buffer,subtree/region restriction
20014 -------------------------------- > Remove restriction
20015 a Agenda for current week or day e Export agenda views
20016 t List of all TODO entries T Entries with special TODO kwd
20017 m Match a TAGS query M Like m, but only TODO entries
20018 L Timeline for current buffer # List stuck projects (!=configure)
20019 s Search for keywords C Configure custom agenda commands
20020 / Multi-occur
20025 header start)
20029 header)))
20082 prefix-descriptions))
20084 prefixes))
20095 " (restriction lock active)"
20108 prefixes nil
20114 nil
20116 custom))))
20133 nil)
20153 match ;; The byte compiler incorrectly complains about this. Keep it!
20154 cmd type lprops)
20188 ;;;###autoload
20190 "Run an agenda command in batch mode and send the result to STDOUT.
20191 If CMD-KEY is a string of length 1, it is used as a key in
20192 `org-agenda-custom-commands' and triggers this command. If it is a
20193 longer string it is used as a tags/todo match string.
20194 Paramters are alternating variable names and values that will be bound
20195 before running the agenda command."
20209 string))
20213 ;;;###autoload
20215 "Run an agenda command in batch mode and send the result to STDOUT.
20216 If CMD-KEY is a string of length 1, it is used as a key in
20217 `org-agenda-custom-commands' and triggers this command. If it is a
20218 longer string it is used as a tags/todo match string.
20219 Paramters are alternating variable names and values that will be bound
20220 before running the agenda command.
20222 The output gives a line for each selected agenda item. Each
20223 item is a list of comma-separated values, like this:
20225 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
20227 category The category of the item
20228 head The headline, without TODO kwd, TAGS and PRIORITY
20229 type The type of the agenda entry, can be
20230 todo selected in TODO match
20231 tagsmatch selected in tags match
20232 diary imported from diary
20233 deadline a deadline on given date
20234 scheduled scheduled on given date
20235 timestamp entry has timestamp on given date
20236 closed entry was closed on given date
20237 upcoming-deadline warning about deadline
20238 past-scheduled forwarded scheduled item
20239 block entry has date block including g. date
20240 todo The todo keyword, if any
20241 tags All tags including inherited ones, separated by colons
20242 date The relevant date, like 2007-2-14
20243 time The time, like 15:00-16:50
20244 extra Sting with extra planning info
20245 priority-l The priority letter if any was given
20246 priority-n The computed numerical priority
20247 agenda-day The day in the agenda where this is listed"
20259 line)
20269 priority-letter priority agenda-day)
20274 "Make sure all properties on an agenda item have a canonical form,
20275 so the export commands can easily use it."
20302 props)
20316 ;;;###autoload
20321 ;; FIXME, why is this a macro?????
20322 ;;;###autoload
20324 "Run all custom agenda commands that have a file argument."
20328 pars cmd thiscmdkey files opts)
20351 "Write the current buffer (an agenda view) as a file.
20352 Depending on the extension of the file name, plain text (.txt),
20353 HTML (.html or .htm) or Postscript (.ps) is produced.
20354 If NOSETTINGS is given, do not scope the settings of
20355 `org-agenda-exporter-settings' into the export commands. This is used when
20356 the settings have already been scoped and we do not wish to overrule other,
20357 higher priority settings."
20373 ;; replace <style> section with org-agenda-export-html-style
20394 "Inhibit read-only for BODY."
20398 "Make sure current buffer is in org-mode. Error if not."
20401 major-mode)))
20404 "Fit the window to the buffer size."
20408 nil
20412 ;;; Agenda file list
20415 "Get the list of agenda files.
20416 Optional UNRESTRICTED means return the full list even if a restriction
20417 is currently in place."
20428 org-agenda-file-regexp)
20430 files)))
20436 files))
20440 "Edit the list of agenda files.
20441 Depending on setup, this either uses customize to edit the variable
20442 `org-agenda-files', or it visits the file that is holding the list. In the
20443 latter case, the buffer is set up in a way that saving it automatically kills
20444 the buffer and restores the previous window configuration."
20463 "Set new value for the agenda file list and save it correcly."
20474 "Read the list of agenda files from a file."
20481 ;;;###autoload
20483 "Cycle through the files in `org-agenda-files'.
20484 If the current buffer visits an agenda file, find the next one in the list.
20485 If the current buffer does not, find the first agenda file."
20490 file)
20502 "Move/add the current file to the top of the agenda file list.
20503 If the file is not present in the list, it is added to the front. If it is
20504 present, it is moved there. With optional argument TO-END, add/move to the
20505 end of the list."
20512 x had)
20525 "Remove current file from the list of files in variable `org-agenda-files'.
20526 These are the files which are being checked for agenda entries.
20527 Optional argument FILE means, use this file instead of the current."
20537 nil x))
20550 "Make sure FILE exists. If not, ask user what to do."
20561 ;;; Agenda prepare and finalize
20606 "Finishing touch for the agenda buffer, called just before displaying it."
20618 org-overriding-columns-format)
20620 org-overriding-columns-format))
20622 org-agenda-view-columns-initially)
20628 )))
20631 "Make highest priority lines bold, and lowest italic."
20638 b e p ov h l)
20642 org-highest-priority)
20644 org-lowest-priority)
20649 ov 'face
20657 "Create buffers for all agenda files, protect archived trees and comments."
20664 bmp file re)
20694 "Function to be called at each match during agenda construction.
20695 If this function returns nil, the current match should not be skipped.
20696 Otherwise, the function must return a position from where the search
20697 should be continued.
20698 This may also be a Lisp form, it will be evaluated.
20699 Never set this variable using `setq' or so, because then it will apply
20700 to all future agenda commands. Instead, bind it with `let' to scope
20701 it dynamically into the agenda-constructing command. A good way to set
20705 "Throw to `:skip' in places that should be skipped.
20706 Also moves point to the end of the skipped region, so that search can
20707 continue from there."
20733 "Return a new agenda marker.
20734 Org-mode keeps a list of these markers and resets them when they are
20735 no longer in use."
20739 m))
20742 "Reset markers created by `org-agenda'."
20747 "Get a buffer visiting FILE. If the buffer needs to be created, add
20748 it to the list of buffers which might be released later."
20751 buf ; just return it
20752 ;; Make a new buffer and remember it
20755 buf)))
20758 "Release all buffers in list, asking the user for confirmation when needed.
20759 When a buffer is unmodified, it is just killed. When modified, it is saved
20760 \(if the user agrees) and then killed."
20765 file
20771 "Get the category applying to position POS."
20774 ;;; Agenda timeline
20779 "Show a time-sorted view of the entries in the current org file.
20780 Only entries with a time stamp of today or later will be listed. With
20782 under the current date.
20783 If the buffer contains an active region, only check the region for
20784 dates."
20797 t doclosed ; always include today
20798 org-timeline-show-empty-dates))
20803 args
20804 s e rtn d emptyp)
20810 ;; Remove past dates from the list of dates.
20813 day-numbers))))
20830 dopast
20831 past)
20839 date args)))
20862 "Return a list of all relevant day numbers from BEG to END buffer positions.
20863 If NO-RANGES is non-nil, include only the start and end dates of a range,
20864 not every single day in the range. If FORCE-TODAY is non-nil, make
20865 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20866 inactive time stamps (those in square brackets) are included.
20867 When EMPTY is non-nil, also include days without any entries."
20871 dates dates1 date day day1 day2 ts1 ts2)
20901 dates)))
20903 ;;; Agenda Daily/Weekly
20914 ;;;###autoload
20916 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20917 The view will be for the current day or week, but from the overview buffer
20918 you will be able to go to other days/weeks.
20921 all unfinished TODO items will also be shown, before the agenda.
20922 This feature is considered obsolete, please use the TODO list or a block
20923 agenda instead.
20925 With a numeric prefix argument in an interactive call, the agenda will
20926 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20927 the number of days. NDAYS defaults to `org-agenda-ndays'.
20929 START-DAY defaults to TODAY, or to the most recent match for the weekday
20930 given in `org-agenda-start-on-weekday'."
20941 ;; Convert to an absolute day number
20949 org-agenda-start-on-weekday nil))
20958 sd
20967 s e rtn rtnall file date d start-pos end-pos todayp nd)
20970 ;; Make the list of days
20972 nd ndays)
20985 rtnall nil)
21013 rtnall nil)
21019 file date
21022 file date
21046 rtnall nd todayp))
21069 ;;; Agenda word search
21073 ;;;###autoload
21075 "Show all entries that contain words or regular expressions.
21076 If the first character of the search string is an asterisks,
21077 search only the headlines.
21080 The individual words are then interpreted as a boolean expression with
21081 logical AND. Words prefixed with a minus must not occur in the entry.
21082 Words without a prefix or prefixed with a plus must occur in the entry.
21083 Matching is case-insensitive and the words are enclosed by word delimiters.
21085 Words enclosed by curly braces are interpreted as regular expressions
21086 that must or must not match in the entry.
21088 This command searches the agenda files, and in addition the files listed
21089 in `org-agenda-text-search-extra-files'."
21096 'org-not-done-regexp org-not-done-regexp
21097 'org-todo-regexp org-todo-regexp
21099 'keymap org-agenda-keymap
21101 regexp rtn rtnall files file pos
21102 marker priority category tags c neg re
21132 words)
21138 regexp))))
21140 rtnall nil)
21149 ;; If file does not exist, make sure an error message is sent
21151 file))))
21160 org-agenda-restrict-end)
21182 regexps-)
21186 regexps+)
21192 ""
21195 category tags))
21226 ;;; Agenda TODO list
21231 ;;;###autoload
21233 "Show all TODO entries from all agenda file in a single list.
21234 The prefix arg can be used to select a specific TODO keyword and limit
21236 for a keyword. A numeric prefix directly selects the Nth keyword in
21237 `org-todo-keywords-1'."
21251 rtn rtnall files file pos)
21261 rtnall nil)
21285 kwds))
21296 ;;; Agenda tags match
21298 ;;;###autoload
21300 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
21301 The prefix arg TODO-ONLY limits the search to TODO entries."
21308 rtn rtnall files file pos matcher
21309 buffer)
21318 rtnall nil)
21326 ;; If file does not exist, merror message to agenda
21337 org-agenda-restrict-end)
21362 ;;; Agenda Finding stuck projects
21365 "Regular expression used in skipping subtrees for the agenda.
21366 This is basically a temporary global variable that can be set and then
21373 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
21374 If yes, it returns the end position of this tree, causing agenda commands
21375 to skip this subtree. This is a function that can be put into
21376 `org-agenda-skip-function' for the duration of a command."
21378 skip)
21384 "Skip entry if any of CONDITIONS is true.
21385 See `org-agenda-skip-if' for details."
21389 "Skip entry if any of CONDITIONS is true.
21390 See `org-agenda-skip-if' for details."
21394 "Checks current entity for CONDITIONS.
21395 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
21396 the entry, i.e. the text before the next heading is checked.
21398 CONDITIONS is a list of symbols, boolean OR is used to combine the results
21399 from different tests. Valid conditions are:
21401 scheduled Check if there is a scheduled cookie
21402 notscheduled Check if there is no scheduled cookie
21403 deadline Check if there is a deadline
21404 notdeadline Check if there is no deadline
21405 regexp Check if regexp matches
21406 notregexp Check if regexp does not match.
21408 The regexp is taken from the conditions list, it must come right after
21409 the `regexp' or `notregexp' element.
21411 If any of these conditions is met, this function returns the end point of
21412 the entity, causing the search to continue from there. This is a function
21413 that can be put into `org-agenda-skip-function' for the duration of a command."
21437 end)))
21439 ;;;###autoload
21441 "Create agenda view for projects that are stuck.
21442 Stuck projects are project that have no next actions. For the definitions
21443 of what a project is and how to check if it stuck, customize the variable
21444 `org-stuck-projects'.
21445 MATCH is being ignored."
21448 ;; FIXME: we could have used org-agenda-skip-if here.
21456 org-done-keywords-for-agenda
21458 todo))
21475 gen-re)))))
21486 ;;; Diary integration
21491 "Get the (Emacs Calendar) diary entries for DATE."
21499 entries
21511 ;; No entries
21513 ;; Omit the date and other unnecessary stuff
21515 ;; Add prefix to each line and extend the text properties
21527 ;; Extend the text properties to the beginning of the line
21530 entries)))))
21533 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21534 This gets rid of the date, the underline under the date, and
21535 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21536 date. It also removes lines that contain only whitespace."
21553 ;; Make sure entries from the diary have the right text properties.
21556 ;; We can rely on the hook, nothing to do
21557 nil
21558 ;; Hook not avaiable, must use advice to make this work
21560 "Make the position visible."
21563 buffer-file-name)
21567 "Add text properties to string, allowing org-mode to act on it."
21570 'keymap org-agenda-keymap
21575 'org-agenda-diary-link t
21579 "Add a dummy entry to the diary.
21580 Needed to avoid empty dates which mess up holiday display."
21581 ;; Catch the error if dealing with the new add-to-diary-alist
21588 ;;;###autoload
21590 "Return diary information from org-files.
21592 It accesses org files and extracts information from those files to be
21593 listed in the diary. The function accepts arguments specifying what
21594 items should be listed. The following arguments are allowed:
21596 :timestamp List the headlines of items containing a date stamp or
21597 date range matching the selected date. Deadlines will
21598 also be listed, on the expiration day.
21600 :sexp List entries resulting from diary-like sexps.
21602 :deadline List any deadlines past due, or due within
21603 `org-deadline-warning-days'. The listing occurs only
21604 in the diary for *today*, not at any other date. If
21605 an entry is marked DONE, it is no longer listed.
21607 :scheduled List all items which are scheduled for the given date.
21608 The diary for *today* also contains items which were
21609 scheduled earlier and are not yet marked DONE.
21611 :todo List all TODO items from the org-file. This may be a
21612 long list - so this is not turned on by default.
21613 Like deadlines, these entries only show up in the
21614 diary for *today*, not at any other date.
21616 The call in the diary file should look like this:
21618 &%%(org-diary) ~/path/to/some/orgfile.org
21620 Use a separate line for each org file to check. Or, if you omit the file name,
21621 all files listed in `org-agenda-files' will be checked automatically:
21623 &%%(org-diary)
21625 If you don't give any arguments (as in the example above), the default
21626 arguments (:deadline :scheduled :timestamp :sexp) are used.
21627 So the example above may also be written as
21629 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21631 The function expects the lisp variables `entry' and `date' to be provided
21632 by the caller, because this is how the calendar works. Don't use this
21633 function from a program - use `org-agenda-get-day-entries' instead."
21635 org-agenda-last-marker-time)
21644 file rtn results)
21646 ;; If this is called during org-agenda, don't return any entries to
21647 ;; the calendar. Org Agenda will list these entries itself.
21655 ;;; Agenda entry finders
21658 "Does the work for `org-diary' and `org-agenda'.
21659 FILE is the path to a file to be checked for entries. DATE is date like
21660 the one returned by `calendar-current-date'. ARGS are symbols indicating
21661 which kind of entries should be extracted. For details about these, see
21662 the documentation of `org-diary'."
21669 arg results rtn)
21671 ;; If file does not exist, make sure an error message ends up in diary
21681 org-agenda-restrict-end)
21683 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21707 results))))
21723 "Is the cursor inside a date range?"
21738 nil)))
21741 "Return the TODO information for agenda display."
21744 'org-not-done-regexp org-not-done-regexp
21745 'org-todo-regexp org-todo-regexp
21747 'keymap org-agenda-keymap
21748 'help-echo
21751 ;; FIXME: get rid of the \n at some point but watch out
21755 org-todo-regexp
21759 org-not-done-regexp)
21761 marker priority category tags
21762 ee txt beg end)
21801 "Return the date stamp information for agenda display."
21803 'org-not-done-regexp org-not-done-regexp
21804 'org-todo-regexp org-todo-regexp
21806 'keymap org-agenda-keymap
21807 'help-echo
21815 "<%Y-%m-%d"
21829 marker hdmarker deadlinep scheduledp donep tmp priority category
21830 ee txt timestr tags b0 b3 e3 head)
21848 b0)
21855 ;; substring should only run to end of time stamp
21867 nil head category tags timestr nil
21868 remove-re)))
21881 "Return the sexp information for agenda display."
21885 'keymap org-agenda-keymap
21886 'help-echo
21890 marker category ee txt tags entry result beg b sexp sexp-entry)
21922 "Return the logged TODO entries for agenda display."
21924 'org-not-done-regexp org-not-done-regexp
21925 'org-todo-regexp org-todo-regexp
21926 'keymap org-agenda-keymap
21927 'help-echo
21939 marker hdmarker priority category tags closedp
21940 ee txt timestr)
21949 ;; donep (org-entry-is-done-p)
21950 )
21952 ;; substring should only run to end of time stamp
21976 "Return the deadline information for agenda display."
21978 'org-not-done-regexp org-not-done-regexp
21979 'org-todo-regexp org-todo-regexp
21980 'keymap org-agenda-keymap
21981 'help-echo
21987 d2 diff dfrac wdays pos pos1 category tags
21988 ee txt head face s upcomingp donep timestr)
22000 ;; When to show a deadline in the calendar:
22001 ;; If the expiration is within wdays warning time.
22002 ;; Past-due deadlines are only shown on the current date
22030 diff))
22031 head category tags timestr))))
22040 'org-category category
22049 "Return the face to displaying a deadline item.
22050 FRACTION is what fraction of the head-warning time has passed."
22058 "Return the scheduled information for agenda display."
22060 'org-todo-regexp org-todo-regexp
22063 'keymap org-agenda-keymap
22064 'help-echo
22070 d2 diff pos pos1 category tags
22071 ee txt head pastschedp donep face timestr s)
22079 ;;; is this right?
22080 ;;; do we need to do this for deadleine too????
22081 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
22084 ;; When to show a scheduled item in the calendar:
22085 ;; If it is on or past the date.
22113 head category tags timestr))))
22117 'org-scheduled-previously
22120 'undone-face face
22132 "Return the date-range information for agenda display."
22134 'org-not-done-regexp org-not-done-regexp
22135 'org-todo-regexp org-todo-regexp
22137 'keymap org-agenda-keymap
22138 'help-echo
22143 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
22144 donep head)
22156 ;; Only allow days between the limits, because the normal
22157 ;; date stamps will catch the limits.
22174 head category tags
22183 ;; Sort the entries by expiration date.
22186 ;;; Agenda presentation and sorting
22196 "Regular expression to match a plain time or time range.
22197 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22198 groups carry important information:
22199 0 the full match
22200 1 the first time, range or not
22208 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
22209 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22210 groups carry important information:
22211 0 the full match
22212 7 hours of duration
22221 "Regular expression to match a timestamp time or time range.
22222 After a match, the following groups carry important information:
22223 0 the full match
22224 1 date plus weekday, for backreferencing to make sure both times on same day
22225 2 the first time, range or not
22229 "A flag, set by `org-compile-prefix-format'.
22232 "A flag, set by `org-compile-prefix-format'.
22236 noprefix remove-re)
22237 "Format TXT to be inserted into the agenda buffer.
22238 In particular, it adds the prefix and corresponding text properties. EXTRA
22239 must be a string and replaces the `%s' specifier in the prefix format.
22240 CATEGORY (string, symbol or nil) may be used to overrule the default
22241 category taken from local variable or file name. It will replace the `%c'
22242 specifier in the format. DOTIME, when non-nil, indicates that a
22243 time-of-day should be extracted from TXT for sorting of this entry, and for
22244 the `%t' specifier in the format. When DOTIME is a string, this string is
22245 searched for a time before TXT is. NOPREFIX is a flag and indicates that
22246 only the correctly processes TXT should be returned - this is used by
22247 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
22248 Any match of REMOVE-RE will be removed from TXT."
22250 ;; Diary entries sometimes have extra whitespace at the beginning
22253 org-category
22259 time ; time and tag are needed for the eval of the prefix format
22262 stamp plain s0 s1 s2 rtn srp)
22264 ;; Extract starting and ending time and move them to prefix
22272 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
22273 ;; them, we might want to remove them there to avoid duplication.
22274 ;; The user can turn this off with a variable.
22280 t))
22282 ;; Normalize the time(s) to 24 hour
22290 org-agenda-default-appointment-duration))
22291 h)
22296 txt)
22297 ;; Tags are in the string
22300 org-prefix-has-tag))
22305 t t txt))))
22311 ;; Create the final string
22314 ;; Prepare the variables needed in the eval of the compiled format
22320 ;; Evaluate the compiled format
22323 ;; And finally add the text properties
22326 'org-highest-priority org-highest-priority
22327 'org-lowest-priority org-lowest-priority
22329 'time-of-day time-of-day
22330 'txt txt
22331 'time time
22332 'extra extra
22347 list)))
22352 new time)
22354 ;; don't show empty grid
22360 nil string "" nil
22362 new)
22370 "Compile the prefix format into a Lisp form that can be evaluated.
22371 The resulting form is returned and stored in the variable
22372 `org-prefix-format-compiled'."
22376 org-agenda-prefix-format)
22381 varform vars var e c f opt)
22383 s start)
22396 ""
22406 ;; the old format
22414 "Check string S for a time of day.
22415 If found, return it as a military time number between 0 and 2400.
22416 If not found, return nil.
22417 The optional STRING argument forces conversion into a 5 character wide string
22418 HH:MM."
22440 "Sort and concatenate the agenda items."
22443 list
22468 x)
22472 " "
22474 x)))
22477 "Compare the priorities of string A and B."
22485 "Compare the string values of categories of strings A and B."
22493 "Compare the string values of categories of strings A and B."
22503 "Compare the time-of-day values of strings A and B."
22512 "Predicate for sorting agenda entries."
22513 ;; The following variables will be used when the form is evaluated.
22514 ;; So even though the compiler complains, keep them.
22528 ;;; Agenda restriction lock
22546 "Set restriction lock for agenda, to current subtree or file.
22547 Restriction will be the file if TYPE is `file', or if type is the
22548 universal prefix '(4), or if the cursor is before the first headline
22549 in the file. Otherwise, restriction will be to the current subtree."
22581 "Remove the agenda restriction lock."
22595 "If there is any window showing the agenda view, update it."
22604 org-agenda-overriding-restriction)
22607 ;;; Agenda commands
22610 "Check if agenda buffer is of allowed type.
22611 If ERROR is non-nil, throw an error, otherwise just return nil."
22613 t
22616 nil)))
22619 "Exit agenda by removing the window or the buffer."
22626 ;; Maybe restore the pre-agenda window configuration.
22629 org-pre-agenda-window-conf
22633 "Exit agenda by removing the window or the buffer.
22634 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22635 Org-mode buffers visited directly by the user will not be touched."
22649 "Save all Org-mode buffers without user confirmation."
22656 "Rebuild Agenda.
22657 When this is the global TODO list, a prefix argument will be interpreted."
22666 org-agenda-pending-undo-list nil)
22672 "Manipulate the query by adding a search term with positive selection.
22673 Positive selection means, the term must be matched for selection of an entry."
22677 "Manipulate the query by adding a search term with negative selection.
22678 Negative selection means, term must not be matched for selection of an entry."
22682 "Manipulate the query by adding a search regexp with positive selection.
22683 Positive selection means, the regexp must match for selection of an entry."
22687 "Manipulate the query by adding a search regexp with negative selection.
22688 Negative selection means, regexp must not match for selection of an entry."
22695 'org-agenda-query-string
22702 org-agenda-query-string))
22706 org-agenda-type))))
22712 "Jump to DATE in agenda."
22717 "Go to today."
22743 "Go forward in time by thee current span.
22744 With prefix ARG, go forward that many times the current span."
22751 greg2 nd)
22773 "Go backward in time by the current span.
22774 With prefix ARG, go backward that many times the current span."
22779 "Switch to daily view for agenda."
22784 "Switch to daily view for agenda."
22789 "Switch to daily view for agenda."
22793 "Switch to daily view for agenda."
22800 "Change the agenda view to SPAN.
22801 SPAN may be `day', `week', `month', `year'."
22806 org-starting-day))
22817 "Compute starting date and number of days for agenda.
22818 SPAN may be `day', `week', `month', `year'. The return value
22819 is a cons cell with the starting date and the number of days,
22820 so that the date SD will be in that range."
22822 nd)
22839 sd)))
22845 sd))))
22848 ;; FIXME: does not work if user makes date format that starts with a blank
22850 "Jump to the next line indicating a date in agenda buffer."
22862 "Jump to the previous line indicating a date in agenda buffer."
22869 ;; Initialize the highlight
22874 "Highlight a region with overlay."
22879 "Detach overlay INDEX."
22882 ;; FIXME this is currently not used.
22891 "Toggle follow mode in an agenda buffer."
22899 "Toggle log mode in an agenda buffer."
22909 "Toggle diary inclusion in an agenda buffer."
22919 "Toggle time grid in an agenda buffer."
22929 "Set the mode name to indicate all the small mode settings."
22948 "Show the priority of the current item.
22949 This priority is composed of the main priority given with the [#A] cookies,
22950 and by additional input from the age of a schedules or deadline entry."
22956 "Show the tags applicable to the current item."
22965 "Go to the Org-mode file which contains the item at point."
22984 "Normal hook run after an item has been shown from the agenda.
22988 "Kill the entry or subtree belonging to the current agenda entry."
23021 "Kill the entry or subtree belonging to the current agenda entry."
23039 "Remove all lines in the agenda that correspond to a given subtree.
23040 The subtree is the one in buffer BUF, starting at BEG and ending at END.
23041 If this information is not given, the function uses the tree at point."
23064 "Follow the link in the current line, if any."
23073 "Get a variable from a referenced buffer and install it here."
23080 "Go to the Org-mode file which contains the item at point."
23097 "Go to the Org-mode file which contains the item at the mouse click."
23103 "Display the Org-mode file which contains the item at point."
23110 "Display the Org-mode file which contains the item at point and recenter."
23118 "Display the Org-mode file which contains the item at the mouse click."
23124 "Check if the entry is a diary link and abort if yes."
23132 "Show the subtree corresponding to the current entry in an indirect buffer.
23133 This calls the command `org-tree-to-indirect-buffer' from the original
23134 Org-mode buffer.
23135 With numerical prefix arg ARG, go up to this level and then take that tree.
23136 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
23137 dedicated frame)."
23150 "Marker pointing to the headline that last changed its TODO state
23154 "Switch TODO entry to next sequence."
23159 "Switch TODO entry to previous sequence."
23164 "Cycle TODO state of line at point, also in Org-mode file.
23165 This changes the line at point, all other lines in the agenda referring to
23166 the same tree node, and the headline of the tree node in the Org-mode file."
23176 newhead)
23197 "Change all lines in the agenda buffer which match HDMARKER.
23198 The new content of the line will be NEWHEAD (as modified by
23199 `org-format-agenda-item'). HDMARKER is checked with
23200 `equal' against all `org-hd-marker' text properties in the file.
23201 If FIXFACE is non-nil, the face of each item is modified acording to
23202 the new TODO state."
23204 props m pl undone-face done-face finish new dotime cat tags)
23234 undone-face done-face))))
23242 "Align all tags in agenda items to `org-agenda-tags-column'."
23255 org-agenda-tags-column))
23263 "Increase the priority of line at point, also in Org-mode file."
23268 "Decrease the priority of line at point, also in Org-mode file."
23273 "Set the priority of line at point, also in Org-mode file.
23274 This changes the line at point, all other lines in the agenda referring to
23275 the same tree node, and the headline of the tree node in the Org-mode file."
23284 newhead)
23300 "Get a list of all headline tags applicable at POS.
23301 POS defaults to point. If tags are inherited, the list contains
23302 the targets in the same sequence as the headlines appear, i.e.
23303 the tags of the current headline come last."
23318 tags)))
23322 tags)))
23324 ;; FIXME: should fix the tags property of the agenda line.
23326 "Set tags for the current headline."
23337 newhead)
23355 "Toggle the archive tag for the current entry."
23364 newhead)
23380 "Change the date of this item to one day later."
23399 "Change the date of this item to one day earlier."
23404 "Show new date stamp via text properties."
23405 ;; We use text properties to make this undoable
23414 ;; Use `duplicable' property to trigger undo recording
23429 "Change the date of this item. Date is prompted for, with default today.
23430 The prefix ARG is passed to the `org-time-stamp' command and can therefore
23431 be used to request time specification in the time stamp."
23449 "Schedule the item at point."
23459 ts)
23471 "Schedule the item at point."
23480 ts)
23490 "Return the heading of the current entry, without the stars."
23500 "Start the clock on the currently selected item."
23513 "Stop the currently running clock."
23521 "Cancel the currently running clock."
23529 "Make a diary entry, like the `i' command from the calendar.
23530 All the standard commands work: block, weekly etc."
23546 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23555 ;; We implement this by hacking the `calendar-cursor-to-date' function
23556 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23572 "Execute a calendar command from the agenda, with the date associated to
23573 the cursor position."
23582 ;; the following 3 vars are needed in the calendar
23596 "Display the phases of the moon for the 3 months around the cursor date."
23601 "Display the holidays for the 3 months around the cursor date."
23606 "Display sunrise and sunset for the cursor date.
23607 Latitude and longitude can be specified with the variables
23608 `calendar-latitude' and `calendar-longitude'. When called with prefix
23609 argument, latitude and longitude will be prompted for."
23618 "Open the Emacs calendar with the date at the cursor."
23631 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23632 This is a command that has to be installed in `calendar-mode-map'."
23636 nil))
23642 date s)
23668 ;;;; Embedded LaTeX
23683 "Toggle the minor `org-cdlatex-mode'.
23684 This mode supports entering LaTeX environment and math in LaTeX fragments
23685 in Org-mode.
23687 nil " OCDL" nil
23692 "Always return t in org-mode buffers.
23693 This is because we want to insert math symbols without dollars even outside
23694 the LaTeX math segments. If Orgmode thinks that point is actually inside
23695 en embedded LaTeX fragement, let texmathp do its job.
23712 "Unconditionally turn on `org-cdlatex-mode'."
23716 "Test if point is inside a LaTeX fragment.
23718 sequence appearing also before point.
23719 Even though the matchers for math are configurable, this function assumes
23721 delimiters are skipped when they have been removed by customization.
23722 The return value is nil, or a cons cell with the delimiter and
23723 and the position of this delimiter.
23725 This function does a reasonably good job, but can locally be fooled by
23726 for example currency specifications. For example it will assume being in
23728 fragments that are properly closed, but during editing, we have to live
23729 with the uncertainty caused by missing closing delimiters. This function
23730 looks only before point, not after."
23749 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23753 ;; count $$
23761 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23762 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23763 - inside a LaTeX fragment, or
23764 - after the first word in a line, where an abbreviation expansion could
23765 insert a LaTeX environment."
23778 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23779 Revert to the normal definition outside of these fragments."
23787 "Execute `cdlatex-math-modify' in LaTeX fragments.
23788 Revert to the normal definition outside of these fragments."
23800 "Remove all overlays with LaTeX fragment images in current buffer."
23805 "Preview the LaTeX fragment at point, or all locally or globally.
23806 If the cursor is in a LaTeX fragment, create the image and overlay
23807 it over the source code. If there is no fragment at point, display
23808 all fragments in the current text, from one headline to the next. With
23809 prefix SUBTREE, display all fragments in the current subtree. With a
23810 double prefix `C-u C-u', or when the cursor is before the first headline,
23811 display all fragments in the buffer.
23841 buffer-file-name)))
23847 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23848 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23849 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23856 "Replace LaTeX fragments with links to an image, and produce images."
23865 m n block linkfile movefile ov)
23866 ;; Check if there are old images files with this prefix, and remove them
23870 todir 'full
23872 ;; Check the different regular expressions
23892 txt movefile opt forbuffer)
23900 ov 'end-glyph
23903 ov 'display
23910 ;; This function borrows from Ganesh Swami's latex2png.el
23914 temporary-file-directory))
23943 "-D" dpi
23944 ;;"-x" scale "-y" scale
23946 "-o" pngfile
23947 dvifile)
23950 ;; Use the requested file name and clean up
23954 pngfile))))
23957 "Return an rgb color specification for dvipng."
23963 "Return string to be used as color value for an RGB component."
23966 ;;;; Exporting
23968 ;;; Variables, constants, and parameter plists
24024 "Return the property list with default settings for the export variables."
24028 rtn))
24031 "Return the property list with file-local settings for export."
24038 p key val text options)
24071 o)
24075 options)
24079 p))))
24085 val)))
24086 dir))
24093 rtn line level)
24098 ;; Beginning of a COMMENT subtree. Skip it.
24104 ;; an ordinary comment line
24105 )
24111 ;; a special table line that should be removed
24112 )
24119 \[v] limit export to visible part of outline tree
24121 \[a] export as ASCII
24123 \[h] export as HTML
24124 \[H] export as HTML to temporary buffer
24125 \[R] export region as HTML
24126 \[b] export as HTML and browse immediately
24127 \[x] export as XOXO
24129 \[l] export as LaTeX
24130 \[L] export as LaTeX to temporary buffer
24132 \[i] export current file as iCalendar file
24133 \[I] export all agenda files as iCalendar files
24134 \[c] export agenda files into combined iCalendar file
24136 \[F] publish current file
24137 \[P] publish current project
24138 \[X] publish... (project will be prompted for)
24158 r1 r2 ass)
24461 )
24462 "Entities for TeX->HTML translation.
24466 The list contains HTML entities for Latin-1, Greek and other symbols.
24467 It is supplemented by a number of commonly used TeX macros with appropriate
24470 ;;; General functions for all backends
24473 "Cleanup a buffer STRING so that links can be created safely."
24491 a b xx
24492 rtn p)
24496 ;; Remove license-to-kill stuff
24504 ;; Get rid of drawers
24509 'identity
24517 ;; Get the correct stuff before the first headline
24528 ;; Get rid of archived trees
24540 ;; Find targets in comments and move them out of comments,
24541 ;; but mark them as targets that should be invisible
24546 ;; Protect backend specific stuff, throw away the others.
24551 fmt)
24582 ;; Protect quoted subtrees
24590 ;; Protect verbatim elements
24597 ;; Remove subtrees that are commented
24603 ;; Remove special table lines
24615 ;; Specific LaTeX stuff
24623 ;; Specific HTML stuff
24625 ;; Convert LaTeX fragments to images
24630 org-current-export-file)))
24634 ;; Remove or replace comments
24643 ;; Find matches for radio targets and turn them into internal links
24650 ;; Find all links that contain a newline and put them into a single line
24652 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24658 ;; Normalize links: Convert angle and plain links into bracket links
24659 ;; Expand link abbreviations
24666 ;; added 'org-link face to links
24682 "]"
24690 ;; Find multiline emphasis and put them into single line
24704 rtn))
24707 "Get a title for the current document, from looking at the buffer."
24713 ;; Mark the line so that it will not be exported as normal text.
24717 ;; Return the title string
24721 "Return subtree title and exclude it from export."
24727 ;; This is a subtree, we take the title from the first heading
24734 title))
24737 "Take link text and make a safe target out of it."
24741 'identity
24747 "Get the minimum level in LINES."
24755 ;; Variable holding the vector with section numbers
24759 "Initialize the vector for the section numbers."
24776 "Return a string with the current section number.
24777 When LEVEL is non-nil, increase section numbers on that level."
24799 string))
24801 ;;; ASCII export
24809 "Export the outline as a pretty ASCII file.
24810 If there is an active region, export only the region.
24811 The prefix ARG specifies how many levels of the outline should become
24812 underlined headlines. The default is 3."
24841 filename))
24857 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24866 region
24867 :for-ascii t
24868 :skip-before-1st-heading
24871 :verbatim-multiline t
24872 :archived-trees
24876 thetoc have-headings first-heading-pos
24877 table-open table-buffer)
24895 ;; create local variables for all options, to make sure all called
24896 ;; functions get the correct information
24900 org-export-plist-vars)
24903 org-export-headline-levels))
24906 umax))
24908 ;; File header
24912 org-export-author-info)
24934 line)
24935 ;; This is a headline
24941 todo
24945 org-done-keywords)))
24946 ; TODO, not DONE
24950 line lines level))))
24957 t t txt)))
24962 txt))
24977 thetoc)
24979 ))))
24980 lines)
24985 ;; Remove the quoted HTML tags.
24987 ;; Remove targets
24990 ;; Replace internal links
24994 t nil line)))
24999 ;; a Headline
25008 ;; New table starts
25010 ;; Accumulate lines
25031 ;; insert the table of contents
25043 ;; Convert whitespace place holders
25053 ;; remove display and invisible chars
25069 "Do extra work for ASCII export"
25079 "Search the subtree below LINE for any TODO entries."
25082 line lv todo)
25090 org-done-keywords))))
25091 ; TODO, not DONE
25096 "Handle quoted HTML for ASCII export."
25099 ;; We just remove the tags for now.
25101 line)
25104 "Insert the string S centered and underline it with character UNDERLINE."
25113 "Insert a new level in ASCII export."
25119 org-export-ascii-bullets))
25121 ;; find the indentation of the next non-empty line
25142 "Create a copy of the visible part of the current buffer, and export it.
25143 The copy is created in a temporary buffer and removed after use.
25144 TYPE is the final key (as a string) that also select the export command in
25145 the `C-c C-e' export dispatcher.
25146 As a special case, if the you type SPC at the prompt, the temporary
25147 org-mode file will not be removed but presented to you so that you can
25148 continue to use it. The prefix arg ARG is passed through to the exporting
25149 command."
25152 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
25154 current-prefix-arg))
25169 s e)
25170 ;; Need to hack the drawers here.
25186 ;; Copy all comment lines to the end, to make sure #+ settings are
25187 ;; still available for the second export step. Kind of a hack, but
25188 ;; does do the trick.
25209 s))
25214 s))
25216 ;;; HTML export
25219 "Return a string with current options as keyword options.
25220 Does include HTML export options as well as TODO and CATEGORY stuff."
25222 "#+TITLE: %s
25223 #+AUTHOR: %s
25224 #+EMAIL: %s
25225 #+LANGUAGE: %s
25226 #+TEXT: Some descriptive text to be emitted. Several lines OK.
25227 #+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
25228 #+CATEGORY: %s
25229 #+SEQ_TODO: %s
25230 #+TYP_TODO: %s
25231 #+PRIORITIES: %c %c %c
25232 #+DRAWERS: %s
25233 #+STARTUP: %s %s %s %s %s
25234 #+TAGS: %s
25235 #+ARCHIVE: %s
25236 #+LINK: %s
25237 "
25239 org-export-headline-levels
25240 org-export-with-section-numbers
25241 org-export-with-toc
25242 org-export-preserve-breaks
25243 org-export-html-expand
25244 org-export-with-fixed-width
25245 org-export-with-tables
25246 org-export-with-sub-superscripts
25247 org-export-with-special-strings
25248 org-export-with-footnotes
25249 org-export-with-emphasize
25250 org-export-with-TeX-macros
25251 org-export-with-LaTeX-fragments
25252 org-export-skip-text-before-1st-heading
25253 org-export-with-drawers
25254 org-export-with-tags
25256 "TODO FEEDBACK VERIFY DONE"
25257 "Me Jason Marie DONE"
25258 org-highest-priority org-lowest-priority org-default-priority
25275 org-archive-location
25276 "org file:~/org/%s.org"
25277 ))
25280 "Insert into the buffer a template with information for exporting."
25289 "Toggle the fixed-width export.
25290 If there is no active region, the QUOTE keyword at the current headline is
25291 inserted or removed. When present, it causes the text between this headline
25292 and the next to be exported as fixed-width text, and unmodified.
25293 If there is an active region, this command adds or removes a colon as the
25294 first character of this line. If the first character of a line is a colon,
25295 this line is also exported in fixed-width font."
25304 off)
25334 "Export the outline as HTML and immediately open it with a browser.
25335 If there is an active region, export only the region.
25336 The prefix ARG specifies how many levels of the outline should become
25337 headlines. The default is 3. Lower levels will become bulleted lists."
25343 "Call `org-export-as-html', may be used in batch processing as
25344 emacs --batch
25345 --load=$HOME/lib/emacs/org.el
25347 --visit=MyFile --funcall org-export-as-html-batch"
25351 "Call `org-exort-as-html` with output to a temporary buffer.
25352 No file is created. The prefix ARG is passed through to `org-export-as-html'."
25358 "Assume the current region has org-mode syntax, and convert it to HTML.
25359 This can be used in any buffer. For example, you could write an
25360 itemized list in org-mode syntax in an HTML buffer and then use this
25361 command to convert it."
25381 "Convert region from BEG to END in org-mode buffer to HTML.
25382 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
25383 contents, and only produce the region of converted text, useful for
25384 cut-and-paste operations.
25385 If BUFFER is a buffer or a string, use/create that buffer as a target
25386 of the converted HTML. If BUFFER is the symbol `string', return the
25387 produced HTML as a string and leave not buffer behind. For example,
25388 a Lisp program could call this function in the following way:
25390 (setq html (org-export-region-as-html beg end t 'string))
25392 When called interactively, the output buffer is selected, and shown
25393 in a window. A non-interactive call will only retunr the buffer."
25398 rtn)
25403 nil nil nil
25404 buffer body-only))
25408 rtn)))
25412 to-buffer body-only pub-dir)
25413 "Export the outline as a pretty HTML file.
25414 If there is an active region, export only the region. The prefix
25415 ARG specifies how many levels of the outline should become
25416 headlines. The default is 3. Lower levels will become bulleted
25417 lists. When HIDDEN is non-nil, don't display the HTML buffer.
25418 EXT-PLIST is a property list with external parameters overriding
25419 org-mode's default settings, but still inferior to file-local
25420 settings. When TO-BUFFER is non-nil, create a buffer with that
25421 name and export to that buffer. If TO-BUFFER is the symbol
25422 `string', don't leave any buffer behind but just return the
25423 resulting HTML as a string. When BODY-ONLY is set, don't produce
25424 the file header and footer, simply return the content of
25425 <body>...</body>, without even the body tags themselves. When
25426 PUB-DIR is set, use this as the publishing directory."
25429 ;; Make sure we have a file name when we need it.
25435 buffer-file-name))
25444 ext-plist
25450 valid thetoc have-headings first-heading-pos
25459 ;; The following two are dynamically scoped into other
25460 ;; routines below.
25480 default-directory))
25514 buffer-file-coding-system))
25516 coding-system))
25518 coding-system))
25530 region
25531 :emph-multiline t
25532 :for-html t
25533 :skip-before-1st-heading
25536 :archived-trees
25538 :add-text
25540 :LaTeX-fragments
25543 table-open type
25544 table-buffer table-orig-buffer
25545 ind start-is-num starter didclose
25546 rpl path desc descp desc1 desc2 link
25547 )
25566 ;; Get the language-dependent settings
25570 ;; Switch to the output buffer
25580 ;; create local variables for all options, to make sure all called
25581 ;; functions get the correct information
25585 org-export-plist-vars)
25587 org-export-headline-levels))
25590 umax))
25592 ;; File header
25598 <head>
25599 <title>%s</title>
25604 %s
25605 </head><body>
25606 "
25619 org-export-html-toplevel-hlevel
25621 org-export-html-toplevel-hlevel)
25622 thetoc)
25627 ;; This is a headline
25636 todo
25640 org-done-keywords)))
25641 ; TODO, not DONE
25645 line lines level))))
25670 ;; Check for targets
25675 t t line))
25678 target-alist))
25689 )))
25690 line)
25691 lines))
25703 ;; end of quote section?
25707 ;; inside a quote section?
25712 ;; verbatim lines
25726 ;; Protected HTML
25741 ;; Horizontal line
25746 ;; make targets to anchors
25754 t t line)))
25758 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25759 t t line)))
25765 t t line)))))
25769 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25770 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25771 ;; Also handle sub_superscripts and checkboxes
25775 ;; Format the links
25785 ;; Make an image out of the description if that is so wanted
25791 ;; FIXME: do we need to unescape here somewhere?
25801 ;; standard URL, just check if we need to inline an image
25809 ;; standard URL
25813 ;; FILE link
25816 thefile file-is-image-p search)
25824 t))
25833 ;; make sure this is can be used as target search
25858 ;; TODO items
25866 org-done-keywords)
25871 ;; Does this contain a reference to a footnote?
25883 t t line))))))
25887 ;; This is a headline
25895 ;; Close any local lists before inserting a new header line
25901 in-local-list nil))
25905 head-count)
25906 ;; QUOTES
25914 ;; New table starts
25916 ;; Accumulate lines
25928 ;; Normal lines
25931 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25932 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25935 line)
25942 ;; empty line. Pretend indentation is large.
25944 0
25960 ;; Start new (level of) list
25967 ;; continue current list
25971 ;; we did close a list, normal text follows: need <p>
25977 "<b>[X]</b>"
25979 t t line))))
25981 ;; Empty lines start a new paragraph. If hand-formatted lists
25982 ;; are not fully interpreted, lines starting with "-", "+", "*"
25983 ;; also start a new paragraph.
25986 ;; Is this the start of a footnote?
25992 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25994 ;; Check if the line break needs to be conserved
26003 ;; Properly close all local lists and other lists
26006 ;; Close any local lists before inserting a new header line
26012 in-local-list nil))
26015 head-count)
26046 ;; insert the table of contents
26063 ;; remove empty paragraphs and lists
26073 ;; Convert whitespace place holders
26094 "Format a table for ascii export."
26098 ;; Table made by table.el - test for spanning
26099 lines
26101 ;; A normal org table
26102 ;; Get rid of hlines at beginning and end
26108 ;; Check if the table has a marking column. If yes remove the
26109 ;; column and the special lines
26111 ;; Get rid of the vertical lines except for grouping
26113 rtn line vl1 start)
26135 vl))
26138 "Find out which HTML converter to use and return the HTML code."
26142 ;; A normal org table
26144 ;; Table made by table.el - test for spanning
26148 nil))
26149 lines)))
26155 hlines))))
26158 ;; We can use my own converter with HTML conversions
26160 ;; Need to use the code generator in table.el, with the original text.
26164 "Format a table into HTML."
26165 ;; Get rid of hlines at beginning and end
26171 ;; Check if the table has a marking column. If yes remove the
26172 ;; column and the special lines
26180 tbopen line fields html gr colgropen)
26192 ;; ignore this line
26194 ;; Break the line into fields
26212 html)))
26217 ;; Put in col tags with the alignment (unfortuntely often ignored...)
26233 html)
26239 "Check if the table has a marking column.
26240 If yes remove the column and the special lines."
26246 lines))
26261 nil)
26263 lines)))
26277 nil)
26282 ;; remove the first column
26284 lines))))
26287 "Format a table generated by table.el into HTML.
26288 This conversion does *not* use `table-generate-source' from table.el.
26289 This has the advantage that Org-mode's HTML conversions can be used.
26290 But it has the disadvantage, that no cell- or row-spanning is allowed."
26293 fields html empty)
26303 html
26305 html
26306 "<tr>"
26319 ;; Ignore this line
26321 ;; Break the line into fields and store the fields
26327 field-buffer))
26330 html))
26333 "Format a table into html, using `table-generate-source' from table.el.
26334 This has the advantage that cell- or row-spanning is allowed.
26335 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
26350 "Format time stamps in string S, or remove them."
26355 ;; never export CLOCK
26370 ;; Line break if line started and ended with time stamp stuff
26372 s
26376 r))))
26379 ;; convert & to &, < to < and > to >
26388 s)
26391 "Remove tags and time staps from lines going into the toc."
26400 t t s)))
26401 s)
26404 "Prepare STRING for HTML export. Applies all active conversions.
26405 If there are links in the string, don't modify these."
26408 m s l res)
26419 "Apply all active conversions to translate special ASCII to HTML."
26440 t t s))
26442 s)
26445 "Create a regular expression which will match a balanced sexp.
26446 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
26447 as single character strings.
26448 The regexp returned will match the entire expression including the
26449 delimiters. It will also define a single group which contains the
26450 match except for the outermost delimiters. The maximum depth of
26451 stacked delimiters is N. Escaping delimiters is not possible."
26487 "Convert special characters in STRING to HTML."
26489 e a re rpl start)
26496 string))
26499 "Convert sub- and superscripts in STRING to HTML."
26515 t t string)))))
26518 string))
26521 "Apply emphasis."
26528 rpl
26534 org-emphasis-alist))
26539 string))
26543 "Insert <p>, but first close previous paragraph if any."
26548 "Close paragraph if there is one open."
26553 "Close <li> if necessary."
26559 "Insert a new level in HTML export.
26560 When TITLE is nil, just close all open levels."
26570 ;; If title is nil, this means this function is called to close
26571 ;; all levels, so the rest is done only if title is given
26583 t t title)))
26599 level level head-count title level))
26604 "Terminate one level in HTML export."
26610 ;;; iCalendar export
26612 ;;;###autoload
26614 "Export current file as an iCalendar file.
26615 The iCalendar file will be located in the same directory as the Org-mode
26616 file, but with extension `.ics'."
26620 ;;;###autoload
26622 "Export all files in `org-agenda-files' to iCalendar .ics files.
26623 Each iCalendar file will be located in the same directory as the Org-mode
26624 file, but with extension `.ics'."
26628 ;;;###autoload
26630 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26631 The file is stored under the name `org-combined-agenda-icalendar-file'."
26636 "Create iCalendar files for all elements of FILES.
26637 If COMBINE is non-nil, combine all calendar entries into a single large
26638 file and store it under the name `org-combined-agenda-icalendar-file'."
26643 org-export-publishing-directory)))
26644 file ical-file ical-buffer category started org-agenda-new-buffers)
26650 org-combined-agenda-icalendar-file
26683 "Hook run after an iCalendar file has been saved.
26684 The iCalendar buffer is still current when this hook is run.
26685 A good way to use this is to tell a desktop calenndar application to re-read
26689 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26690 When COMBINE is non nil, add the category to each line."
26697 scheduledp deadlinep tmp pri category entry location summary desc
26707 inc t
26714 t org-icalendar-include-body)
26724 pos)
26729 ts)
26732 ;; donep (org-entry-is-done-p)
26733 ))
26752 t t summary)))
26759 %s
26760 %s%s
26761 SUMMARY:%s%s%s
26762 CATEGORIES:%s
26766 rrule summary
26771 category)))))
26776 ;; Get all the literal sexps
26802 )
26809 t org-icalendar-include-body)
26815 t t hd)))
26825 %s
26826 SUMMARY:%s%s%s
26827 CATEGORIES:%s
26828 SEQUENCE:1
26829 PRIORITY:%d
26830 STATUS:%s
26832 dts
26838 category pri status)))))))))
26841 "Take out stuff and quote what needs to be quoted.
26842 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26843 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26844 characters."
26846 nil
26865 s))
26868 "Clean-up description string."
26874 "Start an iCalendar file by inserting the header."
26880 VERSION:2.0
26881 X-WR-CALNAME:%s
26882 PRODID:-//%s//Emacs with Org-mode//EN
26883 X-WR-TIMEZONE:%s
26887 "Finish an iCalendar file by inserting the END statement."
26891 "Take a time string S and convert it to iCalendar format.
26892 KEYWORD is added in front, to make a complete line like DTSTART....
26893 When INC is non-nil, increase the hour by two (if time string contains
26894 a time), or the day by one (if it does not contain a time)."
26896 t2 fmt have-time time)
26912 ;;; XOXO export
26920 "Export the org buffer as XOXO.
26921 The XOXO buffer is named *xoxo-<source buffer name>*"
26923 ;; A quickie abstraction
26925 ;; Output everything as XOXO
26939 ;; Check the output buffer is empty.
26941 ;; Kick off the output
26958 ;; Handle level rendering
26975 )
26979 ;; And output the new li
26985 ;; Finally finish off the ol
26992 ;; Finish the buffer off and clean it up.
26997 )))
27000 ;;;; Key bindings
27002 ;; Make `C-c C-x' a prefix key
27005 ;; TAB key with modifiers
27012 ;; The following line is necessary under Suse GNU/Linux
27018 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
27019 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
27020 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
27022 ;; Cursor keys with modifiers
27023 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
27024 (org-defkey org-mode-map [(meta right)] 'org-metaright)
27025 (org-defkey org-mode-map [(meta up)] 'org-metaup)
27026 (org-defkey org-mode-map [(meta down)] 'org-metadown)
27028 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
27029 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
27030 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
27031 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
27033 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
27034 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
27035 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
27036 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
27038 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
27039 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
27041 ;;; Extra keys for tty access.
27042 ;; We only set them when really needed because otherwise the
27043 ;; menus don't show the simple keys
27045 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
27046 (not window-system))
27047 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
27048 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
27049 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
27050 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
27051 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
27052 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
27053 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
27054 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
27055 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
27056 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
27057 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
27058 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
27059 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
27060 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
27061 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
27062 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
27063 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
27064 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
27065 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
27066 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
27067 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
27068 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
27070 ;; All the other keys
27072 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
27073 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
27074 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
27075 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
27076 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
27077 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
27078 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
27079 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
27080 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
27081 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
27082 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
27083 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
27084 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
27085 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
27086 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
27088 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
27089 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
27090 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
27091 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
27092 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
27093 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
27094 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
27095 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
27096 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
27097 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
27098 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
27099 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
27100 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
27101 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
27102 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
27103 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
27104 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
27106 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
27107 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
27108 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
27109 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27110 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
27111 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
27112 (org-defkey org-mode-map "\C-c^" 'org-sort)
27113 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
27114 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
27115 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
27116 (org-defkey org-mode-map "\C-m" 'org-return)
27117 (org-defkey org-mode-map "\C-j" 'org-return-indent)
27118 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
27119 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
27120 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
27121 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
27122 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
27123 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
27124 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
27125 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
27126 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
27127 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
27128 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
27129 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
27130 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
27131 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
27132 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
27134 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
27135 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
27136 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
27137 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
27139 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
27140 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
27141 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
27142 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
27143 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
27144 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
27145 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
27146 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
27147 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
27148 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
27149 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
27150 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
27152 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
27154 (when (featurep 'xemacs)
27155 (org-defkey org-mode-map 'button3 'popup-mode-menu))
27157 (defsubst org-table-p () (org-at-table-p))
27159 (defun org-self-insert-command (N)
27160 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
27161 If the cursor is in a table looking at whitespace, the whitespace is
27162 overwritten, and the table is not marked as requiring realignment."
27163 (interactive "p")
27164 (if (and (org-table-p)
27165 (progn
27166 ;; check if we blank the field, and if that triggers align
27167 (and org-table-auto-blank-field
27168 (member last-command
27169 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
27171 ;; got extra space, this field does not determine column width
27172 (let (org-table-may-need-update) (org-table-blank-field))
27173 ;; no extra space, this field may determine column width
27174 (org-table-blank-field)))
27175 t)
27176 (eq N 1)
27178 (let (org-table-may-need-update)
27179 (goto-char (1- (match-end 0)))
27180 (delete-backward-char 1)
27181 (goto-char (match-beginning 0))
27182 (self-insert-command N))
27183 (setq org-table-may-need-update t)
27184 (self-insert-command N)
27185 (org-fix-tags-on-the-fly)))
27187 (defun org-fix-tags-on-the-fly ()
27188 (when (and (equal (char-after (point-at-bol)) ?*)
27189 (org-on-heading-p))
27190 (org-align-tags-here org-tags-column)))
27192 (defun org-delete-backward-char (N)
27193 "Like `delete-backward-char', insert whitespace at field end in tables.
27194 When deleting backwards, in tables this function will insert whitespace in
27196 still be marked for re-alignment if the field did fill the entire column,
27197 because, in this case the deletion might narrow the column."
27198 (interactive "p")
27199 (if (and (org-table-p)
27200 (eq N 1)
27201 (string-match "|" (buffer-substring (point-at-bol) (point)))
27202 (looking-at ".*?|"))
27203 (let ((pos (point))
27205 (c org-table-may-need-update))
27206 (backward-delete-char N)
27207 (skip-chars-forward "^|")
27208 (insert " ")
27209 (goto-char (1- pos))
27210 ;; noalign: if there were two spaces at the end, this field
27211 ;; does not determine the width of the column.
27212 (if noalign (setq org-table-may-need-update c)))
27213 (backward-delete-char N)
27214 (org-fix-tags-on-the-fly)))
27216 (defun org-delete-char (N)
27217 "Like `delete-char', but insert whitespace at field end in tables.
27218 When deleting characters, in tables this function will insert whitespace in
27220 still be marked for re-alignment if the field did fill the entire column,
27221 because, in this case the deletion might narrow the column."
27222 (interactive "p")
27223 (if (and (org-table-p)
27224 (not (bolp))
27225 (not (= (char-after) ?|))
27226 (eq N 1))
27227 (if (looking-at ".*?|")
27228 (let ((pos (point))
27230 (c org-table-may-need-update))
27231 (replace-match (concat
27232 (substring (match-string 0) 1 -1)
27233 " |"))
27234 (goto-char pos)
27235 ;; noalign: if there were two spaces at the end, this field
27236 ;; does not determine the width of the column.
27237 (if noalign (setq org-table-may-need-update c)))
27238 (delete-char N))
27239 (delete-char N)
27240 (org-fix-tags-on-the-fly)))
27242 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
27243 (put 'org-self-insert-command 'delete-selection t)
27244 (put 'orgtbl-self-insert-command 'delete-selection t)
27245 (put 'org-delete-char 'delete-selection 'supersede)
27246 (put 'org-delete-backward-char 'delete-selection 'supersede)
27248 ;; Make `flyspell-mode' delay after some commands
27249 (put 'org-self-insert-command 'flyspell-delayed t)
27250 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
27251 (put 'org-delete-char 'flyspell-delayed t)
27252 (put 'org-delete-backward-char 'flyspell-delayed t)
27254 ;; Make pabbrev-mode expand after org-mode commands
27255 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
27256 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
27258 ;; How to do this: Measure non-white length of current string
27259 ;; If equal to column width, we should realign.
27261 (defun org-remap (map &rest commands)
27262 "In MAP, remap the functions given in COMMANDS.
27263 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
27264 (let (new old)
27265 (while commands
27266 (setq old (pop commands) new (pop commands))
27267 (if (fboundp 'command-remapping)
27268 (org-defkey map (vector 'remap old) new)
27269 (substitute-key-definition old new map global-map)))))
27271 (when (eq org-enable-table-editor 'optimized)
27272 ;; If the user wants maximum table support, we need to hijack
27273 ;; some standard editing functions
27274 (org-remap org-mode-map
27275 'self-insert-command 'org-self-insert-command
27276 'delete-char 'org-delete-char
27277 'delete-backward-char 'org-delete-backward-char)
27278 (org-defkey org-mode-map "|" 'org-force-self-insert))
27280 (defun org-shiftcursor-error ()
27281 "Throw an error because Shift-Cursor command was applied in wrong context."
27282 (error "This command is active in special context like tables, headlines or timestamps"))
27284 (defun org-shifttab (&optional arg)
27285 "Global visibility cycling or move to previous table field.
27286 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
27287 on context.
27288 See the individual commands for more information."
27289 (interactive "P")
27290 (cond
27291 ((org-at-table-p) (call-interactively 'org-table-previous-field))
27292 (arg (message "Content view to level: ")
27293 (org-content (prefix-numeric-value arg))
27294 (setq org-cycle-global-status 'overview))
27295 (t (call-interactively 'org-global-cycle))))
27297 (defun org-shiftmetaleft ()
27298 "Promote subtree or delete table column.
27299 Calls `org-promote-subtree', `org-outdent-item',
27300 or `org-table-delete-column', depending on context.
27301 See the individual commands for more information."
27302 (interactive)
27303 (cond
27304 ((org-at-table-p) (call-interactively 'org-table-delete-column))
27305 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
27306 ((org-at-item-p) (call-interactively 'org-outdent-item))
27307 (t (org-shiftcursor-error))))
27309 (defun org-shiftmetaright ()
27310 "Demote subtree or insert table column.
27311 Calls `org-demote-subtree', `org-indent-item',
27312 or `org-table-insert-column', depending on context.
27313 See the individual commands for more information."
27314 (interactive)
27315 (cond
27316 ((org-at-table-p) (call-interactively 'org-table-insert-column))
27317 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
27318 ((org-at-item-p) (call-interactively 'org-indent-item))
27319 (t (org-shiftcursor-error))))
27321 (defun org-shiftmetaup (&optional arg)
27322 "Move subtree up or kill table row.
27323 Calls `org-move-subtree-up' or `org-table-kill-row' or
27324 `org-move-item-up' depending on context. See the individual commands
27325 for more information."
27326 (interactive "P")
27327 (cond
27328 ((org-at-table-p) (call-interactively 'org-table-kill-row))
27329 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27330 ((org-at-item-p) (call-interactively 'org-move-item-up))
27331 (t (org-shiftcursor-error))))
27332 (defun org-shiftmetadown (&optional arg)
27333 "Move subtree down or insert table row.
27334 Calls `org-move-subtree-down' or `org-table-insert-row' or
27335 `org-move-item-down', depending on context. See the individual
27336 commands for more information."
27337 (interactive "P")
27338 (cond
27339 ((org-at-table-p) (call-interactively 'org-table-insert-row))
27340 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27341 ((org-at-item-p) (call-interactively 'org-move-item-down))
27342 (t (org-shiftcursor-error))))
27344 (defun org-metaleft (&optional arg)
27345 "Promote heading or move table column to left.
27346 Calls `org-do-promote' or `org-table-move-column', depending on context.
27347 With no specific context, calls the Emacs default `backward-word'.
27348 See the individual commands for more information."
27349 (interactive "P")
27350 (cond
27351 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
27352 ((or (org-on-heading-p) (org-region-active-p))
27353 (call-interactively 'org-do-promote))
27354 ((org-at-item-p) (call-interactively 'org-outdent-item))
27355 (t (call-interactively 'backward-word))))
27357 (defun org-metaright (&optional arg)
27358 "Demote subtree or move table column to right.
27359 Calls `org-do-demote' or `org-table-move-column', depending on context.
27360 With no specific context, calls the Emacs default `forward-word'.
27361 See the individual commands for more information."
27362 (interactive "P")
27363 (cond
27364 ((org-at-table-p) (call-interactively 'org-table-move-column))
27365 ((or (org-on-heading-p) (org-region-active-p))
27366 (call-interactively 'org-do-demote))
27367 ((org-at-item-p) (call-interactively 'org-indent-item))
27368 (t (call-interactively 'forward-word))))
27370 (defun org-metaup (&optional arg)
27371 "Move subtree up or move table row up.
27372 Calls `org-move-subtree-up' or `org-table-move-row' or
27373 `org-move-item-up', depending on context. See the individual commands
27374 for more information."
27375 (interactive "P")
27376 (cond
27377 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
27378 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27379 ((org-at-item-p) (call-interactively 'org-move-item-up))
27380 (t (transpose-lines 1) (beginning-of-line -1))))
27382 (defun org-metadown (&optional arg)
27383 "Move subtree down or move table row down.
27384 Calls `org-move-subtree-down' or `org-table-move-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-move-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 (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
27394 (defun org-shiftup (&optional arg)
27395 "Increase item in timestamp or increase priority of current headline.
27396 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
27397 depending on context. See the individual commands for more information."
27398 (interactive "P")
27399 (cond
27400 ((org-at-timestamp-p t)
27401 (call-interactively (if org-edit-timestamp-down-means-later
27402 'org-timestamp-down 'org-timestamp-up)))
27403 ((org-on-heading-p) (call-interactively 'org-priority-up))
27404 ((org-at-item-p) (call-interactively 'org-previous-item))
27405 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
27407 (defun org-shiftdown (&optional arg)
27408 "Decrease item in timestamp or decrease priority of current headline.
27409 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
27410 depending on context. See the individual commands for more information."
27411 (interactive "P")
27412 (cond
27413 ((org-at-timestamp-p t)
27414 (call-interactively (if org-edit-timestamp-down-means-later
27415 'org-timestamp-up 'org-timestamp-down)))
27416 ((org-on-heading-p) (call-interactively 'org-priority-down))
27417 (t (call-interactively 'org-next-item))))
27419 (defun org-shiftright ()
27420 "Next TODO keyword or timestamp one day later, depending on context."
27421 (interactive)
27422 (cond
27423 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
27424 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
27425 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
27426 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
27427 (t (org-shiftcursor-error))))
27429 (defun org-shiftleft ()
27430 "Previous TODO keyword or timestamp one day earlier, depending on context."
27431 (interactive)
27432 (cond
27433 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
27434 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
27435 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
27436 ((org-at-property-p)
27437 (call-interactively 'org-property-previous-allowed-value))
27438 (t (org-shiftcursor-error))))
27440 (defun org-shiftcontrolright ()
27441 "Switch to next TODO set."
27442 (interactive)
27443 (cond
27444 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
27445 (t (org-shiftcursor-error))))
27447 (defun org-shiftcontrolleft ()
27448 "Switch to previous TODO set."
27449 (interactive)
27450 (cond
27451 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
27452 (t (org-shiftcursor-error))))
27454 (defun org-ctrl-c-ret ()
27455 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
27456 (interactive)
27457 (cond
27458 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27459 (t (call-interactively 'org-insert-heading))))
27461 (defun org-copy-special ()
27462 "Copy region in table or copy current subtree.
27463 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27464 See the individual commands for more information."
27465 (interactive)
27466 (call-interactively
27467 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27469 (defun org-cut-special ()
27470 "Cut region in table or cut current subtree.
27471 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27472 See the individual commands for more information."
27473 (interactive)
27474 (call-interactively
27475 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27477 (defun org-paste-special (arg)
27478 "Paste rectangular region into table, or past subtree relative to level.
27479 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27480 See the individual commands for more information."
27481 (interactive "P")
27482 (if (org-at-table-p)
27483 (org-table-paste-rectangle)
27484 (org-paste-subtree arg)))
27486 (defun org-ctrl-c-ctrl-c (&optional arg)
27487 "Set tags in headline, or update according to changed information at point.
27489 This command does many different things, depending on context:
27491 - If the cursor is in a headline, prompt for tags and insert them
27492 into the current line, aligned to `org-tags-column'. When called
27493 with prefix arg, realign all tags in the current buffer.
27495 - If the cursor is in one of the special #+KEYWORD lines, this
27496 triggers scanning the buffer for these lines and updating the
27497 information.
27499 - If the cursor is inside a table, realign the table. This command
27500 works even if the automatic table editor has been turned off.
27502 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27503 the entire table.
27505 - If the cursor is a the beginning of a dynamic block, update it.
27507 - If the cursor is inside a table created by the table.el package,
27508 activate that table.
27510 - If the current buffer is a remember buffer, close note and file it.
27511 with a prefix argument, file it without further interaction to the default
27512 location.
27514 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27515 links in this buffer.
27517 - If the cursor is on a numbered item in a plain list, renumber the
27518 ordered list.
27520 - If the cursor is on a checkbox, toggle it."
27521 (interactive "P")
27522 (let ((org-enable-table-editor t))
27523 (cond
27524 ((or org-clock-overlays
27525 org-occur-highlights
27526 org-latex-fragment-image-overlays)
27527 (org-remove-clock-overlays)
27528 (org-remove-occur-highlights)
27529 (org-remove-latex-fragment-image-overlays)
27530 (message "Temporary highlights/overlays removed from current buffer"))
27531 ((and (local-variable-p 'org-finish-function (current-buffer))
27532 (fboundp org-finish-function))
27533 (funcall org-finish-function))
27534 ((org-at-property-p)
27535 (call-interactively 'org-property-action))
27536 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27537 ((org-on-heading-p) (call-interactively 'org-set-tags))
27538 ((org-at-table.el-p)
27539 (require 'table)
27540 (beginning-of-line 1)
27541 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27542 (call-interactively 'table-recognize-table))
27543 ((org-at-table-p)
27544 (org-table-maybe-eval-formula)
27545 (if arg
27546 (call-interactively 'org-table-recalculate)
27547 (org-table-maybe-recalculate-line))
27548 (call-interactively 'org-table-align))
27549 ((org-at-item-checkbox-p)
27550 (call-interactively 'org-toggle-checkbox))
27551 ((org-at-item-p)
27552 (call-interactively 'org-maybe-renumber-ordered-list))
27554 ;; Dynamic block
27555 (beginning-of-line 1)
27556 (org-update-dblock))
27558 (cond
27559 ((equal (match-string 1) "TBLFM")
27560 ;; Recalculate the table before this line
27561 (save-excursion
27562 (beginning-of-line 1)
27564 (if (org-at-table-p)
27565 (org-call-with-arg 'org-table-recalculate t))))
27566 (t
27567 (call-interactively 'org-mode-restart))))
27568 (t (error "C-c C-c can do nothing useful at this location.")))))
27570 (defun org-mode-restart ()
27571 "Restart Org-mode, to scan again for special lines.
27572 Also updates the keyword regular expressions."
27573 (interactive)
27574 (let ((org-inhibit-startup t)) (org-mode))
27575 (message "Org-mode restarted to refresh keyword and special line setup"))
27577 (defun org-kill-note-or-show-branches ()
27578 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27579 (interactive)
27580 (if (not org-finish-function)
27581 (call-interactively 'show-branches)
27582 (let ((org-note-abort t))
27583 (funcall org-finish-function))))
27585 (defun org-return (&optional indent)
27586 "Goto next table row or insert a newline.
27587 Calls `org-table-next-row' or `newline', depending on context.
27588 See the individual commands for more information."
27589 (interactive)
27590 (cond
27591 ((bobp) (if indent (newline-and-indent) (newline)))
27592 ((and (org-at-heading-p)
27593 (looking-at
27595 (org-show-entry)
27596 (end-of-line 1)
27597 (newline))
27598 ((org-at-table-p)
27599 (org-table-justify-field-maybe)
27600 (call-interactively 'org-table-next-row))
27601 (t (if indent (newline-and-indent) (newline)))))
27603 (defun org-return-indent ()
27604 "Goto next table row or insert a newline and indent.
27605 Calls `org-table-next-row' or `newline-and-indent', depending on
27606 context. See the individual commands for more information."
27607 (interactive)
27608 (org-return t))
27610 (defun org-ctrl-c-star ()
27611 "Compute table, or change heading status of lines.
27612 Calls `org-table-recalculate' or `org-toggle-region-headlines',
27613 depending on context. This will also turn a plain list item or a normal
27614 line into a subheading."
27615 (interactive)
27616 (cond
27617 ((org-at-table-p)
27618 (call-interactively 'org-table-recalculate))
27619 ((org-region-active-p)
27620 ;; Convert all lines in region to list items
27621 (call-interactively 'org-toggle-region-headings))
27622 ((org-on-heading-p)
27623 (org-toggle-region-headings (point-at-bol)
27624 (min (1+ (point-at-eol)) (point-max))))
27625 ((org-at-item-p)
27626 ;; Convert to heading
27627 ;; FIXME: not yet implemented
27628 )
27629 (t (org-toggle-region-headings (point-at-bol)
27630 (min (1+ (point-at-eol)) (point-max))))))
27632 (defun org-ctrl-c-minus ()
27633 "Insert separator line in table or modify bullet status of line.
27634 Also turns a plain line or a region of lines into list items.
27635 Calls `org-table-insert-hline', `org-toggle-region-items', or
27636 `org-cycle-list-bullet', depending on context."
27637 (interactive)
27638 (cond
27639 ((org-at-table-p)
27640 (call-interactively 'org-table-insert-hline))
27641 ((org-on-heading-p)
27642 ;; Convert to item
27643 (save-excursion
27644 (beginning-of-line 1)
27646 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27647 ((org-region-active-p)
27648 ;; Convert all lines in region to list items
27649 (call-interactively 'org-toggle-region-items))
27650 ((org-in-item-p)
27651 (call-interactively 'org-cycle-list-bullet))
27652 (t (org-toggle-region-items (point-at-bol)
27653 (min (1+ (point-at-eol)) (point-max))))))
27655 (defun org-toggle-region-items (beg end)
27656 "Convert all lines in region to list items.
27657 If the first line is already an item, convert all list items in the region
27658 to normal lines."
27659 (interactive "r")
27660 (let (l2 l)
27661 (save-excursion
27662 (goto-char end)
27663 (setq l2 (org-current-line))
27664 (goto-char beg)
27665 (beginning-of-line 1)
27666 (setq l (1- (org-current-line)))
27667 (if (org-at-item-p)
27668 ;; We already have items, de-itemize
27669 (while (< (setq l (1+ l)) l2)
27670 (when (org-at-item-p)
27671 (goto-char (match-beginning 2))
27672 (delete-region (match-beginning 2) (match-end 2))
27674 (beginning-of-line 2))
27675 (while (< (setq l (1+ l)) l2)
27676 (unless (org-at-item-p)
27679 (beginning-of-line 2))))))
27681 (defun org-toggle-region-headings (beg end)
27682 "Convert all lines in region to list items.
27683 If the first line is already an item, convert all list items in the region
27684 to normal lines."
27685 (interactive "r")
27686 (let (l2 l)
27687 (save-excursion
27688 (goto-char end)
27689 (setq l2 (org-current-line))
27690 (goto-char beg)
27691 (beginning-of-line 1)
27692 (setq l (1- (org-current-line)))
27693 (if (org-on-heading-p)
27694 ;; We already have headlines, de-star them
27695 (while (< (setq l (1+ l)) l2)
27696 (when (org-on-heading-p t)
27697 (and (looking-at outline-regexp) (replace-match "")))
27698 (beginning-of-line 2))
27699 (let* ((stars (save-excursion
27700 (re-search-backward org-complex-heading-regexp nil t)
27701 (or (match-string 1) "*")))
27702 (add-stars (if org-odd-levels-only "**" "*"))
27704 (while (< (setq l (1+ l)) l2)
27705 (unless (org-on-heading-p)
27707 (replace-match rpl)))
27708 (beginning-of-line 2)))))))
27710 (defun org-meta-return (&optional arg)
27711 "Insert a new heading or wrap a region in a table.
27712 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27713 See the individual commands for more information."
27714 (interactive "P")
27715 (cond
27716 ((org-at-table-p)
27717 (call-interactively 'org-table-wrap-region))
27718 (t (call-interactively 'org-insert-heading))))
27720 ;;; Menu entries
27722 ;; Define the Org-mode menus
27723 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27724 '("Tbl"
27725 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27726 ["Next Field" org-cycle (org-at-table-p)]
27727 ["Previous Field" org-shifttab (org-at-table-p)]
27728 ["Next Row" org-return (org-at-table-p)]
27729 "--"
27730 ["Blank Field" org-table-blank-field (org-at-table-p)]
27731 ["Edit Field" org-table-edit-field (org-at-table-p)]
27732 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27733 "--"
27734 ("Column"
27735 ["Move Column Left" org-metaleft (org-at-table-p)]
27736 ["Move Column Right" org-metaright (org-at-table-p)]
27737 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27738 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27739 ("Row"
27740 ["Move Row Up" org-metaup (org-at-table-p)]
27741 ["Move Row Down" org-metadown (org-at-table-p)]
27742 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27743 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27744 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27745 "--"
27746 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27747 ("Rectangle"
27748 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27749 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27750 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27751 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27752 "--"
27753 ("Calculate"
27754 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27755 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27756 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27757 "--"
27758 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27759 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27760 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27761 "--"
27762 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27763 "--"
27764 ["Sum Column/Rectangle" org-table-sum
27765 (or (org-at-table-p) (org-region-active-p))]
27766 ["Which Column?" org-table-current-column (org-at-table-p)])
27767 ["Debug Formulas"
27768 org-table-toggle-formula-debugger
27769 :style toggle :selected org-table-formula-debug]
27770 ["Show Col/Row Numbers"
27771 org-table-toggle-coordinate-overlays
27772 :style toggle :selected org-table-overlay-coordinates]
27773 "--"
27774 ["Create" org-table-create (and (not (org-at-table-p))
27775 org-enable-table-editor)]
27776 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27777 ["Import from File" org-table-import (not (org-at-table-p))]
27778 ["Export to File" org-table-export (org-at-table-p)]
27779 "--"
27780 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27782 (easy-menu-define org-org-menu org-mode-map "Org menu"
27783 '("Org"
27784 ("Show/Hide"
27785 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27786 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27787 ["Sparse Tree" org-occur t]
27788 ["Reveal Context" org-reveal t]
27789 ["Show All" show-all t]
27790 "--"
27791 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27792 "--"
27793 ["New Heading" org-insert-heading t]
27794 ("Navigate Headings"
27795 ["Up" outline-up-heading t]
27796 ["Next" outline-next-visible-heading t]
27797 ["Previous" outline-previous-visible-heading t]
27798 ["Next Same Level" outline-forward-same-level t]
27799 ["Previous Same Level" outline-backward-same-level t]
27800 "--"
27801 ["Jump" org-goto t])
27802 ("Edit Structure"
27803 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27804 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27805 "--"
27806 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27807 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27808 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27809 "--"
27810 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27811 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27812 ["Demote Heading" org-metaright (not (org-at-table-p))]
27813 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27814 "--"
27815 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27816 "--"
27817 ["Convert to odd levels" org-convert-to-odd-levels t]
27818 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27819 ("Editing"
27820 ["Emphasis..." org-emphasize t])
27821 ("Archive"
27822 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27823 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27824 ; :active t :keys "C-u C-c C-x C-a"]
27825 ["Sparse trees open ARCHIVE trees"
27826 (setq org-sparse-tree-open-archived-trees
27827 (not org-sparse-tree-open-archived-trees))
27828 :style toggle :selected org-sparse-tree-open-archived-trees]
27829 ["Cycling opens ARCHIVE trees"
27830 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27831 :style toggle :selected org-cycle-open-archived-trees]
27832 ["Agenda includes ARCHIVE trees"
27833 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27834 :style toggle :selected (not org-agenda-skip-archived-trees)]
27835 "--"
27836 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27837 ; ["Check and Move Children" (org-archive-subtree '(4))
27838 ; :active t :keys "C-u C-c C-x C-s"]
27839 )
27840 "--"
27841 ("TODO Lists"
27842 ["TODO/DONE/-" org-todo t]
27843 ("Select keyword"
27844 ["Next keyword" org-shiftright (org-on-heading-p)]
27845 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27846 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27847 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27848 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27849 ["Show TODO Tree" org-show-todo-tree t]
27850 ["Global TODO list" org-todo-list t]
27851 "--"
27852 ["Set Priority" org-priority t]
27853 ["Priority Up" org-shiftup t]
27854 ["Priority Down" org-shiftdown t])
27855 ("TAGS and Properties"
27856 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27857 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27858 "--"
27859 ["Set property" 'org-set-property t]
27860 ["Column view of properties" org-columns t]
27861 ["Insert Column View DBlock" org-insert-columns-dblock t])
27862 ("Dates and Scheduling"
27863 ["Timestamp" org-time-stamp t]
27864 ["Timestamp (inactive)" org-time-stamp-inactive t]
27865 ("Change Date"
27866 ["1 Day Later" org-shiftright t]
27867 ["1 Day Earlier" org-shiftleft t]
27868 ["1 ... Later" org-shiftup t]
27869 ["1 ... Earlier" org-shiftdown t])
27870 ["Compute Time Range" org-evaluate-time-range t]
27871 ["Schedule Item" org-schedule t]
27872 ["Deadline" org-deadline t]
27873 "--"
27874 ["Custom time format" org-toggle-time-stamp-overlays
27875 :style radio :selected org-display-custom-times]
27876 "--"
27877 ["Goto Calendar" org-goto-calendar t]
27878 ["Date from Calendar" org-date-from-calendar t])
27879 ("Logging work"
27880 ["Clock in" org-clock-in t]
27881 ["Clock out" org-clock-out t]
27882 ["Clock cancel" org-clock-cancel t]
27883 ["Goto running clock" org-clock-goto t]
27884 ["Display times" org-clock-display t]
27885 ["Create clock table" org-clock-report t]
27886 "--"
27887 ["Record DONE time"
27888 (progn (setq org-log-done (not org-log-done))
27889 (message "Switching to %s will %s record a timestamp"
27890 (car org-done-keywords)
27891 (if org-log-done "automatically" "not")))
27892 :style toggle :selected org-log-done])
27893 "--"
27894 ["Agenda Command..." org-agenda t]
27895 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27896 ("File List for Agenda")
27897 ("Special views current file"
27898 ["TODO Tree" org-show-todo-tree t]
27899 ["Check Deadlines" org-check-deadlines t]
27900 ["Timeline" org-timeline t]
27901 ["Tags Tree" org-tags-sparse-tree t])
27902 "--"
27903 ("Hyperlinks"
27904 ["Store Link (Global)" org-store-link t]
27905 ["Insert Link" org-insert-link t]
27906 ["Follow Link" org-open-at-point t]
27907 "--"
27908 ["Next link" org-next-link t]
27909 ["Previous link" org-previous-link t]
27910 "--"
27911 ["Descriptive Links"
27912 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27913 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27914 ["Literal Links"
27915 (progn
27916 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27917 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27918 "--"
27919 ["Export/Publish..." org-export t]
27920 ("LaTeX"
27921 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27922 :selected org-cdlatex-mode]
27923 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27924 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27925 ["Modify math symbol" org-cdlatex-math-modify
27926 (org-inside-LaTeX-fragment-p)]
27927 ["Export LaTeX fragments as images"
27928 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27929 :style toggle :selected org-export-with-LaTeX-fragments])
27930 "--"
27931 ("Documentation"
27932 ["Show Version" org-version t]
27933 ["Info Documentation" org-info t])
27934 ("Customize"
27935 ["Browse Org Group" org-customize t]
27936 "--"
27937 ["Expand This Menu" org-create-customize-menu
27938 (fboundp 'customize-menu-create)])
27939 "--"
27940 ["Refresh setup" org-mode-restart t]
27941 ))
27943 (defun org-info (&optional node)
27944 "Read documentation for Org-mode in the info system.
27945 With optional NODE, go directly to that node."
27946 (interactive)
27947 (info (format "(org)%s" (or node ""))))
27949 (defun org-install-agenda-files-menu ()
27950 (let ((bl (buffer-list)))
27951 (save-excursion
27952 (while bl
27953 (set-buffer (pop bl))
27954 (if (org-mode-p) (setq bl nil)))
27955 (when (org-mode-p)
27956 (easy-menu-change
27957 '("Org") "File List for Agenda"
27958 (append
27959 (list
27960 ["Edit File List" (org-edit-agenda-file-list) t]
27961 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27962 ["Remove Current File from List" org-remove-file t]
27963 ["Cycle through agenda files" org-cycle-agenda-files t]
27964 ["Occur in all agenda files" org-occur-in-agenda-files t]
27965 "--")
27966 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27968 ;;;; Documentation
27970 (defun org-customize ()
27971 "Call the customize function with org as argument."
27972 (interactive)
27973 (customize-browse 'org))
27975 (defun org-create-customize-menu ()
27976 "Create a full customization menu for Org-mode, insert it into the menu."
27977 (interactive)
27978 (if (fboundp 'customize-menu-create)
27979 (progn
27980 (easy-menu-change
27981 '("Org") "Customize"
27982 `(["Browse Org group" org-customize t]
27983 "--"
27984 ,(customize-menu-create 'org)
27985 ["Set" Custom-set t]
27986 ["Save" Custom-save t]
27987 ["Reset to Current" Custom-reset-current t]
27988 ["Reset to Saved" Custom-reset-saved t]
27989 ["Reset to Standard Settings" Custom-reset-standard t]))
27991 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27993 ;;;; Miscellaneous stuff
27996 ;;; Generally useful functions
27998 (defun org-context ()
27999 "Return a list of contexts of the current cursor position.
28000 If several contexts apply, all are returned.
28001 Each context entry is a list with a symbol naming the context, and
28002 two positions indicating start and end of the context. Possible
28003 contexts are:
28005 :headline anywhere in a headline
28006 :headline-stars on the leading stars in a headline
28007 :todo-keyword on a TODO keyword (including DONE) in a headline
28008 :tags on the TAGS in a headline
28009 :priority on the priority cookie in a headline
28010 :item on the first line of a plain list item
28011 :item-bullet on the bullet/number of a plain list item
28012 :checkbox on the checkbox in a plain list item
28013 :table in an org-mode table
28014 :table-special on a special filed in a table
28015 :table-table in a table.el table
28016 :link on a hyperlink
28017 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
28018 :target on a <<target>>
28019 :radio-target on a <<<radio-target>>>
28020 :latex-fragment on a LaTeX fragment
28021 :latex-preview on a LaTeX fragment with overlayed preview image
28023 This function expects the position to be visible because it uses font-lock
28024 faces as a help to recognize the following contexts: :table-special, :link,
28025 and :keyword."
28026 (let* ((f (get-text-property (point) 'face))
28027 (faces (if (listp f) f (list f)))
28028 (p (point)) clist o)
28029 ;; First the large context
28030 (cond
28031 ((org-on-heading-p t)
28032 (push (list :headline (point-at-bol) (point-at-eol)) clist)
28033 (when (progn
28034 (beginning-of-line 1)
28035 (looking-at org-todo-line-tags-regexp))
28036 (push (org-point-in-group p 1 :headline-stars) clist)
28037 (push (org-point-in-group p 2 :todo-keyword) clist)
28038 (push (org-point-in-group p 4 :tags) clist))
28039 (goto-char p)
28042 (push (org-point-in-group p 0 :priority) clist)))
28044 ((org-at-item-p)
28045 (push (org-point-in-group p 2 :item-bullet) clist)
28046 (push (list :item (point-at-bol)
28047 (save-excursion (org-end-of-item) (point)))
28048 clist)
28049 (and (org-at-item-checkbox-p)
28050 (push (org-point-in-group p 0 :checkbox) clist)))
28052 ((org-at-table-p)
28053 (push (list :table (org-table-begin) (org-table-end)) clist)
28054 (if (memq 'org-formula faces)
28055 (push (list :table-special
28056 (previous-single-property-change p 'face)
28057 (next-single-property-change p 'face)) clist)))
28058 ((org-at-table-p 'any)
28059 (push (list :table-table) clist)))
28060 (goto-char p)
28062 ;; Now the small context
28063 (cond
28064 ((org-at-timestamp-p)
28065 (push (org-point-in-group p 0 :timestamp) clist))
28066 ((memq 'org-link faces)
28067 (push (list :link
28068 (previous-single-property-change p 'face)
28069 (next-single-property-change p 'face)) clist))
28070 ((memq 'org-special-keyword faces)
28071 (push (list :keyword
28072 (previous-single-property-change p 'face)
28073 (next-single-property-change p 'face)) clist))
28074 ((org-on-target-p)
28075 (push (org-point-in-group p 0 :target) clist)
28076 (goto-char (1- (match-beginning 0)))
28077 (if (looking-at org-radio-target-regexp)
28078 (push (org-point-in-group p 0 :radio-target) clist))
28079 (goto-char p))
28080 ((setq o (car (delq nil
28081 (mapcar
28082 (lambda (x)
28083 (if (memq x org-latex-fragment-image-overlays) x))
28084 (org-overlays-at (point))))))
28085 (push (list :latex-fragment
28086 (org-overlay-start o) (org-overlay-end o)) clist)
28087 (push (list :latex-preview
28088 (org-overlay-start o) (org-overlay-end o)) clist))
28089 ((org-inside-LaTeX-fragment-p)
28090 ;; FIXME: positions wrong.
28091 (push (list :latex-fragment (point) (point)) clist)))
28093 (setq clist (nreverse (delq nil clist)))
28094 clist))
28096 ;; FIXME: Compare with at-regexp-p Do we need both?
28097 (defun org-in-regexp (re &optional nlines visually)
28098 "Check if point is inside a match of regexp.
28099 Normally only the current line is checked, but you can include NLINES extra
28100 lines both before and after point into the search.
28101 If VISUALLY is set, require that the cursor is not after the match but
28102 really on, so that the block visually is on the match."
28103 (catch 'exit
28104 (let ((pos (point))
28105 (eol (point-at-eol (+ 1 (or nlines 0))))
28106 (inc (if visually 1 0)))
28107 (save-excursion
28108 (beginning-of-line (- 1 (or nlines 0)))
28109 (while (re-search-forward re eol t)
28110 (if (and (<= (match-beginning 0) pos)
28111 (>= (+ inc (match-end 0)) pos))
28112 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
28114 (defun org-at-regexp-p (regexp)
28115 "Is point inside a match of REGEXP in the current line?"
28116 (catch 'exit
28117 (save-excursion
28118 (let ((pos (point)) (end (point-at-eol)))
28119 (beginning-of-line 1)
28120 (while (re-search-forward regexp end t)
28121 (if (and (<= (match-beginning 0) pos)
28122 (>= (match-end 0) pos))
28123 (throw 'exit t)))
28124 nil))))
28126 (defun org-occur-in-agenda-files (regexp &optional nlines)
28127 "Call `multi-occur' with buffers for all agenda files."
28129 (let* ((files (org-agenda-files))
28130 (tnames (mapcar 'file-truename files))
28131 (extra org-agenda-text-search-extra-files)
28132 f)
28133 (while (setq f (pop extra))
28134 (unless (member (file-truename f) tnames)
28135 (add-to-list 'files f 'append)
28136 (add-to-list 'tnames (file-truename f) 'append)))
28137 (multi-occur
28138 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
28139 regexp)))
28141 (if (boundp 'occur-mode-find-occurrence-hook)
28142 ;; Emacs 23
28143 (add-hook 'occur-mode-find-occurrence-hook
28144 (lambda ()
28145 (when (org-mode-p)
28146 (org-reveal))))
28147 ;; Emacs 22
28148 (defadvice occur-mode-goto-occurrence
28149 (after org-occur-reveal activate)
28150 (and (org-mode-p) (org-reveal)))
28151 (defadvice occur-mode-goto-occurrence-other-window
28152 (after org-occur-reveal activate)
28153 (and (org-mode-p) (org-reveal)))
28154 (defadvice occur-mode-display-occurrence
28155 (after org-occur-reveal activate)
28156 (when (org-mode-p)
28157 (let ((pos (occur-mode-find-occurrence)))
28158 (with-current-buffer (marker-buffer pos)
28159 (save-excursion
28160 (goto-char pos)
28161 (org-reveal)))))))
28163 (defun org-uniquify (list)
28164 "Remove duplicate elements from LIST."
28165 (let (res)
28166 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
28167 res))
28169 (defun org-delete-all (elts list)
28170 "Remove all elements in ELTS from LIST."
28171 (while elts
28172 (setq list (delete (pop elts) list)))
28173 list)
28175 (defun org-back-over-empty-lines ()
28176 "Move backwards over witespace, to the beginning of the first empty line.
28177 Returns the number o empty lines passed."
28178 (let ((pos (point)))
28180 (beginning-of-line 2)
28181 (goto-char (min (point) pos))
28182 (count-lines (point) pos)))
28184 (defun org-skip-whitespace ()
28187 (defun org-point-in-group (point group &optional context)
28188 "Check if POINT is in match-group GROUP.
28189 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
28190 match. If the match group does ot exist or point is not inside it,
28191 return nil."
28192 (and (match-beginning group)
28193 (>= point (match-beginning group))
28194 (<= point (match-end group))
28195 (if context
28196 (list context (match-beginning group) (match-end group))
28197 t)))
28199 (defun org-switch-to-buffer-other-window (&rest args)
28200 "Switch to buffer in a second window on the current frame.
28201 In particular, do not allow pop-up frames."
28202 (let (pop-up-frames special-display-buffer-names special-display-regexps
28203 special-display-function)
28204 (apply 'switch-to-buffer-other-window args)))
28206 (defun org-combine-plists (&rest plists)
28207 "Create a single property list from all plists in PLISTS.
28208 The process starts by copying the first list, and then setting properties
28209 from the other lists. Settings in the last list are the most significant
28210 ones and overrule settings in the other lists."
28211 (let ((rtn (copy-sequence (pop plists)))
28212 p v ls)
28213 (while plists
28214 (setq ls (pop plists))
28215 (while ls
28216 (setq p (pop ls) v (pop ls))
28217 (setq rtn (plist-put rtn p v))))
28218 rtn))
28220 (defun org-move-line-down (arg)
28221 "Move the current line down. With prefix argument, move it past ARG lines."
28222 (interactive "p")
28223 (let ((col (current-column))
28224 beg end pos)
28225 (beginning-of-line 1) (setq beg (point))
28226 (beginning-of-line 2) (setq end (point))
28227 (beginning-of-line (+ 1 arg))
28228 (setq pos (move-marker (make-marker) (point)))
28229 (insert (delete-and-extract-region beg end))
28230 (goto-char pos)
28231 (move-to-column col)))
28233 (defun org-move-line-up (arg)
28234 "Move the current line up. With prefix argument, move it past ARG lines."
28235 (interactive "p")
28236 (let ((col (current-column))
28237 beg end pos)
28238 (beginning-of-line 1) (setq beg (point))
28239 (beginning-of-line 2) (setq end (point))
28240 (beginning-of-line (- arg))
28241 (setq pos (move-marker (make-marker) (point)))
28242 (insert (delete-and-extract-region beg end))
28243 (goto-char pos)
28244 (move-to-column col)))
28246 (defun org-replace-escapes (string table)
28247 "Replace %-escapes in STRING with values in TABLE.
28249 The sequences in STRING may contain normal field width and padding information,
28251 so values can contain further %-escapes if they are define later in TABLE."
28252 (let ((case-fold-search nil)
28253 e re rpl)
28254 (while (setq e (pop table))
28255 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
28256 (while (string-match re string)
28257 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
28258 (cdr e)))
28259 (setq string (replace-match rpl t t string))))
28260 string))
28263 (defun org-sublist (list start end)
28264 "Return a section of LIST, from START to END.
28265 Counting starts at 1."
28266 (let (rtn (c start))
28267 (setq list (nthcdr (1- start) list))
28268 (while (and list (<= c end))
28269 (push (pop list) rtn)
28270 (setq c (1+ c)))
28271 (nreverse rtn)))
28273 (defun org-find-base-buffer-visiting (file)
28274 "Like `find-buffer-visiting' but alway return the base buffer and
28275 not an indirect buffer"
28276 (let ((buf (find-buffer-visiting file)))
28277 (if buf
28278 (or (buffer-base-buffer buf) buf)
28279 nil)))
28281 (defun org-image-file-name-regexp ()
28282 "Return regexp matching the file names of images."
28283 (if (fboundp 'image-file-name-regexp)
28284 (image-file-name-regexp)
28285 (let ((image-file-name-extensions
28286 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
28287 "xbm" "xpm" "pbm" "pgm" "ppm")))
28289 (regexp-opt (nconc (mapcar 'upcase
28290 image-file-name-extensions)
28291 image-file-name-extensions)
28292 t)
28295 (defun org-file-image-p (file)
28296 "Return non-nil if FILE is an image."
28297 (save-match-data
28298 (string-match (org-image-file-name-regexp) file)))
28300 ;;; Paragraph filling stuff.
28301 ;; We want this to be just right, so use the full arsenal.
28303 (defun org-indent-line-function ()
28304 "Indent line like previous, but further if previous was headline or item."
28305 (interactive)
28306 (let* ((pos (point))
28307 (itemp (org-at-item-p))
28308 column bpos bcol tpos tcol bullet btype bullet-type)
28309 ;; Find the previous relevant line
28310 (beginning-of-line 1)
28311 (cond
28312 ((looking-at "#") (setq column 0))
28314 (t
28315 (beginning-of-line 0)
28317 (beginning-of-line 0))
28318 (cond
28320 (goto-char (match-end 0))
28321 (setq column (current-column)))
28322 ((org-in-item-p)
28323 (org-beginning-of-item)
28326 (setq bpos (match-beginning 1) tpos (match-end 0)
28327 bcol (progn (goto-char bpos) (current-column))
28328 tcol (progn (goto-char tpos) (current-column))
28329 bullet (match-string 1)
28330 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
28331 (if (not itemp)
28332 (setq column tcol)
28333 (goto-char pos)
28334 (beginning-of-line 1)
28336 (progn
28338 (setq bullet (match-string 1)
28339 btype (if (string-match "[0-9]" bullet) "n" bullet))
28340 (setq column (if (equal btype bullet-type) bcol tcol)))
28341 (setq column (org-get-indentation)))))
28342 (t (setq column (org-get-indentation))))))
28343 (goto-char pos)
28344 (if (<= (current-column) (current-indentation))
28345 (indent-line-to column)
28346 (save-excursion (indent-line-to column)))
28347 (setq column (current-column))
28348 (beginning-of-line 1)
28349 (if (looking-at
28352 (match-string 2) (match-string 3)))
28353 t nil))
28354 (move-to-column column)))
28356 (defun org-set-autofill-regexps ()
28357 (interactive)
28358 ;; In the paragraph separator we include headlines, because filling
28359 ;; text in a line directly attached to a headline would otherwise
28360 ;; fill the headline as well.
28363 ;; The paragraph starter includes hand-formatted lists.
28364 (org-set-local 'paragraph-start
28366 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
28367 ;; But only if the user has not turned off tables or fixed-width regions
28368 (org-set-local
28369 'auto-fill-inhibit-regexp
28372 (if (or org-enable-table-editor org-enable-fixed-width-editor)
28373 (concat
28375 (if org-enable-table-editor "|" "")
28376 (if org-enable-fixed-width-editor ":" "")
28377 "]"))))
28378 ;; We use our own fill-paragraph function, to make sure that tables
28379 ;; and fixed-width regions are not wrapped. That function will pass
28380 ;; through to `fill-paragraph' when appropriate.
28381 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
28382 ; Adaptive filling: To get full control, first make sure that
28383 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
28385 (org-set-local 'adaptive-fill-function
28386 'org-adaptive-fill-function)
28387 (org-set-local
28388 'align-mode-rules-list
28389 '((org-in-buffer-settings
28391 (modes . '(org-mode))))))
28393 (defun org-fill-paragraph (&optional justify)
28394 "Re-align a table, pass through to fill-paragraph if no table."
28395 (let ((table-p (org-at-table-p))
28396 (table.el-p (org-at-table.el-p)))
28397 (cond ((and (equal (char-after (point-at-bol)) ?*)
28398 (save-excursion (goto-char (point-at-bol))
28399 (looking-at outline-regexp)))
28400 t) ; skip headlines
28401 (table.el-p t) ; skip table.el tables
28402 (table-p (org-table-align) t) ; align org-mode tables
28403 (t nil)))) ; call paragraph-fill
28405 ;; For reference, this is the default value of adaptive-fill-regexp
28408 (defun org-adaptive-fill-function ()
28409 "Return a fill prefix for org-mode files.
28410 In particular, this makes sure hanging paragraphs for hand-formatted lists
28411 work correctly."
28413 (match-string 0))
28415 (save-excursion
28416 (goto-char (match-end 0))
28417 (make-string (current-column) ?\ )))
28418 (t nil)))
28420 ;;;; Functions extending outline functionality
28423 (defun org-beginning-of-line (&optional arg)
28424 "Go to the beginning of the current line. If that is invisible, continue
28425 to a visible line beginning. This makes the function of C-a more intuitive.
28426 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28427 first attempt, and only move to after the tags when the cursor is already
28428 beyond the end of the headline."
28429 (interactive "P")
28430 (let ((pos (point)))
28431 (beginning-of-line 1)
28432 (if (bobp)
28433 nil
28434 (backward-char 1)
28435 (if (org-invisible-p)
28436 (while (and (not (bobp)) (org-invisible-p))
28437 (backward-char 1)
28438 (beginning-of-line 1))
28439 (forward-char 1)))
28440 (when org-special-ctrl-a/e
28441 (cond
28442 ((and (looking-at org-todo-line-regexp)
28443 (= (char-after (match-end 1)) ?\ ))
28444 (goto-char
28445 (if (eq org-special-ctrl-a/e t)
28446 (cond ((> pos (match-beginning 3)) (match-beginning 3))
28447 ((= pos (point)) (match-beginning 3))
28448 (t (point)))
28449 (cond ((> pos (point)) (point))
28450 ((not (eq last-command this-command)) (point))
28451 (t (match-beginning 3))))))
28452 ((org-at-item-p)
28453 (goto-char
28454 (if (eq org-special-ctrl-a/e t)
28455 (cond ((> pos (match-end 4)) (match-end 4))
28456 ((= pos (point)) (match-end 4))
28457 (t (point)))
28458 (cond ((> pos (point)) (point))
28459 ((not (eq last-command this-command)) (point))
28460 (t (match-end 4))))))))))
28462 (defun org-end-of-line (&optional arg)
28463 "Go to the end of the line.
28464 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28465 first attempt, and only move to after the tags when the cursor is already
28466 beyond the end of the headline."
28467 (interactive "P")
28468 (if (or (not org-special-ctrl-a/e)
28469 (not (org-on-heading-p)))
28470 (end-of-line arg)
28471 (let ((pos (point)))
28472 (beginning-of-line 1)
28474 (if (eq org-special-ctrl-a/e t)
28475 (if (or (< pos (match-beginning 1))
28476 (= pos (match-end 0)))
28477 (goto-char (match-beginning 1))
28478 (goto-char (match-end 0)))
28479 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
28480 (goto-char (match-end 0))
28481 (goto-char (match-beginning 1))))
28482 (end-of-line arg)))))
28484 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
28485 (define-key org-mode-map "\C-e" 'org-end-of-line)
28487 (defun org-kill-line (&optional arg)
28488 "Kill line, to tags or end of line."
28489 (interactive "P")
28490 (cond
28491 ((or (not org-special-ctrl-k)
28492 (bolp)
28493 (not (org-on-heading-p)))
28494 (call-interactively 'kill-line))
28496 (kill-region (point) (match-beginning 1))
28497 (org-set-tags nil t))
28498 (t (kill-region (point) (point-at-eol)))))
28500 (define-key org-mode-map "\C-k" 'org-kill-line)
28502 (defun org-invisible-p ()
28503 "Check if point is at a character currently not visible."
28504 ;; Early versions of noutline don't have `outline-invisible-p'.
28505 (if (fboundp 'outline-invisible-p)
28506 (outline-invisible-p)
28507 (get-char-property (point) 'invisible)))
28509 (defun org-invisible-p2 ()
28510 "Check if point is at a character currently not visible."
28511 (save-excursion
28512 (if (and (eolp) (not (bobp))) (backward-char 1))
28513 ;; Early versions of noutline don't have `outline-invisible-p'.
28514 (if (fboundp 'outline-invisible-p)
28515 (outline-invisible-p)
28516 (get-char-property (point) 'invisible))))
28518 (defalias 'org-back-to-heading 'outline-back-to-heading)
28519 (defalias 'org-on-heading-p 'outline-on-heading-p)
28520 (defalias 'org-at-heading-p 'outline-on-heading-p)
28521 (defun org-at-heading-or-item-p ()
28522 (or (org-on-heading-p) (org-at-item-p)))
28524 (defun org-on-target-p ()
28525 (or (org-in-regexp org-radio-target-regexp)
28526 (org-in-regexp org-target-regexp)))
28528 (defun org-up-heading-all (arg)
28529 "Move to the heading line of which the present line is a subheading.
28530 This function considers both visible and invisible heading lines.
28531 With argument, move up ARG levels."
28532 (if (fboundp 'outline-up-heading-all)
28533 (outline-up-heading-all arg) ; emacs 21 version of outline.el
28534 (outline-up-heading arg t))) ; emacs 22 version of outline.el
28536 (defun org-up-heading-safe ()
28537 "Move to the heading line of which the present line is a subheading.
28538 This version will not throw an error. It will return the level of the
28539 headline found, or nil if no higher level is found."
28540 (let ((pos (point)) start-level level
28541 (re (concat "^" outline-regexp)))
28542 (catch 'exit
28543 (outline-back-to-heading t)
28544 (setq start-level (funcall outline-level))
28545 (if (equal start-level 1) (throw 'exit nil))
28546 (while (re-search-backward re nil t)
28547 (setq level (funcall outline-level))
28548 (if (< level start-level) (throw 'exit level)))
28549 nil)))
28551 (defun org-first-sibling-p ()
28552 "Is this heading the first child of its parents?"
28553 (interactive)
28554 (let ((re (concat "^" outline-regexp))
28555 level l)
28556 (unless (org-at-heading-p t)
28557 (error "Not at a heading"))
28558 (setq level (funcall outline-level))
28559 (save-excursion
28560 (if (not (re-search-backward re nil t))
28561 t
28562 (setq l (funcall outline-level))
28563 (< l level)))))
28565 (defun org-goto-sibling (&optional previous)
28566 "Goto the next sibling, even if it is invisible.
28567 When PREVIOUS is set, go to the previous sibling instead. Returns t
28568 when a sibling was found. When none is found, return nil and don't
28569 move point."
28570 (let ((fun (if previous 're-search-backward 're-search-forward))
28571 (pos (point))
28572 (re (concat "^" outline-regexp))
28573 level l)
28574 (when (condition-case nil (org-back-to-heading t) (error nil))
28575 (setq level (funcall outline-level))
28576 (catch 'exit
28577 (or previous (forward-char 1))
28578 (while (funcall fun re nil t)
28579 (setq l (funcall outline-level))
28580 (when (< l level) (goto-char pos) (throw 'exit nil))
28581 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28582 (goto-char pos)
28583 nil))))
28585 (defun org-show-siblings ()
28586 "Show all siblings of the current headline."
28587 (save-excursion
28588 (while (org-goto-sibling) (org-flag-heading nil)))
28589 (save-excursion
28590 (while (org-goto-sibling 'previous)
28591 (org-flag-heading nil))))
28593 (defun org-show-hidden-entry ()
28594 "Show an entry where even the heading is hidden."
28595 (save-excursion
28596 (org-show-entry)))
28598 (defun org-flag-heading (flag &optional entry)
28599 "Flag the current heading. FLAG non-nil means make invisible.
28600 When ENTRY is non-nil, show the entire entry."
28601 (save-excursion
28602 (org-back-to-heading t)
28603 ;; Check if we should show the entire entry
28604 (if entry
28605 (progn
28606 (org-show-entry)
28607 (save-excursion
28608 (and (outline-next-heading)
28609 (org-flag-heading nil))))
28610 (outline-flag-region (max (point-min) (1- (point)))
28611 (save-excursion (outline-end-of-heading) (point))
28612 flag))))
28614 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28615 ;; This is an exact copy of the original function, but it uses
28616 ;; `org-back-to-heading', to make it work also in invisible
28617 ;; trees. And is uses an invisible-OK argument.
28618 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28619 (org-back-to-heading invisible-OK)
28620 (let ((first t)
28621 (level (funcall outline-level)))
28622 (while (and (not (eobp))
28623 (or first (> (funcall outline-level) level)))
28624 (setq first nil)
28625 (outline-next-heading))
28626 (unless to-heading
28628 (progn
28629 ;; Go to end of line before heading
28630 (forward-char -1)
28632 ;; leave blank line before heading
28633 (forward-char -1))))))
28634 (point))
28636 (defun org-show-subtree ()
28637 "Show everything after this heading at deeper levels."
28638 (outline-flag-region
28639 (point)
28640 (save-excursion
28641 (outline-end-of-subtree) (outline-next-heading) (point))
28642 nil))
28644 (defun org-show-entry ()
28645 "Show the body directly following this heading.
28646 Show the heading too, if it is currently invisible."
28647 (interactive)
28648 (save-excursion
28649 (condition-case nil
28650 (progn
28651 (org-back-to-heading t)
28652 (outline-flag-region
28653 (max (point-min) (1- (point)))
28654 (save-excursion
28655 (re-search-forward
28657 (or (match-beginning 1) (point-max)))
28658 nil))
28659 (error nil))))
28661 (defun org-make-options-regexp (kwds)
28662 "Make a regular expression for keyword lines."
28663 (concat
28664 "^"
28670 ;; Make isearch reveal the necessary context
28671 (defun org-isearch-end ()
28672 "Reveal context after isearch exits."
28673 (when isearch-success ; only if search was successful
28674 (if (featurep 'xemacs)
28675 ;; Under XEmacs, the hook is run in the correct place,
28676 ;; we directly show the context.
28677 (org-show-context 'isearch)
28678 ;; In Emacs the hook runs *before* restoring the overlays.
28679 ;; So we have to use a one-time post-command-hook to do this.
28680 ;; (Emacs 22 has a special variable, see function `org-mode')
28681 (unless (and (boundp 'isearch-mode-end-hook-quit)
28682 isearch-mode-end-hook-quit)
28683 ;; Only when the isearch was not quitted.
28684 (org-add-hook 'post-command-hook 'org-isearch-post-command
28685 'append 'local)))))
28687 (defun org-isearch-post-command ()
28688 "Remove self from hook, and show context."
28689 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28690 (org-show-context 'isearch))
28693 ;;;; Integration with and fixes for other packages
28695 ;;; Imenu support
28697 (defvar org-imenu-markers nil
28698 "All markers currently used by Imenu.")
28699 (make-variable-buffer-local 'org-imenu-markers)
28701 (defun org-imenu-new-marker (&optional pos)
28702 "Return a new marker for use by Imenu, and remember the marker."
28703 (let ((m (make-marker)))
28704 (move-marker m (or pos (point)))
28705 (push m org-imenu-markers)
28706 m))
28708 (defun org-imenu-get-tree ()
28709 "Produce the index for Imenu."
28710 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28711 (setq org-imenu-markers nil)
28712 (let* ((n org-imenu-depth)
28713 (re (concat "^" outline-regexp))
28714 (subs (make-vector (1+ n) nil))
28715 (last-level 0)
28716 m tree level head)
28717 (save-excursion
28718 (save-restriction
28719 (widen)
28720 (goto-char (point-max))
28721 (while (re-search-backward re nil t)
28722 (setq level (org-reduced-level (funcall outline-level)))
28723 (when (<= level n)
28724 (looking-at org-complex-heading-regexp)
28725 (setq head (org-match-string-no-properties 4)
28726 m (org-imenu-new-marker))
28727 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28728 (if (>= level last-level)
28729 (push (cons head m) (aref subs level))
28730 (push (cons head (aref subs (1+ level))) (aref subs level))
28731 (loop for i from (1+ level) to n do (aset subs i nil)))
28732 (setq last-level level)))))
28733 (aref subs 1)))
28735 (eval-after-load "imenu"
28736 '(progn
28737 (add-hook 'imenu-after-jump-hook
28738 (lambda () (org-show-context 'org-goto)))))
28740 ;; Speedbar support
28742 (defun org-speedbar-set-agenda-restriction ()
28743 "Restrict future agenda commands to the location at point in speedbar.
28745 (interactive)
28746 (let (p m tp np dir txt w)
28747 (cond
28748 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28749 'org-imenu t))
28750 (setq m (get-text-property p 'org-imenu-marker))
28751 (save-excursion
28752 (save-restriction
28753 (set-buffer (marker-buffer m))
28754 (goto-char m)
28755 (org-agenda-set-restriction-lock 'subtree))))
28756 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28757 'speedbar-function 'speedbar-find-file))
28758 (setq tp (previous-single-property-change
28759 (1+ p) 'speedbar-function)
28760 np (next-single-property-change
28761 tp 'speedbar-function)
28762 dir (speedbar-line-directory)
28763 txt (buffer-substring-no-properties (or tp (point-min))
28764 (or np (point-max))))
28765 (save-excursion
28766 (save-restriction
28767 (set-buffer (find-file-noselect
28768 (let ((default-directory dir))
28769 (expand-file-name txt))))
28770 (unless (org-mode-p)
28771 (error "Cannot restrict to non-Org-mode file"))
28772 (org-agenda-set-restriction-lock 'file))))
28773 (t (error "Don't know how to restrict Org-mode's agenda")))
28774 (org-move-overlay org-speedbar-restriction-lock-overlay
28775 (point-at-bol) (point-at-eol))
28776 (setq current-prefix-arg nil)
28777 (org-agenda-maybe-redo)))
28779 (eval-after-load "speedbar"
28780 '(progn
28781 (speedbar-add-supported-extension ".org")
28782 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28783 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28784 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28785 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28786 (add-hook 'speedbar-visiting-tag-hook
28787 (lambda () (org-show-context 'org-goto)))))
28790 ;;; Fixes and Hacks
28792 ;; Make flyspell not check words in links, to not mess up our keymap
28793 (defun org-mode-flyspell-verify ()
28794 "Don't let flyspell put overlays at active buttons."
28795 (not (get-text-property (point) 'keymap)))
28797 ;; Make `bookmark-jump' show the jump location if it was hidden.
28798 (eval-after-load "bookmark"
28799 '(if (boundp 'bookmark-after-jump-hook)
28800 ;; We can use the hook
28801 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28802 ;; Hook not available, use advice
28803 (defadvice bookmark-jump (after org-make-visible activate)
28804 "Make the position visible."
28805 (org-bookmark-jump-unhide))))
28807 (defun org-bookmark-jump-unhide ()
28808 "Unhide the current position, to show the bookmark location."
28809 (and (org-mode-p)
28810 (or (org-invisible-p)
28811 (save-excursion (goto-char (max (point-min) (1- (point))))
28812 (org-invisible-p)))
28813 (org-show-context 'bookmark-jump)))
28815 ;; Make session.el ignore our circular variable
28816 (eval-after-load "session"
28817 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28819 ;;;; Experimental code
28821 (defun org-closed-in-range ()
28822 "Sparse tree of items closed in a certain time range.
28823 Still experimental, may disappear in the future."
28824 (interactive)
28825 ;; Get the time interval from the user.
28826 (let* ((time1 (time-to-seconds
28827 (org-read-date nil 'to-time nil "Starting date: ")))
28828 (time2 (time-to-seconds
28829 (org-read-date nil 'to-time nil "End date:")))
28830 ;; callback function
28831 (callback (lambda ()
28832 (let ((time
28833 (time-to-seconds
28834 (apply 'encode-time
28835 (org-parse-time-string
28836 (match-string 1))))))
28837 ;; check if time in interval
28838 (and (>= time time1) (<= time time2))))))
28839 ;; make tree, check each match with the callback
28842 ;;;; Finish up
28844 (provide 'org)
28846 (run-hooks 'org-load-hook)
28848 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28849 ;;; org.el ends here