| blob | 722adc65b51f0e379837890e12ab1fefde23e895 |
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."
2410 "Custom commands for the agenda.
2411 These commands will be offered on the splash screen displayed by the
2414 (key desc type match options files)
2416 key The key (one or more characters as a string) to be associated
2417 with the command.
2418 desc A description of the commend, when omitted or nil, a default
2419 description is built using MATCH.
2420 type The command type, any of the following symbols:
2421 agenda The daily/weekly agenda.
2422 todo Entries with a specific TODO keyword, in all agenda files.
2423 search Entries containing search words entry or headline.
2424 tags Tags/Property/TODO match in all agenda files.
2425 tags-todo Tags/P/T match in all agenda files, TODO entries only.
2426 todo-tree Sparse tree of specific TODO keyword in *current* file.
2427 tags-tree Sparse tree with all tags matches in *current* file.
2428 occur-tree Occur sparse tree for *current* file.
2429 ... A user-defined function.
2430 match What to search for:
2431 - a single keyword for TODO keyword searches
2432 - a tags match expression for tags searches
2433 - a regular expression for occur searches
2434 options A list of option settings, similar to that in a let form, so like
2435 this: ((opt1 val1) (opt2 val2) ...)
2436 files A list of files file to write the produced agenda buffer to
2437 with the command `org-store-agenda-views'.
2440 produced. Otherwide, only the plain text is written to the file.
2442 You can also define a set of commands, to create a composite agenda buffer.
2443 In this case, an entry looks like this:
2445 (key desc (cmd1 cmd2 ...) general-options file)
2447 where
2449 desc A description string to be displayed in the dispatcher menu.
2450 cmd An agenda command, similar to the above. However, tree commands
2451 are no allowed, but instead you can get agenda and global todo list.
2452 So valid commands for a set are:
2453 (agenda)
2454 (alltodo)
2455 (stuck)
2461 Each command can carry a list of options, and another set of options can be
2462 given for the whole set of commands. Individual command options take
2463 precedence over the general options.
2465 When using several characters as key to a command, the first characters
2466 are prefix commands. For the dispatcher to display useful information, you
2467 should provide a description for the prefix, like
2469 (setq org-agenda-custom-commands
2547 "The register holding the current query string.
2548 The prupose of this is that if you construct a query string interactively,
2549 you can then use it to define a custom command."
2555 "How to identify stuck projects.
2556 This is a list of four items:
2557 1. A tags/todo matcher string that is used to identify a project.
2558 The entire tree below a headline matched by this is considered one project.
2559 2. A list of TODO keywords identifying non-stuck projects.
2560 If the project subtree contains any headline with one of these todo
2561 keywords, the project is considered to be not stuck. If you specify
2563 3. A list of tags identifying non-stuck projects.
2564 If the project subtree contains any headline with one of these tags,
2566 a tag, any tag will mark the project unstuck.
2567 4. An arbitrary regular expression matching non-stuck projects.
2570 or `C-c a #' to produce the list."
2574 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2580 "Options concerning skipping parts of agenda files."
2585 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2586 When nil, the sublevels of a TODO entry are not checked, resulting in
2587 potentially much shorter TODO lists."
2593 "Non-nil means, don't show entries with a date in the global todo list.
2594 You can use this if you prefer to mark mere appointments with a TODO keyword,
2595 but don't want them to show up in the TODO list.
2596 When this is set, it also covers deadlines and scheduled items, the settings
2597 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2598 will be ignored."
2604 "Non-nil means, don't show scheduled entries in the global todo list.
2605 The idea behind this is that by scheduling it, you have already taken care
2606 of this item.
2607 See also `org-agenda-todo-ignore-with-date'."
2613 "Non-nil means, don't show near deadline entries in the global todo list.
2614 Near means closer than `org-deadline-warning-days' days.
2615 The idea behind this is that such items will appear in the agenda anyway.
2616 See also `org-agenda-todo-ignore-with-date'."
2622 "Non-nil means don't show scheduled items in agenda when they are done.
2623 This is relevant for the daily/weekly agenda, not for the TODO list. And
2624 it applies only to the actual date of the scheduling. Warnings about
2625 an item with a past scheduling dates are always turned off when the item
2626 is DONE."
2631 "Non-nil means don't show deadines when the corresponding item is done.
2632 When nil, the deadline is still shown and should give you a happy feeling.
2633 This is relevant for the daily/weekly agenda. And it applied only to the
2634 actualy date of the deadline. Warnings about approching and past-due
2635 deadlines are always turned off when the item is DONE."
2640 "Non-nil means don't select item by timestamp or -range if it is DONE."
2645 "Non-nil means, `org-timeline' also shows dates without an entry.
2646 When nil, only the days which actually have entries are shown.
2647 When t, all days between the first and the last date are shown.
2648 When an integer, show also empty dates, but if there is a gap of more than
2649 N days, just insert a special line indicating the size of the gap."
2658 "Options concerning initial settings in the Agenda in Org Mode."
2663 "Hook run just before displaying an agenda buffer."
2668 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2669 A longer mouse click will still set point. Does not work on XEmacs.
2670 Needs to be set before org.el is loaded."
2675 "The initial value of follow-mode in a newly created agenda window."
2680 "Options concerning the windows used by the Agenda in Org Mode."
2685 "How the agenda buffer should be displayed.
2686 Possible values for this option are:
2688 current-window Show agenda in the current window, keeping all other windows.
2689 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2690 other-window Use `switch-to-buffer-other-window' to display agenda.
2691 reorganize-frame Show only two windows on the current frame, the current
2692 window and the agenda.
2693 See also the variable `org-agenda-restore-windows-after-quit'."
2702 "The min and max height of the agenda window as a fraction of frame height.
2703 The value of the variable is a cons cell with two numbers between 0 and 1.
2704 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2709 "Non-nil means, restore window configuration open exiting agenda.
2710 Before the window configuration is changed for displaying the agenda,
2711 the current status is recorded. When the agenda is exited with
2712 `q' or `x' and this option is set, the old state is restored. If
2713 `org-agenda-window-setup' is `other-frame', the value of this
2714 option will be ignored.."
2719 "How should indirect tree buffers be displayed?
2720 This applies to indirect buffers created with the commands
2722 Valid values are:
2723 current-window Display in the current window
2724 other-window Just display in another window.
2725 dedicated-frame Create one new frame, and re-use it each time.
2726 new-frame Make a new frame each time. Note that in this case
2727 previously-made indirect buffers are kept, and you need to
2728 kill these buffers yourself."
2738 "Options concerning the daily/weekly agenda."
2743 "Number of days to include in overview display.
2744 Should be 1 or 7."
2749 "Non-nil means, start the overview always on the specified weekday.
2750 0 denotes Sunday, 1 denotes Monday etc.
2751 When nil, always start on the current day."
2757 "Non-nil means, `org-agenda' shows every day in the selected range.
2758 When nil, only the days which actually have entries are shown."
2763 "Format string for displaying dates in the agenda.
2764 Used by the daily/weekly agenda and by the timeline. This should be
2765 a format string understood by `format-time-string', or a function returning
2766 the formatted date as a string. The function must take a single argument,
2767 a calendar-style date list like (month day year)."
2774 "Format a date string for display in the daily/weekly agenda, or timeline.
2775 This function makes sure that dates are aligned for easy reading."
2783 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2788 "Set means weekly/daily agenda will always contain all TODO entries.
2789 The TODO entries will be listed at the top of the agenda, before
2790 the entries for specific days."
2795 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2796 When nil, only one occurence is shown, either today or the
2797 nearest into the future."
2802 "No. of days before expiration during which a deadline becomes active.
2803 This variable governs the display in sparse trees and in the agenda.
2804 When 0 or negative, it means use this number (the absolute value of it)
2805 even if a deadline has a different individual lead time specified."
2811 "No. of days to continue listing scheduled items that are not marked DONE.
2812 When an item is scheduled on a date, it shows up in the agenda on this
2813 day and will be listed until it is marked done for the number of days
2814 given here."
2819 "Options concerning the time grid in the Org-mode Agenda."
2824 "Non-nil means, show a time grid in the agenda schedule.
2825 A time grid is a set of lines for specific times (like every two hours between
2826 8:00 and 20:00). The items scheduled for a day at specific times are
2827 sorted in between these lines.
2828 For details about when the grid will be shown, and what it will look like, see
2829 the variable `org-agenda-time-grid'."
2835 "----------------"
2838 "The settings for time grid for agenda display.
2839 This is a list of three items. The first item is again a list. It contains
2840 symbols specifying conditions when the grid should be displayed:
2842 daily if the agenda shows a single day
2843 weekly if the agenda shows an entire week
2844 today show grid on current date, independent of daily/weekly display
2845 require-timed show grid only if at least one item has a time specification
2847 The second item is a string which will be places behing the grid time.
2849 The third item is a list of integers, indicating the times that should have
2850 a grid line."
2852 :type
2859 require-timed)
2861 remove-match))
2866 "Options concerning sorting in the Org-mode Agenda."
2883 "Sorting structure for the agenda items of a single day.
2884 This is a list of symbols which will be used in sequence to determine
2885 if an entry should be listed before another entry. The following
2886 symbols are recognized:
2888 time-up Put entries with time-of-day indications first, early first
2889 time-down Put entries with time-of-day indications first, late first
2890 category-keep Keep the default order of categories, corresponding to the
2891 sequence in `org-agenda-files'.
2892 category-up Sort alphabetically by category, A-Z.
2893 category-down Sort alphabetically by category, Z-A.
2894 tag-up Sort alphabetically by last tag, A-Z.
2895 tag-down Sort alphabetically by last tag, Z-A.
2896 priority-up Sort numerically by priority, high priority last.
2897 priority-down Sort numerically by priority, high priority first.
2899 The different possibilities will be tried in sequence, and testing stops
2901 '(time-up category-keep priority-down)
2902 means: Pull out all entries having a specified time of day and sort them,
2903 in order to make a time schedule for the current day the first thing in the
2904 agenda listing for the day. Of the entries without a time indication, keep
2905 the grouped in categories, don't sort the categories, but keep them in
2906 the sequence given in `org-agenda-files'. Within each category sort by
2907 priority.
2909 Leaving out `category-keep' would mean that items will be sorted across
2910 categories by priority.
2912 Instead of a single list, this can also be a set of list for specific
2913 contents, with a context symbol in the car of the list, any of
2914 `agenda', `todo', `tags' for the corresponding agenda views."
2927 "Non-nil means, items without time are considered late.
2928 This is only relevant for sorting. When t, items which have no explicit
2929 time like 15:30 will be considered as 99:01, i.e. later than any items which
2930 do have a time. When nil, the default time is before 0:00. You can use this
2931 option to decide if the schedule for today should come before or after timeless
2932 agenda entries."
2937 "Options concerning the entry prefix in the Org-mode agenda display."
2947 "Format specifications for the prefix of items in the agenda views.
2948 An alist with four entries, for the different agenda types. The keys to the
2949 sublists are `agenda', `timeline', `todo', and `tags'. The values
2950 are format strings.
2951 This format works similar to a printf format, with the following meaning:
2954 as given by the CATEGORY keyword or derived from the file name.
2955 %T the *last* tag of the item. Last because inherited tags come
2956 first in the list.
2957 %t the time-of-day specification if one applies to the entry, in the
2958 format HH:MM
2959 %s Scheduling/Deadline information, a short string
2961 All specifiers work basically like the standard `%s' of printf, but may
2962 contain two additional characters: A question mark just after the `%' and
2963 a whitespace/punctuation character just before the final letter.
2965 If the first character after `%' is a question mark, the entire field
2966 will only be included if the corresponding value applies to the
2967 current entry. This is useful for fields which should have fixed
2968 width when present, but zero width when absent. For example,
2970 day is specified, but will completely disappear in entries which do
2971 not contain a time.
2973 If there is punctuation or whitespace character just before the final
2974 format letter, this character will be appended to the field value if
2977 empty, no additional colon would be interted.
2980 - Indent the line with two space characters
2981 - Give the category in a 12 chars wide field, padded with whitespace on
2982 the right (because of `-'). Append a colon if there is a category
2983 (because of `:').
2984 - If there is a time-of-day, put it into a 12 chars wide field. If no
2985 time, don't put in an empty field, just skip it (because of '?').
2986 - Finally, put the scheduling information and append a whitespace.
2988 As another example, if you don't want the time-of-day of entries in
2989 the prefix, you could use:
2993 See also the variables `org-agenda-remove-times-when-in-prefix' and
2994 `org-agenda-remove-tags'."
3006 "The compiled version of the most recently used prefix format.
3010 "Format for the TODO keyword in agenda lines.
3012 to occupy a fixed space in the agenda display."
3017 "Text preceeding scheduled items in the agenda view.
3018 This is a list with two strings. The first applies when the item is
3019 scheduled on the current day. The second applies when it has been scheduled
3020 previously, it may contain a %d to capture how many days ago the item was
3021 scheduled."
3028 "Text preceeding deadline items in the agenda view.
3029 This is a list with two strings. The first applies when the item has its
3030 deadline on the current day. The second applies when it is in the past or
3031 in the future, it may contain %d to capture how many days away the deadline
3032 is (was)."
3039 "Non-nil means, remove duplicate time specifications in agenda items.
3040 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
3041 time-of-day specification in a headline or diary entry is extracted and
3042 placed into the prefix. If this option is non-nil, the original specification
3043 \(a timestamp or -range, or just a plain time(range) specification like
3044 11:30-4pm) will be removed for agenda display. This makes the agenda less
3045 cluttered.
3046 The option can be t or nil. It may also be the symbol `beg', indicating
3047 that the time should only be removed what it is located at the beginning of
3048 the headline/diary entry."
3057 "Default duration for appointments that only have a starting time.
3058 When nil, no duration is specified in such cases.
3059 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
3067 "Non-nil means, remove the tags from the headline copy in the agenda.
3068 When this is the symbol `prefix', only remove tags when
3069 `org-agenda-prefix-format' contains a `%T' specifier."
3081 "Shift tags in agenda items to this column.
3082 If this number is positive, it specifies the column. If it is negative,
3083 it means that the tags should be flushright to that column. For example,
3084 -80 works well for a normal 80 character screen."
3092 "Non-nil means, highlight low and high priorities in agenda.
3093 When t, the highest priority entries are bold, lowest priority italic.
3094 This may also be an association list of priority faces. The face may be
3105 "Options for embedding LaTeX code into Org-mode"
3113 "Options for creating images from LaTeX fragments.
3114 This is a property list with the following properties:
3116 `default' means use the forground of the default face.
3118 `default' means use the background of the default face.
3119 :scale a scaling factor for the size of the images
3120 :html-foreground, :html-background, :html-scale
3121 The same numbers for HTML export.
3122 :matchers a list indicating which matchers should be used to
3123 find LaTeX fragments. Valid members of this list are:
3140 "The document header used for processing LaTeX fragments."
3145 "Options for exporting org-listings."
3150 "General options for exporting Org-mode files."
3154 ;; FIXME
3159 When this option is turned on, these strings will be exported as:
3161 Org HTML LaTeX
3162 -----+----------+--------
3164 -- – --
3165 --- — ---
3166 ... … \ldots
3183 "Terms used in export text, translated to different languages.
3184 Use the variable `org-export-default-language' to set the language,
3185 or use the +OPTION lines for a per-file setting."
3195 "The default language of HTML export, as a string.
3196 This should have an association in `org-export-language-setup'."
3201 "Non-nil means, skip all text before the first headline when exporting.
3202 When nil, that text is exported as well."
3207 "The last level which is still exported as a headline.
3208 Inferior levels will produce itemize lists when exported.
3209 Note that a numeric prefix argument to an exporter function overrides
3210 this setting.
3217 "Non-nil means, add section numbers to headlines when exporting.
3224 "Non-nil means, create a table of contents in exported files.
3225 The TOC contains headlines with levels up to`org-export-headline-levels'.
3226 When an integer, include levels up to N in the toc, this may then be
3227 different from `org-export-headline-levels', but it will not be allowed
3228 to be larger than the number of headline levels.
3229 When nil, no table of contents is made.
3232 ASCII export, and with red color in HTML output, if the option
3233 `org-export-mark-todo-in-toc' is set.
3235 In HTML output, the TOC will be clickable.
3246 "Non-nil means, mark TOC lines that contain any open TODO items."
3251 "Non-nil means, preserve all line breaks when exporting.
3252 Normally, in HTML output paragraphs will be reformatted. In ASCII
3253 export, line breaks will always be preserved, regardless of this variable.
3260 "Whether subtrees with the ARCHIVE tag should be exported.
3261 This can have three different values
3262 nil Do not export, pretend this tree is not present
3263 t Do export the entire tree
3264 headline Only export the headline, but skip the tree below it."
3273 "Non-nil means, insert author name and email into the exported file.
3275 This option can also be set with the +OPTIONS line,
3281 "Non-nil means, insert a time stamp into the exported file.
3282 The time stamp shows when the file was created.
3284 This option can also be set with the +OPTIONS line,
3290 "If nil, do not export time stamps and associated keywords."
3295 "If nil, remove timestamps from the table of contents entries."
3300 "If nil, do not export tags, just remove them from headlines.
3301 If this is the symbol `not-in-toc', tags will be removed from table of
3302 contents entries, but still be shown in the headlines of the document.
3312 "Non-nil means, export with drawers like the property drawer.
3313 When t, all drawers are exported. This may also be a list of
3314 drawer names to export."
3323 "Options for translating special ascii sequences for the export backends."
3328 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3329 If the export target supports emphasizing text, the word will be
3330 typeset in bold, italic, or underlined, respectively. Works only for
3331 single words, but you can say: I *really* *mean* *this*.
3332 Not all export backends support this.
3339 "If nil, export [1] as a footnote marker.
3340 Lines starting with [1] will be formatted as footnotes.
3348 When this option is turned on, you can use TeX-like syntax for sub- and
3350 considered as a single item - so grouping with {} is normally not
3351 needed. For example, the following things will be parsed as single
3352 sub- or superscripts.
3354 10^24 or 10^tau several digits will be considered 1 item.
3355 10^-12 or 10^-tau a leading sign with digits or a word
3356 x^2-y^3 will be read as x^2 - y^3, because items are
3357 terminated by almost any nonword/nondigit char.
3358 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3360 Still, ambiguity is possible - so when in doubt use {} to enclose the
3361 sub/superscript. If you set this variable to the symbol `{}',
3362 the braces are *required* in order to trigger interpretations as
3364 frequently in plain text.
3366 Not all export backends support this, but HTML does.
3377 When this option is turned on, these strings will be exported as:
3380 -- : –
3381 --- : —
3383 Not all export backends support this, but HTML does.
3390 "Non-nil means, interpret simple TeX-like macros when exporting.
3392 No only real TeX macros will work here, but the standard HTML entities
3393 for math can be used as macro names as well. For a list of supported
3394 names in HTML export, see the constant `org-html-entities'.
3395 Not all export backends support this.
3403 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3405 the first non-white thing on a line. It will also find the math delimiters
3407 display math.
3416 This can be used to have pre-formatted text, fragments of code etc. For
3417 example:
3418 : ;; Some Lisp examples
3419 : (while (defc cnt)
3420 : (ding))
3421 will be looking just like this in also HTML. See also the QUOTE keyword.
3422 Not all export backends support this.
3429 "Number of stacked braces for sub/superscript matching.
3430 This has to be set before loading org.el to be effective."
3435 "Options for exporting tables in Org-mode."
3441 For example:
3443 | Name | Address | Birthday |
3444 |-------------+----------+-----------|
3445 | Arthur Dent | England | 29.2.2100 |
3447 Not all export backends support this.
3454 "Non-nil means, highlight the first table line.
3455 In HTML export, this means use <th> instead of <td>.
3456 In tables created with table.el, this applies to the first table line.
3457 In Org-mode tables, all lines before the first horizontal separator
3458 line will be formatted with <th> tags."
3463 "Remove special lines and marking characters in calculating tables.
3464 This removes the special marking character column from tables that are set
3465 up for spreadsheet calculations. It also removes the entire lines
3466 marked with `!', `_', or `^'. The lines with `$' are kept, because
3467 the values of constants may be useful to have."
3472 "Non-nil means, always export tables created with table.el natively.
3473 Natively means, use the HTML code generator in table.el.
3474 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3475 the table does not use row- or column-spanning). This has the
3476 advantage, that the automatic HTML conversions for math symbols and
3477 sub/superscripts can be applied. Org-mode's HTML generator is also
3478 much faster."
3483 "Options specific for ASCII export of Org-mode files."
3488 "Characters for underlining headings in ASCII export.
3489 In the given sequence, these characters will be used for level 1, 2, ..."
3494 "Bullet characters for headlines converted to lists in ASCII export.
3495 The first character is used for the first lest level generated in this
3496 way, and so on. If there are more levels than characters given here,
3497 the list will be repeated.
3498 Note that plain lists will keep the same bullets as the have in the
3499 Org-mode file."
3504 "Options specific for XML export of Org-mode files."
3509 "Options specific for HTML export of Org-mode files."
3514 ""
3519 "The extension for exported HTML files."
3525 html {
3526 font-family: Times, serif;
3527 font-size: 12pt;
3528 }
3529 .title { text-align: center; }
3530 .todo { color: red; }
3531 .done { color: green; }
3532 .timestamp { color: grey }
3533 .timestamp-kwd { color: CadetBlue }
3534 .tag { background-color:lightblue; font-weight:normal }
3535 .target { background-color: lavender; }
3536 pre {
3537 border: 1pt solid #AEBDCC;
3538 background-color: #F3F5F7;
3539 padding: 5pt;
3540 font-family: courier, monospace;
3541 }
3542 table { border-collapse: collapse; }
3543 td, th {
3544 vertical-align: top;
3545 <!--border: 1pt solid #ADB9CC;-->
3546 }
3547 </style>"
3548 "The default style specification for exported HTML files.
3549 Since there are different ways of setting style information, this variable
3550 needs to contain the full HTML structure to provide a style, including the
3551 surrounding HTML tags. The style specifications should include definitions
3552 for new classes todo, done, title, and deadline. For example, legal values
3553 would be:
3556 p { font-weight: normal; color: gray; }
3557 h1 { color: black; }
3558 .title { text-align: center; }
3559 .todo, .deadline { color: red; }
3560 .done { color: green; }
3561 </style>
3563 or, if you want to keep the style in a file,
3567 As the value of this option simply gets inserted into the HTML <head> header,
3574 "Format for typesetting the document title in HTML export."
3579 "The <H> level for level 1 headings in HTML export."
3584 "Non-nil means, make file links to `file.org' point to `file.html'.
3585 When org-mode is exporting an org-mode file to HTML, links to
3586 non-html files are directly put into a href tag in HTML.
3587 However, links to other Org-mode files (recognized by the
3588 extension `.org.) should become links to the corresponding html
3589 file, assuming that the linked org-mode file will also be
3590 converted to HTML.
3591 When nil, the links still point to the plain `.org' file."
3596 "Non-nil means, inline images into exported HTML pages.
3597 This is done using an <img> tag. When nil, an anchor with href is used to
3598 link to the image. If this option is `maybe', then images in links with
3599 an empty description will be inlined, while images with a description will
3600 be linked only."
3606 ;; FIXME: rename
3608 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3609 When nil, these tags will be exported as plain text and therefore
3610 not be interpreted by a browser.
3618 "The HTML tag that is used to start a table.
3619 This must be a <table> tag, but you may change the options like
3620 borders and spacing."
3625 "The opening tag for table header fields.
3626 This is customizable so that alignment options can be specified."
3631 "The opening tag for table data fields.
3632 This is customizable so that alignment options can be specified."
3637 "If non-nil, write `org-export-html-html-helper-timestamp'
3638 into the exported HTML text. Otherwise, the buffer will just be saved
3639 to a file."
3645 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3650 "Options specific for iCalendar export of Org-mode files."
3655 "The file name for the iCalendar file covering all agenda files.
3657 The file name should be absolute, the file will be overwritten without warning."
3662 "Non-nil means, export to iCalendar files should also cover TODO items."
3670 "Non-nil means, export to iCalendar files should also cover sexp entries.
3671 These are entries like in the diary, but directly in an Org-mode file."
3676 "Amount of text below headline to be included in iCalendar export.
3677 This is a number of characters that should maximally be included.
3678 Properties, scheduling and clocking lines will always be removed.
3679 The text will be inserted into the DESCRIPTION field."
3687 "Calendar name for the combined iCalendar representing all agenda files."
3692 "Font-lock settings for highlighting in Org-mode."
3697 "Non-nil means fontify only the stars in each headline.
3698 When nil, the entire headline is fontified.
3699 Changing it requires restart of `font-lock-mode' to become effective
3700 also in regions already fontified."
3705 "Non-nil means, hide the first N-1 stars in a headline.
3706 This works by using the face `org-hide' for these stars. This
3707 face is white for a light background, and black for a dark
3708 background. You may have to customize the face `org-hide' to
3709 make this work.
3710 Changing it requires restart of `font-lock-mode' to become effective
3711 also in regions already fontified.
3712 You may also set this on a per-file basis by adding one of the following
3713 lines to the buffer:
3715 #+STARTUP: hidestars
3716 #+STARTUP: showstars"
3721 "Non-nil means, change the face of a headline if it is marked DONE.
3722 Normally, only the TODO/DONE keyword indicates the state of a headline.
3723 When this is non-nil, the headline after the keyword is set to the
3724 `org-headline-done' as an additional indication."
3729 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3730 Changing this variable requires a restart of Emacs to take effect."
3735 "Non-nil means, fontify what is treated specially by the exporters."
3740 "Non-nil mean font-lock should hide the emphasis marker characters."
3751 "Set variable and compute the emphasis regular expression."
3755 org-emphasis-alist org-emphasis-regexp-components)
3768 ;; make sure special characters appear at the right position in the class
3780 ;; Make the regexp
3788 body1
3800 body1
3808 "Components used to build the regular expression for emphasis.
3809 This is a list with 6 entries. Terminology: In an emphasis string
3813 specify what is allowed/forbidden in each part:
3815 pre Chars allowed as prematch. Beginning of line will be allowed too.
3816 post Chars allowed as postmatch. End of line will be allowed too.
3817 border The chars *forbidden* as border characters.
3819 non-shy groups here, and don't allow newline here.
3820 newline The maximum number of newlines allowed in an emphasis exp.
3822 Use customize to modify this, or restart Emacs after changing it."
3840 )
3841 "Special syntax for emphasized text.
3842 Text starting and ending with a special character will be emphasized, for
3843 example *bold*, _underlined_ and /italic/. This variable sets the marker
3844 characters, the face to be used by font-lock for highlighting in Org-mode
3845 Emacs buffers, and the HTML tags to be used for this.
3846 Use customize to modify this, or restart Emacs after changing it."
3859 ;;; The faces
3862 "Faces in Org-mode."
3867 "Make a compatible face specification.
3868 If INHERITS is an existing face and if the Emacs version supports it,
3869 just inherit the face. If not, use SPECS to define the face.
3870 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3871 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3872 to the top of the list. The `min-colors' attribute will be removed from
3873 any other entries, and any resulting duplicates will be removed entirely."
3877 ;; In Emacs 23, we use inheritance where possible.
3878 ;; We only do this in Emacs 23, because only there the outline
3879 ;; faces have been changed to the original org-mode-level-faces.
3882 ;; These do not understand the `min-colors' attribute.
3901 "Face used to hide leading stars in headlines.
3902 The forground color of this face should be equal to the background
3903 color of the frame."
3914 "Face used for level 1 headlines."
3924 "Face used for level 2 headlines."
3936 "Face used for level 3 headlines."
3948 "Face used for level 4 headlines."
3956 "Face used for level 5 headlines."
3964 "Face used for level 6 headlines."
3972 "Face used for level 7 headlines."
3980 "Face used for level 8 headlines."
3988 "Face used for special keywords."
3999 "Face used for drawers."
4003 "Face used for the value of a property."
4015 "Face for column display of entry properties."
4019 ;; Make sure that a fixed-width face is used when we have a column table.
4031 "Face for deadlines and TODO keywords."
4044 "Face for headline with the ARCHIVE tag."
4051 "Face for links."
4058 "Face for the ellipsis in folded text."
4065 "Face for links."
4072 "Face for links."
4079 "Face for links."
4084 "Face for tags."
4094 "Face for TODO keywords."
4103 "Face used for todo keywords that indicate DONE items."
4111 "Face used to indicate that a headline is DONE.
4112 This face is only used if `org-fontify-done-headline' is set. If applies
4113 to the part of the headline after the DONE keyword."
4117 "Faces for specific TODO keywords.
4118 This is a list of cons cells, with TODO keywords in the car
4119 and faces in the cdr. The face can be a symbol, or a property
4136 "Face used for tables."
4146 "Face for formulas."
4159 "Face for fixed-with text like code snippets."
4173 "Face for fixed-with text like code snippets."
4185 "Face used in agenda for captions and dates."
4194 "Face for items scheduled for a certain day."
4204 "Face for items scheduled previously, and not yet done."
4214 "Face for items scheduled previously, and not yet done."
4221 "Faces for showing deadlines in the agenda.
4222 This is a list of cons cells. The cdr of each cell is a face to be used,
4224 Each car is a fraction of the head-warning time that must have passed for
4225 this the face in the cdr to be used for display. The numbers must be
4226 given in descending order. The head-warning time is normally taken
4227 from `org-deadline-warning-days', but can also be specified in the deadline
4228 timestamp itself, like this:
4230 DEADLINE: <2007-08-13 Mon -8d>
4232 You may use d for days, w for weeks, m for months and y for years. Months
4233 and years will only be treated in an approximate fashion (30.4 days for a
4234 month and 365.24 days for a year)."
4242 ;; FIXME: this is not a good face yet.
4251 "Face for showing the agenda restriction lock."
4259 "Face used for time grids."
4264 org-level-5 org-level-6 org-level-7 org-level-8
4265 ))
4268 "The number of different faces to be used for headlines.
4269 Org-mode defines 8 different headline faces, so this can be at most 8.
4270 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4274 ;;; Functions and variables from ther packages
4275 ;; Declared here to avoid compiler warnings
4281 ;; XEmacs only
4287 ;; Emacs only
4290 ;; Various packages
4291 ;; FIXME: get the argument lists for the UNKNOWN stuff
4346 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4347 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4378 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4389 ;; backward compatibility to old version of wl
4392 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4405 ;;; Variables for pre-computed regular expressions, all buffer local
4420 "Matches a headline and puts everything into groups:
4421 group 1: the stars
4422 group 2: The todo keyword, maybe
4423 group 3: Priority cookie
4424 group 4: True headline
4428 "Matches a headline and puts TODO state into group 2 if present.
4473 rear-nonsticky t mouse-map t fontified t)
4480 s)
4487 s)
4496 "Modified `buffer-invisibility-spec' for Emacs 21.
4497 Some ops with invisible text do not work correctly on Emacs 21. For these
4498 we turn off invisibility temporarily. Use this in a `let' form."
4502 "Make VAR local in current buffer and set it to VALUE."
4506 "Check if the current buffer is in Org-mode."
4510 "Return the last element of LIST."
4543 "Variable associated with STARTUP options for org-mode.
4544 Each element is a list of three items: The startup options as written
4545 in the #+STARTUP line, the corresponding variable, and the value to
4546 set this variable to if the option is found. An optional forth element PUSH
4550 "Precompute regular expressions for current buffer."
4565 kwds kws0 kwsa key log value cat arch tags const links hw dws
4566 tail sep kws1 prio props drawers)
4590 links)))
4596 props)))
4603 l var val)
4618 )))
4632 ;; Process the TODO keywords
4634 ;; Use the global values as if they had been given locally.
4645 kwsa nil
4648 ;; 1 2
4656 kw)
4658 kws0)
4675 ;; Process the constants
4683 ;; Process the tags.
4693 tgs))
4701 ;; Compute the regular expressions and other local variables
4706 org-drawer-regexp
4710 org-not-done-keywords
4712 org-todo-regexp
4715 org-not-done-regexp
4719 org-todo-line-regexp
4723 org-complex-heading-regexp
4728 org-nl-done-regexp
4732 org-todo-line-tags-regexp
4737 org-looking-at-done-regexp
4742 org-deadline-time-regexp
4744 org-deadline-line-regexp
4746 org-scheduled-regexp
4748 org-scheduled-time-regexp
4750 org-closed-time-regexp
4752 org-keyword-time-regexp
4758 org-keyword-time-not-clock-regexp
4764 org-maybe-keyword-time-regexp
4770 org-planning-or-clock-line-re
4775 )
4780 "Extract the log state setting from a TODO keyword string.
4794 "Remove a pair of parenthesis at the end of each string in LIST."
4798 x))
4799 list))
4801 ;; FIXME: this could be done much better, using second characters etc.
4803 "Assign fast keys to a keyword-key alist.
4804 Respect keys that are already there."
4814 ;; automatically assign a character.
4826 ;;; Some variables ujsed in various places
4831 "Function to be called when `C-c C-c' is used.
4835 ;; FIXME: Occasionally check by commenting these, to make sure
4836 ;; no other functions uses these, forgetting to let-bind them.
4843 ;; Defined somewhere in this file, but used before definition.
4856 ;;;; Emacs/XEmacs compatibility
4858 ;; Overlay compatibility functions
4876 "Make overlay OVL display TEXT with face FACE."
4886 "Make overlay OVL display TEXT with face FACE."
4909 "Find all overlays specifying PROP at POS or point.
4910 If DELETE is non-nil, delete all those overlays."
4912 ov found)
4916 found))
4918 ;; Region compatibility
4921 "Add-hook, compatible with both Emacsen."
4930 "Is `transient-mark-mode' on and the region active?
4931 Works on both Emacs and XEmacs."
4933 nil
4940 ;; Invisibility compatibility
4943 "Add elements to `buffer-invisibility-spec'.
4944 See documentation for `buffer-invisibility-spec' for the kind of elements
4945 that can be added."
4956 "Remove elements from `buffer-invisibility-spec'."
4964 "Is ARG a member of `buffer-invisibility-spec'?"
4967 nil))
4969 ;;;; Define the Org-mode
4972 (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."))
4975 ;; We use a before-change function to check if a table might need
4976 ;; an update.
4978 "Indicates that a table might need an update.
4979 This variable is set by `org-before-change-function'.
4988 ;;;###autoload
4990 "Outline-based notes management and organizer, alias
4993 Org-mode develops organizational tasks around a NOTES file which
4994 contains information about projects as plain text. Org-mode is
4995 implemented on top of outline-mode, which is ideal to keep the content
4996 of large files well structured. It supports ToDo items, deadlines and
4997 time stamps, which magically appear in the diary listing of the Emacs
4998 calendar. Tables are easily created with a built-in table editor.
4999 Plain text URL-like links connect to websites, emails (VM), Usenet
5000 messages (Gnus), BBDB entries, and any files related to the project.
5001 For printing and sharing of notes, an Org-mode file (or a part of it)
5002 can be exported as a structured ASCII or HTML file.
5004 The following commands are available:
5008 ;; Get rid of Outline menus, they are not needed
5009 ;; Need to do this here because define-derived-mode sets up
5010 ;; the keymap so late. Still, it is a waste to call this each time
5011 ;; we switch another buffer into org-mode.
5014 ;; Assume this is Greg's port, it used easymenu
5037 org-display-table 4
5040 org-ellipsis)))
5044 ;; Calc embedded
5051 ;; Activate before-change-function
5055 ;; Check for running clock before killing a buffer
5057 ;; Paragraphs and auto-filling
5062 ;; Comment characters
5063 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
5066 ;; Align options lines
5068 'align-mode-rules-list
5073 ;; Imenu
5077 ;; Make isearch reveal context
5080 ;; Emacs 21 and XEmacs make use of the hook
5082 ;; Emacs 22 deals with this through a special variable
5086 ;; If empty file that did not turn on org-mode automatically, make it to.
5108 "Call COMMAND interactively, but pretend prefix are was ARG."
5114 ;; works also in narrowed buffer, because we start at 1, not point-min
5118 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5128 "Add text properties to entire string, from beginning to end.
5129 PLIST may be a list of properties, PROPS are individual properties and values
5130 that will be added to PLIST. Returns the string that was modified."
5133 string)
5137 ;;;; Font-Lock stuff, including the activators
5142 (org-defkey org-mouse-map
5143 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5144 (when org-mouse-1-follows-link
5145 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5146 (when org-tab-follows-link
5147 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5148 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5149 (when org-return-follows-link
5150 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5151 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5153 (require 'font-lock)
5156 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5157 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5158 (defvar org-link-re-with-space nil
5159 "Matches a link with spaces, optional angular brackets around it.")
5160 (defvar org-link-re-with-space2 nil
5161 "Matches a link with spaces, optional angular brackets around it.")
5162 (defvar org-angle-link-re nil
5163 "Matches link with angular brackets, spaces are allowed.")
5164 (defvar org-plain-link-re nil
5165 "Matches plain link, without spaces.")
5166 (defvar org-bracket-link-regexp nil
5167 "Matches a link in double brackets.")
5168 (defvar org-bracket-link-analytic-regexp nil
5169 "Regular expression used to analyze links.
5170 Here is what the match groups contain after a match:
5171 1: http:
5172 2: http
5173 3: path
5174 4: [desc]
5175 5: desc")
5176 (defvar org-any-link-re nil
5177 "Regular expression matching any link.")
5179 (defun org-make-link-regexps ()
5180 "Update the link regular expressions.
5181 This should be called after the variable `org-link-types' has changed."
5182 (setq org-link-re-with-space
5183 (concat
5186 "[^" org-non-link-chars "]*"
5188 org-link-re-with-space2
5189 (concat
5194 org-angle-link-re
5195 (concat
5198 "[^" org-non-link-chars "]*"
5200 org-plain-link-re
5201 (concat
5204 org-bracket-link-regexp
5206 org-bracket-link-analytic-regexp
5207 (concat
5214 org-any-link-re
5219 (org-make-link-regexps)
5222 "Regular expression for fast time stamp matching.")
5224 "Regular expression for fast time stamp matching.")
5225 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5226 "Regular expression matching time strings for analysis.
5227 This one does not require the space after the date.")
5228 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5229 "Regular expression matching time strings for analysis.")
5231 "Regular expression matching time stamps, with groups.")
5233 "Regular expression matching time stamps (also [..]), with groups.")
5234 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5235 "Regular expression matching a time stamp range.")
5236 (defconst org-tr-regexp-both
5237 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5238 "Regular expression matching a time stamp range.")
5241 "Regular expression matching a time stamp or time stamp range.")
5244 "Regular expression matching a time stamp or time stamp range.
5245 The time stamps may be either active or inactive.")
5247 (defvar org-emph-face nil)
5249 (defun org-do-emphasis-faces (limit)
5250 "Run through the buffer and add overlays to links."
5251 (let (rtn)
5252 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5253 (if (not (= (char-after (match-beginning 3))
5254 (char-after (match-beginning 4))))
5255 (progn
5256 (setq rtn t)
5257 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5258 'face
5259 (nth 1 (assoc (match-string 3)
5260 org-emphasis-alist)))
5261 (add-text-properties (match-beginning 2) (match-end 2)
5262 '(font-lock-multiline t))
5263 (when org-hide-emphasis-markers
5264 (add-text-properties (match-end 4) (match-beginning 5)
5265 '(invisible org-link))
5266 (add-text-properties (match-beginning 3) (match-end 3)
5267 '(invisible org-link)))))
5268 (backward-char 1))
5269 rtn))
5271 (defun org-emphasize (&optional char)
5272 "Insert or change an emphasis, i.e. a font like bold or italic.
5273 If there is an active region, change that region to a new emphasis.
5274 If there is no region, just insert the marker characters and position
5275 the cursor between them.
5276 CHAR should be either the marker character, or the first character of the
5277 HTML tag associated with that emphasis. If CHAR is a space, the means
5278 to remove the emphasis of the selected region.
5279 If char is not given (for example in an interactive call) it
5280 will be prompted for."
5281 (interactive)
5282 (let ((eal org-emphasis-alist) e det
5283 (erc org-emphasis-regexp-components)
5284 (prompt "")
5285 (string "") beg end move tag c s)
5286 (if (org-region-active-p)
5287 (setq beg (region-beginning) end (region-end)
5288 string (buffer-substring beg end))
5289 (setq move t))
5291 (while (setq e (pop eal))
5292 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5293 c (aref tag 0))
5294 (push (cons c (string-to-char (car e))) det)
5295 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5296 (substring tag 1)))))
5297 (unless char
5298 (message "%s" (concat "Emphasis marker or tag:" prompt))
5299 (setq char (read-char-exclusive)))
5300 (setq char (or (cdr (assoc char det)) char))
5301 (if (equal char ?\ )
5302 (setq s "" move nil)
5303 (unless (assoc (char-to-string char) org-emphasis-alist)
5305 (setq s (char-to-string char)))
5306 (while (and (> (length string) 1)
5307 (equal (substring string 0 1) (substring string -1))
5308 (assoc (substring string 0 1) org-emphasis-alist))
5309 (setq string (substring string 1 -1)))
5310 (setq string (concat s string s))
5311 (if beg (delete-region beg end))
5312 (unless (or (bolp)
5314 (char-to-string (char-before (point)))))
5315 (insert " "))
5317 (char-to-string (char-after (point))))
5318 (insert " ") (backward-char 1))
5319 (insert string)
5320 (and move (backward-char 1))))
5322 (defconst org-nonsticky-props
5323 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5326 (defun org-activate-plain-links (limit)
5327 "Run through the buffer and add overlays to links."
5328 (catch 'exit
5329 (let (f)
5330 (while (re-search-forward org-plain-link-re limit t)
5331 (setq f (get-text-property (match-beginning 0) 'face))
5332 (if (or (eq f 'org-tag)
5333 (and (listp f) (memq 'org-tag f)))
5334 nil
5335 (add-text-properties (match-beginning 0) (match-end 0)
5336 (list 'mouse-face 'highlight
5337 'rear-nonsticky org-nonsticky-props
5338 'keymap org-mouse-map
5339 ))
5340 (throw 'exit t))))))
5342 (defun org-activate-code (limit)
5344 (unless (get-text-property (match-beginning 1) 'face)
5345 (remove-text-properties (match-beginning 0) (match-end 0)
5346 '(display t invisible t intangible t))
5347 t)))
5349 (defun org-activate-angle-links (limit)
5350 "Run through the buffer and add overlays to links."
5351 (if (re-search-forward org-angle-link-re limit t)
5352 (progn
5353 (add-text-properties (match-beginning 0) (match-end 0)
5354 (list 'mouse-face 'highlight
5355 'rear-nonsticky org-nonsticky-props
5356 'keymap org-mouse-map
5357 ))
5358 t)))
5360 (defmacro org-maybe-intangible (props)
5361 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5362 In emacs 21, invisible text is not avoided by the command loop, so the
5363 intangible property is needed to make sure point skips this text.
5364 In Emacs 22, this is not necessary. The intangible text property has
5365 led to problems with flyspell. These problems are fixed in flyspell.el,
5366 but we still avoid setting the property in Emacs 22 and later.
5367 We use a macro so that the test can happen at compilation time."
5368 (if (< emacs-major-version 22)
5369 `(append '(intangible t) ,props)
5370 props))
5372 (defun org-activate-bracket-links (limit)
5373 "Run through the buffer and add overlays to bracketed links."
5374 (if (re-search-forward org-bracket-link-regexp limit t)
5375 (let* ((help (concat "LINK: "
5376 (org-match-string-no-properties 1)))
5377 ;; FIXME: above we should remove the escapes.
5378 ;; but that requires another match, protecting match data,
5379 ;; a lot of overhead for font-lock.
5380 (ip (org-maybe-intangible
5381 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5382 'keymap org-mouse-map 'mouse-face 'highlight
5383 'font-lock-multiline t 'help-echo help)))
5384 (vp (list 'rear-nonsticky org-nonsticky-props
5385 'keymap org-mouse-map 'mouse-face 'highlight
5386 ' font-lock-multiline t 'help-echo help)))
5387 ;; We need to remove the invisible property here. Table narrowing
5388 ;; may have made some of this invisible.
5389 (remove-text-properties (match-beginning 0) (match-end 0)
5390 '(invisible nil))
5391 (if (match-end 3)
5392 (progn
5393 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5394 (add-text-properties (match-beginning 3) (match-end 3) vp)
5395 (add-text-properties (match-end 3) (match-end 0) ip))
5396 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5397 (add-text-properties (match-beginning 1) (match-end 1) vp)
5398 (add-text-properties (match-end 1) (match-end 0) ip))
5399 t)))
5401 (defun org-activate-dates (limit)
5402 "Run through the buffer and add overlays to dates."
5403 (if (re-search-forward org-tsr-regexp-both limit t)
5404 (progn
5405 (add-text-properties (match-beginning 0) (match-end 0)
5406 (list 'mouse-face 'highlight
5407 'rear-nonsticky org-nonsticky-props
5408 'keymap org-mouse-map))
5409 (when org-display-custom-times
5410 (if (match-end 3)
5411 (org-display-custom-time (match-beginning 3) (match-end 3)))
5412 (org-display-custom-time (match-beginning 1) (match-end 1)))
5413 t)))
5415 (defvar org-target-link-regexp nil
5416 "Regular expression matching radio targets in plain text.")
5418 "Regular expression matching a link target.")
5420 "Regular expression matching a radio target.")
5421 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5422 "Regular expression matching any target.")
5424 (defun org-activate-target-links (limit)
5425 "Run through the buffer and add overlays to target matches."
5426 (when org-target-link-regexp
5427 (let ((case-fold-search t))
5428 (if (re-search-forward org-target-link-regexp limit t)
5429 (progn
5430 (add-text-properties (match-beginning 0) (match-end 0)
5431 (list 'mouse-face 'highlight
5432 'rear-nonsticky org-nonsticky-props
5433 'keymap org-mouse-map
5434 'help-echo "Radio target link"
5435 'org-linked-text t))
5436 t)))))
5438 (defun org-update-radio-target-regexp ()
5439 "Find all radio targets in this file and update the regular expression."
5440 (interactive)
5441 (when (memq 'radio org-activate-links)
5442 (setq org-target-link-regexp
5443 (org-make-target-link-regexp (org-all-targets 'radio)))
5444 (org-restart-font-lock)))
5446 (defun org-hide-wide-columns (limit)
5447 (let (s e)
5448 (setq s (text-property-any (point) (or limit (point-max))
5449 'org-cwidth t))
5450 (when s
5451 (setq e (next-single-property-change s 'org-cwidth))
5452 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5453 (goto-char e)
5454 t)))
5456 (defvar org-latex-and-specials-regexp nil
5457 "Regular expression for highlighting export special stuff.")
5458 (defvar org-match-substring-regexp)
5459 (defvar org-match-substring-with-braces-regexp)
5460 (defvar org-export-html-special-string-regexps)
5462 (defun org-compute-latex-and-specials-regexp ()
5463 "Compute regular expression for stuff treated specially by exporters."
5464 (if (not org-highlight-latex-fragments-and-specials)
5465 (org-set-local 'org-latex-and-specials-regexp nil)
5466 (let*
5467 ((matchers (plist-get org-format-latex-options :matchers))
5468 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5469 org-latex-regexps)))
5470 (options (org-combine-plists (org-default-export-plist)
5471 (org-infile-export-plist)))
5472 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5473 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5474 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5475 (org-export-html-expand (plist-get options :expand-quoted-html))
5476 (org-export-with-special-strings (plist-get options :special-strings))
5477 (re-sub
5478 (cond
5479 ((equal org-export-with-sub-superscripts '{})
5480 (list org-match-substring-with-braces-regexp))
5481 (org-export-with-sub-superscripts
5482 (list org-match-substring-regexp))
5483 (t nil)))
5484 (re-latex
5485 (if org-export-with-LaTeX-fragments
5486 (mapcar (lambda (x) (nth 1 x)) latexs)))
5487 (re-macros
5488 (if org-export-with-TeX-macros
5490 (regexp-opt
5491 (append (mapcar 'car org-html-entities)
5492 (if (boundp 'org-latex-entities)
5493 org-latex-entities nil))
5494 'words))) ; FIXME
5495 ))
5497 (re-special (if org-export-with-special-strings
5498 (mapcar (lambda (x) (car x))
5499 org-export-html-special-string-regexps)))
5500 (re-rest
5501 (delq nil
5502 (list
5504 ))))
5505 (org-set-local
5506 'org-latex-and-specials-regexp
5507 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5510 (defface org-latex-and-export-specials
5511 (let ((font (cond ((assq :inherit custom-face-attributes)
5512 '(:inherit underline))
5513 (t '(:underline t)))))
5514 `((((class grayscale) (background light))
5515 (:foreground "DimGray" ,@font))
5516 (((class grayscale) (background dark))
5517 (:foreground "LightGray" ,@font))
5518 (((class color) (background light))
5519 (:foreground "SaddleBrown"))
5520 (((class color) (background dark))
5521 (:foreground "burlywood"))
5522 (t (,@font))))
5523 "Face used to highlight math latex and other special exporter stuff."
5524 :group 'org-faces)
5526 (defun org-do-latex-and-special-faces (limit)
5527 "Run through the buffer and add overlays to links."
5528 (when org-latex-and-specials-regexp
5529 (let (rtn d)
5530 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5531 limit t))
5532 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5533 'face))
5534 '(org-code org-verbatim underline)))
5535 (progn
5536 (setq rtn t
5537 d (cond ((member (char-after (1+ (match-beginning 0)))
5538 '(?_ ?^)) 1)
5539 (t 0)))
5540 (font-lock-prepend-text-property
5541 (+ d (match-beginning 0)) (match-end 0)
5542 'face 'org-latex-and-export-specials)
5543 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5544 '(font-lock-multiline t)))))
5545 rtn)))
5547 (defun org-restart-font-lock ()
5548 "Restart font-lock-mode, to force refontification."
5549 (when (and (boundp 'font-lock-mode) font-lock-mode)
5550 (font-lock-mode -1)
5551 (font-lock-mode 1)))
5553 (defun org-all-targets (&optional radio)
5554 "Return a list of all targets in this file.
5555 With optional argument RADIO, only find radio targets."
5556 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5557 rtn)
5558 (save-excursion
5559 (goto-char (point-min))
5560 (while (re-search-forward re nil t)
5561 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5562 rtn)))
5564 (defun org-make-target-link-regexp (targets)
5565 "Make regular expression matching all strings in TARGETS.
5566 The regular expression finds the targets also if there is a line break
5567 between words."
5568 (and targets
5569 (concat
5571 (mapconcat
5572 (lambda (x)
5573 (while (string-match " +" x)
5575 x)
5576 targets
5580 (defun org-activate-tags (limit)
5582 (progn
5583 (add-text-properties (match-beginning 1) (match-end 1)
5584 (list 'mouse-face 'highlight
5585 'rear-nonsticky org-nonsticky-props
5586 'keymap org-mouse-map))
5587 t)))
5589 (defun org-outline-level ()
5590 (save-excursion
5591 (looking-at outline-regexp)
5592 (if (match-beginning 1)
5593 (+ (org-get-string-indentation (match-string 1)) 1000)
5594 (1- (- (match-end 0) (match-beginning 0))))))
5596 (defvar org-font-lock-keywords nil)
5599 "Regular expression matching a property line.")
5601 (defun org-set-font-lock-defaults ()
5602 (let* ((em org-fontify-emphasized-text)
5603 (lk org-activate-links)
5604 (org-font-lock-extra-keywords
5605 (list
5606 ;; Headlines
5608 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5609 ;; Table lines
5611 (1 'org-table t))
5612 ;; Table internals
5616 ;; Drawers
5617 (list org-drawer-regexp '(0 'org-special-keyword t))
5619 ;; Properties
5620 (list org-property-re
5621 '(1 'org-special-keyword t)
5622 '(3 'org-property-value t))
5623 (if org-format-transports-properties-p
5625 ;; Links
5626 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5627 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5628 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5629 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5630 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5631 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5633 '(org-hide-wide-columns (0 nil append))
5634 ;; TODO lines
5636 '(1 (org-get-todo-face 1) t))
5637 ;; DONE
5638 (if org-fontify-done-headline
5642 '(2 'org-headline-done t))
5643 nil)
5644 ;; Priorities
5646 ;; Special keywords
5651 ;; Emphasis
5652 (if em
5653 (if (featurep 'xemacs)
5654 '(org-do-emphasis-faces (0 nil append))
5655 '(org-do-emphasis-faces)))
5656 ;; Checkboxes
5658 2 'bold prepend)
5659 (if org-provide-checkbox-statistics
5661 (0 (org-get-checkbox-statistics-face) t)))
5663 '(1 'org-archived prepend))
5664 ;; Specials
5665 '(org-do-latex-and-special-faces)
5666 ;; Code
5667 '(org-activate-code (1 'org-code t))
5668 ;; COMMENT
5671 '(1 'org-special-keyword t))
5672 '("^#.*" (0 'font-lock-comment-face t))
5673 )))
5674 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5675 ;; Now set the full font-lock-keywords
5676 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5677 (org-set-local 'font-lock-defaults
5678 '(org-font-lock-keywords t nil nil backward-paragraph))
5679 (kill-local-variable 'font-lock-keywords) nil))
5681 (defvar org-m nil)
5682 (defvar org-l nil)
5683 (defvar org-f nil)
5684 (defun org-get-level-face (n)
5685 "Get the right face for match N in font-lock matching of healdines."
5686 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5687 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5688 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5689 (cond
5690 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5691 ((eq n 2) org-f)
5692 (t (if org-level-color-stars-only nil org-f))))
5694 (defun org-get-todo-face (kwd)
5695 "Get the right face for a TODO keyword KWD.
5696 If KWD is a number, get the corresponding match group."
5697 (if (numberp kwd) (setq kwd (match-string kwd)))
5698 (or (cdr (assoc kwd org-todo-keyword-faces))
5699 (and (member kwd org-done-keywords) 'org-done)
5700 'org-todo))
5702 (defun org-unfontify-region (beg end &optional maybe_loudly)
5703 "Remove fontification and activation overlays from links."
5704 (font-lock-default-unfontify-region beg end)
5705 (let* ((buffer-undo-list t)
5706 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5707 (inhibit-modification-hooks t)
5708 deactivate-mark buffer-file-name buffer-file-truename)
5709 (remove-text-properties beg end
5710 '(mouse-face t keymap t org-linked-text t
5711 invisible t intangible t))))
5713 ;;;; Visibility cycling, including org-goto and indirect buffer
5715 ;;; Cycling
5717 (defvar org-cycle-global-status nil)
5718 (make-variable-buffer-local 'org-cycle-global-status)
5719 (defvar org-cycle-subtree-status nil)
5720 (make-variable-buffer-local 'org-cycle-subtree-status)
5722 ;;;###autoload
5723 (defun org-cycle (&optional arg)
5724 "Visibility cycling for Org-mode.
5726 - When this function is called with a prefix argument, rotate the entire
5727 buffer through 3 states (global cycling)
5728 1. OVERVIEW: Show only top-level headlines.
5729 2. CONTENTS: Show all headlines of all levels, but no body text.
5730 3. SHOW ALL: Show everything.
5732 - When point is at the beginning of a headline, rotate the subtree started
5733 by this line through 3 different states (local cycling)
5734 1. FOLDED: Only the main headline is shown.
5735 2. CHILDREN: The main headline and the direct children are shown.
5736 From this state, you can move to one of the children
5737 and zoom in further.
5738 3. SUBTREE: Show the entire subtree, including body text.
5740 - When there is a numeric prefix, go up to a heading with level ARG, do
5741 a `show-subtree' and return to the previous cursor position. If ARG
5742 is negative, go up that many levels.
5744 - When point is not at the beginning of a headline, execute
5745 `indent-relative', like TAB normally does. See the option
5746 `org-cycle-emulate-tab' for details.
5748 - Special case: if point is at the beginning of the buffer and there is
5749 no headline in line 1, this function will act as if called with prefix arg.
5750 But only if also the variable `org-cycle-global-at-bob' is t."
5751 (interactive "P")
5752 (let* ((outline-regexp
5753 (if (and (org-mode-p) org-cycle-include-plain-lists)
5755 outline-regexp))
5756 (bob-special (and org-cycle-global-at-bob (bobp)
5757 (not (looking-at outline-regexp))))
5758 (org-cycle-hook
5759 (if bob-special
5760 (delq 'org-optimize-window-after-visibility-change
5761 (copy-sequence org-cycle-hook))
5762 org-cycle-hook))
5763 (pos (point)))
5765 (if (or bob-special (equal arg '(4)))
5766 ;; special case: use global cycling
5767 (setq arg t))
5769 (cond
5771 ((org-at-table-p 'any)
5772 ;; Enter the table or move to the next field in the table
5773 (or (org-table-recognize-table.el)
5774 (progn
5775 (if arg (org-table-edit-field t)
5776 (org-table-justify-field-maybe)
5777 (call-interactively 'org-table-next-field)))))
5779 ((eq arg t) ;; Global cycling
5781 (cond
5782 ((and (eq last-command this-command)
5783 (eq org-cycle-global-status 'overview))
5784 ;; We just created the overview - now do table of contents
5785 ;; This can be slow in very large buffers, so indicate action
5786 (message "CONTENTS...")
5787 (org-content)
5788 (message "CONTENTS...done")
5789 (setq org-cycle-global-status 'contents)
5790 (run-hook-with-args 'org-cycle-hook 'contents))
5792 ((and (eq last-command this-command)
5793 (eq org-cycle-global-status 'contents))
5794 ;; We just showed the table of contents - now show everything
5795 (show-all)
5796 (message "SHOW ALL")
5797 (setq org-cycle-global-status 'all)
5798 (run-hook-with-args 'org-cycle-hook 'all))
5800 (t
5801 ;; Default action: go to overview
5802 (org-overview)
5803 (message "OVERVIEW")
5804 (setq org-cycle-global-status 'overview)
5805 (run-hook-with-args 'org-cycle-hook 'overview))))
5807 ((and org-drawers org-drawer-regexp
5808 (save-excursion
5809 (beginning-of-line 1)
5810 (looking-at org-drawer-regexp)))
5811 ;; Toggle block visibility
5812 (org-flag-drawer
5813 (not (get-char-property (match-end 0) 'invisible))))
5815 ((integerp arg)
5816 ;; Show-subtree, ARG levels up from here.
5817 (save-excursion
5818 (org-back-to-heading)
5819 (outline-up-heading (if (< arg 0) (- arg)
5820 (- (funcall outline-level) arg)))
5821 (org-show-subtree)))
5823 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5824 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5825 ;; At a heading: rotate between three different views
5826 (org-back-to-heading)
5827 (let ((goal-column 0) eoh eol eos)
5828 ;; First, some boundaries
5829 (save-excursion
5830 (org-back-to-heading)
5831 (save-excursion
5832 (beginning-of-line 2)
5833 (while (and (not (eobp)) ;; this is like `next-line'
5834 (get-char-property (1- (point)) 'invisible))
5835 (beginning-of-line 2)) (setq eol (point)))
5836 (outline-end-of-heading) (setq eoh (point))
5837 (org-end-of-subtree t)
5838 (unless (eobp)
5840 (beginning-of-line 1) ; in case this is an item
5841 )
5842 (setq eos (1- (point))))
5843 ;; Find out what to do next and set `this-command'
5844 (cond
5845 ((= eos eoh)
5846 ;; Nothing is hidden behind this heading
5847 (message "EMPTY ENTRY")
5848 (setq org-cycle-subtree-status nil)
5849 (save-excursion
5850 (goto-char eos)
5851 (outline-next-heading)
5852 (if (org-invisible-p) (org-flag-heading nil))))
5853 ((or (>= eol eos)
5855 ;; Entire subtree is hidden in one line: open it
5856 (org-show-entry)
5857 (show-children)
5858 (message "CHILDREN")
5859 (save-excursion
5860 (goto-char eos)
5861 (outline-next-heading)
5862 (if (org-invisible-p) (org-flag-heading nil)))
5863 (setq org-cycle-subtree-status 'children)
5864 (run-hook-with-args 'org-cycle-hook 'children))
5865 ((and (eq last-command this-command)
5866 (eq org-cycle-subtree-status 'children))
5867 ;; We just showed the children, now show everything.
5868 (org-show-subtree)
5869 (message "SUBTREE")
5870 (setq org-cycle-subtree-status 'subtree)
5871 (run-hook-with-args 'org-cycle-hook 'subtree))
5872 (t
5873 ;; Default action: hide the subtree.
5874 (hide-subtree)
5875 (message "FOLDED")
5876 (setq org-cycle-subtree-status 'folded)
5877 (run-hook-with-args 'org-cycle-hook 'folded)))))
5879 ;; TAB emulation
5880 (buffer-read-only (org-back-to-heading))
5882 ((org-try-cdlatex-tab))
5884 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5885 (or (not (bolp))
5886 (not (looking-at outline-regexp))))
5889 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5891 (or (and (eq org-cycle-emulate-tab 'white)
5892 (= (match-end 0) (point-at-eol)))
5893 (and (eq org-cycle-emulate-tab 'whitestart)
5894 (>= (match-end 0) pos))))
5895 t
5896 (eq org-cycle-emulate-tab t))
5899 ; (point-at-bol) (point))))
5900 ; (progn
5901 ; (beginning-of-line 1)
5905 (t (save-excursion
5906 (org-back-to-heading)
5907 (org-cycle))))))
5909 ;;;###autoload
5910 (defun org-global-cycle (&optional arg)
5911 "Cycle the global visibility. For details see `org-cycle'."
5912 (interactive "P")
5913 (let ((org-cycle-include-plain-lists
5914 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5915 (if (integerp arg)
5916 (progn
5917 (show-all)
5918 (hide-sublevels arg)
5919 (setq org-cycle-global-status 'contents))
5920 (org-cycle '(4)))))
5922 (defun org-overview ()
5923 "Switch to overview mode, shoing only top-level headlines.
5924 Really, this shows all headlines with level equal or greater than the level
5925 of the first headline in the buffer. This is important, because if the
5926 first headline is not level one, then (hide-sublevels 1) gives confusing
5927 results."
5928 (interactive)
5929 (let ((level (save-excursion
5930 (goto-char (point-min))
5931 (if (re-search-forward (concat "^" outline-regexp) nil t)
5932 (progn
5933 (goto-char (match-beginning 0))
5934 (funcall outline-level))))))
5935 (and level (hide-sublevels level))))
5937 (defun org-content (&optional arg)
5938 "Show all headlines in the buffer, like a table of contents.
5939 With numerical argument N, show content up to level N."
5940 (interactive "P")
5941 (save-excursion
5942 ;; Visit all headings and show their offspring
5943 (and (integerp arg) (org-overview))
5944 (goto-char (point-max))
5945 (catch 'exit
5946 (while (and (progn (condition-case nil
5947 (outline-previous-visible-heading 1)
5948 (error (goto-char (point-min))))
5949 t)
5950 (looking-at outline-regexp))
5951 (if (integerp arg)
5952 (show-children (1- arg))
5953 (show-branches))
5954 (if (bobp) (throw 'exit nil))))))
5957 (defun org-optimize-window-after-visibility-change (state)
5958 "Adjust the window after a change in outline visibility.
5959 This function is the default value of the hook `org-cycle-hook'."
5960 (when (get-buffer-window (current-buffer))
5961 (cond
5962 ; ((eq state 'overview) (org-first-headline-recenter 1))
5963 ; ((eq state 'overview) (org-beginning-of-line))
5964 ((eq state 'content) nil)
5965 ((eq state 'all) nil)
5966 ((eq state 'folded) nil)
5967 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5968 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5970 (defun org-compact-display-after-subtree-move ()
5971 (let (beg end)
5972 (save-excursion
5973 (if (org-up-heading-safe)
5974 (progn
5975 (hide-subtree)
5976 (show-entry)
5977 (show-children)
5978 (org-cycle-show-empty-lines 'children)
5979 (org-cycle-hide-drawers 'children))
5980 (org-overview)))))
5982 (defun org-cycle-show-empty-lines (state)
5983 "Show empty lines above all visible headlines.
5984 The region to be covered depends on STATE when called through
5985 `org-cycle-hook'. Lisp program can use t for STATE to get the
5986 entire buffer covered. Note that an empty line is only shown if there
5987 are at least `org-cycle-separator-lines' empty lines before the headeline."
5988 (when (> org-cycle-separator-lines 0)
5989 (save-excursion
5990 (let* ((n org-cycle-separator-lines)
5991 (re (cond
5994 (t (let ((ns (number-to-string (- n 2))))
5997 beg end)
5998 (cond
5999 ((memq state '(overview contents t))
6000 (setq beg (point-min) end (point-max)))
6001 ((memq state '(children folded))
6002 (setq beg (point) end (progn (org-end-of-subtree t t)
6003 (beginning-of-line 2)
6004 (point)))))
6005 (when beg
6006 (goto-char beg)
6007 (while (re-search-forward re end t)
6008 (if (not (get-char-property (match-end 1) 'invisible))
6009 (outline-flag-region
6010 (match-beginning 1) (match-end 1) nil)))))))
6011 ;; Never hide empty lines at the end of the file.
6012 (save-excursion
6013 (goto-char (point-max))
6014 (outline-previous-heading)
6015 (outline-end-of-heading)
6017 (= (match-end 0) (point-max)))
6018 (outline-flag-region (point) (match-end 0) nil))))
6020 (defun org-subtree-end-visible-p ()
6021 "Is the end of the current subtree visible?"
6022 (pos-visible-in-window-p
6023 (save-excursion (org-end-of-subtree t) (point))))
6025 (defun org-first-headline-recenter (&optional N)
6026 "Move cursor to the first headline and recenter the headline.
6027 Optional argument N means, put the headline into the Nth line of the window."
6028 (goto-char (point-min))
6030 (beginning-of-line)
6031 (recenter (prefix-numeric-value N))))
6033 ;;; Org-goto
6035 (defvar org-goto-window-configuration nil)
6036 (defvar org-goto-marker nil)
6037 (defvar org-goto-map
6038 (let ((map (make-sparse-keymap)))
6039 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6040 (while (setq cmd (pop cmds))
6041 (substitute-key-definition cmd cmd map global-map)))
6042 (suppress-keymap map)
6043 (org-defkey map "\C-m" 'org-goto-ret)
6044 (org-defkey map [(return)] 'org-goto-ret)
6045 (org-defkey map [(left)] 'org-goto-left)
6046 (org-defkey map [(right)] 'org-goto-right)
6047 (org-defkey map [(control ?g)] 'org-goto-quit)
6048 (org-defkey map "\C-i" 'org-cycle)
6049 (org-defkey map [(tab)] 'org-cycle)
6050 (org-defkey map [(down)] 'outline-next-visible-heading)
6051 (org-defkey map [(up)] 'outline-previous-visible-heading)
6052 (if org-goto-auto-isearch
6053 (if (fboundp 'define-key-after)
6054 (define-key-after map [t] 'org-goto-local-auto-isearch)
6055 nil)
6056 (org-defkey map "q" 'org-goto-quit)
6057 (org-defkey map "n" 'outline-next-visible-heading)
6058 (org-defkey map "p" 'outline-previous-visible-heading)
6059 (org-defkey map "f" 'outline-forward-same-level)
6060 (org-defkey map "b" 'outline-backward-same-level)
6061 (org-defkey map "u" 'outline-up-heading))
6062 (org-defkey map "/" 'org-occur)
6063 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6064 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6065 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6066 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6067 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6068 map))
6070 (defconst org-goto-help
6071 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6072 RET=jump to location [Q]uit and return to previous location
6073 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6075 (defvar org-goto-start-pos) ; dynamically scoped parameter
6077 (defun org-goto (&optional alternative-interface)
6078 "Look up a different location in the current file, keeping current visibility.
6080 When you want look-up or go to a different location in a document, the
6081 fastest way is often to fold the entire buffer and then dive into the tree.
6082 This method has the disadvantage, that the previous location will be folded,
6083 which may not be what you want.
6085 This command works around this by showing a copy of the current buffer
6086 in an indirect buffer, in overview mode. You can dive into the tree in
6087 that copy, use org-occur and incremental search to find a location.
6088 When pressing RET or `Q', the command returns to the original buffer in
6089 which the visibility is still unchanged. After RET is will also jump to
6090 the location selected in the indirect buffer and expose the
6091 the headline hierarchy above."
6092 (interactive "P")
6093 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
6094 (org-refile-use-outline-path t)
6095 (interface
6096 (if (not alternative-interface)
6097 org-goto-interface
6098 (if (eq org-goto-interface 'outline)
6099 'outline-path-completion
6100 'outline)))
6101 (org-goto-start-pos (point))
6102 (selected-point
6103 (if (eq interface 'outline)
6104 (car (org-get-location (current-buffer) org-goto-help))
6105 (nth 3 (org-refile-get-location "Goto: ")))))
6106 (if selected-point
6107 (progn
6108 (org-mark-ring-push org-goto-start-pos)
6109 (goto-char selected-point)
6110 (if (or (org-invisible-p) (org-invisible-p2))
6111 (org-show-context 'org-goto)))
6112 (message "Quit"))))
6114 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6115 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6116 (defvar org-goto-local-auto-isearch-map) ; defined below
6118 (defun org-get-location (buf help)
6119 "Let the user select a location in the Org-mode buffer BUF.
6120 This function uses a recursive edit. It returns the selected position
6121 or nil."
6122 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6123 (isearch-hide-immediately nil)
6124 (isearch-search-fun-function
6125 (lambda () 'org-goto-local-search-forward-headings))
6126 (org-goto-selected-point org-goto-exit-command))
6127 (save-excursion
6128 (save-window-excursion
6129 (delete-other-windows)
6130 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6131 (switch-to-buffer
6132 (condition-case nil
6133 (make-indirect-buffer (current-buffer) "*org-goto*")
6134 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6135 (with-output-to-temp-buffer "*Help*"
6136 (princ help))
6137 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6138 (setq buffer-read-only nil)
6139 (let ((org-startup-truncated t)
6140 (org-startup-folded nil)
6141 (org-startup-align-all-tables nil))
6142 (org-mode)
6143 (org-overview))
6144 (setq buffer-read-only t)
6145 (if (and (boundp 'org-goto-start-pos)
6146 (integer-or-marker-p org-goto-start-pos))
6147 (let ((org-show-hierarchy-above t)
6148 (org-show-siblings t)
6149 (org-show-following-heading t))
6150 (goto-char org-goto-start-pos)
6151 (and (org-invisible-p) (org-show-context)))
6152 (goto-char (point-min)))
6153 (org-beginning-of-line)
6154 (message "Select location and press RET")
6155 (use-local-map org-goto-map)
6156 (recursive-edit)
6157 ))
6158 (kill-buffer "*org-goto*")
6159 (cons org-goto-selected-point org-goto-exit-command)))
6161 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6162 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6163 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6164 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6166 (defun org-goto-local-search-forward-headings (string bound noerror)
6167 "Search and make sure that anu matches are in headlines."
6168 (catch 'return
6169 (while (search-forward string bound noerror)
6170 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6171 (and (member :headline context)
6172 (not (member :tags context))))
6173 (throw 'return (point))))))
6175 (defun org-goto-local-auto-isearch ()
6176 "Start isearch."
6177 (interactive)
6178 (goto-char (point-min))
6179 (let ((keys (this-command-keys)))
6180 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6181 (isearch-mode t)
6182 (isearch-process-search-char (string-to-char keys)))))
6184 (defun org-goto-ret (&optional arg)
6185 "Finish `org-goto' by going to the new location."
6186 (interactive "P")
6187 (setq org-goto-selected-point (point)
6188 org-goto-exit-command 'return)
6189 (throw 'exit nil))
6191 (defun org-goto-left ()
6192 "Finish `org-goto' by going to the new location."
6193 (interactive)
6194 (if (org-on-heading-p)
6195 (progn
6196 (beginning-of-line 1)
6197 (setq org-goto-selected-point (point)
6198 org-goto-exit-command 'left)
6199 (throw 'exit nil))
6200 (error "Not on a heading")))
6202 (defun org-goto-right ()
6203 "Finish `org-goto' by going to the new location."
6204 (interactive)
6205 (if (org-on-heading-p)
6206 (progn
6207 (setq org-goto-selected-point (point)
6208 org-goto-exit-command 'right)
6209 (throw 'exit nil))
6210 (error "Not on a heading")))
6212 (defun org-goto-quit ()
6213 "Finish `org-goto' without cursor motion."
6214 (interactive)
6215 (setq org-goto-selected-point nil)
6216 (setq org-goto-exit-command 'quit)
6217 (throw 'exit nil))
6219 ;;; Indirect buffer display of subtrees
6221 (defvar org-indirect-dedicated-frame nil
6222 "This is the frame being used for indirect tree display.")
6223 (defvar org-last-indirect-buffer nil)
6225 (defun org-tree-to-indirect-buffer (&optional arg)
6226 "Create indirect buffer and narrow it to current subtree.
6227 With numerical prefix ARG, go up to this level and then take that tree.
6228 If ARG is negative, go up that many levels.
6229 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6230 indirect buffer previously made with this command, to avoid proliferation of
6231 indirect buffers. However, when you call the command with a `C-u' prefix, or
6232 when `org-indirect-buffer-display' is `new-frame', the last buffer
6233 is kept so that you can work with several indirect buffers at the same time.
6234 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6235 requests that a new frame be made for the new buffer, so that the dedicated
6236 frame is not changed."
6237 (interactive "P")
6238 (let ((cbuf (current-buffer))
6239 (cwin (selected-window))
6240 (pos (point))
6241 beg end level heading ibuf)
6242 (save-excursion
6243 (org-back-to-heading t)
6244 (when (numberp arg)
6245 (setq level (org-outline-level))
6246 (if (< arg 0) (setq arg (+ level arg)))
6247 (while (> (setq level (org-outline-level)) arg)
6248 (outline-up-heading 1 t)))
6249 (setq beg (point)
6250 heading (org-get-heading))
6251 (org-end-of-subtree t) (setq end (point)))
6252 (if (and (buffer-live-p org-last-indirect-buffer)
6253 (not (eq org-indirect-buffer-display 'new-frame))
6254 (not arg))
6255 (kill-buffer org-last-indirect-buffer))
6256 (setq ibuf (org-get-indirect-buffer cbuf)
6257 org-last-indirect-buffer ibuf)
6258 (cond
6259 ((or (eq org-indirect-buffer-display 'new-frame)
6260 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6261 (select-frame (make-frame))
6262 (delete-other-windows)
6263 (switch-to-buffer ibuf)
6264 (org-set-frame-title heading))
6265 ((eq org-indirect-buffer-display 'dedicated-frame)
6266 (raise-frame
6267 (select-frame (or (and org-indirect-dedicated-frame
6268 (frame-live-p org-indirect-dedicated-frame)
6269 org-indirect-dedicated-frame)
6270 (setq org-indirect-dedicated-frame (make-frame)))))
6271 (delete-other-windows)
6272 (switch-to-buffer ibuf)
6273 (org-set-frame-title (concat "Indirect: " heading)))
6274 ((eq org-indirect-buffer-display 'current-window)
6275 (switch-to-buffer ibuf))
6276 ((eq org-indirect-buffer-display 'other-window)
6277 (pop-to-buffer ibuf))
6278 (t (error "Invalid value.")))
6279 (if (featurep 'xemacs)
6280 (save-excursion (org-mode) (turn-on-font-lock)))
6281 (narrow-to-region beg end)
6282 (show-all)
6283 (goto-char pos)
6284 (and (window-live-p cwin) (select-window cwin))))
6286 (defun org-get-indirect-buffer (&optional buffer)
6287 (setq buffer (or buffer (current-buffer)))
6288 (let ((n 1) (base (buffer-name buffer)) bname)
6289 (while (buffer-live-p
6290 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6291 (setq n (1+ n)))
6292 (condition-case nil
6293 (make-indirect-buffer buffer bname 'clone)
6294 (error (make-indirect-buffer buffer bname)))))
6296 (defun org-set-frame-title (title)
6297 "Set the title of the current frame to the string TITLE."
6298 ;; FIXME: how to name a single frame in XEmacs???
6299 (unless (featurep 'xemacs)
6300 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6302 ;;;; Structure editing
6304 ;;; Inserting headlines
6306 (defun org-insert-heading (&optional force-heading)
6307 "Insert a new heading or item with same depth at point.
6308 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6309 If point is at the beginning of a headline, insert a sibling before the
6310 current headline. If point is not at the beginning, do not split the line,
6311 but create the new hedline after the current line."
6312 (interactive "P")
6313 (if (= (buffer-size) 0)
6315 (when (or force-heading (not (org-insert-item)))
6316 (let* ((head (save-excursion
6317 (condition-case nil
6318 (progn
6319 (org-back-to-heading)
6320 (match-string 0))
6321 (error "*"))))
6322 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6323 pos)
6324 (cond
6325 ((and (org-on-heading-p) (bolp)
6326 (or (bobp)
6327 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6328 ;; insert before the current line
6329 (open-line (if blank 2 1)))
6330 ((and (bolp)
6331 (or (bobp)
6332 (save-excursion
6333 (backward-char 1) (not (org-invisible-p)))))
6334 ;; insert right here
6335 nil)
6336 (t
6337 ; ;; in the middle of the line
6338 ; (org-show-entry)
6339 ; (if (org-get-alist-option org-M-RET-may-split-line 'headline)
6340 ; (if (and
6341 ; (org-on-heading-p)
6343 ; ;; protect the tags
6344 ;; (let ((tags (match-string 2)) pos)
6345 ; (delete-region (match-beginning 1) (match-end 1))
6346 ; (setq pos (point-at-bol))
6347 ; (newline (if blank 2 1))
6348 ; (save-excursion
6349 ; (goto-char pos)
6350 ; (end-of-line 1)
6351 ; (insert " " tags)
6352 ; (org-set-tags nil 'align)))
6353 ; (newline (if blank 2 1)))
6354 ; (newline (if blank 2 1))))
6357 ;; in the middle of the line
6358 (org-show-entry)
6359 (let ((split
6360 (org-get-alist-option org-M-RET-may-split-line 'headline))
6361 tags pos)
6362 (if (org-on-heading-p)
6363 (progn
6365 (setq tags (and (match-end 2) (match-string 2)))
6366 (and (match-end 1)
6367 (delete-region (match-beginning 1) (match-end 1)))
6368 (setq pos (point-at-bol))
6369 (or split (end-of-line 1))
6370 (delete-horizontal-space)
6371 (newline (if blank 2 1))
6372 (when tags
6373 (save-excursion
6374 (goto-char pos)
6375 (end-of-line 1)
6376 (insert " " tags)
6377 (org-set-tags nil 'align))))
6378 (or split (end-of-line 1))
6379 (newline (if blank 2 1))))))
6380 (insert head) (just-one-space)
6381 (setq pos (point))
6382 (end-of-line 1)
6383 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6384 (run-hooks 'org-insert-heading-hook)))))
6386 (defun org-insert-heading-after-current ()
6387 "Insert a new heading with same level as current, after current subtree."
6388 (interactive)
6389 (org-back-to-heading)
6390 (org-insert-heading)
6391 (org-move-subtree-down)
6392 (end-of-line 1))
6394 (defun org-insert-todo-heading (arg)
6395 "Insert a new heading with the same level and TODO state as current heading.
6396 If the heading has no TODO state, or if the state is DONE, use the first
6397 state (TODO by default). Also with prefix arg, force first state."
6398 (interactive "P")
6399 (when (not (org-insert-item 'checkbox))
6400 (org-insert-heading)
6401 (save-excursion
6402 (org-back-to-heading)
6403 (outline-previous-heading)
6404 (looking-at org-todo-line-regexp))
6405 (if (or arg
6406 (not (match-beginning 2))
6407 (member (match-string 2) org-done-keywords))
6408 (insert (car org-todo-keywords-1) " ")
6409 (insert (match-string 2) " "))))
6411 (defun org-insert-subheading (arg)
6412 "Insert a new subheading and demote it.
6413 Works for outline headings and for plain lists alike."
6414 (interactive "P")
6415 (org-insert-heading arg)
6416 (cond
6417 ((org-on-heading-p) (org-do-demote))
6418 ((org-at-item-p) (org-indent-item 1))))
6420 (defun org-insert-todo-subheading (arg)
6421 "Insert a new subheading with TODO keyword or checkbox and demote it.
6422 Works for outline headings and for plain lists alike."
6423 (interactive "P")
6424 (org-insert-todo-heading arg)
6425 (cond
6426 ((org-on-heading-p) (org-do-demote))
6427 ((org-at-item-p) (org-indent-item 1))))
6429 ;;; Promotion and Demotion
6431 (defun org-promote-subtree ()
6432 "Promote the entire subtree.
6433 See also `org-promote'."
6434 (interactive)
6435 (save-excursion
6436 (org-map-tree 'org-promote))
6437 (org-fix-position-after-promote))
6439 (defun org-demote-subtree ()
6440 "Demote the entire subtree. See `org-demote'.
6441 See also `org-promote'."
6442 (interactive)
6443 (save-excursion
6444 (org-map-tree 'org-demote))
6445 (org-fix-position-after-promote))
6448 (defun org-do-promote ()
6449 "Promote the current heading higher up the tree.
6450 If the region is active in `transient-mark-mode', promote all headings
6451 in the region."
6452 (interactive)
6453 (save-excursion
6454 (if (org-region-active-p)
6455 (org-map-region 'org-promote (region-beginning) (region-end))
6456 (org-promote)))
6457 (org-fix-position-after-promote))
6459 (defun org-do-demote ()
6460 "Demote the current heading lower down the tree.
6461 If the region is active in `transient-mark-mode', demote all headings
6462 in the region."
6463 (interactive)
6464 (save-excursion
6465 (if (org-region-active-p)
6466 (org-map-region 'org-demote (region-beginning) (region-end))
6467 (org-demote)))
6468 (org-fix-position-after-promote))
6470 (defun org-fix-position-after-promote ()
6471 "Make sure that after pro/demotion cursor position is right."
6472 (let ((pos (point)))
6473 (when (save-excursion
6474 (beginning-of-line 1)
6475 (looking-at org-todo-line-regexp)
6476 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6477 (cond ((eobp) (insert " "))
6478 ((eolp) (insert " "))
6479 ((equal (char-after) ?\ ) (forward-char 1))))))
6481 (defun org-reduced-level (l)
6482 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6484 (defun org-get-legal-level (level &optional change)
6485 "Rectify a level change under the influence of `org-odd-levels-only'
6486 LEVEL is a current level, CHANGE is by how much the level should be
6487 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6488 even level numbers will become the next higher odd number."
6489 (if org-odd-levels-only
6490 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6491 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6492 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6493 (max 1 (+ level change))))
6495 (defun org-promote ()
6496 "Promote the current heading higher up the tree.
6497 If the region is active in `transient-mark-mode', promote all headings
6498 in the region."
6499 (org-back-to-heading t)
6500 (let* ((level (save-match-data (funcall outline-level)))
6501 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6502 (diff (abs (- level (length up-head) -1))))
6503 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6504 (replace-match up-head nil t)
6505 ;; Fixup tag positioning
6506 (and org-auto-align-tags (org-set-tags nil t))
6507 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6509 (defun org-demote ()
6510 "Demote the current heading lower down the tree.
6511 If the region is active in `transient-mark-mode', demote all headings
6512 in the region."
6513 (org-back-to-heading t)
6514 (let* ((level (save-match-data (funcall outline-level)))
6515 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6516 (diff (abs (- level (length down-head) -1))))
6517 (replace-match down-head nil t)
6518 ;; Fixup tag positioning
6519 (and org-auto-align-tags (org-set-tags nil t))
6520 (if org-adapt-indentation (org-fixup-indentation diff))))
6522 (defun org-map-tree (fun)
6523 "Call FUN for every heading underneath the current one."
6524 (org-back-to-heading)
6525 (let ((level (funcall outline-level)))
6526 (save-excursion
6527 (funcall fun)
6528 (while (and (progn
6529 (outline-next-heading)
6530 (> (funcall outline-level) level))
6531 (not (eobp)))
6532 (funcall fun)))))
6534 (defun org-map-region (fun beg end)
6535 "Call FUN for every heading between BEG and END."
6536 (let ((org-ignore-region t))
6537 (save-excursion
6538 (setq end (copy-marker end))
6539 (goto-char beg)
6540 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6541 (< (point) end))
6542 (funcall fun))
6543 (while (and (progn
6544 (outline-next-heading)
6545 (< (point) end))
6546 (not (eobp)))
6547 (funcall fun)))))
6549 (defun org-fixup-indentation (diff)
6550 "Change the indentation in the current entry by DIFF
6551 However, if any line in the current entry has no indentation, or if it
6552 would end up with no indentation after the change, nothing at all is done."
6553 (save-excursion
6554 (let ((end (save-excursion (outline-next-heading)
6555 (point-marker)))
6556 (prohibit (if (> diff 0)
6559 col)
6560 (unless (save-excursion (end-of-line 1)
6561 (re-search-forward prohibit end t))
6562 (while (and (< (point) end)
6564 (goto-char (match-end 0))
6565 (setq col (current-column))
6566 (if (< diff 0) (replace-match ""))
6567 (indent-to (+ diff col))))
6568 (move-marker end nil))))
6570 (defun org-convert-to-odd-levels ()
6571 "Convert an org-mode file with all levels allowed to one with odd levels.
6572 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6573 level 5 etc."
6574 (interactive)
6575 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6576 (let ((org-odd-levels-only nil) n)
6577 (save-excursion
6578 (goto-char (point-min))
6580 (setq n (- (length (match-string 0)) 2))
6581 (while (>= (setq n (1- n)) 0)
6582 (org-demote))
6583 (end-of-line 1))))))
6586 (defun org-convert-to-oddeven-levels ()
6587 "Convert an org-mode file with only odd levels to one with odd and even levels.
6588 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6589 section with an even level, conversion would destroy the structure of the file. An error
6590 is signaled in this case."
6591 (interactive)
6592 (goto-char (point-min))
6593 ;; First check if there are no even levels
6595 (org-show-context t)
6596 (error "Not all levels are odd in this file. Conversion not possible."))
6597 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6598 (let ((org-odd-levels-only nil) n)
6599 (save-excursion
6600 (goto-char (point-min))
6602 (setq n (/ (1- (length (match-string 0))) 2))
6603 (while (>= (setq n (1- n)) 0)
6604 (org-promote))
6605 (end-of-line 1))))))
6607 (defun org-tr-level (n)
6608 "Make N odd if required."
6609 (if org-odd-levels-only (1+ (/ n 2)) n))
6611 ;;; Vertical tree motion, cutting and pasting of subtrees
6613 (defun org-move-subtree-up (&optional arg)
6614 "Move the current subtree up past ARG headlines of the same level."
6615 (interactive "p")
6616 (org-move-subtree-down (- (prefix-numeric-value arg))))
6618 (defun org-move-subtree-down (&optional arg)
6619 "Move the current subtree down past ARG headlines of the same level."
6620 (interactive "p")
6621 (setq arg (prefix-numeric-value arg))
6622 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6623 'outline-get-last-sibling))
6624 (ins-point (make-marker))
6625 (cnt (abs arg))
6626 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6627 ;; Select the tree
6628 (org-back-to-heading)
6629 (setq beg0 (point))
6630 (save-excursion
6631 (setq ne-beg (org-back-over-empty-lines))
6632 (setq beg (point)))
6633 (save-match-data
6634 (save-excursion (outline-end-of-heading)
6635 (setq folded (org-invisible-p)))
6636 (outline-end-of-subtree))
6637 (outline-next-heading)
6638 (setq ne-end (org-back-over-empty-lines))
6639 (setq end (point))
6640 (goto-char beg0)
6641 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6642 ;; include less whitespace
6643 (save-excursion
6644 (goto-char beg)
6645 (forward-line (- ne-beg ne-end))
6646 (setq beg (point))))
6647 ;; Find insertion point, with error handling
6648 (while (> cnt 0)
6649 (or (and (funcall movfunc) (looking-at outline-regexp))
6650 (progn (goto-char beg0)
6651 (error "Cannot move past superior level or buffer limit")))
6652 (setq cnt (1- cnt)))
6653 (if (> arg 0)
6654 ;; Moving forward - still need to move over subtree
6655 (progn (org-end-of-subtree t t)
6656 (save-excursion
6657 (org-back-over-empty-lines)
6658 (or (bolp) (newline)))))
6659 (setq ne-ins (org-back-over-empty-lines))
6660 (move-marker ins-point (point))
6661 (setq txt (buffer-substring beg end))
6662 (delete-region beg end)
6663 (outline-flag-region (1- beg) beg nil)
6664 (outline-flag-region (1- (point)) (point) nil)
6665 (insert txt)
6667 (setq ins-end (point))
6668 (goto-char ins-point)
6669 (org-skip-whitespace)
6670 (when (and (< arg 0)
6671 (org-first-sibling-p)
6672 (> ne-ins ne-beg))
6673 ;; Move whitespace back to beginning
6674 (save-excursion
6675 (goto-char ins-end)
6676 (let ((kill-whole-line t))
6677 (kill-line (- ne-ins ne-beg)) (point)))
6679 (move-marker ins-point nil)
6680 (org-compact-display-after-subtree-move)
6681 (unless folded
6682 (org-show-entry)
6683 (show-children)
6684 (org-cycle-hide-drawers 'children))))
6686 (defvar org-subtree-clip ""
6687 "Clipboard for cut and paste of subtrees.
6688 This is actually only a copy of the kill, because we use the normal kill
6689 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6691 (defvar org-subtree-clip-folded nil
6692 "Was the last copied subtree folded?
6693 This is used to fold the tree back after pasting.")
6695 (defun org-cut-subtree (&optional n)
6696 "Cut the current subtree into the clipboard.
6697 With prefix arg N, cut this many sequential subtrees.
6698 This is a short-hand for marking the subtree and then cutting it."
6699 (interactive "p")
6700 (org-copy-subtree n 'cut))
6702 (defun org-copy-subtree (&optional n cut)
6703 "Cut the current subtree into the clipboard.
6704 With prefix arg N, cut this many sequential subtrees.
6705 This is a short-hand for marking the subtree and then copying it.
6706 If CUT is non-nil, actually cut the subtree."
6707 (interactive "p")
6708 (let (beg end folded (beg0 (point)))
6709 (if (interactive-p)
6710 (org-back-to-heading nil) ; take what looks like a subtree
6711 (org-back-to-heading t)) ; take what is really there
6712 (org-back-over-empty-lines)
6713 (setq beg (point))
6715 (save-match-data
6716 (save-excursion (outline-end-of-heading)
6717 (setq folded (org-invisible-p)))
6718 (condition-case nil
6719 (outline-forward-same-level (1- n))
6720 (error nil))
6721 (org-end-of-subtree t t))
6722 (org-back-over-empty-lines)
6723 (setq end (point))
6724 (goto-char beg0)
6725 (when (> end beg)
6726 (setq org-subtree-clip-folded folded)
6727 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6728 (setq org-subtree-clip (current-kill 0))
6729 (message "%s: Subtree(s) with %d characters"
6730 (if cut "Cut" "Copied")
6731 (length org-subtree-clip)))))
6733 (defun org-paste-subtree (&optional level tree)
6734 "Paste the clipboard as a subtree, with modification of headline level.
6735 The entire subtree is promoted or demoted in order to match a new headline
6736 level. By default, the new level is derived from the visible headings
6737 before and after the insertion point, and taken to be the inferior headline
6738 level of the two. So if the previous visible heading is level 3 and the
6739 next is level 4 (or vice versa), level 4 will be used for insertion.
6740 This makes sure that the subtree remains an independent subtree and does
6741 not swallow low level entries.
6743 You can also force a different level, either by using a numeric prefix
6744 argument, or by inserting the heading marker by hand. For example, if the
6749 If optional TREE is given, use this text instead of the kill ring."
6750 (interactive "P")
6751 (unless (org-kill-is-subtree-p tree)
6752 (error "%s"
6753 (substitute-command-keys
6755 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6760 (old-level (if (string-match ^re txt)
6761 (- (match-end 0) (match-beginning 0) 1)
6762 -1))
6763 (force-level (cond (level (prefix-numeric-value level))
6764 ((string-match
6765 ^re_ (buffer-substring (point-at-bol) (point)))
6766 (- (match-end 1) (match-beginning 1)))
6767 (t nil)))
6768 (previous-level (save-excursion
6769 (condition-case nil
6770 (progn
6771 (outline-previous-visible-heading 1)
6772 (if (looking-at re)
6773 (- (match-end 0) (match-beginning 0) 1)
6774 1))
6775 (error 1))))
6776 (next-level (save-excursion
6777 (condition-case nil
6778 (progn
6779 (or (looking-at outline-regexp)
6780 (outline-next-visible-heading 1))
6781 (if (looking-at re)
6782 (- (match-end 0) (match-beginning 0) 1)
6783 1))
6784 (error 1))))
6785 (new-level (or force-level (max previous-level next-level)))
6786 (shift (if (or (= old-level -1)
6787 (= new-level -1)
6788 (= old-level new-level))
6789 0
6790 (- new-level old-level)))
6791 (delta (if (> shift 0) -1 1))
6792 (func (if (> shift 0) 'org-demote 'org-promote))
6793 (org-odd-levels-only nil)
6794 beg end)
6795 ;; Remove the forced level indicator
6796 (if force-level
6797 (delete-region (point-at-bol) (point)))
6798 ;; Paste
6799 (beginning-of-line 1)
6800 (org-back-over-empty-lines) ;; FIXME: correct fix????
6801 (setq beg (point))
6802 (insert-before-markers txt) ;; FIXME: correct fix????
6804 (setq end (point))
6805 (goto-char beg)
6807 (setq beg (point))
6808 ;; Shift if necessary
6809 (unless (= shift 0)
6810 (save-restriction
6811 (narrow-to-region beg end)
6812 (while (not (= shift 0))
6813 (org-map-region func (point-min) (point-max))
6814 (setq shift (+ delta shift)))
6815 (goto-char (point-min))))
6816 (when (interactive-p)
6817 (message "Clipboard pasted as level %d subtree" new-level))
6818 (if (and kill-ring
6819 (eq org-subtree-clip (current-kill 0))
6820 org-subtree-clip-folded)
6821 ;; The tree was folded before it was killed/copied
6822 (hide-subtree))))
6824 (defun org-kill-is-subtree-p (&optional txt)
6825 "Check if the current kill is an outline subtree, or a set of trees.
6826 Returns nil if kill does not start with a headline, or if the first
6827 headline level is not the largest headline level in the tree.
6828 So this will actually accept several entries of equal levels as well,
6829 which is OK for `org-paste-subtree'.
6830 If optional TXT is given, check this string instead of the current kill."
6831 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6832 (start-level (and kill
6835 kill)
6836 (- (match-end 2) (match-beginning 2) 1)))
6837 (re (concat "^" org-outline-regexp))
6838 (start (1+ (match-beginning 2))))
6839 (if (not start-level)
6840 (progn
6841 nil) ;; does not even start with a heading
6842 (catch 'exit
6843 (while (setq start (string-match re kill (1+ start)))
6844 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6845 (throw 'exit nil)))
6846 t))))
6848 (defun org-narrow-to-subtree ()
6849 "Narrow buffer to the current subtree."
6850 (interactive)
6851 (save-excursion
6852 (save-match-data
6853 (narrow-to-region
6854 (progn (org-back-to-heading) (point))
6855 (progn (org-end-of-subtree t t) (point))))))
6858 ;;; Outline Sorting
6860 (defun org-sort (with-case)
6861 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6862 Optional argument WITH-CASE means sort case-sensitively."
6863 (interactive "P")
6864 (if (org-at-table-p)
6865 (org-call-with-arg 'org-table-sort-lines with-case)
6866 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6868 (defvar org-priority-regexp) ; defined later in the file
6870 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6871 "Sort entries on a certain level of an outline tree.
6872 If there is an active region, the entries in the region are sorted.
6873 Else, if the cursor is before the first entry, sort the top-level items.
6874 Else, the children of the entry at point are sorted.
6876 Sorting can be alphabetically, numerically, and by date/time as given by
6877 the first time stamp in the entry. The command prompts for the sorting
6878 type unless it has been given to the function through the SORTING-TYPE
6879 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6880 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6881 called with point at the beginning of the record. It must return either
6882 a string or a number that should serve as the sorting key for that record.
6884 Comparing entries ignores case by default. However, with an optional argument
6885 WITH-CASE, the sorting considers case as well."
6886 (interactive "P")
6887 (let ((case-func (if with-case 'identity 'downcase))
6888 start beg end stars re re2
6889 txt what tmp plain-list-p)
6890 ;; Find beginning and end of region to sort
6891 (cond
6892 ((org-region-active-p)
6893 ;; we will sort the region
6894 (setq end (region-end)
6895 what "region")
6896 (goto-char (region-beginning))
6897 (if (not (org-on-heading-p)) (outline-next-heading))
6898 (setq start (point)))
6899 ((org-at-item-p)
6900 ;; we will sort this plain list
6901 (org-beginning-of-item-list) (setq start (point))
6902 (org-end-of-item-list) (setq end (point))
6903 (goto-char start)
6904 (setq plain-list-p t
6905 what "plain list"))
6906 ((or (org-on-heading-p)
6907 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6908 ;; we will sort the children of the current headline
6909 (org-back-to-heading)
6910 (setq start (point)
6911 end (progn (org-end-of-subtree t t)
6912 (org-back-over-empty-lines)
6913 (point))
6914 what "children")
6915 (goto-char start)
6916 (show-subtree)
6917 (outline-next-heading))
6918 (t
6919 ;; we will sort the top-level entries in this file
6920 (goto-char (point-min))
6921 (or (org-on-heading-p) (outline-next-heading))
6922 (setq start (point) end (point-max) what "top-level")
6923 (goto-char start)
6924 (show-all)))
6926 (setq beg (point))
6927 (if (>= beg end) (error "Nothing to sort"))
6929 (unless plain-list-p
6931 (setq stars (match-string 1)
6932 re (concat "^" (regexp-quote stars) " +")
6933 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6934 txt (buffer-substring beg end))
6936 (if (and (not (equal stars "*")) (string-match re2 txt))
6937 (error "Region to sort contains a level above the first entry")))
6939 (unless sorting-type
6940 (message
6941 (if plain-list-p
6942 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6943 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6944 what)
6945 (setq sorting-type (read-char-exclusive))
6947 (and (= (downcase sorting-type) ?f)
6948 (setq getkey-func
6949 (completing-read "Sort using function: "
6950 obarray 'fboundp t nil nil))
6951 (setq getkey-func (intern getkey-func)))
6953 (and (= (downcase sorting-type) ?r)
6954 (setq property
6955 (completing-read "Property: "
6956 (mapcar 'list (org-buffer-property-keys t))
6957 nil t))))
6959 (message "Sorting entries...")
6961 (save-restriction
6962 (narrow-to-region start end)
6964 (let ((dcst (downcase sorting-type))
6965 (now (current-time)))
6966 (sort-subr
6967 (/= dcst sorting-type)
6968 ;; This function moves to the beginning character of the "record" to
6969 ;; be sorted.
6970 (if plain-list-p
6971 (lambda nil
6972 (if (org-at-item-p) t (goto-char (point-max))))
6973 (lambda nil
6974 (if (re-search-forward re nil t)
6975 (goto-char (match-beginning 0))
6976 (goto-char (point-max)))))
6977 ;; This function moves to the last character of the "record" being
6978 ;; sorted.
6979 (if plain-list-p
6980 'org-end-of-item
6981 (lambda nil
6982 (save-match-data
6983 (condition-case nil
6984 (outline-forward-same-level 1)
6985 (error
6986 (goto-char (point-max)))))))
6988 ;; This function returns the value that gets sorted against.
6989 (if plain-list-p
6990 (lambda nil
6992 (cond
6993 ((= dcst ?n)
6994 (string-to-number (buffer-substring (match-end 0)
6995 (point-at-eol))))
6996 ((= dcst ?a)
6997 (buffer-substring (match-end 0) (point-at-eol)))
6998 ((= dcst ?t)
6999 (if (re-search-forward org-ts-regexp
7000 (point-at-eol) t)
7001 (org-time-string-to-time (match-string 0))
7002 now))
7003 ((= dcst ?f)
7004 (if getkey-func
7005 (progn
7006 (setq tmp (funcall getkey-func))
7007 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7008 tmp)
7009 (error "Invalid key function `%s'" getkey-func)))
7010 (t (error "Invalid sorting type `%c'" sorting-type)))))
7011 (lambda nil
7012 (cond
7013 ((= dcst ?n)
7014 (if (looking-at outline-regexp)
7015 (string-to-number (buffer-substring (match-end 0)
7016 (point-at-eol)))
7017 nil))
7018 ((= dcst ?a)
7019 (funcall case-func (buffer-substring (point-at-bol)
7020 (point-at-eol))))
7021 ((= dcst ?t)
7022 (if (re-search-forward org-ts-regexp
7023 (save-excursion
7024 (forward-line 2)
7025 (point)) t)
7026 (org-time-string-to-time (match-string 0))
7027 now))
7028 ((= dcst ?p)
7029 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7030 (string-to-char (match-string 2))
7031 org-default-priority))
7032 ((= dcst ?r)
7033 (or (org-entry-get nil property) ""))
7034 ((= dcst ?f)
7035 (if getkey-func
7036 (progn
7037 (setq tmp (funcall getkey-func))
7038 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7039 tmp)
7040 (error "Invalid key function `%s'" getkey-func)))
7041 (t (error "Invalid sorting type `%c'" sorting-type)))))
7042 nil
7043 (cond
7044 ((= dcst ?a) 'string<)
7045 ((= dcst ?t) 'time-less-p)
7046 (t nil)))))
7047 (message "Sorting entries...done")))
7049 (defun org-do-sort (table what &optional with-case sorting-type)
7050 "Sort TABLE of WHAT according to SORTING-TYPE.
7051 The user will be prompted for the SORTING-TYPE if the call to this
7052 function does not specify it. WHAT is only for the prompt, to indicate
7053 what is being sorted. The sorting key will be extracted from
7054 the car of the elements of the table.
7055 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7056 (unless sorting-type
7057 (message
7058 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7059 what)
7060 (setq sorting-type (read-char-exclusive)))
7061 (let ((dcst (downcase sorting-type))
7062 extractfun comparefun)
7063 ;; Define the appropriate functions
7064 (cond
7065 ((= dcst ?n)
7066 (setq extractfun 'string-to-number
7067 comparefun (if (= dcst sorting-type) '< '>)))
7068 ((= dcst ?a)
7069 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7070 (lambda(x) (downcase (org-sort-remove-invisible x))))
7071 comparefun (if (= dcst sorting-type)
7072 'string<
7073 (lambda (a b) (and (not (string< a b))
7074 (not (string= a b)))))))
7075 ((= dcst ?t)
7076 (setq extractfun
7077 (lambda (x)
7078 (if (string-match org-ts-regexp x)
7079 (time-to-seconds
7080 (org-time-string-to-time (match-string 0 x)))
7081 0))
7082 comparefun (if (= dcst sorting-type) '< '>)))
7083 (t (error "Invalid sorting type `%c'" sorting-type)))
7085 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7086 table)
7087 (lambda (a b) (funcall comparefun (car a) (car b))))))
7089 ;;;; Plain list items, including checkboxes
7091 ;;; Plain list items
7093 (defun org-at-item-p ()
7094 "Is point in a line starting a hand-formatted item?"
7095 (let ((llt org-plain-list-ordered-item-terminator))
7096 (save-excursion
7097 (goto-char (point-at-bol))
7098 (looking-at
7099 (cond
7103 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7105 (defun org-in-item-p ()
7106 "It the cursor inside a plain list item.
7107 Does not have to be the first line."
7108 (save-excursion
7109 (condition-case nil
7110 (progn
7111 (org-beginning-of-item)
7112 (org-at-item-p)
7113 t)
7114 (error nil))))
7116 (defun org-insert-item (&optional checkbox)
7117 "Insert a new item at the current level.
7118 Return t when things worked, nil when we are not in an item."
7119 (when (save-excursion
7120 (condition-case nil
7121 (progn
7122 (org-beginning-of-item)
7123 (org-at-item-p)
7124 (if (org-invisible-p) (error "Invisible item"))
7125 t)
7126 (error nil)))
7127 (let* ((bul (match-string 0))
7129 (match-end 0)))
7130 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7131 pos)
7132 (cond
7133 ((and (org-at-item-p) (<= (point) eow))
7134 ;; before the bullet
7135 (beginning-of-line 1)
7136 (open-line (if blank 2 1)))
7137 ((<= (point) eow)
7138 (beginning-of-line 1))
7139 (t
7140 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7141 (end-of-line 1)
7142 (delete-horizontal-space))
7143 (newline (if blank 2 1))))
7144 (insert bul (if checkbox "[ ]" ""))
7145 (just-one-space)
7146 (setq pos (point))
7147 (end-of-line 1)
7148 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7149 (org-maybe-renumber-ordered-list)
7150 (and checkbox (org-update-checkbox-count-maybe))
7151 t))
7153 ;;; Checkboxes
7155 (defun org-at-item-checkbox-p ()
7156 "Is point at a line starting a plain-list item with a checklet?"
7157 (and (org-at-item-p)
7158 (save-excursion
7159 (goto-char (match-end 0))
7163 (defun org-toggle-checkbox (&optional arg)
7164 "Toggle the checkbox in the current line."
7165 (interactive "P")
7166 (catch 'exit
7167 (let (beg end status (firstnew 'unknown))
7168 (cond
7169 ((org-region-active-p)
7170 (setq beg (region-beginning) end (region-end)))
7171 ((org-on-heading-p)
7172 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7173 ((org-at-item-checkbox-p)
7174 (let ((pos (point)))
7175 (replace-match
7176 (cond (arg "[-]")
7177 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7178 (t "[ ]"))
7179 t t)
7180 (goto-char pos))
7181 (throw 'exit t))
7182 (t (error "Not at a checkbox or heading, and no active region")))
7183 (save-excursion
7184 (goto-char beg)
7185 (while (< (point) end)
7186 (when (org-at-item-checkbox-p)
7187 (setq status (equal (match-string 0) "[X]"))
7188 (when (eq firstnew 'unknown)
7189 (setq firstnew (not status)))
7190 (replace-match
7191 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7192 (beginning-of-line 2)))))
7193 (org-update-checkbox-count-maybe))
7195 (defun org-update-checkbox-count-maybe ()
7196 "Update checkbox statistics unless turned off by user."
7197 (when org-provide-checkbox-statistics
7198 (org-update-checkbox-count)))
7200 (defun org-update-checkbox-count (&optional all)
7201 "Update the checkbox statistics in the current section.
7202 This will find all statistic cookies like [57%] and [6/12] and update them
7203 with the current numbers. With optional prefix argument ALL, do this for
7204 the whole buffer."
7205 (interactive "P")
7206 (save-excursion
7207 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7208 (beg (condition-case nil
7209 (progn (outline-back-to-heading) (point))
7210 (error (point-min))))
7211 (end (move-marker (make-marker)
7212 (progn (outline-next-heading) (point))))
7216 beg-cookie end-cookie is-percent c-on c-off lim
7217 eline curr-ind next-ind continue-from startsearch
7218 (cstat 0)
7219 )
7220 (when all
7221 (goto-char (point-min))
7222 (outline-next-heading)
7223 (setq beg (point) end (point-max)))
7224 (goto-char end)
7225 ;; find each statistic cookie
7226 (while (re-search-backward re-find beg t)
7227 (setq beg-cookie (match-beginning 1)
7228 end-cookie (match-end 1)
7229 cstat (+ cstat (if end-cookie 1 0))
7230 startsearch (point-at-eol)
7231 continue-from (point-at-bol)
7232 is-percent (match-beginning 2)
7233 lim (cond
7234 ((org-on-heading-p) (outline-next-heading) (point))
7235 ((org-at-item-p) (org-end-of-item) (point))
7236 (t nil))
7237 c-on 0
7238 c-off 0)
7239 (when lim
7240 ;; find first checkbox for this cookie and gather
7241 ;; statistics from all that are at this indentation level
7242 (goto-char startsearch)
7243 (if (re-search-forward re-box lim t)
7244 (progn
7245 (org-beginning-of-item)
7246 (setq curr-ind (org-get-indentation))
7247 (setq next-ind curr-ind)
7248 (while (= curr-ind next-ind)
7249 (save-excursion (end-of-line) (setq eline (point)))
7250 (if (re-search-forward re-box eline t)
7251 (if (member (match-string 2) '("[ ]" "[-]"))
7252 (setq c-off (1+ c-off))
7253 (setq c-on (1+ c-on))
7254 )
7255 )
7256 (org-end-of-item)
7257 (setq next-ind (org-get-indentation))
7258 )))
7259 (goto-char continue-from)
7260 ;; update cookie
7261 (when end-cookie
7262 (delete-region beg-cookie end-cookie)
7263 (goto-char beg-cookie)
7264 (insert
7265 (if is-percent
7266 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7267 (format "[%d/%d]" c-on (+ c-on c-off)))))
7268 ;; update items checkbox if it has one
7269 (when (org-at-item-p)
7270 (org-beginning-of-item)
7271 (when (and (> (+ c-on c-off) 0)
7272 (re-search-forward re-box (point-at-eol) t))
7273 (setq beg-cookie (match-beginning 2)
7274 end-cookie (match-end 2))
7275 (delete-region beg-cookie end-cookie)
7276 (goto-char beg-cookie)
7277 (cond ((= c-off 0) (insert "[X]"))
7278 ((= c-on 0) (insert "[ ]"))
7279 (t (insert "[-]")))
7280 )))
7281 (goto-char continue-from))
7282 (when (interactive-p)
7283 (message "Checkbox satistics updated %s (%d places)"
7284 (if all "in entire file" "in current outline entry") cstat)))))
7286 (defun org-get-checkbox-statistics-face ()
7287 "Select the face for checkbox statistics.
7288 The face will be `org-done' when all relevant boxes are checked. Otherwise
7289 it will be `org-todo'."
7290 (if (match-end 1)
7291 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7292 (if (and (> (match-end 2) (match-beginning 2))
7293 (equal (match-string 2) (match-string 3)))
7294 'org-done
7295 'org-todo)))
7297 (defun org-get-indentation (&optional line)
7298 "Get the indentation of the current line, interpreting tabs.
7299 When LINE is given, assume it represents a line and compute its indentation."
7300 (if line
7301 (if (string-match "^ *" (org-remove-tabs line))
7302 (match-end 0))
7303 (save-excursion
7304 (beginning-of-line 1)
7306 (current-column))))
7308 (defun org-remove-tabs (s &optional width)
7309 "Replace tabulators in S with spaces.
7310 Assumes that s is a single line, starting in column 0."
7311 (setq width (or width tab-width))
7313 (setq s (replace-match
7314 (make-string
7315 (- (* width (/ (+ (match-beginning 0) width) width))
7316 (match-beginning 0)) ?\ )
7317 t t s)))
7318 s)
7320 (defun org-fix-indentation (line ind)
7321 "Fix indentation in LINE.
7322 IND is a cons cell with target and minimum indentation.
7323 If the current indenation in LINE is smaller than the minimum,
7324 leave it alone. If it is larger than ind, set it to the target."
7325 (let* ((l (org-remove-tabs line))
7326 (i (org-get-indentation l))
7327 (i1 (car ind)) (i2 (cdr ind)))
7328 (if (>= i i2) (setq l (substring line i2)))
7329 (if (> i1 0)
7330 (concat (make-string i1 ?\ ) l)
7331 l)))
7333 (defcustom org-empty-line-terminates-plain-lists nil
7334 "Non-nil means, an empty line ends all plain list levels.
7335 When nil, empty lines are part of the preceeding item."
7336 :group 'org-plain-lists
7337 :type 'boolean)
7339 (defun org-beginning-of-item ()
7340 "Go to the beginning of the current hand-formatted item.
7341 If the cursor is not in an item, throw an error."
7342 (interactive)
7343 (let ((pos (point))
7344 (limit (save-excursion
7345 (condition-case nil
7346 (progn
7347 (org-back-to-heading)
7348 (beginning-of-line 2) (point))
7349 (error (point-min)))))
7350 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7351 ind ind1)
7352 (if (org-at-item-p)
7353 (beginning-of-line 1)
7354 (beginning-of-line 1)
7356 (setq ind (current-column))
7357 (if (catch 'exit
7358 (while t
7359 (beginning-of-line 0)
7360 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7363 (setq ind1 ind-empty)
7365 (setq ind1 (current-column)))
7366 (if (< ind1 ind)
7367 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7368 nil
7369 (goto-char pos)
7370 (error "Not in an item")))))
7372 (defun org-end-of-item ()
7373 "Go to the end of the current hand-formatted item.
7374 If the cursor is not in an item, throw an error."
7375 (interactive)
7376 (let* ((pos (point))
7377 ind1
7378 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7379 (limit (save-excursion (outline-next-heading) (point)))
7380 (ind (save-excursion
7381 (org-beginning-of-item)
7383 (current-column)))
7384 (end (catch 'exit
7385 (while t
7386 (beginning-of-line 2)
7387 (if (eobp) (throw 'exit (point)))
7388 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7390 (setq ind1 ind-empty)
7392 (setq ind1 (current-column)))
7393 (if (<= ind1 ind)
7394 (throw 'exit (point-at-bol)))))))
7395 (if end
7396 (goto-char end)
7397 (goto-char pos)
7398 (error "Not in an item"))))
7400 (defun org-next-item ()
7401 "Move to the beginning of the next item in the current plain list.
7402 Error if not at a plain list, or if this is the last item in the list."
7403 (interactive)
7404 (let (ind ind1 (pos (point)))
7405 (org-beginning-of-item)
7406 (setq ind (org-get-indentation))
7407 (org-end-of-item)
7408 (setq ind1 (org-get-indentation))
7409 (unless (and (org-at-item-p) (= ind ind1))
7410 (goto-char pos)
7411 (error "On last item"))))
7413 (defun org-previous-item ()
7414 "Move to the beginning of the previous item in the current plain list.
7415 Error if not at a plain list, or if this is the first item in the list."
7416 (interactive)
7417 (let (beg ind ind1 (pos (point)))
7418 (org-beginning-of-item)
7419 (setq beg (point))
7420 (setq ind (org-get-indentation))
7421 (goto-char beg)
7422 (catch 'exit
7423 (while t
7424 (beginning-of-line 0)
7426 nil
7427 (if (<= (setq ind1 (org-get-indentation)) ind)
7428 (throw 'exit t)))))
7429 (condition-case nil
7430 (if (or (not (org-at-item-p))
7431 (< ind1 (1- ind)))
7432 (error "")
7433 (org-beginning-of-item))
7434 (error (goto-char pos)
7435 (error "On first item")))))
7437 (defun org-first-list-item-p ()
7438 "Is this heading the item in a plain list?"
7439 (unless (org-at-item-p)
7440 (error "Not at a plain list item"))
7441 (org-beginning-of-item)
7442 (= (point) (save-excursion (org-beginning-of-item-list))))
7444 (defun org-move-item-down ()
7445 "Move the plain list item at point down, i.e. swap with following item.
7446 Subitems (items with larger indentation) are considered part of the item,
7447 so this really moves item trees."
7448 (interactive)
7449 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7450 (org-beginning-of-item)
7451 (setq beg0 (point))
7452 (save-excursion
7453 (setq ne-beg (org-back-over-empty-lines))
7454 (setq beg (point)))
7455 (goto-char beg0)
7456 (setq ind (org-get-indentation))
7457 (org-end-of-item)
7458 (setq end0 (point))
7459 (setq ind1 (org-get-indentation))
7460 (setq ne-end (org-back-over-empty-lines))
7461 (setq end (point))
7462 (goto-char beg0)
7463 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7464 ;; include less whitespace
7465 (save-excursion
7466 (goto-char beg)
7467 (forward-line (- ne-beg ne-end))
7468 (setq beg (point))))
7469 (goto-char end0)
7470 (if (and (org-at-item-p) (= ind ind1))
7471 (progn
7472 (org-end-of-item)
7473 (org-back-over-empty-lines)
7474 (setq txt (buffer-substring beg end))
7475 (save-excursion
7476 (delete-region beg end))
7477 (setq pos (point))
7478 (insert txt)
7479 (goto-char pos) (org-skip-whitespace)
7480 (org-maybe-renumber-ordered-list))
7481 (goto-char pos)
7482 (error "Cannot move this item further down"))))
7484 (defun org-move-item-up (arg)
7485 "Move the plain list item at point up, i.e. swap with previous item.
7486 Subitems (items with larger indentation) are considered part of the item,
7487 so this really moves item trees."
7488 (interactive "p")
7489 (let (beg beg0 end ind ind1 (pos (point)) txt
7490 ne-beg ne-ins ins-end)
7491 (org-beginning-of-item)
7492 (setq beg0 (point))
7493 (setq ind (org-get-indentation))
7494 (save-excursion
7495 (setq ne-beg (org-back-over-empty-lines))
7496 (setq beg (point)))
7497 (goto-char beg0)
7498 (org-end-of-item)
7499 (setq end (point))
7500 (goto-char beg0)
7501 (catch 'exit
7502 (while t
7503 (beginning-of-line 0)
7505 (if org-empty-line-terminates-plain-lists
7506 (progn
7507 (goto-char pos)
7508 (error "Cannot move this item further up"))
7509 nil)
7510 (if (<= (setq ind1 (org-get-indentation)) ind)
7511 (throw 'exit t)))))
7512 (condition-case nil
7513 (org-beginning-of-item)
7514 (error (goto-char beg)
7515 (error "Cannot move this item further up")))
7516 (setq ind1 (org-get-indentation))
7517 (if (and (org-at-item-p) (= ind ind1))
7518 (progn
7519 (setq ne-ins (org-back-over-empty-lines))
7520 (setq txt (buffer-substring beg end))
7521 (save-excursion
7522 (delete-region beg end))
7523 (setq pos (point))
7524 (insert txt)
7525 (setq ins-end (point))
7526 (goto-char pos) (org-skip-whitespace)
7528 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7529 ;; Move whitespace back to beginning
7530 (save-excursion
7531 (goto-char ins-end)
7532 (let ((kill-whole-line t))
7533 (kill-line (- ne-ins ne-beg)) (point)))
7536 (org-maybe-renumber-ordered-list))
7537 (goto-char pos)
7538 (error "Cannot move this item further up"))))
7540 (defun org-maybe-renumber-ordered-list ()
7541 "Renumber the ordered list at point if setup allows it.
7542 This tests the user option `org-auto-renumber-ordered-lists' before
7543 doing the renumbering."
7544 (interactive)
7545 (when (and org-auto-renumber-ordered-lists
7546 (org-at-item-p))
7547 (if (match-beginning 3)
7548 (org-renumber-ordered-list 1)
7549 (org-fix-bullet-type))))
7551 (defun org-maybe-renumber-ordered-list-safe ()
7552 (condition-case nil
7553 (save-excursion
7554 (org-maybe-renumber-ordered-list))
7555 (error nil)))
7557 (defun org-cycle-list-bullet (&optional which)
7558 "Cycle through the different itemize/enumerate bullets.
7559 This cycle the entire list level through the sequence:
7561 `-' -> `+' -> `*' -> `1.' -> `1)'
7563 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7564 0 meand `-', 1 means `+' etc."
7565 (interactive "P")
7566 (org-preserve-lc
7567 (org-beginning-of-item-list)
7568 (org-at-item-p)
7569 (beginning-of-line 1)
7570 (let ((current (match-string 0))
7571 (prevp (eq which 'previous))
7572 new)
7573 (setq new (cond
7574 ((and (numberp which)
7575 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7576 ((string-match "-" current) (if prevp "1)" "+"))
7581 ((string-match ")" current) (if prevp "1." "-"))
7582 (t (error "This should not happen"))))
7584 (org-fix-bullet-type)
7585 (org-maybe-renumber-ordered-list))))
7587 (defun org-get-string-indentation (s)
7588 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7589 (let ((n -1) (i 0) (w tab-width) c)
7590 (catch 'exit
7591 (while (< (setq n (1+ n)) (length s))
7592 (setq c (aref s n))
7593 (cond ((= c ?\ ) (setq i (1+ i)))
7595 (t (throw 'exit t)))))
7596 i))
7598 (defun org-renumber-ordered-list (arg)
7599 "Renumber an ordered plain list.
7600 Cursor needs to be in the first line of an item, the line that starts
7602 (interactive "p")
7603 (unless (and (org-at-item-p)
7604 (match-beginning 3))
7605 (error "This is not an ordered list"))
7606 (let ((line (org-current-line))
7607 (col (current-column))
7608 (ind (org-get-string-indentation
7609 (buffer-substring (point-at-bol) (match-beginning 3))))
7610 ;; (term (substring (match-string 3) -1))
7611 ind1 (n (1- arg))
7612 fmt)
7613 ;; find where this list begins
7614 (org-beginning-of-item-list)
7616 (setq fmt (concat "%d" (match-string 1)))
7617 (beginning-of-line 0)
7618 ;; walk forward and replace these numbers
7619 (catch 'exit
7620 (while t
7621 (catch 'next
7622 (beginning-of-line 2)
7623 (if (eobp) (throw 'exit nil))
7626 (if (> ind1 ind) (throw 'next t))
7627 (if (< ind1 ind) (throw 'exit t))
7628 (if (not (org-at-item-p)) (throw 'exit nil))
7629 (delete-region (match-beginning 2) (match-end 2))
7630 (goto-char (match-beginning 2))
7631 (insert (format fmt (setq n (1+ n)))))))
7632 (goto-line line)
7633 (move-to-column col)))
7635 (defun org-fix-bullet-type ()
7636 "Make sure all items in this list have the same bullet as the firsst item."
7637 (interactive)
7638 (unless (org-at-item-p) (error "This is not a list"))
7639 (let ((line (org-current-line))
7640 (col (current-column))
7641 (ind (current-indentation))
7642 ind1 bullet)
7643 ;; find where this list begins
7644 (org-beginning-of-item-list)
7645 (beginning-of-line 1)
7646 ;; find out what the bullet type is
7648 (setq bullet (match-string 1))
7649 ;; walk forward and replace these numbers
7650 (beginning-of-line 0)
7651 (catch 'exit
7652 (while t
7653 (catch 'next
7654 (beginning-of-line 2)
7655 (if (eobp) (throw 'exit nil))
7658 (if (> ind1 ind) (throw 'next t))
7659 (if (< ind1 ind) (throw 'exit t))
7660 (if (not (org-at-item-p)) (throw 'exit nil))
7663 (replace-match bullet))))
7664 (goto-line line)
7665 (move-to-column col)
7666 (if (string-match "[0-9]" bullet)
7667 (org-renumber-ordered-list 1))))
7669 (defun org-beginning-of-item-list ()
7670 "Go to the beginning of the current item list.
7671 I.e. to the first item in this list."
7672 (interactive)
7673 (org-beginning-of-item)
7674 (let ((pos (point-at-bol))
7675 (ind (org-get-indentation))
7676 ind1)
7677 ;; find where this list begins
7678 (catch 'exit
7679 (while t
7680 (catch 'next
7681 (beginning-of-line 0)
7683 (throw (if (bobp) 'exit 'next) t))
7685 (if (or (< ind1 ind)
7686 (and (= ind1 ind)
7687 (not (org-at-item-p)))
7688 (bobp))
7689 (throw 'exit t)
7690 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7691 (goto-char pos)))
7694 (defun org-end-of-item-list ()
7695 "Go to the end of the current item list.
7696 I.e. to the text after the last item."
7697 (interactive)
7698 (org-beginning-of-item)
7699 (let ((pos (point-at-bol))
7700 (ind (org-get-indentation))
7701 ind1)
7702 ;; find where this list begins
7703 (catch 'exit
7704 (while t
7705 (catch 'next
7706 (beginning-of-line 2)
7708 (throw (if (eobp) 'exit 'next) t))
7710 (if (or (< ind1 ind)
7711 (and (= ind1 ind)
7712 (not (org-at-item-p)))
7713 (eobp))
7714 (progn
7715 (setq pos (point-at-bol))
7716 (throw 'exit t))))))
7717 (goto-char pos)))
7720 (defvar org-last-indent-begin-marker (make-marker))
7721 (defvar org-last-indent-end-marker (make-marker))
7723 (defun org-outdent-item (arg)
7724 "Outdent a local list item."
7725 (interactive "p")
7726 (org-indent-item (- arg)))
7728 (defun org-indent-item (arg)
7729 "Indent a local list item."
7730 (interactive "p")
7731 (unless (org-at-item-p)
7732 (error "Not on an item"))
7733 (save-excursion
7734 (let (beg end ind ind1 tmp delta ind-down ind-up)
7735 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7736 (setq beg org-last-indent-begin-marker
7737 end org-last-indent-end-marker)
7738 (org-beginning-of-item)
7739 (setq beg (move-marker org-last-indent-begin-marker (point)))
7740 (org-end-of-item)
7741 (setq end (move-marker org-last-indent-end-marker (point))))
7742 (goto-char beg)
7743 (setq tmp (org-item-indent-positions)
7744 ind (car tmp)
7745 ind-down (nth 2 tmp)
7746 ind-up (nth 1 tmp)
7747 delta (if (> arg 0)
7748 (if ind-down (- ind-down ind) 2)
7749 (if ind-up (- ind-up ind) -2)))
7750 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7751 (while (< (point) end)
7752 (beginning-of-line 1)
7754 (delete-region (point-at-bol) (point))
7755 (or (eolp) (indent-to-column (+ ind1 delta)))
7756 (beginning-of-line 2))))
7757 (org-fix-bullet-type)
7758 (org-maybe-renumber-ordered-list-safe)
7759 (save-excursion
7760 (beginning-of-line 0)
7761 (condition-case nil (org-beginning-of-item) (error nil))
7762 (org-maybe-renumber-ordered-list-safe)))
7764 (defun org-item-indent-positions ()
7765 "Return indentation for plain list items.
7766 This returns a list with three values: The current indentation, the
7767 parent indentation and the indentation a child should habe.
7768 Assumes cursor in item line."
7769 (let* ((bolpos (point-at-bol))
7770 (ind (org-get-indentation))
7771 ind-down ind-up pos)
7772 (save-excursion
7773 (org-beginning-of-item-list)
7775 (when (org-in-item-p)
7776 (org-beginning-of-item)
7777 (setq ind-up (org-get-indentation))))
7778 (setq pos (point))
7779 (save-excursion
7780 (cond
7781 ((and (condition-case nil (progn (org-previous-item) t)
7782 (error nil))
7783 (or (forward-char 1) t)
7784 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7785 (setq ind-down (org-get-indentation)))
7786 ((and (goto-char pos)
7787 (org-at-item-p))
7788 (goto-char (match-end 0))
7790 (setq ind-down (current-column)))))
7791 (list ind ind-up ind-down)))
7793 ;;; The orgstruct minor mode
7795 ;; Define a minor mode which can be used in other modes in order to
7796 ;; integrate the org-mode structure editing commands.
7798 ;; This is really a hack, because the org-mode structure commands use
7799 ;; keys which normally belong to the major mode. Here is how it
7800 ;; works: The minor mode defines all the keys necessary to operate the
7801 ;; structure commands, but wraps the commands into a function which
7802 ;; tests if the cursor is currently at a headline or a plain list
7803 ;; item. If that is the case, the structure command is used,
7804 ;; temporarily setting many Org-mode variables like regular
7805 ;; expressions for filling etc. However, when any of those keys is
7806 ;; used at a different location, function uses `key-binding' to look
7807 ;; up if the key has an associated command in another currently active
7808 ;; keymap (minor modes, major mode, global), and executes that
7809 ;; command. There might be problems if any of the keys is otherwise
7810 ;; used as a prefix key.
7812 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7813 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7814 ;; addresses this by checking explicitly for both bindings.
7816 (defvar orgstruct-mode-map (make-sparse-keymap)
7817 "Keymap for the minor `orgstruct-mode'.")
7819 (defvar org-local-vars nil
7820 "List of local variables, for use by `orgstruct-mode'")
7822 ;;;###autoload
7823 (define-minor-mode orgstruct-mode
7824 "Toggle the minor more `orgstruct-mode'.
7825 This mode is for using Org-mode structure commands in other modes.
7826 The following key behave as if Org-mode was active, if the cursor
7827 is on a headline, or on a plain list item (both in the definition
7828 of Org-mode).
7830 M-up Move entry/item up
7831 M-down Move entry/item down
7832 M-left Promote
7833 M-right Demote
7834 M-S-up Move entry/item up
7835 M-S-down Move entry/item down
7836 M-S-left Promote subtree
7837 M-S-right Demote subtree
7838 M-q Fill paragraph and items like in Org-mode
7839 C-c ^ Sort entries
7840 C-c - Cycle list bullet
7841 TAB Cycle item visibility
7842 M-RET Insert new heading/item
7843 S-M-RET Insert new TODO heading / Chekbox item
7844 C-c C-c Set tags / toggle checkbox"
7845 nil " OrgStruct" nil
7846 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7848 ;;;###autoload
7849 (defun turn-on-orgstruct ()
7850 "Unconditionally turn on `orgstruct-mode'."
7851 (orgstruct-mode 1))
7853 ;;;###autoload
7854 (defun turn-on-orgstruct++ ()
7855 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7856 In addition to setting orgstruct-mode, this also exports all indentation and
7857 autofilling variables from org-mode into the buffer. Note that turning
7858 off orgstruct-mode will *not* remove these additional settings."
7859 (orgstruct-mode 1)
7860 (let (var val)
7861 (mapc
7862 (lambda (x)
7863 (when (string-match
7865 (symbol-name (car x)))
7866 (setq var (car x) val (nth 1 x))
7867 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7868 org-local-vars)))
7870 (defun orgstruct-error ()
7871 "Error when there is no default binding for a structure key."
7872 (interactive)
7873 (error "This key has no function outside structure elements"))
7875 (defun orgstruct-setup ()
7876 "Setup orgstruct keymaps."
7877 (let ((nfunc 0)
7878 (bindings
7879 (list
7880 '([(meta up)] org-metaup)
7881 '([(meta down)] org-metadown)
7882 '([(meta left)] org-metaleft)
7883 '([(meta right)] org-metaright)
7884 '([(meta shift up)] org-shiftmetaup)
7885 '([(meta shift down)] org-shiftmetadown)
7886 '([(meta shift left)] org-shiftmetaleft)
7887 '([(meta shift right)] org-shiftmetaright)
7888 '([(shift up)] org-shiftup)
7889 '([(shift down)] org-shiftdown)
7890 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7891 '("\M-q" fill-paragraph)
7892 '("\C-c^" org-sort)
7893 '("\C-c-" org-cycle-list-bullet)))
7894 elt key fun cmd)
7895 (while (setq elt (pop bindings))
7896 (setq nfunc (1+ nfunc))
7897 (setq key (org-key (car elt))
7898 fun (nth 1 elt)
7899 cmd (orgstruct-make-binding fun nfunc key))
7900 (org-defkey orgstruct-mode-map key cmd))
7902 ;; Special treatment needed for TAB and RET
7903 (org-defkey orgstruct-mode-map [(tab)]
7904 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7905 (org-defkey orgstruct-mode-map "\C-i"
7906 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7908 (org-defkey orgstruct-mode-map "\M-\C-m"
7909 (orgstruct-make-binding 'org-insert-heading 105
7910 "\M-\C-m" [(meta return)]))
7911 (org-defkey orgstruct-mode-map [(meta return)]
7912 (orgstruct-make-binding 'org-insert-heading 106
7913 [(meta return)] "\M-\C-m"))
7915 (org-defkey orgstruct-mode-map [(shift meta return)]
7916 (orgstruct-make-binding 'org-insert-todo-heading 107
7917 [(meta return)] "\M-\C-m"))
7919 (unless org-local-vars
7920 (setq org-local-vars (org-get-local-variables)))
7922 t))
7924 (defun orgstruct-make-binding (fun n &rest keys)
7925 "Create a function for binding in the structure minor mode.
7926 FUN is the command to call inside a table. N is used to create a unique
7927 command name. KEYS are keys that should be checked in for a command
7928 to execute outside of tables."
7929 (eval
7930 (list 'defun
7931 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7932 '(arg)
7934 "Outside of structure, run the binding of `"
7935 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7936 "'.")
7937 '(interactive "p")
7938 (list 'if
7939 '(org-context-p 'headline 'item)
7940 (list 'org-run-like-in-org-mode (list 'quote fun))
7941 (list 'let '(orgstruct-mode)
7942 (list 'call-interactively
7943 (append '(or)
7944 (mapcar (lambda (k)
7945 (list 'key-binding k))
7946 keys)
7947 '('orgstruct-error))))))))
7949 (defun org-context-p (&rest contexts)
7950 "Check if local context is and of CONTEXTS.
7951 Possible values in the list of contexts are `table', `headline', and `item'."
7952 (let ((pos (point)))
7953 (goto-char (point-at-bol))
7954 (prog1 (or (and (memq 'table contexts)
7956 (and (memq 'headline contexts)
7958 (and (memq 'item contexts)
7960 (goto-char pos))))
7962 (defun org-get-local-variables ()
7963 "Return a list of all local variables in an org-mode buffer."
7964 (let (varlist)
7965 (with-current-buffer (get-buffer-create "*Org tmp*")
7966 (erase-buffer)
7967 (org-mode)
7968 (setq varlist (buffer-local-variables)))
7969 (kill-buffer "*Org tmp*")
7970 (delq nil
7971 (mapcar
7972 (lambda (x)
7973 (setq x
7974 (if (symbolp x)
7975 (list x)
7976 (list (car x) (list 'quote (cdr x)))))
7977 (if (string-match
7978 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7979 (symbol-name (car x)))
7980 x nil))
7981 varlist))))
7983 ;;;###autoload
7984 (defun org-run-like-in-org-mode (cmd)
7985 (unless org-local-vars
7986 (setq org-local-vars (org-get-local-variables)))
7987 (eval (list 'let org-local-vars
7988 (list 'call-interactively (list 'quote cmd)))))
7990 ;;;; Archiving
7992 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7994 (defun org-archive-subtree (&optional find-done)
7995 "Move the current subtree to the archive.
7996 The archive can be a certain top-level heading in the current file, or in
7997 a different file. The tree will be moved to that location, the subtree
7998 heading be marked DONE, and the current time will be added.
8000 When called with prefix argument FIND-DONE, find whole trees without any
8001 open TODO items and archive them (after getting confirmation from the user).
8002 If the cursor is not at a headline when this comand is called, try all level
8003 1 trees. If the cursor is on a headline, only try the direct children of
8004 this heading."
8005 (interactive "P")
8006 (if find-done
8007 (org-archive-all-done)
8008 ;; Save all relevant TODO keyword-relatex variables
8010 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
8011 (tr-org-todo-keywords-1 org-todo-keywords-1)
8012 (tr-org-todo-kwd-alist org-todo-kwd-alist)
8013 (tr-org-done-keywords org-done-keywords)
8014 (tr-org-todo-regexp org-todo-regexp)
8015 (tr-org-todo-line-regexp org-todo-line-regexp)
8016 (tr-org-odd-levels-only org-odd-levels-only)
8017 (this-buffer (current-buffer))
8018 (org-archive-location org-archive-location)
8020 ;; start of variables that will be used for saving context
8021 ;; The compiler complains about them - keep them anyway!
8022 (file (abbreviate-file-name (buffer-file-name)))
8023 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
8024 (time (format-time-string
8025 (substring (cdr org-time-stamp-formats) 1 -1)
8026 (current-time)))
8027 afile heading buffer level newfile-p
8028 category todo priority
8029 ;; start of variables that will be used for savind context
8030 ltags itags prop)
8032 ;; Try to find a local archive location
8033 (save-excursion
8034 (save-restriction
8035 (widen)
8036 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
8038 (setq org-archive-location prop)
8039 (if (or (re-search-backward re nil t)
8040 (re-search-forward re nil t))
8041 (setq org-archive-location (match-string 1))))))
8044 (progn
8045 (setq afile (format (match-string 1 org-archive-location)
8046 (file-name-nondirectory buffer-file-name))
8047 heading (match-string 2 org-archive-location)))
8048 (error "Invalid `org-archive-location'"))
8049 (if (> (length afile) 0)
8050 (setq newfile-p (not (file-exists-p afile))
8051 buffer (find-file-noselect afile))
8052 (setq buffer (current-buffer)))
8053 (unless buffer
8055 (if (and (> (length heading) 0)
8057 (setq level (match-end 0))
8058 (setq heading nil level 0))
8059 (save-excursion
8060 (org-back-to-heading t)
8061 ;; Get context information that will be lost by moving the tree
8062 (org-refresh-category-properties)
8063 (setq category (org-get-category)
8064 todo (and (looking-at org-todo-line-regexp)
8065 (match-string 2))
8066 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
8067 ltags (org-get-tags)
8068 itags (org-delete-all ltags (org-get-tags-at)))
8069 (setq ltags (mapconcat 'identity ltags " ")
8070 itags (mapconcat 'identity itags " "))
8071 ;; We first only copy, in case something goes wrong
8072 ;; we need to protect this-command, to avoid kill-region sets it,
8073 ;; which would lead to duplication of subtrees
8074 (let (this-command) (org-copy-subtree))
8075 (set-buffer buffer)
8076 ;; Enforce org-mode for the archive buffer
8077 (if (not (org-mode-p))
8078 ;; Force the mode for future visits.
8079 (let ((org-insert-mode-line-in-empty-file t)
8080 (org-inhibit-startup t))
8081 (call-interactively 'org-mode)))
8082 (when newfile-p
8083 (goto-char (point-max))
8085 (buffer-file-name this-buffer))))
8086 ;; Force the TODO keywords of the original buffer
8087 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
8088 (org-todo-keywords-1 tr-org-todo-keywords-1)
8089 (org-todo-kwd-alist tr-org-todo-kwd-alist)
8090 (org-done-keywords tr-org-done-keywords)
8091 (org-todo-regexp tr-org-todo-regexp)
8092 (org-todo-line-regexp tr-org-todo-line-regexp)
8093 (org-odd-levels-only
8094 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8095 org-odd-levels-only
8096 tr-org-odd-levels-only)))
8097 (goto-char (point-min))
8098 (show-all)
8099 (if heading
8100 (progn
8101 (if (re-search-forward
8102 (concat "^" (regexp-quote heading)
8104 nil t)
8105 (goto-char (match-end 0))
8106 ;; Heading not found, just insert it at the end
8107 (goto-char (point-max))
8110 (end-of-line 0))
8111 ;; Make the subtree visible
8112 (show-subtree)
8113 (org-end-of-subtree t)
8117 ;; No specific heading, just go to end of file.
8119 ;; Paste
8120 (org-paste-subtree (org-get-legal-level level 1))
8122 ;; Mark the entry as done
8123 (when (and org-archive-mark-done
8124 (looking-at org-todo-line-regexp)
8125 (or (not (match-end 2))
8126 (not (member (match-string 2) org-done-keywords))))
8127 (let (org-log-done org-todo-log-states)
8128 (org-todo
8129 (car (or (member org-archive-mark-done org-done-keywords)
8130 org-done-keywords)))))
8132 ;; Add the context info
8133 (when org-archive-save-context-info
8134 (let ((l org-archive-save-context-info) e n v)
8135 (while (setq e (pop l))
8136 (when (and (setq v (symbol-value e))
8138 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8139 (org-entry-put (point) n v)))))
8141 ;; Save and kill the buffer, if it is not the same buffer.
8142 (if (not (eq this-buffer buffer))
8143 (progn (save-buffer) (kill-buffer buffer)))))
8144 ;; Here we are back in the original buffer. Everything seems to have
8145 ;; worked. So now cut the tree and finish up.
8146 (let (this-command) (org-cut-subtree))
8148 (message "Subtree archived %s"
8149 (if (eq this-buffer buffer)
8150 (concat "under heading: " heading)
8151 (concat "in file: " (abbreviate-file-name afile)))))))
8153 (defun org-refresh-category-properties ()
8154 "Refresh category text properties in teh buffer."
8155 (let ((def-cat (cond
8156 ((null org-category)
8157 (if buffer-file-name
8158 (file-name-sans-extension
8159 (file-name-nondirectory buffer-file-name))
8160 "???"))
8161 ((symbolp org-category) (symbol-name org-category))
8162 (t org-category)))
8163 beg end cat pos optionp)
8164 (org-unmodified
8165 (save-excursion
8166 (save-restriction
8167 (widen)
8168 (goto-char (point-min))
8169 (put-text-property (point) (point-max) 'org-category def-cat)
8170 (while (re-search-forward
8172 (setq pos (match-end 0)
8173 optionp (equal (char-after (match-beginning 0)) ?#)
8174 cat (org-trim (match-string 2)))
8175 (if optionp
8176 (setq beg (point-at-bol) end (point-max))
8177 (org-back-to-heading t)
8178 (setq beg (point) end (org-end-of-subtree t t)))
8179 (put-text-property beg end 'org-category cat)
8180 (goto-char pos)))))))
8182 (defun org-archive-all-done (&optional tag)
8183 "Archive sublevels of the current tree without open TODO items.
8184 If the cursor is not on a headline, try all level 1 trees. If
8185 it is on a headline, try all direct children.
8186 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8188 (rea (concat ".*:" org-archive-tag ":"))
8189 (begm (make-marker))
8190 (endm (make-marker))
8191 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8192 "Move subtree to archive (no open TODO items)? "))
8193 beg end (cntarch 0))
8194 (if (org-on-heading-p)
8195 (progn
8196 (setq re1 (concat "^" (regexp-quote
8197 (make-string
8198 (1+ (- (match-end 0) (match-beginning 0) 1))
8199 ?*))
8200 " "))
8201 (move-marker begm (point))
8202 (move-marker endm (org-end-of-subtree t)))
8203 (setq re1 "^* ")
8204 (move-marker begm (point-min))
8205 (move-marker endm (point-max)))
8206 (save-excursion
8207 (goto-char begm)
8208 (while (re-search-forward re1 endm t)
8209 (setq beg (match-beginning 0)
8210 end (save-excursion (org-end-of-subtree t) (point)))
8211 (goto-char beg)
8212 (if (re-search-forward re end t)
8213 (goto-char end)
8214 (goto-char beg)
8215 (if (and (or (not tag) (not (looking-at rea)))
8216 (y-or-n-p question))
8217 (progn
8218 (if tag
8219 (org-toggle-tag org-archive-tag 'on)
8220 (org-archive-subtree))
8221 (setq cntarch (1+ cntarch)))
8222 (goto-char end)))))
8223 (message "%d trees archived" cntarch)))
8225 (defun org-cycle-hide-drawers (state)
8226 "Re-hide all drawers after a visibility state change."
8227 (when (and (org-mode-p)
8228 (not (memq state '(overview folded))))
8229 (save-excursion
8230 (let* ((globalp (memq state '(contents all)))
8231 (beg (if globalp (point-min) (point)))
8232 (end (if globalp (point-max) (org-end-of-subtree t))))
8233 (goto-char beg)
8234 (while (re-search-forward org-drawer-regexp end t)
8235 (org-flag-drawer t))))))
8237 (defun org-flag-drawer (flag)
8238 (save-excursion
8239 (beginning-of-line 1)
8241 (let ((b (match-end 0))
8242 (outline-regexp org-outline-regexp))
8243 (if (re-search-forward
8245 (save-excursion (outline-next-heading) (point)) t)
8246 (outline-flag-region b (point-at-eol) flag)
8247 (error ":END: line missing"))))))
8249 (defun org-cycle-hide-archived-subtrees (state)
8250 "Re-hide all archived subtrees after a visibility state change."
8251 (when (and (not org-cycle-open-archived-trees)
8252 (not (memq state '(overview folded))))
8253 (save-excursion
8254 (let* ((globalp (memq state '(contents all)))
8255 (beg (if globalp (point-min) (point)))
8256 (end (if globalp (point-max) (org-end-of-subtree t))))
8257 (org-hide-archived-subtrees beg end)
8258 (goto-char beg)
8259 (if (looking-at (concat ".*:" org-archive-tag ":"))
8260 (message "%s" (substitute-command-keys
8261 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8263 (defun org-force-cycle-archived ()
8264 "Cycle subtree even if it is archived."
8265 (interactive)
8266 (setq this-command 'org-cycle)
8267 (let ((org-cycle-open-archived-trees t))
8268 (call-interactively 'org-cycle)))
8270 (defun org-hide-archived-subtrees (beg end)
8271 "Re-hide all archived subtrees after a visibility state change."
8272 (save-excursion
8273 (let* ((re (concat ":" org-archive-tag ":")))
8274 (goto-char beg)
8275 (while (re-search-forward re end t)
8276 (and (org-on-heading-p) (hide-subtree))
8277 (org-end-of-subtree t)))))
8279 (defun org-toggle-tag (tag &optional onoff)
8280 "Toggle the tag TAG for the current line.
8281 If ONOFF is `on' or `off', don't toggle but set to this state."
8282 (unless (org-on-heading-p t) (error "Not on headling"))
8283 (let (res current)
8284 (save-excursion
8285 (beginning-of-line)
8287 (point-at-eol) t)
8288 (progn
8289 (setq current (match-string 1))
8290 (replace-match ""))
8291 (setq current ""))
8292 (setq current (nreverse (org-split-string current ":")))
8293 (cond
8294 ((eq onoff 'on)
8295 (setq res t)
8296 (or (member tag current) (push tag current)))
8297 ((eq onoff 'off)
8298 (or (not (member tag current)) (setq current (delete tag current))))
8299 (t (if (member tag current)
8300 (setq current (delete tag current))
8301 (setq res t)
8302 (push tag current))))
8303 (end-of-line 1)
8304 (if current
8305 (progn
8306 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8307 (org-set-tags nil t))
8308 (delete-horizontal-space))
8309 (run-hooks 'org-after-tags-change-hook))
8310 res))
8312 (defun org-toggle-archive-tag (&optional arg)
8313 "Toggle the archive tag for the current headline.
8314 With prefix ARG, check all children of current headline and offer tagging
8315 the children that do not contain any open TODO items."
8316 (interactive "P")
8317 (if arg
8318 (org-archive-all-done 'tag)
8319 (let (set)
8320 (save-excursion
8321 (org-back-to-heading t)
8322 (setq set (org-toggle-tag org-archive-tag))
8323 (when set (hide-subtree)))
8324 (and set (beginning-of-line 1))
8325 (message "Subtree %s" (if set "archived" "unarchived")))))
8328 ;;;; Tables
8330 ;;; The table editor
8332 ;; Watch out: Here we are talking about two different kind of tables.
8333 ;; Most of the code is for the tables created with the Org-mode table editor.
8334 ;; Sometimes, we talk about tables created and edited with the table.el
8335 ;; Emacs package. We call the former org-type tables, and the latter
8336 ;; table.el-type tables.
8338 (defun org-before-change-function (beg end)
8339 "Every change indicates that a table might need an update."
8340 (setq org-table-may-need-update t))
8343 "Detects an org-type table line.")
8345 "Detects an org-type table line.")
8347 "Detects a table line marked for automatic recalculation.")
8349 "Detects a table line marked for automatic recalculation.")
8351 "Detects a table line marked for automatic recalculation.")
8353 "Detects an org-type table hline.")
8355 "Detects a table-type table hline.")
8357 "Detects an org-type or table-type table.")
8359 "Searching from within a table (any type) this finds the first line
8360 outside the table.")
8362 "Searching from within a table (any type) this finds the first line
8363 outside the table.")
8365 (defvar org-table-last-highlighted-reference nil)
8366 (defvar org-table-formula-history nil)
8368 (defvar org-table-column-names nil
8369 "Alist with column names, derived from the `!' line.")
8370 (defvar org-table-column-name-regexp nil
8371 "Regular expression matching the current column names.")
8372 (defvar org-table-local-parameters nil
8373 "Alist with parameter names, derived from the `$' line.")
8374 (defvar org-table-named-field-locations nil
8375 "Alist with locations of named fields.")
8377 (defvar org-table-current-line-types nil
8378 "Table row types, non-nil only for the duration of a comand.")
8379 (defvar org-table-current-begin-line nil
8380 "Table begin line, non-nil only for the duration of a comand.")
8381 (defvar org-table-current-begin-pos nil
8382 "Table begin position, non-nil only for the duration of a comand.")
8383 (defvar org-table-dlines nil
8384 "Vector of data line line numbers in the current table.")
8385 (defvar org-table-hlines nil
8386 "Vector of hline line numbers in the current table.")
8388 (defconst org-table-range-regexp
8389 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8390 ;; 1 2 3 4 5
8391 "Regular expression for matching ranges in formulas.")
8393 (defconst org-table-range-regexp2
8394 (concat
8398 "Match a range for reference display.")
8400 (defconst org-table-translate-regexp
8402 "Match a reference that needs translation, for reference display.")
8404 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8406 (defun org-table-create-with-table.el ()
8407 "Use the table.el package to insert a new table.
8408 If there is already a table at point, convert between Org-mode tables
8409 and table.el tables."
8410 (interactive)
8411 (require 'table)
8412 (cond
8413 ((org-at-table.el-p)
8414 (if (y-or-n-p "Convert table to Org-mode table? ")
8415 (org-table-convert)))
8416 ((org-at-table-p)
8417 (if (y-or-n-p "Convert table to table.el table? ")
8418 (org-table-convert)))
8419 (t (call-interactively 'table-insert))))
8421 (defun org-table-create-or-convert-from-region (arg)
8422 "Convert region to table, or create an empty table.
8423 If there is an active region, convert it to a table, using the function
8424 `org-table-convert-region'. See the documentation of that function
8425 to learn how the prefix argument is interpreted to determine the field
8426 separator.
8427 If there is no such region, create an empty table with `org-table-create'."
8428 (interactive "P")
8429 (if (org-region-active-p)
8430 (org-table-convert-region (region-beginning) (region-end) arg)
8431 (org-table-create arg)))
8433 (defun org-table-create (&optional size)
8434 "Query for a size and insert a table skeleton.
8436 (interactive "P")
8437 (unless size
8438 (setq size (read-string
8439 (concat "Table size Columns x Rows [e.g. "
8440 org-table-default-size "]: ")
8441 "" nil org-table-default-size)))
8443 (let* ((pos (point))
8444 (indent (make-string (current-column) ?\ ))
8445 (split (org-split-string size " *x *"))
8446 (rows (string-to-number (nth 1 split)))
8447 (columns (string-to-number (car split)))
8448 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8451 (point-at-bol) (point)))
8452 (beginning-of-line 1)
8453 (newline))
8454 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8455 (dotimes (i rows) (insert line))
8456 (goto-char pos)
8457 (if (> rows 1)
8458 ;; Insert a hline after the first row.
8459 (progn
8460 (end-of-line 1)
8462 (goto-char pos)))
8463 (org-table-align)))
8465 (defun org-table-convert-region (beg0 end0 &optional separator)
8466 "Convert region to a table.
8467 The region goes from BEG0 to END0, but these borders will be moved
8468 slightly, to make sure a beginning of line in the first line is included.
8470 SEPARATOR specifies the field separator in the lines. It can have the
8471 following values:
8473 '(4) Use the comma as a field separator
8474 '(16) Use a TAB as field separator
8475 integer When a number, use that many spaces as field separator
8476 nil When nil, the command tries to be smart and figure out the
8477 separator in the following way:
8478 - when each line contains a TAB, assume TAB-separated material
8479 - when each line contains a comme, assume CSV material
8480 - else, assume one or more SPACE charcters as separator."
8481 (interactive "rP")
8482 (let* ((beg (min beg0 end0))
8483 (end (max beg0 end0))
8484 re)
8485 (goto-char beg)
8486 (beginning-of-line 1)
8487 (setq beg (move-marker (make-marker) (point)))
8488 (goto-char end)
8489 (if (bolp) (backward-char 1) (end-of-line 1))
8490 (setq end (move-marker (make-marker) (point)))
8491 ;; Get the right field separator
8492 (unless separator
8493 (goto-char beg)
8494 (setq separator
8495 (cond
8498 (t 1))))
8499 (setq re (cond
8502 ((integerp separator)
8504 (t (error "This should not happen"))))
8505 (goto-char beg)
8506 (while (re-search-forward re end t)
8507 (replace-match "| " t t))
8508 (goto-char beg)
8509 (insert " ")
8510 (org-table-align)))
8512 (defun org-table-import (file arg)
8513 "Import FILE as a table.
8514 The file is assumed to be tab-separated. Such files can be produced by most
8515 spreadsheet and database applications. If no tabs (at least one per line)
8516 are found, lines will be split on whitespace into fields."
8518 (or (bolp) (newline))
8519 (let ((beg (point))
8520 (pm (point-max)))
8521 (insert-file-contents file)
8522 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8524 (defun org-table-export ()
8525 "Export table as a tab-separated file.
8526 Such a file can be imported into a spreadsheet program like Excel."
8527 (interactive)
8528 (let* ((beg (org-table-begin))
8529 (end (org-table-end))
8530 (table (buffer-substring beg end))
8531 (file (read-file-name "Export table to: "))
8532 buf)
8533 (unless (or (not (file-exists-p file))
8534 (y-or-n-p (format "Overwrite file %s? " file)))
8535 (error "Abort"))
8536 (with-current-buffer (find-file-noselect file)
8537 (setq buf (current-buffer))
8538 (erase-buffer)
8539 (fundamental-mode)
8540 (insert table)
8541 (goto-char (point-min))
8543 (replace-match "" t t)
8544 (end-of-line 1))
8545 (goto-char (point-min))
8547 (replace-match "" t t)
8548 (goto-char (min (1+ (point)) (point-max))))
8549 (goto-char (point-min))
8550 (while (re-search-forward "^-[-+]*$" nil t)
8551 (replace-match "")
8553 (delete-char 1)))
8554 (goto-char (point-min))
8557 (save-buffer))
8558 (kill-buffer buf)))
8560 (defvar org-table-aligned-begin-marker (make-marker)
8561 "Marker at the beginning of the table last aligned.
8562 Used to check if cursor still is in that table, to minimize realignment.")
8563 (defvar org-table-aligned-end-marker (make-marker)
8564 "Marker at the end of the table last aligned.
8565 Used to check if cursor still is in that table, to minimize realignment.")
8566 (defvar org-table-last-alignment nil
8567 "List of flags for flushright alignment, from the last re-alignment.
8568 This is being used to correctly align a single field after TAB or RET.")
8569 (defvar org-table-last-column-widths nil
8570 "List of max width of fields in each column.
8571 This is being used to correctly align a single field after TAB or RET.")
8572 (defvar org-table-overlay-coordinates nil
8573 "Overlay coordinates after each align of a table.")
8574 (make-variable-buffer-local 'org-table-overlay-coordinates)
8576 (defvar org-last-recalc-line nil)
8577 (defconst org-narrow-column-arrow "=>"
8578 "Used as display property in narrowed table columns.")
8580 (defun org-table-align ()
8581 "Align the table at point by aligning all vertical bars."
8582 (interactive)
8583 (let* (
8584 ;; Limits of table
8585 (beg (org-table-begin))
8586 (end (org-table-end))
8587 ;; Current cursor position
8588 (linepos (org-current-line))
8589 (colpos (org-table-current-column))
8590 (winstart (window-start))
8591 (winstartline (org-current-line (min winstart (1- (point-max)))))
8592 lines (new "") lengths l typenums ty fields maxfields i
8593 column
8594 (indent "") cnt frac
8595 rfmt hfmt
8596 (spaces '(1 . 1))
8597 (sp1 (car spaces))
8598 (sp2 (cdr spaces))
8599 (rfmt1 (concat
8600 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8601 (hfmt1 (concat
8602 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8603 emptystrings links dates emph narrow fmax f1 len c e)
8604 (untabify beg end)
8605 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8606 ;; Check if we have links or dates
8607 (goto-char beg)
8608 (setq links (re-search-forward org-bracket-link-regexp end t))
8609 (goto-char beg)
8610 (setq emph (and org-hide-emphasis-markers
8611 (re-search-forward org-emph-re end t)))
8612 (goto-char beg)
8613 (setq dates (and org-display-custom-times
8614 (re-search-forward org-ts-regexp-both end t)))
8615 ;; Make sure the link properties are right
8616 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8617 ;; Make sure the date properties are right
8618 (when dates (goto-char beg) (while (org-activate-dates end)))
8619 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8621 ;; Check if we are narrowing any columns
8622 (goto-char beg)
8623 (setq narrow (and org-format-transports-properties-p
8624 (re-search-forward "<[0-9]+>" end t)))
8625 ;; Get the rows
8626 (setq lines (org-split-string
8628 ;; Store the indentation of the first line
8629 (if (string-match "^ *" (car lines))
8630 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8631 ;; Mark the hlines by setting the corresponding element to nil
8632 ;; At the same time, we remove trailing space.
8633 (setq lines (mapcar (lambda (l)
8634 (if (string-match "^ *|-" l)
8635 nil
8637 (substring l 0 (match-beginning 0))
8638 l)))
8639 lines))
8640 ;; Get the data fields by splitting the lines.
8641 (setq fields (mapcar
8642 (lambda (l)
8643 (org-split-string l " *| *"))
8644 (delq nil (copy-sequence lines))))
8645 ;; How many fields in the longest line?
8646 (condition-case nil
8647 (setq maxfields (apply 'max (mapcar 'length fields)))
8648 (error
8649 (kill-region beg end)
8650 (org-table-create org-table-default-size)
8651 (error "Empty table - created default table")))
8652 ;; A list of empty strings to fill any short rows on output
8653 (setq emptystrings (make-list maxfields ""))
8654 ;; Check for special formatting.
8655 (setq i -1)
8656 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8657 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8658 ;; Check if there is an explicit width specified
8659 (when narrow
8660 (setq c column fmax nil)
8661 (while c
8662 (setq e (pop c))
8664 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8665 ;; Find fields that are wider than fmax, and shorten them
8666 (when fmax
8667 (loop for xx in column do
8668 (when (and (stringp xx)
8669 (> (org-string-width xx) fmax))
8670 (org-add-props xx nil
8671 'help-echo
8672 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8673 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8674 (unless (> f1 1)
8676 (match-string 0 xx)))
8677 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8678 (add-text-properties (- f1 2) f1
8679 (list 'display org-narrow-column-arrow)
8680 xx)))))
8681 ;; Get the maximum width for each column
8682 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8683 ;; Get the fraction of numbers, to decide about alignment of the column
8684 (setq cnt 0 frac 0.0)
8685 (loop for x in column do
8686 (if (equal x "")
8687 nil
8688 (setq frac ( / (+ (* frac cnt)
8689 (if (string-match org-table-number-regexp x) 1 0))
8690 (setq cnt (1+ cnt))))))
8691 (push (>= frac org-table-number-fraction) typenums))
8692 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8694 ;; Store the alignment of this table, for later editing of single fields
8695 (setq org-table-last-alignment typenums
8696 org-table-last-column-widths lengths)
8698 ;; With invisible characters, `format' does not get the field width right
8699 ;; So we need to make these fields wide by hand.
8700 (when (or links emph)
8701 (loop for i from 0 upto (1- maxfields) do
8702 (setq len (nth i lengths))
8703 (loop for j from 0 upto (1- (length fields)) do
8704 (setq c (nthcdr i (car (nthcdr j fields))))
8705 (if (and (stringp (car c))
8706 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8707 ; (string-match org-bracket-link-regexp (car c))
8708 (< (org-string-width (car c)) len))
8709 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8711 ;; Compute the formats needed for output of the table
8712 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8713 (while (setq l (pop lengths))
8714 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8715 (setq rfmt (concat rfmt (format rfmt1 ty l))
8716 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8720 (setq new (mapconcat
8721 (lambda (l)
8722 (if l (apply 'format rfmt
8723 (append (pop fields) emptystrings))
8724 hfmt))
8725 lines ""))
8726 ;; Replace the old one
8727 (delete-region beg end)
8728 (move-marker end nil)
8729 (move-marker org-table-aligned-begin-marker (point))
8730 (insert new)
8731 (move-marker org-table-aligned-end-marker (point))
8732 (when (and orgtbl-mode (not (org-mode-p)))
8733 (goto-char org-table-aligned-begin-marker)
8734 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8735 ;; Try to move to the old location
8736 (goto-line winstartline)
8737 (setq winstart (point-at-bol))
8738 (goto-line linepos)
8739 (set-window-start (selected-window) winstart 'noforce)
8740 (org-table-goto-column colpos)
8741 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8742 (setq org-table-may-need-update nil)
8743 ))
8745 (defun org-string-width (s)
8746 "Compute width of string, ignoring invisible characters.
8747 This ignores character with invisibility property `org-link', and also
8748 characters with property `org-cwidth', because these will become invisible
8749 upon the next fontification round."
8750 (let (b l)
8751 (when (or (eq t buffer-invisibility-spec)
8752 (assq 'org-link buffer-invisibility-spec))
8753 (while (setq b (text-property-any 0 (length s)
8754 'invisible 'org-link s))
8755 (setq s (concat (substring s 0 b)
8756 (substring s (or (next-single-property-change
8757 b 'invisible s) (length s)))))))
8758 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8759 (setq s (concat (substring s 0 b)
8760 (substring s (or (next-single-property-change
8761 b 'org-cwidth s) (length s))))))
8762 (setq l (string-width s) b -1)
8763 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8764 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8765 l))
8767 (defun org-table-begin (&optional table-type)
8768 "Find the beginning of the table and return its position.
8769 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8770 (save-excursion
8771 (if (not (re-search-backward
8772 (if table-type org-table-any-border-regexp
8773 org-table-border-regexp)
8774 nil t))
8775 (progn (goto-char (point-min)) (point))
8776 (goto-char (match-beginning 0))
8777 (beginning-of-line 2)
8778 (point))))
8780 (defun org-table-end (&optional table-type)
8781 "Find the end of the table and return its position.
8782 With argument TABLE-TYPE, go to the end of a table.el-type table."
8783 (save-excursion
8784 (if (not (re-search-forward
8785 (if table-type org-table-any-border-regexp
8786 org-table-border-regexp)
8787 nil t))
8788 (goto-char (point-max))
8789 (goto-char (match-beginning 0)))
8790 (point-marker)))
8792 (defun org-table-justify-field-maybe (&optional new)
8793 "Justify the current field, text to left, number to right.
8794 Optional argument NEW may specify text to replace the current field content."
8795 (cond
8796 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8797 ((org-at-table-hline-p))
8798 ((and (not new)
8799 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8800 (current-buffer)))
8801 (< (point) org-table-aligned-begin-marker)
8802 (>= (point) org-table-aligned-end-marker)))
8803 ;; This is not the same table, force a full re-align
8804 (setq org-table-may-need-update t))
8805 (t ;; realign the current field, based on previous full realign
8806 (let* ((pos (point)) s
8807 (col (org-table-current-column))
8808 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8809 l f n o e)
8810 (when (> col 0)
8813 (progn
8814 (setq s (match-string 1)
8815 o (match-string 0)
8816 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8817 e (not (= (match-beginning 2) (match-end 2))))
8818 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8819 l (if e "|" (setq org-table-may-need-update t) ""))
8820 n (format f s))
8821 (if new
8822 (if (<= (length new) l) ;; FIXME: length -> str-width?
8823 (setq n (format f new))
8824 (setq n (concat new "|") org-table-may-need-update t)))
8825 (or (equal n o)
8826 (let (org-table-may-need-update)
8827 (replace-match n t t))))
8828 (setq org-table-may-need-update t))
8829 (goto-char pos))))))
8831 (defun org-table-next-field ()
8832 "Go to the next field in the current table, creating new lines as needed.
8833 Before doing so, re-align the table if necessary."
8834 (interactive)
8835 (org-table-maybe-eval-formula)
8836 (org-table-maybe-recalculate-line)
8837 (if (and org-table-automatic-realign
8838 org-table-may-need-update)
8839 (org-table-align))
8840 (let ((end (org-table-end)))
8841 (if (org-at-table-hline-p)
8842 (end-of-line 1))
8843 (condition-case nil
8844 (progn
8845 (re-search-forward "|" end)
8847 (re-search-forward "|" end))
8848 (if (and (looking-at "-")
8849 org-table-tab-jumps-over-hlines
8851 (goto-char (match-beginning 1)))
8852 (if (looking-at "-")
8853 (progn
8854 (beginning-of-line 0)
8855 (org-table-insert-row 'below))
8856 (if (looking-at " ") (forward-char 1))))
8857 (error
8858 (org-table-insert-row 'below)))))
8860 (defun org-table-previous-field ()
8861 "Go to the previous field in the table.
8862 Before doing so, re-align the table if necessary."
8863 (interactive)
8864 (org-table-justify-field-maybe)
8865 (org-table-maybe-recalculate-line)
8866 (if (and org-table-automatic-realign
8867 org-table-may-need-update)
8868 (org-table-align))
8869 (if (org-at-table-hline-p)
8870 (end-of-line 1))
8871 (re-search-backward "|" (org-table-begin))
8872 (re-search-backward "|" (org-table-begin))
8874 (re-search-backward "|" (org-table-begin)))
8875 (if (looking-at "| ?")
8876 (goto-char (match-end 0))))
8878 (defun org-table-next-row ()
8879 "Go to the next row (same column) in the current table.
8880 Before doing so, re-align the table if necessary."
8881 (interactive)
8882 (org-table-maybe-eval-formula)
8883 (org-table-maybe-recalculate-line)
8886 (newline)
8887 (if (and org-table-automatic-realign
8888 org-table-may-need-update)
8889 (org-table-align))
8890 (let ((col (org-table-current-column)))
8891 (beginning-of-line 2)
8892 (if (or (not (org-at-table-p))
8893 (org-at-table-hline-p))
8894 (progn
8895 (beginning-of-line 0)
8896 (org-table-insert-row 'below)))
8897 (org-table-goto-column col)
8899 (if (looking-at " ") (forward-char 1)))))
8901 (defun org-table-copy-down (n)
8902 "Copy a field down in the current column.
8903 If the field at the cursor is empty, copy into it the content of the nearest
8904 non-empty field above. With argument N, use the Nth non-empty field.
8905 If the current field is not empty, it is copied down to the next row, and
8906 the cursor is moved with it. Therefore, repeating this command causes the
8907 column to be filled row-by-row.
8908 If the variable `org-table-copy-increment' is non-nil and the field is an
8909 integer or a timestamp, it will be incremented while copying. In the case of
8910 a timestamp, if the cursor is on the year, change the year. If it is on the
8911 month or the day, change that. Point will stay on the current date field
8912 in order to easily repeat the interval."
8913 (interactive "p")
8914 (let* ((colpos (org-table-current-column))
8915 (col (current-column))
8916 (field (org-table-get-field))
8918 (beg (org-table-begin))
8919 txt)
8920 (org-table-check-inside-data-field)
8921 (if non-empty
8922 (progn
8923 (setq txt (org-trim field))
8924 (org-table-next-row)
8925 (org-table-blank-field))
8926 (save-excursion
8927 (setq txt
8928 (catch 'exit
8929 (while (progn (beginning-of-line 1)
8930 (re-search-backward org-table-dataline-regexp
8931 beg t))
8932 (org-table-goto-column colpos t)
8933 (if (and (looking-at
8935 (= (setq n (1- n)) 0))
8936 (throw 'exit (match-string 1))))))))
8937 (if txt
8938 (progn
8939 (if (and org-table-copy-increment
8940 (string-match "^[0-9]+$" txt))
8941 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8942 (insert txt)
8943 (move-to-column col)
8944 (if (and org-table-copy-increment (org-at-timestamp-p t))
8945 (org-timestamp-up 1)
8946 (org-table-maybe-recalculate-line))
8947 (org-table-align)
8948 (move-to-column col))
8949 (error "No non-empty field found"))))
8951 (defun org-table-check-inside-data-field ()
8952 "Is point inside a table data field?
8953 I.e. not on a hline or before the first or after the last column?
8954 This actually throws an error, so it aborts the current command."
8955 (if (or (not (org-at-table-p))
8956 (= (org-table-current-column) 0)
8957 (org-at-table-hline-p)
8959 (error "Not in table data field")))
8961 (defvar org-table-clip nil
8962 "Clipboard for table regions.")
8964 (defun org-table-blank-field ()
8965 "Blank the current table field or active region."
8966 (interactive)
8967 (org-table-check-inside-data-field)
8968 (if (and (interactive-p) (org-region-active-p))
8969 (let (org-table-clip)
8970 (org-table-cut-region (region-beginning) (region-end)))
8971 (skip-chars-backward "^|")
8972 (backward-char 1)
8974 (let* ((pos (match-beginning 0))
8975 (match (match-string 0))
8976 (len (org-string-width match)))
8977 (replace-match (concat "|" (make-string (1- len) ?\ )))
8978 (goto-char (+ 2 pos))
8979 (substring match 1)))))
8981 (defun org-table-get-field (&optional n replace)
8982 "Return the value of the field in column N of current row.
8983 N defaults to current field.
8984 If REPLACE is a string, replace field with this value. The return value
8985 is always the old value."
8986 (and n (org-table-goto-column n))
8988 (backward-char 1)
8990 (let* ((pos (match-beginning 0))
8991 (val (buffer-substring (1+ pos) (match-end 0))))
8992 (if replace
8993 (replace-match (concat "|" replace) t t))
8994 (goto-char (min (point-at-eol) (+ 2 pos)))
8995 val)
8996 (forward-char 1) ""))
8998 (defun org-table-field-info (arg)
8999 "Show info about the current field, and highlight any reference at point."
9000 (interactive "P")
9001 (org-table-get-specials)
9002 (save-excursion
9003 (let* ((pos (point))
9004 (col (org-table-current-column))
9005 (cname (car (rassoc (int-to-string col) org-table-column-names)))
9006 (name (car (rassoc (list (org-current-line) col)
9007 org-table-named-field-locations)))
9008 (eql (org-table-get-stored-formulas))
9009 (dline (org-table-current-dline))
9010 (ref (format "@%d$%d" dline col))
9011 (ref1 (org-table-convert-refs-to-an ref))
9012 (fequation (or (assoc name eql) (assoc ref eql)))
9013 (cequation (assoc (int-to-string col) eql))
9014 (eqn (or fequation cequation)))
9015 (goto-char pos)
9016 (condition-case nil
9017 (org-table-show-reference 'local)
9018 (error nil))
9019 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
9020 dline col
9021 (if cname (concat " or $" cname) "")
9022 dline col ref1
9023 (if name (concat " or $" name) "")
9024 ;; FIXME: formula info not correct if special table line
9025 (if eqn
9026 (concat ", formula: "
9027 (org-table-formula-to-user
9028 (concat
9029 (if (string-match "^[$@]"(car eqn)) "" "$")
9030 (car eqn) "=" (cdr eqn))))
9031 "")))))
9033 (defun org-table-current-column ()
9034 "Find out which column we are in.
9035 When called interactively, column is also displayed in echo area."
9036 (interactive)
9037 (if (interactive-p) (org-table-check-inside-data-field))
9038 (save-excursion
9039 (let ((cnt 0) (pos (point)))
9040 (beginning-of-line 1)
9041 (while (search-forward "|" pos t)
9042 (setq cnt (1+ cnt)))
9043 (if (interactive-p) (message "This is table column %d" cnt))
9044 cnt)))
9046 (defun org-table-current-dline ()
9047 "Find out what table data line we are in.
9048 Only datalins count for this."
9049 (interactive)
9050 (if (interactive-p) (org-table-check-inside-data-field))
9051 (save-excursion
9052 (let ((cnt 0) (pos (point)))
9053 (goto-char (org-table-begin))
9054 (while (<= (point) pos)
9055 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
9056 (beginning-of-line 2))
9057 (if (interactive-p) (message "This is table line %d" cnt))
9058 cnt)))
9060 (defun org-table-goto-column (n &optional on-delim force)
9061 "Move the cursor to the Nth column in the current table line.
9062 With optional argument ON-DELIM, stop with point before the left delimiter
9063 of the field.
9064 If there are less than N fields, just go to after the last delimiter.
9065 However, when FORCE is non-nil, create new columns if necessary."
9066 (interactive "p")
9067 (let ((pos (point-at-eol)))
9068 (beginning-of-line 1)
9069 (when (> n 0)
9070 (while (and (> (setq n (1- n)) -1)
9071 (or (search-forward "|" pos t)
9072 (and force
9073 (progn (end-of-line 1)
9074 (skip-chars-backward "^|")
9075 (insert " | "))))))
9076 ; (backward-char 2) t)))))
9077 (when (and force (not (looking-at ".*|")))
9078 (save-excursion (end-of-line 1) (insert " | ")))
9079 (if on-delim
9080 (backward-char 1)
9081 (if (looking-at " ") (forward-char 1))))))
9083 (defun org-at-table-p (&optional table-type)
9084 "Return t if the cursor is inside an org-type table.
9085 If TABLE-TYPE is non-nil, also check for table.el-type tables."
9086 (if org-enable-table-editor
9087 (save-excursion
9088 (beginning-of-line 1)
9089 (looking-at (if table-type org-table-any-line-regexp
9090 org-table-line-regexp)))
9091 nil))
9093 (defun org-at-table.el-p ()
9094 "Return t if and only if we are at a table.el table."
9095 (and (org-at-table-p 'any)
9096 (save-excursion
9097 (goto-char (org-table-begin 'any))
9098 (looking-at org-table1-hline-regexp))))
9100 (defun org-table-recognize-table.el ()
9101 "If there is a table.el table nearby, recognize it and move into it."
9102 (if org-table-tab-recognizes-table.el
9103 (if (org-at-table.el-p)
9104 (progn
9105 (beginning-of-line 1)
9106 (if (looking-at org-table-dataline-regexp)
9107 nil
9108 (if (looking-at org-table1-hline-regexp)
9109 (progn
9110 (beginning-of-line 2)
9111 (if (looking-at org-table-any-border-regexp)
9112 (beginning-of-line -1)))))
9113 (if (re-search-forward "|" (org-table-end t) t)
9114 (progn
9115 (require 'table)
9116 (if (table--at-cell-p (point))
9117 t
9118 (message "recognizing table.el table...")
9119 (table-recognize-table)
9120 (message "recognizing table.el table...done")))
9121 (error "This should not happen..."))
9122 t)
9123 nil)
9124 nil))
9126 (defun org-at-table-hline-p ()
9127 "Return t if the cursor is inside a hline in a table."
9128 (if org-enable-table-editor
9129 (save-excursion
9130 (beginning-of-line 1)
9131 (looking-at org-table-hline-regexp))
9132 nil))
9134 (defun org-table-insert-column ()
9135 "Insert a new column into the table."
9136 (interactive)
9137 (if (not (org-at-table-p))
9138 (error "Not at a table"))
9139 (org-table-find-dataline)
9140 (let* ((col (max 1 (org-table-current-column)))
9141 (beg (org-table-begin))
9142 (end (org-table-end))
9143 ;; Current cursor position
9144 (linepos (org-current-line))
9145 (colpos col))
9146 (goto-char beg)
9147 (while (< (point) end)
9148 (if (org-at-table-hline-p)
9149 nil
9150 (org-table-goto-column col t)
9151 (insert "| "))
9152 (beginning-of-line 2))
9153 (move-marker end nil)
9154 (goto-line linepos)
9155 (org-table-goto-column colpos)
9156 (org-table-align)
9157 (org-table-fix-formulas "$" nil (1- col) 1)))
9159 (defun org-table-find-dataline ()
9160 "Find a dataline in the current table, which is needed for column commands."
9161 (if (and (org-at-table-p)
9162 (not (org-at-table-hline-p)))
9163 t
9164 (let ((col (current-column))
9165 (end (org-table-end)))
9166 (move-to-column col)
9167 (while (and (< (point) end)
9168 (or (not (= (current-column) col))
9169 (org-at-table-hline-p)))
9170 (beginning-of-line 2)
9171 (move-to-column col))
9172 (if (and (org-at-table-p)
9173 (not (org-at-table-hline-p)))
9174 t
9175 (error
9176 "Please position cursor in a data line for column operations")))))
9178 (defun org-table-delete-column ()
9179 "Delete a column from the table."
9180 (interactive)
9181 (if (not (org-at-table-p))
9182 (error "Not at a table"))
9183 (org-table-find-dataline)
9184 (org-table-check-inside-data-field)
9185 (let* ((col (org-table-current-column))
9186 (beg (org-table-begin))
9187 (end (org-table-end))
9188 ;; Current cursor position
9189 (linepos (org-current-line))
9190 (colpos col))
9191 (goto-char beg)
9192 (while (< (point) end)
9193 (if (org-at-table-hline-p)
9194 nil
9195 (org-table-goto-column col t)
9197 (replace-match "|")))
9198 (beginning-of-line 2))
9199 (move-marker end nil)
9200 (goto-line linepos)
9201 (org-table-goto-column colpos)
9202 (org-table-align)
9203 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9204 col -1 col)))
9206 (defun org-table-move-column-right ()
9207 "Move column to the right."
9208 (interactive)
9209 (org-table-move-column nil))
9210 (defun org-table-move-column-left ()
9211 "Move column to the left."
9212 (interactive)
9213 (org-table-move-column 'left))
9215 (defun org-table-move-column (&optional left)
9216 "Move the current column to the right. With arg LEFT, move to the left."
9217 (interactive "P")
9218 (if (not (org-at-table-p))
9219 (error "Not at a table"))
9220 (org-table-find-dataline)
9221 (org-table-check-inside-data-field)
9222 (let* ((col (org-table-current-column))
9223 (col1 (if left (1- col) col))
9224 (beg (org-table-begin))
9225 (end (org-table-end))
9226 ;; Current cursor position
9227 (linepos (org-current-line))
9228 (colpos (if left (1- col) (1+ col))))
9229 (if (and left (= col 1))
9230 (error "Cannot move column further left"))
9232 (error "Cannot move column further right"))
9233 (goto-char beg)
9234 (while (< (point) end)
9235 (if (org-at-table-hline-p)
9236 nil
9237 (org-table-goto-column col1 t)
9240 (beginning-of-line 2))
9241 (move-marker end nil)
9242 (goto-line linepos)
9243 (org-table-goto-column colpos)
9244 (org-table-align)
9245 (org-table-fix-formulas
9246 "$" (list (cons (number-to-string col) (number-to-string colpos))
9247 (cons (number-to-string colpos) (number-to-string col))))))
9249 (defun org-table-move-row-down ()
9250 "Move table row down."
9251 (interactive)
9252 (org-table-move-row nil))
9253 (defun org-table-move-row-up ()
9254 "Move table row up."
9255 (interactive)
9256 (org-table-move-row 'up))
9258 (defun org-table-move-row (&optional up)
9259 "Move the current table line down. With arg UP, move it up."
9260 (interactive "P")
9261 (let* ((col (current-column))
9262 (pos (point))
9263 (hline1p (save-excursion (beginning-of-line 1)
9264 (looking-at org-table-hline-regexp)))
9265 (dline1 (org-table-current-dline))
9266 (dline2 (+ dline1 (if up -1 1)))
9267 (tonew (if up 0 2))
9268 txt hline2p)
9269 (beginning-of-line tonew)
9270 (unless (org-at-table-p)
9271 (goto-char pos)
9272 (error "Cannot move row further"))
9273 (setq hline2p (looking-at org-table-hline-regexp))
9274 (goto-char pos)
9275 (beginning-of-line 1)
9276 (setq pos (point))
9277 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9278 (delete-region (point) (1+ (point-at-eol)))
9279 (beginning-of-line tonew)
9280 (insert txt)
9281 (beginning-of-line 0)
9282 (move-to-column col)
9283 (unless (or hline1p hline2p)
9284 (org-table-fix-formulas
9285 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9286 (cons (number-to-string dline2) (number-to-string dline1)))))))
9288 (defun org-table-insert-row (&optional arg)
9289 "Insert a new row above the current line into the table.
9290 With prefix ARG, insert below the current line."
9291 (interactive "P")
9292 (if (not (org-at-table-p))
9293 (error "Not at a table"))
9294 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9295 (new (org-table-clean-line line)))
9296 ;; Fix the first field if necessary
9298 (setq new (replace-match (match-string 0 line) t t new)))
9299 (beginning-of-line (if arg 2 1))
9301 (beginning-of-line 0)
9302 (re-search-forward "| ?" (point-at-eol) t)
9303 (and (or org-table-may-need-update org-table-overlay-coordinates)
9304 (org-table-align))
9305 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9307 (defun org-table-insert-hline (&optional above)
9308 "Insert a horizontal-line below the current line into the table.
9309 With prefix ABOVE, insert above the current line."
9310 (interactive "P")
9311 (if (not (org-at-table-p))
9312 (error "Not at a table"))
9313 (let ((line (org-table-clean-line
9314 (buffer-substring (point-at-bol) (point-at-eol))))
9315 (col (current-column)))
9317 (setq line (replace-match
9318 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9319 ?-) "|") t t line)))
9321 (beginning-of-line (if above 1 2))
9323 (beginning-of-line (if above 1 -1))
9324 (move-to-column col)
9325 (and org-table-overlay-coordinates (org-table-align))))
9327 (defun org-table-hline-and-move (&optional same-column)
9328 "Insert a hline and move to the row below that line."
9329 (interactive "P")
9330 (let ((col (org-table-current-column)))
9331 (org-table-maybe-eval-formula)
9332 (org-table-maybe-recalculate-line)
9333 (org-table-insert-hline)
9334 (end-of-line 2)
9337 (org-table-next-field))
9338 (if same-column (org-table-goto-column col))))
9340 (defun org-table-clean-line (s)
9342 In particular, this does handle wide and invisible characters."
9344 ;; It's a hline, just map the characters
9345 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9347 (setq s (replace-match
9348 (concat "|" (make-string (org-string-width (match-string 1 s))
9349 ?\ ) "|")
9350 t t s)))
9351 s))
9353 (defun org-table-kill-row ()
9354 "Delete the current row or horizontal line from the table."
9355 (interactive)
9356 (if (not (org-at-table-p))
9357 (error "Not at a table"))
9358 (let ((col (current-column))
9359 (dline (org-table-current-dline)))
9360 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9361 (if (not (org-at-table-p)) (beginning-of-line 0))
9362 (move-to-column col)
9363 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9364 dline -1 dline)))
9366 (defun org-table-sort-lines (with-case &optional sorting-type)
9367 "Sort table lines according to the column at point.
9369 The position of point indicates the column to be used for
9370 sorting, and the range of lines is the range between the nearest
9371 horizontal separator lines, or the entire table of no such lines
9372 exist. If point is before the first column, you will be prompted
9373 for the sorting column. If there is an active region, the mark
9374 specifies the first line and the sorting column, while point
9375 should be in the last line to be included into the sorting.
9377 The command then prompts for the sorting type which can be
9378 alphabetically, numerically, or by time (as given in a time stamp
9379 in the field). Sorting in reverse order is also possible.
9381 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9383 If SORTING-TYPE is specified when this function is called from a Lisp
9384 program, no prompting will take place. SORTING-TYPE must be a character,
9385 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9386 should be done in reverse order."
9387 (interactive "P")
9388 (let* ((thisline (org-current-line))
9389 (thiscol (org-table-current-column))
9390 beg end bcol ecol tend tbeg column lns pos)
9391 (when (equal thiscol 0)
9392 (if (interactive-p)
9393 (setq thiscol
9394 (string-to-number
9395 (read-string "Use column N for sorting: ")))
9396 (setq thiscol 1))
9397 (org-table-goto-column thiscol))
9398 (org-table-check-inside-data-field)
9399 (if (org-region-active-p)
9400 (progn
9401 (setq beg (region-beginning) end (region-end))
9402 (goto-char beg)
9403 (setq column (org-table-current-column)
9404 beg (point-at-bol))
9405 (goto-char end)
9406 (setq end (point-at-bol 2)))
9407 (setq column (org-table-current-column)
9408 pos (point)
9409 tbeg (org-table-begin)
9410 tend (org-table-end))
9411 (if (re-search-backward org-table-hline-regexp tbeg t)
9412 (setq beg (point-at-bol 2))
9413 (goto-char tbeg)
9414 (setq beg (point-at-bol 1)))
9415 (goto-char pos)
9416 (if (re-search-forward org-table-hline-regexp tend t)
9417 (setq end (point-at-bol 1))
9418 (goto-char tend)
9419 (setq end (point-at-bol))))
9420 (setq beg (move-marker (make-marker) beg)
9421 end (move-marker (make-marker) end))
9422 (untabify beg end)
9423 (goto-char beg)
9424 (org-table-goto-column column)
9425 (skip-chars-backward "^|")
9426 (setq bcol (current-column))
9427 (org-table-goto-column (1+ column))
9428 (skip-chars-backward "^|")
9429 (setq ecol (1- (current-column)))
9430 (org-table-goto-column column)
9431 (setq lns (mapcar (lambda(x) (cons
9432 (org-sort-remove-invisible
9433 (nth (1- column)
9435 x))
9437 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9438 (delete-region beg end)
9439 (move-marker beg nil)
9440 (move-marker end nil)
9442 (goto-line thisline)
9443 (org-table-goto-column thiscol)
9444 (message "%d lines sorted, based on column %d" (length lns) column)))
9446 ;; FIXME: maybe we will not need this? Table sorting is broken....
9447 (defun org-sort-remove-invisible (s)
9448 (remove-text-properties 0 (length s) org-rm-props s)
9449 (while (string-match org-bracket-link-regexp s)
9450 (setq s (replace-match (if (match-end 2)
9451 (match-string 3 s)
9452 (match-string 1 s)) t t s)))
9453 s)
9455 (defun org-table-cut-region (beg end)
9456 "Copy region in table to the clipboard and blank all relevant fields."
9457 (interactive "r")
9458 (org-table-copy-region beg end 'cut))
9460 (defun org-table-copy-region (beg end &optional cut)
9461 "Copy rectangular region in table to clipboard.
9462 A special clipboard is used which can only be accessed
9463 with `org-table-paste-rectangle'."
9464 (interactive "rP")
9465 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9466 region cols
9467 (rpl (if cut " " nil)))
9468 (goto-char beg)
9469 (org-table-check-inside-data-field)
9470 (setq l01 (org-current-line)
9471 c01 (org-table-current-column))
9472 (goto-char end)
9473 (org-table-check-inside-data-field)
9474 (setq l02 (org-current-line)
9475 c02 (org-table-current-column))
9476 (setq l1 (min l01 l02) l2 (max l01 l02)
9477 c1 (min c01 c02) c2 (max c01 c02))
9478 (catch 'exit
9479 (while t
9480 (catch 'nextline
9481 (if (> l1 l2) (throw 'exit t))
9482 (goto-line l1)
9483 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9484 (setq cols nil ic1 c1 ic2 c2)
9485 (while (< ic1 (1+ ic2))
9486 (push (org-table-get-field ic1 rpl) cols)
9487 (setq ic1 (1+ ic1)))
9488 (push (nreverse cols) region)
9489 (setq l1 (1+ l1)))))
9490 (setq org-table-clip (nreverse region))
9491 (if cut (org-table-align))
9492 org-table-clip))
9494 (defun org-table-paste-rectangle ()
9495 "Paste a rectangular region into a table.
9496 The upper right corner ends up in the current field. All involved fields
9497 will be overwritten. If the rectangle does not fit into the present table,
9498 the table is enlarged as needed. The process ignores horizontal separator
9499 lines."
9500 (interactive)
9501 (unless (and org-table-clip (listp org-table-clip))
9502 (error "First cut/copy a region to paste!"))
9503 (org-table-check-inside-data-field)
9504 (let* ((clip org-table-clip)
9505 (line (org-current-line))
9506 (col (org-table-current-column))
9507 (org-enable-table-editor t)
9508 (org-table-automatic-realign nil)
9509 c cols field)
9510 (while (setq cols (pop clip))
9511 (while (org-at-table-hline-p) (beginning-of-line 2))
9512 (if (not (org-at-table-p))
9513 (progn (end-of-line 0) (org-table-next-field)))
9514 (setq c col)
9515 (while (setq field (pop cols))
9516 (org-table-goto-column c nil 'force)
9517 (org-table-get-field nil field)
9518 (setq c (1+ c)))
9519 (beginning-of-line 2))
9520 (goto-line line)
9521 (org-table-goto-column col)
9522 (org-table-align)))
9524 (defun org-table-convert ()
9525 "Convert from `org-mode' table to table.el and back.
9526 Obviously, this only works within limits. When an Org-mode table is
9527 converted to table.el, all horizontal separator lines get lost, because
9528 table.el uses these as cell boundaries and has no notion of horizontal lines.
9529 A table.el table can be converted to an Org-mode table only if it does not
9530 do row or column spanning. Multiline cells will become multiple cells.
9531 Beware, Org-mode does not test if the table can be successfully converted - it
9532 blindly applies a recipe that works for simple tables."
9533 (interactive)
9534 (require 'table)
9535 (if (org-at-table.el-p)
9536 ;; convert to Org-mode table
9537 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9538 (end (move-marker (make-marker) (org-table-end t))))
9539 (table-unrecognize-region beg end)
9540 (goto-char beg)
9542 (replace-match ""))
9543 (goto-char beg))
9544 (if (org-at-table-p)
9545 ;; convert to table.el table
9546 (let ((beg (move-marker (make-marker) (org-table-begin)))
9547 (end (move-marker (make-marker) (org-table-end))))
9548 ;; first, get rid of all horizontal lines
9549 (goto-char beg)
9551 (replace-match ""))
9552 ;; insert a hline before first
9553 (goto-char beg)
9554 (org-table-insert-hline 'above)
9555 (beginning-of-line -1)
9556 ;; insert a hline after each line
9557 (while (progn (beginning-of-line 3) (< (point) end))
9558 (org-table-insert-hline))
9559 (goto-char beg)
9560 (setq end (move-marker end (org-table-end)))
9561 ;; replace "+" at beginning and ending of hlines
9564 (goto-char beg)
9566 (replace-match "-+"))
9567 (goto-char beg)))))
9569 (defun org-table-wrap-region (arg)
9570 "Wrap several fields in a column like a paragraph.
9571 This is useful if you'd like to spread the contents of a field over several
9572 lines, in order to keep the table compact.
9574 If there is an active region, and both point and mark are in the same column,
9575 the text in the column is wrapped to minimum width for the given number of
9576 lines. Generally, this makes the table more compact. A prefix ARG may be
9578 formats the selected text to two lines. If the region was longer than two
9579 lines, the remaining lines remain empty. A negative prefix argument reduces
9580 the current number of lines by that amount. The wrapped text is pasted back
9581 into the table. If you formatted it to more lines than it was before, fields
9582 further down in the table get overwritten - so you might need to make space in
9583 the table first.
9585 If there is no region, the current field is split at the cursor position and
9586 the text fragment to the right of the cursor is prepended to the field one
9587 line down.
9589 If there is no region, but you specify a prefix ARG, the current field gets
9590 blank, and the content is appended to the field above."
9591 (interactive "P")
9592 (org-table-check-inside-data-field)
9593 (if (org-region-active-p)
9594 ;; There is a region: fill as a paragraph
9595 (let* ((beg (region-beginning))
9596 (cline (save-excursion (goto-char beg) (org-current-line)))
9597 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9598 nlines)
9599 (org-table-cut-region (region-beginning) (region-end))
9600 (if (> (length (car org-table-clip)) 1)
9601 (error "Region must be limited to single column"))
9602 (setq nlines (if arg
9603 (if (< arg 1)
9604 (+ (length org-table-clip) arg)
9605 arg)
9606 (length org-table-clip)))
9607 (setq org-table-clip
9608 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9609 nil nlines)))
9610 (goto-line cline)
9611 (org-table-goto-column ccol)
9612 (org-table-paste-rectangle))
9613 ;; No region, split the current field at point
9614 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9616 (if arg
9617 ;; combine with field above
9618 (let ((s (org-table-blank-field))
9619 (col (org-table-current-column)))
9620 (beginning-of-line 0)
9621 (while (org-at-table-hline-p) (beginning-of-line 0))
9622 (org-table-goto-column col)
9623 (skip-chars-forward "^|")
9624 (skip-chars-backward " ")
9625 (insert " " (org-trim s))
9626 (org-table-align))
9627 ;; split field
9629 (let ((s (match-string 1)))
9630 (replace-match " |")
9631 (goto-char (match-beginning 0))
9632 (org-table-next-row)
9633 (insert (org-trim s) " ")
9634 (org-table-align))
9635 (org-table-next-row)))))
9637 (defvar org-field-marker nil)
9639 (defun org-table-edit-field (arg)
9640 "Edit table field in a different window.
9641 This is mainly useful for fields that contain hidden parts.
9643 it can be edited in place."
9644 (interactive "P")
9645 (if arg
9646 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9648 (remove-text-properties b e '(org-cwidth t invisible t
9649 display t intangible t))
9650 (if (and (boundp 'font-lock-mode) font-lock-mode)
9651 (font-lock-fontify-block)))
9652 (let ((pos (move-marker (make-marker) (point)))
9653 (field (org-table-get-field))
9654 (cw (current-window-configuration))
9655 p)
9656 (org-switch-to-buffer-other-window "*Org tmp*")
9657 (erase-buffer)
9659 (let ((org-inhibit-startup t)) (org-mode))
9660 (goto-char (setq p (point-max)))
9661 (insert (org-trim field))
9662 (remove-text-properties p (point-max)
9663 '(invisible t org-cwidth t display t
9664 intangible t))
9665 (goto-char p)
9666 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9667 (org-set-local 'org-window-configuration cw)
9668 (org-set-local 'org-field-marker pos)
9669 (message "Edit and finish with C-c C-c"))))
9671 (defun org-table-finish-edit-field ()
9672 "Finish editing a table data field.
9673 Remove all newline characters, insert the result into the table, realign
9674 the table and kill the editing buffer."
9675 (let ((pos org-field-marker)
9676 (cw org-window-configuration)
9677 (cb (current-buffer))
9678 text)
9679 (goto-char (point-min))
9682 (replace-match " "))
9683 (setq text (org-trim (buffer-string)))
9684 (set-window-configuration cw)
9685 (kill-buffer cb)
9686 (select-window (get-buffer-window (marker-buffer pos)))
9687 (goto-char pos)
9688 (move-marker pos nil)
9689 (org-table-check-inside-data-field)
9690 (org-table-get-field nil text)
9691 (org-table-align)
9692 (message "New field value inserted")))
9694 (defun org-trim (s)
9695 "Remove whitespace at beginning and end of string."
9698 s)
9700 (defun org-wrap (string &optional width lines)
9701 "Wrap string to either a number of lines, or a width in characters.
9702 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9703 that costs. If there is a word longer than WIDTH, the text is actually
9704 wrapped to the length of that word.
9705 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9706 many lines, whatever width that takes.
9707 The return value is a list of lines, without newlines at the end."
9709 (maxword (apply 'max (mapcar 'org-string-width words)))
9710 w ll)
9711 (cond (width
9712 (org-do-wrap words (max maxword width)))
9713 (lines
9714 (setq w maxword)
9715 (setq ll (org-do-wrap words maxword))
9716 (if (<= (length ll) lines)
9717 ll
9718 (setq ll words)
9719 (while (> (length ll) lines)
9720 (setq w (1+ w))
9721 (setq ll (org-do-wrap words w)))
9722 ll))
9723 (t (error "Cannot wrap this")))))
9726 (defun org-do-wrap (words width)
9727 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9728 (let (lines line)
9729 (while words
9730 (setq line (pop words))
9731 (while (and words (< (+ (length line) (length (car words))) width))
9732 (setq line (concat line " " (pop words))))
9733 (setq lines (push line lines)))
9734 (nreverse lines)))
9736 (defun org-split-string (string &optional separators)
9737 "Splits STRING into substrings at SEPARATORS.
9738 No empty strings are returned if there are matches at the beginning
9739 and end of string."
9741 (start 0)
9742 notfirst
9743 (list nil))
9744 (while (and (string-match rexp string
9745 (if (and notfirst
9746 (= start (match-beginning 0))
9747 (< start (length string)))
9748 (1+ start) start))
9749 (< (match-beginning 0) (length string)))
9750 (setq notfirst t)
9751 (or (eq (match-beginning 0) 0)
9752 (and (eq (match-beginning 0) (match-end 0))
9753 (eq (match-beginning 0) start))
9754 (setq list
9755 (cons (substring string start (match-beginning 0))
9756 list)))
9757 (setq start (match-end 0)))
9758 (or (eq start (length string))
9759 (setq list
9760 (cons (substring string start)
9761 list)))
9762 (nreverse list)))
9764 (defun org-table-map-tables (function)
9765 "Apply FUNCTION to the start of all tables in the buffer."
9766 (save-excursion
9767 (save-restriction
9768 (widen)
9769 (goto-char (point-min))
9770 (while (re-search-forward org-table-any-line-regexp nil t)
9771 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9772 (beginning-of-line 1)
9773 (if (looking-at org-table-line-regexp)
9774 (save-excursion (funcall function)))
9775 (re-search-forward org-table-any-border-regexp nil 1))))
9776 (message "Mapping tables: done"))
9778 (defvar org-timecnt) ; dynamically scoped parameter
9780 (defun org-table-sum (&optional beg end nlast)
9781 "Sum numbers in region of current table column.
9782 The result will be displayed in the echo area, and will be available
9785 If there is an active region, it is interpreted as a rectangle and all
9786 numbers in that rectangle will be summed. If there is no active
9787 region and point is located in a table column, sum all numbers in that
9788 column.
9790 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9791 numbers are assumed to be times as well (in decimal hours) and the
9792 numbers are added as such.
9794 If NLAST is a number, only the NLAST fields will actually be summed."
9795 (interactive)
9796 (save-excursion
9797 (let (col (org-timecnt 0) diff h m s org-table-clip)
9798 (cond
9799 ((and beg end)) ; beg and end given explicitly
9800 ((org-region-active-p)
9801 (setq beg (region-beginning) end (region-end)))
9802 (t
9803 (setq col (org-table-current-column))
9804 (goto-char (org-table-begin))
9806 (error "No table data"))
9807 (org-table-goto-column col)
9808 (setq beg (point))
9809 (goto-char (org-table-end))
9811 (error "No table data"))
9812 (org-table-goto-column col)
9813 (setq end (point))))
9814 (let* ((items (apply 'append (org-table-copy-region beg end)))
9815 (items1 (cond ((not nlast) items)
9816 ((>= nlast (length items)) items)
9817 (t (setq items (reverse items))
9818 (setcdr (nthcdr (1- nlast) items) nil)
9819 (nreverse items))))
9820 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9821 items1)))
9822 (res (apply '+ numbers))
9823 (sres (if (= org-timecnt 0)
9824 (format "%g" res)
9825 (setq diff (* 3600 res)
9826 h (floor (/ diff 3600)) diff (mod diff 3600)
9827 m (floor (/ diff 60)) diff (mod diff 60)
9828 s diff)
9829 (format "%d:%02d:%02d" h m s))))
9830 (kill-new sres)
9831 (if (interactive-p)
9832 (message "%s"
9833 (substitute-command-keys
9835 (length numbers) sres))))
9836 sres))))
9838 (defun org-table-get-number-for-summing (s)
9839 (let (n)
9840 (if (string-match "^ *|? *" s)
9841 (setq s (replace-match "" nil nil s)))
9842 (if (string-match " *|? *$" s)
9843 (setq s (replace-match "" nil nil s)))
9844 (setq n (string-to-number s))
9845 (cond
9846 ((and (string-match "0" s)
9850 (let ((h (string-to-number (or (match-string 1 s) "0")))
9851 (m (string-to-number (or (match-string 2 s) "0")))
9852 (s (string-to-number (or (match-string 4 s) "0"))))
9853 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9854 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9855 ((equal n 0) nil)
9856 (t n))))
9858 (defun org-table-current-field-formula (&optional key noerror)
9859 "Return the formula active for the current field.
9860 Assumes that specials are in place.
9861 If KEY is given, return the key to this formula.
9863 (let* ((name (car (rassoc (list (org-current-line)
9864 (org-table-current-column))
9865 org-table-named-field-locations)))
9866 (col (org-table-current-column))
9867 (scol (int-to-string col))
9868 (ref (format "@%d$%d" (org-table-current-dline) col))
9869 (stored-list (org-table-get-stored-formulas noerror))
9870 (ass (or (assoc name stored-list)
9871 (assoc ref stored-list)
9872 (assoc scol stored-list))))
9873 (if key
9874 (car ass)
9875 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9876 (cdr ass))))))
9878 (defun org-table-get-formula (&optional equation named)
9879 "Read a formula from the minibuffer, offer stored formula as default.
9880 When NAMED is non-nil, look for a named equation."
9881 (let* ((stored-list (org-table-get-stored-formulas))
9882 (name (car (rassoc (list (org-current-line)
9883 (org-table-current-column))
9884 org-table-named-field-locations)))
9885 (ref (format "@%d$%d" (org-table-current-dline)
9886 (org-table-current-column)))
9887 (refass (assoc ref stored-list))
9888 (scol (if named
9889 (if name name ref)
9890 (int-to-string (org-table-current-column))))
9891 (dummy (and (or name refass) (not named)
9892 (not (y-or-n-p "Replace field formula with column formula? " ))
9893 (error "Abort")))
9894 (name (or name ref))
9895 (org-table-may-need-update nil)
9896 (stored (cdr (assoc scol stored-list)))
9897 (eq (cond
9898 ((and stored equation (string-match "^ *=? *$" equation))
9899 stored)
9900 ((stringp equation)
9901 equation)
9902 (t (org-table-formula-from-user
9903 (read-string
9904 (org-table-formula-to-user
9905 (format "%s formula %s%s="
9906 (if named "Field" "Column")
9907 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9908 scol))
9909 (if stored (org-table-formula-to-user stored) "")
9910 'org-table-formula-history
9911 )))))
9912 mustsave)
9914 ;; remove formula
9915 (setq stored-list (delq (assoc scol stored-list) stored-list))
9916 (org-table-store-formulas stored-list)
9917 (error "Formula removed"))
9918 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9919 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9920 (if (and name (not named))
9921 ;; We set the column equation, delete the named one.
9922 (setq stored-list (delq (assoc name stored-list) stored-list)
9923 mustsave t))
9924 (if stored
9925 (setcdr (assoc scol stored-list) eq)
9926 (setq stored-list (cons (cons scol eq) stored-list)))
9927 (if (or mustsave (not (equal stored eq)))
9928 (org-table-store-formulas stored-list))
9929 eq))
9931 (defun org-table-store-formulas (alist)
9932 "Store the list of formulas below the current table."
9933 (setq alist (sort alist 'org-table-formula-less-p))
9934 (save-excursion
9935 (goto-char (org-table-end))
9937 (progn
9938 ;; don't overwrite TBLFM, we might use text properties to store stuff
9939 (goto-char (match-beginning 2))
9940 (delete-region (match-beginning 2) (match-end 0)))
9941 (insert "#+TBLFM:"))
9942 (insert " "
9943 (mapconcat (lambda (x)
9944 (concat
9945 (if (equal (string-to-char (car x)) ?@) "" "$")
9946 (car x) "=" (cdr x)))
9947 alist "::")
9950 (defsubst org-table-formula-make-cmp-string (a)
9952 (concat
9953 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9954 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9955 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9957 (defun org-table-formula-less-p (a b)
9958 "Compare two formulas for sorting."
9959 (let ((as (org-table-formula-make-cmp-string (car a)))
9960 (bs (org-table-formula-make-cmp-string (car b))))
9961 (and as bs (string< as bs))))
9963 (defun org-table-get-stored-formulas (&optional noerror)
9964 "Return an alist with the stored formulas directly after current table."
9965 (interactive)
9966 (let (scol eq eq-alist strings string seen)
9967 (save-excursion
9968 (goto-char (org-table-end))
9970 (setq strings (org-split-string (match-string 2) " *:: *"))
9971 (while (setq string (pop strings))
9972 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9973 (setq scol (if (match-end 2)
9974 (match-string 2 string)
9975 (match-string 1 string))
9976 eq (match-string 3 string)
9977 eq-alist (cons (cons scol eq) eq-alist))
9978 (if (member scol seen)
9979 (if noerror
9980 (progn
9981 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9982 (ding)
9983 (sit-for 2))
9984 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9985 (push scol seen))))))
9986 (nreverse eq-alist)))
9988 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9989 "Modify the equations after the table structure has been edited.
9991 For all numbers larger than LIMIT, shift them by DELTA."
9992 (save-excursion
9993 (goto-char (org-table-end))
9996 (re2
9997 (when remove
9998 (if (equal key "$")
10001 s n a)
10002 (when remove
10003 (while (re-search-forward re2 (point-at-eol) t)
10004 (replace-match "")))
10005 (while (re-search-forward re (point-at-eol) t)
10006 (setq s (match-string 1) n (string-to-number s))
10007 (cond
10008 ((setq a (assoc s replace))
10009 (replace-match (concat key (cdr a)) t t))
10010 ((and limit (> n limit))
10011 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
10013 (defun org-table-get-specials ()
10014 "Get the column names and local parameters for this table."
10015 (save-excursion
10016 (let ((beg (org-table-begin)) (end (org-table-end))
10017 names name fields fields1 field cnt
10018 c v l line col types dlines hlines)
10019 (setq org-table-column-names nil
10020 org-table-local-parameters nil
10021 org-table-named-field-locations nil
10022 org-table-current-begin-line nil
10023 org-table-current-begin-pos nil
10024 org-table-current-line-types nil)
10025 (goto-char beg)
10027 (setq names (org-split-string (match-string 1) " *| *")
10028 cnt 1)
10029 (while (setq name (pop names))
10030 (setq cnt (1+ cnt))
10031 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
10032 (push (cons name (int-to-string cnt)) org-table-column-names))))
10033 (setq org-table-column-names (nreverse org-table-column-names))
10034 (setq org-table-column-name-regexp
10036 (goto-char beg)
10038 (setq fields (org-split-string (match-string 1) " *| *"))
10039 (while (setq field (pop fields))
10041 (push (cons (match-string 1 field) (match-string 2 field))
10042 org-table-local-parameters))))
10043 (goto-char beg)
10045 (setq c (match-string 1)
10046 fields (org-split-string (match-string 2) " *| *"))
10047 (save-excursion
10048 (beginning-of-line (if (equal c "_") 2 0))
10049 (setq line (org-current-line) col 1)
10051 (setq fields1 (org-split-string (match-string 1) " *| *"))))
10052 (while (and fields1 (setq field (pop fields)))
10053 (setq v (pop fields1) col (1+ col))
10054 (when (and (stringp field) (stringp v)
10055 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
10056 (push (cons field v) org-table-local-parameters)
10057 (push (list field line col) org-table-named-field-locations))))
10058 ;; Analyse the line types
10059 (goto-char beg)
10060 (setq org-table-current-begin-line (org-current-line)
10061 org-table-current-begin-pos (point)
10062 l org-table-current-begin-line)
10064 (push (if (match-end 1) 'hline 'dline) types)
10065 (if (match-end 1) (push l hlines) (push l dlines))
10066 (beginning-of-line 2)
10067 (setq l (1+ l)))
10068 (setq org-table-current-line-types (apply 'vector (nreverse types))
10069 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
10070 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
10072 (defun org-table-maybe-eval-formula ()
10074 If yes, store the formula and apply it."
10075 ;; We already know we are in a table. Get field will only return a formula
10076 ;; when appropriate. It might return a separator line, but no problem.
10077 (when org-table-formula-evaluate-inline
10078 (let* ((field (org-trim (or (org-table-get-field) "")))
10079 named eq)
10081 (setq named (equal (string-to-char field) ?:)
10082 eq (match-string 1 field))
10083 (if (or (fboundp 'calc-eval)
10084 (equal (substring eq 0 (min 2 (length eq))) "'("))
10085 (org-table-eval-formula (if named '(4) nil)
10086 (org-table-formula-from-user eq))
10087 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
10089 (defvar org-recalc-commands nil
10090 "List of commands triggering the recalculation of a line.
10091 Will be filled automatically during use.")
10093 (defvar org-recalc-marks
10094 '((" " . "Unmarked: no special line, no automatic recalculation")
10095 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10096 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10097 ("!" . "Column name definition line. Reference in formula as $name.")
10098 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10099 ("_" . "Names for values in row below this one.")
10100 ("^" . "Names for values in row above this one.")))
10102 (defun org-table-rotate-recalc-marks (&optional newchar)
10103 "Rotate the recalculation mark in the first column.
10104 If in any row, the first field is not consistent with a mark,
10105 insert a new column for the markers.
10106 When there is an active region, change all the lines in the region,
10107 after prompting for the marking character.
10108 After each change, a message will be displayed indicating the meaning
10109 of the new mark."
10110 (interactive)
10111 (unless (org-at-table-p) (error "Not at a table"))
10112 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10113 (beg (org-table-begin))
10114 (end (org-table-end))
10115 (l (org-current-line))
10116 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10117 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10118 (have-col
10119 (save-excursion
10120 (goto-char beg)
10122 (col (org-table-current-column))
10123 (forcenew (car (assoc newchar org-recalc-marks)))
10124 epos new)
10125 (when l1
10126 (message "Change region to what mark? Type # * ! $ or SPC: ")
10127 (setq newchar (char-to-string (read-char-exclusive))
10128 forcenew (car (assoc newchar org-recalc-marks))))
10129 (if (and newchar (not forcenew))
10130 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10131 newchar))
10132 (if l1 (goto-line l1))
10133 (save-excursion
10134 (beginning-of-line 1)
10135 (unless (looking-at org-table-dataline-regexp)
10136 (error "Not at a table data line")))
10137 (unless have-col
10138 (org-table-goto-column 1)
10139 (org-table-insert-column)
10140 (org-table-goto-column (1+ col)))
10141 (setq epos (point-at-eol))
10142 (save-excursion
10143 (beginning-of-line 1)
10144 (org-table-get-field
10146 (concat " "
10147 (setq new (or forcenew
10148 (cadr (member (match-string 1) marks))))
10149 " ")
10150 " # ")))
10151 (if (and l1 l2)
10152 (progn
10153 (goto-line l1)
10154 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10155 (and (looking-at org-table-dataline-regexp)
10156 (org-table-get-field 1 (concat " " new " "))))
10157 (goto-line l1)))
10158 (if (not (= epos (point-at-eol))) (org-table-align))
10159 (goto-line l)
10160 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10162 (defun org-table-maybe-recalculate-line ()
10163 "Recompute the current line if marked for it, and if we haven't just done it."
10164 (interactive)
10165 (and org-table-allow-automatic-line-recalculation
10166 (not (and (memq last-command org-recalc-commands)
10167 (equal org-last-recalc-line (org-current-line))))
10168 (save-excursion (beginning-of-line 1)
10169 (looking-at org-table-auto-recalculate-regexp))
10170 (org-table-recalculate) t))
10172 (defvar org-table-formula-debug nil
10173 "Non-nil means, debug table formulas.
10175 (make-variable-buffer-local 'org-table-formula-debug)
10177 (defvar modes)
10178 (defsubst org-set-calc-mode (var &optional value)
10179 (if (stringp var)
10180 (setq var (assoc var '(("D" calc-angle-mode deg)
10181 ("R" calc-angle-mode rad)
10182 ("F" calc-prefer-frac t)
10183 ("S" calc-symbolic-mode t)))
10184 value (nth 2 var) var (nth 1 var)))
10185 (if (memq var modes)
10186 (setcar (cdr (memq var modes)) value)
10187 (cons var (cons value modes)))
10188 modes)
10190 (defun org-table-eval-formula (&optional arg equation
10191 suppress-align suppress-const
10192 suppress-store suppress-analysis)
10193 "Replace the table field value at the cursor by the result of a calculation.
10195 This function makes use of Dave Gillespie's Calc package, in my view the
10196 most exciting program ever written for GNU Emacs. So you need to have Calc
10197 installed in order to use this function.
10199 In a table, this command replaces the value in the current field with the
10201 formula, by storing it in a special line below the table. When called
10202 with a `C-u' prefix, the current field must ba a named field, and the
10203 formula is installed as valid in only this specific field.
10205 When called with two `C-u' prefixes, insert the active equation
10206 for the field back into the current field, so that it can be
10208 to check the referenced fields.
10210 When called, the command first prompts for a formula, which is read in
10211 the minibuffer. Previously entered formulas are available through the
10212 history list, and the last used formula is offered as a default.
10213 These stored formulas are adapted correctly when moving, inserting, or
10214 deleting columns with the corresponding commands.
10216 The formula can be any algebraic expression understood by the Calc package.
10217 For details, see the Org-mode manual.
10219 This function can also be called from Lisp programs and offers
10220 additional arguments: EQUATION can be the formula to apply. If this
10221 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10222 used to speed-up recursive calls by by-passing unnecessary aligns.
10223 SUPPRESS-CONST suppresses the interpretation of constants in the
10224 formula, assuming that this has been done already outside the function.
10225 SUPPRESS-STORE means the formula should not be stored, either because
10226 it is already stored, or because it is a modified equation that should
10227 not overwrite the stored one."
10228 (interactive "P")
10229 (org-table-check-inside-data-field)
10230 (or suppress-analysis (org-table-get-specials))
10231 (if (equal arg '(16))
10232 (let ((eq (org-table-current-field-formula)))
10233 (or eq (error "No equation active for current field"))
10234 (org-table-get-field nil eq)
10235 (org-table-align)
10236 (setq org-table-may-need-update t))
10237 (let* (fields
10238 (ndown (if (integerp arg) arg 1))
10239 (org-table-automatic-realign nil)
10240 (case-fold-search nil)
10241 (down (> ndown 1))
10242 (formula (if (and equation suppress-store)
10243 equation
10244 (org-table-get-formula equation (equal arg '(4)))))
10245 (n0 (org-table-current-column))
10246 (modes (copy-sequence org-calc-default-modes))
10247 (numbers nil) ; was a variable, now fixed default
10248 (keep-empty nil)
10249 n form form0 bw fmt x ev orig c lispp literal)
10250 ;; Parse the format string. Since we have a lot of modes, this is
10251 ;; a lot of work. However, I think calc still uses most of the time.
10252 (if (string-match ";" formula)
10253 (let ((tmp (org-split-string formula ";")))
10254 (setq formula (car tmp)
10255 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10256 (nth 1 tmp)))
10258 (setq c (string-to-char (match-string 1 fmt))
10259 n (string-to-number (match-string 2 fmt)))
10260 (if (= c ?p)
10261 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10262 (setq modes (org-set-calc-mode
10263 'calc-float-format
10264 (list (cdr (assoc c '((?n . float) (?f . fix)
10265 (?s . sci) (?e . eng))))
10266 n))))
10267 (setq fmt (replace-match "" t t fmt)))
10268 (if (string-match "[NT]" fmt)
10269 (setq numbers (equal (match-string 0 fmt) "N")
10270 fmt (replace-match "" t t fmt)))
10271 (if (string-match "L" fmt)
10272 (setq literal t
10273 fmt (replace-match "" t t fmt)))
10274 (if (string-match "E" fmt)
10275 (setq keep-empty t
10276 fmt (replace-match "" t t fmt)))
10277 (while (string-match "[DRFS]" fmt)
10278 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10279 (setq fmt (replace-match "" t t fmt)))
10281 (setq fmt nil))))
10282 (if (and (not suppress-const) org-table-formula-use-constants)
10283 (setq formula (org-table-formula-substitute-names formula)))
10284 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10285 (while (> ndown 0)
10286 (setq fields (org-split-string
10287 (org-no-properties
10288 (buffer-substring (point-at-bol) (point-at-eol)))
10289 " *| *"))
10290 (if (eq numbers t)
10291 (setq fields (mapcar
10292 (lambda (x) (number-to-string (string-to-number x)))
10293 fields)))
10294 (setq ndown (1- ndown))
10295 (setq form (copy-sequence formula)
10296 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10297 (if (and lispp literal) (setq lispp 'literal))
10298 ;; Check for old vertical references
10299 (setq form (org-rewrite-old-row-references form))
10300 ;; Insert complex ranges
10301 (while (string-match org-table-range-regexp form)
10302 (setq form
10303 (replace-match
10304 (save-match-data
10305 (org-table-make-reference
10306 (org-table-get-range (match-string 0 form) nil n0)
10307 keep-empty numbers lispp))
10308 t t form)))
10309 ;; Insert simple ranges
10311 (setq form
10312 (replace-match
10313 (save-match-data
10314 (org-table-make-reference
10315 (org-sublist
10316 fields (string-to-number (match-string 1 form))
10317 (string-to-number (match-string 2 form)))
10318 keep-empty numbers lispp))
10319 t t form)))
10320 (setq form0 form)
10321 ;; Insert the references to fields in same row
10323 (setq n (string-to-number (match-string 1 form))
10324 x (nth (1- (if (= n 0) n0 n)) fields))
10326 (match-string 0 form)))
10327 (setq form (replace-match
10328 (save-match-data
10329 (org-table-make-reference x nil numbers lispp))
10330 t t form)))
10332 (if lispp
10333 (setq ev (condition-case nil
10334 (eval (eval (read form)))
10335 (error "#ERROR"))
10336 ev (if (numberp ev) (number-to-string ev) ev))
10337 (or (fboundp 'calc-eval)
10338 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10339 (setq ev (calc-eval (cons form modes)
10340 (if numbers 'num))))
10342 (when org-table-formula-debug
10343 (with-output-to-temp-buffer "*Substitution History*"
10344 (princ (format "Substitution history of formula
10345 Orig: %s
10346 $xyz-> %s
10347 @r$c-> %s
10349 (if (listp ev)
10351 (make-string (car ev) ?\-) (nth 1 ev)))
10353 ev (or fmt "NONE")
10354 (if fmt (format fmt (string-to-number ev)) ev)))))
10355 (setq bw (get-buffer-window "*Substitution History*"))
10356 (shrink-window-if-larger-than-buffer bw)
10357 (unless (and (interactive-p) (not ndown))
10358 (unless (let (inhibit-redisplay)
10359 (y-or-n-p "Debugging Formula. Continue to next? "))
10360 (org-table-align)
10361 (error "Abort"))
10362 (delete-window bw)
10363 (message "")))
10364 (if (listp ev) (setq fmt nil ev "#ERROR"))
10365 (org-table-justify-field-maybe
10366 (if fmt (format fmt (string-to-number ev)) ev))
10368 (call-interactively 'org-return)
10369 (setq ndown 0)))
10370 (and down (org-table-maybe-recalculate-line))
10371 (or suppress-align (and org-table-may-need-update
10372 (org-table-align))))))
10374 (defun org-table-put-field-property (prop value)
10375 (save-excursion
10376 (put-text-property (progn (skip-chars-backward "^|") (point))
10377 (progn (skip-chars-forward "^|") (point))
10378 prop value)))
10380 (defun org-table-get-range (desc &optional tbeg col highlight)
10381 "Get a calc vector from a column, accorting to descriptor DESC.
10382 Optional arguments TBEG and COL can give the beginning of the table and
10383 the current column, to avoid unnecessary parsing.
10384 HIGHLIGHT means, just highlight the range."
10385 (if (not (equal (string-to-char desc) ?@))
10386 (setq desc (concat "@" desc)))
10387 (save-excursion
10388 (or tbeg (setq tbeg (org-table-begin)))
10389 (or col (setq col (org-table-current-column)))
10390 (let ((thisline (org-current-line))
10391 beg end c1 c2 r1 r2 rangep tmp)
10392 (unless (string-match org-table-range-regexp desc)
10393 (error "Invalid table range specifier `%s'" desc))
10394 (setq rangep (match-end 3)
10395 r1 (and (match-end 1) (match-string 1 desc))
10396 r2 (and (match-end 4) (match-string 4 desc))
10397 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10398 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10400 (and c1 (setq c1 (+ (string-to-number c1)
10401 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10402 (and c2 (setq c2 (+ (string-to-number c2)
10403 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10404 (if (equal r1 "") (setq r1 nil))
10405 (if (equal r2 "") (setq r2 nil))
10406 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10407 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10408 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10409 (if (not r1) (setq r1 thisline))
10410 (if (not r2) (setq r2 thisline))
10411 (if (not c1) (setq c1 col))
10412 (if (not c2) (setq c2 col))
10413 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10414 ;; just one field
10415 (progn
10416 (goto-line r1)
10417 (while (not (looking-at org-table-dataline-regexp))
10418 (beginning-of-line 2))
10419 (prog1 (org-trim (org-table-get-field c1))
10420 (if highlight (org-table-highlight-rectangle (point) (point)))))
10421 ;; A range, return a vector
10422 ;; First sort the numbers to get a regular ractangle
10423 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10424 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10425 (goto-line r1)
10426 (while (not (looking-at org-table-dataline-regexp))
10427 (beginning-of-line 2))
10428 (org-table-goto-column c1)
10429 (setq beg (point))
10430 (goto-line r2)
10431 (while (not (looking-at org-table-dataline-regexp))
10432 (beginning-of-line 0))
10433 (org-table-goto-column c2)
10434 (setq end (point))
10435 (if highlight
10436 (org-table-highlight-rectangle
10438 ;; return string representation of calc vector
10439 (mapcar 'org-trim
10440 (apply 'append (org-table-copy-region beg end)))))))
10442 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10443 "Analyze descriptor DESC and retrieve the corresponding line number.
10444 The cursor is currently in line CLINE, the table begins in line BLINE,
10445 and TABLE is a vector with line types."
10446 (if (string-match "^[0-9]+$" desc)
10447 (aref org-table-dlines (string-to-number desc))
10448 (setq cline (or cline (org-current-line))
10449 bline (or bline org-table-current-begin-line)
10450 table (or table org-table-current-line-types))
10451 (if (or
10453 ;; 1 2 3 4 5 6
10454 (and (not (match-end 3)) (not (match-end 6)))
10455 (and (match-end 3) (match-end 6) (not (match-end 5))))
10456 (error "invalid row descriptor `%s'" desc))
10457 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10458 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10459 (odir (and (match-end 5) (match-string 5 desc)))
10460 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10461 (i (- cline bline))
10462 (rel (and (match-end 6)
10463 (or (and (match-end 1) (not (match-end 3)))
10464 (match-end 5)))))
10465 (if (and hn (not hdir))
10466 (progn
10467 (setq i 0 hdir "+")
10468 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10469 (if (and (not hn) on (not odir))
10470 (error "should never happen");;(aref org-table-dlines on)
10471 (if (and hn (> hn 0))
10472 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10473 (if on
10474 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10475 (+ bline i)))))
10477 (defun org-find-row-type (table i type backwards relative n)
10478 (let ((l (length table)))
10479 (while (> n 0)
10480 (while (and (setq i (+ i (if backwards -1 1)))
10481 (>= i 0) (< i l)
10482 (not (eq (aref table i) type))
10483 (if (and relative (eq (aref table i) 'hline))
10484 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10485 t)))
10486 (setq n (1- n)))
10487 (if (or (< i 0) (>= i l))
10488 (error "Row descriptior leads outside table")
10489 i)))
10491 (defun org-rewrite-old-row-references (s)
10492 (if (string-match "&[-+0-9I]" s)
10493 (error "Formula contains old &row reference, please rewrite using @-syntax")
10494 s))
10496 (defun org-table-make-reference (elements keep-empty numbers lispp)
10497 "Convert list ELEMENTS to something appropriate to insert into formula.
10498 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10499 NUMBERS indicates that everything should be converted to numbers.
10500 LISPP means to return something appropriate for a Lisp list."
10501 (if (stringp elements) ; just a single val
10502 (if lispp
10503 (if (eq lispp 'literal)
10504 elements
10505 (prin1-to-string (if numbers (string-to-number elements) elements)))
10506 (if (equal elements "") (setq elements "0"))
10507 (if numbers (number-to-string (string-to-number elements)) elements))
10508 (unless keep-empty
10509 (setq elements
10510 (delq nil
10512 elements))))
10513 (setq elements (or elements '("0")))
10514 (if lispp
10515 (mapconcat
10516 (lambda (x)
10517 (if (eq lispp 'literal)
10518 x
10519 (prin1-to-string (if numbers (string-to-number x) x))))
10520 elements " ")
10521 (concat "[" (mapconcat
10522 (lambda (x)
10523 (if numbers (number-to-string (string-to-number x)) x))
10524 elements
10525 ",") "]"))))
10527 (defun org-table-recalculate (&optional all noalign)
10528 "Recalculate the current table line by applying all stored formulas.
10529 With prefix arg ALL, do this for all lines in the table."
10530 (interactive "P")
10531 (or (memq this-command org-recalc-commands)
10532 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10533 (unless (org-at-table-p) (error "Not at a table"))
10534 (if (equal all '(16))
10535 (org-table-iterate)
10536 (org-table-get-specials)
10537 (let* ((eqlist (sort (org-table-get-stored-formulas)
10538 (lambda (a b) (string< (car a) (car b)))))
10539 (inhibit-redisplay (not debug-on-error))
10540 (line-re org-table-dataline-regexp)
10541 (thisline (org-current-line))
10542 (thiscol (org-table-current-column))
10543 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10544 ;; Insert constants in all formulas
10545 (setq eqlist
10546 (mapcar (lambda (x)
10547 (setcdr x (org-table-formula-substitute-names (cdr x)))
10548 x)
10549 eqlist))
10550 ;; Split the equation list
10551 (while (setq eq (pop eqlist))
10552 (if (<= (string-to-char (car eq)) ?9)
10553 (push eq eqlnum)
10554 (push eq eqlname)))
10555 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10556 (if all
10557 (progn
10558 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10559 (goto-char (setq beg (org-table-begin)))
10560 (if (re-search-forward org-table-calculate-mark-regexp end t)
10561 ;; This is a table with marked lines, compute selected lines
10562 (setq line-re org-table-recalculate-regexp)
10563 ;; Move forward to the first non-header line
10564 (if (and (re-search-forward org-table-dataline-regexp end t)
10565 (re-search-forward org-table-hline-regexp end t)
10566 (re-search-forward org-table-dataline-regexp end t))
10567 (setq beg (match-beginning 0))
10568 nil))) ;; just leave beg where it is
10569 (setq beg (point-at-bol)
10570 end (move-marker (make-marker) (1+ (point-at-eol)))))
10571 (goto-char beg)
10572 (and all (message "Re-applying formulas to full table..."))
10574 ;; First find the named fields, and mark them untouchanble
10575 (remove-text-properties beg end '(org-untouchable t))
10576 (while (setq eq (pop eqlname))
10577 (setq name (car eq)
10578 a (assoc name org-table-named-field-locations))
10579 (and (not a)
10581 (setq a (list name
10582 (aref org-table-dlines
10583 (string-to-number (match-string 1 name)))
10584 (string-to-number (match-string 2 name)))))
10585 (when (and a (or all (equal (nth 1 a) thisline)))
10586 (message "Re-applying formula to field: %s" name)
10587 (goto-line (nth 1 a))
10588 (org-table-goto-column (nth 2 a))
10589 (push (append a (list (cdr eq))) eqlname1)
10590 (org-table-put-field-property :org-untouchable t)))
10592 ;; Now evauluate the column formulas, but skip fields covered by
10593 ;; field formulas
10594 (goto-char beg)
10595 (while (re-search-forward line-re end t)
10596 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10597 ;; Unprotected line, recalculate
10598 (and all (message "Re-applying formulas to full table...(line %d)"
10599 (setq cnt (1+ cnt))))
10600 (setq org-last-recalc-line (org-current-line))
10601 (setq eql eqlnum)
10602 (while (setq entry (pop eql))
10603 (goto-line org-last-recalc-line)
10604 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10605 (unless (get-text-property (point) :org-untouchable)
10606 (org-table-eval-formula nil (cdr entry)
10607 'noalign 'nocst 'nostore 'noanalysis)))))
10609 ;; Now evaluate the field formulas
10610 (while (setq eq (pop eqlname1))
10611 (message "Re-applying formula to field: %s" (car eq))
10612 (goto-line (nth 1 eq))
10613 (org-table-goto-column (nth 2 eq))
10614 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10615 'nostore 'noanalysis))
10617 (goto-line thisline)
10618 (org-table-goto-column thiscol)
10619 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10620 (or noalign (and org-table-may-need-update (org-table-align))
10621 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10623 ;; back to initial position
10624 (message "Re-applying formulas...done")
10625 (goto-line thisline)
10626 (org-table-goto-column thiscol)
10627 (or noalign (and org-table-may-need-update (org-table-align))
10628 (and all (message "Re-applying formulas...done"))))))
10630 (defun org-table-iterate (&optional arg)
10631 "Recalculate the table until it does not change anymore."
10632 (interactive "P")
10633 (let ((imax (if arg (prefix-numeric-value arg) 10))
10634 (i 0)
10635 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10636 thistbl)
10637 (catch 'exit
10638 (while (< i imax)
10639 (setq i (1+ i))
10640 (org-table-recalculate 'all)
10641 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10642 (if (not (string= lasttbl thistbl))
10643 (setq lasttbl thistbl)
10644 (if (> i 1)
10645 (message "Convergence after %d iterations" i)
10646 (message "Table was already stable"))
10647 (throw 'exit t)))
10648 (error "No convergence after %d iterations" i))))
10650 (defun org-table-formula-substitute-names (f)
10651 "Replace $const with values in string F."
10652 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10653 ;; First, check for column names
10654 (while (setq start (string-match org-table-column-name-regexp f start))
10655 (setq start (1+ start))
10656 (setq a (assoc (match-string 1 f) org-table-column-names))
10657 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10658 ;; Parameters and constants
10659 (setq start 0)
10661 (setq start (1+ start))
10662 (if (setq a (save-match-data
10663 (org-table-get-constant (match-string 1 f))))
10664 (setq f (replace-match
10665 (concat (if pp "(") a (if pp ")")) t t f))))
10666 (if org-table-formula-debug
10667 (put-text-property 0 (length f) :orig-formula f1 f))
10668 f))
10670 (defun org-table-get-constant (const)
10671 "Find the value for a parameter or constant in a formula.
10672 Parameters get priority."
10673 (or (cdr (assoc const org-table-local-parameters))
10674 (cdr (assoc const org-table-formula-constants-local))
10675 (cdr (assoc const org-table-formula-constants))
10676 (and (fboundp 'constants-get) (constants-get const))
10677 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10678 (org-entry-get nil (substring const 5) 'inherit))
10679 "#UNDEFINED_NAME"))
10681 (defvar org-table-fedit-map
10682 (let ((map (make-sparse-keymap)))
10683 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10684 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10685 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10686 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10687 (org-defkey map "\C-c?" 'org-table-show-reference)
10688 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10689 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10690 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10691 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10692 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10693 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10694 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10695 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10696 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10697 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10698 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10699 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10700 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10701 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10702 map))
10704 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10705 '("Edit-Formulas"
10706 ["Finish and Install" org-table-fedit-finish t]
10707 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10708 ["Abort" org-table-fedit-abort t]
10709 "--"
10710 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10711 ["Complete Lisp Symbol" lisp-complete-symbol t]
10712 "--"
10713 "Shift Reference at Point"
10714 ["Up" org-table-fedit-ref-up t]
10715 ["Down" org-table-fedit-ref-down t]
10716 ["Left" org-table-fedit-ref-left t]
10717 ["Right" org-table-fedit-ref-right t]
10718 "-"
10719 "Change Test Row for Column Formulas"
10720 ["Up" org-table-fedit-line-up t]
10721 ["Down" org-table-fedit-line-down t]
10722 "--"
10723 ["Scroll Table Window" org-table-fedit-scroll t]
10724 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10725 ["Show Table Grid" org-table-fedit-toggle-coordinates
10726 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10727 org-table-overlay-coordinates)]
10728 "--"
10729 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10730 :style toggle :selected org-table-buffer-is-an]))
10732 (defvar org-pos)
10734 (defun org-table-edit-formulas ()
10735 "Edit the formulas of the current table in a separate buffer."
10736 (interactive)
10738 (beginning-of-line 0))
10739 (unless (org-at-table-p) (error "Not at a table"))
10740 (org-table-get-specials)
10741 (let ((key (org-table-current-field-formula 'key 'noerror))
10742 (eql (sort (org-table-get-stored-formulas 'noerror)
10743 'org-table-formula-less-p))
10744 (pos (move-marker (make-marker) (point)))
10745 (startline 1)
10746 (wc (current-window-configuration))
10750 entry s type title)
10751 (org-switch-to-buffer-other-window "*Edit Formulas*")
10752 (erase-buffer)
10753 ;; Keep global-font-lock-mode from turning on font-lock-mode
10754 (let ((font-lock-global-modes '(not fundamental-mode)))
10755 (fundamental-mode))
10756 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10757 (org-set-local 'org-pos pos)
10758 (org-set-local 'org-window-configuration wc)
10759 (use-local-map org-table-fedit-map)
10760 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10761 (easy-menu-add org-table-fedit-menu)
10762 (setq startline (org-current-line))
10763 (while (setq entry (pop eql))
10764 (setq type (cond
10765 ((equal (string-to-char (car entry)) ?@) 'field)
10766 ((string-match "^[0-9]" (car entry)) 'column)
10767 (t 'named)))
10768 (when (setq title (assq type titles))
10770 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10771 (setq titles (delq title titles)))
10772 (if (equal key (car entry)) (setq startline (org-current-line)))
10773 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10775 (remove-text-properties 0 (length s) '(face nil) s)
10776 (insert s))
10777 (if (eq org-table-use-standard-references t)
10778 (org-table-fedit-toggle-ref-type))
10779 (goto-line startline)
10780 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10782 (defun org-table-fedit-post-command ()
10783 (when (not (memq this-command '(lisp-complete-symbol)))
10784 (let ((win (selected-window)))
10785 (save-excursion
10786 (condition-case nil
10787 (org-table-show-reference)
10788 (error nil))
10789 (select-window win)))))
10791 (defun org-table-formula-to-user (s)
10792 "Convert a formula from internal to user representation."
10793 (if (eq org-table-use-standard-references t)
10794 (org-table-convert-refs-to-an s)
10795 s))
10797 (defun org-table-formula-from-user (s)
10798 "Convert a formula from user to internal representation."
10799 (if org-table-use-standard-references
10800 (org-table-convert-refs-to-rc s)
10801 s))
10803 (defun org-table-convert-refs-to-rc (s)
10804 "Convert spreadsheet references from AB7 to @7$28.
10805 Works for single references, but also for entire formulas and even the
10806 full TBLFM line."
10807 (let ((start 0))
10809 (cond
10810 ((match-end 3)
10811 ;; format match, just advance
10812 (setq start (match-end 0)))
10813 ((and (> (match-beginning 0) 0)
10814 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10815 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10816 ;; 3.e5 or something like this.
10817 (setq start (match-end 0)))
10818 (t
10819 (setq start (match-beginning 0)
10820 s (replace-match
10821 (if (equal (match-string 2 s) "&")
10822 (format "$%d" (org-letters-to-number (match-string 1 s)))
10823 (format "@%d$%d"
10824 (string-to-number (match-string 2 s))
10825 (org-letters-to-number (match-string 1 s))))
10826 t t s)))))
10827 s))
10829 (defun org-table-convert-refs-to-an (s)
10830 "Convert spreadsheet references from to @7$28 to AB7.
10831 Works for single references, but also for entire formulas and even the
10832 full TBLFM line."
10834 (setq s (replace-match
10835 (format "%s%d"
10836 (org-number-to-letters
10837 (string-to-number (match-string 2 s)))
10838 (string-to-number (match-string 1 s)))
10839 t t s)))
10842 (org-number-to-letters
10843 (string-to-number (match-string 2 s))) "&")
10844 t nil s)))
10845 s)
10847 (defun org-letters-to-number (s)
10848 "Convert a base 26 number represented by letters into an integer.
10849 For example: AB -> 28."
10850 (let ((n 0))
10851 (setq s (upcase s))
10852 (while (> (length s) 0)
10853 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10854 s (substring s 1)))
10855 n))
10857 (defun org-number-to-letters (n)
10858 "Convert an integer into a base 26 number represented by letters.
10859 For example: 28 -> AB."
10860 (let ((s ""))
10861 (while (> n 0)
10862 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10863 n (/ (1- n) 26)))
10864 s))
10866 (defun org-table-fedit-convert-buffer (function)
10867 "Convert all references in this buffer, using FUNTION."
10868 (let ((line (org-current-line)))
10869 (goto-char (point-min))
10870 (while (not (eobp))
10871 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10872 (delete-region (point) (point-at-eol))
10873 (or (eobp) (forward-char 1)))
10874 (goto-line line)))
10876 (defun org-table-fedit-toggle-ref-type ()
10877 "Convert all references in the buffer from B3 to @3$2 and back."
10878 (interactive)
10879 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10880 (org-table-fedit-convert-buffer
10881 (if org-table-buffer-is-an
10882 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10883 (message "Reference type switched to %s"
10884 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10886 (defun org-table-fedit-ref-up ()
10887 "Shift the reference at point one row/hline up."
10888 (interactive)
10889 (org-table-fedit-shift-reference 'up))
10890 (defun org-table-fedit-ref-down ()
10891 "Shift the reference at point one row/hline down."
10892 (interactive)
10893 (org-table-fedit-shift-reference 'down))
10894 (defun org-table-fedit-ref-left ()
10895 "Shift the reference at point one field to the left."
10896 (interactive)
10897 (org-table-fedit-shift-reference 'left))
10898 (defun org-table-fedit-ref-right ()
10899 "Shift the reference at point one field to the right."
10900 (interactive)
10901 (org-table-fedit-shift-reference 'right))
10903 (defun org-table-fedit-shift-reference (dir)
10904 (cond
10906 (if (memq dir '(left right))
10907 (org-rematch-and-replace 1 (eq dir 'left))
10908 (error "Cannot shift reference in this direction")))
10910 ;; A B3-like reference
10911 (if (memq dir '(up down))
10912 (org-rematch-and-replace 2 (eq dir 'up))
10913 (org-rematch-and-replace 1 (eq dir 'left))))
10914 ((org-at-regexp-p
10916 ;; An internal reference
10917 (if (memq dir '(up down))
10918 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10919 (org-rematch-and-replace 5 (eq dir 'left))))))
10921 (defun org-rematch-and-replace (n &optional decr hline)
10922 "Re-match the group N, and replace it with the shifted refrence."
10923 (or (match-end n) (error "Cannot shift reference in this direction"))
10924 (goto-char (match-beginning n))
10925 (and (looking-at (regexp-quote (match-string n)))
10926 (replace-match (org-shift-refpart (match-string 0) decr hline)
10927 t t)))
10929 (defun org-shift-refpart (ref &optional decr hline)
10930 "Shift a refrence part REF.
10931 If DECR is set, decrease the references row/column, else increase.
10932 If HLINE is set, this may be a hline reference, it certainly is not
10933 a translation reference."
10934 (save-match-data
10935 (let* ((sign (string-match "^[-+]" ref)) n)
10937 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10938 (cond
10939 ((and hline (string-match "^I+" ref))
10940 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10941 (setq n (+ n (if decr -1 1)))
10942 (if (= n 0) (setq n (+ n (if decr -1 1))))
10943 (if sign
10944 (setq sign (if (< n 0) "-" "+") n (abs n))
10945 (setq n (max 1 n)))
10946 (concat sign (make-string n ?I)))
10948 ((string-match "^[0-9]+" ref)
10949 (setq n (string-to-number (concat sign ref)))
10950 (setq n (+ n (if decr -1 1)))
10951 (if sign
10952 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10953 (number-to-string (max 1 n))))
10955 ((string-match "^[a-zA-Z]+" ref)
10956 (org-number-to-letters
10957 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10959 (t (error "Cannot shift reference"))))))
10961 (defun org-table-fedit-toggle-coordinates ()
10962 "Toggle the display of coordinates in the refrenced table."
10963 (interactive)
10964 (let ((pos (marker-position org-pos)))
10965 (with-current-buffer (marker-buffer org-pos)
10966 (save-excursion
10967 (goto-char pos)
10968 (org-table-toggle-coordinate-overlays)))))
10970 (defun org-table-fedit-finish (&optional arg)
10971 "Parse the buffer for formula definitions and install them.
10972 With prefix ARG, apply the new formulas to the table."
10973 (interactive "P")
10974 (org-table-remove-rectangle-highlight)
10975 (if org-table-use-standard-references
10976 (progn
10977 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10978 (setq org-table-buffer-is-an nil)))
10979 (let ((pos org-pos) eql var form)
10980 (goto-char (point-min))
10981 (while (re-search-forward
10983 nil t)
10984 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10985 form (match-string 3))
10986 (setq form (org-trim form))
10987 (when (not (equal form ""))
10989 (setq form (replace-match " " t t form)))
10990 (when (assoc var eql)
10991 (error "Double formulas for %s" var))
10992 (push (cons var form) eql)))
10993 (setq org-pos nil)
10994 (set-window-configuration org-window-configuration)
10995 (select-window (get-buffer-window (marker-buffer pos)))
10996 (goto-char pos)
10997 (unless (org-at-table-p)
10998 (error "Lost table position - cannot install formulae"))
10999 (org-table-store-formulas eql)
11000 (move-marker pos nil)
11001 (kill-buffer "*Edit Formulas*")
11002 (if arg
11003 (org-table-recalculate 'all)
11004 (message "New formulas installed - press C-u C-c C-c to apply."))))
11006 (defun org-table-fedit-abort ()
11007 "Abort editing formulas, without installing the changes."
11008 (interactive)
11009 (org-table-remove-rectangle-highlight)
11010 (let ((pos org-pos))
11011 (set-window-configuration org-window-configuration)
11012 (select-window (get-buffer-window (marker-buffer pos)))
11013 (goto-char pos)
11014 (move-marker pos nil)
11015 (message "Formula editing aborted without installing changes")))
11017 (defun org-table-fedit-lisp-indent ()
11018 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
11019 (interactive)
11020 (let ((pos (point)) beg end ind)
11021 (beginning-of-line 1)
11022 (cond
11024 (goto-char pos)
11025 (call-interactively 'lisp-indent-line))
11027 ((not (fboundp 'pp-buffer))
11028 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
11029 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
11030 (goto-char (- (match-end 0) 2))
11031 (setq beg (point))
11032 (setq ind (make-string (current-column) ?\ ))
11033 (condition-case nil (forward-sexp 1)
11034 (error
11035 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
11036 (setq end (point))
11037 (save-restriction
11038 (narrow-to-region beg end)
11039 (if (eq last-command this-command)
11040 (progn
11041 (goto-char (point-min))
11042 (setq this-command nil)
11044 (replace-match " ")))
11045 (pp-buffer)
11046 (untabify (point-min) (point-max))
11047 (goto-char (1+ (point-min)))
11048 (while (re-search-forward "^." nil t)
11049 (beginning-of-line 1)
11050 (insert ind))
11051 (goto-char (point-max))
11052 (backward-delete-char 1)))
11053 (goto-char beg))
11054 (t nil))))
11056 (defvar org-show-positions nil)
11058 (defun org-table-show-reference (&optional local)
11059 "Show the location/value of the $ expression at point."
11060 (interactive)
11061 (org-table-remove-rectangle-highlight)
11062 (catch 'exit
11063 (let ((pos (if local (point) org-pos))
11064 (face2 'highlight)
11065 (org-inhibit-highlight-removal t)
11066 (win (selected-window))
11067 (org-show-positions nil)
11068 var name e what match dest)
11069 (if local (org-table-get-specials))
11070 (setq what (cond
11071 ((or (org-at-regexp-p org-table-range-regexp2)
11072 (org-at-regexp-p org-table-translate-regexp)
11073 (org-at-regexp-p org-table-range-regexp))
11074 (setq match
11075 (save-match-data
11076 (org-table-convert-refs-to-rc (match-string 0))))
11077 'range)
11080 ((not local) nil)
11081 (t (error "No reference at point")))
11082 match (and what (or match (match-string 0))))
11083 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
11084 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
11085 'secondary-selection))
11086 (org-add-hook 'before-change-functions
11087 'org-table-remove-rectangle-highlight)
11088 (if (eq what 'name) (setq var (substring match 1)))
11089 (when (eq what 'range)
11090 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
11091 (setq match (org-table-formula-substitute-names match)))
11092 (unless local
11093 (save-excursion
11094 (end-of-line 1)
11096 (beginning-of-line 1)
11098 (setq dest
11099 (save-match-data
11100 (org-table-convert-refs-to-rc (match-string 1))))
11101 (org-table-add-rectangle-overlay
11102 (match-beginning 1) (match-end 1) face2))))
11103 (if (and (markerp pos) (marker-buffer pos))
11104 (if (get-buffer-window (marker-buffer pos))
11105 (select-window (get-buffer-window (marker-buffer pos)))
11106 (org-switch-to-buffer-other-window (get-buffer-window
11107 (marker-buffer pos)))))
11108 (goto-char pos)
11109 (org-table-force-dataline)
11110 (when dest
11111 (setq name (substring dest 1))
11112 (cond
11114 (setq e (assoc name org-table-named-field-locations))
11115 (goto-line (nth 1 e))
11116 (org-table-goto-column (nth 2 e)))
11118 (let ((l (string-to-number (match-string 1 dest)))
11119 (c (string-to-number (match-string 2 dest))))
11120 (goto-line (aref org-table-dlines l))
11121 (org-table-goto-column c)))
11122 (t (org-table-goto-column (string-to-number name))))
11123 (move-marker pos (point))
11124 (org-table-highlight-rectangle nil nil face2))
11125 (cond
11126 ((equal dest match))
11127 ((not match))
11128 ((eq what 'range)
11129 (condition-case nil
11130 (save-excursion
11131 (org-table-get-range match nil nil 'highlight))
11132 (error nil)))
11133 ((setq e (assoc var org-table-named-field-locations))
11134 (goto-line (nth 1 e))
11135 (org-table-goto-column (nth 2 e))
11136 (org-table-highlight-rectangle (point) (point))
11137 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11138 ((setq e (assoc var org-table-column-names))
11139 (org-table-goto-column (string-to-number (cdr e)))
11140 (org-table-highlight-rectangle (point) (point))
11141 (goto-char (org-table-begin))
11143 (org-table-end) t)
11144 (progn
11145 (goto-char (match-beginning 1))
11146 (org-table-highlight-rectangle)
11147 (message "Named column (column %s)" (cdr e)))
11148 (error "Column name not found")))
11149 ((eq what 'column)
11150 ;; column number
11151 (org-table-goto-column (string-to-number (substring match 1)))
11152 (org-table-highlight-rectangle (point) (point))
11153 (message "Column %s" (substring match 1)))
11154 ((setq e (assoc var org-table-local-parameters))
11155 (goto-char (org-table-begin))
11157 (progn
11158 (goto-char (match-beginning 1))
11159 (org-table-highlight-rectangle)
11160 (message "Local parameter."))
11161 (error "Parameter not found")))
11162 (t
11163 (cond
11164 ((not var) (error "No reference at point"))
11165 ((setq e (assoc var org-table-formula-constants-local))
11166 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11167 var (cdr e)))
11168 ((setq e (assoc var org-table-formula-constants))
11169 (message "Constant: $%s=%s in `org-table-formula-constants'."
11170 var (cdr e)))
11171 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11172 (message "Constant: $%s=%s, from `constants.el'%s."
11173 var e (format " (%s units)" constants-unit-system)))
11174 (t (error "Undefined name $%s" var)))))
11175 (goto-char pos)
11176 (when (and org-show-positions
11177 (not (memq this-command '(org-table-fedit-scroll
11178 org-table-fedit-scroll-down))))
11179 (push pos org-show-positions)
11180 (push org-table-current-begin-pos org-show-positions)
11181 (let ((min (apply 'min org-show-positions))
11182 (max (apply 'max org-show-positions)))
11183 (goto-char min) (recenter 0)
11184 (goto-char max)
11185 (or (pos-visible-in-window-p max) (recenter -1))))
11186 (select-window win))))
11188 (defun org-table-force-dataline ()
11189 "Make sure the cursor is in a dataline in a table."
11190 (unless (save-excursion
11191 (beginning-of-line 1)
11192 (looking-at org-table-dataline-regexp))
11193 (let* ((re org-table-dataline-regexp)
11194 (p1 (save-excursion (re-search-forward re nil 'move)))
11195 (p2 (save-excursion (re-search-backward re nil 'move))))
11196 (cond ((and p1 p2)
11197 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11198 p1 p2)))
11199 ((or p1 p2) (goto-char (or p1 p2)))
11200 (t (error "No table dataline around here"))))))
11202 (defun org-table-fedit-line-up ()
11203 "Move cursor one line up in the window showing the table."
11204 (interactive)
11205 (org-table-fedit-move 'previous-line))
11207 (defun org-table-fedit-line-down ()
11208 "Move cursor one line down in the window showing the table."
11209 (interactive)
11210 (org-table-fedit-move 'next-line))
11212 (defun org-table-fedit-move (command)
11213 "Move the cursor in the window shoinw the table.
11214 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11215 (let ((org-table-allow-automatic-line-recalculation nil)
11216 (pos org-pos) (win (selected-window)) p)
11217 (select-window (get-buffer-window (marker-buffer org-pos)))
11218 (setq p (point))
11219 (call-interactively command)
11220 (while (and (org-at-table-p)
11221 (org-at-table-hline-p))
11222 (call-interactively command))
11223 (or (org-at-table-p) (goto-char p))
11224 (move-marker pos (point))
11225 (select-window win)))
11227 (defun org-table-fedit-scroll (N)
11228 (interactive "p")
11229 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11230 (scroll-other-window N)))
11232 (defun org-table-fedit-scroll-down (N)
11233 (interactive "p")
11234 (org-table-fedit-scroll (- N)))
11236 (defvar org-table-rectangle-overlays nil)
11238 (defun org-table-add-rectangle-overlay (beg end &optional face)
11239 "Add a new overlay."
11240 (let ((ov (org-make-overlay beg end)))
11241 (org-overlay-put ov 'face (or face 'secondary-selection))
11242 (push ov org-table-rectangle-overlays)))
11244 (defun org-table-highlight-rectangle (&optional beg end face)
11245 "Highlight rectangular region in a table."
11246 (setq beg (or beg (point)) end (or end (point)))
11247 (let ((b (min beg end))
11248 (e (max beg end))
11249 l1 c1 l2 c2 tmp)
11250 (and (boundp 'org-show-positions)
11251 (setq org-show-positions (cons b (cons e org-show-positions))))
11252 (goto-char (min beg end))
11253 (setq l1 (org-current-line)
11254 c1 (org-table-current-column))
11255 (goto-char (max beg end))
11256 (setq l2 (org-current-line)
11257 c2 (org-table-current-column))
11258 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11259 (goto-line l1)
11260 (beginning-of-line 1)
11261 (loop for line from l1 to l2 do
11262 (when (looking-at org-table-dataline-regexp)
11263 (org-table-goto-column c1)
11265 (org-table-goto-column c2)
11267 (org-table-add-rectangle-overlay beg end face))
11268 (beginning-of-line 2))
11269 (goto-char b))
11270 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11272 (defun org-table-remove-rectangle-highlight (&rest ignore)
11273 "Remove the rectangle overlays."
11274 (unless org-inhibit-highlight-removal
11275 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11276 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11277 (setq org-table-rectangle-overlays nil)))
11279 (defvar org-table-coordinate-overlays nil
11280 "Collects the cooordinate grid overlays, so that they can be removed.")
11281 (make-variable-buffer-local 'org-table-coordinate-overlays)
11283 (defun org-table-overlay-coordinates ()
11284 "Add overlays to the table at point, to show row/column coordinates."
11285 (interactive)
11286 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11287 (setq org-table-coordinate-overlays nil)
11288 (save-excursion
11289 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11290 (goto-char (org-table-begin))
11291 (while (org-at-table-p)
11292 (setq eol (point-at-eol))
11293 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11294 (push ov org-table-coordinate-overlays)
11295 (setq hline (looking-at org-table-hline-regexp))
11296 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11297 (format "%4d" (setq id (1+ id)))))
11298 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11299 (when hline
11300 (setq ic 0)
11302 (setq beg (1+ (match-beginning 0))
11303 ic (1+ ic)
11304 s1 (concat "$" (int-to-string ic))
11305 s2 (org-number-to-letters ic)
11306 str (if (eq org-table-use-standard-references t) s2 s1))
11307 (setq ov (org-make-overlay beg (+ beg (length str))))
11308 (push ov org-table-coordinate-overlays)
11309 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11310 (beginning-of-line 2)))))
11312 (defun org-table-toggle-coordinate-overlays ()
11313 "Toggle the display of Row/Column numbers in tables."
11314 (interactive)
11315 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11316 (message "Row/Column number display turned %s"
11317 (if org-table-overlay-coordinates "on" "off"))
11318 (if (and (org-at-table-p) org-table-overlay-coordinates)
11319 (org-table-align))
11320 (unless org-table-overlay-coordinates
11321 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11322 (setq org-table-coordinate-overlays nil)))
11324 (defun org-table-toggle-formula-debugger ()
11325 "Toggle the formula debugger in tables."
11326 (interactive)
11327 (setq org-table-formula-debug (not org-table-formula-debug))
11328 (message "Formula debugging has been turned %s"
11329 (if org-table-formula-debug "on" "off")))
11331 ;;; The orgtbl minor mode
11333 ;; Define a minor mode which can be used in other modes in order to
11334 ;; integrate the org-mode table editor.
11336 ;; This is really a hack, because the org-mode table editor uses several
11337 ;; keys which normally belong to the major mode, for example the TAB and
11338 ;; RET keys. Here is how it works: The minor mode defines all the keys
11339 ;; necessary to operate the table editor, but wraps the commands into a
11340 ;; function which tests if the cursor is currently inside a table. If that
11341 ;; is the case, the table editor command is executed. However, when any of
11342 ;; those keys is used outside a table, the function uses `key-binding' to
11343 ;; look up if the key has an associated command in another currently active
11344 ;; keymap (minor modes, major mode, global), and executes that command.
11345 ;; There might be problems if any of the keys used by the table editor is
11346 ;; otherwise used as a prefix key.
11348 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11349 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11350 ;; addresses this by checking explicitly for both bindings.
11352 ;; The optimized version (see variable `orgtbl-optimized') takes over
11353 ;; all keys which are bound to `self-insert-command' in the *global map*.
11354 ;; Some modes bind other commands to simple characters, for example
11355 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11356 ;; active, this binding is ignored inside tables and replaced with a
11357 ;; modified self-insert.
11359 (defvar orgtbl-mode nil
11360 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11361 table editor in arbitrary modes.")
11362 (make-variable-buffer-local 'orgtbl-mode)
11364 (defvar orgtbl-mode-map (make-keymap)
11365 "Keymap for `orgtbl-mode'.")
11367 ;;;###autoload
11368 (defun turn-on-orgtbl ()
11369 "Unconditionally turn on `orgtbl-mode'."
11370 (orgtbl-mode 1))
11372 (defvar org-old-auto-fill-inhibit-regexp nil
11373 "Local variable used by `orgtbl-mode'")
11376 "Matches a line belonging to an orgtbl.")
11378 (defconst orgtbl-extra-font-lock-keywords
11379 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11380 0 (quote 'org-table) 'prepend))
11381 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11383 ;;;###autoload
11384 (defun orgtbl-mode (&optional arg)
11385 "The `org-mode' table editor as a minor mode for use in other modes."
11386 (interactive)
11387 (if (org-mode-p)
11388 ;; Exit without error, in case some hook functions calls this
11389 ;; by accident in org-mode.
11390 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11391 (setq orgtbl-mode
11392 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11393 (if orgtbl-mode
11394 (progn
11395 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11396 ;; Make sure we are first in minor-mode-map-alist
11397 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11398 (and c (setq minor-mode-map-alist
11399 (cons c (delq c minor-mode-map-alist)))))
11400 (org-set-local (quote org-table-may-need-update) t)
11401 (org-add-hook 'before-change-functions 'org-before-change-function
11402 nil 'local)
11403 (org-set-local 'org-old-auto-fill-inhibit-regexp
11404 auto-fill-inhibit-regexp)
11405 (org-set-local 'auto-fill-inhibit-regexp
11406 (if auto-fill-inhibit-regexp
11408 auto-fill-inhibit-regexp)
11409 orgtbl-line-start-regexp))
11410 (org-add-to-invisibility-spec '(org-cwidth))
11411 (when (fboundp 'font-lock-add-keywords)
11412 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11413 (org-restart-font-lock))
11414 (easy-menu-add orgtbl-mode-menu)
11415 (run-hooks 'orgtbl-mode-hook))
11416 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11417 (org-cleanup-narrow-column-properties)
11418 (org-remove-from-invisibility-spec '(org-cwidth))
11419 (remove-hook 'before-change-functions 'org-before-change-function t)
11420 (when (fboundp 'font-lock-remove-keywords)
11421 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11422 (org-restart-font-lock))
11423 (easy-menu-remove orgtbl-mode-menu)
11424 (force-mode-line-update 'all))))
11426 (defun org-cleanup-narrow-column-properties ()
11427 "Remove all properties related to narrow-column invisibility."
11428 (let ((s 1))
11429 (while (setq s (text-property-any s (point-max)
11430 'display org-narrow-column-arrow))
11431 (remove-text-properties s (1+ s) '(display t)))
11432 (setq s 1)
11433 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11434 (remove-text-properties s (1+ s) '(org-cwidth t)))
11435 (setq s 1)
11436 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11437 (remove-text-properties s (1+ s) '(invisible t)))))
11439 ;; Install it as a minor mode.
11440 (put 'orgtbl-mode :included t)
11441 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11442 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11444 (defun orgtbl-make-binding (fun n &rest keys)
11445 "Create a function for binding in the table minor mode.
11446 FUN is the command to call inside a table. N is used to create a unique
11447 command name. KEYS are keys that should be checked in for a command
11448 to execute outside of tables."
11449 (eval
11450 (list 'defun
11451 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11452 '(arg)
11454 "Outside of tables, run the binding of `"
11455 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11456 "'.")
11457 '(interactive "p")
11458 (list 'if
11459 '(org-at-table-p)
11460 (list 'call-interactively (list 'quote fun))
11461 (list 'let '(orgtbl-mode)
11462 (list 'call-interactively
11463 (append '(or)
11464 (mapcar (lambda (k)
11465 (list 'key-binding k))
11466 keys)
11467 '('orgtbl-error))))))))
11469 (defun orgtbl-error ()
11470 "Error when there is no default binding for a table key."
11471 (interactive)
11472 (error "This key has no function outside tables"))
11474 (defun orgtbl-setup ()
11475 "Setup orgtbl keymaps."
11476 (let ((nfunc 0)
11477 (bindings
11478 (list
11479 '([(meta shift left)] org-table-delete-column)
11480 '([(meta left)] org-table-move-column-left)
11481 '([(meta right)] org-table-move-column-right)
11482 '([(meta shift right)] org-table-insert-column)
11483 '([(meta shift up)] org-table-kill-row)
11484 '([(meta shift down)] org-table-insert-row)
11485 '([(meta up)] org-table-move-row-up)
11486 '([(meta down)] org-table-move-row-down)
11487 '("\C-c\C-w" org-table-cut-region)
11488 '("\C-c\M-w" org-table-copy-region)
11489 '("\C-c\C-y" org-table-paste-rectangle)
11490 '("\C-c-" org-table-insert-hline)
11491 '("\C-c}" org-table-toggle-coordinate-overlays)
11492 '("\C-c{" org-table-toggle-formula-debugger)
11493 '("\C-m" org-table-next-row)
11494 '([(shift return)] org-table-copy-down)
11495 '("\C-c\C-q" org-table-wrap-region)
11496 '("\C-c?" org-table-field-info)
11497 '("\C-c " org-table-blank-field)
11498 '("\C-c+" org-table-sum)
11499 '("\C-c=" org-table-eval-formula)
11500 '("\C-c'" org-table-edit-formulas)
11501 '("\C-c`" org-table-edit-field)
11502 '("\C-c*" org-table-recalculate)
11503 '("\C-c|" org-table-create-or-convert-from-region)
11504 '("\C-c^" org-table-sort-lines)
11505 '([(control ?#)] org-table-rotate-recalc-marks)))
11506 elt key fun cmd)
11507 (while (setq elt (pop bindings))
11508 (setq nfunc (1+ nfunc))
11509 (setq key (org-key (car elt))
11510 fun (nth 1 elt)
11511 cmd (orgtbl-make-binding fun nfunc key))
11512 (org-defkey orgtbl-mode-map key cmd))
11514 ;; Special treatment needed for TAB and RET
11515 (org-defkey orgtbl-mode-map [(return)]
11516 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11517 (org-defkey orgtbl-mode-map "\C-m"
11518 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11520 (org-defkey orgtbl-mode-map [(tab)]
11521 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11522 (org-defkey orgtbl-mode-map "\C-i"
11523 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11525 (org-defkey orgtbl-mode-map [(shift tab)]
11526 (orgtbl-make-binding 'org-table-previous-field 104
11527 [(shift tab)] [(tab)] "\C-i"))
11529 (org-defkey orgtbl-mode-map "\M-\C-m"
11530 (orgtbl-make-binding 'org-table-wrap-region 105
11531 "\M-\C-m" [(meta return)]))
11532 (org-defkey orgtbl-mode-map [(meta return)]
11533 (orgtbl-make-binding 'org-table-wrap-region 106
11534 [(meta return)] "\M-\C-m"))
11536 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11537 (when orgtbl-optimized
11538 ;; If the user wants maximum table support, we need to hijack
11539 ;; some standard editing functions
11540 (org-remap orgtbl-mode-map
11541 'self-insert-command 'orgtbl-self-insert-command
11542 'delete-char 'org-delete-char
11543 'delete-backward-char 'org-delete-backward-char)
11544 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11545 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11546 '("OrgTbl"
11547 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11548 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11549 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11550 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11551 "--"
11552 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11553 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11554 ["Copy Field from Above"
11555 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11556 "--"
11557 ("Column"
11558 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11559 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11560 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11561 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11562 ("Row"
11563 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11564 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11565 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11566 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11567 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
11568 "--"
11569 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11570 ("Rectangle"
11571 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11572 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11573 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11574 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11575 "--"
11576 ("Radio tables"
11577 ["Insert table template" orgtbl-insert-radio-table
11578 (assq major-mode orgtbl-radio-table-templates)]
11579 ["Comment/uncomment table" orgtbl-toggle-comment t])
11580 "--"
11581 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11582 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11583 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11584 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11585 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11586 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11587 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11588 ["Sum Column/Rectangle" org-table-sum
11589 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11590 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11591 ["Debug Formulas"
11592 org-table-toggle-formula-debugger :active (org-at-table-p)
11593 :keys "C-c {"
11594 :style toggle :selected org-table-formula-debug]
11595 ["Show Col/Row Numbers"
11596 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11597 :keys "C-c }"
11598 :style toggle :selected org-table-overlay-coordinates]
11599 ))
11600 t))
11602 (defun orgtbl-ctrl-c-ctrl-c (arg)
11603 "If the cursor is inside a table, realign the table.
11604 It it is a table to be sent away to a receiver, do it.
11605 With prefix arg, also recompute table."
11606 (interactive "P")
11607 (let ((pos (point)) action)
11608 (save-excursion
11609 (beginning-of-line 1)
11613 (cond
11614 ((integerp action)
11615 (goto-char action)
11616 (org-table-maybe-eval-formula)
11617 (if arg
11618 (call-interactively 'org-table-recalculate)
11619 (org-table-maybe-recalculate-line))
11620 (call-interactively 'org-table-align)
11621 (orgtbl-send-table 'maybe))
11622 ((eq action 'recalc)
11623 (save-excursion
11624 (beginning-of-line 1)
11626 (if (org-at-table-p)
11627 (org-call-with-arg 'org-table-recalculate t))))
11628 (t (let (orgtbl-mode)
11629 (call-interactively (key-binding "\C-c\C-c")))))))
11631 (defun orgtbl-tab (arg)
11632 "Justification and field motion for `orgtbl-mode'."
11633 (interactive "P")
11634 (if arg (org-table-edit-field t)
11635 (org-table-justify-field-maybe)
11636 (org-table-next-field)))
11638 (defun orgtbl-ret ()
11639 "Justification and field motion for `orgtbl-mode'."
11640 (interactive)
11641 (org-table-justify-field-maybe)
11642 (org-table-next-row))
11644 (defun orgtbl-self-insert-command (N)
11645 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11646 If the cursor is in a table looking at whitespace, the whitespace is
11647 overwritten, and the table is not marked as requiring realignment."
11648 (interactive "p")
11649 (if (and (org-at-table-p)
11650 (or
11651 (and org-table-auto-blank-field
11652 (member last-command
11653 '(orgtbl-hijacker-command-100
11654 orgtbl-hijacker-command-101
11655 orgtbl-hijacker-command-102
11656 orgtbl-hijacker-command-103
11657 orgtbl-hijacker-command-104
11658 orgtbl-hijacker-command-105))
11659 (org-table-blank-field))
11660 t)
11661 (eq N 1)
11663 (let (org-table-may-need-update)
11664 (goto-char (1- (match-end 0)))
11665 (delete-backward-char 1)
11666 (goto-char (match-beginning 0))
11667 (self-insert-command N))
11668 (setq org-table-may-need-update t)
11669 (let (orgtbl-mode)
11670 (call-interactively (key-binding (vector last-input-event))))))
11672 (defun org-force-self-insert (N)
11673 "Needed to enforce self-insert under remapping."
11674 (interactive "p")
11675 (self-insert-command N))
11678 "Regula expression matching exponentials as produced by calc.")
11680 (defvar org-table-clean-did-remove-column nil)
11682 (defun orgtbl-export (table target)
11683 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11685 org-table-last-alignment org-table-last-column-widths
11686 maxcol column)
11687 (if (not (fboundp func))
11688 (error "Cannot export orgtbl table to %s" target))
11689 (setq lines (org-table-clean-before-export lines))
11690 (setq table
11691 (mapcar
11692 (lambda (x)
11693 (if (string-match org-table-hline-regexp x)
11694 'hline
11696 lines))
11697 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11698 table)))
11699 (loop for i from (1- maxcol) downto 0 do
11700 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11701 (setq column (delq nil column))
11702 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11703 (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))
11704 (funcall func table nil)))
11706 (defun orgtbl-send-table (&optional maybe)
11707 "Send a tranformed version of this table to the receiver position.
11708 With argument MAYBE, fail quietly if no transformation is defined for
11709 this table."
11710 (interactive)
11711 (catch 'exit
11712 (unless (org-at-table-p) (error "Not at a table"))
11713 ;; when non-interactive, we assume align has just happened.
11714 (when (interactive-p) (org-table-align))
11715 (save-excursion
11716 (goto-char (org-table-begin))
11717 (beginning-of-line 0)
11719 (if maybe
11720 (throw 'exit nil)
11721 (error "Don't know how to transform this table."))))
11722 (let* ((name (match-string 1))
11723 beg
11724 (transform (intern (match-string 2)))
11725 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11726 (skip (plist-get params :skip))
11727 (skipcols (plist-get params :skipcols))
11728 (txt (buffer-substring-no-properties
11729 (org-table-begin) (org-table-end)))
11731 (lines (org-table-clean-before-export lines))
11732 (i0 (if org-table-clean-did-remove-column 2 1))
11733 (table (mapcar
11734 (lambda (x)
11735 (if (string-match org-table-hline-regexp x)
11736 'hline
11737 (org-remove-by-index
11739 skipcols i0)))
11740 lines))
11741 (fun (if (= i0 2) 'cdr 'identity))
11742 (org-table-last-alignment
11743 (org-remove-by-index (funcall fun org-table-last-alignment)
11744 skipcols i0))
11745 (org-table-last-column-widths
11746 (org-remove-by-index (funcall fun org-table-last-column-widths)
11747 skipcols i0)))
11749 (unless (fboundp transform)
11750 (error "No such transformation function %s" transform))
11751 (setq txt (funcall transform table params))
11752 ;; Find the insertion place
11753 (save-excursion
11754 (goto-char (point-min))
11755 (unless (re-search-forward
11757 (error "Don't know where to insert translated table"))
11758 (goto-char (match-beginning 0))
11759 (beginning-of-line 2)
11760 (setq beg (point))
11761 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11762 (error "Cannot find end of insertion region"))
11763 (beginning-of-line 1)
11764 (delete-region beg (point))
11765 (goto-char beg)
11767 (message "Table converted and installed at receiver location"))))
11769 (defun org-remove-by-index (list indices &optional i0)
11770 "Remove the elements in LIST with indices in INDICES.
11771 First element has index 0, or I0 if given."
11772 (if (not indices)
11773 list
11774 (if (integerp indices) (setq indices (list indices)))
11775 (setq i0 (1- (or i0 0)))
11776 (delq :rm (mapcar (lambda (x)
11777 (setq i0 (1+ i0))
11778 (if (memq i0 indices) :rm x))
11779 list))))
11781 (defun orgtbl-toggle-comment ()
11782 "Comment or uncomment the orgtbl at point."
11783 (interactive)
11784 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11785 (re2 (concat "^" orgtbl-line-start-regexp))
11786 (commented (save-excursion (beginning-of-line 1)
11787 (cond ((looking-at re1) t)
11788 ((looking-at re2) nil)
11789 (t (error "Not at an org table")))))
11790 (re (if commented re1 re2))
11791 beg end)
11792 (save-excursion
11793 (beginning-of-line 1)
11794 (while (looking-at re) (beginning-of-line 0))
11795 (beginning-of-line 2)
11796 (setq beg (point))
11797 (while (looking-at re) (beginning-of-line 2))
11798 (setq end (point)))
11799 (comment-region beg end (if commented '(4) nil))))
11801 (defun orgtbl-insert-radio-table ()
11802 "Insert a radio table template appropriate for this major mode."
11803 (interactive)
11804 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11805 (txt (nth 1 e))
11806 name pos)
11807 (unless e (error "No radio table setup defined for %s" major-mode))
11808 (setq name (read-string "Table name: "))
11809 (while (string-match "%n" txt)
11810 (setq txt (replace-match name t t txt)))
11812 (setq pos (point))
11813 (insert txt)
11814 (goto-char pos)))
11816 (defun org-get-param (params header i sym &optional hsym)
11817 "Get parameter value for symbol SYM.
11818 If this is a header line, actually get the value for the symbol with an
11820 If the value is a protperty list, get the element for the current column.
11821 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11822 (let ((val (plist-get params sym)))
11823 (and hsym header (setq val (or (plist-get params hsym) val)))
11824 (if (consp val) (plist-get val i) val)))
11826 (defun orgtbl-to-generic (table params)
11827 "Convert the orgtbl-mode TABLE to some other format.
11828 This generic routine can be used for many standard cases.
11829 TABLE is a list, each entry either the symbol `hline' for a horizontal
11830 separator line, or a list of fields for that line.
11831 PARAMS is a property list of parameters that can influence the conversion.
11832 For the generic converter, some parameters are obligatory: You need to
11833 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11834 :splice, you must have :tstart and :tend.
11836 Valid parameters are
11838 :tstart String to start the table. Ignored when :splice is t.
11839 :tend String to end the table. Ignored when :splice is t.
11841 :splice When set to t, return only table body lines, don't wrap
11842 them into :tstart and :tend. Default is nil.
11844 :hline String to be inserted on horizontal separation lines.
11845 May be nil to ignore hlines.
11847 :lstart String to start a new table line.
11848 :lend String to end a table line
11849 :sep Separator between two fields
11850 :lfmt Format for entire line, with enough %s to capture all fields.
11851 If this is present, :lstart, :lend, and :sep are ignored.
11852 :fmt A format to be used to wrap the field, should contain
11853 %s for the original field value. For example, to wrap
11855 This may also be a property list with column numbers and
11858 :hlstart :hlend :hlsep :hlfmt :hfmt
11859 Same as above, specific for the header lines in the table.
11860 All lines before the first hline are treated as header.
11861 If any of these is not present, the data line value is used.
11863 :efmt Use this format to print numbers with exponentials.
11864 The format should have %s twice for inserting mantissa
11866 may also be a property list with column numbers and
11867 formats. :fmt will still be applied after :efmt.
11869 In addition to this, the parameters :skip and :skipcols are always handled
11870 directly by `orgtbl-send-table'. See manual."
11871 (interactive)
11872 (let* ((p params)
11873 (splicep (plist-get p :splice))
11874 (hline (plist-get p :hline))
11875 rtn line i fm efm lfmt h)
11877 ;; Do we have a header?
11878 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11879 (setq h t))
11881 ;; Put header
11882 (unless splicep
11883 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11885 ;; Now loop over all lines
11886 (while (setq line (pop table))
11887 (if (eq line 'hline)
11888 ;; A horizontal separator line
11889 (progn (if hline (push hline rtn))
11890 (setq h nil)) ; no longer in header
11891 ;; A normal line. Convert the fields, push line onto the result list
11892 (setq i 0)
11893 (setq line
11894 (mapcar
11895 (lambda (f)
11896 (setq i (1+ i)
11897 fm (org-get-param p h i :fmt :hfmt)
11898 efm (org-get-param p h i :efmt))
11899 (if (and efm (string-match orgtbl-exp-regexp f))
11900 (setq f (format
11901 efm (match-string 1 f) (match-string 2 f))))
11902 (if fm (setq f (format fm f)))
11903 f)
11904 line))
11905 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11906 (push (apply 'format lfmt line) rtn)
11907 (push (concat
11908 (org-get-param p h i :lstart :hlstart)
11909 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11910 (org-get-param p h i :lend :hlend))
11911 rtn))))
11913 (unless splicep
11914 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11918 (defun orgtbl-to-latex (table params)
11919 "Convert the orgtbl-mode TABLE to LaTeX.
11920 TABLE is a list, each entry either the symbol `hline' for a horizontal
11921 separator line, or a list of fields for that line.
11922 PARAMS is a property list of parameters that can influence the conversion.
11923 Supports all parameters from `orgtbl-to-generic'. Most important for
11924 LaTeX are:
11926 :splice When set to t, return only table body lines, don't wrap
11927 them into a tabular environment. Default is nil.
11929 :fmt A format to be used to wrap the field, should contain %s for the
11930 original field value. For example, to wrap everything in dollars,
11934 :efmt Format for transforming numbers with exponentials. The format
11935 should have %s twice for inserting mantissa and exponent, for
11937 This may also be a property list with column numbers and formats.
11939 The general parameters :skip and :skipcols have already been applied when
11940 this function is called."
11941 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11942 org-table-last-alignment ""))
11943 (params2
11944 (list
11949 (orgtbl-to-generic table (org-combine-plists params2 params))))
11951 (defun orgtbl-to-html (table params)
11952 "Convert the orgtbl-mode TABLE to LaTeX.
11953 TABLE is a list, each entry either the symbol `hline' for a horizontal
11954 separator line, or a list of fields for that line.
11955 PARAMS is a property list of parameters that can influence the conversion.
11956 Currently this function recognizes the following parameters:
11958 :splice When set to t, return only table body lines, don't wrap
11959 them into a <table> environment. Default is nil.
11961 The general parameters :skip and :skipcols have already been applied when
11962 this function is called. The function does *not* use `orgtbl-to-generic',
11963 so you cannot specify parameters for it."
11964 (let* ((splicep (plist-get params :splice))
11965 html)
11966 ;; Just call the formatter we already have
11967 ;; We need to make text lines for it, so put the fields back together.
11968 (setq html (org-format-org-table-html
11969 (mapcar
11970 (lambda (x)
11971 (if (eq x 'hline)
11972 "|----+----|"
11973 (concat "| " (mapconcat 'identity x " | ") " |")))
11974 table)
11975 splicep))
11977 (setq html (replace-match "" t t html)))
11978 html))
11980 (defun orgtbl-to-texinfo (table params)
11981 "Convert the orgtbl-mode TABLE to TeXInfo.
11982 TABLE is a list, each entry either the symbol `hline' for a horizontal
11983 separator line, or a list of fields for that line.
11984 PARAMS is a property list of parameters that can influence the conversion.
11985 Supports all parameters from `orgtbl-to-generic'. Most important for
11986 TeXInfo are:
11988 :splice nil/t When set to t, return only table body lines, don't wrap
11989 them into a multitable environment. Default is nil.
11991 :fmt fmt A format to be used to wrap the field, should contain
11992 %s for the original field value. For example, to wrap
11994 This may also be a property list with column numbers and
11998 are computed automatically from the width of the columns
11999 under org-mode.
12001 The general parameters :skip and :skipcols have already been applied when
12002 this function is called."
12003 (let* ((total (float (apply '+ org-table-last-column-widths)))
12004 (colfrac (or (plist-get params :cf)
12005 (mapconcat
12006 (lambda (x) (format "%.3f" (/ (float x) total)))
12007 org-table-last-column-widths " ")))
12008 (params2
12009 (list
12010 :tstart (concat "@multitable @columnfractions " colfrac)
12011 :tend "@end multitable"
12012 :lstart "@item " :lend "" :sep " @tab "
12013 :hlstart "@headitem ")))
12014 (orgtbl-to-generic table (org-combine-plists params2 params))))
12016 ;;;; Link Stuff
12018 ;;; Link abbreviations
12020 (defun org-link-expand-abbrev (link)
12021 "Apply replacements as defined in `org-link-abbrev-alist."
12023 (let* ((key (match-string 1 link))
12024 (as (or (assoc key org-link-abbrev-alist-local)
12025 (assoc key org-link-abbrev-alist)))
12026 (tag (and (match-end 2) (match-string 3 link)))
12027 rpl)
12028 (if (not as)
12029 link
12030 (setq rpl (cdr as))
12031 (cond
12032 ((symbolp rpl) (funcall rpl tag))
12033 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
12034 (t (concat rpl tag)))))
12035 link))
12037 ;;; Storing and inserting links
12039 (defvar org-insert-link-history nil
12040 "Minibuffer history for links inserted with `org-insert-link'.")
12042 (defvar org-stored-links nil
12043 "Contains the links stored with `org-store-link'.")
12045 (defvar org-store-link-plist nil
12046 "Plist with info about the most recently link created with `org-store-link'.")
12048 (defvar org-link-protocols nil
12049 "Link protocols added to Org-mode using `org-add-link-type'.")
12051 (defvar org-store-link-functions nil
12052 "List of functions that are called to create and store a link.
12053 Each function will be called in turn until one returns a non-nil
12054 value. Each function should check if it is responsible for creating
12055 this link (for example by looking at the major mode).
12056 If not, it must exit and return nil.
12057 If yes, it should return a non-nil value after a calling
12058 `org-store-link-props' with a list of properties and values.
12059 Special properties are:
12063 This is obligatory as well.
12064 :description Optional default description for the second pair
12065 of brackets in an Org-mode link. The user can still change
12066 this when inserting this link into an Org-mode buffer.
12068 In addition to these, any additional properties can be specified
12069 and then used in remember templates.")
12071 (defun org-add-link-type (type &optional follow publish)
12072 "Add TYPE to the list of `org-link-types'.
12073 Re-compute all regular expressions depending on `org-link-types'
12074 FOLLOW and PUBLISH are two functions. Both take the link path as
12075 an argument.
12076 FOLLOW should do whatever is necessary to follow the link, for example
12077 to find a file or display a mail message.
12079 PUBLISH takes the path and retuns the string that should be used when
12080 this document is published. FIMXE: This is actually not yet implemented."
12081 (add-to-list 'org-link-types type t)
12082 (org-make-link-regexps)
12083 (add-to-list 'org-link-protocols
12084 (list type follow publish)))
12086 (defun org-add-agenda-custom-command (entry)
12087 "Replace or add a command in `org-agenda-custom-commands'.
12088 This is mostly for hacking and trying a new command - once the command
12089 works you probably want to add it to `org-agenda-custom-commands' for good."
12090 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
12091 (if ass
12092 (setcdr ass (cdr entry))
12093 (push entry org-agenda-custom-commands))))
12095 ;;;###autoload
12096 (defun org-store-link (arg)
12098 This link is added to `org-stored-links' and can later be inserted
12101 For some link types, a prefix arg is interpreted:
12102 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12103 For file links, arg negates `org-context-in-file-links'."
12104 (interactive "P")
12105 (setq org-store-link-plist nil) ; reset
12106 (let (link cpltxt desc description search txt)
12107 (cond
12109 ((run-hook-with-args-until-success 'org-store-link-functions)
12110 (setq link (plist-get org-store-link-plist :link)
12111 desc (or (plist-get org-store-link-plist :description) link)))
12113 ((eq major-mode 'bbdb-mode)
12114 (let ((name (bbdb-record-name (bbdb-current-record)))
12115 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
12116 (setq cpltxt (concat "bbdb:" (or name company))
12117 link (org-make-link cpltxt))
12118 (org-store-link-props :type "bbdb" :name name :company company)))
12120 ((eq major-mode 'Info-mode)
12121 (setq link (org-make-link "info:"
12122 (file-name-nondirectory Info-current-file)
12123 ":" Info-current-node))
12124 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
12125 ":" Info-current-node))
12126 (org-store-link-props :type "info" :file Info-current-file
12127 :node Info-current-node))
12129 ((eq major-mode 'calendar-mode)
12130 (let ((cd (calendar-cursor-to-date)))
12131 (setq link
12132 (format-time-string
12133 (car org-time-stamp-formats)
12134 (apply 'encode-time
12135 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12136 nil nil nil))))
12137 (org-store-link-props :type "calendar" :date cd)))
12139 ((or (eq major-mode 'vm-summary-mode)
12140 (eq major-mode 'vm-presentation-mode))
12141 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
12142 (vm-follow-summary-cursor)
12143 (save-excursion
12144 (vm-select-folder-buffer)
12145 (let* ((message (car vm-message-pointer))
12146 (folder buffer-file-name)
12147 (subject (vm-su-subject message))
12148 (to (vm-get-header-contents message "To"))
12149 (from (vm-get-header-contents message "From"))
12150 (message-id (vm-su-message-id message)))
12151 (org-store-link-props :type "vm" :from from :to to :subject subject
12152 :message-id message-id)
12153 (setq message-id (org-remove-angle-brackets message-id))
12154 (setq folder (abbreviate-file-name folder))
12155 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
12156 folder)
12157 (setq folder (replace-match "" t t folder)))
12158 (setq cpltxt (org-email-link-description))
12159 (setq link (org-make-link "vm:" folder "#" message-id)))))
12161 ((eq major-mode 'wl-summary-mode)
12162 (let* ((msgnum (wl-summary-message-number))
12163 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12164 msgnum 'message-id))
12165 (wl-message-entity
12166 (if (fboundp 'elmo-message-entity)
12167 (elmo-message-entity
12168 wl-summary-buffer-elmo-folder msgnum)
12169 (elmo-msgdb-overview-get-entity
12170 msgnum (wl-summary-buffer-msgdb))))
12171 (from (wl-summary-line-from))
12172 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12173 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12174 (wl-summary-line-subject))))
12175 (org-store-link-props :type "wl" :from from :to to
12176 :subject subject :message-id message-id)
12177 (setq message-id (org-remove-angle-brackets message-id))
12178 (setq cpltxt (org-email-link-description))
12179 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12180 "#" message-id))))
12182 ((or (equal major-mode 'mh-folder-mode)
12183 (equal major-mode 'mh-show-mode))
12184 (let ((from (org-mhe-get-header "From:"))
12185 (to (org-mhe-get-header "To:"))
12186 (message-id (org-mhe-get-header "Message-Id:"))
12187 (subject (org-mhe-get-header "Subject:")))
12188 (org-store-link-props :type "mh" :from from :to to
12189 :subject subject :message-id message-id)
12190 (setq cpltxt (org-email-link-description))
12191 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12192 (org-remove-angle-brackets message-id)))))
12194 ((or (eq major-mode 'rmail-mode)
12195 (eq major-mode 'rmail-summary-mode))
12196 (save-window-excursion
12197 (save-restriction
12198 (when (eq major-mode 'rmail-summary-mode)
12199 (rmail-show-message rmail-current-message))
12200 (rmail-narrow-to-non-pruned-header)
12201 (let ((folder buffer-file-name)
12202 (message-id (mail-fetch-field "message-id"))
12203 (from (mail-fetch-field "from"))
12204 (to (mail-fetch-field "to"))
12205 (subject (mail-fetch-field "subject")))
12206 (org-store-link-props
12207 :type "rmail" :from from :to to
12208 :subject subject :message-id message-id)
12209 (setq message-id (org-remove-angle-brackets message-id))
12210 (setq cpltxt (org-email-link-description))
12211 (setq link (org-make-link "rmail:" folder "#" message-id)))
12212 (rmail-show-message rmail-current-message))))
12214 ((eq major-mode 'gnus-group-mode)
12215 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12216 (gnus-group-group-name)) ; version
12217 ((fboundp 'gnus-group-name)
12218 (gnus-group-name))
12219 (t "???"))))
12220 (unless group (error "Not on a group"))
12221 (org-store-link-props :type "gnus" :group group)
12222 (setq cpltxt (concat
12223 (if (org-xor arg org-usenet-links-prefer-google)
12224 "http://groups.google.com/groups?group="
12225 "gnus:")
12226 group)
12227 link (org-make-link cpltxt))))
12229 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12230 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12231 (let* ((group gnus-newsgroup-name)
12232 (article (gnus-summary-article-number))
12233 (header (gnus-summary-article-header article))
12234 (from (mail-header-from header))
12235 (message-id (mail-header-id header))
12236 (date (mail-header-date header))
12237 (subject (gnus-summary-subject-string)))
12238 (org-store-link-props :type "gnus" :from from :subject subject
12239 :message-id message-id :group group)
12240 (setq cpltxt (org-email-link-description))
12241 (if (org-xor arg org-usenet-links-prefer-google)
12242 (setq link
12243 (concat
12245 (format "http://groups.google.com/groups?as_umsgid=%s"
12246 (org-fixup-message-id-for-http message-id))))
12247 (setq link (org-make-link "gnus:" group
12248 "#" (number-to-string article))))))
12250 ((eq major-mode 'w3-mode)
12251 (setq cpltxt (url-view-url t)
12252 link (org-make-link cpltxt))
12253 (org-store-link-props :type "w3" :url (url-view-url t)))
12255 ((eq major-mode 'w3m-mode)
12256 (setq cpltxt (or w3m-current-title w3m-current-url)
12257 link (org-make-link w3m-current-url))
12258 (org-store-link-props :type "w3m" :url (url-view-url t)))
12260 ((setq search (run-hook-with-args-until-success
12261 'org-create-file-search-functions))
12262 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12263 "::" search))
12264 (setq cpltxt (or description link)))
12266 ((eq major-mode 'image-mode)
12267 (setq cpltxt (concat "file:"
12268 (abbreviate-file-name buffer-file-name))
12269 link (org-make-link cpltxt))
12270 (org-store-link-props :type "image" :file buffer-file-name))
12272 ((eq major-mode 'dired-mode)
12273 ;; link to the file in the current line
12274 (setq cpltxt (concat "file:"
12275 (abbreviate-file-name
12276 (expand-file-name
12277 (dired-get-filename nil t))))
12278 link (org-make-link cpltxt)))
12280 ((and buffer-file-name (org-mode-p))
12281 ;; Just link to current headline
12282 (setq cpltxt (concat "file:"
12283 (abbreviate-file-name buffer-file-name)))
12284 ;; Add a context search string
12285 (when (org-xor org-context-in-file-links arg)
12286 ;; Check if we are on a target
12288 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12289 (setq txt (cond
12290 ((org-on-heading-p) nil)
12291 ((org-region-active-p)
12292 (buffer-substring (region-beginning) (region-end)))
12293 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12295 (setq cpltxt
12296 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12297 desc "NONE"))))
12299 (setq cpltxt (substring cpltxt 0 -2)))
12300 (setq link (org-make-link cpltxt)))
12302 ((buffer-file-name (buffer-base-buffer))
12303 ;; Just link to this file here.
12304 (setq cpltxt (concat "file:"
12305 (abbreviate-file-name
12306 (buffer-file-name (buffer-base-buffer)))))
12307 ;; Add a context string
12308 (when (org-xor org-context-in-file-links arg)
12309 (setq txt (if (org-region-active-p)
12310 (buffer-substring (region-beginning) (region-end))
12311 (buffer-substring (point-at-bol) (point-at-eol))))
12312 ;; Only use search option if there is some text.
12314 (setq cpltxt
12315 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12316 desc "NONE")))
12317 (setq link (org-make-link cpltxt)))
12319 ((interactive-p)
12320 (error "Cannot link to a buffer which is not visiting a file"))
12322 (t (setq link nil)))
12324 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12325 (setq link (or link cpltxt)
12326 desc (or desc cpltxt))
12327 (if (equal desc "NONE") (setq desc nil))
12329 (if (and (interactive-p) link)
12330 (progn
12331 (setq org-stored-links
12332 (cons (list link desc) org-stored-links))
12333 (message "Stored: %s" (or desc link)))
12334 (and link (org-make-link-string link desc)))))
12336 (defun org-store-link-props (&rest plist)
12337 "Store link properties, extract names and addresses."
12338 (let (x adr)
12339 (when (setq x (plist-get plist :from))
12340 (setq adr (mail-extract-address-components x))
12341 (plist-put plist :fromname (car adr))
12342 (plist-put plist :fromaddress (nth 1 adr)))
12343 (when (setq x (plist-get plist :to))
12344 (setq adr (mail-extract-address-components x))
12345 (plist-put plist :toname (car adr))
12346 (plist-put plist :toaddress (nth 1 adr))))
12347 (let ((from (plist-get plist :from))
12348 (to (plist-get plist :to)))
12349 (when (and from to org-from-is-user-regexp)
12350 (plist-put plist :fromto
12351 (if (string-match org-from-is-user-regexp from)
12352 (concat "to %t")
12353 (concat "from %f")))))
12354 (setq org-store-link-plist plist))
12356 (defun org-email-link-description (&optional fmt)
12357 "Return the description part of an email link.
12358 This takes information from `org-store-link-plist' and formats it
12359 according to FMT (default from `org-email-link-description-format')."
12360 (setq fmt (or fmt org-email-link-description-format))
12361 (let* ((p org-store-link-plist)
12362 (to (plist-get p :toaddress))
12363 (from (plist-get p :fromaddress))
12364 (table
12365 (list
12366 (cons "%c" (plist-get p :fromto))
12367 (cons "%F" (plist-get p :from))
12368 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12369 (cons "%T" (plist-get p :to))
12370 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12371 (cons "%s" (plist-get p :subject))
12372 (cons "%m" (plist-get p :message-id)))))
12373 (when (string-match "%c" fmt)
12374 ;; Check if the user wrote this message
12375 (if (and org-from-is-user-regexp from to
12376 (save-match-data (string-match org-from-is-user-regexp from)))
12377 (setq fmt (replace-match "to %t" t t fmt))
12378 (setq fmt (replace-match "from %f" t t fmt))))
12379 (org-replace-escapes fmt table)))
12381 (defun org-make-org-heading-search-string (&optional string heading)
12382 "Make search string for STRING or current headline."
12383 (interactive)
12384 (let ((s (or string (org-get-heading))))
12385 (unless (and string (not heading))
12386 ;; We are using a headline, clean up garbage in there.
12387 (if (string-match org-todo-regexp s)
12388 (setq s (replace-match "" t t s)))
12390 (setq s (replace-match "" t t s)))
12391 (setq s (org-trim s))
12394 (setq s (replace-match "" t t s)))
12395 (while (string-match org-ts-regexp s)
12396 (setq s (replace-match "" t t s))))
12398 (setq s (replace-match " " t t s)))
12399 (or string (setq s (concat "*" s))) ; Add * for headlines
12402 (defun org-make-link (&rest strings)
12403 "Concatenate STRINGS."
12404 (apply 'concat strings))
12406 (defun org-make-link-string (link &optional description)
12407 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12409 (error "Empty link"))
12410 (when (stringp description)
12411 ;; Remove brackets from the description, they are fatal.
12413 (setq description (replace-match "{" t t description)))
12415 (setq description (replace-match "}" t t description))))
12416 (when (equal (org-link-escape link) description)
12417 ;; No description needed, it is identical
12418 (setq description nil))
12419 (when (and (not description)
12420 (not (equal link (org-link-escape link))))
12421 (setq description link))
12422 (concat "[[" (org-link-escape link) "]"
12423 (if description (concat "[" description "]") "")
12424 "]"))
12426 (defconst org-link-escape-chars
12427 '((?\ . "%20")
12428 (?\[ . "%5B")
12429 (?\] . "%5D")
12440 (?\; . "%3B")
12441 (?? . "%3F")
12442 (?= . "%3D")
12443 (?+ . "%2B")
12444 )
12445 "Association list of escapes for some characters problematic in links.
12446 This is the list that is used for internal purposes.")
12448 (defconst org-link-escape-chars-browser
12449 '((?\ . "%20")) ; 32 for the SPC char
12450 "Association list of escapes for some characters problematic in links.
12451 This is the list that is used before handing over to the browser.")
12453 (defun org-link-escape (text &optional table)
12454 "Escape charaters in TEXT that are problematic for links."
12455 (setq table (or table org-link-escape-chars))
12456 (when text
12457 (let ((re (mapconcat (lambda (x) (regexp-quote
12458 (char-to-string (car x))))
12460 (while (string-match re text)
12461 (setq text
12462 (replace-match
12463 (cdr (assoc (string-to-char (match-string 0 text))
12464 table))
12465 t t text)))
12466 text)))
12468 (defun org-link-unescape (text &optional table)
12469 "Reverse the action of `org-link-escape'."
12470 (setq table (or table org-link-escape-chars))
12471 (when text
12472 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12474 (while (string-match re text)
12475 (setq text
12476 (replace-match
12477 (char-to-string (car (rassoc (match-string 0 text) table)))
12478 t t text)))
12479 text)))
12481 (defun org-xor (a b)
12482 "Exclusive or."
12483 (if a (not b) b))
12485 (defun org-get-header (header)
12486 "Find a header field in the current buffer."
12487 (save-excursion
12488 (goto-char (point-min))
12489 (let ((case-fold-search t) s)
12490 (cond
12491 ((eq header 'from)
12493 (setq s (match-string 1)))
12495 (setq s (replace-match "" t t s)))
12496 (if (string-match "[<(].*" s)
12497 (setq s (replace-match "" t t s))))
12498 ((eq header 'message-id)
12500 (setq s (match-string 1))))
12501 ((eq header 'subject)
12503 (setq s (match-string 1)))))
12506 s)))
12509 (defun org-fixup-message-id-for-http (s)
12510 "Replace special characters in a message id, so it can be used in an http query."
12511 (while (string-match "<" s)
12512 (setq s (replace-match "%3C" t t s)))
12513 (while (string-match ">" s)
12514 (setq s (replace-match "%3E" t t s)))
12515 (while (string-match "@" s)
12516 (setq s (replace-match "%40" t t s)))
12517 s)
12519 ;;;###autoload
12520 (defun org-insert-link-global ()
12521 "Insert a link like Org-mode does.
12522 This command can be called in any mode to insert a link in Org-mode syntax."
12523 (interactive)
12524 (org-run-like-in-org-mode 'org-insert-link))
12526 (defun org-insert-link (&optional complete-file)
12527 "Insert a link. At the prompt, enter the link.
12529 Completion can be used to select a link previously stored with
12530 `org-store-link'. When the empty string is entered (i.e. if you just
12531 press RET at the prompt), the link defaults to the most recently
12532 stored link. As SPC triggers completion in the minibuffer, you need to
12533 use M-SPC or C-q SPC to force the insertion of a space character.
12535 You will also be prompted for a description, and if one is given, it will
12536 be displayed in the buffer instead of the link.
12538 If there is already a link at point, this command will allow you to edit link
12539 and description parts.
12542 selected using completion. The path to the file will be relative to
12543 the current directory if the file is in the current directory or a
12544 subdirectory. Otherwise, the link will be the absolute path as
12545 completed in the minibuffer (i.e. normally ~/path/to/file).
12548 is in the current directory or below.
12550 `org-keep-stored-link-after-insertion'."
12551 (interactive "P")
12552 (let* ((wcf (current-window-configuration))
12553 (region (if (org-region-active-p)
12554 (buffer-substring (region-beginning) (region-end))))
12555 (remove (and region (list (region-beginning) (region-end))))
12556 (desc region)
12557 tmphist ; byte-compile incorrectly complains about this
12558 link entry file)
12559 (cond
12560 ((org-in-regexp org-bracket-link-regexp 1)
12561 ;; We do have a link at point, and we are going to edit it.
12562 (setq remove (list (match-beginning 0) (match-end 0)))
12563 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12564 (setq link (read-string "Link: "
12565 (org-link-unescape
12566 (org-match-string-no-properties 1)))))
12567 ((or (org-in-regexp org-angle-link-re)
12568 (org-in-regexp org-plain-link-re))
12569 ;; Convert to bracket link
12570 (setq remove (list (match-beginning 0) (match-end 0))
12571 link (read-string "Link: "
12572 (org-remove-angle-brackets (match-string 0)))))
12573 ((equal complete-file '(4))
12574 ;; Completing read for file names.
12575 (setq file (read-file-name "File: "))
12576 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12577 (pwd1 (file-name-as-directory (abbreviate-file-name
12578 (expand-file-name ".")))))
12579 (cond
12580 ((equal complete-file '(16))
12581 (setq link (org-make-link
12582 "file:"
12583 (abbreviate-file-name (expand-file-name file)))))
12585 (setq link (org-make-link "file:" (match-string 1 file))))
12587 (expand-file-name file))
12588 (setq link (org-make-link
12589 "file:" (match-string 1 (expand-file-name file)))))
12590 (t (setq link (org-make-link "file:" file))))))
12591 (t
12592 ;; Read link, with completion for stored links.
12593 (with-output-to-temp-buffer "*Org Links*"
12595 (when org-stored-links
12597 (princ (mapconcat
12598 (lambda (x)
12599 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12601 (let ((cw (selected-window)))
12602 (select-window (get-buffer-window "*Org Links*"))
12603 (shrink-window-if-larger-than-buffer)
12604 (setq truncate-lines t)
12605 (select-window cw))
12606 ;; Fake a link history, containing the stored links.
12607 (setq tmphist (append (mapcar 'car org-stored-links)
12608 org-insert-link-history))
12609 (unwind-protect
12610 (setq link (org-completing-read
12611 "Link: "
12612 (append
12613 (mapcar (lambda (x) (list (concat (car x) ":")))
12614 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12615 (mapcar (lambda (x) (list (concat x ":")))
12616 org-link-types))
12617 nil nil nil
12618 'tmphist
12619 (or (car (car org-stored-links)))))
12620 (set-window-configuration wcf)
12621 (kill-buffer "*Org Links*"))
12622 (setq entry (assoc link org-stored-links))
12623 (or entry (push link org-insert-link-history))
12624 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12625 (not org-keep-stored-link-after-insertion))
12626 (setq org-stored-links (delq (assoc link org-stored-links)
12627 org-stored-links)))
12628 (setq desc (or desc (nth 1 entry)))))
12630 (if (string-match org-plain-link-re link)
12631 ;; URL-like link, normalize the use of angular brackets.
12632 (setq link (org-make-link (org-remove-angle-brackets link))))
12634 ;; Check if we are linking to the current file with a search option
12635 ;; If yes, simplify the link by using only the search option.
12636 (when (and buffer-file-name
12638 (let* ((path (match-string 1 link))
12639 (case-fold-search nil)
12640 (search (match-string 2 link)))
12641 (save-match-data
12642 (if (equal (file-truename buffer-file-name) (file-truename path))
12643 ;; We are linking to this same file, with a search option
12644 (setq link search)))))
12646 ;; Check if we can/should use a relative path. If yes, simplify the link
12648 (let* ((path (match-string 1 link))
12649 (origpath path)
12650 (case-fold-search nil))
12651 (cond
12652 ((eq org-link-file-path-type 'absolute)
12653 (setq path (abbreviate-file-name (expand-file-name path))))
12654 ((eq org-link-file-path-type 'noabbrev)
12655 (setq path (expand-file-name path)))
12656 ((eq org-link-file-path-type 'relative)
12657 (setq path (file-relative-name path)))
12658 (t
12659 (save-match-data
12660 (if (string-match (concat "^" (regexp-quote
12661 (file-name-as-directory
12662 (expand-file-name "."))))
12663 (expand-file-name path))
12664 ;; We are linking a file with relative path name.
12665 (setq path (substring (expand-file-name path)
12666 (match-end 0)))))))
12667 (setq link (concat "file:" path))
12668 (if (equal desc origpath)
12669 (setq desc path))))
12671 (setq desc (read-string "Description: " desc))
12673 (if remove (apply 'delete-region remove))
12674 (insert (org-make-link-string link desc))))
12676 (defun org-completing-read (&rest args)
12677 (let ((minibuffer-local-completion-map
12678 (copy-keymap minibuffer-local-completion-map)))
12679 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12680 (apply 'completing-read args)))
12682 ;;; Opening/following a link
12683 (defvar org-link-search-failed nil)
12685 (defun org-next-link ()
12686 "Move forward to the next link.
12687 If the link is in hidden text, expose it."
12688 (interactive)
12689 (when (and org-link-search-failed (eq this-command last-command))
12690 (goto-char (point-min))
12691 (message "Link search wrapped back to beginning of buffer"))
12692 (setq org-link-search-failed nil)
12693 (let* ((pos (point))
12694 (ct (org-context))
12695 (a (assoc :link ct)))
12696 (if a (goto-char (nth 2 a)))
12697 (if (re-search-forward org-any-link-re nil t)
12698 (progn
12699 (goto-char (match-beginning 0))
12700 (if (org-invisible-p) (org-show-context)))
12701 (goto-char pos)
12702 (setq org-link-search-failed t)
12703 (error "No further link found"))))
12705 (defun org-previous-link ()
12706 "Move backward to the previous link.
12707 If the link is in hidden text, expose it."
12708 (interactive)
12709 (when (and org-link-search-failed (eq this-command last-command))
12710 (goto-char (point-max))
12711 (message "Link search wrapped back to end of buffer"))
12712 (setq org-link-search-failed nil)
12713 (let* ((pos (point))
12714 (ct (org-context))
12715 (a (assoc :link ct)))
12716 (if a (goto-char (nth 1 a)))
12717 (if (re-search-backward org-any-link-re nil t)
12718 (progn
12719 (goto-char (match-beginning 0))
12720 (if (org-invisible-p) (org-show-context)))
12721 (goto-char pos)
12722 (setq org-link-search-failed t)
12723 (error "No further link found"))))
12725 (defun org-find-file-at-mouse (ev)
12726 "Open file link or URL at mouse."
12727 (interactive "e")
12728 (mouse-set-point ev)
12729 (org-open-at-point 'in-emacs))
12731 (defun org-open-at-mouse (ev)
12732 "Open file link or URL at mouse."
12733 (interactive "e")
12734 (mouse-set-point ev)
12735 (org-open-at-point))
12737 (defvar org-window-config-before-follow-link nil
12738 "The window configuration before following a link.
12739 This is saved in case the need arises to restore it.")
12741 (defvar org-open-link-marker (make-marker)
12742 "Marker pointing to the location where `org-open-at-point; was called.")
12744 ;;;###autoload
12745 (defun org-open-at-point-global ()
12746 "Follow a link like Org-mode does.
12747 This command can be called in any mode to follow a link that has
12748 Org-mode syntax."
12749 (interactive)
12750 (org-run-like-in-org-mode 'org-open-at-point))
12752 (defun org-open-at-point (&optional in-emacs)
12753 "Open link at or after point.
12754 If there is no link at point, this function will search forward up to
12755 the end of the current subtree.
12756 Normally, files will be opened by an appropriate application. If the
12757 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12758 (interactive "P")
12759 (move-marker org-open-link-marker (point))
12760 (setq org-window-config-before-follow-link (current-window-configuration))
12761 (org-remove-occur-highlights nil nil t)
12762 (if (org-at-timestamp-p t)
12763 (org-follow-timestamp-link)
12764 (let (type path link line search (pos (point)))
12765 (catch 'match
12766 (save-excursion
12768 (when (org-in-regexp org-bracket-link-regexp)
12769 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12771 (setq link (replace-match " " t t link)))
12772 (setq link (org-link-expand-abbrev link))
12773 (if (string-match org-link-re-with-space2 link)
12774 (setq type (match-string 1 link) path (match-string 2 link))
12775 (setq type "thisfile" path link))
12776 (throw 'match t)))
12778 (when (get-text-property (point) 'org-linked-text)
12779 (setq type "thisfile"
12780 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12781 (1+ (point)) (point))
12782 path (buffer-substring
12783 (previous-single-property-change pos 'org-linked-text)
12784 (next-single-property-change pos 'org-linked-text)))
12785 (throw 'match t))
12787 (save-excursion
12788 (when (or (org-in-regexp org-angle-link-re)
12789 (org-in-regexp org-plain-link-re))
12790 (setq type (match-string 1) path (match-string 2))
12791 (throw 'match t)))
12793 (setq type "tree-match"
12794 path (match-string 1))
12795 (throw 'match t))
12796 (save-excursion
12798 (setq type "tags"
12799 path (match-string 1))
12800 (while (string-match ":" path)
12801 (setq path (replace-match "+" t t path)))
12802 (throw 'match t))))
12803 (unless path
12804 (error "No link found"))
12805 ;; Remove any trailing spaces in path
12807 (setq path (replace-match "" t t path)))
12809 (cond
12811 ((assoc type org-link-protocols)
12812 (funcall (nth 1 (assoc type org-link-protocols)) path))
12814 ((equal type "mailto")
12815 (let ((cmd (car org-link-mailto-program))
12816 (args (cdr org-link-mailto-program)) args1
12817 (address path) (subject "") a)
12819 (setq address (match-string 1 path)
12820 subject (org-link-escape (match-string 2 path))))
12821 (while args
12822 (cond
12823 ((not (stringp (car args))) (push (pop args) args1))
12824 (t (setq a (pop args))
12825 (if (string-match "%a" a)
12826 (setq a (replace-match address t t a)))
12827 (if (string-match "%s" a)
12828 (setq a (replace-match subject t t a)))
12829 (push a args1))))
12830 (apply cmd (nreverse args1))))
12832 ((member type '("http" "https" "ftp" "news"))
12833 (browse-url (concat type ":" (org-link-escape
12834 path org-link-escape-chars-browser))))
12836 ((member type '("message"))
12837 (browse-url (concat type ":" path)))
12839 ((string= type "tags")
12840 (org-tags-view in-emacs path))
12841 ((string= type "thisfile")
12842 (if in-emacs
12843 (switch-to-buffer-other-window
12844 (org-get-buffer-for-internal-link (current-buffer)))
12845 (org-mark-ring-push))
12846 (let ((cmd `(org-link-search
12847 ,path
12848 ,(cond ((equal in-emacs '(4)) 'occur)
12849 ((equal in-emacs '(16)) 'org-occur)
12850 (t nil))
12851 ,pos)))
12852 (condition-case nil (eval cmd)
12853 (error (progn (widen) (eval cmd))))))
12855 ((string= type "tree-match")
12858 ((string= type "file")
12860 (setq line (string-to-number (match-string 1 path))
12861 path (substring path 0 (match-beginning 0)))
12863 (setq search (match-string 1 path)
12864 path (substring path 0 (match-beginning 0)))))
12865 (if (string-match "[*?{]" (file-name-nondirectory path))
12866 (dired path)
12867 (org-open-file path in-emacs line search)))
12869 ((string= type "news")
12870 (org-follow-gnus-link path))
12872 ((string= type "bbdb")
12873 (org-follow-bbdb-link path))
12875 ((string= type "info")
12876 (org-follow-info-link path))
12878 ((string= type "gnus")
12879 (let (group article)
12881 (error "Error in Gnus link"))
12882 (setq group (match-string 1 path)
12883 article (match-string 3 path))
12884 (org-follow-gnus-link group article)))
12886 ((string= type "vm")
12887 (let (folder article)
12889 (error "Error in VM link"))
12890 (setq folder (match-string 1 path)
12891 article (match-string 3 path))
12892 ;; in-emacs is the prefix arg, will be interpreted as read-only
12893 (org-follow-vm-link folder article in-emacs)))
12895 ((string= type "wl")
12896 (let (folder article)
12898 (error "Error in Wanderlust link"))
12899 (setq folder (match-string 1 path)
12900 article (match-string 3 path))
12901 (org-follow-wl-link folder article)))
12903 ((string= type "mhe")
12904 (let (folder article)
12906 (error "Error in MHE link"))
12907 (setq folder (match-string 1 path)
12908 article (match-string 3 path))
12909 (org-follow-mhe-link folder article)))
12911 ((string= type "rmail")
12912 (let (folder article)
12914 (error "Error in RMAIL link"))
12915 (setq folder (match-string 1 path)
12916 article (match-string 3 path))
12917 (org-follow-rmail-link folder article)))
12919 ((string= type "shell")
12920 (let ((cmd path))
12921 (if (or (not org-confirm-shell-link-function)
12922 (funcall org-confirm-shell-link-function
12924 (org-add-props cmd nil
12925 'face 'org-warning))))
12926 (progn
12927 (message "Executing %s" cmd)
12928 (shell-command cmd))
12929 (error "Abort"))))
12931 ((string= type "elisp")
12932 (let ((cmd path))
12933 (if (or (not org-confirm-elisp-link-function)
12934 (funcall org-confirm-elisp-link-function
12936 (org-add-props cmd nil
12937 'face 'org-warning))))
12938 (message "%s => %s" cmd (eval (read cmd)))
12939 (error "Abort"))))
12941 (t
12942 (browse-url-at-point)))))
12943 (move-marker org-open-link-marker nil)
12944 (run-hook-with-args 'org-follow-link-hook))
12946 ;;; File search
12948 (defvar org-create-file-search-functions nil
12949 "List of functions to construct the right search string for a file link.
12950 These functions are called in turn with point at the location to
12951 which the link should point.
12953 A function in the hook should first test if it would like to
12954 handle this file type, for example by checking the major-mode or
12955 the file extension. If it decides not to handle this file, it
12956 should just return nil to give other functions a chance. If it
12957 does handle the file, it must return the search string to be used
12958 when following the link. The search string will be part of the
12959 file link, given after a double colon, and `org-open-at-point'
12960 will automatically search for it. If special measures must be
12961 taken to make the search successful, another function should be
12962 added to the companion hook `org-execute-file-search-functions',
12963 which see.
12965 A function in this hook may also use `setq' to set the variable
12966 `description' to provide a suggestion for the descriptive text to
12967 be used for this link when it gets inserted into an Org-mode
12970 (defvar org-execute-file-search-functions nil
12971 "List of functions to execute a file search triggered by a link.
12973 Functions added to this hook must accept a single argument, the
12974 search string that was part of the file link, the part after the
12975 double colon. The function must first check if it would like to
12976 handle this search, for example by checking the major-mode or the
12977 file extension. If it decides not to handle this search, it
12978 should just return nil to give other functions a chance. If it
12979 does handle the search, it must return a non-nil value to keep
12980 other functions from trying.
12982 Each function can access the current prefix argument through the
12983 variable `current-prefix-argument'. Note that a single prefix is
12984 used to force opening a link in Emacs, so it may be good to only
12985 use a numeric or double prefix to guide the search function.
12987 In case this is needed, a function in this hook can also restore
12988 the window configuration before `org-open-at-point' was called using:
12990 (set-window-configuration org-window-config-before-follow-link)")
12992 (defun org-link-search (s &optional type avoid-pos)
12993 "Search for a link search option.
12994 If S is surrounded by forward slashes, it is interpreted as a
12995 regular expression. In org-mode files, this will create an `org-occur'
12996 sparse tree. In ordinary files, `occur' will be used to list matches.
12997 If the current buffer is in `dired-mode', grep will be used to search
12998 in all files. If AVOID-POS is given, ignore matches near that position."
12999 (let ((case-fold-search t)
13003 org-emphasis-alist)
13005 (pos (point))
13006 (pre "") (post "")
13007 words re0 re1 re2 re3 re4 re5 re2a reall)
13008 (cond
13009 ;; First check if there are any special
13010 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
13011 ;; Now try the builtin stuff
13012 ((save-excursion
13013 (goto-char (point-min))
13014 (and
13015 (re-search-forward
13016 (concat "<<" (regexp-quote s0) ">>") nil t)
13017 (setq pos (match-beginning 0))))
13018 ;; There is an exact target for this
13019 (goto-char pos))
13021 ;; A regular expression
13022 (cond
13023 ((org-mode-p)
13024 (org-occur (match-string 1 s)))
13025 ;;((eq major-mode 'dired-mode)
13026 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
13027 (t (org-do-occur (match-string 1 s)))))
13028 (t
13029 ;; A normal search strings
13030 (when (equal (string-to-char s) ?*)
13031 ;; Anchor on headlines, post may include tags.
13034 s (substring s 1)))
13035 (remove-text-properties
13036 0 (length s)
13037 '(face nil mouse-face nil keymap nil fontified nil) s)
13038 ;; Make a series of regular expressions to find a match
13045 re1 (concat pre re2 post)
13046 re3 (concat pre re4 post)
13047 re5 (concat pre ".*" re4)
13048 re2 (concat pre re2)
13049 re2a (concat pre re2a)
13050 re4 (concat pre re4)
13054 ))
13055 (cond
13056 ((eq type 'org-occur) (org-occur reall))
13057 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
13058 (t (goto-char (point-min))
13059 (if (or (org-search-not-self 1 re0 nil t)
13060 (org-search-not-self 1 re1 nil t)
13061 (org-search-not-self 1 re2 nil t)
13062 (org-search-not-self 1 re2a nil t)
13063 (org-search-not-self 1 re3 nil t)
13064 (org-search-not-self 1 re4 nil t)
13065 (org-search-not-self 1 re5 nil t)
13066 )
13067 (goto-char (match-beginning 1))
13068 (goto-char pos)
13069 (error "No match")))))
13070 (t
13071 ;; Normal string-search
13072 (goto-char (point-min))
13073 (if (search-forward s nil t)
13074 (goto-char (match-beginning 0))
13075 (error "No match"))))
13076 (and (org-mode-p) (org-show-context 'link-search))))
13078 (defun org-search-not-self (group &rest args)
13079 "Execute `re-search-forward', but only accept matches that do not
13080 enclose the position of `org-open-link-marker'."
13081 (let ((m org-open-link-marker))
13082 (catch 'exit
13083 (while (apply 're-search-forward args)
13084 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
13085 (goto-char (match-end group))
13086 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
13087 (> (match-beginning 0) (marker-position m))
13088 (< (match-end 0) (marker-position m)))
13089 (save-match-data
13090 (or (not (org-in-regexp
13091 org-bracket-link-analytic-regexp 1))
13092 (not (match-end 4)) ; no description
13093 (and (<= (match-beginning 4) (point))
13094 (>= (match-end 4) (point))))))
13095 (throw 'exit (point))))))))
13097 (defun org-get-buffer-for-internal-link (buffer)
13098 "Return a buffer to be used for displaying the link target of internal links."
13099 (cond
13100 ((not org-display-internal-link-with-indirect-buffer)
13101 buffer)
13102 ((string-match "(Clone)$" (buffer-name buffer))
13103 (message "Buffer is already a clone, not making another one")
13104 ;; we also do not modify visibility in this case
13105 buffer)
13106 (t ; make a new indirect buffer for displaying the link
13107 (let* ((bn (buffer-name buffer))
13108 (ibn (concat bn "(Clone)"))
13109 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13110 (with-current-buffer ib (org-overview))
13111 ib))))
13113 (defun org-do-occur (regexp &optional cleanup)
13114 "Call the Emacs command `occur'.
13115 If CLEANUP is non-nil, remove the printout of the regular expression
13116 in the *Occur* buffer. This is useful if the regex is long and not useful
13117 to read."
13118 (occur regexp)
13119 (when cleanup
13120 (let ((cwin (selected-window)) win beg end)
13121 (when (setq win (get-buffer-window "*Occur*"))
13122 (select-window win))
13123 (goto-char (point-min))
13124 (when (re-search-forward "match[a-z]+" nil t)
13125 (setq beg (match-end 0))
13127 (setq end (1- (match-beginning 0)))))
13128 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13129 (goto-char (point-min))
13130 (select-window cwin))))
13132 ;;; The mark ring for links jumps
13134 (defvar org-mark-ring nil
13135 "Mark ring for positions before jumps in Org-mode.")
13136 (defvar org-mark-ring-last-goto nil
13137 "Last position in the mark ring used to go back.")
13138 ;; Fill and close the ring
13139 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13140 (loop for i from 1 to org-mark-ring-length do
13141 (push (make-marker) org-mark-ring))
13142 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13143 org-mark-ring)
13145 (defun org-mark-ring-push (&optional pos buffer)
13146 "Put the current position or POS into the mark ring and rotate it."
13147 (interactive)
13148 (setq pos (or pos (point)))
13149 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13150 (move-marker (car org-mark-ring)
13151 (or pos (point))
13152 (or buffer (current-buffer)))
13153 (message "%s"
13154 (substitute-command-keys
13157 (defun org-mark-ring-goto (&optional n)
13158 "Jump to the previous position in the mark ring.
13159 With prefix arg N, jump back that many stored positions. When
13160 called several times in succession, walk through the entire ring.
13161 Org-mode commands jumping to a different position in the current file,
13162 or to another Org-mode file, automatically push the old position
13163 onto the ring."
13164 (interactive "p")
13165 (let (p m)
13166 (if (eq last-command this-command)
13167 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13168 (setq p org-mark-ring))
13169 (setq org-mark-ring-last-goto p)
13170 (setq m (car p))
13171 (switch-to-buffer (marker-buffer m))
13172 (goto-char m)
13173 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13175 (defun org-remove-angle-brackets (s)
13176 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13177 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13178 s)
13179 (defun org-add-angle-brackets (s)
13180 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13181 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13182 s)
13184 ;;; Following specific links
13186 (defun org-follow-timestamp-link ()
13187 (cond
13188 ((org-at-date-range-p t)
13189 (let ((org-agenda-start-on-weekday)
13190 (t1 (match-string 1))
13191 (t2 (match-string 2)))
13192 (setq t1 (time-to-days (org-time-string-to-time t1))
13193 t2 (time-to-days (org-time-string-to-time t2)))
13194 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13195 ((org-at-timestamp-p t)
13196 (org-agenda-list nil (time-to-days (org-time-string-to-time
13197 (substring (match-string 1) 0 10)))
13198 1))
13199 (t (error "This should not happen"))))
13202 (defun org-follow-bbdb-link (name)
13203 "Follow a BBDB link to NAME."
13204 (require 'bbdb)
13205 (let ((inhibit-redisplay (not debug-on-error))
13206 (bbdb-electric-p nil))
13207 (catch 'exit
13208 ;; Exact match on name
13210 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13211 ;; Exact match on name
13213 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13214 ;; Partial match on name
13215 (bbdb-name name nil)
13216 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13217 ;; Partial match on company
13218 (bbdb-company name nil)
13219 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13220 ;; General match including network address and notes
13221 (bbdb name nil)
13222 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13223 (delete-window (get-buffer-window "*BBDB*"))
13224 (error "No matching BBDB record")))))
13226 (defun org-follow-info-link (name)
13227 "Follow an info file & node link to NAME."
13230 (progn
13231 (require 'info)
13232 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13233 (Info-find-node (match-string 1 name) (match-string 2 name))
13234 (Info-find-node (match-string 1 name) "Top")))
13235 (message "Could not open: %s" name)))
13237 (defun org-follow-gnus-link (&optional group article)
13238 "Follow a Gnus link to GROUP and ARTICLE."
13239 (require 'gnus)
13240 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13241 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13242 (cond ((and group article)
13243 (gnus-group-read-group 1 nil group)
13244 (gnus-summary-goto-article (string-to-number article) nil t))
13245 (group (gnus-group-jump-to-group group))))
13247 (defun org-follow-vm-link (&optional folder article readonly)
13248 "Follow a VM link to FOLDER and ARTICLE."
13249 (require 'vm)
13250 (setq article (org-add-angle-brackets article))
13252 ;; ange-ftp or efs or tramp access
13253 (let ((user (or (match-string 1 folder) (user-login-name)))
13254 (host (match-string 2 folder))
13255 (file (match-string 3 folder)))
13256 (cond
13257 ((featurep 'tramp)
13258 ;; use tramp to access the file
13259 (if (featurep 'xemacs)
13260 (setq folder (format "[%s@%s]%s" user host file))
13261 (setq folder (format "/%s@%s:%s" user host file))))
13262 (t
13263 ;; use ange-ftp or efs
13264 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13265 (setq folder (format "/%s@%s:%s" user host file))))))
13266 (when folder
13267 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13268 (sit-for 0.1)
13269 (when article
13270 (vm-select-folder-buffer)
13271 (widen)
13272 (let ((case-fold-search t))
13273 (goto-char (point-min))
13274 (if (not (re-search-forward
13275 (concat "^" "message-id: *" (regexp-quote article))))
13276 (error "Could not find the specified message in this folder"))
13277 (vm-isearch-update)
13278 (vm-isearch-narrow)
13279 (vm-beginning-of-message)
13280 (vm-summarize)))))
13282 (defun org-follow-wl-link (folder article)
13283 "Follow a Wanderlust link to FOLDER and ARTICLE."
13284 (if (and (string= folder "%")
13285 article
13287 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13288 ;; Thus, we recompose folder and article ids.
13289 (setq folder (format "%s#%s" folder (match-string 1 article))
13290 article (match-string 3 article)))
13291 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13292 (error "No such folder: %s" folder))
13293 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13294 (and article
13295 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13296 (wl-summary-redisplay)))
13298 (defun org-follow-rmail-link (folder article)
13299 "Follow an RMAIL link to FOLDER and ARTICLE."
13300 (setq article (org-add-angle-brackets article))
13301 (let (message-number)
13302 (save-excursion
13303 (save-window-excursion
13304 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13305 (setq message-number
13306 (save-restriction
13307 (widen)
13308 (goto-char (point-max))
13309 (if (re-search-backward
13311 (or article "")))
13312 nil t)
13313 (rmail-what-message))))))
13314 (if message-number
13315 (progn
13316 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13317 (rmail-show-message message-number)
13318 message-number)
13319 (error "Message not found"))))
13321 ;;; mh-e integration based on planner-mode
13322 (defun org-mhe-get-message-real-folder ()
13323 "Return the name of the current message real folder, so if you use
13324 sequences, it will now work."
13325 (save-excursion
13326 (let* ((folder
13327 (if (equal major-mode 'mh-folder-mode)
13328 mh-current-folder
13329 ;; Refer to the show buffer
13330 mh-show-folder-buffer))
13331 (end-index
13332 (if (boundp 'mh-index-folder)
13333 (min (length mh-index-folder) (length folder))))
13334 )
13335 ;; a simple test on mh-index-data does not work, because
13336 ;; mh-index-data is always nil in a show buffer.
13337 (if (and (boundp 'mh-index-folder)
13338 (string= mh-index-folder (substring folder 0 end-index)))
13339 (if (equal major-mode 'mh-show-mode)
13340 (save-window-excursion
13341 (let (pop-up-frames)
13342 (when (buffer-live-p (get-buffer folder))
13343 (progn
13344 (pop-to-buffer folder)
13345 (org-mhe-get-message-folder-from-index)
13346 )
13347 )))
13348 (org-mhe-get-message-folder-from-index)
13349 )
13350 folder
13351 )
13352 )))
13354 (defun org-mhe-get-message-folder-from-index ()
13355 "Returns the name of the message folder in a index folder buffer."
13356 (save-excursion
13357 (mh-index-previous-folder)
13359 (message "%s" (match-string 1))))
13361 (defun org-mhe-get-message-folder ()
13362 "Return the name of the current message folder. Be careful if you
13363 use sequences."
13364 (save-excursion
13365 (if (equal major-mode 'mh-folder-mode)
13366 mh-current-folder
13367 ;; Refer to the show buffer
13368 mh-show-folder-buffer)))
13370 (defun org-mhe-get-message-num ()
13371 "Return the number of the current message. Be careful if you
13372 use sequences."
13373 (save-excursion
13374 (if (equal major-mode 'mh-folder-mode)
13375 (mh-get-msg-num nil)
13376 ;; Refer to the show buffer
13377 (mh-show-buffer-message-number))))
13379 (defun org-mhe-get-header (header)
13380 "Return a header of the message in folder mode. This will create a
13381 show buffer for the corresponding message. If you have a more clever
13382 idea..."
13383 (let* ((folder (org-mhe-get-message-folder))
13384 (num (org-mhe-get-message-num))
13385 (buffer (get-buffer-create (concat "show-" folder)))
13386 (header-field))
13387 (with-current-buffer buffer
13388 (mh-display-msg num folder)
13389 (if (equal major-mode 'mh-folder-mode)
13390 (mh-header-display)
13391 (mh-show-header-display))
13392 (set-buffer buffer)
13393 (setq header-field (mh-get-header-field header))
13394 (if (equal major-mode 'mh-folder-mode)
13395 (mh-show)
13396 (mh-show-show))
13397 header-field)))
13399 (defun org-follow-mhe-link (folder article)
13400 "Follow an MHE link to FOLDER and ARTICLE.
13401 If ARTICLE is nil FOLDER is shown. If the configuration variable
13402 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13403 ARTICLE is searched in all folders. Indexed searches (swish++,
13404 namazu, and others supported by MH-E) will always search in all
13405 folders."
13406 (require 'mh-e)
13407 (require 'mh-search)
13408 (require 'mh-utils)
13409 (mh-find-path)
13410 (if (not article)
13411 (mh-visit-folder (mh-normalize-folder-name folder))
13412 (setq article (org-add-angle-brackets article))
13413 (mh-search-choose)
13414 (if (equal mh-searcher 'pick)
13415 (progn
13416 (mh-search folder (list "--message-id" article))
13417 (when (and org-mhe-search-all-folders
13418 (not (org-mhe-get-message-real-folder)))
13419 (kill-this-buffer)
13420 (mh-search "+" (list "--message-id" article))))
13421 (mh-search "+" article))
13422 (if (org-mhe-get-message-real-folder)
13423 (mh-show-msg 1)
13424 (kill-this-buffer)
13425 (error "Message not found"))))
13427 ;;; BibTeX links
13429 ;; Use the custom search meachnism to construct and use search strings for
13430 ;; file links to BibTeX database entries.
13432 (defun org-create-file-search-in-bibtex ()
13433 "Create the search string and description for a BibTeX database entry."
13434 (when (eq major-mode 'bibtex-mode)
13435 ;; yes, we want to construct this search string.
13436 ;; Make a good description for this entry, using names, year and the title
13437 ;; Put it into the `description' variable which is dynamically scoped.
13438 (let ((bibtex-autokey-names 1)
13439 (bibtex-autokey-names-stretch 1)
13440 (bibtex-autokey-name-case-convert-function 'identity)
13441 (bibtex-autokey-name-separator " & ")
13442 (bibtex-autokey-additional-names " et al.")
13443 (bibtex-autokey-year-length 4)
13444 (bibtex-autokey-name-year-separator " ")
13445 (bibtex-autokey-titlewords 3)
13446 (bibtex-autokey-titleword-separator " ")
13447 (bibtex-autokey-titleword-case-convert-function 'identity)
13448 (bibtex-autokey-titleword-length 'infty)
13449 (bibtex-autokey-year-title-separator ": "))
13450 (setq description (bibtex-generate-autokey)))
13451 ;; Now parse the entry, get the key and return it.
13452 (save-excursion
13453 (bibtex-beginning-of-entry)
13454 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13456 (defun org-execute-file-search-in-bibtex (s)
13457 "Find the link search string S as a key for a database entry."
13458 (when (eq major-mode 'bibtex-mode)
13459 ;; Yes, we want to do the search in this file.
13460 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13461 (goto-char (point-min))
13464 (goto-char (match-beginning 0)))
13465 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13466 ;; Use double prefix to indicate that any web link should be browsed
13467 (let ((b (current-buffer)) (p (point)))
13468 ;; Restore the window configuration because we just use the web link
13469 (set-window-configuration org-window-config-before-follow-link)
13470 (save-excursion (set-buffer b) (goto-char p)
13471 (bibtex-url)))
13472 (recenter 0)) ; Move entry start to beginning of window
13473 ;; return t to indicate that the search is done.
13474 t))
13476 ;; Finally add the functions to the right hooks.
13477 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13478 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13480 ;; end of Bibtex link setup
13482 ;;; Following file links
13484 (defun org-open-file (path &optional in-emacs line search)
13485 "Open the file at PATH.
13486 First, this expands any special file name abbreviations. Then the
13487 configuration variable `org-file-apps' is checked if it contains an
13488 entry for this file type, and if yes, the corresponding command is launched.
13489 If no application is found, Emacs simply visits the file.
13490 With optional argument IN-EMACS, Emacs will visit the file.
13491 Optional LINE specifies a line to go to, optional SEARCH a string to
13492 search for. If LINE or SEARCH is given, the file will always be
13493 opened in Emacs.
13494 If the file does not exist, an error is thrown."
13495 (setq in-emacs (or in-emacs line search))
13496 (let* ((file (if (equal path "")
13497 buffer-file-name
13498 (substitute-in-file-name (expand-file-name path))))
13499 (apps (append org-file-apps (org-default-apps)))
13500 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13501 (dirp (if remp nil (file-directory-p file)))
13502 (dfile (downcase file))
13503 (old-buffer (current-buffer))
13504 (old-pos (point))
13505 (old-mode major-mode)
13506 ext cmd)
13508 (setq ext (match-string 1 dfile))
13510 (setq ext (match-string 1 dfile))))
13511 (if in-emacs
13512 (setq cmd 'emacs)
13513 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13514 (and dirp (cdr (assoc 'directory apps)))
13515 (cdr (assoc ext apps))
13516 (cdr (assoc t apps)))))
13517 (when (eq cmd 'mailcap)
13518 (require 'mailcap)
13519 (mailcap-parse-mailcaps)
13520 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13521 (command (mailcap-mime-info mime-type)))
13522 (if (stringp command)
13523 (setq cmd command)
13524 (setq cmd 'emacs))))
13525 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13526 (not (file-exists-p file))
13527 (not org-open-non-existing-files))
13528 (error "No such file: %s" file))
13529 (cond
13531 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13533 (setq cmd (replace-match "%s" t t cmd)))
13534 (while (string-match "%s" cmd)
13535 (setq cmd (replace-match
13536 (save-match-data (shell-quote-argument file))
13537 t t cmd)))
13538 (save-window-excursion
13539 (start-process-shell-command cmd nil cmd)))
13540 ((or (stringp cmd)
13541 (eq cmd 'emacs))
13542 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13543 (widen)
13544 (if line (goto-line line)
13545 (if search (org-link-search search))))
13546 ((consp cmd)
13547 (eval cmd))
13548 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13549 (and (org-mode-p) (eq old-mode 'org-mode)
13550 (or (not (equal old-buffer (current-buffer)))
13551 (not (equal old-pos (point))))
13552 (org-mark-ring-push old-pos old-buffer))))
13554 (defun org-default-apps ()
13555 "Return the default applications for this operating system."
13556 (cond
13557 ((eq system-type 'darwin)
13558 org-file-apps-defaults-macosx)
13559 ((eq system-type 'windows-nt)
13560 org-file-apps-defaults-windowsnt)
13561 (t org-file-apps-defaults-gnu)))
13563 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13564 (defun org-file-remote-p (file)
13565 "Test whether FILE specifies a location on a remote system.
13566 Return non-nil if the location is indeed remote.
13570 (cond ((fboundp 'file-remote-p)
13571 (file-remote-p file))
13572 ((fboundp 'tramp-handle-file-remote-p)
13573 (tramp-handle-file-remote-p file))
13574 ((and (boundp 'ange-ftp-name-format)
13575 (string-match (car ange-ftp-name-format) file))
13576 t)
13577 (t nil)))
13580 ;;;; Hooks for remember.el, and refiling
13582 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13583 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13585 ;;;###autoload
13586 (defun org-remember-insinuate ()
13587 "Setup remember.el for use wiht Org-mode."
13588 (require 'remember)
13589 (setq remember-annotation-functions '(org-remember-annotation))
13590 (setq remember-handler-functions '(org-remember-handler))
13591 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13593 ;;;###autoload
13594 (defun org-remember-annotation ()
13595 "Return a link to the current location as an annotation for remember.el.
13596 If you are using Org-mode files as target for data storage with
13597 remember.el, then the annotations should include a link compatible with the
13598 conventions in Org-mode. This function returns such a link."
13599 (org-store-link nil))
13601 (defconst org-remember-help
13602 "Select a destination location for the note.
13603 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13604 RET on headline -> Store as sublevel entry to current headline
13605 RET at beg-of-buf -> Append to file as level 2 headline
13606 <left>/<right> -> before/after current headline, same headings level")
13608 (defvar org-remember-previous-location nil)
13609 (defvar org-force-remember-template-char) ;; dynamically scoped
13611 ;; Save the major mode of the buffer we called remember from
13612 (defvar org-select-template-temp-major-mode nil)
13614 ;; Temporary store the buffer where remember was called from
13615 (defvar org-select-template-original-buffer nil)
13617 (defun org-select-remember-template (&optional use-char)
13618 (when org-remember-templates
13619 (let* ((pre-selected-templates
13620 (mapcar
13621 (lambda (tpl)
13622 (let ((ctxt (nth 5 tpl))
13623 (mode org-select-template-temp-major-mode)
13624 (buf org-select-template-original-buffer))
13625 (if (or (and (functionp ctxt)
13626 (save-excursion
13627 (set-buffer buf)
13628 ;; Protect the user-defined function from error
13629 (condition-case nil (funcall ctxt) (error nil))))
13630 (and ctxt (listp ctxt)
13631 (delq nil (mapcar (lambda(x) (eq mode x)) ctxt))))
13632 tpl)))
13633 org-remember-templates))
13634 ;; If no template at this point, add the default templates:
13635 (pre-selected-templates1
13636 (if (not (delq nil pre-selected-templates))
13637 (mapcar (lambda(x) (if (not (nth 5 x)) x))
13638 org-remember-templates)
13639 pre-selected-templates))
13640 ;; Then unconditionnally add template for any contexts
13641 (pre-selected-templates2
13642 (append (mapcar (lambda(x) (if (eq (nth 5 x) t) x))
13643 org-remember-templates)
13644 (delq nil pre-selected-templates1)))
13645 (templates (mapcar (lambda (x)
13646 (if (stringp (car x))
13647 (append (list (nth 1 x) (car x)) (cddr x))
13648 (append (list (car x) "") (cdr x))))
13649 (delq nil pre-selected-templates2)))
13650 (char (or use-char
13651 (cond
13652 ((= (length templates) 1)
13653 (caar templates))
13654 ((and (boundp 'org-force-remember-template-char)
13655 org-force-remember-template-char)
13656 (if (stringp org-force-remember-template-char)
13657 (string-to-char org-force-remember-template-char)
13658 org-force-remember-template-char))
13659 (t
13660 (message "Select template: %s"
13661 (mapconcat
13662 (lambda (x)
13663 (cond
13665 (format "[%c]" (car x)))
13666 ((equal (downcase (car x))
13667 (downcase (aref (nth 1 x) 0)))
13668 (format "[%c]%s" (car x)
13669 (substring (nth 1 x) 1)))
13670 (t (format "[%c]%s" (car x) (nth 1 x)))))
13671 templates " "))
13672 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13673 (when (equal char0 ?\C-g)
13674 (jump-to-register remember-register)
13675 (kill-buffer remember-buffer))
13676 char0))))))
13677 (cddr (assoc char templates)))))
13679 (defvar x-last-selected-text)
13680 (defvar x-last-selected-text-primary)
13682 ;;;###autoload
13683 (defun org-remember-apply-template (&optional use-char skip-interactive)
13684 "Initialize *remember* buffer with template, invoke `org-mode'.
13685 This function should be placed into `remember-mode-hook' and in fact requires
13686 to be run from that hook to function properly."
13687 (if org-remember-templates
13688 (let* ((entry (org-select-remember-template use-char))
13689 (tpl (car entry))
13690 (plist-p (if org-store-link-plist t nil))
13691 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13693 (nth 1 entry)
13694 org-default-notes-file))
13695 (headline (nth 2 entry))
13696 (v-c (or (and (eq window-system 'x)
13697 (fboundp 'x-cut-buffer-or-selection-value)
13698 (x-cut-buffer-or-selection-value))
13699 (org-bound-and-true-p x-last-selected-text)
13700 (org-bound-and-true-p x-last-selected-text-primary)
13701 (and (> (length kill-ring) 0) (current-kill 0))))
13702 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13703 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13704 (v-u (concat "[" (substring v-t 1 -1) "]"))
13705 (v-U (concat "[" (substring v-T 1 -1) "]"))
13706 ;; `initial' and `annotation' are bound in `remember'
13707 (v-i (if (boundp 'initial) initial))
13708 (v-a (if (and (boundp 'annotation) annotation)
13709 (if (equal annotation "[[]]") "" annotation)
13710 ""))
13711 (v-A (if (and v-a
13714 v-a))
13715 (v-n user-full-name)
13716 (org-startup-folded nil)
13717 org-time-was-given org-end-time-was-given x
13718 prompt completions char time pos default histvar)
13719 (setq org-store-link-plist
13720 (append (list :annotation v-a :initial v-i)
13721 org-store-link-plist))
13722 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13723 (erase-buffer)
13724 (insert (substitute-command-keys
13725 (format
13726 "## Filing location: Select interactively, default, or last used:
13727 ## %s to select file and header location interactively.
13731 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13732 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13733 (abbreviate-file-name (or file org-default-notes-file))
13734 (or headline "")
13735 (or (car org-remember-previous-location) "???")
13736 (or (cdr org-remember-previous-location) "???"))))
13737 (insert tpl) (goto-char (point-min))
13738 ;; Simple %-escapes
13740 (when (and initial (equal (match-string 0) "%i"))
13741 (save-match-data
13742 (let* ((lead (buffer-substring
13743 (point-at-bol) (match-beginning 0))))
13744 (setq v-i (mapconcat 'identity
13747 (replace-match
13748 (or (eval (intern (concat "v-" (match-string 1)))) "")
13749 t t))
13751 ;; %[] Insert contents of a file.
13752 (goto-char (point-min))
13754 (let ((start (match-beginning 0))
13755 (end (match-end 0))
13756 (filename (expand-file-name (match-string 1))))
13757 (goto-char start)
13758 (delete-region start end)
13759 (condition-case error
13760 (insert-file-contents filename)
13761 (error (insert (format "%%![Couldn't insert %s: %s]"
13762 filename error))))))
13763 ;; %() embedded elisp
13764 (goto-char (point-min))
13766 (goto-char (match-beginning 0))
13767 (let ((template-start (point)))
13768 (forward-char 1)
13769 (let ((result
13770 (condition-case error
13771 (eval (read (current-buffer)))
13772 (error (format "%%![Error: %s]" error)))))
13773 (delete-region template-start (point))
13774 (insert result))))
13776 ;; From the property list
13777 (when plist-p
13778 (goto-char (point-min))
13780 (and (setq x (or (plist-get org-store-link-plist
13781 (intern (match-string 1))) ""))
13782 (replace-match x t t))))
13784 ;; Turn on org-mode in the remember buffer, set local variables
13785 (org-mode)
13786 (org-set-local 'org-finish-function 'org-remember-finalize)
13788 (org-set-local 'org-default-notes-file file))
13790 (org-set-local 'org-remember-default-headline headline))
13791 ;; Interactive template entries
13792 (goto-char (point-min))
13794 (setq char (if (match-end 3) (match-string 3))
13795 prompt (if (match-end 2) (match-string 2)))
13796 (goto-char (match-beginning 0))
13797 (replace-match "")
13798 (setq completions nil default nil)
13799 (when prompt
13800 (setq completions (org-split-string prompt "|")
13801 prompt (pop completions)
13802 default (car completions)
13803 histvar (intern (concat
13804 "org-remember-template-prompt-history::"
13805 (or prompt "")))
13806 completions (mapcar 'list completions)))
13807 (cond
13808 ((member char '("G" "g"))
13809 (let* ((org-last-tags-completion-table
13810 (org-global-tags-completion-table
13811 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13812 (org-add-colon-after-tag-completion t)
13813 (ins (completing-read
13814 (if prompt (concat prompt ": ") "Tags: ")
13815 'org-tags-completion-function nil nil nil
13816 'org-tags-history)))
13817 (setq ins (mapconcat 'identity
13818 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13819 ":"))
13821 (or (equal (char-before) ?:) (insert ":"))
13822 (insert ins)
13823 (or (equal (char-after) ?:) (insert ":")))))
13824 (char
13825 (setq org-time-was-given (equal (upcase char) char))
13826 (setq time (org-read-date (equal (upcase char) "U") t nil
13827 prompt))
13828 (org-insert-time-stamp time org-time-was-given
13829 (member char '("u" "U"))
13830 nil nil (list org-end-time-was-given)))
13831 (t
13832 (insert (org-completing-read
13833 (concat (if prompt prompt "Enter string")
13834 (if default (concat " [" default "]"))
13835 ": ")
13836 completions nil nil nil histvar default)))))
13837 (goto-char (point-min))
13839 (replace-match "")
13841 (org-mode)
13842 (org-set-local 'org-finish-function 'org-remember-finalize))
13843 (when (save-excursion
13844 (goto-char (point-min))
13845 (re-search-forward "%!" nil t))
13846 (replace-match "")
13847 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13849 (defun org-remember-finish-immediately ()
13850 "File remember note immediately.
13851 This should be run in `post-command-hook' and will remove itself
13852 from that hook."
13853 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13854 (when org-finish-function
13855 (funcall org-finish-function)))
13857 (defvar org-clock-marker) ; Defined below
13858 (defun org-remember-finalize ()
13859 "Finalize the remember process."
13860 (unless (fboundp 'remember-finalize)
13861 (defalias 'remember-finalize 'remember-buffer))
13862 (when (and org-clock-marker
13863 (equal (marker-buffer org-clock-marker) (current-buffer)))
13864 ;; FIXME: test this, this is w/o notetaking!
13865 (let (org-log-note-clock-out) (org-clock-out)))
13866 (when buffer-file-name
13867 (save-buffer)
13868 (setq buffer-file-name nil))
13869 (remember-finalize))
13871 ;;;###autoload
13872 (defun org-remember (&optional goto org-force-remember-template-char)
13873 "Call `remember'. If this is already a remember buffer, re-apply template.
13874 If there is an active region, make sure remember uses it as initial content
13875 of the remember buffer.
13877 When called interactively with a `C-u' prefix argument GOTO, don't remember
13878 anything, just go to the file/headline where the selected template usually
13879 stores its notes. With a double prefix arg `C-u C-u', go to the last
13880 note stored by remember.
13882 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13883 associated with a template in `org-remember-templates'."
13884 (interactive "P")
13885 (cond
13886 ((equal goto '(4)) (org-go-to-remember-target))
13887 ((equal goto '(16)) (org-remember-goto-last-stored))
13888 (t
13889 ;; set temporary variables that will be needed in
13890 ;; `org-select-remember-template'
13891 (setq org-select-template-temp-major-mode major-mode)
13892 (setq org-select-template-original-buffer (current-buffer))
13893 (if (memq org-finish-function '(remember-buffer remember-finalize))
13894 (progn
13895 (when (< (length org-remember-templates) 2)
13896 (error "No other template available"))
13897 (erase-buffer)
13898 (let ((annotation (plist-get org-store-link-plist :annotation))
13899 (initial (plist-get org-store-link-plist :initial)))
13900 (org-remember-apply-template))
13901 (message "Press C-c C-c to remember data"))
13902 (if (org-region-active-p)
13903 (remember (buffer-substring (point) (mark)))
13904 (call-interactively 'remember))))))
13906 (defun org-remember-goto-last-stored ()
13907 "Go to the location where the last remember note was stored."
13908 (interactive)
13909 (bookmark-jump "org-remember-last-stored")
13910 (message "This is the last note stored by remember"))
13912 (defun org-go-to-remember-target (&optional template-key)
13913 "Go to the target location of a remember template.
13914 The user is queried for the template."
13915 (interactive)
13916 (let* (org-select-template-temp-major-mode
13917 (entry (org-select-remember-template template-key))
13918 (file (nth 1 entry))
13919 (heading (nth 2 entry))
13920 visiting)
13922 (setq file org-default-notes-file))
13924 (setq heading org-remember-default-headline))
13925 (setq visiting (org-find-base-buffer-visiting file))
13926 (if (not visiting) (find-file-noselect file))
13927 (switch-to-buffer (or visiting (get-file-buffer file)))
13928 (widen)
13929 (goto-char (point-min))
13930 (if (re-search-forward
13933 nil t)
13934 (goto-char (match-beginning 0))
13935 (error "Target headline not found: %s" heading))))
13937 (defvar org-note-abort nil) ; dynamically scoped
13939 ;;;###autoload
13940 (defun org-remember-handler ()
13941 "Store stuff from remember.el into an org file.
13942 First prompts for an org file. If the user just presses return, the value
13943 of `org-default-notes-file' is used.
13944 Then the command offers the headings tree of the selected file in order to
13945 file the text at a specific location.
13946 You can either immediately press RET to get the note appended to the
13947 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13948 find a better place. Then press RET or <left> or <right> in insert the note.
13950 Key Cursor position Note gets inserted
13951 -----------------------------------------------------------------------------
13952 RET buffer-start as level 1 heading at end of file
13953 RET on headline as sublevel of the heading at cursor
13954 RET no heading at cursor position, level taken from context.
13955 Or use prefix arg to specify level manually.
13956 <left> on headline as same level, before current heading
13957 <right> on headline as same level, after current heading
13959 So the fastest way to store the note is to press RET RET to append it to
13960 the default file. This way your current train of thought is not
13961 interrupted, in accordance with the principles of remember.el.
13962 You can also get the fast execution without prompting by using
13963 C-u C-c C-c to exit the remember buffer. See also the variable
13964 `org-remember-store-without-prompt'.
13966 Before being stored away, the function ensures that the text has a
13968 is constructed from the current date and some additional data.
13970 If the variable `org-adapt-indentation' is non-nil, the entire text is
13971 also indented so that it starts in the same column as the headline
13972 \(i.e. after the stars).
13974 See also the variable `org-reverse-note-order'."
13975 (goto-char (point-min))
13977 (replace-match ""))
13978 (goto-char (point-max))
13979 (beginning-of-line 1)
13981 (delete-region (1- (point)) (point-max))
13982 (beginning-of-line 1))
13983 (catch 'quit
13984 (if org-note-abort (throw 'quit nil))
13985 (let* ((txt (buffer-substring (point-min) (point-max)))
13986 (fastp (org-xor (equal current-prefix-arg '(4))
13987 org-remember-store-without-prompt))
13988 (file (cond
13989 (fastp org-default-notes-file)
13990 ((and (eq org-remember-interactive-interface 'refile)
13991 org-refile-targets)
13992 org-default-notes-file)
13993 ((not (and (equal current-prefix-arg '(16))
13994 org-remember-previous-location))
13995 (org-get-org-file))))
13996 (heading org-remember-default-headline)
13997 (visiting (and file (org-find-base-buffer-visiting file)))
13998 (org-startup-folded nil)
13999 (org-startup-align-all-tables nil)
14000 (org-goto-start-pos 1)
14001 spos exitcmd level indent reversed)
14002 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
14003 (setq file (car org-remember-previous-location)
14004 heading (cdr org-remember-previous-location)
14005 fastp t))
14006 (setq current-prefix-arg nil)
14008 (setq txt (replace-match "" t t txt)))
14009 ;; Modify text so that it becomes a nice subtree which can be inserted
14010 ;; into an org tree.
14012 first)
14013 (setq first (car lines) lines (cdr lines))
14015 ;; Is already a headline
14016 (setq indent nil)
14017 ;; We need to add a headline: Use time and first buffer line
14018 (setq lines (cons first lines)
14019 first (concat "* " (current-time-string)
14020 " (" (remember-buffer-desc) ")")
14021 indent " "))
14022 (if (and org-adapt-indentation indent)
14023 (setq lines (mapcar
14024 (lambda (x)
14026 (concat indent x) x))
14027 lines)))
14034 ;; Put the modified text back into the remember buffer, for refile.
14035 (erase-buffer)
14036 (insert txt)
14037 (goto-char (point-min))
14038 (when (and (eq org-remember-interactive-interface 'refile)
14039 (not fastp))
14040 (org-refile nil (or visiting (find-file-noselect file)))
14041 (throw 'quit t))
14042 ;; Find the file
14043 (if (not visiting) (find-file-noselect file))
14044 (with-current-buffer (or visiting (get-file-buffer file))
14045 (unless (org-mode-p)
14046 (error "Target files for remember notes must be in Org-mode"))
14047 (save-excursion
14048 (save-restriction
14049 (widen)
14050 (and (goto-char (point-min))
14053 (setq reversed (org-notes-order-reversed-p))
14055 ;; Find the default location
14057 (goto-char (point-min))
14058 (if (re-search-forward
14061 nil t)
14062 (setq org-goto-start-pos (match-beginning 0))
14063 (when fastp
14064 (goto-char (point-max))
14065 (unless (bolp) (newline))
14067 (setq org-goto-start-pos (point-at-bol 0)))))
14069 ;; Ask the User for a location, using the appropriate interface
14070 (cond
14071 (fastp (setq spos org-goto-start-pos
14072 exitcmd 'return))
14073 ((eq org-remember-interactive-interface 'outline)
14074 (setq spos (org-get-location (current-buffer)
14075 org-remember-help)
14076 exitcmd (cdr spos)
14077 spos (car spos)))
14078 ((eq org-remember-interactive-interface 'outline-path-completion)
14079 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
14080 (org-refile-use-outline-path t))
14081 (setq spos (org-refile-get-location "Heading: ")
14082 exitcmd 'return
14083 spos (nth 3 spos))))
14084 (t (error "this should not hapen")))
14085 (if (not spos) (throw 'quit nil)) ; return nil to show we did
14086 ; not handle this note
14087 (goto-char spos)
14088 (cond ((org-on-heading-p t)
14089 (org-back-to-heading t)
14090 (setq level (funcall outline-level))
14091 (cond
14092 ((eq exitcmd 'return)
14093 ;; sublevel of current
14094 (setq org-remember-previous-location
14095 (cons (abbreviate-file-name file)
14096 (org-get-heading 'notags)))
14097 (if reversed
14098 (outline-next-heading)
14099 (org-end-of-subtree t)
14100 (if (not (bolp))
14102 (beginning-of-line 2)
14103 (end-of-line 1)
14105 (bookmark-set "org-remember-last-stored")
14106 (org-paste-subtree (org-get-legal-level level 1) txt))
14107 ((eq exitcmd 'left)
14108 ;; before current
14109 (bookmark-set "org-remember-last-stored")
14110 (org-paste-subtree level txt))
14111 ((eq exitcmd 'right)
14112 ;; after current
14113 (org-end-of-subtree t)
14114 (bookmark-set "org-remember-last-stored")
14115 (org-paste-subtree level txt))
14116 (t (error "This should not happen"))))
14118 ((and (bobp) (not reversed))
14119 ;; Put it at the end, one level below level 1
14120 (save-restriction
14121 (widen)
14122 (goto-char (point-max))
14123 (if (not (bolp)) (newline))
14124 (bookmark-set "org-remember-last-stored")
14125 (org-paste-subtree (org-get-legal-level 1 1) txt)))
14127 ((and (bobp) reversed)
14128 ;; Put it at the start, as level 1
14129 (save-restriction
14130 (widen)
14131 (goto-char (point-min))
14133 (beginning-of-line 1)
14134 (bookmark-set "org-remember-last-stored")
14135 (org-paste-subtree 1 txt)))
14136 (t
14137 ;; Put it right there, with automatic level determined by
14138 ;; org-paste-subtree or from prefix arg
14139 (bookmark-set "org-remember-last-stored")
14140 (org-paste-subtree
14141 (if (numberp current-prefix-arg) current-prefix-arg)
14142 txt)))
14143 (when remember-save-after-remembering
14144 (save-buffer)
14145 (if (not visiting) (kill-buffer (current-buffer)))))))))
14147 t) ;; return t to indicate that we took care of this note.
14149 (defun org-get-org-file ()
14150 "Read a filename, with default directory `org-directory'."
14151 (let ((default (or org-default-notes-file remember-data-file)))
14152 (read-file-name (format "File name [%s]: " default)
14153 (file-name-as-directory org-directory)
14154 default)))
14156 (defun org-notes-order-reversed-p ()
14157 "Check if the current file should receive notes in reversed order."
14158 (cond
14159 ((not org-reverse-note-order) nil)
14160 ((eq t org-reverse-note-order) t)
14161 ((not (listp org-reverse-note-order)) nil)
14162 (t (catch 'exit
14163 (let ((all org-reverse-note-order)
14164 entry)
14165 (while (setq entry (pop all))
14166 (if (string-match (car entry) buffer-file-name)
14167 (throw 'exit (cdr entry))))
14168 nil)))))
14170 ;;; Refiling
14172 (defvar org-refile-target-table nil
14173 "The list of refile targets, created by `org-refile'.")
14175 (defvar org-agenda-new-buffers nil
14176 "Buffers created to visit agenda files.")
14178 (defun org-get-refile-targets (&optional default-buffer)
14179 "Produce a table with refile targets."
14180 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
14181 targets txt re files f desc descre)
14182 (with-current-buffer (or default-buffer (current-buffer))
14183 (while (setq entry (pop entries))
14184 (setq files (car entry) desc (cdr entry))
14185 (cond
14186 ((null files) (setq files (list (current-buffer))))
14187 ((eq files 'org-agenda-files)
14188 (setq files (org-agenda-files 'unrestricted)))
14189 ((and (symbolp files) (fboundp files))
14190 (setq files (funcall files)))
14191 ((and (symbolp files) (boundp files))
14192 (setq files (symbol-value files))))
14193 (if (stringp files) (setq files (list files)))
14194 (cond
14195 ((eq (car desc) :tag)
14197 ((eq (car desc) :todo)
14199 ((eq (car desc) :regexp)
14200 (setq descre (cdr desc)))
14201 ((eq (car desc) :level)
14203 (if org-odd-levels-only
14204 (1- (* 2 (cdr desc)))
14205 (cdr desc)))
14207 ((eq (car desc) :maxlevel)
14209 (if org-odd-levels-only
14210 (1- (* 2 (cdr desc)))
14211 (cdr desc)))
14213 (t (error "Bad refiling target description %s" desc)))
14214 (while (setq f (pop files))
14215 (save-excursion
14216 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14217 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14218 (save-excursion
14219 (save-restriction
14220 (widen)
14221 (goto-char (point-min))
14222 (while (re-search-forward descre nil t)
14223 (goto-char (point-at-bol))
14224 (when (looking-at org-complex-heading-regexp)
14225 (setq txt (match-string 4)
14226 re (concat "^" (regexp-quote
14227 (buffer-substring (match-beginning 1)
14228 (match-end 4)))))
14230 (regexp-quote
14231 (match-string 5)))))
14233 (when org-refile-use-outline-path
14234 (setq txt (mapconcat 'identity
14235 (append
14236 (if (eq org-refile-use-outline-path 'file)
14237 (list (file-name-nondirectory
14238 (buffer-file-name (buffer-base-buffer))))
14239 (if (eq org-refile-use-outline-path 'full-file-path)
14240 (list (buffer-file-name (buffer-base-buffer)))))
14241 (org-get-outline-path)
14242 (list txt))
14243 "/")))
14244 (push (list txt f re (point)) targets))
14245 (goto-char (point-at-eol))))))))
14246 (nreverse targets))))
14248 (defun org-get-outline-path ()
14249 "Return the outline path to the current entry, as a list."
14250 (let (rtn)
14251 (save-excursion
14252 (while (org-up-heading-safe)
14253 (when (looking-at org-complex-heading-regexp)
14254 (push (org-match-string-no-properties 4) rtn)))
14255 rtn)))
14257 (defvar org-refile-history nil
14258 "History for refiling operations.")
14260 (defun org-refile (&optional goto default-buffer)
14261 "Move the entry at point to another heading.
14262 The list of target headings is compiled using the information in
14263 `org-refile-targets', which see. This list is created upon first use, and
14264 you can update it by calling this command with a double prefix (`C-u C-u').
14265 FIXME: Can we find a better way of updating?
14267 At the target location, the entry is filed as a subitem of the target heading.
14268 Depending on `org-reverse-note-order', the new subitem will either be the
14269 first of the last subitem.
14271 With prefix arg GOTO, the command will only visit the target location,
14272 not actually move anything.
14273 With a double prefix `C-c C-c', go to the location where the last refiling
14274 operation has put the subtree.
14276 With a double prefix argument, the command can be used to jump to any
14277 heading in the current buffer."
14278 (interactive "P")
14279 (let* ((cbuf (current-buffer))
14280 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14281 pos it nbuf file re level reversed)
14282 (if (equal goto '(16))
14283 (org-refile-goto-last-stored)
14284 (when (setq it (org-refile-get-location
14285 (if goto "Goto: " "Refile to: ") default-buffer))
14286 (setq file (nth 1 it)
14287 re (nth 2 it)
14288 pos (nth 3 it))
14289 (setq nbuf (or (find-buffer-visiting file)
14290 (find-file-noselect file)))
14291 (if goto
14292 (progn
14293 (switch-to-buffer nbuf)
14294 (goto-char pos)
14295 (org-show-context 'org-goto))
14296 (org-copy-special)
14297 (save-excursion
14298 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14299 (find-file-noselect file))))
14300 (setq reversed (org-notes-order-reversed-p))
14301 (save-excursion
14302 (save-restriction
14303 (widen)
14304 (goto-char pos)
14305 (looking-at outline-regexp)
14306 (setq level (org-get-legal-level (funcall outline-level) 1))
14307 (goto-char
14308 (if reversed
14309 (outline-next-heading)
14310 (or (save-excursion (outline-get-next-sibling))
14311 (org-end-of-subtree t t)
14312 (point-max))))
14313 (bookmark-set "org-refile-last-stored")
14314 (org-paste-subtree level))))
14315 (org-cut-special)
14318 (defun org-refile-goto-last-stored ()
14319 "Go to the location where the last refile was stored."
14320 (interactive)
14321 (bookmark-jump "org-refile-last-stored")
14322 (message "This is the location of the last refile"))
14324 (defun org-refile-get-location (&optional prompt default-buffer)
14325 "Prompt the user for a refile location, using PROMPT."
14326 (let ((org-refile-targets org-refile-targets)
14327 (org-refile-use-outline-path org-refile-use-outline-path))
14328 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14329 (unless org-refile-target-table
14330 (error "No refile targets"))
14331 (let* ((cbuf (current-buffer))
14332 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14333 (fname (and filename (file-truename filename)))
14334 (tbl (mapcar
14335 (lambda (x)
14336 (if (not (equal fname (file-truename (nth 1 x))))
14337 (cons (concat (car x) " (" (file-name-nondirectory
14338 (nth 1 x)) ")")
14339 (cdr x))
14340 x))
14341 org-refile-target-table))
14342 (completion-ignore-case t))
14343 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14344 tbl)))
14346 ;;;; Dynamic blocks
14348 (defun org-find-dblock (name)
14349 "Find the first dynamic block with name NAME in the buffer.
14350 If not found, stay at current position and return nil."
14351 (let (pos)
14352 (save-excursion
14353 (goto-char (point-min))
14355 nil t)
14356 (match-beginning 0))))
14357 (if pos (goto-char pos))
14358 pos))
14360 (defconst org-dblock-start-re
14362 "Matches the startline of a dynamic block, with parameters.")
14365 "Matches the end of a dyhamic block.")
14367 (defun org-create-dblock (plist)
14368 "Create a dynamic block section, with parameters taken from PLIST.
14369 PLIST must containe a :name entry which is used as name of the block."
14370 (unless (bolp) (newline))
14371 (let ((name (plist-get plist :name)))
14372 (insert "#+BEGIN: " name)
14373 (while plist
14374 (if (eq (car plist) :name)
14375 (setq plist (cddr plist))
14376 (insert " " (prin1-to-string (pop plist)))))
14378 (beginning-of-line -2)))
14380 (defun org-prepare-dblock ()
14381 "Prepare dynamic block for refresh.
14382 This empties the block, puts the cursor at the insert position and returns
14383 the property list including an extra property :name with the block name."
14384 (unless (looking-at org-dblock-start-re)
14385 (error "Not at a dynamic block"))
14386 (let* ((begdel (1+ (match-end 0)))
14387 (name (org-no-properties (match-string 1)))
14388 (params (append (list :name name)
14389 (read (concat "(" (match-string 3) ")")))))
14390 (unless (re-search-forward org-dblock-end-re nil t)
14391 (error "Dynamic block not terminated"))
14392 (delete-region begdel (match-beginning 0))
14393 (goto-char begdel)
14394 (open-line 1)
14395 params))
14397 (defun org-map-dblocks (&optional command)
14398 "Apply COMMAND to all dynamic blocks in the current buffer.
14399 If COMMAND is not given, use `org-update-dblock'."
14400 (let ((cmd (or command 'org-update-dblock))
14401 pos)
14402 (save-excursion
14403 (goto-char (point-min))
14404 (while (re-search-forward org-dblock-start-re nil t)
14405 (goto-char (setq pos (match-beginning 0)))
14406 (condition-case nil
14407 (funcall cmd)
14408 (error (message "Error during update of dynamic block")))
14409 (goto-char pos)
14410 (unless (re-search-forward org-dblock-end-re nil t)
14411 (error "Dynamic block not terminated"))))))
14413 (defun org-dblock-update (&optional arg)
14414 "User command for updating dynamic blocks.
14415 Update the dynamic block at point. With prefix ARG, update all dynamic
14416 blocks in the buffer."
14417 (interactive "P")
14418 (if arg
14419 (org-update-all-dblocks)
14420 (or (looking-at org-dblock-start-re)
14421 (org-beginning-of-dblock))
14422 (org-update-dblock)))
14424 (defun org-update-dblock ()
14425 "Update the dynamic block at point
14426 This means to empty the block, parse for parameters and then call
14427 the correct writing function."
14428 (save-window-excursion
14429 (let* ((pos (point))
14430 (line (org-current-line))
14431 (params (org-prepare-dblock))
14432 (name (plist-get params :name))
14433 (cmd (intern (concat "org-dblock-write:" name))))
14434 (message "Updating dynamic block `%s' at line %d..." name line)
14435 (funcall cmd params)
14436 (message "Updating dynamic block `%s' at line %d...done" name line)
14437 (goto-char pos))))
14439 (defun org-beginning-of-dblock ()
14440 "Find the beginning of the dynamic block at point.
14441 Error if there is no scuh block at point."
14442 (let ((pos (point))
14443 beg)
14444 (end-of-line 1)
14445 (if (and (re-search-backward org-dblock-start-re nil t)
14446 (setq beg (match-beginning 0))
14447 (re-search-forward org-dblock-end-re nil t)
14448 (> (match-end 0) pos))
14449 (goto-char beg)
14450 (goto-char pos)
14451 (error "Not in a dynamic block"))))
14453 (defun org-update-all-dblocks ()
14454 "Update all dynamic blocks in the buffer.
14455 This function can be used in a hook."
14456 (when (org-mode-p)
14457 (org-map-dblocks 'org-update-dblock)))
14460 ;;;; Completion
14462 (defconst org-additional-option-like-keywords
14463 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14464 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14465 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14467 (defun org-complete (&optional arg)
14468 "Perform completion on word at point.
14469 At the beginning of a headline, this completes TODO keywords as given in
14470 `org-todo-keywords'.
14471 If the current word is preceded by a backslash, completes the TeX symbols
14472 that are supported for HTML support.
14474 setting file options.
14476 At all other locations, this simply calls the value of
14477 `org-completion-fallback-command'."
14478 (interactive "P")
14479 (org-without-partial-completion
14480 (catch 'exit
14481 (let* ((end (point))
14482 (beg1 (save-excursion
14483 (skip-chars-backward (org-re "[:alnum:]_@"))
14484 (point)))
14485 (beg (save-excursion
14486 (skip-chars-backward "a-zA-Z0-9_:$")
14487 (point)))
14488 (confirm (lambda (x) (stringp (car x))))
14489 (searchhead (equal (char-before beg) ?*))
14490 (tag (and (equal (char-before beg1) ?:)
14491 (equal (char-after (point-at-bol)) ?*)))
14492 (prop (and (equal (char-before beg1) ?:)
14493 (not (equal (char-after (point-at-bol)) ?*))))
14495 (link (equal (char-before beg) ?\[))
14496 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14497 beg)
14498 "#+"))
14500 (buffer-substring (point-at-bol) (point))))
14501 (completion-ignore-case opt)
14502 (type nil)
14503 (tbl nil)
14504 (table (cond
14505 (opt
14506 (setq type :opt)
14507 (append
14508 (mapcar
14509 (lambda (x)
14511 (cons (match-string 2 x) (match-string 1 x)))
14513 (mapcar 'list org-additional-option-like-keywords)))
14514 (startup
14515 (setq type :startup)
14516 org-startup-options)
14517 (link (append org-link-abbrev-alist-local
14518 org-link-abbrev-alist))
14519 (texp
14520 (setq type :tex)
14521 org-html-entities)
14523 (buffer-substring (point-at-bol) beg))
14524 (setq type :todo)
14525 (mapcar 'list org-todo-keywords-1))
14526 (searchhead
14527 (setq type :searchhead)
14528 (save-excursion
14529 (goto-char (point-min))
14530 (while (re-search-forward org-todo-line-regexp nil t)
14531 (push (list
14532 (org-make-org-heading-search-string
14533 (match-string 3) t))
14534 tbl)))
14535 tbl)
14536 (tag (setq type :tag beg beg1)
14537 (or org-tag-alist (org-get-buffer-tags)))
14538 (prop (setq type :prop beg beg1)
14539 (mapcar 'list (org-buffer-property-keys nil t t)))
14540 (t (progn
14541 (call-interactively org-completion-fallback-command)
14542 (throw 'exit nil)))))
14543 (pattern (buffer-substring-no-properties beg end))
14544 (completion (try-completion pattern table confirm)))
14545 (cond ((eq completion t)
14546 (if (not (assoc (upcase pattern) table))
14547 (message "Already complete")
14548 (if (equal type :opt)
14549 (insert (substring (cdr (assoc (upcase pattern) table))
14550 (length pattern)))
14551 (if (memq type '(:tag :prop)) (insert ":")))))
14552 ((null completion)
14554 (ding))
14555 ((not (string= pattern completion))
14556 (delete-region beg end)
14557 (if (string-match " +$" completion)
14558 (setq completion (replace-match "" t t completion)))
14559 (insert completion)
14560 (if (get-buffer-window "*Completions*")
14561 (delete-window (get-buffer-window "*Completions*")))
14562 (if (assoc completion table)
14563 (if (eq type :todo) (insert " ")
14564 (if (memq type '(:tag :prop)) (insert ":"))))
14565 (if (and (equal type :opt) (assoc completion table))
14566 (message "%s" (substitute-command-keys
14568 (t
14569 (message "Making completion list...")
14570 (let ((list (sort (all-completions pattern table confirm)
14571 'string<)))
14572 (with-output-to-temp-buffer "*Completions*"
14573 (condition-case nil
14574 ;; Protection needed for XEmacs and emacs 21
14575 (display-completion-list list pattern)
14576 (error (display-completion-list list)))))
14577 (message "Making completion list...%s" "done")))))))
14579 ;;;; TODO, DEADLINE, Comments
14581 (defun org-toggle-comment ()
14582 "Change the COMMENT state of an entry."
14583 (interactive)
14584 (save-excursion
14585 (org-back-to-heading)
14586 (let (case-fold-search)
14587 (if (looking-at (concat outline-regexp
14589 (replace-match "" t t nil 1)
14590 (if (looking-at outline-regexp)
14591 (progn
14592 (goto-char (match-end 0))
14593 (insert org-comment-string " ")))))))
14595 (defvar org-last-todo-state-is-todo nil
14596 "This is non-nil when the last TODO state change led to a TODO state.
14597 If the last change removed the TODO tag or switched to DONE, then
14598 this is nil.")
14600 (defvar org-setting-tags nil) ; dynamically skiped
14602 ;; FIXME: better place
14603 (defun org-property-or-variable-value (var &optional inherit)
14604 "Check if there is a property fixing the value of VAR.
14605 If yes, return this value. If not, return the current value of the variable."
14606 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14608 (read prop)
14609 (symbol-value var))))
14611 (defun org-parse-local-options (string var)
14612 "Parse STRING for startup setting relevant for variable VAR."
14613 (let ((rtn (symbol-value var))
14614 e opts)
14615 (save-match-data
14617 rtn
14618 (setq opts (delq nil (mapcar (lambda (x)
14619 (setq e (assoc x org-startup-options))
14620 (if (eq (nth 1 e) var) e nil))
14622 (if (not opts)
14623 rtn
14624 (setq rtn nil)
14625 (while (setq e (pop opts))
14626 (if (not (nth 3 e))
14627 (setq rtn (nth 2 e))
14628 (if (not (listp rtn)) (setq rtn nil))
14629 (push (nth 2 e) rtn)))
14630 rtn)))))
14632 (defvar org-blocker-hook nil
14633 "Hook for functions that are allowed to block a state change.
14635 Each function gets as its single argument a property list, see
14636 `org-trigger-hook' for more information about this list.
14638 If any of the functions in this hook returns nil, the state change
14639 is blocked.")
14641 (defvar org-trigger-hook nil
14642 "Hook for functions that are triggered by a state change.
14644 Each function gets as its single argument a property list with at least
14645 the following elements:
14647 (:type type-of-change :position pos-at-entry-start
14648 :from old-state :to new-state)
14650 Depending on the type, more properties may be present.
14652 This mechanism is currently implemented for:
14654 TODO state changes
14655 ------------------
14656 :type todo-state-change
14657 :from previous state (keyword as a string), or nil
14658 :to new state (keyword as a string), or nil")
14661 (defun org-todo (&optional arg)
14662 "Change the TODO state of an item.
14663 The state of an item is given by a keyword at the start of the heading,
14664 like
14665 *** TODO Write paper
14666 *** DONE Call mom
14668 The different keywords are specified in the variable `org-todo-keywords'.
14670 So for this example: when the item starts with TODO, it is changed to DONE.
14671 When it starts with DONE, the DONE is removed. And when neither TODO nor
14672 DONE are present, add TODO at the beginning of the heading.
14674 With C-u prefix arg, use completion to determine the new state.
14675 With numeric prefix arg, switch to that state.
14677 For calling through lisp, arg is also interpreted in the following way:
14678 'none -> empty state
14680 'done -> switch to DONE
14681 'nextset -> switch to the next set of keywords
14682 'previousset -> switch to the previous set of keywords
14684 really is a member of `org-todo-keywords'."
14685 (interactive "P")
14686 (save-excursion
14687 (catch 'exit
14688 (org-back-to-heading)
14689 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14690 (or (looking-at (concat " +" org-todo-regexp " *"))
14691 (looking-at " *"))
14692 (let* ((match-data (match-data))
14693 (startpos (point-at-bol))
14694 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14695 (org-log-done org-log-done)
14696 (org-log-repeat org-log-repeat)
14697 (org-todo-log-states org-todo-log-states)
14698 (this (match-string 1))
14699 (hl-pos (match-beginning 0))
14700 (head (org-get-todo-sequence-head this))
14701 (ass (assoc head org-todo-kwd-alist))
14702 (interpret (nth 1 ass))
14703 (done-word (nth 3 ass))
14704 (final-done-word (nth 4 ass))
14705 (last-state (or this ""))
14706 (completion-ignore-case t)
14707 (member (member this org-todo-keywords-1))
14708 (tail (cdr member))
14709 (state (cond
14710 ((and org-todo-key-trigger
14711 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14712 (and (not arg) org-use-fast-todo-selection
14713 (not (eq org-use-fast-todo-selection 'prefix)))))
14714 ;; Use fast selection
14715 (org-fast-todo-selection))
14716 ((and (equal arg '(4))
14717 (or (not org-use-fast-todo-selection)
14718 (not org-todo-key-trigger)))
14719 ;; Read a state with completion
14720 (completing-read "State: " (mapcar (lambda(x) (list x))
14721 org-todo-keywords-1)
14722 nil t))
14723 ((eq arg 'right)
14724 (if this
14725 (if tail (car tail) nil)
14726 (car org-todo-keywords-1)))
14727 ((eq arg 'left)
14728 (if (equal member org-todo-keywords-1)
14729 nil
14730 (if this
14731 (nth (- (length org-todo-keywords-1) (length tail) 2)
14732 org-todo-keywords-1)
14733 (org-last org-todo-keywords-1))))
14734 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14735 (setq arg nil))) ; hack to fall back to cycling
14736 (arg
14737 ;; user or caller requests a specific state
14738 (cond
14739 ((equal arg "") nil)
14740 ((eq arg 'none) nil)
14741 ((eq arg 'done) (or done-word (car org-done-keywords)))
14742 ((eq arg 'nextset)
14743 (or (car (cdr (member head org-todo-heads)))
14744 (car org-todo-heads)))
14745 ((eq arg 'previousset)
14746 (let ((org-todo-heads (reverse org-todo-heads)))
14747 (or (car (cdr (member head org-todo-heads)))
14748 (car org-todo-heads))))
14749 ((car (member arg org-todo-keywords-1)))
14750 ((nth (1- (prefix-numeric-value arg))
14751 org-todo-keywords-1))))
14752 ((null member) (or head (car org-todo-keywords-1)))
14753 ((equal this final-done-word) nil) ;; -> make empty
14754 ((null tail) nil) ;; -> first entry
14755 ((eq interpret 'sequence)
14756 (car tail))
14757 ((memq interpret '(type priority))
14758 (if (eq this-command last-command)
14759 (car tail)
14760 (if (> (length tail) 0)
14761 (or done-word (car org-done-keywords))
14762 nil)))
14763 (t nil)))
14764 (next (if state (concat " " state " ") " "))
14765 (change-plist (list :type 'todo-state-change :from this :to state
14766 :position startpos))
14767 dolog now-done-p)
14768 (when org-blocker-hook
14769 (unless (save-excursion
14770 (save-match-data
14771 (run-hook-with-args-until-failure
14772 'org-blocker-hook change-plist)))
14773 (if (interactive-p)
14774 (error "TODO state change from %s to %s blocked" this state)
14775 ;; fail silently
14776 (message "TODO state change from %s to %s blocked" this state)
14777 (throw 'exit nil))))
14778 (store-match-data match-data)
14779 (replace-match next t t)
14780 (unless (pos-visible-in-window-p hl-pos)
14781 (message "TODO state changed to %s" (org-trim next)))
14782 (unless head
14783 (setq head (org-get-todo-sequence-head state)
14784 ass (assoc head org-todo-kwd-alist)
14785 interpret (nth 1 ass)
14786 done-word (nth 3 ass)
14787 final-done-word (nth 4 ass)))
14788 (when (memq arg '(nextset previousset))
14789 (message "Keyword-Set %d/%d: %s"
14790 (- (length org-todo-sets) -1
14791 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14792 (length org-todo-sets)
14793 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14794 (setq org-last-todo-state-is-todo
14795 (not (member state org-done-keywords)))
14796 (setq now-done-p (and (member state org-done-keywords)
14797 (not (member this org-done-keywords))))
14798 (and logging (org-local-logging logging))
14799 (when (and (or org-todo-log-states org-log-done)
14800 (not (memq arg '(nextset previousset))))
14801 ;; we need to look at recording a time and note
14802 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14803 (nth 2 (assoc this org-todo-log-states))))
14804 (when (and state
14805 (member state org-not-done-keywords)
14806 (not (member this org-not-done-keywords)))
14807 ;; This is now a todo state and was not one before
14808 ;; If there was a CLOSED time stamp, get rid of it.
14809 (org-add-planning-info nil nil 'closed))
14810 (when (and now-done-p org-log-done)
14811 ;; It is now done, and it was not done before
14812 (org-add-planning-info 'closed (org-current-time))
14813 (if (and (not dolog) (eq 'note org-log-done))
14814 (org-add-log-maybe 'done state 'findpos 'note)))
14815 (when (and state dolog)
14816 ;; This is a non-nil state, and we need to log it
14817 (org-add-log-maybe 'state state 'findpos dolog)))
14818 ;; Fixup tag positioning
14819 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14820 (run-hooks 'org-after-todo-state-change-hook)
14821 (if (and arg (not (member state org-done-keywords)))
14822 (setq head (org-get-todo-sequence-head state)))
14823 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14824 ;; Do we need to trigger a repeat?
14825 (when now-done-p (org-auto-repeat-maybe state))
14826 ;; Fixup cursor location if close to the keyword
14827 (if (and (outline-on-heading-p)
14828 (not (bolp))
14829 (save-excursion (beginning-of-line 1)
14830 (looking-at org-todo-line-regexp))
14831 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14832 (progn
14833 (goto-char (or (match-end 2) (match-end 1)))
14834 (just-one-space)))
14835 (when org-trigger-hook
14836 (save-excursion
14837 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14839 (defun org-local-logging (value)
14840 "Get logging settings from a property VALUE."
14841 (let* (words w a)
14842 ;; directly set the variables, they are already local.
14843 (setq org-log-done nil
14844 org-log-repeat nil
14845 org-todo-log-states nil)
14846 (setq words (org-split-string value))
14847 (while (setq w (pop words))
14848 (cond
14849 ((setq a (assoc w org-startup-options))
14850 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14851 (set (nth 1 a) (nth 2 a))))
14852 ((setq a (org-extract-log-state-settings w))
14853 (and (member (car a) org-todo-keywords-1)
14854 (push a org-todo-log-states)))))))
14856 (defun org-get-todo-sequence-head (kwd)
14857 "Return the head of the TODO sequence to which KWD belongs.
14858 If KWD is not set, check if there is a text property remembering the
14859 right sequence."
14860 (let (p)
14861 (cond
14862 ((not kwd)
14863 (or (get-text-property (point-at-bol) 'org-todo-head)
14864 (progn
14865 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14866 nil (point-at-eol)))
14867 (get-text-property p 'org-todo-head))))
14868 ((not (member kwd org-todo-keywords-1))
14869 (car org-todo-keywords-1))
14870 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14872 (defun org-fast-todo-selection ()
14873 "Fast TODO keyword selection with single keys.
14874 Returns the new TODO keyword, or nil if no state change should occur."
14875 (let* ((fulltable org-todo-key-alist)
14876 (done-keywords org-done-keywords) ;; needed for the faces.
14877 (maxlen (apply 'max (mapcar
14878 (lambda (x)
14879 (if (stringp (car x)) (string-width (car x)) 0))
14880 fulltable)))
14881 (expert nil)
14882 (fwidth (+ maxlen 3 1 3))
14883 (ncol (/ (- (window-width) 4) fwidth))
14884 tg cnt e c tbl
14885 groups ingroup)
14886 (save-window-excursion
14887 (if expert
14888 (set-buffer (get-buffer-create " *Org todo*"))
14889 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14890 (erase-buffer)
14891 (org-set-local 'org-done-keywords done-keywords)
14892 (setq tbl fulltable cnt 0)
14893 (while (setq e (pop tbl))
14894 (cond
14895 ((equal e '(:startgroup))
14896 (push '() groups) (setq ingroup t)
14897 (when (not (= cnt 0))
14898 (setq cnt 0)
14900 (insert "{ "))
14901 ((equal e '(:endgroup))
14902 (setq ingroup nil cnt 0)
14904 (t
14905 (setq tg (car e) c (cdr e))
14906 (if ingroup (push tg (car groups)))
14907 (setq tg (org-add-props tg nil 'face
14908 (org-get-todo-face tg)))
14909 (if (and (= cnt 0) (not ingroup)) (insert " "))
14910 (insert "[" c "] " tg (make-string
14911 (- fwidth 4 (length tg)) ?\ ))
14912 (when (= (setq cnt (1+ cnt)) ncol)
14914 (if ingroup (insert " "))
14915 (setq cnt 0)))))
14917 (goto-char (point-min))
14918 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14919 (fit-window-to-buffer))
14920 (message "[a-z..]:Set [SPC]:clear")
14921 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14922 (cond
14923 ((or (= c ?\C-g)
14924 (and (= c ?q) (not (rassoc c fulltable))))
14925 (setq quit-flag t))
14926 ((= c ?\ ) nil)
14927 ((setq e (rassoc c fulltable) tg (car e))
14928 tg)
14929 (t (setq quit-flag t))))))
14931 (defun org-get-repeat ()
14932 "Check if tere is a deadline/schedule with repeater in this entry."
14933 (save-match-data
14934 (save-excursion
14935 (org-back-to-heading t)
14936 (if (re-search-forward
14937 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14938 (match-string 1)))))
14940 (defvar org-last-changed-timestamp)
14941 (defvar org-log-post-message)
14942 (defvar org-log-note-purpose)
14943 (defun org-auto-repeat-maybe (done-word)
14944 "Check if the current headline contains a repeated deadline/schedule.
14945 If yes, set TODO state back to what it was and change the base date
14946 of repeating deadline/scheduled time stamps to new date.
14947 This function is run automatically after each state change to a DONE state."
14948 ;; last-state is dynamically scoped into this function
14949 (let* ((repeat (org-get-repeat))
14950 (aa (assoc last-state org-todo-kwd-alist))
14951 (interpret (nth 1 aa))
14952 (head (nth 2 aa))
14953 (whata '(("d" . day) ("m" . month) ("y" . year)))
14954 (msg "Entry repeats: ")
14955 (org-log-done nil)
14956 (org-todo-log-states nil)
14957 re type n what ts)
14958 (when repeat
14959 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
14960 (org-todo (if (eq interpret 'type) last-state head))
14961 (when (and org-log-repeat
14962 (or (not (memq 'org-add-log-note
14963 (default-value 'post-command-hook)))
14964 (eq org-log-note-purpose 'done)))
14965 ;; Make sure a note is taken;
14966 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
14967 'findpos org-log-repeat))
14968 (org-back-to-heading t)
14969 (org-add-planning-info nil nil 'closed)
14973 (while (re-search-forward
14974 re (save-excursion (outline-next-heading) (point)) t)
14975 (setq type (if (match-end 1) org-scheduled-string
14976 (if (match-end 3) org-deadline-string "Plain:"))
14977 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14979 (setq n (string-to-number (match-string 1 ts))
14980 what (match-string 2 ts))
14981 (if (equal what "w") (setq n (* n 7) what "d"))
14982 (org-timestamp-change n (cdr (assoc what whata)))
14983 (setq msg (concat msg type org-last-changed-timestamp " "))))
14984 (setq org-log-post-message msg)
14985 (message "%s" msg))))
14987 (defun org-show-todo-tree (arg)
14988 "Make a compact tree which shows all headlines marked with TODO.
14989 The tree will show the lines where the regexp matches, and all higher
14990 headlines above the match.
14992 With a numeric prefix N, construct a sparse tree for the Nth element
14993 of `org-todo-keywords-1'."
14994 (interactive "P")
14995 (let ((case-fold-search nil)
14996 (kwd-re
14997 (cond ((null arg) org-not-done-regexp)
14998 ((equal arg '(4))
14999 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
15000 (mapcar 'list org-todo-keywords-1))))
15004 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
15005 (regexp-quote (nth (1- (prefix-numeric-value arg))
15006 org-todo-keywords-1)))
15007 (t (error "Invalid prefix argument: %s" arg)))))
15008 (message "%d TODO entries found"
15009 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
15011 (defun org-deadline (&optional remove)
15013 With argument REMOVE, remove any deadline from the item."
15014 (interactive "P")
15015 (if remove
15016 (progn
15017 (org-remove-timestamp-with-keyword org-deadline-string)
15018 (message "Item no longer has a deadline."))
15019 (org-add-planning-info 'deadline nil 'closed)))
15021 (defun org-schedule (&optional remove)
15022 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
15023 With argument REMOVE, remove any scheduling date from the item."
15024 (interactive "P")
15025 (if remove
15026 (progn
15027 (org-remove-timestamp-with-keyword org-scheduled-string)
15028 (message "Item is no longer scheduled."))
15029 (org-add-planning-info 'scheduled nil 'closed)))
15031 (defun org-remove-timestamp-with-keyword (keyword)
15032 "Remove all time stamps with KEYWORD in the current entry."
15034 beg)
15035 (save-excursion
15036 (org-back-to-heading t)
15037 (setq beg (point))
15038 (org-end-of-subtree t t)
15039 (while (re-search-backward re beg t)
15040 (replace-match "")
15042 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
15044 (defun org-add-planning-info (what &optional time &rest remove)
15045 "Insert new timestamp with keyword in the line directly after the headline.
15046 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
15047 If non is given, the user is prompted for a date.
15048 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
15049 be removed."
15050 (interactive)
15051 (let (org-time-was-given org-end-time-was-given)
15052 (when what (setq time (or time (org-read-date nil 'to-time))))
15053 (when (and org-insert-labeled-timestamps-at-point
15054 (member what '(scheduled deadline)))
15055 (insert
15056 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
15057 (org-insert-time-stamp time org-time-was-given
15058 nil nil nil (list org-end-time-was-given))
15059 (setq what nil))
15060 (save-excursion
15061 (save-restriction
15062 (let (col list elt ts buffer-invisibility-spec)
15063 (org-back-to-heading t)
15065 (goto-char (match-end 1))
15066 (setq col (current-column))
15067 (goto-char (match-end 0))
15069 (if (and (not (looking-at outline-regexp))
15072 (not (equal (match-string 1) org-clock-string)))
15073 (narrow-to-region (match-beginning 0) (match-end 0))
15075 (backward-char 1)
15076 (narrow-to-region (point) (point))
15077 (indent-to-column col))
15078 ;; Check if we have to remove something.
15079 (setq list (cons what remove))
15080 (while list
15081 (setq elt (pop list))
15082 (goto-char (point-min))
15083 (when (or (and (eq elt 'scheduled)
15084 (re-search-forward org-scheduled-time-regexp nil t))
15085 (and (eq elt 'deadline)
15086 (re-search-forward org-deadline-time-regexp nil t))
15087 (and (eq elt 'closed)
15088 (re-search-forward org-closed-time-regexp nil t)))
15089 (replace-match "")
15090 (if (looking-at "--+<[^>]+>") (replace-match ""))
15091 (if (looking-at " +") (replace-match ""))))
15092 (goto-char (point-max))
15093 (when what
15094 (insert
15095 (if (not (equal (char-before) ?\ )) " " "")
15096 (cond ((eq what 'scheduled) org-scheduled-string)
15097 ((eq what 'deadline) org-deadline-string)
15098 ((eq what 'closed) org-closed-string))
15099 " ")
15100 (setq ts (org-insert-time-stamp
15101 time
15102 (or org-time-was-given
15103 (and (eq what 'closed) org-log-done-with-time))
15104 (eq what 'closed)
15105 nil nil (list org-end-time-was-given)))
15106 (end-of-line 1))
15107 (goto-char (point-min))
15108 (widen)
15110 (replace-match ""))
15111 ts)))))
15113 (defvar org-log-note-marker (make-marker))
15114 (defvar org-log-note-purpose nil)
15115 (defvar org-log-note-state nil)
15116 (defvar org-log-note-how nil)
15117 (defvar org-log-note-window-configuration nil)
15118 (defvar org-log-note-return-to (make-marker))
15119 (defvar org-log-post-message nil
15120 "Message to be displayed after a log note has been stored.
15121 The auto-repeater uses this.")
15123 (defun org-add-log-maybe (&optional purpose state findpos how)
15124 "Set up the post command hook to take a note.
15125 If this is about to TODO state change, the new state is expected in STATE.
15126 When FINDPOS is non-nil, find the correct position for the note in
15127 the current entry. If not, assume that it can be inserted at point."
15128 (save-excursion
15129 (when findpos
15130 (org-back-to-heading t)
15134 (goto-char (match-end 0))
15135 (unless org-log-states-order-reversed
15137 (org-skip-over-state-notes)
15139 (move-marker org-log-note-marker (point))
15140 (setq org-log-note-purpose purpose
15141 org-log-note-state state
15142 org-log-note-how how)
15143 (add-hook 'post-command-hook 'org-add-log-note 'append)))
15145 (defun org-skip-over-state-notes ()
15146 "Skip past the list of State notes in an entry."
15149 (condition-case nil
15150 (org-next-item)
15151 (error (org-end-of-item)))))
15153 (defun org-add-log-note (&optional purpose)
15154 "Pop up a window for taking a note, and add this note later at point."
15155 (remove-hook 'post-command-hook 'org-add-log-note)
15156 (setq org-log-note-window-configuration (current-window-configuration))
15157 (delete-other-windows)
15158 (move-marker org-log-note-return-to (point))
15159 (switch-to-buffer (marker-buffer org-log-note-marker))
15160 (goto-char org-log-note-marker)
15161 (org-switch-to-buffer-other-window "*Org Note*")
15162 (erase-buffer)
15163 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
15164 (org-store-log-note)
15165 (let ((org-inhibit-startup t)) (org-mode))
15166 (insert (format "# Insert note for %s.
15168 (cond
15169 ((eq org-log-note-purpose 'clock-out) "stopped clock")
15170 ((eq org-log-note-purpose 'done) "closed todo item")
15171 ((eq org-log-note-purpose 'state)
15173 (t (error "This should not happen")))))
15174 (org-set-local 'org-finish-function 'org-store-log-note)))
15176 (defun org-store-log-note ()
15177 "Finish taking a log note, and insert it to where it belongs."
15178 (let ((txt (buffer-string))
15179 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
15180 lines ind)
15181 (kill-buffer (current-buffer))
15183 (setq txt (replace-match "" t t txt)))
15185 (setq txt (replace-match "" t t txt)))
15188 (setq note
15189 (org-replace-escapes
15190 note
15191 (list (cons "%u" (user-login-name))
15192 (cons "%U" user-full-name)
15193 (cons "%t" (format-time-string
15194 (org-time-stamp-format 'long 'inactive)
15195 (current-time)))
15196 (cons "%s" (if org-log-note-state
15198 "")))))
15200 (push note lines))
15201 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15202 (when lines
15203 (save-excursion
15204 (set-buffer (marker-buffer org-log-note-marker))
15205 (save-excursion
15206 (goto-char org-log-note-marker)
15207 (move-marker org-log-note-marker nil)
15208 (end-of-line 1)
15210 (indent-relative nil)
15211 (insert "- " (pop lines))
15212 (org-indent-line-function)
15213 (beginning-of-line 1)
15215 (setq ind (concat (match-string 0) " "))
15216 (end-of-line 1)
15218 (set-window-configuration org-log-note-window-configuration)
15219 (with-current-buffer (marker-buffer org-log-note-return-to)
15220 (goto-char org-log-note-return-to))
15221 (move-marker org-log-note-return-to nil)
15222 (and org-log-post-message (message "%s" org-log-post-message)))
15224 ;; FIXME: what else would be useful?
15225 ;; - priority
15226 ;; - date
15228 (defun org-sparse-tree (&optional arg)
15229 "Create a sparse tree, prompt for the details.
15230 This command can create sparse trees. You first need to select the type
15231 of match used to create the tree:
15233 t Show entries with a specific TODO keyword.
15234 T Show entries selected by a tags match.
15235 p Enter a property name and its value (both with completion on existing
15236 names/values) and show entries with that property.
15237 r Show entries matching a regular expression
15238 d Show deadlines due within `org-deadline-warning-days'."
15239 (interactive "P")
15240 (let (ans kwd value)
15241 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15242 (setq ans (read-char-exclusive))
15243 (cond
15244 ((equal ans ?d)
15245 (call-interactively 'org-check-deadlines))
15246 ((equal ans ?b)
15247 (call-interactively 'org-check-before-date))
15248 ((equal ans ?t)
15249 (org-show-todo-tree '(4)))
15250 ((equal ans ?T)
15251 (call-interactively 'org-tags-sparse-tree))
15252 ((member ans '(?p ?P))
15253 (setq kwd (completing-read "Property: "
15254 (mapcar 'list (org-buffer-property-keys))))
15255 (setq value (completing-read "Value: "
15256 (mapcar 'list (org-property-values kwd))))
15259 (org-tags-sparse-tree arg (concat kwd "=" value)))
15260 ((member ans '(?r ?R ?/))
15261 (call-interactively 'org-occur))
15264 (defvar org-occur-highlights nil
15265 "List of overlays used for occur matches.")
15266 (make-variable-buffer-local 'org-occur-highlights)
15267 (defvar org-occur-parameters nil
15268 "Parameters of the active org-occur calls.
15269 This is a list, each call to org-occur pushes as cons cell,
15270 containing the regular expression and the callback, onto the list.
15271 The list can contain several entries if `org-occur' has been called
15272 several time with the KEEP-PREVIOUS argument. Otherwise, this list
15273 will only contain one set of parameters. When the highlights are
15274 removed (for example with `C-c C-c', or with the next edit (depending
15275 on `org-remove-highlights-with-change'), this variable is emptied
15276 as well.")
15277 (make-variable-buffer-local 'org-occur-parameters)
15279 (defun org-occur (regexp &optional keep-previous callback)
15280 "Make a compact tree which shows all matches of REGEXP.
15281 The tree will show the lines where the regexp matches, and all higher
15282 headlines above the match. It will also show the heading after the match,
15283 to make sure editing the matching entry is easy.
15284 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15285 call to `org-occur' will be kept, to allow stacking of calls to this
15286 command.
15287 If CALLBACK is non-nil, it is a function which is called to confirm
15288 that the match should indeed be shown."
15290 (unless keep-previous
15291 (org-remove-occur-highlights nil nil t))
15292 (push (cons regexp callback) org-occur-parameters)
15293 (let ((cnt 0))
15294 (save-excursion
15295 (goto-char (point-min))
15296 (if (or (not keep-previous) ; do not want to keep
15297 (not org-occur-highlights)) ; no previous matches
15298 ;; hide everything
15299 (org-overview))
15300 (while (re-search-forward regexp nil t)
15301 (when (or (not callback)
15302 (save-match-data (funcall callback)))
15303 (setq cnt (1+ cnt))
15304 (when org-highlight-sparse-tree-matches
15305 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15306 (org-show-context 'occur-tree))))
15307 (when org-remove-highlights-with-change
15308 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15309 nil 'local))
15310 (unless org-sparse-tree-open-archived-trees
15311 (org-hide-archived-subtrees (point-min) (point-max)))
15312 (run-hooks 'org-occur-hook)
15313 (if (interactive-p)
15314 (message "%d match(es) for regexp %s" cnt regexp))
15315 cnt))
15317 (defun org-show-context (&optional key)
15318 "Make sure point and context and visible.
15319 How much context is shown depends upon the variables
15320 `org-show-hierarchy-above', `org-show-following-heading'. and
15321 `org-show-siblings'."
15322 (let ((heading-p (org-on-heading-p t))
15323 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15324 (following-p (org-get-alist-option org-show-following-heading key))
15325 (entry-p (org-get-alist-option org-show-entry-below key))
15326 (siblings-p (org-get-alist-option org-show-siblings key)))
15327 (catch 'exit
15328 ;; Show heading or entry text
15329 (if (and heading-p (not entry-p))
15330 (org-flag-heading nil) ; only show the heading
15331 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15332 (org-show-hidden-entry))) ; show entire entry
15333 (when following-p
15334 ;; Show next sibling, or heading below text
15335 (save-excursion
15336 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15337 (org-flag-heading nil))))
15338 (when siblings-p (org-show-siblings))
15339 (when hierarchy-p
15340 ;; show all higher headings, possibly with siblings
15341 (save-excursion
15342 (while (and (condition-case nil
15343 (progn (org-up-heading-all 1) t)
15344 (error nil))
15345 (not (bobp)))
15346 (org-flag-heading nil)
15347 (when siblings-p (org-show-siblings))))))))
15349 (defun org-reveal (&optional siblings)
15350 "Show current entry, hierarchy above it, and the following headline.
15351 This can be used to show a consistent set of context around locations
15352 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15353 not t for the search context.
15355 With optional argument SIBLINGS, on each level of the hierarchy all
15356 siblings are shown. This repairs the tree structure to what it would
15357 look like when opened with hierarchical calls to `org-cycle'."
15358 (interactive "P")
15359 (let ((org-show-hierarchy-above t)
15360 (org-show-following-heading t)
15361 (org-show-siblings (if siblings t org-show-siblings)))
15362 (org-show-context nil)))
15364 (defun org-highlight-new-match (beg end)
15365 "Highlight from BEG to END and mark the highlight is an occur headline."
15366 (let ((ov (org-make-overlay beg end)))
15367 (org-overlay-put ov 'face 'secondary-selection)
15368 (push ov org-occur-highlights)))
15370 (defun org-remove-occur-highlights (&optional beg end noremove)
15371 "Remove the occur highlights from the buffer.
15372 BEG and END are ignored. If NOREMOVE is nil, remove this function
15373 from the `before-change-functions' in the current buffer."
15374 (interactive)
15375 (unless org-inhibit-highlight-removal
15376 (mapc 'org-delete-overlay org-occur-highlights)
15377 (setq org-occur-highlights nil)
15378 (setq org-occur-parameters nil)
15379 (unless noremove
15380 (remove-hook 'before-change-functions
15381 'org-remove-occur-highlights 'local))))
15383 ;;;; Priorities
15386 "Regular expression matching the priority indicator.")
15388 (defvar org-remove-priority-next-time nil)
15390 (defun org-priority-up ()
15391 "Increase the priority of the current item."
15392 (interactive)
15393 (org-priority 'up))
15395 (defun org-priority-down ()
15396 "Decrease the priority of the current item."
15397 (interactive)
15398 (org-priority 'down))
15400 (defun org-priority (&optional action)
15401 "Change the priority of an item by ARG.
15402 ACTION can be `set', `up', `down', or a character."
15403 (interactive)
15404 (setq action (or action 'set))
15405 (let (current new news have remove)
15406 (save-excursion
15407 (org-back-to-heading)
15408 (if (looking-at org-priority-regexp)
15409 (setq current (string-to-char (match-string 2))
15410 have t)
15411 (setq current org-default-priority))
15412 (cond
15413 ((or (eq action 'set) (integerp action))
15414 (if (integerp action)
15415 (setq new action)
15416 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15417 (setq new (read-char-exclusive)))
15418 (if (and (= (upcase org-highest-priority) org-highest-priority)
15419 (= (upcase org-lowest-priority) org-lowest-priority))
15420 (setq new (upcase new)))
15421 (cond ((equal new ?\ ) (setq remove t))
15422 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15423 (error "Priority must be between `%c' and `%c'"
15424 org-highest-priority org-lowest-priority))))
15425 ((eq action 'up)
15426 (if (and (not have) (eq last-command this-command))
15427 (setq new org-lowest-priority)
15428 (setq new (if (and org-priority-start-cycle-with-default (not have))
15429 org-default-priority (1- current)))))
15430 ((eq action 'down)
15431 (if (and (not have) (eq last-command this-command))
15432 (setq new org-highest-priority)
15433 (setq new (if (and org-priority-start-cycle-with-default (not have))
15434 org-default-priority (1+ current)))))
15435 (t (error "Invalid action")))
15436 (if (or (< (upcase new) org-highest-priority)
15437 (> (upcase new) org-lowest-priority))
15438 (setq remove t))
15439 (setq news (format "%c" new))
15440 (if have
15441 (if remove
15442 (replace-match "" t t nil 1)
15443 (replace-match news t t nil 2))
15444 (if remove
15445 (error "No priority cookie found in line")
15446 (looking-at org-todo-line-regexp)
15447 (if (match-end 2)
15448 (progn
15449 (goto-char (match-end 2))
15450 (insert " [#" news "]"))
15451 (goto-char (match-beginning 3))
15452 (insert "[#" news "] ")))))
15453 (org-preserve-lc (org-set-tags nil 'align))
15454 (if remove
15455 (message "Priority removed")
15456 (message "Priority of current item set to %s" news))))
15459 (defun org-get-priority (s)
15460 "Find priority cookie and return priority."
15461 (save-match-data
15462 (if (not (string-match org-priority-regexp s))
15463 (* 1000 (- org-lowest-priority org-default-priority))
15464 (* 1000 (- org-lowest-priority
15465 (string-to-char (match-string 2 s)))))))
15467 ;;;; Tags
15469 (defun org-scan-tags (action matcher &optional todo-only)
15470 "Scan headline tags with inheritance and produce output ACTION.
15471 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15472 evaluated, testing if a given set of tags qualifies a headline for
15473 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15474 are included in the output."
15477 (org-re
15479 (props (list 'face nil
15480 'done-face 'org-done
15481 'undone-face nil
15482 'mouse-face 'highlight
15483 'org-not-done-regexp org-not-done-regexp
15484 'org-todo-regexp org-todo-regexp
15485 'keymap org-agenda-keymap
15486 'help-echo
15487 (format "mouse-2 or RET jump to org file %s"
15488 (abbreviate-file-name
15489 (or (buffer-file-name (buffer-base-buffer))
15490 (buffer-name (buffer-base-buffer)))))))
15491 (case-fold-search nil)
15492 lspos
15493 tags tags-list tags-alist (llast 0) rtn level category i txt
15494 todo marker entry priority)
15495 (save-excursion
15496 (goto-char (point-min))
15497 (when (eq action 'sparse-tree)
15498 (org-overview)
15499 (org-remove-occur-highlights))
15500 (while (re-search-forward re nil t)
15501 (catch :skip
15502 (setq todo (if (match-end 1) (match-string 2))
15503 tags (if (match-end 4) (match-string 4)))
15504 (goto-char (setq lspos (1+ (match-beginning 0))))
15505 (setq level (org-reduced-level (funcall outline-level))
15506 category (org-get-category))
15507 (setq i llast llast level)
15508 ;; remove tag lists from same and sublevels
15509 (while (>= i level)
15510 (when (setq entry (assoc i tags-alist))
15511 (setq tags-alist (delete entry tags-alist)))
15512 (setq i (1- i)))
15513 ;; add the nex tags
15514 (when tags
15515 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15516 tags-alist
15517 (cons (cons level tags) tags-alist)))
15518 ;; compile tags for current headline
15519 (setq tags-list
15520 (if org-use-tag-inheritance
15521 (apply 'append (mapcar 'cdr tags-alist))
15522 tags))
15523 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15524 (eval matcher)
15525 (or (not org-agenda-skip-archived-trees)
15526 (not (member org-archive-tag tags-list))))
15527 (and (eq action 'agenda) (org-agenda-skip))
15528 ;; list this headline
15530 (if (eq action 'sparse-tree)
15531 (progn
15532 (and org-highlight-sparse-tree-matches
15533 (org-get-heading) (match-end 0)
15534 (org-highlight-new-match
15535 (match-beginning 0) (match-beginning 1)))
15536 (org-show-context 'tags-tree))
15537 (setq txt (org-format-agenda-item
15538 ""
15539 (concat
15540 (if org-tags-match-list-sublevels
15541 (make-string (1- level) ?.) "")
15542 (org-get-heading))
15543 category tags-list)
15544 priority (org-get-priority txt))
15545 (goto-char lspos)
15546 (setq marker (org-agenda-new-marker))
15547 (org-add-props txt props
15548 'org-marker marker 'org-hd-marker marker 'org-category category
15549 'priority priority 'type "tagsmatch")
15550 (push txt rtn))
15551 ;; if we are to skip sublevels, jump to end of subtree
15552 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15553 (when (and (eq action 'sparse-tree)
15554 (not org-sparse-tree-open-archived-trees))
15555 (org-hide-archived-subtrees (point-min) (point-max)))
15556 (nreverse rtn)))
15558 (defvar todo-only) ;; dynamically scoped
15560 (defun org-tags-sparse-tree (&optional todo-only match)
15561 "Create a sparse tree according to tags string MATCH.
15562 MATCH can contain positive and negative selection of tags, like
15564 If optional argument TODO_ONLY is non-nil, only select lines that are
15565 also TODO lines."
15566 (interactive "P")
15567 (org-prepare-agenda-buffers (list (current-buffer)))
15568 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15570 (defvar org-cached-props nil)
15571 (defun org-cached-entry-get (pom property)
15572 (if (or (eq t org-use-property-inheritance)
15573 (member property org-use-property-inheritance))
15574 ;; Caching is not possible, check it directly
15575 (org-entry-get pom property 'inherit)
15576 ;; Get all properties, so that we can do complicated checks easily
15577 (cdr (assoc property (or org-cached-props
15578 (setq org-cached-props
15579 (org-entry-properties pom)))))))
15581 (defun org-global-tags-completion-table (&optional files)
15582 "Return the list of all tags in all agenda buffer/files."
15583 (save-excursion
15584 (org-uniquify
15585 (delq nil
15586 (apply 'append
15587 (mapcar
15588 (lambda (file)
15589 (set-buffer (find-file-noselect file))
15590 (append (org-get-buffer-tags)
15591 (mapcar (lambda (x) (if (stringp (car-safe x))
15592 (list (car-safe x)) nil))
15593 org-tag-alist)))
15594 (if (and files (car files))
15595 files
15596 (org-agenda-files))))))))
15598 (defun org-make-tags-matcher (match)
15599 "Create the TAGS//TODO matcher form for the selection string MATCH."
15600 ;; todo-only is scoped dynamically into this function, and the function
15601 ;; may change it it the matcher asksk for it.
15602 (unless match
15603 ;; Get a new match request, with completion
15604 (let ((org-last-tags-completion-table
15605 (org-global-tags-completion-table)))
15606 (setq match (completing-read
15607 "Match: " 'org-tags-completion-function nil nil nil
15608 'org-tags-history))))
15610 ;; Parse the string and create a lisp form
15611 (let ((match0 match)
15612 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15613 minus tag mm
15614 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15615 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15616 (if (string-match "/+" match)
15617 ;; match contains also a todo-matching request
15618 (progn
15619 (setq tagsmatch (substring match 0 (match-beginning 0))
15620 todomatch (substring match (match-end 0)))
15621 (if (string-match "^!" todomatch)
15622 (setq todo-only t todomatch (substring todomatch 1)))
15624 (setq todomatch nil)))
15625 ;; only matching tags
15626 (setq tagsmatch match todomatch nil))
15628 ;; Make the tags matcher
15630 (setq tagsmatcher t)
15631 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15632 (while (setq term (pop orterms))
15634 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15635 (while (string-match re term)
15636 (setq minus (and (match-end 1)
15637 (equal (match-string 1 term) "-"))
15638 tag (match-string 2 term)
15639 re-p (equal (string-to-char tag) ?{)
15640 level-p (match-end 3)
15641 prop-p (match-end 4)
15642 mm (cond
15643 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15644 (level-p `(= level ,(string-to-number
15645 (match-string 3 term))))
15646 (prop-p
15647 (setq pn (match-string 4 term)
15648 pv (match-string 5 term)
15649 cat-p (equal pn "CATEGORY")
15650 re-p (equal (string-to-char pv) ?{)
15651 pv (substring pv 1 -1))
15652 (if (equal pn "CATEGORY")
15653 (setq gv '(get-text-property (point) 'org-category))
15654 (setq gv `(org-cached-entry-get nil ,pn)))
15655 (if re-p
15656 `(string-match ,pv (or ,gv ""))
15657 `(equal ,pv (or ,gv ""))))
15658 (t `(member ,(downcase tag) tags-list)))
15659 mm (if minus (list 'not mm) mm)
15660 term (substring term (match-end 0)))
15661 (push mm tagsmatcher))
15662 (push (if (> (length tagsmatcher) 1)
15663 (cons 'and tagsmatcher)
15664 (car tagsmatcher))
15665 orlist)
15666 (setq tagsmatcher nil))
15667 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15668 (setq tagsmatcher
15669 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15671 ;; Make the todo matcher
15673 (setq todomatcher t)
15674 (setq orterms (org-split-string todomatch "|") orlist nil)
15675 (while (setq term (pop orterms))
15676 (while (string-match re term)
15677 (setq minus (and (match-end 1)
15678 (equal (match-string 1 term) "-"))
15679 kwd (match-string 2 term)
15680 re-p (equal (string-to-char kwd) ?{)
15681 term (substring term (match-end 0))
15682 mm (if re-p
15683 `(string-match ,(substring kwd 1 -1) todo)
15684 (list 'equal 'todo kwd))
15685 mm (if minus (list 'not mm) mm))
15686 (push mm todomatcher))
15687 (push (if (> (length todomatcher) 1)
15688 (cons 'and todomatcher)
15689 (car todomatcher))
15690 orlist)
15691 (setq todomatcher nil))
15692 (setq todomatcher (if (> (length orlist) 1)
15693 (cons 'or orlist) (car orlist))))
15695 ;; Return the string and lisp forms of the matcher
15696 (setq matcher (if todomatcher
15697 (list 'and tagsmatcher todomatcher)
15698 tagsmatcher))
15699 (cons match0 matcher)))
15701 (defun org-match-any-p (re list)
15702 "Does re match any element of list?"
15703 (setq list (mapcar (lambda (x) (string-match re x)) list))
15704 (delq nil list))
15706 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15707 (defvar org-tags-overlay (org-make-overlay 1 1))
15708 (org-detach-overlay org-tags-overlay)
15710 (defun org-align-tags-here (to-col)
15711 ;; Assumes that this is a headline
15712 (let ((pos (point)) (col (current-column)) tags)
15713 (beginning-of-line 1)
15715 (< pos (match-beginning 2)))
15716 (progn
15717 (setq tags (match-string 2))
15718 (goto-char (match-beginning 1))
15719 (insert " ")
15720 (delete-region (point) (1+ (match-end 0)))
15721 (backward-char 1)
15722 (move-to-column
15723 (max (1+ (current-column))
15724 (1+ col)
15725 (if (> to-col 0)
15726 to-col
15727 (- (abs to-col) (length tags))))
15728 t)
15729 (insert tags)
15730 (move-to-column (min (current-column) col) t))
15731 (goto-char pos))))
15733 (defun org-set-tags (&optional arg just-align)
15734 "Set the tags for the current headline.
15735 With prefix ARG, realign all tags in headings in the current buffer."
15736 (interactive "P")
15737 (let* ((re (concat "^" outline-regexp))
15738 (current (org-get-tags-string))
15739 (col (current-column))
15740 (org-setting-tags t)
15741 table current-tags inherited-tags ; computed below when needed
15742 tags p0 c0 c1 rpl)
15743 (if arg
15744 (save-excursion
15745 (goto-char (point-min))
15746 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15747 (while (re-search-forward re nil t)
15748 (org-set-tags nil t)
15749 (end-of-line 1)))
15750 (message "All tags realigned to column %d" org-tags-column))
15751 (if just-align
15752 (setq tags current)
15753 ;; Get a new set of tags from the user
15754 (save-excursion
15755 (setq table (or org-tag-alist (org-get-buffer-tags))
15756 org-last-tags-completion-table table
15757 current-tags (org-split-string current ":")
15758 inherited-tags (nreverse
15759 (nthcdr (length current-tags)
15760 (nreverse (org-get-tags-at))))
15761 tags
15762 (if (or (eq t org-use-fast-tag-selection)
15763 (and org-use-fast-tag-selection
15764 (delq nil (mapcar 'cdr table))))
15765 (org-fast-tag-selection
15766 current-tags inherited-tags table
15767 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15768 (let ((org-add-colon-after-tag-completion t))
15769 (org-trim
15770 (org-without-partial-completion
15771 (completing-read "Tags: " 'org-tags-completion-function
15772 nil nil current 'org-tags-history)))))))
15773 (while (string-match "[-+&]+" tags)
15774 ;; No boolean logic, just a list
15775 (setq tags (replace-match ":" t t tags))))
15778 (setq tags "")
15779 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15780 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15782 ;; Insert new tags at the correct column
15783 (beginning-of-line 1)
15784 (cond
15785 ((and (equal current "") (equal tags "")))
15786 ((re-search-forward
15788 (point-at-eol) t)
15789 (if (equal tags "")
15790 (setq rpl "")
15791 (goto-char (match-beginning 0))
15792 (setq c0 (current-column) p0 (point)
15793 c1 (max (1+ c0) (if (> org-tags-column 0)
15794 org-tags-column
15795 (- (- org-tags-column) (length tags))))
15796 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15797 (replace-match rpl t t)
15798 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15799 tags)
15800 (t (error "Tags alignment failed")))
15801 (move-to-column col)
15802 (unless just-align
15803 (run-hooks 'org-after-tags-change-hook)))))
15805 (defun org-change-tag-in-region (beg end tag off)
15806 "Add or remove TAG for each entry in the region.
15807 This works in the agenda, and also in an org-mode buffer."
15808 (interactive
15809 (list (region-beginning) (region-end)
15810 (let ((org-last-tags-completion-table
15811 (if (org-mode-p)
15812 (org-get-buffer-tags)
15813 (org-global-tags-completion-table))))
15814 (completing-read
15815 "Tag: " 'org-tags-completion-function nil nil nil
15816 'org-tags-history))
15817 (progn
15818 (message "[s]et or [r]emove? ")
15819 (equal (read-char-exclusive) ?r))))
15820 (if (fboundp 'deactivate-mark) (deactivate-mark))
15821 (let ((agendap (equal major-mode 'org-agenda-mode))
15822 l1 l2 m buf pos newhead (cnt 0))
15823 (goto-char end)
15824 (setq l2 (1- (org-current-line)))
15825 (goto-char beg)
15826 (setq l1 (org-current-line))
15827 (loop for l from l1 to l2 do
15828 (goto-line l)
15829 (setq m (get-text-property (point) 'org-hd-marker))
15830 (when (or (and (org-mode-p) (org-on-heading-p))
15831 (and agendap m))
15832 (setq buf (if agendap (marker-buffer m) (current-buffer))
15833 pos (if agendap m (point)))
15834 (with-current-buffer buf
15835 (save-excursion
15836 (save-restriction
15837 (goto-char pos)
15838 (setq cnt (1+ cnt))
15839 (org-toggle-tag tag (if off 'off 'on))
15840 (setq newhead (org-get-heading)))))
15841 (and agendap (org-agenda-change-all-lines newhead m))))
15842 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15844 (defun org-tags-completion-function (string predicate &optional flag)
15845 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15846 (confirm (lambda (x) (stringp (car x)))))
15848 (setq s1 (match-string 1 string)
15849 s2 (match-string 2 string))
15850 (setq s1 "" s2 string))
15851 (cond
15852 ((eq flag nil)
15853 ;; try completion
15854 (setq rtn (try-completion s2 ctable confirm))
15855 (if (stringp rtn)
15856 (setq rtn
15857 (concat s1 s2 (substring rtn (length s2))
15858 (if (and org-add-colon-after-tag-completion
15859 (assoc rtn ctable))
15860 ":" ""))))
15861 rtn)
15862 ((eq flag t)
15863 ;; all-completions
15864 (all-completions s2 ctable confirm)
15865 )
15866 ((eq flag 'lambda)
15867 ;; exact match?
15868 (assoc s2 ctable)))
15869 ))
15871 (defun org-fast-tag-insert (kwd tags face &optional end)
15872 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15873 (insert (format "%-12s" (concat kwd ":"))
15874 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15875 (or end "")))
15877 (defun org-fast-tag-show-exit (flag)
15878 (save-excursion
15879 (goto-line 3)
15881 (replace-match ""))
15882 (when flag
15883 (end-of-line 1)
15884 (move-to-column (- (window-width) 19) t)
15885 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15887 (defun org-set-current-tags-overlay (current prefix)
15888 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15889 (if (featurep 'xemacs)
15890 (org-overlay-display org-tags-overlay (concat prefix s)
15891 'secondary-selection)
15892 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15893 (org-overlay-display org-tags-overlay (concat prefix s)))))
15895 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15896 "Fast tag selection with single keys.
15897 CURRENT is the current list of tags in the headline, INHERITED is the
15898 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15899 possibly with grouping information. TODO-TABLE is a similar table with
15900 TODO keywords, should these have keys assigned to them.
15901 If the keys are nil, a-z are automatically assigned.
15902 Returns the new tags string, or nil to not change the current settings."
15903 (let* ((fulltable (append table todo-table))
15904 (maxlen (apply 'max (mapcar
15905 (lambda (x)
15906 (if (stringp (car x)) (string-width (car x)) 0))
15907 fulltable)))
15908 (buf (current-buffer))
15909 (expert (eq org-fast-tag-selection-single-key 'expert))
15910 (buffer-tags nil)
15911 (fwidth (+ maxlen 3 1 3))
15912 (ncol (/ (- (window-width) 4) fwidth))
15913 (i-face 'org-done)
15914 (c-face 'org-todo)
15915 tg cnt e c char c1 c2 ntable tbl rtn
15916 ov-start ov-end ov-prefix
15917 (exit-after-next org-fast-tag-selection-single-key)
15918 (done-keywords org-done-keywords)
15919 groups ingroup)
15920 (save-excursion
15921 (beginning-of-line 1)
15922 (if (looking-at
15924 (setq ov-start (match-beginning 1)
15925 ov-end (match-end 1)
15926 ov-prefix "")
15927 (setq ov-start (1- (point-at-eol))
15928 ov-end (1+ ov-start))
15930 (setq ov-prefix
15931 (concat
15932 (buffer-substring (1- (point)) (point))
15933 (if (> (current-column) org-tags-column)
15934 " "
15935 (make-string (- org-tags-column (current-column)) ?\ ))))))
15936 (org-move-overlay org-tags-overlay ov-start ov-end)
15937 (save-window-excursion
15938 (if expert
15939 (set-buffer (get-buffer-create " *Org tags*"))
15940 (delete-other-windows)
15941 (split-window-vertically)
15942 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15943 (erase-buffer)
15944 (org-set-local 'org-done-keywords done-keywords)
15947 (org-fast-tag-show-exit exit-after-next)
15948 (org-set-current-tags-overlay current ov-prefix)
15949 (setq tbl fulltable char ?a cnt 0)
15950 (while (setq e (pop tbl))
15951 (cond
15952 ((equal e '(:startgroup))
15953 (push '() groups) (setq ingroup t)
15954 (when (not (= cnt 0))
15955 (setq cnt 0)
15957 (insert "{ "))
15958 ((equal e '(:endgroup))
15959 (setq ingroup nil cnt 0)
15961 (t
15962 (setq tg (car e) c2 nil)
15963 (if (cdr e)
15964 (setq c (cdr e))
15965 ;; automatically assign a character.
15966 (setq c1 (string-to-char
15967 (downcase (substring
15968 tg (if (= (string-to-char tg) ?@) 1 0)))))
15969 (if (or (rassoc c1 ntable) (rassoc c1 table))
15970 (while (or (rassoc char ntable) (rassoc char table))
15971 (setq char (1+ char)))
15972 (setq c2 c1))
15973 (setq c (or c2 char)))
15974 (if ingroup (push tg (car groups)))
15975 (setq tg (org-add-props tg nil 'face
15976 (cond
15977 ((not (assoc tg table))
15978 (org-get-todo-face tg))
15979 ((member tg current) c-face)
15980 ((member tg inherited) i-face)
15981 (t nil))))
15982 (if (and (= cnt 0) (not ingroup)) (insert " "))
15983 (insert "[" c "] " tg (make-string
15984 (- fwidth 4 (length tg)) ?\ ))
15985 (push (cons tg c) ntable)
15986 (when (= (setq cnt (1+ cnt)) ncol)
15988 (if ingroup (insert " "))
15989 (setq cnt 0)))))
15990 (setq ntable (nreverse ntable))
15992 (goto-char (point-min))
15993 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15994 (fit-window-to-buffer))
15995 (setq rtn
15996 (catch 'exit
15997 (while t
15998 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15999 (if groups " [!] no groups" " [!]groups")
16000 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
16001 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
16002 (cond
16004 ((= c ?!)
16005 (setq groups (not groups))
16006 (goto-char (point-min))
16007 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
16008 ((= c ?\C-c)
16009 (if (not expert)
16010 (org-fast-tag-show-exit
16011 (setq exit-after-next (not exit-after-next)))
16012 (setq expert nil)
16013 (delete-other-windows)
16014 (split-window-vertically)
16015 (org-switch-to-buffer-other-window " *Org tags*")
16016 (and (fboundp 'fit-window-to-buffer)
16017 (fit-window-to-buffer))))
16018 ((or (= c ?\C-g)
16019 (and (= c ?q) (not (rassoc c ntable))))
16020 (org-detach-overlay org-tags-overlay)
16021 (setq quit-flag t))
16022 ((= c ?\ )
16023 (setq current nil)
16024 (if exit-after-next (setq exit-after-next 'now)))
16026 (condition-case nil
16027 (setq tg (completing-read
16028 "Tag: "
16029 (or buffer-tags
16030 (with-current-buffer buf
16031 (org-get-buffer-tags)))))
16032 (quit (setq tg "")))
16034 (add-to-list 'buffer-tags (list tg))
16035 (if (member tg current)
16036 (setq current (delete tg current))
16037 (push tg current)))
16038 (if exit-after-next (setq exit-after-next 'now)))
16039 ((setq e (rassoc c todo-table) tg (car e))
16040 (with-current-buffer buf
16041 (save-excursion (org-todo tg)))
16042 (if exit-after-next (setq exit-after-next 'now)))
16043 ((setq e (rassoc c ntable) tg (car e))
16044 (if (member tg current)
16045 (setq current (delete tg current))
16046 (loop for g in groups do
16047 (if (member tg g)
16048 (mapc (lambda (x)
16049 (setq current (delete x current)))
16050 g)))
16051 (push tg current))
16052 (if exit-after-next (setq exit-after-next 'now))))
16054 ;; Create a sorted list
16055 (setq current
16056 (sort current
16057 (lambda (a b)
16058 (assoc b (cdr (memq (assoc a ntable) ntable))))))
16059 (if (eq exit-after-next 'now) (throw 'exit t))
16060 (goto-char (point-min))
16061 (beginning-of-line 2)
16062 (delete-region (point) (point-at-eol))
16063 (org-fast-tag-insert "Current" current c-face)
16064 (org-set-current-tags-overlay current ov-prefix)
16065 (while (re-search-forward
16067 (setq tg (match-string 1))
16068 (add-text-properties
16069 (match-beginning 1) (match-end 1)
16070 (list 'face
16071 (cond
16072 ((member tg current) c-face)
16073 ((member tg inherited) i-face)
16074 (t (get-text-property (match-beginning 1) 'face))))))
16075 (goto-char (point-min)))))
16076 (org-detach-overlay org-tags-overlay)
16077 (if rtn
16078 (mapconcat 'identity current ":")
16079 nil))))
16081 (defun org-get-tags-string ()
16082 "Get the TAGS string in the current headline."
16083 (unless (org-on-heading-p t)
16084 (error "Not on a heading"))
16085 (save-excursion
16086 (beginning-of-line 1)
16088 (org-match-string-no-properties 1)
16089 "")))
16091 (defun org-get-tags ()
16092 "Get the list of tags specified in the current headline."
16093 (org-split-string (org-get-tags-string) ":"))
16095 (defun org-get-buffer-tags ()
16096 "Get a table of all tags used in the buffer, for completion."
16097 (let (tags)
16098 (save-excursion
16099 (goto-char (point-min))
16100 (while (re-search-forward
16102 (when (equal (char-after (point-at-bol 0)) ?*)
16103 (mapc (lambda (x) (add-to-list 'tags x))
16104 (org-split-string (org-match-string-no-properties 1) ":")))))
16105 (mapcar 'list tags)))
16108 ;;;; Properties
16110 ;;; Setting and retrieving properties
16112 (defconst org-special-properties
16113 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
16114 "TIMESTAMP" "TIMESTAMP_IA")
16115 "The special properties valid in Org-mode.
16117 These are properties that are not defined in the property drawer,
16118 but in some other way.")
16120 (defconst org-default-properties
16121 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
16122 "LOCATION" "LOGGING" "COLUMNS")
16123 "Some properties that are used by Org-mode for various purposes.
16124 Being in this list makes sure that they are offered for completion.")
16127 "Regular expression matching the first line of a property drawer.")
16130 "Regular expression matching the first line of a property drawer.")
16132 (defun org-property-action ()
16133 "Do an action on properties."
16134 (interactive)
16135 (let (c)
16136 (org-at-property-p)
16137 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
16138 (setq c (read-char-exclusive))
16139 (cond
16140 ((equal c ?s)
16141 (call-interactively 'org-set-property))
16142 ((equal c ?d)
16143 (call-interactively 'org-delete-property))
16144 ((equal c ?D)
16145 (call-interactively 'org-delete-property-globally))
16146 ((equal c ?c)
16147 (call-interactively 'org-compute-property-at-point))
16148 (t (error "No such property action %c" c)))))
16150 (defun org-at-property-p ()
16151 "Is the cursor in a property line?"
16152 ;; FIXME: Does not check if we are actually in the drawer.
16153 ;; FIXME: also returns true on any drawers.....
16154 ;; This is used by C-c C-c for property action.
16155 (save-excursion
16156 (beginning-of-line 1)
16159 (defmacro org-with-point-at (pom &rest body)
16160 "Move to buffer and point of point-or-marker POM for the duration of BODY."
16161 (declare (indent 1) (debug t))
16162 `(save-excursion
16163 (if (markerp pom) (set-buffer (marker-buffer pom)))
16164 (save-excursion
16165 (goto-char (or pom (point)))
16166 ,@body)))
16168 (defun org-get-property-block (&optional beg end force)
16169 "Return the (beg . end) range of the body of the property drawer.
16170 BEG and END can be beginning and end of subtree, if not given
16171 they will be found.
16172 If the drawer does not exist and FORCE is non-nil, create the drawer."
16173 (catch 'exit
16174 (save-excursion
16175 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
16176 (end (or end (progn (outline-next-heading) (point)))))
16177 (goto-char beg)
16178 (if (re-search-forward org-property-start-re end t)
16179 (setq beg (1+ (match-end 0)))
16180 (if force
16181 (save-excursion
16182 (org-insert-property-drawer)
16183 (setq end (progn (outline-next-heading) (point))))
16184 (throw 'exit nil))
16185 (goto-char beg)
16186 (if (re-search-forward org-property-start-re end t)
16187 (setq beg (1+ (match-end 0)))))
16188 (if (re-search-forward org-property-end-re end t)
16189 (setq end (match-beginning 0))
16190 (or force (throw 'exit nil))
16191 (goto-char beg)
16192 (setq end beg)
16193 (org-indent-line-function)
16195 (cons beg end)))))
16197 (defun org-entry-properties (&optional pom which)
16198 "Get all properties of the entry at point-or-marker POM.
16199 This includes the TODO keyword, the tags, time strings for deadline,
16200 scheduled, and clocking, and any additional properties defined in the
16201 entry. The return value is an alist, keys may occur multiple times
16202 if the property key was used several times.
16203 POM may also be nil, in which case the current entry is used.
16204 If WHICH is nil or `all', get all properties. If WHICH is
16205 `special' or `standard', only get that subclass."
16206 (setq which (or which 'all))
16207 (org-with-point-at pom
16208 (let ((clockstr (substring org-clock-string 0 -1))
16209 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
16210 beg end range props sum-props key value string clocksum)
16211 (save-excursion
16212 (when (condition-case nil (org-back-to-heading t) (error nil))
16213 (setq beg (point))
16214 (setq sum-props (get-text-property (point) 'org-summaries))
16215 (setq clocksum (get-text-property (point) :org-clock-minutes))
16216 (outline-next-heading)
16217 (setq end (point))
16218 (when (memq which '(all special))
16219 ;; Get the special properties, like TODO and tags
16220 (goto-char beg)
16221 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16222 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16223 (when (looking-at org-priority-regexp)
16224 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16225 (when (and (setq value (org-get-tags-string))
16227 (push (cons "TAGS" value) props))
16228 (when (setq value (org-get-tags-at))
16229 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16230 props))
16231 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16232 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16233 string (if (equal key clockstr)
16234 (org-no-properties
16235 (org-trim
16236 (buffer-substring
16237 (match-beginning 3) (goto-char (point-at-eol)))))
16238 (substring (org-match-string-no-properties 3) 1 -1)))
16239 (unless key
16240 (if (= (char-after (match-beginning 3)) ?\[)
16241 (setq key "TIMESTAMP_IA")
16242 (setq key "TIMESTAMP")))
16243 (when (or (equal key clockstr) (not (assoc key props)))
16244 (push (cons key string) props)))
16246 )
16248 (when (memq which '(all standard))
16249 ;; Get the standard properties, like :PORP: ...
16250 (setq range (org-get-property-block beg end))
16251 (when range
16252 (goto-char (car range))
16253 (while (re-search-forward
16255 (cdr range) t)
16256 (setq key (org-match-string-no-properties 1)
16257 value (org-trim (or (org-match-string-no-properties 2) "")))
16258 (unless (member key excluded)
16259 (push (cons key (or value "")) props)))))
16260 (if clocksum
16261 (push (cons "CLOCKSUM"
16262 (org-column-number-to-string (/ (float clocksum) 60.)
16263 'add_times))
16264 props))
16265 (append sum-props (nreverse props)))))))
16267 (defun org-entry-get (pom property &optional inherit)
16268 "Get value of PROPERTY for entry at point-or-marker POM.
16269 If INHERIT is non-nil and the entry does not have the property,
16270 then also check higher levels of the hierarchy.
16271 If the property is present but empty, the return value is the empty string.
16272 If the property is not present at all, nil is returned."
16273 (org-with-point-at pom
16274 (if inherit
16275 (org-entry-get-with-inheritance property)
16276 (if (member property org-special-properties)
16277 ;; We need a special property. Use brute force, get all properties.
16278 (cdr (assoc property (org-entry-properties nil 'special)))
16279 (let ((range (org-get-property-block)))
16280 (if (and range
16281 (goto-char (car range))
16282 (re-search-forward
16284 (cdr range) t))
16285 ;; Found the property, return it.
16286 (if (match-end 1)
16287 (org-match-string-no-properties 1)
16288 "")))))))
16290 (defun org-entry-delete (pom property)
16291 "Delete the property PROPERTY from entry at point-or-marker POM."
16292 (org-with-point-at pom
16293 (if (member property org-special-properties)
16294 nil ; cannot delete these properties.
16295 (let ((range (org-get-property-block)))
16296 (if (and range
16297 (goto-char (car range))
16298 (re-search-forward
16300 (cdr range) t))
16301 (progn
16302 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16303 t)
16304 nil)))))
16306 ;; Multi-values properties are properties that contain multiple values
16307 ;; These values are assumed to be single words, separated by whitespace.
16308 (defun org-entry-add-to-multivalued-property (pom property value)
16309 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16310 (let* ((old (org-entry-get pom property))
16312 (unless (member value values)
16313 (setq values (cons value values))
16314 (org-entry-put pom property
16315 (mapconcat 'identity values " ")))))
16317 (defun org-entry-remove-from-multivalued-property (pom property value)
16318 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16319 (let* ((old (org-entry-get pom property))
16321 (when (member value values)
16322 (setq values (delete value values))
16323 (org-entry-put pom property
16324 (mapconcat 'identity values " ")))))
16326 (defun org-entry-member-in-multivalued-property (pom property value)
16327 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16328 (let* ((old (org-entry-get pom property))
16330 (member value values)))
16332 (defvar org-entry-property-inherited-from (make-marker))
16334 (defun org-entry-get-with-inheritance (property)
16335 "Get entry property, and search higher levels if not present."
16336 (let (tmp)
16337 (save-excursion
16338 (save-restriction
16339 (widen)
16340 (catch 'ex
16341 (while t
16342 (when (setq tmp (org-entry-get nil property))
16343 (org-back-to-heading t)
16344 (move-marker org-entry-property-inherited-from (point))
16345 (throw 'ex tmp))
16346 (or (org-up-heading-safe) (throw 'ex nil)))))
16347 (or tmp (cdr (assoc property org-local-properties))
16348 (cdr (assoc property org-global-properties))))))
16350 (defun org-entry-put (pom property value)
16351 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16352 (org-with-point-at pom
16353 (org-back-to-heading t)
16354 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16355 range)
16356 (cond
16357 ((equal property "TODO")
16359 (not (member value org-todo-keywords-1)))
16361 (if (or (not value)
16363 (setq value 'none))
16364 (org-todo value)
16365 (org-set-tags nil 'align))
16366 ((equal property "PRIORITY")
16368 (string-to-char value) ?\ ))
16369 (org-set-tags nil 'align))
16370 ((equal property "SCHEDULED")
16371 (if (re-search-forward org-scheduled-time-regexp end t)
16372 (cond
16373 ((eq value 'earlier) (org-timestamp-change -1 'day))
16374 ((eq value 'later) (org-timestamp-change 1 'day))
16375 (t (call-interactively 'org-schedule)))
16376 (call-interactively 'org-schedule)))
16377 ((equal property "DEADLINE")
16378 (if (re-search-forward org-deadline-time-regexp end t)
16379 (cond
16380 ((eq value 'earlier) (org-timestamp-change -1 'day))
16381 ((eq value 'later) (org-timestamp-change 1 'day))
16382 (t (call-interactively 'org-deadline)))
16383 (call-interactively 'org-deadline)))
16384 ((member property org-special-properties)
16385 (error "The %s property can not yet be set with `org-entry-put'"
16386 property))
16387 (t ; a non-special property
16388 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16389 (setq range (org-get-property-block beg end 'force))
16390 (goto-char (car range))
16391 (if (re-search-forward
16393 (progn
16394 (delete-region (match-beginning 1) (match-end 1))
16395 (goto-char (match-beginning 1)))
16396 (goto-char (cdr range))
16398 (backward-char 1)
16399 (org-indent-line-function)
16400 (insert ":" property ":"))
16401 (and value (insert " " value))
16402 (org-indent-line-function)))))))
16404 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16405 "Get all property keys in the current buffer.
16406 With INCLUDE-SPECIALS, also list the special properties that relect things
16407 like tags and TODO state.
16408 With INCLUDE-DEFAULTS, also include properties that has special meaning
16409 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16410 With INCLUDE-COLUMNS, also include property names given in COLUMN
16411 formats in the current buffer."
16412 (let (rtn range cfmt cols s p)
16413 (save-excursion
16414 (save-restriction
16415 (widen)
16416 (goto-char (point-min))
16417 (while (re-search-forward org-property-start-re nil t)
16418 (setq range (org-get-property-block))
16419 (goto-char (car range))
16420 (while (re-search-forward
16422 (cdr range) t)
16423 (add-to-list 'rtn (org-match-string-no-properties 1)))
16424 (outline-next-heading))))
16426 (when include-specials
16427 (setq rtn (append org-special-properties rtn)))
16429 (when include-defaults
16430 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16432 (when include-columns
16433 (save-excursion
16434 (save-restriction
16435 (widen)
16436 (goto-char (point-min))
16437 (while (re-search-forward
16439 nil t)
16440 (setq cfmt (match-string 2) s 0)
16442 cfmt s)
16443 (setq s (match-end 0)
16444 p (match-string 1 cfmt))
16445 (unless (or (equal p "ITEM")
16446 (member p org-special-properties))
16447 (add-to-list 'rtn (match-string 1 cfmt))))))))
16449 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16451 (defun org-property-values (key)
16452 "Return a list of all values of property KEY."
16453 (save-excursion
16454 (save-restriction
16455 (widen)
16456 (goto-char (point-min))
16458 values)
16459 (while (re-search-forward re nil t)
16460 (add-to-list 'values (org-trim (match-string 1))))
16461 (delete "" values)))))
16463 (defun org-insert-property-drawer ()
16464 "Insert a property drawer into the current entry."
16465 (interactive)
16466 (org-back-to-heading t)
16467 (looking-at outline-regexp)
16468 (let ((indent (- (match-end 0)(match-beginning 0)))
16469 (beg (point))
16471 end hiddenp)
16472 (outline-next-heading)
16473 (setq end (point))
16474 (goto-char beg)
16475 (while (re-search-forward re end t))
16476 (setq hiddenp (org-invisible-p))
16477 (end-of-line 1)
16479 (org-skip-over-state-notes)
16481 (if (eq (char-before) ?*) (forward-char 1))
16483 (beginning-of-line 0)
16484 (indent-to-column indent)
16485 (beginning-of-line 2)
16486 (indent-to-column indent)
16487 (beginning-of-line 0)
16488 (if hiddenp
16489 (save-excursion
16490 (org-back-to-heading t)
16491 (hide-entry))
16492 (org-flag-drawer t))))
16494 (defun org-set-property (property value)
16495 "In the current entry, set PROPERTY to VALUE.
16496 When called interactively, this will prompt for a property name, offering
16497 completion on existing and default properties. And then it will prompt
16498 for a value, offering competion either on allowed values (via an inherited
16499 xxx_ALL property) or on existing values in other instances of this property
16500 in the current file."
16501 (interactive
16502 (let* ((prop (completing-read
16503 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16504 (cur (org-entry-get nil prop))
16505 (allowed (org-property-get-allowed-values nil prop 'table))
16506 (existing (mapcar 'list (org-property-values prop)))
16507 (val (if allowed
16508 (completing-read "Value: " allowed nil 'req-match)
16509 (completing-read
16511 (concat "[" cur "]") "")
16512 ": ")
16513 existing nil nil "" nil cur))))
16514 (list prop (if (equal val "") cur val))))
16515 (unless (equal (org-entry-get nil property) value)
16516 (org-entry-put nil property value)))
16518 (defun org-delete-property (property)
16519 "In the current entry, delete PROPERTY."
16520 (interactive
16521 (let* ((prop (completing-read
16522 "Property: " (org-entry-properties nil 'standard))))
16523 (list prop)))
16524 (message "Property %s %s" property
16525 (if (org-entry-delete nil property)
16526 "deleted"
16527 "was not present in the entry")))
16529 (defun org-delete-property-globally (property)
16530 "Remove PROPERTY globally, from all entries."
16531 (interactive
16532 (let* ((prop (completing-read
16533 "Globally remove property: "
16534 (mapcar 'list (org-buffer-property-keys)))))
16535 (list prop)))
16536 (save-excursion
16537 (save-restriction
16538 (widen)
16539 (goto-char (point-min))
16540 (let ((cnt 0))
16541 (while (re-search-forward
16543 nil t)
16544 (setq cnt (1+ cnt))
16545 (replace-match ""))
16548 (defvar org-columns-current-fmt-compiled) ; defined below
16550 (defun org-compute-property-at-point ()
16551 "Compute the property at point.
16552 This looks for an enclosing column format, extracts the operator and
16553 then applies it to the proerty in the column format's scope."
16554 (interactive)
16555 (unless (org-at-property-p)
16556 (error "Not at a property"))
16557 (let ((prop (org-match-string-no-properties 2)))
16558 (org-columns-get-format-and-top-level)
16559 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16560 (error "No operator defined for property %s" prop))
16561 (org-columns-compute prop)))
16563 (defun org-property-get-allowed-values (pom property &optional table)
16564 "Get allowed values for the property PROPERTY.
16565 When TABLE is non-nil, return an alist that can directly be used for
16566 completion."
16567 (let (vals)
16568 (cond
16569 ((equal property "TODO")
16570 (setq vals (org-with-point-at pom
16571 (append org-todo-keywords-1 '("")))))
16572 ((equal property "PRIORITY")
16573 (let ((n org-lowest-priority))
16574 (while (>= n org-highest-priority)
16575 (push (char-to-string n) vals)
16576 (setq n (1- n)))))
16577 ((member property org-special-properties))
16578 (t
16579 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16582 (setq vals (car (read-from-string (concat "(" vals ")"))))
16583 (setq vals (mapcar (lambda (x)
16584 (cond ((stringp x) x)
16585 ((numberp x) (number-to-string x))
16586 ((symbolp x) (symbol-name x))
16587 (t "???")))
16588 vals)))))
16589 (if table (mapcar 'list vals) vals)))
16591 (defun org-property-previous-allowed-value (&optional previous)
16592 "Switch to the next allowed value for this property."
16593 (interactive)
16594 (org-property-next-allowed-value t))
16596 (defun org-property-next-allowed-value (&optional previous)
16597 "Switch to the next allowed value for this property."
16598 (interactive)
16599 (unless (org-at-property-p)
16600 (error "Not at a property"))
16601 (let* ((key (match-string 2))
16602 (value (match-string 3))
16603 (allowed (or (org-property-get-allowed-values (point) key)
16604 (and (member value '("[ ]" "[-]" "[X]"))
16605 '("[ ]" "[X]"))))
16606 nval)
16607 (unless allowed
16608 (error "Allowed values for this property have not been defined"))
16609 (if previous (setq allowed (reverse allowed)))
16610 (if (member value allowed)
16611 (setq nval (car (cdr (member value allowed)))))
16612 (setq nval (or nval (car allowed)))
16613 (if (equal nval value)
16614 (error "Only one allowed value for this property"))
16615 (org-at-property-p)
16616 (replace-match (concat " :" key ": " nval) t t)
16617 (org-indent-line-function)
16618 (beginning-of-line 1)
16621 (defun org-find-entry-with-id (ident)
16622 "Locate the entry that contains the ID property with exact value IDENT.
16623 IDENT can be a string, a symbol or a number, this function will search for
16624 the string representation of it.
16625 Return the position where this entry starts, or nil if there is no such entry."
16626 (let ((id (cond
16627 ((stringp ident) ident)
16628 ((symbol-name ident) (symbol-name ident))
16629 ((numberp ident) (number-to-string ident))
16630 (t (error "IDENT %s must be a string, symbol or number" ident))))
16631 (case-fold-search nil))
16632 (save-excursion
16633 (save-restriction
16634 (widen)
16635 (goto-char (point-min))
16636 (when (re-search-forward
16638 nil t)
16639 (org-back-to-heading)
16640 (point))))))
16642 ;;; Column View
16644 (defvar org-columns-overlays nil
16645 "Holds the list of current column overlays.")
16647 (defvar org-columns-current-fmt nil
16648 "Local variable, holds the currently active column format.")
16649 (defvar org-columns-current-fmt-compiled nil
16650 "Local variable, holds the currently active column format.
16651 This is the compiled version of the format.")
16652 (defvar org-columns-current-widths nil
16653 "Loval variable, holds the currently widths of fields.")
16654 (defvar org-columns-current-maxwidths nil
16655 "Loval variable, holds the currently active maximum column widths.")
16656 (defvar org-columns-begin-marker (make-marker)
16657 "Points to the position where last a column creation command was called.")
16658 (defvar org-columns-top-level-marker (make-marker)
16659 "Points to the position where current columns region starts.")
16661 (defvar org-columns-map (make-sparse-keymap)
16662 "The keymap valid in column display.")
16664 (defun org-columns-content ()
16665 "Switch to contents view while in columns view."
16666 (interactive)
16667 (org-overview)
16668 (org-content))
16670 (org-defkey org-columns-map "c" 'org-columns-content)
16671 (org-defkey org-columns-map "o" 'org-overview)
16672 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16673 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16674 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16675 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16676 (org-defkey org-columns-map "v" 'org-columns-show-value)
16677 (org-defkey org-columns-map "q" 'org-columns-quit)
16678 (org-defkey org-columns-map "r" 'org-columns-redo)
16679 (org-defkey org-columns-map "g" 'org-columns-redo)
16680 (org-defkey org-columns-map [left] 'backward-char)
16681 (org-defkey org-columns-map "\M-b" 'backward-char)
16682 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16683 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16684 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16685 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16686 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16687 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16688 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16689 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16690 (org-defkey org-columns-map "<" 'org-columns-narrow)
16691 (org-defkey org-columns-map ">" 'org-columns-widen)
16692 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16693 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16694 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16695 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16697 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16698 '("Column"
16699 ["Edit property" org-columns-edit-value t]
16700 ["Next allowed value" org-columns-next-allowed-value t]
16701 ["Previous allowed value" org-columns-previous-allowed-value t]
16702 ["Show full value" org-columns-show-value t]
16703 ["Edit allowed values" org-columns-edit-allowed t]
16704 "--"
16705 ["Edit column attributes" org-columns-edit-attributes t]
16706 ["Increase column width" org-columns-widen t]
16707 ["Decrease column width" org-columns-narrow t]
16708 "--"
16709 ["Move column right" org-columns-move-right t]
16710 ["Move column left" org-columns-move-left t]
16711 ["Add column" org-columns-new t]
16712 ["Delete column" org-columns-delete t]
16713 "--"
16714 ["CONTENTS" org-columns-content t]
16715 ["OVERVIEW" org-overview t]
16716 ["Refresh columns display" org-columns-redo t]
16717 "--"
16718 ["Open link" org-columns-open-link t]
16719 "--"
16720 ["Quit" org-columns-quit t]))
16722 (defun org-columns-new-overlay (beg end &optional string face)
16723 "Create a new column overlay and add it to the list."
16724 (let ((ov (org-make-overlay beg end)))
16725 (org-overlay-put ov 'face (or face 'secondary-selection))
16726 (org-overlay-display ov string face)
16727 (push ov org-columns-overlays)
16728 ov))
16730 (defun org-columns-display-here (&optional props)
16731 "Overlay the current line with column display."
16732 (interactive)
16733 (let* ((fmt org-columns-current-fmt-compiled)
16734 (beg (point-at-bol))
16735 (level-face (save-excursion
16736 (beginning-of-line 1)
16738 (org-get-level-face 2))))
16739 (color (list :foreground
16740 (face-attribute (or level-face 'default) :foreground)))
16741 props pom property ass width f string ov column val modval)
16742 ;; Check if the entry is in another buffer.
16743 (unless props
16744 (if (eq major-mode 'org-agenda-mode)
16745 (setq pom (or (get-text-property (point) 'org-hd-marker)
16746 (get-text-property (point) 'org-marker))
16747 props (if pom (org-entry-properties pom) nil))
16748 (setq props (org-entry-properties nil))))
16749 ;; Walk the format
16750 (while (setq column (pop fmt))
16751 (setq property (car column)
16752 ass (if (equal property "ITEM")
16753 (cons "ITEM"
16754 (save-match-data
16755 (org-no-properties
16756 (org-remove-tabs
16757 (buffer-substring-no-properties
16758 (point-at-bol) (point-at-eol))))))
16759 (assoc property props))
16760 width (or (cdr (assoc property org-columns-current-maxwidths))
16761 (nth 2 column)
16762 (length property))
16763 f (format "%%-%d.%ds | " width width)
16764 val (or (cdr ass) "")
16765 modval (if (equal property "ITEM")
16766 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16767 string (format f (or modval val)))
16768 ;; Create the overlay
16769 (org-unmodified
16770 (setq ov (org-columns-new-overlay
16771 beg (setq beg (1+ beg)) string
16772 (list color 'org-column)))
16773 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16774 (org-overlay-put ov 'keymap org-columns-map)
16775 (org-overlay-put ov 'org-columns-key property)
16776 (org-overlay-put ov 'org-columns-value (cdr ass))
16777 (org-overlay-put ov 'org-columns-value-modified modval)
16778 (org-overlay-put ov 'org-columns-pom pom)
16779 (org-overlay-put ov 'org-columns-format f))
16780 (if (or (not (char-after beg))
16782 (let ((inhibit-read-only t))
16783 (save-excursion
16784 (goto-char beg)
16785 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16786 ;; Make the rest of the line disappear.
16787 (org-unmodified
16788 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16789 (org-overlay-put ov 'invisible t)
16790 (org-overlay-put ov 'keymap org-columns-map)
16791 (org-overlay-put ov 'intangible t)
16792 (push ov org-columns-overlays)
16793 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16794 (org-overlay-put ov 'keymap org-columns-map)
16795 (push ov org-columns-overlays)
16796 (let ((inhibit-read-only t))
16797 (put-text-property (max (point-min) (1- (point-at-bol)))
16798 (min (point-max) (1+ (point-at-eol)))
16799 'read-only "Type `e' to edit property")))))
16801 (defvar org-previous-header-line-format nil
16802 "The header line format before column view was turned on.")
16803 (defvar org-columns-inhibit-recalculation nil
16804 "Inhibit recomputing of columns on column view startup.")
16807 (defvar header-line-format)
16808 (defun org-columns-display-here-title ()
16809 "Overlay the newline before the current line with the table title."
16810 (interactive)
16811 (let ((fmt org-columns-current-fmt-compiled)
16812 string (title "")
16813 property width f column str widths)
16814 (while (setq column (pop fmt))
16815 (setq property (car column)
16816 str (or (nth 1 column) property)
16817 width (or (cdr (assoc property org-columns-current-maxwidths))
16818 (nth 2 column)
16819 (length str))
16820 widths (push width widths)
16821 f (format "%%-%d.%ds | " width width)
16822 string (format f str)
16823 title (concat title string)))
16824 (setq title (concat
16825 (org-add-props " " nil 'display '(space :align-to 0))
16826 (org-add-props title nil 'face '(:weight bold :underline t))))
16827 (org-set-local 'org-previous-header-line-format header-line-format)
16828 (org-set-local 'org-columns-current-widths (nreverse widths))
16829 (setq header-line-format title)))
16831 (defun org-columns-remove-overlays ()
16832 "Remove all currently active column overlays."
16833 (interactive)
16834 (when (marker-buffer org-columns-begin-marker)
16835 (with-current-buffer (marker-buffer org-columns-begin-marker)
16836 (when (local-variable-p 'org-previous-header-line-format)
16837 (setq header-line-format org-previous-header-line-format)
16838 (kill-local-variable 'org-previous-header-line-format))
16839 (move-marker org-columns-begin-marker nil)
16840 (move-marker org-columns-top-level-marker nil)
16841 (org-unmodified
16842 (mapc 'org-delete-overlay org-columns-overlays)
16843 (setq org-columns-overlays nil)
16844 (let ((inhibit-read-only t))
16845 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16847 (defun org-columns-cleanup-item (item fmt)
16848 "Remove from ITEM what is a column in the format FMT."
16849 (if (not org-complex-heading-regexp)
16850 item
16851 (when (string-match org-complex-heading-regexp item)
16852 (concat
16853 (org-add-props (concat (match-string 1 item) " ") nil
16854 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16855 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16856 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16857 " " (match-string 4 item)
16858 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16860 (defun org-columns-show-value ()
16861 "Show the full value of the property."
16862 (interactive)
16863 (let ((value (get-char-property (point) 'org-columns-value)))
16864 (message "Value is: %s" (or value ""))))
16866 (defun org-columns-quit ()
16867 "Remove the column overlays and in this way exit column editing."
16868 (interactive)
16869 (org-unmodified
16870 (org-columns-remove-overlays)
16871 (let ((inhibit-read-only t))
16872 (remove-text-properties (point-min) (point-max) '(read-only t))))
16873 (when (eq major-mode 'org-agenda-mode)
16874 (message
16875 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16877 (defun org-columns-check-computed ()
16878 "Check if this column value is computed.
16879 If yes, throw an error indicating that changing it does not make sense."
16880 (let ((val (get-char-property (point) 'org-columns-value)))
16881 (when (and (stringp val)
16882 (get-char-property 0 'org-computed val))
16883 (error "This value is computed from the entry's children"))))
16885 (defun org-columns-todo (&optional arg)
16886 "Change the TODO state during column view."
16887 (interactive "P")
16888 (org-columns-edit-value "TODO"))
16890 (defun org-columns-set-tags-or-toggle (&optional arg)
16891 "Toggle checkbox at point, or set tags for current headline."
16892 (interactive "P")
16894 (get-char-property (point) 'org-columns-value))
16895 (org-columns-next-allowed-value)
16896 (org-columns-edit-value "TAGS")))
16898 (defun org-columns-edit-value (&optional key)
16899 "Edit the value of the property at point in column view.
16900 Where possible, use the standard interface for changing this line."
16901 (interactive)
16902 (org-columns-check-computed)
16903 (let* ((external-key key)
16904 (col (current-column))
16905 (key (or key (get-char-property (point) 'org-columns-key)))
16906 (value (get-char-property (point) 'org-columns-value))
16907 (bol (point-at-bol)) (eol (point-at-eol))
16908 (pom (or (get-text-property bol 'org-hd-marker)
16909 (point))) ; keep despite of compiler waring
16910 (line-overlays
16911 (delq nil (mapcar (lambda (x)
16912 (and (eq (overlay-buffer x) (current-buffer))
16913 (>= (overlay-start x) bol)
16914 (<= (overlay-start x) eol)
16915 x))
16916 org-columns-overlays)))
16917 nval eval allowed)
16918 (cond
16919 ((equal key "CLOCKSUM")
16920 (error "This special column cannot be edited"))
16921 ((equal key "ITEM")
16922 (setq eval '(org-with-point-at pom
16923 (org-edit-headline))))
16924 ((equal key "TODO")
16925 (setq eval '(org-with-point-at pom
16926 (let ((current-prefix-arg
16927 (if external-key current-prefix-arg '(4))))
16928 (call-interactively 'org-todo)))))
16929 ((equal key "PRIORITY")
16930 (setq eval '(org-with-point-at pom
16931 (call-interactively 'org-priority))))
16932 ((equal key "TAGS")
16933 (setq eval '(org-with-point-at pom
16934 (let ((org-fast-tag-selection-single-key
16935 (if (eq org-fast-tag-selection-single-key 'expert)
16936 t org-fast-tag-selection-single-key)))
16937 (call-interactively 'org-set-tags)))))
16938 ((equal key "DEADLINE")
16939 (setq eval '(org-with-point-at pom
16940 (call-interactively 'org-deadline))))
16941 ((equal key "SCHEDULED")
16942 (setq eval '(org-with-point-at pom
16943 (call-interactively 'org-schedule))))
16944 (t
16945 (setq allowed (org-property-get-allowed-values pom key 'table))
16946 (if allowed
16947 (setq nval (completing-read "Value: " allowed nil t))
16948 (setq nval (read-string "Edit: " value)))
16949 (setq nval (org-trim nval))
16950 (when (not (equal nval value))
16951 (setq eval '(org-entry-put pom key nval)))))
16952 (when eval
16953 (let ((inhibit-read-only t))
16954 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16955 (unwind-protect
16956 (progn
16957 (setq org-columns-overlays
16958 (org-delete-all line-overlays org-columns-overlays))
16959 (mapc 'org-delete-overlay line-overlays)
16960 (org-columns-eval eval))
16961 (org-columns-display-here))))
16962 (move-to-column col)
16963 (if (and (org-mode-p)
16964 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16965 (org-columns-update key))))
16967 (defun org-edit-headline () ; FIXME: this is not columns specific
16968 "Edit the current headline, the part without TODO keyword, TAGS."
16969 (org-back-to-heading)
16970 (when (looking-at org-todo-line-regexp)
16971 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16972 (txt (match-string 3))
16973 (post "")
16974 txt2)
16976 (setq post (match-string 0 txt)
16977 txt (substring txt 0 (match-beginning 0))))
16978 (setq txt2 (read-string "Edit: " txt))
16979 (when (not (equal txt txt2))
16980 (beginning-of-line 1)
16981 (insert pre txt2 post)
16982 (delete-region (point) (point-at-eol))
16983 (org-set-tags nil t)))))
16985 (defun org-columns-edit-allowed ()
16986 "Edit the list of allowed values for the current property."
16987 (interactive)
16988 (let* ((key (get-char-property (point) 'org-columns-key))
16989 (key1 (concat key "_ALL"))
16990 (allowed (org-entry-get (point) key1 t))
16991 nval)
16992 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16993 (setq nval (read-string "Allowed: " allowed))
16994 (org-entry-put
16995 (cond ((marker-position org-entry-property-inherited-from)
16996 org-entry-property-inherited-from)
16997 ((marker-position org-columns-top-level-marker)
16998 org-columns-top-level-marker))
16999 key1 nval)))
17001 (defmacro org-no-warnings (&rest body)
17002 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
17004 (defun org-columns-eval (form)
17005 (let (hidep)
17006 (save-excursion
17007 (beginning-of-line 1)
17008 ;; `next-line' is needed here, because it skips invisible line.
17009 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
17010 (setq hidep (org-on-heading-p 1)))
17011 (eval form)
17012 (and hidep (hide-entry))))
17014 (defun org-columns-previous-allowed-value ()
17015 "Switch to the previous allowed value for this column."
17016 (interactive)
17017 (org-columns-next-allowed-value t))
17019 (defun org-columns-next-allowed-value (&optional previous)
17020 "Switch to the next allowed value for this column."
17021 (interactive)
17022 (org-columns-check-computed)
17023 (let* ((col (current-column))
17024 (key (get-char-property (point) 'org-columns-key))
17025 (value (get-char-property (point) 'org-columns-value))
17026 (bol (point-at-bol)) (eol (point-at-eol))
17027 (pom (or (get-text-property bol 'org-hd-marker)
17028 (point))) ; keep despite of compiler waring
17029 (line-overlays
17030 (delq nil (mapcar (lambda (x)
17031 (and (eq (overlay-buffer x) (current-buffer))
17032 (>= (overlay-start x) bol)
17033 (<= (overlay-start x) eol)
17034 x))
17035 org-columns-overlays)))
17036 (allowed (or (org-property-get-allowed-values pom key)
17037 (and (memq
17038 (nth 4 (assoc key org-columns-current-fmt-compiled))
17039 '(checkbox checkbox-n-of-m checkbox-percent))
17040 '("[ ]" "[X]"))))
17041 nval)
17042 (when (equal key "ITEM")
17043 (error "Cannot edit item headline from here"))
17044 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
17045 (error "Allowed values for this property have not been defined"))
17046 (if (member key '("SCHEDULED" "DEADLINE"))
17047 (setq nval (if previous 'earlier 'later))
17048 (if previous (setq allowed (reverse allowed)))
17049 (if (member value allowed)
17050 (setq nval (car (cdr (member value allowed)))))
17051 (setq nval (or nval (car allowed)))
17052 (if (equal nval value)
17053 (error "Only one allowed value for this property")))
17054 (let ((inhibit-read-only t))
17055 (remove-text-properties (1- bol) eol '(read-only t))
17056 (unwind-protect
17057 (progn
17058 (setq org-columns-overlays
17059 (org-delete-all line-overlays org-columns-overlays))
17060 (mapc 'org-delete-overlay line-overlays)
17061 (org-columns-eval '(org-entry-put pom key nval)))
17062 (org-columns-display-here)))
17063 (move-to-column col)
17064 (if (and (org-mode-p)
17065 (nth 3 (assoc key org-columns-current-fmt-compiled)))
17066 (org-columns-update key))))
17068 (defun org-verify-version (task)
17069 (cond
17070 ((eq task 'columns)
17071 (if (or (featurep 'xemacs)
17072 (< emacs-major-version 22))
17073 (error "Emacs 22 is required for the columns feature")))))
17075 (defun org-columns-open-link (&optional arg)
17076 (interactive "P")
17077 (let ((value (get-char-property (point) 'org-columns-value)))
17078 (org-open-link-from-string value arg)))
17080 (defun org-open-link-from-string (s &optional arg)
17081 "Open a link in the string S, as if it was in Org-mode."
17082 (interactive)
17083 (with-temp-buffer
17084 (let ((org-inhibit-startup t))
17085 (org-mode)
17086 (insert s)
17087 (goto-char (point-min))
17088 (org-open-at-point arg))))
17090 (defun org-columns-get-format-and-top-level ()
17091 (let (fmt)
17092 (when (condition-case nil (org-back-to-heading) (error nil))
17093 (move-marker org-entry-property-inherited-from nil)
17094 (setq fmt (org-entry-get nil "COLUMNS" t)))
17095 (setq fmt (or fmt org-columns-default-format))
17096 (org-set-local 'org-columns-current-fmt fmt)
17097 (org-columns-compile-format fmt)
17098 (if (marker-position org-entry-property-inherited-from)
17099 (move-marker org-columns-top-level-marker
17100 org-entry-property-inherited-from)
17101 (move-marker org-columns-top-level-marker (point)))
17102 fmt))
17104 (defun org-columns ()
17105 "Turn on column view on an org-mode file."
17106 (interactive)
17107 (org-verify-version 'columns)
17108 (org-columns-remove-overlays)
17109 (move-marker org-columns-begin-marker (point))
17110 (let (beg end fmt cache maxwidths)
17111 (setq fmt (org-columns-get-format-and-top-level))
17112 (save-excursion
17113 (goto-char org-columns-top-level-marker)
17114 (setq beg (point))
17115 (unless org-columns-inhibit-recalculation
17116 (org-columns-compute-all))
17117 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
17118 (point-max)))
17119 ;; Get and cache the properties
17120 (goto-char beg)
17121 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
17122 (save-excursion
17123 (save-restriction
17124 (narrow-to-region beg end)
17125 (org-clock-sum))))
17126 (while (re-search-forward (concat "^" outline-regexp) end t)
17127 (push (cons (org-current-line) (org-entry-properties)) cache))
17128 (when cache
17129 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17130 (org-set-local 'org-columns-current-maxwidths maxwidths)
17131 (org-columns-display-here-title)
17132 (mapc (lambda (x)
17133 (goto-line (car x))
17134 (org-columns-display-here (cdr x)))
17135 cache)))))
17137 (defun org-columns-new (&optional prop title width op fmt &rest rest)
17138 "Insert a new column, to the leeft o the current column."
17139 (interactive)
17140 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
17141 cell)
17142 (setq prop (completing-read
17143 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
17144 nil nil prop))
17145 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
17146 (setq width (read-string "Column width: " (if width (number-to-string width))))
17148 (setq width (string-to-number width))
17149 (setq width nil))
17150 (setq fmt (completing-read "Summary [none]: "
17151 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
17152 nil t))
17154 (setq fmt (intern fmt))
17155 (setq fmt nil))
17156 (if (eq fmt 'none) (setq fmt nil))
17157 (if editp
17158 (progn
17159 (setcar editp prop)
17160 (setcdr editp (list title width nil fmt)))
17161 (setq cell (nthcdr (1- (current-column))
17162 org-columns-current-fmt-compiled))
17163 (setcdr cell (cons (list prop title width nil fmt)
17164 (cdr cell))))
17165 (org-columns-store-format)
17166 (org-columns-redo)))
17168 (defun org-columns-delete ()
17169 "Delete the column at point from columns view."
17170 (interactive)
17171 (let* ((n (current-column))
17172 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
17173 (when (y-or-n-p
17175 (setq org-columns-current-fmt-compiled
17176 (delq (nth n org-columns-current-fmt-compiled)
17177 org-columns-current-fmt-compiled))
17178 (org-columns-store-format)
17179 (org-columns-redo)
17180 (if (>= (current-column) (length org-columns-current-fmt-compiled))
17181 (backward-char 1)))))
17183 (defun org-columns-edit-attributes ()
17184 "Edit the attributes of the current column."
17185 (interactive)
17186 (let* ((n (current-column))
17187 (info (nth n org-columns-current-fmt-compiled)))
17188 (apply 'org-columns-new info)))
17190 (defun org-columns-widen (arg)
17191 "Make the column wider by ARG characters."
17192 (interactive "p")
17193 (let* ((n (current-column))
17194 (entry (nth n org-columns-current-fmt-compiled))
17195 (width (or (nth 2 entry)
17196 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
17197 (setq width (max 1 (+ width arg)))
17198 (setcar (nthcdr 2 entry) width)
17199 (org-columns-store-format)
17200 (org-columns-redo)))
17202 (defun org-columns-narrow (arg)
17203 "Make the column nrrower by ARG characters."
17204 (interactive "p")
17205 (org-columns-widen (- arg)))
17207 (defun org-columns-move-right ()
17208 "Swap this column with the one to the right."
17209 (interactive)
17210 (let* ((n (current-column))
17211 (cell (nthcdr n org-columns-current-fmt-compiled))
17212 e)
17213 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17214 (error "Cannot shift this column further to the right"))
17215 (setq e (car cell))
17216 (setcar cell (car (cdr cell)))
17217 (setcdr cell (cons e (cdr (cdr cell))))
17218 (org-columns-store-format)
17219 (org-columns-redo)
17220 (forward-char 1)))
17222 (defun org-columns-move-left ()
17223 "Swap this column with the one to the left."
17224 (interactive)
17225 (let* ((n (current-column)))
17226 (when (= n 0)
17227 (error "Cannot shift this column further to the left"))
17228 (backward-char 1)
17229 (org-columns-move-right)
17230 (backward-char 1)))
17232 (defun org-columns-store-format ()
17233 "Store the text version of the current columns format in appropriate place.
17234 This is either in the COLUMNS property of the node starting the current column
17235 display, or in the #+COLUMNS line of the current buffer."
17236 (let (fmt (cnt 0))
17237 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17238 (org-set-local 'org-columns-current-fmt fmt)
17239 (if (marker-position org-columns-top-level-marker)
17240 (save-excursion
17241 (goto-char org-columns-top-level-marker)
17242 (if (and (org-at-heading-p)
17243 (org-entry-get nil "COLUMNS"))
17244 (org-entry-put nil "COLUMNS" fmt)
17245 (goto-char (point-min))
17246 ;; Overwrite all #+COLUMNS lines....
17248 (setq cnt (1+ cnt))
17249 (replace-match (concat "#+COLUMNS: " fmt) t t))
17250 (unless (> cnt 0)
17251 (goto-char (point-min))
17252 (or (org-on-heading-p t) (outline-next-heading))
17253 (let ((inhibit-read-only t))
17255 (org-set-local 'org-columns-default-format fmt))))))
17257 (defvar org-overriding-columns-format nil
17258 "When set, overrides any other definition.")
17259 (defvar org-agenda-view-columns-initially nil
17260 "When set, switch to columns view immediately after creating the agenda.")
17262 (defun org-agenda-columns ()
17263 "Turn on column view in the agenda."
17264 (interactive)
17265 (org-verify-version 'columns)
17266 (org-columns-remove-overlays)
17267 (move-marker org-columns-begin-marker (point))
17268 (let (fmt cache maxwidths m)
17269 (cond
17270 ((and (local-variable-p 'org-overriding-columns-format)
17271 org-overriding-columns-format)
17272 (setq fmt org-overriding-columns-format))
17273 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17274 (setq fmt (org-entry-get m "COLUMNS" t)))
17275 ((and (boundp 'org-columns-current-fmt)
17276 (local-variable-p 'org-columns-current-fmt)
17277 org-columns-current-fmt)
17278 (setq fmt org-columns-current-fmt))
17279 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17280 (setq m (get-text-property m 'org-hd-marker))
17281 (setq fmt (org-entry-get m "COLUMNS" t))))
17282 (setq fmt (or fmt org-columns-default-format))
17283 (org-set-local 'org-columns-current-fmt fmt)
17284 (org-columns-compile-format fmt)
17285 (save-excursion
17286 ;; Get and cache the properties
17287 (goto-char (point-min))
17288 (while (not (eobp))
17289 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17290 (get-text-property (point) 'org-marker)))
17291 (push (cons (org-current-line) (org-entry-properties m)) cache))
17292 (beginning-of-line 2))
17293 (when cache
17294 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17295 (org-set-local 'org-columns-current-maxwidths maxwidths)
17296 (org-columns-display-here-title)
17297 (mapc (lambda (x)
17298 (goto-line (car x))
17299 (org-columns-display-here (cdr x)))
17300 cache)))))
17302 (defun org-columns-get-autowidth-alist (s cache)
17303 "Derive the maximum column widths from the format and the cache."
17304 (let ((start 0) rtn)
17306 (push (cons (match-string 1 s) 1) rtn)
17307 (setq start (match-end 0)))
17308 (mapc (lambda (x)
17309 (setcdr x (apply 'max
17310 (mapcar
17311 (lambda (y)
17312 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17313 cache))))
17314 rtn)
17315 rtn))
17317 (defun org-columns-compute-all ()
17318 "Compute all columns that have operators defined."
17319 (org-unmodified
17320 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17321 (let ((columns org-columns-current-fmt-compiled) col)
17322 (while (setq col (pop columns))
17323 (when (nth 3 col)
17324 (save-excursion
17325 (org-columns-compute (car col)))))))
17327 (defun org-columns-update (property)
17328 "Recompute PROPERTY, and update the columns display for it."
17329 (org-columns-compute property)
17330 (let (fmt val pos)
17331 (save-excursion
17332 (mapc (lambda (ov)
17333 (when (equal (org-overlay-get ov 'org-columns-key) property)
17334 (setq pos (org-overlay-start ov))
17335 (goto-char pos)
17336 (when (setq val (cdr (assoc property
17337 (get-text-property
17338 (point-at-bol) 'org-summaries))))
17339 (setq fmt (org-overlay-get ov 'org-columns-format))
17340 (org-overlay-put ov 'org-columns-value val)
17341 (org-overlay-put ov 'display (format fmt val)))))
17342 org-columns-overlays))))
17344 (defun org-columns-compute (property)
17345 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17346 (interactive)
17347 (let* ((re (concat "^" outline-regexp))
17348 (lmax 30) ; Does anyone use deeper levels???
17349 (lsum (make-vector lmax 0))
17350 (lflag (make-vector lmax nil))
17351 (level 0)
17352 (ass (assoc property org-columns-current-fmt-compiled))
17353 (format (nth 4 ass))
17354 (printf (nth 5 ass))
17355 (beg org-columns-top-level-marker)
17356 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17357 (save-excursion
17358 ;; Find the region to compute
17359 (goto-char beg)
17360 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17361 (goto-char end)
17362 ;; Walk the tree from the back and do the computations
17363 (while (re-search-backward re beg t)
17364 (setq sumpos (match-beginning 0)
17365 last-level level
17366 level (org-outline-level)
17367 val (org-entry-get nil property)
17369 (cond
17370 ((< level last-level)
17371 ;; put the sum of lower levels here as a property
17372 (setq sum (aref lsum last-level) ; current sum
17373 flag (aref lflag last-level) ; any valid entries from children?
17374 str (org-column-number-to-string sum format printf)
17375 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17376 useval (if flag str1 (if valflag val ""))
17377 sum-alist (get-text-property sumpos 'org-summaries))
17378 (if (assoc property sum-alist)
17379 (setcdr (assoc property sum-alist) useval)
17380 (push (cons property useval) sum-alist)
17381 (org-unmodified
17382 (add-text-properties sumpos (1+ sumpos)
17383 (list 'org-summaries sum-alist))))
17384 (when val
17385 (org-entry-put nil property (if flag str val)))
17386 ;; add current to current level accumulator
17387 (when (or flag valflag)
17388 (aset lsum level (+ (aref lsum level)
17389 (if flag sum (org-column-string-to-number
17390 (if flag str val) format))))
17391 (aset lflag level t))
17392 ;; clear accumulators for deeper levels
17393 (loop for l from (1+ level) to (1- lmax) do
17394 (aset lsum l 0)
17395 (aset lflag l nil)))
17396 ((>= level last-level)
17397 ;; add what we have here to the accumulator for this level
17398 (aset lsum level (+ (aref lsum level)
17399 (org-column-string-to-number (or val "0") format)))
17400 (and valflag (aset lflag level t)))
17401 (t (error "This should not happen")))))))
17403 (defun org-columns-redo ()
17404 "Construct the column display again."
17405 (interactive)
17406 (message "Recomputing columns...")
17407 (save-excursion
17408 (if (marker-position org-columns-begin-marker)
17409 (goto-char org-columns-begin-marker))
17410 (org-columns-remove-overlays)
17411 (if (org-mode-p)
17412 (call-interactively 'org-columns)
17413 (call-interactively 'org-agenda-columns)))
17414 (message "Recomputing columns...done"))
17416 (defun org-columns-not-in-agenda ()
17417 (if (eq major-mode 'org-agenda-mode)
17418 (error "This command is only allowed in Org-mode buffers")))
17421 (defun org-string-to-number (s)
17422 "Convert string to number, and interpret hh:mm:ss."
17423 (if (not (string-match ":" s))
17424 (string-to-number s)
17425 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17426 (while l
17427 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17428 sum)))
17430 (defun org-column-number-to-string (n fmt &optional printf)
17431 "Convert a computed column number to a string value, according to FMT."
17432 (cond
17433 ((eq fmt 'add_times)
17434 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17435 (format "%d:%02d" h m)))
17436 ((eq fmt 'checkbox)
17437 (cond ((= n (floor n)) "[X]")
17438 ((> n 1.) "[-]")
17439 (t "[ ]")))
17440 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17441 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17442 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17443 (printf (format printf n))
17444 ((eq fmt 'currency)
17445 (format "%.2f" n))
17446 (t (number-to-string n))))
17448 (defun org-nofm-to-completion (n m &optional percent)
17449 (if (not percent)
17450 (format "[%d/%d]" n m)
17451 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17453 (defun org-column-string-to-number (s fmt)
17454 "Convert a column value to a number that can be used for column computing."
17455 (cond
17456 ((string-match ":" s)
17457 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17458 (while l
17459 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17460 sum))
17461 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17462 (if (equal s "[X]") 1. 0.000001))
17463 (t (string-to-number s))))
17465 (defun org-columns-uncompile-format (cfmt)
17466 "Turn the compiled columns format back into a string representation."
17467 (let ((rtn "") e s prop title op width fmt printf)
17468 (while (setq e (pop cfmt))
17469 (setq prop (car e)
17470 title (nth 1 e)
17471 width (nth 2 e)
17472 op (nth 3 e)
17473 fmt (nth 4 e)
17474 printf (nth 5 e))
17475 (cond
17476 ((eq fmt 'add_times) (setq op ":"))
17477 ((eq fmt 'checkbox) (setq op "X"))
17478 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17479 ((eq fmt 'checkbox-percent) (setq op "X%"))
17480 ((eq fmt 'add_numbers) (setq op "+"))
17481 ((eq fmt 'currency) (setq op "$")))
17482 (if (and op printf) (setq op (concat op ";" printf)))
17483 (if (equal title prop) (setq title nil))
17484 (setq s (concat "%" (if width (number-to-string width))
17485 prop
17486 (if title (concat "(" title ")"))
17487 (if op (concat "{" op "}"))))
17488 (setq rtn (concat rtn " " s)))
17489 (org-trim rtn)))
17491 (defun org-columns-compile-format (fmt)
17492 "Turn a column format string into an alist of specifications.
17493 The alist has one entry for each column in the format. The elements of
17494 that list are:
17495 property the property
17496 title the title field for the columns
17497 width the column width in characters, can be nil for automatic
17498 operator the operator if any
17499 format the output format for computed results, derived from operator
17500 printf a printf format for computed values"
17501 (let ((start 0) width prop title op f printf)
17502 (setq org-columns-current-fmt-compiled nil)
17503 (while (string-match
17504 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17505 fmt start)
17506 (setq start (match-end 0)
17507 width (match-string 1 fmt)
17508 prop (match-string 2 fmt)
17509 title (or (match-string 3 fmt) prop)
17510 op (match-string 4 fmt)
17511 f nil
17512 printf nil)
17513 (if width (setq width (string-to-number width)))
17514 (when (and op (string-match ";" op))
17515 (setq printf (substring op (match-end 0))
17516 op (substring op 0 (match-beginning 0))))
17517 (cond
17518 ((equal op "+") (setq f 'add_numbers))
17519 ((equal op "$") (setq f 'currency))
17520 ((equal op ":") (setq f 'add_times))
17521 ((equal op "X") (setq f 'checkbox))
17522 ((equal op "X/") (setq f 'checkbox-n-of-m))
17523 ((equal op "X%") (setq f 'checkbox-percent))
17524 )
17525 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17526 (setq org-columns-current-fmt-compiled
17527 (nreverse org-columns-current-fmt-compiled))))
17530 ;;; Dynamic block for Column view
17532 (defun org-columns-capture-view (&optional maxlevel skip-empty-rows)
17533 "Get the column view of the current buffer or subtree.
17534 The first optional argument MAXLEVEL sets the level limit. A
17535 second optional argument SKIP-EMPTY-ROWS tells whether to skip
17536 empty rows, an empty row being one where all the column view
17537 specifiers except ITEM are empty. This function returns a list
17538 containing the title row and all other rows. Each row is a list
17539 of fields."
17540 (save-excursion
17541 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17542 (n (length title)) row tbl)
17543 (goto-char (point-min))
17545 (or (null maxlevel)
17546 (>= maxlevel
17547 (if org-odd-levels-only
17548 (/ (1+ (length (match-string 1))) 2)
17549 (length (match-string 1))))))
17550 (when (get-char-property (match-beginning 0) 'org-columns-key)
17551 (setq row nil)
17552 (loop for i from 0 to (1- n) do
17553 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17554 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17555 "")
17556 row))
17557 (setq row (nreverse row))
17558 (unless (and skip-empty-rows
17559 (eq 1 (length (delete "" (delete-dups row)))))
17560 (push row tbl))))
17561 (append (list title 'hline) (nreverse tbl)))))
17563 (defun org-dblock-write:columnview (params)
17564 "Write the column view table.
17565 PARAMS is a property list of parameters:
17567 :width enforce same column widths with <N> specifiers.
17568 :id the :ID: property of the entry where the columns view
17569 should be built, as a string. When `local', call locally.
17570 When `global' call column view with the cursor at the beginning
17571 of the buffer (usually this means that the whole buffer switches
17572 to column view).
17573 :hlines When t, insert a hline before each item. When a number, insert
17574 a hline before each level <= that number.
17575 :vlines When t, make each column a colgroup to enforce vertical lines.
17576 :maxlevel When set to a number, don't capture headlines below this level.
17577 :skip-empty-rows
17578 When t, skip rows where all specifiers other than ITEM are empty."
17579 (let ((pos (move-marker (make-marker) (point)))
17580 (hlines (plist-get params :hlines))
17581 (vlines (plist-get params :vlines))
17582 (maxlevel (plist-get params :maxlevel))
17583 (skip-empty-rows (plist-get params :skip-empty-rows))
17584 tbl id idpos nfields tmp)
17585 (save-excursion
17586 (save-restriction
17587 (when (setq id (plist-get params :id))
17588 (cond ((not id) nil)
17589 ((eq id 'global) (goto-char (point-min)))
17590 ((eq id 'local) nil)
17591 ((setq idpos (org-find-entry-with-id id))
17592 (goto-char idpos))
17593 (t (error "Cannot find entry with :ID: %s" id))))
17594 (org-columns)
17595 (setq tbl (org-columns-capture-view maxlevel skip-empty-rows))
17596 (setq nfields (length (car tbl)))
17597 (org-columns-quit)))
17598 (goto-char pos)
17599 (move-marker pos nil)
17600 (when tbl
17601 (when (plist-get params :hlines)
17602 (setq tmp nil)
17603 (while tbl
17604 (if (eq (car tbl) 'hline)
17605 (push (pop tbl) tmp)
17607 (if (and (not (eq (car tmp) 'hline))
17608 (or (eq hlines t)
17609 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17610 (push 'hline tmp)))
17611 (push (pop tbl) tmp)))
17612 (setq tbl (nreverse tmp)))
17613 (when vlines
17614 (setq tbl (mapcar (lambda (x)
17615 (if (eq 'hline x) x (cons "" x)))
17616 tbl))
17617 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17618 (setq pos (point))
17619 (insert (org-listtable-to-string tbl))
17620 (when (plist-get params :width)
17622 org-columns-current-widths "|")))
17623 (goto-char pos)
17624 (org-table-align))))
17626 (defun org-listtable-to-string (tbl)
17627 "Convert a listtable TBL to a string that contains the Org-mode table.
17628 The table still need to be alligned. The resulting string has no leading
17629 and tailing newline characters."
17630 (mapconcat
17631 (lambda (x)
17632 (cond
17633 ((listp x)
17634 (concat "|" (mapconcat 'identity x "|") "|"))
17635 ((eq x 'hline) "|-|")
17636 (t (error "Garbage in listtable: %s" x))))
17639 (defun org-insert-columns-dblock ()
17640 "Create a dynamic block capturing a column view table."
17641 (interactive)
17642 (let ((defaults '(:name "columnview" :hlines 1))
17643 (id (completing-read
17644 "Capture columns (local, global, entry with :ID: property) [local]: "
17645 (append '(("global") ("local"))
17646 (mapcar 'list (org-property-values "ID"))))))
17647 (if (equal id "") (setq id 'local))
17648 (if (equal id "global") (setq id 'global))
17649 (setq defaults (append defaults (list :id id)))
17650 (org-create-dblock defaults)
17651 (org-update-dblock)))
17653 ;;;; Timestamps
17655 (defvar org-last-changed-timestamp nil)
17656 (defvar org-time-was-given) ; dynamically scoped parameter
17657 (defvar org-end-time-was-given) ; dynamically scoped parameter
17658 (defvar org-ts-what) ; dynamically scoped parameter
17660 (defun org-time-stamp (arg)
17661 "Prompt for a date/time and insert a time stamp.
17662 If the user specifies a time like HH:MM, or if this command is called
17663 with a prefix argument, the time stamp will contain date and time.
17664 Otherwise, only the date will be included. All parts of a date not
17665 specified by the user will be filled in from the current date/time.
17666 So if you press just return without typing anything, the time stamp
17667 will represent the current date/time. If there is already a timestamp
17668 at the cursor, it will be modified."
17669 (interactive "P")
17670 (let* ((ts nil)
17671 (default-time
17672 ;; Default time is either today, or, when entering a range,
17673 ;; the range start.
17674 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17675 (save-excursion
17676 (re-search-backward
17678 (- (point) 20) t)))
17679 (apply 'encode-time (org-parse-time-string (match-string 1)))
17680 (current-time)))
17681 (default-input (and ts (org-get-compact-tod ts)))
17682 org-time-was-given org-end-time-was-given time)
17683 (cond
17684 ((and (org-at-timestamp-p)
17685 (eq last-command 'org-time-stamp)
17686 (eq this-command 'org-time-stamp))
17687 (insert "--")
17688 (setq time (let ((this-command this-command))
17689 (org-read-date arg 'totime nil nil default-time default-input)))
17690 (org-insert-time-stamp time (or org-time-was-given arg)))
17691 ((org-at-timestamp-p)
17692 (setq time (let ((this-command this-command))
17693 (org-read-date arg 'totime nil nil default-time default-input)))
17694 (when (org-at-timestamp-p) ; just to get the match data
17695 (replace-match "")
17696 (setq org-last-changed-timestamp
17697 (org-insert-time-stamp
17698 time (or org-time-was-given arg)
17699 nil nil nil (list org-end-time-was-given))))
17700 (message "Timestamp updated"))
17701 (t
17702 (setq time (let ((this-command this-command))
17703 (org-read-date arg 'totime nil nil default-time default-input)))
17704 (org-insert-time-stamp time (or org-time-was-given arg)
17705 nil nil nil (list org-end-time-was-given))))))
17707 ;; FIXME: can we use this for something else????
17708 ;; like computing time differences?????
17709 (defun org-get-compact-tod (s)
17710 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17711 (let* ((t1 (match-string 1 s))
17712 (h1 (string-to-number (match-string 2 s)))
17713 (m1 (string-to-number (match-string 3 s)))
17714 (t2 (and (match-end 4) (match-string 5 s)))
17715 (h2 (and t2 (string-to-number (match-string 6 s))))
17716 (m2 (and t2 (string-to-number (match-string 7 s))))
17717 dh dm)
17718 (if (not t2)
17719 t1
17720 (setq dh (- h2 h1) dm (- m2 m1))
17721 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17722 (concat t1 "+" (number-to-string dh)
17723 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17725 (defun org-time-stamp-inactive (&optional arg)
17726 "Insert an inactive time stamp.
17727 An inactive time stamp is enclosed in square brackets instead of angle
17728 brackets. It is inactive in the sense that it does not trigger agenda entries,
17729 does not link to the calendar and cannot be changed with the S-cursor keys.
17730 So these are more for recording a certain time/date."
17731 (interactive "P")
17732 (let (org-time-was-given org-end-time-was-given time)
17733 (setq time (org-read-date arg 'totime))
17734 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17735 nil nil (list org-end-time-was-given))))
17737 (defvar org-date-ovl (org-make-overlay 1 1))
17738 (org-overlay-put org-date-ovl 'face 'org-warning)
17739 (org-detach-overlay org-date-ovl)
17741 (defvar org-ans1) ; dynamically scoped parameter
17742 (defvar org-ans2) ; dynamically scoped parameter
17744 (defvar org-plain-time-of-day-regexp) ; defined below
17746 (defvar org-read-date-overlay nil)
17747 (defvar org-dcst nil) ; dynamically scoped
17749 (defun org-read-date (&optional with-time to-time from-string prompt
17750 default-time default-input)
17751 "Read a date, possibly a time, and make things smooth for the user.
17752 The prompt will suggest to enter an ISO date, but you can also enter anything
17753 which will at least partially be understood by `parse-time-string'.
17754 Unrecognized parts of the date will default to the current day, month, year,
17755 hour and minute. If this command is called to replace a timestamp at point,
17756 of to enter the second timestamp of a range, the default time is taken from the
17757 existing stamp. For example,
17758 3-2-5 --> 2003-02-05
17759 feb 15 --> currentyear-02-15
17760 sep 12 9 --> 2009-09-12
17761 12:45 --> today 12:45
17762 22 sept 0:34 --> currentyear-09-22 0:34
17763 12 --> currentyear-currentmonth-12
17764 Fri --> nearest Friday (today or later)
17765 etc.
17767 Furthermore you can specify a relative date by giving, as the *first* thing
17768 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17769 change in days weeks, months, years.
17770 With a single plus or minus, the date is relative to today. With a double
17771 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17772 +4d --> four days from today
17773 +4 --> same as above
17774 +2w --> two weeks from today
17775 ++5 --> five days from default date
17777 The function understands only English month and weekday abbreviations,
17778 but this can be configured with the variables `parse-time-months' and
17779 `parse-time-weekdays'.
17781 While prompting, a calendar is popped up - you can also select the
17782 date with the mouse (button 1). The calendar shows a period of three
17783 months. To scroll it to other months, use the keys `>' and `<'.
17784 If you don't like the calendar, turn it off with
17785 \(setq org-read-date-popup-calendar nil)
17787 With optional argument TO-TIME, the date will immediately be converted
17788 to an internal time.
17789 With an optional argument WITH-TIME, the prompt will suggest to also
17790 insert a time. Note that when WITH-TIME is not set, you can still
17791 enter a time, and this function will inform the calling routine about
17792 this change. The calling routine may then choose to change the format
17793 used to insert the time stamp into the buffer to include the time.
17794 With optional argument FROM-STRING, read from this string instead from
17795 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17796 the time/date that is used for everything that is not specified by the
17797 user."
17798 (require 'parse-time)
17799 (let* ((org-time-stamp-rounding-minutes
17800 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
17801 (org-dcst org-display-custom-times)
17802 (ct (org-current-time))
17803 (def (or default-time ct))
17804 (defdecode (decode-time def))
17805 (dummy (progn
17806 (when (< (nth 2 defdecode) org-extend-today-until)
17807 (setcar (nthcdr 2 defdecode) -1)
17808 (setcar (nthcdr 1 defdecode) 59)
17809 (setq def (apply 'encode-time defdecode)
17810 defdecode (decode-time def)))))
17811 (calendar-move-hook nil)
17812 (view-diary-entries-initially nil)
17813 (view-calendar-holidays-initially nil)
17814 (timestr (format-time-string
17815 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17816 (prompt (concat (if prompt (concat prompt " ") "")
17817 (format "Date+time [%s]: " timestr)))
17818 ans (org-ans0 "") org-ans1 org-ans2 final)
17820 (cond
17821 (from-string (setq ans from-string))
17822 (org-read-date-popup-calendar
17823 (save-excursion
17824 (save-window-excursion
17825 (calendar)
17826 (calendar-forward-day (- (time-to-days def)
17827 (calendar-absolute-from-gregorian
17828 (calendar-current-date))))
17829 (org-eval-in-calendar nil t)
17830 (let* ((old-map (current-local-map))
17831 (map (copy-keymap calendar-mode-map))
17832 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17833 (org-defkey map (kbd "RET") 'org-calendar-select)
17834 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17835 'org-calendar-select-mouse)
17873 ;; org-ans0: from prompt
17874 ;; org-ans1: from mouse click
17875 ;; org-ans2: from calendar motion
17903 "Display the currrent date prompt interpretation in the minibuffer."
17919 org-time-stamp-custom-formats
17920 org-time-stamp-formats))
17929 org-end-time-was-given
17936 "Analyze the combined answer of the date prompt."
17937 ;; FIXME: cleanup and comment
17939 hour minute second wday pm h2 m2 tl wday1)
17947 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17957 t nil ans)))
17958 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17959 ;; If there is a time with am/pm, and *no* time without it, we convert
17960 ;; so that matching will be successful.
17974 t t ans))))
17976 ;; Check if a time range is given as a duration
17977 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17985 ;; Check if there is a time range
18019 ;; Weekday was given, but no day, so pick that day in the week
18020 ;; on or after the derived date.
18034 "Check string S for special relative date string.
18035 TODAY and DEFAULT are internal times, for today and for a default.
18036 Return shift list (N what def-flag)
18038 N is the number of WHATs to shift.
18039 DEF-FLAG is t when a double ++ or -- indicates shift relative to
18040 the DEFAULT date rather than TODAY."
18049 ?+))
18056 delta)
18066 "Eval FORM in the calendar window and return to current window.
18067 Also, store the cursor date in variable org-ans2."
18078 ; ;; Update the prompt to show new default date
18079 ; (save-excursion
18080 ; (goto-char (point-min))
18081 ; (when (and org-ans2
18082 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
18083 ; (get-text-property (match-end 0) 'field))
18084 ; (let ((inhibit-read-only t))
18085 ; (replace-match (concat "[" org-ans2 "]") t t)
18086 ; (add-text-properties (point-min) (1+ (match-end 0))
18087 ; (text-properties-at (1+ (point-min)))))))))
18090 "Return to `org-read-date' with the date currently selected.
18091 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18100 "Insert a date stamp for the date given by the internal TIME.
18101 WITH-HM means, use the stamp format that includes the time of the day.
18102 INACTIVE means use square brackets instead of angular ones, so that the
18103 stamp will not contribute to the agenda.
18104 PRE and POST are optional strings to be inserted before and after the
18105 stamp.
18106 The command returns the inserted time stamp."
18108 stamp)
18125 stamp))
18128 "Toggle the use of custom time stamp formats."
18149 "Overlay modified time stamp format over timestamp between BED and END."
18176 "Translate all timestamps in STRING to custom format.
18177 But do this only if the variable `org-display-custom-times' is set."
18182 t1 with-hm inactive tf time str beg end)
18191 org-time-stamp-custom-formats)
18200 string)
18203 "Set 0 instead of nil for the first 6 elements of time.
18204 Don't touch the rest."
18209 "Difference between TIMESTAMP-STRING and now in days."
18214 "Is the time in TIMESTAMP-STRING close to the current date?"
18220 "Get the deadline lead time appropriate for timestring TS."
18223 ;; 0 or negative, enforce this value no matter what
18226 ;; lead time is specified.
18231 ;; go for the default.
18235 "Return to `org-read-date' with the date currently selected.
18236 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18246 "Check if there are any deadlines due or past due.
18247 A deadline is considered due if it happens within `org-deadline-warning-days'
18248 days from today's date. If the deadline appears in an entry marked DONE,
18249 it is not shown. The prefix arg NDAYS can be used to test that many
18264 org-warn-days)))
18267 "Check if there are deadlines or scheduled entries before DATE."
18281 "Evaluate a time range by computing the difference between start and end.
18282 Normally the result is just printed in the echo area, but with prefix arg
18283 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18284 If the time range is actually in a table, the result is inserted into the
18285 next column.
18286 For time difference computation, a year is assumed to be exactly 365
18287 days in order to avoid rounding problems."
18307 ;; (ys (floor (* 365 24 60 60)))
18315 y d h m align)
18318 y 0
18323 y 0
18361 "Convert a time stamp to an absolute day number.
18362 If there is a specifyer for a cyclic time stamp, get the closest date to
18363 DAYNR."
18367 daynr
18372 prefer))
18376 "Return the time corresponding to date D.
18377 D may be an absolute day number, or a calendar-type list (month day year)."
18382 "List of holidays, for Diary display in Org-mode."
18390 "Process a SEXP diary ENTRY for DATE."
18410 "Get iCalendar entries from diary entries in buffer FROMBUF.
18411 This uses the icalendar.el library."
18414 temporary-file-directory))
18417 buf rtn b e)
18433 rtn))
18436 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18437 When PREFER is `past' return a date that is either CURRENT or past.
18438 When PREFER is `future', return a date that is either CURRENT or future."
18439 ;; Make the proper lists from the dates
18442 dn dw sday cday n1 n2
18443 d m y y1 y2 date1 date2 nmonths nm ny m2)
18448 current
18472 ;; approx number of month between the tow dates
18474 ;; How often does dn fit in there?
18503 "Turn any specification of DATE into a gregorian date for the calendar."
18513 "Parse the standard Org-mode time string.
18514 This should be a lot faster than the normal `parse-time-string'.
18515 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18516 hour and minute fields will be nil if not given."
18526 nil nil nil)
18530 "Increase the date item at the cursor by one.
18531 If the cursor is on the year, change the year. If it is on the month or
18532 the day, change that.
18533 With prefix ARG, change by that many units."
18538 "Decrease the date item at the cursor by one.
18539 If the cursor is on the year, change the year. If it is on the month or
18540 the day, change that.
18541 With prefix ARG, change by that many units."
18546 "Increase the date in the time stamp by one day.
18547 With prefix ARG, change that many days."
18555 "Decrease the date in the time stamp by one day.
18556 With prefix ARG, change that many days."
18569 "Determine if the cursor is in or at a timestamp."
18595 ans))
18598 "Toggle the type (<active> or [inactive]) of a time stamp."
18610 "Change the date in the time stamp at point.
18611 The date will be changed by N times WHAT. WHAT can be `day', `month',
18612 `year', `minute', `second'. If WHAT is not given, the cursor position
18613 in the timestamp determines what will be changed."
18615 with-hm inactive
18617 org-ts-what
18618 extra rem
18619 ts time time0)
18625 org-display-custom-times
18635 ts)
18669 ;; Try to recenter the calendar window, if any
18675 ;; FIXME: does not yet work for lead times
18677 "Change the different parts of the lead-time and repeat fields in timestamp."
18679 ng h m new)
18680 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18701 new
18703 s))
18706 "If the calendar is visible, recenter it to DATE."
18717 "Go to the Emacs calendar at the current date.
18718 If there is a time stamp in the current line, go to that date.
18719 A prefix ARG can be used to force the current date."
18738 "Return a list (month day year) of date at point in calendar."
18744 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18745 If there is already a time stamp at the cursor position, update it."
18755 ;;;###autoload
18757 "Activate appointments found in `org-agenda-files'.
18759 appointements.
18761 If FILTER is t, interactively prompt the user for a regular
18762 expression, and filter out entries that don't match it.
18764 If FILTER is a string, use this string as a regular expression
18765 for filtering entries out.
18767 FILTER can also be an alist with the car of each cell being
18768 either 'headline or 'category. For example:
18773 will only add headlines containing IMPORTANT or headlines
18786 ;; Get all entries which may contain an appt
18793 ;; Map thru entries and find if we should filter them out
18806 ;; FIXME: Shall we remove text-properties for the appt text?
18807 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18821 ;;; The clock for measuring work time.
18846 "Start the clock on the current item.
18847 If necessary, clock-out of the currently active clock."
18855 org-clock-in-switch-to-state
18882 "Find the location where the next clock line should be inserted."
18888 first last)
18892 ;; we seem to have a CLOCK drawer, so go there.
18895 ;; Lets count the CLOCK lines
18903 ;; Wrap current entries into a new drawer
18921 ;; Planning info, skip to after it
18933 "Stop the currently running clock.
18934 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18971 "Cancel the running clock be removing the start timestamp."
18985 "Go to the currently clocked-in entry."
19002 "Sum the times for each subtree.
19003 Puts the resulting times in minutes as a text property on each headline."
19007 org-clock-string
19013 ts te dt
19014 time)
19021 ;; Two time stamps
19033 ;; A naket time
19050 "Show subtree times in the entire buffer.
19051 If TOTAL-ONLY is non-nil, only show the total time for the entire file
19052 in the echo area."
19069 ;; Arrange to remove the overlays upon next change.
19079 "Put an overlays on the current line, displaying TIME.
19080 If LEVEL is given, prefix time with a corresponding number of stars.
19081 This creates a new overlay and stores it in `org-clock-overlays', so that it
19082 will be easy to remove."
19086 ov tx)
19105 "Remove the occur highlights from the buffer.
19106 BEG and END are ignored. If NOREMOVE is nil, remove this function
19107 from the `before-change-functions' in the current buffer."
19117 "Clock out if the current entry contains the running clock.
19118 This is used to stop the clock after a TODO entry is marked DONE,
19119 and is only done if the variable `org-clock-out-when-done' is not nil."
19125 org-clock-marker))
19126 ;; Clock out, but don't accept a logging message for this.
19134 "Check if the current buffer contains the running clock.
19135 If yes, offer to stop it and to save the buffer with the changes."
19144 "Create a table containing a report about clocked time.
19145 If the cursor is inside an existing clocktable block, then the table
19146 will be updated. If not, a new clocktable will be inserted.
19147 When called with a prefix argument, move to the first clock table in the
19148 buffer and update it."
19161 "Check if the cursor is in a clocktable."
19169 start))))
19172 "If this is a CLOCK line, update it and return t.
19173 Otherwise, return nil."
19182 ts te h m s)
19184 nil
19198 t)))))
19201 "Return two times bordering a special time range.
19202 Key is a symbol specifying the range and can be one of `today', `yesterday',
19203 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
19204 A week starts Monday 0:00 and ends Sunday 24:00.
19205 The range is determined relative to TIME. TIME defaults to the current time.
19206 The return value is a cons cell with two internal times like the ones
19207 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
19208 the returned times will be formatted strings."
19213 s1 m1 h1 d1 month1 y1 diff ts te fm)
19243 "Write the standard clocktable."
19258 ipos time h m p level hlc hdl
19259 cc beg end pos tbl)
19273 ;; Get the right scope
19296 file)
19306 org-clock-file-total-minutes)))))))
19317 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19338 "Clock summary at ["
19342 "]."
19355 "|"
19356 "*Total time*| "
19378 cc)
19412 x))
19413 lines)
19416 ;; FIXME: I don't think anybody uses this, ask David
19418 "Return an internal list with clocking information.
19419 This list has one entry for each CLOCK interval.
19420 FIXME: describe the elements."
19424 rtn beg end next cont level title total closedp leafp
19425 clockpos titlepos h m donep)
19450 total title titlepos level leafp)
19451 rtn)
19455 ;;;; Agenda, and Diary Integration
19457 ;;; Define the Org-agenda-mode
19472 "Mode for time-sorted view on action items in Org-mode files.
19474 The following commands are available:
19480 org-agenda-pending-undo-list nil)
19482 ;; Keep global-font-lock-mode from turning on font-lock-mode
19490 ;; Make sure properties are removed when copying text
19495 buffer-substring-filters)))
19498 org-agenda-show-log nil))
19505 "Restricted to single file"
19517 org-agenda-mode-map global-map)
19620 "--"
19627 "--"
19631 "--"
19636 "--"
19641 "--"
19646 "--"
19663 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19667 "--"
19669 "--"
19679 "--"
19681 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19685 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19689 "--"
19691 "--"
19694 ))
19696 ;;; Agenda undo
19708 "Execute BODY if there is no `org-protected' text property at point."
19714 "Execute BODY while recording undo information in two buffers."
19722 _c1 _c2)
19723 ,@_body
19730 ;; make sure there are undo boundaries
19733 ;; remember which buffer to undo
19735 org-agenda-undo-list)))))
19738 "Undo a remote editing step in the agenda.
19739 This undoes changes both in the agenda buffer and in the remote buffer
19740 that have been changed along."
19746 org-agenda-pending-undo-list org-agenda-undo-list))
19750 buf line cmd rembuf)
19772 "Verify that a real change occurred between the undo lists L1 and L2."
19777 ;;; Agenda dispatch
19785 ;;;###autoload
19787 "Dispatch agenda commands to collect entries to the agenda buffer.
19788 Prompts for a command to execute. Any prefix arg will be passed
19789 on to the selected command. The default selections are:
19791 a Call `org-agenda-list' to display the agenda for current day or week.
19792 t Call `org-todo-list' to display the global todo list.
19793 T Call `org-todo-list' to display the global todo list, select only
19794 entries with a specific TODO keyword (the user gets a prompt).
19795 m Call `org-tags-view' to display headlines with tags matching
19796 a condition (the user is prompted for the condition).
19797 M Like `m', but select only TODO entries, no ordinary headlines.
19798 L Create a timeline for the current buffer.
19799 e Export views to associated files.
19801 More commands can be added by configuring the variable
19802 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19803 searches can be pre-defined in this way.
19805 If the current buffer is in Org-mode and visiting a file, you can also
19806 first press `<' once to indicate that the agenda should be temporarily
19808 Pressing `<' twice means to restrict to the current subtree or region
19809 \(if active)."
19815 ;; normalize different versions
19821 nil)
19825 org-agenda-custom-commands)))
19828 entry key type match lprops ans)
19829 ;; Turn off restriction unless there is an overriding one
19835 ;; Delete old local properties
19837 ;; Remember where this call originated
19843 ;; Estabish the restriction, if any
19860 ;; For example the todo list should not need it (but does...)
19876 current-prefix-arg)))
19929 cmds)))
19932 "The user interface for selecting an agenda command."
19939 restriction second-time
19940 c entry key type match prefixes rmheader header-end custom1 desc)
19947 "
19948 Press key for an agenda command: < Buffer,subtree/region restriction
19949 -------------------------------- > Remove restriction
19950 a Agenda for current week or day e Export agenda views
19951 t List of all TODO entries T Entries with special TODO kwd
19952 m Match a TAGS query M Like m, but only TODO entries
19953 L Timeline for current buffer # List stuck projects (!=configure)
19954 s Search for keywords C Configure custom agenda commands
19955 / Multi-occur
19960 header start)
19964 header)))
20017 prefix-descriptions))
20019 prefixes))
20030 " (restriction lock active)"
20043 prefixes nil
20049 nil
20051 custom))))
20068 nil)
20088 match ;; The byte compiler incorrectly complains about this. Keep it!
20089 cmd type lprops)
20123 ;;;###autoload
20125 "Run an agenda command in batch mode and send the result to STDOUT.
20126 If CMD-KEY is a string of length 1, it is used as a key in
20127 `org-agenda-custom-commands' and triggers this command. If it is a
20128 longer string it is used as a tags/todo match string.
20129 Paramters are alternating variable names and values that will be bound
20130 before running the agenda command."
20144 string))
20148 ;;;###autoload
20150 "Run an agenda command in batch mode and send the result to STDOUT.
20151 If CMD-KEY is a string of length 1, it is used as a key in
20152 `org-agenda-custom-commands' and triggers this command. If it is a
20153 longer string it is used as a tags/todo match string.
20154 Paramters are alternating variable names and values that will be bound
20155 before running the agenda command.
20157 The output gives a line for each selected agenda item. Each
20158 item is a list of comma-separated values, like this:
20160 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
20162 category The category of the item
20163 head The headline, without TODO kwd, TAGS and PRIORITY
20164 type The type of the agenda entry, can be
20165 todo selected in TODO match
20166 tagsmatch selected in tags match
20167 diary imported from diary
20168 deadline a deadline on given date
20169 scheduled scheduled on given date
20170 timestamp entry has timestamp on given date
20171 closed entry was closed on given date
20172 upcoming-deadline warning about deadline
20173 past-scheduled forwarded scheduled item
20174 block entry has date block including g. date
20175 todo The todo keyword, if any
20176 tags All tags including inherited ones, separated by colons
20177 date The relevant date, like 2007-2-14
20178 time The time, like 15:00-16:50
20179 extra Sting with extra planning info
20180 priority-l The priority letter if any was given
20181 priority-n The computed numerical priority
20182 agenda-day The day in the agenda where this is listed"
20194 line)
20204 priority-letter priority agenda-day)
20209 "Make sure all properties on an agenda item have a canonical form,
20210 so the export commands can easily use it."
20237 props)
20251 ;;;###autoload
20256 ;; FIXME, why is this a macro?????
20257 ;;;###autoload
20259 "Run all custom agenda commands that have a file argument."
20263 pars cmd thiscmdkey files opts)
20286 "Write the current buffer (an agenda view) as a file.
20287 Depending on the extension of the file name, plain text (.txt),
20288 HTML (.html or .htm) or Postscript (.ps) is produced.
20289 If NOSETTINGS is given, do not scope the settings of
20290 `org-agenda-exporter-settings' into the export commands. This is used when
20291 the settings have already been scoped and we do not wish to overrule other,
20292 higher priority settings."
20308 ;; replace <style> section with org-agenda-export-html-style
20329 "Inhibit read-only for BODY."
20333 "Make sure current buffer is in org-mode. Error if not."
20336 major-mode)))
20339 "Fit the window to the buffer size."
20343 nil
20347 ;;; Agenda file list
20350 "Get the list of agenda files.
20351 Optional UNRESTRICTED means return the full list even if a restriction
20352 is currently in place."
20363 org-agenda-file-regexp)
20365 files)))
20371 files))
20375 "Edit the list of agenda files.
20376 Depending on setup, this either uses customize to edit the variable
20377 `org-agenda-files', or it visits the file that is holding the list. In the
20378 latter case, the buffer is set up in a way that saving it automatically kills
20379 the buffer and restores the previous window configuration."
20398 "Set new value for the agenda file list and save it correcly."
20409 "Read the list of agenda files from a file."
20416 ;;;###autoload
20418 "Cycle through the files in `org-agenda-files'.
20419 If the current buffer visits an agenda file, find the next one in the list.
20420 If the current buffer does not, find the first agenda file."
20425 file)
20437 "Move/add the current file to the top of the agenda file list.
20438 If the file is not present in the list, it is added to the front. If it is
20439 present, it is moved there. With optional argument TO-END, add/move to the
20440 end of the list."
20447 x had)
20460 "Remove current file from the list of files in variable `org-agenda-files'.
20461 These are the files which are being checked for agenda entries.
20462 Optional argument FILE means, use this file instead of the current."
20472 nil x))
20485 "Make sure FILE exists. If not, ask user what to do."
20496 ;;; Agenda prepare and finalize
20541 "Finishing touch for the agenda buffer, called just before displaying it."
20553 org-overriding-columns-format)
20555 org-overriding-columns-format))
20557 org-agenda-view-columns-initially)
20563 )))
20566 "Make highest priority lines bold, and lowest italic."
20573 b e p ov h l)
20577 org-highest-priority)
20579 org-lowest-priority)
20584 ov 'face
20592 "Create buffers for all agenda files, protect archived trees and comments."
20599 bmp file re)
20629 "Function to be called at each match during agenda construction.
20630 If this function returns nil, the current match should not be skipped.
20631 Otherwise, the function must return a position from where the search
20632 should be continued.
20633 This may also be a Lisp form, it will be evaluated.
20634 Never set this variable using `setq' or so, because then it will apply
20635 to all future agenda commands. Instead, bind it with `let' to scope
20636 it dynamically into the agenda-constructing command. A good way to set
20640 "Throw to `:skip' in places that should be skipped.
20641 Also moves point to the end of the skipped region, so that search can
20642 continue from there."
20668 "Return a new agenda marker.
20669 Org-mode keeps a list of these markers and resets them when they are
20670 no longer in use."
20674 m))
20677 "Reset markers created by `org-agenda'."
20682 "Get a buffer visiting FILE. If the buffer needs to be created, add
20683 it to the list of buffers which might be released later."
20686 buf ; just return it
20687 ;; Make a new buffer and remember it
20690 buf)))
20693 "Release all buffers in list, asking the user for confirmation when needed.
20694 When a buffer is unmodified, it is just killed. When modified, it is saved
20695 \(if the user agrees) and then killed."
20700 file
20706 "Get the category applying to position POS."
20709 ;;; Agenda timeline
20714 "Show a time-sorted view of the entries in the current org file.
20715 Only entries with a time stamp of today or later will be listed. With
20717 under the current date.
20718 If the buffer contains an active region, only check the region for
20719 dates."
20732 t doclosed ; always include today
20733 org-timeline-show-empty-dates))
20738 args
20739 s e rtn d emptyp)
20745 ;; Remove past dates from the list of dates.
20748 day-numbers))))
20765 dopast
20766 past)
20774 date args)))
20797 "Return a list of all relevant day numbers from BEG to END buffer positions.
20798 If NO-RANGES is non-nil, include only the start and end dates of a range,
20799 not every single day in the range. If FORCE-TODAY is non-nil, make
20800 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20801 inactive time stamps (those in square brackets) are included.
20802 When EMPTY is non-nil, also include days without any entries."
20806 dates dates1 date day day1 day2 ts1 ts2)
20836 dates)))
20838 ;;; Agenda Daily/Weekly
20849 ;;;###autoload
20851 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20852 The view will be for the current day or week, but from the overview buffer
20853 you will be able to go to other days/weeks.
20856 all unfinished TODO items will also be shown, before the agenda.
20857 This feature is considered obsolete, please use the TODO list or a block
20858 agenda instead.
20860 With a numeric prefix argument in an interactive call, the agenda will
20861 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20862 the number of days. NDAYS defaults to `org-agenda-ndays'.
20864 START-DAY defaults to TODAY, or to the most recent match for the weekday
20865 given in `org-agenda-start-on-weekday'."
20876 ;; Convert to an absolute day number
20884 org-agenda-start-on-weekday nil))
20893 sd
20902 s e rtn rtnall file date d start-pos end-pos todayp nd)
20905 ;; Make the list of days
20907 nd ndays)
20920 rtnall nil)
20948 rtnall nil)
20954 file date
20957 file date
20981 rtnall nd todayp))
21004 ;;; Agenda word search
21008 ;;;###autoload
21010 "Show all entries that contain words or regular expressions.
21011 If the first character of the search string is an asterisks,
21012 search only the headlines.
21015 The individual words are then interpreted as a boolean expression with
21016 logical AND. Words prefixed with a minus must not occur in the entry.
21017 Words without a prefix or prefixed with a plus must occur in the entry.
21018 Matching is case-insensitive and the words are enclosed by word delimiters.
21020 Words enclosed by curly braces are interpreted as regular expressions
21021 that must or must not match in the entry.
21023 This command searches the agenda files, and in addition the files listed
21024 in `org-agenda-text-search-extra-files'."
21031 'org-not-done-regexp org-not-done-regexp
21032 'org-todo-regexp org-todo-regexp
21034 'keymap org-agenda-keymap
21036 regexp rtn rtnall files file pos
21037 marker priority category tags c neg re
21067 words)
21073 regexp))))
21075 rtnall nil)
21084 ;; If file does not exist, make sure an error message is sent
21086 file))))
21095 org-agenda-restrict-end)
21117 regexps-)
21121 regexps+)
21127 ""
21130 category tags))
21161 ;;; Agenda TODO list
21166 ;;;###autoload
21168 "Show all TODO entries from all agenda file in a single list.
21169 The prefix arg can be used to select a specific TODO keyword and limit
21171 for a keyword. A numeric prefix directly selects the Nth keyword in
21172 `org-todo-keywords-1'."
21186 rtn rtnall files file pos)
21196 rtnall nil)
21220 kwds))
21231 ;;; Agenda tags match
21233 ;;;###autoload
21235 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
21236 The prefix arg TODO-ONLY limits the search to TODO entries."
21243 rtn rtnall files file pos matcher
21244 buffer)
21252 rtnall nil)
21260 ;; If file does not exist, merror message to agenda
21271 org-agenda-restrict-end)
21296 ;;; Agenda Finding stuck projects
21299 "Regular expression used in skipping subtrees for the agenda.
21300 This is basically a temporary global variable that can be set and then
21307 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
21308 If yes, it returns the end position of this tree, causing agenda commands
21309 to skip this subtree. This is a function that can be put into
21310 `org-agenda-skip-function' for the duration of a command."
21312 skip)
21318 "Skip entry if any of CONDITIONS is true.
21319 See `org-agenda-skip-if' for details."
21323 "Skip entry if any of CONDITIONS is true.
21324 See `org-agenda-skip-if' for details."
21328 "Checks current entity for CONDITIONS.
21329 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
21330 the entry, i.e. the text before the next heading is checked.
21332 CONDITIONS is a list of symbols, boolean OR is used to combine the results
21333 from different tests. Valid conditions are:
21335 scheduled Check if there is a scheduled cookie
21336 notscheduled Check if there is no scheduled cookie
21337 deadline Check if there is a deadline
21338 notdeadline Check if there is no deadline
21339 regexp Check if regexp matches
21340 notregexp Check if regexp does not match.
21342 The regexp is taken from the conditions list, it must come right after
21343 the `regexp' or `notregexp' element.
21345 If any of these conditions is met, this function returns the end point of
21346 the entity, causing the search to continue from there. This is a function
21347 that can be put into `org-agenda-skip-function' for the duration of a command."
21371 end)))
21373 ;;;###autoload
21375 "Create agenda view for projects that are stuck.
21376 Stuck projects are project that have no next actions. For the definitions
21377 of what a project is and how to check if it stuck, customize the variable
21378 `org-stuck-projects'.
21379 MATCH is being ignored."
21382 ;; FIXME: we could have used org-agenda-skip-if here.
21390 org-done-keywords-for-agenda
21392 todo))
21409 gen-re)))))
21420 ;;; Diary integration
21425 "Get the (Emacs Calendar) diary entries for DATE."
21433 entries
21445 ;; No entries
21447 ;; Omit the date and other unnecessary stuff
21449 ;; Add prefix to each line and extend the text properties
21461 ;; Extend the text properties to the beginning of the line
21464 entries)))))
21467 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21468 This gets rid of the date, the underline under the date, and
21469 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21470 date. It also removes lines that contain only whitespace."
21487 ;; Make sure entries from the diary have the right text properties.
21490 ;; We can rely on the hook, nothing to do
21491 nil
21492 ;; Hook not avaiable, must use advice to make this work
21494 "Make the position visible."
21497 buffer-file-name)
21501 "Add text properties to string, allowing org-mode to act on it."
21504 'keymap org-agenda-keymap
21509 'org-agenda-diary-link t
21513 "Add a dummy entry to the diary.
21514 Needed to avoid empty dates which mess up holiday display."
21515 ;; Catch the error if dealing with the new add-to-diary-alist
21522 ;;;###autoload
21524 "Return diary information from org-files.
21526 It accesses org files and extracts information from those files to be
21527 listed in the diary. The function accepts arguments specifying what
21528 items should be listed. The following arguments are allowed:
21530 :timestamp List the headlines of items containing a date stamp or
21531 date range matching the selected date. Deadlines will
21532 also be listed, on the expiration day.
21534 :sexp List entries resulting from diary-like sexps.
21536 :deadline List any deadlines past due, or due within
21537 `org-deadline-warning-days'. The listing occurs only
21538 in the diary for *today*, not at any other date. If
21539 an entry is marked DONE, it is no longer listed.
21541 :scheduled List all items which are scheduled for the given date.
21542 The diary for *today* also contains items which were
21543 scheduled earlier and are not yet marked DONE.
21545 :todo List all TODO items from the org-file. This may be a
21546 long list - so this is not turned on by default.
21547 Like deadlines, these entries only show up in the
21548 diary for *today*, not at any other date.
21550 The call in the diary file should look like this:
21552 &%%(org-diary) ~/path/to/some/orgfile.org
21554 Use a separate line for each org file to check. Or, if you omit the file name,
21555 all files listed in `org-agenda-files' will be checked automatically:
21557 &%%(org-diary)
21559 If you don't give any arguments (as in the example above), the default
21560 arguments (:deadline :scheduled :timestamp :sexp) are used.
21561 So the example above may also be written as
21563 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21565 The function expects the lisp variables `entry' and `date' to be provided
21566 by the caller, because this is how the calendar works. Don't use this
21567 function from a program - use `org-agenda-get-day-entries' instead."
21569 org-agenda-last-marker-time)
21578 file rtn results)
21580 ;; If this is called during org-agenda, don't return any entries to
21581 ;; the calendar. Org Agenda will list these entries itself.
21589 ;;; Agenda entry finders
21592 "Does the work for `org-diary' and `org-agenda'.
21593 FILE is the path to a file to be checked for entries. DATE is date like
21594 the one returned by `calendar-current-date'. ARGS are symbols indicating
21595 which kind of entries should be extracted. For details about these, see
21596 the documentation of `org-diary'."
21603 arg results rtn)
21605 ;; If file does not exist, make sure an error message ends up in diary
21615 org-agenda-restrict-end)
21617 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21641 results))))
21657 "Is the cursor inside a date range?"
21672 nil)))
21675 "Return the TODO information for agenda display."
21678 'org-not-done-regexp org-not-done-regexp
21679 'org-todo-regexp org-todo-regexp
21681 'keymap org-agenda-keymap
21682 'help-echo
21685 ;; FIXME: get rid of the \n at some point but watch out
21689 org-todo-regexp
21693 org-not-done-regexp)
21695 marker priority category tags
21696 ee txt beg end)
21735 "Return the date stamp information for agenda display."
21737 'org-not-done-regexp org-not-done-regexp
21738 'org-todo-regexp org-todo-regexp
21740 'keymap org-agenda-keymap
21741 'help-echo
21749 "<%Y-%m-%d"
21763 marker hdmarker deadlinep scheduledp donep tmp priority category
21764 ee txt timestr tags b0 b3 e3 head)
21782 b0)
21789 ;; substring should only run to end of time stamp
21801 nil head category tags timestr nil
21802 remove-re)))
21815 "Return the sexp information for agenda display."
21819 'keymap org-agenda-keymap
21820 'help-echo
21824 marker category ee txt tags entry result beg b sexp sexp-entry)
21856 "Return the logged TODO entries for agenda display."
21858 'org-not-done-regexp org-not-done-regexp
21859 'org-todo-regexp org-todo-regexp
21860 'keymap org-agenda-keymap
21861 'help-echo
21873 marker hdmarker priority category tags closedp
21874 ee txt timestr)
21883 ;; donep (org-entry-is-done-p)
21884 )
21886 ;; substring should only run to end of time stamp
21910 "Return the deadline information for agenda display."
21912 'org-not-done-regexp org-not-done-regexp
21913 'org-todo-regexp org-todo-regexp
21914 'keymap org-agenda-keymap
21915 'help-echo
21921 d2 diff dfrac wdays pos pos1 category tags
21922 ee txt head face s upcomingp donep timestr)
21934 ;; When to show a deadline in the calendar:
21935 ;; If the expiration is within wdays warning time.
21936 ;; Past-due deadlines are only shown on the current date
21964 diff))
21965 head category tags timestr))))
21974 'org-category category
21983 "Return the face to displaying a deadline item.
21984 FRACTION is what fraction of the head-warning time has passed."
21992 "Return the scheduled information for agenda display."
21994 'org-todo-regexp org-todo-regexp
21997 'keymap org-agenda-keymap
21998 'help-echo
22004 d2 diff pos pos1 category tags
22005 ee txt head pastschedp donep face timestr s)
22013 ;;; is this right?
22014 ;;; do we need to do this for deadleine too????
22015 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
22018 ;; When to show a scheduled item in the calendar:
22019 ;; If it is on or past the date.
22047 head category tags timestr))))
22051 'org-scheduled-previously
22054 'undone-face face
22066 "Return the date-range information for agenda display."
22068 'org-not-done-regexp org-not-done-regexp
22069 'org-todo-regexp org-todo-regexp
22071 'keymap org-agenda-keymap
22072 'help-echo
22077 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
22078 donep head)
22090 ;; Only allow days between the limits, because the normal
22091 ;; date stamps will catch the limits.
22108 head category tags
22117 ;; Sort the entries by expiration date.
22120 ;;; Agenda presentation and sorting
22130 "Regular expression to match a plain time or time range.
22131 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22132 groups carry important information:
22133 0 the full match
22134 1 the first time, range or not
22142 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
22143 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
22144 groups carry important information:
22145 0 the full match
22146 7 hours of duration
22155 "Regular expression to match a timestamp time or time range.
22156 After a match, the following groups carry important information:
22157 0 the full match
22158 1 date plus weekday, for backreferencing to make sure both times on same day
22159 2 the first time, range or not
22163 "A flag, set by `org-compile-prefix-format'.
22166 "A flag, set by `org-compile-prefix-format'.
22170 noprefix remove-re)
22171 "Format TXT to be inserted into the agenda buffer.
22172 In particular, it adds the prefix and corresponding text properties. EXTRA
22173 must be a string and replaces the `%s' specifier in the prefix format.
22174 CATEGORY (string, symbol or nil) may be used to overrule the default
22175 category taken from local variable or file name. It will replace the `%c'
22176 specifier in the format. DOTIME, when non-nil, indicates that a
22177 time-of-day should be extracted from TXT for sorting of this entry, and for
22178 the `%t' specifier in the format. When DOTIME is a string, this string is
22179 searched for a time before TXT is. NOPREFIX is a flag and indicates that
22180 only the correctly processes TXT should be returned - this is used by
22181 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
22182 Any match of REMOVE-RE will be removed from TXT."
22184 ;; Diary entries sometimes have extra whitespace at the beginning
22187 org-category
22193 time ; time and tag are needed for the eval of the prefix format
22196 stamp plain s0 s1 s2 rtn srp)
22198 ;; Extract starting and ending time and move them to prefix
22206 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
22207 ;; them, we might want to remove them there to avoid duplication.
22208 ;; The user can turn this off with a variable.
22214 t))
22216 ;; Normalize the time(s) to 24 hour
22224 org-agenda-default-appointment-duration))
22225 h)
22230 txt)
22231 ;; Tags are in the string
22234 org-prefix-has-tag))
22239 t t txt))))
22245 ;; Create the final string
22248 ;; Prepare the variables needed in the eval of the compiled format
22254 ;; Evaluate the compiled format
22257 ;; And finally add the text properties
22260 'org-highest-priority org-highest-priority
22261 'org-lowest-priority org-lowest-priority
22263 'time-of-day time-of-day
22264 'txt txt
22265 'time time
22266 'extra extra
22281 list)))
22286 new time)
22288 ;; don't show empty grid
22294 nil string "" nil
22296 new)
22304 "Compile the prefix format into a Lisp form that can be evaluated.
22305 The resulting form is returned and stored in the variable
22306 `org-prefix-format-compiled'."
22310 org-agenda-prefix-format)
22315 varform vars var e c f opt)
22317 s start)
22330 ""
22340 ;; the old format
22348 "Check string S for a time of day.
22349 If found, return it as a military time number between 0 and 2400.
22350 If not found, return nil.
22351 The optional STRING argument forces conversion into a 5 character wide string
22352 HH:MM."
22374 "Sort and concatenate the agenda items."
22377 list
22402 x)
22406 " "
22408 x)))
22411 "Compare the priorities of string A and B."
22419 "Compare the string values of categories of strings A and B."
22427 "Compare the string values of categories of strings A and B."
22437 "Compare the time-of-day values of strings A and B."
22446 "Predicate for sorting agenda entries."
22447 ;; The following variables will be used when the form is evaluated.
22448 ;; So even though the compiler complains, keep them.
22462 ;;; Agenda restriction lock
22480 "Set restriction lock for agenda, to current subtree or file.
22481 Restriction will be the file if TYPE is `file', or if type is the
22482 universal prefix '(4), or if the cursor is before the first headline
22483 in the file. Otherwise, restriction will be to the current subtree."
22515 "Remove the agenda restriction lock."
22529 "If there is any window showing the agenda view, update it."
22538 org-agenda-overriding-restriction)
22541 ;;; Agenda commands
22544 "Check if agenda buffer is of allowed type.
22545 If ERROR is non-nil, throw an error, otherwise just return nil."
22547 t
22550 nil)))
22553 "Exit agenda by removing the window or the buffer."
22560 ;; Maybe restore the pre-agenda window configuration.
22563 org-pre-agenda-window-conf
22567 "Exit agenda by removing the window or the buffer.
22568 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22569 Org-mode buffers visited directly by the user will not be touched."
22583 "Save all Org-mode buffers without user confirmation."
22590 "Rebuild Agenda.
22591 When this is the global TODO list, a prefix argument will be interpreted."
22600 org-agenda-pending-undo-list nil)
22606 "Manipulate the query by adding a search term with positive selection.
22607 Positive selection means, the term must be matched for selection of an entry."
22611 "Manipulate the query by adding a search term with negative selection.
22612 Negative selection means, term must not be matched for selection of an entry."
22616 "Manipulate the query by adding a search regexp with positive selection.
22617 Positive selection means, the regexp must match for selection of an entry."
22621 "Manipulate the query by adding a search regexp with negative selection.
22622 Negative selection means, regexp must not match for selection of an entry."
22629 'org-agenda-query-string
22636 org-agenda-query-string))
22640 org-agenda-type))))
22646 "Jump to DATE in agenda."
22651 "Go to today."
22677 "Go forward in time by thee current span.
22678 With prefix ARG, go forward that many times the current span."
22685 greg2 nd)
22707 "Go backward in time by the current span.
22708 With prefix ARG, go backward that many times the current span."
22713 "Switch to daily view for agenda."
22718 "Switch to daily view for agenda."
22723 "Switch to daily view for agenda."
22727 "Switch to daily view for agenda."
22734 "Change the agenda view to SPAN.
22735 SPAN may be `day', `week', `month', `year'."
22740 org-starting-day))
22751 "Compute starting date and number of days for agenda.
22752 SPAN may be `day', `week', `month', `year'. The return value
22753 is a cons cell with the starting date and the number of days,
22754 so that the date SD will be in that range."
22756 nd)
22773 sd)))
22779 sd))))
22782 ;; FIXME: does not work if user makes date format that starts with a blank
22784 "Jump to the next line indicating a date in agenda buffer."
22796 "Jump to the previous line indicating a date in agenda buffer."
22803 ;; Initialize the highlight
22808 "Highlight a region with overlay."
22813 "Detach overlay INDEX."
22816 ;; FIXME this is currently not used.
22825 "Toggle follow mode in an agenda buffer."
22833 "Toggle log mode in an agenda buffer."
22843 "Toggle diary inclusion in an agenda buffer."
22853 "Toggle time grid in an agenda buffer."
22863 "Set the mode name to indicate all the small mode settings."
22882 "Show the priority of the current item.
22883 This priority is composed of the main priority given with the [#A] cookies,
22884 and by additional input from the age of a schedules or deadline entry."
22890 "Show the tags applicable to the current item."
22899 "Go to the Org-mode file which contains the item at point."
22918 "Normal hook run after an item has been shown from the agenda.
22922 "Kill the entry or subtree belonging to the current agenda entry."
22955 "Kill the entry or subtree belonging to the current agenda entry."
22973 "Remove all lines in the agenda that correspond to a given subtree.
22974 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22975 If this information is not given, the function uses the tree at point."
22998 "Follow the link in the current line, if any."
23007 "Get a variable from a referenced buffer and install it here."
23014 "Go to the Org-mode file which contains the item at point."
23031 "Go to the Org-mode file which contains the item at the mouse click."
23037 "Display the Org-mode file which contains the item at point."
23044 "Display the Org-mode file which contains the item at point and recenter."
23052 "Display the Org-mode file which contains the item at the mouse click."
23058 "Check if the entry is a diary link and abort if yes."
23066 "Show the subtree corresponding to the current entry in an indirect buffer.
23067 This calls the command `org-tree-to-indirect-buffer' from the original
23068 Org-mode buffer.
23069 With numerical prefix arg ARG, go up to this level and then take that tree.
23070 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
23071 dedicated frame)."
23084 "Marker pointing to the headline that last changed its TODO state
23088 "Switch TODO entry to next sequence."
23093 "Switch TODO entry to previous sequence."
23098 "Cycle TODO state of line at point, also in Org-mode file.
23099 This changes the line at point, all other lines in the agenda referring to
23100 the same tree node, and the headline of the tree node in the Org-mode file."
23110 newhead)
23131 "Change all lines in the agenda buffer which match HDMARKER.
23132 The new content of the line will be NEWHEAD (as modified by
23133 `org-format-agenda-item'). HDMARKER is checked with
23134 `equal' against all `org-hd-marker' text properties in the file.
23135 If FIXFACE is non-nil, the face of each item is modified acording to
23136 the new TODO state."
23138 props m pl undone-face done-face finish new dotime cat tags)
23168 undone-face done-face))))
23176 "Align all tags in agenda items to `org-agenda-tags-column'."
23189 org-agenda-tags-column))
23197 "Increase the priority of line at point, also in Org-mode file."
23202 "Decrease the priority of line at point, also in Org-mode file."
23207 "Set the priority of line at point, also in Org-mode file.
23208 This changes the line at point, all other lines in the agenda referring to
23209 the same tree node, and the headline of the tree node in the Org-mode file."
23218 newhead)
23234 "Get a list of all headline tags applicable at POS.
23235 POS defaults to point. If tags are inherited, the list contains
23236 the targets in the same sequence as the headlines appear, i.e.
23237 the tags of the current headline come last."
23252 tags)))
23256 tags)))
23258 ;; FIXME: should fix the tags property of the agenda line.
23260 "Set tags for the current headline."
23271 newhead)
23289 "Toggle the archive tag for the current entry."
23298 newhead)
23314 "Change the date of this item to one day later."
23333 "Change the date of this item to one day earlier."
23338 "Show new date stamp via text properties."
23339 ;; We use text properties to make this undoable
23348 ;; Use `duplicable' property to trigger undo recording
23363 "Change the date of this item. Date is prompted for, with default today.
23364 The prefix ARG is passed to the `org-time-stamp' command and can therefore
23365 be used to request time specification in the time stamp."
23383 "Schedule the item at point."
23393 ts)
23405 "Schedule the item at point."
23414 ts)
23424 "Return the heading of the current entry, without the stars."
23434 "Start the clock on the currently selected item."
23447 "Stop the currently running clock."
23455 "Cancel the currently running clock."
23463 "Make a diary entry, like the `i' command from the calendar.
23464 All the standard commands work: block, weekly etc."
23480 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23489 ;; We implement this by hacking the `calendar-cursor-to-date' function
23490 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23506 "Execute a calendar command from the agenda, with the date associated to
23507 the cursor position."
23516 ;; the following 3 vars are needed in the calendar
23530 "Display the phases of the moon for the 3 months around the cursor date."
23535 "Display the holidays for the 3 months around the cursor date."
23540 "Display sunrise and sunset for the cursor date.
23541 Latitude and longitude can be specified with the variables
23542 `calendar-latitude' and `calendar-longitude'. When called with prefix
23543 argument, latitude and longitude will be prompted for."
23552 "Open the Emacs calendar with the date at the cursor."
23565 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23566 This is a command that has to be installed in `calendar-mode-map'."
23570 nil))
23576 date s)
23602 ;;;; Embedded LaTeX
23617 "Toggle the minor `org-cdlatex-mode'.
23618 This mode supports entering LaTeX environment and math in LaTeX fragments
23619 in Org-mode.
23621 nil " OCDL" nil
23626 "Always return t in org-mode buffers.
23627 This is because we want to insert math symbols without dollars even outside
23628 the LaTeX math segments. If Orgmode thinks that point is actually inside
23629 en embedded LaTeX fragement, let texmathp do its job.
23646 "Unconditionally turn on `org-cdlatex-mode'."
23650 "Test if point is inside a LaTeX fragment.
23652 sequence appearing also before point.
23653 Even though the matchers for math are configurable, this function assumes
23655 delimiters are skipped when they have been removed by customization.
23656 The return value is nil, or a cons cell with the delimiter and
23657 and the position of this delimiter.
23659 This function does a reasonably good job, but can locally be fooled by
23660 for example currency specifications. For example it will assume being in
23662 fragments that are properly closed, but during editing, we have to live
23663 with the uncertainty caused by missing closing delimiters. This function
23664 looks only before point, not after."
23683 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23687 ;; count $$
23695 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23696 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23697 - inside a LaTeX fragment, or
23698 - after the first word in a line, where an abbreviation expansion could
23699 insert a LaTeX environment."
23712 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23713 Revert to the normal definition outside of these fragments."
23721 "Execute `cdlatex-math-modify' in LaTeX fragments.
23722 Revert to the normal definition outside of these fragments."
23734 "Remove all overlays with LaTeX fragment images in current buffer."
23739 "Preview the LaTeX fragment at point, or all locally or globally.
23740 If the cursor is in a LaTeX fragment, create the image and overlay
23741 it over the source code. If there is no fragment at point, display
23742 all fragments in the current text, from one headline to the next. With
23743 prefix SUBTREE, display all fragments in the current subtree. With a
23744 double prefix `C-u C-u', or when the cursor is before the first headline,
23745 display all fragments in the buffer.
23775 buffer-file-name)))
23781 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23782 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23783 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23790 "Replace LaTeX fragments with links to an image, and produce images."
23799 m n block linkfile movefile ov)
23800 ;; Check if there are old images files with this prefix, and remove them
23804 todir 'full
23806 ;; Check the different regular expressions
23826 txt movefile opt forbuffer)
23834 ov 'end-glyph
23837 ov 'display
23844 ;; This function borrows from Ganesh Swami's latex2png.el
23848 temporary-file-directory))
23877 "-D" dpi
23878 ;;"-x" scale "-y" scale
23880 "-o" pngfile
23881 dvifile)
23884 ;; Use the requested file name and clean up
23888 pngfile))))
23891 "Return an rgb color specification for dvipng."
23897 "Return string to be used as color value for an RGB component."
23900 ;;;; Exporting
23902 ;;; Variables, constants, and parameter plists
23958 "Return the property list with default settings for the export variables."
23962 rtn))
23965 "Return the property list with file-local settings for export."
23972 p key val text options)
24005 o)
24009 options)
24013 p))))
24019 val)))
24020 dir))
24027 rtn line level)
24032 ;; Beginning of a COMMENT subtree. Skip it.
24038 ;; an ordinary comment line
24039 )
24045 ;; a special table line that should be removed
24046 )
24053 \[v] limit export to visible part of outline tree
24055 \[a] export as ASCII
24057 \[h] export as HTML
24058 \[H] export as HTML to temporary buffer
24059 \[R] export region as HTML
24060 \[b] export as HTML and browse immediately
24061 \[x] export as XOXO
24063 \[l] export as LaTeX
24064 \[L] export as LaTeX to temporary buffer
24066 \[i] export current file as iCalendar file
24067 \[I] export all agenda files as iCalendar files
24068 \[c] export agenda files into combined iCalendar file
24070 \[F] publish current file
24071 \[P] publish current project
24072 \[X] publish... (project will be prompted for)
24092 r1 r2 ass)
24395 )
24396 "Entities for TeX->HTML translation.
24400 The list contains HTML entities for Latin-1, Greek and other symbols.
24401 It is supplemented by a number of commonly used TeX macros with appropriate
24404 ;;; General functions for all backends
24407 "Cleanup a buffer STRING so that links can be created safely."
24425 a b xx
24426 rtn p)
24430 ;; Remove license-to-kill stuff
24438 ;; Get rid of drawers
24443 'identity
24451 ;; Get the correct stuff before the first headline
24462 ;; Get rid of archived trees
24474 ;; Find targets in comments and move them out of comments,
24475 ;; but mark them as targets that should be invisible
24480 ;; Protect backend specific stuff, throw away the others.
24485 fmt)
24516 ;; Protect quoted subtrees
24524 ;; Protect verbatim elements
24531 ;; Remove subtrees that are commented
24537 ;; Remove special table lines
24549 ;; Specific LaTeX stuff
24557 ;; Specific HTML stuff
24559 ;; Convert LaTeX fragments to images
24564 org-current-export-file)))
24568 ;; Remove or replace comments
24577 ;; Find matches for radio targets and turn them into internal links
24584 ;; Find all links that contain a newline and put them into a single line
24586 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24592 ;; Normalize links: Convert angle and plain links into bracket links
24593 ;; Expand link abbreviations
24600 ;; added 'org-link face to links
24616 "]"
24624 ;; Find multiline emphasis and put them into single line
24638 rtn))
24641 "Get a title for the current document, from looking at the buffer."
24647 ;; Mark the line so that it will not be exported as normal text.
24651 ;; Return the title string
24655 "Return subtree title and exclude it from export."
24661 ;; This is a subtree, we take the title from the first heading
24668 title))
24671 "Take link text and make a safe target out of it."
24675 'identity
24681 "Get the minimum level in LINES."
24689 ;; Variable holding the vector with section numbers
24693 "Initialize the vector for the section numbers."
24710 "Return a string with the current section number.
24711 When LEVEL is non-nil, increase section numbers on that level."
24733 string))
24735 ;;; ASCII export
24743 "Export the outline as a pretty ASCII file.
24744 If there is an active region, export only the region.
24745 The prefix ARG specifies how many levels of the outline should become
24746 underlined headlines. The default is 3."
24775 filename))
24791 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24800 region
24801 :for-ascii t
24802 :skip-before-1st-heading
24805 :verbatim-multiline t
24806 :archived-trees
24810 thetoc have-headings first-heading-pos
24811 table-open table-buffer)
24829 ;; create local variables for all options, to make sure all called
24830 ;; functions get the correct information
24834 org-export-plist-vars)
24837 org-export-headline-levels))
24840 umax))
24842 ;; File header
24846 org-export-author-info)
24868 line)
24869 ;; This is a headline
24875 todo
24879 org-done-keywords)))
24880 ; TODO, not DONE
24884 line lines level))))
24891 t t txt)))
24896 txt))
24911 thetoc)
24913 ))))
24914 lines)
24919 ;; Remove the quoted HTML tags.
24921 ;; Remove targets
24924 ;; Replace internal links
24928 t nil line)))
24933 ;; a Headline
24942 ;; New table starts
24944 ;; Accumulate lines
24965 ;; insert the table of contents
24977 ;; Convert whitespace place holders
24987 ;; remove display and invisible chars
25003 "Do extra work for ASCII export"
25013 "Search the subtree below LINE for any TODO entries."
25016 line lv todo)
25024 org-done-keywords))))
25025 ; TODO, not DONE
25030 "Handle quoted HTML for ASCII export."
25033 ;; We just remove the tags for now.
25035 line)
25038 "Insert the string S centered and underline it with character UNDERLINE."
25047 "Insert a new level in ASCII export."
25053 org-export-ascii-bullets))
25055 ;; find the indentation of the next non-empty line
25076 "Create a copy of the visible part of the current buffer, and export it.
25077 The copy is created in a temporary buffer and removed after use.
25078 TYPE is the final key (as a string) that also select the export command in
25079 the `C-c C-e' export dispatcher.
25080 As a special case, if the you type SPC at the prompt, the temporary
25081 org-mode file will not be removed but presented to you so that you can
25082 continue to use it. The prefix arg ARG is passed through to the exporting
25083 command."
25086 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
25088 current-prefix-arg))
25103 s e)
25104 ;; Need to hack the drawers here.
25120 ;; Copy all comment lines to the end, to make sure #+ settings are
25121 ;; still available for the second export step. Kind of a hack, but
25122 ;; does do the trick.
25143 s))
25148 s))
25150 ;;; HTML export
25153 "Return a string with current options as keyword options.
25154 Does include HTML export options as well as TODO and CATEGORY stuff."
25156 "#+TITLE: %s
25157 #+AUTHOR: %s
25158 #+EMAIL: %s
25159 #+LANGUAGE: %s
25160 #+TEXT: Some descriptive text to be emitted. Several lines OK.
25161 #+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
25162 #+CATEGORY: %s
25163 #+SEQ_TODO: %s
25164 #+TYP_TODO: %s
25165 #+PRIORITIES: %c %c %c
25166 #+DRAWERS: %s
25167 #+STARTUP: %s %s %s %s %s
25168 #+TAGS: %s
25169 #+ARCHIVE: %s
25170 #+LINK: %s
25171 "
25173 org-export-headline-levels
25174 org-export-with-section-numbers
25175 org-export-with-toc
25176 org-export-preserve-breaks
25177 org-export-html-expand
25178 org-export-with-fixed-width
25179 org-export-with-tables
25180 org-export-with-sub-superscripts
25181 org-export-with-special-strings
25182 org-export-with-footnotes
25183 org-export-with-emphasize
25184 org-export-with-TeX-macros
25185 org-export-with-LaTeX-fragments
25186 org-export-skip-text-before-1st-heading
25187 org-export-with-drawers
25188 org-export-with-tags
25190 "TODO FEEDBACK VERIFY DONE"
25191 "Me Jason Marie DONE"
25192 org-highest-priority org-lowest-priority org-default-priority
25209 org-archive-location
25210 "org file:~/org/%s.org"
25211 ))
25214 "Insert into the buffer a template with information for exporting."
25223 "Toggle the fixed-width export.
25224 If there is no active region, the QUOTE keyword at the current headline is
25225 inserted or removed. When present, it causes the text between this headline
25226 and the next to be exported as fixed-width text, and unmodified.
25227 If there is an active region, this command adds or removes a colon as the
25228 first character of this line. If the first character of a line is a colon,
25229 this line is also exported in fixed-width font."
25238 off)
25268 "Export the outline as HTML and immediately open it with a browser.
25269 If there is an active region, export only the region.
25270 The prefix ARG specifies how many levels of the outline should become
25271 headlines. The default is 3. Lower levels will become bulleted lists."
25277 "Call `org-export-as-html', may be used in batch processing as
25278 emacs --batch
25279 --load=$HOME/lib/emacs/org.el
25281 --visit=MyFile --funcall org-export-as-html-batch"
25285 "Call `org-exort-as-html` with output to a temporary buffer.
25286 No file is created. The prefix ARG is passed through to `org-export-as-html'."
25292 "Assume the current region has org-mode syntax, and convert it to HTML.
25293 This can be used in any buffer. For example, you could write an
25294 itemized list in org-mode syntax in an HTML buffer and then use this
25295 command to convert it."
25315 "Convert region from BEG to END in org-mode buffer to HTML.
25316 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
25317 contents, and only produce the region of converted text, useful for
25318 cut-and-paste operations.
25319 If BUFFER is a buffer or a string, use/create that buffer as a target
25320 of the converted HTML. If BUFFER is the symbol `string', return the
25321 produced HTML as a string and leave not buffer behind. For example,
25322 a Lisp program could call this function in the following way:
25324 (setq html (org-export-region-as-html beg end t 'string))
25326 When called interactively, the output buffer is selected, and shown
25327 in a window. A non-interactive call will only retunr the buffer."
25332 rtn)
25337 nil nil nil
25338 buffer body-only))
25342 rtn)))
25346 to-buffer body-only pub-dir)
25347 "Export the outline as a pretty HTML file.
25348 If there is an active region, export only the region. The prefix
25349 ARG specifies how many levels of the outline should become
25350 headlines. The default is 3. Lower levels will become bulleted
25351 lists. When HIDDEN is non-nil, don't display the HTML buffer.
25352 EXT-PLIST is a property list with external parameters overriding
25353 org-mode's default settings, but still inferior to file-local
25354 settings. When TO-BUFFER is non-nil, create a buffer with that
25355 name and export to that buffer. If TO-BUFFER is the symbol
25356 `string', don't leave any buffer behind but just return the
25357 resulting HTML as a string. When BODY-ONLY is set, don't produce
25358 the file header and footer, simply return the content of
25359 <body>...</body>, without even the body tags themselves. When
25360 PUB-DIR is set, use this as the publishing directory."
25363 ;; Make sure we have a file name when we need it.
25369 buffer-file-name))
25378 ext-plist
25384 valid thetoc have-headings first-heading-pos
25393 ;; The following two are dynamically scoped into other
25394 ;; routines below.
25414 default-directory))
25448 buffer-file-coding-system))
25450 coding-system))
25452 coding-system))
25464 region
25465 :emph-multiline t
25466 :for-html t
25467 :skip-before-1st-heading
25470 :archived-trees
25472 :add-text
25474 :LaTeX-fragments
25477 table-open type
25478 table-buffer table-orig-buffer
25479 ind start-is-num starter didclose
25480 rpl path desc descp desc1 desc2 link
25481 )
25500 ;; Get the language-dependent settings
25504 ;; Switch to the output buffer
25514 ;; create local variables for all options, to make sure all called
25515 ;; functions get the correct information
25519 org-export-plist-vars)
25521 org-export-headline-levels))
25524 umax))
25526 ;; File header
25532 <head>
25533 <title>%s</title>
25538 %s
25539 </head><body>
25540 "
25553 org-export-html-toplevel-hlevel
25555 org-export-html-toplevel-hlevel)
25556 thetoc)
25561 ;; This is a headline
25570 todo
25574 org-done-keywords)))
25575 ; TODO, not DONE
25579 line lines level))))
25604 ;; Check for targets
25609 t t line))
25612 target-alist))
25623 )))
25624 line)
25625 lines))
25637 ;; end of quote section?
25641 ;; inside a quote section?
25646 ;; verbatim lines
25660 ;; Protected HTML
25675 ;; Horizontal line
25680 ;; make targets to anchors
25688 t t line)))
25692 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25693 t t line)))
25699 t t line)))))
25703 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25704 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25705 ;; Also handle sub_superscripts and checkboxes
25709 ;; Format the links
25719 ;; Make an image out of the description if that is so wanted
25725 ;; FIXME: do we need to unescape here somewhere?
25735 ;; standard URL, just check if we need to inline an image
25743 ;; standard URL
25747 ;; FILE link
25750 thefile file-is-image-p search)
25758 t))
25767 ;; make sure this is can be used as target search
25792 ;; TODO items
25800 org-done-keywords)
25805 ;; Does this contain a reference to a footnote?
25817 t t line))))))
25821 ;; This is a headline
25829 ;; Close any local lists before inserting a new header line
25835 in-local-list nil))
25839 head-count)
25840 ;; QUOTES
25848 ;; New table starts
25850 ;; Accumulate lines
25862 ;; Normal lines
25865 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25866 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25869 line)
25876 ;; empty line. Pretend indentation is large.
25878 0
25894 ;; Start new (level of) list
25901 ;; continue current list
25905 ;; we did close a list, normal text follows: need <p>
25911 "<b>[X]</b>"
25913 t t line))))
25915 ;; Empty lines start a new paragraph. If hand-formatted lists
25916 ;; are not fully interpreted, lines starting with "-", "+", "*"
25917 ;; also start a new paragraph.
25920 ;; Is this the start of a footnote?
25926 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25928 ;; Check if the line break needs to be conserved
25937 ;; Properly close all local lists and other lists
25940 ;; Close any local lists before inserting a new header line
25946 in-local-list nil))
25949 head-count)
25980 ;; insert the table of contents
25997 ;; remove empty paragraphs and lists
26007 ;; Convert whitespace place holders
26028 "Format a table for ascii export."
26032 ;; Table made by table.el - test for spanning
26033 lines
26035 ;; A normal org table
26036 ;; Get rid of hlines at beginning and end
26042 ;; Check if the table has a marking column. If yes remove the
26043 ;; column and the special lines
26045 ;; Get rid of the vertical lines except for grouping
26047 rtn line vl1 start)
26069 vl))
26072 "Find out which HTML converter to use and return the HTML code."
26076 ;; A normal org table
26078 ;; Table made by table.el - test for spanning
26082 nil))
26083 lines)))
26089 hlines))))
26092 ;; We can use my own converter with HTML conversions
26094 ;; Need to use the code generator in table.el, with the original text.
26098 "Format a table into HTML."
26099 ;; Get rid of hlines at beginning and end
26105 ;; Check if the table has a marking column. If yes remove the
26106 ;; column and the special lines
26114 tbopen line fields html gr colgropen)
26126 ;; ignore this line
26128 ;; Break the line into fields
26146 html)))
26151 ;; Put in col tags with the alignment (unfortuntely often ignored...)
26167 html)
26173 "Check if the table has a marking column.
26174 If yes remove the column and the special lines."
26180 lines))
26195 nil)
26197 lines)))
26211 nil)
26216 ;; remove the first column
26218 lines))))
26221 "Format a table generated by table.el into HTML.
26222 This conversion does *not* use `table-generate-source' from table.el.
26223 This has the advantage that Org-mode's HTML conversions can be used.
26224 But it has the disadvantage, that no cell- or row-spanning is allowed."
26227 fields html empty)
26237 html
26239 html
26240 "<tr>"
26253 ;; Ignore this line
26255 ;; Break the line into fields and store the fields
26261 field-buffer))
26264 html))
26267 "Format a table into html, using `table-generate-source' from table.el.
26268 This has the advantage that cell- or row-spanning is allowed.
26269 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
26284 "Format time stamps in string S, or remove them."
26289 ;; never export CLOCK
26304 ;; Line break if line started and ended with time stamp stuff
26306 s
26310 r))))
26313 ;; convert & to &, < to < and > to >
26322 s)
26325 "Remove tags and time staps from lines going into the toc."
26334 t t s)))
26335 s)
26338 "Prepare STRING for HTML export. Applies all active conversions.
26339 If there are links in the string, don't modify these."
26342 m s l res)
26353 "Apply all active conversions to translate special ASCII to HTML."
26374 t t s))
26376 s)
26379 "Create a regular expression which will match a balanced sexp.
26380 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
26381 as single character strings.
26382 The regexp returned will match the entire expression including the
26383 delimiters. It will also define a single group which contains the
26384 match except for the outermost delimiters. The maximum depth of
26385 stacked delimiters is N. Escaping delimiters is not possible."
26421 "Convert special characters in STRING to HTML."
26423 e a re rpl start)
26430 string))
26433 "Convert sub- and superscripts in STRING to HTML."
26449 t t string)))))
26452 string))
26455 "Apply emphasis."
26462 rpl
26468 org-emphasis-alist))
26473 string))
26477 "Insert <p>, but first close previous paragraph if any."
26482 "Close paragraph if there is one open."
26487 "Close <li> if necessary."
26493 "Insert a new level in HTML export.
26494 When TITLE is nil, just close all open levels."
26504 ;; If title is nil, this means this function is called to close
26505 ;; all levels, so the rest is done only if title is given
26517 t t title)))
26533 level level head-count title level))
26538 "Terminate one level in HTML export."
26544 ;;; iCalendar export
26546 ;;;###autoload
26548 "Export current file as an iCalendar file.
26549 The iCalendar file will be located in the same directory as the Org-mode
26550 file, but with extension `.ics'."
26554 ;;;###autoload
26556 "Export all files in `org-agenda-files' to iCalendar .ics files.
26557 Each iCalendar file will be located in the same directory as the Org-mode
26558 file, but with extension `.ics'."
26562 ;;;###autoload
26564 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26565 The file is stored under the name `org-combined-agenda-icalendar-file'."
26570 "Create iCalendar files for all elements of FILES.
26571 If COMBINE is non-nil, combine all calendar entries into a single large
26572 file and store it under the name `org-combined-agenda-icalendar-file'."
26577 org-export-publishing-directory)))
26578 file ical-file ical-buffer category started org-agenda-new-buffers)
26584 org-combined-agenda-icalendar-file
26617 "Hook run after an iCalendar file has been saved.
26618 The iCalendar buffer is still current when this hook is run.
26619 A good way to use this is to tell a desktop calenndar application to re-read
26623 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26624 When COMBINE is non nil, add the category to each line."
26631 scheduledp deadlinep tmp pri category entry location summary desc
26641 inc t
26648 t org-icalendar-include-body)
26658 pos)
26663 ts)
26666 ;; donep (org-entry-is-done-p)
26667 ))
26686 t t summary)))
26693 %s
26694 %s%s
26695 SUMMARY:%s%s%s
26696 CATEGORIES:%s
26700 rrule summary
26705 category)))))
26710 ;; Get all the literal sexps
26736 )
26743 t org-icalendar-include-body)
26749 t t hd)))
26759 %s
26760 SUMMARY:%s%s%s
26761 CATEGORIES:%s
26762 SEQUENCE:1
26763 PRIORITY:%d
26764 STATUS:%s
26766 dts
26772 category pri status)))))))))
26775 "Take out stuff and quote what needs to be quoted.
26776 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26777 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26778 characters."
26780 nil
26799 s))
26802 "Clean-up description string."
26808 "Start an iCalendar file by inserting the header."
26814 VERSION:2.0
26815 X-WR-CALNAME:%s
26816 PRODID:-//%s//Emacs with Org-mode//EN
26817 X-WR-TIMEZONE:%s
26821 "Finish an iCalendar file by inserting the END statement."
26825 "Take a time string S and convert it to iCalendar format.
26826 KEYWORD is added in front, to make a complete line like DTSTART....
26827 When INC is non-nil, increase the hour by two (if time string contains
26828 a time), or the day by one (if it does not contain a time)."
26830 t2 fmt have-time time)
26846 ;;; XOXO export
26854 "Export the org buffer as XOXO.
26855 The XOXO buffer is named *xoxo-<source buffer name>*"
26857 ;; A quickie abstraction
26859 ;; Output everything as XOXO
26873 ;; Check the output buffer is empty.
26875 ;; Kick off the output
26892 ;; Handle level rendering
26909 )
26913 ;; And output the new li
26919 ;; Finally finish off the ol
26926 ;; Finish the buffer off and clean it up.
26931 )))
26934 ;;;; Key bindings
26936 ;; Make `C-c C-x' a prefix key
26939 ;; TAB key with modifiers
26946 ;; The following line is necessary under Suse GNU/Linux
26952 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26953 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26954 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26956 ;; Cursor keys with modifiers
26957 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26958 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26959 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26960 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26962 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26963 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26964 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26965 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26967 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26968 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26969 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26970 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26972 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26973 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26975 ;;; Extra keys for tty access.
26976 ;; We only set them when really needed because otherwise the
26977 ;; menus don't show the simple keys
26979 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26980 (not window-system))
26981 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26982 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26983 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26984 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26985 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26986 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26987 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26988 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26989 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26990 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26991 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26992 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26993 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26994 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26995 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26996 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26997 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26998 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26999 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
27000 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
27001 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
27002 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
27004 ;; All the other keys
27006 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
27007 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
27008 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
27009 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
27010 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
27011 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
27012 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
27013 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
27014 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
27015 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
27016 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
27017 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
27018 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
27019 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
27020 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
27022 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
27023 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
27024 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
27025 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
27026 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
27027 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
27028 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
27029 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
27030 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
27031 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
27032 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
27033 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
27034 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
27035 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
27036 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
27037 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
27038 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
27040 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
27041 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
27042 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
27043 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
27044 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
27045 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
27046 (org-defkey org-mode-map "\C-c^" 'org-sort)
27047 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
27048 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
27049 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
27050 (org-defkey org-mode-map "\C-m" 'org-return)
27051 (org-defkey org-mode-map "\C-j" 'org-return-indent)
27052 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
27053 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
27054 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
27055 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
27056 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
27057 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
27058 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
27059 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
27060 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
27061 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
27062 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
27063 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
27064 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
27065 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
27066 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
27068 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
27069 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
27070 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
27071 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
27073 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
27074 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
27075 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
27076 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
27077 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
27078 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
27079 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
27080 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
27081 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
27082 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
27083 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
27084 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
27086 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
27088 (when (featurep 'xemacs)
27089 (org-defkey org-mode-map 'button3 'popup-mode-menu))
27091 (defsubst org-table-p () (org-at-table-p))
27093 (defun org-self-insert-command (N)
27094 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
27095 If the cursor is in a table looking at whitespace, the whitespace is
27096 overwritten, and the table is not marked as requiring realignment."
27097 (interactive "p")
27098 (if (and (org-table-p)
27099 (progn
27100 ;; check if we blank the field, and if that triggers align
27101 (and org-table-auto-blank-field
27102 (member last-command
27103 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
27105 ;; got extra space, this field does not determine column width
27106 (let (org-table-may-need-update) (org-table-blank-field))
27107 ;; no extra space, this field may determine column width
27108 (org-table-blank-field)))
27109 t)
27110 (eq N 1)
27112 (let (org-table-may-need-update)
27113 (goto-char (1- (match-end 0)))
27114 (delete-backward-char 1)
27115 (goto-char (match-beginning 0))
27116 (self-insert-command N))
27117 (setq org-table-may-need-update t)
27118 (self-insert-command N)
27119 (org-fix-tags-on-the-fly)))
27121 (defun org-fix-tags-on-the-fly ()
27122 (when (and (equal (char-after (point-at-bol)) ?*)
27123 (org-on-heading-p))
27124 (org-align-tags-here org-tags-column)))
27126 (defun org-delete-backward-char (N)
27127 "Like `delete-backward-char', insert whitespace at field end in tables.
27128 When deleting backwards, in tables this function will insert whitespace in
27130 still be marked for re-alignment if the field did fill the entire column,
27131 because, in this case the deletion might narrow the column."
27132 (interactive "p")
27133 (if (and (org-table-p)
27134 (eq N 1)
27135 (string-match "|" (buffer-substring (point-at-bol) (point)))
27136 (looking-at ".*?|"))
27137 (let ((pos (point))
27139 (c org-table-may-need-update))
27140 (backward-delete-char N)
27141 (skip-chars-forward "^|")
27142 (insert " ")
27143 (goto-char (1- pos))
27144 ;; noalign: if there were two spaces at the end, this field
27145 ;; does not determine the width of the column.
27146 (if noalign (setq org-table-may-need-update c)))
27147 (backward-delete-char N)
27148 (org-fix-tags-on-the-fly)))
27150 (defun org-delete-char (N)
27151 "Like `delete-char', but insert whitespace at field end in tables.
27152 When deleting characters, in tables this function will insert whitespace in
27154 still be marked for re-alignment if the field did fill the entire column,
27155 because, in this case the deletion might narrow the column."
27156 (interactive "p")
27157 (if (and (org-table-p)
27158 (not (bolp))
27159 (not (= (char-after) ?|))
27160 (eq N 1))
27161 (if (looking-at ".*?|")
27162 (let ((pos (point))
27164 (c org-table-may-need-update))
27165 (replace-match (concat
27166 (substring (match-string 0) 1 -1)
27167 " |"))
27168 (goto-char pos)
27169 ;; noalign: if there were two spaces at the end, this field
27170 ;; does not determine the width of the column.
27171 (if noalign (setq org-table-may-need-update c)))
27172 (delete-char N))
27173 (delete-char N)
27174 (org-fix-tags-on-the-fly)))
27176 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
27177 (put 'org-self-insert-command 'delete-selection t)
27178 (put 'orgtbl-self-insert-command 'delete-selection t)
27179 (put 'org-delete-char 'delete-selection 'supersede)
27180 (put 'org-delete-backward-char 'delete-selection 'supersede)
27182 ;; Make `flyspell-mode' delay after some commands
27183 (put 'org-self-insert-command 'flyspell-delayed t)
27184 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
27185 (put 'org-delete-char 'flyspell-delayed t)
27186 (put 'org-delete-backward-char 'flyspell-delayed t)
27188 ;; Make pabbrev-mode expand after org-mode commands
27189 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
27190 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
27192 ;; How to do this: Measure non-white length of current string
27193 ;; If equal to column width, we should realign.
27195 (defun org-remap (map &rest commands)
27196 "In MAP, remap the functions given in COMMANDS.
27197 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
27198 (let (new old)
27199 (while commands
27200 (setq old (pop commands) new (pop commands))
27201 (if (fboundp 'command-remapping)
27202 (org-defkey map (vector 'remap old) new)
27203 (substitute-key-definition old new map global-map)))))
27205 (when (eq org-enable-table-editor 'optimized)
27206 ;; If the user wants maximum table support, we need to hijack
27207 ;; some standard editing functions
27208 (org-remap org-mode-map
27209 'self-insert-command 'org-self-insert-command
27210 'delete-char 'org-delete-char
27211 'delete-backward-char 'org-delete-backward-char)
27212 (org-defkey org-mode-map "|" 'org-force-self-insert))
27214 (defun org-shiftcursor-error ()
27215 "Throw an error because Shift-Cursor command was applied in wrong context."
27216 (error "This command is active in special context like tables, headlines or timestamps"))
27218 (defun org-shifttab (&optional arg)
27219 "Global visibility cycling or move to previous table field.
27220 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
27221 on context.
27222 See the individual commands for more information."
27223 (interactive "P")
27224 (cond
27225 ((org-at-table-p) (call-interactively 'org-table-previous-field))
27226 (arg (message "Content view to level: ")
27227 (org-content (prefix-numeric-value arg))
27228 (setq org-cycle-global-status 'overview))
27229 (t (call-interactively 'org-global-cycle))))
27231 (defun org-shiftmetaleft ()
27232 "Promote subtree or delete table column.
27233 Calls `org-promote-subtree', `org-outdent-item',
27234 or `org-table-delete-column', depending on context.
27235 See the individual commands for more information."
27236 (interactive)
27237 (cond
27238 ((org-at-table-p) (call-interactively 'org-table-delete-column))
27239 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
27240 ((org-at-item-p) (call-interactively 'org-outdent-item))
27241 (t (org-shiftcursor-error))))
27243 (defun org-shiftmetaright ()
27244 "Demote subtree or insert table column.
27245 Calls `org-demote-subtree', `org-indent-item',
27246 or `org-table-insert-column', depending on context.
27247 See the individual commands for more information."
27248 (interactive)
27249 (cond
27250 ((org-at-table-p) (call-interactively 'org-table-insert-column))
27251 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
27252 ((org-at-item-p) (call-interactively 'org-indent-item))
27253 (t (org-shiftcursor-error))))
27255 (defun org-shiftmetaup (&optional arg)
27256 "Move subtree up or kill table row.
27257 Calls `org-move-subtree-up' or `org-table-kill-row' or
27258 `org-move-item-up' depending on context. See the individual commands
27259 for more information."
27260 (interactive "P")
27261 (cond
27262 ((org-at-table-p) (call-interactively 'org-table-kill-row))
27263 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27264 ((org-at-item-p) (call-interactively 'org-move-item-up))
27265 (t (org-shiftcursor-error))))
27266 (defun org-shiftmetadown (&optional arg)
27267 "Move subtree down or insert table row.
27268 Calls `org-move-subtree-down' or `org-table-insert-row' or
27269 `org-move-item-down', depending on context. See the individual
27270 commands for more information."
27271 (interactive "P")
27272 (cond
27273 ((org-at-table-p) (call-interactively 'org-table-insert-row))
27274 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27275 ((org-at-item-p) (call-interactively 'org-move-item-down))
27276 (t (org-shiftcursor-error))))
27278 (defun org-metaleft (&optional arg)
27279 "Promote heading or move table column to left.
27280 Calls `org-do-promote' or `org-table-move-column', depending on context.
27281 With no specific context, calls the Emacs default `backward-word'.
27282 See the individual commands for more information."
27283 (interactive "P")
27284 (cond
27285 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
27286 ((or (org-on-heading-p) (org-region-active-p))
27287 (call-interactively 'org-do-promote))
27288 ((org-at-item-p) (call-interactively 'org-outdent-item))
27289 (t (call-interactively 'backward-word))))
27291 (defun org-metaright (&optional arg)
27292 "Demote subtree or move table column to right.
27293 Calls `org-do-demote' or `org-table-move-column', depending on context.
27294 With no specific context, calls the Emacs default `forward-word'.
27295 See the individual commands for more information."
27296 (interactive "P")
27297 (cond
27298 ((org-at-table-p) (call-interactively 'org-table-move-column))
27299 ((or (org-on-heading-p) (org-region-active-p))
27300 (call-interactively 'org-do-demote))
27301 ((org-at-item-p) (call-interactively 'org-indent-item))
27302 (t (call-interactively 'forward-word))))
27304 (defun org-metaup (&optional arg)
27305 "Move subtree up or move table row up.
27306 Calls `org-move-subtree-up' or `org-table-move-row' or
27307 `org-move-item-up', depending on context. See the individual commands
27308 for more information."
27309 (interactive "P")
27310 (cond
27311 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
27312 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
27313 ((org-at-item-p) (call-interactively 'org-move-item-up))
27314 (t (transpose-lines 1) (beginning-of-line -1))))
27316 (defun org-metadown (&optional arg)
27317 "Move subtree down or move table row down.
27318 Calls `org-move-subtree-down' or `org-table-move-row' or
27319 `org-move-item-down', depending on context. See the individual
27320 commands for more information."
27321 (interactive "P")
27322 (cond
27323 ((org-at-table-p) (call-interactively 'org-table-move-row))
27324 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
27325 ((org-at-item-p) (call-interactively 'org-move-item-down))
27326 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
27328 (defun org-shiftup (&optional arg)
27329 "Increase item in timestamp or increase priority of current headline.
27330 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
27331 depending on context. See the individual commands for more information."
27332 (interactive "P")
27333 (cond
27334 ((org-at-timestamp-p t)
27335 (call-interactively (if org-edit-timestamp-down-means-later
27336 'org-timestamp-down 'org-timestamp-up)))
27337 ((org-on-heading-p) (call-interactively 'org-priority-up))
27338 ((org-at-item-p) (call-interactively 'org-previous-item))
27339 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
27341 (defun org-shiftdown (&optional arg)
27342 "Decrease item in timestamp or decrease priority of current headline.
27343 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
27344 depending on context. See the individual commands for more information."
27345 (interactive "P")
27346 (cond
27347 ((org-at-timestamp-p t)
27348 (call-interactively (if org-edit-timestamp-down-means-later
27349 'org-timestamp-up 'org-timestamp-down)))
27350 ((org-on-heading-p) (call-interactively 'org-priority-down))
27351 (t (call-interactively 'org-next-item))))
27353 (defun org-shiftright ()
27354 "Next TODO keyword or timestamp one day later, depending on context."
27355 (interactive)
27356 (cond
27357 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
27358 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
27359 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
27360 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
27361 (t (org-shiftcursor-error))))
27363 (defun org-shiftleft ()
27364 "Previous TODO keyword or timestamp one day earlier, depending on context."
27365 (interactive)
27366 (cond
27367 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
27368 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
27369 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
27370 ((org-at-property-p)
27371 (call-interactively 'org-property-previous-allowed-value))
27372 (t (org-shiftcursor-error))))
27374 (defun org-shiftcontrolright ()
27375 "Switch to next TODO set."
27376 (interactive)
27377 (cond
27378 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
27379 (t (org-shiftcursor-error))))
27381 (defun org-shiftcontrolleft ()
27382 "Switch to previous TODO set."
27383 (interactive)
27384 (cond
27385 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
27386 (t (org-shiftcursor-error))))
27388 (defun org-ctrl-c-ret ()
27389 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
27390 (interactive)
27391 (cond
27392 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27393 (t (call-interactively 'org-insert-heading))))
27395 (defun org-copy-special ()
27396 "Copy region in table or copy current subtree.
27397 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27398 See the individual commands for more information."
27399 (interactive)
27400 (call-interactively
27401 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27403 (defun org-cut-special ()
27404 "Cut region in table or cut current subtree.
27405 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27406 See the individual commands for more information."
27407 (interactive)
27408 (call-interactively
27409 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27411 (defun org-paste-special (arg)
27412 "Paste rectangular region into table, or past subtree relative to level.
27413 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27414 See the individual commands for more information."
27415 (interactive "P")
27416 (if (org-at-table-p)
27417 (org-table-paste-rectangle)
27418 (org-paste-subtree arg)))
27420 (defun org-ctrl-c-ctrl-c (&optional arg)
27421 "Set tags in headline, or update according to changed information at point.
27423 This command does many different things, depending on context:
27425 - If the cursor is in a headline, prompt for tags and insert them
27426 into the current line, aligned to `org-tags-column'. When called
27427 with prefix arg, realign all tags in the current buffer.
27429 - If the cursor is in one of the special #+KEYWORD lines, this
27430 triggers scanning the buffer for these lines and updating the
27431 information.
27433 - If the cursor is inside a table, realign the table. This command
27434 works even if the automatic table editor has been turned off.
27436 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27437 the entire table.
27439 - If the cursor is a the beginning of a dynamic block, update it.
27441 - If the cursor is inside a table created by the table.el package,
27442 activate that table.
27444 - If the current buffer is a remember buffer, close note and file it.
27445 with a prefix argument, file it without further interaction to the default
27446 location.
27448 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27449 links in this buffer.
27451 - If the cursor is on a numbered item in a plain list, renumber the
27452 ordered list.
27454 - If the cursor is on a checkbox, toggle it."
27455 (interactive "P")
27456 (let ((org-enable-table-editor t))
27457 (cond
27458 ((or org-clock-overlays
27459 org-occur-highlights
27460 org-latex-fragment-image-overlays)
27461 (org-remove-clock-overlays)
27462 (org-remove-occur-highlights)
27463 (org-remove-latex-fragment-image-overlays)
27464 (message "Temporary highlights/overlays removed from current buffer"))
27465 ((and (local-variable-p 'org-finish-function (current-buffer))
27466 (fboundp org-finish-function))
27467 (funcall org-finish-function))
27468 ((org-at-property-p)
27469 (call-interactively 'org-property-action))
27470 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27471 ((org-on-heading-p) (call-interactively 'org-set-tags))
27472 ((org-at-table.el-p)
27473 (require 'table)
27474 (beginning-of-line 1)
27475 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27476 (call-interactively 'table-recognize-table))
27477 ((org-at-table-p)
27478 (org-table-maybe-eval-formula)
27479 (if arg
27480 (call-interactively 'org-table-recalculate)
27481 (org-table-maybe-recalculate-line))
27482 (call-interactively 'org-table-align))
27483 ((org-at-item-checkbox-p)
27484 (call-interactively 'org-toggle-checkbox))
27485 ((org-at-item-p)
27486 (call-interactively 'org-maybe-renumber-ordered-list))
27488 ;; Dynamic block
27489 (beginning-of-line 1)
27490 (org-update-dblock))
27492 (cond
27493 ((equal (match-string 1) "TBLFM")
27494 ;; Recalculate the table before this line
27495 (save-excursion
27496 (beginning-of-line 1)
27498 (if (org-at-table-p)
27499 (org-call-with-arg 'org-table-recalculate t))))
27500 (t
27501 (call-interactively 'org-mode-restart))))
27502 (t (error "C-c C-c can do nothing useful at this location.")))))
27504 (defun org-mode-restart ()
27505 "Restart Org-mode, to scan again for special lines.
27506 Also updates the keyword regular expressions."
27507 (interactive)
27508 (let ((org-inhibit-startup t)) (org-mode))
27509 (message "Org-mode restarted to refresh keyword and special line setup"))
27511 (defun org-kill-note-or-show-branches ()
27512 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27513 (interactive)
27514 (if (not org-finish-function)
27515 (call-interactively 'show-branches)
27516 (let ((org-note-abort t))
27517 (funcall org-finish-function))))
27519 (defun org-return (&optional indent)
27520 "Goto next table row or insert a newline.
27521 Calls `org-table-next-row' or `newline', depending on context.
27522 See the individual commands for more information."
27523 (interactive)
27524 (cond
27525 ((bobp) (if indent (newline-and-indent) (newline)))
27526 ((and (org-at-heading-p)
27527 (looking-at
27529 (org-show-entry)
27530 (end-of-line 1)
27531 (newline))
27532 ((org-at-table-p)
27533 (org-table-justify-field-maybe)
27534 (call-interactively 'org-table-next-row))
27535 (t (if indent (newline-and-indent) (newline)))))
27537 (defun org-return-indent ()
27538 "Goto next table row or insert a newline and indent.
27539 Calls `org-table-next-row' or `newline-and-indent', depending on
27540 context. See the individual commands for more information."
27541 (interactive)
27542 (org-return t))
27544 (defun org-ctrl-c-star ()
27545 "Compute table, or change heading status of lines.
27546 Calls `org-table-recalculate' or `org-toggle-region-headlines',
27547 depending on context. This will also turn a plain list item or a normal
27548 line into a subheading."
27549 (interactive)
27550 (cond
27551 ((org-at-table-p)
27552 (call-interactively 'org-table-recalculate))
27553 ((org-region-active-p)
27554 ;; Convert all lines in region to list items
27555 (call-interactively 'org-toggle-region-headings))
27556 ((org-on-heading-p)
27557 (org-toggle-region-headings (point-at-bol)
27558 (min (1+ (point-at-eol)) (point-max))))
27559 ((org-at-item-p)
27560 ;; Convert to heading
27561 ;; FIXME: not yet implemented
27562 )
27563 (t (org-toggle-region-headings (point-at-bol)
27564 (min (1+ (point-at-eol)) (point-max))))))
27566 (defun org-ctrl-c-minus ()
27567 "Insert separator line in table or modify bullet status of line.
27568 Also turns a plain line or a region of lines into list items.
27569 Calls `org-table-insert-hline', `org-toggle-region-items', or
27570 `org-cycle-list-bullet', depending on context."
27571 (interactive)
27572 (cond
27573 ((org-at-table-p)
27574 (call-interactively 'org-table-insert-hline))
27575 ((org-on-heading-p)
27576 ;; Convert to item
27577 (save-excursion
27578 (beginning-of-line 1)
27580 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27581 ((org-region-active-p)
27582 ;; Convert all lines in region to list items
27583 (call-interactively 'org-toggle-region-items))
27584 ((org-in-item-p)
27585 (call-interactively 'org-cycle-list-bullet))
27586 (t (org-toggle-region-items (point-at-bol)
27587 (min (1+ (point-at-eol)) (point-max))))))
27589 (defun org-toggle-region-items (beg end)
27590 "Convert all lines in region to list items.
27591 If the first line is already an item, convert all list items in the region
27592 to normal lines."
27593 (interactive "r")
27594 (let (l2 l)
27595 (save-excursion
27596 (goto-char end)
27597 (setq l2 (org-current-line))
27598 (goto-char beg)
27599 (beginning-of-line 1)
27600 (setq l (1- (org-current-line)))
27601 (if (org-at-item-p)
27602 ;; We already have items, de-itemize
27603 (while (< (setq l (1+ l)) l2)
27604 (when (org-at-item-p)
27605 (goto-char (match-beginning 2))
27606 (delete-region (match-beginning 2) (match-end 2))
27608 (beginning-of-line 2))
27609 (while (< (setq l (1+ l)) l2)
27610 (unless (org-at-item-p)
27613 (beginning-of-line 2))))))
27615 (defun org-toggle-region-headings (beg end)
27616 "Convert all lines in region to list items.
27617 If the first line is already an item, convert all list items in the region
27618 to normal lines."
27619 (interactive "r")
27620 (let (l2 l)
27621 (save-excursion
27622 (goto-char end)
27623 (setq l2 (org-current-line))
27624 (goto-char beg)
27625 (beginning-of-line 1)
27626 (setq l (1- (org-current-line)))
27627 (if (org-on-heading-p)
27628 ;; We already have headlines, de-star them
27629 (while (< (setq l (1+ l)) l2)
27630 (when (org-on-heading-p t)
27631 (and (looking-at outline-regexp) (replace-match "")))
27632 (beginning-of-line 2))
27633 (let* ((stars (save-excursion
27634 (re-search-backward org-complex-heading-regexp nil t)
27635 (or (match-string 1) "*")))
27636 (add-stars (if org-odd-levels-only "**" "*"))
27638 (while (< (setq l (1+ l)) l2)
27639 (unless (org-on-heading-p)
27641 (replace-match rpl)))
27642 (beginning-of-line 2)))))))
27644 (defun org-meta-return (&optional arg)
27645 "Insert a new heading or wrap a region in a table.
27646 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27647 See the individual commands for more information."
27648 (interactive "P")
27649 (cond
27650 ((org-at-table-p)
27651 (call-interactively 'org-table-wrap-region))
27652 (t (call-interactively 'org-insert-heading))))
27654 ;;; Menu entries
27656 ;; Define the Org-mode menus
27657 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27658 '("Tbl"
27659 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27660 ["Next Field" org-cycle (org-at-table-p)]
27661 ["Previous Field" org-shifttab (org-at-table-p)]
27662 ["Next Row" org-return (org-at-table-p)]
27663 "--"
27664 ["Blank Field" org-table-blank-field (org-at-table-p)]
27665 ["Edit Field" org-table-edit-field (org-at-table-p)]
27666 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27667 "--"
27668 ("Column"
27669 ["Move Column Left" org-metaleft (org-at-table-p)]
27670 ["Move Column Right" org-metaright (org-at-table-p)]
27671 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27672 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27673 ("Row"
27674 ["Move Row Up" org-metaup (org-at-table-p)]
27675 ["Move Row Down" org-metadown (org-at-table-p)]
27676 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27677 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27678 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27679 "--"
27680 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27681 ("Rectangle"
27682 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27683 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27684 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27685 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27686 "--"
27687 ("Calculate"
27688 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27689 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27690 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27691 "--"
27692 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27693 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27694 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27695 "--"
27696 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27697 "--"
27698 ["Sum Column/Rectangle" org-table-sum
27699 (or (org-at-table-p) (org-region-active-p))]
27700 ["Which Column?" org-table-current-column (org-at-table-p)])
27701 ["Debug Formulas"
27702 org-table-toggle-formula-debugger
27703 :style toggle :selected org-table-formula-debug]
27704 ["Show Col/Row Numbers"
27705 org-table-toggle-coordinate-overlays
27706 :style toggle :selected org-table-overlay-coordinates]
27707 "--"
27708 ["Create" org-table-create (and (not (org-at-table-p))
27709 org-enable-table-editor)]
27710 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27711 ["Import from File" org-table-import (not (org-at-table-p))]
27712 ["Export to File" org-table-export (org-at-table-p)]
27713 "--"
27714 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27716 (easy-menu-define org-org-menu org-mode-map "Org menu"
27717 '("Org"
27718 ("Show/Hide"
27719 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27720 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27721 ["Sparse Tree" org-occur t]
27722 ["Reveal Context" org-reveal t]
27723 ["Show All" show-all t]
27724 "--"
27725 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27726 "--"
27727 ["New Heading" org-insert-heading t]
27728 ("Navigate Headings"
27729 ["Up" outline-up-heading t]
27730 ["Next" outline-next-visible-heading t]
27731 ["Previous" outline-previous-visible-heading t]
27732 ["Next Same Level" outline-forward-same-level t]
27733 ["Previous Same Level" outline-backward-same-level t]
27734 "--"
27735 ["Jump" org-goto t])
27736 ("Edit Structure"
27737 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27738 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27739 "--"
27740 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27741 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27742 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27743 "--"
27744 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27745 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27746 ["Demote Heading" org-metaright (not (org-at-table-p))]
27747 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27748 "--"
27749 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27750 "--"
27751 ["Convert to odd levels" org-convert-to-odd-levels t]
27752 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27753 ("Editing"
27754 ["Emphasis..." org-emphasize t])
27755 ("Archive"
27756 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27757 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27758 ; :active t :keys "C-u C-c C-x C-a"]
27759 ["Sparse trees open ARCHIVE trees"
27760 (setq org-sparse-tree-open-archived-trees
27761 (not org-sparse-tree-open-archived-trees))
27762 :style toggle :selected org-sparse-tree-open-archived-trees]
27763 ["Cycling opens ARCHIVE trees"
27764 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27765 :style toggle :selected org-cycle-open-archived-trees]
27766 ["Agenda includes ARCHIVE trees"
27767 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27768 :style toggle :selected (not org-agenda-skip-archived-trees)]
27769 "--"
27770 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27771 ; ["Check and Move Children" (org-archive-subtree '(4))
27772 ; :active t :keys "C-u C-c C-x C-s"]
27773 )
27774 "--"
27775 ("TODO Lists"
27776 ["TODO/DONE/-" org-todo t]
27777 ("Select keyword"
27778 ["Next keyword" org-shiftright (org-on-heading-p)]
27779 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27780 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27781 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27782 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27783 ["Show TODO Tree" org-show-todo-tree t]
27784 ["Global TODO list" org-todo-list t]
27785 "--"
27786 ["Set Priority" org-priority t]
27787 ["Priority Up" org-shiftup t]
27788 ["Priority Down" org-shiftdown t])
27789 ("TAGS and Properties"
27790 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27791 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27792 "--"
27793 ["Set property" 'org-set-property t]
27794 ["Column view of properties" org-columns t]
27795 ["Insert Column View DBlock" org-insert-columns-dblock t])
27796 ("Dates and Scheduling"
27797 ["Timestamp" org-time-stamp t]
27798 ["Timestamp (inactive)" org-time-stamp-inactive t]
27799 ("Change Date"
27800 ["1 Day Later" org-shiftright t]
27801 ["1 Day Earlier" org-shiftleft t]
27802 ["1 ... Later" org-shiftup t]
27803 ["1 ... Earlier" org-shiftdown t])
27804 ["Compute Time Range" org-evaluate-time-range t]
27805 ["Schedule Item" org-schedule t]
27806 ["Deadline" org-deadline t]
27807 "--"
27808 ["Custom time format" org-toggle-time-stamp-overlays
27809 :style radio :selected org-display-custom-times]
27810 "--"
27811 ["Goto Calendar" org-goto-calendar t]
27812 ["Date from Calendar" org-date-from-calendar t])
27813 ("Logging work"
27814 ["Clock in" org-clock-in t]
27815 ["Clock out" org-clock-out t]
27816 ["Clock cancel" org-clock-cancel t]
27817 ["Goto running clock" org-clock-goto t]
27818 ["Display times" org-clock-display t]
27819 ["Create clock table" org-clock-report t]
27820 "--"
27821 ["Record DONE time"
27822 (progn (setq org-log-done (not org-log-done))
27823 (message "Switching to %s will %s record a timestamp"
27824 (car org-done-keywords)
27825 (if org-log-done "automatically" "not")))
27826 :style toggle :selected org-log-done])
27827 "--"
27828 ["Agenda Command..." org-agenda t]
27829 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27830 ("File List for Agenda")
27831 ("Special views current file"
27832 ["TODO Tree" org-show-todo-tree t]
27833 ["Check Deadlines" org-check-deadlines t]
27834 ["Timeline" org-timeline t]
27835 ["Tags Tree" org-tags-sparse-tree t])
27836 "--"
27837 ("Hyperlinks"
27838 ["Store Link (Global)" org-store-link t]
27839 ["Insert Link" org-insert-link t]
27840 ["Follow Link" org-open-at-point t]
27841 "--"
27842 ["Next link" org-next-link t]
27843 ["Previous link" org-previous-link t]
27844 "--"
27845 ["Descriptive Links"
27846 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27847 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27848 ["Literal Links"
27849 (progn
27850 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27851 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27852 "--"
27853 ["Export/Publish..." org-export t]
27854 ("LaTeX"
27855 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27856 :selected org-cdlatex-mode]
27857 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27858 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27859 ["Modify math symbol" org-cdlatex-math-modify
27860 (org-inside-LaTeX-fragment-p)]
27861 ["Export LaTeX fragments as images"
27862 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27863 :style toggle :selected org-export-with-LaTeX-fragments])
27864 "--"
27865 ("Documentation"
27866 ["Show Version" org-version t]
27867 ["Info Documentation" org-info t])
27868 ("Customize"
27869 ["Browse Org Group" org-customize t]
27870 "--"
27871 ["Expand This Menu" org-create-customize-menu
27872 (fboundp 'customize-menu-create)])
27873 "--"
27874 ["Refresh setup" org-mode-restart t]
27875 ))
27877 (defun org-info (&optional node)
27878 "Read documentation for Org-mode in the info system.
27879 With optional NODE, go directly to that node."
27880 (interactive)
27881 (info (format "(org)%s" (or node ""))))
27883 (defun org-install-agenda-files-menu ()
27884 (let ((bl (buffer-list)))
27885 (save-excursion
27886 (while bl
27887 (set-buffer (pop bl))
27888 (if (org-mode-p) (setq bl nil)))
27889 (when (org-mode-p)
27890 (easy-menu-change
27891 '("Org") "File List for Agenda"
27892 (append
27893 (list
27894 ["Edit File List" (org-edit-agenda-file-list) t]
27895 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27896 ["Remove Current File from List" org-remove-file t]
27897 ["Cycle through agenda files" org-cycle-agenda-files t]
27898 ["Occur in all agenda files" org-occur-in-agenda-files t]
27899 "--")
27900 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27902 ;;;; Documentation
27904 (defun org-customize ()
27905 "Call the customize function with org as argument."
27906 (interactive)
27907 (customize-browse 'org))
27909 (defun org-create-customize-menu ()
27910 "Create a full customization menu for Org-mode, insert it into the menu."
27911 (interactive)
27912 (if (fboundp 'customize-menu-create)
27913 (progn
27914 (easy-menu-change
27915 '("Org") "Customize"
27916 `(["Browse Org group" org-customize t]
27917 "--"
27918 ,(customize-menu-create 'org)
27919 ["Set" Custom-set t]
27920 ["Save" Custom-save t]
27921 ["Reset to Current" Custom-reset-current t]
27922 ["Reset to Saved" Custom-reset-saved t]
27923 ["Reset to Standard Settings" Custom-reset-standard t]))
27925 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27927 ;;;; Miscellaneous stuff
27930 ;;; Generally useful functions
27932 (defun org-context ()
27933 "Return a list of contexts of the current cursor position.
27934 If several contexts apply, all are returned.
27935 Each context entry is a list with a symbol naming the context, and
27936 two positions indicating start and end of the context. Possible
27937 contexts are:
27939 :headline anywhere in a headline
27940 :headline-stars on the leading stars in a headline
27941 :todo-keyword on a TODO keyword (including DONE) in a headline
27942 :tags on the TAGS in a headline
27943 :priority on the priority cookie in a headline
27944 :item on the first line of a plain list item
27945 :item-bullet on the bullet/number of a plain list item
27946 :checkbox on the checkbox in a plain list item
27947 :table in an org-mode table
27948 :table-special on a special filed in a table
27949 :table-table in a table.el table
27950 :link on a hyperlink
27951 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27952 :target on a <<target>>
27953 :radio-target on a <<<radio-target>>>
27954 :latex-fragment on a LaTeX fragment
27955 :latex-preview on a LaTeX fragment with overlayed preview image
27957 This function expects the position to be visible because it uses font-lock
27958 faces as a help to recognize the following contexts: :table-special, :link,
27959 and :keyword."
27960 (let* ((f (get-text-property (point) 'face))
27961 (faces (if (listp f) f (list f)))
27962 (p (point)) clist o)
27963 ;; First the large context
27964 (cond
27965 ((org-on-heading-p t)
27966 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27967 (when (progn
27968 (beginning-of-line 1)
27969 (looking-at org-todo-line-tags-regexp))
27970 (push (org-point-in-group p 1 :headline-stars) clist)
27971 (push (org-point-in-group p 2 :todo-keyword) clist)
27972 (push (org-point-in-group p 4 :tags) clist))
27973 (goto-char p)
27976 (push (org-point-in-group p 0 :priority) clist)))
27978 ((org-at-item-p)
27979 (push (org-point-in-group p 2 :item-bullet) clist)
27980 (push (list :item (point-at-bol)
27981 (save-excursion (org-end-of-item) (point)))
27982 clist)
27983 (and (org-at-item-checkbox-p)
27984 (push (org-point-in-group p 0 :checkbox) clist)))
27986 ((org-at-table-p)
27987 (push (list :table (org-table-begin) (org-table-end)) clist)
27988 (if (memq 'org-formula faces)
27989 (push (list :table-special
27990 (previous-single-property-change p 'face)
27991 (next-single-property-change p 'face)) clist)))
27992 ((org-at-table-p 'any)
27993 (push (list :table-table) clist)))
27994 (goto-char p)
27996 ;; Now the small context
27997 (cond
27998 ((org-at-timestamp-p)
27999 (push (org-point-in-group p 0 :timestamp) clist))
28000 ((memq 'org-link faces)
28001 (push (list :link
28002 (previous-single-property-change p 'face)
28003 (next-single-property-change p 'face)) clist))
28004 ((memq 'org-special-keyword faces)
28005 (push (list :keyword
28006 (previous-single-property-change p 'face)
28007 (next-single-property-change p 'face)) clist))
28008 ((org-on-target-p)
28009 (push (org-point-in-group p 0 :target) clist)
28010 (goto-char (1- (match-beginning 0)))
28011 (if (looking-at org-radio-target-regexp)
28012 (push (org-point-in-group p 0 :radio-target) clist))
28013 (goto-char p))
28014 ((setq o (car (delq nil
28015 (mapcar
28016 (lambda (x)
28017 (if (memq x org-latex-fragment-image-overlays) x))
28018 (org-overlays-at (point))))))
28019 (push (list :latex-fragment
28020 (org-overlay-start o) (org-overlay-end o)) clist)
28021 (push (list :latex-preview
28022 (org-overlay-start o) (org-overlay-end o)) clist))
28023 ((org-inside-LaTeX-fragment-p)
28024 ;; FIXME: positions wrong.
28025 (push (list :latex-fragment (point) (point)) clist)))
28027 (setq clist (nreverse (delq nil clist)))
28028 clist))
28030 ;; FIXME: Compare with at-regexp-p Do we need both?
28031 (defun org-in-regexp (re &optional nlines visually)
28032 "Check if point is inside a match of regexp.
28033 Normally only the current line is checked, but you can include NLINES extra
28034 lines both before and after point into the search.
28035 If VISUALLY is set, require that the cursor is not after the match but
28036 really on, so that the block visually is on the match."
28037 (catch 'exit
28038 (let ((pos (point))
28039 (eol (point-at-eol (+ 1 (or nlines 0))))
28040 (inc (if visually 1 0)))
28041 (save-excursion
28042 (beginning-of-line (- 1 (or nlines 0)))
28043 (while (re-search-forward re eol t)
28044 (if (and (<= (match-beginning 0) pos)
28045 (>= (+ inc (match-end 0)) pos))
28046 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
28048 (defun org-at-regexp-p (regexp)
28049 "Is point inside a match of REGEXP in the current line?"
28050 (catch 'exit
28051 (save-excursion
28052 (let ((pos (point)) (end (point-at-eol)))
28053 (beginning-of-line 1)
28054 (while (re-search-forward regexp end t)
28055 (if (and (<= (match-beginning 0) pos)
28056 (>= (match-end 0) pos))
28057 (throw 'exit t)))
28058 nil))))
28060 (defun org-occur-in-agenda-files (regexp &optional nlines)
28061 "Call `multi-occur' with buffers for all agenda files."
28063 (let* ((files (org-agenda-files))
28064 (tnames (mapcar 'file-truename files))
28065 (extra org-agenda-text-search-extra-files)
28066 f)
28067 (while (setq f (pop extra))
28068 (unless (member (file-truename f) tnames)
28069 (add-to-list 'files f 'append)
28070 (add-to-list 'tnames (file-truename f) 'append)))
28071 (multi-occur
28072 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
28073 regexp)))
28075 (if (boundp 'occur-mode-find-occurrence-hook)
28076 ;; Emacs 23
28077 (add-hook 'occur-mode-find-occurrence-hook
28078 (lambda ()
28079 (when (org-mode-p)
28080 (org-reveal))))
28081 ;; Emacs 22
28082 (defadvice occur-mode-goto-occurrence
28083 (after org-occur-reveal activate)
28084 (and (org-mode-p) (org-reveal)))
28085 (defadvice occur-mode-goto-occurrence-other-window
28086 (after org-occur-reveal activate)
28087 (and (org-mode-p) (org-reveal)))
28088 (defadvice occur-mode-display-occurrence
28089 (after org-occur-reveal activate)
28090 (when (org-mode-p)
28091 (let ((pos (occur-mode-find-occurrence)))
28092 (with-current-buffer (marker-buffer pos)
28093 (save-excursion
28094 (goto-char pos)
28095 (org-reveal)))))))
28097 (defun org-uniquify (list)
28098 "Remove duplicate elements from LIST."
28099 (let (res)
28100 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
28101 res))
28103 (defun org-delete-all (elts list)
28104 "Remove all elements in ELTS from LIST."
28105 (while elts
28106 (setq list (delete (pop elts) list)))
28107 list)
28109 (defun org-back-over-empty-lines ()
28110 "Move backwards over witespace, to the beginning of the first empty line.
28111 Returns the number o empty lines passed."
28112 (let ((pos (point)))
28114 (beginning-of-line 2)
28115 (goto-char (min (point) pos))
28116 (count-lines (point) pos)))
28118 (defun org-skip-whitespace ()
28121 (defun org-point-in-group (point group &optional context)
28122 "Check if POINT is in match-group GROUP.
28123 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
28124 match. If the match group does ot exist or point is not inside it,
28125 return nil."
28126 (and (match-beginning group)
28127 (>= point (match-beginning group))
28128 (<= point (match-end group))
28129 (if context
28130 (list context (match-beginning group) (match-end group))
28131 t)))
28133 (defun org-switch-to-buffer-other-window (&rest args)
28134 "Switch to buffer in a second window on the current frame.
28135 In particular, do not allow pop-up frames."
28136 (let (pop-up-frames special-display-buffer-names special-display-regexps
28137 special-display-function)
28138 (apply 'switch-to-buffer-other-window args)))
28140 (defun org-combine-plists (&rest plists)
28141 "Create a single property list from all plists in PLISTS.
28142 The process starts by copying the first list, and then setting properties
28143 from the other lists. Settings in the last list are the most significant
28144 ones and overrule settings in the other lists."
28145 (let ((rtn (copy-sequence (pop plists)))
28146 p v ls)
28147 (while plists
28148 (setq ls (pop plists))
28149 (while ls
28150 (setq p (pop ls) v (pop ls))
28151 (setq rtn (plist-put rtn p v))))
28152 rtn))
28154 (defun org-move-line-down (arg)
28155 "Move the current line down. With prefix argument, move it past ARG lines."
28156 (interactive "p")
28157 (let ((col (current-column))
28158 beg end pos)
28159 (beginning-of-line 1) (setq beg (point))
28160 (beginning-of-line 2) (setq end (point))
28161 (beginning-of-line (+ 1 arg))
28162 (setq pos (move-marker (make-marker) (point)))
28163 (insert (delete-and-extract-region beg end))
28164 (goto-char pos)
28165 (move-to-column col)))
28167 (defun org-move-line-up (arg)
28168 "Move the current line up. With prefix argument, move it past ARG lines."
28169 (interactive "p")
28170 (let ((col (current-column))
28171 beg end pos)
28172 (beginning-of-line 1) (setq beg (point))
28173 (beginning-of-line 2) (setq end (point))
28174 (beginning-of-line (- arg))
28175 (setq pos (move-marker (make-marker) (point)))
28176 (insert (delete-and-extract-region beg end))
28177 (goto-char pos)
28178 (move-to-column col)))
28180 (defun org-replace-escapes (string table)
28181 "Replace %-escapes in STRING with values in TABLE.
28183 The sequences in STRING may contain normal field width and padding information,
28185 so values can contain further %-escapes if they are define later in TABLE."
28186 (let ((case-fold-search nil)
28187 e re rpl)
28188 (while (setq e (pop table))
28189 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
28190 (while (string-match re string)
28191 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
28192 (cdr e)))
28193 (setq string (replace-match rpl t t string))))
28194 string))
28197 (defun org-sublist (list start end)
28198 "Return a section of LIST, from START to END.
28199 Counting starts at 1."
28200 (let (rtn (c start))
28201 (setq list (nthcdr (1- start) list))
28202 (while (and list (<= c end))
28203 (push (pop list) rtn)
28204 (setq c (1+ c)))
28205 (nreverse rtn)))
28207 (defun org-find-base-buffer-visiting (file)
28208 "Like `find-buffer-visiting' but alway return the base buffer and
28209 not an indirect buffer"
28210 (let ((buf (find-buffer-visiting file)))
28211 (if buf
28212 (or (buffer-base-buffer buf) buf)
28213 nil)))
28215 (defun org-image-file-name-regexp ()
28216 "Return regexp matching the file names of images."
28217 (if (fboundp 'image-file-name-regexp)
28218 (image-file-name-regexp)
28219 (let ((image-file-name-extensions
28220 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
28221 "xbm" "xpm" "pbm" "pgm" "ppm")))
28223 (regexp-opt (nconc (mapcar 'upcase
28224 image-file-name-extensions)
28225 image-file-name-extensions)
28226 t)
28229 (defun org-file-image-p (file)
28230 "Return non-nil if FILE is an image."
28231 (save-match-data
28232 (string-match (org-image-file-name-regexp) file)))
28234 ;;; Paragraph filling stuff.
28235 ;; We want this to be just right, so use the full arsenal.
28237 (defun org-indent-line-function ()
28238 "Indent line like previous, but further if previous was headline or item."
28239 (interactive)
28240 (let* ((pos (point))
28241 (itemp (org-at-item-p))
28242 column bpos bcol tpos tcol bullet btype bullet-type)
28243 ;; Find the previous relevant line
28244 (beginning-of-line 1)
28245 (cond
28246 ((looking-at "#") (setq column 0))
28248 (t
28249 (beginning-of-line 0)
28251 (beginning-of-line 0))
28252 (cond
28254 (goto-char (match-end 0))
28255 (setq column (current-column)))
28256 ((org-in-item-p)
28257 (org-beginning-of-item)
28260 (setq bpos (match-beginning 1) tpos (match-end 0)
28261 bcol (progn (goto-char bpos) (current-column))
28262 tcol (progn (goto-char tpos) (current-column))
28263 bullet (match-string 1)
28264 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
28265 (if (not itemp)
28266 (setq column tcol)
28267 (goto-char pos)
28268 (beginning-of-line 1)
28270 (progn
28272 (setq bullet (match-string 1)
28273 btype (if (string-match "[0-9]" bullet) "n" bullet))
28274 (setq column (if (equal btype bullet-type) bcol tcol)))
28275 (setq column (org-get-indentation)))))
28276 (t (setq column (org-get-indentation))))))
28277 (goto-char pos)
28278 (if (<= (current-column) (current-indentation))
28279 (indent-line-to column)
28280 (save-excursion (indent-line-to column)))
28281 (setq column (current-column))
28282 (beginning-of-line 1)
28283 (if (looking-at
28286 (match-string 2) (match-string 3)))
28287 t nil))
28288 (move-to-column column)))
28290 (defun org-set-autofill-regexps ()
28291 (interactive)
28292 ;; In the paragraph separator we include headlines, because filling
28293 ;; text in a line directly attached to a headline would otherwise
28294 ;; fill the headline as well.
28297 ;; The paragraph starter includes hand-formatted lists.
28298 (org-set-local 'paragraph-start
28300 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
28301 ;; But only if the user has not turned off tables or fixed-width regions
28302 (org-set-local
28303 'auto-fill-inhibit-regexp
28306 (if (or org-enable-table-editor org-enable-fixed-width-editor)
28307 (concat
28309 (if org-enable-table-editor "|" "")
28310 (if org-enable-fixed-width-editor ":" "")
28311 "]"))))
28312 ;; We use our own fill-paragraph function, to make sure that tables
28313 ;; and fixed-width regions are not wrapped. That function will pass
28314 ;; through to `fill-paragraph' when appropriate.
28315 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
28316 ; Adaptive filling: To get full control, first make sure that
28317 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
28319 (org-set-local 'adaptive-fill-function
28320 'org-adaptive-fill-function)
28321 (org-set-local
28322 'align-mode-rules-list
28323 '((org-in-buffer-settings
28325 (modes . '(org-mode))))))
28327 (defun org-fill-paragraph (&optional justify)
28328 "Re-align a table, pass through to fill-paragraph if no table."
28329 (let ((table-p (org-at-table-p))
28330 (table.el-p (org-at-table.el-p)))
28331 (cond ((and (equal (char-after (point-at-bol)) ?*)
28332 (save-excursion (goto-char (point-at-bol))
28333 (looking-at outline-regexp)))
28334 t) ; skip headlines
28335 (table.el-p t) ; skip table.el tables
28336 (table-p (org-table-align) t) ; align org-mode tables
28337 (t nil)))) ; call paragraph-fill
28339 ;; For reference, this is the default value of adaptive-fill-regexp
28342 (defun org-adaptive-fill-function ()
28343 "Return a fill prefix for org-mode files.
28344 In particular, this makes sure hanging paragraphs for hand-formatted lists
28345 work correctly."
28347 (match-string 0))
28349 (save-excursion
28350 (goto-char (match-end 0))
28351 (make-string (current-column) ?\ )))
28352 (t nil)))
28354 ;;;; Functions extending outline functionality
28357 (defun org-beginning-of-line (&optional arg)
28358 "Go to the beginning of the current line. If that is invisible, continue
28359 to a visible line beginning. This makes the function of C-a more intuitive.
28360 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28361 first attempt, and only move to after the tags when the cursor is already
28362 beyond the end of the headline."
28363 (interactive "P")
28364 (let ((pos (point)))
28365 (beginning-of-line 1)
28366 (if (bobp)
28367 nil
28368 (backward-char 1)
28369 (if (org-invisible-p)
28370 (while (and (not (bobp)) (org-invisible-p))
28371 (backward-char 1)
28372 (beginning-of-line 1))
28373 (forward-char 1)))
28374 (when org-special-ctrl-a/e
28375 (cond
28376 ((and (looking-at org-todo-line-regexp)
28377 (= (char-after (match-end 1)) ?\ ))
28378 (goto-char
28379 (if (eq org-special-ctrl-a/e t)
28380 (cond ((> pos (match-beginning 3)) (match-beginning 3))
28381 ((= pos (point)) (match-beginning 3))
28382 (t (point)))
28383 (cond ((> pos (point)) (point))
28384 ((not (eq last-command this-command)) (point))
28385 (t (match-beginning 3))))))
28386 ((org-at-item-p)
28387 (goto-char
28388 (if (eq org-special-ctrl-a/e t)
28389 (cond ((> pos (match-end 4)) (match-end 4))
28390 ((= pos (point)) (match-end 4))
28391 (t (point)))
28392 (cond ((> pos (point)) (point))
28393 ((not (eq last-command this-command)) (point))
28394 (t (match-end 4))))))))))
28396 (defun org-end-of-line (&optional arg)
28397 "Go to the end of the line.
28398 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
28399 first attempt, and only move to after the tags when the cursor is already
28400 beyond the end of the headline."
28401 (interactive "P")
28402 (if (or (not org-special-ctrl-a/e)
28403 (not (org-on-heading-p)))
28404 (end-of-line arg)
28405 (let ((pos (point)))
28406 (beginning-of-line 1)
28408 (if (eq org-special-ctrl-a/e t)
28409 (if (or (< pos (match-beginning 1))
28410 (= pos (match-end 0)))
28411 (goto-char (match-beginning 1))
28412 (goto-char (match-end 0)))
28413 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
28414 (goto-char (match-end 0))
28415 (goto-char (match-beginning 1))))
28416 (end-of-line arg)))))
28418 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
28419 (define-key org-mode-map "\C-e" 'org-end-of-line)
28421 (defun org-kill-line (&optional arg)
28422 "Kill line, to tags or end of line."
28423 (interactive "P")
28424 (cond
28425 ((or (not org-special-ctrl-k)
28426 (bolp)
28427 (not (org-on-heading-p)))
28428 (call-interactively 'kill-line))
28430 (kill-region (point) (match-beginning 1))
28431 (org-set-tags nil t))
28432 (t (kill-region (point) (point-at-eol)))))
28434 (define-key org-mode-map "\C-k" 'org-kill-line)
28436 (defun org-invisible-p ()
28437 "Check if point is at a character currently not visible."
28438 ;; Early versions of noutline don't have `outline-invisible-p'.
28439 (if (fboundp 'outline-invisible-p)
28440 (outline-invisible-p)
28441 (get-char-property (point) 'invisible)))
28443 (defun org-invisible-p2 ()
28444 "Check if point is at a character currently not visible."
28445 (save-excursion
28446 (if (and (eolp) (not (bobp))) (backward-char 1))
28447 ;; Early versions of noutline don't have `outline-invisible-p'.
28448 (if (fboundp 'outline-invisible-p)
28449 (outline-invisible-p)
28450 (get-char-property (point) 'invisible))))
28452 (defalias 'org-back-to-heading 'outline-back-to-heading)
28453 (defalias 'org-on-heading-p 'outline-on-heading-p)
28454 (defalias 'org-at-heading-p 'outline-on-heading-p)
28455 (defun org-at-heading-or-item-p ()
28456 (or (org-on-heading-p) (org-at-item-p)))
28458 (defun org-on-target-p ()
28459 (or (org-in-regexp org-radio-target-regexp)
28460 (org-in-regexp org-target-regexp)))
28462 (defun org-up-heading-all (arg)
28463 "Move to the heading line of which the present line is a subheading.
28464 This function considers both visible and invisible heading lines.
28465 With argument, move up ARG levels."
28466 (if (fboundp 'outline-up-heading-all)
28467 (outline-up-heading-all arg) ; emacs 21 version of outline.el
28468 (outline-up-heading arg t))) ; emacs 22 version of outline.el
28470 (defun org-up-heading-safe ()
28471 "Move to the heading line of which the present line is a subheading.
28472 This version will not throw an error. It will return the level of the
28473 headline found, or nil if no higher level is found."
28474 (let ((pos (point)) start-level level
28475 (re (concat "^" outline-regexp)))
28476 (catch 'exit
28477 (outline-back-to-heading t)
28478 (setq start-level (funcall outline-level))
28479 (if (equal start-level 1) (throw 'exit nil))
28480 (while (re-search-backward re nil t)
28481 (setq level (funcall outline-level))
28482 (if (< level start-level) (throw 'exit level)))
28483 nil)))
28485 (defun org-first-sibling-p ()
28486 "Is this heading the first child of its parents?"
28487 (interactive)
28488 (let ((re (concat "^" outline-regexp))
28489 level l)
28490 (unless (org-at-heading-p t)
28491 (error "Not at a heading"))
28492 (setq level (funcall outline-level))
28493 (save-excursion
28494 (if (not (re-search-backward re nil t))
28495 t
28496 (setq l (funcall outline-level))
28497 (< l level)))))
28499 (defun org-goto-sibling (&optional previous)
28500 "Goto the next sibling, even if it is invisible.
28501 When PREVIOUS is set, go to the previous sibling instead. Returns t
28502 when a sibling was found. When none is found, return nil and don't
28503 move point."
28504 (let ((fun (if previous 're-search-backward 're-search-forward))
28505 (pos (point))
28506 (re (concat "^" outline-regexp))
28507 level l)
28508 (when (condition-case nil (org-back-to-heading t) (error nil))
28509 (setq level (funcall outline-level))
28510 (catch 'exit
28511 (or previous (forward-char 1))
28512 (while (funcall fun re nil t)
28513 (setq l (funcall outline-level))
28514 (when (< l level) (goto-char pos) (throw 'exit nil))
28515 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28516 (goto-char pos)
28517 nil))))
28519 (defun org-show-siblings ()
28520 "Show all siblings of the current headline."
28521 (save-excursion
28522 (while (org-goto-sibling) (org-flag-heading nil)))
28523 (save-excursion
28524 (while (org-goto-sibling 'previous)
28525 (org-flag-heading nil))))
28527 (defun org-show-hidden-entry ()
28528 "Show an entry where even the heading is hidden."
28529 (save-excursion
28530 (org-show-entry)))
28532 (defun org-flag-heading (flag &optional entry)
28533 "Flag the current heading. FLAG non-nil means make invisible.
28534 When ENTRY is non-nil, show the entire entry."
28535 (save-excursion
28536 (org-back-to-heading t)
28537 ;; Check if we should show the entire entry
28538 (if entry
28539 (progn
28540 (org-show-entry)
28541 (save-excursion
28542 (and (outline-next-heading)
28543 (org-flag-heading nil))))
28544 (outline-flag-region (max (point-min) (1- (point)))
28545 (save-excursion (outline-end-of-heading) (point))
28546 flag))))
28548 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28549 ;; This is an exact copy of the original function, but it uses
28550 ;; `org-back-to-heading', to make it work also in invisible
28551 ;; trees. And is uses an invisible-OK argument.
28552 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28553 (org-back-to-heading invisible-OK)
28554 (let ((first t)
28555 (level (funcall outline-level)))
28556 (while (and (not (eobp))
28557 (or first (> (funcall outline-level) level)))
28558 (setq first nil)
28559 (outline-next-heading))
28560 (unless to-heading
28562 (progn
28563 ;; Go to end of line before heading
28564 (forward-char -1)
28566 ;; leave blank line before heading
28567 (forward-char -1))))))
28568 (point))
28570 (defun org-show-subtree ()
28571 "Show everything after this heading at deeper levels."
28572 (outline-flag-region
28573 (point)
28574 (save-excursion
28575 (outline-end-of-subtree) (outline-next-heading) (point))
28576 nil))
28578 (defun org-show-entry ()
28579 "Show the body directly following this heading.
28580 Show the heading too, if it is currently invisible."
28581 (interactive)
28582 (save-excursion
28583 (condition-case nil
28584 (progn
28585 (org-back-to-heading t)
28586 (outline-flag-region
28587 (max (point-min) (1- (point)))
28588 (save-excursion
28589 (re-search-forward
28591 (or (match-beginning 1) (point-max)))
28592 nil))
28593 (error nil))))
28595 (defun org-make-options-regexp (kwds)
28596 "Make a regular expression for keyword lines."
28597 (concat
28598 "^"
28604 ;; Make isearch reveal the necessary context
28605 (defun org-isearch-end ()
28606 "Reveal context after isearch exits."
28607 (when isearch-success ; only if search was successful
28608 (if (featurep 'xemacs)
28609 ;; Under XEmacs, the hook is run in the correct place,
28610 ;; we directly show the context.
28611 (org-show-context 'isearch)
28612 ;; In Emacs the hook runs *before* restoring the overlays.
28613 ;; So we have to use a one-time post-command-hook to do this.
28614 ;; (Emacs 22 has a special variable, see function `org-mode')
28615 (unless (and (boundp 'isearch-mode-end-hook-quit)
28616 isearch-mode-end-hook-quit)
28617 ;; Only when the isearch was not quitted.
28618 (org-add-hook 'post-command-hook 'org-isearch-post-command
28619 'append 'local)))))
28621 (defun org-isearch-post-command ()
28622 "Remove self from hook, and show context."
28623 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28624 (org-show-context 'isearch))
28627 ;;;; Integration with and fixes for other packages
28629 ;;; Imenu support
28631 (defvar org-imenu-markers nil
28632 "All markers currently used by Imenu.")
28633 (make-variable-buffer-local 'org-imenu-markers)
28635 (defun org-imenu-new-marker (&optional pos)
28636 "Return a new marker for use by Imenu, and remember the marker."
28637 (let ((m (make-marker)))
28638 (move-marker m (or pos (point)))
28639 (push m org-imenu-markers)
28640 m))
28642 (defun org-imenu-get-tree ()
28643 "Produce the index for Imenu."
28644 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28645 (setq org-imenu-markers nil)
28646 (let* ((n org-imenu-depth)
28647 (re (concat "^" outline-regexp))
28648 (subs (make-vector (1+ n) nil))
28649 (last-level 0)
28650 m tree level head)
28651 (save-excursion
28652 (save-restriction
28653 (widen)
28654 (goto-char (point-max))
28655 (while (re-search-backward re nil t)
28656 (setq level (org-reduced-level (funcall outline-level)))
28657 (when (<= level n)
28658 (looking-at org-complex-heading-regexp)
28659 (setq head (org-match-string-no-properties 4)
28660 m (org-imenu-new-marker))
28661 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28662 (if (>= level last-level)
28663 (push (cons head m) (aref subs level))
28664 (push (cons head (aref subs (1+ level))) (aref subs level))
28665 (loop for i from (1+ level) to n do (aset subs i nil)))
28666 (setq last-level level)))))
28667 (aref subs 1)))
28669 (eval-after-load "imenu"
28670 '(progn
28671 (add-hook 'imenu-after-jump-hook
28672 (lambda () (org-show-context 'org-goto)))))
28674 ;; Speedbar support
28676 (defun org-speedbar-set-agenda-restriction ()
28677 "Restrict future agenda commands to the location at point in speedbar.
28679 (interactive)
28680 (let (p m tp np dir txt w)
28681 (cond
28682 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28683 'org-imenu t))
28684 (setq m (get-text-property p 'org-imenu-marker))
28685 (save-excursion
28686 (save-restriction
28687 (set-buffer (marker-buffer m))
28688 (goto-char m)
28689 (org-agenda-set-restriction-lock 'subtree))))
28690 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28691 'speedbar-function 'speedbar-find-file))
28692 (setq tp (previous-single-property-change
28693 (1+ p) 'speedbar-function)
28694 np (next-single-property-change
28695 tp 'speedbar-function)
28696 dir (speedbar-line-directory)
28697 txt (buffer-substring-no-properties (or tp (point-min))
28698 (or np (point-max))))
28699 (save-excursion
28700 (save-restriction
28701 (set-buffer (find-file-noselect
28702 (let ((default-directory dir))
28703 (expand-file-name txt))))
28704 (unless (org-mode-p)
28705 (error "Cannot restrict to non-Org-mode file"))
28706 (org-agenda-set-restriction-lock 'file))))
28707 (t (error "Don't know how to restrict Org-mode's agenda")))
28708 (org-move-overlay org-speedbar-restriction-lock-overlay
28709 (point-at-bol) (point-at-eol))
28710 (setq current-prefix-arg nil)
28711 (org-agenda-maybe-redo)))
28713 (eval-after-load "speedbar"
28714 '(progn
28715 (speedbar-add-supported-extension ".org")
28716 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28717 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28718 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28719 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28720 (add-hook 'speedbar-visiting-tag-hook
28721 (lambda () (org-show-context 'org-goto)))))
28724 ;;; Fixes and Hacks
28726 ;; Make flyspell not check words in links, to not mess up our keymap
28727 (defun org-mode-flyspell-verify ()
28728 "Don't let flyspell put overlays at active buttons."
28729 (not (get-text-property (point) 'keymap)))
28731 ;; Make `bookmark-jump' show the jump location if it was hidden.
28732 (eval-after-load "bookmark"
28733 '(if (boundp 'bookmark-after-jump-hook)
28734 ;; We can use the hook
28735 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28736 ;; Hook not available, use advice
28737 (defadvice bookmark-jump (after org-make-visible activate)
28738 "Make the position visible."
28739 (org-bookmark-jump-unhide))))
28741 (defun org-bookmark-jump-unhide ()
28742 "Unhide the current position, to show the bookmark location."
28743 (and (org-mode-p)
28744 (or (org-invisible-p)
28745 (save-excursion (goto-char (max (point-min) (1- (point))))
28746 (org-invisible-p)))
28747 (org-show-context 'bookmark-jump)))
28749 ;; Fix a bug in htmlize where there are text properties (face nil)
28750 (eval-after-load "htmlize"
28751 '(progn
28752 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28753 "Make sure there are no nil faces"
28754 (setq ad-return-value (delq nil ad-return-value)))))
28756 ;; Make session.el ignore our circular variable
28757 (eval-after-load "session"
28758 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28760 ;;;; Experimental code
28762 (defun org-closed-in-range ()
28763 "Sparse tree of items closed in a certain time range.
28764 Still experimental, may disappear in the future."
28765 (interactive)
28766 ;; Get the time interval from the user.
28767 (let* ((time1 (time-to-seconds
28768 (org-read-date nil 'to-time nil "Starting date: ")))
28769 (time2 (time-to-seconds
28770 (org-read-date nil 'to-time nil "End date:")))
28771 ;; callback function
28772 (callback (lambda ()
28773 (let ((time
28774 (time-to-seconds
28775 (apply 'encode-time
28776 (org-parse-time-string
28777 (match-string 1))))))
28778 ;; check if time in interval
28779 (and (>= time time1) (<= time time2))))))
28780 ;; make tree, check each match with the callback
28783 ;;;; Finish up
28785 (provide 'org)
28787 (run-hooks 'org-load-hook)
28789 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28790 ;;; org.el ends here