| blob | c29fca1f8310dce0f90e0f97debd009d996686b6 |
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, valid 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-valid-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 (define-obsolete-function-alias 'org-get-legal-level
6561 'org-get-valid-level "23.1")
6563 (defun org-promote ()
6564 "Promote the current heading higher up the tree.
6565 If the region is active in `transient-mark-mode', promote all headings
6566 in the region."
6567 (org-back-to-heading t)
6568 (let* ((level (save-match-data (funcall outline-level)))
6569 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6570 (diff (abs (- level (length up-head) -1))))
6571 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6572 (replace-match up-head nil t)
6573 ;; Fixup tag positioning
6574 (and org-auto-align-tags (org-set-tags nil t))
6575 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6577 (defun org-demote ()
6578 "Demote the current heading lower down the tree.
6579 If the region is active in `transient-mark-mode', demote all headings
6580 in the region."
6581 (org-back-to-heading t)
6582 (let* ((level (save-match-data (funcall outline-level)))
6583 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6584 (diff (abs (- level (length down-head) -1))))
6585 (replace-match down-head nil t)
6586 ;; Fixup tag positioning
6587 (and org-auto-align-tags (org-set-tags nil t))
6588 (if org-adapt-indentation (org-fixup-indentation diff))))
6590 (defun org-map-tree (fun)
6591 "Call FUN for every heading underneath the current one."
6592 (org-back-to-heading)
6593 (let ((level (funcall outline-level)))
6594 (save-excursion
6595 (funcall fun)
6596 (while (and (progn
6597 (outline-next-heading)
6598 (> (funcall outline-level) level))
6599 (not (eobp)))
6600 (funcall fun)))))
6602 (defun org-map-region (fun beg end)
6603 "Call FUN for every heading between BEG and END."
6604 (let ((org-ignore-region t))
6605 (save-excursion
6606 (setq end (copy-marker end))
6607 (goto-char beg)
6608 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6609 (< (point) end))
6610 (funcall fun))
6611 (while (and (progn
6612 (outline-next-heading)
6613 (< (point) end))
6614 (not (eobp)))
6615 (funcall fun)))))
6617 (defun org-fixup-indentation (diff)
6618 "Change the indentation in the current entry by DIFF
6619 However, if any line in the current entry has no indentation, or if it
6620 would end up with no indentation after the change, nothing at all is done."
6621 (save-excursion
6622 (let ((end (save-excursion (outline-next-heading)
6623 (point-marker)))
6624 (prohibit (if (> diff 0)
6627 col)
6628 (unless (save-excursion (end-of-line 1)
6629 (re-search-forward prohibit end t))
6630 (while (and (< (point) end)
6632 (goto-char (match-end 0))
6633 (setq col (current-column))
6634 (if (< diff 0) (replace-match ""))
6635 (indent-to (+ diff col))))
6636 (move-marker end nil))))
6638 (defun org-convert-to-odd-levels ()
6639 "Convert an org-mode file with all levels allowed to one with odd levels.
6640 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6641 level 5 etc."
6642 (interactive)
6643 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6644 (let ((org-odd-levels-only nil) n)
6645 (save-excursion
6646 (goto-char (point-min))
6648 (setq n (- (length (match-string 0)) 2))
6649 (while (>= (setq n (1- n)) 0)
6650 (org-demote))
6651 (end-of-line 1))))))
6654 (defun org-convert-to-oddeven-levels ()
6655 "Convert an org-mode file with only odd levels to one with odd and even levels.
6656 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6657 section with an even level, conversion would destroy the structure of the file. An error
6658 is signaled in this case."
6659 (interactive)
6660 (goto-char (point-min))
6661 ;; First check if there are no even levels
6663 (org-show-context t)
6664 (error "Not all levels are odd in this file. Conversion not possible."))
6665 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6666 (let ((org-odd-levels-only nil) n)
6667 (save-excursion
6668 (goto-char (point-min))
6670 (setq n (/ (1- (length (match-string 0))) 2))
6671 (while (>= (setq n (1- n)) 0)
6672 (org-promote))
6673 (end-of-line 1))))))
6675 (defun org-tr-level (n)
6676 "Make N odd if required."
6677 (if org-odd-levels-only (1+ (/ n 2)) n))
6679 ;;; Vertical tree motion, cutting and pasting of subtrees
6681 (defun org-move-subtree-up (&optional arg)
6682 "Move the current subtree up past ARG headlines of the same level."
6683 (interactive "p")
6684 (org-move-subtree-down (- (prefix-numeric-value arg))))
6686 (defun org-move-subtree-down (&optional arg)
6687 "Move the current subtree down past ARG headlines of the same level."
6688 (interactive "p")
6689 (setq arg (prefix-numeric-value arg))
6690 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6691 'outline-get-last-sibling))
6692 (ins-point (make-marker))
6693 (cnt (abs arg))
6694 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6695 ;; Select the tree
6696 (org-back-to-heading)
6697 (setq beg0 (point))
6698 (save-excursion
6699 (setq ne-beg (org-back-over-empty-lines))
6700 (setq beg (point)))
6701 (save-match-data
6702 (save-excursion (outline-end-of-heading)
6703 (setq folded (org-invisible-p)))
6704 (outline-end-of-subtree))
6705 (outline-next-heading)
6706 (setq ne-end (org-back-over-empty-lines))
6707 (setq end (point))
6708 (goto-char beg0)
6709 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6710 ;; include less whitespace
6711 (save-excursion
6712 (goto-char beg)
6713 (forward-line (- ne-beg ne-end))
6714 (setq beg (point))))
6715 ;; Find insertion point, with error handling
6716 (while (> cnt 0)
6717 (or (and (funcall movfunc) (looking-at outline-regexp))
6718 (progn (goto-char beg0)
6719 (error "Cannot move past superior level or buffer limit")))
6720 (setq cnt (1- cnt)))
6721 (if (> arg 0)
6722 ;; Moving forward - still need to move over subtree
6723 (progn (org-end-of-subtree t t)
6724 (save-excursion
6725 (org-back-over-empty-lines)
6726 (or (bolp) (newline)))))
6727 (setq ne-ins (org-back-over-empty-lines))
6728 (move-marker ins-point (point))
6729 (setq txt (buffer-substring beg end))
6730 (delete-region beg end)
6731 (outline-flag-region (1- beg) beg nil)
6732 (outline-flag-region (1- (point)) (point) nil)
6733 (insert txt)
6735 (setq ins-end (point))
6736 (goto-char ins-point)
6737 (org-skip-whitespace)
6738 (when (and (< arg 0)
6739 (org-first-sibling-p)
6740 (> ne-ins ne-beg))
6741 ;; Move whitespace back to beginning
6742 (save-excursion
6743 (goto-char ins-end)
6744 (let ((kill-whole-line t))
6745 (kill-line (- ne-ins ne-beg)) (point)))
6747 (move-marker ins-point nil)
6748 (org-compact-display-after-subtree-move)
6749 (unless folded
6750 (org-show-entry)
6751 (show-children)
6752 (org-cycle-hide-drawers 'children))))
6754 (defvar org-subtree-clip ""
6755 "Clipboard for cut and paste of subtrees.
6756 This is actually only a copy of the kill, because we use the normal kill
6757 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6759 (defvar org-subtree-clip-folded nil
6760 "Was the last copied subtree folded?
6761 This is used to fold the tree back after pasting.")
6763 (defun org-cut-subtree (&optional n)
6764 "Cut the current subtree into the clipboard.
6765 With prefix arg N, cut this many sequential subtrees.
6766 This is a short-hand for marking the subtree and then cutting it."
6767 (interactive "p")
6768 (org-copy-subtree n 'cut))
6770 (defun org-copy-subtree (&optional n cut)
6771 "Cut the current subtree into the clipboard.
6772 With prefix arg N, cut this many sequential subtrees.
6773 This is a short-hand for marking the subtree and then copying it.
6774 If CUT is non-nil, actually cut the subtree."
6775 (interactive "p")
6776 (let (beg end folded (beg0 (point)))
6777 (if (interactive-p)
6778 (org-back-to-heading nil) ; take what looks like a subtree
6779 (org-back-to-heading t)) ; take what is really there
6780 (org-back-over-empty-lines)
6781 (setq beg (point))
6783 (save-match-data
6784 (save-excursion (outline-end-of-heading)
6785 (setq folded (org-invisible-p)))
6786 (condition-case nil
6787 (outline-forward-same-level (1- n))
6788 (error nil))
6789 (org-end-of-subtree t t))
6790 (org-back-over-empty-lines)
6791 (setq end (point))
6792 (goto-char beg0)
6793 (when (> end beg)
6794 (setq org-subtree-clip-folded folded)
6795 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6796 (setq org-subtree-clip (current-kill 0))
6797 (message "%s: Subtree(s) with %d characters"
6798 (if cut "Cut" "Copied")
6799 (length org-subtree-clip)))))
6801 (defun org-paste-subtree (&optional level tree)
6802 "Paste the clipboard as a subtree, with modification of headline level.
6803 The entire subtree is promoted or demoted in order to match a new headline
6804 level. By default, the new level is derived from the visible headings
6805 before and after the insertion point, and taken to be the inferior headline
6806 level of the two. So if the previous visible heading is level 3 and the
6807 next is level 4 (or vice versa), level 4 will be used for insertion.
6808 This makes sure that the subtree remains an independent subtree and does
6809 not swallow low level entries.
6811 You can also force a different level, either by using a numeric prefix
6812 argument, or by inserting the heading marker by hand. For example, if the
6817 If optional TREE is given, use this text instead of the kill ring."
6818 (interactive "P")
6819 (unless (org-kill-is-subtree-p tree)
6820 (error "%s"
6821 (substitute-command-keys
6823 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6828 (old-level (if (string-match ^re txt)
6829 (- (match-end 0) (match-beginning 0) 1)
6830 -1))
6831 (force-level (cond (level (prefix-numeric-value level))
6832 ((string-match
6833 ^re_ (buffer-substring (point-at-bol) (point)))
6834 (- (match-end 1) (match-beginning 1)))
6835 (t nil)))
6836 (previous-level (save-excursion
6837 (condition-case nil
6838 (progn
6839 (outline-previous-visible-heading 1)
6840 (if (looking-at re)
6841 (- (match-end 0) (match-beginning 0) 1)
6842 1))
6843 (error 1))))
6844 (next-level (save-excursion
6845 (condition-case nil
6846 (progn
6847 (or (looking-at outline-regexp)
6848 (outline-next-visible-heading 1))
6849 (if (looking-at re)
6850 (- (match-end 0) (match-beginning 0) 1)
6851 1))
6852 (error 1))))
6853 (new-level (or force-level (max previous-level next-level)))
6854 (shift (if (or (= old-level -1)
6855 (= new-level -1)
6856 (= old-level new-level))
6857 0
6858 (- new-level old-level)))
6859 (delta (if (> shift 0) -1 1))
6860 (func (if (> shift 0) 'org-demote 'org-promote))
6861 (org-odd-levels-only nil)
6862 beg end)
6863 ;; Remove the forced level indicator
6864 (if force-level
6865 (delete-region (point-at-bol) (point)))
6866 ;; Paste
6867 (beginning-of-line 1)
6868 (org-back-over-empty-lines) ;; FIXME: correct fix????
6869 (setq beg (point))
6870 (insert-before-markers txt) ;; FIXME: correct fix????
6872 (setq end (point))
6873 (goto-char beg)
6875 (setq beg (point))
6876 ;; Shift if necessary
6877 (unless (= shift 0)
6878 (save-restriction
6879 (narrow-to-region beg end)
6880 (while (not (= shift 0))
6881 (org-map-region func (point-min) (point-max))
6882 (setq shift (+ delta shift)))
6883 (goto-char (point-min))))
6884 (when (interactive-p)
6885 (message "Clipboard pasted as level %d subtree" new-level))
6886 (if (and kill-ring
6887 (eq org-subtree-clip (current-kill 0))
6888 org-subtree-clip-folded)
6889 ;; The tree was folded before it was killed/copied
6890 (hide-subtree))))
6892 (defun org-kill-is-subtree-p (&optional txt)
6893 "Check if the current kill is an outline subtree, or a set of trees.
6894 Returns nil if kill does not start with a headline, or if the first
6895 headline level is not the largest headline level in the tree.
6896 So this will actually accept several entries of equal levels as well,
6897 which is OK for `org-paste-subtree'.
6898 If optional TXT is given, check this string instead of the current kill."
6899 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6900 (start-level (and kill
6903 kill)
6904 (- (match-end 2) (match-beginning 2) 1)))
6905 (re (concat "^" org-outline-regexp))
6906 (start (1+ (match-beginning 2))))
6907 (if (not start-level)
6908 (progn
6909 nil) ;; does not even start with a heading
6910 (catch 'exit
6911 (while (setq start (string-match re kill (1+ start)))
6912 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6913 (throw 'exit nil)))
6914 t))))
6916 (defun org-narrow-to-subtree ()
6917 "Narrow buffer to the current subtree."
6918 (interactive)
6919 (save-excursion
6920 (save-match-data
6921 (narrow-to-region
6922 (progn (org-back-to-heading) (point))
6923 (progn (org-end-of-subtree t t) (point))))))
6926 ;;; Outline Sorting
6928 (defun org-sort (with-case)
6929 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6930 Optional argument WITH-CASE means sort case-sensitively."
6931 (interactive "P")
6932 (if (org-at-table-p)
6933 (org-call-with-arg 'org-table-sort-lines with-case)
6934 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6936 (defvar org-priority-regexp) ; defined later in the file
6938 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6939 "Sort entries on a certain level of an outline tree.
6940 If there is an active region, the entries in the region are sorted.
6941 Else, if the cursor is before the first entry, sort the top-level items.
6942 Else, the children of the entry at point are sorted.
6944 Sorting can be alphabetically, numerically, and by date/time as given by
6945 the first time stamp in the entry. The command prompts for the sorting
6946 type unless it has been given to the function through the SORTING-TYPE
6947 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6948 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6949 called with point at the beginning of the record. It must return either
6950 a string or a number that should serve as the sorting key for that record.
6952 Comparing entries ignores case by default. However, with an optional argument
6953 WITH-CASE, the sorting considers case as well."
6954 (interactive "P")
6955 (let ((case-func (if with-case 'identity 'downcase))
6956 start beg end stars re re2
6957 txt what tmp plain-list-p)
6958 ;; Find beginning and end of region to sort
6959 (cond
6960 ((org-region-active-p)
6961 ;; we will sort the region
6962 (setq end (region-end)
6963 what "region")
6964 (goto-char (region-beginning))
6965 (if (not (org-on-heading-p)) (outline-next-heading))
6966 (setq start (point)))
6967 ((org-at-item-p)
6968 ;; we will sort this plain list
6969 (org-beginning-of-item-list) (setq start (point))
6970 (org-end-of-item-list) (setq end (point))
6971 (goto-char start)
6972 (setq plain-list-p t
6973 what "plain list"))
6974 ((or (org-on-heading-p)
6975 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6976 ;; we will sort the children of the current headline
6977 (org-back-to-heading)
6978 (setq start (point)
6979 end (progn (org-end-of-subtree t t)
6980 (org-back-over-empty-lines)
6981 (point))
6982 what "children")
6983 (goto-char start)
6984 (show-subtree)
6985 (outline-next-heading))
6986 (t
6987 ;; we will sort the top-level entries in this file
6988 (goto-char (point-min))
6989 (or (org-on-heading-p) (outline-next-heading))
6990 (setq start (point) end (point-max) what "top-level")
6991 (goto-char start)
6992 (show-all)))
6994 (setq beg (point))
6995 (if (>= beg end) (error "Nothing to sort"))
6997 (unless plain-list-p
6999 (setq stars (match-string 1)
7000 re (concat "^" (regexp-quote stars) " +")
7001 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7002 txt (buffer-substring beg end))
7004 (if (and (not (equal stars "*")) (string-match re2 txt))
7005 (error "Region to sort contains a level above the first entry")))
7007 (unless sorting-type
7008 (message
7009 (if plain-list-p
7010 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
7011 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
7012 what)
7013 (setq sorting-type (read-char-exclusive))
7015 (and (= (downcase sorting-type) ?f)
7016 (setq getkey-func
7017 (completing-read "Sort using function: "
7018 obarray 'fboundp t nil nil))
7019 (setq getkey-func (intern getkey-func)))
7021 (and (= (downcase sorting-type) ?r)
7022 (setq property
7023 (completing-read "Property: "
7024 (mapcar 'list (org-buffer-property-keys t))
7025 nil t))))
7027 (message "Sorting entries...")
7029 (save-restriction
7030 (narrow-to-region start end)
7032 (let ((dcst (downcase sorting-type))
7033 (now (current-time)))
7034 (sort-subr
7035 (/= dcst sorting-type)
7036 ;; This function moves to the beginning character of the "record" to
7037 ;; be sorted.
7038 (if plain-list-p
7039 (lambda nil
7040 (if (org-at-item-p) t (goto-char (point-max))))
7041 (lambda nil
7042 (if (re-search-forward re nil t)
7043 (goto-char (match-beginning 0))
7044 (goto-char (point-max)))))
7045 ;; This function moves to the last character of the "record" being
7046 ;; sorted.
7047 (if plain-list-p
7048 'org-end-of-item
7049 (lambda nil
7050 (save-match-data
7051 (condition-case nil
7052 (outline-forward-same-level 1)
7053 (error
7054 (goto-char (point-max)))))))
7056 ;; This function returns the value that gets sorted against.
7057 (if plain-list-p
7058 (lambda nil
7060 (cond
7061 ((= dcst ?n)
7062 (string-to-number (buffer-substring (match-end 0)
7063 (point-at-eol))))
7064 ((= dcst ?a)
7065 (buffer-substring (match-end 0) (point-at-eol)))
7066 ((= dcst ?t)
7067 (if (re-search-forward org-ts-regexp
7068 (point-at-eol) t)
7069 (org-time-string-to-time (match-string 0))
7070 now))
7071 ((= dcst ?f)
7072 (if getkey-func
7073 (progn
7074 (setq tmp (funcall getkey-func))
7075 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7076 tmp)
7077 (error "Invalid key function `%s'" getkey-func)))
7078 (t (error "Invalid sorting type `%c'" sorting-type)))))
7079 (lambda nil
7080 (cond
7081 ((= dcst ?n)
7082 (if (looking-at outline-regexp)
7083 (string-to-number (buffer-substring (match-end 0)
7084 (point-at-eol)))
7085 nil))
7086 ((= dcst ?a)
7087 (funcall case-func (buffer-substring (point-at-bol)
7088 (point-at-eol))))
7089 ((= dcst ?t)
7090 (if (re-search-forward org-ts-regexp
7091 (save-excursion
7092 (forward-line 2)
7093 (point)) t)
7094 (org-time-string-to-time (match-string 0))
7095 now))
7096 ((= dcst ?p)
7097 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7098 (string-to-char (match-string 2))
7099 org-default-priority))
7100 ((= dcst ?r)
7101 (or (org-entry-get nil property) ""))
7102 ((= dcst ?f)
7103 (if getkey-func
7104 (progn
7105 (setq tmp (funcall getkey-func))
7106 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7107 tmp)
7108 (error "Invalid key function `%s'" getkey-func)))
7109 (t (error "Invalid sorting type `%c'" sorting-type)))))
7110 nil
7111 (cond
7112 ((= dcst ?a) 'string<)
7113 ((= dcst ?t) 'time-less-p)
7114 (t nil)))))
7115 (message "Sorting entries...done")))
7117 (defun org-do-sort (table what &optional with-case sorting-type)
7118 "Sort TABLE of WHAT according to SORTING-TYPE.
7119 The user will be prompted for the SORTING-TYPE if the call to this
7120 function does not specify it. WHAT is only for the prompt, to indicate
7121 what is being sorted. The sorting key will be extracted from
7122 the car of the elements of the table.
7123 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7124 (unless sorting-type
7125 (message
7126 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7127 what)
7128 (setq sorting-type (read-char-exclusive)))
7129 (let ((dcst (downcase sorting-type))
7130 extractfun comparefun)
7131 ;; Define the appropriate functions
7132 (cond
7133 ((= dcst ?n)
7134 (setq extractfun 'string-to-number
7135 comparefun (if (= dcst sorting-type) '< '>)))
7136 ((= dcst ?a)
7137 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7138 (lambda(x) (downcase (org-sort-remove-invisible x))))
7139 comparefun (if (= dcst sorting-type)
7140 'string<
7141 (lambda (a b) (and (not (string< a b))
7142 (not (string= a b)))))))
7143 ((= dcst ?t)
7144 (setq extractfun
7145 (lambda (x)
7146 (if (string-match org-ts-regexp x)
7147 (time-to-seconds
7148 (org-time-string-to-time (match-string 0 x)))
7149 0))
7150 comparefun (if (= dcst sorting-type) '< '>)))
7151 (t (error "Invalid sorting type `%c'" sorting-type)))
7153 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7154 table)
7155 (lambda (a b) (funcall comparefun (car a) (car b))))))
7157 ;;;; Plain list items, including checkboxes
7159 ;;; Plain list items
7161 (defun org-at-item-p ()
7162 "Is point in a line starting a hand-formatted item?"
7163 (let ((llt org-plain-list-ordered-item-terminator))
7164 (save-excursion
7165 (goto-char (point-at-bol))
7166 (looking-at
7167 (cond
7171 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7173 (defun org-in-item-p ()
7174 "It the cursor inside a plain list item.
7175 Does not have to be the first line."
7176 (save-excursion
7177 (condition-case nil
7178 (progn
7179 (org-beginning-of-item)
7180 (org-at-item-p)
7181 t)
7182 (error nil))))
7184 (defun org-insert-item (&optional checkbox)
7185 "Insert a new item at the current level.
7186 Return t when things worked, nil when we are not in an item."
7187 (when (save-excursion
7188 (condition-case nil
7189 (progn
7190 (org-beginning-of-item)
7191 (org-at-item-p)
7192 (if (org-invisible-p) (error "Invisible item"))
7193 t)
7194 (error nil)))
7195 (let* ((bul (match-string 0))
7197 (match-end 0)))
7198 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7199 pos)
7200 (cond
7201 ((and (org-at-item-p) (<= (point) eow))
7202 ;; before the bullet
7203 (beginning-of-line 1)
7204 (open-line (if blank 2 1)))
7205 ((<= (point) eow)
7206 (beginning-of-line 1))
7207 (t
7208 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7209 (end-of-line 1)
7210 (delete-horizontal-space))
7211 (newline (if blank 2 1))))
7212 (insert bul (if checkbox "[ ]" ""))
7213 (just-one-space)
7214 (setq pos (point))
7215 (end-of-line 1)
7216 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7217 (org-maybe-renumber-ordered-list)
7218 (and checkbox (org-update-checkbox-count-maybe))
7219 t))
7221 ;;; Checkboxes
7223 (defun org-at-item-checkbox-p ()
7224 "Is point at a line starting a plain-list item with a checklet?"
7225 (and (org-at-item-p)
7226 (save-excursion
7227 (goto-char (match-end 0))
7231 (defun org-toggle-checkbox (&optional arg)
7232 "Toggle the checkbox in the current line."
7233 (interactive "P")
7234 (catch 'exit
7235 (let (beg end status (firstnew 'unknown))
7236 (cond
7237 ((org-region-active-p)
7238 (setq beg (region-beginning) end (region-end)))
7239 ((org-on-heading-p)
7240 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7241 ((org-at-item-checkbox-p)
7242 (let ((pos (point)))
7243 (replace-match
7244 (cond (arg "[-]")
7245 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7246 (t "[ ]"))
7247 t t)
7248 (goto-char pos))
7249 (throw 'exit t))
7250 (t (error "Not at a checkbox or heading, and no active region")))
7251 (save-excursion
7252 (goto-char beg)
7253 (while (< (point) end)
7254 (when (org-at-item-checkbox-p)
7255 (setq status (equal (match-string 0) "[X]"))
7256 (when (eq firstnew 'unknown)
7257 (setq firstnew (not status)))
7258 (replace-match
7259 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7260 (beginning-of-line 2)))))
7261 (org-update-checkbox-count-maybe))
7263 (defun org-update-checkbox-count-maybe ()
7264 "Update checkbox statistics unless turned off by user."
7265 (when org-provide-checkbox-statistics
7266 (org-update-checkbox-count)))
7268 (defun org-update-checkbox-count (&optional all)
7269 "Update the checkbox statistics in the current section.
7270 This will find all statistic cookies like [57%] and [6/12] and update them
7271 with the current numbers. With optional prefix argument ALL, do this for
7272 the whole buffer."
7273 (interactive "P")
7274 (save-excursion
7275 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7276 (beg (condition-case nil
7277 (progn (outline-back-to-heading) (point))
7278 (error (point-min))))
7279 (end (move-marker (make-marker)
7280 (progn (outline-next-heading) (point))))
7284 beg-cookie end-cookie is-percent c-on c-off lim
7285 eline curr-ind next-ind continue-from startsearch
7286 (cstat 0)
7287 )
7288 (when all
7289 (goto-char (point-min))
7290 (outline-next-heading)
7291 (setq beg (point) end (point-max)))
7292 (goto-char end)
7293 ;; find each statistic cookie
7294 (while (re-search-backward re-find beg t)
7295 (setq beg-cookie (match-beginning 1)
7296 end-cookie (match-end 1)
7297 cstat (+ cstat (if end-cookie 1 0))
7298 startsearch (point-at-eol)
7299 continue-from (point-at-bol)
7300 is-percent (match-beginning 2)
7301 lim (cond
7302 ((org-on-heading-p) (outline-next-heading) (point))
7303 ((org-at-item-p) (org-end-of-item) (point))
7304 (t nil))
7305 c-on 0
7306 c-off 0)
7307 (when lim
7308 ;; find first checkbox for this cookie and gather
7309 ;; statistics from all that are at this indentation level
7310 (goto-char startsearch)
7311 (if (re-search-forward re-box lim t)
7312 (progn
7313 (org-beginning-of-item)
7314 (setq curr-ind (org-get-indentation))
7315 (setq next-ind curr-ind)
7316 (while (= curr-ind next-ind)
7317 (save-excursion (end-of-line) (setq eline (point)))
7318 (if (re-search-forward re-box eline t)
7319 (if (member (match-string 2) '("[ ]" "[-]"))
7320 (setq c-off (1+ c-off))
7321 (setq c-on (1+ c-on))
7322 )
7323 )
7324 (org-end-of-item)
7325 (setq next-ind (org-get-indentation))
7326 )))
7327 (goto-char continue-from)
7328 ;; update cookie
7329 (when end-cookie
7330 (delete-region beg-cookie end-cookie)
7331 (goto-char beg-cookie)
7332 (insert
7333 (if is-percent
7334 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7335 (format "[%d/%d]" c-on (+ c-on c-off)))))
7336 ;; update items checkbox if it has one
7337 (when (org-at-item-p)
7338 (org-beginning-of-item)
7339 (when (and (> (+ c-on c-off) 0)
7340 (re-search-forward re-box (point-at-eol) t))
7341 (setq beg-cookie (match-beginning 2)
7342 end-cookie (match-end 2))
7343 (delete-region beg-cookie end-cookie)
7344 (goto-char beg-cookie)
7345 (cond ((= c-off 0) (insert "[X]"))
7346 ((= c-on 0) (insert "[ ]"))
7347 (t (insert "[-]")))
7348 )))
7349 (goto-char continue-from))
7350 (when (interactive-p)
7351 (message "Checkbox satistics updated %s (%d places)"
7352 (if all "in entire file" "in current outline entry") cstat)))))
7354 (defun org-get-checkbox-statistics-face ()
7355 "Select the face for checkbox statistics.
7356 The face will be `org-done' when all relevant boxes are checked. Otherwise
7357 it will be `org-todo'."
7358 (if (match-end 1)
7359 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7360 (if (and (> (match-end 2) (match-beginning 2))
7361 (equal (match-string 2) (match-string 3)))
7362 'org-done
7363 'org-todo)))
7365 (defun org-get-indentation (&optional line)
7366 "Get the indentation of the current line, interpreting tabs.
7367 When LINE is given, assume it represents a line and compute its indentation."
7368 (if line
7369 (if (string-match "^ *" (org-remove-tabs line))
7370 (match-end 0))
7371 (save-excursion
7372 (beginning-of-line 1)
7374 (current-column))))
7376 (defun org-remove-tabs (s &optional width)
7377 "Replace tabulators in S with spaces.
7378 Assumes that s is a single line, starting in column 0."
7379 (setq width (or width tab-width))
7381 (setq s (replace-match
7382 (make-string
7383 (- (* width (/ (+ (match-beginning 0) width) width))
7384 (match-beginning 0)) ?\ )
7385 t t s)))
7386 s)
7388 (defun org-fix-indentation (line ind)
7389 "Fix indentation in LINE.
7390 IND is a cons cell with target and minimum indentation.
7391 If the current indenation in LINE is smaller than the minimum,
7392 leave it alone. If it is larger than ind, set it to the target."
7393 (let* ((l (org-remove-tabs line))
7394 (i (org-get-indentation l))
7395 (i1 (car ind)) (i2 (cdr ind)))
7396 (if (>= i i2) (setq l (substring line i2)))
7397 (if (> i1 0)
7398 (concat (make-string i1 ?\ ) l)
7399 l)))
7401 (defcustom org-empty-line-terminates-plain-lists nil
7402 "Non-nil means, an empty line ends all plain list levels.
7403 When nil, empty lines are part of the preceeding item."
7404 :group 'org-plain-lists
7405 :type 'boolean)
7407 (defun org-beginning-of-item ()
7408 "Go to the beginning of the current hand-formatted item.
7409 If the cursor is not in an item, throw an error."
7410 (interactive)
7411 (let ((pos (point))
7412 (limit (save-excursion
7413 (condition-case nil
7414 (progn
7415 (org-back-to-heading)
7416 (beginning-of-line 2) (point))
7417 (error (point-min)))))
7418 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7419 ind ind1)
7420 (if (org-at-item-p)
7421 (beginning-of-line 1)
7422 (beginning-of-line 1)
7424 (setq ind (current-column))
7425 (if (catch 'exit
7426 (while t
7427 (beginning-of-line 0)
7428 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7431 (setq ind1 ind-empty)
7433 (setq ind1 (current-column)))
7434 (if (< ind1 ind)
7435 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7436 nil
7437 (goto-char pos)
7438 (error "Not in an item")))))
7440 (defun org-end-of-item ()
7441 "Go to the end of the current hand-formatted item.
7442 If the cursor is not in an item, throw an error."
7443 (interactive)
7444 (let* ((pos (point))
7445 ind1
7446 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7447 (limit (save-excursion (outline-next-heading) (point)))
7448 (ind (save-excursion
7449 (org-beginning-of-item)
7451 (current-column)))
7452 (end (catch 'exit
7453 (while t
7454 (beginning-of-line 2)
7455 (if (eobp) (throw 'exit (point)))
7456 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7458 (setq ind1 ind-empty)
7460 (setq ind1 (current-column)))
7461 (if (<= ind1 ind)
7462 (throw 'exit (point-at-bol)))))))
7463 (if end
7464 (goto-char end)
7465 (goto-char pos)
7466 (error "Not in an item"))))
7468 (defun org-next-item ()
7469 "Move to the beginning of the next item in the current plain list.
7470 Error if not at a plain list, or if this is the last item in the list."
7471 (interactive)
7472 (let (ind ind1 (pos (point)))
7473 (org-beginning-of-item)
7474 (setq ind (org-get-indentation))
7475 (org-end-of-item)
7476 (setq ind1 (org-get-indentation))
7477 (unless (and (org-at-item-p) (= ind ind1))
7478 (goto-char pos)
7479 (error "On last item"))))
7481 (defun org-previous-item ()
7482 "Move to the beginning of the previous item in the current plain list.
7483 Error if not at a plain list, or if this is the first item in the list."
7484 (interactive)
7485 (let (beg ind ind1 (pos (point)))
7486 (org-beginning-of-item)
7487 (setq beg (point))
7488 (setq ind (org-get-indentation))
7489 (goto-char beg)
7490 (catch 'exit
7491 (while t
7492 (beginning-of-line 0)
7494 nil
7495 (if (<= (setq ind1 (org-get-indentation)) ind)
7496 (throw 'exit t)))))
7497 (condition-case nil
7498 (if (or (not (org-at-item-p))
7499 (< ind1 (1- ind)))
7500 (error "")
7501 (org-beginning-of-item))
7502 (error (goto-char pos)
7503 (error "On first item")))))
7505 (defun org-first-list-item-p ()
7506 "Is this heading the item in a plain list?"
7507 (unless (org-at-item-p)
7508 (error "Not at a plain list item"))
7509 (org-beginning-of-item)
7510 (= (point) (save-excursion (org-beginning-of-item-list))))
7512 (defun org-move-item-down ()
7513 "Move the plain list item at point down, i.e. swap with following item.
7514 Subitems (items with larger indentation) are considered part of the item,
7515 so this really moves item trees."
7516 (interactive)
7517 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7518 (org-beginning-of-item)
7519 (setq beg0 (point))
7520 (save-excursion
7521 (setq ne-beg (org-back-over-empty-lines))
7522 (setq beg (point)))
7523 (goto-char beg0)
7524 (setq ind (org-get-indentation))
7525 (org-end-of-item)
7526 (setq end0 (point))
7527 (setq ind1 (org-get-indentation))
7528 (setq ne-end (org-back-over-empty-lines))
7529 (setq end (point))
7530 (goto-char beg0)
7531 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7532 ;; include less whitespace
7533 (save-excursion
7534 (goto-char beg)
7535 (forward-line (- ne-beg ne-end))
7536 (setq beg (point))))
7537 (goto-char end0)
7538 (if (and (org-at-item-p) (= ind ind1))
7539 (progn
7540 (org-end-of-item)
7541 (org-back-over-empty-lines)
7542 (setq txt (buffer-substring beg end))
7543 (save-excursion
7544 (delete-region beg end))
7545 (setq pos (point))
7546 (insert txt)
7547 (goto-char pos) (org-skip-whitespace)
7548 (org-maybe-renumber-ordered-list))
7549 (goto-char pos)
7550 (error "Cannot move this item further down"))))
7552 (defun org-move-item-up (arg)
7553 "Move the plain list item at point up, i.e. swap with previous item.
7554 Subitems (items with larger indentation) are considered part of the item,
7555 so this really moves item trees."
7556 (interactive "p")
7557 (let (beg beg0 end ind ind1 (pos (point)) txt
7558 ne-beg ne-ins ins-end)
7559 (org-beginning-of-item)
7560 (setq beg0 (point))
7561 (setq ind (org-get-indentation))
7562 (save-excursion
7563 (setq ne-beg (org-back-over-empty-lines))
7564 (setq beg (point)))
7565 (goto-char beg0)
7566 (org-end-of-item)
7567 (setq end (point))
7568 (goto-char beg0)
7569 (catch 'exit
7570 (while t
7571 (beginning-of-line 0)
7573 (if org-empty-line-terminates-plain-lists
7574 (progn
7575 (goto-char pos)
7576 (error "Cannot move this item further up"))
7577 nil)
7578 (if (<= (setq ind1 (org-get-indentation)) ind)
7579 (throw 'exit t)))))
7580 (condition-case nil
7581 (org-beginning-of-item)
7582 (error (goto-char beg)
7583 (error "Cannot move this item further up")))
7584 (setq ind1 (org-get-indentation))
7585 (if (and (org-at-item-p) (= ind ind1))
7586 (progn
7587 (setq ne-ins (org-back-over-empty-lines))
7588 (setq txt (buffer-substring beg end))
7589 (save-excursion
7590 (delete-region beg end))
7591 (setq pos (point))
7592 (insert txt)
7593 (setq ins-end (point))
7594 (goto-char pos) (org-skip-whitespace)
7596 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7597 ;; Move whitespace back to beginning
7598 (save-excursion
7599 (goto-char ins-end)
7600 (let ((kill-whole-line t))
7601 (kill-line (- ne-ins ne-beg)) (point)))
7604 (org-maybe-renumber-ordered-list))
7605 (goto-char pos)
7606 (error "Cannot move this item further up"))))
7608 (defun org-maybe-renumber-ordered-list ()
7609 "Renumber the ordered list at point if setup allows it.
7610 This tests the user option `org-auto-renumber-ordered-lists' before
7611 doing the renumbering."
7612 (interactive)
7613 (when (and org-auto-renumber-ordered-lists
7614 (org-at-item-p))
7615 (if (match-beginning 3)
7616 (org-renumber-ordered-list 1)
7617 (org-fix-bullet-type))))
7619 (defun org-maybe-renumber-ordered-list-safe ()
7620 (condition-case nil
7621 (save-excursion
7622 (org-maybe-renumber-ordered-list))
7623 (error nil)))
7625 (defun org-cycle-list-bullet (&optional which)
7626 "Cycle through the different itemize/enumerate bullets.
7627 This cycle the entire list level through the sequence:
7629 `-' -> `+' -> `*' -> `1.' -> `1)'
7631 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7632 0 meand `-', 1 means `+' etc."
7633 (interactive "P")
7634 (org-preserve-lc
7635 (org-beginning-of-item-list)
7636 (org-at-item-p)
7637 (beginning-of-line 1)
7638 (let ((current (match-string 0))
7639 (prevp (eq which 'previous))
7640 new)
7641 (setq new (cond
7642 ((and (numberp which)
7643 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7644 ((string-match "-" current) (if prevp "1)" "+"))
7649 ((string-match ")" current) (if prevp "1." "-"))
7650 (t (error "This should not happen"))))
7652 (org-fix-bullet-type)
7653 (org-maybe-renumber-ordered-list))))
7655 (defun org-get-string-indentation (s)
7656 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7657 (let ((n -1) (i 0) (w tab-width) c)
7658 (catch 'exit
7659 (while (< (setq n (1+ n)) (length s))
7660 (setq c (aref s n))
7661 (cond ((= c ?\ ) (setq i (1+ i)))
7663 (t (throw 'exit t)))))
7664 i))
7666 (defun org-renumber-ordered-list (arg)
7667 "Renumber an ordered plain list.
7668 Cursor needs to be in the first line of an item, the line that starts
7670 (interactive "p")
7671 (unless (and (org-at-item-p)
7672 (match-beginning 3))
7673 (error "This is not an ordered list"))
7674 (let ((line (org-current-line))
7675 (col (current-column))
7676 (ind (org-get-string-indentation
7677 (buffer-substring (point-at-bol) (match-beginning 3))))
7678 ;; (term (substring (match-string 3) -1))
7679 ind1 (n (1- arg))
7680 fmt)
7681 ;; find where this list begins
7682 (org-beginning-of-item-list)
7684 (setq fmt (concat "%d" (match-string 1)))
7685 (beginning-of-line 0)
7686 ;; walk forward and replace these numbers
7687 (catch 'exit
7688 (while t
7689 (catch 'next
7690 (beginning-of-line 2)
7691 (if (eobp) (throw 'exit nil))
7694 (if (> ind1 ind) (throw 'next t))
7695 (if (< ind1 ind) (throw 'exit t))
7696 (if (not (org-at-item-p)) (throw 'exit nil))
7697 (delete-region (match-beginning 2) (match-end 2))
7698 (goto-char (match-beginning 2))
7699 (insert (format fmt (setq n (1+ n)))))))
7700 (goto-line line)
7701 (move-to-column col)))
7703 (defun org-fix-bullet-type ()
7704 "Make sure all items in this list have the same bullet as the firsst item."
7705 (interactive)
7706 (unless (org-at-item-p) (error "This is not a list"))
7707 (let ((line (org-current-line))
7708 (col (current-column))
7709 (ind (current-indentation))
7710 ind1 bullet)
7711 ;; find where this list begins
7712 (org-beginning-of-item-list)
7713 (beginning-of-line 1)
7714 ;; find out what the bullet type is
7716 (setq bullet (match-string 1))
7717 ;; walk forward and replace these numbers
7718 (beginning-of-line 0)
7719 (catch 'exit
7720 (while t
7721 (catch 'next
7722 (beginning-of-line 2)
7723 (if (eobp) (throw 'exit nil))
7726 (if (> ind1 ind) (throw 'next t))
7727 (if (< ind1 ind) (throw 'exit t))
7728 (if (not (org-at-item-p)) (throw 'exit nil))
7731 (replace-match bullet))))
7732 (goto-line line)
7733 (move-to-column col)
7734 (if (string-match "[0-9]" bullet)
7735 (org-renumber-ordered-list 1))))
7737 (defun org-beginning-of-item-list ()
7738 "Go to the beginning of the current item list.
7739 I.e. to the first item in this list."
7740 (interactive)
7741 (org-beginning-of-item)
7742 (let ((pos (point-at-bol))
7743 (ind (org-get-indentation))
7744 ind1)
7745 ;; find where this list begins
7746 (catch 'exit
7747 (while t
7748 (catch 'next
7749 (beginning-of-line 0)
7751 (throw (if (bobp) 'exit 'next) t))
7753 (if (or (< ind1 ind)
7754 (and (= ind1 ind)
7755 (not (org-at-item-p)))
7756 (bobp))
7757 (throw 'exit t)
7758 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7759 (goto-char pos)))
7762 (defun org-end-of-item-list ()
7763 "Go to the end of the current item list.
7764 I.e. to the text after the last item."
7765 (interactive)
7766 (org-beginning-of-item)
7767 (let ((pos (point-at-bol))
7768 (ind (org-get-indentation))
7769 ind1)
7770 ;; find where this list begins
7771 (catch 'exit
7772 (while t
7773 (catch 'next
7774 (beginning-of-line 2)
7776 (throw (if (eobp) 'exit 'next) t))
7778 (if (or (< ind1 ind)
7779 (and (= ind1 ind)
7780 (not (org-at-item-p)))
7781 (eobp))
7782 (progn
7783 (setq pos (point-at-bol))
7784 (throw 'exit t))))))
7785 (goto-char pos)))
7788 (defvar org-last-indent-begin-marker (make-marker))
7789 (defvar org-last-indent-end-marker (make-marker))
7791 (defun org-outdent-item (arg)
7792 "Outdent a local list item."
7793 (interactive "p")
7794 (org-indent-item (- arg)))
7796 (defun org-indent-item (arg)
7797 "Indent a local list item."
7798 (interactive "p")
7799 (unless (org-at-item-p)
7800 (error "Not on an item"))
7801 (save-excursion
7802 (let (beg end ind ind1 tmp delta ind-down ind-up)
7803 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7804 (setq beg org-last-indent-begin-marker
7805 end org-last-indent-end-marker)
7806 (org-beginning-of-item)
7807 (setq beg (move-marker org-last-indent-begin-marker (point)))
7808 (org-end-of-item)
7809 (setq end (move-marker org-last-indent-end-marker (point))))
7810 (goto-char beg)
7811 (setq tmp (org-item-indent-positions)
7812 ind (car tmp)
7813 ind-down (nth 2 tmp)
7814 ind-up (nth 1 tmp)
7815 delta (if (> arg 0)
7816 (if ind-down (- ind-down ind) 2)
7817 (if ind-up (- ind-up ind) -2)))
7818 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7819 (while (< (point) end)
7820 (beginning-of-line 1)
7822 (delete-region (point-at-bol) (point))
7823 (or (eolp) (indent-to-column (+ ind1 delta)))
7824 (beginning-of-line 2))))
7825 (org-fix-bullet-type)
7826 (org-maybe-renumber-ordered-list-safe)
7827 (save-excursion
7828 (beginning-of-line 0)
7829 (condition-case nil (org-beginning-of-item) (error nil))
7830 (org-maybe-renumber-ordered-list-safe)))
7832 (defun org-item-indent-positions ()
7833 "Return indentation for plain list items.
7834 This returns a list with three values: The current indentation, the
7835 parent indentation and the indentation a child should habe.
7836 Assumes cursor in item line."
7837 (let* ((bolpos (point-at-bol))
7838 (ind (org-get-indentation))
7839 ind-down ind-up pos)
7840 (save-excursion
7841 (org-beginning-of-item-list)
7843 (when (org-in-item-p)
7844 (org-beginning-of-item)
7845 (setq ind-up (org-get-indentation))))
7846 (setq pos (point))
7847 (save-excursion
7848 (cond
7849 ((and (condition-case nil (progn (org-previous-item) t)
7850 (error nil))
7851 (or (forward-char 1) t)
7852 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7853 (setq ind-down (org-get-indentation)))
7854 ((and (goto-char pos)
7855 (org-at-item-p))
7856 (goto-char (match-end 0))
7858 (setq ind-down (current-column)))))
7859 (list ind ind-up ind-down)))
7861 ;;; The orgstruct minor mode
7863 ;; Define a minor mode which can be used in other modes in order to
7864 ;; integrate the org-mode structure editing commands.
7866 ;; This is really a hack, because the org-mode structure commands use
7867 ;; keys which normally belong to the major mode. Here is how it
7868 ;; works: The minor mode defines all the keys necessary to operate the
7869 ;; structure commands, but wraps the commands into a function which
7870 ;; tests if the cursor is currently at a headline or a plain list
7871 ;; item. If that is the case, the structure command is used,
7872 ;; temporarily setting many Org-mode variables like regular
7873 ;; expressions for filling etc. However, when any of those keys is
7874 ;; used at a different location, function uses `key-binding' to look
7875 ;; up if the key has an associated command in another currently active
7876 ;; keymap (minor modes, major mode, global), and executes that
7877 ;; command. There might be problems if any of the keys is otherwise
7878 ;; used as a prefix key.
7880 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7881 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7882 ;; addresses this by checking explicitly for both bindings.
7884 (defvar orgstruct-mode-map (make-sparse-keymap)
7885 "Keymap for the minor `orgstruct-mode'.")
7887 (defvar org-local-vars nil
7888 "List of local variables, for use by `orgstruct-mode'")
7890 ;;;###autoload
7891 (define-minor-mode orgstruct-mode
7892 "Toggle the minor more `orgstruct-mode'.
7893 This mode is for using Org-mode structure commands in other modes.
7894 The following key behave as if Org-mode was active, if the cursor
7895 is on a headline, or on a plain list item (both in the definition
7896 of Org-mode).
7898 M-up Move entry/item up
7899 M-down Move entry/item down
7900 M-left Promote
7901 M-right Demote
7902 M-S-up Move entry/item up
7903 M-S-down Move entry/item down
7904 M-S-left Promote subtree
7905 M-S-right Demote subtree
7906 M-q Fill paragraph and items like in Org-mode
7907 C-c ^ Sort entries
7908 C-c - Cycle list bullet
7909 TAB Cycle item visibility
7910 M-RET Insert new heading/item
7911 S-M-RET Insert new TODO heading / Chekbox item
7912 C-c C-c Set tags / toggle checkbox"
7913 nil " OrgStruct" nil
7914 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7916 ;;;###autoload
7917 (defun turn-on-orgstruct ()
7918 "Unconditionally turn on `orgstruct-mode'."
7919 (orgstruct-mode 1))
7921 ;;;###autoload
7922 (defun turn-on-orgstruct++ ()
7923 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7924 In addition to setting orgstruct-mode, this also exports all indentation and
7925 autofilling variables from org-mode into the buffer. Note that turning
7926 off orgstruct-mode will *not* remove these additional settings."
7927 (orgstruct-mode 1)
7928 (let (var val)
7929 (mapc
7930 (lambda (x)
7931 (when (string-match
7933 (symbol-name (car x)))
7934 (setq var (car x) val (nth 1 x))
7935 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7936 org-local-vars)))
7938 (defun orgstruct-error ()
7939 "Error when there is no default binding for a structure key."
7940 (interactive)
7941 (error "This key has no function outside structure elements"))
7943 (defun orgstruct-setup ()
7944 "Setup orgstruct keymaps."
7945 (let ((nfunc 0)
7946 (bindings
7947 (list
7948 '([(meta up)] org-metaup)
7949 '([(meta down)] org-metadown)
7950 '([(meta left)] org-metaleft)
7951 '([(meta right)] org-metaright)
7952 '([(meta shift up)] org-shiftmetaup)
7953 '([(meta shift down)] org-shiftmetadown)
7954 '([(meta shift left)] org-shiftmetaleft)
7955 '([(meta shift right)] org-shiftmetaright)
7956 '([(shift up)] org-shiftup)
7957 '([(shift down)] org-shiftdown)
7958 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7959 '("\M-q" fill-paragraph)
7960 '("\C-c^" org-sort)
7961 '("\C-c-" org-cycle-list-bullet)))
7962 elt key fun cmd)
7963 (while (setq elt (pop bindings))
7964 (setq nfunc (1+ nfunc))
7965 (setq key (org-key (car elt))
7966 fun (nth 1 elt)
7967 cmd (orgstruct-make-binding fun nfunc key))
7968 (org-defkey orgstruct-mode-map key cmd))
7970 ;; Special treatment needed for TAB and RET
7971 (org-defkey orgstruct-mode-map [(tab)]
7972 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7973 (org-defkey orgstruct-mode-map "\C-i"
7974 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7976 (org-defkey orgstruct-mode-map "\M-\C-m"
7977 (orgstruct-make-binding 'org-insert-heading 105
7978 "\M-\C-m" [(meta return)]))
7979 (org-defkey orgstruct-mode-map [(meta return)]
7980 (orgstruct-make-binding 'org-insert-heading 106
7981 [(meta return)] "\M-\C-m"))
7983 (org-defkey orgstruct-mode-map [(shift meta return)]
7984 (orgstruct-make-binding 'org-insert-todo-heading 107
7985 [(meta return)] "\M-\C-m"))
7987 (unless org-local-vars
7988 (setq org-local-vars (org-get-local-variables)))
7990 t))
7992 (defun orgstruct-make-binding (fun n &rest keys)
7993 "Create a function for binding in the structure minor mode.
7994 FUN is the command to call inside a table. N is used to create a unique
7995 command name. KEYS are keys that should be checked in for a command
7996 to execute outside of tables."
7997 (eval
7998 (list 'defun
7999 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8000 '(arg)
8002 "Outside of structure, run the binding of `"
8003 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8004 "'.")
8005 '(interactive "p")
8006 (list 'if
8007 '(org-context-p 'headline 'item)
8008 (list 'org-run-like-in-org-mode (list 'quote fun))
8009 (list 'let '(orgstruct-mode)
8010 (list 'call-interactively
8011 (append '(or)
8012 (mapcar (lambda (k)
8013 (list 'key-binding k))
8014 keys)
8015 '('orgstruct-error))))))))
8017 (defun org-context-p (&rest contexts)
8018 "Check if local context is and of CONTEXTS.
8019 Possible values in the list of contexts are `table', `headline', and `item'."
8020 (let ((pos (point)))
8021 (goto-char (point-at-bol))
8022 (prog1 (or (and (memq 'table contexts)
8024 (and (memq 'headline contexts)
8026 (and (memq 'item contexts)
8028 (goto-char pos))))
8030 (defun org-get-local-variables ()
8031 "Return a list of all local variables in an org-mode buffer."
8032 (let (varlist)
8033 (with-current-buffer (get-buffer-create "*Org tmp*")
8034 (erase-buffer)
8035 (org-mode)
8036 (setq varlist (buffer-local-variables)))
8037 (kill-buffer "*Org tmp*")
8038 (delq nil
8039 (mapcar
8040 (lambda (x)
8041 (setq x
8042 (if (symbolp x)
8043 (list x)
8044 (list (car x) (list 'quote (cdr x)))))
8045 (if (string-match
8046 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8047 (symbol-name (car x)))
8048 x nil))
8049 varlist))))
8051 ;;;###autoload
8052 (defun org-run-like-in-org-mode (cmd)
8053 (unless org-local-vars
8054 (setq org-local-vars (org-get-local-variables)))
8055 (eval (list 'let org-local-vars
8056 (list 'call-interactively (list 'quote cmd)))))
8058 ;;;; Archiving
8060 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
8062 (defun org-archive-subtree (&optional find-done)
8063 "Move the current subtree to the archive.
8064 The archive can be a certain top-level heading in the current file, or in
8065 a different file. The tree will be moved to that location, the subtree
8066 heading be marked DONE, and the current time will be added.
8068 When called with prefix argument FIND-DONE, find whole trees without any
8069 open TODO items and archive them (after getting confirmation from the user).
8070 If the cursor is not at a headline when this comand is called, try all level
8071 1 trees. If the cursor is on a headline, only try the direct children of
8072 this heading."
8073 (interactive "P")
8074 (if find-done
8075 (org-archive-all-done)
8076 ;; Save all relevant TODO keyword-relatex variables
8078 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
8079 (tr-org-todo-keywords-1 org-todo-keywords-1)
8080 (tr-org-todo-kwd-alist org-todo-kwd-alist)
8081 (tr-org-done-keywords org-done-keywords)
8082 (tr-org-todo-regexp org-todo-regexp)
8083 (tr-org-todo-line-regexp org-todo-line-regexp)
8084 (tr-org-odd-levels-only org-odd-levels-only)
8085 (this-buffer (current-buffer))
8086 (org-archive-location org-archive-location)
8088 ;; start of variables that will be used for saving context
8089 ;; The compiler complains about them - keep them anyway!
8090 (file (abbreviate-file-name (buffer-file-name)))
8091 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
8092 (time (format-time-string
8093 (substring (cdr org-time-stamp-formats) 1 -1)
8094 (current-time)))
8095 afile heading buffer level newfile-p
8096 category todo priority
8097 ;; start of variables that will be used for savind context
8098 ltags itags prop)
8100 ;; Try to find a local archive location
8101 (save-excursion
8102 (save-restriction
8103 (widen)
8104 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
8106 (setq org-archive-location prop)
8107 (if (or (re-search-backward re nil t)
8108 (re-search-forward re nil t))
8109 (setq org-archive-location (match-string 1))))))
8112 (progn
8113 (setq afile (format (match-string 1 org-archive-location)
8114 (file-name-nondirectory buffer-file-name))
8115 heading (match-string 2 org-archive-location)))
8116 (error "Invalid `org-archive-location'"))
8117 (if (> (length afile) 0)
8118 (setq newfile-p (not (file-exists-p afile))
8119 buffer (find-file-noselect afile))
8120 (setq buffer (current-buffer)))
8121 (unless buffer
8123 (if (and (> (length heading) 0)
8125 (setq level (match-end 0))
8126 (setq heading nil level 0))
8127 (save-excursion
8128 (org-back-to-heading t)
8129 ;; Get context information that will be lost by moving the tree
8130 (org-refresh-category-properties)
8131 (setq category (org-get-category)
8132 todo (and (looking-at org-todo-line-regexp)
8133 (match-string 2))
8134 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
8135 ltags (org-get-tags)
8136 itags (org-delete-all ltags (org-get-tags-at)))
8137 (setq ltags (mapconcat 'identity ltags " ")
8138 itags (mapconcat 'identity itags " "))
8139 ;; We first only copy, in case something goes wrong
8140 ;; we need to protect this-command, to avoid kill-region sets it,
8141 ;; which would lead to duplication of subtrees
8142 (let (this-command) (org-copy-subtree))
8143 (set-buffer buffer)
8144 ;; Enforce org-mode for the archive buffer
8145 (if (not (org-mode-p))
8146 ;; Force the mode for future visits.
8147 (let ((org-insert-mode-line-in-empty-file t)
8148 (org-inhibit-startup t))
8149 (call-interactively 'org-mode)))
8150 (when newfile-p
8151 (goto-char (point-max))
8153 (buffer-file-name this-buffer))))
8154 ;; Force the TODO keywords of the original buffer
8155 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
8156 (org-todo-keywords-1 tr-org-todo-keywords-1)
8157 (org-todo-kwd-alist tr-org-todo-kwd-alist)
8158 (org-done-keywords tr-org-done-keywords)
8159 (org-todo-regexp tr-org-todo-regexp)
8160 (org-todo-line-regexp tr-org-todo-line-regexp)
8161 (org-odd-levels-only
8162 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8163 org-odd-levels-only
8164 tr-org-odd-levels-only)))
8165 (goto-char (point-min))
8166 (show-all)
8167 (if heading
8168 (progn
8169 (if (re-search-forward
8170 (concat "^" (regexp-quote heading)
8172 nil t)
8173 (goto-char (match-end 0))
8174 ;; Heading not found, just insert it at the end
8175 (goto-char (point-max))
8178 (end-of-line 0))
8179 ;; Make the subtree visible
8180 (show-subtree)
8181 (org-end-of-subtree t)
8185 ;; No specific heading, just go to end of file.
8187 ;; Paste
8188 (org-paste-subtree (org-get-valid-level level 1))
8190 ;; Mark the entry as done
8191 (when (and org-archive-mark-done
8192 (looking-at org-todo-line-regexp)
8193 (or (not (match-end 2))
8194 (not (member (match-string 2) org-done-keywords))))
8195 (let (org-log-done org-todo-log-states)
8196 (org-todo
8197 (car (or (member org-archive-mark-done org-done-keywords)
8198 org-done-keywords)))))
8200 ;; Add the context info
8201 (when org-archive-save-context-info
8202 (let ((l org-archive-save-context-info) e n v)
8203 (while (setq e (pop l))
8204 (when (and (setq v (symbol-value e))
8206 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8207 (org-entry-put (point) n v)))))
8209 ;; Save and kill the buffer, if it is not the same buffer.
8210 (if (not (eq this-buffer buffer))
8211 (progn (save-buffer) (kill-buffer buffer)))))
8212 ;; Here we are back in the original buffer. Everything seems to have
8213 ;; worked. So now cut the tree and finish up.
8214 (let (this-command) (org-cut-subtree))
8216 (message "Subtree archived %s"
8217 (if (eq this-buffer buffer)
8218 (concat "under heading: " heading)
8219 (concat "in file: " (abbreviate-file-name afile)))))))
8221 (defun org-refresh-category-properties ()
8222 "Refresh category text properties in teh buffer."
8223 (let ((def-cat (cond
8224 ((null org-category)
8225 (if buffer-file-name
8226 (file-name-sans-extension
8227 (file-name-nondirectory buffer-file-name))
8228 "???"))
8229 ((symbolp org-category) (symbol-name org-category))
8230 (t org-category)))
8231 beg end cat pos optionp)
8232 (org-unmodified
8233 (save-excursion
8234 (save-restriction
8235 (widen)
8236 (goto-char (point-min))
8237 (put-text-property (point) (point-max) 'org-category def-cat)
8238 (while (re-search-forward
8240 (setq pos (match-end 0)
8241 optionp (equal (char-after (match-beginning 0)) ?#)
8242 cat (org-trim (match-string 2)))
8243 (if optionp
8244 (setq beg (point-at-bol) end (point-max))
8245 (org-back-to-heading t)
8246 (setq beg (point) end (org-end-of-subtree t t)))
8247 (put-text-property beg end 'org-category cat)
8248 (goto-char pos)))))))
8250 (defun org-archive-all-done (&optional tag)
8251 "Archive sublevels of the current tree without open TODO items.
8252 If the cursor is not on a headline, try all level 1 trees. If
8253 it is on a headline, try all direct children.
8254 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8256 (rea (concat ".*:" org-archive-tag ":"))
8257 (begm (make-marker))
8258 (endm (make-marker))
8259 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8260 "Move subtree to archive (no open TODO items)? "))
8261 beg end (cntarch 0))
8262 (if (org-on-heading-p)
8263 (progn
8264 (setq re1 (concat "^" (regexp-quote
8265 (make-string
8266 (1+ (- (match-end 0) (match-beginning 0) 1))
8267 ?*))
8268 " "))
8269 (move-marker begm (point))
8270 (move-marker endm (org-end-of-subtree t)))
8271 (setq re1 "^* ")
8272 (move-marker begm (point-min))
8273 (move-marker endm (point-max)))
8274 (save-excursion
8275 (goto-char begm)
8276 (while (re-search-forward re1 endm t)
8277 (setq beg (match-beginning 0)
8278 end (save-excursion (org-end-of-subtree t) (point)))
8279 (goto-char beg)
8280 (if (re-search-forward re end t)
8281 (goto-char end)
8282 (goto-char beg)
8283 (if (and (or (not tag) (not (looking-at rea)))
8284 (y-or-n-p question))
8285 (progn
8286 (if tag
8287 (org-toggle-tag org-archive-tag 'on)
8288 (org-archive-subtree))
8289 (setq cntarch (1+ cntarch)))
8290 (goto-char end)))))
8291 (message "%d trees archived" cntarch)))
8293 (defun org-cycle-hide-drawers (state)
8294 "Re-hide all drawers after a visibility state change."
8295 (when (and (org-mode-p)
8296 (not (memq state '(overview folded))))
8297 (save-excursion
8298 (let* ((globalp (memq state '(contents all)))
8299 (beg (if globalp (point-min) (point)))
8300 (end (if globalp (point-max) (org-end-of-subtree t))))
8301 (goto-char beg)
8302 (while (re-search-forward org-drawer-regexp end t)
8303 (org-flag-drawer t))))))
8305 (defun org-flag-drawer (flag)
8306 (save-excursion
8307 (beginning-of-line 1)
8309 (let ((b (match-end 0))
8310 (outline-regexp org-outline-regexp))
8311 (if (re-search-forward
8313 (save-excursion (outline-next-heading) (point)) t)
8314 (outline-flag-region b (point-at-eol) flag)
8315 (error ":END: line missing"))))))
8317 (defun org-cycle-hide-archived-subtrees (state)
8318 "Re-hide all archived subtrees after a visibility state change."
8319 (when (and (not org-cycle-open-archived-trees)
8320 (not (memq state '(overview folded))))
8321 (save-excursion
8322 (let* ((globalp (memq state '(contents all)))
8323 (beg (if globalp (point-min) (point)))
8324 (end (if globalp (point-max) (org-end-of-subtree t))))
8325 (org-hide-archived-subtrees beg end)
8326 (goto-char beg)
8327 (if (looking-at (concat ".*:" org-archive-tag ":"))
8328 (message "%s" (substitute-command-keys
8329 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8331 (defun org-force-cycle-archived ()
8332 "Cycle subtree even if it is archived."
8333 (interactive)
8334 (setq this-command 'org-cycle)
8335 (let ((org-cycle-open-archived-trees t))
8336 (call-interactively 'org-cycle)))
8338 (defun org-hide-archived-subtrees (beg end)
8339 "Re-hide all archived subtrees after a visibility state change."
8340 (save-excursion
8341 (let* ((re (concat ":" org-archive-tag ":")))
8342 (goto-char beg)
8343 (while (re-search-forward re end t)
8344 (and (org-on-heading-p) (hide-subtree))
8345 (org-end-of-subtree t)))))
8347 (defun org-toggle-tag (tag &optional onoff)
8348 "Toggle the tag TAG for the current line.
8349 If ONOFF is `on' or `off', don't toggle but set to this state."
8350 (unless (org-on-heading-p t) (error "Not on headling"))
8351 (let (res current)
8352 (save-excursion
8353 (beginning-of-line)
8355 (point-at-eol) t)
8356 (progn
8357 (setq current (match-string 1))
8358 (replace-match ""))
8359 (setq current ""))
8360 (setq current (nreverse (org-split-string current ":")))
8361 (cond
8362 ((eq onoff 'on)
8363 (setq res t)
8364 (or (member tag current) (push tag current)))
8365 ((eq onoff 'off)
8366 (or (not (member tag current)) (setq current (delete tag current))))
8367 (t (if (member tag current)
8368 (setq current (delete tag current))
8369 (setq res t)
8370 (push tag current))))
8371 (end-of-line 1)
8372 (if current
8373 (progn
8374 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8375 (org-set-tags nil t))
8376 (delete-horizontal-space))
8377 (run-hooks 'org-after-tags-change-hook))
8378 res))
8380 (defun org-toggle-archive-tag (&optional arg)
8381 "Toggle the archive tag for the current headline.
8382 With prefix ARG, check all children of current headline and offer tagging
8383 the children that do not contain any open TODO items."
8384 (interactive "P")
8385 (if arg
8386 (org-archive-all-done 'tag)
8387 (let (set)
8388 (save-excursion
8389 (org-back-to-heading t)
8390 (setq set (org-toggle-tag org-archive-tag))
8391 (when set (hide-subtree)))
8392 (and set (beginning-of-line 1))
8393 (message "Subtree %s" (if set "archived" "unarchived")))))
8396 ;;;; Tables
8398 ;;; The table editor
8400 ;; Watch out: Here we are talking about two different kind of tables.
8401 ;; Most of the code is for the tables created with the Org-mode table editor.
8402 ;; Sometimes, we talk about tables created and edited with the table.el
8403 ;; Emacs package. We call the former org-type tables, and the latter
8404 ;; table.el-type tables.
8406 (defun org-before-change-function (beg end)
8407 "Every change indicates that a table might need an update."
8408 (setq org-table-may-need-update t))
8411 "Detects an org-type table line.")
8413 "Detects an org-type table line.")
8415 "Detects a table line marked for automatic recalculation.")
8417 "Detects a table line marked for automatic recalculation.")
8419 "Detects a table line marked for automatic recalculation.")
8421 "Detects an org-type table hline.")
8423 "Detects a table-type table hline.")
8425 "Detects an org-type or table-type table.")
8427 "Searching from within a table (any type) this finds the first line
8428 outside the table.")
8430 "Searching from within a table (any type) this finds the first line
8431 outside the table.")
8433 (defvar org-table-last-highlighted-reference nil)
8434 (defvar org-table-formula-history nil)
8436 (defvar org-table-column-names nil
8437 "Alist with column names, derived from the `!' line.")
8438 (defvar org-table-column-name-regexp nil
8439 "Regular expression matching the current column names.")
8440 (defvar org-table-local-parameters nil
8441 "Alist with parameter names, derived from the `$' line.")
8442 (defvar org-table-named-field-locations nil
8443 "Alist with locations of named fields.")
8445 (defvar org-table-current-line-types nil
8446 "Table row types, non-nil only for the duration of a comand.")
8447 (defvar org-table-current-begin-line nil
8448 "Table begin line, non-nil only for the duration of a comand.")
8449 (defvar org-table-current-begin-pos nil
8450 "Table begin position, non-nil only for the duration of a comand.")
8451 (defvar org-table-dlines nil
8452 "Vector of data line line numbers in the current table.")
8453 (defvar org-table-hlines nil
8454 "Vector of hline line numbers in the current table.")
8456 (defconst org-table-range-regexp
8457 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8458 ;; 1 2 3 4 5
8459 "Regular expression for matching ranges in formulas.")
8461 (defconst org-table-range-regexp2
8462 (concat
8466 "Match a range for reference display.")
8468 (defconst org-table-translate-regexp
8470 "Match a reference that needs translation, for reference display.")
8472 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8474 (defun org-table-create-with-table.el ()
8475 "Use the table.el package to insert a new table.
8476 If there is already a table at point, convert between Org-mode tables
8477 and table.el tables."
8478 (interactive)
8479 (require 'table)
8480 (cond
8481 ((org-at-table.el-p)
8482 (if (y-or-n-p "Convert table to Org-mode table? ")
8483 (org-table-convert)))
8484 ((org-at-table-p)
8485 (if (y-or-n-p "Convert table to table.el table? ")
8486 (org-table-convert)))
8487 (t (call-interactively 'table-insert))))
8489 (defun org-table-create-or-convert-from-region (arg)
8490 "Convert region to table, or create an empty table.
8491 If there is an active region, convert it to a table, using the function
8492 `org-table-convert-region'. See the documentation of that function
8493 to learn how the prefix argument is interpreted to determine the field
8494 separator.
8495 If there is no such region, create an empty table with `org-table-create'."
8496 (interactive "P")
8497 (if (org-region-active-p)
8498 (org-table-convert-region (region-beginning) (region-end) arg)
8499 (org-table-create arg)))
8501 (defun org-table-create (&optional size)
8502 "Query for a size and insert a table skeleton.
8504 (interactive "P")
8505 (unless size
8506 (setq size (read-string
8507 (concat "Table size Columns x Rows [e.g. "
8508 org-table-default-size "]: ")
8509 "" nil org-table-default-size)))
8511 (let* ((pos (point))
8512 (indent (make-string (current-column) ?\ ))
8513 (split (org-split-string size " *x *"))
8514 (rows (string-to-number (nth 1 split)))
8515 (columns (string-to-number (car split)))
8516 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8519 (point-at-bol) (point)))
8520 (beginning-of-line 1)
8521 (newline))
8522 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8523 (dotimes (i rows) (insert line))
8524 (goto-char pos)
8525 (if (> rows 1)
8526 ;; Insert a hline after the first row.
8527 (progn
8528 (end-of-line 1)
8530 (goto-char pos)))
8531 (org-table-align)))
8533 (defun org-table-convert-region (beg0 end0 &optional separator)
8534 "Convert region to a table.
8535 The region goes from BEG0 to END0, but these borders will be moved
8536 slightly, to make sure a beginning of line in the first line is included.
8538 SEPARATOR specifies the field separator in the lines. It can have the
8539 following values:
8541 '(4) Use the comma as a field separator
8542 '(16) Use a TAB as field separator
8543 integer When a number, use that many spaces as field separator
8544 nil When nil, the command tries to be smart and figure out the
8545 separator in the following way:
8546 - when each line contains a TAB, assume TAB-separated material
8547 - when each line contains a comme, assume CSV material
8548 - else, assume one or more SPACE charcters as separator."
8549 (interactive "rP")
8550 (let* ((beg (min beg0 end0))
8551 (end (max beg0 end0))
8552 re)
8553 (goto-char beg)
8554 (beginning-of-line 1)
8555 (setq beg (move-marker (make-marker) (point)))
8556 (goto-char end)
8557 (if (bolp) (backward-char 1) (end-of-line 1))
8558 (setq end (move-marker (make-marker) (point)))
8559 ;; Get the right field separator
8560 (unless separator
8561 (goto-char beg)
8562 (setq separator
8563 (cond
8566 (t 1))))
8567 (setq re (cond
8570 ((integerp separator)
8572 (t (error "This should not happen"))))
8573 (goto-char beg)
8574 (while (re-search-forward re end t)
8575 (replace-match "| " t t))
8576 (goto-char beg)
8577 (insert " ")
8578 (org-table-align)))
8580 (defun org-table-import (file arg)
8581 "Import FILE as a table.
8582 The file is assumed to be tab-separated. Such files can be produced by most
8583 spreadsheet and database applications. If no tabs (at least one per line)
8584 are found, lines will be split on whitespace into fields."
8586 (or (bolp) (newline))
8587 (let ((beg (point))
8588 (pm (point-max)))
8589 (insert-file-contents file)
8590 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8592 (defun org-table-export ()
8593 "Export table as a tab-separated file.
8594 Such a file can be imported into a spreadsheet program like Excel."
8595 (interactive)
8596 (let* ((beg (org-table-begin))
8597 (end (org-table-end))
8598 (table (buffer-substring beg end))
8599 (file (read-file-name "Export table to: "))
8600 buf)
8601 (unless (or (not (file-exists-p file))
8602 (y-or-n-p (format "Overwrite file %s? " file)))
8603 (error "Abort"))
8604 (with-current-buffer (find-file-noselect file)
8605 (setq buf (current-buffer))
8606 (erase-buffer)
8607 (fundamental-mode)
8608 (insert table)
8609 (goto-char (point-min))
8611 (replace-match "" t t)
8612 (end-of-line 1))
8613 (goto-char (point-min))
8615 (replace-match "" t t)
8616 (goto-char (min (1+ (point)) (point-max))))
8617 (goto-char (point-min))
8618 (while (re-search-forward "^-[-+]*$" nil t)
8619 (replace-match "")
8621 (delete-char 1)))
8622 (goto-char (point-min))
8625 (save-buffer))
8626 (kill-buffer buf)))
8628 (defvar org-table-aligned-begin-marker (make-marker)
8629 "Marker at the beginning of the table last aligned.
8630 Used to check if cursor still is in that table, to minimize realignment.")
8631 (defvar org-table-aligned-end-marker (make-marker)
8632 "Marker at the end of the table last aligned.
8633 Used to check if cursor still is in that table, to minimize realignment.")
8634 (defvar org-table-last-alignment nil
8635 "List of flags for flushright alignment, from the last re-alignment.
8636 This is being used to correctly align a single field after TAB or RET.")
8637 (defvar org-table-last-column-widths nil
8638 "List of max width of fields in each column.
8639 This is being used to correctly align a single field after TAB or RET.")
8640 (defvar org-table-overlay-coordinates nil
8641 "Overlay coordinates after each align of a table.")
8642 (make-variable-buffer-local 'org-table-overlay-coordinates)
8644 (defvar org-last-recalc-line nil)
8645 (defconst org-narrow-column-arrow "=>"
8646 "Used as display property in narrowed table columns.")
8648 (defun org-table-align ()
8649 "Align the table at point by aligning all vertical bars."
8650 (interactive)
8651 (let* (
8652 ;; Limits of table
8653 (beg (org-table-begin))
8654 (end (org-table-end))
8655 ;; Current cursor position
8656 (linepos (org-current-line))
8657 (colpos (org-table-current-column))
8658 (winstart (window-start))
8659 (winstartline (org-current-line (min winstart (1- (point-max)))))
8660 lines (new "") lengths l typenums ty fields maxfields i
8661 column
8662 (indent "") cnt frac
8663 rfmt hfmt
8664 (spaces '(1 . 1))
8665 (sp1 (car spaces))
8666 (sp2 (cdr spaces))
8667 (rfmt1 (concat
8668 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8669 (hfmt1 (concat
8670 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8671 emptystrings links dates emph narrow fmax f1 len c e)
8672 (untabify beg end)
8673 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8674 ;; Check if we have links or dates
8675 (goto-char beg)
8676 (setq links (re-search-forward org-bracket-link-regexp end t))
8677 (goto-char beg)
8678 (setq emph (and org-hide-emphasis-markers
8679 (re-search-forward org-emph-re end t)))
8680 (goto-char beg)
8681 (setq dates (and org-display-custom-times
8682 (re-search-forward org-ts-regexp-both end t)))
8683 ;; Make sure the link properties are right
8684 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8685 ;; Make sure the date properties are right
8686 (when dates (goto-char beg) (while (org-activate-dates end)))
8687 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8689 ;; Check if we are narrowing any columns
8690 (goto-char beg)
8691 (setq narrow (and org-format-transports-properties-p
8692 (re-search-forward "<[0-9]+>" end t)))
8693 ;; Get the rows
8694 (setq lines (org-split-string
8696 ;; Store the indentation of the first line
8697 (if (string-match "^ *" (car lines))
8698 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8699 ;; Mark the hlines by setting the corresponding element to nil
8700 ;; At the same time, we remove trailing space.
8701 (setq lines (mapcar (lambda (l)
8702 (if (string-match "^ *|-" l)
8703 nil
8705 (substring l 0 (match-beginning 0))
8706 l)))
8707 lines))
8708 ;; Get the data fields by splitting the lines.
8709 (setq fields (mapcar
8710 (lambda (l)
8711 (org-split-string l " *| *"))
8712 (delq nil (copy-sequence lines))))
8713 ;; How many fields in the longest line?
8714 (condition-case nil
8715 (setq maxfields (apply 'max (mapcar 'length fields)))
8716 (error
8717 (kill-region beg end)
8718 (org-table-create org-table-default-size)
8719 (error "Empty table - created default table")))
8720 ;; A list of empty strings to fill any short rows on output
8721 (setq emptystrings (make-list maxfields ""))
8722 ;; Check for special formatting.
8723 (setq i -1)
8724 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8725 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8726 ;; Check if there is an explicit width specified
8727 (when narrow
8728 (setq c column fmax nil)
8729 (while c
8730 (setq e (pop c))
8732 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8733 ;; Find fields that are wider than fmax, and shorten them
8734 (when fmax
8735 (loop for xx in column do
8736 (when (and (stringp xx)
8737 (> (org-string-width xx) fmax))
8738 (org-add-props xx nil
8739 'help-echo
8740 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8741 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8742 (unless (> f1 1)
8744 (match-string 0 xx)))
8745 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8746 (add-text-properties (- f1 2) f1
8747 (list 'display org-narrow-column-arrow)
8748 xx)))))
8749 ;; Get the maximum width for each column
8750 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8751 ;; Get the fraction of numbers, to decide about alignment of the column
8752 (setq cnt 0 frac 0.0)
8753 (loop for x in column do
8754 (if (equal x "")
8755 nil
8756 (setq frac ( / (+ (* frac cnt)
8757 (if (string-match org-table-number-regexp x) 1 0))
8758 (setq cnt (1+ cnt))))))
8759 (push (>= frac org-table-number-fraction) typenums))
8760 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8762 ;; Store the alignment of this table, for later editing of single fields
8763 (setq org-table-last-alignment typenums
8764 org-table-last-column-widths lengths)
8766 ;; With invisible characters, `format' does not get the field width right
8767 ;; So we need to make these fields wide by hand.
8768 (when (or links emph)
8769 (loop for i from 0 upto (1- maxfields) do
8770 (setq len (nth i lengths))
8771 (loop for j from 0 upto (1- (length fields)) do
8772 (setq c (nthcdr i (car (nthcdr j fields))))
8773 (if (and (stringp (car c))
8774 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8775 ; (string-match org-bracket-link-regexp (car c))
8776 (< (org-string-width (car c)) len))
8777 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8779 ;; Compute the formats needed for output of the table
8780 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8781 (while (setq l (pop lengths))
8782 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8783 (setq rfmt (concat rfmt (format rfmt1 ty l))
8784 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8788 (setq new (mapconcat
8789 (lambda (l)
8790 (if l (apply 'format rfmt
8791 (append (pop fields) emptystrings))
8792 hfmt))
8793 lines ""))
8794 ;; Replace the old one
8795 (delete-region beg end)
8796 (move-marker end nil)
8797 (move-marker org-table-aligned-begin-marker (point))
8798 (insert new)
8799 (move-marker org-table-aligned-end-marker (point))
8800 (when (and orgtbl-mode (not (org-mode-p)))
8801 (goto-char org-table-aligned-begin-marker)
8802 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8803 ;; Try to move to the old location
8804 (goto-line winstartline)
8805 (setq winstart (point-at-bol))
8806 (goto-line linepos)
8807 (set-window-start (selected-window) winstart 'noforce)
8808 (org-table-goto-column colpos)
8809 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8810 (setq org-table-may-need-update nil)
8811 ))
8813 (defun org-string-width (s)
8814 "Compute width of string, ignoring invisible characters.
8815 This ignores character with invisibility property `org-link', and also
8816 characters with property `org-cwidth', because these will become invisible
8817 upon the next fontification round."
8818 (let (b l)
8819 (when (or (eq t buffer-invisibility-spec)
8820 (assq 'org-link buffer-invisibility-spec))
8821 (while (setq b (text-property-any 0 (length s)
8822 'invisible 'org-link s))
8823 (setq s (concat (substring s 0 b)
8824 (substring s (or (next-single-property-change
8825 b 'invisible s) (length s)))))))
8826 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8827 (setq s (concat (substring s 0 b)
8828 (substring s (or (next-single-property-change
8829 b 'org-cwidth s) (length s))))))
8830 (setq l (string-width s) b -1)
8831 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8832 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8833 l))
8835 (defun org-table-begin (&optional table-type)
8836 "Find the beginning of the table and return its position.
8837 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8838 (save-excursion
8839 (if (not (re-search-backward
8840 (if table-type org-table-any-border-regexp
8841 org-table-border-regexp)
8842 nil t))
8843 (progn (goto-char (point-min)) (point))
8844 (goto-char (match-beginning 0))
8845 (beginning-of-line 2)
8846 (point))))
8848 (defun org-table-end (&optional table-type)
8849 "Find the end of the table and return its position.
8850 With argument TABLE-TYPE, go to the end of a table.el-type table."
8851 (save-excursion
8852 (if (not (re-search-forward
8853 (if table-type org-table-any-border-regexp
8854 org-table-border-regexp)
8855 nil t))
8856 (goto-char (point-max))
8857 (goto-char (match-beginning 0)))
8858 (point-marker)))
8860 (defun org-table-justify-field-maybe (&optional new)
8861 "Justify the current field, text to left, number to right.
8862 Optional argument NEW may specify text to replace the current field content."
8863 (cond
8864 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8865 ((org-at-table-hline-p))
8866 ((and (not new)
8867 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8868 (current-buffer)))
8869 (< (point) org-table-aligned-begin-marker)
8870 (>= (point) org-table-aligned-end-marker)))
8871 ;; This is not the same table, force a full re-align
8872 (setq org-table-may-need-update t))
8873 (t ;; realign the current field, based on previous full realign
8874 (let* ((pos (point)) s
8875 (col (org-table-current-column))
8876 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8877 l f n o e)
8878 (when (> col 0)
8881 (progn
8882 (setq s (match-string 1)
8883 o (match-string 0)
8884 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8885 e (not (= (match-beginning 2) (match-end 2))))
8886 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8887 l (if e "|" (setq org-table-may-need-update t) ""))
8888 n (format f s))
8889 (if new
8890 (if (<= (length new) l) ;; FIXME: length -> str-width?
8891 (setq n (format f new))
8892 (setq n (concat new "|") org-table-may-need-update t)))
8893 (or (equal n o)
8894 (let (org-table-may-need-update)
8895 (replace-match n t t))))
8896 (setq org-table-may-need-update t))
8897 (goto-char pos))))))
8899 (defun org-table-next-field ()
8900 "Go to the next field in the current table, creating new lines as needed.
8901 Before doing so, re-align the table if necessary."
8902 (interactive)
8903 (org-table-maybe-eval-formula)
8904 (org-table-maybe-recalculate-line)
8905 (if (and org-table-automatic-realign
8906 org-table-may-need-update)
8907 (org-table-align))
8908 (let ((end (org-table-end)))
8909 (if (org-at-table-hline-p)
8910 (end-of-line 1))
8911 (condition-case nil
8912 (progn
8913 (re-search-forward "|" end)
8915 (re-search-forward "|" end))
8916 (if (and (looking-at "-")
8917 org-table-tab-jumps-over-hlines
8919 (goto-char (match-beginning 1)))
8920 (if (looking-at "-")
8921 (progn
8922 (beginning-of-line 0)
8923 (org-table-insert-row 'below))
8924 (if (looking-at " ") (forward-char 1))))
8925 (error
8926 (org-table-insert-row 'below)))))
8928 (defun org-table-previous-field ()
8929 "Go to the previous field in the table.
8930 Before doing so, re-align the table if necessary."
8931 (interactive)
8932 (org-table-justify-field-maybe)
8933 (org-table-maybe-recalculate-line)
8934 (if (and org-table-automatic-realign
8935 org-table-may-need-update)
8936 (org-table-align))
8937 (if (org-at-table-hline-p)
8938 (end-of-line 1))
8939 (re-search-backward "|" (org-table-begin))
8940 (re-search-backward "|" (org-table-begin))
8942 (re-search-backward "|" (org-table-begin)))
8943 (if (looking-at "| ?")
8944 (goto-char (match-end 0))))
8946 (defun org-table-next-row ()
8947 "Go to the next row (same column) in the current table.
8948 Before doing so, re-align the table if necessary."
8949 (interactive)
8950 (org-table-maybe-eval-formula)
8951 (org-table-maybe-recalculate-line)
8954 (newline)
8955 (if (and org-table-automatic-realign
8956 org-table-may-need-update)
8957 (org-table-align))
8958 (let ((col (org-table-current-column)))
8959 (beginning-of-line 2)
8960 (if (or (not (org-at-table-p))
8961 (org-at-table-hline-p))
8962 (progn
8963 (beginning-of-line 0)
8964 (org-table-insert-row 'below)))
8965 (org-table-goto-column col)
8967 (if (looking-at " ") (forward-char 1)))))
8969 (defun org-table-copy-down (n)
8970 "Copy a field down in the current column.
8971 If the field at the cursor is empty, copy into it the content of the nearest
8972 non-empty field above. With argument N, use the Nth non-empty field.
8973 If the current field is not empty, it is copied down to the next row, and
8974 the cursor is moved with it. Therefore, repeating this command causes the
8975 column to be filled row-by-row.
8976 If the variable `org-table-copy-increment' is non-nil and the field is an
8977 integer or a timestamp, it will be incremented while copying. In the case of
8978 a timestamp, if the cursor is on the year, change the year. If it is on the
8979 month or the day, change that. Point will stay on the current date field
8980 in order to easily repeat the interval."
8981 (interactive "p")
8982 (let* ((colpos (org-table-current-column))
8983 (col (current-column))
8984 (field (org-table-get-field))
8986 (beg (org-table-begin))
8987 txt)
8988 (org-table-check-inside-data-field)
8989 (if non-empty
8990 (progn
8991 (setq txt (org-trim field))
8992 (org-table-next-row)
8993 (org-table-blank-field))
8994 (save-excursion
8995 (setq txt
8996 (catch 'exit
8997 (while (progn (beginning-of-line 1)
8998 (re-search-backward org-table-dataline-regexp
8999 beg t))
9000 (org-table-goto-column colpos t)
9001 (if (and (looking-at
9003 (= (setq n (1- n)) 0))
9004 (throw 'exit (match-string 1))))))))
9005 (if txt
9006 (progn
9007 (if (and org-table-copy-increment
9008 (string-match "^[0-9]+$" txt))
9009 (setq txt (format "%d" (+ (string-to-number txt) 1))))
9010 (insert txt)
9011 (move-to-column col)
9012 (if (and org-table-copy-increment (org-at-timestamp-p t))
9013 (org-timestamp-up 1)
9014 (org-table-maybe-recalculate-line))
9015 (org-table-align)
9016 (move-to-column col))
9017 (error "No non-empty field found"))))
9019 (defun org-table-check-inside-data-field ()
9020 "Is point inside a table data field?
9021 I.e. not on a hline or before the first or after the last column?
9022 This actually throws an error, so it aborts the current command."
9023 (if (or (not (org-at-table-p))
9024 (= (org-table-current-column) 0)
9025 (org-at-table-hline-p)
9027 (error "Not in table data field")))
9029 (defvar org-table-clip nil
9030 "Clipboard for table regions.")
9032 (defun org-table-blank-field ()
9033 "Blank the current table field or active region."
9034 (interactive)
9035 (org-table-check-inside-data-field)
9036 (if (and (interactive-p) (org-region-active-p))
9037 (let (org-table-clip)
9038 (org-table-cut-region (region-beginning) (region-end)))
9039 (skip-chars-backward "^|")
9040 (backward-char 1)
9042 (let* ((pos (match-beginning 0))
9043 (match (match-string 0))
9044 (len (org-string-width match)))
9045 (replace-match (concat "|" (make-string (1- len) ?\ )))
9046 (goto-char (+ 2 pos))
9047 (substring match 1)))))
9049 (defun org-table-get-field (&optional n replace)
9050 "Return the value of the field in column N of current row.
9051 N defaults to current field.
9052 If REPLACE is a string, replace field with this value. The return value
9053 is always the old value."
9054 (and n (org-table-goto-column n))
9056 (backward-char 1)
9058 (let* ((pos (match-beginning 0))
9059 (val (buffer-substring (1+ pos) (match-end 0))))
9060 (if replace
9061 (replace-match (concat "|" replace) t t))
9062 (goto-char (min (point-at-eol) (+ 2 pos)))
9063 val)
9064 (forward-char 1) ""))
9066 (defun org-table-field-info (arg)
9067 "Show info about the current field, and highlight any reference at point."
9068 (interactive "P")
9069 (org-table-get-specials)
9070 (save-excursion
9071 (let* ((pos (point))
9072 (col (org-table-current-column))
9073 (cname (car (rassoc (int-to-string col) org-table-column-names)))
9074 (name (car (rassoc (list (org-current-line) col)
9075 org-table-named-field-locations)))
9076 (eql (org-table-get-stored-formulas))
9077 (dline (org-table-current-dline))
9078 (ref (format "@%d$%d" dline col))
9079 (ref1 (org-table-convert-refs-to-an ref))
9080 (fequation (or (assoc name eql) (assoc ref eql)))
9081 (cequation (assoc (int-to-string col) eql))
9082 (eqn (or fequation cequation)))
9083 (goto-char pos)
9084 (condition-case nil
9085 (org-table-show-reference 'local)
9086 (error nil))
9087 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
9088 dline col
9089 (if cname (concat " or $" cname) "")
9090 dline col ref1
9091 (if name (concat " or $" name) "")
9092 ;; FIXME: formula info not correct if special table line
9093 (if eqn
9094 (concat ", formula: "
9095 (org-table-formula-to-user
9096 (concat
9097 (if (string-match "^[$@]"(car eqn)) "" "$")
9098 (car eqn) "=" (cdr eqn))))
9099 "")))))
9101 (defun org-table-current-column ()
9102 "Find out which column we are in.
9103 When called interactively, column is also displayed in echo area."
9104 (interactive)
9105 (if (interactive-p) (org-table-check-inside-data-field))
9106 (save-excursion
9107 (let ((cnt 0) (pos (point)))
9108 (beginning-of-line 1)
9109 (while (search-forward "|" pos t)
9110 (setq cnt (1+ cnt)))
9111 (if (interactive-p) (message "This is table column %d" cnt))
9112 cnt)))
9114 (defun org-table-current-dline ()
9115 "Find out what table data line we are in.
9116 Only datalins count for this."
9117 (interactive)
9118 (if (interactive-p) (org-table-check-inside-data-field))
9119 (save-excursion
9120 (let ((cnt 0) (pos (point)))
9121 (goto-char (org-table-begin))
9122 (while (<= (point) pos)
9123 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
9124 (beginning-of-line 2))
9125 (if (interactive-p) (message "This is table line %d" cnt))
9126 cnt)))
9128 (defun org-table-goto-column (n &optional on-delim force)
9129 "Move the cursor to the Nth column in the current table line.
9130 With optional argument ON-DELIM, stop with point before the left delimiter
9131 of the field.
9132 If there are less than N fields, just go to after the last delimiter.
9133 However, when FORCE is non-nil, create new columns if necessary."
9134 (interactive "p")
9135 (let ((pos (point-at-eol)))
9136 (beginning-of-line 1)
9137 (when (> n 0)
9138 (while (and (> (setq n (1- n)) -1)
9139 (or (search-forward "|" pos t)
9140 (and force
9141 (progn (end-of-line 1)
9142 (skip-chars-backward "^|")
9143 (insert " | "))))))
9144 ; (backward-char 2) t)))))
9145 (when (and force (not (looking-at ".*|")))
9146 (save-excursion (end-of-line 1) (insert " | ")))
9147 (if on-delim
9148 (backward-char 1)
9149 (if (looking-at " ") (forward-char 1))))))
9151 (defun org-at-table-p (&optional table-type)
9152 "Return t if the cursor is inside an org-type table.
9153 If TABLE-TYPE is non-nil, also check for table.el-type tables."
9154 (if org-enable-table-editor
9155 (save-excursion
9156 (beginning-of-line 1)
9157 (looking-at (if table-type org-table-any-line-regexp
9158 org-table-line-regexp)))
9159 nil))
9161 (defun org-at-table.el-p ()
9162 "Return t if and only if we are at a table.el table."
9163 (and (org-at-table-p 'any)
9164 (save-excursion
9165 (goto-char (org-table-begin 'any))
9166 (looking-at org-table1-hline-regexp))))
9168 (defun org-table-recognize-table.el ()
9169 "If there is a table.el table nearby, recognize it and move into it."
9170 (if org-table-tab-recognizes-table.el
9171 (if (org-at-table.el-p)
9172 (progn
9173 (beginning-of-line 1)
9174 (if (looking-at org-table-dataline-regexp)
9175 nil
9176 (if (looking-at org-table1-hline-regexp)
9177 (progn
9178 (beginning-of-line 2)
9179 (if (looking-at org-table-any-border-regexp)
9180 (beginning-of-line -1)))))
9181 (if (re-search-forward "|" (org-table-end t) t)
9182 (progn
9183 (require 'table)
9184 (if (table--at-cell-p (point))
9185 t
9186 (message "recognizing table.el table...")
9187 (table-recognize-table)
9188 (message "recognizing table.el table...done")))
9189 (error "This should not happen..."))
9190 t)
9191 nil)
9192 nil))
9194 (defun org-at-table-hline-p ()
9195 "Return t if the cursor is inside a hline in a table."
9196 (if org-enable-table-editor
9197 (save-excursion
9198 (beginning-of-line 1)
9199 (looking-at org-table-hline-regexp))
9200 nil))
9202 (defun org-table-insert-column ()
9203 "Insert a new column into the table."
9204 (interactive)
9205 (if (not (org-at-table-p))
9206 (error "Not at a table"))
9207 (org-table-find-dataline)
9208 (let* ((col (max 1 (org-table-current-column)))
9209 (beg (org-table-begin))
9210 (end (org-table-end))
9211 ;; Current cursor position
9212 (linepos (org-current-line))
9213 (colpos col))
9214 (goto-char beg)
9215 (while (< (point) end)
9216 (if (org-at-table-hline-p)
9217 nil
9218 (org-table-goto-column col t)
9219 (insert "| "))
9220 (beginning-of-line 2))
9221 (move-marker end nil)
9222 (goto-line linepos)
9223 (org-table-goto-column colpos)
9224 (org-table-align)
9225 (org-table-fix-formulas "$" nil (1- col) 1)))
9227 (defun org-table-find-dataline ()
9228 "Find a dataline in the current table, which is needed for column commands."
9229 (if (and (org-at-table-p)
9230 (not (org-at-table-hline-p)))
9231 t
9232 (let ((col (current-column))
9233 (end (org-table-end)))
9234 (move-to-column col)
9235 (while (and (< (point) end)
9236 (or (not (= (current-column) col))
9237 (org-at-table-hline-p)))
9238 (beginning-of-line 2)
9239 (move-to-column col))
9240 (if (and (org-at-table-p)
9241 (not (org-at-table-hline-p)))
9242 t
9243 (error
9244 "Please position cursor in a data line for column operations")))))
9246 (defun org-table-delete-column ()
9247 "Delete a column from the table."
9248 (interactive)
9249 (if (not (org-at-table-p))
9250 (error "Not at a table"))
9251 (org-table-find-dataline)
9252 (org-table-check-inside-data-field)
9253 (let* ((col (org-table-current-column))
9254 (beg (org-table-begin))
9255 (end (org-table-end))
9256 ;; Current cursor position
9257 (linepos (org-current-line))
9258 (colpos col))
9259 (goto-char beg)
9260 (while (< (point) end)
9261 (if (org-at-table-hline-p)
9262 nil
9263 (org-table-goto-column col t)
9265 (replace-match "|")))
9266 (beginning-of-line 2))
9267 (move-marker end nil)
9268 (goto-line linepos)
9269 (org-table-goto-column colpos)
9270 (org-table-align)
9271 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9272 col -1 col)))
9274 (defun org-table-move-column-right ()
9275 "Move column to the right."
9276 (interactive)
9277 (org-table-move-column nil))
9278 (defun org-table-move-column-left ()
9279 "Move column to the left."
9280 (interactive)
9281 (org-table-move-column 'left))
9283 (defun org-table-move-column (&optional left)
9284 "Move the current column to the right. With arg LEFT, move to the left."
9285 (interactive "P")
9286 (if (not (org-at-table-p))
9287 (error "Not at a table"))
9288 (org-table-find-dataline)
9289 (org-table-check-inside-data-field)
9290 (let* ((col (org-table-current-column))
9291 (col1 (if left (1- col) col))
9292 (beg (org-table-begin))
9293 (end (org-table-end))
9294 ;; Current cursor position
9295 (linepos (org-current-line))
9296 (colpos (if left (1- col) (1+ col))))
9297 (if (and left (= col 1))
9298 (error "Cannot move column further left"))
9300 (error "Cannot move column further right"))
9301 (goto-char beg)
9302 (while (< (point) end)
9303 (if (org-at-table-hline-p)
9304 nil
9305 (org-table-goto-column col1 t)
9308 (beginning-of-line 2))
9309 (move-marker end nil)
9310 (goto-line linepos)
9311 (org-table-goto-column colpos)
9312 (org-table-align)
9313 (org-table-fix-formulas
9314 "$" (list (cons (number-to-string col) (number-to-string colpos))
9315 (cons (number-to-string colpos) (number-to-string col))))))
9317 (defun org-table-move-row-down ()
9318 "Move table row down."
9319 (interactive)
9320 (org-table-move-row nil))
9321 (defun org-table-move-row-up ()
9322 "Move table row up."
9323 (interactive)
9324 (org-table-move-row 'up))
9326 (defun org-table-move-row (&optional up)
9327 "Move the current table line down. With arg UP, move it up."
9328 (interactive "P")
9329 (let* ((col (current-column))
9330 (pos (point))
9331 (hline1p (save-excursion (beginning-of-line 1)
9332 (looking-at org-table-hline-regexp)))
9333 (dline1 (org-table-current-dline))
9334 (dline2 (+ dline1 (if up -1 1)))
9335 (tonew (if up 0 2))
9336 txt hline2p)
9337 (beginning-of-line tonew)
9338 (unless (org-at-table-p)
9339 (goto-char pos)
9340 (error "Cannot move row further"))
9341 (setq hline2p (looking-at org-table-hline-regexp))
9342 (goto-char pos)
9343 (beginning-of-line 1)
9344 (setq pos (point))
9345 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9346 (delete-region (point) (1+ (point-at-eol)))
9347 (beginning-of-line tonew)
9348 (insert txt)
9349 (beginning-of-line 0)
9350 (move-to-column col)
9351 (unless (or hline1p hline2p)
9352 (org-table-fix-formulas
9353 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9354 (cons (number-to-string dline2) (number-to-string dline1)))))))
9356 (defun org-table-insert-row (&optional arg)
9357 "Insert a new row above the current line into the table.
9358 With prefix ARG, insert below the current line."
9359 (interactive "P")
9360 (if (not (org-at-table-p))
9361 (error "Not at a table"))
9362 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9363 (new (org-table-clean-line line)))
9364 ;; Fix the first field if necessary
9366 (setq new (replace-match (match-string 0 line) t t new)))
9367 (beginning-of-line (if arg 2 1))
9369 (beginning-of-line 0)
9370 (re-search-forward "| ?" (point-at-eol) t)
9371 (and (or org-table-may-need-update org-table-overlay-coordinates)
9372 (org-table-align))
9373 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9375 (defun org-table-insert-hline (&optional above)
9376 "Insert a horizontal-line below the current line into the table.
9377 With prefix ABOVE, insert above the current line."
9378 (interactive "P")
9379 (if (not (org-at-table-p))
9380 (error "Not at a table"))
9381 (let ((line (org-table-clean-line
9382 (buffer-substring (point-at-bol) (point-at-eol))))
9383 (col (current-column)))
9385 (setq line (replace-match
9386 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9387 ?-) "|") t t line)))
9389 (beginning-of-line (if above 1 2))
9391 (beginning-of-line (if above 1 -1))
9392 (move-to-column col)
9393 (and org-table-overlay-coordinates (org-table-align))))
9395 (defun org-table-hline-and-move (&optional same-column)
9396 "Insert a hline and move to the row below that line."
9397 (interactive "P")
9398 (let ((col (org-table-current-column)))
9399 (org-table-maybe-eval-formula)
9400 (org-table-maybe-recalculate-line)
9401 (org-table-insert-hline)
9402 (end-of-line 2)
9405 (org-table-next-field))
9406 (if same-column (org-table-goto-column col))))
9408 (defun org-table-clean-line (s)
9410 In particular, this does handle wide and invisible characters."
9412 ;; It's a hline, just map the characters
9413 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9415 (setq s (replace-match
9416 (concat "|" (make-string (org-string-width (match-string 1 s))
9417 ?\ ) "|")
9418 t t s)))
9419 s))
9421 (defun org-table-kill-row ()
9422 "Delete the current row or horizontal line from the table."
9423 (interactive)
9424 (if (not (org-at-table-p))
9425 (error "Not at a table"))
9426 (let ((col (current-column))
9427 (dline (org-table-current-dline)))
9428 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9429 (if (not (org-at-table-p)) (beginning-of-line 0))
9430 (move-to-column col)
9431 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9432 dline -1 dline)))
9434 (defun org-table-sort-lines (with-case &optional sorting-type)
9435 "Sort table lines according to the column at point.
9437 The position of point indicates the column to be used for
9438 sorting, and the range of lines is the range between the nearest
9439 horizontal separator lines, or the entire table of no such lines
9440 exist. If point is before the first column, you will be prompted
9441 for the sorting column. If there is an active region, the mark
9442 specifies the first line and the sorting column, while point
9443 should be in the last line to be included into the sorting.
9445 The command then prompts for the sorting type which can be
9446 alphabetically, numerically, or by time (as given in a time stamp
9447 in the field). Sorting in reverse order is also possible.
9449 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9451 If SORTING-TYPE is specified when this function is called from a Lisp
9452 program, no prompting will take place. SORTING-TYPE must be a character,
9453 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9454 should be done in reverse order."
9455 (interactive "P")
9456 (let* ((thisline (org-current-line))
9457 (thiscol (org-table-current-column))
9458 beg end bcol ecol tend tbeg column lns pos)
9459 (when (equal thiscol 0)
9460 (if (interactive-p)
9461 (setq thiscol
9462 (string-to-number
9463 (read-string "Use column N for sorting: ")))
9464 (setq thiscol 1))
9465 (org-table-goto-column thiscol))
9466 (org-table-check-inside-data-field)
9467 (if (org-region-active-p)
9468 (progn
9469 (setq beg (region-beginning) end (region-end))
9470 (goto-char beg)
9471 (setq column (org-table-current-column)
9472 beg (point-at-bol))
9473 (goto-char end)
9474 (setq end (point-at-bol 2)))
9475 (setq column (org-table-current-column)
9476 pos (point)
9477 tbeg (org-table-begin)
9478 tend (org-table-end))
9479 (if (re-search-backward org-table-hline-regexp tbeg t)
9480 (setq beg (point-at-bol 2))
9481 (goto-char tbeg)
9482 (setq beg (point-at-bol 1)))
9483 (goto-char pos)
9484 (if (re-search-forward org-table-hline-regexp tend t)
9485 (setq end (point-at-bol 1))
9486 (goto-char tend)
9487 (setq end (point-at-bol))))
9488 (setq beg (move-marker (make-marker) beg)
9489 end (move-marker (make-marker) end))
9490 (untabify beg end)
9491 (goto-char beg)
9492 (org-table-goto-column column)
9493 (skip-chars-backward "^|")
9494 (setq bcol (current-column))
9495 (org-table-goto-column (1+ column))
9496 (skip-chars-backward "^|")
9497 (setq ecol (1- (current-column)))
9498 (org-table-goto-column column)
9499 (setq lns (mapcar (lambda(x) (cons
9500 (org-sort-remove-invisible
9501 (nth (1- column)
9503 x))
9505 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9506 (delete-region beg end)
9507 (move-marker beg nil)
9508 (move-marker end nil)
9510 (goto-line thisline)
9511 (org-table-goto-column thiscol)
9512 (message "%d lines sorted, based on column %d" (length lns) column)))
9514 ;; FIXME: maybe we will not need this? Table sorting is broken....
9515 (defun org-sort-remove-invisible (s)
9516 (remove-text-properties 0 (length s) org-rm-props s)
9517 (while (string-match org-bracket-link-regexp s)
9518 (setq s (replace-match (if (match-end 2)
9519 (match-string 3 s)
9520 (match-string 1 s)) t t s)))
9521 s)
9523 (defun org-table-cut-region (beg end)
9524 "Copy region in table to the clipboard and blank all relevant fields."
9525 (interactive "r")
9526 (org-table-copy-region beg end 'cut))
9528 (defun org-table-copy-region (beg end &optional cut)
9529 "Copy rectangular region in table to clipboard.
9530 A special clipboard is used which can only be accessed
9531 with `org-table-paste-rectangle'."
9532 (interactive "rP")
9533 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9534 region cols
9535 (rpl (if cut " " nil)))
9536 (goto-char beg)
9537 (org-table-check-inside-data-field)
9538 (setq l01 (org-current-line)
9539 c01 (org-table-current-column))
9540 (goto-char end)
9541 (org-table-check-inside-data-field)
9542 (setq l02 (org-current-line)
9543 c02 (org-table-current-column))
9544 (setq l1 (min l01 l02) l2 (max l01 l02)
9545 c1 (min c01 c02) c2 (max c01 c02))
9546 (catch 'exit
9547 (while t
9548 (catch 'nextline
9549 (if (> l1 l2) (throw 'exit t))
9550 (goto-line l1)
9551 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9552 (setq cols nil ic1 c1 ic2 c2)
9553 (while (< ic1 (1+ ic2))
9554 (push (org-table-get-field ic1 rpl) cols)
9555 (setq ic1 (1+ ic1)))
9556 (push (nreverse cols) region)
9557 (setq l1 (1+ l1)))))
9558 (setq org-table-clip (nreverse region))
9559 (if cut (org-table-align))
9560 org-table-clip))
9562 (defun org-table-paste-rectangle ()
9563 "Paste a rectangular region into a table.
9564 The upper right corner ends up in the current field. All involved fields
9565 will be overwritten. If the rectangle does not fit into the present table,
9566 the table is enlarged as needed. The process ignores horizontal separator
9567 lines."
9568 (interactive)
9569 (unless (and org-table-clip (listp org-table-clip))
9570 (error "First cut/copy a region to paste!"))
9571 (org-table-check-inside-data-field)
9572 (let* ((clip org-table-clip)
9573 (line (org-current-line))
9574 (col (org-table-current-column))
9575 (org-enable-table-editor t)
9576 (org-table-automatic-realign nil)
9577 c cols field)
9578 (while (setq cols (pop clip))
9579 (while (org-at-table-hline-p) (beginning-of-line 2))
9580 (if (not (org-at-table-p))
9581 (progn (end-of-line 0) (org-table-next-field)))
9582 (setq c col)
9583 (while (setq field (pop cols))
9584 (org-table-goto-column c nil 'force)
9585 (org-table-get-field nil field)
9586 (setq c (1+ c)))
9587 (beginning-of-line 2))
9588 (goto-line line)
9589 (org-table-goto-column col)
9590 (org-table-align)))
9592 (defun org-table-convert ()
9593 "Convert from `org-mode' table to table.el and back.
9594 Obviously, this only works within limits. When an Org-mode table is
9595 converted to table.el, all horizontal separator lines get lost, because
9596 table.el uses these as cell boundaries and has no notion of horizontal lines.
9597 A table.el table can be converted to an Org-mode table only if it does not
9598 do row or column spanning. Multiline cells will become multiple cells.
9599 Beware, Org-mode does not test if the table can be successfully converted - it
9600 blindly applies a recipe that works for simple tables."
9601 (interactive)
9602 (require 'table)
9603 (if (org-at-table.el-p)
9604 ;; convert to Org-mode table
9605 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9606 (end (move-marker (make-marker) (org-table-end t))))
9607 (table-unrecognize-region beg end)
9608 (goto-char beg)
9610 (replace-match ""))
9611 (goto-char beg))
9612 (if (org-at-table-p)
9613 ;; convert to table.el table
9614 (let ((beg (move-marker (make-marker) (org-table-begin)))
9615 (end (move-marker (make-marker) (org-table-end))))
9616 ;; first, get rid of all horizontal lines
9617 (goto-char beg)
9619 (replace-match ""))
9620 ;; insert a hline before first
9621 (goto-char beg)
9622 (org-table-insert-hline 'above)
9623 (beginning-of-line -1)
9624 ;; insert a hline after each line
9625 (while (progn (beginning-of-line 3) (< (point) end))
9626 (org-table-insert-hline))
9627 (goto-char beg)
9628 (setq end (move-marker end (org-table-end)))
9629 ;; replace "+" at beginning and ending of hlines
9632 (goto-char beg)
9634 (replace-match "-+"))
9635 (goto-char beg)))))
9637 (defun org-table-wrap-region (arg)
9638 "Wrap several fields in a column like a paragraph.
9639 This is useful if you'd like to spread the contents of a field over several
9640 lines, in order to keep the table compact.
9642 If there is an active region, and both point and mark are in the same column,
9643 the text in the column is wrapped to minimum width for the given number of
9644 lines. Generally, this makes the table more compact. A prefix ARG may be
9646 formats the selected text to two lines. If the region was longer than two
9647 lines, the remaining lines remain empty. A negative prefix argument reduces
9648 the current number of lines by that amount. The wrapped text is pasted back
9649 into the table. If you formatted it to more lines than it was before, fields
9650 further down in the table get overwritten - so you might need to make space in
9651 the table first.
9653 If there is no region, the current field is split at the cursor position and
9654 the text fragment to the right of the cursor is prepended to the field one
9655 line down.
9657 If there is no region, but you specify a prefix ARG, the current field gets
9658 blank, and the content is appended to the field above."
9659 (interactive "P")
9660 (org-table-check-inside-data-field)
9661 (if (org-region-active-p)
9662 ;; There is a region: fill as a paragraph
9663 (let* ((beg (region-beginning))
9664 (cline (save-excursion (goto-char beg) (org-current-line)))
9665 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9666 nlines)
9667 (org-table-cut-region (region-beginning) (region-end))
9668 (if (> (length (car org-table-clip)) 1)
9669 (error "Region must be limited to single column"))
9670 (setq nlines (if arg
9671 (if (< arg 1)
9672 (+ (length org-table-clip) arg)
9673 arg)
9674 (length org-table-clip)))
9675 (setq org-table-clip
9676 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9677 nil nlines)))
9678 (goto-line cline)
9679 (org-table-goto-column ccol)
9680 (org-table-paste-rectangle))
9681 ;; No region, split the current field at point
9682 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9684 (if arg
9685 ;; combine with field above
9686 (let ((s (org-table-blank-field))
9687 (col (org-table-current-column)))
9688 (beginning-of-line 0)
9689 (while (org-at-table-hline-p) (beginning-of-line 0))
9690 (org-table-goto-column col)
9691 (skip-chars-forward "^|")
9692 (skip-chars-backward " ")
9693 (insert " " (org-trim s))
9694 (org-table-align))
9695 ;; split field
9697 (let ((s (match-string 1)))
9698 (replace-match " |")
9699 (goto-char (match-beginning 0))
9700 (org-table-next-row)
9701 (insert (org-trim s) " ")
9702 (org-table-align))
9703 (org-table-next-row)))))
9705 (defvar org-field-marker nil)
9707 (defun org-table-edit-field (arg)
9708 "Edit table field in a different window.
9709 This is mainly useful for fields that contain hidden parts.
9711 it can be edited in place."
9712 (interactive "P")
9713 (if arg
9714 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9716 (remove-text-properties b e '(org-cwidth t invisible t
9717 display t intangible t))
9718 (if (and (boundp 'font-lock-mode) font-lock-mode)
9719 (font-lock-fontify-block)))
9720 (let ((pos (move-marker (make-marker) (point)))
9721 (field (org-table-get-field))
9722 (cw (current-window-configuration))
9723 p)
9724 (org-switch-to-buffer-other-window "*Org tmp*")
9725 (erase-buffer)
9727 (let ((org-inhibit-startup t)) (org-mode))
9728 (goto-char (setq p (point-max)))
9729 (insert (org-trim field))
9730 (remove-text-properties p (point-max)
9731 '(invisible t org-cwidth t display t
9732 intangible t))
9733 (goto-char p)
9734 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9735 (org-set-local 'org-window-configuration cw)
9736 (org-set-local 'org-field-marker pos)
9737 (message "Edit and finish with C-c C-c"))))
9739 (defun org-table-finish-edit-field ()
9740 "Finish editing a table data field.
9741 Remove all newline characters, insert the result into the table, realign
9742 the table and kill the editing buffer."
9743 (let ((pos org-field-marker)
9744 (cw org-window-configuration)
9745 (cb (current-buffer))
9746 text)
9747 (goto-char (point-min))
9750 (replace-match " "))
9751 (setq text (org-trim (buffer-string)))
9752 (set-window-configuration cw)
9753 (kill-buffer cb)
9754 (select-window (get-buffer-window (marker-buffer pos)))
9755 (goto-char pos)
9756 (move-marker pos nil)
9757 (org-table-check-inside-data-field)
9758 (org-table-get-field nil text)
9759 (org-table-align)
9760 (message "New field value inserted")))
9762 (defun org-trim (s)
9763 "Remove whitespace at beginning and end of string."
9766 s)
9768 (defun org-wrap (string &optional width lines)
9769 "Wrap string to either a number of lines, or a width in characters.
9770 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9771 that costs. If there is a word longer than WIDTH, the text is actually
9772 wrapped to the length of that word.
9773 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9774 many lines, whatever width that takes.
9775 The return value is a list of lines, without newlines at the end."
9777 (maxword (apply 'max (mapcar 'org-string-width words)))
9778 w ll)
9779 (cond (width
9780 (org-do-wrap words (max maxword width)))
9781 (lines
9782 (setq w maxword)
9783 (setq ll (org-do-wrap words maxword))
9784 (if (<= (length ll) lines)
9785 ll
9786 (setq ll words)
9787 (while (> (length ll) lines)
9788 (setq w (1+ w))
9789 (setq ll (org-do-wrap words w)))
9790 ll))
9791 (t (error "Cannot wrap this")))))
9794 (defun org-do-wrap (words width)
9795 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9796 (let (lines line)
9797 (while words
9798 (setq line (pop words))
9799 (while (and words (< (+ (length line) (length (car words))) width))
9800 (setq line (concat line " " (pop words))))
9801 (setq lines (push line lines)))
9802 (nreverse lines)))
9804 (defun org-split-string (string &optional separators)
9805 "Splits STRING into substrings at SEPARATORS.
9806 No empty strings are returned if there are matches at the beginning
9807 and end of string."
9809 (start 0)
9810 notfirst
9811 (list nil))
9812 (while (and (string-match rexp string
9813 (if (and notfirst
9814 (= start (match-beginning 0))
9815 (< start (length string)))
9816 (1+ start) start))
9817 (< (match-beginning 0) (length string)))
9818 (setq notfirst t)
9819 (or (eq (match-beginning 0) 0)
9820 (and (eq (match-beginning 0) (match-end 0))
9821 (eq (match-beginning 0) start))
9822 (setq list
9823 (cons (substring string start (match-beginning 0))
9824 list)))
9825 (setq start (match-end 0)))
9826 (or (eq start (length string))
9827 (setq list
9828 (cons (substring string start)
9829 list)))
9830 (nreverse list)))
9832 (defun org-table-map-tables (function)
9833 "Apply FUNCTION to the start of all tables in the buffer."
9834 (save-excursion
9835 (save-restriction
9836 (widen)
9837 (goto-char (point-min))
9838 (while (re-search-forward org-table-any-line-regexp nil t)
9839 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9840 (beginning-of-line 1)
9841 (if (looking-at org-table-line-regexp)
9842 (save-excursion (funcall function)))
9843 (re-search-forward org-table-any-border-regexp nil 1))))
9844 (message "Mapping tables: done"))
9846 (defvar org-timecnt) ; dynamically scoped parameter
9848 (defun org-table-sum (&optional beg end nlast)
9849 "Sum numbers in region of current table column.
9850 The result will be displayed in the echo area, and will be available
9853 If there is an active region, it is interpreted as a rectangle and all
9854 numbers in that rectangle will be summed. If there is no active
9855 region and point is located in a table column, sum all numbers in that
9856 column.
9858 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9859 numbers are assumed to be times as well (in decimal hours) and the
9860 numbers are added as such.
9862 If NLAST is a number, only the NLAST fields will actually be summed."
9863 (interactive)
9864 (save-excursion
9865 (let (col (org-timecnt 0) diff h m s org-table-clip)
9866 (cond
9867 ((and beg end)) ; beg and end given explicitly
9868 ((org-region-active-p)
9869 (setq beg (region-beginning) end (region-end)))
9870 (t
9871 (setq col (org-table-current-column))
9872 (goto-char (org-table-begin))
9874 (error "No table data"))
9875 (org-table-goto-column col)
9876 (setq beg (point))
9877 (goto-char (org-table-end))
9879 (error "No table data"))
9880 (org-table-goto-column col)
9881 (setq end (point))))
9882 (let* ((items (apply 'append (org-table-copy-region beg end)))
9883 (items1 (cond ((not nlast) items)
9884 ((>= nlast (length items)) items)
9885 (t (setq items (reverse items))
9886 (setcdr (nthcdr (1- nlast) items) nil)
9887 (nreverse items))))
9888 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9889 items1)))
9890 (res (apply '+ numbers))
9891 (sres (if (= org-timecnt 0)
9892 (format "%g" res)
9893 (setq diff (* 3600 res)
9894 h (floor (/ diff 3600)) diff (mod diff 3600)
9895 m (floor (/ diff 60)) diff (mod diff 60)
9896 s diff)
9897 (format "%d:%02d:%02d" h m s))))
9898 (kill-new sres)
9899 (if (interactive-p)
9900 (message "%s"
9901 (substitute-command-keys
9903 (length numbers) sres))))
9904 sres))))
9906 (defun org-table-get-number-for-summing (s)
9907 (let (n)
9908 (if (string-match "^ *|? *" s)
9909 (setq s (replace-match "" nil nil s)))
9910 (if (string-match " *|? *$" s)
9911 (setq s (replace-match "" nil nil s)))
9912 (setq n (string-to-number s))
9913 (cond
9914 ((and (string-match "0" s)
9918 (let ((h (string-to-number (or (match-string 1 s) "0")))
9919 (m (string-to-number (or (match-string 2 s) "0")))
9920 (s (string-to-number (or (match-string 4 s) "0"))))
9921 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9922 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9923 ((equal n 0) nil)
9924 (t n))))
9926 (defun org-table-current-field-formula (&optional key noerror)
9927 "Return the formula active for the current field.
9928 Assumes that specials are in place.
9929 If KEY is given, return the key to this formula.
9931 (let* ((name (car (rassoc (list (org-current-line)
9932 (org-table-current-column))
9933 org-table-named-field-locations)))
9934 (col (org-table-current-column))
9935 (scol (int-to-string col))
9936 (ref (format "@%d$%d" (org-table-current-dline) col))
9937 (stored-list (org-table-get-stored-formulas noerror))
9938 (ass (or (assoc name stored-list)
9939 (assoc ref stored-list)
9940 (assoc scol stored-list))))
9941 (if key
9942 (car ass)
9943 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9944 (cdr ass))))))
9946 (defun org-table-get-formula (&optional equation named)
9947 "Read a formula from the minibuffer, offer stored formula as default.
9948 When NAMED is non-nil, look for a named equation."
9949 (let* ((stored-list (org-table-get-stored-formulas))
9950 (name (car (rassoc (list (org-current-line)
9951 (org-table-current-column))
9952 org-table-named-field-locations)))
9953 (ref (format "@%d$%d" (org-table-current-dline)
9954 (org-table-current-column)))
9955 (refass (assoc ref stored-list))
9956 (scol (if named
9957 (if name name ref)
9958 (int-to-string (org-table-current-column))))
9959 (dummy (and (or name refass) (not named)
9960 (not (y-or-n-p "Replace field formula with column formula? " ))
9961 (error "Abort")))
9962 (name (or name ref))
9963 (org-table-may-need-update nil)
9964 (stored (cdr (assoc scol stored-list)))
9965 (eq (cond
9966 ((and stored equation (string-match "^ *=? *$" equation))
9967 stored)
9968 ((stringp equation)
9969 equation)
9970 (t (org-table-formula-from-user
9971 (read-string
9972 (org-table-formula-to-user
9973 (format "%s formula %s%s="
9974 (if named "Field" "Column")
9975 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9976 scol))
9977 (if stored (org-table-formula-to-user stored) "")
9978 'org-table-formula-history
9979 )))))
9980 mustsave)
9982 ;; remove formula
9983 (setq stored-list (delq (assoc scol stored-list) stored-list))
9984 (org-table-store-formulas stored-list)
9985 (error "Formula removed"))
9986 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9987 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9988 (if (and name (not named))
9989 ;; We set the column equation, delete the named one.
9990 (setq stored-list (delq (assoc name stored-list) stored-list)
9991 mustsave t))
9992 (if stored
9993 (setcdr (assoc scol stored-list) eq)
9994 (setq stored-list (cons (cons scol eq) stored-list)))
9995 (if (or mustsave (not (equal stored eq)))
9996 (org-table-store-formulas stored-list))
9997 eq))
9999 (defun org-table-store-formulas (alist)
10000 "Store the list of formulas below the current table."
10001 (setq alist (sort alist 'org-table-formula-less-p))
10002 (save-excursion
10003 (goto-char (org-table-end))
10005 (progn
10006 ;; don't overwrite TBLFM, we might use text properties to store stuff
10007 (goto-char (match-beginning 2))
10008 (delete-region (match-beginning 2) (match-end 0)))
10009 (insert "#+TBLFM:"))
10010 (insert " "
10011 (mapconcat (lambda (x)
10012 (concat
10013 (if (equal (string-to-char (car x)) ?@) "" "$")
10014 (car x) "=" (cdr x)))
10015 alist "::")
10018 (defsubst org-table-formula-make-cmp-string (a)
10020 (concat
10021 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
10022 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
10023 (if (match-end 5) (concat "@@" (match-string 5 a))))))
10025 (defun org-table-formula-less-p (a b)
10026 "Compare two formulas for sorting."
10027 (let ((as (org-table-formula-make-cmp-string (car a)))
10028 (bs (org-table-formula-make-cmp-string (car b))))
10029 (and as bs (string< as bs))))
10031 (defun org-table-get-stored-formulas (&optional noerror)
10032 "Return an alist with the stored formulas directly after current table."
10033 (interactive)
10034 (let (scol eq eq-alist strings string seen)
10035 (save-excursion
10036 (goto-char (org-table-end))
10038 (setq strings (org-split-string (match-string 2) " *:: *"))
10039 (while (setq string (pop strings))
10040 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
10041 (setq scol (if (match-end 2)
10042 (match-string 2 string)
10043 (match-string 1 string))
10044 eq (match-string 3 string)
10045 eq-alist (cons (cons scol eq) eq-alist))
10046 (if (member scol seen)
10047 (if noerror
10048 (progn
10049 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
10050 (ding)
10051 (sit-for 2))
10052 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
10053 (push scol seen))))))
10054 (nreverse eq-alist)))
10056 (defun org-table-fix-formulas (key replace &optional limit delta remove)
10057 "Modify the equations after the table structure has been edited.
10059 For all numbers larger than LIMIT, shift them by DELTA."
10060 (save-excursion
10061 (goto-char (org-table-end))
10064 (re2
10065 (when remove
10066 (if (equal key "$")
10069 s n a)
10070 (when remove
10071 (while (re-search-forward re2 (point-at-eol) t)
10072 (replace-match "")))
10073 (while (re-search-forward re (point-at-eol) t)
10074 (setq s (match-string 1) n (string-to-number s))
10075 (cond
10076 ((setq a (assoc s replace))
10077 (replace-match (concat key (cdr a)) t t))
10078 ((and limit (> n limit))
10079 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
10081 (defun org-table-get-specials ()
10082 "Get the column names and local parameters for this table."
10083 (save-excursion
10084 (let ((beg (org-table-begin)) (end (org-table-end))
10085 names name fields fields1 field cnt
10086 c v l line col types dlines hlines)
10087 (setq org-table-column-names nil
10088 org-table-local-parameters nil
10089 org-table-named-field-locations nil
10090 org-table-current-begin-line nil
10091 org-table-current-begin-pos nil
10092 org-table-current-line-types nil)
10093 (goto-char beg)
10095 (setq names (org-split-string (match-string 1) " *| *")
10096 cnt 1)
10097 (while (setq name (pop names))
10098 (setq cnt (1+ cnt))
10099 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
10100 (push (cons name (int-to-string cnt)) org-table-column-names))))
10101 (setq org-table-column-names (nreverse org-table-column-names))
10102 (setq org-table-column-name-regexp
10104 (goto-char beg)
10106 (setq fields (org-split-string (match-string 1) " *| *"))
10107 (while (setq field (pop fields))
10109 (push (cons (match-string 1 field) (match-string 2 field))
10110 org-table-local-parameters))))
10111 (goto-char beg)
10113 (setq c (match-string 1)
10114 fields (org-split-string (match-string 2) " *| *"))
10115 (save-excursion
10116 (beginning-of-line (if (equal c "_") 2 0))
10117 (setq line (org-current-line) col 1)
10119 (setq fields1 (org-split-string (match-string 1) " *| *"))))
10120 (while (and fields1 (setq field (pop fields)))
10121 (setq v (pop fields1) col (1+ col))
10122 (when (and (stringp field) (stringp v)
10123 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
10124 (push (cons field v) org-table-local-parameters)
10125 (push (list field line col) org-table-named-field-locations))))
10126 ;; Analyse the line types
10127 (goto-char beg)
10128 (setq org-table-current-begin-line (org-current-line)
10129 org-table-current-begin-pos (point)
10130 l org-table-current-begin-line)
10132 (push (if (match-end 1) 'hline 'dline) types)
10133 (if (match-end 1) (push l hlines) (push l dlines))
10134 (beginning-of-line 2)
10135 (setq l (1+ l)))
10136 (setq org-table-current-line-types (apply 'vector (nreverse types))
10137 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
10138 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
10140 (defun org-table-maybe-eval-formula ()
10142 If yes, store the formula and apply it."
10143 ;; We already know we are in a table. Get field will only return a formula
10144 ;; when appropriate. It might return a separator line, but no problem.
10145 (when org-table-formula-evaluate-inline
10146 (let* ((field (org-trim (or (org-table-get-field) "")))
10147 named eq)
10149 (setq named (equal (string-to-char field) ?:)
10150 eq (match-string 1 field))
10151 (if (or (fboundp 'calc-eval)
10152 (equal (substring eq 0 (min 2 (length eq))) "'("))
10153 (org-table-eval-formula (if named '(4) nil)
10154 (org-table-formula-from-user eq))
10155 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
10157 (defvar org-recalc-commands nil
10158 "List of commands triggering the recalculation of a line.
10159 Will be filled automatically during use.")
10161 (defvar org-recalc-marks
10162 '((" " . "Unmarked: no special line, no automatic recalculation")
10163 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10164 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10165 ("!" . "Column name definition line. Reference in formula as $name.")
10166 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10167 ("_" . "Names for values in row below this one.")
10168 ("^" . "Names for values in row above this one.")))
10170 (defun org-table-rotate-recalc-marks (&optional newchar)
10171 "Rotate the recalculation mark in the first column.
10172 If in any row, the first field is not consistent with a mark,
10173 insert a new column for the markers.
10174 When there is an active region, change all the lines in the region,
10175 after prompting for the marking character.
10176 After each change, a message will be displayed indicating the meaning
10177 of the new mark."
10178 (interactive)
10179 (unless (org-at-table-p) (error "Not at a table"))
10180 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10181 (beg (org-table-begin))
10182 (end (org-table-end))
10183 (l (org-current-line))
10184 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10185 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10186 (have-col
10187 (save-excursion
10188 (goto-char beg)
10190 (col (org-table-current-column))
10191 (forcenew (car (assoc newchar org-recalc-marks)))
10192 epos new)
10193 (when l1
10194 (message "Change region to what mark? Type # * ! $ or SPC: ")
10195 (setq newchar (char-to-string (read-char-exclusive))
10196 forcenew (car (assoc newchar org-recalc-marks))))
10197 (if (and newchar (not forcenew))
10198 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10199 newchar))
10200 (if l1 (goto-line l1))
10201 (save-excursion
10202 (beginning-of-line 1)
10203 (unless (looking-at org-table-dataline-regexp)
10204 (error "Not at a table data line")))
10205 (unless have-col
10206 (org-table-goto-column 1)
10207 (org-table-insert-column)
10208 (org-table-goto-column (1+ col)))
10209 (setq epos (point-at-eol))
10210 (save-excursion
10211 (beginning-of-line 1)
10212 (org-table-get-field
10214 (concat " "
10215 (setq new (or forcenew
10216 (cadr (member (match-string 1) marks))))
10217 " ")
10218 " # ")))
10219 (if (and l1 l2)
10220 (progn
10221 (goto-line l1)
10222 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10223 (and (looking-at org-table-dataline-regexp)
10224 (org-table-get-field 1 (concat " " new " "))))
10225 (goto-line l1)))
10226 (if (not (= epos (point-at-eol))) (org-table-align))
10227 (goto-line l)
10228 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10230 (defun org-table-maybe-recalculate-line ()
10231 "Recompute the current line if marked for it, and if we haven't just done it."
10232 (interactive)
10233 (and org-table-allow-automatic-line-recalculation
10234 (not (and (memq last-command org-recalc-commands)
10235 (equal org-last-recalc-line (org-current-line))))
10236 (save-excursion (beginning-of-line 1)
10237 (looking-at org-table-auto-recalculate-regexp))
10238 (org-table-recalculate) t))
10240 (defvar org-table-formula-debug nil
10241 "Non-nil means, debug table formulas.
10243 (make-variable-buffer-local 'org-table-formula-debug)
10245 (defvar modes)
10246 (defsubst org-set-calc-mode (var &optional value)
10247 (if (stringp var)
10248 (setq var (assoc var '(("D" calc-angle-mode deg)
10249 ("R" calc-angle-mode rad)
10250 ("F" calc-prefer-frac t)
10251 ("S" calc-symbolic-mode t)))
10252 value (nth 2 var) var (nth 1 var)))
10253 (if (memq var modes)
10254 (setcar (cdr (memq var modes)) value)
10255 (cons var (cons value modes)))
10256 modes)
10258 (defun org-table-eval-formula (&optional arg equation
10259 suppress-align suppress-const
10260 suppress-store suppress-analysis)
10261 "Replace the table field value at the cursor by the result of a calculation.
10263 This function makes use of Dave Gillespie's Calc package, in my view the
10264 most exciting program ever written for GNU Emacs. So you need to have Calc
10265 installed in order to use this function.
10267 In a table, this command replaces the value in the current field with the
10269 formula, by storing it in a special line below the table. When called
10270 with a `C-u' prefix, the current field must ba a named field, and the
10271 formula is installed as valid in only this specific field.
10273 When called with two `C-u' prefixes, insert the active equation
10274 for the field back into the current field, so that it can be
10276 to check the referenced fields.
10278 When called, the command first prompts for a formula, which is read in
10279 the minibuffer. Previously entered formulas are available through the
10280 history list, and the last used formula is offered as a default.
10281 These stored formulas are adapted correctly when moving, inserting, or
10282 deleting columns with the corresponding commands.
10284 The formula can be any algebraic expression understood by the Calc package.
10285 For details, see the Org-mode manual.
10287 This function can also be called from Lisp programs and offers
10288 additional arguments: EQUATION can be the formula to apply. If this
10289 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10290 used to speed-up recursive calls by by-passing unnecessary aligns.
10291 SUPPRESS-CONST suppresses the interpretation of constants in the
10292 formula, assuming that this has been done already outside the function.
10293 SUPPRESS-STORE means the formula should not be stored, either because
10294 it is already stored, or because it is a modified equation that should
10295 not overwrite the stored one."
10296 (interactive "P")
10297 (org-table-check-inside-data-field)
10298 (or suppress-analysis (org-table-get-specials))
10299 (if (equal arg '(16))
10300 (let ((eq (org-table-current-field-formula)))
10301 (or eq (error "No equation active for current field"))
10302 (org-table-get-field nil eq)
10303 (org-table-align)
10304 (setq org-table-may-need-update t))
10305 (let* (fields
10306 (ndown (if (integerp arg) arg 1))
10307 (org-table-automatic-realign nil)
10308 (case-fold-search nil)
10309 (down (> ndown 1))
10310 (formula (if (and equation suppress-store)
10311 equation
10312 (org-table-get-formula equation (equal arg '(4)))))
10313 (n0 (org-table-current-column))
10314 (modes (copy-sequence org-calc-default-modes))
10315 (numbers nil) ; was a variable, now fixed default
10316 (keep-empty nil)
10317 n form form0 bw fmt x ev orig c lispp literal)
10318 ;; Parse the format string. Since we have a lot of modes, this is
10319 ;; a lot of work. However, I think calc still uses most of the time.
10320 (if (string-match ";" formula)
10321 (let ((tmp (org-split-string formula ";")))
10322 (setq formula (car tmp)
10323 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10324 (nth 1 tmp)))
10326 (setq c (string-to-char (match-string 1 fmt))
10327 n (string-to-number (match-string 2 fmt)))
10328 (if (= c ?p)
10329 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10330 (setq modes (org-set-calc-mode
10331 'calc-float-format
10332 (list (cdr (assoc c '((?n . float) (?f . fix)
10333 (?s . sci) (?e . eng))))
10334 n))))
10335 (setq fmt (replace-match "" t t fmt)))
10336 (if (string-match "[NT]" fmt)
10337 (setq numbers (equal (match-string 0 fmt) "N")
10338 fmt (replace-match "" t t fmt)))
10339 (if (string-match "L" fmt)
10340 (setq literal t
10341 fmt (replace-match "" t t fmt)))
10342 (if (string-match "E" fmt)
10343 (setq keep-empty t
10344 fmt (replace-match "" t t fmt)))
10345 (while (string-match "[DRFS]" fmt)
10346 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10347 (setq fmt (replace-match "" t t fmt)))
10349 (setq fmt nil))))
10350 (if (and (not suppress-const) org-table-formula-use-constants)
10351 (setq formula (org-table-formula-substitute-names formula)))
10352 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10353 (while (> ndown 0)
10354 (setq fields (org-split-string
10355 (org-no-properties
10356 (buffer-substring (point-at-bol) (point-at-eol)))
10357 " *| *"))
10358 (if (eq numbers t)
10359 (setq fields (mapcar
10360 (lambda (x) (number-to-string (string-to-number x)))
10361 fields)))
10362 (setq ndown (1- ndown))
10363 (setq form (copy-sequence formula)
10364 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10365 (if (and lispp literal) (setq lispp 'literal))
10366 ;; Check for old vertical references
10367 (setq form (org-rewrite-old-row-references form))
10368 ;; Insert complex ranges
10369 (while (string-match org-table-range-regexp form)
10370 (setq form
10371 (replace-match
10372 (save-match-data
10373 (org-table-make-reference
10374 (org-table-get-range (match-string 0 form) nil n0)
10375 keep-empty numbers lispp))
10376 t t form)))
10377 ;; Insert simple ranges
10379 (setq form
10380 (replace-match
10381 (save-match-data
10382 (org-table-make-reference
10383 (org-sublist
10384 fields (string-to-number (match-string 1 form))
10385 (string-to-number (match-string 2 form)))
10386 keep-empty numbers lispp))
10387 t t form)))
10388 (setq form0 form)
10389 ;; Insert the references to fields in same row
10391 (setq n (string-to-number (match-string 1 form))
10392 x (nth (1- (if (= n 0) n0 n)) fields))
10394 (match-string 0 form)))
10395 (setq form (replace-match
10396 (save-match-data
10397 (org-table-make-reference x nil numbers lispp))
10398 t t form)))
10400 (if lispp
10401 (setq ev (condition-case nil
10402 (eval (eval (read form)))
10403 (error "#ERROR"))
10404 ev (if (numberp ev) (number-to-string ev) ev))
10405 (or (fboundp 'calc-eval)
10406 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10407 (setq ev (calc-eval (cons form modes)
10408 (if numbers 'num))))
10410 (when org-table-formula-debug
10411 (with-output-to-temp-buffer "*Substitution History*"
10412 (princ (format "Substitution history of formula
10413 Orig: %s
10414 $xyz-> %s
10415 @r$c-> %s
10417 (if (listp ev)
10419 (make-string (car ev) ?\-) (nth 1 ev)))
10421 ev (or fmt "NONE")
10422 (if fmt (format fmt (string-to-number ev)) ev)))))
10423 (setq bw (get-buffer-window "*Substitution History*"))
10424 (shrink-window-if-larger-than-buffer bw)
10425 (unless (and (interactive-p) (not ndown))
10426 (unless (let (inhibit-redisplay)
10427 (y-or-n-p "Debugging Formula. Continue to next? "))
10428 (org-table-align)
10429 (error "Abort"))
10430 (delete-window bw)
10431 (message "")))
10432 (if (listp ev) (setq fmt nil ev "#ERROR"))
10433 (org-table-justify-field-maybe
10434 (if fmt (format fmt (string-to-number ev)) ev))
10436 (call-interactively 'org-return)
10437 (setq ndown 0)))
10438 (and down (org-table-maybe-recalculate-line))
10439 (or suppress-align (and org-table-may-need-update
10440 (org-table-align))))))
10442 (defun org-table-put-field-property (prop value)
10443 (save-excursion
10444 (put-text-property (progn (skip-chars-backward "^|") (point))
10445 (progn (skip-chars-forward "^|") (point))
10446 prop value)))
10448 (defun org-table-get-range (desc &optional tbeg col highlight)
10449 "Get a calc vector from a column, accorting to descriptor DESC.
10450 Optional arguments TBEG and COL can give the beginning of the table and
10451 the current column, to avoid unnecessary parsing.
10452 HIGHLIGHT means, just highlight the range."
10453 (if (not (equal (string-to-char desc) ?@))
10454 (setq desc (concat "@" desc)))
10455 (save-excursion
10456 (or tbeg (setq tbeg (org-table-begin)))
10457 (or col (setq col (org-table-current-column)))
10458 (let ((thisline (org-current-line))
10459 beg end c1 c2 r1 r2 rangep tmp)
10460 (unless (string-match org-table-range-regexp desc)
10461 (error "Invalid table range specifier `%s'" desc))
10462 (setq rangep (match-end 3)
10463 r1 (and (match-end 1) (match-string 1 desc))
10464 r2 (and (match-end 4) (match-string 4 desc))
10465 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10466 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10468 (and c1 (setq c1 (+ (string-to-number c1)
10469 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10470 (and c2 (setq c2 (+ (string-to-number c2)
10471 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10472 (if (equal r1 "") (setq r1 nil))
10473 (if (equal r2 "") (setq r2 nil))
10474 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10475 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10476 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10477 (if (not r1) (setq r1 thisline))
10478 (if (not r2) (setq r2 thisline))
10479 (if (not c1) (setq c1 col))
10480 (if (not c2) (setq c2 col))
10481 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10482 ;; just one field
10483 (progn
10484 (goto-line r1)
10485 (while (not (looking-at org-table-dataline-regexp))
10486 (beginning-of-line 2))
10487 (prog1 (org-trim (org-table-get-field c1))
10488 (if highlight (org-table-highlight-rectangle (point) (point)))))
10489 ;; A range, return a vector
10490 ;; First sort the numbers to get a regular ractangle
10491 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10492 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10493 (goto-line r1)
10494 (while (not (looking-at org-table-dataline-regexp))
10495 (beginning-of-line 2))
10496 (org-table-goto-column c1)
10497 (setq beg (point))
10498 (goto-line r2)
10499 (while (not (looking-at org-table-dataline-regexp))
10500 (beginning-of-line 0))
10501 (org-table-goto-column c2)
10502 (setq end (point))
10503 (if highlight
10504 (org-table-highlight-rectangle
10506 ;; return string representation of calc vector
10507 (mapcar 'org-trim
10508 (apply 'append (org-table-copy-region beg end)))))))
10510 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10511 "Analyze descriptor DESC and retrieve the corresponding line number.
10512 The cursor is currently in line CLINE, the table begins in line BLINE,
10513 and TABLE is a vector with line types."
10514 (if (string-match "^[0-9]+$" desc)
10515 (aref org-table-dlines (string-to-number desc))
10516 (setq cline (or cline (org-current-line))
10517 bline (or bline org-table-current-begin-line)
10518 table (or table org-table-current-line-types))
10519 (if (or
10521 ;; 1 2 3 4 5 6
10522 (and (not (match-end 3)) (not (match-end 6)))
10523 (and (match-end 3) (match-end 6) (not (match-end 5))))
10524 (error "invalid row descriptor `%s'" desc))
10525 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10526 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10527 (odir (and (match-end 5) (match-string 5 desc)))
10528 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10529 (i (- cline bline))
10530 (rel (and (match-end 6)
10531 (or (and (match-end 1) (not (match-end 3)))
10532 (match-end 5)))))
10533 (if (and hn (not hdir))
10534 (progn
10535 (setq i 0 hdir "+")
10536 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10537 (if (and (not hn) on (not odir))
10538 (error "should never happen");;(aref org-table-dlines on)
10539 (if (and hn (> hn 0))
10540 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10541 (if on
10542 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10543 (+ bline i)))))
10545 (defun org-find-row-type (table i type backwards relative n)
10546 (let ((l (length table)))
10547 (while (> n 0)
10548 (while (and (setq i (+ i (if backwards -1 1)))
10549 (>= i 0) (< i l)
10550 (not (eq (aref table i) type))
10551 (if (and relative (eq (aref table i) 'hline))
10552 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10553 t)))
10554 (setq n (1- n)))
10555 (if (or (< i 0) (>= i l))
10556 (error "Row descriptior leads outside table")
10557 i)))
10559 (defun org-rewrite-old-row-references (s)
10560 (if (string-match "&[-+0-9I]" s)
10561 (error "Formula contains old &row reference, please rewrite using @-syntax")
10562 s))
10564 (defun org-table-make-reference (elements keep-empty numbers lispp)
10565 "Convert list ELEMENTS to something appropriate to insert into formula.
10566 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10567 NUMBERS indicates that everything should be converted to numbers.
10568 LISPP means to return something appropriate for a Lisp list."
10569 (if (stringp elements) ; just a single val
10570 (if lispp
10571 (if (eq lispp 'literal)
10572 elements
10573 (prin1-to-string (if numbers (string-to-number elements) elements)))
10574 (if (equal elements "") (setq elements "0"))
10575 (if numbers (number-to-string (string-to-number elements)) elements))
10576 (unless keep-empty
10577 (setq elements
10578 (delq nil
10580 elements))))
10581 (setq elements (or elements '("0")))
10582 (if lispp
10583 (mapconcat
10584 (lambda (x)
10585 (if (eq lispp 'literal)
10586 x
10587 (prin1-to-string (if numbers (string-to-number x) x))))
10588 elements " ")
10589 (concat "[" (mapconcat
10590 (lambda (x)
10591 (if numbers (number-to-string (string-to-number x)) x))
10592 elements
10593 ",") "]"))))
10595 (defun org-table-recalculate (&optional all noalign)
10596 "Recalculate the current table line by applying all stored formulas.
10597 With prefix arg ALL, do this for all lines in the table."
10598 (interactive "P")
10599 (or (memq this-command org-recalc-commands)
10600 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10601 (unless (org-at-table-p) (error "Not at a table"))
10602 (if (equal all '(16))
10603 (org-table-iterate)
10604 (org-table-get-specials)
10605 (let* ((eqlist (sort (org-table-get-stored-formulas)
10606 (lambda (a b) (string< (car a) (car b)))))
10607 (inhibit-redisplay (not debug-on-error))
10608 (line-re org-table-dataline-regexp)
10609 (thisline (org-current-line))
10610 (thiscol (org-table-current-column))
10611 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10612 ;; Insert constants in all formulas
10613 (setq eqlist
10614 (mapcar (lambda (x)
10615 (setcdr x (org-table-formula-substitute-names (cdr x)))
10616 x)
10617 eqlist))
10618 ;; Split the equation list
10619 (while (setq eq (pop eqlist))
10620 (if (<= (string-to-char (car eq)) ?9)
10621 (push eq eqlnum)
10622 (push eq eqlname)))
10623 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10624 (if all
10625 (progn
10626 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10627 (goto-char (setq beg (org-table-begin)))
10628 (if (re-search-forward org-table-calculate-mark-regexp end t)
10629 ;; This is a table with marked lines, compute selected lines
10630 (setq line-re org-table-recalculate-regexp)
10631 ;; Move forward to the first non-header line
10632 (if (and (re-search-forward org-table-dataline-regexp end t)
10633 (re-search-forward org-table-hline-regexp end t)
10634 (re-search-forward org-table-dataline-regexp end t))
10635 (setq beg (match-beginning 0))
10636 nil))) ;; just leave beg where it is
10637 (setq beg (point-at-bol)
10638 end (move-marker (make-marker) (1+ (point-at-eol)))))
10639 (goto-char beg)
10640 (and all (message "Re-applying formulas to full table..."))
10642 ;; First find the named fields, and mark them untouchanble
10643 (remove-text-properties beg end '(org-untouchable t))
10644 (while (setq eq (pop eqlname))
10645 (setq name (car eq)
10646 a (assoc name org-table-named-field-locations))
10647 (and (not a)
10649 (setq a (list name
10650 (aref org-table-dlines
10651 (string-to-number (match-string 1 name)))
10652 (string-to-number (match-string 2 name)))))
10653 (when (and a (or all (equal (nth 1 a) thisline)))
10654 (message "Re-applying formula to field: %s" name)
10655 (goto-line (nth 1 a))
10656 (org-table-goto-column (nth 2 a))
10657 (push (append a (list (cdr eq))) eqlname1)
10658 (org-table-put-field-property :org-untouchable t)))
10660 ;; Now evauluate the column formulas, but skip fields covered by
10661 ;; field formulas
10662 (goto-char beg)
10663 (while (re-search-forward line-re end t)
10664 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10665 ;; Unprotected line, recalculate
10666 (and all (message "Re-applying formulas to full table...(line %d)"
10667 (setq cnt (1+ cnt))))
10668 (setq org-last-recalc-line (org-current-line))
10669 (setq eql eqlnum)
10670 (while (setq entry (pop eql))
10671 (goto-line org-last-recalc-line)
10672 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10673 (unless (get-text-property (point) :org-untouchable)
10674 (org-table-eval-formula nil (cdr entry)
10675 'noalign 'nocst 'nostore 'noanalysis)))))
10677 ;; Now evaluate the field formulas
10678 (while (setq eq (pop eqlname1))
10679 (message "Re-applying formula to field: %s" (car eq))
10680 (goto-line (nth 1 eq))
10681 (org-table-goto-column (nth 2 eq))
10682 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10683 'nostore 'noanalysis))
10685 (goto-line thisline)
10686 (org-table-goto-column thiscol)
10687 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10688 (or noalign (and org-table-may-need-update (org-table-align))
10689 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10691 ;; back to initial position
10692 (message "Re-applying formulas...done")
10693 (goto-line thisline)
10694 (org-table-goto-column thiscol)
10695 (or noalign (and org-table-may-need-update (org-table-align))
10696 (and all (message "Re-applying formulas...done"))))))
10698 (defun org-table-iterate (&optional arg)
10699 "Recalculate the table until it does not change anymore."
10700 (interactive "P")
10701 (let ((imax (if arg (prefix-numeric-value arg) 10))
10702 (i 0)
10703 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10704 thistbl)
10705 (catch 'exit
10706 (while (< i imax)
10707 (setq i (1+ i))
10708 (org-table-recalculate 'all)
10709 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10710 (if (not (string= lasttbl thistbl))
10711 (setq lasttbl thistbl)
10712 (if (> i 1)
10713 (message "Convergence after %d iterations" i)
10714 (message "Table was already stable"))
10715 (throw 'exit t)))
10716 (error "No convergence after %d iterations" i))))
10718 (defun org-table-formula-substitute-names (f)
10719 "Replace $const with values in string F."
10720 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10721 ;; First, check for column names
10722 (while (setq start (string-match org-table-column-name-regexp f start))
10723 (setq start (1+ start))
10724 (setq a (assoc (match-string 1 f) org-table-column-names))
10725 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10726 ;; Parameters and constants
10727 (setq start 0)
10729 (setq start (1+ start))
10730 (if (setq a (save-match-data
10731 (org-table-get-constant (match-string 1 f))))
10732 (setq f (replace-match
10733 (concat (if pp "(") a (if pp ")")) t t f))))
10734 (if org-table-formula-debug
10735 (put-text-property 0 (length f) :orig-formula f1 f))
10736 f))
10738 (defun org-table-get-constant (const)
10739 "Find the value for a parameter or constant in a formula.
10740 Parameters get priority."
10741 (or (cdr (assoc const org-table-local-parameters))
10742 (cdr (assoc const org-table-formula-constants-local))
10743 (cdr (assoc const org-table-formula-constants))
10744 (and (fboundp 'constants-get) (constants-get const))
10745 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10746 (org-entry-get nil (substring const 5) 'inherit))
10747 "#UNDEFINED_NAME"))
10749 (defvar org-table-fedit-map
10750 (let ((map (make-sparse-keymap)))
10751 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10752 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10753 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10754 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10755 (org-defkey map "\C-c?" 'org-table-show-reference)
10756 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10757 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10758 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10759 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10760 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10761 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10762 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10763 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10764 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10765 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10766 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10767 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10768 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10769 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10770 map))
10772 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10773 '("Edit-Formulas"
10774 ["Finish and Install" org-table-fedit-finish t]
10775 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10776 ["Abort" org-table-fedit-abort t]
10777 "--"
10778 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10779 ["Complete Lisp Symbol" lisp-complete-symbol t]
10780 "--"
10781 "Shift Reference at Point"
10782 ["Up" org-table-fedit-ref-up t]
10783 ["Down" org-table-fedit-ref-down t]
10784 ["Left" org-table-fedit-ref-left t]
10785 ["Right" org-table-fedit-ref-right t]
10786 "-"
10787 "Change Test Row for Column Formulas"
10788 ["Up" org-table-fedit-line-up t]
10789 ["Down" org-table-fedit-line-down t]
10790 "--"
10791 ["Scroll Table Window" org-table-fedit-scroll t]
10792 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10793 ["Show Table Grid" org-table-fedit-toggle-coordinates
10794 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10795 org-table-overlay-coordinates)]
10796 "--"
10797 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10798 :style toggle :selected org-table-buffer-is-an]))
10800 (defvar org-pos)
10802 (defun org-table-edit-formulas ()
10803 "Edit the formulas of the current table in a separate buffer."
10804 (interactive)
10806 (beginning-of-line 0))
10807 (unless (org-at-table-p) (error "Not at a table"))
10808 (org-table-get-specials)
10809 (let ((key (org-table-current-field-formula 'key 'noerror))
10810 (eql (sort (org-table-get-stored-formulas 'noerror)
10811 'org-table-formula-less-p))
10812 (pos (move-marker (make-marker) (point)))
10813 (startline 1)
10814 (wc (current-window-configuration))
10818 entry s type title)
10819 (org-switch-to-buffer-other-window "*Edit Formulas*")
10820 (erase-buffer)
10821 ;; Keep global-font-lock-mode from turning on font-lock-mode
10822 (let ((font-lock-global-modes '(not fundamental-mode)))
10823 (fundamental-mode))
10824 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10825 (org-set-local 'org-pos pos)
10826 (org-set-local 'org-window-configuration wc)
10827 (use-local-map org-table-fedit-map)
10828 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10829 (easy-menu-add org-table-fedit-menu)
10830 (setq startline (org-current-line))
10831 (while (setq entry (pop eql))
10832 (setq type (cond
10833 ((equal (string-to-char (car entry)) ?@) 'field)
10834 ((string-match "^[0-9]" (car entry)) 'column)
10835 (t 'named)))
10836 (when (setq title (assq type titles))
10838 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10839 (setq titles (delq title titles)))
10840 (if (equal key (car entry)) (setq startline (org-current-line)))
10841 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10843 (remove-text-properties 0 (length s) '(face nil) s)
10844 (insert s))
10845 (if (eq org-table-use-standard-references t)
10846 (org-table-fedit-toggle-ref-type))
10847 (goto-line startline)
10848 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10850 (defun org-table-fedit-post-command ()
10851 (when (not (memq this-command '(lisp-complete-symbol)))
10852 (let ((win (selected-window)))
10853 (save-excursion
10854 (condition-case nil
10855 (org-table-show-reference)
10856 (error nil))
10857 (select-window win)))))
10859 (defun org-table-formula-to-user (s)
10860 "Convert a formula from internal to user representation."
10861 (if (eq org-table-use-standard-references t)
10862 (org-table-convert-refs-to-an s)
10863 s))
10865 (defun org-table-formula-from-user (s)
10866 "Convert a formula from user to internal representation."
10867 (if org-table-use-standard-references
10868 (org-table-convert-refs-to-rc s)
10869 s))
10871 (defun org-table-convert-refs-to-rc (s)
10872 "Convert spreadsheet references from AB7 to @7$28.
10873 Works for single references, but also for entire formulas and even the
10874 full TBLFM line."
10875 (let ((start 0))
10877 (cond
10878 ((match-end 3)
10879 ;; format match, just advance
10880 (setq start (match-end 0)))
10881 ((and (> (match-beginning 0) 0)
10882 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10883 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10884 ;; 3.e5 or something like this.
10885 (setq start (match-end 0)))
10886 (t
10887 (setq start (match-beginning 0)
10888 s (replace-match
10889 (if (equal (match-string 2 s) "&")
10890 (format "$%d" (org-letters-to-number (match-string 1 s)))
10891 (format "@%d$%d"
10892 (string-to-number (match-string 2 s))
10893 (org-letters-to-number (match-string 1 s))))
10894 t t s)))))
10895 s))
10897 (defun org-table-convert-refs-to-an (s)
10898 "Convert spreadsheet references from to @7$28 to AB7.
10899 Works for single references, but also for entire formulas and even the
10900 full TBLFM line."
10902 (setq s (replace-match
10903 (format "%s%d"
10904 (org-number-to-letters
10905 (string-to-number (match-string 2 s)))
10906 (string-to-number (match-string 1 s)))
10907 t t s)))
10910 (org-number-to-letters
10911 (string-to-number (match-string 2 s))) "&")
10912 t nil s)))
10913 s)
10915 (defun org-letters-to-number (s)
10916 "Convert a base 26 number represented by letters into an integer.
10917 For example: AB -> 28."
10918 (let ((n 0))
10919 (setq s (upcase s))
10920 (while (> (length s) 0)
10921 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10922 s (substring s 1)))
10923 n))
10925 (defun org-number-to-letters (n)
10926 "Convert an integer into a base 26 number represented by letters.
10927 For example: 28 -> AB."
10928 (let ((s ""))
10929 (while (> n 0)
10930 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10931 n (/ (1- n) 26)))
10932 s))
10934 (defun org-table-fedit-convert-buffer (function)
10935 "Convert all references in this buffer, using FUNTION."
10936 (let ((line (org-current-line)))
10937 (goto-char (point-min))
10938 (while (not (eobp))
10939 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10940 (delete-region (point) (point-at-eol))
10941 (or (eobp) (forward-char 1)))
10942 (goto-line line)))
10944 (defun org-table-fedit-toggle-ref-type ()
10945 "Convert all references in the buffer from B3 to @3$2 and back."
10946 (interactive)
10947 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10948 (org-table-fedit-convert-buffer
10949 (if org-table-buffer-is-an
10950 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10951 (message "Reference type switched to %s"
10952 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10954 (defun org-table-fedit-ref-up ()
10955 "Shift the reference at point one row/hline up."
10956 (interactive)
10957 (org-table-fedit-shift-reference 'up))
10958 (defun org-table-fedit-ref-down ()
10959 "Shift the reference at point one row/hline down."
10960 (interactive)
10961 (org-table-fedit-shift-reference 'down))
10962 (defun org-table-fedit-ref-left ()
10963 "Shift the reference at point one field to the left."
10964 (interactive)
10965 (org-table-fedit-shift-reference 'left))
10966 (defun org-table-fedit-ref-right ()
10967 "Shift the reference at point one field to the right."
10968 (interactive)
10969 (org-table-fedit-shift-reference 'right))
10971 (defun org-table-fedit-shift-reference (dir)
10972 (cond
10974 (if (memq dir '(left right))
10975 (org-rematch-and-replace 1 (eq dir 'left))
10976 (error "Cannot shift reference in this direction")))
10978 ;; A B3-like reference
10979 (if (memq dir '(up down))
10980 (org-rematch-and-replace 2 (eq dir 'up))
10981 (org-rematch-and-replace 1 (eq dir 'left))))
10982 ((org-at-regexp-p
10984 ;; An internal reference
10985 (if (memq dir '(up down))
10986 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10987 (org-rematch-and-replace 5 (eq dir 'left))))))
10989 (defun org-rematch-and-replace (n &optional decr hline)
10990 "Re-match the group N, and replace it with the shifted refrence."
10991 (or (match-end n) (error "Cannot shift reference in this direction"))
10992 (goto-char (match-beginning n))
10993 (and (looking-at (regexp-quote (match-string n)))
10994 (replace-match (org-shift-refpart (match-string 0) decr hline)
10995 t t)))
10997 (defun org-shift-refpart (ref &optional decr hline)
10998 "Shift a refrence part REF.
10999 If DECR is set, decrease the references row/column, else increase.
11000 If HLINE is set, this may be a hline reference, it certainly is not
11001 a translation reference."
11002 (save-match-data
11003 (let* ((sign (string-match "^[-+]" ref)) n)
11005 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
11006 (cond
11007 ((and hline (string-match "^I+" ref))
11008 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
11009 (setq n (+ n (if decr -1 1)))
11010 (if (= n 0) (setq n (+ n (if decr -1 1))))
11011 (if sign
11012 (setq sign (if (< n 0) "-" "+") n (abs n))
11013 (setq n (max 1 n)))
11014 (concat sign (make-string n ?I)))
11016 ((string-match "^[0-9]+" ref)
11017 (setq n (string-to-number (concat sign ref)))
11018 (setq n (+ n (if decr -1 1)))
11019 (if sign
11020 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
11021 (number-to-string (max 1 n))))
11023 ((string-match "^[a-zA-Z]+" ref)
11024 (org-number-to-letters
11025 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
11027 (t (error "Cannot shift reference"))))))
11029 (defun org-table-fedit-toggle-coordinates ()
11030 "Toggle the display of coordinates in the refrenced table."
11031 (interactive)
11032 (let ((pos (marker-position org-pos)))
11033 (with-current-buffer (marker-buffer org-pos)
11034 (save-excursion
11035 (goto-char pos)
11036 (org-table-toggle-coordinate-overlays)))))
11038 (defun org-table-fedit-finish (&optional arg)
11039 "Parse the buffer for formula definitions and install them.
11040 With prefix ARG, apply the new formulas to the table."
11041 (interactive "P")
11042 (org-table-remove-rectangle-highlight)
11043 (if org-table-use-standard-references
11044 (progn
11045 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
11046 (setq org-table-buffer-is-an nil)))
11047 (let ((pos org-pos) eql var form)
11048 (goto-char (point-min))
11049 (while (re-search-forward
11051 nil t)
11052 (setq var (if (match-end 2) (match-string 2) (match-string 1))
11053 form (match-string 3))
11054 (setq form (org-trim form))
11055 (when (not (equal form ""))
11057 (setq form (replace-match " " t t form)))
11058 (when (assoc var eql)
11059 (error "Double formulas for %s" var))
11060 (push (cons var form) eql)))
11061 (setq org-pos nil)
11062 (set-window-configuration org-window-configuration)
11063 (select-window (get-buffer-window (marker-buffer pos)))
11064 (goto-char pos)
11065 (unless (org-at-table-p)
11066 (error "Lost table position - cannot install formulae"))
11067 (org-table-store-formulas eql)
11068 (move-marker pos nil)
11069 (kill-buffer "*Edit Formulas*")
11070 (if arg
11071 (org-table-recalculate 'all)
11072 (message "New formulas installed - press C-u C-c C-c to apply."))))
11074 (defun org-table-fedit-abort ()
11075 "Abort editing formulas, without installing the changes."
11076 (interactive)
11077 (org-table-remove-rectangle-highlight)
11078 (let ((pos org-pos))
11079 (set-window-configuration org-window-configuration)
11080 (select-window (get-buffer-window (marker-buffer pos)))
11081 (goto-char pos)
11082 (move-marker pos nil)
11083 (message "Formula editing aborted without installing changes")))
11085 (defun org-table-fedit-lisp-indent ()
11086 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
11087 (interactive)
11088 (let ((pos (point)) beg end ind)
11089 (beginning-of-line 1)
11090 (cond
11092 (goto-char pos)
11093 (call-interactively 'lisp-indent-line))
11095 ((not (fboundp 'pp-buffer))
11096 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
11097 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
11098 (goto-char (- (match-end 0) 2))
11099 (setq beg (point))
11100 (setq ind (make-string (current-column) ?\ ))
11101 (condition-case nil (forward-sexp 1)
11102 (error
11103 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
11104 (setq end (point))
11105 (save-restriction
11106 (narrow-to-region beg end)
11107 (if (eq last-command this-command)
11108 (progn
11109 (goto-char (point-min))
11110 (setq this-command nil)
11112 (replace-match " ")))
11113 (pp-buffer)
11114 (untabify (point-min) (point-max))
11115 (goto-char (1+ (point-min)))
11116 (while (re-search-forward "^." nil t)
11117 (beginning-of-line 1)
11118 (insert ind))
11119 (goto-char (point-max))
11120 (backward-delete-char 1)))
11121 (goto-char beg))
11122 (t nil))))
11124 (defvar org-show-positions nil)
11126 (defun org-table-show-reference (&optional local)
11127 "Show the location/value of the $ expression at point."
11128 (interactive)
11129 (org-table-remove-rectangle-highlight)
11130 (catch 'exit
11131 (let ((pos (if local (point) org-pos))
11132 (face2 'highlight)
11133 (org-inhibit-highlight-removal t)
11134 (win (selected-window))
11135 (org-show-positions nil)
11136 var name e what match dest)
11137 (if local (org-table-get-specials))
11138 (setq what (cond
11139 ((or (org-at-regexp-p org-table-range-regexp2)
11140 (org-at-regexp-p org-table-translate-regexp)
11141 (org-at-regexp-p org-table-range-regexp))
11142 (setq match
11143 (save-match-data
11144 (org-table-convert-refs-to-rc (match-string 0))))
11145 'range)
11148 ((not local) nil)
11149 (t (error "No reference at point")))
11150 match (and what (or match (match-string 0))))
11151 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
11152 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
11153 'secondary-selection))
11154 (org-add-hook 'before-change-functions
11155 'org-table-remove-rectangle-highlight)
11156 (if (eq what 'name) (setq var (substring match 1)))
11157 (when (eq what 'range)
11158 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
11159 (setq match (org-table-formula-substitute-names match)))
11160 (unless local
11161 (save-excursion
11162 (end-of-line 1)
11164 (beginning-of-line 1)
11166 (setq dest
11167 (save-match-data
11168 (org-table-convert-refs-to-rc (match-string 1))))
11169 (org-table-add-rectangle-overlay
11170 (match-beginning 1) (match-end 1) face2))))
11171 (if (and (markerp pos) (marker-buffer pos))
11172 (if (get-buffer-window (marker-buffer pos))
11173 (select-window (get-buffer-window (marker-buffer pos)))
11174 (org-switch-to-buffer-other-window (get-buffer-window
11175 (marker-buffer pos)))))
11176 (goto-char pos)
11177 (org-table-force-dataline)
11178 (when dest
11179 (setq name (substring dest 1))
11180 (cond
11182 (setq e (assoc name org-table-named-field-locations))
11183 (goto-line (nth 1 e))
11184 (org-table-goto-column (nth 2 e)))
11186 (let ((l (string-to-number (match-string 1 dest)))
11187 (c (string-to-number (match-string 2 dest))))
11188 (goto-line (aref org-table-dlines l))
11189 (org-table-goto-column c)))
11190 (t (org-table-goto-column (string-to-number name))))
11191 (move-marker pos (point))
11192 (org-table-highlight-rectangle nil nil face2))
11193 (cond
11194 ((equal dest match))
11195 ((not match))
11196 ((eq what 'range)
11197 (condition-case nil
11198 (save-excursion
11199 (org-table-get-range match nil nil 'highlight))
11200 (error nil)))
11201 ((setq e (assoc var org-table-named-field-locations))
11202 (goto-line (nth 1 e))
11203 (org-table-goto-column (nth 2 e))
11204 (org-table-highlight-rectangle (point) (point))
11205 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11206 ((setq e (assoc var org-table-column-names))
11207 (org-table-goto-column (string-to-number (cdr e)))
11208 (org-table-highlight-rectangle (point) (point))
11209 (goto-char (org-table-begin))
11211 (org-table-end) t)
11212 (progn
11213 (goto-char (match-beginning 1))
11214 (org-table-highlight-rectangle)
11215 (message "Named column (column %s)" (cdr e)))
11216 (error "Column name not found")))
11217 ((eq what 'column)
11218 ;; column number
11219 (org-table-goto-column (string-to-number (substring match 1)))
11220 (org-table-highlight-rectangle (point) (point))
11221 (message "Column %s" (substring match 1)))
11222 ((setq e (assoc var org-table-local-parameters))
11223 (goto-char (org-table-begin))
11225 (progn
11226 (goto-char (match-beginning 1))
11227 (org-table-highlight-rectangle)
11228 (message "Local parameter."))
11229 (error "Parameter not found")))
11230 (t
11231 (cond
11232 ((not var) (error "No reference at point"))
11233 ((setq e (assoc var org-table-formula-constants-local))
11234 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11235 var (cdr e)))
11236 ((setq e (assoc var org-table-formula-constants))
11237 (message "Constant: $%s=%s in `org-table-formula-constants'."
11238 var (cdr e)))
11239 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11240 (message "Constant: $%s=%s, from `constants.el'%s."
11241 var e (format " (%s units)" constants-unit-system)))
11242 (t (error "Undefined name $%s" var)))))
11243 (goto-char pos)
11244 (when (and org-show-positions
11245 (not (memq this-command '(org-table-fedit-scroll
11246 org-table-fedit-scroll-down))))
11247 (push pos org-show-positions)
11248 (push org-table-current-begin-pos org-show-positions)
11249 (let ((min (apply 'min org-show-positions))
11250 (max (apply 'max org-show-positions)))
11251 (goto-char min) (recenter 0)
11252 (goto-char max)
11253 (or (pos-visible-in-window-p max) (recenter -1))))
11254 (select-window win))))
11256 (defun org-table-force-dataline ()
11257 "Make sure the cursor is in a dataline in a table."
11258 (unless (save-excursion
11259 (beginning-of-line 1)
11260 (looking-at org-table-dataline-regexp))
11261 (let* ((re org-table-dataline-regexp)
11262 (p1 (save-excursion (re-search-forward re nil 'move)))
11263 (p2 (save-excursion (re-search-backward re nil 'move))))
11264 (cond ((and p1 p2)
11265 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11266 p1 p2)))
11267 ((or p1 p2) (goto-char (or p1 p2)))
11268 (t (error "No table dataline around here"))))))
11270 (defun org-table-fedit-line-up ()
11271 "Move cursor one line up in the window showing the table."
11272 (interactive)
11273 (org-table-fedit-move 'previous-line))
11275 (defun org-table-fedit-line-down ()
11276 "Move cursor one line down in the window showing the table."
11277 (interactive)
11278 (org-table-fedit-move 'next-line))
11280 (defun org-table-fedit-move (command)
11281 "Move the cursor in the window shoinw the table.
11282 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11283 (let ((org-table-allow-automatic-line-recalculation nil)
11284 (pos org-pos) (win (selected-window)) p)
11285 (select-window (get-buffer-window (marker-buffer org-pos)))
11286 (setq p (point))
11287 (call-interactively command)
11288 (while (and (org-at-table-p)
11289 (org-at-table-hline-p))
11290 (call-interactively command))
11291 (or (org-at-table-p) (goto-char p))
11292 (move-marker pos (point))
11293 (select-window win)))
11295 (defun org-table-fedit-scroll (N)
11296 (interactive "p")
11297 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11298 (scroll-other-window N)))
11300 (defun org-table-fedit-scroll-down (N)
11301 (interactive "p")
11302 (org-table-fedit-scroll (- N)))
11304 (defvar org-table-rectangle-overlays nil)
11306 (defun org-table-add-rectangle-overlay (beg end &optional face)
11307 "Add a new overlay."
11308 (let ((ov (org-make-overlay beg end)))
11309 (org-overlay-put ov 'face (or face 'secondary-selection))
11310 (push ov org-table-rectangle-overlays)))
11312 (defun org-table-highlight-rectangle (&optional beg end face)
11313 "Highlight rectangular region in a table."
11314 (setq beg (or beg (point)) end (or end (point)))
11315 (let ((b (min beg end))
11316 (e (max beg end))
11317 l1 c1 l2 c2 tmp)
11318 (and (boundp 'org-show-positions)
11319 (setq org-show-positions (cons b (cons e org-show-positions))))
11320 (goto-char (min beg end))
11321 (setq l1 (org-current-line)
11322 c1 (org-table-current-column))
11323 (goto-char (max beg end))
11324 (setq l2 (org-current-line)
11325 c2 (org-table-current-column))
11326 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11327 (goto-line l1)
11328 (beginning-of-line 1)
11329 (loop for line from l1 to l2 do
11330 (when (looking-at org-table-dataline-regexp)
11331 (org-table-goto-column c1)
11333 (org-table-goto-column c2)
11335 (org-table-add-rectangle-overlay beg end face))
11336 (beginning-of-line 2))
11337 (goto-char b))
11338 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11340 (defun org-table-remove-rectangle-highlight (&rest ignore)
11341 "Remove the rectangle overlays."
11342 (unless org-inhibit-highlight-removal
11343 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11344 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11345 (setq org-table-rectangle-overlays nil)))
11347 (defvar org-table-coordinate-overlays nil
11348 "Collects the cooordinate grid overlays, so that they can be removed.")
11349 (make-variable-buffer-local 'org-table-coordinate-overlays)
11351 (defun org-table-overlay-coordinates ()
11352 "Add overlays to the table at point, to show row/column coordinates."
11353 (interactive)
11354 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11355 (setq org-table-coordinate-overlays nil)
11356 (save-excursion
11357 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11358 (goto-char (org-table-begin))
11359 (while (org-at-table-p)
11360 (setq eol (point-at-eol))
11361 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11362 (push ov org-table-coordinate-overlays)
11363 (setq hline (looking-at org-table-hline-regexp))
11364 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11365 (format "%4d" (setq id (1+ id)))))
11366 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11367 (when hline
11368 (setq ic 0)
11370 (setq beg (1+ (match-beginning 0))
11371 ic (1+ ic)
11372 s1 (concat "$" (int-to-string ic))
11373 s2 (org-number-to-letters ic)
11374 str (if (eq org-table-use-standard-references t) s2 s1))
11375 (setq ov (org-make-overlay beg (+ beg (length str))))
11376 (push ov org-table-coordinate-overlays)
11377 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11378 (beginning-of-line 2)))))
11380 (defun org-table-toggle-coordinate-overlays ()
11381 "Toggle the display of Row/Column numbers in tables."
11382 (interactive)
11383 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11384 (message "Row/Column number display turned %s"
11385 (if org-table-overlay-coordinates "on" "off"))
11386 (if (and (org-at-table-p) org-table-overlay-coordinates)
11387 (org-table-align))
11388 (unless org-table-overlay-coordinates
11389 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11390 (setq org-table-coordinate-overlays nil)))
11392 (defun org-table-toggle-formula-debugger ()
11393 "Toggle the formula debugger in tables."
11394 (interactive)
11395 (setq org-table-formula-debug (not org-table-formula-debug))
11396 (message "Formula debugging has been turned %s"
11397 (if org-table-formula-debug "on" "off")))
11399 ;;; The orgtbl minor mode
11401 ;; Define a minor mode which can be used in other modes in order to
11402 ;; integrate the org-mode table editor.
11404 ;; This is really a hack, because the org-mode table editor uses several
11405 ;; keys which normally belong to the major mode, for example the TAB and
11406 ;; RET keys. Here is how it works: The minor mode defines all the keys
11407 ;; necessary to operate the table editor, but wraps the commands into a
11408 ;; function which tests if the cursor is currently inside a table. If that
11409 ;; is the case, the table editor command is executed. However, when any of
11410 ;; those keys is used outside a table, the function uses `key-binding' to
11411 ;; look up if the key has an associated command in another currently active
11412 ;; keymap (minor modes, major mode, global), and executes that command.
11413 ;; There might be problems if any of the keys used by the table editor is
11414 ;; otherwise used as a prefix key.
11416 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11417 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11418 ;; addresses this by checking explicitly for both bindings.
11420 ;; The optimized version (see variable `orgtbl-optimized') takes over
11421 ;; all keys which are bound to `self-insert-command' in the *global map*.
11422 ;; Some modes bind other commands to simple characters, for example
11423 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11424 ;; active, this binding is ignored inside tables and replaced with a
11425 ;; modified self-insert.
11427 (defvar orgtbl-mode nil
11428 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11429 table editor in arbitrary modes.")
11430 (make-variable-buffer-local 'orgtbl-mode)
11432 (defvar orgtbl-mode-map (make-keymap)
11433 "Keymap for `orgtbl-mode'.")
11435 ;;;###autoload
11436 (defun turn-on-orgtbl ()
11437 "Unconditionally turn on `orgtbl-mode'."
11438 (orgtbl-mode 1))
11440 (defvar org-old-auto-fill-inhibit-regexp nil
11441 "Local variable used by `orgtbl-mode'")
11444 "Matches a line belonging to an orgtbl.")
11446 (defconst orgtbl-extra-font-lock-keywords
11447 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11448 0 (quote 'org-table) 'prepend))
11449 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11451 ;;;###autoload
11452 (defun orgtbl-mode (&optional arg)
11453 "The `org-mode' table editor as a minor mode for use in other modes."
11454 (interactive)
11455 (if (org-mode-p)
11456 ;; Exit without error, in case some hook functions calls this
11457 ;; by accident in org-mode.
11458 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11459 (setq orgtbl-mode
11460 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11461 (if orgtbl-mode
11462 (progn
11463 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11464 ;; Make sure we are first in minor-mode-map-alist
11465 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11466 (and c (setq minor-mode-map-alist
11467 (cons c (delq c minor-mode-map-alist)))))
11468 (org-set-local (quote org-table-may-need-update) t)
11469 (org-add-hook 'before-change-functions 'org-before-change-function
11470 nil 'local)
11471 (org-set-local 'org-old-auto-fill-inhibit-regexp
11472 auto-fill-inhibit-regexp)
11473 (org-set-local 'auto-fill-inhibit-regexp
11474 (if auto-fill-inhibit-regexp
11476 auto-fill-inhibit-regexp)
11477 orgtbl-line-start-regexp))
11478 (org-add-to-invisibility-spec '(org-cwidth))
11479 (when (fboundp 'font-lock-add-keywords)
11480 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11481 (org-restart-font-lock))
11482 (easy-menu-add orgtbl-mode-menu)
11483 (run-hooks 'orgtbl-mode-hook))
11484 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11485 (org-cleanup-narrow-column-properties)
11486 (org-remove-from-invisibility-spec '(org-cwidth))
11487 (remove-hook 'before-change-functions 'org-before-change-function t)
11488 (when (fboundp 'font-lock-remove-keywords)
11489 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11490 (org-restart-font-lock))
11491 (easy-menu-remove orgtbl-mode-menu)
11492 (force-mode-line-update 'all))))
11494 (defun org-cleanup-narrow-column-properties ()
11495 "Remove all properties related to narrow-column invisibility."
11496 (let ((s 1))
11497 (while (setq s (text-property-any s (point-max)
11498 'display org-narrow-column-arrow))
11499 (remove-text-properties s (1+ s) '(display t)))
11500 (setq s 1)
11501 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11502 (remove-text-properties s (1+ s) '(org-cwidth t)))
11503 (setq s 1)
11504 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11505 (remove-text-properties s (1+ s) '(invisible t)))))
11507 ;; Install it as a minor mode.
11508 (put 'orgtbl-mode :included t)
11509 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11510 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11512 (defun orgtbl-make-binding (fun n &rest keys)
11513 "Create a function for binding in the table minor mode.
11514 FUN is the command to call inside a table. N is used to create a unique
11515 command name. KEYS are keys that should be checked in for a command
11516 to execute outside of tables."
11517 (eval
11518 (list 'defun
11519 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11520 '(arg)
11522 "Outside of tables, run the binding of `"
11523 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11524 "'.")
11525 '(interactive "p")
11526 (list 'if
11527 '(org-at-table-p)
11528 (list 'call-interactively (list 'quote fun))
11529 (list 'let '(orgtbl-mode)
11530 (list 'call-interactively
11531 (append '(or)
11532 (mapcar (lambda (k)
11533 (list 'key-binding k))
11534 keys)
11535 '('orgtbl-error))))))))
11537 (defun orgtbl-error ()
11538 "Error when there is no default binding for a table key."
11539 (interactive)
11540 (error "This key has no function outside tables"))
11542 (defun orgtbl-setup ()
11543 "Setup orgtbl keymaps."
11544 (let ((nfunc 0)
11545 (bindings
11546 (list
11547 '([(meta shift left)] org-table-delete-column)
11548 '([(meta left)] org-table-move-column-left)
11549 '([(meta right)] org-table-move-column-right)
11550 '([(meta shift right)] org-table-insert-column)
11551 '([(meta shift up)] org-table-kill-row)
11552 '([(meta shift down)] org-table-insert-row)
11553 '([(meta up)] org-table-move-row-up)
11554 '([(meta down)] org-table-move-row-down)
11555 '("\C-c\C-w" org-table-cut-region)
11556 '("\C-c\M-w" org-table-copy-region)
11557 '("\C-c\C-y" org-table-paste-rectangle)
11558 '("\C-c-" org-table-insert-hline)
11559 '("\C-c}" org-table-toggle-coordinate-overlays)
11560 '("\C-c{" org-table-toggle-formula-debugger)
11561 '("\C-m" org-table-next-row)
11562 '([(shift return)] org-table-copy-down)
11563 '("\C-c\C-q" org-table-wrap-region)
11564 '("\C-c?" org-table-field-info)
11565 '("\C-c " org-table-blank-field)
11566 '("\C-c+" org-table-sum)
11567 '("\C-c=" org-table-eval-formula)
11568 '("\C-c'" org-table-edit-formulas)
11569 '("\C-c`" org-table-edit-field)
11570 '("\C-c*" org-table-recalculate)
11571 '("\C-c|" org-table-create-or-convert-from-region)
11572 '("\C-c^" org-table-sort-lines)
11573 '([(control ?#)] org-table-rotate-recalc-marks)))
11574 elt key fun cmd)
11575 (while (setq elt (pop bindings))
11576 (setq nfunc (1+ nfunc))
11577 (setq key (org-key (car elt))
11578 fun (nth 1 elt)
11579 cmd (orgtbl-make-binding fun nfunc key))
11580 (org-defkey orgtbl-mode-map key cmd))
11582 ;; Special treatment needed for TAB and RET
11583 (org-defkey orgtbl-mode-map [(return)]
11584 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11585 (org-defkey orgtbl-mode-map "\C-m"
11586 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11588 (org-defkey orgtbl-mode-map [(tab)]
11589 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11590 (org-defkey orgtbl-mode-map "\C-i"
11591 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11593 (org-defkey orgtbl-mode-map [(shift tab)]
11594 (orgtbl-make-binding 'org-table-previous-field 104
11595 [(shift tab)] [(tab)] "\C-i"))
11597 (org-defkey orgtbl-mode-map "\M-\C-m"
11598 (orgtbl-make-binding 'org-table-wrap-region 105
11599 "\M-\C-m" [(meta return)]))
11600 (org-defkey orgtbl-mode-map [(meta return)]
11601 (orgtbl-make-binding 'org-table-wrap-region 106
11602 [(meta return)] "\M-\C-m"))
11604 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11605 (when orgtbl-optimized
11606 ;; If the user wants maximum table support, we need to hijack
11607 ;; some standard editing functions
11608 (org-remap orgtbl-mode-map
11609 'self-insert-command 'orgtbl-self-insert-command
11610 'delete-char 'org-delete-char
11611 'delete-backward-char 'org-delete-backward-char)
11612 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11613 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11614 '("OrgTbl"
11615 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11616 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11617 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11618 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11619 "--"
11620 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11621 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11622 ["Copy Field from Above"
11623 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11624 "--"
11625 ("Column"
11626 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11627 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11628 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11629 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11630 ("Row"
11631 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11632 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11633 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11634 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11635 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
11636 "--"
11637 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11638 ("Rectangle"
11639 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11640 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11641 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11642 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11643 "--"
11644 ("Radio tables"
11645 ["Insert table template" orgtbl-insert-radio-table
11646 (assq major-mode orgtbl-radio-table-templates)]
11647 ["Comment/uncomment table" orgtbl-toggle-comment t])
11648 "--"
11649 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11650 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11651 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11652 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11653 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11654 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11655 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11656 ["Sum Column/Rectangle" org-table-sum
11657 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11658 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11659 ["Debug Formulas"
11660 org-table-toggle-formula-debugger :active (org-at-table-p)
11661 :keys "C-c {"
11662 :style toggle :selected org-table-formula-debug]
11663 ["Show Col/Row Numbers"
11664 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11665 :keys "C-c }"
11666 :style toggle :selected org-table-overlay-coordinates]
11667 ))
11668 t))
11670 (defun orgtbl-ctrl-c-ctrl-c (arg)
11671 "If the cursor is inside a table, realign the table.
11672 It it is a table to be sent away to a receiver, do it.
11673 With prefix arg, also recompute table."
11674 (interactive "P")
11675 (let ((pos (point)) action)
11676 (save-excursion
11677 (beginning-of-line 1)
11681 (cond
11682 ((integerp action)
11683 (goto-char action)
11684 (org-table-maybe-eval-formula)
11685 (if arg
11686 (call-interactively 'org-table-recalculate)
11687 (org-table-maybe-recalculate-line))
11688 (call-interactively 'org-table-align)
11689 (orgtbl-send-table 'maybe))
11690 ((eq action 'recalc)
11691 (save-excursion
11692 (beginning-of-line 1)
11694 (if (org-at-table-p)
11695 (org-call-with-arg 'org-table-recalculate t))))
11696 (t (let (orgtbl-mode)
11697 (call-interactively (key-binding "\C-c\C-c")))))))
11699 (defun orgtbl-tab (arg)
11700 "Justification and field motion for `orgtbl-mode'."
11701 (interactive "P")
11702 (if arg (org-table-edit-field t)
11703 (org-table-justify-field-maybe)
11704 (org-table-next-field)))
11706 (defun orgtbl-ret ()
11707 "Justification and field motion for `orgtbl-mode'."
11708 (interactive)
11709 (org-table-justify-field-maybe)
11710 (org-table-next-row))
11712 (defun orgtbl-self-insert-command (N)
11713 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11714 If the cursor is in a table looking at whitespace, the whitespace is
11715 overwritten, and the table is not marked as requiring realignment."
11716 (interactive "p")
11717 (if (and (org-at-table-p)
11718 (or
11719 (and org-table-auto-blank-field
11720 (member last-command
11721 '(orgtbl-hijacker-command-100
11722 orgtbl-hijacker-command-101
11723 orgtbl-hijacker-command-102
11724 orgtbl-hijacker-command-103
11725 orgtbl-hijacker-command-104
11726 orgtbl-hijacker-command-105))
11727 (org-table-blank-field))
11728 t)
11729 (eq N 1)
11731 (let (org-table-may-need-update)
11732 (goto-char (1- (match-end 0)))
11733 (delete-backward-char 1)
11734 (goto-char (match-beginning 0))
11735 (self-insert-command N))
11736 (setq org-table-may-need-update t)
11737 (let (orgtbl-mode)
11738 (call-interactively (key-binding (vector last-input-event))))))
11740 (defun org-force-self-insert (N)
11741 "Needed to enforce self-insert under remapping."
11742 (interactive "p")
11743 (self-insert-command N))
11746 "Regula expression matching exponentials as produced by calc.")
11748 (defvar org-table-clean-did-remove-column nil)
11750 (defun orgtbl-export (table target)
11751 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11753 org-table-last-alignment org-table-last-column-widths
11754 maxcol column)
11755 (if (not (fboundp func))
11756 (error "Cannot export orgtbl table to %s" target))
11757 (setq lines (org-table-clean-before-export lines))
11758 (setq table
11759 (mapcar
11760 (lambda (x)
11761 (if (string-match org-table-hline-regexp x)
11762 'hline
11764 lines))
11765 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11766 table)))
11767 (loop for i from (1- maxcol) downto 0 do
11768 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11769 (setq column (delq nil column))
11770 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11771 (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))
11772 (funcall func table nil)))
11774 (defun orgtbl-send-table (&optional maybe)
11775 "Send a tranformed version of this table to the receiver position.
11776 With argument MAYBE, fail quietly if no transformation is defined for
11777 this table."
11778 (interactive)
11779 (catch 'exit
11780 (unless (org-at-table-p) (error "Not at a table"))
11781 ;; when non-interactive, we assume align has just happened.
11782 (when (interactive-p) (org-table-align))
11783 (save-excursion
11784 (goto-char (org-table-begin))
11785 (beginning-of-line 0)
11787 (if maybe
11788 (throw 'exit nil)
11789 (error "Don't know how to transform this table."))))
11790 (let* ((name (match-string 1))
11791 beg
11792 (transform (intern (match-string 2)))
11793 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11794 (skip (plist-get params :skip))
11795 (skipcols (plist-get params :skipcols))
11796 (txt (buffer-substring-no-properties
11797 (org-table-begin) (org-table-end)))
11799 (lines (org-table-clean-before-export lines))
11800 (i0 (if org-table-clean-did-remove-column 2 1))
11801 (table (mapcar
11802 (lambda (x)
11803 (if (string-match org-table-hline-regexp x)
11804 'hline
11805 (org-remove-by-index
11807 skipcols i0)))
11808 lines))
11809 (fun (if (= i0 2) 'cdr 'identity))
11810 (org-table-last-alignment
11811 (org-remove-by-index (funcall fun org-table-last-alignment)
11812 skipcols i0))
11813 (org-table-last-column-widths
11814 (org-remove-by-index (funcall fun org-table-last-column-widths)
11815 skipcols i0)))
11817 (unless (fboundp transform)
11818 (error "No such transformation function %s" transform))
11819 (setq txt (funcall transform table params))
11820 ;; Find the insertion place
11821 (save-excursion
11822 (goto-char (point-min))
11823 (unless (re-search-forward
11825 (error "Don't know where to insert translated table"))
11826 (goto-char (match-beginning 0))
11827 (beginning-of-line 2)
11828 (setq beg (point))
11829 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11830 (error "Cannot find end of insertion region"))
11831 (beginning-of-line 1)
11832 (delete-region beg (point))
11833 (goto-char beg)
11835 (message "Table converted and installed at receiver location"))))
11837 (defun org-remove-by-index (list indices &optional i0)
11838 "Remove the elements in LIST with indices in INDICES.
11839 First element has index 0, or I0 if given."
11840 (if (not indices)
11841 list
11842 (if (integerp indices) (setq indices (list indices)))
11843 (setq i0 (1- (or i0 0)))
11844 (delq :rm (mapcar (lambda (x)
11845 (setq i0 (1+ i0))
11846 (if (memq i0 indices) :rm x))
11847 list))))
11849 (defun orgtbl-toggle-comment ()
11850 "Comment or uncomment the orgtbl at point."
11851 (interactive)
11852 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11853 (re2 (concat "^" orgtbl-line-start-regexp))
11854 (commented (save-excursion (beginning-of-line 1)
11855 (cond ((looking-at re1) t)
11856 ((looking-at re2) nil)
11857 (t (error "Not at an org table")))))
11858 (re (if commented re1 re2))
11859 beg end)
11860 (save-excursion
11861 (beginning-of-line 1)
11862 (while (looking-at re) (beginning-of-line 0))
11863 (beginning-of-line 2)
11864 (setq beg (point))
11865 (while (looking-at re) (beginning-of-line 2))
11866 (setq end (point)))
11867 (comment-region beg end (if commented '(4) nil))))
11869 (defun orgtbl-insert-radio-table ()
11870 "Insert a radio table template appropriate for this major mode."
11871 (interactive)
11872 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11873 (txt (nth 1 e))
11874 name pos)
11875 (unless e (error "No radio table setup defined for %s" major-mode))
11876 (setq name (read-string "Table name: "))
11877 (while (string-match "%n" txt)
11878 (setq txt (replace-match name t t txt)))
11880 (setq pos (point))
11881 (insert txt)
11882 (goto-char pos)))
11884 (defun org-get-param (params header i sym &optional hsym)
11885 "Get parameter value for symbol SYM.
11886 If this is a header line, actually get the value for the symbol with an
11888 If the value is a protperty list, get the element for the current column.
11889 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11890 (let ((val (plist-get params sym)))
11891 (and hsym header (setq val (or (plist-get params hsym) val)))
11892 (if (consp val) (plist-get val i) val)))
11894 (defun orgtbl-to-generic (table params)
11895 "Convert the orgtbl-mode TABLE to some other format.
11896 This generic routine can be used for many standard cases.
11897 TABLE is a list, each entry either the symbol `hline' for a horizontal
11898 separator line, or a list of fields for that line.
11899 PARAMS is a property list of parameters that can influence the conversion.
11900 For the generic converter, some parameters are obligatory: You need to
11901 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11902 :splice, you must have :tstart and :tend.
11904 Valid parameters are
11906 :tstart String to start the table. Ignored when :splice is t.
11907 :tend String to end the table. Ignored when :splice is t.
11909 :splice When set to t, return only table body lines, don't wrap
11910 them into :tstart and :tend. Default is nil.
11912 :hline String to be inserted on horizontal separation lines.
11913 May be nil to ignore hlines.
11915 :lstart String to start a new table line.
11916 :lend String to end a table line
11917 :sep Separator between two fields
11918 :lfmt Format for entire line, with enough %s to capture all fields.
11919 If this is present, :lstart, :lend, and :sep are ignored.
11920 :fmt A format to be used to wrap the field, should contain
11921 %s for the original field value. For example, to wrap
11923 This may also be a property list with column numbers and
11926 :hlstart :hlend :hlsep :hlfmt :hfmt
11927 Same as above, specific for the header lines in the table.
11928 All lines before the first hline are treated as header.
11929 If any of these is not present, the data line value is used.
11931 :efmt Use this format to print numbers with exponentials.
11932 The format should have %s twice for inserting mantissa
11934 may also be a property list with column numbers and
11935 formats. :fmt will still be applied after :efmt.
11937 In addition to this, the parameters :skip and :skipcols are always handled
11938 directly by `orgtbl-send-table'. See manual."
11939 (interactive)
11940 (let* ((p params)
11941 (splicep (plist-get p :splice))
11942 (hline (plist-get p :hline))
11943 rtn line i fm efm lfmt h)
11945 ;; Do we have a header?
11946 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11947 (setq h t))
11949 ;; Put header
11950 (unless splicep
11951 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11953 ;; Now loop over all lines
11954 (while (setq line (pop table))
11955 (if (eq line 'hline)
11956 ;; A horizontal separator line
11957 (progn (if hline (push hline rtn))
11958 (setq h nil)) ; no longer in header
11959 ;; A normal line. Convert the fields, push line onto the result list
11960 (setq i 0)
11961 (setq line
11962 (mapcar
11963 (lambda (f)
11964 (setq i (1+ i)
11965 fm (org-get-param p h i :fmt :hfmt)
11966 efm (org-get-param p h i :efmt))
11967 (if (and efm (string-match orgtbl-exp-regexp f))
11968 (setq f (format
11969 efm (match-string 1 f) (match-string 2 f))))
11970 (if fm (setq f (format fm f)))
11971 f)
11972 line))
11973 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11974 (push (apply 'format lfmt line) rtn)
11975 (push (concat
11976 (org-get-param p h i :lstart :hlstart)
11977 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11978 (org-get-param p h i :lend :hlend))
11979 rtn))))
11981 (unless splicep
11982 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11986 (defun orgtbl-to-latex (table params)
11987 "Convert the orgtbl-mode TABLE to LaTeX.
11988 TABLE is a list, each entry either the symbol `hline' for a horizontal
11989 separator line, or a list of fields for that line.
11990 PARAMS is a property list of parameters that can influence the conversion.
11991 Supports all parameters from `orgtbl-to-generic'. Most important for
11992 LaTeX are:
11994 :splice When set to t, return only table body lines, don't wrap
11995 them into a tabular environment. Default is nil.
11997 :fmt A format to be used to wrap the field, should contain %s for the
11998 original field value. For example, to wrap everything in dollars,
12002 :efmt Format for transforming numbers with exponentials. The format
12003 should have %s twice for inserting mantissa and exponent, for
12005 This may also be a property list with column numbers and formats.
12007 The general parameters :skip and :skipcols have already been applied when
12008 this function is called."
12009 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
12010 org-table-last-alignment ""))
12011 (params2
12012 (list
12017 (orgtbl-to-generic table (org-combine-plists params2 params))))
12019 (defun orgtbl-to-html (table params)
12020 "Convert the orgtbl-mode TABLE to LaTeX.
12021 TABLE is a list, each entry either the symbol `hline' for a horizontal
12022 separator line, or a list of fields for that line.
12023 PARAMS is a property list of parameters that can influence the conversion.
12024 Currently this function recognizes the following parameters:
12026 :splice When set to t, return only table body lines, don't wrap
12027 them into a <table> environment. Default is nil.
12029 The general parameters :skip and :skipcols have already been applied when
12030 this function is called. The function does *not* use `orgtbl-to-generic',
12031 so you cannot specify parameters for it."
12032 (let* ((splicep (plist-get params :splice))
12033 html)
12034 ;; Just call the formatter we already have
12035 ;; We need to make text lines for it, so put the fields back together.
12036 (setq html (org-format-org-table-html
12037 (mapcar
12038 (lambda (x)
12039 (if (eq x 'hline)
12040 "|----+----|"
12041 (concat "| " (mapconcat 'identity x " | ") " |")))
12042 table)
12043 splicep))
12045 (setq html (replace-match "" t t html)))
12046 html))
12048 (defun orgtbl-to-texinfo (table params)
12049 "Convert the orgtbl-mode TABLE to TeXInfo.
12050 TABLE is a list, each entry either the symbol `hline' for a horizontal
12051 separator line, or a list of fields for that line.
12052 PARAMS is a property list of parameters that can influence the conversion.
12053 Supports all parameters from `orgtbl-to-generic'. Most important for
12054 TeXInfo are:
12056 :splice nil/t When set to t, return only table body lines, don't wrap
12057 them into a multitable environment. Default is nil.
12059 :fmt fmt A format to be used to wrap the field, should contain
12060 %s for the original field value. For example, to wrap
12062 This may also be a property list with column numbers and
12066 are computed automatically from the width of the columns
12067 under org-mode.
12069 The general parameters :skip and :skipcols have already been applied when
12070 this function is called."
12071 (let* ((total (float (apply '+ org-table-last-column-widths)))
12072 (colfrac (or (plist-get params :cf)
12073 (mapconcat
12074 (lambda (x) (format "%.3f" (/ (float x) total)))
12075 org-table-last-column-widths " ")))
12076 (params2
12077 (list
12078 :tstart (concat "@multitable @columnfractions " colfrac)
12079 :tend "@end multitable"
12080 :lstart "@item " :lend "" :sep " @tab "
12081 :hlstart "@headitem ")))
12082 (orgtbl-to-generic table (org-combine-plists params2 params))))
12084 ;;;; Link Stuff
12086 ;;; Link abbreviations
12088 (defun org-link-expand-abbrev (link)
12089 "Apply replacements as defined in `org-link-abbrev-alist."
12091 (let* ((key (match-string 1 link))
12092 (as (or (assoc key org-link-abbrev-alist-local)
12093 (assoc key org-link-abbrev-alist)))
12094 (tag (and (match-end 2) (match-string 3 link)))
12095 rpl)
12096 (if (not as)
12097 link
12098 (setq rpl (cdr as))
12099 (cond
12100 ((symbolp rpl) (funcall rpl tag))
12101 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
12102 (t (concat rpl tag)))))
12103 link))
12105 ;;; Storing and inserting links
12107 (defvar org-insert-link-history nil
12108 "Minibuffer history for links inserted with `org-insert-link'.")
12110 (defvar org-stored-links nil
12111 "Contains the links stored with `org-store-link'.")
12113 (defvar org-store-link-plist nil
12114 "Plist with info about the most recently link created with `org-store-link'.")
12116 (defvar org-link-protocols nil
12117 "Link protocols added to Org-mode using `org-add-link-type'.")
12119 (defvar org-store-link-functions nil
12120 "List of functions that are called to create and store a link.
12121 Each function will be called in turn until one returns a non-nil
12122 value. Each function should check if it is responsible for creating
12123 this link (for example by looking at the major mode).
12124 If not, it must exit and return nil.
12125 If yes, it should return a non-nil value after a calling
12126 `org-store-link-props' with a list of properties and values.
12127 Special properties are:
12131 This is obligatory as well.
12132 :description Optional default description for the second pair
12133 of brackets in an Org-mode link. The user can still change
12134 this when inserting this link into an Org-mode buffer.
12136 In addition to these, any additional properties can be specified
12137 and then used in remember templates.")
12139 (defun org-add-link-type (type &optional follow publish)
12140 "Add TYPE to the list of `org-link-types'.
12141 Re-compute all regular expressions depending on `org-link-types'
12142 FOLLOW and PUBLISH are two functions. Both take the link path as
12143 an argument.
12144 FOLLOW should do whatever is necessary to follow the link, for example
12145 to find a file or display a mail message.
12147 PUBLISH takes the path and retuns the string that should be used when
12148 this document is published. FIMXE: This is actually not yet implemented."
12149 (add-to-list 'org-link-types type t)
12150 (org-make-link-regexps)
12151 (add-to-list 'org-link-protocols
12152 (list type follow publish)))
12154 (defun org-add-agenda-custom-command (entry)
12155 "Replace or add a command in `org-agenda-custom-commands'.
12156 This is mostly for hacking and trying a new command - once the command
12157 works you probably want to add it to `org-agenda-custom-commands' for good."
12158 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
12159 (if ass
12160 (setcdr ass (cdr entry))
12161 (push entry org-agenda-custom-commands))))
12163 ;;;###autoload
12164 (defun org-store-link (arg)
12166 This link is added to `org-stored-links' and can later be inserted
12169 For some link types, a prefix arg is interpreted:
12170 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12171 For file links, arg negates `org-context-in-file-links'."
12172 (interactive "P")
12173 (setq org-store-link-plist nil) ; reset
12174 (let (link cpltxt desc description search txt)
12175 (cond
12177 ((run-hook-with-args-until-success 'org-store-link-functions)
12178 (setq link (plist-get org-store-link-plist :link)
12179 desc (or (plist-get org-store-link-plist :description) link)))
12181 ((eq major-mode 'bbdb-mode)
12182 (let ((name (bbdb-record-name (bbdb-current-record)))
12183 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
12184 (setq cpltxt (concat "bbdb:" (or name company))
12185 link (org-make-link cpltxt))
12186 (org-store-link-props :type "bbdb" :name name :company company)))
12188 ((eq major-mode 'Info-mode)
12189 (setq link (org-make-link "info:"
12190 (file-name-nondirectory Info-current-file)
12191 ":" Info-current-node))
12192 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
12193 ":" Info-current-node))
12194 (org-store-link-props :type "info" :file Info-current-file
12195 :node Info-current-node))
12197 ((eq major-mode 'calendar-mode)
12198 (let ((cd (calendar-cursor-to-date)))
12199 (setq link
12200 (format-time-string
12201 (car org-time-stamp-formats)
12202 (apply 'encode-time
12203 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12204 nil nil nil))))
12205 (org-store-link-props :type "calendar" :date cd)))
12207 ((or (eq major-mode 'vm-summary-mode)
12208 (eq major-mode 'vm-presentation-mode))
12209 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
12210 (vm-follow-summary-cursor)
12211 (save-excursion
12212 (vm-select-folder-buffer)
12213 (let* ((message (car vm-message-pointer))
12214 (folder buffer-file-name)
12215 (subject (vm-su-subject message))
12216 (to (vm-get-header-contents message "To"))
12217 (from (vm-get-header-contents message "From"))
12218 (message-id (vm-su-message-id message)))
12219 (org-store-link-props :type "vm" :from from :to to :subject subject
12220 :message-id message-id)
12221 (setq message-id (org-remove-angle-brackets message-id))
12222 (setq folder (abbreviate-file-name folder))
12223 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
12224 folder)
12225 (setq folder (replace-match "" t t folder)))
12226 (setq cpltxt (org-email-link-description))
12227 (setq link (org-make-link "vm:" folder "#" message-id)))))
12229 ((eq major-mode 'wl-summary-mode)
12230 (let* ((msgnum (wl-summary-message-number))
12231 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12232 msgnum 'message-id))
12233 (wl-message-entity
12234 (if (fboundp 'elmo-message-entity)
12235 (elmo-message-entity
12236 wl-summary-buffer-elmo-folder msgnum)
12237 (elmo-msgdb-overview-get-entity
12238 msgnum (wl-summary-buffer-msgdb))))
12239 (from (wl-summary-line-from))
12240 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12241 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12242 (wl-summary-line-subject))))
12243 (org-store-link-props :type "wl" :from from :to to
12244 :subject subject :message-id message-id)
12245 (setq message-id (org-remove-angle-brackets message-id))
12246 (setq cpltxt (org-email-link-description))
12247 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12248 "#" message-id))))
12250 ((or (equal major-mode 'mh-folder-mode)
12251 (equal major-mode 'mh-show-mode))
12252 (let ((from (org-mhe-get-header "From:"))
12253 (to (org-mhe-get-header "To:"))
12254 (message-id (org-mhe-get-header "Message-Id:"))
12255 (subject (org-mhe-get-header "Subject:")))
12256 (org-store-link-props :type "mh" :from from :to to
12257 :subject subject :message-id message-id)
12258 (setq cpltxt (org-email-link-description))
12259 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12260 (org-remove-angle-brackets message-id)))))
12262 ((or (eq major-mode 'rmail-mode)
12263 (eq major-mode 'rmail-summary-mode))
12264 (save-window-excursion
12265 (save-restriction
12266 (when (eq major-mode 'rmail-summary-mode)
12267 (rmail-show-message rmail-current-message))
12268 (rmail-narrow-to-non-pruned-header)
12269 (let ((folder buffer-file-name)
12270 (message-id (mail-fetch-field "message-id"))
12271 (from (mail-fetch-field "from"))
12272 (to (mail-fetch-field "to"))
12273 (subject (mail-fetch-field "subject")))
12274 (org-store-link-props
12275 :type "rmail" :from from :to to
12276 :subject subject :message-id message-id)
12277 (setq message-id (org-remove-angle-brackets message-id))
12278 (setq cpltxt (org-email-link-description))
12279 (setq link (org-make-link "rmail:" folder "#" message-id)))
12280 (rmail-show-message rmail-current-message))))
12282 ((eq major-mode 'gnus-group-mode)
12283 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12284 (gnus-group-group-name)) ; version
12285 ((fboundp 'gnus-group-name)
12286 (gnus-group-name))
12287 (t "???"))))
12288 (unless group (error "Not on a group"))
12289 (org-store-link-props :type "gnus" :group group)
12290 (setq cpltxt (concat
12291 (if (org-xor arg org-usenet-links-prefer-google)
12292 "http://groups.google.com/groups?group="
12293 "gnus:")
12294 group)
12295 link (org-make-link cpltxt))))
12297 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12298 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12299 (let* ((group gnus-newsgroup-name)
12300 (article (gnus-summary-article-number))
12301 (header (gnus-summary-article-header article))
12302 (from (mail-header-from header))
12303 (message-id (mail-header-id header))
12304 (date (mail-header-date header))
12305 (subject (gnus-summary-subject-string)))
12306 (org-store-link-props :type "gnus" :from from :subject subject
12307 :message-id message-id :group group)
12308 (setq cpltxt (org-email-link-description))
12309 (if (org-xor arg org-usenet-links-prefer-google)
12310 (setq link
12311 (concat
12313 (format "http://groups.google.com/groups?as_umsgid=%s"
12314 (org-fixup-message-id-for-http message-id))))
12315 (setq link (org-make-link "gnus:" group
12316 "#" (number-to-string article))))))
12318 ((eq major-mode 'w3-mode)
12319 (setq cpltxt (url-view-url t)
12320 link (org-make-link cpltxt))
12321 (org-store-link-props :type "w3" :url (url-view-url t)))
12323 ((eq major-mode 'w3m-mode)
12324 (setq cpltxt (or w3m-current-title w3m-current-url)
12325 link (org-make-link w3m-current-url))
12326 (org-store-link-props :type "w3m" :url (url-view-url t)))
12328 ((setq search (run-hook-with-args-until-success
12329 'org-create-file-search-functions))
12330 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12331 "::" search))
12332 (setq cpltxt (or description link)))
12334 ((eq major-mode 'image-mode)
12335 (setq cpltxt (concat "file:"
12336 (abbreviate-file-name buffer-file-name))
12337 link (org-make-link cpltxt))
12338 (org-store-link-props :type "image" :file buffer-file-name))
12340 ((eq major-mode 'dired-mode)
12341 ;; link to the file in the current line
12342 (setq cpltxt (concat "file:"
12343 (abbreviate-file-name
12344 (expand-file-name
12345 (dired-get-filename nil t))))
12346 link (org-make-link cpltxt)))
12348 ((and buffer-file-name (org-mode-p))
12349 ;; Just link to current headline
12350 (setq cpltxt (concat "file:"
12351 (abbreviate-file-name buffer-file-name)))
12352 ;; Add a context search string
12353 (when (org-xor org-context-in-file-links arg)
12354 ;; Check if we are on a target
12356 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12357 (setq txt (cond
12358 ((org-on-heading-p) nil)
12359 ((org-region-active-p)
12360 (buffer-substring (region-beginning) (region-end)))
12361 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12363 (setq cpltxt
12364 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12365 desc "NONE"))))
12367 (setq cpltxt (substring cpltxt 0 -2)))
12368 (setq link (org-make-link cpltxt)))
12370 ((buffer-file-name (buffer-base-buffer))
12371 ;; Just link to this file here.
12372 (setq cpltxt (concat "file:"
12373 (abbreviate-file-name
12374 (buffer-file-name (buffer-base-buffer)))))
12375 ;; Add a context string
12376 (when (org-xor org-context-in-file-links arg)
12377 (setq txt (if (org-region-active-p)
12378 (buffer-substring (region-beginning) (region-end))
12379 (buffer-substring (point-at-bol) (point-at-eol))))
12380 ;; Only use search option if there is some text.
12382 (setq cpltxt
12383 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12384 desc "NONE")))
12385 (setq link (org-make-link cpltxt)))
12387 ((interactive-p)
12388 (error "Cannot link to a buffer which is not visiting a file"))
12390 (t (setq link nil)))
12392 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12393 (setq link (or link cpltxt)
12394 desc (or desc cpltxt))
12395 (if (equal desc "NONE") (setq desc nil))
12397 (if (and (interactive-p) link)
12398 (progn
12399 (setq org-stored-links
12400 (cons (list link desc) org-stored-links))
12401 (message "Stored: %s" (or desc link)))
12402 (and link (org-make-link-string link desc)))))
12404 (defun org-store-link-props (&rest plist)
12405 "Store link properties, extract names and addresses."
12406 (let (x adr)
12407 (when (setq x (plist-get plist :from))
12408 (setq adr (mail-extract-address-components x))
12409 (plist-put plist :fromname (car adr))
12410 (plist-put plist :fromaddress (nth 1 adr)))
12411 (when (setq x (plist-get plist :to))
12412 (setq adr (mail-extract-address-components x))
12413 (plist-put plist :toname (car adr))
12414 (plist-put plist :toaddress (nth 1 adr))))
12415 (let ((from (plist-get plist :from))
12416 (to (plist-get plist :to)))
12417 (when (and from to org-from-is-user-regexp)
12418 (plist-put plist :fromto
12419 (if (string-match org-from-is-user-regexp from)
12420 (concat "to %t")
12421 (concat "from %f")))))
12422 (setq org-store-link-plist plist))
12424 (defun org-email-link-description (&optional fmt)
12425 "Return the description part of an email link.
12426 This takes information from `org-store-link-plist' and formats it
12427 according to FMT (default from `org-email-link-description-format')."
12428 (setq fmt (or fmt org-email-link-description-format))
12429 (let* ((p org-store-link-plist)
12430 (to (plist-get p :toaddress))
12431 (from (plist-get p :fromaddress))
12432 (table
12433 (list
12434 (cons "%c" (plist-get p :fromto))
12435 (cons "%F" (plist-get p :from))
12436 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12437 (cons "%T" (plist-get p :to))
12438 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12439 (cons "%s" (plist-get p :subject))
12440 (cons "%m" (plist-get p :message-id)))))
12441 (when (string-match "%c" fmt)
12442 ;; Check if the user wrote this message
12443 (if (and org-from-is-user-regexp from to
12444 (save-match-data (string-match org-from-is-user-regexp from)))
12445 (setq fmt (replace-match "to %t" t t fmt))
12446 (setq fmt (replace-match "from %f" t t fmt))))
12447 (org-replace-escapes fmt table)))
12449 (defun org-make-org-heading-search-string (&optional string heading)
12450 "Make search string for STRING or current headline."
12451 (interactive)
12452 (let ((s (or string (org-get-heading))))
12453 (unless (and string (not heading))
12454 ;; We are using a headline, clean up garbage in there.
12455 (if (string-match org-todo-regexp s)
12456 (setq s (replace-match "" t t s)))
12458 (setq s (replace-match "" t t s)))
12459 (setq s (org-trim s))
12462 (setq s (replace-match "" t t s)))
12463 (while (string-match org-ts-regexp s)
12464 (setq s (replace-match "" t t s))))
12466 (setq s (replace-match " " t t s)))
12467 (or string (setq s (concat "*" s))) ; Add * for headlines
12470 (defun org-make-link (&rest strings)
12471 "Concatenate STRINGS."
12472 (apply 'concat strings))
12474 (defun org-make-link-string (link &optional description)
12475 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12477 (error "Empty link"))
12478 (when (stringp description)
12479 ;; Remove brackets from the description, they are fatal.
12481 (setq description (replace-match "{" t t description)))
12483 (setq description (replace-match "}" t t description))))
12484 (when (equal (org-link-escape link) description)
12485 ;; No description needed, it is identical
12486 (setq description nil))
12487 (when (and (not description)
12488 (not (equal link (org-link-escape link))))
12489 (setq description link))
12490 (concat "[[" (org-link-escape link) "]"
12491 (if description (concat "[" description "]") "")
12492 "]"))
12494 (defconst org-link-escape-chars
12495 '((?\ . "%20")
12496 (?\[ . "%5B")
12497 (?\] . "%5D")
12508 (?\; . "%3B")
12509 (?? . "%3F")
12510 (?= . "%3D")
12511 (?+ . "%2B")
12512 )
12513 "Association list of escapes for some characters problematic in links.
12514 This is the list that is used for internal purposes.")
12516 (defconst org-link-escape-chars-browser
12517 '((?\ . "%20")) ; 32 for the SPC char
12518 "Association list of escapes for some characters problematic in links.
12519 This is the list that is used before handing over to the browser.")
12521 (defun org-link-escape (text &optional table)
12522 "Escape charaters in TEXT that are problematic for links."
12523 (setq table (or table org-link-escape-chars))
12524 (when text
12525 (let ((re (mapconcat (lambda (x) (regexp-quote
12526 (char-to-string (car x))))
12528 (while (string-match re text)
12529 (setq text
12530 (replace-match
12531 (cdr (assoc (string-to-char (match-string 0 text))
12532 table))
12533 t t text)))
12534 text)))
12536 (defun org-link-unescape (text &optional table)
12537 "Reverse the action of `org-link-escape'."
12538 (setq table (or table org-link-escape-chars))
12539 (when text
12540 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12542 (while (string-match re text)
12543 (setq text
12544 (replace-match
12545 (char-to-string (car (rassoc (match-string 0 text) table)))
12546 t t text)))
12547 text)))
12549 (defun org-xor (a b)
12550 "Exclusive or."
12551 (if a (not b) b))
12553 (defun org-get-header (header)
12554 "Find a header field in the current buffer."
12555 (save-excursion
12556 (goto-char (point-min))
12557 (let ((case-fold-search t) s)
12558 (cond
12559 ((eq header 'from)
12561 (setq s (match-string 1)))
12563 (setq s (replace-match "" t t s)))
12564 (if (string-match "[<(].*" s)
12565 (setq s (replace-match "" t t s))))
12566 ((eq header 'message-id)
12568 (setq s (match-string 1))))
12569 ((eq header 'subject)
12571 (setq s (match-string 1)))))
12574 s)))
12577 (defun org-fixup-message-id-for-http (s)
12578 "Replace special characters in a message id, so it can be used in an http query."
12579 (while (string-match "<" s)
12580 (setq s (replace-match "%3C" t t s)))
12581 (while (string-match ">" s)
12582 (setq s (replace-match "%3E" t t s)))
12583 (while (string-match "@" s)
12584 (setq s (replace-match "%40" t t s)))
12585 s)
12587 ;;;###autoload
12588 (defun org-insert-link-global ()
12589 "Insert a link like Org-mode does.
12590 This command can be called in any mode to insert a link in Org-mode syntax."
12591 (interactive)
12592 (org-run-like-in-org-mode 'org-insert-link))
12594 (defun org-insert-link (&optional complete-file)
12595 "Insert a link. At the prompt, enter the link.
12597 Completion can be used to select a link previously stored with
12598 `org-store-link'. When the empty string is entered (i.e. if you just
12599 press RET at the prompt), the link defaults to the most recently
12600 stored link. As SPC triggers completion in the minibuffer, you need to
12601 use M-SPC or C-q SPC to force the insertion of a space character.
12603 You will also be prompted for a description, and if one is given, it will
12604 be displayed in the buffer instead of the link.
12606 If there is already a link at point, this command will allow you to edit link
12607 and description parts.
12610 selected using completion. The path to the file will be relative to
12611 the current directory if the file is in the current directory or a
12612 subdirectory. Otherwise, the link will be the absolute path as
12613 completed in the minibuffer (i.e. normally ~/path/to/file).
12616 is in the current directory or below.
12618 `org-keep-stored-link-after-insertion'."
12619 (interactive "P")
12620 (let* ((wcf (current-window-configuration))
12621 (region (if (org-region-active-p)
12622 (buffer-substring (region-beginning) (region-end))))
12623 (remove (and region (list (region-beginning) (region-end))))
12624 (desc region)
12625 tmphist ; byte-compile incorrectly complains about this
12626 link entry file)
12627 (cond
12628 ((org-in-regexp org-bracket-link-regexp 1)
12629 ;; We do have a link at point, and we are going to edit it.
12630 (setq remove (list (match-beginning 0) (match-end 0)))
12631 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12632 (setq link (read-string "Link: "
12633 (org-link-unescape
12634 (org-match-string-no-properties 1)))))
12635 ((or (org-in-regexp org-angle-link-re)
12636 (org-in-regexp org-plain-link-re))
12637 ;; Convert to bracket link
12638 (setq remove (list (match-beginning 0) (match-end 0))
12639 link (read-string "Link: "
12640 (org-remove-angle-brackets (match-string 0)))))
12641 ((equal complete-file '(4))
12642 ;; Completing read for file names.
12643 (setq file (read-file-name "File: "))
12644 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12645 (pwd1 (file-name-as-directory (abbreviate-file-name
12646 (expand-file-name ".")))))
12647 (cond
12648 ((equal complete-file '(16))
12649 (setq link (org-make-link
12650 "file:"
12651 (abbreviate-file-name (expand-file-name file)))))
12653 (setq link (org-make-link "file:" (match-string 1 file))))
12655 (expand-file-name file))
12656 (setq link (org-make-link
12657 "file:" (match-string 1 (expand-file-name file)))))
12658 (t (setq link (org-make-link "file:" file))))))
12659 (t
12660 ;; Read link, with completion for stored links.
12661 (with-output-to-temp-buffer "*Org Links*"
12663 (when org-stored-links
12665 (princ (mapconcat
12666 (lambda (x)
12667 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12669 (let ((cw (selected-window)))
12670 (select-window (get-buffer-window "*Org Links*"))
12671 (shrink-window-if-larger-than-buffer)
12672 (setq truncate-lines t)
12673 (select-window cw))
12674 ;; Fake a link history, containing the stored links.
12675 (setq tmphist (append (mapcar 'car org-stored-links)
12676 org-insert-link-history))
12677 (unwind-protect
12678 (setq link (org-completing-read
12679 "Link: "
12680 (append
12681 (mapcar (lambda (x) (list (concat (car x) ":")))
12682 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12683 (mapcar (lambda (x) (list (concat x ":")))
12684 org-link-types))
12685 nil nil nil
12686 'tmphist
12687 (or (car (car org-stored-links)))))
12688 (set-window-configuration wcf)
12689 (kill-buffer "*Org Links*"))
12690 (setq entry (assoc link org-stored-links))
12691 (or entry (push link org-insert-link-history))
12692 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12693 (not org-keep-stored-link-after-insertion))
12694 (setq org-stored-links (delq (assoc link org-stored-links)
12695 org-stored-links)))
12696 (setq desc (or desc (nth 1 entry)))))
12698 (if (string-match org-plain-link-re link)
12699 ;; URL-like link, normalize the use of angular brackets.
12700 (setq link (org-make-link (org-remove-angle-brackets link))))
12702 ;; Check if we are linking to the current file with a search option
12703 ;; If yes, simplify the link by using only the search option.
12704 (when (and buffer-file-name
12706 (let* ((path (match-string 1 link))
12707 (case-fold-search nil)
12708 (search (match-string 2 link)))
12709 (save-match-data
12710 (if (equal (file-truename buffer-file-name) (file-truename path))
12711 ;; We are linking to this same file, with a search option
12712 (setq link search)))))
12714 ;; Check if we can/should use a relative path. If yes, simplify the link
12716 (let* ((path (match-string 1 link))
12717 (origpath path)
12718 (case-fold-search nil))
12719 (cond
12720 ((eq org-link-file-path-type 'absolute)
12721 (setq path (abbreviate-file-name (expand-file-name path))))
12722 ((eq org-link-file-path-type 'noabbrev)
12723 (setq path (expand-file-name path)))
12724 ((eq org-link-file-path-type 'relative)
12725 (setq path (file-relative-name path)))
12726 (t
12727 (save-match-data
12728 (if (string-match (concat "^" (regexp-quote
12729 (file-name-as-directory
12730 (expand-file-name "."))))
12731 (expand-file-name path))
12732 ;; We are linking a file with relative path name.
12733 (setq path (substring (expand-file-name path)
12734 (match-end 0)))))))
12735 (setq link (concat "file:" path))
12736 (if (equal desc origpath)
12737 (setq desc path))))
12739 (setq desc (read-string "Description: " desc))
12741 (if remove (apply 'delete-region remove))
12742 (insert (org-make-link-string link desc))))
12744 (defun org-completing-read (&rest args)
12745 (let ((minibuffer-local-completion-map
12746 (copy-keymap minibuffer-local-completion-map)))
12747 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12748 (apply 'completing-read args)))
12750 ;;; Opening/following a link
12751 (defvar org-link-search-failed nil)
12753 (defun org-next-link ()
12754 "Move forward to the next link.
12755 If the link is in hidden text, expose it."
12756 (interactive)
12757 (when (and org-link-search-failed (eq this-command last-command))
12758 (goto-char (point-min))
12759 (message "Link search wrapped back to beginning of buffer"))
12760 (setq org-link-search-failed nil)
12761 (let* ((pos (point))
12762 (ct (org-context))
12763 (a (assoc :link ct)))
12764 (if a (goto-char (nth 2 a)))
12765 (if (re-search-forward org-any-link-re nil t)
12766 (progn
12767 (goto-char (match-beginning 0))
12768 (if (org-invisible-p) (org-show-context)))
12769 (goto-char pos)
12770 (setq org-link-search-failed t)
12771 (error "No further link found"))))
12773 (defun org-previous-link ()
12774 "Move backward to the previous link.
12775 If the link is in hidden text, expose it."
12776 (interactive)
12777 (when (and org-link-search-failed (eq this-command last-command))
12778 (goto-char (point-max))
12779 (message "Link search wrapped back to end of buffer"))
12780 (setq org-link-search-failed nil)
12781 (let* ((pos (point))
12782 (ct (org-context))
12783 (a (assoc :link ct)))
12784 (if a (goto-char (nth 1 a)))
12785 (if (re-search-backward org-any-link-re nil t)
12786 (progn
12787 (goto-char (match-beginning 0))
12788 (if (org-invisible-p) (org-show-context)))
12789 (goto-char pos)
12790 (setq org-link-search-failed t)
12791 (error "No further link found"))))
12793 (defun org-find-file-at-mouse (ev)
12794 "Open file link or URL at mouse."
12795 (interactive "e")
12796 (mouse-set-point ev)
12797 (org-open-at-point 'in-emacs))
12799 (defun org-open-at-mouse (ev)
12800 "Open file link or URL at mouse."
12801 (interactive "e")
12802 (mouse-set-point ev)
12803 (org-open-at-point))
12805 (defvar org-window-config-before-follow-link nil
12806 "The window configuration before following a link.
12807 This is saved in case the need arises to restore it.")
12809 (defvar org-open-link-marker (make-marker)
12810 "Marker pointing to the location where `org-open-at-point; was called.")
12812 ;;;###autoload
12813 (defun org-open-at-point-global ()
12814 "Follow a link like Org-mode does.
12815 This command can be called in any mode to follow a link that has
12816 Org-mode syntax."
12817 (interactive)
12818 (org-run-like-in-org-mode 'org-open-at-point))
12820 (defun org-open-at-point (&optional in-emacs)
12821 "Open link at or after point.
12822 If there is no link at point, this function will search forward up to
12823 the end of the current subtree.
12824 Normally, files will be opened by an appropriate application. If the
12825 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12826 (interactive "P")
12827 (move-marker org-open-link-marker (point))
12828 (setq org-window-config-before-follow-link (current-window-configuration))
12829 (org-remove-occur-highlights nil nil t)
12830 (if (org-at-timestamp-p t)
12831 (org-follow-timestamp-link)
12832 (let (type path link line search (pos (point)))
12833 (catch 'match
12834 (save-excursion
12836 (when (org-in-regexp org-bracket-link-regexp)
12837 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12839 (setq link (replace-match " " t t link)))
12840 (setq link (org-link-expand-abbrev link))
12841 (if (string-match org-link-re-with-space2 link)
12842 (setq type (match-string 1 link) path (match-string 2 link))
12843 (setq type "thisfile" path link))
12844 (throw 'match t)))
12846 (when (get-text-property (point) 'org-linked-text)
12847 (setq type "thisfile"
12848 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12849 (1+ (point)) (point))
12850 path (buffer-substring
12851 (previous-single-property-change pos 'org-linked-text)
12852 (next-single-property-change pos 'org-linked-text)))
12853 (throw 'match t))
12855 (save-excursion
12856 (when (or (org-in-regexp org-angle-link-re)
12857 (org-in-regexp org-plain-link-re))
12858 (setq type (match-string 1) path (match-string 2))
12859 (throw 'match t)))
12861 (setq type "tree-match"
12862 path (match-string 1))
12863 (throw 'match t))
12864 (save-excursion
12866 (setq type "tags"
12867 path (match-string 1))
12868 (while (string-match ":" path)
12869 (setq path (replace-match "+" t t path)))
12870 (throw 'match t))))
12871 (unless path
12872 (error "No link found"))
12873 ;; Remove any trailing spaces in path
12875 (setq path (replace-match "" t t path)))
12877 (cond
12879 ((assoc type org-link-protocols)
12880 (funcall (nth 1 (assoc type org-link-protocols)) path))
12882 ((equal type "mailto")
12883 (let ((cmd (car org-link-mailto-program))
12884 (args (cdr org-link-mailto-program)) args1
12885 (address path) (subject "") a)
12887 (setq address (match-string 1 path)
12888 subject (org-link-escape (match-string 2 path))))
12889 (while args
12890 (cond
12891 ((not (stringp (car args))) (push (pop args) args1))
12892 (t (setq a (pop args))
12893 (if (string-match "%a" a)
12894 (setq a (replace-match address t t a)))
12895 (if (string-match "%s" a)
12896 (setq a (replace-match subject t t a)))
12897 (push a args1))))
12898 (apply cmd (nreverse args1))))
12900 ((member type '("http" "https" "ftp" "news"))
12901 (browse-url (concat type ":" (org-link-escape
12902 path org-link-escape-chars-browser))))
12904 ((member type '("message"))
12905 (browse-url (concat type ":" path)))
12907 ((string= type "tags")
12908 (org-tags-view in-emacs path))
12909 ((string= type "thisfile")
12910 (if in-emacs
12911 (switch-to-buffer-other-window
12912 (org-get-buffer-for-internal-link (current-buffer)))
12913 (org-mark-ring-push))
12914 (let ((cmd `(org-link-search
12915 ,path
12916 ,(cond ((equal in-emacs '(4)) 'occur)
12917 ((equal in-emacs '(16)) 'org-occur)
12918 (t nil))
12919 ,pos)))
12920 (condition-case nil (eval cmd)
12921 (error (progn (widen) (eval cmd))))))
12923 ((string= type "tree-match")
12926 ((string= type "file")
12928 (setq line (string-to-number (match-string 1 path))
12929 path (substring path 0 (match-beginning 0)))
12931 (setq search (match-string 1 path)
12932 path (substring path 0 (match-beginning 0)))))
12933 (if (string-match "[*?{]" (file-name-nondirectory path))
12934 (dired path)
12935 (org-open-file path in-emacs line search)))
12937 ((string= type "news")
12938 (org-follow-gnus-link path))
12940 ((string= type "bbdb")
12941 (org-follow-bbdb-link path))
12943 ((string= type "info")
12944 (org-follow-info-link path))
12946 ((string= type "gnus")
12947 (let (group article)
12949 (error "Error in Gnus link"))
12950 (setq group (match-string 1 path)
12951 article (match-string 3 path))
12952 (org-follow-gnus-link group article)))
12954 ((string= type "vm")
12955 (let (folder article)
12957 (error "Error in VM link"))
12958 (setq folder (match-string 1 path)
12959 article (match-string 3 path))
12960 ;; in-emacs is the prefix arg, will be interpreted as read-only
12961 (org-follow-vm-link folder article in-emacs)))
12963 ((string= type "wl")
12964 (let (folder article)
12966 (error "Error in Wanderlust link"))
12967 (setq folder (match-string 1 path)
12968 article (match-string 3 path))
12969 (org-follow-wl-link folder article)))
12971 ((string= type "mhe")
12972 (let (folder article)
12974 (error "Error in MHE link"))
12975 (setq folder (match-string 1 path)
12976 article (match-string 3 path))
12977 (org-follow-mhe-link folder article)))
12979 ((string= type "rmail")
12980 (let (folder article)
12982 (error "Error in RMAIL link"))
12983 (setq folder (match-string 1 path)
12984 article (match-string 3 path))
12985 (org-follow-rmail-link folder article)))
12987 ((string= type "shell")
12988 (let ((cmd path))
12989 (if (or (not org-confirm-shell-link-function)
12990 (funcall org-confirm-shell-link-function
12992 (org-add-props cmd nil
12993 'face 'org-warning))))
12994 (progn
12995 (message "Executing %s" cmd)
12996 (shell-command cmd))
12997 (error "Abort"))))
12999 ((string= type "elisp")
13000 (let ((cmd path))
13001 (if (or (not org-confirm-elisp-link-function)
13002 (funcall org-confirm-elisp-link-function
13004 (org-add-props cmd nil
13005 'face 'org-warning))))
13006 (message "%s => %s" cmd (eval (read cmd)))
13007 (error "Abort"))))
13009 (t
13010 (browse-url-at-point)))))
13011 (move-marker org-open-link-marker nil)
13012 (run-hook-with-args 'org-follow-link-hook))
13014 ;;; File search
13016 (defvar org-create-file-search-functions nil
13017 "List of functions to construct the right search string for a file link.
13018 These functions are called in turn with point at the location to
13019 which the link should point.
13021 A function in the hook should first test if it would like to
13022 handle this file type, for example by checking the major-mode or
13023 the file extension. If it decides not to handle this file, it
13024 should just return nil to give other functions a chance. If it
13025 does handle the file, it must return the search string to be used
13026 when following the link. The search string will be part of the
13027 file link, given after a double colon, and `org-open-at-point'
13028 will automatically search for it. If special measures must be
13029 taken to make the search successful, another function should be
13030 added to the companion hook `org-execute-file-search-functions',
13031 which see.
13033 A function in this hook may also use `setq' to set the variable
13034 `description' to provide a suggestion for the descriptive text to
13035 be used for this link when it gets inserted into an Org-mode
13038 (defvar org-execute-file-search-functions nil
13039 "List of functions to execute a file search triggered by a link.
13041 Functions added to this hook must accept a single argument, the
13042 search string that was part of the file link, the part after the
13043 double colon. The function must first check if it would like to
13044 handle this search, for example by checking the major-mode or the
13045 file extension. If it decides not to handle this search, it
13046 should just return nil to give other functions a chance. If it
13047 does handle the search, it must return a non-nil value to keep
13048 other functions from trying.
13050 Each function can access the current prefix argument through the
13051 variable `current-prefix-argument'. Note that a single prefix is
13052 used to force opening a link in Emacs, so it may be good to only
13053 use a numeric or double prefix to guide the search function.
13055 In case this is needed, a function in this hook can also restore
13056 the window configuration before `org-open-at-point' was called using:
13058 (set-window-configuration org-window-config-before-follow-link)")
13060 (defun org-link-search (s &optional type avoid-pos)
13061 "Search for a link search option.
13062 If S is surrounded by forward slashes, it is interpreted as a
13063 regular expression. In org-mode files, this will create an `org-occur'
13064 sparse tree. In ordinary files, `occur' will be used to list matches.
13065 If the current buffer is in `dired-mode', grep will be used to search
13066 in all files. If AVOID-POS is given, ignore matches near that position."
13067 (let ((case-fold-search t)
13071 org-emphasis-alist)
13073 (pos (point))
13074 (pre "") (post "")
13075 words re0 re1 re2 re3 re4 re5 re2a reall)
13076 (cond
13077 ;; First check if there are any special
13078 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
13079 ;; Now try the builtin stuff
13080 ((save-excursion
13081 (goto-char (point-min))
13082 (and
13083 (re-search-forward
13084 (concat "<<" (regexp-quote s0) ">>") nil t)
13085 (setq pos (match-beginning 0))))
13086 ;; There is an exact target for this
13087 (goto-char pos))
13089 ;; A regular expression
13090 (cond
13091 ((org-mode-p)
13092 (org-occur (match-string 1 s)))
13093 ;;((eq major-mode 'dired-mode)
13094 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
13095 (t (org-do-occur (match-string 1 s)))))
13096 (t
13097 ;; A normal search strings
13098 (when (equal (string-to-char s) ?*)
13099 ;; Anchor on headlines, post may include tags.
13102 s (substring s 1)))
13103 (remove-text-properties
13104 0 (length s)
13105 '(face nil mouse-face nil keymap nil fontified nil) s)
13106 ;; Make a series of regular expressions to find a match
13113 re1 (concat pre re2 post)
13114 re3 (concat pre re4 post)
13115 re5 (concat pre ".*" re4)
13116 re2 (concat pre re2)
13117 re2a (concat pre re2a)
13118 re4 (concat pre re4)
13122 ))
13123 (cond
13124 ((eq type 'org-occur) (org-occur reall))
13125 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
13126 (t (goto-char (point-min))
13127 (if (or (org-search-not-self 1 re0 nil t)
13128 (org-search-not-self 1 re1 nil t)
13129 (org-search-not-self 1 re2 nil t)
13130 (org-search-not-self 1 re2a nil t)
13131 (org-search-not-self 1 re3 nil t)
13132 (org-search-not-self 1 re4 nil t)
13133 (org-search-not-self 1 re5 nil t)
13134 )
13135 (goto-char (match-beginning 1))
13136 (goto-char pos)
13137 (error "No match")))))
13138 (t
13139 ;; Normal string-search
13140 (goto-char (point-min))
13141 (if (search-forward s nil t)
13142 (goto-char (match-beginning 0))
13143 (error "No match"))))
13144 (and (org-mode-p) (org-show-context 'link-search))))
13146 (defun org-search-not-self (group &rest args)
13147 "Execute `re-search-forward', but only accept matches that do not
13148 enclose the position of `org-open-link-marker'."
13149 (let ((m org-open-link-marker))
13150 (catch 'exit
13151 (while (apply 're-search-forward args)
13152 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
13153 (goto-char (match-end group))
13154 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
13155 (> (match-beginning 0) (marker-position m))
13156 (< (match-end 0) (marker-position m)))
13157 (save-match-data
13158 (or (not (org-in-regexp
13159 org-bracket-link-analytic-regexp 1))
13160 (not (match-end 4)) ; no description
13161 (and (<= (match-beginning 4) (point))
13162 (>= (match-end 4) (point))))))
13163 (throw 'exit (point))))))))
13165 (defun org-get-buffer-for-internal-link (buffer)
13166 "Return a buffer to be used for displaying the link target of internal links."
13167 (cond
13168 ((not org-display-internal-link-with-indirect-buffer)
13169 buffer)
13170 ((string-match "(Clone)$" (buffer-name buffer))
13171 (message "Buffer is already a clone, not making another one")
13172 ;; we also do not modify visibility in this case
13173 buffer)
13174 (t ; make a new indirect buffer for displaying the link
13175 (let* ((bn (buffer-name buffer))
13176 (ibn (concat bn "(Clone)"))
13177 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13178 (with-current-buffer ib (org-overview))
13179 ib))))
13181 (defun org-do-occur (regexp &optional cleanup)
13182 "Call the Emacs command `occur'.
13183 If CLEANUP is non-nil, remove the printout of the regular expression
13184 in the *Occur* buffer. This is useful if the regex is long and not useful
13185 to read."
13186 (occur regexp)
13187 (when cleanup
13188 (let ((cwin (selected-window)) win beg end)
13189 (when (setq win (get-buffer-window "*Occur*"))
13190 (select-window win))
13191 (goto-char (point-min))
13192 (when (re-search-forward "match[a-z]+" nil t)
13193 (setq beg (match-end 0))
13195 (setq end (1- (match-beginning 0)))))
13196 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13197 (goto-char (point-min))
13198 (select-window cwin))))
13200 ;;; The mark ring for links jumps
13202 (defvar org-mark-ring nil
13203 "Mark ring for positions before jumps in Org-mode.")
13204 (defvar org-mark-ring-last-goto nil
13205 "Last position in the mark ring used to go back.")
13206 ;; Fill and close the ring
13207 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13208 (loop for i from 1 to org-mark-ring-length do
13209 (push (make-marker) org-mark-ring))
13210 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13211 org-mark-ring)
13213 (defun org-mark-ring-push (&optional pos buffer)
13214 "Put the current position or POS into the mark ring and rotate it."
13215 (interactive)
13216 (setq pos (or pos (point)))
13217 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13218 (move-marker (car org-mark-ring)
13219 (or pos (point))
13220 (or buffer (current-buffer)))
13221 (message "%s"
13222 (substitute-command-keys
13225 (defun org-mark-ring-goto (&optional n)
13226 "Jump to the previous position in the mark ring.
13227 With prefix arg N, jump back that many stored positions. When
13228 called several times in succession, walk through the entire ring.
13229 Org-mode commands jumping to a different position in the current file,
13230 or to another Org-mode file, automatically push the old position
13231 onto the ring."
13232 (interactive "p")
13233 (let (p m)
13234 (if (eq last-command this-command)
13235 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13236 (setq p org-mark-ring))
13237 (setq org-mark-ring-last-goto p)
13238 (setq m (car p))
13239 (switch-to-buffer (marker-buffer m))
13240 (goto-char m)
13241 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13243 (defun org-remove-angle-brackets (s)
13244 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13245 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13246 s)
13247 (defun org-add-angle-brackets (s)
13248 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13249 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13250 s)
13252 ;;; Following specific links
13254 (defun org-follow-timestamp-link ()
13255 (cond
13256 ((org-at-date-range-p t)
13257 (let ((org-agenda-start-on-weekday)
13258 (t1 (match-string 1))
13259 (t2 (match-string 2)))
13260 (setq t1 (time-to-days (org-time-string-to-time t1))
13261 t2 (time-to-days (org-time-string-to-time t2)))
13262 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13263 ((org-at-timestamp-p t)
13264 (org-agenda-list nil (time-to-days (org-time-string-to-time
13265 (substring (match-string 1) 0 10)))
13266 1))
13267 (t (error "This should not happen"))))
13270 (defun org-follow-bbdb-link (name)
13271 "Follow a BBDB link to NAME."
13272 (require 'bbdb)
13273 (let ((inhibit-redisplay (not debug-on-error))
13274 (bbdb-electric-p nil))
13275 (catch 'exit
13276 ;; Exact match on name
13278 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13279 ;; Exact match on name
13281 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13282 ;; Partial match on name
13283 (bbdb-name name nil)
13284 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13285 ;; Partial match on company
13286 (bbdb-company name nil)
13287 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13288 ;; General match including network address and notes
13289 (bbdb name nil)
13290 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13291 (delete-window (get-buffer-window "*BBDB*"))
13292 (error "No matching BBDB record")))))
13294 (defun org-follow-info-link (name)
13295 "Follow an info file & node link to NAME."
13298 (progn
13299 (require 'info)
13300 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13301 (Info-find-node (match-string 1 name) (match-string 2 name))
13302 (Info-find-node (match-string 1 name) "Top")))
13303 (message "Could not open: %s" name)))
13305 (defun org-follow-gnus-link (&optional group article)
13306 "Follow a Gnus link to GROUP and ARTICLE."
13307 (require 'gnus)
13308 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13309 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13310 (cond ((and group article)
13311 (gnus-group-read-group 1 nil group)
13312 (gnus-summary-goto-article (string-to-number article) nil t))
13313 (group (gnus-group-jump-to-group group))))
13315 (defun org-follow-vm-link (&optional folder article readonly)
13316 "Follow a VM link to FOLDER and ARTICLE."
13317 (require 'vm)
13318 (setq article (org-add-angle-brackets article))
13320 ;; ange-ftp or efs or tramp access
13321 (let ((user (or (match-string 1 folder) (user-login-name)))
13322 (host (match-string 2 folder))
13323 (file (match-string 3 folder)))
13324 (cond
13325 ((featurep 'tramp)
13326 ;; use tramp to access the file
13327 (if (featurep 'xemacs)
13328 (setq folder (format "[%s@%s]%s" user host file))
13329 (setq folder (format "/%s@%s:%s" user host file))))
13330 (t
13331 ;; use ange-ftp or efs
13332 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13333 (setq folder (format "/%s@%s:%s" user host file))))))
13334 (when folder
13335 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13336 (sit-for 0.1)
13337 (when article
13338 (vm-select-folder-buffer)
13339 (widen)
13340 (let ((case-fold-search t))
13341 (goto-char (point-min))
13342 (if (not (re-search-forward
13343 (concat "^" "message-id: *" (regexp-quote article))))
13344 (error "Could not find the specified message in this folder"))
13345 (vm-isearch-update)
13346 (vm-isearch-narrow)
13347 (vm-beginning-of-message)
13348 (vm-summarize)))))
13350 (defun org-follow-wl-link (folder article)
13351 "Follow a Wanderlust link to FOLDER and ARTICLE."
13352 (if (and (string= folder "%")
13353 article
13355 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13356 ;; Thus, we recompose folder and article ids.
13357 (setq folder (format "%s#%s" folder (match-string 1 article))
13358 article (match-string 3 article)))
13359 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13360 (error "No such folder: %s" folder))
13361 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13362 (and article
13363 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13364 (wl-summary-redisplay)))
13366 (defun org-follow-rmail-link (folder article)
13367 "Follow an RMAIL link to FOLDER and ARTICLE."
13368 (setq article (org-add-angle-brackets article))
13369 (let (message-number)
13370 (save-excursion
13371 (save-window-excursion
13372 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13373 (setq message-number
13374 (save-restriction
13375 (widen)
13376 (goto-char (point-max))
13377 (if (re-search-backward
13379 (or article "")))
13380 nil t)
13381 (rmail-what-message))))))
13382 (if message-number
13383 (progn
13384 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13385 (rmail-show-message message-number)
13386 message-number)
13387 (error "Message not found"))))
13389 ;;; mh-e integration based on planner-mode
13390 (defun org-mhe-get-message-real-folder ()
13391 "Return the name of the current message real folder, so if you use
13392 sequences, it will now work."
13393 (save-excursion
13394 (let* ((folder
13395 (if (equal major-mode 'mh-folder-mode)
13396 mh-current-folder
13397 ;; Refer to the show buffer
13398 mh-show-folder-buffer))
13399 (end-index
13400 (if (boundp 'mh-index-folder)
13401 (min (length mh-index-folder) (length folder))))
13402 )
13403 ;; a simple test on mh-index-data does not work, because
13404 ;; mh-index-data is always nil in a show buffer.
13405 (if (and (boundp 'mh-index-folder)
13406 (string= mh-index-folder (substring folder 0 end-index)))
13407 (if (equal major-mode 'mh-show-mode)
13408 (save-window-excursion
13409 (let (pop-up-frames)
13410 (when (buffer-live-p (get-buffer folder))
13411 (progn
13412 (pop-to-buffer folder)
13413 (org-mhe-get-message-folder-from-index)
13414 )
13415 )))
13416 (org-mhe-get-message-folder-from-index)
13417 )
13418 folder
13419 )
13420 )))
13422 (defun org-mhe-get-message-folder-from-index ()
13423 "Returns the name of the message folder in a index folder buffer."
13424 (save-excursion
13425 (mh-index-previous-folder)
13427 (message "%s" (match-string 1))))
13429 (defun org-mhe-get-message-folder ()
13430 "Return the name of the current message folder. Be careful if you
13431 use sequences."
13432 (save-excursion
13433 (if (equal major-mode 'mh-folder-mode)
13434 mh-current-folder
13435 ;; Refer to the show buffer
13436 mh-show-folder-buffer)))
13438 (defun org-mhe-get-message-num ()
13439 "Return the number of the current message. Be careful if you
13440 use sequences."
13441 (save-excursion
13442 (if (equal major-mode 'mh-folder-mode)
13443 (mh-get-msg-num nil)
13444 ;; Refer to the show buffer
13445 (mh-show-buffer-message-number))))
13447 (defun org-mhe-get-header (header)
13448 "Return a header of the message in folder mode. This will create a
13449 show buffer for the corresponding message. If you have a more clever
13450 idea..."
13451 (let* ((folder (org-mhe-get-message-folder))
13452 (num (org-mhe-get-message-num))
13453 (buffer (get-buffer-create (concat "show-" folder)))
13454 (header-field))
13455 (with-current-buffer buffer
13456 (mh-display-msg num folder)
13457 (if (equal major-mode 'mh-folder-mode)
13458 (mh-header-display)
13459 (mh-show-header-display))
13460 (set-buffer buffer)
13461 (setq header-field (mh-get-header-field header))
13462 (if (equal major-mode 'mh-folder-mode)
13463 (mh-show)
13464 (mh-show-show))
13465 header-field)))
13467 (defun org-follow-mhe-link (folder article)
13468 "Follow an MHE link to FOLDER and ARTICLE.
13469 If ARTICLE is nil FOLDER is shown. If the configuration variable
13470 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13471 ARTICLE is searched in all folders. Indexed searches (swish++,
13472 namazu, and others supported by MH-E) will always search in all
13473 folders."
13474 (require 'mh-e)
13475 (require 'mh-search)
13476 (require 'mh-utils)
13477 (mh-find-path)
13478 (if (not article)
13479 (mh-visit-folder (mh-normalize-folder-name folder))
13480 (setq article (org-add-angle-brackets article))
13481 (mh-search-choose)
13482 (if (equal mh-searcher 'pick)
13483 (progn
13484 (mh-search folder (list "--message-id" article))
13485 (when (and org-mhe-search-all-folders
13486 (not (org-mhe-get-message-real-folder)))
13487 (kill-this-buffer)
13488 (mh-search "+" (list "--message-id" article))))
13489 (mh-search "+" article))
13490 (if (org-mhe-get-message-real-folder)
13491 (mh-show-msg 1)
13492 (kill-this-buffer)
13493 (error "Message not found"))))
13495 ;;; BibTeX links
13497 ;; Use the custom search meachnism to construct and use search strings for
13498 ;; file links to BibTeX database entries.
13500 (defun org-create-file-search-in-bibtex ()
13501 "Create the search string and description for a BibTeX database entry."
13502 (when (eq major-mode 'bibtex-mode)
13503 ;; yes, we want to construct this search string.
13504 ;; Make a good description for this entry, using names, year and the title
13505 ;; Put it into the `description' variable which is dynamically scoped.
13506 (let ((bibtex-autokey-names 1)
13507 (bibtex-autokey-names-stretch 1)
13508 (bibtex-autokey-name-case-convert-function 'identity)
13509 (bibtex-autokey-name-separator " & ")
13510 (bibtex-autokey-additional-names " et al.")
13511 (bibtex-autokey-year-length 4)
13512 (bibtex-autokey-name-year-separator " ")
13513 (bibtex-autokey-titlewords 3)
13514 (bibtex-autokey-titleword-separator " ")
13515 (bibtex-autokey-titleword-case-convert-function 'identity)
13516 (bibtex-autokey-titleword-length 'infty)
13517 (bibtex-autokey-year-title-separator ": "))
13518 (setq description (bibtex-generate-autokey)))
13519 ;; Now parse the entry, get the key and return it.
13520 (save-excursion
13521 (bibtex-beginning-of-entry)
13522 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13524 (defun org-execute-file-search-in-bibtex (s)
13525 "Find the link search string S as a key for a database entry."
13526 (when (eq major-mode 'bibtex-mode)
13527 ;; Yes, we want to do the search in this file.
13528 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13529 (goto-char (point-min))
13532 (goto-char (match-beginning 0)))
13533 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13534 ;; Use double prefix to indicate that any web link should be browsed
13535 (let ((b (current-buffer)) (p (point)))
13536 ;; Restore the window configuration because we just use the web link
13537 (set-window-configuration org-window-config-before-follow-link)
13538 (save-excursion (set-buffer b) (goto-char p)
13539 (bibtex-url)))
13540 (recenter 0)) ; Move entry start to beginning of window
13541 ;; return t to indicate that the search is done.
13542 t))
13544 ;; Finally add the functions to the right hooks.
13545 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13546 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13548 ;; end of Bibtex link setup
13550 ;;; Following file links
13552 (defun org-open-file (path &optional in-emacs line search)
13553 "Open the file at PATH.
13554 First, this expands any special file name abbreviations. Then the
13555 configuration variable `org-file-apps' is checked if it contains an
13556 entry for this file type, and if yes, the corresponding command is launched.
13557 If no application is found, Emacs simply visits the file.
13558 With optional argument IN-EMACS, Emacs will visit the file.
13559 Optional LINE specifies a line to go to, optional SEARCH a string to
13560 search for. If LINE or SEARCH is given, the file will always be
13561 opened in Emacs.
13562 If the file does not exist, an error is thrown."
13563 (setq in-emacs (or in-emacs line search))
13564 (let* ((file (if (equal path "")
13565 buffer-file-name
13566 (substitute-in-file-name (expand-file-name path))))
13567 (apps (append org-file-apps (org-default-apps)))
13568 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13569 (dirp (if remp nil (file-directory-p file)))
13570 (dfile (downcase file))
13571 (old-buffer (current-buffer))
13572 (old-pos (point))
13573 (old-mode major-mode)
13574 ext cmd)
13576 (setq ext (match-string 1 dfile))
13578 (setq ext (match-string 1 dfile))))
13579 (if in-emacs
13580 (setq cmd 'emacs)
13581 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13582 (and dirp (cdr (assoc 'directory apps)))
13583 (cdr (assoc ext apps))
13584 (cdr (assoc t apps)))))
13585 (when (eq cmd 'mailcap)
13586 (require 'mailcap)
13587 (mailcap-parse-mailcaps)
13588 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13589 (command (mailcap-mime-info mime-type)))
13590 (if (stringp command)
13591 (setq cmd command)
13592 (setq cmd 'emacs))))
13593 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13594 (not (file-exists-p file))
13595 (not org-open-non-existing-files))
13596 (error "No such file: %s" file))
13597 (cond
13599 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13601 (setq cmd (replace-match "%s" t t cmd)))
13602 (while (string-match "%s" cmd)
13603 (setq cmd (replace-match
13604 (save-match-data (shell-quote-argument file))
13605 t t cmd)))
13606 (save-window-excursion
13607 (start-process-shell-command cmd nil cmd)))
13608 ((or (stringp cmd)
13609 (eq cmd 'emacs))
13610 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13611 (widen)
13612 (if line (goto-line line)
13613 (if search (org-link-search search))))
13614 ((consp cmd)
13615 (eval cmd))
13616 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13617 (and (org-mode-p) (eq old-mode 'org-mode)
13618 (or (not (equal old-buffer (current-buffer)))
13619 (not (equal old-pos (point))))
13620 (org-mark-ring-push old-pos old-buffer))))
13622 (defun org-default-apps ()
13623 "Return the default applications for this operating system."
13624 (cond
13625 ((eq system-type 'darwin)
13626 org-file-apps-defaults-macosx)
13627 ((eq system-type 'windows-nt)
13628 org-file-apps-defaults-windowsnt)
13629 (t org-file-apps-defaults-gnu)))
13631 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13632 (defun org-file-remote-p (file)
13633 "Test whether FILE specifies a location on a remote system.
13634 Return non-nil if the location is indeed remote.
13638 (cond ((fboundp 'file-remote-p)
13639 (file-remote-p file))
13640 ((fboundp 'tramp-handle-file-remote-p)
13641 (tramp-handle-file-remote-p file))
13642 ((and (boundp 'ange-ftp-name-format)
13643 (string-match (car ange-ftp-name-format) file))
13644 t)
13645 (t nil)))
13648 ;;;; Hooks for remember.el, and refiling
13650 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13651 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13653 ;;;###autoload
13654 (defun org-remember-insinuate ()
13655 "Setup remember.el for use wiht Org-mode."
13656 (require 'remember)
13657 (setq remember-annotation-functions '(org-remember-annotation))
13658 (setq remember-handler-functions '(org-remember-handler))
13659 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13661 ;;;###autoload
13662 (defun org-remember-annotation ()
13663 "Return a link to the current location as an annotation for remember.el.
13664 If you are using Org-mode files as target for data storage with
13665 remember.el, then the annotations should include a link compatible with the
13666 conventions in Org-mode. This function returns such a link."
13667 (org-store-link nil))
13669 (defconst org-remember-help
13670 "Select a destination location for the note.
13671 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13672 RET on headline -> Store as sublevel entry to current headline
13673 RET at beg-of-buf -> Append to file as level 2 headline
13674 <left>/<right> -> before/after current headline, same headings level")
13676 (defvar org-remember-previous-location nil)
13677 (defvar org-force-remember-template-char) ;; dynamically scoped
13679 ;; Save the major mode of the buffer we called remember from
13680 (defvar org-select-template-temp-major-mode nil)
13682 ;; Temporary store the buffer where remember was called from
13683 (defvar org-select-template-original-buffer nil)
13685 (defun org-select-remember-template (&optional use-char)
13686 (when org-remember-templates
13687 (let* ((pre-selected-templates
13688 (mapcar
13689 (lambda (tpl)
13690 (let ((ctxt (nth 5 tpl))
13691 (mode org-select-template-temp-major-mode)
13692 (buf org-select-template-original-buffer))
13693 (if (or (and (functionp ctxt)
13694 (save-excursion
13695 (set-buffer buf)
13696 ;; Protect the user-defined function from error
13697 (condition-case nil (funcall ctxt) (error nil))))
13698 (and ctxt (listp ctxt)
13699 (delq nil (mapcar (lambda(x) (eq mode x)) ctxt))))
13700 tpl)))
13701 org-remember-templates))
13702 ;; If no template at this point, add the default templates:
13703 (pre-selected-templates1
13704 (if (not (delq nil pre-selected-templates))
13705 (mapcar (lambda(x) (if (not (nth 5 x)) x))
13706 org-remember-templates)
13707 pre-selected-templates))
13708 ;; Then unconditionnally add template for any contexts
13709 (pre-selected-templates2
13710 (append (mapcar (lambda(x) (if (eq (nth 5 x) t) x))
13711 org-remember-templates)
13712 (delq nil pre-selected-templates1)))
13713 (templates (mapcar (lambda (x)
13714 (if (stringp (car x))
13715 (append (list (nth 1 x) (car x)) (cddr x))
13716 (append (list (car x) "") (cdr x))))
13717 (delq nil pre-selected-templates2)))
13718 (char (or use-char
13719 (cond
13720 ((= (length templates) 1)
13721 (caar templates))
13722 ((and (boundp 'org-force-remember-template-char)
13723 org-force-remember-template-char)
13724 (if (stringp org-force-remember-template-char)
13725 (string-to-char org-force-remember-template-char)
13726 org-force-remember-template-char))
13727 (t
13728 (message "Select template: %s"
13729 (mapconcat
13730 (lambda (x)
13731 (cond
13733 (format "[%c]" (car x)))
13734 ((equal (downcase (car x))
13735 (downcase (aref (nth 1 x) 0)))
13736 (format "[%c]%s" (car x)
13737 (substring (nth 1 x) 1)))
13738 (t (format "[%c]%s" (car x) (nth 1 x)))))
13739 templates " "))
13740 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13741 (when (equal char0 ?\C-g)
13742 (jump-to-register remember-register)
13743 (kill-buffer remember-buffer))
13744 char0))))))
13745 (cddr (assoc char templates)))))
13747 (defvar x-last-selected-text)
13748 (defvar x-last-selected-text-primary)
13750 ;;;###autoload
13751 (defun org-remember-apply-template (&optional use-char skip-interactive)
13752 "Initialize *remember* buffer with template, invoke `org-mode'.
13753 This function should be placed into `remember-mode-hook' and in fact requires
13754 to be run from that hook to function properly."
13755 (if org-remember-templates
13756 (let* ((entry (org-select-remember-template use-char))
13757 (tpl (car entry))
13758 (plist-p (if org-store-link-plist t nil))
13759 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13761 (nth 1 entry)
13762 org-default-notes-file))
13763 (headline (nth 2 entry))
13764 (v-c (or (and (eq window-system 'x)
13765 (fboundp 'x-cut-buffer-or-selection-value)
13766 (x-cut-buffer-or-selection-value))
13767 (org-bound-and-true-p x-last-selected-text)
13768 (org-bound-and-true-p x-last-selected-text-primary)
13769 (and (> (length kill-ring) 0) (current-kill 0))))
13770 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13771 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13772 (v-u (concat "[" (substring v-t 1 -1) "]"))
13773 (v-U (concat "[" (substring v-T 1 -1) "]"))
13774 ;; `initial' and `annotation' are bound in `remember'
13775 (v-i (if (boundp 'initial) initial))
13776 (v-a (if (and (boundp 'annotation) annotation)
13777 (if (equal annotation "[[]]") "" annotation)
13778 ""))
13779 (v-A (if (and v-a
13782 v-a))
13783 (v-n user-full-name)
13784 (org-startup-folded nil)
13785 org-time-was-given org-end-time-was-given x
13786 prompt completions char time pos default histvar)
13787 (setq org-store-link-plist
13788 (append (list :annotation v-a :initial v-i)
13789 org-store-link-plist))
13790 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13791 (erase-buffer)
13792 (insert (substitute-command-keys
13793 (format
13794 "## Filing location: Select interactively, default, or last used:
13795 ## %s to select file and header location interactively.
13799 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13800 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13801 (abbreviate-file-name (or file org-default-notes-file))
13802 (or headline "")
13803 (or (car org-remember-previous-location) "???")
13804 (or (cdr org-remember-previous-location) "???"))))
13805 (insert tpl) (goto-char (point-min))
13806 ;; Simple %-escapes
13808 (when (and initial (equal (match-string 0) "%i"))
13809 (save-match-data
13810 (let* ((lead (buffer-substring
13811 (point-at-bol) (match-beginning 0))))
13812 (setq v-i (mapconcat 'identity
13815 (replace-match
13816 (or (eval (intern (concat "v-" (match-string 1)))) "")
13817 t t))
13819 ;; %[] Insert contents of a file.
13820 (goto-char (point-min))
13822 (let ((start (match-beginning 0))
13823 (end (match-end 0))
13824 (filename (expand-file-name (match-string 1))))
13825 (goto-char start)
13826 (delete-region start end)
13827 (condition-case error
13828 (insert-file-contents filename)
13829 (error (insert (format "%%![Couldn't insert %s: %s]"
13830 filename error))))))
13831 ;; %() embedded elisp
13832 (goto-char (point-min))
13834 (goto-char (match-beginning 0))
13835 (let ((template-start (point)))
13836 (forward-char 1)
13837 (let ((result
13838 (condition-case error
13839 (eval (read (current-buffer)))
13840 (error (format "%%![Error: %s]" error)))))
13841 (delete-region template-start (point))
13842 (insert result))))
13844 ;; From the property list
13845 (when plist-p
13846 (goto-char (point-min))
13848 (and (setq x (or (plist-get org-store-link-plist
13849 (intern (match-string 1))) ""))
13850 (replace-match x t t))))
13852 ;; Turn on org-mode in the remember buffer, set local variables
13853 (org-mode)
13854 (org-set-local 'org-finish-function 'org-remember-finalize)
13856 (org-set-local 'org-default-notes-file file))
13858 (org-set-local 'org-remember-default-headline headline))
13859 ;; Interactive template entries
13860 (goto-char (point-min))
13862 (setq char (if (match-end 3) (match-string 3))
13863 prompt (if (match-end 2) (match-string 2)))
13864 (goto-char (match-beginning 0))
13865 (replace-match "")
13866 (setq completions nil default nil)
13867 (when prompt
13868 (setq completions (org-split-string prompt "|")
13869 prompt (pop completions)
13870 default (car completions)
13871 histvar (intern (concat
13872 "org-remember-template-prompt-history::"
13873 (or prompt "")))
13874 completions (mapcar 'list completions)))
13875 (cond
13876 ((member char '("G" "g"))
13877 (let* ((org-last-tags-completion-table
13878 (org-global-tags-completion-table
13879 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13880 (org-add-colon-after-tag-completion t)
13881 (ins (completing-read
13882 (if prompt (concat prompt ": ") "Tags: ")
13883 'org-tags-completion-function nil nil nil
13884 'org-tags-history)))
13885 (setq ins (mapconcat 'identity
13886 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13887 ":"))
13889 (or (equal (char-before) ?:) (insert ":"))
13890 (insert ins)
13891 (or (equal (char-after) ?:) (insert ":")))))
13892 (char
13893 (setq org-time-was-given (equal (upcase char) char))
13894 (setq time (org-read-date (equal (upcase char) "U") t nil
13895 prompt))
13896 (org-insert-time-stamp time org-time-was-given
13897 (member char '("u" "U"))
13898 nil nil (list org-end-time-was-given)))
13899 (t
13900 (insert (org-completing-read
13901 (concat (if prompt prompt "Enter string")
13902 (if default (concat " [" default "]"))
13903 ": ")
13904 completions nil nil nil histvar default)))))
13905 (goto-char (point-min))
13907 (replace-match "")
13909 (org-mode)
13910 (org-set-local 'org-finish-function 'org-remember-finalize))
13911 (when (save-excursion
13912 (goto-char (point-min))
13913 (re-search-forward "%!" nil t))
13914 (replace-match "")
13915 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13917 (defun org-remember-finish-immediately ()
13918 "File remember note immediately.
13919 This should be run in `post-command-hook' and will remove itself
13920 from that hook."
13921 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13922 (when org-finish-function
13923 (funcall org-finish-function)))
13925 (defvar org-clock-marker) ; Defined below
13926 (defun org-remember-finalize ()
13927 "Finalize the remember process."
13928 (unless (fboundp 'remember-finalize)
13929 (defalias 'remember-finalize 'remember-buffer))
13930 (when (and org-clock-marker
13931 (equal (marker-buffer org-clock-marker) (current-buffer)))
13932 ;; FIXME: test this, this is w/o notetaking!
13933 (let (org-log-note-clock-out) (org-clock-out)))
13934 (when buffer-file-name
13935 (save-buffer)
13936 (setq buffer-file-name nil))
13937 (remember-finalize))
13939 ;;;###autoload
13940 (defun org-remember (&optional goto org-force-remember-template-char)
13941 "Call `remember'. If this is already a remember buffer, re-apply template.
13942 If there is an active region, make sure remember uses it as initial content
13943 of the remember buffer.
13945 When called interactively with a `C-u' prefix argument GOTO, don't remember
13946 anything, just go to the file/headline where the selected template usually
13947 stores its notes. With a double prefix arg `C-u C-u', go to the last
13948 note stored by remember.
13950 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13951 associated with a template in `org-remember-templates'."
13952 (interactive "P")
13953 (cond
13954 ((equal goto '(4)) (org-go-to-remember-target))
13955 ((equal goto '(16)) (org-remember-goto-last-stored))
13956 (t
13957 ;; set temporary variables that will be needed in
13958 ;; `org-select-remember-template'
13959 (setq org-select-template-temp-major-mode major-mode)
13960 (setq org-select-template-original-buffer (current-buffer))
13961 (if (memq org-finish-function '(remember-buffer remember-finalize))
13962 (progn
13963 (when (< (length org-remember-templates) 2)
13964 (error "No other template available"))
13965 (erase-buffer)
13966 (let ((annotation (plist-get org-store-link-plist :annotation))
13967 (initial (plist-get org-store-link-plist :initial)))
13968 (org-remember-apply-template))
13969 (message "Press C-c C-c to remember data"))
13970 (if (org-region-active-p)
13971 (remember (buffer-substring (point) (mark)))
13972 (call-interactively 'remember))))))
13974 (defun org-remember-goto-last-stored ()
13975 "Go to the location where the last remember note was stored."
13976 (interactive)
13977 (bookmark-jump "org-remember-last-stored")
13978 (message "This is the last note stored by remember"))
13980 (defun org-go-to-remember-target (&optional template-key)
13981 "Go to the target location of a remember template.
13982 The user is queried for the template."
13983 (interactive)
13984 (let* (org-select-template-temp-major-mode
13985 (entry (org-select-remember-template template-key))
13986 (file (nth 1 entry))
13987 (heading (nth 2 entry))
13988 visiting)
13990 (setq file org-default-notes-file))
13992 (setq heading org-remember-default-headline))
13993 (setq visiting (org-find-base-buffer-visiting file))
13994 (if (not visiting) (find-file-noselect file))
13995 (switch-to-buffer (or visiting (get-file-buffer file)))
13996 (widen)
13997 (goto-char (point-min))
13998 (if (re-search-forward
14001 nil t)
14002 (goto-char (match-beginning 0))
14003 (error "Target headline not found: %s" heading))))
14005 (defvar org-note-abort nil) ; dynamically scoped
14007 ;;;###autoload
14008 (defun org-remember-handler ()
14009 "Store stuff from remember.el into an org file.
14010 First prompts for an org file. If the user just presses return, the value
14011 of `org-default-notes-file' is used.
14012 Then the command offers the headings tree of the selected file in order to
14013 file the text at a specific location.
14014 You can either immediately press RET to get the note appended to the
14015 file, or you can use vertical cursor motion and visibility cycling (TAB) to
14016 find a better place. Then press RET or <left> or <right> in insert the note.
14018 Key Cursor position Note gets inserted
14019 -----------------------------------------------------------------------------
14020 RET buffer-start as level 1 heading at end of file
14021 RET on headline as sublevel of the heading at cursor
14022 RET no heading at cursor position, level taken from context.
14023 Or use prefix arg to specify level manually.
14024 <left> on headline as same level, before current heading
14025 <right> on headline as same level, after current heading
14027 So the fastest way to store the note is to press RET RET to append it to
14028 the default file. This way your current train of thought is not
14029 interrupted, in accordance with the principles of remember.el.
14030 You can also get the fast execution without prompting by using
14031 C-u C-c C-c to exit the remember buffer. See also the variable
14032 `org-remember-store-without-prompt'.
14034 Before being stored away, the function ensures that the text has a
14036 is constructed from the current date and some additional data.
14038 If the variable `org-adapt-indentation' is non-nil, the entire text is
14039 also indented so that it starts in the same column as the headline
14040 \(i.e. after the stars).
14042 See also the variable `org-reverse-note-order'."
14043 (goto-char (point-min))
14045 (replace-match ""))
14046 (goto-char (point-max))
14047 (beginning-of-line 1)
14049 (delete-region (1- (point)) (point-max))
14050 (beginning-of-line 1))
14051 (catch 'quit
14052 (if org-note-abort (throw 'quit nil))
14053 (let* ((txt (buffer-substring (point-min) (point-max)))
14054 (fastp (org-xor (equal current-prefix-arg '(4))
14055 org-remember-store-without-prompt))
14056 (file (cond
14057 (fastp org-default-notes-file)
14058 ((and (eq org-remember-interactive-interface 'refile)
14059 org-refile-targets)
14060 org-default-notes-file)
14061 ((not (and (equal current-prefix-arg '(16))
14062 org-remember-previous-location))
14063 (org-get-org-file))))
14064 (heading org-remember-default-headline)
14065 (visiting (and file (org-find-base-buffer-visiting file)))
14066 (org-startup-folded nil)
14067 (org-startup-align-all-tables nil)
14068 (org-goto-start-pos 1)
14069 spos exitcmd level indent reversed)
14070 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
14071 (setq file (car org-remember-previous-location)
14072 heading (cdr org-remember-previous-location)
14073 fastp t))
14074 (setq current-prefix-arg nil)
14076 (setq txt (replace-match "" t t txt)))
14077 ;; Modify text so that it becomes a nice subtree which can be inserted
14078 ;; into an org tree.
14080 first)
14081 (setq first (car lines) lines (cdr lines))
14083 ;; Is already a headline
14084 (setq indent nil)
14085 ;; We need to add a headline: Use time and first buffer line
14086 (setq lines (cons first lines)
14087 first (concat "* " (current-time-string)
14088 " (" (remember-buffer-desc) ")")
14089 indent " "))
14090 (if (and org-adapt-indentation indent)
14091 (setq lines (mapcar
14092 (lambda (x)
14094 (concat indent x) x))
14095 lines)))
14102 ;; Put the modified text back into the remember buffer, for refile.
14103 (erase-buffer)
14104 (insert txt)
14105 (goto-char (point-min))
14106 (when (and (eq org-remember-interactive-interface 'refile)
14107 (not fastp))
14108 (org-refile nil (or visiting (find-file-noselect file)))
14109 (throw 'quit t))
14110 ;; Find the file
14111 (if (not visiting) (find-file-noselect file))
14112 (with-current-buffer (or visiting (get-file-buffer file))
14113 (unless (org-mode-p)
14114 (error "Target files for remember notes must be in Org-mode"))
14115 (save-excursion
14116 (save-restriction
14117 (widen)
14118 (and (goto-char (point-min))
14121 (setq reversed (org-notes-order-reversed-p))
14123 ;; Find the default location
14125 (goto-char (point-min))
14126 (if (re-search-forward
14129 nil t)
14130 (setq org-goto-start-pos (match-beginning 0))
14131 (when fastp
14132 (goto-char (point-max))
14133 (unless (bolp) (newline))
14135 (setq org-goto-start-pos (point-at-bol 0)))))
14137 ;; Ask the User for a location, using the appropriate interface
14138 (cond
14139 (fastp (setq spos org-goto-start-pos
14140 exitcmd 'return))
14141 ((eq org-remember-interactive-interface 'outline)
14142 (setq spos (org-get-location (current-buffer)
14143 org-remember-help)
14144 exitcmd (cdr spos)
14145 spos (car spos)))
14146 ((eq org-remember-interactive-interface 'outline-path-completion)
14147 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
14148 (org-refile-use-outline-path t))
14149 (setq spos (org-refile-get-location "Heading: ")
14150 exitcmd 'return
14151 spos (nth 3 spos))))
14152 (t (error "this should not hapen")))
14153 (if (not spos) (throw 'quit nil)) ; return nil to show we did
14154 ; not handle this note
14155 (goto-char spos)
14156 (cond ((org-on-heading-p t)
14157 (org-back-to-heading t)
14158 (setq level (funcall outline-level))
14159 (cond
14160 ((eq exitcmd 'return)
14161 ;; sublevel of current
14162 (setq org-remember-previous-location
14163 (cons (abbreviate-file-name file)
14164 (org-get-heading 'notags)))
14165 (if reversed
14166 (outline-next-heading)
14167 (org-end-of-subtree t)
14168 (if (not (bolp))
14170 (beginning-of-line 2)
14171 (end-of-line 1)
14173 (bookmark-set "org-remember-last-stored")
14174 (org-paste-subtree (org-get-valid-level level 1) txt))
14175 ((eq exitcmd 'left)
14176 ;; before current
14177 (bookmark-set "org-remember-last-stored")
14178 (org-paste-subtree level txt))
14179 ((eq exitcmd 'right)
14180 ;; after current
14181 (org-end-of-subtree t)
14182 (bookmark-set "org-remember-last-stored")
14183 (org-paste-subtree level txt))
14184 (t (error "This should not happen"))))
14186 ((and (bobp) (not reversed))
14187 ;; Put it at the end, one level below level 1
14188 (save-restriction
14189 (widen)
14190 (goto-char (point-max))
14191 (if (not (bolp)) (newline))
14192 (bookmark-set "org-remember-last-stored")
14193 (org-paste-subtree (org-get-valid-level 1 1) txt)))
14195 ((and (bobp) reversed)
14196 ;; Put it at the start, as level 1
14197 (save-restriction
14198 (widen)
14199 (goto-char (point-min))
14201 (beginning-of-line 1)
14202 (bookmark-set "org-remember-last-stored")
14203 (org-paste-subtree 1 txt)))
14204 (t
14205 ;; Put it right there, with automatic level determined by
14206 ;; org-paste-subtree or from prefix arg
14207 (bookmark-set "org-remember-last-stored")
14208 (org-paste-subtree
14209 (if (numberp current-prefix-arg) current-prefix-arg)
14210 txt)))
14211 (when remember-save-after-remembering
14212 (save-buffer)
14213 (if (not visiting) (kill-buffer (current-buffer)))))))))
14215 t) ;; return t to indicate that we took care of this note.
14217 (defun org-get-org-file ()
14218 "Read a filename, with default directory `org-directory'."
14219 (let ((default (or org-default-notes-file remember-data-file)))
14220 (read-file-name (format "File name [%s]: " default)
14221 (file-name-as-directory org-directory)
14222 default)))
14224 (defun org-notes-order-reversed-p ()
14225 "Check if the current file should receive notes in reversed order."
14226 (cond
14227 ((not org-reverse-note-order) nil)
14228 ((eq t org-reverse-note-order) t)
14229 ((not (listp org-reverse-note-order)) nil)
14230 (t (catch 'exit
14231 (let ((all org-reverse-note-order)
14232 entry)
14233 (while (setq entry (pop all))
14234 (if (string-match (car entry) buffer-file-name)
14235 (throw 'exit (cdr entry))))
14236 nil)))))
14238 ;;; Refiling
14240 (defvar org-refile-target-table nil
14241 "The list of refile targets, created by `org-refile'.")
14243 (defvar org-agenda-new-buffers nil
14244 "Buffers created to visit agenda files.")
14246 (defun org-get-refile-targets (&optional default-buffer)
14247 "Produce a table with refile targets."
14248 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
14249 targets txt re files f desc descre)
14250 (with-current-buffer (or default-buffer (current-buffer))
14251 (while (setq entry (pop entries))
14252 (setq files (car entry) desc (cdr entry))
14253 (cond
14254 ((null files) (setq files (list (current-buffer))))
14255 ((eq files 'org-agenda-files)
14256 (setq files (org-agenda-files 'unrestricted)))
14257 ((and (symbolp files) (fboundp files))
14258 (setq files (funcall files)))
14259 ((and (symbolp files) (boundp files))
14260 (setq files (symbol-value files))))
14261 (if (stringp files) (setq files (list files)))
14262 (cond
14263 ((eq (car desc) :tag)
14265 ((eq (car desc) :todo)
14267 ((eq (car desc) :regexp)
14268 (setq descre (cdr desc)))
14269 ((eq (car desc) :level)
14271 (if org-odd-levels-only
14272 (1- (* 2 (cdr desc)))
14273 (cdr desc)))
14275 ((eq (car desc) :maxlevel)
14277 (if org-odd-levels-only
14278 (1- (* 2 (cdr desc)))
14279 (cdr desc)))
14281 (t (error "Bad refiling target description %s" desc)))
14282 (while (setq f (pop files))
14283 (save-excursion
14284 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14285 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14286 (save-excursion
14287 (save-restriction
14288 (widen)
14289 (goto-char (point-min))
14290 (while (re-search-forward descre nil t)
14291 (goto-char (point-at-bol))
14292 (when (looking-at org-complex-heading-regexp)
14293 (setq txt (match-string 4)
14294 re (concat "^" (regexp-quote
14295 (buffer-substring (match-beginning 1)
14296 (match-end 4)))))
14298 (regexp-quote
14299 (match-string 5)))))
14301 (when org-refile-use-outline-path
14302 (setq txt (mapconcat 'identity
14303 (append
14304 (if (eq org-refile-use-outline-path 'file)
14305 (list (file-name-nondirectory
14306 (buffer-file-name (buffer-base-buffer))))
14307 (if (eq org-refile-use-outline-path 'full-file-path)
14308 (list (buffer-file-name (buffer-base-buffer)))))
14309 (org-get-outline-path)
14310 (list txt))
14311 "/")))
14312 (push (list txt f re (point)) targets))
14313 (goto-char (point-at-eol))))))))
14314 (nreverse targets))))
14316 (defun org-get-outline-path ()
14317 "Return the outline path to the current entry, as a list."
14318 (let (rtn)
14319 (save-excursion
14320 (while (org-up-heading-safe)
14321 (when (looking-at org-complex-heading-regexp)
14322 (push (org-match-string-no-properties 4) rtn)))
14323 rtn)))
14325 (defvar org-refile-history nil
14326 "History for refiling operations.")
14328 (defun org-refile (&optional goto default-buffer)
14329 "Move the entry at point to another heading.
14330 The list of target headings is compiled using the information in
14331 `org-refile-targets', which see. This list is created upon first use, and
14332 you can update it by calling this command with a double prefix (`C-u C-u').
14333 FIXME: Can we find a better way of updating?
14335 At the target location, the entry is filed as a subitem of the target heading.
14336 Depending on `org-reverse-note-order', the new subitem will either be the
14337 first of the last subitem.
14339 With prefix arg GOTO, the command will only visit the target location,
14340 not actually move anything.
14341 With a double prefix `C-c C-c', go to the location where the last refiling
14342 operation has put the subtree.
14344 With a double prefix argument, the command can be used to jump to any
14345 heading in the current buffer."
14346 (interactive "P")
14347 (let* ((cbuf (current-buffer))
14348 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14349 pos it nbuf file re level reversed)
14350 (if (equal goto '(16))
14351 (org-refile-goto-last-stored)
14352 (when (setq it (org-refile-get-location
14353 (if goto "Goto: " "Refile to: ") default-buffer))
14354 (setq file (nth 1 it)
14355 re (nth 2 it)
14356 pos (nth 3 it))
14357 (setq nbuf (or (find-buffer-visiting file)
14358 (find-file-noselect file)))
14359 (if goto
14360 (progn
14361 (switch-to-buffer nbuf)
14362 (goto-char pos)
14363 (org-show-context 'org-goto))
14364 (org-copy-special)
14365 (save-excursion
14366 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14367 (find-file-noselect file))))
14368 (setq reversed (org-notes-order-reversed-p))
14369 (save-excursion
14370 (save-restriction
14371 (widen)
14372 (goto-char pos)
14373 (looking-at outline-regexp)
14374 (setq level (org-get-valid-level (funcall outline-level) 1))
14375 (goto-char
14376 (if reversed
14377 (outline-next-heading)
14378 (or (save-excursion (outline-get-next-sibling))
14379 (org-end-of-subtree t t)
14380 (point-max))))
14381 (bookmark-set "org-refile-last-stored")
14382 (org-paste-subtree level))))
14383 (org-cut-special)
14386 (defun org-refile-goto-last-stored ()
14387 "Go to the location where the last refile was stored."
14388 (interactive)
14389 (bookmark-jump "org-refile-last-stored")
14390 (message "This is the location of the last refile"))
14392 (defun org-refile-get-location (&optional prompt default-buffer)
14393 "Prompt the user for a refile location, using PROMPT."
14394 (let ((org-refile-targets org-refile-targets)
14395 (org-refile-use-outline-path org-refile-use-outline-path))
14396 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14397 (unless org-refile-target-table
14398 (error "No refile targets"))
14399 (let* ((cbuf (current-buffer))
14400 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14401 (fname (and filename (file-truename filename)))
14402 (tbl (mapcar
14403 (lambda (x)
14404 (if (not (equal fname (file-truename (nth 1 x))))
14405 (cons (concat (car x) " (" (file-name-nondirectory
14406 (nth 1 x)) ")")
14407 (cdr x))
14408 x))
14409 org-refile-target-table))
14410 (completion-ignore-case t))
14411 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14412 tbl)))
14414 ;;;; Dynamic blocks
14416 (defun org-find-dblock (name)
14417 "Find the first dynamic block with name NAME in the buffer.
14418 If not found, stay at current position and return nil."
14419 (let (pos)
14420 (save-excursion
14421 (goto-char (point-min))
14423 nil t)
14424 (match-beginning 0))))
14425 (if pos (goto-char pos))
14426 pos))
14428 (defconst org-dblock-start-re
14430 "Matches the startline of a dynamic block, with parameters.")
14433 "Matches the end of a dyhamic block.")
14435 (defun org-create-dblock (plist)
14436 "Create a dynamic block section, with parameters taken from PLIST.
14437 PLIST must containe a :name entry which is used as name of the block."
14438 (unless (bolp) (newline))
14439 (let ((name (plist-get plist :name)))
14440 (insert "#+BEGIN: " name)
14441 (while plist
14442 (if (eq (car plist) :name)
14443 (setq plist (cddr plist))
14444 (insert " " (prin1-to-string (pop plist)))))
14446 (beginning-of-line -2)))
14448 (defun org-prepare-dblock ()
14449 "Prepare dynamic block for refresh.
14450 This empties the block, puts the cursor at the insert position and returns
14451 the property list including an extra property :name with the block name."
14452 (unless (looking-at org-dblock-start-re)
14453 (error "Not at a dynamic block"))
14454 (let* ((begdel (1+ (match-end 0)))
14455 (name (org-no-properties (match-string 1)))
14456 (params (append (list :name name)
14457 (read (concat "(" (match-string 3) ")")))))
14458 (unless (re-search-forward org-dblock-end-re nil t)
14459 (error "Dynamic block not terminated"))
14460 (delete-region begdel (match-beginning 0))
14461 (goto-char begdel)
14462 (open-line 1)
14463 params))
14465 (defun org-map-dblocks (&optional command)
14466 "Apply COMMAND to all dynamic blocks in the current buffer.
14467 If COMMAND is not given, use `org-update-dblock'."
14468 (let ((cmd (or command 'org-update-dblock))
14469 pos)
14470 (save-excursion
14471 (goto-char (point-min))
14472 (while (re-search-forward org-dblock-start-re nil t)
14473 (goto-char (setq pos (match-beginning 0)))
14474 (condition-case nil
14475 (funcall cmd)
14476 (error (message "Error during update of dynamic block")))
14477 (goto-char pos)
14478 (unless (re-search-forward org-dblock-end-re nil t)
14479 (error "Dynamic block not terminated"))))))
14481 (defun org-dblock-update (&optional arg)
14482 "User command for updating dynamic blocks.
14483 Update the dynamic block at point. With prefix ARG, update all dynamic
14484 blocks in the buffer."
14485 (interactive "P")
14486 (if arg
14487 (org-update-all-dblocks)
14488 (or (looking-at org-dblock-start-re)
14489 (org-beginning-of-dblock))
14490 (org-update-dblock)))
14492 (defun org-update-dblock ()
14493 "Update the dynamic block at point
14494 This means to empty the block, parse for parameters and then call
14495 the correct writing function."
14496 (save-window-excursion
14497 (let* ((pos (point))
14498 (line (org-current-line))
14499 (params (org-prepare-dblock))
14500 (name (plist-get params :name))
14501 (cmd (intern (concat "org-dblock-write:" name))))
14502 (message "Updating dynamic block `%s' at line %d..." name line)
14503 (funcall cmd params)
14504 (message "Updating dynamic block `%s' at line %d...done" name line)
14505 (goto-char pos))))
14507 (defun org-beginning-of-dblock ()
14508 "Find the beginning of the dynamic block at point.
14509 Error if there is no scuh block at point."
14510 (let ((pos (point))
14511 beg)
14512 (end-of-line 1)
14513 (if (and (re-search-backward org-dblock-start-re nil t)
14514 (setq beg (match-beginning 0))
14515 (re-search-forward org-dblock-end-re nil t)
14516 (> (match-end 0) pos))
14517 (goto-char beg)
14518 (goto-char pos)
14519 (error "Not in a dynamic block"))))
14521 (defun org-update-all-dblocks ()
14522 "Update all dynamic blocks in the buffer.
14523 This function can be used in a hook."
14524 (when (org-mode-p)
14525 (org-map-dblocks 'org-update-dblock)))
14528 ;;;; Completion
14530 (defconst org-additional-option-like-keywords
14531 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14532 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14533 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14535 (defun org-complete (&optional arg)
14536 "Perform completion on word at point.
14537 At the beginning of a headline, this completes TODO keywords as given in
14538 `org-todo-keywords'.
14539 If the current word is preceded by a backslash, completes the TeX symbols
14540 that are supported for HTML support.
14542 setting file options.
14544 At all other locations, this simply calls the value of
14545 `org-completion-fallback-command'."
14546 (interactive "P")
14547 (org-without-partial-completion
14548 (catch 'exit
14549 (let* ((end (point))
14550 (beg1 (save-excursion
14551 (skip-chars-backward (org-re "[:alnum:]_@"))
14552 (point)))
14553 (beg (save-excursion
14554 (skip-chars-backward "a-zA-Z0-9_:$")
14555 (point)))
14556 (confirm (lambda (x) (stringp (car x))))
14557 (searchhead (equal (char-before beg) ?*))
14558 (tag (and (equal (char-before beg1) ?:)
14559 (equal (char-after (point-at-bol)) ?*)))
14560 (prop (and (equal (char-before beg1) ?:)
14561 (not (equal (char-after (point-at-bol)) ?*))))
14563 (link (equal (char-before beg) ?\[))
14564 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14565 beg)
14566 "#+"))
14568 (buffer-substring (point-at-bol) (point))))
14569 (completion-ignore-case opt)
14570 (type nil)
14571 (tbl nil)
14572 (table (cond
14573 (opt
14574 (setq type :opt)
14575 (append
14576 (mapcar
14577 (lambda (x)
14579 (cons (match-string 2 x) (match-string 1 x)))
14581 (mapcar 'list org-additional-option-like-keywords)))
14582 (startup
14583 (setq type :startup)
14584 org-startup-options)
14585 (link (append org-link-abbrev-alist-local
14586 org-link-abbrev-alist))
14587 (texp
14588 (setq type :tex)
14589 org-html-entities)
14591 (buffer-substring (point-at-bol) beg))
14592 (setq type :todo)
14593 (mapcar 'list org-todo-keywords-1))
14594 (searchhead
14595 (setq type :searchhead)
14596 (save-excursion
14597 (goto-char (point-min))
14598 (while (re-search-forward org-todo-line-regexp nil t)
14599 (push (list
14600 (org-make-org-heading-search-string
14601 (match-string 3) t))
14602 tbl)))
14603 tbl)
14604 (tag (setq type :tag beg beg1)
14605 (or org-tag-alist (org-get-buffer-tags)))
14606 (prop (setq type :prop beg beg1)
14607 (mapcar 'list (org-buffer-property-keys nil t t)))
14608 (t (progn
14609 (call-interactively org-completion-fallback-command)
14610 (throw 'exit nil)))))
14611 (pattern (buffer-substring-no-properties beg end))
14612 (completion (try-completion pattern table confirm)))
14613 (cond ((eq completion t)
14614 (if (not (assoc (upcase pattern) table))
14615 (message "Already complete")
14616 (if (equal type :opt)
14617 (insert (substring (cdr (assoc (upcase pattern) table))
14618 (length pattern)))
14619 (if (memq type '(:tag :prop)) (insert ":")))))
14620 ((null completion)
14622 (ding))
14623 ((not (string= pattern completion))
14624 (delete-region beg end)
14625 (if (string-match " +$" completion)
14626 (setq completion (replace-match "" t t completion)))
14627 (insert completion)
14628 (if (get-buffer-window "*Completions*")
14629 (delete-window (get-buffer-window "*Completions*")))
14630 (if (assoc completion table)
14631 (if (eq type :todo) (insert " ")
14632 (if (memq type '(:tag :prop)) (insert ":"))))
14633 (if (and (equal type :opt) (assoc completion table))
14634 (message "%s" (substitute-command-keys
14636 (t
14637 (message "Making completion list...")
14638 (let ((list (sort (all-completions pattern table confirm)
14639 'string<)))
14640 (with-output-to-temp-buffer "*Completions*"
14641 (condition-case nil
14642 ;; Protection needed for XEmacs and emacs 21
14643 (display-completion-list list pattern)
14644 (error (display-completion-list list)))))
14645 (message "Making completion list...%s" "done")))))))
14647 ;;;; TODO, DEADLINE, Comments
14649 (defun org-toggle-comment ()
14650 "Change the COMMENT state of an entry."
14651 (interactive)
14652 (save-excursion
14653 (org-back-to-heading)
14654 (let (case-fold-search)
14655 (if (looking-at (concat outline-regexp
14657 (replace-match "" t t nil 1)
14658 (if (looking-at outline-regexp)
14659 (progn
14660 (goto-char (match-end 0))
14661 (insert org-comment-string " ")))))))
14663 (defvar org-last-todo-state-is-todo nil
14664 "This is non-nil when the last TODO state change led to a TODO state.
14665 If the last change removed the TODO tag or switched to DONE, then
14666 this is nil.")
14668 (defvar org-setting-tags nil) ; dynamically skiped
14670 ;; FIXME: better place
14671 (defun org-property-or-variable-value (var &optional inherit)
14672 "Check if there is a property fixing the value of VAR.
14673 If yes, return this value. If not, return the current value of the variable."
14674 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14676 (read prop)
14677 (symbol-value var))))
14679 (defun org-parse-local-options (string var)
14680 "Parse STRING for startup setting relevant for variable VAR."
14681 (let ((rtn (symbol-value var))
14682 e opts)
14683 (save-match-data
14685 rtn
14686 (setq opts (delq nil (mapcar (lambda (x)
14687 (setq e (assoc x org-startup-options))
14688 (if (eq (nth 1 e) var) e nil))
14690 (if (not opts)
14691 rtn
14692 (setq rtn nil)
14693 (while (setq e (pop opts))
14694 (if (not (nth 3 e))
14695 (setq rtn (nth 2 e))
14696 (if (not (listp rtn)) (setq rtn nil))
14697 (push (nth 2 e) rtn)))
14698 rtn)))))
14700 (defvar org-blocker-hook nil
14701 "Hook for functions that are allowed to block a state change.
14703 Each function gets as its single argument a property list, see
14704 `org-trigger-hook' for more information about this list.
14706 If any of the functions in this hook returns nil, the state change
14707 is blocked.")
14709 (defvar org-trigger-hook nil
14710 "Hook for functions that are triggered by a state change.
14712 Each function gets as its single argument a property list with at least
14713 the following elements:
14715 (:type type-of-change :position pos-at-entry-start
14716 :from old-state :to new-state)
14718 Depending on the type, more properties may be present.
14720 This mechanism is currently implemented for:
14722 TODO state changes
14723 ------------------
14724 :type todo-state-change
14725 :from previous state (keyword as a string), or nil
14726 :to new state (keyword as a string), or nil")
14729 (defun org-todo (&optional arg)
14730 "Change the TODO state of an item.
14731 The state of an item is given by a keyword at the start of the heading,
14732 like
14733 *** TODO Write paper
14734 *** DONE Call mom
14736 The different keywords are specified in the variable `org-todo-keywords'.
14738 So for this example: when the item starts with TODO, it is changed to DONE.
14739 When it starts with DONE, the DONE is removed. And when neither TODO nor
14740 DONE are present, add TODO at the beginning of the heading.
14742 With C-u prefix arg, use completion to determine the new state.
14743 With numeric prefix arg, switch to that state.
14745 For calling through lisp, arg is also interpreted in the following way:
14746 'none -> empty state
14748 'done -> switch to DONE
14749 'nextset -> switch to the next set of keywords
14750 'previousset -> switch to the previous set of keywords
14752 really is a member of `org-todo-keywords'."
14753 (interactive "P")
14754 (save-excursion
14755 (catch 'exit
14756 (org-back-to-heading)
14757 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14758 (or (looking-at (concat " +" org-todo-regexp " *"))
14759 (looking-at " *"))
14760 (let* ((match-data (match-data))
14761 (startpos (point-at-bol))
14762 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14763 (org-log-done org-log-done)
14764 (org-log-repeat org-log-repeat)
14765 (org-todo-log-states org-todo-log-states)
14766 (this (match-string 1))
14767 (hl-pos (match-beginning 0))
14768 (head (org-get-todo-sequence-head this))
14769 (ass (assoc head org-todo-kwd-alist))
14770 (interpret (nth 1 ass))
14771 (done-word (nth 3 ass))
14772 (final-done-word (nth 4 ass))
14773 (last-state (or this ""))
14774 (completion-ignore-case t)
14775 (member (member this org-todo-keywords-1))
14776 (tail (cdr member))
14777 (state (cond
14778 ((and org-todo-key-trigger
14779 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14780 (and (not arg) org-use-fast-todo-selection
14781 (not (eq org-use-fast-todo-selection 'prefix)))))
14782 ;; Use fast selection
14783 (org-fast-todo-selection))
14784 ((and (equal arg '(4))
14785 (or (not org-use-fast-todo-selection)
14786 (not org-todo-key-trigger)))
14787 ;; Read a state with completion
14788 (completing-read "State: " (mapcar (lambda(x) (list x))
14789 org-todo-keywords-1)
14790 nil t))
14791 ((eq arg 'right)
14792 (if this
14793 (if tail (car tail) nil)
14794 (car org-todo-keywords-1)))
14795 ((eq arg 'left)
14796 (if (equal member org-todo-keywords-1)
14797 nil
14798 (if this
14799 (nth (- (length org-todo-keywords-1) (length tail) 2)
14800 org-todo-keywords-1)
14801 (org-last org-todo-keywords-1))))
14802 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14803 (setq arg nil))) ; hack to fall back to cycling
14804 (arg
14805 ;; user or caller requests a specific state
14806 (cond
14807 ((equal arg "") nil)
14808 ((eq arg 'none) nil)
14809 ((eq arg 'done) (or done-word (car org-done-keywords)))
14810 ((eq arg 'nextset)
14811 (or (car (cdr (member head org-todo-heads)))
14812 (car org-todo-heads)))
14813 ((eq arg 'previousset)
14814 (let ((org-todo-heads (reverse org-todo-heads)))
14815 (or (car (cdr (member head org-todo-heads)))
14816 (car org-todo-heads))))
14817 ((car (member arg org-todo-keywords-1)))
14818 ((nth (1- (prefix-numeric-value arg))
14819 org-todo-keywords-1))))
14820 ((null member) (or head (car org-todo-keywords-1)))
14821 ((equal this final-done-word) nil) ;; -> make empty
14822 ((null tail) nil) ;; -> first entry
14823 ((eq interpret 'sequence)
14824 (car tail))
14825 ((memq interpret '(type priority))
14826 (if (eq this-command last-command)
14827 (car tail)
14828 (if (> (length tail) 0)
14829 (or done-word (car org-done-keywords))
14830 nil)))
14831 (t nil)))
14832 (next (if state (concat " " state " ") " "))
14833 (change-plist (list :type 'todo-state-change :from this :to state
14834 :position startpos))
14835 dolog now-done-p)
14836 (when org-blocker-hook
14837 (unless (save-excursion
14838 (save-match-data
14839 (run-hook-with-args-until-failure
14840 'org-blocker-hook change-plist)))
14841 (if (interactive-p)
14842 (error "TODO state change from %s to %s blocked" this state)
14843 ;; fail silently
14844 (message "TODO state change from %s to %s blocked" this state)
14845 (throw 'exit nil))))
14846 (store-match-data match-data)
14847 (replace-match next t t)
14848 (unless (pos-visible-in-window-p hl-pos)
14849 (message "TODO state changed to %s" (org-trim next)))
14850 (unless head
14851 (setq head (org-get-todo-sequence-head state)
14852 ass (assoc head org-todo-kwd-alist)
14853 interpret (nth 1 ass)
14854 done-word (nth 3 ass)
14855 final-done-word (nth 4 ass)))
14856 (when (memq arg '(nextset previousset))
14857 (message "Keyword-Set %d/%d: %s"
14858 (- (length org-todo-sets) -1
14859 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14860 (length org-todo-sets)
14861 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14862 (setq org-last-todo-state-is-todo
14863 (not (member state org-done-keywords)))
14864 (setq now-done-p (and (member state org-done-keywords)
14865 (not (member this org-done-keywords))))
14866 (and logging (org-local-logging logging))
14867 (when (and (or org-todo-log-states org-log-done)
14868 (not (memq arg '(nextset previousset))))
14869 ;; we need to look at recording a time and note
14870 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14871 (nth 2 (assoc this org-todo-log-states))))
14872 (when (and state
14873 (member state org-not-done-keywords)
14874 (not (member this org-not-done-keywords)))
14875 ;; This is now a todo state and was not one before
14876 ;; If there was a CLOSED time stamp, get rid of it.
14877 (org-add-planning-info nil nil 'closed))
14878 (when (and now-done-p org-log-done)
14879 ;; It is now done, and it was not done before
14880 (org-add-planning-info 'closed (org-current-time))
14881 (if (and (not dolog) (eq 'note org-log-done))
14882 (org-add-log-maybe 'done state 'findpos 'note)))
14883 (when (and state dolog)
14884 ;; This is a non-nil state, and we need to log it
14885 (org-add-log-maybe 'state state 'findpos dolog)))
14886 ;; Fixup tag positioning
14887 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14888 (run-hooks 'org-after-todo-state-change-hook)
14889 (if (and arg (not (member state org-done-keywords)))
14890 (setq head (org-get-todo-sequence-head state)))
14891 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14892 ;; Do we need to trigger a repeat?
14893 (when now-done-p (org-auto-repeat-maybe state))
14894 ;; Fixup cursor location if close to the keyword
14895 (if (and (outline-on-heading-p)
14896 (not (bolp))
14897 (save-excursion (beginning-of-line 1)
14898 (looking-at org-todo-line-regexp))
14899 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14900 (progn
14901 (goto-char (or (match-end 2) (match-end 1)))
14902 (just-one-space)))
14903 (when org-trigger-hook
14904 (save-excursion
14905 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14907 (defun org-local-logging (value)
14908 "Get logging settings from a property VALUE."
14909 (let* (words w a)
14910 ;; directly set the variables, they are already local.
14911 (setq org-log-done nil
14912 org-log-repeat nil
14913 org-todo-log-states nil)
14914 (setq words (org-split-string value))
14915 (while (setq w (pop words))
14916 (cond
14917 ((setq a (assoc w org-startup-options))
14918 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14919 (set (nth 1 a) (nth 2 a))))
14920 ((setq a (org-extract-log-state-settings w))
14921 (and (member (car a) org-todo-keywords-1)
14922 (push a org-todo-log-states)))))))
14924 (defun org-get-todo-sequence-head (kwd)
14925 "Return the head of the TODO sequence to which KWD belongs.
14926 If KWD is not set, check if there is a text property remembering the
14927 right sequence."
14928 (let (p)
14929 (cond
14930 ((not kwd)
14931 (or (get-text-property (point-at-bol) 'org-todo-head)
14932 (progn
14933 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14934 nil (point-at-eol)))
14935 (get-text-property p 'org-todo-head))))
14936 ((not (member kwd org-todo-keywords-1))
14937 (car org-todo-keywords-1))
14938 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14940 (defun org-fast-todo-selection ()
14941 "Fast TODO keyword selection with single keys.
14942 Returns the new TODO keyword, or nil if no state change should occur."
14943 (let* ((fulltable org-todo-key-alist)
14944 (done-keywords org-done-keywords) ;; needed for the faces.
14945 (maxlen (apply 'max (mapcar
14946 (lambda (x)
14947 (if (stringp (car x)) (string-width (car x)) 0))
14948 fulltable)))
14949 (expert nil)
14950 (fwidth (+ maxlen 3 1 3))
14951 (ncol (/ (- (window-width) 4) fwidth))
14952 tg cnt e c tbl
14953 groups ingroup)
14954 (save-window-excursion
14955 (if expert
14956 (set-buffer (get-buffer-create " *Org todo*"))
14957 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14958 (erase-buffer)
14959 (org-set-local 'org-done-keywords done-keywords)
14960 (setq tbl fulltable cnt 0)
14961 (while (setq e (pop tbl))
14962 (cond
14963 ((equal e '(:startgroup))
14964 (push '() groups) (setq ingroup t)
14965 (when (not (= cnt 0))
14966 (setq cnt 0)
14968 (insert "{ "))
14969 ((equal e '(:endgroup))
14970 (setq ingroup nil cnt 0)
14972 (t
14973 (setq tg (car e) c (cdr e))
14974 (if ingroup (push tg (car groups)))
14975 (setq tg (org-add-props tg nil 'face
14976 (org-get-todo-face tg)))
14977 (if (and (= cnt 0) (not ingroup)) (insert " "))
14978 (insert "[" c "] " tg (make-string
14979 (- fwidth 4 (length tg)) ?\ ))
14980 (when (= (setq cnt (1+ cnt)) ncol)
14982 (if ingroup (insert " "))
14983 (setq cnt 0)))))
14985 (goto-char (point-min))
14986 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14987 (fit-window-to-buffer))
14988 (message "[a-z..]:Set [SPC]:clear")
14989 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14990 (cond
14991 ((or (= c ?\C-g)
14992 (and (= c ?q) (not (rassoc c fulltable))))
14993 (setq quit-flag t))
14994 ((= c ?\ ) nil)
14995 ((setq e (rassoc c fulltable) tg (car e))
14996 tg)
14997 (t (setq quit-flag t))))))
14999 (defun org-get-repeat ()
15000 "Check if tere is a deadline/schedule with repeater in this entry."
15001 (save-match-data
15002 (save-excursion
15003 (org-back-to-heading t)
15004 (if (re-search-forward
15005 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
15006 (match-string 1)))))
15008 (defvar org-last-changed-timestamp)
15009 (defvar org-log-post-message)
15010 (defvar org-log-note-purpose)
15011 (defun org-auto-repeat-maybe (done-word)
15012 "Check if the current headline contains a repeated deadline/schedule.
15013 If yes, set TODO state back to what it was and change the base date
15014 of repeating deadline/scheduled time stamps to new date.
15015 This function is run automatically after each state change to a DONE state."
15016 ;; last-state is dynamically scoped into this function
15017 (let* ((repeat (org-get-repeat))
15018 (aa (assoc last-state org-todo-kwd-alist))
15019 (interpret (nth 1 aa))
15020 (head (nth 2 aa))
15021 (whata '(("d" . day) ("m" . month) ("y" . year)))
15022 (msg "Entry repeats: ")
15023 (org-log-done nil)
15024 (org-todo-log-states nil)
15025 re type n what ts)
15026 (when repeat
15027 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
15028 (org-todo (if (eq interpret 'type) last-state head))
15029 (when (and org-log-repeat
15030 (or (not (memq 'org-add-log-note
15031 (default-value 'post-command-hook)))
15032 (eq org-log-note-purpose 'done)))
15033 ;; Make sure a note is taken;
15034 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
15035 'findpos org-log-repeat))
15036 (org-back-to-heading t)
15037 (org-add-planning-info nil nil 'closed)
15041 (while (re-search-forward
15042 re (save-excursion (outline-next-heading) (point)) t)
15043 (setq type (if (match-end 1) org-scheduled-string
15044 (if (match-end 3) org-deadline-string "Plain:"))
15045 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
15047 (setq n (string-to-number (match-string 1 ts))
15048 what (match-string 2 ts))
15049 (if (equal what "w") (setq n (* n 7) what "d"))
15050 (org-timestamp-change n (cdr (assoc what whata)))
15051 (setq msg (concat msg type org-last-changed-timestamp " "))))
15052 (setq org-log-post-message msg)
15053 (message "%s" msg))))
15055 (defun org-show-todo-tree (arg)
15056 "Make a compact tree which shows all headlines marked with TODO.
15057 The tree will show the lines where the regexp matches, and all higher
15058 headlines above the match.
15060 With a numeric prefix N, construct a sparse tree for the Nth element
15061 of `org-todo-keywords-1'."
15062 (interactive "P")
15063 (let ((case-fold-search nil)
15064 (kwd-re
15065 (cond ((null arg) org-not-done-regexp)
15066 ((equal arg '(4))
15067 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
15068 (mapcar 'list org-todo-keywords-1))))
15072 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
15073 (regexp-quote (nth (1- (prefix-numeric-value arg))
15074 org-todo-keywords-1)))
15075 (t (error "Invalid prefix argument: %s" arg)))))
15076 (message "%d TODO entries found"
15077 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
15079 (defun org-deadline (&optional remove)
15081 With argument REMOVE, remove any deadline from the item."
15082 (interactive "P")
15083 (if remove
15084 (progn
15085 (org-remove-timestamp-with-keyword org-deadline-string)
15086 (message "Item no longer has a deadline."))
15087 (org-add-planning-info 'deadline nil 'closed)))
15089 (defun org-schedule (&optional remove)
15090 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
15091 With argument REMOVE, remove any scheduling date from the item."
15092 (interactive "P")
15093 (if remove
15094 (progn
15095 (org-remove-timestamp-with-keyword org-scheduled-string)
15096 (message "Item is no longer scheduled."))
15097 (org-add-planning-info 'scheduled nil 'closed)))
15099 (defun org-remove-timestamp-with-keyword (keyword)
15100 "Remove all time stamps with KEYWORD in the current entry."
15102 beg)
15103 (save-excursion
15104 (org-back-to-heading t)
15105 (setq beg (point))
15106 (org-end-of-subtree t t)
15107 (while (re-search-backward re beg t)
15108 (replace-match "")
15110 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
15112 (defun org-add-planning-info (what &optional time &rest remove)
15113 "Insert new timestamp with keyword in the line directly after the headline.
15114 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
15115 If non is given, the user is prompted for a date.
15116 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
15117 be removed."
15118 (interactive)
15119 (let (org-time-was-given org-end-time-was-given)
15120 (when what (setq time (or time (org-read-date nil 'to-time))))
15121 (when (and org-insert-labeled-timestamps-at-point
15122 (member what '(scheduled deadline)))
15123 (insert
15124 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
15125 (org-insert-time-stamp time org-time-was-given
15126 nil nil nil (list org-end-time-was-given))
15127 (setq what nil))
15128 (save-excursion
15129 (save-restriction
15130 (let (col list elt ts buffer-invisibility-spec)
15131 (org-back-to-heading t)
15133 (goto-char (match-end 1))
15134 (setq col (current-column))
15135 (goto-char (match-end 0))
15137 (if (and (not (looking-at outline-regexp))
15140 (not (equal (match-string 1) org-clock-string)))
15141 (narrow-to-region (match-beginning 0) (match-end 0))
15143 (backward-char 1)
15144 (narrow-to-region (point) (point))
15145 (indent-to-column col))
15146 ;; Check if we have to remove something.
15147 (setq list (cons what remove))
15148 (while list
15149 (setq elt (pop list))
15150 (goto-char (point-min))
15151 (when (or (and (eq elt 'scheduled)
15152 (re-search-forward org-scheduled-time-regexp nil t))
15153 (and (eq elt 'deadline)
15154 (re-search-forward org-deadline-time-regexp nil t))
15155 (and (eq elt 'closed)
15156 (re-search-forward org-closed-time-regexp nil t)))
15157 (replace-match "")
15158 (if (looking-at "--+<[^>]+>") (replace-match ""))
15159 (if (looking-at " +") (replace-match ""))))
15160 (goto-char (point-max))
15161 (when what
15162 (insert
15163 (if (not (equal (char-before) ?\ )) " " "")
15164 (cond ((eq what 'scheduled) org-scheduled-string)
15165 ((eq what 'deadline) org-deadline-string)
15166 ((eq what 'closed) org-closed-string))
15167 " ")
15168 (setq ts (org-insert-time-stamp
15169 time
15170 (or org-time-was-given
15171 (and (eq what 'closed) org-log-done-with-time))
15172 (eq what 'closed)
15173 nil nil (list org-end-time-was-given)))
15174 (end-of-line 1))
15175 (goto-char (point-min))
15176 (widen)
15178 (replace-match ""))
15179 ts)))))
15181 (defvar org-log-note-marker (make-marker))
15182 (defvar org-log-note-purpose nil)
15183 (defvar org-log-note-state nil)
15184 (defvar org-log-note-how nil)
15185 (defvar org-log-note-window-configuration nil)
15186 (defvar org-log-note-return-to (make-marker))
15187 (defvar org-log-post-message nil
15188 "Message to be displayed after a log note has been stored.
15189 The auto-repeater uses this.")
15191 (defun org-add-log-maybe (&optional purpose state findpos how)
15192 "Set up the post command hook to take a note.
15193 If this is about to TODO state change, the new state is expected in STATE.
15194 When FINDPOS is non-nil, find the correct position for the note in
15195 the current entry. If not, assume that it can be inserted at point."
15196 (save-excursion
15197 (when findpos
15198 (org-back-to-heading t)
15202 (goto-char (match-end 0))
15203 (unless org-log-states-order-reversed
15205 (org-skip-over-state-notes)
15207 (move-marker org-log-note-marker (point))
15208 (setq org-log-note-purpose purpose
15209 org-log-note-state state
15210 org-log-note-how how)
15211 (add-hook 'post-command-hook 'org-add-log-note 'append)))
15213 (defun org-skip-over-state-notes ()
15214 "Skip past the list of State notes in an entry."
15217 (condition-case nil
15218 (org-next-item)
15219 (error (org-end-of-item)))))
15221 (defun org-add-log-note (&optional purpose)
15222 "Pop up a window for taking a note, and add this note later at point."
15223 (remove-hook 'post-command-hook 'org-add-log-note)
15224 (setq org-log-note-window-configuration (current-window-configuration))
15225 (delete-other-windows)
15226 (move-marker org-log-note-return-to (point))
15227 (switch-to-buffer (marker-buffer org-log-note-marker))
15228 (goto-char org-log-note-marker)
15229 (org-switch-to-buffer-other-window "*Org Note*")
15230 (erase-buffer)
15231 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
15232 (org-store-log-note)
15233 (let ((org-inhibit-startup t)) (org-mode))
15234 (insert (format "# Insert note for %s.
15236 (cond
15237 ((eq org-log-note-purpose 'clock-out) "stopped clock")
15238 ((eq org-log-note-purpose 'done) "closed todo item")
15239 ((eq org-log-note-purpose 'state)
15241 (t (error "This should not happen")))))
15242 (org-set-local 'org-finish-function 'org-store-log-note)))
15244 (defun org-store-log-note ()
15245 "Finish taking a log note, and insert it to where it belongs."
15246 (let ((txt (buffer-string))
15247 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
15248 lines ind)
15249 (kill-buffer (current-buffer))
15251 (setq txt (replace-match "" t t txt)))
15253 (setq txt (replace-match "" t t txt)))
15256 (setq note
15257 (org-replace-escapes
15258 note
15259 (list (cons "%u" (user-login-name))
15260 (cons "%U" user-full-name)
15261 (cons "%t" (format-time-string
15262 (org-time-stamp-format 'long 'inactive)
15263 (current-time)))
15264 (cons "%s" (if org-log-note-state
15266 "")))))
15268 (push note lines))
15269 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15270 (when lines
15271 (save-excursion
15272 (set-buffer (marker-buffer org-log-note-marker))
15273 (save-excursion
15274 (goto-char org-log-note-marker)
15275 (move-marker org-log-note-marker nil)
15276 (end-of-line 1)
15278 (indent-relative nil)
15279 (insert "- " (pop lines))
15280 (org-indent-line-function)
15281 (beginning-of-line 1)
15283 (setq ind (concat (match-string 0) " "))
15284 (end-of-line 1)
15286 (set-window-configuration org-log-note-window-configuration)
15287 (with-current-buffer (marker-buffer org-log-note-return-to)
15288 (goto-char org-log-note-return-to))
15289 (move-marker org-log-note-return-to nil)
15290 (and org-log-post-message (message "%s" org-log-post-message)))
15292 ;; FIXME: what else would be useful?
15293 ;; - priority
15294 ;; - date
15296 (defun org-sparse-tree (&optional arg)
15297 "Create a sparse tree, prompt for the details.
15298 This command can create sparse trees. You first need to select the type
15299 of match used to create the tree:
15301 t Show entries with a specific TODO keyword.
15302 T Show entries selected by a tags match.
15303 p Enter a property name and its value (both with completion on existing
15304 names/values) and show entries with that property.
15305 r Show entries matching a regular expression
15306 d Show deadlines due within `org-deadline-warning-days'."
15307 (interactive "P")
15308 (let (ans kwd value)
15309 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15310 (setq ans (read-char-exclusive))
15311 (cond
15312 ((equal ans ?d)
15313 (call-interactively 'org-check-deadlines))
15314 ((equal ans ?b)
15315 (call-interactively 'org-check-before-date))
15316 ((equal ans ?t)
15317 (org-show-todo-tree '(4)))
15318 ((equal ans ?T)
15319 (call-interactively 'org-tags-sparse-tree))
15320 ((member ans '(?p ?P))
15321 (setq kwd (completing-read "Property: "
15322 (mapcar 'list (org-buffer-property-keys))))
15323 (setq value (completing-read "Value: "
15324 (mapcar 'list (org-property-values kwd))))
15327 (org-tags-sparse-tree arg (concat kwd "=" value)))
15328 ((member ans '(?r ?R ?/))
15329 (call-interactively 'org-occur))
15332 (defvar org-occur-highlights nil
15333 "List of overlays used for occur matches.")
15334 (make-variable-buffer-local 'org-occur-highlights)
15335 (defvar org-occur-parameters nil
15336 "Parameters of the active org-occur calls.
15337 This is a list, each call to org-occur pushes as cons cell,
15338 containing the regular expression and the callback, onto the list.
15339 The list can contain several entries if `org-occur' has been called
15340 several time with the KEEP-PREVIOUS argument. Otherwise, this list
15341 will only contain one set of parameters. When the highlights are
15342 removed (for example with `C-c C-c', or with the next edit (depending
15343 on `org-remove-highlights-with-change'), this variable is emptied
15344 as well.")
15345 (make-variable-buffer-local 'org-occur-parameters)
15347 (defun org-occur (regexp &optional keep-previous callback)
15348 "Make a compact tree which shows all matches of REGEXP.
15349 The tree will show the lines where the regexp matches, and all higher
15350 headlines above the match. It will also show the heading after the match,
15351 to make sure editing the matching entry is easy.
15352 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15353 call to `org-occur' will be kept, to allow stacking of calls to this
15354 command.
15355 If CALLBACK is non-nil, it is a function which is called to confirm
15356 that the match should indeed be shown."
15358 (unless keep-previous
15359 (org-remove-occur-highlights nil nil t))
15360 (push (cons regexp callback) org-occur-parameters)
15361 (let ((cnt 0))
15362 (save-excursion
15363 (goto-char (point-min))
15364 (if (or (not keep-previous) ; do not want to keep
15365 (not org-occur-highlights)) ; no previous matches
15366 ;; hide everything
15367 (org-overview))
15368 (while (re-search-forward regexp nil t)
15369 (when (or (not callback)
15370 (save-match-data (funcall callback)))
15371 (setq cnt (1+ cnt))
15372 (when org-highlight-sparse-tree-matches
15373 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15374 (org-show-context 'occur-tree))))
15375 (when org-remove-highlights-with-change
15376 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15377 nil 'local))
15378 (unless org-sparse-tree-open-archived-trees
15379 (org-hide-archived-subtrees (point-min) (point-max)))
15380 (run-hooks 'org-occur-hook)
15381 (if (interactive-p)
15382 (message "%d match(es) for regexp %s" cnt regexp))
15383 cnt))
15385 (defun org-show-context (&optional key)
15386 "Make sure point and context and visible.
15387 How much context is shown depends upon the variables
15388 `org-show-hierarchy-above', `org-show-following-heading'. and
15389 `org-show-siblings'."
15390 (let ((heading-p (org-on-heading-p t))
15391 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15392 (following-p (org-get-alist-option org-show-following-heading key))
15393 (entry-p (org-get-alist-option org-show-entry-below key))
15394 (siblings-p (org-get-alist-option org-show-siblings key)))
15395 (catch 'exit
15396 ;; Show heading or entry text
15397 (if (and heading-p (not entry-p))
15398 (org-flag-heading nil) ; only show the heading
15399 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15400 (org-show-hidden-entry))) ; show entire entry
15401 (when following-p
15402 ;; Show next sibling, or heading below text
15403 (save-excursion
15404 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15405 (org-flag-heading nil))))
15406 (when siblings-p (org-show-siblings))
15407 (when hierarchy-p
15408 ;; show all higher headings, possibly with siblings
15409 (save-excursion
15410 (while (and (condition-case nil
15411 (progn (org-up-heading-all 1) t)
15412 (error nil))
15413 (not (bobp)))
15414 (org-flag-heading nil)
15415 (when siblings-p (org-show-siblings))))))))
15417 (defun org-reveal (&optional siblings)
15418 "Show current entry, hierarchy above it, and the following headline.
15419 This can be used to show a consistent set of context around locations
15420 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15421 not t for the search context.
15423 With optional argument SIBLINGS, on each level of the hierarchy all
15424 siblings are shown. This repairs the tree structure to what it would
15425 look like when opened with hierarchical calls to `org-cycle'."
15426 (interactive "P")
15427 (let ((org-show-hierarchy-above t)
15428 (org-show-following-heading t)
15429 (org-show-siblings (if siblings t org-show-siblings)))
15430 (org-show-context nil)))
15432 (defun org-highlight-new-match (beg end)
15433 "Highlight from BEG to END and mark the highlight is an occur headline."
15434 (let ((ov (org-make-overlay beg end)))
15435 (org-overlay-put ov 'face 'secondary-selection)
15436 (push ov org-occur-highlights)))
15438 (defun org-remove-occur-highlights (&optional beg end noremove)
15439 "Remove the occur highlights from the buffer.
15440 BEG and END are ignored. If NOREMOVE is nil, remove this function
15441 from the `before-change-functions' in the current buffer."
15442 (interactive)
15443 (unless org-inhibit-highlight-removal
15444 (mapc 'org-delete-overlay org-occur-highlights)
15445 (setq org-occur-highlights nil)
15446 (setq org-occur-parameters nil)
15447 (unless noremove
15448 (remove-hook 'before-change-functions
15449 'org-remove-occur-highlights 'local))))
15451 ;;;; Priorities
15454 "Regular expression matching the priority indicator.")
15456 (defvar org-remove-priority-next-time nil)
15458 (defun org-priority-up ()
15459 "Increase the priority of the current item."
15460 (interactive)
15461 (org-priority 'up))
15463 (defun org-priority-down ()
15464 "Decrease the priority of the current item."
15465 (interactive)
15466 (org-priority 'down))
15468 (defun org-priority (&optional action)
15469 "Change the priority of an item by ARG.
15470 ACTION can be `set', `up', `down', or a character."
15471 (interactive)
15472 (setq action (or action 'set))
15473 (let (current new news have remove)
15474 (save-excursion
15475 (org-back-to-heading)
15476 (if (looking-at org-priority-regexp)
15477 (setq current (string-to-char (match-string 2))
15478 have t)
15479 (setq current org-default-priority))
15480 (cond
15481 ((or (eq action 'set) (integerp action))
15482 (if (integerp action)
15483 (setq new action)
15484 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15485 (setq new (read-char-exclusive)))
15486 (if (and (= (upcase org-highest-priority) org-highest-priority)
15487 (= (upcase org-lowest-priority) org-lowest-priority))
15488 (setq new (upcase new)))
15489 (cond ((equal new ?\ ) (setq remove t))
15490 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15491 (error "Priority must be between `%c' and `%c'"
15492 org-highest-priority org-lowest-priority))))
15493 ((eq action 'up)
15494 (if (and (not have) (eq last-command this-command))
15495 (setq new org-lowest-priority)
15496 (setq new (if (and org-priority-start-cycle-with-default (not have))
15497 org-default-priority (1- current)))))
15498 ((eq action 'down)
15499 (if (and (not have) (eq last-command this-command))
15500 (setq new org-highest-priority)
15501 (setq new (if (and org-priority-start-cycle-with-default (not have))
15502 org-default-priority (1+ current)))))
15503 (t (error "Invalid action")))
15504 (if (or (< (upcase new) org-highest-priority)
15505 (> (upcase new) org-lowest-priority))
15506 (setq remove t))
15507 (setq news (format "%c" new))
15508 (if have
15509 (if remove
15510 (replace-match "" t t nil 1)
15511 (replace-match news t t nil 2))
15512 (if remove
15513 (error "No priority cookie found in line")
15514 (looking-at org-todo-line-regexp)
15515 (if (match-end 2)
15516 (progn
15517 (goto-char (match-end 2))
15518 (insert " [#" news "]"))
15519 (goto-char (match-beginning 3))
15520 (insert "[#" news "] ")))))
15521 (org-preserve-lc (org-set-tags nil 'align))
15522 (if remove
15523 (message "Priority removed")
15524 (message "Priority of current item set to %s" news))))
15527 (defun org-get-priority (s)
15528 "Find priority cookie and return priority."
15529 (save-match-data
15530 (if (not (string-match org-priority-regexp s))
15531 (* 1000 (- org-lowest-priority org-default-priority))
15532 (* 1000 (- org-lowest-priority
15533 (string-to-char (match-string 2 s)))))))
15535 ;;;; Tags
15537 (defun org-scan-tags (action matcher &optional todo-only)
15538 "Scan headline tags with inheritance and produce output ACTION.
15539 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15540 evaluated, testing if a given set of tags qualifies a headline for
15541 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15542 are included in the output."
15545 (org-re
15547 (props (list 'face nil
15548 'done-face 'org-done
15549 'undone-face nil
15550 'mouse-face 'highlight
15551 'org-not-done-regexp org-not-done-regexp
15552 'org-todo-regexp org-todo-regexp
15553 'keymap org-agenda-keymap
15554 'help-echo
15555 (format "mouse-2 or RET jump to org file %s"
15556 (abbreviate-file-name
15557 (or (buffer-file-name (buffer-base-buffer))
15558 (buffer-name (buffer-base-buffer)))))))
15559 (case-fold-search nil)
15560 lspos
15561 tags tags-list tags-alist (llast 0) rtn level category i txt
15562 todo marker entry priority)
15563 (save-excursion
15564 (goto-char (point-min))
15565 (when (eq action 'sparse-tree)
15566 (org-overview)
15567 (org-remove-occur-highlights))
15568 (while (re-search-forward re nil t)
15569 (catch :skip
15570 (setq todo (if (match-end 1) (match-string 2))
15571 tags (if (match-end 4) (match-string 4)))
15572 (goto-char (setq lspos (1+ (match-beginning 0))))
15573 (setq level (org-reduced-level (funcall outline-level))
15574 category (org-get-category))
15575 (setq i llast llast level)
15576 ;; remove tag lists from same and sublevels
15577 (while (>= i level)
15578 (when (setq entry (assoc i tags-alist))
15579 (setq tags-alist (delete entry tags-alist)))
15580 (setq i (1- i)))
15581 ;; add the nex tags
15582 (when tags
15583 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15584 tags-alist
15585 (cons (cons level tags) tags-alist)))
15586 ;; compile tags for current headline
15587 (setq tags-list
15588 (if org-use-tag-inheritance
15589 (apply 'append (mapcar 'cdr tags-alist))
15590 tags))
15591 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15592 (eval matcher)
15593 (or (not org-agenda-skip-archived-trees)
15594 (not (member org-archive-tag tags-list))))
15595 (and (eq action 'agenda) (org-agenda-skip))
15596 ;; list this headline
15598 (if (eq action 'sparse-tree)
15599 (progn
15600 (and org-highlight-sparse-tree-matches
15601 (org-get-heading) (match-end 0)
15602 (org-highlight-new-match
15603 (match-beginning 0) (match-beginning 1)))
15604 (org-show-context 'tags-tree))
15605 (setq txt (org-format-agenda-item
15606 ""
15607 (concat
15608 (if org-tags-match-list-sublevels
15609 (make-string (1- level) ?.) "")
15610 (org-get-heading))
15611 category tags-list)
15612 priority (org-get-priority txt))
15613 (goto-char lspos)
15614 (setq marker (org-agenda-new-marker))
15615 (org-add-props txt props
15616 'org-marker marker 'org-hd-marker marker 'org-category category
15617 'priority priority 'type "tagsmatch")
15618 (push txt rtn))
15619 ;; if we are to skip sublevels, jump to end of subtree
15620 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15621 (when (and (eq action 'sparse-tree)
15622 (not org-sparse-tree-open-archived-trees))
15623 (org-hide-archived-subtrees (point-min) (point-max)))
15624 (nreverse rtn)))
15626 (defvar todo-only) ;; dynamically scoped
15628 (defun org-tags-sparse-tree (&optional todo-only match)
15629 "Create a sparse tree according to tags string MATCH.
15630 MATCH can contain positive and negative selection of tags, like
15632 If optional argument TODO_ONLY is non-nil, only select lines that are
15633 also TODO lines."
15634 (interactive "P")
15635 (org-prepare-agenda-buffers (list (current-buffer)))
15636 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15638 (defvar org-cached-props nil)
15639 (defun org-cached-entry-get (pom property)
15640 (if (or (eq t org-use-property-inheritance)
15641 (member property org-use-property-inheritance))
15642 ;; Caching is not possible, check it directly
15643 (org-entry-get pom property 'inherit)
15644 ;; Get all properties, so that we can do complicated checks easily
15645 (cdr (assoc property (or org-cached-props
15646 (setq org-cached-props
15647 (org-entry-properties pom)))))))
15649 (defun org-global-tags-completion-table (&optional files)
15650 "Return the list of all tags in all agenda buffer/files."
15651 (save-excursion
15652 (org-uniquify
15653 (delq nil
15654 (apply 'append
15655 (mapcar
15656 (lambda (file)
15657 (set-buffer (find-file-noselect file))
15658 (append (org-get-buffer-tags)
15659 (mapcar (lambda (x) (if (stringp (car-safe x))
15660 (list (car-safe x)) nil))
15661 org-tag-alist)))
15662 (if (and files (car files))
15663 files
15664 (org-agenda-files))))))))
15666 (defun org-make-tags-matcher (match)
15667 "Create the TAGS//TODO matcher form for the selection string MATCH."
15668 ;; todo-only is scoped dynamically into this function, and the function
15669 ;; may change it it the matcher asksk for it.
15670 (unless match
15671 ;; Get a new match request, with completion
15672 (let ((org-last-tags-completion-table
15673 (org-global-tags-completion-table)))
15674 (setq match (completing-read
15675 "Match: " 'org-tags-completion-function nil nil nil
15676 'org-tags-history))))
15678 ;; Parse the string and create a lisp form
15679 (let ((match0 match)
15680 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15681 minus tag mm
15682 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15683 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15684 (if (string-match "/+" match)
15685 ;; match contains also a todo-matching request
15686 (progn
15687 (setq tagsmatch (substring match 0 (match-beginning 0))
15688 todomatch (substring match (match-end 0)))
15689 (if (string-match "^!" todomatch)
15690 (setq todo-only t todomatch (substring todomatch 1)))
15692 (setq todomatch nil)))
15693 ;; only matching tags
15694 (setq tagsmatch match todomatch nil))
15696 ;; Make the tags matcher
15698 (setq tagsmatcher t)
15699 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15700 (while (setq term (pop orterms))
15702 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15703 (while (string-match re term)
15704 (setq minus (and (match-end 1)
15705 (equal (match-string 1 term) "-"))
15706 tag (match-string 2 term)
15707 re-p (equal (string-to-char tag) ?{)
15708 level-p (match-end 3)
15709 prop-p (match-end 4)
15710 mm (cond
15711 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15712 (level-p `(= level ,(string-to-number
15713 (match-string 3 term))))
15714 (prop-p
15715 (setq pn (match-string 4 term)
15716 pv (match-string 5 term)
15717 cat-p (equal pn "CATEGORY")
15718 re-p (equal (string-to-char pv) ?{)
15719 pv (substring pv 1 -1))
15720 (if (equal pn "CATEGORY")
15721 (setq gv '(get-text-property (point) 'org-category))
15722 (setq gv `(org-cached-entry-get nil ,pn)))
15723 (if re-p
15724 `(string-match ,pv (or ,gv ""))
15725 `(equal ,pv (or ,gv ""))))
15726 (t `(member ,(downcase tag) tags-list)))
15727 mm (if minus (list 'not mm) mm)
15728 term (substring term (match-end 0)))
15729 (push mm tagsmatcher))
15730 (push (if (> (length tagsmatcher) 1)
15731 (cons 'and tagsmatcher)
15732 (car tagsmatcher))
15733 orlist)
15734 (setq tagsmatcher nil))
15735 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15736 (setq tagsmatcher
15737 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15739 ;; Make the todo matcher
15741 (setq todomatcher t)
15742 (setq orterms (org-split-string todomatch "|") orlist nil)
15743 (while (setq term (pop orterms))
15744 (while (string-match re term)
15745 (setq minus (and (match-end 1)
15746 (equal (match-string 1 term) "-"))
15747 kwd (match-string 2 term)
15748 re-p (equal (string-to-char kwd) ?{)
15749 term (substring term (match-end 0))
15750 mm (if re-p
15751 `(string-match ,(substring kwd 1 -1) todo)
15752 (list 'equal 'todo kwd))
15753 mm (if minus (list 'not mm) mm))
15754 (push mm todomatcher))
15755 (push (if (> (length todomatcher) 1)
15756 (cons 'and todomatcher)
15757 (car todomatcher))
15758 orlist)
15759 (setq todomatcher nil))
15760 (setq todomatcher (if (> (length orlist) 1)
15761 (cons 'or orlist) (car orlist))))
15763 ;; Return the string and lisp forms of the matcher
15764 (setq matcher (if todomatcher
15765 (list 'and tagsmatcher todomatcher)
15766 tagsmatcher))
15767 (cons match0 matcher)))
15769 (defun org-match-any-p (re list)
15770 "Does re match any element of list?"
15771 (setq list (mapcar (lambda (x) (string-match re x)) list))
15772 (delq nil list))
15774 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15775 (defvar org-tags-overlay (org-make-overlay 1 1))
15776 (org-detach-overlay org-tags-overlay)
15778 (defun org-align-tags-here (to-col)
15779 ;; Assumes that this is a headline
15780 (let ((pos (point)) (col (current-column)) tags)
15781 (beginning-of-line 1)
15783 (< pos (match-beginning 2)))
15784 (progn
15785 (setq tags (match-string 2))
15786 (goto-char (match-beginning 1))
15787 (insert " ")
15788 (delete-region (point) (1+ (match-end 0)))
15789 (backward-char 1)
15790 (move-to-column
15791 (max (1+ (current-column))
15792 (1+ col)
15793 (if (> to-col 0)
15794 to-col
15795 (- (abs to-col) (length tags))))
15796 t)
15797 (insert tags)
15798 (move-to-column (min (current-column) col) t))
15799 (goto-char pos))))
15801 (defun org-set-tags (&optional arg just-align)
15802 "Set the tags for the current headline.
15803 With prefix ARG, realign all tags in headings in the current buffer."
15804 (interactive "P")
15805 (let* ((re (concat "^" outline-regexp))
15806 (current (org-get-tags-string))
15807 (col (current-column))
15808 (org-setting-tags t)
15809 table current-tags inherited-tags ; computed below when needed
15810 tags p0 c0 c1 rpl)
15811 (if arg
15812 (save-excursion
15813 (goto-char (point-min))
15814 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15815 (while (re-search-forward re nil t)
15816 (org-set-tags nil t)
15817 (end-of-line 1)))
15818 (message "All tags realigned to column %d" org-tags-column))
15819 (if just-align
15820 (setq tags current)
15821 ;; Get a new set of tags from the user
15822 (save-excursion
15823 (setq table (or org-tag-alist (org-get-buffer-tags))
15824 org-last-tags-completion-table table
15825 current-tags (org-split-string current ":")
15826 inherited-tags (nreverse
15827 (nthcdr (length current-tags)
15828 (nreverse (org-get-tags-at))))
15829 tags
15830 (if (or (eq t org-use-fast-tag-selection)
15831 (and org-use-fast-tag-selection
15832 (delq nil (mapcar 'cdr table))))
15833 (org-fast-tag-selection
15834 current-tags inherited-tags table
15835 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15836 (let ((org-add-colon-after-tag-completion t))
15837 (org-trim
15838 (org-without-partial-completion
15839 (completing-read "Tags: " 'org-tags-completion-function
15840 nil nil current 'org-tags-history)))))))
15841 (while (string-match "[-+&]+" tags)
15842 ;; No boolean logic, just a list
15843 (setq tags (replace-match ":" t t tags))))
15846 (setq tags "")
15847 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15848 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15850 ;; Insert new tags at the correct column
15851 (beginning-of-line 1)
15852 (cond
15853 ((and (equal current "") (equal tags "")))
15854 ((re-search-forward
15856 (point-at-eol) t)
15857 (if (equal tags "")
15858 (setq rpl "")
15859 (goto-char (match-beginning 0))
15860 (setq c0 (current-column) p0 (point)
15861 c1 (max (1+ c0) (if (> org-tags-column 0)
15862 org-tags-column
15863 (- (- org-tags-column) (length tags))))
15864 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15865 (replace-match rpl t t)
15866 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15867 tags)
15868 (t (error "Tags alignment failed")))
15869 (move-to-column col)
15870 (unless just-align
15871 (run-hooks 'org-after-tags-change-hook)))))
15873 (defun org-change-tag-in-region (beg end tag off)
15874 "Add or remove TAG for each entry in the region.
15875 This works in the agenda, and also in an org-mode buffer."
15876 (interactive
15877 (list (region-beginning) (region-end)
15878 (let ((org-last-tags-completion-table
15879 (if (org-mode-p)
15880 (org-get-buffer-tags)
15881 (org-global-tags-completion-table))))
15882 (completing-read
15883 "Tag: " 'org-tags-completion-function nil nil nil
15884 'org-tags-history))
15885 (progn
15886 (message "[s]et or [r]emove? ")
15887 (equal (read-char-exclusive) ?r))))
15888 (if (fboundp 'deactivate-mark) (deactivate-mark))
15889 (let ((agendap (equal major-mode 'org-agenda-mode))
15890 l1 l2 m buf pos newhead (cnt 0))
15891 (goto-char end)
15892 (setq l2 (1- (org-current-line)))
15893 (goto-char beg)
15894 (setq l1 (org-current-line))
15895 (loop for l from l1 to l2 do
15896 (goto-line l)
15897 (setq m (get-text-property (point) 'org-hd-marker))
15898 (when (or (and (org-mode-p) (org-on-heading-p))
15899 (and agendap m))
15900 (setq buf (if agendap (marker-buffer m) (current-buffer))
15901 pos (if agendap m (point)))
15902 (with-current-buffer buf
15903 (save-excursion
15904 (save-restriction
15905 (goto-char pos)
15906 (setq cnt (1+ cnt))
15907 (org-toggle-tag tag (if off 'off 'on))
15908 (setq newhead (org-get-heading)))))
15909 (and agendap (org-agenda-change-all-lines newhead m))))
15910 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15912 (defun org-tags-completion-function (string predicate &optional flag)
15913 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15914 (confirm (lambda (x) (stringp (car x)))))
15916 (setq s1 (match-string 1 string)
15917 s2 (match-string 2 string))
15918 (setq s1 "" s2 string))
15919 (cond
15920 ((eq flag nil)
15921 ;; try completion
15922 (setq rtn (try-completion s2 ctable confirm))
15923 (if (stringp rtn)
15924 (setq rtn
15925 (concat s1 s2 (substring rtn (length s2))
15926 (if (and org-add-colon-after-tag-completion
15927 (assoc rtn ctable))
15928 ":" ""))))
15929 rtn)
15930 ((eq flag t)
15931 ;; all-completions
15932 (all-completions s2 ctable confirm)
15933 )
15934 ((eq flag 'lambda)
15935 ;; exact match?
15936 (assoc s2 ctable)))
15937 ))
15939 (defun org-fast-tag-insert (kwd tags face &optional end)
15940 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15941 (insert (format "%-12s" (concat kwd ":"))
15942 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15943 (or end "")))
15945 (defun org-fast-tag-show-exit (flag)
15946 (save-excursion
15947 (goto-line 3)
15949 (replace-match ""))
15950 (when flag
15951 (end-of-line 1)
15952 (move-to-column (- (window-width) 19) t)
15953 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15955 (defun org-set-current-tags-overlay (current prefix)
15956 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15957 (if (featurep 'xemacs)
15958 (org-overlay-display org-tags-overlay (concat prefix s)
15959 'secondary-selection)
15960 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15961 (org-overlay-display org-tags-overlay (concat prefix s)))))
15963 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15964 "Fast tag selection with single keys.
15965 CURRENT is the current list of tags in the headline, INHERITED is the
15966 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15967 possibly with grouping information. TODO-TABLE is a similar table with
15968 TODO keywords, should these have keys assigned to them.
15969 If the keys are nil, a-z are automatically assigned.
15970 Returns the new tags string, or nil to not change the current settings."
15971 (let* ((fulltable (append table todo-table))
15972 (maxlen (apply 'max (mapcar
15973 (lambda (x)
15974 (if (stringp (car x)) (string-width (car x)) 0))
15975 fulltable)))
15976 (buf (current-buffer))
15977 (expert (eq org-fast-tag-selection-single-key 'expert))
15978 (buffer-tags nil)
15979 (fwidth (+ maxlen 3 1 3))
15980 (ncol (/ (- (window-width) 4) fwidth))
15981 (i-face 'org-done)
15982 (c-face 'org-todo)
15983 tg cnt e c char c1 c2 ntable tbl rtn
15984 ov-start ov-end ov-prefix
15985 (exit-after-next org-fast-tag-selection-single-key)
15986 (done-keywords org-done-keywords)
15987 groups ingroup)
15988 (save-excursion
15989 (beginning-of-line 1)
15990 (if (looking-at
15992 (setq ov-start (match-beginning 1)
15993 ov-end (match-end 1)
15994 ov-prefix "")
15995 (setq ov-start (1- (point-at-eol))
15996 ov-end (1+ ov-start))
15998 (setq ov-prefix
15999 (concat
16000 (buffer-substring (1- (point)) (point))
16001 (if (> (current-column) org-tags-column)
16002 " "
16003 (make-string (- org-tags-column (current-column)) ?\ ))))))
16004 (org-move-overlay org-tags-overlay ov-start ov-end)
16005 (save-window-excursion
16006 (if expert
16007 (set-buffer (get-buffer-create " *Org tags*"))
16008 (delete-other-windows)
16009 (split-window-vertically)
16010 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
16011 (erase-buffer)
16012 (org-set-local 'org-done-keywords done-keywords)
16015 (org-fast-tag-show-exit exit-after-next)
16016 (org-set-current-tags-overlay current ov-prefix)
16017 (setq tbl fulltable char ?a cnt 0)
16018 (while (setq e (pop tbl))
16019 (cond
16020 ((equal e '(:startgroup))
16021 (push '() groups) (setq ingroup t)
16022 (when (not (= cnt 0))
16023 (setq cnt 0)
16025 (insert "{ "))
16026 ((equal e '(:endgroup))
16027 (setq ingroup nil cnt 0)
16029 (t
16030 (setq tg (car e) c2 nil)
16031 (if (cdr e)
16032 (setq c (cdr e))
16033 ;; automatically assign a character.
16034 (setq c1 (string-to-char
16035 (downcase (substring
16036 tg (if (= (string-to-char tg) ?@) 1 0)))))
16037 (if (or (rassoc c1 ntable) (rassoc c1 table))
16038 (while (or (rassoc char ntable) (rassoc char table))
16039 (setq char (1+ char)))
16040 (setq c2 c1))
16041 (setq c (or c2 char)))
16042 (if ingroup (push tg (car groups)))
16043 (setq tg (org-add-props tg nil 'face
16044 (cond
16045 ((not (assoc tg table))
16046 (org-get-todo-face tg))
16047 ((member tg current) c-face)
16048 ((member tg inherited) i-face)
16049 (t nil))))
16050 (if (and (= cnt 0) (not ingroup)) (insert " "))
16051 (insert "[" c "] " tg (make-string
16052 (- fwidth 4 (length tg)) ?\ ))
16053 (push (cons tg c) ntable)
16054 (when (= (setq cnt (1+ cnt)) ncol)
16056 (if ingroup (insert " "))
16057 (setq cnt 0)))))
16058 (setq ntable (nreverse ntable))
16060 (goto-char (point-min))
16061 (if (and (not expert) (fboundp 'fit-window-to-buffer))
16062 (fit-window-to-buffer))
16063 (setq rtn
16064 (catch 'exit
16065 (while t
16066 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
16067 (if groups " [!] no groups" " [!]groups")
16068 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
16069 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
16070 (cond
16072 ((= c ?!)
16073 (setq groups (not groups))
16074 (goto-char (point-min))
16075 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
16076 ((= c ?\C-c)
16077 (if (not expert)
16078 (org-fast-tag-show-exit
16079 (setq exit-after-next (not exit-after-next)))
16080 (setq expert nil)
16081 (delete-other-windows)
16082 (split-window-vertically)
16083 (org-switch-to-buffer-other-window " *Org tags*")
16084 (and (fboundp 'fit-window-to-buffer)
16085 (fit-window-to-buffer))))
16086 ((or (= c ?\C-g)
16087 (and (= c ?q) (not (rassoc c ntable))))
16088 (org-detach-overlay org-tags-overlay)
16089 (setq quit-flag t))
16090 ((= c ?\ )
16091 (setq current nil)
16092 (if exit-after-next (setq exit-after-next 'now)))
16094 (condition-case nil
16095 (setq tg (completing-read
16096 "Tag: "
16097 (or buffer-tags
16098 (with-current-buffer buf
16099 (org-get-buffer-tags)))))
16100 (quit (setq tg "")))
16102 (add-to-list 'buffer-tags (list tg))
16103 (if (member tg current)
16104 (setq current (delete tg current))
16105 (push tg current)))
16106 (if exit-after-next (setq exit-after-next 'now)))
16107 ((setq e (rassoc c todo-table) tg (car e))
16108 (with-current-buffer buf
16109 (save-excursion (org-todo tg)))
16110 (if exit-after-next (setq exit-after-next 'now)))
16111 ((setq e (rassoc c ntable) tg (car e))
16112 (if (member tg current)
16113 (setq current (delete tg current))
16114 (loop for g in groups do
16115 (if (member tg g)
16116 (mapc (lambda (x)
16117 (setq current (delete x current)))
16118 g)))
16119 (push tg current))
16120 (if exit-after-next (setq exit-after-next 'now))))
16122 ;; Create a sorted list
16123 (setq current
16124 (sort current
16125 (lambda (a b)
16126 (assoc b (cdr (memq (assoc a ntable) ntable))))))
16127 (if (eq exit-after-next 'now) (throw 'exit t))
16128 (goto-char (point-min))
16129 (beginning-of-line 2)
16130 (delete-region (point) (point-at-eol))
16131 (org-fast-tag-insert "Current" current c-face)
16132 (org-set-current-tags-overlay current ov-prefix)
16133 (while (re-search-forward
16135 (setq tg (match-string 1))
16136 (add-text-properties
16137 (match-beginning 1) (match-end 1)
16138 (list 'face
16139 (cond
16140 ((member tg current) c-face)
16141 ((member tg inherited) i-face)
16142 (t (get-text-property (match-beginning 1) 'face))))))
16143 (goto-char (point-min)))))
16144 (org-detach-overlay org-tags-overlay)
16145 (if rtn
16146 (mapconcat 'identity current ":")
16147 nil))))
16149 (defun org-get-tags-string ()
16150 "Get the TAGS string in the current headline."
16151 (unless (org-on-heading-p t)
16152 (error "Not on a heading"))
16153 (save-excursion
16154 (beginning-of-line 1)
16156 (org-match-string-no-properties 1)
16157 "")))
16159 (defun org-get-tags ()
16160 "Get the list of tags specified in the current headline."
16161 (org-split-string (org-get-tags-string) ":"))
16163 (defun org-get-buffer-tags ()
16164 "Get a table of all tags used in the buffer, for completion."
16165 (let (tags)
16166 (save-excursion
16167 (goto-char (point-min))
16168 (while (re-search-forward
16170 (when (equal (char-after (point-at-bol 0)) ?*)
16171 (mapc (lambda (x) (add-to-list 'tags x))
16172 (org-split-string (org-match-string-no-properties 1) ":")))))
16173 (mapcar 'list tags)))
16176 ;;;; Properties
16178 ;;; Setting and retrieving properties
16180 (defconst org-special-properties
16181 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
16182 "TIMESTAMP" "TIMESTAMP_IA")
16183 "The special properties valid in Org-mode.
16185 These are properties that are not defined in the property drawer,
16186 but in some other way.")
16188 (defconst org-default-properties
16189 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
16190 "LOCATION" "LOGGING" "COLUMNS")
16191 "Some properties that are used by Org-mode for various purposes.
16192 Being in this list makes sure that they are offered for completion.")
16195 "Regular expression matching the first line of a property drawer.")
16198 "Regular expression matching the first line of a property drawer.")
16200 (defun org-property-action ()
16201 "Do an action on properties."
16202 (interactive)
16203 (let (c)
16204 (org-at-property-p)
16205 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
16206 (setq c (read-char-exclusive))
16207 (cond
16208 ((equal c ?s)
16209 (call-interactively 'org-set-property))
16210 ((equal c ?d)
16211 (call-interactively 'org-delete-property))
16212 ((equal c ?D)
16213 (call-interactively 'org-delete-property-globally))
16214 ((equal c ?c)
16215 (call-interactively 'org-compute-property-at-point))
16216 (t (error "No such property action %c" c)))))
16218 (defun org-at-property-p ()
16219 "Is the cursor in a property line?"
16220 ;; FIXME: Does not check if we are actually in the drawer.
16221 ;; FIXME: also returns true on any drawers.....
16222 ;; This is used by C-c C-c for property action.
16223 (save-excursion
16224 (beginning-of-line 1)
16227 (defmacro org-with-point-at (pom &rest body)
16228 "Move to buffer and point of point-or-marker POM for the duration of BODY."
16229 (declare (indent 1) (debug t))
16230 `(save-excursion
16231 (if (markerp pom) (set-buffer (marker-buffer pom)))
16232 (save-excursion
16233 (goto-char (or pom (point)))
16234 ,@body)))
16236 (defun org-get-property-block (&optional beg end force)
16237 "Return the (beg . end) range of the body of the property drawer.
16238 BEG and END can be beginning and end of subtree, if not given
16239 they will be found.
16240 If the drawer does not exist and FORCE is non-nil, create the drawer."
16241 (catch 'exit
16242 (save-excursion
16243 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
16244 (end (or end (progn (outline-next-heading) (point)))))
16245 (goto-char beg)
16246 (if (re-search-forward org-property-start-re end t)
16247 (setq beg (1+ (match-end 0)))
16248 (if force
16249 (save-excursion
16250 (org-insert-property-drawer)
16251 (setq end (progn (outline-next-heading) (point))))
16252 (throw 'exit nil))
16253 (goto-char beg)
16254 (if (re-search-forward org-property-start-re end t)
16255 (setq beg (1+ (match-end 0)))))
16256 (if (re-search-forward org-property-end-re end t)
16257 (setq end (match-beginning 0))
16258 (or force (throw 'exit nil))
16259 (goto-char beg)
16260 (setq end beg)
16261 (org-indent-line-function)
16263 (cons beg end)))))
16265 (defun org-entry-properties (&optional pom which)
16266 "Get all properties of the entry at point-or-marker POM.
16267 This includes the TODO keyword, the tags, time strings for deadline,
16268 scheduled, and clocking, and any additional properties defined in the
16269 entry. The return value is an alist, keys may occur multiple times
16270 if the property key was used several times.
16271 POM may also be nil, in which case the current entry is used.
16272 If WHICH is nil or `all', get all properties. If WHICH is
16273 `special' or `standard', only get that subclass."
16274 (setq which (or which 'all))
16275 (org-with-point-at pom
16276 (let ((clockstr (substring org-clock-string 0 -1))
16277 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
16278 beg end range props sum-props key value string clocksum)
16279 (save-excursion
16280 (when (condition-case nil (org-back-to-heading t) (error nil))
16281 (setq beg (point))
16282 (setq sum-props (get-text-property (point) 'org-summaries))
16283 (setq clocksum (get-text-property (point) :org-clock-minutes))
16284 (outline-next-heading)
16285 (setq end (point))
16286 (when (memq which '(all special))
16287 ;; Get the special properties, like TODO and tags
16288 (goto-char beg)
16289 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16290 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16291 (when (looking-at org-priority-regexp)
16292 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16293 (when (and (setq value (org-get-tags-string))
16295 (push (cons "TAGS" value) props))
16296 (when (setq value (org-get-tags-at))
16297 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16298 props))
16299 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16300 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16301 string (if (equal key clockstr)
16302 (org-no-properties
16303 (org-trim
16304 (buffer-substring
16305 (match-beginning 3) (goto-char (point-at-eol)))))
16306 (substring (org-match-string-no-properties 3) 1 -1)))
16307 (unless key
16308 (if (= (char-after (match-beginning 3)) ?\[)
16309 (setq key "TIMESTAMP_IA")
16310 (setq key "TIMESTAMP")))
16311 (when (or (equal key clockstr) (not (assoc key props)))
16312 (push (cons key string) props)))
16314 )
16316 (when (memq which '(all standard))
16317 ;; Get the standard properties, like :PORP: ...
16318 (setq range (org-get-property-block beg end))
16319 (when range
16320 (goto-char (car range))
16321 (while (re-search-forward
16323 (cdr range) t)
16324 (setq key (org-match-string-no-properties 1)
16325 value (org-trim (or (org-match-string-no-properties 2) "")))
16326 (unless (member key excluded)
16327 (push (cons key (or value "")) props)))))
16328 (if clocksum
16329 (push (cons "CLOCKSUM"
16330 (org-column-number-to-string (/ (float clocksum) 60.)
16331 'add_times))
16332 props))
16333 (append sum-props (nreverse props)))))))
16335 (defun org-entry-get (pom property &optional inherit)
16336 "Get value of PROPERTY for entry at point-or-marker POM.
16337 If INHERIT is non-nil and the entry does not have the property,
16338 then also check higher levels of the hierarchy.
16339 If the property is present but empty, the return value is the empty string.
16340 If the property is not present at all, nil is returned."
16341 (org-with-point-at pom
16342 (if inherit
16343 (org-entry-get-with-inheritance property)
16344 (if (member property org-special-properties)
16345 ;; We need a special property. Use brute force, get all properties.
16346 (cdr (assoc property (org-entry-properties nil 'special)))
16347 (let ((range (org-get-property-block)))
16348 (if (and range
16349 (goto-char (car range))
16350 (re-search-forward
16352 (cdr range) t))
16353 ;; Found the property, return it.
16354 (if (match-end 1)
16355 (org-match-string-no-properties 1)
16356 "")))))))
16358 (defun org-entry-delete (pom property)
16359 "Delete the property PROPERTY from entry at point-or-marker POM."
16360 (org-with-point-at pom
16361 (if (member property org-special-properties)
16362 nil ; cannot delete these properties.
16363 (let ((range (org-get-property-block)))
16364 (if (and range
16365 (goto-char (car range))
16366 (re-search-forward
16368 (cdr range) t))
16369 (progn
16370 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16371 t)
16372 nil)))))
16374 ;; Multi-values properties are properties that contain multiple values
16375 ;; These values are assumed to be single words, separated by whitespace.
16376 (defun org-entry-add-to-multivalued-property (pom property value)
16377 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16378 (let* ((old (org-entry-get pom property))
16380 (unless (member value values)
16381 (setq values (cons value values))
16382 (org-entry-put pom property
16383 (mapconcat 'identity values " ")))))
16385 (defun org-entry-remove-from-multivalued-property (pom property value)
16386 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16387 (let* ((old (org-entry-get pom property))
16389 (when (member value values)
16390 (setq values (delete value values))
16391 (org-entry-put pom property
16392 (mapconcat 'identity values " ")))))
16394 (defun org-entry-member-in-multivalued-property (pom property value)
16395 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16396 (let* ((old (org-entry-get pom property))
16398 (member value values)))
16400 (defvar org-entry-property-inherited-from (make-marker))
16402 (defun org-entry-get-with-inheritance (property)
16403 "Get entry property, and search higher levels if not present."
16404 (let (tmp)
16405 (save-excursion
16406 (save-restriction
16407 (widen)
16408 (catch 'ex
16409 (while t
16410 (when (setq tmp (org-entry-get nil property))
16411 (org-back-to-heading t)
16412 (move-marker org-entry-property-inherited-from (point))
16413 (throw 'ex tmp))
16414 (or (org-up-heading-safe) (throw 'ex nil)))))
16415 (or tmp (cdr (assoc property org-local-properties))
16416 (cdr (assoc property org-global-properties))))))
16418 (defun org-entry-put (pom property value)
16419 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16420 (org-with-point-at pom
16421 (org-back-to-heading t)
16422 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16423 range)
16424 (cond
16425 ((equal property "TODO")
16427 (not (member value org-todo-keywords-1)))
16429 (if (or (not value)
16431 (setq value 'none))
16432 (org-todo value)
16433 (org-set-tags nil 'align))
16434 ((equal property "PRIORITY")
16436 (string-to-char value) ?\ ))
16437 (org-set-tags nil 'align))
16438 ((equal property "SCHEDULED")
16439 (if (re-search-forward org-scheduled-time-regexp end t)
16440 (cond
16441 ((eq value 'earlier) (org-timestamp-change -1 'day))
16442 ((eq value 'later) (org-timestamp-change 1 'day))
16443 (t (call-interactively 'org-schedule)))
16444 (call-interactively 'org-schedule)))
16445 ((equal property "DEADLINE")
16446 (if (re-search-forward org-deadline-time-regexp end t)
16447 (cond
16448 ((eq value 'earlier) (org-timestamp-change -1 'day))
16449 ((eq value 'later) (org-timestamp-change 1 'day))
16450 (t (call-interactively 'org-deadline)))
16451 (call-interactively 'org-deadline)))
16452 ((member property org-special-properties)
16453 (error "The %s property can not yet be set with `org-entry-put'"
16454 property))
16455 (t ; a non-special property
16456 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16457 (setq range (org-get-property-block beg end 'force))
16458 (goto-char (car range))
16459 (if (re-search-forward
16461 (progn
16462 (delete-region (match-beginning 1) (match-end 1))
16463 (goto-char (match-beginning 1)))
16464 (goto-char (cdr range))
16466 (backward-char 1)
16467 (org-indent-line-function)
16468 (insert ":" property ":"))
16469 (and value (insert " " value))
16470 (org-indent-line-function)))))))
16472 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16473 "Get all property keys in the current buffer.
16474 With INCLUDE-SPECIALS, also list the special properties that relect things
16475 like tags and TODO state.
16476 With INCLUDE-DEFAULTS, also include properties that has special meaning
16477 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16478 With INCLUDE-COLUMNS, also include property names given in COLUMN
16479 formats in the current buffer."
16480 (let (rtn range cfmt cols s p)
16481 (save-excursion
16482 (save-restriction
16483 (widen)
16484 (goto-char (point-min))
16485 (while (re-search-forward org-property-start-re nil t)
16486 (setq range (org-get-property-block))
16487 (goto-char (car range))
16488 (while (re-search-forward
16490 (cdr range) t)
16491 (add-to-list 'rtn (org-match-string-no-properties 1)))
16492 (outline-next-heading))))
16494 (when include-specials
16495 (setq rtn (append org-special-properties rtn)))
16497 (when include-defaults
16498 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16500 (when include-columns
16501 (save-excursion
16502 (save-restriction
16503 (widen)
16504 (goto-char (point-min))
16505 (while (re-search-forward
16507 nil t)
16508 (setq cfmt (match-string 2) s 0)
16510 cfmt s)
16511 (setq s (match-end 0)
16512 p (match-string 1 cfmt))
16513 (unless (or (equal p "ITEM")
16514 (member p org-special-properties))
16515 (add-to-list 'rtn (match-string 1 cfmt))))))))
16517 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16519 (defun org-property-values (key)
16520 "Return a list of all values of property KEY."
16521 (save-excursion
16522 (save-restriction
16523 (widen)
16524 (goto-char (point-min))
16526 values)
16527 (while (re-search-forward re nil t)
16528 (add-to-list 'values (org-trim (match-string 1))))
16529 (delete "" values)))))
16531 (defun org-insert-property-drawer ()
16532 "Insert a property drawer into the current entry."
16533 (interactive)
16534 (org-back-to-heading t)
16535 (looking-at outline-regexp)
16536 (let ((indent (- (match-end 0)(match-beginning 0)))
16537 (beg (point))
16539 end hiddenp)
16540 (outline-next-heading)
16541 (setq end (point))
16542 (goto-char beg)
16543 (while (re-search-forward re end t))
16544 (setq hiddenp (org-invisible-p))
16545 (end-of-line 1)
16547 (org-skip-over-state-notes)
16549 (if (eq (char-before) ?*) (forward-char 1))
16551 (beginning-of-line 0)
16552 (indent-to-column indent)
16553 (beginning-of-line 2)
16554 (indent-to-column indent)
16555 (beginning-of-line 0)
16556 (if hiddenp
16557 (save-excursion
16558 (org-back-to-heading t)
16559 (hide-entry))
16560 (org-flag-drawer t))))
16562 (defun org-set-property (property value)
16563 "In the current entry, set PROPERTY to VALUE.
16564 When called interactively, this will prompt for a property name, offering
16565 completion on existing and default properties. And then it will prompt
16566 for a value, offering competion either on allowed values (via an inherited
16567 xxx_ALL property) or on existing values in other instances of this property
16568 in the current file."
16569 (interactive
16570 (let* ((prop (completing-read
16571 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16572 (cur (org-entry-get nil prop))
16573 (allowed (org-property-get-allowed-values nil prop 'table))
16574 (existing (mapcar 'list (org-property-values prop)))
16575 (val (if allowed
16576 (completing-read "Value: " allowed nil 'req-match)
16577 (completing-read
16579 (concat "[" cur "]") "")
16580 ": ")
16581 existing nil nil "" nil cur))))
16582 (list prop (if (equal val "") cur val))))
16583 (unless (equal (org-entry-get nil property) value)
16584 (org-entry-put nil property value)))
16586 (defun org-delete-property (property)
16587 "In the current entry, delete PROPERTY."
16588 (interactive
16589 (let* ((prop (completing-read
16590 "Property: " (org-entry-properties nil 'standard))))
16591 (list prop)))
16592 (message "Property %s %s" property
16593 (if (org-entry-delete nil property)
16594 "deleted"
16595 "was not present in the entry")))
16597 (defun org-delete-property-globally (property)
16598 "Remove PROPERTY globally, from all entries."
16599 (interactive
16600 (let* ((prop (completing-read
16601 "Globally remove property: "
16602 (mapcar 'list (org-buffer-property-keys)))))
16603 (list prop)))
16604 (save-excursion
16605 (save-restriction
16606 (widen)
16607 (goto-char (point-min))
16608 (let ((cnt 0))
16609 (while (re-search-forward
16611 nil t)
16612 (setq cnt (1+ cnt))
16613 (replace-match ""))
16616 (defvar org-columns-current-fmt-compiled) ; defined below
16618 (defun org-compute-property-at-point ()
16619 "Compute the property at point.
16620 This looks for an enclosing column format, extracts the operator and
16621 then applies it to the proerty in the column format's scope."
16622 (interactive)
16623 (unless (org-at-property-p)
16624 (error "Not at a property"))
16625 (let ((prop (org-match-string-no-properties 2)))
16626 (org-columns-get-format-and-top-level)
16627 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16628 (error "No operator defined for property %s" prop))
16629 (org-columns-compute prop)))
16631 (defun org-property-get-allowed-values (pom property &optional table)
16632 "Get allowed values for the property PROPERTY.
16633 When TABLE is non-nil, return an alist that can directly be used for
16634 completion."
16635 (let (vals)
16636 (cond
16637 ((equal property "TODO")
16638 (setq vals (org-with-point-at pom
16639 (append org-todo-keywords-1 '("")))))
16640 ((equal property "PRIORITY")
16641 (let ((n org-lowest-priority))
16642 (while (>= n org-highest-priority)
16643 (push (char-to-string n) vals)
16644 (setq n (1- n)))))
16645 ((member property org-special-properties))
16646 (t
16647 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16650 (setq vals (car (read-from-string (concat "(" vals ")"))))
16651 (setq vals (mapcar (lambda (x)
16652 (cond ((stringp x) x)
16653 ((numberp x) (number-to-string x))
16654 ((symbolp x) (symbol-name x))
16655 (t "???")))
16656 vals)))))
16657 (if table (mapcar 'list vals) vals)))
16659 (defun org-property-previous-allowed-value (&optional previous)
16660 "Switch to the next allowed value for this property."
16661 (interactive)
16662 (org-property-next-allowed-value t))
16664 (defun org-property-next-allowed-value (&optional previous)
16665 "Switch to the next allowed value for this property."
16666 (interactive)
16667 (unless (org-at-property-p)
16668 (error "Not at a property"))
16669 (let* ((key (match-string 2))
16670 (value (match-string 3))
16671 (allowed (or (org-property-get-allowed-values (point) key)
16672 (and (member value '("[ ]" "[-]" "[X]"))
16673 '("[ ]" "[X]"))))
16674 nval)
16675 (unless allowed
16676 (error "Allowed values for this property have not been defined"))
16677 (if previous (setq allowed (reverse allowed)))
16678 (if (member value allowed)
16679 (setq nval (car (cdr (member value allowed)))))
16680 (setq nval (or nval (car allowed)))
16681 (if (equal nval value)
16682 (error "Only one allowed value for this property"))
16683 (org-at-property-p)
16684 (replace-match (concat " :" key ": " nval) t t)
16685 (org-indent-line-function)
16686 (beginning-of-line 1)
16689 (defun org-find-entry-with-id (ident)
16690 "Locate the entry that contains the ID property with exact value IDENT.
16691 IDENT can be a string, a symbol or a number, this function will search for
16692 the string representation of it.
16693 Return the position where this entry starts, or nil if there is no such entry."
16694 (let ((id (cond
16695 ((stringp ident) ident)
16696 ((symbol-name ident) (symbol-name ident))
16697 ((numberp ident) (number-to-string ident))
16698 (t (error "IDENT %s must be a string, symbol or number" ident))))
16699 (case-fold-search nil))
16700 (save-excursion
16701 (save-restriction
16702 (widen)
16703 (goto-char (point-min))
16704 (when (re-search-forward
16706 nil t)
16707 (org-back-to-heading)
16708 (point))))))
16710 ;;; Column View
16712 (defvar org-columns-overlays nil
16713 "Holds the list of current column overlays.")
16715 (defvar org-columns-current-fmt nil
16716 "Local variable, holds the currently active column format.")
16717 (defvar org-columns-current-fmt-compiled nil
16718 "Local variable, holds the currently active column format.
16719 This is the compiled version of the format.")
16720 (defvar org-columns-current-widths nil
16721 "Loval variable, holds the currently widths of fields.")
16722 (defvar org-columns-current-maxwidths nil
16723 "Loval variable, holds the currently active maximum column widths.")
16724 (defvar org-columns-begin-marker (make-marker)
16725 "Points to the position where last a column creation command was called.")
16726 (defvar org-columns-top-level-marker (make-marker)
16727 "Points to the position where current columns region starts.")
16729 (defvar org-columns-map (make-sparse-keymap)
16730 "The keymap valid in column display.")
16732 (defun org-columns-content ()
16733 "Switch to contents view while in columns view."
16734 (interactive)
16735 (org-overview)
16736 (org-content))
16738 (org-defkey org-columns-map "c" 'org-columns-content)
16739 (org-defkey org-columns-map "o" 'org-overview)
16740 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16741 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16742 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16743 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16744 (org-defkey org-columns-map "v" 'org-columns-show-value)
16745 (org-defkey org-columns-map "q" 'org-columns-quit)
16746 (org-defkey org-columns-map "r" 'org-columns-redo)
16747 (org-defkey org-columns-map "g" 'org-columns-redo)
16748 (org-defkey org-columns-map [left] 'backward-char)
16749 (org-defkey org-columns-map "\M-b" 'backward-char)
16750 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16751 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16752 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16753 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16754 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16755 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16756 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16757 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16758 (org-defkey org-columns-map "<" 'org-columns-narrow)
16759 (org-defkey org-columns-map ">" 'org-columns-widen)
16760 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16761 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16762 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16763 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16765 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16766 '("Column"
16767 ["Edit property" org-columns-edit-value t]
16768 ["Next allowed value" org-columns-next-allowed-value t]
16769 ["Previous allowed value" org-columns-previous-allowed-value t]
16770 ["Show full value" org-columns-show-value t]
16771 ["Edit allowed values" org-columns-edit-allowed t]
16772 "--"
16773 ["Edit column attributes" org-columns-edit-attributes t]
16774 ["Increase column width" org-columns-widen t]
16775 ["Decrease column width" org-columns-narrow t]
16776 "--"
16777 ["Move column right" org-columns-move-right t]
16778 ["Move column left" org-columns-move-left t]
16779 ["Add column" org-columns-new t]
16780 ["Delete column" org-columns-delete t]
16781 "--"
16782 ["CONTENTS" org-columns-content t]
16783 ["OVERVIEW" org-overview t]
16784 ["Refresh columns display" org-columns-redo t]
16785 "--"
16786 ["Open link" org-columns-open-link t]
16787 "--"
16788 ["Quit" org-columns-quit t]))
16790 (defun org-columns-new-overlay (beg end &optional string face)
16791 "Create a new column overlay and add it to the list."
16792 (let ((ov (org-make-overlay beg end)))
16793 (org-overlay-put ov 'face (or face 'secondary-selection))
16794 (org-overlay-display ov string face)
16795 (push ov org-columns-overlays)
16796 ov))
16798 (defun org-columns-display-here (&optional props)
16799 "Overlay the current line with column display."
16800 (interactive)
16801 (let* ((fmt org-columns-current-fmt-compiled)
16802 (beg (point-at-bol))
16803 (level-face (save-excursion
16804 (beginning-of-line 1)
16806 (org-get-level-face 2))))
16807 (color (list :foreground
16808 (face-attribute (or level-face 'default) :foreground)))
16809 props pom property ass width f string ov column val modval)
16810 ;; Check if the entry is in another buffer.
16811 (unless props
16812 (if (eq major-mode 'org-agenda-mode)
16813 (setq pom (or (get-text-property (point) 'org-hd-marker)
16814 (get-text-property (point) 'org-marker))
16815 props (if pom (org-entry-properties pom) nil))
16816 (setq props (org-entry-properties nil))))
16817 ;; Walk the format
16818 (while (setq column (pop fmt))
16819 (setq property (car column)
16820 ass (if (equal property "ITEM")
16821 (cons "ITEM"
16822 (save-match-data
16823 (org-no-properties
16824 (org-remove-tabs
16825 (buffer-substring-no-properties
16826 (point-at-bol) (point-at-eol))))))
16827 (assoc property props))
16828 width (or (cdr (assoc property org-columns-current-maxwidths))
16829 (nth 2 column)
16830 (length property))
16831 f (format "%%-%d.%ds | " width width)
16832 val (or (cdr ass) "")
16833 modval (if (equal property "ITEM")
16834 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16835 string (format f (or modval val)))
16836 ;; Create the overlay
16837 (org-unmodified
16838 (setq ov (org-columns-new-overlay
16839 beg (setq beg (1+ beg)) string
16840 (list color 'org-column)))
16841 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16842 (org-overlay-put ov 'keymap org-columns-map)
16843 (org-overlay-put ov 'org-columns-key property)
16844 (org-overlay-put ov 'org-columns-value (cdr ass))
16845 (org-overlay-put ov 'org-columns-value-modified modval)
16846 (org-overlay-put ov 'org-columns-pom pom)
16847 (org-overlay-put ov 'org-columns-format f))
16848 (if (or (not (char-after beg))
16850 (let ((inhibit-read-only t))
16851 (save-excursion
16852 (goto-char beg)
16853 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16854 ;; Make the rest of the line disappear.
16855 (org-unmodified
16856 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16857 (org-overlay-put ov 'invisible t)
16858 (org-overlay-put ov 'keymap org-columns-map)
16859 (org-overlay-put ov 'intangible t)
16860 (push ov org-columns-overlays)
16861 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16862 (org-overlay-put ov 'keymap org-columns-map)
16863 (push ov org-columns-overlays)
16864 (let ((inhibit-read-only t))
16865 (put-text-property (max (point-min) (1- (point-at-bol)))
16866 (min (point-max) (1+ (point-at-eol)))
16867 'read-only "Type `e' to edit property")))))
16869 (defvar org-previous-header-line-format nil
16870 "The header line format before column view was turned on.")
16871 (defvar org-columns-inhibit-recalculation nil
16872 "Inhibit recomputing of columns on column view startup.")
16875 (defvar header-line-format)
16876 (defun org-columns-display-here-title ()
16877 "Overlay the newline before the current line with the table title."
16878 (interactive)
16879 (let ((fmt org-columns-current-fmt-compiled)
16880 string (title "")
16881 property width f column str widths)
16882 (while (setq column (pop fmt))
16883 (setq property (car column)
16884 str (or (nth 1 column) property)
16885 width (or (cdr (assoc property org-columns-current-maxwidths))
16886 (nth 2 column)
16887 (length str))
16888 widths (push width widths)
16889 f (format "%%-%d.%ds | " width width)
16890 string (format f str)
16891 title (concat title string)))
16892 (setq title (concat
16893 (org-add-props " " nil 'display '(space :align-to 0))
16894 (org-add-props title nil 'face '(:weight bold :underline t))))
16895 (org-set-local 'org-previous-header-line-format header-line-format)
16896 (org-set-local 'org-columns-current-widths (nreverse widths))
16897 (setq header-line-format title)))
16899 (defun org-columns-remove-overlays ()
16900 "Remove all currently active column overlays."
16901 (interactive)
16902 (when (marker-buffer org-columns-begin-marker)
16903 (with-current-buffer (marker-buffer org-columns-begin-marker)
16904 (when (local-variable-p 'org-previous-header-line-format)
16905 (setq header-line-format org-previous-header-line-format)
16906 (kill-local-variable 'org-previous-header-line-format))
16907 (move-marker org-columns-begin-marker nil)
16908 (move-marker org-columns-top-level-marker nil)
16909 (org-unmodified
16910 (mapc 'org-delete-overlay org-columns-overlays)
16911 (setq org-columns-overlays nil)
16912 (let ((inhibit-read-only t))
16913 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16915 (defun org-columns-cleanup-item (item fmt)
16916 "Remove from ITEM what is a column in the format FMT."
16917 (if (not org-complex-heading-regexp)
16918 item
16919 (when (string-match org-complex-heading-regexp item)
16920 (concat
16921 (org-add-props (concat (match-string 1 item) " ") nil
16922 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16923 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16924 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16925 " " (match-string 4 item)
16926 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16928 (defun org-columns-show-value ()
16929 "Show the full value of the property."
16930 (interactive)
16931 (let ((value (get-char-property (point) 'org-columns-value)))
16932 (message "Value is: %s" (or value ""))))
16934 (defun org-columns-quit ()
16935 "Remove the column overlays and in this way exit column editing."
16936 (interactive)
16937 (org-unmodified
16938 (org-columns-remove-overlays)
16939 (let ((inhibit-read-only t))
16940 (remove-text-properties (point-min) (point-max) '(read-only t))))
16941 (when (eq major-mode 'org-agenda-mode)
16942 (message
16943 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16945 (defun org-columns-check-computed ()
16946 "Check if this column value is computed.
16947 If yes, throw an error indicating that changing it does not make sense."
16948 (let ((val (get-char-property (point) 'org-columns-value)))
16949 (when (and (stringp val)
16950 (get-char-property 0 'org-computed val))
16951 (error "This value is computed from the entry's children"))))
16953 (defun org-columns-todo (&optional arg)
16954 "Change the TODO state during column view."
16955 (interactive "P")
16956 (org-columns-edit-value "TODO"))
16958 (defun org-columns-set-tags-or-toggle (&optional arg)
16959 "Toggle checkbox at point, or set tags for current headline."
16960 (interactive "P")
16962 (get-char-property (point) 'org-columns-value))
16963 (org-columns-next-allowed-value)
16964 (org-columns-edit-value "TAGS")))
16966 (defun org-columns-edit-value (&optional key)
16967 "Edit the value of the property at point in column view.
16968 Where possible, use the standard interface for changing this line."
16969 (interactive)
16970 (org-columns-check-computed)
16971 (let* ((external-key key)
16972 (col (current-column))
16973 (key (or key (get-char-property (point) 'org-columns-key)))
16974 (value (get-char-property (point) 'org-columns-value))
16975 (bol (point-at-bol)) (eol (point-at-eol))
16976 (pom (or (get-text-property bol 'org-hd-marker)
16977 (point))) ; keep despite of compiler waring
16978 (line-overlays
16979 (delq nil (mapcar (lambda (x)
16980 (and (eq (overlay-buffer x) (current-buffer))
16981 (>= (overlay-start x) bol)
16982 (<= (overlay-start x) eol)
16983 x))
16984 org-columns-overlays)))
16985 nval eval allowed)
16986 (cond
16987 ((equal key "CLOCKSUM")
16988 (error "This special column cannot be edited"))
16989 ((equal key "ITEM")
16990 (setq eval '(org-with-point-at pom
16991 (org-edit-headline))))
16992 ((equal key "TODO")
16993 (setq eval '(org-with-point-at pom
16994 (let ((current-prefix-arg
16995 (if external-key current-prefix-arg '(4))))
16996 (call-interactively 'org-todo)))))
16997 ((equal key "PRIORITY")
16998 (setq eval '(org-with-point-at pom
16999 (call-interactively 'org-priority))))
17000 ((equal key "TAGS")
17001 (setq eval '(org-with-point-at pom
17002 (let ((org-fast-tag-selection-single-key
17003 (if (eq org-fast-tag-selection-single-key 'expert)
17004 t org-fast-tag-selection-single-key)))
17005 (call-interactively 'org-set-tags)))))
17006 ((equal key "DEADLINE")
17007 (setq eval '(org-with-point-at pom
17008 (call-interactively 'org-deadline))))
17009 ((equal key "SCHEDULED")
17010 (setq eval '(org-with-point-at pom
17011 (call-interactively 'org-schedule))))
17012 (t
17013 (setq allowed (org-property-get-allowed-values pom key 'table))
17014 (if allowed
17015 (setq nval (completing-read "Value: " allowed nil t))
17016 (setq nval (read-string "Edit: " value)))
17017 (setq nval (org-trim nval))
17018 (when (not (equal nval value))
17019 (setq eval '(org-entry-put pom key nval)))))
17020 (when eval
17021 (let ((inhibit-read-only t))
17022 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
17023 (unwind-protect
17024 (progn
17025 (setq org-columns-overlays
17026 (org-delete-all line-overlays org-columns-overlays))
17027 (mapc 'org-delete-overlay line-overlays)
17028 (org-columns-eval eval))
17029 (org-columns-display-here))))
17030 (move-to-column col)
17031 (if (and (org-mode-p)
17032 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17033 (org-columns-update key))))
17035 (defun org-edit-headline () ; FIXME: this is not columns specific
17036 "Edit the current headline, the part without TODO keyword, TAGS."
17037 (org-back-to-heading)
17038 (when (looking-at org-todo-line-regexp)
17039 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
17040 (txt (match-string 3))
17041 (post "")
17042 txt2)
17044 (setq post (match-string 0 txt)
17045 txt (substring txt 0 (match-beginning 0))))
17046 (setq txt2 (read-string "Edit: " txt))
17047 (when (not (equal txt txt2))
17048 (beginning-of-line 1)
17049 (insert pre txt2 post)
17050 (delete-region (point) (point-at-eol))
17051 (org-set-tags nil t)))))
17053 (defun org-columns-edit-allowed ()
17054 "Edit the list of allowed values for the current property."
17055 (interactive)
17056 (let* ((key (get-char-property (point) 'org-columns-key))
17057 (key1 (concat key "_ALL"))
17058 (allowed (org-entry-get (point) key1 t))
17059 nval)
17060 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
17061 (setq nval (read-string "Allowed: " allowed))
17062 (org-entry-put
17063 (cond ((marker-position org-entry-property-inherited-from)
17064 org-entry-property-inherited-from)
17065 ((marker-position org-columns-top-level-marker)
17066 org-columns-top-level-marker))
17067 key1 nval)))
17069 (defmacro org-no-warnings (&rest body)
17070 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
17072 (defun org-columns-eval (form)
17073 (let (hidep)
17074 (save-excursion
17075 (beginning-of-line 1)
17076 ;; `next-line' is needed here, because it skips invisible line.
17077 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
17078 (setq hidep (org-on-heading-p 1)))
17079 (eval form)
17080 (and hidep (hide-entry))))
17082 (defun org-columns-previous-allowed-value ()
17083 "Switch to the previous allowed value for this column."
17084 (interactive)
17085 (org-columns-next-allowed-value t))
17087 (defun org-columns-next-allowed-value (&optional previous)
17088 "Switch to the next allowed value for this column."
17089 (interactive)
17090 (org-columns-check-computed)
17091 (let* ((col (current-column))
17092 (key (get-char-property (point) 'org-columns-key))
17093 (value (get-char-property (point) 'org-columns-value))
17094 (bol (point-at-bol)) (eol (point-at-eol))
17095 (pom (or (get-text-property bol 'org-hd-marker)
17096 (point))) ; keep despite of compiler waring
17097 (line-overlays
17098 (delq nil (mapcar (lambda (x)
17099 (and (eq (overlay-buffer x) (current-buffer))
17100 (>= (overlay-start x) bol)
17101 (<= (overlay-start x) eol)
17102 x))
17103 org-columns-overlays)))
17104 (allowed (or (org-property-get-allowed-values pom key)
17105 (and (memq
17106 (nth 4 (assoc key org-columns-current-fmt-compiled))
17107 '(checkbox checkbox-n-of-m checkbox-percent))
17108 '("[ ]" "[X]"))))
17109 nval)
17110 (when (equal key "ITEM")
17111 (error "Cannot edit item headline from here"))
17112 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
17113 (error "Allowed values for this property have not been defined"))
17114 (if (member key '("SCHEDULED" "DEADLINE"))
17115 (setq nval (if previous 'earlier 'later))
17116 (if previous (setq allowed (reverse allowed)))
17117 (if (member value allowed)
17118 (setq nval (car (cdr (member value allowed)))))
17119 (setq nval (or nval (car allowed)))
17120 (if (equal nval value)
17121 (error "Only one allowed value for this property")))
17122 (let ((inhibit-read-only t))
17123 (remove-text-properties (1- bol) eol '(read-only t))
17124 (unwind-protect
17125 (progn
17126 (setq org-columns-overlays
17127 (org-delete-all line-overlays org-columns-overlays))
17128 (mapc 'org-delete-overlay line-overlays)
17129 (org-columns-eval '(org-entry-put pom key nval)))
17130 (org-columns-display-here)))
17131 (move-to-column col)
17132 (if (and (org-mode-p)
17133 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17134 (org-columns-update key))))
17136 (defun org-verify-version (task)
17137 (cond
17138 ((eq task 'columns)
17139 (if (or (featurep 'xemacs)
17140 (< emacs-major-version 22))
17141 (error "Emacs 22 is required for the columns feature")))))
17143 (defun org-columns-open-link (&optional arg)
17144 (interactive "P")
17145 (let ((value (get-char-property (point) 'org-columns-value)))
17146 (org-open-link-from-string value arg)))
17148 (defun org-open-link-from-string (s &optional arg)
17149 "Open a link in the string S, as if it was in Org-mode."
17150 (interactive)
17151 (with-temp-buffer
17152 (let ((org-inhibit-startup t))
17153 (org-mode)
17154 (insert s)
17155 (goto-char (point-min))
17156 (org-open-at-point arg))))
17158 (defun org-columns-get-format-and-top-level ()
17159 (let (fmt)
17160 (when (condition-case nil (org-back-to-heading) (error nil))
17161 (move-marker org-entry-property-inherited-from nil)
17162 (setq fmt (org-entry-get nil "COLUMNS" t)))
17163 (setq fmt (or fmt org-columns-default-format))
17164 (org-set-local 'org-columns-current-fmt fmt)
17165 (org-columns-compile-format fmt)
17166 (if (marker-position org-entry-property-inherited-from)
17167 (move-marker org-columns-top-level-marker
17168 org-entry-property-inherited-from)
17169 (move-marker org-columns-top-level-marker (point)))
17170 fmt))
17172 (defun org-columns ()
17173 "Turn on column view on an org-mode file."
17174 (interactive)
17175 (org-verify-version 'columns)
17176 (org-columns-remove-overlays)
17177 (move-marker org-columns-begin-marker (point))
17178 (let (beg end fmt cache maxwidths)
17179 (setq fmt (org-columns-get-format-and-top-level))
17180 (save-excursion
17181 (goto-char org-columns-top-level-marker)
17182 (setq beg (point))
17183 (unless org-columns-inhibit-recalculation
17184 (org-columns-compute-all))
17185 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
17186 (point-max)))
17187 ;; Get and cache the properties
17188 (goto-char beg)
17189 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
17190 (save-excursion
17191 (save-restriction
17192 (narrow-to-region beg end)
17193 (org-clock-sum))))
17194 (while (re-search-forward (concat "^" outline-regexp) end t)
17195 (push (cons (org-current-line) (org-entry-properties)) cache))
17196 (when cache
17197 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17198 (org-set-local 'org-columns-current-maxwidths maxwidths)
17199 (org-columns-display-here-title)
17200 (mapc (lambda (x)
17201 (goto-line (car x))
17202 (org-columns-display-here (cdr x)))
17203 cache)))))
17205 (defun org-columns-new (&optional prop title width op fmt &rest rest)
17206 "Insert a new column, to the leeft o the current column."
17207 (interactive)
17208 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
17209 cell)
17210 (setq prop (completing-read
17211 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
17212 nil nil prop))
17213 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
17214 (setq width (read-string "Column width: " (if width (number-to-string width))))
17216 (setq width (string-to-number width))
17217 (setq width nil))
17218 (setq fmt (completing-read "Summary [none]: "
17219 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
17220 nil t))
17222 (setq fmt (intern fmt))
17223 (setq fmt nil))
17224 (if (eq fmt 'none) (setq fmt nil))
17225 (if editp
17226 (progn
17227 (setcar editp prop)
17228 (setcdr editp (list title width nil fmt)))
17229 (setq cell (nthcdr (1- (current-column))
17230 org-columns-current-fmt-compiled))
17231 (setcdr cell (cons (list prop title width nil fmt)
17232 (cdr cell))))
17233 (org-columns-store-format)
17234 (org-columns-redo)))
17236 (defun org-columns-delete ()
17237 "Delete the column at point from columns view."
17238 (interactive)
17239 (let* ((n (current-column))
17240 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
17241 (when (y-or-n-p
17243 (setq org-columns-current-fmt-compiled
17244 (delq (nth n org-columns-current-fmt-compiled)
17245 org-columns-current-fmt-compiled))
17246 (org-columns-store-format)
17247 (org-columns-redo)
17248 (if (>= (current-column) (length org-columns-current-fmt-compiled))
17249 (backward-char 1)))))
17251 (defun org-columns-edit-attributes ()
17252 "Edit the attributes of the current column."
17253 (interactive)
17254 (let* ((n (current-column))
17255 (info (nth n org-columns-current-fmt-compiled)))
17256 (apply 'org-columns-new info)))
17258 (defun org-columns-widen (arg)
17259 "Make the column wider by ARG characters."
17260 (interactive "p")
17261 (let* ((n (current-column))
17262 (entry (nth n org-columns-current-fmt-compiled))
17263 (width (or (nth 2 entry)
17264 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
17265 (setq width (max 1 (+ width arg)))
17266 (setcar (nthcdr 2 entry) width)
17267 (org-columns-store-format)
17268 (org-columns-redo)))
17270 (defun org-columns-narrow (arg)
17271 "Make the column nrrower by ARG characters."
17272 (interactive "p")
17273 (org-columns-widen (- arg)))
17275 (defun org-columns-move-right ()
17276 "Swap this column with the one to the right."
17277 (interactive)
17278 (let* ((n (current-column))
17279 (cell (nthcdr n org-columns-current-fmt-compiled))
17280 e)
17281 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17282 (error "Cannot shift this column further to the right"))
17283 (setq e (car cell))
17284 (setcar cell (car (cdr cell)))
17285 (setcdr cell (cons e (cdr (cdr cell))))
17286 (org-columns-store-format)
17287 (org-columns-redo)
17288 (forward-char 1)))
17290 (defun org-columns-move-left ()
17291 "Swap this column with the one to the left."
17292 (interactive)
17293 (let* ((n (current-column)))
17294 (when (= n 0)
17295 (error "Cannot shift this column further to the left"))
17296 (backward-char 1)
17297 (org-columns-move-right)
17298 (backward-char 1)))
17300 (defun org-columns-store-format ()
17301 "Store the text version of the current columns format in appropriate place.
17302 This is either in the COLUMNS property of the node starting the current column
17303 display, or in the #+COLUMNS line of the current buffer."
17304 (let (fmt (cnt 0))
17305 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17306 (org-set-local 'org-columns-current-fmt fmt)
17307 (if (marker-position org-columns-top-level-marker)
17308 (save-excursion
17309 (goto-char org-columns-top-level-marker)
17310 (if (and (org-at-heading-p)
17311 (org-entry-get nil "COLUMNS"))
17312 (org-entry-put nil "COLUMNS" fmt)
17313 (goto-char (point-min))
17314 ;; Overwrite all #+COLUMNS lines....
17316 (setq cnt (1+ cnt))
17317 (replace-match (concat "#+COLUMNS: " fmt) t t))
17318 (unless (> cnt 0)
17319 (goto-char (point-min))
17320 (or (org-on-heading-p t) (outline-next-heading))
17321 (let ((inhibit-read-only t))
17323 (org-set-local 'org-columns-default-format fmt))))))
17325 (defvar org-overriding-columns-format nil
17326 "When set, overrides any other definition.")
17327 (defvar org-agenda-view-columns-initially nil
17328 "When set, switch to columns view immediately after creating the agenda.")
17330 (defun org-agenda-columns ()
17331 "Turn on column view in the agenda."
17332 (interactive)
17333 (org-verify-version 'columns)
17334 (org-columns-remove-overlays)
17335 (move-marker org-columns-begin-marker (point))
17336 (let (fmt cache maxwidths m)
17337 (cond
17338 ((and (local-variable-p 'org-overriding-columns-format)
17339 org-overriding-columns-format)
17340 (setq fmt org-overriding-columns-format))
17341 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17342 (setq fmt (org-entry-get m "COLUMNS" t)))
17343 ((and (boundp 'org-columns-current-fmt)
17344 (local-variable-p 'org-columns-current-fmt)
17345 org-columns-current-fmt)
17346 (setq fmt org-columns-current-fmt))
17347 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17348 (setq m (get-text-property m 'org-hd-marker))
17349 (setq fmt (org-entry-get m "COLUMNS" t))))
17350 (setq fmt (or fmt org-columns-default-format))
17351 (org-set-local 'org-columns-current-fmt fmt)
17352 (org-columns-compile-format fmt)
17353 (save-excursion
17354 ;; Get and cache the properties
17355 (goto-char (point-min))
17356 (while (not (eobp))
17357 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17358 (get-text-property (point) 'org-marker)))
17359 (push (cons (org-current-line) (org-entry-properties m)) cache))
17360 (beginning-of-line 2))
17361 (when cache
17362 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17363 (org-set-local 'org-columns-current-maxwidths maxwidths)
17364 (org-columns-display-here-title)
17365 (mapc (lambda (x)
17366 (goto-line (car x))
17367 (org-columns-display-here (cdr x)))
17368 cache)))))
17370 (defun org-columns-get-autowidth-alist (s cache)
17371 "Derive the maximum column widths from the format and the cache."
17372 (let ((start 0) rtn)
17374 (push (cons (match-string 1 s) 1) rtn)
17375 (setq start (match-end 0)))
17376 (mapc (lambda (x)
17377 (setcdr x (apply 'max
17378 (mapcar
17379 (lambda (y)
17380 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17381 cache))))
17382 rtn)
17383 rtn))
17385 (defun org-columns-compute-all ()
17386 "Compute all columns that have operators defined."
17387 (org-unmodified
17388 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17389 (let ((columns org-columns-current-fmt-compiled) col)
17390 (while (setq col (pop columns))
17391 (when (nth 3 col)
17392 (save-excursion
17393 (org-columns-compute (car col)))))))
17395 (defun org-columns-update (property)
17396 "Recompute PROPERTY, and update the columns display for it."
17397 (org-columns-compute property)
17398 (let (fmt val pos)
17399 (save-excursion
17400 (mapc (lambda (ov)
17401 (when (equal (org-overlay-get ov 'org-columns-key) property)
17402 (setq pos (org-overlay-start ov))
17403 (goto-char pos)
17404 (when (setq val (cdr (assoc property
17405 (get-text-property
17406 (point-at-bol) 'org-summaries))))
17407 (setq fmt (org-overlay-get ov 'org-columns-format))
17408 (org-overlay-put ov 'org-columns-value val)
17409 (org-overlay-put ov 'display (format fmt val)))))
17410 org-columns-overlays))))
17412 (defun org-columns-compute (property)
17413 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17414 (interactive)
17415 (let* ((re (concat "^" outline-regexp))
17416 (lmax 30) ; Does anyone use deeper levels???
17417 (lsum (make-vector lmax 0))
17418 (lflag (make-vector lmax nil))
17419 (level 0)
17420 (ass (assoc property org-columns-current-fmt-compiled))
17421 (format (nth 4 ass))
17422 (printf (nth 5 ass))
17423 (beg org-columns-top-level-marker)
17424 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17425 (save-excursion
17426 ;; Find the region to compute
17427 (goto-char beg)
17428 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17429 (goto-char end)
17430 ;; Walk the tree from the back and do the computations
17431 (while (re-search-backward re beg t)
17432 (setq sumpos (match-beginning 0)
17433 last-level level
17434 level (org-outline-level)
17435 val (org-entry-get nil property)
17437 (cond
17438 ((< level last-level)
17439 ;; put the sum of lower levels here as a property
17440 (setq sum (aref lsum last-level) ; current sum
17441 flag (aref lflag last-level) ; any valid entries from children?
17442 str (org-column-number-to-string sum format printf)
17443 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17444 useval (if flag str1 (if valflag val ""))
17445 sum-alist (get-text-property sumpos 'org-summaries))
17446 (if (assoc property sum-alist)
17447 (setcdr (assoc property sum-alist) useval)
17448 (push (cons property useval) sum-alist)
17449 (org-unmodified
17450 (add-text-properties sumpos (1+ sumpos)
17451 (list 'org-summaries sum-alist))))
17452 (when val
17453 (org-entry-put nil property (if flag str val)))
17454 ;; add current to current level accumulator
17455 (when (or flag valflag)
17456 (aset lsum level (+ (aref lsum level)
17457 (if flag sum (org-column-string-to-number
17458 (if flag str val) format))))
17459 (aset lflag level t))
17460 ;; clear accumulators for deeper levels
17461 (loop for l from (1+ level) to (1- lmax) do
17462 (aset lsum l 0)
17463 (aset lflag l nil)))
17464 ((>= level last-level)
17465 ;; add what we have here to the accumulator for this level
17466 (aset lsum level (+ (aref lsum level)
17467 (org-column-string-to-number (or val "0") format)))
17468 (and valflag (aset lflag level t)))
17469 (t (error "This should not happen")))))))
17471 (defun org-columns-redo ()
17472 "Construct the column display again."
17473 (interactive)
17474 (message "Recomputing columns...")
17475 (save-excursion
17476 (if (marker-position org-columns-begin-marker)
17477 (goto-char org-columns-begin-marker))
17478 (org-columns-remove-overlays)
17479 (if (org-mode-p)
17480 (call-interactively 'org-columns)
17481 (call-interactively 'org-agenda-columns)))
17482 (message "Recomputing columns...done"))
17484 (defun org-columns-not-in-agenda ()
17485 (if (eq major-mode 'org-agenda-mode)
17486 (error "This command is only allowed in Org-mode buffers")))
17489 (defun org-string-to-number (s)
17490 "Convert string to number, and interpret hh:mm:ss."
17491 (if (not (string-match ":" s))
17492 (string-to-number s)
17493 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17494 (while l
17495 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17496 sum)))
17498 (defun org-column-number-to-string (n fmt &optional printf)
17499 "Convert a computed column number to a string value, according to FMT."
17500 (cond
17501 ((eq fmt 'add_times)
17502 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17503 (format "%d:%02d" h m)))
17504 ((eq fmt 'checkbox)
17505 (cond ((= n (floor n)) "[X]")
17506 ((> n 1.) "[-]")
17507 (t "[ ]")))
17508 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17509 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17510 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17511 (printf (format printf n))
17512 ((eq fmt 'currency)
17513 (format "%.2f" n))
17514 (t (number-to-string n))))
17516 (defun org-nofm-to-completion (n m &optional percent)
17517 (if (not percent)
17518 (format "[%d/%d]" n m)
17519 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17521 (defun org-column-string-to-number (s fmt)
17522 "Convert a column value to a number that can be used for column computing."
17523 (cond
17524 ((string-match ":" s)
17525 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17526 (while l
17527 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17528 sum))
17529 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17530 (if (equal s "[X]") 1. 0.000001))
17531 (t (string-to-number s))))
17533 (defun org-columns-uncompile-format (cfmt)
17534 "Turn the compiled columns format back into a string representation."
17535 (let ((rtn "") e s prop title op width fmt printf)
17536 (while (setq e (pop cfmt))
17537 (setq prop (car e)
17538 title (nth 1 e)
17539 width (nth 2 e)
17540 op (nth 3 e)
17541 fmt (nth 4 e)
17542 printf (nth 5 e))
17543 (cond
17544 ((eq fmt 'add_times) (setq op ":"))
17545 ((eq fmt 'checkbox) (setq op "X"))
17546 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17547 ((eq fmt 'checkbox-percent) (setq op "X%"))
17548 ((eq fmt 'add_numbers) (setq op "+"))
17549 ((eq fmt 'currency) (setq op "$")))
17550 (if (and op printf) (setq op (concat op ";" printf)))
17551 (if (equal title prop) (setq title nil))
17552 (setq s (concat "%" (if width (number-to-string width))
17553 prop
17554 (if title (concat "(" title ")"))
17555 (if op (concat "{" op "}"))))
17556 (setq rtn (concat rtn " " s)))
17557 (org-trim rtn)))
17559 (defun org-columns-compile-format (fmt)
17560 "Turn a column format string into an alist of specifications.
17561 The alist has one entry for each column in the format. The elements of
17562 that list are:
17563 property the property
17564 title the title field for the columns
17565 width the column width in characters, can be nil for automatic
17566 operator the operator if any
17567 format the output format for computed results, derived from operator
17568 printf a printf format for computed values"
17569 (let ((start 0) width prop title op f printf)
17570 (setq org-columns-current-fmt-compiled nil)
17571 (while (string-match
17572 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17573 fmt start)
17574 (setq start (match-end 0)
17575 width (match-string 1 fmt)
17576 prop (match-string 2 fmt)
17577 title (or (match-string 3 fmt) prop)
17578 op (match-string 4 fmt)
17579 f nil
17580 printf nil)
17581 (if width (setq width (string-to-number width)))
17582 (when (and op (string-match ";" op))
17583 (setq printf (substring op (match-end 0))
17584 op (substring op 0 (match-beginning 0))))
17585 (cond
17586 ((equal op "+") (setq f 'add_numbers))
17587 ((equal op "$") (setq f 'currency))
17588 ((equal op ":") (setq f 'add_times))
17589 ((equal op "X") (setq f 'checkbox))
17590 ((equal op "X/") (setq f 'checkbox-n-of-m))
17591 ((equal op "X%") (setq f 'checkbox-percent))
17592 )
17593 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17594 (setq org-columns-current-fmt-compiled
17595 (nreverse org-columns-current-fmt-compiled))))
17598 ;;; Dynamic block for Column view
17600 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
17601 "Get the column view of the current buffer or subtree.
17602 The first optional argument MAXLEVEL sets the level limit. A
17603 second optional argument SKIP-EMPTY-ROWS tells whether to skip
17604 empty rows, an empty row being one where all the column view
17605 specifiers except ITEM are empty. This function returns a list
17606 containing the title row and all other rows. Each row is a list
17607 of fields."
17608 (save-excursion
17609 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17610 (n (length title)) row tbl)
17611 (goto-char (point-min))
17613 (or (null maxlevel)
17614 (>= maxlevel
17615 (if org-odd-levels-only
17616 (/ (1+ (length (match-string 1))) 2)
17617 (length (match-string 1))))))
17618 (when (get-char-property (match-beginning 0) 'org-columns-key)
17619 (setq row nil)
17620 (loop for i from 0 to (1- n) do
17621 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17622 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17623 "")
17624 row))
17625 (setq row (nreverse row))
17626 (unless (and skip-empty-rows
17627 (eq 1 (length (delete "" (delete-dups row)))))
17628 (push row tbl))))
17629 (append (list title 'hline) (nreverse tbl)))))
17631 (defun org-dblock-write:columnview (params)
17632 "Write the column view table.
17633 PARAMS is a property list of parameters:
17635 :width enforce same column widths with <N> specifiers.
17636 :id the :ID: property of the entry where the columns view
17637 should be built, as a string. When `local', call locally.
17638 When `global' call column view with the cursor at the beginning
17639 of the buffer (usually this means that the whole buffer switches
17640 to column view).
17641 :hlines When t, insert a hline before each item. When a number, insert
17642 a hline before each level <= that number.
17643 :vlines When t, make each column a colgroup to enforce vertical lines.
17644 :maxlevel When set to a number, don't capture headlines below this level.
17645 :skip-empty-rows
17646 When t, skip rows where all specifiers other than ITEM are empty."
17647 (let ((pos (move-marker (make-marker) (point)))
17648 (hlines (plist-get params :hlines))
17649 (vlines (plist-get params :vlines))
17650 (maxlevel (plist-get params :maxlevel))
17651 (skip-empty-rows (plist-get params :skip-empty-rows))
17652 tbl id idpos nfields tmp)
17653 (save-excursion
17654 (save-restriction
17655 (when (setq id (plist-get params :id))
17656 (cond ((not id) nil)
17657 ((eq id 'global) (goto-char (point-min)))
17658 ((eq id 'local) nil)
17659 ((setq idpos (org-find-entry-with-id id))
17660 (goto-char idpos))
17661 (t (error "Cannot find entry with :ID: %s" id))))
17662 (org-columns)
17663 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
17664 (setq nfields (length (car tbl)))
17665 (org-columns-quit)))
17666 (goto-char pos)
17667 (move-marker pos nil)
17668 (when tbl
17669 (when (plist-get params :hlines)
17670 (setq tmp nil)
17671 (while tbl
17672 (if (eq (car tbl) 'hline)
17673 (push (pop tbl) tmp)
17675 (if (and (not (eq (car tmp) 'hline))
17676 (or (eq hlines t)
17677 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17678 (push 'hline tmp)))
17679 (push (pop tbl) tmp)))
17680 (setq tbl (nreverse tmp)))
17681 (when vlines
17682 (setq tbl (mapcar (lambda (x)
17683 (if (eq 'hline x) x (cons "" x)))
17684 tbl))
17685 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17686 (setq pos (point))
17687 (insert (org-listtable-to-string tbl))
17688 (when (plist-get params :width)
17690 org-columns-current-widths "|")))
17691 (goto-char pos)
17692 (org-table-align))))
17694 (defun org-listtable-to-string (tbl)
17695 "Convert a listtable TBL to a string that contains the Org-mode table.
17696 The table still need to be alligned. The resulting string has no leading
17697 and tailing newline characters."
17698 (mapconcat
17699 (lambda (x)
17700 (cond
17701 ((listp x)
17702 (concat "|" (mapconcat 'identity x "|") "|"))
17703 ((eq x 'hline) "|-|")
17704 (t (error "Garbage in listtable: %s" x))))
17707 (defun org-insert-columns-dblock ()
17708 "Create a dynamic block capturing a column view table."
17709 (interactive)
17710 (let ((defaults '(:name "columnview" :hlines 1))
17711 (id (completing-read
17712 "Capture columns (local, global, entry with :ID: property) [local]: "
17713 (append '(("global") ("local"))
17714 (mapcar 'list (org-property-values "ID"))))))
17715 (if (equal id "") (setq id 'local))
17716 (if (equal id "global") (setq id 'global))
17717 (setq defaults (append defaults (list :id id)))
17718 (org-create-dblock defaults)
17719 (org-update-dblock)))
17721 ;;;; Timestamps
17723 (defvar org-last-changed-timestamp nil)
17724 (defvar org-time-was-given) ; dynamically scoped parameter
17725 (defvar org-end-time-was-given) ; dynamically scoped parameter
17726 (defvar org-ts-what) ; dynamically scoped parameter
17728 (defun org-time-stamp (arg)
17729 "Prompt for a date/time and insert a time stamp.
17730 If the user specifies a time like HH:MM, or if this command is called
17731 with a prefix argument, the time stamp will contain date and time.
17732 Otherwise, only the date will be included. All parts of a date not
17733 specified by the user will be filled in from the current date/time.
17734 So if you press just return without typing anything, the time stamp
17735 will represent the current date/time. If there is already a timestamp
17736 at the cursor, it will be modified."
17737 (interactive "P")
17738 (let* ((ts nil)
17739 (default-time
17740 ;; Default time is either today, or, when entering a range,
17741 ;; the range start.
17742 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17743 (save-excursion
17744 (re-search-backward
17746 (- (point) 20) t)))
17747 (apply 'encode-time (org-parse-time-string (match-string 1)))
17748 (current-time)))
17749 (default-input (and ts (org-get-compact-tod ts)))
17750 org-time-was-given org-end-time-was-given time)
17751 (cond
17752 ((and (org-at-timestamp-p)
17753 (eq last-command 'org-time-stamp)
17754 (eq this-command 'org-time-stamp))
17755 (insert "--")
17756 (setq time (let ((this-command this-command))
17757 (org-read-date arg 'totime nil nil default-time default-input)))
17758 (org-insert-time-stamp time (or org-time-was-given arg)))
17759 ((org-at-timestamp-p)
17760 (setq time (let ((this-command this-command))
17761 (org-read-date arg 'totime nil nil default-time default-input)))
17762 (when (org-at-timestamp-p) ; just to get the match data
17763 (replace-match "")
17764 (setq org-last-changed-timestamp
17765 (org-insert-time-stamp
17766 time (or org-time-was-given arg)
17767 nil nil nil (list org-end-time-was-given))))
17768 (message "Timestamp updated"))
17769 (t
17770 (setq time (let ((this-command this-command))
17771 (org-read-date arg 'totime nil nil default-time default-input)))
17772 (org-insert-time-stamp time (or org-time-was-given arg)
17773 nil nil nil (list org-end-time-was-given))))))
17775 ;; FIXME: can we use this for something else????
17776 ;; like computing time differences?????
17777 (defun org-get-compact-tod (s)
17778 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17779 (let* ((t1 (match-string 1 s))
17780 (h1 (string-to-number (match-string 2 s)))
17781 (m1 (string-to-number (match-string 3 s)))
17782 (t2 (and (match-end 4) (match-string 5 s)))
17783 (h2 (and t2 (string-to-number (match-string 6 s))))
17784 (m2 (and t2 (string-to-number (match-string 7 s))))
17785 dh dm)
17786 (if (not t2)
17787 t1
17788 (setq dh (- h2 h1) dm (- m2 m1))
17789 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17790 (concat t1 "+" (number-to-string dh)
17791 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17793 (defun org-time-stamp-inactive (&optional arg)
17794 "Insert an inactive time stamp.
17795 An inactive time stamp is enclosed in square brackets instead of angle
17796 brackets. It is inactive in the sense that it does not trigger agenda entries,
17797 does not link to the calendar and cannot be changed with the S-cursor keys.
17798 So these are more for recording a certain time/date."
17799 (interactive "P")
17800 (let (org-time-was-given org-end-time-was-given time)
17801 (setq time (org-read-date arg 'totime))
17802 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17803 nil nil (list org-end-time-was-given))))
17805 (defvar org-date-ovl (org-make-overlay 1 1))
17806 (org-overlay-put org-date-ovl 'face 'org-warning)
17807 (org-detach-overlay org-date-ovl)
17809 (defvar org-ans1) ; dynamically scoped parameter
17810 (defvar org-ans2) ; dynamically scoped parameter
17812 (defvar org-plain-time-of-day-regexp) ; defined below
17814 (defvar org-read-date-overlay nil)
17815 (defvar org-dcst nil) ; dynamically scoped
17817 (defun org-read-date (&optional with-time to-time from-string prompt
17818 default-time default-input)
17819 "Read a date, possibly a time, and make things smooth for the user.
17820 The prompt will suggest to enter an ISO date, but you can also enter anything
17821 which will at least partially be understood by `parse-time-string'.
17822 Unrecognized parts of the date will default to the current day, month, year,
17823 hour and minute. If this command is called to replace a timestamp at point,
17824 of to enter the second timestamp of a range, the default time is taken from the
17825 existing stamp. For example,
17826 3-2-5 --> 2003-02-05
17827 feb 15 --> currentyear-02-15
17828 sep 12 9 --> 2009-09-12
17829 12:45 --> today 12:45
17830 22 sept 0:34 --> currentyear-09-22 0:34
17831 12 --> currentyear-currentmonth-12
17832 Fri --> nearest Friday (today or later)
17833 etc.
17835 Furthermore you can specify a relative date by giving, as the *first* thing
17836 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17837 change in days weeks, months, years.
17838 With a single plus or minus, the date is relative to today. With a double
17839 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17840 +4d --> four days from today
17841 +4 --> same as above
17842 +2w --> two weeks from today
17843 ++5 --> five days from default date
17845 The function understands only English month and weekday abbreviations,
17846 but this can be configured with the variables `parse-time-months' and
17847 `parse-time-weekdays'.
17849 While prompting, a calendar is popped up - you can also select the
17850 date with the mouse (button 1). The calendar shows a period of three
17851 months. To scroll it to other months, use the keys `>' and `<'.
17852 If you don't like the calendar, turn it off with
17853 \(setq org-read-date-popup-calendar nil)
17855 With optional argument TO-TIME, the date will immediately be converted
17856 to an internal time.
17857 With an optional argument WITH-TIME, the prompt will suggest to also
17858 insert a time. Note that when WITH-TIME is not set, you can still
17859 enter a time, and this function will inform the calling routine about
17860 this change. The calling routine may then choose to change the format
17861 used to insert the time stamp into the buffer to include the time.
17862 With optional argument FROM-STRING, read from this string instead from
17863 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17864 the time/date that is used for everything that is not specified by the
17865 user."
17866 (require 'parse-time)
17867 (let* ((org-time-stamp-rounding-minutes
17868 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
17869 (org-dcst org-display-custom-times)
17870 (ct (org-current-time))
17871 (def (or default-time ct))
17872 (defdecode (decode-time def))
17873 (dummy (progn
17874 (when (< (nth 2 defdecode) org-extend-today-until)
17875 (setcar (nthcdr 2 defdecode) -1)
17876 (setcar (nthcdr 1 defdecode) 59)
17877 (setq def (apply 'encode-time defdecode)
17878 defdecode (decode-time def)))))
17879 (calendar-move-hook nil)
17880 (view-diary-entries-initially nil)
17881 (view-calendar-holidays-initially nil)
17882 (timestr (format-time-string
17883 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17884 (prompt (concat (if prompt (concat prompt " ") "")
17885 (format "Date+time [%s]: " timestr)))
17886 ans (org-ans0 "") org-ans1 org-ans2 final)
17888 (cond
17889 (from-string (setq ans from-string))
17890 (org-read-date-popup-calendar
17891 (save-excursion
17892 (save-window-excursion
17893 (calendar)
17894 (calendar-forward-day (- (time-to-days def)
17895 (calendar-absolute-from-gregorian
17896 (calendar-current-date))))
17897 (org-eval-in-calendar nil t)
17898 (let* ((old-map (current-local-map))
17899 (map (copy-keymap calendar-mode-map))
17900 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17901 (org-defkey map (kbd "RET") 'org-calendar-select)
17902 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17903 'org-calendar-select-mouse)
17941 ;; org-ans0: from prompt
17942 ;; org-ans1: from mouse click
17943 ;; org-ans2: from calendar motion
17971 "Display the currrent date prompt interpretation in the minibuffer."
17987 org-time-stamp-custom-formats
17988 org-time-stamp-formats))
17997 org-end-time-was-given
18004 "Analyze the combined answer of the date prompt."
18005 ;; FIXME: cleanup and comment
18007 hour minute second wday pm h2 m2 tl wday1)
18015 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
18025 t nil ans)))
18026 ;; Help matching am/pm times, because `parse-time-string' does not do that.
18027 ;; If there is a time with am/pm, and *no* time without it, we convert
18028 ;; so that matching will be successful.
18042 t t ans))))
18044 ;; Check if a time range is given as a duration
18045 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
18053 ;; Check if there is a time range
18087 ;; Weekday was given, but no day, so pick that day in the week
18088 ;; on or after the derived date.
18102 "Check string S for special relative date string.
18103 TODAY and DEFAULT are internal times, for today and for a default.
18104 Return shift list (N what def-flag)
18106 N is the number of WHATs to shift.
18107 DEF-FLAG is t when a double ++ or -- indicates shift relative to
18108 the DEFAULT date rather than TODAY."
18117 ?+))
18124 delta)
18134 "Eval FORM in the calendar window and return to current window.
18135 Also, store the cursor date in variable org-ans2."
18146 ; ;; Update the prompt to show new default date
18147 ; (save-excursion
18148 ; (goto-char (point-min))
18149 ; (when (and org-ans2
18150 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
18151 ; (get-text-property (match-end 0) 'field))
18152 ; (let ((inhibit-read-only t))
18153 ; (replace-match (concat "[" org-ans2 "]") t t)
18154 ; (add-text-properties (point-min) (1+ (match-end 0))
18155 ; (text-properties-at (1+ (point-min)))))))))
18158 "Return to `org-read-date' with the date currently selected.
18159 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18168 "Insert a date stamp for the date given by the internal TIME.
18169 WITH-HM means, use the stamp format that includes the time of the day.
18170 INACTIVE means use square brackets instead of angular ones, so that the
18171 stamp will not contribute to the agenda.
18172 PRE and POST are optional strings to be inserted before and after the
18173 stamp.
18174 The command returns the inserted time stamp."
18176 stamp)
18193 stamp))
18196 "Toggle the use of custom time stamp formats."
18217 "Overlay modified time stamp format over timestamp between BED and END."
18244 "Translate all timestamps in STRING to custom format.
18245 But do this only if the variable `org-display-custom-times' is set."
18250 t1 with-hm inactive tf time str beg end)
18259 org-time-stamp-custom-formats)
18268 string)
18271 "Set 0 instead of nil for the first 6 elements of time.
18272 Don't touch the rest."
18277 "Difference between TIMESTAMP-STRING and now in days."
18282 "Is the time in TIMESTAMP-STRING close to the current date?"
18288 "Get the deadline lead time appropriate for timestring TS."
18291 ;; 0 or negative, enforce this value no matter what
18294 ;; lead time is specified.
18299 ;; go for the default.
18303 "Return to `org-read-date' with the date currently selected.
18304 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18314 "Check if there are any deadlines due or past due.
18315 A deadline is considered due if it happens within `org-deadline-warning-days'
18316 days from today's date. If the deadline appears in an entry marked DONE,
18317 it is not shown. The prefix arg NDAYS can be used to test that many
18332 org-warn-days)))
18335 "Check if there are deadlines or scheduled entries before DATE."
18349 "Evaluate a time range by computing the difference between start and end.
18350 Normally the result is just printed in the echo area, but with prefix arg
18351 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18352 If the time range is actually in a table, the result is inserted into the
18353 next column.
18354 For time difference computation, a year is assumed to be exactly 365
18355 days in order to avoid rounding problems."
18375 ;; (ys (floor (* 365 24 60 60)))
18383 y d h m align)
18386 y 0
18391 y 0
18429 "Convert a time stamp to an absolute day number.
18430 If there is a specifyer for a cyclic time stamp, get the closest date to
18431 DAYNR."
18435 daynr
18440 prefer))
18444 "Return the time corresponding to date D.
18445 D may be an absolute day number, or a calendar-type list (month day year)."
18450 "List of holidays, for Diary display in Org-mode."
18458 "Process a SEXP diary ENTRY for DATE."
18478 "Get iCalendar entries from diary entries in buffer FROMBUF.
18479 This uses the icalendar.el library."
18482 temporary-file-directory))
18485 buf rtn b e)
18501 rtn))
18504 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18505 When PREFER is `past' return a date that is either CURRENT or past.
18506 When PREFER is `future', return a date that is either CURRENT or future."
18507 ;; Make the proper lists from the dates
18510 dn dw sday cday n1 n2
18511 d m y y1 y2 date1 date2 nmonths nm ny m2)
18516 current
18540 ;; approx number of month between the tow dates
18542 ;; How often does dn fit in there?
18571 "Turn any specification of DATE into a gregorian date for the calendar."
18581 "Parse the standard Org-mode time string.
18582 This should be a lot faster than the normal `parse-time-string'.
18583 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18584 hour and minute fields will be nil if not given."
18594 nil nil nil)
18598 "Increase the date item at the cursor by one.
18599 If the cursor is on the year, change the year. If it is on the month or
18600 the day, change that.
18601 With prefix ARG, change by that many units."
18606 "Decrease the date item at the cursor by one.
18607 If the cursor is on the year, change the year. If it is on the month or
18608 the day, change that.
18609 With prefix ARG, change by that many units."
18614 "Increase the date in the time stamp by one day.
18615 With prefix ARG, change that many days."
18623 "Decrease the date in the time stamp by one day.
18624 With prefix ARG, change that many days."
18637 "Determine if the cursor is in or at a timestamp."
18663 ans))
18666 "Toggle the type (<active> or [inactive]) of a time stamp."
18678 "Change the date in the time stamp at point.
18679 The date will be changed by N times WHAT. WHAT can be `day', `month',
18680 `year', `minute', `second'. If WHAT is not given, the cursor position
18681 in the timestamp determines what will be changed."
18683 with-hm inactive
18685 org-ts-what
18686 extra rem
18687 ts time time0)
18693 org-display-custom-times
18703 ts)
18737 ;; Try to recenter the calendar window, if any
18743 ;; FIXME: does not yet work for lead times
18745 "Change the different parts of the lead-time and repeat fields in timestamp."
18747 ng h m new rem)
18748 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18777 new
18779 s))
18782 "If the calendar is visible, recenter it to DATE."
18793 "Go to the Emacs calendar at the current date.
18794 If there is a time stamp in the current line, go to that date.
18795 A prefix ARG can be used to force the current date."
18814 "Return a list (month day year) of date at point in calendar."
18820 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18821 If there is already a time stamp at the cursor position, update it."
18831 ;;;###autoload
18833 "Activate appointments found in `org-agenda-files'.
18835 appointements.
18837 If FILTER is t, interactively prompt the user for a regular
18838 expression, and filter out entries that don't match it.
18840 If FILTER is a string, use this string as a regular expression
18841 for filtering entries out.
18843 FILTER can also be an alist with the car of each cell being
18844 either 'headline or 'category. For example:
18849 will only add headlines containing IMPORTANT or headlines
18862 ;; Get all entries which may contain an appt
18869 ;; Map thru entries and find if we should filter them out
18882 ;; FIXME: Shall we remove text-properties for the appt text?
18883 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18897 ;;; The clock for measuring work time.
18922 "Start the clock on the current item.
18923 If necessary, clock-out of the currently active clock."
18931 org-clock-in-switch-to-state
18958 "Find the location where the next clock line should be inserted."
18964 first last)
18968 ;; we seem to have a CLOCK drawer, so go there.
18971 ;; Lets count the CLOCK lines
18979 ;; Wrap current entries into a new drawer
18997 ;; Planning info, skip to after it
19009 "Stop the currently running clock.
19010 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
19047 "Cancel the running clock be removing the start timestamp."
19061 "Go to the currently clocked-in entry."
19078 "Sum the times for each subtree.
19079 Puts the resulting times in minutes as a text property on each headline."
19083 org-clock-string
19089 ts te dt
19090 time)
19097 ;; Two time stamps
19109 ;; A naket time
19126 "Show subtree times in the entire buffer.
19127 If TOTAL-ONLY is non-nil, only show the total time for the entire file
19128 in the echo area."
19145 ;; Arrange to remove the overlays upon next change.
19155 "Put an overlays on the current line, displaying TIME.
19156 If LEVEL is given, prefix time with a corresponding number of stars.
19157 This creates a new overlay and stores it in `org-clock-overlays', so that it
19158 will be easy to remove."
19162 ov tx)
19181 "Remove the occur highlights from the buffer.
19182 BEG and END are ignored. If NOREMOVE is nil, remove this function
19183 from the `before-change-functions' in the current buffer."
19193 "Clock out if the current entry contains the running clock.
19194 This is used to stop the clock after a TODO entry is marked DONE,
19195 and is only done if the variable `org-clock-out-when-done' is not nil."
19201 org-clock-marker))
19202 ;; Clock out, but don't accept a logging message for this.
19210 "Check if the current buffer contains the running clock.
19211 If yes, offer to stop it and to save the buffer with the changes."
19220 "Create a table containing a report about clocked time.
19221 If the cursor is inside an existing clocktable block, then the table
19222 will be updated. If not, a new clocktable will be inserted.
19223 When called with a prefix argument, move to the first clock table in the
19224 buffer and update it."
19237 "Check if the cursor is in a clocktable."
19245 start))))
19248 "If this is a CLOCK line, update it and return t.
19249 Otherwise, return nil."
19258 ts te h m s)
19260 nil
19274 t)))))
19277 "Return two times bordering a special time range.
19278 Key is a symbol specifying the range and can be one of `today', `yesterday',
19279 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
19280 A week starts Monday 0:00 and ends Sunday 24:00.
19281 The range is determined relative to TIME. TIME defaults to the current time.
19282 The return value is a cons cell with two internal times like the ones
19283 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
19284 the returned times will be formatted strings."
19289 s1 m1 h1 d1 month1 y1 diff ts te fm)
19319 "Write the standard clocktable."
19335 ipos time h m p level hlc hdl
19336 cc beg end pos tbl)
19350 ;; Get the right scope
19373 file)
19383 org-clock-file-total-minutes)))))))
19394 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19423 "Clock summary at ["
19427 "]."
19440 "|"
19441 "*Total time*| "
19463 cc)
19497 x))
19498 lines)
19501 ;; FIXME: I don't think anybody uses this, ask David
19503 "Return an internal list with clocking information.
19504 This list has one entry for each CLOCK interval.
19505 FIXME: describe the elements."
19509 rtn beg end next cont level title total closedp leafp
19510 clockpos titlepos h m donep)
19535 total title titlepos level leafp)
19536 rtn)
19540 ;;;; Agenda, and Diary Integration
19542 ;;; Define the Org-agenda-mode
19557 "Mode for time-sorted view on action items in Org-mode files.
19559 The following commands are available:
19565 org-agenda-pending-undo-list nil)
19567 ;; Keep global-font-lock-mode from turning on font-lock-mode
19575 ;; Make sure properties are removed when copying text
19580 buffer-substring-filters)))
19583 org-agenda-show-log nil))
19590 "Restricted to single file"
19602 org-agenda-mode-map global-map)
19705 "--"
19712 "--"
19716 "--"
19721 "--"
19726 "--"
19731 "--"
19748 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19752 "--"
19754 "--"
19764 "--"
19766 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19770 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19774 "--"
19776 "--"
19779 ))
19781 ;;; Agenda undo
19793 "Execute BODY if there is no `org-protected' text property at point."
19799 "Execute BODY while recording undo information in two buffers."
19807 _c1 _c2)
19808 ,@_body
19815 ;; make sure there are undo boundaries
19818 ;; remember which buffer to undo
19820 org-agenda-undo-list)))))
19823 "Undo a remote editing step in the agenda.
19824 This undoes changes both in the agenda buffer and in the remote buffer
19825 that have been changed along."
19831 org-agenda-pending-undo-list org-agenda-undo-list))
19835 buf line cmd rembuf)
19857 "Verify that a real change occurred between the undo lists L1 and L2."
19862 ;;; Agenda dispatch
19870 ;;;###autoload
19872 "Dispatch agenda commands to collect entries to the agenda buffer.
19873 Prompts for a command to execute. Any prefix arg will be passed
19874 on to the selected command. The default selections are:
19876 a Call `org-agenda-list' to display the agenda for current day or week.
19877 t Call `org-todo-list' to display the global todo list.
19878 T Call `org-todo-list' to display the global todo list, select only
19879 entries with a specific TODO keyword (the user gets a prompt).
19880 m Call `org-tags-view' to display headlines with tags matching
19881 a condition (the user is prompted for the condition).
19882 M Like `m', but select only TODO entries, no ordinary headlines.
19883 L Create a timeline for the current buffer.
19884 e Export views to associated files.
19886 More commands can be added by configuring the variable
19887 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19888 searches can be pre-defined in this way.
19890 If the current buffer is in Org-mode and visiting a file, you can also
19891 first press `<' once to indicate that the agenda should be temporarily
19893 Pressing `<' twice means to restrict to the current subtree or region
19894 \(if active)."
19900 ;; normalize different versions
19906 nil)
19910 org-agenda-custom-commands)))
19913 entry key type match lprops ans)
19914 ;; Turn off restriction unless there is an overriding one
19920 ;; Delete old local properties
19922 ;; Remember where this call originated
19928 ;; Estabish the restriction, if any
19945 ;; For example the todo list should not need it (but does...)
19961 current-prefix-arg)))
20014 cmds)))
20017 "The user interface for selecting an agenda command."
20024 restriction second-time
20025 c entry key type match prefixes rmheader header-end custom1 desc)
20032 "
20033 Press key for an agenda command: < Buffer,subtree/region restriction
20034 -------------------------------- > Remove restriction
20035 a Agenda for current week or day e Export agenda views
20036 t List of all TODO entries T Entries with special TODO kwd
20037 m Match a TAGS query M Like m, but only TODO entries
20038 L Timeline for current buffer # List stuck projects (!=configure)
20039 s Search for keywords C Configure custom agenda commands
20040 / Multi-occur
20045 header start)
20049 header)))
20102 prefix-descriptions))
20104 prefixes))
20115 " (restriction lock active)"
20128 prefixes nil
20134 nil
20136 custom))))
20153 nil)
20173 match ;; The byte compiler incorrectly complains about this. Keep it!
20174 cmd type lprops)
20208 ;;;###autoload
20210 "Run an agenda command in batch mode and send the result to STDOUT.
20211 If CMD-KEY is a string of length 1, it is used as a key in
20212 `org-agenda-custom-commands' and triggers this command. If it is a
20213 longer string it is used as a tags/todo match string.
20214 Paramters are alternating variable names and values that will be bound
20215 before running the agenda command."
20229 string))
20233 ;;;###autoload
20235 "Run an agenda command in batch mode and send the result to STDOUT.
20236 If CMD-KEY is a string of length 1, it is used as a key in
20237 `org-agenda-custom-commands' and triggers this command. If it is a
20238 longer string it is used as a tags/todo match string.
20239 Paramters are alternating variable names and values that will be bound
20240 before running the agenda command.
20242 The output gives a line for each selected agenda item. Each
20243 item is a list of comma-separated values, like this:
20245 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
20247 category The category of the item
20248 head The headline, without TODO kwd, TAGS and PRIORITY
20249 type The type of the agenda entry, can be
20250 todo selected in TODO match
20251 tagsmatch selected in tags match
20252 diary imported from diary
20253 deadline a deadline on given date
20254 scheduled scheduled on given date
20255 timestamp entry has timestamp on given date
20256 closed entry was closed on given date
20257 upcoming-deadline warning about deadline
20258 past-scheduled forwarded scheduled item
20259 block entry has date block including g. date
20260 todo The todo keyword, if any
20261 tags All tags including inherited ones, separated by colons
20262 date The relevant date, like 2007-2-14
20263 time The time, like 15:00-16:50
20264 extra Sting with extra planning info
20265 priority-l The priority letter if any was given
20266 priority-n The computed numerical priority
20267 agenda-day The day in the agenda where this is listed"
20279 line)
20289 priority-letter priority agenda-day)
20294 "Make sure all properties on an agenda item have a canonical form,
20295 so the export commands can easily use it."
20322 props)
20336 ;;;###autoload
20341 ;; FIXME, why is this a macro?????
20342 ;;;###autoload
20344 "Run all custom agenda commands that have a file argument."
20348 pars cmd thiscmdkey files opts)
20371 "Write the current buffer (an agenda view) as a file.
20372 Depending on the extension of the file name, plain text (.txt),
20373 HTML (.html or .htm) or Postscript (.ps) is produced.
20374 If NOSETTINGS is given, do not scope the settings of
20375 `org-agenda-exporter-settings' into the export commands. This is used when
20376 the settings have already been scoped and we do not wish to overrule other,
20377 higher priority settings."
20393 ;; replace <style> section with org-agenda-export-html-style
20414 "Inhibit read-only for BODY."
20418 "Make sure current buffer is in org-mode. Error if not."
20421 major-mode)))
20424 "Fit the window to the buffer size."
20428 nil
20432 ;;; Agenda file list
20435 "Get the list of agenda files.
20436 Optional UNRESTRICTED means return the full list even if a restriction
20437 is currently in place."
20448 org-agenda-file-regexp)
20450 files)))
20456 files))
20460 "Edit the list of agenda files.
20461 Depending on setup, this either uses customize to edit the variable
20462 `org-agenda-files', or it visits the file that is holding the list. In the
20463 latter case, the buffer is set up in a way that saving it automatically kills
20464 the buffer and restores the previous window configuration."
20483 "Set new value for the agenda file list and save it correcly."
20494 "Read the list of agenda files from a file."
20501 ;;;###autoload
20503 "Cycle through the files in `org-agenda-files'.
20504 If the current buffer visits an agenda file, find the next one in the list.
20505 If the current buffer does not, find the first agenda file."
20510 file)
20522 "Move/add the current file to the top of the agenda file list.
20523 If the file is not present in the list, it is added to the front. If it is
20524 present, it is moved there. With optional argument TO-END, add/move to the
20525 end of the list."
20532 x had)
20545 "Remove current file from the list of files in variable `org-agenda-files'.
20546 These are the files which are being checked for agenda entries.
20547 Optional argument FILE means, use this file instead of the current."
20557 nil x))
20570 "Make sure FILE exists. If not, ask user what to do."
20581 ;;; Agenda prepare and finalize
20626 "Finishing touch for the agenda buffer, called just before displaying it."
20638 org-overriding-columns-format)
20640 org-overriding-columns-format))
20642 org-agenda-view-columns-initially)
20648 )))
20651 "Make highest priority lines bold, and lowest italic."
20658 b e p ov h l)
20662 org-highest-priority)
20664 org-lowest-priority)
20669 ov 'face
20677 "Create buffers for all agenda files, protect archived trees and comments."
20684 bmp file re)
20714 "Function to be called at each match during agenda construction.
20715 If this function returns nil, the current match should not be skipped.
20716 Otherwise, the function must return a position from where the search
20717 should be continued.
20718 This may also be a Lisp form, it will be evaluated.
20719 Never set this variable using `setq' or so, because then it will apply
20720 to all future agenda commands. Instead, bind it with `let' to scope
20721 it dynamically into the agenda-constructing command. A good way to set
20725 "Throw to `:skip' in places that should be skipped.
20726 Also moves point to the end of the skipped region, so that search can
20727 continue from there."
20753 "Return a new agenda marker.
20754 Org-mode keeps a list of these markers and resets them when they are
20755 no longer in use."
20759 m))
20762 "Reset markers created by `org-agenda'."
20767 "Get a buffer visiting FILE. If the buffer needs to be created, add
20768 it to the list of buffers which might be released later."
20771 buf ; just return it
20772 ;; Make a new buffer and remember it
20775 buf)))
20778 "Release all buffers in list, asking the user for confirmation when needed.
20779 When a buffer is unmodified, it is just killed. When modified, it is saved
20780 \(if the user agrees) and then killed."
20785 file
20791 "Get the category applying to position POS."
20794 ;;; Agenda timeline
20799 "Show a time-sorted view of the entries in the current org file.
20800 Only entries with a time stamp of today or later will be listed. With
20802 under the current date.
20803 If the buffer contains an active region, only check the region for
20804 dates."
20817 t doclosed ; always include today
20818 org-timeline-show-empty-dates))
20823 args
20824 s e rtn d emptyp)
20830 ;; Remove past dates from the list of dates.
20833 day-numbers))))
20850 dopast
20851 past)
20859 date args)))
20882 "Return a list of all relevant day numbers from BEG to END buffer positions.
20883 If NO-RANGES is non-nil, include only the start and end dates of a range,
20884 not every single day in the range. If FORCE-TODAY is non-nil, make
20885 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20886 inactive time stamps (those in square brackets) are included.
20887 When EMPTY is non-nil, also include days without any entries."
20891 dates dates1 date day day1 day2 ts1 ts2)
20921 dates)))
20923 ;;; Agenda Daily/Weekly
20934 ;;;###autoload
20936 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20937 The view will be for the current day or week, but from the overview buffer
20938 you will be able to go to other days/weeks.
20941 all unfinished TODO items will also be shown, before the agenda.
20942 This feature is considered obsolete, please use the TODO list or a block
20943 agenda instead.
20945 With a numeric prefix argument in an interactive call, the agenda will
20946 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20947 the number of days. NDAYS defaults to `org-agenda-ndays'.
20949 START-DAY defaults to TODAY, or to the most recent match for the weekday
20950 given in `org-agenda-start-on-weekday'."
20961 ;; Convert to an absolute day number
20969 org-agenda-start-on-weekday nil))
20978 sd
20987 s e rtn rtnall file date d start-pos end-pos todayp nd)
20990 ;; Make the list of days
20992 nd ndays)
21005 rtnall nil)
21033 rtnall nil)
21039 file date
21042 file date
21066 rtnall nd todayp))
21089 ;;; Agenda word search
21093 ;;;###autoload
21095 "Show all entries that contain words or regular expressions.
21096 If the first character of the search string is an asterisks,
21097 search only the headlines.
21100 The individual words are then interpreted as a boolean expression with
21101 logical AND. Words prefixed with a minus must not occur in the entry.
21102 Words without a prefix or prefixed with a plus must occur in the entry.
21103 Matching is case-insensitive and the words are enclosed by word delimiters.
21105 Words enclosed by curly braces are interpreted as regular expressions
21106 that must or must not match in the entry.
21108 This command searches the agenda files, and in addition the files listed
21109 in `org-agenda-text-search-extra-files'."
21116 'org-not-done-regexp org-not-done-regexp
21117 'org-todo-regexp org-todo-regexp
21119 'keymap org-agenda-keymap
21121 regexp rtn rtnall files file pos
21122 marker priority category tags c neg re
21152 words)
21158 regexp))))
21160 rtnall nil)
21169 ;; If file does not exist, make sure an error message is sent
21171 file))))
21180 org-agenda-restrict-end)
21202 regexps-)
21206 regexps+)
21212 ""
21215 category tags))
21246 ;;; Agenda TODO list
21251 ;;;###autoload
21253 "Show all TODO entries from all agenda file in a single list.
21254 The prefix arg can be used to select a specific TODO keyword and limit
21256 for a keyword. A numeric prefix directly selects the Nth keyword in
21257 `org-todo-keywords-1'."
21271 rtn rtnall files file pos)
21281 rtnall nil)
21305 kwds))
21316 ;;; Agenda tags match
21318 ;;;###autoload
21320 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
21321 The prefix arg TODO-ONLY limits the search to TODO entries."
21328 rtn rtnall files file pos matcher
21329 buffer)
21338 rtnall nil)
21346 ;; If file does not exist, merror message to agenda
21357 org-agenda-restrict-end)
21382 ;;; Agenda Finding stuck projects
21385 "Regular expression used in skipping subtrees for the agenda.
21386 This is basically a temporary global variable that can be set and then
21393 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
21394 If yes, it returns the end position of this tree, causing agenda commands
21395 to skip this subtree. This is a function that can be put into
21396 `org-agenda-skip-function' for the duration of a command."
21398 skip)
21404 "Skip entry if any of CONDITIONS is true.
21405 See `org-agenda-skip-if' for details."
21409 "Skip entry if any of CONDITIONS is true.
21410 See `org-agenda-skip-if' for details."
21414 "Checks current entity for CONDITIONS.
21415 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
21416 the entry, i.e. the text before the next heading is checked.
21418 CONDITIONS is a list of symbols, boolean OR is used to combine the results
21419 from different tests. Valid conditions are:
21421 scheduled Check if there is a scheduled cookie
21422 notscheduled Check if there is no scheduled cookie
21423 deadline Check if there is a deadline
21424 notdeadline Check if there is no deadline
21425 regexp Check if regexp matches
21426 notregexp Check if regexp does not match.
21428 The regexp is taken from the conditions list, it must come right after
21429 the `regexp' or `notregexp' element.
21431 If any of these conditions is met, this function returns the end point of
21432 the entity, causing the search to continue from there. This is a function
21433 that can be put into `org-agenda-skip-function' for the duration of a command."
21457 end)))
21459 ;;;###autoload
21461 "Create agenda view for projects that are stuck.
21462 Stuck projects are project that have no next actions. For the definitions
21463 of what a project is and how to check if it stuck, customize the variable
21464 `org-stuck-projects'.
21465 MATCH is being ignored."
21468 ;; FIXME: we could have used org-agenda-skip-if here.
21476 org-done-keywords-for-agenda
21478 todo))
21495 gen-re)))))
21506 ;;; Diary integration
21511 "Get the (Emacs Calendar) diary entries for DATE."
21519 entries
21531 ;; No entries
21533 ;; Omit the date and other unnecessary stuff
21535 ;; Add prefix to each line and extend the text properties
21547 ;; Extend the text properties to the beginning of the line
21550 entries)))))
21553 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21554 This gets rid of the date, the underline under the date, and
21555 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21556 date. It also removes lines that contain only whitespace."
21573 ;; Make sure entries from the diary have the right text properties.
21576 ;; We can rely on the hook, nothing to do
21577 nil
21578 ;; Hook not avaiable, must use advice to make this work
21580 "Make the position visible."
21583 buffer-file-name)
21587 "Add text properties to string, allowing org-mode to act on it."
21590 'keymap org-agenda-keymap
21595 'org-agenda-diary-link t
21599 "Add a dummy entry to the diary.
21600 Needed to avoid empty dates which mess up holiday display."
21601 ;; Catch the error if dealing with the new add-to-diary-alist
21608 ;;;###autoload
21610 "Return diary information from org-files.
21612 It accesses org files and extracts information from those files to be
21613 listed in the diary. The function accepts arguments specifying what
21614 items should be listed. The following arguments are allowed:
21616 :timestamp List the headlines of items containing a date stamp or
21617 date range matching the selected date. Deadlines will
21618 also be listed, on the expiration day.
21620 :sexp List entries resulting from diary-like sexps.
21622 :deadline List any deadlines past due, or due within
21623 `org-deadline-warning-days'. The listing occurs only
21624 in the diary for *today*, not at any other date. If
21625 an entry is marked DONE, it is no longer listed.
21627 :scheduled List all items which are scheduled for the given date.
21628 The diary for *today* also contains items which were
21629 scheduled earlier and are not yet marked DONE.
21631 :todo List all TODO items from the org-file. This may be a
21632 long list - so this is not turned on by default.
21633 Like deadlines, these entries only show up in the
21634 diary for *today*, not at any other date.
21636 The call in the diary file should look like this:
21638 &%%(org-diary) ~/path/to/some/orgfile.org
21640 Use a separate line for each org file to check. Or, if you omit the file name,
21641 all files listed in `org-agenda-files' will be checked automatically:
21643 &%%(org-diary)
21645 If you don't give any arguments (as in the example above), the default
21646 arguments (:deadline :scheduled :timestamp :sexp) are used.
21647 So the example above may also be written as
21649 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21651 The function expects the lisp variables `entry' and `date' to be provided
21652 by the caller, because this is how the calendar works. Don't use this
21653 function from a program - use `org-agenda-get-day-entries' instead."
21655 org-agenda-last-marker-time)
21664 file rtn results)
21666 ;; If this is called during org-agenda, don't return any entries to
21667 ;; the calendar. Org Agenda will list these entries itself.
21675 ;;; Agenda entry finders
21678 "Does the work for `org-diary' and `org-agenda'.
21679 FILE is the path to a file to be checked for entries. DATE is date like
21680 the one returned by `calendar-current-date'. ARGS are symbols indicating
21681 which kind of entries should be extracted. For details about these, see
21682 the documentation of `org-diary'."
21689 arg results rtn)
21691 ;; If file does not exist, make sure an error message ends up in diary
21701 org-agenda-restrict-end)
21703 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21727 results))))
21743 "Is the cursor inside a date range?"
21758 nil)))
21761 "Return the TODO information for agenda display."
21764 'org-not-done-regexp org-not-done-regexp
21765 'org-todo-regexp org-todo-regexp
21767 'keymap org-agenda-keymap
21768 'help-echo
21771 ;; FIXME: get rid of the \n at some point but watch out
21775 org-todo-regexp
21779 org-not-done-regexp)
21781 marker priority category tags
21782 ee txt beg end)
21821 "Return the date stamp information for agenda display."
21823 'org-not-done-regexp org-not-done-regexp
21824 'org-todo-regexp org-todo-regexp
21826 'keymap org-agenda-keymap
21827 'help-echo
21835 "<%Y-%m-%d"
21849 marker hdmarker deadlinep scheduledp donep tmp priority category
21850 ee txt timestr tags b0 b3 e3 head)
21868 b0)
21875 ;; substring should only run to end of time stamp
21887 nil head category tags timestr nil
21888 remove-re)))
21901 "Return the sexp information for agenda display."
21905 'keymap org-agenda-keymap
21906 'help-echo
21910 marker category ee txt tags entry result beg b sexp sexp-entry)
21942 "Return the logged TODO entries for agenda display."
21944 'org-not-done-regexp org-not-done-regexp
21945 'org-todo-regexp org-todo-regexp
21946 'keymap org-agenda-keymap
21947 'help-echo
21959 marker hdmarker priority category tags closedp
21960 ee txt timestr)
21969 ;; donep (org-entry-is-done-p)
21970 )
21972 ;; substring should only run to end of time stamp
21996 "Return the deadline information for agenda display."
21998 'org-not-done-regexp org-not-done-regexp
21999 'org-todo-regexp org-todo-regexp
22000 'keymap org-agenda-keymap
22001 'help-echo
22007 d2 diff dfrac wdays pos pos1 category tags
22008 ee txt head face s upcomingp donep timestr)
22020 ;; When to show a deadline in the calendar:
22021 ;; If the expiration is within wdays warning time.
22022 ;; Past-due deadlines are only shown on the current date
22050 diff))
22051 head category tags timestr))))
22060 'org-category category
22069 "Return the face to displaying a deadline item.
22070 FRACTION is what fraction of the head-warning time has passed."
22078 "Return the scheduled information for agenda display."
22080 'org-todo-regexp org-todo-regexp
22083 'keymap org-agenda-keymap
22084 'help-echo
22090 d2 diff pos pos1 category tags
22091 ee txt head pastschedp donep face timestr s)
22099 ;;; is this right?
22100 ;;; do we need to do this for deadleine too????
22101 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
22104 ;; When to show a scheduled item in the calendar:
22105 ;; If it is on or past the date.
22133 head category tags timestr))))
22137 'org-scheduled-previously
22140 'undone-face face
22152 "Return the date-range information for agenda display."
22154 'org-not-done-regexp org-not-done-regexp
22155 'org-todo-regexp org-todo-regexp
22157 'keymap org-agenda-keymap
22158 'help-echo
22163 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
22164 donep head)
22176 ;; Only allow days between the limits, because the normal
22177 ;; date stamps will catch the limits.
22194 head category tags
22203 ;; Sort the entries by expiration date.
22206 ;;; Agenda presentation and sorting
22216 "Regular expression to match a plain time or time range.
22217 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22218 groups carry important information:
22219 0 the full match
22220 1 the first time, range or not
22228 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
22229 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22230 groups carry important information:
22231 0 the full match
22232 7 hours of duration
22241 "Regular expression to match a timestamp time or time range.
22242 After a match, the following groups carry important information:
22243 0 the full match
22244 1 date plus weekday, for backreferencing to make sure both times on same day
22245 2 the first time, range or not
22249 "A flag, set by `org-compile-prefix-format'.
22252 "A flag, set by `org-compile-prefix-format'.
22256 noprefix remove-re)
22257 "Format TXT to be inserted into the agenda buffer.
22258 In particular, it adds the prefix and corresponding text properties. EXTRA
22259 must be a string and replaces the `%s' specifier in the prefix format.
22260 CATEGORY (string, symbol or nil) may be used to overrule the default
22261 category taken from local variable or file name. It will replace the `%c'
22262 specifier in the format. DOTIME, when non-nil, indicates that a
22263 time-of-day should be extracted from TXT for sorting of this entry, and for
22264 the `%t' specifier in the format. When DOTIME is a string, this string is
22265 searched for a time before TXT is. NOPREFIX is a flag and indicates that
22266 only the correctly processes TXT should be returned - this is used by
22267 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
22268 Any match of REMOVE-RE will be removed from TXT."
22270 ;; Diary entries sometimes have extra whitespace at the beginning
22273 org-category
22279 time ; time and tag are needed for the eval of the prefix format
22282 stamp plain s0 s1 s2 rtn srp)
22284 ;; Extract starting and ending time and move them to prefix
22292 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
22293 ;; them, we might want to remove them there to avoid duplication.
22294 ;; The user can turn this off with a variable.
22300 t))
22302 ;; Normalize the time(s) to 24 hour
22310 org-agenda-default-appointment-duration))
22311 h)
22316 txt)
22317 ;; Tags are in the string
22320 org-prefix-has-tag))
22325 t t txt))))
22331 ;; Create the final string
22334 ;; Prepare the variables needed in the eval of the compiled format
22340 ;; Evaluate the compiled format
22343 ;; And finally add the text properties
22346 'org-highest-priority org-highest-priority
22347 'org-lowest-priority org-lowest-priority
22349 'time-of-day time-of-day
22350 'txt txt
22351 'time time
22352 'extra extra
22367 list)))
22372 new time)
22374 ;; don't show empty grid
22380 nil string "" nil
22382 new)
22390 "Compile the prefix format into a Lisp form that can be evaluated.
22391 The resulting form is returned and stored in the variable
22392 `org-prefix-format-compiled'."
22396 org-agenda-prefix-format)
22401 varform vars var e c f opt)
22403 s start)
22416 ""
22426 ;; the old format
22434 "Check string S for a time of day.
22435 If found, return it as a military time number between 0 and 2400.
22436 If not found, return nil.
22437 The optional STRING argument forces conversion into a 5 character wide string
22438 HH:MM."
22460 "Sort and concatenate the agenda items."
22463 list
22488 x)
22492 " "
22494 x)))
22497 "Compare the priorities of string A and B."
22505 "Compare the string values of categories of strings A and B."
22513 "Compare the string values of categories of strings A and B."
22523 "Compare the time-of-day values of strings A and B."
22532 "Predicate for sorting agenda entries."
22533 ;; The following variables will be used when the form is evaluated.
22534 ;; So even though the compiler complains, keep them.
22548 ;;; Agenda restriction lock
22566 "Set restriction lock for agenda, to current subtree or file.
22567 Restriction will be the file if TYPE is `file', or if type is the
22568 universal prefix '(4), or if the cursor is before the first headline
22569 in the file. Otherwise, restriction will be to the current subtree."
22601 "Remove the agenda restriction lock."
22615 "If there is any window showing the agenda view, update it."
22624 org-agenda-overriding-restriction)
22627 ;;; Agenda commands
22630 "Check if agenda buffer is of allowed type.
22631 If ERROR is non-nil, throw an error, otherwise just return nil."
22633 t
22636 nil)))
22639 "Exit agenda by removing the window or the buffer."
22646 ;; Maybe restore the pre-agenda window configuration.
22649 org-pre-agenda-window-conf
22653 "Exit agenda by removing the window or the buffer.
22654 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22655 Org-mode buffers visited directly by the user will not be touched."
22669 "Save all Org-mode buffers without user confirmation."
22676 "Rebuild Agenda.
22677 When this is the global TODO list, a prefix argument will be interpreted."
22686 org-agenda-pending-undo-list nil)
22692 "Manipulate the query by adding a search term with positive selection.
22693 Positive selection means, the term must be matched for selection of an entry."
22697 "Manipulate the query by adding a search term with negative selection.
22698 Negative selection means, term must not be matched for selection of an entry."
22702 "Manipulate the query by adding a search regexp with positive selection.
22703 Positive selection means, the regexp must match for selection of an entry."
22707 "Manipulate the query by adding a search regexp with negative selection.
22708 Negative selection means, regexp must not match for selection of an entry."
22715 'org-agenda-query-string
22722 org-agenda-query-string))
22726 org-agenda-type))))
22732 "Jump to DATE in agenda."
22737 "Go to today."
22763 "Go forward in time by thee current span.
22764 With prefix ARG, go forward that many times the current span."
22771 greg2 nd)
22793 "Go backward in time by the current span.
22794 With prefix ARG, go backward that many times the current span."
22799 "Switch to daily view for agenda."
22804 "Switch to daily view for agenda."
22809 "Switch to daily view for agenda."
22813 "Switch to daily view for agenda."
22820 "Change the agenda view to SPAN.
22821 SPAN may be `day', `week', `month', `year'."
22826 org-starting-day))
22837 "Compute starting date and number of days for agenda.
22838 SPAN may be `day', `week', `month', `year'. The return value
22839 is a cons cell with the starting date and the number of days,
22840 so that the date SD will be in that range."
22842 nd)
22859 sd)))
22865 sd))))
22868 ;; FIXME: does not work if user makes date format that starts with a blank
22870 "Jump to the next line indicating a date in agenda buffer."
22882 "Jump to the previous line indicating a date in agenda buffer."
22889 ;; Initialize the highlight
22894 "Highlight a region with overlay."
22899 "Detach overlay INDEX."
22902 ;; FIXME this is currently not used.
22911 "Toggle follow mode in an agenda buffer."
22919 "Toggle log mode in an agenda buffer."
22929 "Toggle diary inclusion in an agenda buffer."
22939 "Toggle time grid in an agenda buffer."
22949 "Set the mode name to indicate all the small mode settings."
22968 "Show the priority of the current item.
22969 This priority is composed of the main priority given with the [#A] cookies,
22970 and by additional input from the age of a schedules or deadline entry."
22976 "Show the tags applicable to the current item."
22985 "Go to the Org-mode file which contains the item at point."
23004 "Normal hook run after an item has been shown from the agenda.
23008 "Kill the entry or subtree belonging to the current agenda entry."
23041 "Kill the entry or subtree belonging to the current agenda entry."
23059 "Remove all lines in the agenda that correspond to a given subtree.
23060 The subtree is the one in buffer BUF, starting at BEG and ending at END.
23061 If this information is not given, the function uses the tree at point."
23084 "Follow the link in the current line, if any."
23093 "Get a variable from a referenced buffer and install it here."
23100 "Go to the Org-mode file which contains the item at point."
23117 "Go to the Org-mode file which contains the item at the mouse click."
23123 "Display the Org-mode file which contains the item at point."
23130 "Display the Org-mode file which contains the item at point and recenter."
23138 "Display the Org-mode file which contains the item at the mouse click."
23144 "Check if the entry is a diary link and abort if yes."
23152 "Show the subtree corresponding to the current entry in an indirect buffer.
23153 This calls the command `org-tree-to-indirect-buffer' from the original
23154 Org-mode buffer.
23155 With numerical prefix arg ARG, go up to this level and then take that tree.
23156 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
23157 dedicated frame)."
23170 "Marker pointing to the headline that last changed its TODO state
23174 "Switch TODO entry to next sequence."
23179 "Switch TODO entry to previous sequence."
23184 "Cycle TODO state of line at point, also in Org-mode file.
23185 This changes the line at point, all other lines in the agenda referring to
23186 the same tree node, and the headline of the tree node in the Org-mode file."
23196 newhead)
23217 "Change all lines in the agenda buffer which match HDMARKER.
23218 The new content of the line will be NEWHEAD (as modified by
23219 `org-format-agenda-item'). HDMARKER is checked with
23220 `equal' against all `org-hd-marker' text properties in the file.
23221 If FIXFACE is non-nil, the face of each item is modified acording to
23222 the new TODO state."
23224 props m pl undone-face done-face finish new dotime cat tags)
23254 undone-face done-face))))
23262 "Align all tags in agenda items to `org-agenda-tags-column'."
23275 org-agenda-tags-column))
23283 "Increase the priority of line at point, also in Org-mode file."
23288 "Decrease the priority of line at point, also in Org-mode file."
23293 "Set the priority of line at point, also in Org-mode file.
23294 This changes the line at point, all other lines in the agenda referring to
23295 the same tree node, and the headline of the tree node in the Org-mode file."
23304 newhead)
23320 "Get a list of all headline tags applicable at POS.
23321 POS defaults to point. If tags are inherited, the list contains
23322 the targets in the same sequence as the headlines appear, i.e.
23323 the tags of the current headline come last."
23339 tags)))
23343 tags)))
23345 ;; FIXME: should fix the tags property of the agenda line.
23347 "Set tags for the current headline."
23358 newhead)
23376 "Toggle the archive tag for the current entry."
23385 newhead)
23401 "Change the date of this item to one day later."
23420 "Change the date of this item to one day earlier."
23425 "Show new date stamp via text properties."
23426 ;; We use text properties to make this undoable
23435 ;; Use `duplicable' property to trigger undo recording
23450 "Change the date of this item. Date is prompted for, with default today.
23451 The prefix ARG is passed to the `org-time-stamp' command and can therefore
23452 be used to request time specification in the time stamp."
23470 "Schedule the item at point."
23480 ts)
23492 "Schedule the item at point."
23501 ts)
23511 "Return the heading of the current entry, without the stars."
23521 "Start the clock on the currently selected item."
23534 "Stop the currently running clock."
23542 "Cancel the currently running clock."
23550 "Make a diary entry, like the `i' command from the calendar.
23551 All the standard commands work: block, weekly etc."
23567 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23576 ;; We implement this by hacking the `calendar-cursor-to-date' function
23577 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23593 "Execute a calendar command from the agenda, with the date associated to
23594 the cursor position."
23603 ;; the following 3 vars are needed in the calendar
23617 "Display the phases of the moon for the 3 months around the cursor date."
23622 "Display the holidays for the 3 months around the cursor date."
23627 "Display sunrise and sunset for the cursor date.
23628 Latitude and longitude can be specified with the variables
23629 `calendar-latitude' and `calendar-longitude'. When called with prefix
23630 argument, latitude and longitude will be prompted for."
23639 "Open the Emacs calendar with the date at the cursor."
23652 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23653 This is a command that has to be installed in `calendar-mode-map'."
23657 nil))
23663 date s)
23689 ;;;; Embedded LaTeX
23704 "Toggle the minor `org-cdlatex-mode'.
23705 This mode supports entering LaTeX environment and math in LaTeX fragments
23706 in Org-mode.
23708 nil " OCDL" nil
23713 "Always return t in org-mode buffers.
23714 This is because we want to insert math symbols without dollars even outside
23715 the LaTeX math segments. If Orgmode thinks that point is actually inside
23716 en embedded LaTeX fragement, let texmathp do its job.
23733 "Unconditionally turn on `org-cdlatex-mode'."
23737 "Test if point is inside a LaTeX fragment.
23739 sequence appearing also before point.
23740 Even though the matchers for math are configurable, this function assumes
23742 delimiters are skipped when they have been removed by customization.
23743 The return value is nil, or a cons cell with the delimiter and
23744 and the position of this delimiter.
23746 This function does a reasonably good job, but can locally be fooled by
23747 for example currency specifications. For example it will assume being in
23749 fragments that are properly closed, but during editing, we have to live
23750 with the uncertainty caused by missing closing delimiters. This function
23751 looks only before point, not after."
23770 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23774 ;; count $$
23782 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23783 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23784 - inside a LaTeX fragment, or
23785 - after the first word in a line, where an abbreviation expansion could
23786 insert a LaTeX environment."
23799 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23800 Revert to the normal definition outside of these fragments."
23808 "Execute `cdlatex-math-modify' in LaTeX fragments.
23809 Revert to the normal definition outside of these fragments."
23821 "Remove all overlays with LaTeX fragment images in current buffer."
23826 "Preview the LaTeX fragment at point, or all locally or globally.
23827 If the cursor is in a LaTeX fragment, create the image and overlay
23828 it over the source code. If there is no fragment at point, display
23829 all fragments in the current text, from one headline to the next. With
23830 prefix SUBTREE, display all fragments in the current subtree. With a
23831 double prefix `C-u C-u', or when the cursor is before the first headline,
23832 display all fragments in the buffer.
23862 buffer-file-name)))
23868 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23869 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23870 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23877 "Replace LaTeX fragments with links to an image, and produce images."
23886 m n block linkfile movefile ov)
23887 ;; Check if there are old images files with this prefix, and remove them
23891 todir 'full
23893 ;; Check the different regular expressions
23913 txt movefile opt forbuffer)
23921 ov 'end-glyph
23924 ov 'display
23931 ;; This function borrows from Ganesh Swami's latex2png.el
23935 temporary-file-directory))
23964 "-D" dpi
23965 ;;"-x" scale "-y" scale
23967 "-o" pngfile
23968 dvifile)
23971 ;; Use the requested file name and clean up
23975 pngfile))))
23978 "Return an rgb color specification for dvipng."
23984 "Return string to be used as color value for an RGB component."
23987 ;;;; Exporting
23989 ;;; Variables, constants, and parameter plists
24045 "Return the property list with default settings for the export variables."
24049 rtn))
24052 "Return the property list with file-local settings for export."
24059 p key val text options)
24092 o)
24096 options)
24100 p))))
24106 val)))
24107 dir))
24114 rtn line level)
24119 ;; Beginning of a COMMENT subtree. Skip it.
24125 ;; an ordinary comment line
24126 )
24132 ;; a special table line that should be removed
24133 )
24140 \[v] limit export to visible part of outline tree
24142 \[a] export as ASCII
24144 \[h] export as HTML
24145 \[H] export as HTML to temporary buffer
24146 \[R] export region as HTML
24147 \[b] export as HTML and browse immediately
24148 \[x] export as XOXO
24150 \[l] export as LaTeX
24151 \[L] export as LaTeX to temporary buffer
24153 \[i] export current file as iCalendar file
24154 \[I] export all agenda files as iCalendar files
24155 \[c] export agenda files into combined iCalendar file
24157 \[F] publish current file
24158 \[P] publish current project
24159 \[X] publish... (project will be prompted for)
24179 r1 r2 ass)
24482 )
24483 "Entities for TeX->HTML translation.
24487 The list contains HTML entities for Latin-1, Greek and other symbols.
24488 It is supplemented by a number of commonly used TeX macros with appropriate
24491 ;;; General functions for all backends
24494 "Cleanup a buffer STRING so that links can be created safely."
24512 a b xx
24513 rtn p)
24517 ;; Remove license-to-kill stuff
24525 ;; Get rid of drawers
24530 'identity
24538 ;; Get the correct stuff before the first headline
24549 ;; Get rid of archived trees
24561 ;; Find targets in comments and move them out of comments,
24562 ;; but mark them as targets that should be invisible
24567 ;; Protect backend specific stuff, throw away the others.
24572 fmt)
24603 ;; Protect quoted subtrees
24611 ;; Protect verbatim elements
24618 ;; Remove subtrees that are commented
24624 ;; Remove special table lines
24636 ;; Specific LaTeX stuff
24644 ;; Specific HTML stuff
24646 ;; Convert LaTeX fragments to images
24651 org-current-export-file)))
24655 ;; Remove or replace comments
24664 ;; Find matches for radio targets and turn them into internal links
24671 ;; Find all links that contain a newline and put them into a single line
24673 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24679 ;; Normalize links: Convert angle and plain links into bracket links
24680 ;; Expand link abbreviations
24687 ;; added 'org-link face to links
24703 "]"
24711 ;; Find multiline emphasis and put them into single line
24725 rtn))
24728 "Get a title for the current document, from looking at the buffer."
24734 ;; Mark the line so that it will not be exported as normal text.
24738 ;; Return the title string
24742 "Return subtree title and exclude it from export."
24748 ;; This is a subtree, we take the title from the first heading
24755 title))
24758 "Take link text and make a safe target out of it."
24762 'identity
24768 "Get the minimum level in LINES."
24776 ;; Variable holding the vector with section numbers
24780 "Initialize the vector for the section numbers."
24797 "Return a string with the current section number.
24798 When LEVEL is non-nil, increase section numbers on that level."
24820 string))
24822 ;;; ASCII export
24830 "Export the outline as a pretty ASCII file.
24831 If there is an active region, export only the region.
24832 The prefix ARG specifies how many levels of the outline should become
24833 underlined headlines. The default is 3."
24862 filename))
24878 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24887 region
24888 :for-ascii t
24889 :skip-before-1st-heading
24892 :verbatim-multiline t
24893 :archived-trees
24897 thetoc have-headings first-heading-pos
24898 table-open table-buffer)
24916 ;; create local variables for all options, to make sure all called
24917 ;; functions get the correct information
24921 org-export-plist-vars)
24924 org-export-headline-levels))
24927 umax))
24929 ;; File header
24933 org-export-author-info)
24955 line)
24956 ;; This is a headline
24962 todo
24966 org-done-keywords)))
24967 ; TODO, not DONE
24971 line lines level))))
24978 t t txt)))
24983 txt))
24998 thetoc)
25000 ))))
25001 lines)
25006 ;; Remove the quoted HTML tags.
25008 ;; Remove targets
25011 ;; Replace internal links
25015 t nil line)))
25020 ;; a Headline
25029 ;; New table starts
25031 ;; Accumulate lines
25052 ;; insert the table of contents
25064 ;; Convert whitespace place holders
25074 ;; remove display and invisible chars
25090 "Do extra work for ASCII export"
25100 "Search the subtree below LINE for any TODO entries."
25103 line lv todo)
25111 org-done-keywords))))
25112 ; TODO, not DONE
25117 "Handle quoted HTML for ASCII export."
25120 ;; We just remove the tags for now.
25122 line)
25125 "Insert the string S centered and underline it with character UNDERLINE."
25134 "Insert a new level in ASCII export."
25140 org-export-ascii-bullets))
25142 ;; find the indentation of the next non-empty line
25163 "Create a copy of the visible part of the current buffer, and export it.
25164 The copy is created in a temporary buffer and removed after use.
25165 TYPE is the final key (as a string) that also select the export command in
25166 the `C-c C-e' export dispatcher.
25167 As a special case, if the you type SPC at the prompt, the temporary
25168 org-mode file will not be removed but presented to you so that you can
25169 continue to use it. The prefix arg ARG is passed through to the exporting
25170 command."
25173 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
25175 current-prefix-arg))
25190 s e)
25191 ;; Need to hack the drawers here.
25207 ;; Copy all comment lines to the end, to make sure #+ settings are
25208 ;; still available for the second export step. Kind of a hack, but
25209 ;; does do the trick.
25230 s))
25235 s))
25237 ;;; HTML export
25240 "Return a string with current options as keyword options.
25241 Does include HTML export options as well as TODO and CATEGORY stuff."
25243 "#+TITLE: %s
25244 #+AUTHOR: %s
25245 #+EMAIL: %s
25246 #+LANGUAGE: %s
25247 #+TEXT: Some descriptive text to be emitted. Several lines OK.
25248 #+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
25249 #+CATEGORY: %s
25250 #+SEQ_TODO: %s
25251 #+TYP_TODO: %s
25252 #+PRIORITIES: %c %c %c
25253 #+DRAWERS: %s
25254 #+STARTUP: %s %s %s %s %s
25255 #+TAGS: %s
25256 #+ARCHIVE: %s
25257 #+LINK: %s
25258 "
25260 org-export-headline-levels
25261 org-export-with-section-numbers
25262 org-export-with-toc
25263 org-export-preserve-breaks
25264 org-export-html-expand
25265 org-export-with-fixed-width
25266 org-export-with-tables
25267 org-export-with-sub-superscripts
25268 org-export-with-special-strings
25269 org-export-with-footnotes
25270 org-export-with-emphasize
25271 org-export-with-TeX-macros
25272 org-export-with-LaTeX-fragments
25273 org-export-skip-text-before-1st-heading
25274 org-export-with-drawers
25275 org-export-with-tags
25277 "TODO FEEDBACK VERIFY DONE"
25278 "Me Jason Marie DONE"
25279 org-highest-priority org-lowest-priority org-default-priority
25296 org-archive-location
25297 "org file:~/org/%s.org"
25298 ))
25301 "Insert into the buffer a template with information for exporting."
25310 "Toggle the fixed-width export.
25311 If there is no active region, the QUOTE keyword at the current headline is
25312 inserted or removed. When present, it causes the text between this headline
25313 and the next to be exported as fixed-width text, and unmodified.
25314 If there is an active region, this command adds or removes a colon as the
25315 first character of this line. If the first character of a line is a colon,
25316 this line is also exported in fixed-width font."
25325 off)
25355 "Export the outline as HTML and immediately open it with a browser.
25356 If there is an active region, export only the region.
25357 The prefix ARG specifies how many levels of the outline should become
25358 headlines. The default is 3. Lower levels will become bulleted lists."
25364 "Call `org-export-as-html', may be used in batch processing as
25365 emacs --batch
25366 --load=$HOME/lib/emacs/org.el
25368 --visit=MyFile --funcall org-export-as-html-batch"
25372 "Call `org-exort-as-html` with output to a temporary buffer.
25373 No file is created. The prefix ARG is passed through to `org-export-as-html'."
25379 "Assume the current region has org-mode syntax, and convert it to HTML.
25380 This can be used in any buffer. For example, you could write an
25381 itemized list in org-mode syntax in an HTML buffer and then use this
25382 command to convert it."
25402 "Convert region from BEG to END in org-mode buffer to HTML.
25403 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
25404 contents, and only produce the region of converted text, useful for
25405 cut-and-paste operations.
25406 If BUFFER is a buffer or a string, use/create that buffer as a target
25407 of the converted HTML. If BUFFER is the symbol `string', return the
25408 produced HTML as a string and leave not buffer behind. For example,
25409 a Lisp program could call this function in the following way:
25411 (setq html (org-export-region-as-html beg end t 'string))
25413 When called interactively, the output buffer is selected, and shown
25414 in a window. A non-interactive call will only retunr the buffer."
25419 rtn)
25424 nil nil nil
25425 buffer body-only))
25429 rtn)))
25433 to-buffer body-only pub-dir)
25434 "Export the outline as a pretty HTML file.
25435 If there is an active region, export only the region. The prefix
25436 ARG specifies how many levels of the outline should become
25437 headlines. The default is 3. Lower levels will become bulleted
25438 lists. When HIDDEN is non-nil, don't display the HTML buffer.
25439 EXT-PLIST is a property list with external parameters overriding
25440 org-mode's default settings, but still inferior to file-local
25441 settings. When TO-BUFFER is non-nil, create a buffer with that
25442 name and export to that buffer. If TO-BUFFER is the symbol
25443 `string', don't leave any buffer behind but just return the
25444 resulting HTML as a string. When BODY-ONLY is set, don't produce
25445 the file header and footer, simply return the content of
25446 <body>...</body>, without even the body tags themselves. When
25447 PUB-DIR is set, use this as the publishing directory."
25450 ;; Make sure we have a file name when we need it.
25456 buffer-file-name))
25465 ext-plist
25471 valid thetoc have-headings first-heading-pos
25480 ;; The following two are dynamically scoped into other
25481 ;; routines below.
25501 default-directory))
25535 buffer-file-coding-system))
25537 coding-system))
25539 coding-system))
25551 region
25552 :emph-multiline t
25553 :for-html t
25554 :skip-before-1st-heading
25557 :archived-trees
25559 :add-text
25561 :LaTeX-fragments
25564 table-open type
25565 table-buffer table-orig-buffer
25566 ind start-is-num starter didclose
25567 rpl path desc descp desc1 desc2 link
25568 )
25587 ;; Get the language-dependent settings
25591 ;; Switch to the output buffer
25601 ;; create local variables for all options, to make sure all called
25602 ;; functions get the correct information
25606 org-export-plist-vars)
25608 org-export-headline-levels))
25611 umax))
25613 ;; File header
25619 <head>
25620 <title>%s</title>
25625 %s
25626 </head><body>
25627 "
25640 org-export-html-toplevel-hlevel
25642 org-export-html-toplevel-hlevel)
25643 thetoc)
25648 ;; This is a headline
25657 todo
25661 org-done-keywords)))
25662 ; TODO, not DONE
25666 line lines level))))
25691 ;; Check for targets
25696 t t line))
25699 target-alist))
25710 )))
25711 line)
25712 lines))
25724 ;; end of quote section?
25728 ;; inside a quote section?
25733 ;; verbatim lines
25747 ;; Protected HTML
25762 ;; Horizontal line
25767 ;; make targets to anchors
25775 t t line)))
25779 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25780 t t line)))
25786 t t line)))))
25790 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25791 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25792 ;; Also handle sub_superscripts and checkboxes
25796 ;; Format the links
25806 ;; Make an image out of the description if that is so wanted
25812 ;; FIXME: do we need to unescape here somewhere?
25822 ;; standard URL, just check if we need to inline an image
25830 ;; standard URL
25834 ;; FILE link
25837 thefile file-is-image-p search)
25845 t))
25854 ;; make sure this is can be used as target search
25879 ;; TODO items
25887 org-done-keywords)
25892 ;; Does this contain a reference to a footnote?
25904 t t line))))))
25908 ;; This is a headline
25916 ;; Close any local lists before inserting a new header line
25922 in-local-list nil))
25926 head-count)
25927 ;; QUOTES
25935 ;; New table starts
25937 ;; Accumulate lines
25949 ;; Normal lines
25952 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25953 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25956 line)
25963 ;; empty line. Pretend indentation is large.
25965 0
25981 ;; Start new (level of) list
25988 ;; continue current list
25992 ;; we did close a list, normal text follows: need <p>
25998 "<b>[X]</b>"
26000 t t line))))
26002 ;; Empty lines start a new paragraph. If hand-formatted lists
26003 ;; are not fully interpreted, lines starting with "-", "+", "*"
26004 ;; also start a new paragraph.
26007 ;; Is this the start of a footnote?
26013 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
26015 ;; Check if the line break needs to be conserved
26024 ;; Properly close all local lists and other lists
26027 ;; Close any local lists before inserting a new header line
26033 in-local-list nil))
26036 head-count)
26067 ;; insert the table of contents
26084 ;; remove empty paragraphs and lists
26094 ;; Convert whitespace place holders
26114 "Format a table for ascii export."
26118 ;; Table made by table.el - test for spanning
26119 lines
26121 ;; A normal org table
26122 ;; Get rid of hlines at beginning and end
26128 ;; Check if the table has a marking column. If yes remove the
26129 ;; column and the special lines
26131 ;; Get rid of the vertical lines except for grouping
26133 rtn line vl1 start)
26155 vl))
26158 "Find out which HTML converter to use and return the HTML code."
26162 ;; A normal org table
26164 ;; Table made by table.el - test for spanning
26168 nil))
26169 lines)))
26175 hlines))))
26178 ;; We can use my own converter with HTML conversions
26180 ;; Need to use the code generator in table.el, with the original text.
26184 "Format a table into HTML."
26185 ;; Get rid of hlines at beginning and end
26191 ;; Check if the table has a marking column. If yes remove the
26192 ;; column and the special lines
26200 tbopen line fields html gr colgropen)
26212 ;; ignore this line
26214 ;; Break the line into fields
26232 html)))
26237 ;; Put in col tags with the alignment (unfortuntely often ignored...)
26253 html)
26259 "Check if the table has a marking column.
26260 If yes remove the column and the special lines."
26266 lines))
26281 nil)
26283 lines)))
26297 nil)
26302 ;; remove the first column
26304 lines))))
26307 "Format a table generated by table.el into HTML.
26308 This conversion does *not* use `table-generate-source' from table.el.
26309 This has the advantage that Org-mode's HTML conversions can be used.
26310 But it has the disadvantage, that no cell- or row-spanning is allowed."
26313 fields html empty)
26323 html
26325 html
26326 "<tr>"
26339 ;; Ignore this line
26341 ;; Break the line into fields and store the fields
26347 field-buffer))
26350 html))
26353 "Format a table into html, using `table-generate-source' from table.el.
26354 This has the advantage that cell- or row-spanning is allowed.
26355 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
26370 "Format time stamps in string S, or remove them."
26375 ;; never export CLOCK
26390 ;; Line break if line started and ended with time stamp stuff
26392 s
26396 r))))
26399 ;; convert & to &, < to < and > to >
26408 s)
26411 "Remove tags and time staps from lines going into the toc."
26420 t t s)))
26421 s)
26424 "Prepare STRING for HTML export. Applies all active conversions.
26425 If there are links in the string, don't modify these."
26428 m s l res)
26439 "Apply all active conversions to translate special ASCII to HTML."
26460 t t s))
26462 s)
26465 "Create a regular expression which will match a balanced sexp.
26466 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
26467 as single character strings.
26468 The regexp returned will match the entire expression including the
26469 delimiters. It will also define a single group which contains the
26470 match except for the outermost delimiters. The maximum depth of
26471 stacked delimiters is N. Escaping delimiters is not possible."
26507 "Convert special characters in STRING to HTML."
26509 e a re rpl start)
26516 string))
26519 "Convert sub- and superscripts in STRING to HTML."
26535 t t string)))))
26538 string))
26541 "Apply emphasis."
26548 rpl
26554 org-emphasis-alist))
26559 string))
26563 "Insert <p>, but first close previous paragraph if any."
26568 "Close paragraph if there is one open."
26573 "Close <li> if necessary."
26579 "Insert a new level in HTML export.
26580 When TITLE is nil, just close all open levels."
26590 ;; If title is nil, this means this function is called to close
26591 ;; all levels, so the rest is done only if title is given
26603 t t title)))
26619 level level head-count title level))
26624 "Terminate one level in HTML export."
26630 ;;; iCalendar export
26632 ;;;###autoload
26634 "Export current file as an iCalendar file.
26635 The iCalendar file will be located in the same directory as the Org-mode
26636 file, but with extension `.ics'."
26640 ;;;###autoload
26642 "Export all files in `org-agenda-files' to iCalendar .ics files.
26643 Each iCalendar file will be located in the same directory as the Org-mode
26644 file, but with extension `.ics'."
26648 ;;;###autoload
26650 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26651 The file is stored under the name `org-combined-agenda-icalendar-file'."
26656 "Create iCalendar files for all elements of FILES.
26657 If COMBINE is non-nil, combine all calendar entries into a single large
26658 file and store it under the name `org-combined-agenda-icalendar-file'."
26663 org-export-publishing-directory)))
26664 file ical-file ical-buffer category started org-agenda-new-buffers)
26670 org-combined-agenda-icalendar-file
26703 "Hook run after an iCalendar file has been saved.
26704 The iCalendar buffer is still current when this hook is run.
26705 A good way to use this is to tell a desktop calenndar application to re-read
26709 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26710 When COMBINE is non nil, add the category to each line."
26717 scheduledp deadlinep tmp pri category entry location summary desc
26727 inc t
26734 t org-icalendar-include-body)
26744 pos)
26749 ts)
26752 ;; donep (org-entry-is-done-p)
26753 ))
26772 t t summary)))
26779 %s
26780 %s%s
26781 SUMMARY:%s%s%s
26782 CATEGORIES:%s
26786 rrule summary
26791 category)))))
26796 ;; Get all the literal sexps
26822 )
26829 t org-icalendar-include-body)
26835 t t hd)))
26845 %s
26846 SUMMARY:%s%s%s
26847 CATEGORIES:%s
26848 SEQUENCE:1
26849 PRIORITY:%d
26850 STATUS:%s
26852 dts
26858 category pri status)))))))))
26861 "Take out stuff and quote what needs to be quoted.
26862 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26863 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26864 characters."
26866 nil
26885 s))
26888 "Clean-up description string."
26894 "Start an iCalendar file by inserting the header."
26900 VERSION:2.0
26901 X-WR-CALNAME:%s
26902 PRODID:-//%s//Emacs with Org-mode//EN
26903 X-WR-TIMEZONE:%s
26907 "Finish an iCalendar file by inserting the END statement."
26911 "Take a time string S and convert it to iCalendar format.
26912 KEYWORD is added in front, to make a complete line like DTSTART....
26913 When INC is non-nil, increase the hour by two (if time string contains
26914 a time), or the day by one (if it does not contain a time)."
26916 t2 fmt have-time time)
26932 ;;; XOXO export
26940 "Export the org buffer as XOXO.
26941 The XOXO buffer is named *xoxo-<source buffer name>*"
26943 ;; A quickie abstraction
26945 ;; Output everything as XOXO
26959 ;; Check the output buffer is empty.
26961 ;; Kick off the output
26978 ;; Handle level rendering
26995 )
26999 ;; And output the new li
27005 ;; Finally finish off the ol
27012 ;; Finish the buffer off and clean it up.
27017 )))
27020 ;;;; Key bindings
27022 ;; Make `C-c C-x' a prefix key
27025 ;; TAB key with modifiers
27032 ;; The following line is necessary under Suse GNU/Linux
27038 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
27039 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
27040 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
27042 ;; Cursor keys with modifiers
27043 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
27044 (org-defkey org-mode-map [(meta right)] 'org-metaright)
27045 (org-defkey org-mode-map [(meta up)] 'org-metaup)
27046 (org-defkey org-mode-map [(meta down)] 'org-metadown)
27048 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
27049 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
27050 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
27051 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
27053 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
27054 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
27055 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
27056 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
27058 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
27059 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
27061 ;;; Extra keys for tty access.
27062 ;; We only set them when really needed because otherwise the
27063 ;; menus don't show the simple keys
27065 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
27066 (not window-system))
27067 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
27068 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
27069 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
27070 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
27071 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
27072 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
27073 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
27074 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
27075 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
27076 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
27077 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
27078 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
27079 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
27080 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
27081 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
27082 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
27083 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
27084 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
27085 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
27086 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
27087 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
27088 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
27090 ;; All the other keys
27092 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
27093 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
27094 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
27095 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
27096 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
27097 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
27098 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
27099 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
27100 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
27101 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
27102 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
27103 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
27104 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
27105 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
27106 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
27108 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
27109 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
27110 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
27111 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
27112 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
27113 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
27114 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
27115 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
27116 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
27117 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
27118 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
27119 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
27120 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
27121 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
27122 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
27123 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
27124 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
27126 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
27127 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
27128 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
27129 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27130 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
27131 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
27132 (org-defkey org-mode-map "\C-c^" 'org-sort)
27133 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
27134 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
27135 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
27136 (org-defkey org-mode-map "\C-m" 'org-return)
27137 (org-defkey org-mode-map "\C-j" 'org-return-indent)
27138 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
27139 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
27140 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
27141 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
27142 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
27143 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
27144 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
27145 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
27146 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
27147 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
27148 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
27149 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
27150 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
27151 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
27152 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
27154 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
27155 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
27156 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
27157 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
27159 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
27160 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
27161 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
27162 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
27163 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
27164 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
27165 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
27166 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
27167 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
27168 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
27169 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
27170 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
27172 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
27174 (when (featurep 'xemacs)
27175 (org-defkey org-mode-map 'button3 'popup-mode-menu))
27177 (defsubst org-table-p () (org-at-table-p))
27179 (defun org-self-insert-command (N)
27180 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
27181 If the cursor is in a table looking at whitespace, the whitespace is
27182 overwritten, and the table is not marked as requiring realignment."
27183 (interactive "p")
27184 (if (and (org-table-p)
27185 (progn
27186 ;; check if we blank the field, and if that triggers align
27187 (and org-table-auto-blank-field
27188 (member last-command
27189 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
27191 ;; got extra space, this field does not determine column width
27192 (let (org-table-may-need-update) (org-table-blank-field))
27193 ;; no extra space, this field may determine column width
27194 (org-table-blank-field)))
27195 t)
27196 (eq N 1)
27198 (let (org-table-may-need-update)
27199 (goto-char (1- (match-end 0)))
27200 (delete-backward-char 1)
27201 (goto-char (match-beginning 0))
27202 (self-insert-command N))
27203 (setq org-table-may-need-update t)
27204 (self-insert-command N)
27205 (org-fix-tags-on-the-fly)))
27207 (defun org-fix-tags-on-the-fly ()
27208 (when (and (equal (char-after (point-at-bol)) ?*)
27209 (org-on-heading-p))
27210 (org-align-tags-here org-tags-column)))
27212 (defun org-delete-backward-char (N)
27213 "Like `delete-backward-char', insert whitespace at field end in tables.
27214 When deleting backwards, in tables this function will insert whitespace in
27216 still be marked for re-alignment if the field did fill the entire column,
27217 because, in this case the deletion might narrow the column."
27218 (interactive "p")
27219 (if (and (org-table-p)
27220 (eq N 1)
27221 (string-match "|" (buffer-substring (point-at-bol) (point)))
27222 (looking-at ".*?|"))
27223 (let ((pos (point))
27225 (c org-table-may-need-update))
27226 (backward-delete-char N)
27227 (skip-chars-forward "^|")
27228 (insert " ")
27229 (goto-char (1- pos))
27230 ;; noalign: if there were two spaces at the end, this field
27231 ;; does not determine the width of the column.
27232 (if noalign (setq org-table-may-need-update c)))
27233 (backward-delete-char N)
27234 (org-fix-tags-on-the-fly)))
27236 (defun org-delete-char (N)
27237 "Like `delete-char', but insert whitespace at field end in tables.
27238 When deleting characters, in tables this function will insert whitespace in
27240 still be marked for re-alignment if the field did fill the entire column,
27241 because, in this case the deletion might narrow the column."
27242 (interactive "p")
27243 (if (and (org-table-p)
27244 (not (bolp))
27245 (not (= (char-after) ?|))
27246 (eq N 1))
27247 (if (looking-at ".*?|")
27248 (let ((pos (point))
27250 (c org-table-may-need-update))
27251 (replace-match (concat
27252 (substring (match-string 0) 1 -1)
27253 " |"))
27254 (goto-char pos)
27255 ;; noalign: if there were two spaces at the end, this field
27256 ;; does not determine the width of the column.
27257 (if noalign (setq org-table-may-need-update c)))
27258 (delete-char N))
27259 (delete-char N)
27260 (org-fix-tags-on-the-fly)))
27262 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
27263 (put 'org-self-insert-command 'delete-selection t)
27264 (put 'orgtbl-self-insert-command 'delete-selection t)
27265 (put 'org-delete-char 'delete-selection 'supersede)
27266 (put 'org-delete-backward-char 'delete-selection 'supersede)
27268 ;; Make `flyspell-mode' delay after some commands
27269 (put 'org-self-insert-command 'flyspell-delayed t)
27270 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
27271 (put 'org-delete-char 'flyspell-delayed t)
27272 (put 'org-delete-backward-char 'flyspell-delayed t)
27274 ;; Make pabbrev-mode expand after org-mode commands
27275 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
27276 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
27278 ;; How to do this: Measure non-white length of current string
27279 ;; If equal to column width, we should realign.
27281 (defun org-remap (map &rest commands)
27282 "In MAP, remap the functions given in COMMANDS.
27283 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
27284 (let (new old)
27285 (while commands
27286 (setq old (pop commands) new (pop commands))
27287 (if (fboundp 'command-remapping)
27288 (org-defkey map (vector 'remap old) new)
27289 (substitute-key-definition old new map global-map)))))
27291 (when (eq org-enable-table-editor 'optimized)
27292 ;; If the user wants maximum table support, we need to hijack
27293 ;; some standard editing functions
27294 (org-remap org-mode-map
27295 'self-insert-command 'org-self-insert-command
27296 'delete-char 'org-delete-char
27297 'delete-backward-char 'org-delete-backward-char)
27298 (org-defkey org-mode-map "|" 'org-force-self-insert))
27300 (defun org-shiftcursor-error ()
27301 "Throw an error because Shift-Cursor command was applied in wrong context."
27302 (error "This command is active in special context like tables, headlines or timestamps"))
27304 (defun org-shifttab (&optional arg)
27305 "Global visibility cycling or move to previous table field.
27306 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
27307 on context.
27308 See the individual commands for more information."
27309 (interactive "P")
27310 (cond
27311 ((org-at-table-p) (call-interactively 'org-table-previous-field))
27312 (arg (message "Content view to level: ")
27313 (org-content (prefix-numeric-value arg))
27314 (setq org-cycle-global-status 'overview))
27315 (t (call-interactively 'org-global-cycle))))
27317 (defun org-shiftmetaleft ()
27318 "Promote subtree or delete table column.
27319 Calls `org-promote-subtree', `org-outdent-item',
27320 or `org-table-delete-column', depending on context.
27321 See the individual commands for more information."
27322 (interactive)
27323 (cond
27324 ((org-at-table-p) (call-interactively 'org-table-delete-column))
27325 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
27326 ((org-at-item-p) (call-interactively 'org-outdent-item))
27327 (t (org-shiftcursor-error))))
27329 (defun org-shiftmetaright ()
27330 "Demote subtree or insert table column.
27331 Calls `org-demote-subtree', `org-indent-item',
27332 or `org-table-insert-column', depending on context.
27333 See the individual commands for more information."
27334 (interactive)
27335 (cond
27336 ((org-at-table-p) (call-interactively 'org-table-insert-column))
27337 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
27338 ((org-at-item-p) (call-interactively 'org-indent-item))
27339 (t (org-shiftcursor-error))))
27341 (defun org-shiftmetaup (&optional arg)
27342 "Move subtree up or kill table row.
27343 Calls `org-move-subtree-up' or `org-table-kill-row' or
27344 `org-move-item-up' depending on context. See the individual commands
27345 for more information."
27346 (interactive "P")
27347 (cond
27348 ((org-at-table-p) (call-interactively 'org-table-kill-row))
27349 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27350 ((org-at-item-p) (call-interactively 'org-move-item-up))
27351 (t (org-shiftcursor-error))))
27352 (defun org-shiftmetadown (&optional arg)
27353 "Move subtree down or insert table row.
27354 Calls `org-move-subtree-down' or `org-table-insert-row' or
27355 `org-move-item-down', depending on context. See the individual
27356 commands for more information."
27357 (interactive "P")
27358 (cond
27359 ((org-at-table-p) (call-interactively 'org-table-insert-row))
27360 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27361 ((org-at-item-p) (call-interactively 'org-move-item-down))
27362 (t (org-shiftcursor-error))))
27364 (defun org-metaleft (&optional arg)
27365 "Promote heading or move table column to left.
27366 Calls `org-do-promote' or `org-table-move-column', depending on context.
27367 With no specific context, calls the Emacs default `backward-word'.
27368 See the individual commands for more information."
27369 (interactive "P")
27370 (cond
27371 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
27372 ((or (org-on-heading-p) (org-region-active-p))
27373 (call-interactively 'org-do-promote))
27374 ((org-at-item-p) (call-interactively 'org-outdent-item))
27375 (t (call-interactively 'backward-word))))
27377 (defun org-metaright (&optional arg)
27378 "Demote subtree or move table column to right.
27379 Calls `org-do-demote' or `org-table-move-column', depending on context.
27380 With no specific context, calls the Emacs default `forward-word'.
27381 See the individual commands for more information."
27382 (interactive "P")
27383 (cond
27384 ((org-at-table-p) (call-interactively 'org-table-move-column))
27385 ((or (org-on-heading-p) (org-region-active-p))
27386 (call-interactively 'org-do-demote))
27387 ((org-at-item-p) (call-interactively 'org-indent-item))
27388 (t (call-interactively 'forward-word))))
27390 (defun org-metaup (&optional arg)
27391 "Move subtree up or move table row up.
27392 Calls `org-move-subtree-up' or `org-table-move-row' or
27393 `org-move-item-up', depending on context. See the individual commands
27394 for more information."
27395 (interactive "P")
27396 (cond
27397 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
27398 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27399 ((org-at-item-p) (call-interactively 'org-move-item-up))
27400 (t (transpose-lines 1) (beginning-of-line -1))))
27402 (defun org-metadown (&optional arg)
27403 "Move subtree down or move table row down.
27404 Calls `org-move-subtree-down' or `org-table-move-row' or
27405 `org-move-item-down', depending on context. See the individual
27406 commands for more information."
27407 (interactive "P")
27408 (cond
27409 ((org-at-table-p) (call-interactively 'org-table-move-row))
27410 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27411 ((org-at-item-p) (call-interactively 'org-move-item-down))
27412 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
27414 (defun org-shiftup (&optional arg)
27415 "Increase item in timestamp or increase priority of current headline.
27416 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
27417 depending on context. See the individual commands for more information."
27418 (interactive "P")
27419 (cond
27420 ((org-at-timestamp-p t)
27421 (call-interactively (if org-edit-timestamp-down-means-later
27422 'org-timestamp-down 'org-timestamp-up)))
27423 ((org-on-heading-p) (call-interactively 'org-priority-up))
27424 ((org-at-item-p) (call-interactively 'org-previous-item))
27425 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
27427 (defun org-shiftdown (&optional arg)
27428 "Decrease item in timestamp or decrease priority of current headline.
27429 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
27430 depending on context. See the individual commands for more information."
27431 (interactive "P")
27432 (cond
27433 ((org-at-timestamp-p t)
27434 (call-interactively (if org-edit-timestamp-down-means-later
27435 'org-timestamp-up 'org-timestamp-down)))
27436 ((org-on-heading-p) (call-interactively 'org-priority-down))
27437 (t (call-interactively 'org-next-item))))
27439 (defun org-shiftright ()
27440 "Next TODO keyword or timestamp one day later, depending on context."
27441 (interactive)
27442 (cond
27443 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
27444 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
27445 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
27446 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
27447 (t (org-shiftcursor-error))))
27449 (defun org-shiftleft ()
27450 "Previous TODO keyword or timestamp one day earlier, depending on context."
27451 (interactive)
27452 (cond
27453 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
27454 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
27455 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
27456 ((org-at-property-p)
27457 (call-interactively 'org-property-previous-allowed-value))
27458 (t (org-shiftcursor-error))))
27460 (defun org-shiftcontrolright ()
27461 "Switch to next TODO set."
27462 (interactive)
27463 (cond
27464 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
27465 (t (org-shiftcursor-error))))
27467 (defun org-shiftcontrolleft ()
27468 "Switch to previous TODO set."
27469 (interactive)
27470 (cond
27471 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
27472 (t (org-shiftcursor-error))))
27474 (defun org-ctrl-c-ret ()
27475 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
27476 (interactive)
27477 (cond
27478 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27479 (t (call-interactively 'org-insert-heading))))
27481 (defun org-copy-special ()
27482 "Copy region in table or copy current subtree.
27483 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27484 See the individual commands for more information."
27485 (interactive)
27486 (call-interactively
27487 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27489 (defun org-cut-special ()
27490 "Cut region in table or cut current subtree.
27491 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27492 See the individual commands for more information."
27493 (interactive)
27494 (call-interactively
27495 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27497 (defun org-paste-special (arg)
27498 "Paste rectangular region into table, or past subtree relative to level.
27499 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27500 See the individual commands for more information."
27501 (interactive "P")
27502 (if (org-at-table-p)
27503 (org-table-paste-rectangle)
27504 (org-paste-subtree arg)))
27506 (defun org-ctrl-c-ctrl-c (&optional arg)
27507 "Set tags in headline, or update according to changed information at point.
27509 This command does many different things, depending on context:
27511 - If the cursor is in a headline, prompt for tags and insert them
27512 into the current line, aligned to `org-tags-column'. When called
27513 with prefix arg, realign all tags in the current buffer.
27515 - If the cursor is in one of the special #+KEYWORD lines, this
27516 triggers scanning the buffer for these lines and updating the
27517 information.
27519 - If the cursor is inside a table, realign the table. This command
27520 works even if the automatic table editor has been turned off.
27522 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27523 the entire table.
27525 - If the cursor is a the beginning of a dynamic block, update it.
27527 - If the cursor is inside a table created by the table.el package,
27528 activate that table.
27530 - If the current buffer is a remember buffer, close note and file it.
27531 with a prefix argument, file it without further interaction to the default
27532 location.
27534 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27535 links in this buffer.
27537 - If the cursor is on a numbered item in a plain list, renumber the
27538 ordered list.
27540 - If the cursor is on a checkbox, toggle it."
27541 (interactive "P")
27542 (let ((org-enable-table-editor t))
27543 (cond
27544 ((or org-clock-overlays
27545 org-occur-highlights
27546 org-latex-fragment-image-overlays)
27547 (org-remove-clock-overlays)
27548 (org-remove-occur-highlights)
27549 (org-remove-latex-fragment-image-overlays)
27550 (message "Temporary highlights/overlays removed from current buffer"))
27551 ((and (local-variable-p 'org-finish-function (current-buffer))
27552 (fboundp org-finish-function))
27553 (funcall org-finish-function))
27554 ((org-at-property-p)
27555 (call-interactively 'org-property-action))
27556 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27557 ((org-on-heading-p) (call-interactively 'org-set-tags))
27558 ((org-at-table.el-p)
27559 (require 'table)
27560 (beginning-of-line 1)
27561 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27562 (call-interactively 'table-recognize-table))
27563 ((org-at-table-p)
27564 (org-table-maybe-eval-formula)
27565 (if arg
27566 (call-interactively 'org-table-recalculate)
27567 (org-table-maybe-recalculate-line))
27568 (call-interactively 'org-table-align))
27569 ((org-at-item-checkbox-p)
27570 (call-interactively 'org-toggle-checkbox))
27571 ((org-at-item-p)
27572 (call-interactively 'org-maybe-renumber-ordered-list))
27574 ;; Dynamic block
27575 (beginning-of-line 1)
27576 (org-update-dblock))
27578 (cond
27579 ((equal (match-string 1) "TBLFM")
27580 ;; Recalculate the table before this line
27581 (save-excursion
27582 (beginning-of-line 1)
27584 (if (org-at-table-p)
27585 (org-call-with-arg 'org-table-recalculate t))))
27586 (t
27587 (call-interactively 'org-mode-restart))))
27588 (t (error "C-c C-c can do nothing useful at this location.")))))
27590 (defun org-mode-restart ()
27591 "Restart Org-mode, to scan again for special lines.
27592 Also updates the keyword regular expressions."
27593 (interactive)
27594 (let ((org-inhibit-startup t)) (org-mode))
27595 (message "Org-mode restarted to refresh keyword and special line setup"))
27597 (defun org-kill-note-or-show-branches ()
27598 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27599 (interactive)
27600 (if (not org-finish-function)
27601 (call-interactively 'show-branches)
27602 (let ((org-note-abort t))
27603 (funcall org-finish-function))))
27605 (defun org-return (&optional indent)
27606 "Goto next table row or insert a newline.
27607 Calls `org-table-next-row' or `newline', depending on context.
27608 See the individual commands for more information."
27609 (interactive)
27610 (cond
27611 ((bobp) (if indent (newline-and-indent) (newline)))
27612 ((and (org-at-heading-p)
27613 (looking-at
27615 (org-show-entry)
27616 (end-of-line 1)
27617 (newline))
27618 ((org-at-table-p)
27619 (org-table-justify-field-maybe)
27620 (call-interactively 'org-table-next-row))
27621 (t (if indent (newline-and-indent) (newline)))))
27623 (defun org-return-indent ()
27624 "Goto next table row or insert a newline and indent.
27625 Calls `org-table-next-row' or `newline-and-indent', depending on
27626 context. See the individual commands for more information."
27627 (interactive)
27628 (org-return t))
27630 (defun org-ctrl-c-star ()
27631 "Compute table, or change heading status of lines.
27632 Calls `org-table-recalculate' or `org-toggle-region-headlines',
27633 depending on context. This will also turn a plain list item or a normal
27634 line into a subheading."
27635 (interactive)
27636 (cond
27637 ((org-at-table-p)
27638 (call-interactively 'org-table-recalculate))
27639 ((org-region-active-p)
27640 ;; Convert all lines in region to list items
27641 (call-interactively 'org-toggle-region-headings))
27642 ((org-on-heading-p)
27643 (org-toggle-region-headings (point-at-bol)
27644 (min (1+ (point-at-eol)) (point-max))))
27645 ((org-at-item-p)
27646 ;; Convert to heading
27647 ;; FIXME: not yet implemented
27648 )
27649 (t (org-toggle-region-headings (point-at-bol)
27650 (min (1+ (point-at-eol)) (point-max))))))
27652 (defun org-ctrl-c-minus ()
27653 "Insert separator line in table or modify bullet status of line.
27654 Also turns a plain line or a region of lines into list items.
27655 Calls `org-table-insert-hline', `org-toggle-region-items', or
27656 `org-cycle-list-bullet', depending on context."
27657 (interactive)
27658 (cond
27659 ((org-at-table-p)
27660 (call-interactively 'org-table-insert-hline))
27661 ((org-on-heading-p)
27662 ;; Convert to item
27663 (save-excursion
27664 (beginning-of-line 1)
27666 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27667 ((org-region-active-p)
27668 ;; Convert all lines in region to list items
27669 (call-interactively 'org-toggle-region-items))
27670 ((org-in-item-p)
27671 (call-interactively 'org-cycle-list-bullet))
27672 (t (org-toggle-region-items (point-at-bol)
27673 (min (1+ (point-at-eol)) (point-max))))))
27675 (defun org-toggle-region-items (beg end)
27676 "Convert all lines in region to list items.
27677 If the first line is already an item, convert all list items in the region
27678 to normal lines."
27679 (interactive "r")
27680 (let (l2 l)
27681 (save-excursion
27682 (goto-char end)
27683 (setq l2 (org-current-line))
27684 (goto-char beg)
27685 (beginning-of-line 1)
27686 (setq l (1- (org-current-line)))
27687 (if (org-at-item-p)
27688 ;; We already have items, de-itemize
27689 (while (< (setq l (1+ l)) l2)
27690 (when (org-at-item-p)
27691 (goto-char (match-beginning 2))
27692 (delete-region (match-beginning 2) (match-end 2))
27694 (beginning-of-line 2))
27695 (while (< (setq l (1+ l)) l2)
27696 (unless (org-at-item-p)
27699 (beginning-of-line 2))))))
27701 (defun org-toggle-region-headings (beg end)
27702 "Convert all lines in region to list items.
27703 If the first line is already an item, convert all list items in the region
27704 to normal lines."
27705 (interactive "r")
27706 (let (l2 l)
27707 (save-excursion
27708 (goto-char end)
27709 (setq l2 (org-current-line))
27710 (goto-char beg)
27711 (beginning-of-line 1)
27712 (setq l (1- (org-current-line)))
27713 (if (org-on-heading-p)
27714 ;; We already have headlines, de-star them
27715 (while (< (setq l (1+ l)) l2)
27716 (when (org-on-heading-p t)
27717 (and (looking-at outline-regexp) (replace-match "")))
27718 (beginning-of-line 2))
27719 (let* ((stars (save-excursion
27720 (re-search-backward org-complex-heading-regexp nil t)
27721 (or (match-string 1) "*")))
27722 (add-stars (if org-odd-levels-only "**" "*"))
27724 (while (< (setq l (1+ l)) l2)
27725 (unless (org-on-heading-p)
27727 (replace-match rpl)))
27728 (beginning-of-line 2)))))))
27730 (defun org-meta-return (&optional arg)
27731 "Insert a new heading or wrap a region in a table.
27732 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27733 See the individual commands for more information."
27734 (interactive "P")
27735 (cond
27736 ((org-at-table-p)
27737 (call-interactively 'org-table-wrap-region))
27738 (t (call-interactively 'org-insert-heading))))
27740 ;;; Menu entries
27742 ;; Define the Org-mode menus
27743 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27744 '("Tbl"
27745 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27746 ["Next Field" org-cycle (org-at-table-p)]
27747 ["Previous Field" org-shifttab (org-at-table-p)]
27748 ["Next Row" org-return (org-at-table-p)]
27749 "--"
27750 ["Blank Field" org-table-blank-field (org-at-table-p)]
27751 ["Edit Field" org-table-edit-field (org-at-table-p)]
27752 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27753 "--"
27754 ("Column"
27755 ["Move Column Left" org-metaleft (org-at-table-p)]
27756 ["Move Column Right" org-metaright (org-at-table-p)]
27757 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27758 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27759 ("Row"
27760 ["Move Row Up" org-metaup (org-at-table-p)]
27761 ["Move Row Down" org-metadown (org-at-table-p)]
27762 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27763 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27764 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27765 "--"
27766 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27767 ("Rectangle"
27768 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27769 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27770 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27771 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27772 "--"
27773 ("Calculate"
27774 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27775 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27776 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27777 "--"
27778 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27779 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27780 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27781 "--"
27782 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27783 "--"
27784 ["Sum Column/Rectangle" org-table-sum
27785 (or (org-at-table-p) (org-region-active-p))]
27786 ["Which Column?" org-table-current-column (org-at-table-p)])
27787 ["Debug Formulas"
27788 org-table-toggle-formula-debugger
27789 :style toggle :selected org-table-formula-debug]
27790 ["Show Col/Row Numbers"
27791 org-table-toggle-coordinate-overlays
27792 :style toggle :selected org-table-overlay-coordinates]
27793 "--"
27794 ["Create" org-table-create (and (not (org-at-table-p))
27795 org-enable-table-editor)]
27796 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27797 ["Import from File" org-table-import (not (org-at-table-p))]
27798 ["Export to File" org-table-export (org-at-table-p)]
27799 "--"
27800 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27802 (easy-menu-define org-org-menu org-mode-map "Org menu"
27803 '("Org"
27804 ("Show/Hide"
27805 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27806 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27807 ["Sparse Tree" org-occur t]
27808 ["Reveal Context" org-reveal t]
27809 ["Show All" show-all t]
27810 "--"
27811 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27812 "--"
27813 ["New Heading" org-insert-heading t]
27814 ("Navigate Headings"
27815 ["Up" outline-up-heading t]
27816 ["Next" outline-next-visible-heading t]
27817 ["Previous" outline-previous-visible-heading t]
27818 ["Next Same Level" outline-forward-same-level t]
27819 ["Previous Same Level" outline-backward-same-level t]
27820 "--"
27821 ["Jump" org-goto t])
27822 ("Edit Structure"
27823 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27824 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27825 "--"
27826 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27827 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27828 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27829 "--"
27830 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27831 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27832 ["Demote Heading" org-metaright (not (org-at-table-p))]
27833 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27834 "--"
27835 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27836 "--"
27837 ["Convert to odd levels" org-convert-to-odd-levels t]
27838 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27839 ("Editing"
27840 ["Emphasis..." org-emphasize t])
27841 ("Archive"
27842 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27843 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27844 ; :active t :keys "C-u C-c C-x C-a"]
27845 ["Sparse trees open ARCHIVE trees"
27846 (setq org-sparse-tree-open-archived-trees
27847 (not org-sparse-tree-open-archived-trees))
27848 :style toggle :selected org-sparse-tree-open-archived-trees]
27849 ["Cycling opens ARCHIVE trees"
27850 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27851 :style toggle :selected org-cycle-open-archived-trees]
27852 ["Agenda includes ARCHIVE trees"
27853 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27854 :style toggle :selected (not org-agenda-skip-archived-trees)]
27855 "--"
27856 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27857 ; ["Check and Move Children" (org-archive-subtree '(4))
27858 ; :active t :keys "C-u C-c C-x C-s"]
27859 )
27860 "--"
27861 ("TODO Lists"
27862 ["TODO/DONE/-" org-todo t]
27863 ("Select keyword"
27864 ["Next keyword" org-shiftright (org-on-heading-p)]
27865 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27866 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27867 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27868 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27869 ["Show TODO Tree" org-show-todo-tree t]
27870 ["Global TODO list" org-todo-list t]
27871 "--"
27872 ["Set Priority" org-priority t]
27873 ["Priority Up" org-shiftup t]
27874 ["Priority Down" org-shiftdown t])
27875 ("TAGS and Properties"
27876 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27877 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27878 "--"
27879 ["Set property" 'org-set-property t]
27880 ["Column view of properties" org-columns t]
27881 ["Insert Column View DBlock" org-insert-columns-dblock t])
27882 ("Dates and Scheduling"
27883 ["Timestamp" org-time-stamp t]
27884 ["Timestamp (inactive)" org-time-stamp-inactive t]
27885 ("Change Date"
27886 ["1 Day Later" org-shiftright t]
27887 ["1 Day Earlier" org-shiftleft t]
27888 ["1 ... Later" org-shiftup t]
27889 ["1 ... Earlier" org-shiftdown t])
27890 ["Compute Time Range" org-evaluate-time-range t]
27891 ["Schedule Item" org-schedule t]
27892 ["Deadline" org-deadline t]
27893 "--"
27894 ["Custom time format" org-toggle-time-stamp-overlays
27895 :style radio :selected org-display-custom-times]
27896 "--"
27897 ["Goto Calendar" org-goto-calendar t]
27898 ["Date from Calendar" org-date-from-calendar t])
27899 ("Logging work"
27900 ["Clock in" org-clock-in t]
27901 ["Clock out" org-clock-out t]
27902 ["Clock cancel" org-clock-cancel t]
27903 ["Goto running clock" org-clock-goto t]
27904 ["Display times" org-clock-display t]
27905 ["Create clock table" org-clock-report t]
27906 "--"
27907 ["Record DONE time"
27908 (progn (setq org-log-done (not org-log-done))
27909 (message "Switching to %s will %s record a timestamp"
27910 (car org-done-keywords)
27911 (if org-log-done "automatically" "not")))
27912 :style toggle :selected org-log-done])
27913 "--"
27914 ["Agenda Command..." org-agenda t]
27915 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27916 ("File List for Agenda")
27917 ("Special views current file"
27918 ["TODO Tree" org-show-todo-tree t]
27919 ["Check Deadlines" org-check-deadlines t]
27920 ["Timeline" org-timeline t]
27921 ["Tags Tree" org-tags-sparse-tree t])
27922 "--"
27923 ("Hyperlinks"
27924 ["Store Link (Global)" org-store-link t]
27925 ["Insert Link" org-insert-link t]
27926 ["Follow Link" org-open-at-point t]
27927 "--"
27928 ["Next link" org-next-link t]
27929 ["Previous link" org-previous-link t]
27930 "--"
27931 ["Descriptive Links"
27932 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27933 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27934 ["Literal Links"
27935 (progn
27936 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27937 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27938 "--"
27939 ["Export/Publish..." org-export t]
27940 ("LaTeX"
27941 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27942 :selected org-cdlatex-mode]
27943 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27944 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27945 ["Modify math symbol" org-cdlatex-math-modify
27946 (org-inside-LaTeX-fragment-p)]
27947 ["Export LaTeX fragments as images"
27948 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27949 :style toggle :selected org-export-with-LaTeX-fragments])
27950 "--"
27951 ("Documentation"
27952 ["Show Version" org-version t]
27953 ["Info Documentation" org-info t])
27954 ("Customize"
27955 ["Browse Org Group" org-customize t]
27956 "--"
27957 ["Expand This Menu" org-create-customize-menu
27958 (fboundp 'customize-menu-create)])
27959 "--"
27960 ["Refresh setup" org-mode-restart t]
27961 ))
27963 (defun org-info (&optional node)
27964 "Read documentation for Org-mode in the info system.
27965 With optional NODE, go directly to that node."
27966 (interactive)
27967 (info (format "(org)%s" (or node ""))))
27969 (defun org-install-agenda-files-menu ()
27970 (let ((bl (buffer-list)))
27971 (save-excursion
27972 (while bl
27973 (set-buffer (pop bl))
27974 (if (org-mode-p) (setq bl nil)))
27975 (when (org-mode-p)
27976 (easy-menu-change
27977 '("Org") "File List for Agenda"
27978 (append
27979 (list
27980 ["Edit File List" (org-edit-agenda-file-list) t]
27981 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27982 ["Remove Current File from List" org-remove-file t]
27983 ["Cycle through agenda files" org-cycle-agenda-files t]
27984 ["Occur in all agenda files" org-occur-in-agenda-files t]
27985 "--")
27986 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27988 ;;;; Documentation
27990 (defun org-customize ()
27991 "Call the customize function with org as argument."
27992 (interactive)
27993 (customize-browse 'org))
27995 (defun org-create-customize-menu ()
27996 "Create a full customization menu for Org-mode, insert it into the menu."
27997 (interactive)
27998 (if (fboundp 'customize-menu-create)
27999 (progn
28000 (easy-menu-change
28001 '("Org") "Customize"
28002 `(["Browse Org group" org-customize t]
28003 "--"
28004 ,(customize-menu-create 'org)
28005 ["Set" Custom-set t]
28006 ["Save" Custom-save t]
28007 ["Reset to Current" Custom-reset-current t]
28008 ["Reset to Saved" Custom-reset-saved t]
28009 ["Reset to Standard Settings" Custom-reset-standard t]))
28011 (error "Cannot expand menu (outdated version of cus-edit.el)")))
28013 ;;;; Miscellaneous stuff
28016 ;;; Generally useful functions
28018 (defun org-context ()
28019 "Return a list of contexts of the current cursor position.
28020 If several contexts apply, all are returned.
28021 Each context entry is a list with a symbol naming the context, and
28022 two positions indicating start and end of the context. Possible
28023 contexts are:
28025 :headline anywhere in a headline
28026 :headline-stars on the leading stars in a headline
28027 :todo-keyword on a TODO keyword (including DONE) in a headline
28028 :tags on the TAGS in a headline
28029 :priority on the priority cookie in a headline
28030 :item on the first line of a plain list item
28031 :item-bullet on the bullet/number of a plain list item
28032 :checkbox on the checkbox in a plain list item
28033 :table in an org-mode table
28034 :table-special on a special filed in a table
28035 :table-table in a table.el table
28036 :link on a hyperlink
28037 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
28038 :target on a <<target>>
28039 :radio-target on a <<<radio-target>>>
28040 :latex-fragment on a LaTeX fragment
28041 :latex-preview on a LaTeX fragment with overlayed preview image
28043 This function expects the position to be visible because it uses font-lock
28044 faces as a help to recognize the following contexts: :table-special, :link,
28045 and :keyword."
28046 (let* ((f (get-text-property (point) 'face))
28047 (faces (if (listp f) f (list f)))
28048 (p (point)) clist o)
28049 ;; First the large context
28050 (cond
28051 ((org-on-heading-p t)
28052 (push (list :headline (point-at-bol) (point-at-eol)) clist)
28053 (when (progn
28054 (beginning-of-line 1)
28055 (looking-at org-todo-line-tags-regexp))
28056 (push (org-point-in-group p 1 :headline-stars) clist)
28057 (push (org-point-in-group p 2 :todo-keyword) clist)
28058 (push (org-point-in-group p 4 :tags) clist))
28059 (goto-char p)
28062 (push (org-point-in-group p 0 :priority) clist)))
28064 ((org-at-item-p)
28065 (push (org-point-in-group p 2 :item-bullet) clist)
28066 (push (list :item (point-at-bol)
28067 (save-excursion (org-end-of-item) (point)))
28068 clist)
28069 (and (org-at-item-checkbox-p)
28070 (push (org-point-in-group p 0 :checkbox) clist)))
28072 ((org-at-table-p)
28073 (push (list :table (org-table-begin) (org-table-end)) clist)
28074 (if (memq 'org-formula faces)
28075 (push (list :table-special
28076 (previous-single-property-change p 'face)
28077 (next-single-property-change p 'face)) clist)))
28078 ((org-at-table-p 'any)
28079 (push (list :table-table) clist)))
28080 (goto-char p)
28082 ;; Now the small context
28083 (cond
28084 ((org-at-timestamp-p)
28085 (push (org-point-in-group p 0 :timestamp) clist))
28086 ((memq 'org-link faces)
28087 (push (list :link
28088 (previous-single-property-change p 'face)
28089 (next-single-property-change p 'face)) clist))
28090 ((memq 'org-special-keyword faces)
28091 (push (list :keyword
28092 (previous-single-property-change p 'face)
28093 (next-single-property-change p 'face)) clist))
28094 ((org-on-target-p)
28095 (push (org-point-in-group p 0 :target) clist)
28096 (goto-char (1- (match-beginning 0)))
28097 (if (looking-at org-radio-target-regexp)
28098 (push (org-point-in-group p 0 :radio-target) clist))
28099 (goto-char p))
28100 ((setq o (car (delq nil
28101 (mapcar
28102 (lambda (x)
28103 (if (memq x org-latex-fragment-image-overlays) x))
28104 (org-overlays-at (point))))))
28105 (push (list :latex-fragment
28106 (org-overlay-start o) (org-overlay-end o)) clist)
28107 (push (list :latex-preview
28108 (org-overlay-start o) (org-overlay-end o)) clist))
28109 ((org-inside-LaTeX-fragment-p)
28110 ;; FIXME: positions wrong.
28111 (push (list :latex-fragment (point) (point)) clist)))
28113 (setq clist (nreverse (delq nil clist)))
28114 clist))
28116 ;; FIXME: Compare with at-regexp-p Do we need both?
28117 (defun org-in-regexp (re &optional nlines visually)
28118 "Check if point is inside a match of regexp.
28119 Normally only the current line is checked, but you can include NLINES extra
28120 lines both before and after point into the search.
28121 If VISUALLY is set, require that the cursor is not after the match but
28122 really on, so that the block visually is on the match."
28123 (catch 'exit
28124 (let ((pos (point))
28125 (eol (point-at-eol (+ 1 (or nlines 0))))
28126 (inc (if visually 1 0)))
28127 (save-excursion
28128 (beginning-of-line (- 1 (or nlines 0)))
28129 (while (re-search-forward re eol t)
28130 (if (and (<= (match-beginning 0) pos)
28131 (>= (+ inc (match-end 0)) pos))
28132 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
28134 (defun org-at-regexp-p (regexp)
28135 "Is point inside a match of REGEXP in the current line?"
28136 (catch 'exit
28137 (save-excursion
28138 (let ((pos (point)) (end (point-at-eol)))
28139 (beginning-of-line 1)
28140 (while (re-search-forward regexp end t)
28141 (if (and (<= (match-beginning 0) pos)
28142 (>= (match-end 0) pos))
28143 (throw 'exit t)))
28144 nil))))
28146 (defun org-occur-in-agenda-files (regexp &optional nlines)
28147 "Call `multi-occur' with buffers for all agenda files."
28149 (let* ((files (org-agenda-files))
28150 (tnames (mapcar 'file-truename files))
28151 (extra org-agenda-text-search-extra-files)
28152 f)
28153 (while (setq f (pop extra))
28154 (unless (member (file-truename f) tnames)
28155 (add-to-list 'files f 'append)
28156 (add-to-list 'tnames (file-truename f) 'append)))
28157 (multi-occur
28158 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
28159 regexp)))
28161 (if (boundp 'occur-mode-find-occurrence-hook)
28162 ;; Emacs 23
28163 (add-hook 'occur-mode-find-occurrence-hook
28164 (lambda ()
28165 (when (org-mode-p)
28166 (org-reveal))))
28167 ;; Emacs 22
28168 (defadvice occur-mode-goto-occurrence
28169 (after org-occur-reveal activate)
28170 (and (org-mode-p) (org-reveal)))
28171 (defadvice occur-mode-goto-occurrence-other-window
28172 (after org-occur-reveal activate)
28173 (and (org-mode-p) (org-reveal)))
28174 (defadvice occur-mode-display-occurrence
28175 (after org-occur-reveal activate)
28176 (when (org-mode-p)
28177 (let ((pos (occur-mode-find-occurrence)))
28178 (with-current-buffer (marker-buffer pos)
28179 (save-excursion
28180 (goto-char pos)
28181 (org-reveal)))))))
28183 (defun org-uniquify (list)
28184 "Remove duplicate elements from LIST."
28185 (let (res)
28186 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
28187 res))
28189 (defun org-delete-all (elts list)
28190 "Remove all elements in ELTS from LIST."
28191 (while elts
28192 (setq list (delete (pop elts) list)))
28193 list)
28195 (defun org-back-over-empty-lines ()
28196 "Move backwards over witespace, to the beginning of the first empty line.
28197 Returns the number o empty lines passed."
28198 (let ((pos (point)))
28200 (beginning-of-line 2)
28201 (goto-char (min (point) pos))
28202 (count-lines (point) pos)))
28204 (defun org-skip-whitespace ()
28207 (defun org-point-in-group (point group &optional context)
28208 "Check if POINT is in match-group GROUP.
28209 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
28210 match. If the match group does ot exist or point is not inside it,
28211 return nil."
28212 (and (match-beginning group)
28213 (>= point (match-beginning group))
28214 (<= point (match-end group))
28215 (if context
28216 (list context (match-beginning group) (match-end group))
28217 t)))
28219 (defun org-switch-to-buffer-other-window (&rest args)
28220 "Switch to buffer in a second window on the current frame.
28221 In particular, do not allow pop-up frames."
28222 (let (pop-up-frames special-display-buffer-names special-display-regexps
28223 special-display-function)
28224 (apply 'switch-to-buffer-other-window args)))
28226 (defun org-combine-plists (&rest plists)
28227 "Create a single property list from all plists in PLISTS.
28228 The process starts by copying the first list, and then setting properties
28229 from the other lists. Settings in the last list are the most significant
28230 ones and overrule settings in the other lists."
28231 (let ((rtn (copy-sequence (pop plists)))
28232 p v ls)
28233 (while plists
28234 (setq ls (pop plists))
28235 (while ls
28236 (setq p (pop ls) v (pop ls))
28237 (setq rtn (plist-put rtn p v))))
28238 rtn))
28240 (defun org-move-line-down (arg)
28241 "Move the current line down. With prefix argument, move it past ARG lines."
28242 (interactive "p")
28243 (let ((col (current-column))
28244 beg end pos)
28245 (beginning-of-line 1) (setq beg (point))
28246 (beginning-of-line 2) (setq end (point))
28247 (beginning-of-line (+ 1 arg))
28248 (setq pos (move-marker (make-marker) (point)))
28249 (insert (delete-and-extract-region beg end))
28250 (goto-char pos)
28251 (move-to-column col)))
28253 (defun org-move-line-up (arg)
28254 "Move the current line up. With prefix argument, move it past ARG lines."
28255 (interactive "p")
28256 (let ((col (current-column))
28257 beg end pos)
28258 (beginning-of-line 1) (setq beg (point))
28259 (beginning-of-line 2) (setq end (point))
28260 (beginning-of-line (- arg))
28261 (setq pos (move-marker (make-marker) (point)))
28262 (insert (delete-and-extract-region beg end))
28263 (goto-char pos)
28264 (move-to-column col)))
28266 (defun org-replace-escapes (string table)
28267 "Replace %-escapes in STRING with values in TABLE.
28269 The sequences in STRING may contain normal field width and padding information,
28271 so values can contain further %-escapes if they are define later in TABLE."
28272 (let ((case-fold-search nil)
28273 e re rpl)
28274 (while (setq e (pop table))
28275 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
28276 (while (string-match re string)
28277 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
28278 (cdr e)))
28279 (setq string (replace-match rpl t t string))))
28280 string))
28283 (defun org-sublist (list start end)
28284 "Return a section of LIST, from START to END.
28285 Counting starts at 1."
28286 (let (rtn (c start))
28287 (setq list (nthcdr (1- start) list))
28288 (while (and list (<= c end))
28289 (push (pop list) rtn)
28290 (setq c (1+ c)))
28291 (nreverse rtn)))
28293 (defun org-find-base-buffer-visiting (file)
28294 "Like `find-buffer-visiting' but alway return the base buffer and
28295 not an indirect buffer"
28296 (let ((buf (find-buffer-visiting file)))
28297 (if buf
28298 (or (buffer-base-buffer buf) buf)
28299 nil)))
28301 (defun org-image-file-name-regexp ()
28302 "Return regexp matching the file names of images."
28303 (if (fboundp 'image-file-name-regexp)
28304 (image-file-name-regexp)
28305 (let ((image-file-name-extensions
28306 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
28307 "xbm" "xpm" "pbm" "pgm" "ppm")))
28309 (regexp-opt (nconc (mapcar 'upcase
28310 image-file-name-extensions)
28311 image-file-name-extensions)
28312 t)
28315 (defun org-file-image-p (file)
28316 "Return non-nil if FILE is an image."
28317 (save-match-data
28318 (string-match (org-image-file-name-regexp) file)))
28320 ;;; Paragraph filling stuff.
28321 ;; We want this to be just right, so use the full arsenal.
28323 (defun org-indent-line-function ()
28324 "Indent line like previous, but further if previous was headline or item."
28325 (interactive)
28326 (let* ((pos (point))
28327 (itemp (org-at-item-p))
28328 column bpos bcol tpos tcol bullet btype bullet-type)
28329 ;; Find the previous relevant line
28330 (beginning-of-line 1)
28331 (cond
28332 ((looking-at "#") (setq column 0))
28334 (t
28335 (beginning-of-line 0)
28337 (beginning-of-line 0))
28338 (cond
28340 (goto-char (match-end 0))
28341 (setq column (current-column)))
28342 ((org-in-item-p)
28343 (org-beginning-of-item)
28346 (setq bpos (match-beginning 1) tpos (match-end 0)
28347 bcol (progn (goto-char bpos) (current-column))
28348 tcol (progn (goto-char tpos) (current-column))
28349 bullet (match-string 1)
28350 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
28351 (if (not itemp)
28352 (setq column tcol)
28353 (goto-char pos)
28354 (beginning-of-line 1)
28356 (progn
28358 (setq bullet (match-string 1)
28359 btype (if (string-match "[0-9]" bullet) "n" bullet))
28360 (setq column (if (equal btype bullet-type) bcol tcol)))
28361 (setq column (org-get-indentation)))))
28362 (t (setq column (org-get-indentation))))))
28363 (goto-char pos)
28364 (if (<= (current-column) (current-indentation))
28365 (indent-line-to column)
28366 (save-excursion (indent-line-to column)))
28367 (setq column (current-column))
28368 (beginning-of-line 1)
28369 (if (looking-at
28372 (match-string 2) (match-string 3)))
28373 t nil))
28374 (move-to-column column)))
28376 (defun org-set-autofill-regexps ()
28377 (interactive)
28378 ;; In the paragraph separator we include headlines, because filling
28379 ;; text in a line directly attached to a headline would otherwise
28380 ;; fill the headline as well.
28383 ;; The paragraph starter includes hand-formatted lists.
28384 (org-set-local 'paragraph-start
28386 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
28387 ;; But only if the user has not turned off tables or fixed-width regions
28388 (org-set-local
28389 'auto-fill-inhibit-regexp
28392 (if (or org-enable-table-editor org-enable-fixed-width-editor)
28393 (concat
28395 (if org-enable-table-editor "|" "")
28396 (if org-enable-fixed-width-editor ":" "")
28397 "]"))))
28398 ;; We use our own fill-paragraph function, to make sure that tables
28399 ;; and fixed-width regions are not wrapped. That function will pass
28400 ;; through to `fill-paragraph' when appropriate.
28401 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
28402 ; Adaptive filling: To get full control, first make sure that
28403 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
28405 (org-set-local 'adaptive-fill-function
28406 'org-adaptive-fill-function)
28407 (org-set-local
28408 'align-mode-rules-list
28409 '((org-in-buffer-settings
28411 (modes . '(org-mode))))))
28413 (defun org-fill-paragraph (&optional justify)
28414 "Re-align a table, pass through to fill-paragraph if no table."
28415 (let ((table-p (org-at-table-p))
28416 (table.el-p (org-at-table.el-p)))
28417 (cond ((and (equal (char-after (point-at-bol)) ?*)
28418 (save-excursion (goto-char (point-at-bol))
28419 (looking-at outline-regexp)))
28420 t) ; skip headlines
28421 (table.el-p t) ; skip table.el tables
28422 (table-p (org-table-align) t) ; align org-mode tables
28423 (t nil)))) ; call paragraph-fill
28425 ;; For reference, this is the default value of adaptive-fill-regexp
28428 (defun org-adaptive-fill-function ()
28429 "Return a fill prefix for org-mode files.
28430 In particular, this makes sure hanging paragraphs for hand-formatted lists
28431 work correctly."
28433 (match-string 0))
28435 (save-excursion
28436 (goto-char (match-end 0))
28437 (make-string (current-column) ?\ )))
28438 (t nil)))
28440 ;;;; Functions extending outline functionality
28443 (defun org-beginning-of-line (&optional arg)
28444 "Go to the beginning of the current line. If that is invisible, continue
28445 to a visible line beginning. This makes the function of C-a more intuitive.
28446 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28447 first attempt, and only move to after the tags when the cursor is already
28448 beyond the end of the headline."
28449 (interactive "P")
28450 (let ((pos (point)))
28451 (beginning-of-line 1)
28452 (if (bobp)
28453 nil
28454 (backward-char 1)
28455 (if (org-invisible-p)
28456 (while (and (not (bobp)) (org-invisible-p))
28457 (backward-char 1)
28458 (beginning-of-line 1))
28459 (forward-char 1)))
28460 (when org-special-ctrl-a/e
28461 (cond
28462 ((and (looking-at org-todo-line-regexp)
28463 (= (char-after (match-end 1)) ?\ ))
28464 (goto-char
28465 (if (eq org-special-ctrl-a/e t)
28466 (cond ((> pos (match-beginning 3)) (match-beginning 3))
28467 ((= pos (point)) (match-beginning 3))
28468 (t (point)))
28469 (cond ((> pos (point)) (point))
28470 ((not (eq last-command this-command)) (point))
28471 (t (match-beginning 3))))))
28472 ((org-at-item-p)
28473 (goto-char
28474 (if (eq org-special-ctrl-a/e t)
28475 (cond ((> pos (match-end 4)) (match-end 4))
28476 ((= pos (point)) (match-end 4))
28477 (t (point)))
28478 (cond ((> pos (point)) (point))
28479 ((not (eq last-command this-command)) (point))
28480 (t (match-end 4))))))))))
28482 (defun org-end-of-line (&optional arg)
28483 "Go to the end of the line.
28484 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28485 first attempt, and only move to after the tags when the cursor is already
28486 beyond the end of the headline."
28487 (interactive "P")
28488 (if (or (not org-special-ctrl-a/e)
28489 (not (org-on-heading-p)))
28490 (end-of-line arg)
28491 (let ((pos (point)))
28492 (beginning-of-line 1)
28494 (if (eq org-special-ctrl-a/e t)
28495 (if (or (< pos (match-beginning 1))
28496 (= pos (match-end 0)))
28497 (goto-char (match-beginning 1))
28498 (goto-char (match-end 0)))
28499 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
28500 (goto-char (match-end 0))
28501 (goto-char (match-beginning 1))))
28502 (end-of-line arg)))))
28504 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
28505 (define-key org-mode-map "\C-e" 'org-end-of-line)
28507 (defun org-kill-line (&optional arg)
28508 "Kill line, to tags or end of line."
28509 (interactive "P")
28510 (cond
28511 ((or (not org-special-ctrl-k)
28512 (bolp)
28513 (not (org-on-heading-p)))
28514 (call-interactively 'kill-line))
28516 (kill-region (point) (match-beginning 1))
28517 (org-set-tags nil t))
28518 (t (kill-region (point) (point-at-eol)))))
28520 (define-key org-mode-map "\C-k" 'org-kill-line)
28522 (defun org-invisible-p ()
28523 "Check if point is at a character currently not visible."
28524 ;; Early versions of noutline don't have `outline-invisible-p'.
28525 (if (fboundp 'outline-invisible-p)
28526 (outline-invisible-p)
28527 (get-char-property (point) 'invisible)))
28529 (defun org-invisible-p2 ()
28530 "Check if point is at a character currently not visible."
28531 (save-excursion
28532 (if (and (eolp) (not (bobp))) (backward-char 1))
28533 ;; Early versions of noutline don't have `outline-invisible-p'.
28534 (if (fboundp 'outline-invisible-p)
28535 (outline-invisible-p)
28536 (get-char-property (point) 'invisible))))
28538 (defalias 'org-back-to-heading 'outline-back-to-heading)
28539 (defalias 'org-on-heading-p 'outline-on-heading-p)
28540 (defalias 'org-at-heading-p 'outline-on-heading-p)
28541 (defun org-at-heading-or-item-p ()
28542 (or (org-on-heading-p) (org-at-item-p)))
28544 (defun org-on-target-p ()
28545 (or (org-in-regexp org-radio-target-regexp)
28546 (org-in-regexp org-target-regexp)))
28548 (defun org-up-heading-all (arg)
28549 "Move to the heading line of which the present line is a subheading.
28550 This function considers both visible and invisible heading lines.
28551 With argument, move up ARG levels."
28552 (if (fboundp 'outline-up-heading-all)
28553 (outline-up-heading-all arg) ; emacs 21 version of outline.el
28554 (outline-up-heading arg t))) ; emacs 22 version of outline.el
28556 (defun org-up-heading-safe ()
28557 "Move to the heading line of which the present line is a subheading.
28558 This version will not throw an error. It will return the level of the
28559 headline found, or nil if no higher level is found."
28560 (let ((pos (point)) start-level level
28561 (re (concat "^" outline-regexp)))
28562 (catch 'exit
28563 (outline-back-to-heading t)
28564 (setq start-level (funcall outline-level))
28565 (if (equal start-level 1) (throw 'exit nil))
28566 (while (re-search-backward re nil t)
28567 (setq level (funcall outline-level))
28568 (if (< level start-level) (throw 'exit level)))
28569 nil)))
28571 (defun org-first-sibling-p ()
28572 "Is this heading the first child of its parents?"
28573 (interactive)
28574 (let ((re (concat "^" outline-regexp))
28575 level l)
28576 (unless (org-at-heading-p t)
28577 (error "Not at a heading"))
28578 (setq level (funcall outline-level))
28579 (save-excursion
28580 (if (not (re-search-backward re nil t))
28581 t
28582 (setq l (funcall outline-level))
28583 (< l level)))))
28585 (defun org-goto-sibling (&optional previous)
28586 "Goto the next sibling, even if it is invisible.
28587 When PREVIOUS is set, go to the previous sibling instead. Returns t
28588 when a sibling was found. When none is found, return nil and don't
28589 move point."
28590 (let ((fun (if previous 're-search-backward 're-search-forward))
28591 (pos (point))
28592 (re (concat "^" outline-regexp))
28593 level l)
28594 (when (condition-case nil (org-back-to-heading t) (error nil))
28595 (setq level (funcall outline-level))
28596 (catch 'exit
28597 (or previous (forward-char 1))
28598 (while (funcall fun re nil t)
28599 (setq l (funcall outline-level))
28600 (when (< l level) (goto-char pos) (throw 'exit nil))
28601 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28602 (goto-char pos)
28603 nil))))
28605 (defun org-show-siblings ()
28606 "Show all siblings of the current headline."
28607 (save-excursion
28608 (while (org-goto-sibling) (org-flag-heading nil)))
28609 (save-excursion
28610 (while (org-goto-sibling 'previous)
28611 (org-flag-heading nil))))
28613 (defun org-show-hidden-entry ()
28614 "Show an entry where even the heading is hidden."
28615 (save-excursion
28616 (org-show-entry)))
28618 (defun org-flag-heading (flag &optional entry)
28619 "Flag the current heading. FLAG non-nil means make invisible.
28620 When ENTRY is non-nil, show the entire entry."
28621 (save-excursion
28622 (org-back-to-heading t)
28623 ;; Check if we should show the entire entry
28624 (if entry
28625 (progn
28626 (org-show-entry)
28627 (save-excursion
28628 (and (outline-next-heading)
28629 (org-flag-heading nil))))
28630 (outline-flag-region (max (point-min) (1- (point)))
28631 (save-excursion (outline-end-of-heading) (point))
28632 flag))))
28634 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28635 ;; This is an exact copy of the original function, but it uses
28636 ;; `org-back-to-heading', to make it work also in invisible
28637 ;; trees. And is uses an invisible-OK argument.
28638 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28639 (org-back-to-heading invisible-OK)
28640 (let ((first t)
28641 (level (funcall outline-level)))
28642 (while (and (not (eobp))
28643 (or first (> (funcall outline-level) level)))
28644 (setq first nil)
28645 (outline-next-heading))
28646 (unless to-heading
28648 (progn
28649 ;; Go to end of line before heading
28650 (forward-char -1)
28652 ;; leave blank line before heading
28653 (forward-char -1))))))
28654 (point))
28656 (defun org-show-subtree ()
28657 "Show everything after this heading at deeper levels."
28658 (outline-flag-region
28659 (point)
28660 (save-excursion
28661 (outline-end-of-subtree) (outline-next-heading) (point))
28662 nil))
28664 (defun org-show-entry ()
28665 "Show the body directly following this heading.
28666 Show the heading too, if it is currently invisible."
28667 (interactive)
28668 (save-excursion
28669 (condition-case nil
28670 (progn
28671 (org-back-to-heading t)
28672 (outline-flag-region
28673 (max (point-min) (1- (point)))
28674 (save-excursion
28675 (re-search-forward
28677 (or (match-beginning 1) (point-max)))
28678 nil))
28679 (error nil))))
28681 (defun org-make-options-regexp (kwds)
28682 "Make a regular expression for keyword lines."
28683 (concat
28684 "^"
28690 ;; Make isearch reveal the necessary context
28691 (defun org-isearch-end ()
28692 "Reveal context after isearch exits."
28693 (when isearch-success ; only if search was successful
28694 (if (featurep 'xemacs)
28695 ;; Under XEmacs, the hook is run in the correct place,
28696 ;; we directly show the context.
28697 (org-show-context 'isearch)
28698 ;; In Emacs the hook runs *before* restoring the overlays.
28699 ;; So we have to use a one-time post-command-hook to do this.
28700 ;; (Emacs 22 has a special variable, see function `org-mode')
28701 (unless (and (boundp 'isearch-mode-end-hook-quit)
28702 isearch-mode-end-hook-quit)
28703 ;; Only when the isearch was not quitted.
28704 (org-add-hook 'post-command-hook 'org-isearch-post-command
28705 'append 'local)))))
28707 (defun org-isearch-post-command ()
28708 "Remove self from hook, and show context."
28709 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28710 (org-show-context 'isearch))
28713 ;;;; Integration with and fixes for other packages
28715 ;;; Imenu support
28717 (defvar org-imenu-markers nil
28718 "All markers currently used by Imenu.")
28719 (make-variable-buffer-local 'org-imenu-markers)
28721 (defun org-imenu-new-marker (&optional pos)
28722 "Return a new marker for use by Imenu, and remember the marker."
28723 (let ((m (make-marker)))
28724 (move-marker m (or pos (point)))
28725 (push m org-imenu-markers)
28726 m))
28728 (defun org-imenu-get-tree ()
28729 "Produce the index for Imenu."
28730 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28731 (setq org-imenu-markers nil)
28732 (let* ((n org-imenu-depth)
28733 (re (concat "^" outline-regexp))
28734 (subs (make-vector (1+ n) nil))
28735 (last-level 0)
28736 m tree level head)
28737 (save-excursion
28738 (save-restriction
28739 (widen)
28740 (goto-char (point-max))
28741 (while (re-search-backward re nil t)
28742 (setq level (org-reduced-level (funcall outline-level)))
28743 (when (<= level n)
28744 (looking-at org-complex-heading-regexp)
28745 (setq head (org-match-string-no-properties 4)
28746 m (org-imenu-new-marker))
28747 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28748 (if (>= level last-level)
28749 (push (cons head m) (aref subs level))
28750 (push (cons head (aref subs (1+ level))) (aref subs level))
28751 (loop for i from (1+ level) to n do (aset subs i nil)))
28752 (setq last-level level)))))
28753 (aref subs 1)))
28755 (eval-after-load "imenu"
28756 '(progn
28757 (add-hook 'imenu-after-jump-hook
28758 (lambda () (org-show-context 'org-goto)))))
28760 ;; Speedbar support
28762 (defun org-speedbar-set-agenda-restriction ()
28763 "Restrict future agenda commands to the location at point in speedbar.
28765 (interactive)
28766 (let (p m tp np dir txt w)
28767 (cond
28768 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28769 'org-imenu t))
28770 (setq m (get-text-property p 'org-imenu-marker))
28771 (save-excursion
28772 (save-restriction
28773 (set-buffer (marker-buffer m))
28774 (goto-char m)
28775 (org-agenda-set-restriction-lock 'subtree))))
28776 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28777 'speedbar-function 'speedbar-find-file))
28778 (setq tp (previous-single-property-change
28779 (1+ p) 'speedbar-function)
28780 np (next-single-property-change
28781 tp 'speedbar-function)
28782 dir (speedbar-line-directory)
28783 txt (buffer-substring-no-properties (or tp (point-min))
28784 (or np (point-max))))
28785 (save-excursion
28786 (save-restriction
28787 (set-buffer (find-file-noselect
28788 (let ((default-directory dir))
28789 (expand-file-name txt))))
28790 (unless (org-mode-p)
28791 (error "Cannot restrict to non-Org-mode file"))
28792 (org-agenda-set-restriction-lock 'file))))
28793 (t (error "Don't know how to restrict Org-mode's agenda")))
28794 (org-move-overlay org-speedbar-restriction-lock-overlay
28795 (point-at-bol) (point-at-eol))
28796 (setq current-prefix-arg nil)
28797 (org-agenda-maybe-redo)))
28799 (eval-after-load "speedbar"
28800 '(progn
28801 (speedbar-add-supported-extension ".org")
28802 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28803 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28804 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28805 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28806 (add-hook 'speedbar-visiting-tag-hook
28807 (lambda () (org-show-context 'org-goto)))))
28810 ;;; Fixes and Hacks
28812 ;; Make flyspell not check words in links, to not mess up our keymap
28813 (defun org-mode-flyspell-verify ()
28814 "Don't let flyspell put overlays at active buttons."
28815 (not (get-text-property (point) 'keymap)))
28817 ;; Make `bookmark-jump' show the jump location if it was hidden.
28818 (eval-after-load "bookmark"
28819 '(if (boundp 'bookmark-after-jump-hook)
28820 ;; We can use the hook
28821 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28822 ;; Hook not available, use advice
28823 (defadvice bookmark-jump (after org-make-visible activate)
28824 "Make the position visible."
28825 (org-bookmark-jump-unhide))))
28827 (defun org-bookmark-jump-unhide ()
28828 "Unhide the current position, to show the bookmark location."
28829 (and (org-mode-p)
28830 (or (org-invisible-p)
28831 (save-excursion (goto-char (max (point-min) (1- (point))))
28832 (org-invisible-p)))
28833 (org-show-context 'bookmark-jump)))
28835 ;; Make session.el ignore our circular variable
28836 (eval-after-load "session"
28837 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28839 ;;;; Experimental code
28841 (defun org-closed-in-range ()
28842 "Sparse tree of items closed in a certain time range.
28843 Still experimental, may disappear in the future."
28844 (interactive)
28845 ;; Get the time interval from the user.
28846 (let* ((time1 (time-to-seconds
28847 (org-read-date nil 'to-time nil "Starting date: ")))
28848 (time2 (time-to-seconds
28849 (org-read-date nil 'to-time nil "End date:")))
28850 ;; callback function
28851 (callback (lambda ()
28852 (let ((time
28853 (time-to-seconds
28854 (apply 'encode-time
28855 (org-parse-time-string
28856 (match-string 1))))))
28857 ;; check if time in interval
28858 (and (>= time time1) (<= time time2))))))
28859 ;; make tree, check each match with the callback
28862 ;;;; Finish up
28864 (provide 'org)
28866 (run-hooks 'org-load-hook)
28868 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28869 ;;; org.el ends here