| blob | b10fb418e7bd2676863188abea68ca2079e4d39c |
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."
154 ;; FIXME: Needs a separate group...
157 Normal means, no org-mode-specific context."
162 "Options concerning startup of Org-mode."
167 "Non-nil means, entering Org-mode will switch to OVERVIEW.
168 This can also be configured on a per-file basis by adding one of
169 the following lines anywhere in the buffer:
171 #+STARTUP: fold
172 #+STARTUP: nofold
173 #+STARTUP: content"
181 "Non-nil means, entering Org-mode will set `truncate-lines'.
182 This is useful since some lines containing links can be very long and
183 uninteresting. Also tables look terrible when wrapped."
188 "Non-nil means, align all tables when visiting a file.
189 This is useful when the column width in tables is forced with <N> cookies
190 in table fields. Such tables will look correct only after the first re-align.
191 This can also be configured on a per-file basis by adding one of
192 the following lines anywhere in the buffer:
193 #+STARTUP: align
194 #+STARTUP: noalign"
199 "Non-nil means insert the first line setting Org-mode in empty files.
200 When the function `org-mode' is called interactively in an empty file, this
201 normally means that the file name does not automatically trigger Org-mode.
202 To ensure that the file will always be in Org-mode in the future, a
203 line enforcing Org-mode will be inserted into the buffer, if this option
204 has been set."
209 "Non-nil means use alternative key bindings for some keys.
210 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
211 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
212 If you want to use Org-mode together with one of these other modes,
213 or more generally if you would like to move some Org-mode commands to
214 other keys, set this variable and configure the keys with the variable
215 `org-disputed-keys'.
217 This option is only relevant at load-time of Org-mode, and must be set
218 *before* org.el is loaded. Changing it requires a restart of Emacs to
219 become effective."
233 "Keys for which Org-mode and other modes compete.
234 This is an alist, cars are the default keys, second element specifies
235 the alternative to use when `org-replace-disputed-keys' is t.
237 Keys can be specified in any syntax supported by `define-key'.
238 The value of this option takes effect only at Org-mode's startup,
239 therefore you'll have to restart Emacs to apply it after changing."
244 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
245 Or return the original if not disputed."
250 org-disputed-keys)))
252 key))
262 "Define a key, possibly translated, as returned by `org-key'."
266 "The ellipsis to use in the Org-mode outline.
267 When nil, just use the standard three dots. When a string, use that instead,
268 When a face, use the standart 3 dots, but with the specified face.
269 The change affects only Org-mode (which will then use its own display table).
270 Changing this requires executing `M-x org-mode' in a buffer to become
271 effective."
281 "Keywords in Org-mode."
286 "String to mark deadline entries.
287 A deadline is this string, followed by a time stamp. Should be a word,
288 terminated by a colon. You can insert a schedule keyword and
290 Changes become only effective after restarting Emacs."
295 "String to mark scheduled TODO entries.
296 A schedule is this string, followed by a time stamp. Should be a word,
297 terminated by a colon. You can insert a schedule keyword and
299 Changes become only effective after restarting Emacs."
304 "String used as the prefix for timestamps logging closing a TODO entry."
309 "String used as prefix for timestamps clocking work hours on an item."
314 "Entries starting with this keyword will never be exported.
315 An entry can be toggled between COMMENT and normal with
317 Changes become only effective after restarting Emacs."
322 "Entries starting with this keyword will be exported in fixed-width font.
323 Quoting applies only to the text in the entry following the headline, and does
324 not extend beyond the next headline, even if that is lower level.
325 An entry can be toggled between QUOTE and normal with
331 ; (concat "\\(?:\\<\\(?:" org-scheduled-string "\\|" org-deadline-string "\\)"
332 ; " +<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\)\\(\\+[0-9]+[dwmy]\\)")
334 "Regular expression for specifying repeated events.
338 "Options concerning the general structure of Org-mode files."
343 "Options about how to make context of a location visible."
367 "Non-nil means, show full hierarchy when revealing a location.
368 Org-mode often shows locations in an org-mode file which might have
369 been invisible before. When this is set, the hierarchy of headings
370 above the exposed location is shown.
371 Turning this off for example for sparse trees makes them very compact.
372 Instead of t, this can also be an alist specifying this option for different
373 contexts. Valid contexts are
374 agenda when exposing an entry from the agenda
375 org-goto when using the command `org-goto' on key C-c C-j
376 occur-tree when using the command `org-occur' on key C-c /
377 tags-tree when constructing a sparse tree based on tags matches
378 link-search when exposing search matches associated with a link
379 mark-goto when exposing the jump goal of a mark
380 bookmark-jump when exposing a bookmark location
381 isearch when exiting from an incremental search
382 default default for all contexts not set explicitly"
387 "Non-nil means, show following heading when revealing a location.
388 Org-mode often shows locations in an org-mode file which might have
389 been invisible before. When this is set, the heading following the
390 match is shown.
391 Turning this off for example for sparse trees makes them very compact,
392 but makes it harder to edit the location of the match. In such a case,
394 Instead of t, this can also be an alist specifying this option for different
395 contexts. See `org-show-hierarchy-above' for valid contexts."
400 "Non-nil means, show all sibling heading when revealing a location.
401 Org-mode often shows locations in an org-mode file which might have
402 been invisible before. When this is set, the sibling of the current entry
403 heading are all made visible. If `org-show-hierarchy-above' is t,
404 the same happens on each level of the hierarchy above the current entry.
406 By default this is on for the isearch context, off for all other contexts.
407 Turning this off for example for sparse trees makes them very compact,
408 but makes it harder to edit the location of the match. In such a case,
410 Instead of t, this can also be an alist specifying this option for different
411 contexts. See `org-show-hierarchy-above' for valid contexts."
416 "Non-nil means, show the entry below a headline when revealing a location.
417 Org-mode often shows locations in an org-mode file which might have
418 been invisible before. When this is set, the text below the headline that is
419 exposed is also shown.
421 By default this is off for all contexts.
422 Instead of t, this can also be an alist specifying this option for different
423 contexts. See `org-show-hierarchy-above' for valid contexts."
428 "Options concerning visibility cycling in Org-mode."
433 "Names of drawers. Drawers are not opened by cycling on the headline above.
434 Drawers only open with a TAB on the drawer line itself. A drawer looks like
435 this:
436 :DRAWERNAME:
437 .....
438 :END:
440 the property API.
442 Drawers can be defined on the per-file basis with a line like:
444 #+DRAWERS: HIDDEN STATE PROPERTIES"
449 "Cycle globally if cursor is at beginning of buffer and not at a headline.
450 This makes it possible to do global cycling without having to use S-TAB or
451 C-u TAB. For this special case to work, the first line of the buffer
452 must not be a headline - it may be empty ot some other text. When used in
453 this way, `org-cycle-hook' is disables temporarily, to make sure the
454 cursor stays at the beginning of the buffer.
455 When this option is nil, don't do anything special at the beginning
456 of the buffer."
461 "Where should `org-cycle' emulate TAB.
462 nil Never
463 white Only in completely white lines
464 whitestart Only at the beginning of lines, before the first non-white char
465 t Everywhere except in headlines
466 exc-hl-bol Everywhere except at the start of a headline
467 If TAB is used in a place where it does not emulate TAB, the current subtree
468 visibility is cycled."
475 ))
478 "Number of empty lines needed to keep an empty line between collapsed trees.
479 If you leave an empty line between the end of a subtree and the following
480 headline, this empty line is hidden when the subtree is folded.
481 Org-mode will leave (exactly) one empty line visible if the number of
482 empty lines is equal or larger to the number given in this variable.
483 So the default 2 means, at least 2 empty lines after the end of a subtree
484 are needed to produce free space between a collapsed subtree and the
485 following headline.
487 Special case: when 0, never leave empty lines in collapsed view."
492 org-cycle-hide-drawers
493 org-cycle-show-empty-lines
494 org-optimize-window-after-visibility-change)
495 "Hook that is run after `org-cycle' has changed the buffer visibility.
496 The function(s) in this hook must accept a single argument which indicates
497 the new state that was set by the most recent `org-cycle' command. The
498 argument is a symbol. After a global state change, it can have the values
499 `overview', `content', or `all'. After a local state change, it can have
500 the values `folded', `children', or `subtree'."
505 "Options concerning structure editing in Org-mode."
510 "Non-nil means, skip even levels and only use odd levels for the outline.
511 This has the effect that two stars are being added/taken away in
512 promotion/demotion commands. It also influences how levels are
513 handled by the exporters.
514 Changing it requires restart of `font-lock-mode' to become effective
515 for fontification also in regions already fontified.
516 You may also set this on a per-file basis by adding one of the following
517 lines to the buffer:
519 #+STARTUP: odd
520 #+STARTUP: oddeven"
526 "Non-nil means, adapt indentation when promoting and demoting.
527 When this is set and the *entire* text in an entry is indented, the
528 indentation is increased by one space in a demotion command, and
529 decreased by one in a promotion command. If any line in the entry
530 body starts at column 0, indentation is not changed at all."
535 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
536 When t, `C-a' will bring back the cursor to the beginning of the
537 headline text, i.e. after the stars and after a possible TODO keyword.
538 In an item, this will be the position after the bullet.
539 When the cursor is already at that position, another `C-a' will bring
540 it to the beginning of the line.
541 `C-e' will jump to the end of the headline, ignoring the presence of tags
542 in the headline. A second `C-e' will then jump to the true end of the
543 line, after any tags.
544 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
545 and only a directly following, identical keypress will bring the cursor
546 to the special positions."
557 "Non-nil means `C-k' will behave specially in headlines.
558 When nil, `C-k' will call the default `kill-line' command.
559 When t, the following will happen while the cursor is in the headline:
561 - When the cursor is at the beginning of a headline, kill the entire
562 line and possible the folded subtree below the line.
563 - When in the middle of the headline text, kill the headline up to the tags.
564 - When after the headline text, kill the tags."
569 "Non-nil means, M-RET will split the line at the cursor position.
570 When nil, it will go to the end of the line before making a
571 new line.
572 You may also set this option in a different way for different
573 contexts. Valid contexts are:
575 headline when creating a new headline
576 item when creating a new item
577 table in a table field
578 default the value to be used for all contexts not explicitly
579 customized"
597 "Should `org-insert-heading' leave a blank line before new heading/item?
598 The value is an alist, with `heading' and `plain-list-item' as car,
599 and a boolean flag as cdr."
606 "Hook being run after inserting a new heading."
612 This currently only means, they are never auto-wrapped.
613 When nil, such lines will be treated like ordinary lines.
614 See also the QUOTE keyword."
619 "Non-nil means, typing characters in org-goto starts incremental search."
624 "Options concerning sparse trees in Org-mode."
629 "Non-nil means, highlight all matches that define a sparse tree.
630 The highlights will automatically disappear the next time the buffer is
631 changed by an edit command."
636 "Non-nil means, any change to the buffer will remove temporary highlights.
637 Such highlights are created by `org-occur' and `org-clock-display'.
638 When nil, `C-c C-c needs to be used to get rid of the highlights.
639 The highlights created by `org-preview-latex-fragment' always need
640 `C-c C-c' to be removed."
647 "Hook that is run after `org-occur' has constructed a sparse tree.
648 This can be used to recenter the window to show as much of the structure
649 as possible."
654 "Options concerning plain lists in Org-mode."
659 "Non-nil means, include plain lists into visibility cycling.
660 This means that during cycling, plain list items will *temporarily* be
661 interpreted as outline headlines with a level given by 1000+i where i is the
662 indentation of the bullet. In all other operations, plain list items are
663 not seen as headlines. For example, you cannot assign a TODO keyword to
664 such an item."
669 "The character that makes a line with leading number an ordered list item.
670 Valid values are ?. and ?\). To get both terminators, use t. While
671 ?. may look nicer, it creates the danger that a line with leading
672 number may be incorrectly interpreted as an item. ?\) therefore is
673 the safe choice."
680 "Non-nil means, automatically renumber ordered plain lists.
681 Renumbering happens when the sequence have been changed with
688 "Non-nil means, update checkbox statistics after insert and toggle.
689 When this is set, checkbox statistics is updated each time you either insert
696 "Options concerning archiving in Org-mode."
701 "The tag that marks a subtree as archived.
702 An archived subtree does not open during visibility cycling, and does
703 not contribute to the agenda listings.
704 After changing this, font-lock must be restarted in the relevant buffers to
705 get the proper fontification."
711 "Non-nil means, the agenda will skip any items located in archived trees.
712 An archived tree is a tree marked with the tag ARCHIVE."
718 "Non-nil means, `org-cycle' will open archived trees.
719 An archived tree is a tree marked with the tag ARCHIVE.
720 When nil, archived trees will stay folded. You can still open them with
721 normal outline commands like `show-all', but not with the cycling commands."
727 "Non-nil means sparse tree construction shows matches in archived trees.
728 When nil, matches in these trees are highlighted, but the trees are kept in
729 collapsed state."
735 "The location where subtrees should be archived.
736 This string consists of two parts, separated by a double-colon.
738 The first part is a file name - when omitted, archiving happens in the same
739 file. %s will be replaced by the current file name (without directory part).
740 Archiving to a different file is useful to keep archived entries from
741 contributing to the Org-mode Agenda.
743 The part after the double colon is a headline. The archived entries will be
744 filed under that headline. When omitted, the subtrees are simply filed away
745 at the end of the file, as top-level entries.
747 Here are a few examples:
749 If the current file is Projects.org, archive in file
750 Projects.org_archive, as top-level trees. This is the default.
753 Archive in the current file, under the top-level headline
757 Archive in file ~/org/archive.org (absolute path), as top-level trees.
760 Archive in file ./basement (relative path), as level 3 trees
763 You may set this option on a per-file basis by adding to the buffer a
764 line like
766 #+ARCHIVE: basement::** Finished Tasks"
771 "Non-nil means, mark entries as DONE when they are moved to the archive file.
772 This can be a string to set the keyword to use. When t, Org-mode will
773 use the first keyword in its list that means done."
781 "Non-nil means, add a time stamp to entries moved to an archive file.
782 This variable is obsolete and has no effect anymore, instead add ot remove
783 `time' from the variablle `org-archive-save-context-info'."
788 "Parts of context info that should be stored as properties when archiving.
789 When a subtree is moved to an archive file, it looses information given by
790 context, like inherited tags, the category, and possibly also the TODO
791 state (depending on the variable `org-archive-mark-done').
792 This variable can be a list of any of the following symbols:
794 time The time of archiving.
795 file The file where the entry originates.
796 itags The local tags, in the headline of the subtree.
797 ltags The tags the subtree inherits from further up the hierarchy.
798 todo The pre-archive TODO state.
799 category The category, taken from file name or #+CATEGORY lines.
800 olpath The outline path to the item. These are all headlines above
801 the current item, separated by /, like a file path.
803 For each symbol present in the list, a property will be created in
805 information."
818 "Options concerning imenu and speedbar in Org-mode."
823 "The maximum level for Imenu access to Org-mode headlines.
824 This also applied for speedbar access."
829 "Options concerning tables in Org-mode."
835 When nil, such lines will be treated like ordinary lines.
837 When equal to the symbol `optimized', the table editor will be optimized to
838 do the following:
839 - Automatic overwrite mode in front of whitespace in table fields.
840 This makes the structure of the table stay in tact as long as the edited
841 field does not exceed the column width.
842 - Minimize the number of realigns. Normally, the table is aligned each time
843 TAB or RET are pressed to move to another field. With optimization this
844 happens only if changes to a field might have changed the column width.
845 Optimization requires replacing the functions `self-insert-command',
846 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
847 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
848 very good at guessing when a re-align will be necessary, but you can always
851 If you would like to use the optimized version in Org-mode, but the
852 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
854 This variable can be used to turn on and off the table editor during a session,
855 but in order to toggle optimization, a restart is required.
857 See also the variable `org-table-auto-blank-field'."
865 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
866 In the optimized version, the table editor takes over all simple keys that
867 normally just insert a character. In tables, the characters are inserted
868 in a way to minimize disturbing the table structure (i.e. in overwrite mode
869 for empty fields). Outside tables, the correct binding of the keys is
870 restored.
872 The default for this option is t if the optimized version is also used in
873 Org-mode. See the variable `org-enable-table-editor' for details. Changing
874 this variable requires a restart of Emacs to become effective."
880 % END RECEIVE ORGTBL %n
882 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
883 | | |
886 @c END RECEIVE ORGTBL %n
887 @ignore
888 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
889 | | |
892 <!-- END RECEIVE ORGTBL %n -->
893 <!--
894 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
895 | | |
897 "Templates for radio tables in different major modes.
898 All occurrences of %n in a template will be replaced with the name of the
899 table, obtained by prompting the user."
906 "Settings for tables in Org-mode."
911 "The default size for newly created tables, Columns x Rows."
917 "Regular expression for recognizing numbers in table columns.
918 If a table column contains mostly numbers, it will be aligned to the
919 right. If not, it will be aligned to the left.
921 The default value of this option is a regular expression which allows
922 anything which looks remotely like a number as used in scientific
923 context. For example, all of the following will be considered a
924 number:
925 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
927 Other options offered by the customize interface are more restrictive."
945 "Fraction of numbers in a column required to make the column align right.
946 In a column all non-white fields are considered. If at least this
947 fraction of fields is matched by `org-table-number-fraction',
948 alignment to the right border applies."
953 "Behavior of tables during editing in Org-mode."
958 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
960 removal/insertion."
965 "Non-nil means, automatically blank table field when starting to type into it.
966 This only happens when typing immediately after a field motion
967 command (TAB, S-TAB or RET).
968 Only relevant when `org-enable-table-editor' is equal to `optimized'."
973 "Non-nil means, tab in the last column of a table with jump over a hline.
974 If a horizontal separator line is following the current line,
975 `org-table-next-field' can either create a new row before that line, or jump
976 over the line. When this option is nil, a new line will be created before
977 this line."
982 "Non-nil means, TAB will automatically notice a table.el table.
983 When it sees such a table, it moves point into it and - if necessary -
984 calls `table-recognize-table'."
989 "Options concerning tables in Org-mode."
994 "Should org-mode work with table refrences like B3 instead of @3$2?
995 Possible values are:
996 nil never use them
997 from accept as input, do not present for editing
998 t: accept as input and present for editing"
1013 calc-angle-mode deg
1014 calc-prefer-frac nil
1015 calc-symbolic-mode nil
1017 calc-display-working-message t
1018 )
1019 "List with Calc mode settings for use in calc-eval for table formulas.
1020 The list must contain alternating symbols (Calc modes variables and values).
1021 Don't remove any of the default settings, just change the values. Org-mode
1022 relies on the variables to be present in the list."
1027 "Non-nil means, TAB and RET evaluate a formula in current table field.
1028 If the current field starts with an equal sign, it is assumed to be a formula
1029 which should be evaluated as described in the manual and in the documentation
1030 string of the command `org-table-eval-formula'. This feature requires the
1031 Emacs calc package.
1032 When this variable is nil, formula calculation is only available through
1038 "Non-nil means, interpret constants in formulas in tables.
1039 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1040 by the value given in `org-table-formula-constants', or by a value obtained
1041 from the `constants.el' package."
1046 "Alist with constant names and values, for use in table formulas.
1047 The car of each element is a name of a constant, without the `$' before it.
1048 The cdr is the value as a string. For example, if you'd like to use the
1049 speed of light in a formula, you would configure
1053 and then use it in an equation like `$1*$c'.
1055 Constants can also be defined on a per-file basis using a line like
1057 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1068 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1069 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1074 "Options concerning links in Org-mode."
1079 "Buffer-local version of `org-link-abbrev-alist', which see.
1084 "Alist of link abbreviations.
1085 The car of each element is a string, to be replaced at the start of a link.
1087 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1089 [[linkkey:tag][description]]
1091 If REPLACE is a string, the tag will simply be appended to create the link.
1094 REPLACE may also be a function that will be called with the tag as the
1095 only argument to create the link, which should be returned as a string.
1097 See the manual for examples."
1102 "Non-nil means, hide link part and only show description of bracket links.
1103 Bracket links are like [[link][descritpion]]. This variable sets the initial
1104 state in new org-mode buffers. The setting can then be toggled on a
1105 per-buffer basis from the Org->Hyperlinks menu."
1110 "How the path name in file links should be stored.
1111 Valid values are:
1113 relative Relative to the current directory, i.e. the directory of the file
1114 into which the link is being inserted.
1115 absolute Absolute path, if possible with ~ for home directory.
1116 noabbrev Absolute path, no abbreviation of home directory.
1117 adaptive Use relative path for files in the current directory and sub-
1118 directories of it. For other files, use an absolute path."
1127 "Types of links that should be activated in Org-mode files.
1128 This is a list of symbols, each leading to the activation of a certain link
1129 type. In principle, it does not hurt to turn on most link types - there may
1130 be a small gain when turning off unused link types. The types are:
1132 bracket The recommended [[link][description]] or [[link]] links with hiding.
1133 angular Links in angular brackes that may contain whitespace like
1134 <bbdb:Carsten Dominik>.
1135 plain Plain links in normal text, no whitespace, like http://google.com.
1136 radio Text that is matched by a radio target, see manual for details.
1137 tag Tag settings in a headline (link to tag search).
1138 date Time stamps (link to calendar).
1140 Changing this variable requires a restart of Emacs to become effective."
1151 "Options concerning storing links in Org-mode"
1156 "Format of the description part of a link to an email or usenet message.
1157 The following %-excapes will be replaced by corresponding information:
1165 %s subject
1166 %m message-id.
1168 You may use normal field width specification between the % and the letter.
1169 This is for example useful to limit the length of the subject.
1183 It should match if the message is from the user him/herself."
1188 "Non-nil means, file links from `org-store-link' contain context.
1189 A search string will be added to the file name with :: as separator and
1190 used to find the context when the link is activated by the command
1191 `org-open-at-point'.
1193 negates this setting for the duration of the command."
1198 "Non-nil means, keep link in list for entire session.
1200 The command `org-store-link' adds a link pointing to the current
1201 location to an internal list. These links accumulate during a session.
1202 The command `org-insert-link' can be used to insert links into any
1203 Org-mode file (offering completion for all stored links). When this
1205 will be removed from the list, to make completing the unused links
1206 more efficient."
1211 "Non-nil means, `org-store-link' will create web links to Google groups.
1212 When nil, Gnus will be used for such links.
1214 negates this setting for the duration of the command."
1219 "Options concerning following links in Org-mode"
1224 "Non-nil means, on links TAB will follow the link.
1225 Needs to be set before org.el is loaded."
1230 "Non-nil means, on links RET will follow the link.
1231 Needs to be set before org.el is loaded."
1236 "Non-nil means, mouse-1 on a link will follow the link.
1237 A longer mouse click will still set point. Does not wortk on XEmacs.
1238 Needs to be set before org.el is loaded."
1243 "Number of different positions to be recorded in the ring
1244 Changing this requires a restart of Emacs to work correctly."
1252 "Setup the frame configuration for following links.
1253 When following a link with Emacs, it may often be useful to display
1254 this link in another window or frame. This variable can be used to
1255 set this up for the different types of links.
1256 For VM, use any of
1257 `vm-visit-folder'
1258 `vm-visit-folder-other-frame'
1259 For Gnus, use any of
1260 `gnus'
1261 `gnus-other-frame'
1262 For FILE, use any of
1263 `find-file'
1264 `find-file-other-window'
1265 `find-file-other-frame'
1266 For the calendar, use the variable `calendar-setup'.
1267 For BBDB, it is currently only possible to display the matches in
1268 another window."
1287 "Non-nil means, use indirect buffer to display infile links.
1288 Activating internal links (from one location in a file to another location
1289 in the same file) normally just jumps to the location. When the link is
1290 activated with a C-u prefix (or with mouse-3), the link is displayed in
1291 another window. When this option is set, the other window actually displays
1292 an indirect buffer clone of the current buffer, to avoid any visibility
1293 changes to the current buffer."
1298 "Non-nil means, `org-open-file' will open non-existing files.
1299 When nil, an error will be generated."
1304 "Function and arguments to call for following mailto links.
1305 This is a list with the first element being a lisp function, and the
1306 remaining elements being arguments to the function. In string arguments,
1307 %a will be replaced by the address, and %s will be replaced by the subject
1308 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1317 "Non-nil means, ask for confirmation before executing shell links.
1318 Shell links can be dangerous: just think about a link
1320 [[shell:rm -rf ~/*][Google Search]]
1323 but really it would remove your entire home directory.
1324 Therefore we advise against setting this variable to nil.
1325 Just change it to `y-or-n-p' of you want to confirm with a
1334 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1335 Elisp links can be dangerous: just think about a link
1340 but really it would remove your entire home directory.
1341 Therefore we advise against setting this variable to nil.
1342 Just change it to `y-or-n-p' of you want to confirm with a
1353 "Default file applications on a UNIX or GNU/Linux system.
1365 "Default file applications on a MacOS X system.
1367 for some files for which the OS does not have a good default.
1375 'mswindows-shell-execute
1378 "Default file applications on a Windows NT system.
1383 '(
1390 )
1391 "External applications for opening `file:path' items in a document.
1392 Org-mode uses system defaults for different file types, but
1393 you can use this variable to set the application for a given file
1394 extension. The entries in this list are cons cells where the car identifies
1395 files and the cdr the corresponding command. Possible values for the
1396 file identifier are
1398 `directory' Matches a directory
1399 `remote' Matches a remote file, accessible through tramp or efs.
1400 Remote files most likely should be visited through Emacs
1401 because external applications cannot handle such paths.
1402 t Default for all remaining files
1404 Possible values for the command are:
1405 `emacs' The file will be visited by the current Emacs process.
1406 `default' Use the default application for this file type.
1407 string A command to be executed by a shell; %s will be replaced
1408 by the path to the file.
1409 sexp A Lisp form which will be evaluated. The file path will
1410 be available in the Lisp variable `file'.
1411 For more examples, see the system specific constants
1412 `org-file-apps-defaults-macosx'
1413 `org-file-apps-defaults-windowsnt'
1414 `org-file-apps-defaults-gnu'."
1429 "Non-nil means, that the search for the mh-message will be extended to
1430 all folders if the message cannot be found in the folder given in the link.
1431 Searching all folders is very efficient with one of the search engines
1432 supported by MH-E, but will be slow with pick."
1437 "Options concerning interaction with remember.el."
1442 "Directory with org files.
1443 This directory will be used as default to prompt for org files.
1444 Used by the hooks for remember.el."
1449 "Default target for storing notes.
1450 Used by the hooks for remember.el. This can be a string, or nil to mean
1451 the value of `remember-data-file'.
1452 You can set this on a per-template basis with the variable
1453 `org-remember-templates'."
1457 file))
1460 "Non-nil means, `C-c C-c' stores remember note without further promts.
1461 In this case, you need `C-u C-c C-c' to get the prompts for
1462 note file and headline.
1463 When this variable is nil, `C-c C-c' give you the prompts, and
1464 `C-u C-c C-c' trigger the fasttrack."
1469 "The interface to be used for interactive filing of remember notes.
1470 This is only used when the interactive mode for selecting a filing
1471 location is used (see the variable `org-remember-store-without-prompt').
1472 Allowed vaues are:
1473 outline The interface shows an outline of the relevant file
1474 and the correct heading is found by moving through
1475 the outline or by searching with incremental search.
1476 outline-path-completion Headlines in the current buffer are offered via
1477 completion.
1478 refile Use the refile interface, and offer headlines,
1479 possibly from different buffers."
1487 "The default interface to be used for `org-goto'.
1488 Allowed vaues are:
1489 outline The interface shows an outline of the relevant file
1490 and the correct heading is found by moving through
1491 the outline or by searching with incremental search.
1492 outline-path-completion Headlines in the current buffer are offered via
1493 completion."
1500 "The headline that should be the default location in the notes file.
1501 When filing remember notes, the cursor will start at that position.
1502 You can set this on a per-template basis with the variable
1503 `org-remember-templates'."
1508 "Templates for the creation of remember buffers.
1509 When nil, just let remember make the buffer.
1510 When not nil, this is a list of 5-element lists. In each entry, the first
1511 element is the name of the template, which should be a single short word.
1512 The second element is a character, a unique key to select this template.
1513 The third element is the template. The fourth element is optional and can
1514 specify a destination file for remember items created with this template.
1515 The default file is given by `org-default-notes-file'. An optional fifth
1516 element can specify the headline in that file that should be offered
1517 first when the user is asked to file the entry. The default headline is
1518 given in the variable `org-remember-default-headline'.
1520 The template specifies the structure of the remember buffer. It should have
1521 a first line starting with a star, to act as the org-mode headline.
1522 Furthermore, the following %-escapes will be replaced with content:
1524 %^{prompt} Prompt the user for a string and replace this sequence with it.
1525 A default value and a completion table ca be specified like this:
1526 %^{prompt|default|completion2|completion3|...}
1527 %t time stamp, date only
1528 %T time stamp with date and time
1529 %u, %U like the above, but inactive time stamps
1530 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1531 You may define a prompt like %^{Please specify birthday}t
1532 %n user name (taken from `user-full-name')
1533 %a annotation, normally the link created with org-store-link
1534 %i initial content, the region active. If %i is indented,
1535 the entire inserted text will be indented as well.
1536 %c content of the clipboard, or current kill ring head
1537 %^g prompt for tags, with completion on tags in target file
1538 %^G prompt for tags, with completion all tags in all agenda files
1539 %:keyword specific information for certain link types, see below
1540 %[pathname] insert the contents of the file given by `pathname'
1541 %(sexp) evaluate elisp `(sexp)' and replace with the result
1542 %! Store this note immediately after filling the template
1544 %? After completing the template, position cursor here.
1546 Apart from these general escapes, you can access information specific to the
1547 link type that is created. For example, calling `remember' in emails or gnus
1548 will record the author and the subject of the message, which you can access
1549 with %:author and %:subject, respectively. Here is a complete list of what
1550 is recorded for each link type.
1552 Link type | Available information
1553 -------------------+------------------------------------------------------
1554 bbdb | %:type %:name %:company
1555 vm, wl, mh, rmail | %:type %:subject %:message-id
1556 | %:from %:fromname %:fromaddress
1557 | %:to %:toname %:toaddress
1559 gnus | %:group, for messages also all email fields
1560 w3, w3m | %:type %:url
1561 info | %:type %:file %:node
1562 calendar | %:type %:date"
1585 "Non-nil means, store new notes at the beginning of a file or entry.
1586 When nil, new notes will be filed to the end of a file or entry.
1587 This can also be a list with cons cells of regular expressions that
1588 are matched against file names, and values."
1598 This is list of cons cells. Each cell contains:
1599 - a specification of the files to be considered, either a list of files,
1600 or a symbol whose function or value fields will be used to retrieve
1601 a file name or a list of file names. Nil means, refile to a different
1602 heading in the current buffer.
1603 - A specification of how to find candidate refile targets. This may be
1604 any of
1606 This tag has to be present in all target headlines, inheritance will
1607 not be considered.
1609 todo keyword.
1611 headlines that are refiling targets.
1612 - a cons cell (:level . N). Any headline of level N is considered a target.
1613 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1614 ;; FIXME: what if there are a var and func with same name???
1630 "Non-nil means, provide refile targets as paths.
1631 So a level 3 headline will be available as level1/level2/level3.
1632 When the value is `file', also include the file name (without directory)
1633 into the path. When `full-file-path', include the full file path."
1642 "Options concerning TODO items in Org-mode."
1647 "Options concerning Progress logging in Org-mode."
1652 "List of TODO entry keyword sequences and their interpretation.
1655 Each sequence starts with a symbol, either `sequence' or `type',
1656 indicating if the keywords should be interpreted as a sequence of
1657 action steps, or as different types of TODO items. The first
1658 keywords are states requiring action - these states will select a headline
1659 for inclusion into the global TODO list Org-mode produces. If one of
1662 the last keyword is treated as the only DONE state of the sequence.
1665 additional state where no keyword is present. For details about this
1666 cycling, see the manual.
1668 TODO keywords and interpretation can also be set on a per-file basis with
1669 the special #+SEQ_TODO and #+TYP_TODO lines.
1671 Each keyword can optionally specify a character for fast state selection
1672 \(in combination with the variable `org-use-fast-todo-selection')
1673 and specifiers for state change logging, using the same syntax
1676 indicates to record a time stamp each time this state is selected.
1679 entering and when leaving this state.
1681 For backward compatibility, this variable may also be just a list
1682 of keywords - in this case the interptetation (sequence or type) will be
1683 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1721 "Controls how TODO keywords are interpreted.
1722 This variable is in principle obsolete and is only used for
1723 backward compatibility, if the interpretation of todo keywords is
1724 not given already in `org-todo-keywords'. See that variable for
1725 more information."
1732 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1733 This variable describes if and under what circumstances the cycling
1734 mechanism for TODO keywords will be replaced by a single-key, direct
1735 selection scheme.
1737 When nil, fast selection is never used.
1739 When the symbol `prefix', it will be used when `org-todo' is called with
1740 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1741 in an agenda buffer.
1743 When t, fast selection is used by default. In this case, the prefix
1744 argument forces cycling instead.
1746 In all cases, the special interface is only used if access keys have actually
1747 been assigned by the user, i.e. if keywords in the configuration are followed
1748 by a letter in parenthesis, like TODO(t)."
1756 "Hook which is run after the state of a TODO item was changed.
1757 The new state (a string with a TODO keyword, or nil) is available in the
1758 Lisp variable `state'."
1763 "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
1764 When equal to the list (done), also prompt for a closing note.
1765 This can also be configured on a per-file basis by adding one of
1766 the following lines anywhere in the buffer:
1768 #+STARTUP: logdone
1769 #+STARTUP: lognotedone
1770 #+STARTUP: nologdone"
1778 ;; Normalize old uses of org-log-done.
1784 ;; FIXME: document
1786 "Non-nil means, recored a note when clocking out of an item.
1787 This can also be configured on a per-file basis by adding one of
1788 the following lines anywhere in the buffer:
1790 #+STARTUP: lognoteclock-out
1791 #+STARTUP: nolognoteclock-out"
1797 "Non-nil means, the CLOSED time stamp will contain date and time.
1798 When nil, only the date will be recorded."
1806 "Headings for notes added when clocking out or closing TODO items.
1807 The value is an alist, with the car being a symbol indicating the note
1808 context, and the cdr is the heading to be used. The heading may also be the
1809 empty string.
1810 %t in the heading will be replaced by a time stamp.
1811 %s will be replaced by the new TODO state, in double quotes.
1812 %u will be replaced by the user name.
1813 %U will be replaced by the full user name."
1819 "Heading when changing todo state (todo sequence only)"
1824 "Non-nil means, the latest state change note will be directly after heading.
1825 When nil, the notes will be orderer according to time."
1831 "Non-nil means, record moving through the DONE state when triggering repeat.
1832 An auto-repeating tasks is immediately switched back to TODO when marked
1834 the TODO keyword definition, or recording a cloing note by setting
1835 `org-log-done', there will be no record of the task moving trhough DONE.
1836 This variable forces taking a note anyway. Possible values are:
1838 nil Don't force a record
1839 time Record a time stamp
1840 note Record a note
1842 This option can also be set with on a per-file-basis with
1844 #+STARTUP: logrepeat
1845 #+STARTUP: lognoterepeat
1846 #+STARTUP: nologrepeat
1848 You can have local logging settings for a subtree by setting the LOGGING
1849 property to one or more of these keywords."
1858 "Should clocking info be wrapped into a drawer?
1859 When t, clocking info will always be inserted into a :CLOCK: drawer.
1860 If necessary, the drawer will be created.
1861 When nil, the drawer will not be created, but used when present.
1862 When an integer and the number of clocking entries in an item
1863 reaches or exceeds this number, a drawer will be created."
1872 "When t, the clock will be stopped when the relevant entry is marked DONE.
1873 Nil means, clock will keep running until stopped explicitly with
1874 `C-c C-x C-o', or until the clock is started in a different item."
1879 "Set task to a special todo state while clocking it.
1880 The value should be the state to which the entry should be switched."
1888 "Priorities in Org-mode."
1893 "The highest priority of TODO items. A character like ?A, ?B etc.
1894 Must have a smaller ASCII number than `org-lowest-priority'."
1899 "The lowest priority of TODO items. A character like ?A, ?B etc.
1900 Must have a larger ASCII number than `org-highest-priority'."
1905 "The default priority of TODO items.
1906 This is the priority an item get if no explicit priority is given."
1911 "Non-nil means, start with default priority when starting to cycle.
1912 When this is nil, the first step in the cycle will be (depending on the
1913 command used) one higher or lower that the default priority."
1918 "Options concerning time stamps and deadlines in Org-mode."
1923 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1924 When nil, these labeled time stamps are forces into the second line of an
1925 entry, just after the headline. When scheduling from the global TODO list,
1926 the time stamp will always be forced into the second line."
1931 "Formats for `format-time-string' which are used for time stamps.
1935 "Number of minutes to round time stamps to upon insertion.
1936 When zero, insert the time unmodified. Useful rounding numbers
1937 should be factors of 60, so for example 5, 10, 15.
1938 When this is not zero, you can still force an exact time-stamp by using
1939 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1944 "Non-nil means, overlay custom formats over all time stamps.
1945 The formats are defined through the variable `org-time-stamp-custom-formats'.
1946 To turn this on on a per-file basis, insert anywhere in the file:
1947 #+STARTUP: customtime"
1955 "Custom formats for time stamps. See `format-time-string' for the syntax.
1956 These are overlayed over the default ISO format if the variable
1957 `org-display-custom-times' is set. Time like %H:%M should be at the
1958 end of the second format."
1963 "Get the right format for a time string."
1968 f)))
1971 "Non-nil means, assume future for incomplete date input from user.
1972 This affects the following situations:
1973 1. The user gives a day, but no month.
1976 it will be considered as *this* month.
1977 2. The user gives a month but not a year.
1981 When this option is nil, the current month and year will always be used
1982 as defaults."
1987 "Non-nil means, display current interpretation of date prompt live.
1988 This display will be in an overlay, in the minibuffer."
1993 "Non-nil means, pop up a calendar when prompting for a date.
1994 In the calendar, the date can be selected with mouse-1. However, the
1995 minibuffer will also be active, and you can simply enter the date as well.
1996 When nil, only the minibuffer will be available."
2004 "The hour when your day really ends.
2005 This has influence for the following applications:
2007 the time given here, the day recognized as TODAY is actually yesterday.
2008 - When a date is read from the user and it is still before the time given
2009 here, the current date and time will be assumed to be yesterday, 23:59.
2011 FIXME:
2012 IMPORTANT: This is still a very experimental feature, it may disappear
2013 again or it may be extended to mean more things."
2018 "Non-nil means, S-down will increase the time in a time stamp.
2019 When nil, S-up will increase."
2024 "Non-nil means, make the calendar window follow timestamp changes.
2025 When a timestamp is modified and the calendar window is visible, it will be
2026 moved to the new date."
2031 "When non-nil, should be a function to create `org-clock-heading'.
2032 This is the string shown in the mode line when a clock is running.
2033 The function is called with point at the beginning of the headline."
2038 "Options concerning tags in Org-mode."
2043 "List of tags allowed in Org-mode files.
2044 When this list is nil, Org-mode will base TAG input on what is already in the
2045 buffer.
2046 The value of this variable is an alist, the car of each entry must be a
2047 keyword as a string, the cdr may be a character that is used to select
2048 that tag through the fast-tag-selection interface.
2049 See the manual for details."
2059 "Non-nil means, use fast tag selection scheme.
2060 This is a special interface to select and deselect tags with single keys.
2061 When nil, fast selection is never used.
2062 When the symbol `auto', fast selection is used if and only if selection
2063 characters for tags have been configured, either through the variable
2064 `org-tag-alist' or through a #+TAGS line in the buffer.
2065 When t, fast selection is always used and selection keys are assigned
2066 automatically if necessary."
2074 "Non-nil means, fast tag selection exits after first change.
2075 When nil, you have to press RET to exit it.
2076 During fast tag selection, you can toggle this flag with `C-c'.
2077 This variable can also have the value `expert'. In this case, the window
2078 displaying the tags menu is not even shown, until you press C-c again."
2086 "Non-nil means, fast tags selection interface will also offer TODO states.
2090 "The column to which tags should be indented in a headline.
2091 If this number is positive, it specifies the column. If it is negative,
2092 it means that the tags should be flushright to that column. For example,
2093 -80 works well for a normal 80 character screen."
2098 "Non-nil means, realign tags after pro/demotion of TODO state change.
2099 These operations change the length of a headline and therefore shift
2100 the tags around. With this options turned on, after each such operation
2101 the tags are again aligned to `org-tags-column'."
2106 "Non-nil means, tags in levels apply also for sublevels.
2107 When nil, only the tags directly given in a specific line apply there.
2108 If you turn off this option, you very likely want to turn on the
2109 companion option `org-tags-match-list-sublevels'."
2114 "Non-nil means list also sublevels of headlines matching tag search.
2115 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2116 the sublevels of a headline matching a tag search often also match
2117 the same search. Listing all of them can create very long lists.
2118 Setting this variable to nil causes subtrees of a match to be skipped.
2119 This option is off by default, because inheritance in on. If you turn
2120 inheritance off, you very likely want to turn this option on.
2122 As a special case, if the tag search is restricted to TODO items, the
2123 value of this variable is ignored and sublevels are always checked, to
2124 make sure all corresponding TODO items find their way into the list."
2136 "Options concerning properties in Org-mode."
2141 "How property key/value pairs should be formatted by `indent-line'.
2142 When `indent-line' hits a property definition, it will format the line
2143 according to this format, mainly to make sure that the values are
2144 lined-up with respect to each other."
2149 "Non-nil means, properties apply also for sublevels.
2150 This setting is only relevant during property searches, not when querying
2151 an entry with `org-entry-get'. To retrieve a property with inheritance,
2152 you need to call `org-entry-get' with the inheritance flag.
2153 Turning this on can cause significant overhead when doing a search, so
2154 this is turned off by default.
2155 When nil, only the properties directly given in the current entry count.
2156 The value may also be a list of properties that shouldhave inheritance.
2158 However, note that some special properties use inheritance under special
2159 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2161 for valid values of a property."
2169 "The default column format, if no other format has been defined.
2170 This variable can be set on the per-file basis by inserting a line
2172 #+COLUMNS: %25ITEM ....."
2177 "List of property/value pairs that can be inherited by any entry.
2178 You can set buffer-local values for this by adding lines like
2180 #+PROPERTY: NAME VALUE"
2187 "List of property/value pairs that can be inherited by any entry.
2188 Valid for the current buffer.
2192 "Options concerning agenda views in Org-mode."
2197 "Variable used by org files to set a category for agenda display.
2198 Such files should use a file variable to set it, for example
2202 or contain a special line
2204 #+CATEGORY: ELisp
2206 If the file does not specify a category, then file's base name
2211 "The files to be used for agenda display.
2215 If an entry is a directory, all files in that directory that are matched by
2216 `org-agenda-file-regexp' will be part of the file list.
2218 If the value of the variable is not a list but a single file name, then
2219 the list of agenda files is actually stored and maintained in that file, one
2220 agenda file per line."
2227 "Regular expression to match files for `org-agenda-files'.
2228 If any element in the list in that variable contains a directory instead
2229 of a normal file, all files in that directory that are matched by this
2230 regular expression will be included."
2235 "t means to just skip non-reachable files in `org-agenda-files'.
2236 Nil means to remove them, after a query, from the list."
2241 "List of extra files to be searched by `org-occur-in-agenda-files'.
2242 The files in `org-agenda-files' are always searched."
2247 "When set, remote killing from the agenda buffer needs confirmation.
2248 When t, a confirmation is always needed. When a number N, confirmation is
2249 only needed when the text to be killed contains more than N non-white lines."
2257 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2258 The command `org-calendar-goto-agenda' will be bound to this key. The
2259 default is the character `c' because then `c' can be used to switch back and
2260 forth between agenda and calendar."
2265 "Non-nil means, make the block agenda more compact.
2266 This is done by leaving out unnecessary lines."
2271 "Options concerning exporting agenda views in Org-mode."
2276 "Non-nil means, use colors in agenda views."
2281 "Alist of variable/value pairs that should be active during agenda export.
2282 This is a good place to set uptions for ps-print and for htmlize."
2290 "The style specification for exported HTML Agenda files.
2291 If this variable contains a string, it will replace the default <style>
2292 section as produced by `htmlize'.
2293 Since there are different ways of setting style information, this variable
2294 needs to contain the full HTML structure to provide a style, including the
2295 surrounding HTML tags. The style specifications should include definitions
2296 the fonts used by the agenda, here is an example:
2299 p { font-weight: normal; color: gray; }
2300 .org-agenda-structure {
2301 font-size: 110%;
2302 color: #003399;
2303 font-weight: 600;
2304 }
2305 .org-todo {
2306 color: #cc6666;Week-agenda:
2307 font-weight: bold;
2308 }
2309 .org-done {
2310 color: #339933;
2311 }
2312 .title { text-align: center; }
2313 .todo, .deadline { color: red; }
2314 .done { color: green; }
2315 </style>
2317 or, if you want to keep the style in a file,
2321 As the value of this option simply gets inserted into the HTML <head> header,
2323 <style>...</style> is required, if not present the variable will be ignored."
2329 "Options concerning agenda views in Org-mode."
2334 "Custom commands for the agenda.
2335 These commands will be offered on the splash screen displayed by the
2338 (key desc type match options files)
2340 key The key (one or more characters as a string) to be associated
2341 with the command.
2342 desc A description of the commend, when omitted or nil, a default
2343 description is built using MATCH.
2344 type The command type, any of the following symbols:
2345 todo Entries with a specific TODO keyword, in all agenda files.
2346 tags Tags match in all agenda files.
2347 tags-todo Tags match in all agenda files, TODO entries only.
2348 todo-tree Sparse tree of specific TODO keyword in *current* file.
2349 tags-tree Sparse tree with all tags matches in *current* file.
2350 occur-tree Occur sparse tree for *current* file.
2351 ... A user-defined function.
2352 match What to search for:
2353 - a single keyword for TODO keyword searches
2354 - a tags match expression for tags searches
2355 - a regular expression for occur searches
2356 options A list of option settings, similar to that in a let form, so like
2357 this: ((opt1 val1) (opt2 val2) ...)
2358 files A list of files file to write the produced agenda buffer to
2359 with the command `org-store-agenda-views'.
2362 produced. Otherwide, only the plain text is written to the file.
2364 You can also define a set of commands, to create a composite agenda buffer.
2365 In this case, an entry looks like this:
2367 (key desc (cmd1 cmd2 ...) general-options file)
2369 where
2371 desc A description string to be displayed in the dispatcher menu.
2372 cmd An agenda command, similar to the above. However, tree commands
2373 are no allowed, but instead you can get agenda and global todo list.
2374 So valid commands for a set are:
2375 (agenda)
2376 (alltodo)
2377 (stuck)
2382 Each command can carry a list of options, and another set of options can be
2383 given for the whole set of commands. Individual command options take
2384 precedence over the general options.
2386 When using several characters as key to a command, the first characters
2387 are prefix commands. For the dispatcher to display useful information, you
2388 should provide a description for the prefix, like
2390 (setq org-agenda-custom-commands
2462 "How to identify stuck projects.
2463 This is a list of four items:
2464 1. A tags/todo matcher string that is used to identify a project.
2465 The entire tree below a headline matched by this is considered one project.
2466 2. A list of TODO keywords identifying non-stuck projects.
2467 If the project subtree contains any headline with one of these todo
2468 keywords, the project is considered to be not stuck. If you specify
2470 3. A list of tags identifying non-stuck projects.
2471 If the project subtree contains any headline with one of these tags,
2473 a tag, any tag will mark the project unstuck.
2474 4. An arbitrary regular expression matching non-stuck projects.
2477 or `C-c a #' to produce the list."
2481 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2487 "Options concerning skipping parts of agenda files."
2492 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2493 When nil, the sublevels of a TODO entry are not checked, resulting in
2494 potentially much shorter TODO lists."
2500 "Non-nil means, don't show entries with a date in the global todo list.
2501 You can use this if you prefer to mark mere appointments with a TODO keyword,
2502 but don't want them to show up in the TODO list.
2503 When this is set, it also covers deadlines and scheduled items, the settings
2504 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2505 will be ignored."
2511 "Non-nil means, don't show scheduled entries in the global todo list.
2512 The idea behind this is that by scheduling it, you have already taken care
2513 of this item.
2514 See also `org-agenda-todo-ignore-with-date'."
2520 "Non-nil means, don't show near deadline entries in the global todo list.
2521 Near means closer than `org-deadline-warning-days' days.
2522 The idea behind this is that such items will appear in the agenda anyway.
2523 See also `org-agenda-todo-ignore-with-date'."
2529 "Non-nil means don't show scheduled items in agenda when they are done.
2530 This is relevant for the daily/weekly agenda, not for the TODO list. And
2531 it applies only to the actual date of the scheduling. Warnings about
2532 an item with a past scheduling dates are always turned off when the item
2533 is DONE."
2538 "Non-nil means don't show deadines when the corresponding item is done.
2539 When nil, the deadline is still shown and should give you a happy feeling.
2540 This is relevant for the daily/weekly agenda. And it applied only to the
2541 actualy date of the deadline. Warnings about approching and past-due
2542 deadlines are always turned off when the item is DONE."
2547 "Non-nil means don't select item by timestamp or -range if it is DONE."
2552 "Non-nil means, `org-timeline' also shows dates without an entry.
2553 When nil, only the days which actually have entries are shown.
2554 When t, all days between the first and the last date are shown.
2555 When an integer, show also empty dates, but if there is a gap of more than
2556 N days, just insert a special line indicating the size of the gap."
2565 "Options concerning initial settings in the Agenda in Org Mode."
2570 "Hook run just before displaying an agenda buffer."
2575 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2576 A longer mouse click will still set point. Does not wortk on XEmacs.
2577 Needs to be set before org.el is loaded."
2582 "The initial value of follow-mode in a newly created agenda window."
2587 "Options concerning the windows used by the Agenda in Org Mode."
2592 "How the agenda buffer should be displayed.
2593 Possible values for this option are:
2595 current-window Show agenda in the current window, keeping all other windows.
2596 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2597 other-window Use `switch-to-buffer-other-window' to display agenda.
2598 reorganize-frame Show only two windows on the current frame, the current
2599 window and the agenda.
2600 See also the variable `org-agenda-restore-windows-after-quit'."
2609 "The min and max height of the agenda window as a fraction of frame height.
2610 The value of the variable is a cons cell with two numbers between 0 and 1.
2611 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2616 "Non-nil means, restore window configuration open exiting agenda.
2617 Before the window configuration is changed for displaying the agenda,
2618 the current status is recorded. When the agenda is exited with
2619 `q' or `x' and this option is set, the old state is restored. If
2620 `org-agenda-window-setup' is `other-frame', the value of this
2621 option will be ignored.."
2626 "How should indirect tree buffers be displayed?
2627 This applies to indirect buffers created with the commands
2629 Valid values are:
2630 current-window Display in the current window
2631 other-window Just display in another window.
2632 dedicated-frame Create one new frame, and re-use it each time.
2633 new-frame Make a new frame each time. Note that in this case
2634 previously-made indirect buffers are kept, and you need to
2635 kill these buffers yourself."
2645 "Options concerning the daily/weekly agenda."
2650 "Number of days to include in overview display.
2651 Should be 1 or 7."
2656 "Non-nil means, start the overview always on the specified weekday.
2657 0 denotes Sunday, 1 denotes Monday etc.
2658 When nil, always start on the current day."
2664 "Non-nil means, `org-agenda' shows every day in the selected range.
2665 When nil, only the days which actually have entries are shown."
2670 "Format string for displaying dates in the agenda.
2671 Used by the daily/weekly agenda and by the timeline. This should be
2672 a format string understood by `format-time-string', or a function returning
2673 the formatted date as a string. The function must take a single argument,
2674 a calendar-style date list like (month day year)."
2681 "Format a date string for display in the daily/weekly agenda, or timeline.
2682 This function makes sure that dates are aligned for easy reading."
2690 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2695 "Set means weekly/daily agenda will always contain all TODO entries.
2696 The TODO entries will be listed at the top of the agenda, before
2697 the entries for specific days."
2702 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2703 When nil, only one occurence is shown, either today or the
2704 nearest into the future."
2709 "No. of days before expiration during which a deadline becomes active.
2710 This variable governs the display in sparse trees and in the agenda.
2711 When negative or null, it means use the absolute value of this number
2712 even if a deadline has a different individual lead time specified."
2718 "No. of days to continue listing scheduled items that are not marked DONE.
2719 When an item is scheduled on a date, it shows up in the agenda on this
2720 day and will be listed until it is marked done for the number of days
2721 given here."
2726 "Options concerning the time grid in the Org-mode Agenda."
2731 "Non-nil means, show a time grid in the agenda schedule.
2732 A time grid is a set of lines for specific times (like every two hours between
2733 8:00 and 20:00). The items scheduled for a day at specific times are
2734 sorted in between these lines.
2735 For details about when the grid will be shown, and what it will look like, see
2736 the variable `org-agenda-time-grid'."
2742 "----------------"
2745 "The settings for time grid for agenda display.
2746 This is a list of three items. The first item is again a list. It contains
2747 symbols specifying conditions when the grid should be displayed:
2749 daily if the agenda shows a single day
2750 weekly if the agenda shows an entire week
2751 today show grid on current date, independent of daily/weekly display
2752 require-timed show grid only if at least one item has a time specification
2754 The second item is a string which will be places behing the grid time.
2756 The third item is a list of integers, indicating the times that should have
2757 a grid line."
2759 :type
2766 require-timed)
2768 remove-match))
2773 "Options concerning sorting in the Org-mode Agenda."
2789 "Sorting structure for the agenda items of a single day.
2790 This is a list of symbols which will be used in sequence to determine
2791 if an entry should be listed before another entry. The following
2792 symbols are recognized:
2794 time-up Put entries with time-of-day indications first, early first
2795 time-down Put entries with time-of-day indications first, late first
2796 category-keep Keep the default order of categories, corresponding to the
2797 sequence in `org-agenda-files'.
2798 category-up Sort alphabetically by category, A-Z.
2799 category-down Sort alphabetically by category, Z-A.
2800 tag-up Sort alphabetically by last tag, A-Z.
2801 tag-down Sort alphabetically by last tag, Z-A.
2802 priority-up Sort numerically by priority, high priority last.
2803 priority-down Sort numerically by priority, high priority first.
2805 The different possibilities will be tried in sequence, and testing stops
2807 '(time-up category-keep priority-down)
2808 means: Pull out all entries having a specified time of day and sort them,
2809 in order to make a time schedule for the current day the first thing in the
2810 agenda listing for the day. Of the entries without a time indication, keep
2811 the grouped in categories, don't sort the categories, but keep them in
2812 the sequence given in `org-agenda-files'. Within each category sort by
2813 priority.
2815 Leaving out `category-keep' would mean that items will be sorted across
2816 categories by priority.
2818 Instead of a single list, this can also be a set of list for specific
2819 contents, with a context symbol in the car of the list, any of
2820 `agenda', `todo', `tags' for the corresponding agenda views."
2833 "Non-nil means, items without time are considered late.
2834 This is only relevant for sorting. When t, items which have no explicit
2835 time like 15:30 will be considered as 99:01, i.e. later than any items which
2836 do have a time. When nil, the default time is before 0:00. You can use this
2837 option to decide if the schedule for today should come before or after timeless
2838 agenda entries."
2843 "Options concerning the entry prefix in the Org-mode agenda display."
2852 "Format specifications for the prefix of items in the agenda views.
2853 An alist with four entries, for the different agenda types. The keys to the
2854 sublists are `agenda', `timeline', `todo', and `tags'. The values
2855 are format strings.
2856 This format works similar to a printf format, with the following meaning:
2859 as given by the CATEGORY keyword or derived from the file name.
2860 %T the *last* tag of the item. Last because inherited tags come
2861 first in the list.
2862 %t the time-of-day specification if one applies to the entry, in the
2863 format HH:MM
2864 %s Scheduling/Deadline information, a short string
2866 All specifiers work basically like the standard `%s' of printf, but may
2867 contain two additional characters: A question mark just after the `%' and
2868 a whitespace/punctuation character just before the final letter.
2870 If the first character after `%' is a question mark, the entire field
2871 will only be included if the corresponding value applies to the
2872 current entry. This is useful for fields which should have fixed
2873 width when present, but zero width when absent. For example,
2875 day is specified, but will completely disappear in entries which do
2876 not contain a time.
2878 If there is punctuation or whitespace character just before the final
2879 format letter, this character will be appended to the field value if
2882 empty, no additional colon would be interted.
2885 - Indent the line with two space characters
2886 - Give the category in a 12 chars wide field, padded with whitespace on
2887 the right (because of `-'). Append a colon if there is a category
2888 (because of `:').
2889 - If there is a time-of-day, put it into a 12 chars wide field. If no
2890 time, don't put in an empty field, just skip it (because of '?').
2891 - Finally, put the scheduling information and append a whitespace.
2893 As another example, if you don't want the time-of-day of entries in
2894 the prefix, you could use:
2898 See also the variables `org-agenda-remove-times-when-in-prefix' and
2899 `org-agenda-remove-tags'."
2910 "The compiled version of the most recently used prefix format.
2914 "Format for the TODO keyword in agenda lines.
2916 to occupy a fixed space in the agenda display."
2921 "Text preceeding scheduled items in the agenda view.
2922 This is a list with two strings. The first applies when the item is
2923 scheduled on the current day. The second applies when it has been scheduled
2924 previously, it may contain a %d to capture how many days ago the item was
2925 scheduled."
2932 "Text preceeding deadline items in the agenda view.
2933 This is a list with two strings. The first applies when the item has its
2934 deadline on the current day. The second applies when it is in the past or
2935 in the future, it may contain %d to capture how many days away the deadline
2936 is (was)."
2943 "Non-nil means, remove duplicate time specifications in agenda items.
2944 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2945 time-of-day specification in a headline or diary entry is extracted and
2946 placed into the prefix. If this option is non-nil, the original specification
2947 \(a timestamp or -range, or just a plain time(range) specification like
2948 11:30-4pm) will be removed for agenda display. This makes the agenda less
2949 cluttered.
2950 The option can be t or nil. It may also be the symbol `beg', indicating
2951 that the time should only be removed what it is located at the beginning of
2952 the headline/diary entry."
2961 "Default duration for appointments that only have a starting time.
2962 When nil, no duration is specified in such cases.
2963 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2971 "Non-nil means, remove the tags from the headline copy in the agenda.
2972 When this is the symbol `prefix', only remove tags when
2973 `org-agenda-prefix-format' contains a `%T' specifier."
2985 "Shift tags in agenda items to this column.
2986 If this number is positive, it specifies the column. If it is negative,
2987 it means that the tags should be flushright to that column. For example,
2988 -80 works well for a normal 80 character screen."
2996 "Non-nil means, highlight low and high priorities in agenda.
2997 When t, the highest priority entries are bold, lowest priority italic.
2998 This may also be an association list of priority faces. The face may be
3009 "Options for embedding LaTeX code into Org-mode"
3017 "Options for creating images from LaTeX fragments.
3018 This is a property list with the following properties:
3020 `default' means use the forground of the default face.
3022 `default' means use the background of the default face.
3023 :scale a scaling factor for the size of the images
3024 :html-foreground, :html-background, :html-scale
3025 The same numbers for HTML export.
3026 :matchers a list indicating which matchers should be used to
3027 find LaTeX fragments. Valid members of this list are:
3044 "The document header used for processing LaTeX fragments."
3049 "Options for exporting org-listings."
3054 "General options for exporting Org-mode files."
3058 ;; FIXME
3063 When this option is turned on, these strings will be exported as:
3065 Org HTML LaTeX
3066 -----+----------+--------
3068 -- – --
3069 --- — ---
3070 ... … \ldots
3087 "Terms used in export text, translated to different languages.
3088 Use the variable `org-export-default-language' to set the language,
3089 or use the +OPTION lines for a per-file setting."
3099 "The default language of HTML export, as a string.
3100 This should have an association in `org-export-language-setup'."
3105 "Non-nil means, skip all text before the first headline when exporting.
3106 When nil, that text is exported as well."
3111 "The last level which is still exported as a headline.
3112 Inferior levels will produce itemize lists when exported.
3113 Note that a numeric prefix argument to an exporter function overrides
3114 this setting.
3121 "Non-nil means, add section numbers to headlines when exporting.
3128 "Non-nil means, create a table of contents in exported files.
3129 The TOC contains headlines with levels up to`org-export-headline-levels'.
3130 When an integer, include levels up to N in the toc, this may then be
3131 different from `org-export-headline-levels', but it will not be allowed
3132 to be larger than the number of headline levels.
3133 When nil, no table of contents is made.
3136 ASCII export, and with red color in HTML output, if the option
3137 `org-export-mark-todo-in-toc' is set.
3139 In HTML output, the TOC will be clickable.
3150 "Non-nil means, mark TOC lines that contain any open TODO items."
3155 "Non-nil means, preserve all line breaks when exporting.
3156 Normally, in HTML output paragraphs will be reformatted. In ASCII
3157 export, line breaks will always be preserved, regardless of this variable.
3164 "Whether subtrees with the ARCHIVE tag should be exported.
3165 This can have three different values
3166 nil Do not export, pretend this tree is not present
3167 t Do export the entire tree
3168 headline Only export the headline, but skip the tree below it."
3177 "Non-nil means, insert author name and email into the exported file.
3179 This option can also be set with the +OPTIONS line,
3185 "Non-nil means, insert a time stamp into the exported file.
3186 The time stamp shows when the file was created.
3188 This option can also be set with the +OPTIONS line,
3194 "If nil, do not export time stamps and associated keywords."
3199 "If nil, remove timestamps from the table of contents entries."
3204 "If nil, do not export tags, just remove them from headlines.
3205 If this is the symbol `not-in-toc', tags will be removed from table of
3206 contents entries, but still be shown in the headlines of the document.
3216 "Non-nil means, export with drawers like the property drawer.
3217 When t, all drawers are exported. This may also be a list of
3218 drawer names to export."
3227 "Options for translating special ascii sequences for the export backends."
3232 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3233 If the export target supports emphasizing text, the word will be
3234 typeset in bold, italic, or underlined, respectively. Works only for
3235 single words, but you can say: I *really* *mean* *this*.
3236 Not all export backends support this.
3243 "If nil, export [1] as a footnote marker.
3244 Lines starting with [1] will be formatted as footnotes.
3252 When this option is turned on, you can use TeX-like syntax for sub- and
3254 considered as a single item - so grouping with {} is normally not
3255 needed. For example, the following things will be parsed as single
3256 sub- or superscripts.
3258 10^24 or 10^tau several digits will be considered 1 item.
3259 10^-12 or 10^-tau a leading sign with digits or a word
3260 x^2-y^3 will be read as x^2 - y^3, because items are
3261 terminated by almost any nonword/nondigit char.
3262 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3264 Still, ambiguity is possible - so when in doubt use {} to enclose the
3265 sub/superscript. If you set this variable to the symbol `{}',
3266 the braces are *required* in order to trigger interpretations as
3268 frequently in plain text.
3270 Not all export backends support this, but HTML does.
3281 When this option is turned on, these strings will be exported as:
3284 -- : –
3285 --- : —
3287 Not all export backends support this, but HTML does.
3294 "Non-nil means, interpret simple TeX-like macros when exporting.
3296 No only real TeX macros will work here, but the standard HTML entities
3297 for math can be used as macro names as well. For a list of supported
3298 names in HTML export, see the constant `org-html-entities'.
3299 Not all export backends support this.
3307 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3309 the first non-white thing on a line. It will also find the math delimiters
3311 display math.
3320 This can be used to have pre-formatted text, fragments of code etc. For
3321 example:
3322 : ;; Some Lisp examples
3323 : (while (defc cnt)
3324 : (ding))
3325 will be looking just like this in also HTML. See also the QUOTE keyword.
3326 Not all export backends support this.
3333 "Number of stacked braces for sub/superscript matching.
3334 This has to be set before loading org.el to be effective."
3339 "Options for exporting tables in Org-mode."
3345 For example:
3347 | Name | Address | Birthday |
3348 |-------------+----------+-----------|
3349 | Arthur Dent | England | 29.2.2100 |
3351 Not all export backends support this.
3358 "Non-nil means, highlight the first table line.
3359 In HTML export, this means use <th> instead of <td>.
3360 In tables created with table.el, this applies to the first table line.
3361 In Org-mode tables, all lines before the first horizontal separator
3362 line will be formatted with <th> tags."
3367 "Remove special lines and marking characters in calculating tables.
3368 This removes the special marking character column from tables that are set
3369 up for spreadsheet calculations. It also removes the entire lines
3370 marked with `!', `_', or `^'. The lines with `$' are kept, because
3371 the values of constants may be useful to have."
3376 "Non-nil means, always export tables created with table.el natively.
3377 Natively means, use the HTML code generator in table.el.
3378 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3379 the table does not use row- or column-spanning). This has the
3380 advantage, that the automatic HTML conversions for math symbols and
3381 sub/superscripts can be applied. Org-mode's HTML generator is also
3382 much faster."
3387 "Options specific for ASCII export of Org-mode files."
3392 "Characters for underlining headings in ASCII export.
3393 In the given sequence, these characters will be used for level 1, 2, ..."
3398 "Bullet characters for headlines converted to lists in ASCII export.
3399 The first character is used for the first lest level generated in this
3400 way, and so on. If there are more levels than characters given here,
3401 the list will be repeated.
3402 Note that plain lists will keep the same bullets as the have in the
3403 Org-mode file."
3408 "Options specific for XML export of Org-mode files."
3413 "Options specific for HTML export of Org-mode files."
3418 ""
3423 "The extension for exported HTML files."
3429 html {
3430 font-family: Times, serif;
3431 font-size: 12pt;
3432 }
3433 .title { text-align: center; }
3434 .todo { color: red; }
3435 .done { color: green; }
3436 .timestamp { color: grey }
3437 .timestamp-kwd { color: CadetBlue }
3438 .tag { background-color:lightblue; font-weight:normal }
3439 .target { background-color: lavender; }
3440 pre {
3441 border: 1pt solid #AEBDCC;
3442 background-color: #F3F5F7;
3443 padding: 5pt;
3444 font-family: courier, monospace;
3445 }
3446 table { border-collapse: collapse; }
3447 td, th {
3448 vertical-align: top;
3449 <!--border: 1pt solid #ADB9CC;-->
3450 }
3451 </style>"
3452 "The default style specification for exported HTML files.
3453 Since there are different ways of setting style information, this variable
3454 needs to contain the full HTML structure to provide a style, including the
3455 surrounding HTML tags. The style specifications should include definitions
3456 for new classes todo, done, title, and deadline. For example, legal values
3457 would be:
3460 p { font-weight: normal; color: gray; }
3461 h1 { color: black; }
3462 .title { text-align: center; }
3463 .todo, .deadline { color: red; }
3464 .done { color: green; }
3465 </style>
3467 or, if you want to keep the style in a file,
3471 As the value of this option simply gets inserted into the HTML <head> header,
3478 "Format for typesetting the document title in HTML export."
3483 "The <H> level for level 1 headings in HTML export."
3488 "Non-nil means, make file links to `file.org' point to `file.html'.
3489 When org-mode is exporting an org-mode file to HTML, links to
3490 non-html files are directly put into a href tag in HTML.
3491 However, links to other Org-mode files (recognized by the
3492 extension `.org.) should become links to the corresponding html
3493 file, assuming that the linked org-mode file will also be
3494 converted to HTML.
3495 When nil, the links still point to the plain `.org' file."
3500 "Non-nil means, inline images into exported HTML pages.
3501 This is done using an <img> tag. When nil, an anchor with href is used to
3502 link to the image. If this option is `maybe', then images in links with
3503 an empty description will be inlined, while images with a description will
3504 be linked only."
3510 ;; FIXME: rename
3512 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3513 When nil, these tags will be exported as plain text and therefore
3514 not be interpreted by a browser.
3522 "The HTML tag that is used to start a table.
3523 This must be a <table> tag, but you may change the options like
3524 borders and spacing."
3529 "The opening tag for table header fields.
3530 This is customizable so that alignment options can be specified."
3535 "The opening tag for table data fields.
3536 This is customizable so that alignment options can be specified."
3541 "If non-nil, write `org-export-html-html-helper-timestamp'
3542 into the exported HTML text. Otherwise, the buffer will just be saved
3543 to a file."
3549 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3554 "Options specific for iCalendar export of Org-mode files."
3559 "The file name for the iCalendar file covering all agenda files.
3561 The file name should be absolute, the file will be overwritten without warning."
3566 "Non-nil means, export to iCalendar files should also cover TODO items."
3574 "Non-nil means, export to iCalendar files should also cover sexp entries.
3575 These are entries like in the diary, but directly in an Org-mode file."
3580 "Amount of text below headline to be included in iCalendar export.
3581 This is a number of characters that should maximally be included.
3582 Properties, scheduling and clocking lines will always be removed.
3583 The text will be inserted into the DESCRIPTION field."
3591 "Calendar name for the combined iCalendar representing all agenda files."
3596 "Font-lock settings for highlighting in Org-mode."
3601 "Non-nil means fontify only the stars in each headline.
3602 When nil, the entire headline is fontified.
3603 Changing it requires restart of `font-lock-mode' to become effective
3604 also in regions already fontified."
3609 "Non-nil means, hide the first N-1 stars in a headline.
3610 This works by using the face `org-hide' for these stars. This
3611 face is white for a light background, and black for a dark
3612 background. You may have to customize the face `org-hide' to
3613 make this work.
3614 Changing it requires restart of `font-lock-mode' to become effective
3615 also in regions already fontified.
3616 You may also set this on a per-file basis by adding one of the following
3617 lines to the buffer:
3619 #+STARTUP: hidestars
3620 #+STARTUP: showstars"
3625 "Non-nil means, change the face of a headline if it is marked DONE.
3626 Normally, only the TODO/DONE keyword indicates the state of a headline.
3627 When this is non-nil, the headline after the keyword is set to the
3628 `org-headline-done' as an additional indication."
3633 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3634 Changing this variable requires a restart of Emacs to take effect."
3639 "Non-nil means, fontify what is treated specially by the exporters."
3644 "Non-nil mean font-lock should hide the emphasis marker characters."
3655 "Set variable and compute the emphasis regular expression."
3659 org-emphasis-alist org-emphasis-regexp-components)
3672 ;; make sure special characters appear at the right position in the class
3684 ;; Make the regexp
3692 body1
3704 body1
3712 "Components used to build the regular expression for emphasis.
3713 This is a list with 6 entries. Terminology: In an emphasis string
3717 specify what is allowed/forbidden in each part:
3719 pre Chars allowed as prematch. Beginning of line will be allowed too.
3720 post Chars allowed as postmatch. End of line will be allowed too.
3721 border The chars *forbidden* as border characters.
3723 non-shy groups here, and don't allow newline here.
3724 newline The maximum number of newlines allowed in an emphasis exp.
3726 Use customize to modify this, or restart Emacs after changing it."
3744 )
3745 "Special syntax for emphasized text.
3746 Text starting and ending with a special character will be emphasized, for
3747 example *bold*, _underlined_ and /italic/. This variable sets the marker
3748 characters, the face to be used by font-lock for highlighting in Org-mode
3749 Emacs buffers, and the HTML tags to be used for this.
3750 Use customize to modify this, or restart Emacs after changing it."
3763 ;;; The faces
3766 "Faces in Org-mode."
3771 "Make a compatible face specification.
3772 If INHERITS is an existing face and if the Emacs version supports it,
3773 just inherit the face. If not, use SPECS to define the face.
3774 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3775 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3776 to the top of the list. The `min-colors' attribute will be removed from
3777 any other entries, and any resulting duplicates will be removed entirely."
3781 ;; In Emacs 23, we use inheritance where possible.
3782 ;; We only do this in Emacs 23, because only there the outline
3783 ;; faces have been changed to the original org-mode-level-faces.
3786 ;; These do not understand the `min-colors' attribute.
3805 "Face used to hide leading stars in headlines.
3806 The forground color of this face should be equal to the background
3807 color of the frame."
3818 "Face used for level 1 headlines."
3828 "Face used for level 2 headlines."
3840 "Face used for level 3 headlines."
3852 "Face used for level 4 headlines."
3860 "Face used for level 5 headlines."
3868 "Face used for level 6 headlines."
3876 "Face used for level 7 headlines."
3884 "Face used for level 8 headlines."
3892 "Face used for special keywords."
3903 "Face used for drawers."
3907 "Face used for the value of a property."
3919 "Face for column display of entry properties."
3923 ;; Make sure that a fixed-width face is used when we have a column table.
3935 "Face for deadlines and TODO keywords."
3948 "Face for headline with the ARCHIVE tag."
3955 "Face for links."
3962 "Face for the ellipsis in folded text."
3969 "Face for links."
3976 "Face for links."
3983 "Face for links."
3988 "Face for tags."
3998 "Face for TODO keywords."
4007 "Face used for todo keywords that indicate DONE items."
4015 "Face used to indicate that a headline is DONE.
4016 This face is only used if `org-fontify-done-headline' is set. If applies
4017 to the part of the headline after the DONE keyword."
4021 "Faces for specific TODO keywords.
4022 This is a list of cons cells, with TODO keywords in the car
4023 and faces in the cdr. The face can be a symbol, or a property
4040 "Face used for tables."
4050 "Face for formulas."
4063 "Face for fixed-with text like code snippets."
4077 "Face for fixed-with text like code snippets."
4089 "Face used in agenda for captions and dates."
4098 "Face for items scheduled for a certain day."
4108 "Face for items scheduled previously, and not yet done."
4118 "Face for items scheduled previously, and not yet done."
4125 "Faces for showing deadlines in the agenda.
4126 This is a list of cons cells. The cdr of each cell is a face to be used,
4128 Each car is a fraction of the head-warning time that must have passed for
4129 this the face in the cdr to be used for display. The numbers must be
4130 given in descending order. The head-warning time is normally taken
4131 from `org-deadline-warning-days', but can also be specified in the deadline
4132 timestamp itself, like this:
4134 DEADLINE: <2007-08-13 Mon -8d>
4136 You may use d for days, w for weeks, m for months and y for years. Months
4137 and years will only be treated in an approximate fashion (30.4 days for a
4138 month and 365.24 days for a year)."
4146 ;; FIXME: this is not a good face yet.
4155 "Face for showing the agenda restriction lock."
4163 "Face used for time grids."
4168 org-level-5 org-level-6 org-level-7 org-level-8
4169 ))
4172 "The number different faces to be used for headlines.
4173 Org-mode defines 8 different headline faces, so this can be at most 8.
4174 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4178 ;;; Functions and variables from ther packages
4179 ;; Declared here to avoid compiler warnings
4185 ;; XEmacs only
4191 ;; Emacs only
4194 ;; Various packages
4195 ;; FIXME: get the argument lists for the UNKNOWN stuff
4253 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4254 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4285 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4296 ;; backward compatibility to old version of wl
4299 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4312 ;;; Variables for pre-computed regular expressions, all buffer local
4327 "Matches a headline and puts everything into groups:
4328 group 1: the stars
4329 group 2: The todo keyword, maybe
4330 group 3: Priority cookie
4331 group 4: True headline
4335 "Matches a headline and puts TODO state into group 2 if present.
4380 rear-nonsticky t mouse-map t fontified t)
4387 s)
4394 s)
4403 "Modified `buffer-invisibility-spec' for Emacs 21.
4404 Some ops with invisible text do not work correctly on Emacs 21. For these
4405 we turn off invisibility temporarily. Use this in a `let' form."
4409 "Make VAR local in current buffer and set it to VALUE."
4413 "Check if the current buffer is in Org-mode."
4417 "Return the last element of LIST."
4450 "Variable associated with STARTUP options for org-mode.
4451 Each element is a list of three items: The startup options as written
4452 in the #+STARTUP line, the corresponding variable, and the value to
4453 set this variable to if the option is found. An optional forth element PUSH
4457 "Precompute regular expressions for current buffer."
4472 kwds kws0 kwsa key log value cat arch tags const links hw dws
4473 tail sep kws1 prio props drawers)
4497 links)))
4503 props)))
4510 l var val)
4525 )))
4539 ;; Process the TODO keywords
4541 ;; Use the global values as if they had been given locally.
4552 kwsa nil
4555 ;; 1 2
4563 kw)
4565 kws0)
4582 ;; Process the constants
4590 ;; Process the tags.
4600 tgs))
4608 ;; Compute the regular expressions and other local variables
4613 org-drawer-regexp
4617 org-not-done-keywords
4619 org-todo-regexp
4622 org-not-done-regexp
4626 org-todo-line-regexp
4630 org-complex-heading-regexp
4635 org-nl-done-regexp
4639 org-todo-line-tags-regexp
4644 org-looking-at-done-regexp
4649 org-deadline-time-regexp
4651 org-deadline-line-regexp
4653 org-scheduled-regexp
4655 org-scheduled-time-regexp
4657 org-closed-time-regexp
4659 org-keyword-time-regexp
4665 org-keyword-time-not-clock-regexp
4671 org-maybe-keyword-time-regexp
4677 org-planning-or-clock-line-re
4682 )
4687 "Extract the log state setting from a TODO keyword string.
4701 "Remove a pair of parenthesis at the end of each string in LIST."
4705 x))
4706 list))
4708 ;; FIXME: this could be done much better, using second characters etc.
4710 "Assign fast keys to a keyword-key alist.
4711 Respect keys that are already there."
4721 ;; automatically assign a character.
4733 ;;; Some variables ujsed in various places
4738 "Function to be called when `C-c C-c' is used.
4742 ;; FIXME: Occasionally check by commenting these, to make sure
4743 ;; no other functions uses these, forgetting to let-bind them.
4750 ;; Defined somewhere in this file, but used before definition.
4763 ;;;; Emacs/XEmacs compatibility
4765 ;; Overlay compatibility functions
4783 "Make overlay OVL display TEXT with face FACE."
4793 "Make overlay OVL display TEXT with face FACE."
4816 "Find all overlays specifying PROP at POS or point.
4817 If DELETE is non-nil, delete all those overlays."
4819 ov found)
4823 found))
4825 ;; Region compatibility
4828 "Add-hook, compatible with both Emacsen."
4837 "Is `transient-mark-mode' on and the region active?
4838 Works on both Emacs and XEmacs."
4840 nil
4847 ;; Invisibility compatibility
4850 "Add elements to `buffer-invisibility-spec'.
4851 See documentation for `buffer-invisibility-spec' for the kind of elements
4852 that can be added."
4863 "Remove elements from `buffer-invisibility-spec'."
4871 "Is ARG a member of `buffer-invisibility-spec'?"
4874 nil))
4876 ;;;; Define the Org-mode
4879 (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."))
4882 ;; We use a before-change function to check if a table might need
4883 ;; an update.
4885 "Indicates that a table might need an update.
4886 This variable is set by `org-before-change-function'.
4895 ;;;###autoload
4897 "Outline-based notes management and organizer, alias
4900 Org-mode develops organizational tasks around a NOTES file which
4901 contains information about projects as plain text. Org-mode is
4902 implemented on top of outline-mode, which is ideal to keep the content
4903 of large files well structured. It supports ToDo items, deadlines and
4904 time stamps, which magically appear in the diary listing of the Emacs
4905 calendar. Tables are easily created with a built-in table editor.
4906 Plain text URL-like links connect to websites, emails (VM), Usenet
4907 messages (Gnus), BBDB entries, and any files related to the project.
4908 For printing and sharing of notes, an Org-mode file (or a part of it)
4909 can be exported as a structured ASCII or HTML file.
4911 The following commands are available:
4915 ;; Get rid of Outline menus, they are not needed
4916 ;; Need to do this here because define-derived-mode sets up
4917 ;; the keymap so late. Still, it is a waste to call this each time
4918 ;; we switch another buffer into org-mode.
4921 ;; Assume this is Greg's port, it used easymenu
4944 org-display-table 4
4947 org-ellipsis)))
4951 ;; Calc embedded
4958 ;; Activate before-change-function
4962 ;; Check for running clock before killing a buffer
4964 ;; Paragraphs and auto-filling
4969 ;; Comment characters
4970 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4973 ;; Align options lines
4975 'align-mode-rules-list
4980 ;; Imenu
4984 ;; Make isearch reveal context
4987 ;; Emacs 21 and XEmacs make use of the hook
4989 ;; Emacs 22 deals with this through a special variable
4993 ;; If empty file that did not turn on org-mode automatically, make it to.
5015 "Call COMMAND interactively, but pretend prefix are was ARG."
5021 ;; works also in narrowed buffer, because we start at 1, not point-min
5025 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5035 "Add text properties to entire string, from beginning to end.
5036 PLIST may be a list of properties, PROPS are individual properties and values
5037 that will be added to PLIST. Returns the string that was modified."
5040 string)
5044 ;;;; Font-Lock stuff, including the activators
5049 (org-defkey org-mouse-map
5050 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5051 (when org-mouse-1-follows-link
5052 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5053 (when org-tab-follows-link
5054 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5055 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5056 (when org-return-follows-link
5057 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5058 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5060 (require 'font-lock)
5063 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5064 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5065 (defvar org-link-re-with-space nil
5066 "Matches a link with spaces, optional angular brackets around it.")
5067 (defvar org-link-re-with-space2 nil
5068 "Matches a link with spaces, optional angular brackets around it.")
5069 (defvar org-angle-link-re nil
5070 "Matches link with angular brackets, spaces are allowed.")
5071 (defvar org-plain-link-re nil
5072 "Matches plain link, without spaces.")
5073 (defvar org-bracket-link-regexp nil
5074 "Matches a link in double brackets.")
5075 (defvar org-bracket-link-analytic-regexp nil
5076 "Regular expression used to analyze links.
5077 Here is what the match groups contain after a match:
5078 1: http:
5079 2: http
5080 3: path
5081 4: [desc]
5082 5: desc")
5083 (defvar org-any-link-re nil
5084 "Regular expression matching any link.")
5086 (defun org-make-link-regexps ()
5087 "Update the link regular expressions.
5088 This should be called after the variable `org-link-types' has changed."
5089 (setq org-link-re-with-space
5090 (concat
5093 "[^" org-non-link-chars "]*"
5095 org-link-re-with-space2
5096 (concat
5101 org-angle-link-re
5102 (concat
5105 "[^" org-non-link-chars "]*"
5107 org-plain-link-re
5108 (concat
5111 org-bracket-link-regexp
5113 org-bracket-link-analytic-regexp
5114 (concat
5121 org-any-link-re
5126 (org-make-link-regexps)
5129 "Regular expression for fast time stamp matching.")
5131 "Regular expression for fast time stamp matching.")
5132 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5133 "Regular expression matching time strings for analysis.
5134 This one does not require the space after the date.")
5135 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5136 "Regular expression matching time strings for analysis.")
5138 "Regular expression matching time stamps, with groups.")
5140 "Regular expression matching time stamps (also [..]), with groups.")
5141 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5142 "Regular expression matching a time stamp range.")
5143 (defconst org-tr-regexp-both
5144 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5145 "Regular expression matching a time stamp range.")
5148 "Regular expression matching a time stamp or time stamp range.")
5151 "Regular expression matching a time stamp or time stamp range.
5152 The time stamps may be either active or inactive.")
5154 (defvar org-emph-face nil)
5156 (defun org-do-emphasis-faces (limit)
5157 "Run through the buffer and add overlays to links."
5158 (let (rtn)
5159 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5160 (if (not (= (char-after (match-beginning 3))
5161 (char-after (match-beginning 4))))
5162 (progn
5163 (setq rtn t)
5164 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5165 'face
5166 (nth 1 (assoc (match-string 3)
5167 org-emphasis-alist)))
5168 (add-text-properties (match-beginning 2) (match-end 2)
5169 '(font-lock-multiline t))
5170 (when org-hide-emphasis-markers
5171 (add-text-properties (match-end 4) (match-beginning 5)
5172 '(invisible org-link))
5173 (add-text-properties (match-beginning 3) (match-end 3)
5174 '(invisible org-link)))))
5175 (backward-char 1))
5176 rtn))
5178 (defun org-emphasize (&optional char)
5179 "Insert or change an emphasis, i.e. a font like bold or italic.
5180 If there is an active region, change that region to a new emphasis.
5181 If there is no region, just insert the marker characters and position
5182 the cursor between them.
5183 CHAR should be either the marker character, or the first character of the
5184 HTML tag associated with that emphasis. If CHAR is a space, the means
5185 to remove the emphasis of the selected region.
5186 If char is not given (for example in an interactive call) it
5187 will be prompted for."
5188 (interactive)
5189 (let ((eal org-emphasis-alist) e det
5190 (erc org-emphasis-regexp-components)
5191 (prompt "")
5192 (string "") beg end move tag c s)
5193 (if (org-region-active-p)
5194 (setq beg (region-beginning) end (region-end)
5195 string (buffer-substring beg end))
5196 (setq move t))
5198 (while (setq e (pop eal))
5199 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5200 c (aref tag 0))
5201 (push (cons c (string-to-char (car e))) det)
5202 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5203 (substring tag 1)))))
5204 (unless char
5205 (message "%s" (concat "Emphasis marker or tag:" prompt))
5206 (setq char (read-char-exclusive)))
5207 (setq char (or (cdr (assoc char det)) char))
5208 (if (equal char ?\ )
5209 (setq s "" move nil)
5210 (unless (assoc (char-to-string char) org-emphasis-alist)
5212 (setq s (char-to-string char)))
5213 (while (and (> (length string) 1)
5214 (equal (substring string 0 1) (substring string -1))
5215 (assoc (substring string 0 1) org-emphasis-alist))
5216 (setq string (substring string 1 -1)))
5217 (setq string (concat s string s))
5218 (if beg (delete-region beg end))
5219 (unless (or (bolp)
5221 (char-to-string (char-before (point)))))
5222 (insert " "))
5224 (char-to-string (char-after (point))))
5225 (insert " ") (backward-char 1))
5226 (insert string)
5227 (and move (backward-char 1))))
5229 (defconst org-nonsticky-props
5230 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5233 (defun org-activate-plain-links (limit)
5234 "Run through the buffer and add overlays to links."
5235 (catch 'exit
5236 (let (f)
5237 (while (re-search-forward org-plain-link-re limit t)
5238 (setq f (get-text-property (match-beginning 0) 'face))
5239 (if (or (eq f 'org-tag)
5240 (and (listp f) (memq 'org-tag f)))
5241 nil
5242 (add-text-properties (match-beginning 0) (match-end 0)
5243 (list 'mouse-face 'highlight
5244 'rear-nonsticky org-nonsticky-props
5245 'keymap org-mouse-map
5246 ))
5247 (throw 'exit t))))))
5249 (defun org-activate-code (limit)
5251 (unless (get-text-property (match-beginning 1) 'face)
5252 (remove-text-properties (match-beginning 0) (match-end 0)
5253 '(display t invisible t intangible t))
5254 t)))
5256 (defun org-activate-angle-links (limit)
5257 "Run through the buffer and add overlays to links."
5258 (if (re-search-forward org-angle-link-re limit t)
5259 (progn
5260 (add-text-properties (match-beginning 0) (match-end 0)
5261 (list 'mouse-face 'highlight
5262 'rear-nonsticky org-nonsticky-props
5263 'keymap org-mouse-map
5264 ))
5265 t)))
5267 (defmacro org-maybe-intangible (props)
5268 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5269 In emacs 21, invisible text is not avoided by the command loop, so the
5270 intangible property is needed to make sure point skips this text.
5271 In Emacs 22, this is not necessary. The intangible text property has
5272 led to problems with flyspell. These problems are fixed in flyspell.el,
5273 but we still avoid setting the property in Emacs 22 and later.
5274 We use a macro so that the test can happen at compilation time."
5275 (if (< emacs-major-version 22)
5276 `(append '(intangible t) ,props)
5277 props))
5279 (defun org-activate-bracket-links (limit)
5280 "Run through the buffer and add overlays to bracketed links."
5281 (if (re-search-forward org-bracket-link-regexp limit t)
5282 (let* ((help (concat "LINK: "
5283 (org-match-string-no-properties 1)))
5284 ;; FIXME: above we should remove the escapes.
5285 ;; but that requires another match, protecting match data,
5286 ;; a lot of overhead for font-lock.
5287 (ip (org-maybe-intangible
5288 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5289 'keymap org-mouse-map 'mouse-face 'highlight
5290 'font-lock-multiline t 'help-echo help)))
5291 (vp (list 'rear-nonsticky org-nonsticky-props
5292 'keymap org-mouse-map 'mouse-face 'highlight
5293 ' font-lock-multiline t 'help-echo help)))
5294 ;; We need to remove the invisible property here. Table narrowing
5295 ;; may have made some of this invisible.
5296 (remove-text-properties (match-beginning 0) (match-end 0)
5297 '(invisible nil))
5298 (if (match-end 3)
5299 (progn
5300 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5301 (add-text-properties (match-beginning 3) (match-end 3) vp)
5302 (add-text-properties (match-end 3) (match-end 0) ip))
5303 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5304 (add-text-properties (match-beginning 1) (match-end 1) vp)
5305 (add-text-properties (match-end 1) (match-end 0) ip))
5306 t)))
5308 (defun org-activate-dates (limit)
5309 "Run through the buffer and add overlays to dates."
5310 (if (re-search-forward org-tsr-regexp-both limit t)
5311 (progn
5312 (add-text-properties (match-beginning 0) (match-end 0)
5313 (list 'mouse-face 'highlight
5314 'rear-nonsticky org-nonsticky-props
5315 'keymap org-mouse-map))
5316 (when org-display-custom-times
5317 (if (match-end 3)
5318 (org-display-custom-time (match-beginning 3) (match-end 3)))
5319 (org-display-custom-time (match-beginning 1) (match-end 1)))
5320 t)))
5322 (defvar org-target-link-regexp nil
5323 "Regular expression matching radio targets in plain text.")
5325 "Regular expression matching a link target.")
5327 "Regular expression matching a radio target.")
5328 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5329 "Regular expression matching any target.")
5331 (defun org-activate-target-links (limit)
5332 "Run through the buffer and add overlays to target matches."
5333 (when org-target-link-regexp
5334 (let ((case-fold-search t))
5335 (if (re-search-forward org-target-link-regexp limit t)
5336 (progn
5337 (add-text-properties (match-beginning 0) (match-end 0)
5338 (list 'mouse-face 'highlight
5339 'rear-nonsticky org-nonsticky-props
5340 'keymap org-mouse-map
5341 'help-echo "Radio target link"
5342 'org-linked-text t))
5343 t)))))
5345 (defun org-update-radio-target-regexp ()
5346 "Find all radio targets in this file and update the regular expression."
5347 (interactive)
5348 (when (memq 'radio org-activate-links)
5349 (setq org-target-link-regexp
5350 (org-make-target-link-regexp (org-all-targets 'radio)))
5351 (org-restart-font-lock)))
5353 (defun org-hide-wide-columns (limit)
5354 (let (s e)
5355 (setq s (text-property-any (point) (or limit (point-max))
5356 'org-cwidth t))
5357 (when s
5358 (setq e (next-single-property-change s 'org-cwidth))
5359 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5360 (goto-char e)
5361 t)))
5363 (defvar org-latex-and-specials-regexp nil
5364 "Regular expression for highlighting export special stuff.")
5365 (defvar org-match-substring-regexp)
5366 (defvar org-match-substring-with-braces-regexp)
5367 (defvar org-export-html-special-string-regexps)
5369 (defun org-compute-latex-and-specials-regexp ()
5370 "Compute regular expression for stuff treated specially by exporters."
5371 (if (not org-highlight-latex-fragments-and-specials)
5372 (org-set-local 'org-latex-and-specials-regexp nil)
5373 (let*
5374 ((matchers (plist-get org-format-latex-options :matchers))
5375 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5376 org-latex-regexps)))
5377 (options (org-combine-plists (org-default-export-plist)
5378 (org-infile-export-plist)))
5379 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5380 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5381 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5382 (org-export-html-expand (plist-get options :expand-quoted-html))
5383 (org-export-with-special-strings (plist-get options :special-strings))
5384 (re-sub
5385 (cond
5386 ((equal org-export-with-sub-superscripts '{})
5387 (list org-match-substring-with-braces-regexp))
5388 (org-export-with-sub-superscripts
5389 (list org-match-substring-regexp))
5390 (t nil)))
5391 (re-latex
5392 (if org-export-with-LaTeX-fragments
5393 (mapcar (lambda (x) (nth 1 x)) latexs)))
5394 (re-macros
5395 (if org-export-with-TeX-macros
5397 (regexp-opt
5398 (append (mapcar 'car org-html-entities)
5399 (if (boundp 'org-latex-entities)
5400 org-latex-entities nil))
5401 'words))) ; FIXME
5402 ))
5404 (re-special (if org-export-with-special-strings
5405 (mapcar (lambda (x) (car x))
5406 org-export-html-special-string-regexps)))
5407 (re-rest
5408 (delq nil
5409 (list
5411 ))))
5412 (org-set-local
5413 'org-latex-and-specials-regexp
5414 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5417 (defface org-latex-and-export-specials
5418 (let ((font (cond ((assq :inherit custom-face-attributes)
5419 '(:inherit underline))
5420 (t '(:underline t)))))
5421 `((((class grayscale) (background light))
5422 (:foreground "DimGray" ,@font))
5423 (((class grayscale) (background dark))
5424 (:foreground "LightGray" ,@font))
5425 (((class color) (background light))
5426 (:foreground "SaddleBrown"))
5427 (((class color) (background dark))
5428 (:foreground "burlywood"))
5429 (t (,@font))))
5430 "Face used to highlight math latex and other special exporter stuff."
5431 :group 'org-faces)
5433 (defun org-do-latex-and-special-faces (limit)
5434 "Run through the buffer and add overlays to links."
5435 (when org-latex-and-specials-regexp
5436 (let (rtn d)
5437 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5438 limit t))
5439 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5440 'face))
5441 '(org-code org-verbatim underline)))
5442 (progn
5443 (setq rtn t
5444 d (cond ((member (char-after (1+ (match-beginning 0)))
5445 '(?_ ?^)) 1)
5446 (t 0)))
5447 (font-lock-prepend-text-property
5448 (+ d (match-beginning 0)) (match-end 0)
5449 'face 'org-latex-and-export-specials)
5450 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5451 '(font-lock-multiline t)))))
5452 rtn)))
5454 (defun org-restart-font-lock ()
5455 "Restart font-lock-mode, to force refontification."
5456 (when (and (boundp 'font-lock-mode) font-lock-mode)
5457 (font-lock-mode -1)
5458 (font-lock-mode 1)))
5460 (defun org-all-targets (&optional radio)
5461 "Return a list of all targets in this file.
5462 With optional argument RADIO, only find radio targets."
5463 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5464 rtn)
5465 (save-excursion
5466 (goto-char (point-min))
5467 (while (re-search-forward re nil t)
5468 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5469 rtn)))
5471 (defun org-make-target-link-regexp (targets)
5472 "Make regular expression matching all strings in TARGETS.
5473 The regular expression finds the targets also if there is a line break
5474 between words."
5475 (and targets
5476 (concat
5478 (mapconcat
5479 (lambda (x)
5480 (while (string-match " +" x)
5482 x)
5483 targets
5487 (defun org-activate-tags (limit)
5489 (progn
5490 (add-text-properties (match-beginning 1) (match-end 1)
5491 (list 'mouse-face 'highlight
5492 'rear-nonsticky org-nonsticky-props
5493 'keymap org-mouse-map))
5494 t)))
5496 (defun org-outline-level ()
5497 (save-excursion
5498 (looking-at outline-regexp)
5499 (if (match-beginning 1)
5500 (+ (org-get-string-indentation (match-string 1)) 1000)
5501 (1- (- (match-end 0) (match-beginning 0))))))
5503 (defvar org-font-lock-keywords nil)
5506 "Regular expression matching a property line.")
5508 (defun org-set-font-lock-defaults ()
5509 (let* ((em org-fontify-emphasized-text)
5510 (lk org-activate-links)
5511 (org-font-lock-extra-keywords
5512 (list
5513 ;; Headlines
5515 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5516 ;; Table lines
5518 (1 'org-table t))
5519 ;; Table internals
5523 ;; Drawers
5524 (list org-drawer-regexp '(0 'org-special-keyword t))
5526 ;; Properties
5527 (list org-property-re
5528 '(1 'org-special-keyword t)
5529 '(3 'org-property-value t))
5530 (if org-format-transports-properties-p
5532 ;; Links
5533 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5534 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5535 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5536 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5537 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5538 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5540 '(org-hide-wide-columns (0 nil append))
5541 ;; TODO lines
5543 '(1 (org-get-todo-face 1) t))
5544 ;; DONE
5545 (if org-fontify-done-headline
5549 '(2 'org-headline-done t))
5550 nil)
5551 ;; Priorities
5553 ;; Special keywords
5558 ;; Emphasis
5559 (if em
5560 (if (featurep 'xemacs)
5561 '(org-do-emphasis-faces (0 nil append))
5562 '(org-do-emphasis-faces)))
5563 ;; Checkboxes
5565 2 'bold prepend)
5566 (if org-provide-checkbox-statistics
5568 (0 (org-get-checkbox-statistics-face) t)))
5570 '(1 'org-archived prepend))
5571 ;; Specials
5572 '(org-do-latex-and-special-faces)
5573 ;; Code
5574 '(org-activate-code (1 'org-code t))
5575 ;; COMMENT
5578 '(1 'org-special-keyword t))
5579 '("^#.*" (0 'font-lock-comment-face t))
5580 )))
5581 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5582 ;; Now set the full font-lock-keywords
5583 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5584 (org-set-local 'font-lock-defaults
5585 '(org-font-lock-keywords t nil nil backward-paragraph))
5586 (kill-local-variable 'font-lock-keywords) nil))
5588 (defvar org-m nil)
5589 (defvar org-l nil)
5590 (defvar org-f nil)
5591 (defun org-get-level-face (n)
5592 "Get the right face for match N in font-lock matching of healdines."
5593 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5594 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5595 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5596 (cond
5597 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5598 ((eq n 2) org-f)
5599 (t (if org-level-color-stars-only nil org-f))))
5601 (defun org-get-todo-face (kwd)
5602 "Get the right face for a TODO keyword KWD.
5603 If KWD is a number, get the corresponding match group."
5604 (if (numberp kwd) (setq kwd (match-string kwd)))
5605 (or (cdr (assoc kwd org-todo-keyword-faces))
5606 (and (member kwd org-done-keywords) 'org-done)
5607 'org-todo))
5609 (defun org-unfontify-region (beg end &optional maybe_loudly)
5610 "Remove fontification and activation overlays from links."
5611 (font-lock-default-unfontify-region beg end)
5612 (let* ((buffer-undo-list t)
5613 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5614 (inhibit-modification-hooks t)
5615 deactivate-mark buffer-file-name buffer-file-truename)
5616 (remove-text-properties beg end
5617 '(mouse-face t keymap t org-linked-text t
5618 invisible t intangible t))))
5620 ;;;; Visibility cycling, including org-goto and indirect buffer
5622 ;;; Cycling
5624 (defvar org-cycle-global-status nil)
5625 (make-variable-buffer-local 'org-cycle-global-status)
5626 (defvar org-cycle-subtree-status nil)
5627 (make-variable-buffer-local 'org-cycle-subtree-status)
5629 ;;;###autoload
5630 (defun org-cycle (&optional arg)
5631 "Visibility cycling for Org-mode.
5633 - When this function is called with a prefix argument, rotate the entire
5634 buffer through 3 states (global cycling)
5635 1. OVERVIEW: Show only top-level headlines.
5636 2. CONTENTS: Show all headlines of all levels, but no body text.
5637 3. SHOW ALL: Show everything.
5639 - When point is at the beginning of a headline, rotate the subtree started
5640 by this line through 3 different states (local cycling)
5641 1. FOLDED: Only the main headline is shown.
5642 2. CHILDREN: The main headline and the direct children are shown.
5643 From this state, you can move to one of the children
5644 and zoom in further.
5645 3. SUBTREE: Show the entire subtree, including body text.
5647 - When there is a numeric prefix, go up to a heading with level ARG, do
5648 a `show-subtree' and return to the previous cursor position. If ARG
5649 is negative, go up that many levels.
5651 - When point is not at the beginning of a headline, execute
5652 `indent-relative', like TAB normally does. See the option
5653 `org-cycle-emulate-tab' for details.
5655 - Special case: if point is at the beginning of the buffer and there is
5656 no headline in line 1, this function will act as if called with prefix arg.
5657 But only if also the variable `org-cycle-global-at-bob' is t."
5658 (interactive "P")
5659 (let* ((outline-regexp
5660 (if (and (org-mode-p) org-cycle-include-plain-lists)
5662 outline-regexp))
5663 (bob-special (and org-cycle-global-at-bob (bobp)
5664 (not (looking-at outline-regexp))))
5665 (org-cycle-hook
5666 (if bob-special
5667 (delq 'org-optimize-window-after-visibility-change
5668 (copy-sequence org-cycle-hook))
5669 org-cycle-hook))
5670 (pos (point)))
5672 (if (or bob-special (equal arg '(4)))
5673 ;; special case: use global cycling
5674 (setq arg t))
5676 (cond
5678 ((org-at-table-p 'any)
5679 ;; Enter the table or move to the next field in the table
5680 (or (org-table-recognize-table.el)
5681 (progn
5682 (if arg (org-table-edit-field t)
5683 (org-table-justify-field-maybe)
5684 (call-interactively 'org-table-next-field)))))
5686 ((eq arg t) ;; Global cycling
5688 (cond
5689 ((and (eq last-command this-command)
5690 (eq org-cycle-global-status 'overview))
5691 ;; We just created the overview - now do table of contents
5692 ;; This can be slow in very large buffers, so indicate action
5693 (message "CONTENTS...")
5694 (org-content)
5695 (message "CONTENTS...done")
5696 (setq org-cycle-global-status 'contents)
5697 (run-hook-with-args 'org-cycle-hook 'contents))
5699 ((and (eq last-command this-command)
5700 (eq org-cycle-global-status 'contents))
5701 ;; We just showed the table of contents - now show everything
5702 (show-all)
5703 (message "SHOW ALL")
5704 (setq org-cycle-global-status 'all)
5705 (run-hook-with-args 'org-cycle-hook 'all))
5707 (t
5708 ;; Default action: go to overview
5709 (org-overview)
5710 (message "OVERVIEW")
5711 (setq org-cycle-global-status 'overview)
5712 (run-hook-with-args 'org-cycle-hook 'overview))))
5714 ((and org-drawers org-drawer-regexp
5715 (save-excursion
5716 (beginning-of-line 1)
5717 (looking-at org-drawer-regexp)))
5718 ;; Toggle block visibility
5719 (org-flag-drawer
5720 (not (get-char-property (match-end 0) 'invisible))))
5722 ((integerp arg)
5723 ;; Show-subtree, ARG levels up from here.
5724 (save-excursion
5725 (org-back-to-heading)
5726 (outline-up-heading (if (< arg 0) (- arg)
5727 (- (funcall outline-level) arg)))
5728 (org-show-subtree)))
5730 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5731 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5732 ;; At a heading: rotate between three different views
5733 (org-back-to-heading)
5734 (let ((goal-column 0) eoh eol eos)
5735 ;; First, some boundaries
5736 (save-excursion
5737 (org-back-to-heading)
5738 (save-excursion
5739 (beginning-of-line 2)
5740 (while (and (not (eobp)) ;; this is like `next-line'
5741 (get-char-property (1- (point)) 'invisible))
5742 (beginning-of-line 2)) (setq eol (point)))
5743 (outline-end-of-heading) (setq eoh (point))
5744 (org-end-of-subtree t)
5745 (unless (eobp)
5747 (beginning-of-line 1) ; in case this is an item
5748 )
5749 (setq eos (1- (point))))
5750 ;; Find out what to do next and set `this-command'
5751 (cond
5752 ((= eos eoh)
5753 ;; Nothing is hidden behind this heading
5754 (message "EMPTY ENTRY")
5755 (setq org-cycle-subtree-status nil)
5756 (save-excursion
5757 (goto-char eos)
5758 (outline-next-heading)
5759 (if (org-invisible-p) (org-flag-heading nil))))
5760 ((or (>= eol eos)
5762 ;; Entire subtree is hidden in one line: open it
5763 (org-show-entry)
5764 (show-children)
5765 (message "CHILDREN")
5766 (save-excursion
5767 (goto-char eos)
5768 (outline-next-heading)
5769 (if (org-invisible-p) (org-flag-heading nil)))
5770 (setq org-cycle-subtree-status 'children)
5771 (run-hook-with-args 'org-cycle-hook 'children))
5772 ((and (eq last-command this-command)
5773 (eq org-cycle-subtree-status 'children))
5774 ;; We just showed the children, now show everything.
5775 (org-show-subtree)
5776 (message "SUBTREE")
5777 (setq org-cycle-subtree-status 'subtree)
5778 (run-hook-with-args 'org-cycle-hook 'subtree))
5779 (t
5780 ;; Default action: hide the subtree.
5781 (hide-subtree)
5782 (message "FOLDED")
5783 (setq org-cycle-subtree-status 'folded)
5784 (run-hook-with-args 'org-cycle-hook 'folded)))))
5786 ;; TAB emulation
5787 (buffer-read-only (org-back-to-heading))
5789 ((org-try-cdlatex-tab))
5791 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5792 (or (not (bolp))
5793 (not (looking-at outline-regexp))))
5796 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5798 (or (and (eq org-cycle-emulate-tab 'white)
5799 (= (match-end 0) (point-at-eol)))
5800 (and (eq org-cycle-emulate-tab 'whitestart)
5801 (>= (match-end 0) pos))))
5802 t
5803 (eq org-cycle-emulate-tab t))
5806 ; (point-at-bol) (point))))
5807 ; (progn
5808 ; (beginning-of-line 1)
5812 (t (save-excursion
5813 (org-back-to-heading)
5814 (org-cycle))))))
5816 ;;;###autoload
5817 (defun org-global-cycle (&optional arg)
5818 "Cycle the global visibility. For details see `org-cycle'."
5819 (interactive "P")
5820 (let ((org-cycle-include-plain-lists
5821 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5822 (if (integerp arg)
5823 (progn
5824 (show-all)
5825 (hide-sublevels arg)
5826 (setq org-cycle-global-status 'contents))
5827 (org-cycle '(4)))))
5829 (defun org-overview ()
5830 "Switch to overview mode, shoing only top-level headlines.
5831 Really, this shows all headlines with level equal or greater than the level
5832 of the first headline in the buffer. This is important, because if the
5833 first headline is not level one, then (hide-sublevels 1) gives confusing
5834 results."
5835 (interactive)
5836 (let ((level (save-excursion
5837 (goto-char (point-min))
5838 (if (re-search-forward (concat "^" outline-regexp) nil t)
5839 (progn
5840 (goto-char (match-beginning 0))
5841 (funcall outline-level))))))
5842 (and level (hide-sublevels level))))
5844 (defun org-content (&optional arg)
5845 "Show all headlines in the buffer, like a table of contents.
5846 With numerical argument N, show content up to level N."
5847 (interactive "P")
5848 (save-excursion
5849 ;; Visit all headings and show their offspring
5850 (and (integerp arg) (org-overview))
5851 (goto-char (point-max))
5852 (catch 'exit
5853 (while (and (progn (condition-case nil
5854 (outline-previous-visible-heading 1)
5855 (error (goto-char (point-min))))
5856 t)
5857 (looking-at outline-regexp))
5858 (if (integerp arg)
5859 (show-children (1- arg))
5860 (show-branches))
5861 (if (bobp) (throw 'exit nil))))))
5864 (defun org-optimize-window-after-visibility-change (state)
5865 "Adjust the window after a change in outline visibility.
5866 This function is the default value of the hook `org-cycle-hook'."
5867 (when (get-buffer-window (current-buffer))
5868 (cond
5869 ; ((eq state 'overview) (org-first-headline-recenter 1))
5870 ; ((eq state 'overview) (org-beginning-of-line))
5871 ((eq state 'content) nil)
5872 ((eq state 'all) nil)
5873 ((eq state 'folded) nil)
5874 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5875 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5877 (defun org-compact-display-after-subtree-move ()
5878 (let (beg end)
5879 (save-excursion
5880 (if (org-up-heading-safe)
5881 (progn
5882 (hide-subtree)
5883 (show-entry)
5884 (show-children)
5885 (org-cycle-show-empty-lines 'children)
5886 (org-cycle-hide-drawers 'children))
5887 (org-overview)))))
5889 (defun org-cycle-show-empty-lines (state)
5890 "Show empty lines above all visible headlines.
5891 The region to be covered depends on STATE when called through
5892 `org-cycle-hook'. Lisp program can use t for STATE to get the
5893 entire buffer covered. Note that an empty line is only shown if there
5894 are at least `org-cycle-separator-lines' empty lines before the headeline."
5895 (when (> org-cycle-separator-lines 0)
5896 (save-excursion
5897 (let* ((n org-cycle-separator-lines)
5898 (re (cond
5901 (t (let ((ns (number-to-string (- n 2))))
5904 beg end)
5905 (cond
5906 ((memq state '(overview contents t))
5907 (setq beg (point-min) end (point-max)))
5908 ((memq state '(children folded))
5909 (setq beg (point) end (progn (org-end-of-subtree t t)
5910 (beginning-of-line 2)
5911 (point)))))
5912 (when beg
5913 (goto-char beg)
5914 (while (re-search-forward re end t)
5915 (if (not (get-char-property (match-end 1) 'invisible))
5916 (outline-flag-region
5917 (match-beginning 1) (match-end 1) nil)))))))
5918 ;; Never hide empty lines at the end of the file.
5919 (save-excursion
5920 (goto-char (point-max))
5921 (outline-previous-heading)
5922 (outline-end-of-heading)
5924 (= (match-end 0) (point-max)))
5925 (outline-flag-region (point) (match-end 0) nil))))
5927 (defun org-subtree-end-visible-p ()
5928 "Is the end of the current subtree visible?"
5929 (pos-visible-in-window-p
5930 (save-excursion (org-end-of-subtree t) (point))))
5932 (defun org-first-headline-recenter (&optional N)
5933 "Move cursor to the first headline and recenter the headline.
5934 Optional argument N means, put the headline into the Nth line of the window."
5935 (goto-char (point-min))
5937 (beginning-of-line)
5938 (recenter (prefix-numeric-value N))))
5940 ;;; Org-goto
5942 (defvar org-goto-window-configuration nil)
5943 (defvar org-goto-marker nil)
5944 (defvar org-goto-map
5945 (let ((map (make-sparse-keymap)))
5946 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5947 (while (setq cmd (pop cmds))
5948 (substitute-key-definition cmd cmd map global-map)))
5949 (suppress-keymap map)
5950 (org-defkey map "\C-m" 'org-goto-ret)
5951 (org-defkey map [(return)] 'org-goto-ret)
5952 (org-defkey map [(left)] 'org-goto-left)
5953 (org-defkey map [(right)] 'org-goto-right)
5954 (org-defkey map [(control ?g)] 'org-goto-quit)
5955 (org-defkey map "\C-i" 'org-cycle)
5956 (org-defkey map [(tab)] 'org-cycle)
5957 (org-defkey map [(down)] 'outline-next-visible-heading)
5958 (org-defkey map [(up)] 'outline-previous-visible-heading)
5959 (if org-goto-auto-isearch
5960 (if (fboundp 'define-key-after)
5961 (define-key-after map [t] 'org-goto-local-auto-isearch)
5962 nil)
5963 (org-defkey map "q" 'org-goto-quit)
5964 (org-defkey map "n" 'outline-next-visible-heading)
5965 (org-defkey map "p" 'outline-previous-visible-heading)
5966 (org-defkey map "f" 'outline-forward-same-level)
5967 (org-defkey map "b" 'outline-backward-same-level)
5968 (org-defkey map "u" 'outline-up-heading))
5969 (org-defkey map "/" 'org-occur)
5970 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5971 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5972 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5973 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5974 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5975 map))
5977 (defconst org-goto-help
5978 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5979 RET=jump to location [Q]uit and return to previous location
5980 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5982 (defvar org-goto-start-pos) ; dynamically scoped parameter
5984 (defun org-goto (&optional alternative-interface)
5985 "Look up a different location in the current file, keeping current visibility.
5987 When you want look-up or go to a different location in a document, the
5988 fastest way is often to fold the entire buffer and then dive into the tree.
5989 This method has the disadvantage, that the previous location will be folded,
5990 which may not be what you want.
5992 This command works around this by showing a copy of the current buffer
5993 in an indirect buffer, in overview mode. You can dive into the tree in
5994 that copy, use org-occur and incremental search to find a location.
5995 When pressing RET or `Q', the command returns to the original buffer in
5996 which the visibility is still unchanged. After RET is will also jump to
5997 the location selected in the indirect buffer and expose the
5998 the headline hierarchy above."
5999 (interactive "P")
6000 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
6001 (org-refile-use-outline-path t)
6002 (interface
6003 (if (not alternative-interface)
6004 org-goto-interface
6005 (if (eq org-goto-interface 'outline)
6006 'outline-path-completion
6007 'outline)))
6008 (org-goto-start-pos (point))
6009 (selected-point
6010 (if (eq interface 'outline)
6011 (car (org-get-location (current-buffer) org-goto-help))
6012 (nth 3 (org-refile-get-location "Goto: ")))))
6013 (if selected-point
6014 (progn
6015 (org-mark-ring-push org-goto-start-pos)
6016 (goto-char selected-point)
6017 (if (or (org-invisible-p) (org-invisible-p2))
6018 (org-show-context 'org-goto)))
6019 (message "Quit"))))
6021 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6022 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6023 (defvar org-goto-local-auto-isearch-map) ; defined below
6025 (defun org-get-location (buf help)
6026 "Let the user select a location in the Org-mode buffer BUF.
6027 This function uses a recursive edit. It returns the selected position
6028 or nil."
6029 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6030 (isearch-hide-immediately nil)
6031 (isearch-search-fun-function
6032 (lambda () 'org-goto-local-search-forward-headings))
6033 (org-goto-selected-point org-goto-exit-command))
6034 (save-excursion
6035 (save-window-excursion
6036 (delete-other-windows)
6037 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6038 (switch-to-buffer
6039 (condition-case nil
6040 (make-indirect-buffer (current-buffer) "*org-goto*")
6041 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6042 (with-output-to-temp-buffer "*Help*"
6043 (princ help))
6044 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6045 (setq buffer-read-only nil)
6046 (let ((org-startup-truncated t)
6047 (org-startup-folded nil)
6048 (org-startup-align-all-tables nil))
6049 (org-mode)
6050 (org-overview))
6051 (setq buffer-read-only t)
6052 (if (and (boundp 'org-goto-start-pos)
6053 (integer-or-marker-p org-goto-start-pos))
6054 (let ((org-show-hierarchy-above t)
6055 (org-show-siblings t)
6056 (org-show-following-heading t))
6057 (goto-char org-goto-start-pos)
6058 (and (org-invisible-p) (org-show-context)))
6059 (goto-char (point-min)))
6060 (org-beginning-of-line)
6061 (message "Select location and press RET")
6062 (use-local-map org-goto-map)
6063 (recursive-edit)
6064 ))
6065 (kill-buffer "*org-goto*")
6066 (cons org-goto-selected-point org-goto-exit-command)))
6068 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6069 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6070 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6071 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6073 (defun org-goto-local-search-forward-headings (string bound noerror)
6074 "Search and make sure that anu matches are in headlines."
6075 (catch 'return
6076 (while (search-forward string bound noerror)
6077 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6078 (and (member :headline context)
6079 (not (member :tags context))))
6080 (throw 'return (point))))))
6082 (defun org-goto-local-auto-isearch ()
6083 "Start isearch."
6084 (interactive)
6085 (goto-char (point-min))
6086 (let ((keys (this-command-keys)))
6087 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6088 (isearch-mode t)
6089 (isearch-process-search-char (string-to-char keys)))))
6091 (defun org-goto-ret (&optional arg)
6092 "Finish `org-goto' by going to the new location."
6093 (interactive "P")
6094 (setq org-goto-selected-point (point)
6095 org-goto-exit-command 'return)
6096 (throw 'exit nil))
6098 (defun org-goto-left ()
6099 "Finish `org-goto' by going to the new location."
6100 (interactive)
6101 (if (org-on-heading-p)
6102 (progn
6103 (beginning-of-line 1)
6104 (setq org-goto-selected-point (point)
6105 org-goto-exit-command 'left)
6106 (throw 'exit nil))
6107 (error "Not on a heading")))
6109 (defun org-goto-right ()
6110 "Finish `org-goto' by going to the new location."
6111 (interactive)
6112 (if (org-on-heading-p)
6113 (progn
6114 (setq org-goto-selected-point (point)
6115 org-goto-exit-command 'right)
6116 (throw 'exit nil))
6117 (error "Not on a heading")))
6119 (defun org-goto-quit ()
6120 "Finish `org-goto' without cursor motion."
6121 (interactive)
6122 (setq org-goto-selected-point nil)
6123 (setq org-goto-exit-command 'quit)
6124 (throw 'exit nil))
6126 ;;; Indirect buffer display of subtrees
6128 (defvar org-indirect-dedicated-frame nil
6129 "This is the frame being used for indirect tree display.")
6130 (defvar org-last-indirect-buffer nil)
6132 (defun org-tree-to-indirect-buffer (&optional arg)
6133 "Create indirect buffer and narrow it to current subtree.
6134 With numerical prefix ARG, go up to this level and then take that tree.
6135 If ARG is negative, go up that many levels.
6136 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6137 indirect buffer previously made with this command, to avoid proliferation of
6138 indirect buffers. However, when you call the command with a `C-u' prefix, or
6139 when `org-indirect-buffer-display' is `new-frame', the last buffer
6140 is kept so that you can work with several indirect buffers at the same time.
6141 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6142 requests that a new frame be made for the new buffer, so that the dedicated
6143 frame is not changed."
6144 (interactive "P")
6145 (let ((cbuf (current-buffer))
6146 (cwin (selected-window))
6147 (pos (point))
6148 beg end level heading ibuf)
6149 (save-excursion
6150 (org-back-to-heading t)
6151 (when (numberp arg)
6152 (setq level (org-outline-level))
6153 (if (< arg 0) (setq arg (+ level arg)))
6154 (while (> (setq level (org-outline-level)) arg)
6155 (outline-up-heading 1 t)))
6156 (setq beg (point)
6157 heading (org-get-heading))
6158 (org-end-of-subtree t) (setq end (point)))
6159 (if (and (buffer-live-p org-last-indirect-buffer)
6160 (not (eq org-indirect-buffer-display 'new-frame))
6161 (not arg))
6162 (kill-buffer org-last-indirect-buffer))
6163 (setq ibuf (org-get-indirect-buffer cbuf)
6164 org-last-indirect-buffer ibuf)
6165 (cond
6166 ((or (eq org-indirect-buffer-display 'new-frame)
6167 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6168 (select-frame (make-frame))
6169 (delete-other-windows)
6170 (switch-to-buffer ibuf)
6171 (org-set-frame-title heading))
6172 ((eq org-indirect-buffer-display 'dedicated-frame)
6173 (raise-frame
6174 (select-frame (or (and org-indirect-dedicated-frame
6175 (frame-live-p org-indirect-dedicated-frame)
6176 org-indirect-dedicated-frame)
6177 (setq org-indirect-dedicated-frame (make-frame)))))
6178 (delete-other-windows)
6179 (switch-to-buffer ibuf)
6180 (org-set-frame-title (concat "Indirect: " heading)))
6181 ((eq org-indirect-buffer-display 'current-window)
6182 (switch-to-buffer ibuf))
6183 ((eq org-indirect-buffer-display 'other-window)
6184 (pop-to-buffer ibuf))
6185 (t (error "Invalid value.")))
6186 (if (featurep 'xemacs)
6187 (save-excursion (org-mode) (turn-on-font-lock)))
6188 (narrow-to-region beg end)
6189 (show-all)
6190 (goto-char pos)
6191 (and (window-live-p cwin) (select-window cwin))))
6193 (defun org-get-indirect-buffer (&optional buffer)
6194 (setq buffer (or buffer (current-buffer)))
6195 (let ((n 1) (base (buffer-name buffer)) bname)
6196 (while (buffer-live-p
6197 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6198 (setq n (1+ n)))
6199 (condition-case nil
6200 (make-indirect-buffer buffer bname 'clone)
6201 (error (make-indirect-buffer buffer bname)))))
6203 (defun org-set-frame-title (title)
6204 "Set the title of the current frame to the string TITLE."
6205 ;; FIXME: how to name a single frame in XEmacs???
6206 (unless (featurep 'xemacs)
6207 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6209 ;;;; Structure editing
6211 ;;; Inserting headlines
6213 (defun org-insert-heading (&optional force-heading)
6214 "Insert a new heading or item with same depth at point.
6215 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6216 If point is at the beginning of a headline, insert a sibling before the
6217 current headline. If point is not at the beginning, do not split the line,
6218 but create the new hedline after the current line."
6219 (interactive "P")
6220 (if (= (buffer-size) 0)
6222 (when (or force-heading (not (org-insert-item)))
6223 (let* ((head (save-excursion
6224 (condition-case nil
6225 (progn
6226 (org-back-to-heading)
6227 (match-string 0))
6228 (error "*"))))
6229 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6230 pos)
6231 (cond
6232 ((and (org-on-heading-p) (bolp)
6233 (or (bobp)
6234 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6235 ;; insert before the current line
6236 (open-line (if blank 2 1)))
6237 ((and (bolp)
6238 (or (bobp)
6239 (save-excursion
6240 (backward-char 1) (not (org-invisible-p)))))
6241 ;; insert right here
6242 nil)
6243 (t
6244 ; ;; in the middle of the line
6245 ; (org-show-entry)
6246 ; (if (org-get-alist-option org-M-RET-may-split-line 'headline)
6247 ; (if (and
6248 ; (org-on-heading-p)
6250 ; ;; protect the tags
6251 ;; (let ((tags (match-string 2)) pos)
6252 ; (delete-region (match-beginning 1) (match-end 1))
6253 ; (setq pos (point-at-bol))
6254 ; (newline (if blank 2 1))
6255 ; (save-excursion
6256 ; (goto-char pos)
6257 ; (end-of-line 1)
6258 ; (insert " " tags)
6259 ; (org-set-tags nil 'align)))
6260 ; (newline (if blank 2 1)))
6261 ; (newline (if blank 2 1))))
6264 ;; in the middle of the line
6265 (org-show-entry)
6266 (let ((split
6267 (org-get-alist-option org-M-RET-may-split-line 'headline))
6268 tags pos)
6269 (if (org-on-heading-p)
6270 (progn
6272 (setq tags (and (match-end 2) (match-string 2)))
6273 (and (match-end 1)
6274 (delete-region (match-beginning 1) (match-end 1)))
6275 (setq pos (point-at-bol))
6276 (or split (end-of-line 1))
6277 (delete-horizontal-space)
6278 (newline (if blank 2 1))
6279 (when tags
6280 (save-excursion
6281 (goto-char pos)
6282 (end-of-line 1)
6283 (insert " " tags)
6284 (org-set-tags nil 'align))))
6285 (or split (end-of-line 1))
6286 (newline (if blank 2 1))))))
6287 (insert head) (just-one-space)
6288 (setq pos (point))
6289 (end-of-line 1)
6290 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6291 (run-hooks 'org-insert-heading-hook)))))
6293 (defun org-insert-heading-after-current ()
6294 "Insert a new heading with same level as current, after current subtree."
6295 (interactive)
6296 (org-back-to-heading)
6297 (org-insert-heading)
6298 (org-move-subtree-down)
6299 (end-of-line 1))
6301 (defun org-insert-todo-heading (arg)
6302 "Insert a new heading with the same level and TODO state as current heading.
6303 If the heading has no TODO state, or if the state is DONE, use the first
6304 state (TODO by default). Also with prefix arg, force first state."
6305 (interactive "P")
6306 (when (not (org-insert-item 'checkbox))
6307 (org-insert-heading)
6308 (save-excursion
6309 (org-back-to-heading)
6310 (outline-previous-heading)
6311 (looking-at org-todo-line-regexp))
6312 (if (or arg
6313 (not (match-beginning 2))
6314 (member (match-string 2) org-done-keywords))
6315 (insert (car org-todo-keywords-1) " ")
6316 (insert (match-string 2) " "))))
6318 (defun org-insert-subheading (arg)
6319 "Insert a new subheading and demote it.
6320 Works for outline headings and for plain lists alike."
6321 (interactive "P")
6322 (org-insert-heading arg)
6323 (cond
6324 ((org-on-heading-p) (org-do-demote))
6325 ((org-at-item-p) (org-indent-item 1))))
6327 (defun org-insert-todo-subheading (arg)
6328 "Insert a new subheading with TODO keyword or checkbox and demote it.
6329 Works for outline headings and for plain lists alike."
6330 (interactive "P")
6331 (org-insert-todo-heading arg)
6332 (cond
6333 ((org-on-heading-p) (org-do-demote))
6334 ((org-at-item-p) (org-indent-item 1))))
6336 ;;; Promotion and Demotion
6338 (defun org-promote-subtree ()
6339 "Promote the entire subtree.
6340 See also `org-promote'."
6341 (interactive)
6342 (save-excursion
6343 (org-map-tree 'org-promote))
6344 (org-fix-position-after-promote))
6346 (defun org-demote-subtree ()
6347 "Demote the entire subtree. See `org-demote'.
6348 See also `org-promote'."
6349 (interactive)
6350 (save-excursion
6351 (org-map-tree 'org-demote))
6352 (org-fix-position-after-promote))
6355 (defun org-do-promote ()
6356 "Promote the current heading higher up the tree.
6357 If the region is active in `transient-mark-mode', promote all headings
6358 in the region."
6359 (interactive)
6360 (save-excursion
6361 (if (org-region-active-p)
6362 (org-map-region 'org-promote (region-beginning) (region-end))
6363 (org-promote)))
6364 (org-fix-position-after-promote))
6366 (defun org-do-demote ()
6367 "Demote the current heading lower down the tree.
6368 If the region is active in `transient-mark-mode', demote all headings
6369 in the region."
6370 (interactive)
6371 (save-excursion
6372 (if (org-region-active-p)
6373 (org-map-region 'org-demote (region-beginning) (region-end))
6374 (org-demote)))
6375 (org-fix-position-after-promote))
6377 (defun org-fix-position-after-promote ()
6378 "Make sure that after pro/demotion cursor position is right."
6379 (let ((pos (point)))
6380 (when (save-excursion
6381 (beginning-of-line 1)
6382 (looking-at org-todo-line-regexp)
6383 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6384 (cond ((eobp) (insert " "))
6385 ((eolp) (insert " "))
6386 ((equal (char-after) ?\ ) (forward-char 1))))))
6388 (defun org-reduced-level (l)
6389 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6391 (defun org-get-legal-level (level &optional change)
6392 "Rectify a level change under the influence of `org-odd-levels-only'
6393 LEVEL is a current level, CHANGE is by how much the level should be
6394 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6395 even level numbers will become the next higher odd number."
6396 (if org-odd-levels-only
6397 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6398 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6399 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6400 (max 1 (+ level change))))
6402 (defun org-promote ()
6403 "Promote the current heading higher up the tree.
6404 If the region is active in `transient-mark-mode', promote all headings
6405 in the region."
6406 (org-back-to-heading t)
6407 (let* ((level (save-match-data (funcall outline-level)))
6408 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6409 (diff (abs (- level (length up-head) -1))))
6410 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6411 (replace-match up-head nil t)
6412 ;; Fixup tag positioning
6413 (and org-auto-align-tags (org-set-tags nil t))
6414 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6416 (defun org-demote ()
6417 "Demote the current heading lower down the tree.
6418 If the region is active in `transient-mark-mode', demote all headings
6419 in the region."
6420 (org-back-to-heading t)
6421 (let* ((level (save-match-data (funcall outline-level)))
6422 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6423 (diff (abs (- level (length down-head) -1))))
6424 (replace-match down-head nil t)
6425 ;; Fixup tag positioning
6426 (and org-auto-align-tags (org-set-tags nil t))
6427 (if org-adapt-indentation (org-fixup-indentation diff))))
6429 (defun org-map-tree (fun)
6430 "Call FUN for every heading underneath the current one."
6431 (org-back-to-heading)
6432 (let ((level (funcall outline-level)))
6433 (save-excursion
6434 (funcall fun)
6435 (while (and (progn
6436 (outline-next-heading)
6437 (> (funcall outline-level) level))
6438 (not (eobp)))
6439 (funcall fun)))))
6441 (defun org-map-region (fun beg end)
6442 "Call FUN for every heading between BEG and END."
6443 (let ((org-ignore-region t))
6444 (save-excursion
6445 (setq end (copy-marker end))
6446 (goto-char beg)
6447 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6448 (< (point) end))
6449 (funcall fun))
6450 (while (and (progn
6451 (outline-next-heading)
6452 (< (point) end))
6453 (not (eobp)))
6454 (funcall fun)))))
6456 (defun org-fixup-indentation (diff)
6457 "Change the indentation in the current entry by DIFF
6458 However, if any line in the current entry has no indentation, or if it
6459 would end up with no indentation after the change, nothing at all is done."
6460 (save-excursion
6461 (let ((end (save-excursion (outline-next-heading)
6462 (point-marker)))
6463 (prohibit (if (> diff 0)
6466 col)
6467 (unless (save-excursion (end-of-line 1)
6468 (re-search-forward prohibit end t))
6469 (while (and (< (point) end)
6471 (goto-char (match-end 0))
6472 (setq col (current-column))
6473 (if (< diff 0) (replace-match ""))
6474 (indent-to (+ diff col))))
6475 (move-marker end nil))))
6477 (defun org-convert-to-odd-levels ()
6478 "Convert an org-mode file with all levels allowed to one with odd levels.
6479 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6480 level 5 etc."
6481 (interactive)
6482 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6483 (let ((org-odd-levels-only nil) n)
6484 (save-excursion
6485 (goto-char (point-min))
6487 (setq n (- (length (match-string 0)) 2))
6488 (while (>= (setq n (1- n)) 0)
6489 (org-demote))
6490 (end-of-line 1))))))
6493 (defun org-convert-to-oddeven-levels ()
6494 "Convert an org-mode file with only odd levels to one with odd and even levels.
6495 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6496 section with an even level, conversion would destroy the structure of the file. An error
6497 is signaled in this case."
6498 (interactive)
6499 (goto-char (point-min))
6500 ;; First check if there are no even levels
6502 (org-show-context t)
6503 (error "Not all levels are odd in this file. Conversion not possible."))
6504 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6505 (let ((org-odd-levels-only nil) n)
6506 (save-excursion
6507 (goto-char (point-min))
6509 (setq n (/ (1- (length (match-string 0))) 2))
6510 (while (>= (setq n (1- n)) 0)
6511 (org-promote))
6512 (end-of-line 1))))))
6514 (defun org-tr-level (n)
6515 "Make N odd if required."
6516 (if org-odd-levels-only (1+ (/ n 2)) n))
6518 ;;; Vertical tree motion, cutting and pasting of subtrees
6520 (defun org-move-subtree-up (&optional arg)
6521 "Move the current subtree up past ARG headlines of the same level."
6522 (interactive "p")
6523 (org-move-subtree-down (- (prefix-numeric-value arg))))
6525 (defun org-move-subtree-down (&optional arg)
6526 "Move the current subtree down past ARG headlines of the same level."
6527 (interactive "p")
6528 (setq arg (prefix-numeric-value arg))
6529 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6530 'outline-get-last-sibling))
6531 (ins-point (make-marker))
6532 (cnt (abs arg))
6533 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6534 ;; Select the tree
6535 (org-back-to-heading)
6536 (setq beg0 (point))
6537 (save-excursion
6538 (setq ne-beg (org-back-over-empty-lines))
6539 (setq beg (point)))
6540 (save-match-data
6541 (save-excursion (outline-end-of-heading)
6542 (setq folded (org-invisible-p)))
6543 (outline-end-of-subtree))
6544 (outline-next-heading)
6545 (setq ne-end (org-back-over-empty-lines))
6546 (setq end (point))
6547 (goto-char beg0)
6548 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6549 ;; include less whitespace
6550 (save-excursion
6551 (goto-char beg)
6552 (forward-line (- ne-beg ne-end))
6553 (setq beg (point))))
6554 ;; Find insertion point, with error handling
6555 (while (> cnt 0)
6556 (or (and (funcall movfunc) (looking-at outline-regexp))
6557 (progn (goto-char beg0)
6558 (error "Cannot move past superior level or buffer limit")))
6559 (setq cnt (1- cnt)))
6560 (if (> arg 0)
6561 ;; Moving forward - still need to move over subtree
6562 (progn (org-end-of-subtree t t)
6563 (save-excursion
6564 (org-back-over-empty-lines)
6565 (or (bolp) (newline)))))
6566 (setq ne-ins (org-back-over-empty-lines))
6567 (move-marker ins-point (point))
6568 (setq txt (buffer-substring beg end))
6569 (delete-region beg end)
6570 (outline-flag-region (1- beg) beg nil)
6571 (outline-flag-region (1- (point)) (point) nil)
6572 (insert txt)
6574 (setq ins-end (point))
6575 (goto-char ins-point)
6576 (org-skip-whitespace)
6577 (when (and (< arg 0)
6578 (org-first-sibling-p)
6579 (> ne-ins ne-beg))
6580 ;; Move whitespace back to beginning
6581 (save-excursion
6582 (goto-char ins-end)
6583 (let ((kill-whole-line t))
6584 (kill-line (- ne-ins ne-beg)) (point)))
6586 (move-marker ins-point nil)
6587 (org-compact-display-after-subtree-move)
6588 (unless folded
6589 (org-show-entry)
6590 (show-children)
6591 (org-cycle-hide-drawers 'children))))
6593 (defvar org-subtree-clip ""
6594 "Clipboard for cut and paste of subtrees.
6595 This is actually only a copy of the kill, because we use the normal kill
6596 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6598 (defvar org-subtree-clip-folded nil
6599 "Was the last copied subtree folded?
6600 This is used to fold the tree back after pasting.")
6602 (defun org-cut-subtree (&optional n)
6603 "Cut the current subtree into the clipboard.
6604 With prefix arg N, cut this many sequential subtrees.
6605 This is a short-hand for marking the subtree and then cutting it."
6606 (interactive "p")
6607 (org-copy-subtree n 'cut))
6609 (defun org-copy-subtree (&optional n cut)
6610 "Cut the current subtree into the clipboard.
6611 With prefix arg N, cut this many sequential subtrees.
6612 This is a short-hand for marking the subtree and then copying it.
6613 If CUT is non-nil, actually cut the subtree."
6614 (interactive "p")
6615 (let (beg end folded (beg0 (point)))
6616 (if (interactive-p)
6617 (org-back-to-heading nil) ; take what looks like a subtree
6618 (org-back-to-heading t)) ; take what is really there
6619 (org-back-over-empty-lines)
6620 (setq beg (point))
6622 (save-match-data
6623 (save-excursion (outline-end-of-heading)
6624 (setq folded (org-invisible-p)))
6625 (condition-case nil
6626 (outline-forward-same-level (1- n))
6627 (error nil))
6628 (org-end-of-subtree t t))
6629 (org-back-over-empty-lines)
6630 (setq end (point))
6631 (goto-char beg0)
6632 (when (> end beg)
6633 (setq org-subtree-clip-folded folded)
6634 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6635 (setq org-subtree-clip (current-kill 0))
6636 (message "%s: Subtree(s) with %d characters"
6637 (if cut "Cut" "Copied")
6638 (length org-subtree-clip)))))
6640 (defun org-paste-subtree (&optional level tree)
6641 "Paste the clipboard as a subtree, with modification of headline level.
6642 The entire subtree is promoted or demoted in order to match a new headline
6643 level. By default, the new level is derived from the visible headings
6644 before and after the insertion point, and taken to be the inferior headline
6645 level of the two. So if the previous visible heading is level 3 and the
6646 next is level 4 (or vice versa), level 4 will be used for insertion.
6647 This makes sure that the subtree remains an independent subtree and does
6648 not swallow low level entries.
6650 You can also force a different level, either by using a numeric prefix
6651 argument, or by inserting the heading marker by hand. For example, if the
6656 If optional TREE is given, use this text instead of the kill ring."
6657 (interactive "P")
6658 (unless (org-kill-is-subtree-p tree)
6659 (error "%s"
6660 (substitute-command-keys
6662 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6667 (old-level (if (string-match ^re txt)
6668 (- (match-end 0) (match-beginning 0) 1)
6669 -1))
6670 (force-level (cond (level (prefix-numeric-value level))
6671 ((string-match
6672 ^re_ (buffer-substring (point-at-bol) (point)))
6673 (- (match-end 1) (match-beginning 1)))
6674 (t nil)))
6675 (previous-level (save-excursion
6676 (condition-case nil
6677 (progn
6678 (outline-previous-visible-heading 1)
6679 (if (looking-at re)
6680 (- (match-end 0) (match-beginning 0) 1)
6681 1))
6682 (error 1))))
6683 (next-level (save-excursion
6684 (condition-case nil
6685 (progn
6686 (or (looking-at outline-regexp)
6687 (outline-next-visible-heading 1))
6688 (if (looking-at re)
6689 (- (match-end 0) (match-beginning 0) 1)
6690 1))
6691 (error 1))))
6692 (new-level (or force-level (max previous-level next-level)))
6693 (shift (if (or (= old-level -1)
6694 (= new-level -1)
6695 (= old-level new-level))
6696 0
6697 (- new-level old-level)))
6698 (delta (if (> shift 0) -1 1))
6699 (func (if (> shift 0) 'org-demote 'org-promote))
6700 (org-odd-levels-only nil)
6701 beg end)
6702 ;; Remove the forced level indicator
6703 (if force-level
6704 (delete-region (point-at-bol) (point)))
6705 ;; Paste
6706 (beginning-of-line 1)
6707 (org-back-over-empty-lines) ;; FIXME: correct fix????
6708 (setq beg (point))
6709 (insert-before-markers txt) ;; FIXME: correct fix????
6711 (setq end (point))
6712 (goto-char beg)
6714 (setq beg (point))
6715 ;; Shift if necessary
6716 (unless (= shift 0)
6717 (save-restriction
6718 (narrow-to-region beg end)
6719 (while (not (= shift 0))
6720 (org-map-region func (point-min) (point-max))
6721 (setq shift (+ delta shift)))
6722 (goto-char (point-min))))
6723 (when (interactive-p)
6724 (message "Clipboard pasted as level %d subtree" new-level))
6725 (if (and kill-ring
6726 (eq org-subtree-clip (current-kill 0))
6727 org-subtree-clip-folded)
6728 ;; The tree was folded before it was killed/copied
6729 (hide-subtree))))
6731 (defun org-kill-is-subtree-p (&optional txt)
6732 "Check if the current kill is an outline subtree, or a set of trees.
6733 Returns nil if kill does not start with a headline, or if the first
6734 headline level is not the largest headline level in the tree.
6735 So this will actually accept several entries of equal levels as well,
6736 which is OK for `org-paste-subtree'.
6737 If optional TXT is given, check this string instead of the current kill."
6738 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6739 (start-level (and kill
6742 kill)
6743 (- (match-end 2) (match-beginning 2) 1)))
6744 (re (concat "^" org-outline-regexp))
6745 (start (1+ (match-beginning 2))))
6746 (if (not start-level)
6747 (progn
6748 nil) ;; does not even start with a heading
6749 (catch 'exit
6750 (while (setq start (string-match re kill (1+ start)))
6751 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6752 (throw 'exit nil)))
6753 t))))
6755 (defun org-narrow-to-subtree ()
6756 "Narrow buffer to the current subtree."
6757 (interactive)
6758 (save-excursion
6759 (save-match-data
6760 (narrow-to-region
6761 (progn (org-back-to-heading) (point))
6762 (progn (org-end-of-subtree t t) (point))))))
6765 ;;; Outline Sorting
6767 (defun org-sort (with-case)
6768 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6769 Optional argument WITH-CASE means sort case-sensitively."
6770 (interactive "P")
6771 (if (org-at-table-p)
6772 (org-call-with-arg 'org-table-sort-lines with-case)
6773 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6775 (defvar org-priority-regexp) ; defined later in the file
6777 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6778 "Sort entries on a certain level of an outline tree.
6779 If there is an active region, the entries in the region are sorted.
6780 Else, if the cursor is before the first entry, sort the top-level items.
6781 Else, the children of the entry at point are sorted.
6783 Sorting can be alphabetically, numerically, and by date/time as given by
6784 the first time stamp in the entry. The command prompts for the sorting
6785 type unless it has been given to the function through the SORTING-TYPE
6786 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6787 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6788 called with point at the beginning of the record. It must return either
6789 a string or a number that should serve as the sorting key for that record.
6791 Comparing entries ignores case by default. However, with an optional argument
6792 WITH-CASE, the sorting considers case as well."
6793 (interactive "P")
6794 (let ((case-func (if with-case 'identity 'downcase))
6795 start beg end stars re re2
6796 txt what tmp plain-list-p)
6797 ;; Find beginning and end of region to sort
6798 (cond
6799 ((org-region-active-p)
6800 ;; we will sort the region
6801 (setq end (region-end)
6802 what "region")
6803 (goto-char (region-beginning))
6804 (if (not (org-on-heading-p)) (outline-next-heading))
6805 (setq start (point)))
6806 ((org-at-item-p)
6807 ;; we will sort this plain list
6808 (org-beginning-of-item-list) (setq start (point))
6809 (org-end-of-item-list) (setq end (point))
6810 (goto-char start)
6811 (setq plain-list-p t
6812 what "plain list"))
6813 ((or (org-on-heading-p)
6814 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6815 ;; we will sort the children of the current headline
6816 (org-back-to-heading)
6817 (setq start (point)
6818 end (progn (org-end-of-subtree t t)
6819 (org-back-over-empty-lines)
6820 (point))
6821 what "children")
6822 (goto-char start)
6823 (show-subtree)
6824 (outline-next-heading))
6825 (t
6826 ;; we will sort the top-level entries in this file
6827 (goto-char (point-min))
6828 (or (org-on-heading-p) (outline-next-heading))
6829 (setq start (point) end (point-max) what "top-level")
6830 (goto-char start)
6831 (show-all)))
6833 (setq beg (point))
6834 (if (>= beg end) (error "Nothing to sort"))
6836 (unless plain-list-p
6838 (setq stars (match-string 1)
6839 re (concat "^" (regexp-quote stars) " +")
6840 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6841 txt (buffer-substring beg end))
6843 (if (and (not (equal stars "*")) (string-match re2 txt))
6844 (error "Region to sort contains a level above the first entry")))
6846 (unless sorting-type
6847 (message
6848 (if plain-list-p
6849 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6850 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6851 what)
6852 (setq sorting-type (read-char-exclusive))
6854 (and (= (downcase sorting-type) ?f)
6855 (setq getkey-func
6856 (completing-read "Sort using function: "
6857 obarray 'fboundp t nil nil))
6858 (setq getkey-func (intern getkey-func)))
6860 (and (= (downcase sorting-type) ?r)
6861 (setq property
6862 (completing-read "Property: "
6863 (mapcar 'list (org-buffer-property-keys t))
6864 nil t))))
6866 (message "Sorting entries...")
6868 (save-restriction
6869 (narrow-to-region start end)
6871 (let ((dcst (downcase sorting-type))
6872 (now (current-time)))
6873 (sort-subr
6874 (/= dcst sorting-type)
6875 ;; This function moves to the beginning character of the "record" to
6876 ;; be sorted.
6877 (if plain-list-p
6878 (lambda nil
6879 (if (org-at-item-p) t (goto-char (point-max))))
6880 (lambda nil
6881 (if (re-search-forward re nil t)
6882 (goto-char (match-beginning 0))
6883 (goto-char (point-max)))))
6884 ;; This function moves to the last character of the "record" being
6885 ;; sorted.
6886 (if plain-list-p
6887 'org-end-of-item
6888 (lambda nil
6889 (save-match-data
6890 (condition-case nil
6891 (outline-forward-same-level 1)
6892 (error
6893 (goto-char (point-max)))))))
6895 ;; This function returns the value that gets sorted against.
6896 (if plain-list-p
6897 (lambda nil
6899 (cond
6900 ((= dcst ?n)
6901 (string-to-number (buffer-substring (match-end 0)
6902 (point-at-eol))))
6903 ((= dcst ?a)
6904 (buffer-substring (match-end 0) (point-at-eol)))
6905 ((= dcst ?t)
6906 (if (re-search-forward org-ts-regexp
6907 (point-at-eol) t)
6908 (org-time-string-to-time (match-string 0))
6909 now))
6910 ((= dcst ?f)
6911 (if getkey-func
6912 (progn
6913 (setq tmp (funcall getkey-func))
6914 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6915 tmp)
6916 (error "Invalid key function `%s'" getkey-func)))
6917 (t (error "Invalid sorting type `%c'" sorting-type)))))
6918 (lambda nil
6919 (cond
6920 ((= dcst ?n)
6921 (if (looking-at outline-regexp)
6922 (string-to-number (buffer-substring (match-end 0)
6923 (point-at-eol)))
6924 nil))
6925 ((= dcst ?a)
6926 (funcall case-func (buffer-substring (point-at-bol)
6927 (point-at-eol))))
6928 ((= dcst ?t)
6929 (if (re-search-forward org-ts-regexp
6930 (save-excursion
6931 (forward-line 2)
6932 (point)) t)
6933 (org-time-string-to-time (match-string 0))
6934 now))
6935 ((= dcst ?p)
6936 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6937 (string-to-char (match-string 2))
6938 org-default-priority))
6939 ((= dcst ?r)
6940 (or (org-entry-get nil property) ""))
6941 ((= dcst ?f)
6942 (if getkey-func
6943 (progn
6944 (setq tmp (funcall getkey-func))
6945 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6946 tmp)
6947 (error "Invalid key function `%s'" getkey-func)))
6948 (t (error "Invalid sorting type `%c'" sorting-type)))))
6949 nil
6950 (cond
6951 ((= dcst ?a) 'string<)
6952 ((= dcst ?t) 'time-less-p)
6953 (t nil)))))
6954 (message "Sorting entries...done")))
6956 (defun org-do-sort (table what &optional with-case sorting-type)
6957 "Sort TABLE of WHAT according to SORTING-TYPE.
6958 The user will be prompted for the SORTING-TYPE if the call to this
6959 function does not specify it. WHAT is only for the prompt, to indicate
6960 what is being sorted. The sorting key will be extracted from
6961 the car of the elements of the table.
6962 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6963 (unless sorting-type
6964 (message
6965 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6966 what)
6967 (setq sorting-type (read-char-exclusive)))
6968 (let ((dcst (downcase sorting-type))
6969 extractfun comparefun)
6970 ;; Define the appropriate functions
6971 (cond
6972 ((= dcst ?n)
6973 (setq extractfun 'string-to-number
6974 comparefun (if (= dcst sorting-type) '< '>)))
6975 ((= dcst ?a)
6976 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6977 (lambda(x) (downcase (org-sort-remove-invisible x))))
6978 comparefun (if (= dcst sorting-type)
6979 'string<
6980 (lambda (a b) (and (not (string< a b))
6981 (not (string= a b)))))))
6982 ((= dcst ?t)
6983 (setq extractfun
6984 (lambda (x)
6985 (if (string-match org-ts-regexp x)
6986 (time-to-seconds
6987 (org-time-string-to-time (match-string 0 x)))
6988 0))
6989 comparefun (if (= dcst sorting-type) '< '>)))
6990 (t (error "Invalid sorting type `%c'" sorting-type)))
6992 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6993 table)
6994 (lambda (a b) (funcall comparefun (car a) (car b))))))
6996 ;;;; Plain list items, including checkboxes
6998 ;;; Plain list items
7000 (defun org-at-item-p ()
7001 "Is point in a line starting a hand-formatted item?"
7002 (let ((llt org-plain-list-ordered-item-terminator))
7003 (save-excursion
7004 (goto-char (point-at-bol))
7005 (looking-at
7006 (cond
7010 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
7012 (defun org-in-item-p ()
7013 "It the cursor inside a plain list item.
7014 Does not have to be the first line."
7015 (save-excursion
7016 (condition-case nil
7017 (progn
7018 (org-beginning-of-item)
7019 (org-at-item-p)
7020 t)
7021 (error nil))))
7023 (defun org-insert-item (&optional checkbox)
7024 "Insert a new item at the current level.
7025 Return t when things worked, nil when we are not in an item."
7026 (when (save-excursion
7027 (condition-case nil
7028 (progn
7029 (org-beginning-of-item)
7030 (org-at-item-p)
7031 (if (org-invisible-p) (error "Invisible item"))
7032 t)
7033 (error nil)))
7034 (let* ((bul (match-string 0))
7036 (match-end 0)))
7037 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
7038 pos)
7039 (cond
7040 ((and (org-at-item-p) (<= (point) eow))
7041 ;; before the bullet
7042 (beginning-of-line 1)
7043 (open-line (if blank 2 1)))
7044 ((<= (point) eow)
7045 (beginning-of-line 1))
7046 (t
7047 (unless (org-get-alist-option org-M-RET-may-split-line 'item)
7048 (end-of-line 1)
7049 (delete-horizontal-space))
7050 (newline (if blank 2 1))))
7051 (insert bul (if checkbox "[ ]" ""))
7052 (just-one-space)
7053 (setq pos (point))
7054 (end-of-line 1)
7055 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
7056 (org-maybe-renumber-ordered-list)
7057 (and checkbox (org-update-checkbox-count-maybe))
7058 t))
7060 ;;; Checkboxes
7062 (defun org-at-item-checkbox-p ()
7063 "Is point at a line starting a plain-list item with a checklet?"
7064 (and (org-at-item-p)
7065 (save-excursion
7066 (goto-char (match-end 0))
7070 (defun org-toggle-checkbox (&optional arg)
7071 "Toggle the checkbox in the current line."
7072 (interactive "P")
7073 (catch 'exit
7074 (let (beg end status (firstnew 'unknown))
7075 (cond
7076 ((org-region-active-p)
7077 (setq beg (region-beginning) end (region-end)))
7078 ((org-on-heading-p)
7079 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7080 ((org-at-item-checkbox-p)
7081 (let ((pos (point)))
7082 (replace-match
7083 (cond (arg "[-]")
7084 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7085 (t "[ ]"))
7086 t t)
7087 (goto-char pos))
7088 (throw 'exit t))
7089 (t (error "Not at a checkbox or heading, and no active region")))
7090 (save-excursion
7091 (goto-char beg)
7092 (while (< (point) end)
7093 (when (org-at-item-checkbox-p)
7094 (setq status (equal (match-string 0) "[X]"))
7095 (when (eq firstnew 'unknown)
7096 (setq firstnew (not status)))
7097 (replace-match
7098 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7099 (beginning-of-line 2)))))
7100 (org-update-checkbox-count-maybe))
7102 (defun org-update-checkbox-count-maybe ()
7103 "Update checkbox statistics unless turned off by user."
7104 (when org-provide-checkbox-statistics
7105 (org-update-checkbox-count)))
7107 (defun org-update-checkbox-count (&optional all)
7108 "Update the checkbox statistics in the current section.
7109 This will find all statistic cookies like [57%] and [6/12] and update them
7110 with the current numbers. With optional prefix argument ALL, do this for
7111 the whole buffer."
7112 (interactive "P")
7113 (save-excursion
7114 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7115 (beg (condition-case nil
7116 (progn (outline-back-to-heading) (point))
7117 (error (point-min))))
7118 (end (move-marker (make-marker)
7119 (progn (outline-next-heading) (point))))
7123 beg-cookie end-cookie is-percent c-on c-off lim
7124 eline curr-ind next-ind continue-from startsearch
7125 (cstat 0)
7126 )
7127 (when all
7128 (goto-char (point-min))
7129 (outline-next-heading)
7130 (setq beg (point) end (point-max)))
7131 (goto-char end)
7132 ;; find each statistic cookie
7133 (while (re-search-backward re-find beg t)
7134 (setq beg-cookie (match-beginning 1)
7135 end-cookie (match-end 1)
7136 cstat (+ cstat (if end-cookie 1 0))
7137 startsearch (point-at-eol)
7138 continue-from (point-at-bol)
7139 is-percent (match-beginning 2)
7140 lim (cond
7141 ((org-on-heading-p) (outline-next-heading) (point))
7142 ((org-at-item-p) (org-end-of-item) (point))
7143 (t nil))
7144 c-on 0
7145 c-off 0)
7146 (when lim
7147 ;; find first checkbox for this cookie and gather
7148 ;; statistics from all that are at this indentation level
7149 (goto-char startsearch)
7150 (if (re-search-forward re-box lim t)
7151 (progn
7152 (org-beginning-of-item)
7153 (setq curr-ind (org-get-indentation))
7154 (setq next-ind curr-ind)
7155 (while (= curr-ind next-ind)
7156 (save-excursion (end-of-line) (setq eline (point)))
7157 (if (re-search-forward re-box eline t)
7158 (if (member (match-string 2) '("[ ]" "[-]"))
7159 (setq c-off (1+ c-off))
7160 (setq c-on (1+ c-on))
7161 )
7162 )
7163 (org-end-of-item)
7164 (setq next-ind (org-get-indentation))
7165 )))
7166 (goto-char continue-from)
7167 ;; update cookie
7168 (when end-cookie
7169 (delete-region beg-cookie end-cookie)
7170 (goto-char beg-cookie)
7171 (insert
7172 (if is-percent
7173 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7174 (format "[%d/%d]" c-on (+ c-on c-off)))))
7175 ;; update items checkbox if it has one
7176 (when (org-at-item-p)
7177 (org-beginning-of-item)
7178 (when (and (> (+ c-on c-off) 0)
7179 (re-search-forward re-box (point-at-eol) t))
7180 (setq beg-cookie (match-beginning 2)
7181 end-cookie (match-end 2))
7182 (delete-region beg-cookie end-cookie)
7183 (goto-char beg-cookie)
7184 (cond ((= c-off 0) (insert "[X]"))
7185 ((= c-on 0) (insert "[ ]"))
7186 (t (insert "[-]")))
7187 )))
7188 (goto-char continue-from))
7189 (when (interactive-p)
7190 (message "Checkbox satistics updated %s (%d places)"
7191 (if all "in entire file" "in current outline entry") cstat)))))
7193 (defun org-get-checkbox-statistics-face ()
7194 "Select the face for checkbox statistics.
7195 The face will be `org-done' when all relevant boxes are checked. Otherwise
7196 it will be `org-todo'."
7197 (if (match-end 1)
7198 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7199 (if (and (> (match-end 2) (match-beginning 2))
7200 (equal (match-string 2) (match-string 3)))
7201 'org-done
7202 'org-todo)))
7204 (defun org-get-indentation (&optional line)
7205 "Get the indentation of the current line, interpreting tabs.
7206 When LINE is given, assume it represents a line and compute its indentation."
7207 (if line
7208 (if (string-match "^ *" (org-remove-tabs line))
7209 (match-end 0))
7210 (save-excursion
7211 (beginning-of-line 1)
7213 (current-column))))
7215 (defun org-remove-tabs (s &optional width)
7216 "Replace tabulators in S with spaces.
7217 Assumes that s is a single line, starting in column 0."
7218 (setq width (or width tab-width))
7220 (setq s (replace-match
7221 (make-string
7222 (- (* width (/ (+ (match-beginning 0) width) width))
7223 (match-beginning 0)) ?\ )
7224 t t s)))
7225 s)
7227 (defun org-fix-indentation (line ind)
7228 "Fix indentation in LINE.
7229 IND is a cons cell with target and minimum indentation.
7230 If the current indenation in LINE is smaller than the minimum,
7231 leave it alone. If it is larger than ind, set it to the target."
7232 (let* ((l (org-remove-tabs line))
7233 (i (org-get-indentation l))
7234 (i1 (car ind)) (i2 (cdr ind)))
7235 (if (>= i i2) (setq l (substring line i2)))
7236 (if (> i1 0)
7237 (concat (make-string i1 ?\ ) l)
7238 l)))
7240 (defcustom org-empty-line-terminates-plain-lists nil
7241 "Non-nil means, an empty line ends all plain list levels.
7242 When nil, empty lines are part of the preceeding item."
7243 :group 'org-plain-lists
7244 :type 'boolean)
7246 (defun org-beginning-of-item ()
7247 "Go to the beginning of the current hand-formatted item.
7248 If the cursor is not in an item, throw an error."
7249 (interactive)
7250 (let ((pos (point))
7251 (limit (save-excursion
7252 (condition-case nil
7253 (progn
7254 (org-back-to-heading)
7255 (beginning-of-line 2) (point))
7256 (error (point-min)))))
7257 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7258 ind ind1)
7259 (if (org-at-item-p)
7260 (beginning-of-line 1)
7261 (beginning-of-line 1)
7263 (setq ind (current-column))
7264 (if (catch 'exit
7265 (while t
7266 (beginning-of-line 0)
7267 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7270 (setq ind1 ind-empty)
7272 (setq ind1 (current-column)))
7273 (if (< ind1 ind)
7274 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7275 nil
7276 (goto-char pos)
7277 (error "Not in an item")))))
7279 (defun org-end-of-item ()
7280 "Go to the end of the current hand-formatted item.
7281 If the cursor is not in an item, throw an error."
7282 (interactive)
7283 (let* ((pos (point))
7284 ind1
7285 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7286 (limit (save-excursion (outline-next-heading) (point)))
7287 (ind (save-excursion
7288 (org-beginning-of-item)
7290 (current-column)))
7291 (end (catch 'exit
7292 (while t
7293 (beginning-of-line 2)
7294 (if (eobp) (throw 'exit (point)))
7295 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7297 (setq ind1 ind-empty)
7299 (setq ind1 (current-column)))
7300 (if (<= ind1 ind)
7301 (throw 'exit (point-at-bol)))))))
7302 (if end
7303 (goto-char end)
7304 (goto-char pos)
7305 (error "Not in an item"))))
7307 (defun org-next-item ()
7308 "Move to the beginning of the next item in the current plain list.
7309 Error if not at a plain list, or if this is the last item in the list."
7310 (interactive)
7311 (let (ind ind1 (pos (point)))
7312 (org-beginning-of-item)
7313 (setq ind (org-get-indentation))
7314 (org-end-of-item)
7315 (setq ind1 (org-get-indentation))
7316 (unless (and (org-at-item-p) (= ind ind1))
7317 (goto-char pos)
7318 (error "On last item"))))
7320 (defun org-previous-item ()
7321 "Move to the beginning of the previous item in the current plain list.
7322 Error if not at a plain list, or if this is the first item in the list."
7323 (interactive)
7324 (let (beg ind ind1 (pos (point)))
7325 (org-beginning-of-item)
7326 (setq beg (point))
7327 (setq ind (org-get-indentation))
7328 (goto-char beg)
7329 (catch 'exit
7330 (while t
7331 (beginning-of-line 0)
7333 nil
7334 (if (<= (setq ind1 (org-get-indentation)) ind)
7335 (throw 'exit t)))))
7336 (condition-case nil
7337 (if (or (not (org-at-item-p))
7338 (< ind1 (1- ind)))
7339 (error "")
7340 (org-beginning-of-item))
7341 (error (goto-char pos)
7342 (error "On first item")))))
7344 (defun org-first-list-item-p ()
7345 "Is this heading the item in a plain list?"
7346 (unless (org-at-item-p)
7347 (error "Not at a plain list item"))
7348 (org-beginning-of-item)
7349 (= (point) (save-excursion (org-beginning-of-item-list))))
7351 (defun org-move-item-down ()
7352 "Move the plain list item at point down, i.e. swap with following item.
7353 Subitems (items with larger indentation) are considered part of the item,
7354 so this really moves item trees."
7355 (interactive)
7356 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7357 (org-beginning-of-item)
7358 (setq beg0 (point))
7359 (save-excursion
7360 (setq ne-beg (org-back-over-empty-lines))
7361 (setq beg (point)))
7362 (goto-char beg0)
7363 (setq ind (org-get-indentation))
7364 (org-end-of-item)
7365 (setq end0 (point))
7366 (setq ind1 (org-get-indentation))
7367 (setq ne-end (org-back-over-empty-lines))
7368 (setq end (point))
7369 (goto-char beg0)
7370 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7371 ;; include less whitespace
7372 (save-excursion
7373 (goto-char beg)
7374 (forward-line (- ne-beg ne-end))
7375 (setq beg (point))))
7376 (goto-char end0)
7377 (if (and (org-at-item-p) (= ind ind1))
7378 (progn
7379 (org-end-of-item)
7380 (org-back-over-empty-lines)
7381 (setq txt (buffer-substring beg end))
7382 (save-excursion
7383 (delete-region beg end))
7384 (setq pos (point))
7385 (insert txt)
7386 (goto-char pos) (org-skip-whitespace)
7387 (org-maybe-renumber-ordered-list))
7388 (goto-char pos)
7389 (error "Cannot move this item further down"))))
7391 (defun org-move-item-up (arg)
7392 "Move the plain list item at point up, i.e. swap with previous item.
7393 Subitems (items with larger indentation) are considered part of the item,
7394 so this really moves item trees."
7395 (interactive "p")
7396 (let (beg beg0 end ind ind1 (pos (point)) txt
7397 ne-beg ne-ins ins-end)
7398 (org-beginning-of-item)
7399 (setq beg0 (point))
7400 (setq ind (org-get-indentation))
7401 (save-excursion
7402 (setq ne-beg (org-back-over-empty-lines))
7403 (setq beg (point)))
7404 (goto-char beg0)
7405 (org-end-of-item)
7406 (setq end (point))
7407 (goto-char beg0)
7408 (catch 'exit
7409 (while t
7410 (beginning-of-line 0)
7412 (if org-empty-line-terminates-plain-lists
7413 (progn
7414 (goto-char pos)
7415 (error "Cannot move this item further up"))
7416 nil)
7417 (if (<= (setq ind1 (org-get-indentation)) ind)
7418 (throw 'exit t)))))
7419 (condition-case nil
7420 (org-beginning-of-item)
7421 (error (goto-char beg)
7422 (error "Cannot move this item further up")))
7423 (setq ind1 (org-get-indentation))
7424 (if (and (org-at-item-p) (= ind ind1))
7425 (progn
7426 (setq ne-ins (org-back-over-empty-lines))
7427 (setq txt (buffer-substring beg end))
7428 (save-excursion
7429 (delete-region beg end))
7430 (setq pos (point))
7431 (insert txt)
7432 (setq ins-end (point))
7433 (goto-char pos) (org-skip-whitespace)
7435 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7436 ;; Move whitespace back to beginning
7437 (save-excursion
7438 (goto-char ins-end)
7439 (let ((kill-whole-line t))
7440 (kill-line (- ne-ins ne-beg)) (point)))
7443 (org-maybe-renumber-ordered-list))
7444 (goto-char pos)
7445 (error "Cannot move this item further up"))))
7447 (defun org-maybe-renumber-ordered-list ()
7448 "Renumber the ordered list at point if setup allows it.
7449 This tests the user option `org-auto-renumber-ordered-lists' before
7450 doing the renumbering."
7451 (interactive)
7452 (when (and org-auto-renumber-ordered-lists
7453 (org-at-item-p))
7454 (if (match-beginning 3)
7455 (org-renumber-ordered-list 1)
7456 (org-fix-bullet-type))))
7458 (defun org-maybe-renumber-ordered-list-safe ()
7459 (condition-case nil
7460 (save-excursion
7461 (org-maybe-renumber-ordered-list))
7462 (error nil)))
7464 (defun org-cycle-list-bullet (&optional which)
7465 "Cycle through the different itemize/enumerate bullets.
7466 This cycle the entire list level through the sequence:
7468 `-' -> `+' -> `*' -> `1.' -> `1)'
7470 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7471 0 meand `-', 1 means `+' etc."
7472 (interactive "P")
7473 (org-preserve-lc
7474 (org-beginning-of-item-list)
7475 (org-at-item-p)
7476 (beginning-of-line 1)
7477 (let ((current (match-string 0))
7478 (prevp (eq which 'previous))
7479 new)
7480 (setq new (cond
7481 ((and (numberp which)
7482 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7483 ((string-match "-" current) (if prevp "1)" "+"))
7488 ((string-match ")" current) (if prevp "1." "-"))
7489 (t (error "This should not happen"))))
7491 (org-fix-bullet-type)
7492 (org-maybe-renumber-ordered-list))))
7494 (defun org-get-string-indentation (s)
7495 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7496 (let ((n -1) (i 0) (w tab-width) c)
7497 (catch 'exit
7498 (while (< (setq n (1+ n)) (length s))
7499 (setq c (aref s n))
7500 (cond ((= c ?\ ) (setq i (1+ i)))
7502 (t (throw 'exit t)))))
7503 i))
7505 (defun org-renumber-ordered-list (arg)
7506 "Renumber an ordered plain list.
7507 Cursor needs to be in the first line of an item, the line that starts
7509 (interactive "p")
7510 (unless (and (org-at-item-p)
7511 (match-beginning 3))
7512 (error "This is not an ordered list"))
7513 (let ((line (org-current-line))
7514 (col (current-column))
7515 (ind (org-get-string-indentation
7516 (buffer-substring (point-at-bol) (match-beginning 3))))
7517 ;; (term (substring (match-string 3) -1))
7518 ind1 (n (1- arg))
7519 fmt)
7520 ;; find where this list begins
7521 (org-beginning-of-item-list)
7523 (setq fmt (concat "%d" (match-string 1)))
7524 (beginning-of-line 0)
7525 ;; walk forward and replace these numbers
7526 (catch 'exit
7527 (while t
7528 (catch 'next
7529 (beginning-of-line 2)
7530 (if (eobp) (throw 'exit nil))
7533 (if (> ind1 ind) (throw 'next t))
7534 (if (< ind1 ind) (throw 'exit t))
7535 (if (not (org-at-item-p)) (throw 'exit nil))
7536 (delete-region (match-beginning 2) (match-end 2))
7537 (goto-char (match-beginning 2))
7538 (insert (format fmt (setq n (1+ n)))))))
7539 (goto-line line)
7540 (move-to-column col)))
7542 (defun org-fix-bullet-type ()
7543 "Make sure all items in this list have the same bullet as the firsst item."
7544 (interactive)
7545 (unless (org-at-item-p) (error "This is not a list"))
7546 (let ((line (org-current-line))
7547 (col (current-column))
7548 (ind (current-indentation))
7549 ind1 bullet)
7550 ;; find where this list begins
7551 (org-beginning-of-item-list)
7552 (beginning-of-line 1)
7553 ;; find out what the bullet type is
7555 (setq bullet (match-string 1))
7556 ;; walk forward and replace these numbers
7557 (beginning-of-line 0)
7558 (catch 'exit
7559 (while t
7560 (catch 'next
7561 (beginning-of-line 2)
7562 (if (eobp) (throw 'exit nil))
7565 (if (> ind1 ind) (throw 'next t))
7566 (if (< ind1 ind) (throw 'exit t))
7567 (if (not (org-at-item-p)) (throw 'exit nil))
7570 (replace-match bullet))))
7571 (goto-line line)
7572 (move-to-column col)
7573 (if (string-match "[0-9]" bullet)
7574 (org-renumber-ordered-list 1))))
7576 (defun org-beginning-of-item-list ()
7577 "Go to the beginning of the current item list.
7578 I.e. to the first item in this list."
7579 (interactive)
7580 (org-beginning-of-item)
7581 (let ((pos (point-at-bol))
7582 (ind (org-get-indentation))
7583 ind1)
7584 ;; find where this list begins
7585 (catch 'exit
7586 (while t
7587 (catch 'next
7588 (beginning-of-line 0)
7590 (throw (if (bobp) 'exit 'next) t))
7592 (if (or (< ind1 ind)
7593 (and (= ind1 ind)
7594 (not (org-at-item-p)))
7595 (bobp))
7596 (throw 'exit t)
7597 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7598 (goto-char pos)))
7601 (defun org-end-of-item-list ()
7602 "Go to the end of the current item list.
7603 I.e. to the text after the last item."
7604 (interactive)
7605 (org-beginning-of-item)
7606 (let ((pos (point-at-bol))
7607 (ind (org-get-indentation))
7608 ind1)
7609 ;; find where this list begins
7610 (catch 'exit
7611 (while t
7612 (catch 'next
7613 (beginning-of-line 2)
7615 (throw (if (eobp) 'exit 'next) t))
7617 (if (or (< ind1 ind)
7618 (and (= ind1 ind)
7619 (not (org-at-item-p)))
7620 (eobp))
7621 (progn
7622 (setq pos (point-at-bol))
7623 (throw 'exit t))))))
7624 (goto-char pos)))
7627 (defvar org-last-indent-begin-marker (make-marker))
7628 (defvar org-last-indent-end-marker (make-marker))
7630 (defun org-outdent-item (arg)
7631 "Outdent a local list item."
7632 (interactive "p")
7633 (org-indent-item (- arg)))
7635 (defun org-indent-item (arg)
7636 "Indent a local list item."
7637 (interactive "p")
7638 (unless (org-at-item-p)
7639 (error "Not on an item"))
7640 (save-excursion
7641 (let (beg end ind ind1 tmp delta ind-down ind-up)
7642 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7643 (setq beg org-last-indent-begin-marker
7644 end org-last-indent-end-marker)
7645 (org-beginning-of-item)
7646 (setq beg (move-marker org-last-indent-begin-marker (point)))
7647 (org-end-of-item)
7648 (setq end (move-marker org-last-indent-end-marker (point))))
7649 (goto-char beg)
7650 (setq tmp (org-item-indent-positions)
7651 ind (car tmp)
7652 ind-down (nth 2 tmp)
7653 ind-up (nth 1 tmp)
7654 delta (if (> arg 0)
7655 (if ind-down (- ind-down ind) 2)
7656 (if ind-up (- ind-up ind) -2)))
7657 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7658 (while (< (point) end)
7659 (beginning-of-line 1)
7661 (delete-region (point-at-bol) (point))
7662 (or (eolp) (indent-to-column (+ ind1 delta)))
7663 (beginning-of-line 2))))
7664 (org-fix-bullet-type)
7665 (org-maybe-renumber-ordered-list-safe)
7666 (save-excursion
7667 (beginning-of-line 0)
7668 (condition-case nil (org-beginning-of-item) (error nil))
7669 (org-maybe-renumber-ordered-list-safe)))
7671 (defun org-item-indent-positions ()
7672 "Return indentation for plain list items.
7673 This returns a list with three values: The current indentation, the
7674 parent indentation and the indentation a child should habe.
7675 Assumes cursor in item line."
7676 (let* ((bolpos (point-at-bol))
7677 (ind (org-get-indentation))
7678 ind-down ind-up pos)
7679 (save-excursion
7680 (org-beginning-of-item-list)
7682 (when (org-in-item-p)
7683 (org-beginning-of-item)
7684 (setq ind-up (org-get-indentation))))
7685 (setq pos (point))
7686 (save-excursion
7687 (cond
7688 ((and (condition-case nil (progn (org-previous-item) t)
7689 (error nil))
7690 (or (forward-char 1) t)
7691 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7692 (setq ind-down (org-get-indentation)))
7693 ((and (goto-char pos)
7694 (org-at-item-p))
7695 (goto-char (match-end 0))
7697 (setq ind-down (current-column)))))
7698 (list ind ind-up ind-down)))
7700 ;;; The orgstruct minor mode
7702 ;; Define a minor mode which can be used in other modes in order to
7703 ;; integrate the org-mode structure editing commands.
7705 ;; This is really a hack, because the org-mode structure commands use
7706 ;; keys which normally belong to the major mode. Here is how it
7707 ;; works: The minor mode defines all the keys necessary to operate the
7708 ;; structure commands, but wraps the commands into a function which
7709 ;; tests if the cursor is currently at a headline or a plain list
7710 ;; item. If that is the case, the structure command is used,
7711 ;; temporarily setting many Org-mode variables like regular
7712 ;; expressions for filling etc. However, when any of those keys is
7713 ;; used at a different location, function uses `key-binding' to look
7714 ;; up if the key has an associated command in another currently active
7715 ;; keymap (minor modes, major mode, global), and executes that
7716 ;; command. There might be problems if any of the keys is otherwise
7717 ;; used as a prefix key.
7719 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7720 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7721 ;; addresses this by checking explicitly for both bindings.
7723 (defvar orgstruct-mode-map (make-sparse-keymap)
7724 "Keymap for the minor `orgstruct-mode'.")
7726 (defvar org-local-vars nil
7727 "List of local variables, for use by `orgstruct-mode'")
7729 ;;;###autoload
7730 (define-minor-mode orgstruct-mode
7731 "Toggle the minor more `orgstruct-mode'.
7732 This mode is for using Org-mode structure commands in other modes.
7733 The following key behave as if Org-mode was active, if the cursor
7734 is on a headline, or on a plain list item (both in the definition
7735 of Org-mode).
7737 M-up Move entry/item up
7738 M-down Move entry/item down
7739 M-left Promote
7740 M-right Demote
7741 M-S-up Move entry/item up
7742 M-S-down Move entry/item down
7743 M-S-left Promote subtree
7744 M-S-right Demote subtree
7745 M-q Fill paragraph and items like in Org-mode
7746 C-c ^ Sort entries
7747 C-c - Cycle list bullet
7748 TAB Cycle item visibility
7749 M-RET Insert new heading/item
7750 S-M-RET Insert new TODO heading / Chekbox item
7751 C-c C-c Set tags / toggle checkbox"
7752 nil " OrgStruct" nil
7753 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7755 ;;;###autoload
7756 (defun turn-on-orgstruct ()
7757 "Unconditionally turn on `orgstruct-mode'."
7758 (orgstruct-mode 1))
7760 ;;;###autoload
7761 (defun turn-on-orgstruct++ ()
7762 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7763 In addition to setting orgstruct-mode, this also exports all indentation and
7764 autofilling variables from org-mode into the buffer. Note that turning
7765 off orgstruct-mode will *not* remove these additional settings."
7766 (orgstruct-mode 1)
7767 (let (var val)
7768 (mapc
7769 (lambda (x)
7770 (when (string-match
7772 (symbol-name (car x)))
7773 (setq var (car x) val (nth 1 x))
7774 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7775 org-local-vars)))
7777 (defun orgstruct-error ()
7778 "Error when there is no default binding for a structure key."
7779 (interactive)
7780 (error "This key has no function outside structure elements"))
7782 (defun orgstruct-setup ()
7783 "Setup orgstruct keymaps."
7784 (let ((nfunc 0)
7785 (bindings
7786 (list
7787 '([(meta up)] org-metaup)
7788 '([(meta down)] org-metadown)
7789 '([(meta left)] org-metaleft)
7790 '([(meta right)] org-metaright)
7791 '([(meta shift up)] org-shiftmetaup)
7792 '([(meta shift down)] org-shiftmetadown)
7793 '([(meta shift left)] org-shiftmetaleft)
7794 '([(meta shift right)] org-shiftmetaright)
7795 '([(shift up)] org-shiftup)
7796 '([(shift down)] org-shiftdown)
7797 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7798 '("\M-q" fill-paragraph)
7799 '("\C-c^" org-sort)
7800 '("\C-c-" org-cycle-list-bullet)))
7801 elt key fun cmd)
7802 (while (setq elt (pop bindings))
7803 (setq nfunc (1+ nfunc))
7804 (setq key (org-key (car elt))
7805 fun (nth 1 elt)
7806 cmd (orgstruct-make-binding fun nfunc key))
7807 (org-defkey orgstruct-mode-map key cmd))
7809 ;; Special treatment needed for TAB and RET
7810 (org-defkey orgstruct-mode-map [(tab)]
7811 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7812 (org-defkey orgstruct-mode-map "\C-i"
7813 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7815 (org-defkey orgstruct-mode-map "\M-\C-m"
7816 (orgstruct-make-binding 'org-insert-heading 105
7817 "\M-\C-m" [(meta return)]))
7818 (org-defkey orgstruct-mode-map [(meta return)]
7819 (orgstruct-make-binding 'org-insert-heading 106
7820 [(meta return)] "\M-\C-m"))
7822 (org-defkey orgstruct-mode-map [(shift meta return)]
7823 (orgstruct-make-binding 'org-insert-todo-heading 107
7824 [(meta return)] "\M-\C-m"))
7826 (unless org-local-vars
7827 (setq org-local-vars (org-get-local-variables)))
7829 t))
7831 (defun orgstruct-make-binding (fun n &rest keys)
7832 "Create a function for binding in the structure minor mode.
7833 FUN is the command to call inside a table. N is used to create a unique
7834 command name. KEYS are keys that should be checked in for a command
7835 to execute outside of tables."
7836 (eval
7837 (list 'defun
7838 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7839 '(arg)
7841 "Outside of structure, run the binding of `"
7842 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7843 "'.")
7844 '(interactive "p")
7845 (list 'if
7846 '(org-context-p 'headline 'item)
7847 (list 'org-run-like-in-org-mode (list 'quote fun))
7848 (list 'let '(orgstruct-mode)
7849 (list 'call-interactively
7850 (append '(or)
7851 (mapcar (lambda (k)
7852 (list 'key-binding k))
7853 keys)
7854 '('orgstruct-error))))))))
7856 (defun org-context-p (&rest contexts)
7857 "Check if local context is and of CONTEXTS.
7858 Possible values in the list of contexts are `table', `headline', and `item'."
7859 (let ((pos (point)))
7860 (goto-char (point-at-bol))
7861 (prog1 (or (and (memq 'table contexts)
7863 (and (memq 'headline contexts)
7865 (and (memq 'item contexts)
7867 (goto-char pos))))
7869 (defun org-get-local-variables ()
7870 "Return a list of all local variables in an org-mode buffer."
7871 (let (varlist)
7872 (with-current-buffer (get-buffer-create "*Org tmp*")
7873 (erase-buffer)
7874 (org-mode)
7875 (setq varlist (buffer-local-variables)))
7876 (kill-buffer "*Org tmp*")
7877 (delq nil
7878 (mapcar
7879 (lambda (x)
7880 (setq x
7881 (if (symbolp x)
7882 (list x)
7883 (list (car x) (list 'quote (cdr x)))))
7884 (if (string-match
7885 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7886 (symbol-name (car x)))
7887 x nil))
7888 varlist))))
7890 ;;;###autoload
7891 (defun org-run-like-in-org-mode (cmd)
7892 (unless org-local-vars
7893 (setq org-local-vars (org-get-local-variables)))
7894 (eval (list 'let org-local-vars
7895 (list 'call-interactively (list 'quote cmd)))))
7897 ;;;; Archiving
7899 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7901 (defun org-archive-subtree (&optional find-done)
7902 "Move the current subtree to the archive.
7903 The archive can be a certain top-level heading in the current file, or in
7904 a different file. The tree will be moved to that location, the subtree
7905 heading be marked DONE, and the current time will be added.
7907 When called with prefix argument FIND-DONE, find whole trees without any
7908 open TODO items and archive them (after getting confirmation from the user).
7909 If the cursor is not at a headline when this comand is called, try all level
7910 1 trees. If the cursor is on a headline, only try the direct children of
7911 this heading."
7912 (interactive "P")
7913 (if find-done
7914 (org-archive-all-done)
7915 ;; Save all relevant TODO keyword-relatex variables
7917 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7918 (tr-org-todo-keywords-1 org-todo-keywords-1)
7919 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7920 (tr-org-done-keywords org-done-keywords)
7921 (tr-org-todo-regexp org-todo-regexp)
7922 (tr-org-todo-line-regexp org-todo-line-regexp)
7923 (tr-org-odd-levels-only org-odd-levels-only)
7924 (this-buffer (current-buffer))
7925 (org-archive-location org-archive-location)
7927 ;; start of variables that will be used for saving context
7928 ;; The compiler complains about them - keep them anyway!
7929 (file (abbreviate-file-name (buffer-file-name)))
7930 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7931 (time (format-time-string
7932 (substring (cdr org-time-stamp-formats) 1 -1)
7933 (current-time)))
7934 afile heading buffer level newfile-p
7935 category todo priority
7936 ;; start of variables that will be used for savind context
7937 ltags itags prop)
7939 ;; Try to find a local archive location
7940 (save-excursion
7941 (save-restriction
7942 (widen)
7943 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7945 (setq org-archive-location prop)
7946 (if (or (re-search-backward re nil t)
7947 (re-search-forward re nil t))
7948 (setq org-archive-location (match-string 1))))))
7951 (progn
7952 (setq afile (format (match-string 1 org-archive-location)
7953 (file-name-nondirectory buffer-file-name))
7954 heading (match-string 2 org-archive-location)))
7955 (error "Invalid `org-archive-location'"))
7956 (if (> (length afile) 0)
7957 (setq newfile-p (not (file-exists-p afile))
7958 buffer (find-file-noselect afile))
7959 (setq buffer (current-buffer)))
7960 (unless buffer
7962 (if (and (> (length heading) 0)
7964 (setq level (match-end 0))
7965 (setq heading nil level 0))
7966 (save-excursion
7967 (org-back-to-heading t)
7968 ;; Get context information that will be lost by moving the tree
7969 (org-refresh-category-properties)
7970 (setq category (org-get-category)
7971 todo (and (looking-at org-todo-line-regexp)
7972 (match-string 2))
7973 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7974 ltags (org-get-tags)
7975 itags (org-delete-all ltags (org-get-tags-at)))
7976 (setq ltags (mapconcat 'identity ltags " ")
7977 itags (mapconcat 'identity itags " "))
7978 ;; We first only copy, in case something goes wrong
7979 ;; we need to protect this-command, to avoid kill-region sets it,
7980 ;; which would lead to duplication of subtrees
7981 (let (this-command) (org-copy-subtree))
7982 (set-buffer buffer)
7983 ;; Enforce org-mode for the archive buffer
7984 (if (not (org-mode-p))
7985 ;; Force the mode for future visits.
7986 (let ((org-insert-mode-line-in-empty-file t)
7987 (org-inhibit-startup t))
7988 (call-interactively 'org-mode)))
7989 (when newfile-p
7990 (goto-char (point-max))
7992 (buffer-file-name this-buffer))))
7993 ;; Force the TODO keywords of the original buffer
7994 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7995 (org-todo-keywords-1 tr-org-todo-keywords-1)
7996 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7997 (org-done-keywords tr-org-done-keywords)
7998 (org-todo-regexp tr-org-todo-regexp)
7999 (org-todo-line-regexp tr-org-todo-line-regexp)
8000 (org-odd-levels-only
8001 (if (local-variable-p 'org-odd-levels-only (current-buffer))
8002 org-odd-levels-only
8003 tr-org-odd-levels-only)))
8004 (goto-char (point-min))
8005 (if heading
8006 (progn
8007 (if (re-search-forward
8008 (concat "^" (regexp-quote heading)
8010 nil t)
8011 (goto-char (match-end 0))
8012 ;; Heading not found, just insert it at the end
8013 (goto-char (point-max))
8016 (end-of-line 0))
8017 ;; Make the subtree visible
8018 (show-subtree)
8019 (org-end-of-subtree t)
8023 ;; No specific heading, just go to end of file.
8025 ;; Paste
8026 (org-paste-subtree (org-get-legal-level level 1))
8028 ;; Mark the entry as done
8029 (when (and org-archive-mark-done
8030 (looking-at org-todo-line-regexp)
8031 (or (not (match-end 2))
8032 (not (member (match-string 2) org-done-keywords))))
8033 (let (org-log-done org-todo-log-states)
8034 (org-todo
8035 (car (or (member org-archive-mark-done org-done-keywords)
8036 org-done-keywords)))))
8038 ;; Add the context info
8039 (when org-archive-save-context-info
8040 (let ((l org-archive-save-context-info) e n v)
8041 (while (setq e (pop l))
8042 (when (and (setq v (symbol-value e))
8044 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
8045 (org-entry-put (point) n v)))))
8047 ;; Save the buffer, if it is not the same buffer.
8048 (if (not (eq this-buffer buffer)) (save-buffer))))
8049 ;; Here we are back in the original buffer. Everything seems to have
8050 ;; worked. So now cut the tree and finish up.
8051 (let (this-command) (org-cut-subtree))
8053 (message "Subtree archived %s"
8054 (if (eq this-buffer buffer)
8055 (concat "under heading: " heading)
8056 (concat "in file: " (abbreviate-file-name afile)))))))
8058 (defun org-refresh-category-properties ()
8059 "Refresh category text properties in teh buffer."
8060 (let ((def-cat (cond
8061 ((null org-category)
8062 (if buffer-file-name
8063 (file-name-sans-extension
8064 (file-name-nondirectory buffer-file-name))
8065 "???"))
8066 ((symbolp org-category) (symbol-name org-category))
8067 (t org-category)))
8068 beg end cat pos optionp)
8069 (org-unmodified
8070 (save-excursion
8071 (save-restriction
8072 (widen)
8073 (goto-char (point-min))
8074 (put-text-property (point) (point-max) 'org-category def-cat)
8075 (while (re-search-forward
8077 (setq pos (match-end 0)
8078 optionp (equal (char-after (match-beginning 0)) ?#)
8079 cat (org-trim (match-string 2)))
8080 (if optionp
8081 (setq beg (point-at-bol) end (point-max))
8082 (org-back-to-heading t)
8083 (setq beg (point) end (org-end-of-subtree t t)))
8084 (put-text-property beg end 'org-category cat)
8085 (goto-char pos)))))))
8087 (defun org-archive-all-done (&optional tag)
8088 "Archive sublevels of the current tree without open TODO items.
8089 If the cursor is not on a headline, try all level 1 trees. If
8090 it is on a headline, try all direct children.
8091 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8093 (rea (concat ".*:" org-archive-tag ":"))
8094 (begm (make-marker))
8095 (endm (make-marker))
8096 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8097 "Move subtree to archive (no open TODO items)? "))
8098 beg end (cntarch 0))
8099 (if (org-on-heading-p)
8100 (progn
8101 (setq re1 (concat "^" (regexp-quote
8102 (make-string
8103 (1+ (- (match-end 0) (match-beginning 0) 1))
8104 ?*))
8105 " "))
8106 (move-marker begm (point))
8107 (move-marker endm (org-end-of-subtree t)))
8108 (setq re1 "^* ")
8109 (move-marker begm (point-min))
8110 (move-marker endm (point-max)))
8111 (save-excursion
8112 (goto-char begm)
8113 (while (re-search-forward re1 endm t)
8114 (setq beg (match-beginning 0)
8115 end (save-excursion (org-end-of-subtree t) (point)))
8116 (goto-char beg)
8117 (if (re-search-forward re end t)
8118 (goto-char end)
8119 (goto-char beg)
8120 (if (and (or (not tag) (not (looking-at rea)))
8121 (y-or-n-p question))
8122 (progn
8123 (if tag
8124 (org-toggle-tag org-archive-tag 'on)
8125 (org-archive-subtree))
8126 (setq cntarch (1+ cntarch)))
8127 (goto-char end)))))
8128 (message "%d trees archived" cntarch)))
8130 (defun org-cycle-hide-drawers (state)
8131 "Re-hide all drawers after a visibility state change."
8132 (when (and (org-mode-p)
8133 (not (memq state '(overview folded))))
8134 (save-excursion
8135 (let* ((globalp (memq state '(contents all)))
8136 (beg (if globalp (point-min) (point)))
8137 (end (if globalp (point-max) (org-end-of-subtree t))))
8138 (goto-char beg)
8139 (while (re-search-forward org-drawer-regexp end t)
8140 (org-flag-drawer t))))))
8142 (defun org-flag-drawer (flag)
8143 (save-excursion
8144 (beginning-of-line 1)
8146 (let ((b (match-end 0))
8147 (outline-regexp org-outline-regexp))
8148 (if (re-search-forward
8150 (save-excursion (outline-next-heading) (point)) t)
8151 (outline-flag-region b (point-at-eol) flag)
8152 (error ":END: line missing"))))))
8154 (defun org-cycle-hide-archived-subtrees (state)
8155 "Re-hide all archived subtrees after a visibility state change."
8156 (when (and (not org-cycle-open-archived-trees)
8157 (not (memq state '(overview folded))))
8158 (save-excursion
8159 (let* ((globalp (memq state '(contents all)))
8160 (beg (if globalp (point-min) (point)))
8161 (end (if globalp (point-max) (org-end-of-subtree t))))
8162 (org-hide-archived-subtrees beg end)
8163 (goto-char beg)
8164 (if (looking-at (concat ".*:" org-archive-tag ":"))
8165 (message "%s" (substitute-command-keys
8166 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8168 (defun org-force-cycle-archived ()
8169 "Cycle subtree even if it is archived."
8170 (interactive)
8171 (setq this-command 'org-cycle)
8172 (let ((org-cycle-open-archived-trees t))
8173 (call-interactively 'org-cycle)))
8175 (defun org-hide-archived-subtrees (beg end)
8176 "Re-hide all archived subtrees after a visibility state change."
8177 (save-excursion
8178 (let* ((re (concat ":" org-archive-tag ":")))
8179 (goto-char beg)
8180 (while (re-search-forward re end t)
8181 (and (org-on-heading-p) (hide-subtree))
8182 (org-end-of-subtree t)))))
8184 (defun org-toggle-tag (tag &optional onoff)
8185 "Toggle the tag TAG for the current line.
8186 If ONOFF is `on' or `off', don't toggle but set to this state."
8187 (unless (org-on-heading-p t) (error "Not on headling"))
8188 (let (res current)
8189 (save-excursion
8190 (beginning-of-line)
8192 (point-at-eol) t)
8193 (progn
8194 (setq current (match-string 1))
8195 (replace-match ""))
8196 (setq current ""))
8197 (setq current (nreverse (org-split-string current ":")))
8198 (cond
8199 ((eq onoff 'on)
8200 (setq res t)
8201 (or (member tag current) (push tag current)))
8202 ((eq onoff 'off)
8203 (or (not (member tag current)) (setq current (delete tag current))))
8204 (t (if (member tag current)
8205 (setq current (delete tag current))
8206 (setq res t)
8207 (push tag current))))
8208 (end-of-line 1)
8209 (if current
8210 (progn
8211 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8212 (org-set-tags nil t))
8213 (delete-horizontal-space))
8214 (run-hooks 'org-after-tags-change-hook))
8215 res))
8217 (defun org-toggle-archive-tag (&optional arg)
8218 "Toggle the archive tag for the current headline.
8219 With prefix ARG, check all children of current headline and offer tagging
8220 the children that do not contain any open TODO items."
8221 (interactive "P")
8222 (if arg
8223 (org-archive-all-done 'tag)
8224 (let (set)
8225 (save-excursion
8226 (org-back-to-heading t)
8227 (setq set (org-toggle-tag org-archive-tag))
8228 (when set (hide-subtree)))
8229 (and set (beginning-of-line 1))
8230 (message "Subtree %s" (if set "archived" "unarchived")))))
8233 ;;;; Tables
8235 ;;; The table editor
8237 ;; Watch out: Here we are talking about two different kind of tables.
8238 ;; Most of the code is for the tables created with the Org-mode table editor.
8239 ;; Sometimes, we talk about tables created and edited with the table.el
8240 ;; Emacs package. We call the former org-type tables, and the latter
8241 ;; table.el-type tables.
8243 (defun org-before-change-function (beg end)
8244 "Every change indicates that a table might need an update."
8245 (setq org-table-may-need-update t))
8248 "Detects an org-type table line.")
8250 "Detects an org-type table line.")
8252 "Detects a table line marked for automatic recalculation.")
8254 "Detects a table line marked for automatic recalculation.")
8256 "Detects a table line marked for automatic recalculation.")
8258 "Detects an org-type table hline.")
8260 "Detects a table-type table hline.")
8262 "Detects an org-type or table-type table.")
8264 "Searching from within a table (any type) this finds the first line
8265 outside the table.")
8267 "Searching from within a table (any type) this finds the first line
8268 outside the table.")
8270 (defvar org-table-last-highlighted-reference nil)
8271 (defvar org-table-formula-history nil)
8273 (defvar org-table-column-names nil
8274 "Alist with column names, derived from the `!' line.")
8275 (defvar org-table-column-name-regexp nil
8276 "Regular expression matching the current column names.")
8277 (defvar org-table-local-parameters nil
8278 "Alist with parameter names, derived from the `$' line.")
8279 (defvar org-table-named-field-locations nil
8280 "Alist with locations of named fields.")
8282 (defvar org-table-current-line-types nil
8283 "Table row types, non-nil only for the duration of a comand.")
8284 (defvar org-table-current-begin-line nil
8285 "Table begin line, non-nil only for the duration of a comand.")
8286 (defvar org-table-current-begin-pos nil
8287 "Table begin position, non-nil only for the duration of a comand.")
8288 (defvar org-table-dlines nil
8289 "Vector of data line line numbers in the current table.")
8290 (defvar org-table-hlines nil
8291 "Vector of hline line numbers in the current table.")
8293 (defconst org-table-range-regexp
8294 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8295 ;; 1 2 3 4 5
8296 "Regular expression for matching ranges in formulas.")
8298 (defconst org-table-range-regexp2
8299 (concat
8303 "Match a range for reference display.")
8305 (defconst org-table-translate-regexp
8307 "Match a reference that needs translation, for reference display.")
8309 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8311 (defun org-table-create-with-table.el ()
8312 "Use the table.el package to insert a new table.
8313 If there is already a table at point, convert between Org-mode tables
8314 and table.el tables."
8315 (interactive)
8316 (require 'table)
8317 (cond
8318 ((org-at-table.el-p)
8319 (if (y-or-n-p "Convert table to Org-mode table? ")
8320 (org-table-convert)))
8321 ((org-at-table-p)
8322 (if (y-or-n-p "Convert table to table.el table? ")
8323 (org-table-convert)))
8324 (t (call-interactively 'table-insert))))
8326 (defun org-table-create-or-convert-from-region (arg)
8327 "Convert region to table, or create an empty table.
8328 If there is an active region, convert it to a table, using the function
8329 `org-table-convert-region'. See the documentation of that function
8330 to learn how the prefix argument is interpreted to determine the field
8331 separator.
8332 If there is no such region, create an empty table with `org-table-create'."
8333 (interactive "P")
8334 (if (org-region-active-p)
8335 (org-table-convert-region (region-beginning) (region-end) arg)
8336 (org-table-create arg)))
8338 (defun org-table-create (&optional size)
8339 "Query for a size and insert a table skeleton.
8341 (interactive "P")
8342 (unless size
8343 (setq size (read-string
8344 (concat "Table size Columns x Rows [e.g. "
8345 org-table-default-size "]: ")
8346 "" nil org-table-default-size)))
8348 (let* ((pos (point))
8349 (indent (make-string (current-column) ?\ ))
8350 (split (org-split-string size " *x *"))
8351 (rows (string-to-number (nth 1 split)))
8352 (columns (string-to-number (car split)))
8353 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8356 (point-at-bol) (point)))
8357 (beginning-of-line 1)
8358 (newline))
8359 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8360 (dotimes (i rows) (insert line))
8361 (goto-char pos)
8362 (if (> rows 1)
8363 ;; Insert a hline after the first row.
8364 (progn
8365 (end-of-line 1)
8367 (goto-char pos)))
8368 (org-table-align)))
8370 (defun org-table-convert-region (beg0 end0 &optional separator)
8371 "Convert region to a table.
8372 The region goes from BEG0 to END0, but these borders will be moved
8373 slightly, to make sure a beginning of line in the first line is included.
8375 SEPARATOR specifies the field separator in the lines. It can have the
8376 following values:
8378 '(4) Use the comma as a field separator
8379 '(16) Use a TAB as field separator
8380 integer When a number, use that many spaces as field separator
8381 nil When nil, the command tries to be smart and figure out the
8382 separator in the following way:
8383 - when each line contains a TAB, assume TAB-separated material
8384 - when each line contains a comme, assume CSV material
8385 - else, assume one or more SPACE charcters as separator."
8386 (interactive "rP")
8387 (let* ((beg (min beg0 end0))
8388 (end (max beg0 end0))
8389 re)
8390 (goto-char beg)
8391 (beginning-of-line 1)
8392 (setq beg (move-marker (make-marker) (point)))
8393 (goto-char end)
8394 (if (bolp) (backward-char 1) (end-of-line 1))
8395 (setq end (move-marker (make-marker) (point)))
8396 ;; Get the right field separator
8397 (unless separator
8398 (goto-char beg)
8399 (setq separator
8400 (cond
8403 (t 1))))
8404 (setq re (cond
8407 ((integerp separator)
8409 (t (error "This should not happen"))))
8410 (goto-char beg)
8411 (while (re-search-forward re end t)
8412 (replace-match "| " t t))
8413 (goto-char beg)
8414 (insert " ")
8415 (org-table-align)))
8417 (defun org-table-import (file arg)
8418 "Import FILE as a table.
8419 The file is assumed to be tab-separated. Such files can be produced by most
8420 spreadsheet and database applications. If no tabs (at least one per line)
8421 are found, lines will be split on whitespace into fields."
8423 (or (bolp) (newline))
8424 (let ((beg (point))
8425 (pm (point-max)))
8426 (insert-file-contents file)
8427 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8429 (defun org-table-export ()
8430 "Export table as a tab-separated file.
8431 Such a file can be imported into a spreadsheet program like Excel."
8432 (interactive)
8433 (let* ((beg (org-table-begin))
8434 (end (org-table-end))
8435 (table (buffer-substring beg end))
8436 (file (read-file-name "Export table to: "))
8437 buf)
8438 (unless (or (not (file-exists-p file))
8439 (y-or-n-p (format "Overwrite file %s? " file)))
8440 (error "Abort"))
8441 (with-current-buffer (find-file-noselect file)
8442 (setq buf (current-buffer))
8443 (erase-buffer)
8444 (fundamental-mode)
8445 (insert table)
8446 (goto-char (point-min))
8448 (replace-match "" t t)
8449 (end-of-line 1))
8450 (goto-char (point-min))
8452 (replace-match "" t t)
8453 (goto-char (min (1+ (point)) (point-max))))
8454 (goto-char (point-min))
8455 (while (re-search-forward "^-[-+]*$" nil t)
8456 (replace-match "")
8458 (delete-char 1)))
8459 (goto-char (point-min))
8462 (save-buffer))
8463 (kill-buffer buf)))
8465 (defvar org-table-aligned-begin-marker (make-marker)
8466 "Marker at the beginning of the table last aligned.
8467 Used to check if cursor still is in that table, to minimize realignment.")
8468 (defvar org-table-aligned-end-marker (make-marker)
8469 "Marker at the end of the table last aligned.
8470 Used to check if cursor still is in that table, to minimize realignment.")
8471 (defvar org-table-last-alignment nil
8472 "List of flags for flushright alignment, from the last re-alignment.
8473 This is being used to correctly align a single field after TAB or RET.")
8474 (defvar org-table-last-column-widths nil
8475 "List of max width of fields in each column.
8476 This is being used to correctly align a single field after TAB or RET.")
8477 (defvar org-table-overlay-coordinates nil
8478 "Overlay coordinates after each align of a table.")
8479 (make-variable-buffer-local 'org-table-overlay-coordinates)
8481 (defvar org-last-recalc-line nil)
8482 (defconst org-narrow-column-arrow "=>"
8483 "Used as display property in narrowed table columns.")
8485 (defun org-table-align ()
8486 "Align the table at point by aligning all vertical bars."
8487 (interactive)
8488 (let* (
8489 ;; Limits of table
8490 (beg (org-table-begin))
8491 (end (org-table-end))
8492 ;; Current cursor position
8493 (linepos (org-current-line))
8494 (colpos (org-table-current-column))
8495 (winstart (window-start))
8496 (winstartline (org-current-line (min winstart (1- (point-max)))))
8497 lines (new "") lengths l typenums ty fields maxfields i
8498 column
8499 (indent "") cnt frac
8500 rfmt hfmt
8501 (spaces '(1 . 1))
8502 (sp1 (car spaces))
8503 (sp2 (cdr spaces))
8504 (rfmt1 (concat
8505 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8506 (hfmt1 (concat
8507 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8508 emptystrings links dates emph narrow fmax f1 len c e)
8509 (untabify beg end)
8510 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8511 ;; Check if we have links or dates
8512 (goto-char beg)
8513 (setq links (re-search-forward org-bracket-link-regexp end t))
8514 (goto-char beg)
8515 (setq emph (and org-hide-emphasis-markers
8516 (re-search-forward org-emph-re end t)))
8517 (goto-char beg)
8518 (setq dates (and org-display-custom-times
8519 (re-search-forward org-ts-regexp-both end t)))
8520 ;; Make sure the link properties are right
8521 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8522 ;; Make sure the date properties are right
8523 (when dates (goto-char beg) (while (org-activate-dates end)))
8524 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8526 ;; Check if we are narrowing any columns
8527 (goto-char beg)
8528 (setq narrow (and org-format-transports-properties-p
8529 (re-search-forward "<[0-9]+>" end t)))
8530 ;; Get the rows
8531 (setq lines (org-split-string
8533 ;; Store the indentation of the first line
8534 (if (string-match "^ *" (car lines))
8535 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8536 ;; Mark the hlines by setting the corresponding element to nil
8537 ;; At the same time, we remove trailing space.
8538 (setq lines (mapcar (lambda (l)
8539 (if (string-match "^ *|-" l)
8540 nil
8542 (substring l 0 (match-beginning 0))
8543 l)))
8544 lines))
8545 ;; Get the data fields by splitting the lines.
8546 (setq fields (mapcar
8547 (lambda (l)
8548 (org-split-string l " *| *"))
8549 (delq nil (copy-sequence lines))))
8550 ;; How many fields in the longest line?
8551 (condition-case nil
8552 (setq maxfields (apply 'max (mapcar 'length fields)))
8553 (error
8554 (kill-region beg end)
8555 (org-table-create org-table-default-size)
8556 (error "Empty table - created default table")))
8557 ;; A list of empty strings to fill any short rows on output
8558 (setq emptystrings (make-list maxfields ""))
8559 ;; Check for special formatting.
8560 (setq i -1)
8561 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8562 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8563 ;; Check if there is an explicit width specified
8564 (when narrow
8565 (setq c column fmax nil)
8566 (while c
8567 (setq e (pop c))
8569 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8570 ;; Find fields that are wider than fmax, and shorten them
8571 (when fmax
8572 (loop for xx in column do
8573 (when (and (stringp xx)
8574 (> (org-string-width xx) fmax))
8575 (org-add-props xx nil
8576 'help-echo
8577 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8578 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8579 (unless (> f1 1)
8581 (match-string 0 xx)))
8582 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8583 (add-text-properties (- f1 2) f1
8584 (list 'display org-narrow-column-arrow)
8585 xx)))))
8586 ;; Get the maximum width for each column
8587 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8588 ;; Get the fraction of numbers, to decide about alignment of the column
8589 (setq cnt 0 frac 0.0)
8590 (loop for x in column do
8591 (if (equal x "")
8592 nil
8593 (setq frac ( / (+ (* frac cnt)
8594 (if (string-match org-table-number-regexp x) 1 0))
8595 (setq cnt (1+ cnt))))))
8596 (push (>= frac org-table-number-fraction) typenums))
8597 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8599 ;; Store the alignment of this table, for later editing of single fields
8600 (setq org-table-last-alignment typenums
8601 org-table-last-column-widths lengths)
8603 ;; With invisible characters, `format' does not get the field width right
8604 ;; So we need to make these fields wide by hand.
8605 (when (or links emph)
8606 (loop for i from 0 upto (1- maxfields) do
8607 (setq len (nth i lengths))
8608 (loop for j from 0 upto (1- (length fields)) do
8609 (setq c (nthcdr i (car (nthcdr j fields))))
8610 (if (and (stringp (car c))
8611 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8612 ; (string-match org-bracket-link-regexp (car c))
8613 (< (org-string-width (car c)) len))
8614 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8616 ;; Compute the formats needed for output of the table
8617 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8618 (while (setq l (pop lengths))
8619 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8620 (setq rfmt (concat rfmt (format rfmt1 ty l))
8621 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8625 (setq new (mapconcat
8626 (lambda (l)
8627 (if l (apply 'format rfmt
8628 (append (pop fields) emptystrings))
8629 hfmt))
8630 lines ""))
8631 ;; Replace the old one
8632 (delete-region beg end)
8633 (move-marker end nil)
8634 (move-marker org-table-aligned-begin-marker (point))
8635 (insert new)
8636 (move-marker org-table-aligned-end-marker (point))
8637 (when (and orgtbl-mode (not (org-mode-p)))
8638 (goto-char org-table-aligned-begin-marker)
8639 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8640 ;; Try to move to the old location
8641 (goto-line winstartline)
8642 (setq winstart (point-at-bol))
8643 (goto-line linepos)
8644 (set-window-start (selected-window) winstart 'noforce)
8645 (org-table-goto-column colpos)
8646 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8647 (setq org-table-may-need-update nil)
8648 ))
8650 (defun org-string-width (s)
8651 "Compute width of string, ignoring invisible characters.
8652 This ignores character with invisibility property `org-link', and also
8653 characters with property `org-cwidth', because these will become invisible
8654 upon the next fontification round."
8655 (let (b l)
8656 (when (or (eq t buffer-invisibility-spec)
8657 (assq 'org-link buffer-invisibility-spec))
8658 (while (setq b (text-property-any 0 (length s)
8659 'invisible 'org-link s))
8660 (setq s (concat (substring s 0 b)
8661 (substring s (or (next-single-property-change
8662 b 'invisible s) (length s)))))))
8663 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8664 (setq s (concat (substring s 0 b)
8665 (substring s (or (next-single-property-change
8666 b 'org-cwidth s) (length s))))))
8667 (setq l (string-width s) b -1)
8668 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8669 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8670 l))
8672 (defun org-table-begin (&optional table-type)
8673 "Find the beginning of the table and return its position.
8674 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8675 (save-excursion
8676 (if (not (re-search-backward
8677 (if table-type org-table-any-border-regexp
8678 org-table-border-regexp)
8679 nil t))
8680 (progn (goto-char (point-min)) (point))
8681 (goto-char (match-beginning 0))
8682 (beginning-of-line 2)
8683 (point))))
8685 (defun org-table-end (&optional table-type)
8686 "Find the end of the table and return its position.
8687 With argument TABLE-TYPE, go to the end of a table.el-type table."
8688 (save-excursion
8689 (if (not (re-search-forward
8690 (if table-type org-table-any-border-regexp
8691 org-table-border-regexp)
8692 nil t))
8693 (goto-char (point-max))
8694 (goto-char (match-beginning 0)))
8695 (point-marker)))
8697 (defun org-table-justify-field-maybe (&optional new)
8698 "Justify the current field, text to left, number to right.
8699 Optional argument NEW may specify text to replace the current field content."
8700 (cond
8701 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8702 ((org-at-table-hline-p))
8703 ((and (not new)
8704 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8705 (current-buffer)))
8706 (< (point) org-table-aligned-begin-marker)
8707 (>= (point) org-table-aligned-end-marker)))
8708 ;; This is not the same table, force a full re-align
8709 (setq org-table-may-need-update t))
8710 (t ;; realign the current field, based on previous full realign
8711 (let* ((pos (point)) s
8712 (col (org-table-current-column))
8713 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8714 l f n o e)
8715 (when (> col 0)
8718 (progn
8719 (setq s (match-string 1)
8720 o (match-string 0)
8721 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8722 e (not (= (match-beginning 2) (match-end 2))))
8723 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8724 l (if e "|" (setq org-table-may-need-update t) ""))
8725 n (format f s))
8726 (if new
8727 (if (<= (length new) l) ;; FIXME: length -> str-width?
8728 (setq n (format f new))
8729 (setq n (concat new "|") org-table-may-need-update t)))
8730 (or (equal n o)
8731 (let (org-table-may-need-update)
8732 (replace-match n t t))))
8733 (setq org-table-may-need-update t))
8734 (goto-char pos))))))
8736 (defun org-table-next-field ()
8737 "Go to the next field in the current table, creating new lines as needed.
8738 Before doing so, re-align the table if necessary."
8739 (interactive)
8740 (org-table-maybe-eval-formula)
8741 (org-table-maybe-recalculate-line)
8742 (if (and org-table-automatic-realign
8743 org-table-may-need-update)
8744 (org-table-align))
8745 (let ((end (org-table-end)))
8746 (if (org-at-table-hline-p)
8747 (end-of-line 1))
8748 (condition-case nil
8749 (progn
8750 (re-search-forward "|" end)
8752 (re-search-forward "|" end))
8753 (if (and (looking-at "-")
8754 org-table-tab-jumps-over-hlines
8756 (goto-char (match-beginning 1)))
8757 (if (looking-at "-")
8758 (progn
8759 (beginning-of-line 0)
8760 (org-table-insert-row 'below))
8761 (if (looking-at " ") (forward-char 1))))
8762 (error
8763 (org-table-insert-row 'below)))))
8765 (defun org-table-previous-field ()
8766 "Go to the previous field in the table.
8767 Before doing so, re-align the table if necessary."
8768 (interactive)
8769 (org-table-justify-field-maybe)
8770 (org-table-maybe-recalculate-line)
8771 (if (and org-table-automatic-realign
8772 org-table-may-need-update)
8773 (org-table-align))
8774 (if (org-at-table-hline-p)
8775 (end-of-line 1))
8776 (re-search-backward "|" (org-table-begin))
8777 (re-search-backward "|" (org-table-begin))
8779 (re-search-backward "|" (org-table-begin)))
8780 (if (looking-at "| ?")
8781 (goto-char (match-end 0))))
8783 (defun org-table-next-row ()
8784 "Go to the next row (same column) in the current table.
8785 Before doing so, re-align the table if necessary."
8786 (interactive)
8787 (org-table-maybe-eval-formula)
8788 (org-table-maybe-recalculate-line)
8791 (newline)
8792 (if (and org-table-automatic-realign
8793 org-table-may-need-update)
8794 (org-table-align))
8795 (let ((col (org-table-current-column)))
8796 (beginning-of-line 2)
8797 (if (or (not (org-at-table-p))
8798 (org-at-table-hline-p))
8799 (progn
8800 (beginning-of-line 0)
8801 (org-table-insert-row 'below)))
8802 (org-table-goto-column col)
8804 (if (looking-at " ") (forward-char 1)))))
8806 (defun org-table-copy-down (n)
8807 "Copy a field down in the current column.
8808 If the field at the cursor is empty, copy into it the content of the nearest
8809 non-empty field above. With argument N, use the Nth non-empty field.
8810 If the current field is not empty, it is copied down to the next row, and
8811 the cursor is moved with it. Therefore, repeating this command causes the
8812 column to be filled row-by-row.
8813 If the variable `org-table-copy-increment' is non-nil and the field is an
8814 integer or a timestamp, it will be incremented while copying. In the case of
8815 a timestamp, if the cursor is on the year, change the year. If it is on the
8816 month or the day, change that. Point will stay on the current date field
8817 in order to easily repeat the interval."
8818 (interactive "p")
8819 (let* ((colpos (org-table-current-column))
8820 (col (current-column))
8821 (field (org-table-get-field))
8823 (beg (org-table-begin))
8824 txt)
8825 (org-table-check-inside-data-field)
8826 (if non-empty
8827 (progn
8828 (setq txt (org-trim field))
8829 (org-table-next-row)
8830 (org-table-blank-field))
8831 (save-excursion
8832 (setq txt
8833 (catch 'exit
8834 (while (progn (beginning-of-line 1)
8835 (re-search-backward org-table-dataline-regexp
8836 beg t))
8837 (org-table-goto-column colpos t)
8838 (if (and (looking-at
8840 (= (setq n (1- n)) 0))
8841 (throw 'exit (match-string 1))))))))
8842 (if txt
8843 (progn
8844 (if (and org-table-copy-increment
8845 (string-match "^[0-9]+$" txt))
8846 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8847 (insert txt)
8848 (move-to-column col)
8849 (if (and org-table-copy-increment (org-at-timestamp-p t))
8850 (org-timestamp-up 1)
8851 (org-table-maybe-recalculate-line))
8852 (org-table-align)
8853 (move-to-column col))
8854 (error "No non-empty field found"))))
8856 (defun org-table-check-inside-data-field ()
8857 "Is point inside a table data field?
8858 I.e. not on a hline or before the first or after the last column?
8859 This actually throws an error, so it aborts the current command."
8860 (if (or (not (org-at-table-p))
8861 (= (org-table-current-column) 0)
8862 (org-at-table-hline-p)
8864 (error "Not in table data field")))
8866 (defvar org-table-clip nil
8867 "Clipboard for table regions.")
8869 (defun org-table-blank-field ()
8870 "Blank the current table field or active region."
8871 (interactive)
8872 (org-table-check-inside-data-field)
8873 (if (and (interactive-p) (org-region-active-p))
8874 (let (org-table-clip)
8875 (org-table-cut-region (region-beginning) (region-end)))
8876 (skip-chars-backward "^|")
8877 (backward-char 1)
8879 (let* ((pos (match-beginning 0))
8880 (match (match-string 0))
8881 (len (org-string-width match)))
8882 (replace-match (concat "|" (make-string (1- len) ?\ )))
8883 (goto-char (+ 2 pos))
8884 (substring match 1)))))
8886 (defun org-table-get-field (&optional n replace)
8887 "Return the value of the field in column N of current row.
8888 N defaults to current field.
8889 If REPLACE is a string, replace field with this value. The return value
8890 is always the old value."
8891 (and n (org-table-goto-column n))
8893 (backward-char 1)
8895 (let* ((pos (match-beginning 0))
8896 (val (buffer-substring (1+ pos) (match-end 0))))
8897 (if replace
8898 (replace-match (concat "|" replace) t t))
8899 (goto-char (min (point-at-eol) (+ 2 pos)))
8900 val)
8901 (forward-char 1) ""))
8903 (defun org-table-field-info (arg)
8904 "Show info about the current field, and highlight any reference at point."
8905 (interactive "P")
8906 (org-table-get-specials)
8907 (save-excursion
8908 (let* ((pos (point))
8909 (col (org-table-current-column))
8910 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8911 (name (car (rassoc (list (org-current-line) col)
8912 org-table-named-field-locations)))
8913 (eql (org-table-get-stored-formulas))
8914 (dline (org-table-current-dline))
8915 (ref (format "@%d$%d" dline col))
8916 (ref1 (org-table-convert-refs-to-an ref))
8917 (fequation (or (assoc name eql) (assoc ref eql)))
8918 (cequation (assoc (int-to-string col) eql))
8919 (eqn (or fequation cequation)))
8920 (goto-char pos)
8921 (condition-case nil
8922 (org-table-show-reference 'local)
8923 (error nil))
8924 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8925 dline col
8926 (if cname (concat " or $" cname) "")
8927 dline col ref1
8928 (if name (concat " or $" name) "")
8929 ;; FIXME: formula info not correct if special table line
8930 (if eqn
8931 (concat ", formula: "
8932 (org-table-formula-to-user
8933 (concat
8934 (if (string-match "^[$@]"(car eqn)) "" "$")
8935 (car eqn) "=" (cdr eqn))))
8936 "")))))
8938 (defun org-table-current-column ()
8939 "Find out which column we are in.
8940 When called interactively, column is also displayed in echo area."
8941 (interactive)
8942 (if (interactive-p) (org-table-check-inside-data-field))
8943 (save-excursion
8944 (let ((cnt 0) (pos (point)))
8945 (beginning-of-line 1)
8946 (while (search-forward "|" pos t)
8947 (setq cnt (1+ cnt)))
8948 (if (interactive-p) (message "This is table column %d" cnt))
8949 cnt)))
8951 (defun org-table-current-dline ()
8952 "Find out what table data line we are in.
8953 Only datalins count for this."
8954 (interactive)
8955 (if (interactive-p) (org-table-check-inside-data-field))
8956 (save-excursion
8957 (let ((cnt 0) (pos (point)))
8958 (goto-char (org-table-begin))
8959 (while (<= (point) pos)
8960 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8961 (beginning-of-line 2))
8962 (if (interactive-p) (message "This is table line %d" cnt))
8963 cnt)))
8965 (defun org-table-goto-column (n &optional on-delim force)
8966 "Move the cursor to the Nth column in the current table line.
8967 With optional argument ON-DELIM, stop with point before the left delimiter
8968 of the field.
8969 If there are less than N fields, just go to after the last delimiter.
8970 However, when FORCE is non-nil, create new columns if necessary."
8971 (interactive "p")
8972 (let ((pos (point-at-eol)))
8973 (beginning-of-line 1)
8974 (when (> n 0)
8975 (while (and (> (setq n (1- n)) -1)
8976 (or (search-forward "|" pos t)
8977 (and force
8978 (progn (end-of-line 1)
8979 (skip-chars-backward "^|")
8980 (insert " | "))))))
8981 ; (backward-char 2) t)))))
8982 (when (and force (not (looking-at ".*|")))
8983 (save-excursion (end-of-line 1) (insert " | ")))
8984 (if on-delim
8985 (backward-char 1)
8986 (if (looking-at " ") (forward-char 1))))))
8988 (defun org-at-table-p (&optional table-type)
8989 "Return t if the cursor is inside an org-type table.
8990 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8991 (if org-enable-table-editor
8992 (save-excursion
8993 (beginning-of-line 1)
8994 (looking-at (if table-type org-table-any-line-regexp
8995 org-table-line-regexp)))
8996 nil))
8998 (defun org-at-table.el-p ()
8999 "Return t if and only if we are at a table.el table."
9000 (and (org-at-table-p 'any)
9001 (save-excursion
9002 (goto-char (org-table-begin 'any))
9003 (looking-at org-table1-hline-regexp))))
9005 (defun org-table-recognize-table.el ()
9006 "If there is a table.el table nearby, recognize it and move into it."
9007 (if org-table-tab-recognizes-table.el
9008 (if (org-at-table.el-p)
9009 (progn
9010 (beginning-of-line 1)
9011 (if (looking-at org-table-dataline-regexp)
9012 nil
9013 (if (looking-at org-table1-hline-regexp)
9014 (progn
9015 (beginning-of-line 2)
9016 (if (looking-at org-table-any-border-regexp)
9017 (beginning-of-line -1)))))
9018 (if (re-search-forward "|" (org-table-end t) t)
9019 (progn
9020 (require 'table)
9021 (if (table--at-cell-p (point))
9022 t
9023 (message "recognizing table.el table...")
9024 (table-recognize-table)
9025 (message "recognizing table.el table...done")))
9026 (error "This should not happen..."))
9027 t)
9028 nil)
9029 nil))
9031 (defun org-at-table-hline-p ()
9032 "Return t if the cursor is inside a hline in a table."
9033 (if org-enable-table-editor
9034 (save-excursion
9035 (beginning-of-line 1)
9036 (looking-at org-table-hline-regexp))
9037 nil))
9039 (defun org-table-insert-column ()
9040 "Insert a new column into the table."
9041 (interactive)
9042 (if (not (org-at-table-p))
9043 (error "Not at a table"))
9044 (org-table-find-dataline)
9045 (let* ((col (max 1 (org-table-current-column)))
9046 (beg (org-table-begin))
9047 (end (org-table-end))
9048 ;; Current cursor position
9049 (linepos (org-current-line))
9050 (colpos col))
9051 (goto-char beg)
9052 (while (< (point) end)
9053 (if (org-at-table-hline-p)
9054 nil
9055 (org-table-goto-column col t)
9056 (insert "| "))
9057 (beginning-of-line 2))
9058 (move-marker end nil)
9059 (goto-line linepos)
9060 (org-table-goto-column colpos)
9061 (org-table-align)
9062 (org-table-fix-formulas "$" nil (1- col) 1)))
9064 (defun org-table-find-dataline ()
9065 "Find a dataline in the current table, which is needed for column commands."
9066 (if (and (org-at-table-p)
9067 (not (org-at-table-hline-p)))
9068 t
9069 (let ((col (current-column))
9070 (end (org-table-end)))
9071 (move-to-column col)
9072 (while (and (< (point) end)
9073 (or (not (= (current-column) col))
9074 (org-at-table-hline-p)))
9075 (beginning-of-line 2)
9076 (move-to-column col))
9077 (if (and (org-at-table-p)
9078 (not (org-at-table-hline-p)))
9079 t
9080 (error
9081 "Please position cursor in a data line for column operations")))))
9083 (defun org-table-delete-column ()
9084 "Delete a column from the table."
9085 (interactive)
9086 (if (not (org-at-table-p))
9087 (error "Not at a table"))
9088 (org-table-find-dataline)
9089 (org-table-check-inside-data-field)
9090 (let* ((col (org-table-current-column))
9091 (beg (org-table-begin))
9092 (end (org-table-end))
9093 ;; Current cursor position
9094 (linepos (org-current-line))
9095 (colpos col))
9096 (goto-char beg)
9097 (while (< (point) end)
9098 (if (org-at-table-hline-p)
9099 nil
9100 (org-table-goto-column col t)
9102 (replace-match "|")))
9103 (beginning-of-line 2))
9104 (move-marker end nil)
9105 (goto-line linepos)
9106 (org-table-goto-column colpos)
9107 (org-table-align)
9108 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9109 col -1 col)))
9111 (defun org-table-move-column-right ()
9112 "Move column to the right."
9113 (interactive)
9114 (org-table-move-column nil))
9115 (defun org-table-move-column-left ()
9116 "Move column to the left."
9117 (interactive)
9118 (org-table-move-column 'left))
9120 (defun org-table-move-column (&optional left)
9121 "Move the current column to the right. With arg LEFT, move to the left."
9122 (interactive "P")
9123 (if (not (org-at-table-p))
9124 (error "Not at a table"))
9125 (org-table-find-dataline)
9126 (org-table-check-inside-data-field)
9127 (let* ((col (org-table-current-column))
9128 (col1 (if left (1- col) col))
9129 (beg (org-table-begin))
9130 (end (org-table-end))
9131 ;; Current cursor position
9132 (linepos (org-current-line))
9133 (colpos (if left (1- col) (1+ col))))
9134 (if (and left (= col 1))
9135 (error "Cannot move column further left"))
9137 (error "Cannot move column further right"))
9138 (goto-char beg)
9139 (while (< (point) end)
9140 (if (org-at-table-hline-p)
9141 nil
9142 (org-table-goto-column col1 t)
9145 (beginning-of-line 2))
9146 (move-marker end nil)
9147 (goto-line linepos)
9148 (org-table-goto-column colpos)
9149 (org-table-align)
9150 (org-table-fix-formulas
9151 "$" (list (cons (number-to-string col) (number-to-string colpos))
9152 (cons (number-to-string colpos) (number-to-string col))))))
9154 (defun org-table-move-row-down ()
9155 "Move table row down."
9156 (interactive)
9157 (org-table-move-row nil))
9158 (defun org-table-move-row-up ()
9159 "Move table row up."
9160 (interactive)
9161 (org-table-move-row 'up))
9163 (defun org-table-move-row (&optional up)
9164 "Move the current table line down. With arg UP, move it up."
9165 (interactive "P")
9166 (let* ((col (current-column))
9167 (pos (point))
9168 (hline1p (save-excursion (beginning-of-line 1)
9169 (looking-at org-table-hline-regexp)))
9170 (dline1 (org-table-current-dline))
9171 (dline2 (+ dline1 (if up -1 1)))
9172 (tonew (if up 0 2))
9173 txt hline2p)
9174 (beginning-of-line tonew)
9175 (unless (org-at-table-p)
9176 (goto-char pos)
9177 (error "Cannot move row further"))
9178 (setq hline2p (looking-at org-table-hline-regexp))
9179 (goto-char pos)
9180 (beginning-of-line 1)
9181 (setq pos (point))
9182 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9183 (delete-region (point) (1+ (point-at-eol)))
9184 (beginning-of-line tonew)
9185 (insert txt)
9186 (beginning-of-line 0)
9187 (move-to-column col)
9188 (unless (or hline1p hline2p)
9189 (org-table-fix-formulas
9190 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9191 (cons (number-to-string dline2) (number-to-string dline1)))))))
9193 (defun org-table-insert-row (&optional arg)
9194 "Insert a new row above the current line into the table.
9195 With prefix ARG, insert below the current line."
9196 (interactive "P")
9197 (if (not (org-at-table-p))
9198 (error "Not at a table"))
9199 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9200 (new (org-table-clean-line line)))
9201 ;; Fix the first field if necessary
9203 (setq new (replace-match (match-string 0 line) t t new)))
9204 (beginning-of-line (if arg 2 1))
9206 (beginning-of-line 0)
9207 (re-search-forward "| ?" (point-at-eol) t)
9208 (and (or org-table-may-need-update org-table-overlay-coordinates)
9209 (org-table-align))
9210 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9212 (defun org-table-insert-hline (&optional above)
9213 "Insert a horizontal-line below the current line into the table.
9214 With prefix ABOVE, insert above the current line."
9215 (interactive "P")
9216 (if (not (org-at-table-p))
9217 (error "Not at a table"))
9218 (let ((line (org-table-clean-line
9219 (buffer-substring (point-at-bol) (point-at-eol))))
9220 (col (current-column)))
9222 (setq line (replace-match
9223 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9224 ?-) "|") t t line)))
9226 (beginning-of-line (if above 1 2))
9228 (beginning-of-line (if above 1 -1))
9229 (move-to-column col)
9230 (and org-table-overlay-coordinates (org-table-align))))
9232 (defun org-table-hline-and-move (&optional same-column)
9233 "Insert a hline and move to the row below that line."
9234 (interactive "P")
9235 (let ((col (org-table-current-column)))
9236 (org-table-maybe-eval-formula)
9237 (org-table-maybe-recalculate-line)
9238 (org-table-insert-hline)
9239 (end-of-line 2)
9242 (org-table-next-field))
9243 (if same-column (org-table-goto-column col))))
9245 (defun org-table-clean-line (s)
9247 In particular, this does handle wide and invisible characters."
9249 ;; It's a hline, just map the characters
9250 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9252 (setq s (replace-match
9253 (concat "|" (make-string (org-string-width (match-string 1 s))
9254 ?\ ) "|")
9255 t t s)))
9256 s))
9258 (defun org-table-kill-row ()
9259 "Delete the current row or horizontal line from the table."
9260 (interactive)
9261 (if (not (org-at-table-p))
9262 (error "Not at a table"))
9263 (let ((col (current-column))
9264 (dline (org-table-current-dline)))
9265 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9266 (if (not (org-at-table-p)) (beginning-of-line 0))
9267 (move-to-column col)
9268 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9269 dline -1 dline)))
9271 (defun org-table-sort-lines (with-case &optional sorting-type)
9272 "Sort table lines according to the column at point.
9274 The position of point indicates the column to be used for
9275 sorting, and the range of lines is the range between the nearest
9276 horizontal separator lines, or the entire table of no such lines
9277 exist. If point is before the first column, you will be prompted
9278 for the sorting column. If there is an active region, the mark
9279 specifies the first line and the sorting column, while point
9280 should be in the last line to be included into the sorting.
9282 The command then prompts for the sorting type which can be
9283 alphabetically, numerically, or by time (as given in a time stamp
9284 in the field). Sorting in reverse order is also possible.
9286 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9288 If SORTING-TYPE is specified when this function is called from a Lisp
9289 program, no prompting will take place. SORTING-TYPE must be a character,
9290 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9291 should be done in reverse order."
9292 (interactive "P")
9293 (let* ((thisline (org-current-line))
9294 (thiscol (org-table-current-column))
9295 beg end bcol ecol tend tbeg column lns pos)
9296 (when (equal thiscol 0)
9297 (if (interactive-p)
9298 (setq thiscol
9299 (string-to-number
9300 (read-string "Use column N for sorting: ")))
9301 (setq thiscol 1))
9302 (org-table-goto-column thiscol))
9303 (org-table-check-inside-data-field)
9304 (if (org-region-active-p)
9305 (progn
9306 (setq beg (region-beginning) end (region-end))
9307 (goto-char beg)
9308 (setq column (org-table-current-column)
9309 beg (point-at-bol))
9310 (goto-char end)
9311 (setq end (point-at-bol 2)))
9312 (setq column (org-table-current-column)
9313 pos (point)
9314 tbeg (org-table-begin)
9315 tend (org-table-end))
9316 (if (re-search-backward org-table-hline-regexp tbeg t)
9317 (setq beg (point-at-bol 2))
9318 (goto-char tbeg)
9319 (setq beg (point-at-bol 1)))
9320 (goto-char pos)
9321 (if (re-search-forward org-table-hline-regexp tend t)
9322 (setq end (point-at-bol 1))
9323 (goto-char tend)
9324 (setq end (point-at-bol))))
9325 (setq beg (move-marker (make-marker) beg)
9326 end (move-marker (make-marker) end))
9327 (untabify beg end)
9328 (goto-char beg)
9329 (org-table-goto-column column)
9330 (skip-chars-backward "^|")
9331 (setq bcol (current-column))
9332 (org-table-goto-column (1+ column))
9333 (skip-chars-backward "^|")
9334 (setq ecol (1- (current-column)))
9335 (org-table-goto-column column)
9336 (setq lns (mapcar (lambda(x) (cons
9337 (org-sort-remove-invisible
9338 (nth (1- column)
9340 x))
9342 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9343 (delete-region beg end)
9344 (move-marker beg nil)
9345 (move-marker end nil)
9347 (goto-line thisline)
9348 (org-table-goto-column thiscol)
9349 (message "%d lines sorted, based on column %d" (length lns) column)))
9351 ;; FIXME: maybe we will not need this? Table sorting is broken....
9352 (defun org-sort-remove-invisible (s)
9353 (remove-text-properties 0 (length s) org-rm-props s)
9354 (while (string-match org-bracket-link-regexp s)
9355 (setq s (replace-match (if (match-end 2)
9356 (match-string 3 s)
9357 (match-string 1 s)) t t s)))
9358 s)
9360 (defun org-table-cut-region (beg end)
9361 "Copy region in table to the clipboard and blank all relevant fields."
9362 (interactive "r")
9363 (org-table-copy-region beg end 'cut))
9365 (defun org-table-copy-region (beg end &optional cut)
9366 "Copy rectangular region in table to clipboard.
9367 A special clipboard is used which can only be accessed
9368 with `org-table-paste-rectangle'."
9369 (interactive "rP")
9370 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9371 region cols
9372 (rpl (if cut " " nil)))
9373 (goto-char beg)
9374 (org-table-check-inside-data-field)
9375 (setq l01 (org-current-line)
9376 c01 (org-table-current-column))
9377 (goto-char end)
9378 (org-table-check-inside-data-field)
9379 (setq l02 (org-current-line)
9380 c02 (org-table-current-column))
9381 (setq l1 (min l01 l02) l2 (max l01 l02)
9382 c1 (min c01 c02) c2 (max c01 c02))
9383 (catch 'exit
9384 (while t
9385 (catch 'nextline
9386 (if (> l1 l2) (throw 'exit t))
9387 (goto-line l1)
9388 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9389 (setq cols nil ic1 c1 ic2 c2)
9390 (while (< ic1 (1+ ic2))
9391 (push (org-table-get-field ic1 rpl) cols)
9392 (setq ic1 (1+ ic1)))
9393 (push (nreverse cols) region)
9394 (setq l1 (1+ l1)))))
9395 (setq org-table-clip (nreverse region))
9396 (if cut (org-table-align))
9397 org-table-clip))
9399 (defun org-table-paste-rectangle ()
9400 "Paste a rectangular region into a table.
9401 The upper right corner ends up in the current field. All involved fields
9402 will be overwritten. If the rectangle does not fit into the present table,
9403 the table is enlarged as needed. The process ignores horizontal separator
9404 lines."
9405 (interactive)
9406 (unless (and org-table-clip (listp org-table-clip))
9407 (error "First cut/copy a region to paste!"))
9408 (org-table-check-inside-data-field)
9409 (let* ((clip org-table-clip)
9410 (line (org-current-line))
9411 (col (org-table-current-column))
9412 (org-enable-table-editor t)
9413 (org-table-automatic-realign nil)
9414 c cols field)
9415 (while (setq cols (pop clip))
9416 (while (org-at-table-hline-p) (beginning-of-line 2))
9417 (if (not (org-at-table-p))
9418 (progn (end-of-line 0) (org-table-next-field)))
9419 (setq c col)
9420 (while (setq field (pop cols))
9421 (org-table-goto-column c nil 'force)
9422 (org-table-get-field nil field)
9423 (setq c (1+ c)))
9424 (beginning-of-line 2))
9425 (goto-line line)
9426 (org-table-goto-column col)
9427 (org-table-align)))
9429 (defun org-table-convert ()
9430 "Convert from `org-mode' table to table.el and back.
9431 Obviously, this only works within limits. When an Org-mode table is
9432 converted to table.el, all horizontal separator lines get lost, because
9433 table.el uses these as cell boundaries and has no notion of horizontal lines.
9434 A table.el table can be converted to an Org-mode table only if it does not
9435 do row or column spanning. Multiline cells will become multiple cells.
9436 Beware, Org-mode does not test if the table can be successfully converted - it
9437 blindly applies a recipe that works for simple tables."
9438 (interactive)
9439 (require 'table)
9440 (if (org-at-table.el-p)
9441 ;; convert to Org-mode table
9442 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9443 (end (move-marker (make-marker) (org-table-end t))))
9444 (table-unrecognize-region beg end)
9445 (goto-char beg)
9447 (replace-match ""))
9448 (goto-char beg))
9449 (if (org-at-table-p)
9450 ;; convert to table.el table
9451 (let ((beg (move-marker (make-marker) (org-table-begin)))
9452 (end (move-marker (make-marker) (org-table-end))))
9453 ;; first, get rid of all horizontal lines
9454 (goto-char beg)
9456 (replace-match ""))
9457 ;; insert a hline before first
9458 (goto-char beg)
9459 (org-table-insert-hline 'above)
9460 (beginning-of-line -1)
9461 ;; insert a hline after each line
9462 (while (progn (beginning-of-line 3) (< (point) end))
9463 (org-table-insert-hline))
9464 (goto-char beg)
9465 (setq end (move-marker end (org-table-end)))
9466 ;; replace "+" at beginning and ending of hlines
9469 (goto-char beg)
9471 (replace-match "-+"))
9472 (goto-char beg)))))
9474 (defun org-table-wrap-region (arg)
9475 "Wrap several fields in a column like a paragraph.
9476 This is useful if you'd like to spread the contents of a field over several
9477 lines, in order to keep the table compact.
9479 If there is an active region, and both point and mark are in the same column,
9480 the text in the column is wrapped to minimum width for the given number of
9481 lines. Generally, this makes the table more compact. A prefix ARG may be
9483 formats the selected text to two lines. If the region was longer than two
9484 lines, the remaining lines remain empty. A negative prefix argument reduces
9485 the current number of lines by that amount. The wrapped text is pasted back
9486 into the table. If you formatted it to more lines than it was before, fields
9487 further down in the table get overwritten - so you might need to make space in
9488 the table first.
9490 If there is no region, the current field is split at the cursor position and
9491 the text fragment to the right of the cursor is prepended to the field one
9492 line down.
9494 If there is no region, but you specify a prefix ARG, the current field gets
9495 blank, and the content is appended to the field above."
9496 (interactive "P")
9497 (org-table-check-inside-data-field)
9498 (if (org-region-active-p)
9499 ;; There is a region: fill as a paragraph
9500 (let* ((beg (region-beginning))
9501 (cline (save-excursion (goto-char beg) (org-current-line)))
9502 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9503 nlines)
9504 (org-table-cut-region (region-beginning) (region-end))
9505 (if (> (length (car org-table-clip)) 1)
9506 (error "Region must be limited to single column"))
9507 (setq nlines (if arg
9508 (if (< arg 1)
9509 (+ (length org-table-clip) arg)
9510 arg)
9511 (length org-table-clip)))
9512 (setq org-table-clip
9513 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9514 nil nlines)))
9515 (goto-line cline)
9516 (org-table-goto-column ccol)
9517 (org-table-paste-rectangle))
9518 ;; No region, split the current field at point
9519 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
9521 (if arg
9522 ;; combine with field above
9523 (let ((s (org-table-blank-field))
9524 (col (org-table-current-column)))
9525 (beginning-of-line 0)
9526 (while (org-at-table-hline-p) (beginning-of-line 0))
9527 (org-table-goto-column col)
9528 (skip-chars-forward "^|")
9529 (skip-chars-backward " ")
9530 (insert " " (org-trim s))
9531 (org-table-align))
9532 ;; split field
9534 (let ((s (match-string 1)))
9535 (replace-match " |")
9536 (goto-char (match-beginning 0))
9537 (org-table-next-row)
9538 (insert (org-trim s) " ")
9539 (org-table-align))
9540 (org-table-next-row)))))
9542 (defvar org-field-marker nil)
9544 (defun org-table-edit-field (arg)
9545 "Edit table field in a different window.
9546 This is mainly useful for fields that contain hidden parts.
9548 it can be edited in place."
9549 (interactive "P")
9550 (if arg
9551 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9553 (remove-text-properties b e '(org-cwidth t invisible t
9554 display t intangible t))
9555 (if (and (boundp 'font-lock-mode) font-lock-mode)
9556 (font-lock-fontify-block)))
9557 (let ((pos (move-marker (make-marker) (point)))
9558 (field (org-table-get-field))
9559 (cw (current-window-configuration))
9560 p)
9561 (org-switch-to-buffer-other-window "*Org tmp*")
9562 (erase-buffer)
9564 (let ((org-inhibit-startup t)) (org-mode))
9565 (goto-char (setq p (point-max)))
9566 (insert (org-trim field))
9567 (remove-text-properties p (point-max)
9568 '(invisible t org-cwidth t display t
9569 intangible t))
9570 (goto-char p)
9571 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9572 (org-set-local 'org-window-configuration cw)
9573 (org-set-local 'org-field-marker pos)
9574 (message "Edit and finish with C-c C-c"))))
9576 (defun org-table-finish-edit-field ()
9577 "Finish editing a table data field.
9578 Remove all newline characters, insert the result into the table, realign
9579 the table and kill the editing buffer."
9580 (let ((pos org-field-marker)
9581 (cw org-window-configuration)
9582 (cb (current-buffer))
9583 text)
9584 (goto-char (point-min))
9587 (replace-match " "))
9588 (setq text (org-trim (buffer-string)))
9589 (set-window-configuration cw)
9590 (kill-buffer cb)
9591 (select-window (get-buffer-window (marker-buffer pos)))
9592 (goto-char pos)
9593 (move-marker pos nil)
9594 (org-table-check-inside-data-field)
9595 (org-table-get-field nil text)
9596 (org-table-align)
9597 (message "New field value inserted")))
9599 (defun org-trim (s)
9600 "Remove whitespace at beginning and end of string."
9603 s)
9605 (defun org-wrap (string &optional width lines)
9606 "Wrap string to either a number of lines, or a width in characters.
9607 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9608 that costs. If there is a word longer than WIDTH, the text is actually
9609 wrapped to the length of that word.
9610 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9611 many lines, whatever width that takes.
9612 The return value is a list of lines, without newlines at the end."
9614 (maxword (apply 'max (mapcar 'org-string-width words)))
9615 w ll)
9616 (cond (width
9617 (org-do-wrap words (max maxword width)))
9618 (lines
9619 (setq w maxword)
9620 (setq ll (org-do-wrap words maxword))
9621 (if (<= (length ll) lines)
9622 ll
9623 (setq ll words)
9624 (while (> (length ll) lines)
9625 (setq w (1+ w))
9626 (setq ll (org-do-wrap words w)))
9627 ll))
9628 (t (error "Cannot wrap this")))))
9631 (defun org-do-wrap (words width)
9632 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9633 (let (lines line)
9634 (while words
9635 (setq line (pop words))
9636 (while (and words (< (+ (length line) (length (car words))) width))
9637 (setq line (concat line " " (pop words))))
9638 (setq lines (push line lines)))
9639 (nreverse lines)))
9641 (defun org-split-string (string &optional separators)
9642 "Splits STRING into substrings at SEPARATORS.
9643 No empty strings are returned if there are matches at the beginning
9644 and end of string."
9646 (start 0)
9647 notfirst
9648 (list nil))
9649 (while (and (string-match rexp string
9650 (if (and notfirst
9651 (= start (match-beginning 0))
9652 (< start (length string)))
9653 (1+ start) start))
9654 (< (match-beginning 0) (length string)))
9655 (setq notfirst t)
9656 (or (eq (match-beginning 0) 0)
9657 (and (eq (match-beginning 0) (match-end 0))
9658 (eq (match-beginning 0) start))
9659 (setq list
9660 (cons (substring string start (match-beginning 0))
9661 list)))
9662 (setq start (match-end 0)))
9663 (or (eq start (length string))
9664 (setq list
9665 (cons (substring string start)
9666 list)))
9667 (nreverse list)))
9669 (defun org-table-map-tables (function)
9670 "Apply FUNCTION to the start of all tables in the buffer."
9671 (save-excursion
9672 (save-restriction
9673 (widen)
9674 (goto-char (point-min))
9675 (while (re-search-forward org-table-any-line-regexp nil t)
9676 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9677 (beginning-of-line 1)
9678 (if (looking-at org-table-line-regexp)
9679 (save-excursion (funcall function)))
9680 (re-search-forward org-table-any-border-regexp nil 1))))
9681 (message "Mapping tables: done"))
9683 (defvar org-timecnt) ; dynamically scoped parameter
9685 (defun org-table-sum (&optional beg end nlast)
9686 "Sum numbers in region of current table column.
9687 The result will be displayed in the echo area, and will be available
9690 If there is an active region, it is interpreted as a rectangle and all
9691 numbers in that rectangle will be summed. If there is no active
9692 region and point is located in a table column, sum all numbers in that
9693 column.
9695 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9696 numbers are assumed to be times as well (in decimal hours) and the
9697 numbers are added as such.
9699 If NLAST is a number, only the NLAST fields will actually be summed."
9700 (interactive)
9701 (save-excursion
9702 (let (col (org-timecnt 0) diff h m s org-table-clip)
9703 (cond
9704 ((and beg end)) ; beg and end given explicitly
9705 ((org-region-active-p)
9706 (setq beg (region-beginning) end (region-end)))
9707 (t
9708 (setq col (org-table-current-column))
9709 (goto-char (org-table-begin))
9711 (error "No table data"))
9712 (org-table-goto-column col)
9713 (setq beg (point))
9714 (goto-char (org-table-end))
9716 (error "No table data"))
9717 (org-table-goto-column col)
9718 (setq end (point))))
9719 (let* ((items (apply 'append (org-table-copy-region beg end)))
9720 (items1 (cond ((not nlast) items)
9721 ((>= nlast (length items)) items)
9722 (t (setq items (reverse items))
9723 (setcdr (nthcdr (1- nlast) items) nil)
9724 (nreverse items))))
9725 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9726 items1)))
9727 (res (apply '+ numbers))
9728 (sres (if (= org-timecnt 0)
9729 (format "%g" res)
9730 (setq diff (* 3600 res)
9731 h (floor (/ diff 3600)) diff (mod diff 3600)
9732 m (floor (/ diff 60)) diff (mod diff 60)
9733 s diff)
9734 (format "%d:%02d:%02d" h m s))))
9735 (kill-new sres)
9736 (if (interactive-p)
9737 (message "%s"
9738 (substitute-command-keys
9740 (length numbers) sres))))
9741 sres))))
9743 (defun org-table-get-number-for-summing (s)
9744 (let (n)
9745 (if (string-match "^ *|? *" s)
9746 (setq s (replace-match "" nil nil s)))
9747 (if (string-match " *|? *$" s)
9748 (setq s (replace-match "" nil nil s)))
9749 (setq n (string-to-number s))
9750 (cond
9751 ((and (string-match "0" s)
9755 (let ((h (string-to-number (or (match-string 1 s) "0")))
9756 (m (string-to-number (or (match-string 2 s) "0")))
9757 (s (string-to-number (or (match-string 4 s) "0"))))
9758 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9759 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9760 ((equal n 0) nil)
9761 (t n))))
9763 (defun org-table-current-field-formula (&optional key noerror)
9764 "Return the formula active for the current field.
9765 Assumes that specials are in place.
9766 If KEY is given, return the key to this formula.
9768 (let* ((name (car (rassoc (list (org-current-line)
9769 (org-table-current-column))
9770 org-table-named-field-locations)))
9771 (col (org-table-current-column))
9772 (scol (int-to-string col))
9773 (ref (format "@%d$%d" (org-table-current-dline) col))
9774 (stored-list (org-table-get-stored-formulas noerror))
9775 (ass (or (assoc name stored-list)
9776 (assoc ref stored-list)
9777 (assoc scol stored-list))))
9778 (if key
9779 (car ass)
9780 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9781 (cdr ass))))))
9783 (defun org-table-get-formula (&optional equation named)
9784 "Read a formula from the minibuffer, offer stored formula as default.
9785 When NAMED is non-nil, look for a named equation."
9786 (let* ((stored-list (org-table-get-stored-formulas))
9787 (name (car (rassoc (list (org-current-line)
9788 (org-table-current-column))
9789 org-table-named-field-locations)))
9790 (ref (format "@%d$%d" (org-table-current-dline)
9791 (org-table-current-column)))
9792 (refass (assoc ref stored-list))
9793 (scol (if named
9794 (if name name ref)
9795 (int-to-string (org-table-current-column))))
9796 (dummy (and (or name refass) (not named)
9797 (not (y-or-n-p "Replace field formula with column formula? " ))
9798 (error "Abort")))
9799 (name (or name ref))
9800 (org-table-may-need-update nil)
9801 (stored (cdr (assoc scol stored-list)))
9802 (eq (cond
9803 ((and stored equation (string-match "^ *=? *$" equation))
9804 stored)
9805 ((stringp equation)
9806 equation)
9807 (t (org-table-formula-from-user
9808 (read-string
9809 (org-table-formula-to-user
9810 (format "%s formula %s%s="
9811 (if named "Field" "Column")
9812 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9813 scol))
9814 (if stored (org-table-formula-to-user stored) "")
9815 'org-table-formula-history
9816 )))))
9817 mustsave)
9819 ;; remove formula
9820 (setq stored-list (delq (assoc scol stored-list) stored-list))
9821 (org-table-store-formulas stored-list)
9822 (error "Formula removed"))
9823 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9824 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9825 (if (and name (not named))
9826 ;; We set the column equation, delete the named one.
9827 (setq stored-list (delq (assoc name stored-list) stored-list)
9828 mustsave t))
9829 (if stored
9830 (setcdr (assoc scol stored-list) eq)
9831 (setq stored-list (cons (cons scol eq) stored-list)))
9832 (if (or mustsave (not (equal stored eq)))
9833 (org-table-store-formulas stored-list))
9834 eq))
9836 (defun org-table-store-formulas (alist)
9837 "Store the list of formulas below the current table."
9838 (setq alist (sort alist 'org-table-formula-less-p))
9839 (save-excursion
9840 (goto-char (org-table-end))
9842 (progn
9843 ;; don't overwrite TBLFM, we might use text properties to store stuff
9844 (goto-char (match-beginning 2))
9845 (delete-region (match-beginning 2) (match-end 0)))
9846 (insert "#+TBLFM:"))
9847 (insert " "
9848 (mapconcat (lambda (x)
9849 (concat
9850 (if (equal (string-to-char (car x)) ?@) "" "$")
9851 (car x) "=" (cdr x)))
9852 alist "::")
9855 (defsubst org-table-formula-make-cmp-string (a)
9857 (concat
9858 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9859 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9860 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9862 (defun org-table-formula-less-p (a b)
9863 "Compare two formulas for sorting."
9864 (let ((as (org-table-formula-make-cmp-string (car a)))
9865 (bs (org-table-formula-make-cmp-string (car b))))
9866 (and as bs (string< as bs))))
9868 (defun org-table-get-stored-formulas (&optional noerror)
9869 "Return an alist with the stored formulas directly after current table."
9870 (interactive)
9871 (let (scol eq eq-alist strings string seen)
9872 (save-excursion
9873 (goto-char (org-table-end))
9875 (setq strings (org-split-string (match-string 2) " *:: *"))
9876 (while (setq string (pop strings))
9877 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9878 (setq scol (if (match-end 2)
9879 (match-string 2 string)
9880 (match-string 1 string))
9881 eq (match-string 3 string)
9882 eq-alist (cons (cons scol eq) eq-alist))
9883 (if (member scol seen)
9884 (if noerror
9885 (progn
9886 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9887 (ding)
9888 (sit-for 2))
9889 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9890 (push scol seen))))))
9891 (nreverse eq-alist)))
9893 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9894 "Modify the equations after the table structure has been edited.
9896 For all numbers larger than LIMIT, shift them by DELTA."
9897 (save-excursion
9898 (goto-char (org-table-end))
9901 (re2
9902 (when remove
9903 (if (equal key "$")
9906 s n a)
9907 (when remove
9908 (while (re-search-forward re2 (point-at-eol) t)
9909 (replace-match "")))
9910 (while (re-search-forward re (point-at-eol) t)
9911 (setq s (match-string 1) n (string-to-number s))
9912 (cond
9913 ((setq a (assoc s replace))
9914 (replace-match (concat key (cdr a)) t t))
9915 ((and limit (> n limit))
9916 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9918 (defun org-table-get-specials ()
9919 "Get the column names and local parameters for this table."
9920 (save-excursion
9921 (let ((beg (org-table-begin)) (end (org-table-end))
9922 names name fields fields1 field cnt
9923 c v l line col types dlines hlines)
9924 (setq org-table-column-names nil
9925 org-table-local-parameters nil
9926 org-table-named-field-locations nil
9927 org-table-current-begin-line nil
9928 org-table-current-begin-pos nil
9929 org-table-current-line-types nil)
9930 (goto-char beg)
9932 (setq names (org-split-string (match-string 1) " *| *")
9933 cnt 1)
9934 (while (setq name (pop names))
9935 (setq cnt (1+ cnt))
9936 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9937 (push (cons name (int-to-string cnt)) org-table-column-names))))
9938 (setq org-table-column-names (nreverse org-table-column-names))
9939 (setq org-table-column-name-regexp
9941 (goto-char beg)
9943 (setq fields (org-split-string (match-string 1) " *| *"))
9944 (while (setq field (pop fields))
9946 (push (cons (match-string 1 field) (match-string 2 field))
9947 org-table-local-parameters))))
9948 (goto-char beg)
9950 (setq c (match-string 1)
9951 fields (org-split-string (match-string 2) " *| *"))
9952 (save-excursion
9953 (beginning-of-line (if (equal c "_") 2 0))
9954 (setq line (org-current-line) col 1)
9956 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9957 (while (and fields1 (setq field (pop fields)))
9958 (setq v (pop fields1) col (1+ col))
9959 (when (and (stringp field) (stringp v)
9960 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9961 (push (cons field v) org-table-local-parameters)
9962 (push (list field line col) org-table-named-field-locations))))
9963 ;; Analyse the line types
9964 (goto-char beg)
9965 (setq org-table-current-begin-line (org-current-line)
9966 org-table-current-begin-pos (point)
9967 l org-table-current-begin-line)
9969 (push (if (match-end 1) 'hline 'dline) types)
9970 (if (match-end 1) (push l hlines) (push l dlines))
9971 (beginning-of-line 2)
9972 (setq l (1+ l)))
9973 (setq org-table-current-line-types (apply 'vector (nreverse types))
9974 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9975 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9977 (defun org-table-maybe-eval-formula ()
9979 If yes, store the formula and apply it."
9980 ;; We already know we are in a table. Get field will only return a formula
9981 ;; when appropriate. It might return a separator line, but no problem.
9982 (when org-table-formula-evaluate-inline
9983 (let* ((field (org-trim (or (org-table-get-field) "")))
9984 named eq)
9986 (setq named (equal (string-to-char field) ?:)
9987 eq (match-string 1 field))
9988 (if (or (fboundp 'calc-eval)
9989 (equal (substring eq 0 (min 2 (length eq))) "'("))
9990 (org-table-eval-formula (if named '(4) nil)
9991 (org-table-formula-from-user eq))
9992 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9994 (defvar org-recalc-commands nil
9995 "List of commands triggering the recalculation of a line.
9996 Will be filled automatically during use.")
9998 (defvar org-recalc-marks
9999 '((" " . "Unmarked: no special line, no automatic recalculation")
10000 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
10001 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
10002 ("!" . "Column name definition line. Reference in formula as $name.")
10003 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
10004 ("_" . "Names for values in row below this one.")
10005 ("^" . "Names for values in row above this one.")))
10007 (defun org-table-rotate-recalc-marks (&optional newchar)
10008 "Rotate the recalculation mark in the first column.
10009 If in any row, the first field is not consistent with a mark,
10010 insert a new column for the markers.
10011 When there is an active region, change all the lines in the region,
10012 after prompting for the marking character.
10013 After each change, a message will be displayed indicating the meaning
10014 of the new mark."
10015 (interactive)
10016 (unless (org-at-table-p) (error "Not at a table"))
10017 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
10018 (beg (org-table-begin))
10019 (end (org-table-end))
10020 (l (org-current-line))
10021 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
10022 (l2 (if (org-region-active-p) (org-current-line (region-end))))
10023 (have-col
10024 (save-excursion
10025 (goto-char beg)
10027 (col (org-table-current-column))
10028 (forcenew (car (assoc newchar org-recalc-marks)))
10029 epos new)
10030 (when l1
10031 (message "Change region to what mark? Type # * ! $ or SPC: ")
10032 (setq newchar (char-to-string (read-char-exclusive))
10033 forcenew (car (assoc newchar org-recalc-marks))))
10034 (if (and newchar (not forcenew))
10035 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
10036 newchar))
10037 (if l1 (goto-line l1))
10038 (save-excursion
10039 (beginning-of-line 1)
10040 (unless (looking-at org-table-dataline-regexp)
10041 (error "Not at a table data line")))
10042 (unless have-col
10043 (org-table-goto-column 1)
10044 (org-table-insert-column)
10045 (org-table-goto-column (1+ col)))
10046 (setq epos (point-at-eol))
10047 (save-excursion
10048 (beginning-of-line 1)
10049 (org-table-get-field
10051 (concat " "
10052 (setq new (or forcenew
10053 (cadr (member (match-string 1) marks))))
10054 " ")
10055 " # ")))
10056 (if (and l1 l2)
10057 (progn
10058 (goto-line l1)
10059 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
10060 (and (looking-at org-table-dataline-regexp)
10061 (org-table-get-field 1 (concat " " new " "))))
10062 (goto-line l1)))
10063 (if (not (= epos (point-at-eol))) (org-table-align))
10064 (goto-line l)
10065 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10067 (defun org-table-maybe-recalculate-line ()
10068 "Recompute the current line if marked for it, and if we haven't just done it."
10069 (interactive)
10070 (and org-table-allow-automatic-line-recalculation
10071 (not (and (memq last-command org-recalc-commands)
10072 (equal org-last-recalc-line (org-current-line))))
10073 (save-excursion (beginning-of-line 1)
10074 (looking-at org-table-auto-recalculate-regexp))
10075 (org-table-recalculate) t))
10077 (defvar org-table-formula-debug nil
10078 "Non-nil means, debug table formulas.
10080 (make-variable-buffer-local 'org-table-formula-debug)
10082 (defvar modes)
10083 (defsubst org-set-calc-mode (var &optional value)
10084 (if (stringp var)
10085 (setq var (assoc var '(("D" calc-angle-mode deg)
10086 ("R" calc-angle-mode rad)
10087 ("F" calc-prefer-frac t)
10088 ("S" calc-symbolic-mode t)))
10089 value (nth 2 var) var (nth 1 var)))
10090 (if (memq var modes)
10091 (setcar (cdr (memq var modes)) value)
10092 (cons var (cons value modes)))
10093 modes)
10095 (defun org-table-eval-formula (&optional arg equation
10096 suppress-align suppress-const
10097 suppress-store suppress-analysis)
10098 "Replace the table field value at the cursor by the result of a calculation.
10100 This function makes use of Dave Gillespie's Calc package, in my view the
10101 most exciting program ever written for GNU Emacs. So you need to have Calc
10102 installed in order to use this function.
10104 In a table, this command replaces the value in the current field with the
10106 formula, by storing it in a special line below the table. When called
10107 with a `C-u' prefix, the current field must ba a named field, and the
10108 formula is installed as valid in only this specific field.
10110 When called with two `C-u' prefixes, insert the active equation
10111 for the field back into the current field, so that it can be
10113 to check the referenced fields.
10115 When called, the command first prompts for a formula, which is read in
10116 the minibuffer. Previously entered formulas are available through the
10117 history list, and the last used formula is offered as a default.
10118 These stored formulas are adapted correctly when moving, inserting, or
10119 deleting columns with the corresponding commands.
10121 The formula can be any algebraic expression understood by the Calc package.
10122 For details, see the Org-mode manual.
10124 This function can also be called from Lisp programs and offers
10125 additional arguments: EQUATION can be the formula to apply. If this
10126 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10127 used to speed-up recursive calls by by-passing unnecessary aligns.
10128 SUPPRESS-CONST suppresses the interpretation of constants in the
10129 formula, assuming that this has been done already outside the function.
10130 SUPPRESS-STORE means the formula should not be stored, either because
10131 it is already stored, or because it is a modified equation that should
10132 not overwrite the stored one."
10133 (interactive "P")
10134 (org-table-check-inside-data-field)
10135 (or suppress-analysis (org-table-get-specials))
10136 (if (equal arg '(16))
10137 (let ((eq (org-table-current-field-formula)))
10138 (or eq (error "No equation active for current field"))
10139 (org-table-get-field nil eq)
10140 (org-table-align)
10141 (setq org-table-may-need-update t))
10142 (let* (fields
10143 (ndown (if (integerp arg) arg 1))
10144 (org-table-automatic-realign nil)
10145 (case-fold-search nil)
10146 (down (> ndown 1))
10147 (formula (if (and equation suppress-store)
10148 equation
10149 (org-table-get-formula equation (equal arg '(4)))))
10150 (n0 (org-table-current-column))
10151 (modes (copy-sequence org-calc-default-modes))
10152 (numbers nil) ; was a variable, now fixed default
10153 (keep-empty nil)
10154 n form form0 bw fmt x ev orig c lispp literal)
10155 ;; Parse the format string. Since we have a lot of modes, this is
10156 ;; a lot of work. However, I think calc still uses most of the time.
10157 (if (string-match ";" formula)
10158 (let ((tmp (org-split-string formula ";")))
10159 (setq formula (car tmp)
10160 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10161 (nth 1 tmp)))
10163 (setq c (string-to-char (match-string 1 fmt))
10164 n (string-to-number (match-string 2 fmt)))
10165 (if (= c ?p)
10166 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10167 (setq modes (org-set-calc-mode
10168 'calc-float-format
10169 (list (cdr (assoc c '((?n . float) (?f . fix)
10170 (?s . sci) (?e . eng))))
10171 n))))
10172 (setq fmt (replace-match "" t t fmt)))
10173 (if (string-match "[NT]" fmt)
10174 (setq numbers (equal (match-string 0 fmt) "N")
10175 fmt (replace-match "" t t fmt)))
10176 (if (string-match "L" fmt)
10177 (setq literal t
10178 fmt (replace-match "" t t fmt)))
10179 (if (string-match "E" fmt)
10180 (setq keep-empty t
10181 fmt (replace-match "" t t fmt)))
10182 (while (string-match "[DRFS]" fmt)
10183 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10184 (setq fmt (replace-match "" t t fmt)))
10186 (setq fmt nil))))
10187 (if (and (not suppress-const) org-table-formula-use-constants)
10188 (setq formula (org-table-formula-substitute-names formula)))
10189 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10190 (while (> ndown 0)
10191 (setq fields (org-split-string
10192 (org-no-properties
10193 (buffer-substring (point-at-bol) (point-at-eol)))
10194 " *| *"))
10195 (if (eq numbers t)
10196 (setq fields (mapcar
10197 (lambda (x) (number-to-string (string-to-number x)))
10198 fields)))
10199 (setq ndown (1- ndown))
10200 (setq form (copy-sequence formula)
10201 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10202 (if (and lispp literal) (setq lispp 'literal))
10203 ;; Check for old vertical references
10204 (setq form (org-rewrite-old-row-references form))
10205 ;; Insert complex ranges
10206 (while (string-match org-table-range-regexp form)
10207 (setq form
10208 (replace-match
10209 (save-match-data
10210 (org-table-make-reference
10211 (org-table-get-range (match-string 0 form) nil n0)
10212 keep-empty numbers lispp))
10213 t t form)))
10214 ;; Insert simple ranges
10216 (setq form
10217 (replace-match
10218 (save-match-data
10219 (org-table-make-reference
10220 (org-sublist
10221 fields (string-to-number (match-string 1 form))
10222 (string-to-number (match-string 2 form)))
10223 keep-empty numbers lispp))
10224 t t form)))
10225 (setq form0 form)
10226 ;; Insert the references to fields in same row
10228 (setq n (string-to-number (match-string 1 form))
10229 x (nth (1- (if (= n 0) n0 n)) fields))
10231 (match-string 0 form)))
10232 (setq form (replace-match
10233 (save-match-data
10234 (org-table-make-reference x nil numbers lispp))
10235 t t form)))
10237 (if lispp
10238 (setq ev (condition-case nil
10239 (eval (eval (read form)))
10240 (error "#ERROR"))
10241 ev (if (numberp ev) (number-to-string ev) ev))
10242 (or (fboundp 'calc-eval)
10243 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10244 (setq ev (calc-eval (cons form modes)
10245 (if numbers 'num))))
10247 (when org-table-formula-debug
10248 (with-output-to-temp-buffer "*Substitution History*"
10249 (princ (format "Substitution history of formula
10250 Orig: %s
10251 $xyz-> %s
10252 @r$c-> %s
10254 (if (listp ev)
10256 (make-string (car ev) ?\-) (nth 1 ev)))
10258 ev (or fmt "NONE")
10259 (if fmt (format fmt (string-to-number ev)) ev)))))
10260 (setq bw (get-buffer-window "*Substitution History*"))
10261 (shrink-window-if-larger-than-buffer bw)
10262 (unless (and (interactive-p) (not ndown))
10263 (unless (let (inhibit-redisplay)
10264 (y-or-n-p "Debugging Formula. Continue to next? "))
10265 (org-table-align)
10266 (error "Abort"))
10267 (delete-window bw)
10268 (message "")))
10269 (if (listp ev) (setq fmt nil ev "#ERROR"))
10270 (org-table-justify-field-maybe
10271 (if fmt (format fmt (string-to-number ev)) ev))
10273 (call-interactively 'org-return)
10274 (setq ndown 0)))
10275 (and down (org-table-maybe-recalculate-line))
10276 (or suppress-align (and org-table-may-need-update
10277 (org-table-align))))))
10279 (defun org-table-put-field-property (prop value)
10280 (save-excursion
10281 (put-text-property (progn (skip-chars-backward "^|") (point))
10282 (progn (skip-chars-forward "^|") (point))
10283 prop value)))
10285 (defun org-table-get-range (desc &optional tbeg col highlight)
10286 "Get a calc vector from a column, accorting to descriptor DESC.
10287 Optional arguments TBEG and COL can give the beginning of the table and
10288 the current column, to avoid unnecessary parsing.
10289 HIGHLIGHT means, just highlight the range."
10290 (if (not (equal (string-to-char desc) ?@))
10291 (setq desc (concat "@" desc)))
10292 (save-excursion
10293 (or tbeg (setq tbeg (org-table-begin)))
10294 (or col (setq col (org-table-current-column)))
10295 (let ((thisline (org-current-line))
10296 beg end c1 c2 r1 r2 rangep tmp)
10297 (unless (string-match org-table-range-regexp desc)
10298 (error "Invalid table range specifier `%s'" desc))
10299 (setq rangep (match-end 3)
10300 r1 (and (match-end 1) (match-string 1 desc))
10301 r2 (and (match-end 4) (match-string 4 desc))
10302 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10303 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10305 (and c1 (setq c1 (+ (string-to-number c1)
10306 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10307 (and c2 (setq c2 (+ (string-to-number c2)
10308 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10309 (if (equal r1 "") (setq r1 nil))
10310 (if (equal r2 "") (setq r2 nil))
10311 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10312 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10313 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10314 (if (not r1) (setq r1 thisline))
10315 (if (not r2) (setq r2 thisline))
10316 (if (not c1) (setq c1 col))
10317 (if (not c2) (setq c2 col))
10318 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10319 ;; just one field
10320 (progn
10321 (goto-line r1)
10322 (while (not (looking-at org-table-dataline-regexp))
10323 (beginning-of-line 2))
10324 (prog1 (org-trim (org-table-get-field c1))
10325 (if highlight (org-table-highlight-rectangle (point) (point)))))
10326 ;; A range, return a vector
10327 ;; First sort the numbers to get a regular ractangle
10328 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10329 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10330 (goto-line r1)
10331 (while (not (looking-at org-table-dataline-regexp))
10332 (beginning-of-line 2))
10333 (org-table-goto-column c1)
10334 (setq beg (point))
10335 (goto-line r2)
10336 (while (not (looking-at org-table-dataline-regexp))
10337 (beginning-of-line 0))
10338 (org-table-goto-column c2)
10339 (setq end (point))
10340 (if highlight
10341 (org-table-highlight-rectangle
10343 ;; return string representation of calc vector
10344 (mapcar 'org-trim
10345 (apply 'append (org-table-copy-region beg end)))))))
10347 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10348 "Analyze descriptor DESC and retrieve the corresponding line number.
10349 The cursor is currently in line CLINE, the table begins in line BLINE,
10350 and TABLE is a vector with line types."
10351 (if (string-match "^[0-9]+$" desc)
10352 (aref org-table-dlines (string-to-number desc))
10353 (setq cline (or cline (org-current-line))
10354 bline (or bline org-table-current-begin-line)
10355 table (or table org-table-current-line-types))
10356 (if (or
10358 ;; 1 2 3 4 5 6
10359 (and (not (match-end 3)) (not (match-end 6)))
10360 (and (match-end 3) (match-end 6) (not (match-end 5))))
10361 (error "invalid row descriptor `%s'" desc))
10362 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10363 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10364 (odir (and (match-end 5) (match-string 5 desc)))
10365 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10366 (i (- cline bline))
10367 (rel (and (match-end 6)
10368 (or (and (match-end 1) (not (match-end 3)))
10369 (match-end 5)))))
10370 (if (and hn (not hdir))
10371 (progn
10372 (setq i 0 hdir "+")
10373 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10374 (if (and (not hn) on (not odir))
10375 (error "should never happen");;(aref org-table-dlines on)
10376 (if (and hn (> hn 0))
10377 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10378 (if on
10379 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10380 (+ bline i)))))
10382 (defun org-find-row-type (table i type backwards relative n)
10383 (let ((l (length table)))
10384 (while (> n 0)
10385 (while (and (setq i (+ i (if backwards -1 1)))
10386 (>= i 0) (< i l)
10387 (not (eq (aref table i) type))
10388 (if (and relative (eq (aref table i) 'hline))
10389 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10390 t)))
10391 (setq n (1- n)))
10392 (if (or (< i 0) (>= i l))
10393 (error "Row descriptior leads outside table")
10394 i)))
10396 (defun org-rewrite-old-row-references (s)
10397 (if (string-match "&[-+0-9I]" s)
10398 (error "Formula contains old &row reference, please rewrite using @-syntax")
10399 s))
10401 (defun org-table-make-reference (elements keep-empty numbers lispp)
10402 "Convert list ELEMENTS to something appropriate to insert into formula.
10403 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10404 NUMBERS indicates that everything should be converted to numbers.
10405 LISPP means to return something appropriate for a Lisp list."
10406 (if (stringp elements) ; just a single val
10407 (if lispp
10408 (if (eq lispp 'literal)
10409 elements
10410 (prin1-to-string (if numbers (string-to-number elements) elements)))
10411 (if (equal elements "") (setq elements "0"))
10412 (if numbers (number-to-string (string-to-number elements)) elements))
10413 (unless keep-empty
10414 (setq elements
10415 (delq nil
10417 elements))))
10418 (setq elements (or elements '("0")))
10419 (if lispp
10420 (mapconcat
10421 (lambda (x)
10422 (if (eq lispp 'literal)
10423 x
10424 (prin1-to-string (if numbers (string-to-number x) x))))
10425 elements " ")
10426 (concat "[" (mapconcat
10427 (lambda (x)
10428 (if numbers (number-to-string (string-to-number x)) x))
10429 elements
10430 ",") "]"))))
10432 (defun org-table-recalculate (&optional all noalign)
10433 "Recalculate the current table line by applying all stored formulas.
10434 With prefix arg ALL, do this for all lines in the table."
10435 (interactive "P")
10436 (or (memq this-command org-recalc-commands)
10437 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10438 (unless (org-at-table-p) (error "Not at a table"))
10439 (if (equal all '(16))
10440 (org-table-iterate)
10441 (org-table-get-specials)
10442 (let* ((eqlist (sort (org-table-get-stored-formulas)
10443 (lambda (a b) (string< (car a) (car b)))))
10444 (inhibit-redisplay (not debug-on-error))
10445 (line-re org-table-dataline-regexp)
10446 (thisline (org-current-line))
10447 (thiscol (org-table-current-column))
10448 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10449 ;; Insert constants in all formulas
10450 (setq eqlist
10451 (mapcar (lambda (x)
10452 (setcdr x (org-table-formula-substitute-names (cdr x)))
10453 x)
10454 eqlist))
10455 ;; Split the equation list
10456 (while (setq eq (pop eqlist))
10457 (if (<= (string-to-char (car eq)) ?9)
10458 (push eq eqlnum)
10459 (push eq eqlname)))
10460 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10461 (if all
10462 (progn
10463 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10464 (goto-char (setq beg (org-table-begin)))
10465 (if (re-search-forward org-table-calculate-mark-regexp end t)
10466 ;; This is a table with marked lines, compute selected lines
10467 (setq line-re org-table-recalculate-regexp)
10468 ;; Move forward to the first non-header line
10469 (if (and (re-search-forward org-table-dataline-regexp end t)
10470 (re-search-forward org-table-hline-regexp end t)
10471 (re-search-forward org-table-dataline-regexp end t))
10472 (setq beg (match-beginning 0))
10473 nil))) ;; just leave beg where it is
10474 (setq beg (point-at-bol)
10475 end (move-marker (make-marker) (1+ (point-at-eol)))))
10476 (goto-char beg)
10477 (and all (message "Re-applying formulas to full table..."))
10479 ;; First find the named fields, and mark them untouchanble
10480 (remove-text-properties beg end '(org-untouchable t))
10481 (while (setq eq (pop eqlname))
10482 (setq name (car eq)
10483 a (assoc name org-table-named-field-locations))
10484 (and (not a)
10486 (setq a (list name
10487 (aref org-table-dlines
10488 (string-to-number (match-string 1 name)))
10489 (string-to-number (match-string 2 name)))))
10490 (when (and a (or all (equal (nth 1 a) thisline)))
10491 (message "Re-applying formula to field: %s" name)
10492 (goto-line (nth 1 a))
10493 (org-table-goto-column (nth 2 a))
10494 (push (append a (list (cdr eq))) eqlname1)
10495 (org-table-put-field-property :org-untouchable t)))
10497 ;; Now evauluate the column formulas, but skip fields covered by
10498 ;; field formulas
10499 (goto-char beg)
10500 (while (re-search-forward line-re end t)
10501 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10502 ;; Unprotected line, recalculate
10503 (and all (message "Re-applying formulas to full table...(line %d)"
10504 (setq cnt (1+ cnt))))
10505 (setq org-last-recalc-line (org-current-line))
10506 (setq eql eqlnum)
10507 (while (setq entry (pop eql))
10508 (goto-line org-last-recalc-line)
10509 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10510 (unless (get-text-property (point) :org-untouchable)
10511 (org-table-eval-formula nil (cdr entry)
10512 'noalign 'nocst 'nostore 'noanalysis)))))
10514 ;; Now evaluate the field formulas
10515 (while (setq eq (pop eqlname1))
10516 (message "Re-applying formula to field: %s" (car eq))
10517 (goto-line (nth 1 eq))
10518 (org-table-goto-column (nth 2 eq))
10519 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10520 'nostore 'noanalysis))
10522 (goto-line thisline)
10523 (org-table-goto-column thiscol)
10524 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10525 (or noalign (and org-table-may-need-update (org-table-align))
10526 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10528 ;; back to initial position
10529 (message "Re-applying formulas...done")
10530 (goto-line thisline)
10531 (org-table-goto-column thiscol)
10532 (or noalign (and org-table-may-need-update (org-table-align))
10533 (and all (message "Re-applying formulas...done"))))))
10535 (defun org-table-iterate (&optional arg)
10536 "Recalculate the table until it does not change anymore."
10537 (interactive "P")
10538 (let ((imax (if arg (prefix-numeric-value arg) 10))
10539 (i 0)
10540 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10541 thistbl)
10542 (catch 'exit
10543 (while (< i imax)
10544 (setq i (1+ i))
10545 (org-table-recalculate 'all)
10546 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10547 (if (not (string= lasttbl thistbl))
10548 (setq lasttbl thistbl)
10549 (if (> i 1)
10550 (message "Convergence after %d iterations" i)
10551 (message "Table was already stable"))
10552 (throw 'exit t)))
10553 (error "No convergence after %d iterations" i))))
10555 (defun org-table-formula-substitute-names (f)
10556 "Replace $const with values in string F."
10557 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10558 ;; First, check for column names
10559 (while (setq start (string-match org-table-column-name-regexp f start))
10560 (setq start (1+ start))
10561 (setq a (assoc (match-string 1 f) org-table-column-names))
10562 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10563 ;; Parameters and constants
10564 (setq start 0)
10566 (setq start (1+ start))
10567 (if (setq a (save-match-data
10568 (org-table-get-constant (match-string 1 f))))
10569 (setq f (replace-match
10570 (concat (if pp "(") a (if pp ")")) t t f))))
10571 (if org-table-formula-debug
10572 (put-text-property 0 (length f) :orig-formula f1 f))
10573 f))
10575 (defun org-table-get-constant (const)
10576 "Find the value for a parameter or constant in a formula.
10577 Parameters get priority."
10578 (or (cdr (assoc const org-table-local-parameters))
10579 (cdr (assoc const org-table-formula-constants-local))
10580 (cdr (assoc const org-table-formula-constants))
10581 (and (fboundp 'constants-get) (constants-get const))
10582 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10583 (org-entry-get nil (substring const 5) 'inherit))
10584 "#UNDEFINED_NAME"))
10586 (defvar org-table-fedit-map
10587 (let ((map (make-sparse-keymap)))
10588 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10589 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10590 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10591 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10592 (org-defkey map "\C-c?" 'org-table-show-reference)
10593 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10594 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10595 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10596 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10597 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10598 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10599 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10600 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10601 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10602 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10603 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10604 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10605 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10606 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10607 map))
10609 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10610 '("Edit-Formulas"
10611 ["Finish and Install" org-table-fedit-finish t]
10612 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10613 ["Abort" org-table-fedit-abort t]
10614 "--"
10615 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10616 ["Complete Lisp Symbol" lisp-complete-symbol t]
10617 "--"
10618 "Shift Reference at Point"
10619 ["Up" org-table-fedit-ref-up t]
10620 ["Down" org-table-fedit-ref-down t]
10621 ["Left" org-table-fedit-ref-left t]
10622 ["Right" org-table-fedit-ref-right t]
10623 "-"
10624 "Change Test Row for Column Formulas"
10625 ["Up" org-table-fedit-line-up t]
10626 ["Down" org-table-fedit-line-down t]
10627 "--"
10628 ["Scroll Table Window" org-table-fedit-scroll t]
10629 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10630 ["Show Table Grid" org-table-fedit-toggle-coordinates
10631 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10632 org-table-overlay-coordinates)]
10633 "--"
10634 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10635 :style toggle :selected org-table-buffer-is-an]))
10637 (defvar org-pos)
10639 (defun org-table-edit-formulas ()
10640 "Edit the formulas of the current table in a separate buffer."
10641 (interactive)
10643 (beginning-of-line 0))
10644 (unless (org-at-table-p) (error "Not at a table"))
10645 (org-table-get-specials)
10646 (let ((key (org-table-current-field-formula 'key 'noerror))
10647 (eql (sort (org-table-get-stored-formulas 'noerror)
10648 'org-table-formula-less-p))
10649 (pos (move-marker (make-marker) (point)))
10650 (startline 1)
10651 (wc (current-window-configuration))
10655 entry s type title)
10656 (org-switch-to-buffer-other-window "*Edit Formulas*")
10657 (erase-buffer)
10658 ;; Keep global-font-lock-mode from turning on font-lock-mode
10659 (let ((font-lock-global-modes '(not fundamental-mode)))
10660 (fundamental-mode))
10661 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10662 (org-set-local 'org-pos pos)
10663 (org-set-local 'org-window-configuration wc)
10664 (use-local-map org-table-fedit-map)
10665 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10666 (easy-menu-add org-table-fedit-menu)
10667 (setq startline (org-current-line))
10668 (while (setq entry (pop eql))
10669 (setq type (cond
10670 ((equal (string-to-char (car entry)) ?@) 'field)
10671 ((string-match "^[0-9]" (car entry)) 'column)
10672 (t 'named)))
10673 (when (setq title (assq type titles))
10675 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10676 (setq titles (delq title titles)))
10677 (if (equal key (car entry)) (setq startline (org-current-line)))
10678 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10680 (remove-text-properties 0 (length s) '(face nil) s)
10681 (insert s))
10682 (if (eq org-table-use-standard-references t)
10683 (org-table-fedit-toggle-ref-type))
10684 (goto-line startline)
10685 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10687 (defun org-table-fedit-post-command ()
10688 (when (not (memq this-command '(lisp-complete-symbol)))
10689 (let ((win (selected-window)))
10690 (save-excursion
10691 (condition-case nil
10692 (org-table-show-reference)
10693 (error nil))
10694 (select-window win)))))
10696 (defun org-table-formula-to-user (s)
10697 "Convert a formula from internal to user representation."
10698 (if (eq org-table-use-standard-references t)
10699 (org-table-convert-refs-to-an s)
10700 s))
10702 (defun org-table-formula-from-user (s)
10703 "Convert a formula from user to internal representation."
10704 (if org-table-use-standard-references
10705 (org-table-convert-refs-to-rc s)
10706 s))
10708 (defun org-table-convert-refs-to-rc (s)
10709 "Convert spreadsheet references from AB7 to @7$28.
10710 Works for single references, but also for entire formulas and even the
10711 full TBLFM line."
10712 (let ((start 0))
10714 (cond
10715 ((match-end 3)
10716 ;; format match, just advance
10717 (setq start (match-end 0)))
10718 ((and (> (match-beginning 0) 0)
10719 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10720 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10721 ;; 3.e5 or something like this.
10722 (setq start (match-end 0)))
10723 (t
10724 (setq start (match-beginning 0)
10725 s (replace-match
10726 (if (equal (match-string 2 s) "&")
10727 (format "$%d" (org-letters-to-number (match-string 1 s)))
10728 (format "@%d$%d"
10729 (string-to-number (match-string 2 s))
10730 (org-letters-to-number (match-string 1 s))))
10731 t t s)))))
10732 s))
10734 (defun org-table-convert-refs-to-an (s)
10735 "Convert spreadsheet references from to @7$28 to AB7.
10736 Works for single references, but also for entire formulas and even the
10737 full TBLFM line."
10739 (setq s (replace-match
10740 (format "%s%d"
10741 (org-number-to-letters
10742 (string-to-number (match-string 2 s)))
10743 (string-to-number (match-string 1 s)))
10744 t t s)))
10747 (org-number-to-letters
10748 (string-to-number (match-string 2 s))) "&")
10749 t nil s)))
10750 s)
10752 (defun org-letters-to-number (s)
10753 "Convert a base 26 number represented by letters into an integer.
10754 For example: AB -> 28."
10755 (let ((n 0))
10756 (setq s (upcase s))
10757 (while (> (length s) 0)
10758 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10759 s (substring s 1)))
10760 n))
10762 (defun org-number-to-letters (n)
10763 "Convert an integer into a base 26 number represented by letters.
10764 For example: 28 -> AB."
10765 (let ((s ""))
10766 (while (> n 0)
10767 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10768 n (/ (1- n) 26)))
10769 s))
10771 (defun org-table-fedit-convert-buffer (function)
10772 "Convert all references in this buffer, using FUNTION."
10773 (let ((line (org-current-line)))
10774 (goto-char (point-min))
10775 (while (not (eobp))
10776 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10777 (delete-region (point) (point-at-eol))
10778 (or (eobp) (forward-char 1)))
10779 (goto-line line)))
10781 (defun org-table-fedit-toggle-ref-type ()
10782 "Convert all references in the buffer from B3 to @3$2 and back."
10783 (interactive)
10784 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10785 (org-table-fedit-convert-buffer
10786 (if org-table-buffer-is-an
10787 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10788 (message "Reference type switched to %s"
10789 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10791 (defun org-table-fedit-ref-up ()
10792 "Shift the reference at point one row/hline up."
10793 (interactive)
10794 (org-table-fedit-shift-reference 'up))
10795 (defun org-table-fedit-ref-down ()
10796 "Shift the reference at point one row/hline down."
10797 (interactive)
10798 (org-table-fedit-shift-reference 'down))
10799 (defun org-table-fedit-ref-left ()
10800 "Shift the reference at point one field to the left."
10801 (interactive)
10802 (org-table-fedit-shift-reference 'left))
10803 (defun org-table-fedit-ref-right ()
10804 "Shift the reference at point one field to the right."
10805 (interactive)
10806 (org-table-fedit-shift-reference 'right))
10808 (defun org-table-fedit-shift-reference (dir)
10809 (cond
10811 (if (memq dir '(left right))
10812 (org-rematch-and-replace 1 (eq dir 'left))
10813 (error "Cannot shift reference in this direction")))
10815 ;; A B3-like reference
10816 (if (memq dir '(up down))
10817 (org-rematch-and-replace 2 (eq dir 'up))
10818 (org-rematch-and-replace 1 (eq dir 'left))))
10819 ((org-at-regexp-p
10821 ;; An internal reference
10822 (if (memq dir '(up down))
10823 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10824 (org-rematch-and-replace 5 (eq dir 'left))))))
10826 (defun org-rematch-and-replace (n &optional decr hline)
10827 "Re-match the group N, and replace it with the shifted refrence."
10828 (or (match-end n) (error "Cannot shift reference in this direction"))
10829 (goto-char (match-beginning n))
10830 (and (looking-at (regexp-quote (match-string n)))
10831 (replace-match (org-shift-refpart (match-string 0) decr hline)
10832 t t)))
10834 (defun org-shift-refpart (ref &optional decr hline)
10835 "Shift a refrence part REF.
10836 If DECR is set, decrease the references row/column, else increase.
10837 If HLINE is set, this may be a hline reference, it certainly is not
10838 a translation reference."
10839 (save-match-data
10840 (let* ((sign (string-match "^[-+]" ref)) n)
10842 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10843 (cond
10844 ((and hline (string-match "^I+" ref))
10845 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10846 (setq n (+ n (if decr -1 1)))
10847 (if (= n 0) (setq n (+ n (if decr -1 1))))
10848 (if sign
10849 (setq sign (if (< n 0) "-" "+") n (abs n))
10850 (setq n (max 1 n)))
10851 (concat sign (make-string n ?I)))
10853 ((string-match "^[0-9]+" ref)
10854 (setq n (string-to-number (concat sign ref)))
10855 (setq n (+ n (if decr -1 1)))
10856 (if sign
10857 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10858 (number-to-string (max 1 n))))
10860 ((string-match "^[a-zA-Z]+" ref)
10861 (org-number-to-letters
10862 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10864 (t (error "Cannot shift reference"))))))
10866 (defun org-table-fedit-toggle-coordinates ()
10867 "Toggle the display of coordinates in the refrenced table."
10868 (interactive)
10869 (let ((pos (marker-position org-pos)))
10870 (with-current-buffer (marker-buffer org-pos)
10871 (save-excursion
10872 (goto-char pos)
10873 (org-table-toggle-coordinate-overlays)))))
10875 (defun org-table-fedit-finish (&optional arg)
10876 "Parse the buffer for formula definitions and install them.
10877 With prefix ARG, apply the new formulas to the table."
10878 (interactive "P")
10879 (org-table-remove-rectangle-highlight)
10880 (if org-table-use-standard-references
10881 (progn
10882 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10883 (setq org-table-buffer-is-an nil)))
10884 (let ((pos org-pos) eql var form)
10885 (goto-char (point-min))
10886 (while (re-search-forward
10888 nil t)
10889 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10890 form (match-string 3))
10891 (setq form (org-trim form))
10892 (when (not (equal form ""))
10894 (setq form (replace-match " " t t form)))
10895 (when (assoc var eql)
10896 (error "Double formulas for %s" var))
10897 (push (cons var form) eql)))
10898 (setq org-pos nil)
10899 (set-window-configuration org-window-configuration)
10900 (select-window (get-buffer-window (marker-buffer pos)))
10901 (goto-char pos)
10902 (unless (org-at-table-p)
10903 (error "Lost table position - cannot install formulae"))
10904 (org-table-store-formulas eql)
10905 (move-marker pos nil)
10906 (kill-buffer "*Edit Formulas*")
10907 (if arg
10908 (org-table-recalculate 'all)
10909 (message "New formulas installed - press C-u C-c C-c to apply."))))
10911 (defun org-table-fedit-abort ()
10912 "Abort editing formulas, without installing the changes."
10913 (interactive)
10914 (org-table-remove-rectangle-highlight)
10915 (let ((pos org-pos))
10916 (set-window-configuration org-window-configuration)
10917 (select-window (get-buffer-window (marker-buffer pos)))
10918 (goto-char pos)
10919 (move-marker pos nil)
10920 (message "Formula editing aborted without installing changes")))
10922 (defun org-table-fedit-lisp-indent ()
10923 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10924 (interactive)
10925 (let ((pos (point)) beg end ind)
10926 (beginning-of-line 1)
10927 (cond
10929 (goto-char pos)
10930 (call-interactively 'lisp-indent-line))
10932 ((not (fboundp 'pp-buffer))
10933 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10934 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10935 (goto-char (- (match-end 0) 2))
10936 (setq beg (point))
10937 (setq ind (make-string (current-column) ?\ ))
10938 (condition-case nil (forward-sexp 1)
10939 (error
10940 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10941 (setq end (point))
10942 (save-restriction
10943 (narrow-to-region beg end)
10944 (if (eq last-command this-command)
10945 (progn
10946 (goto-char (point-min))
10947 (setq this-command nil)
10949 (replace-match " ")))
10950 (pp-buffer)
10951 (untabify (point-min) (point-max))
10952 (goto-char (1+ (point-min)))
10953 (while (re-search-forward "^." nil t)
10954 (beginning-of-line 1)
10955 (insert ind))
10956 (goto-char (point-max))
10957 (backward-delete-char 1)))
10958 (goto-char beg))
10959 (t nil))))
10961 (defvar org-show-positions nil)
10963 (defun org-table-show-reference (&optional local)
10964 "Show the location/value of the $ expression at point."
10965 (interactive)
10966 (org-table-remove-rectangle-highlight)
10967 (catch 'exit
10968 (let ((pos (if local (point) org-pos))
10969 (face2 'highlight)
10970 (org-inhibit-highlight-removal t)
10971 (win (selected-window))
10972 (org-show-positions nil)
10973 var name e what match dest)
10974 (if local (org-table-get-specials))
10975 (setq what (cond
10976 ((or (org-at-regexp-p org-table-range-regexp2)
10977 (org-at-regexp-p org-table-translate-regexp)
10978 (org-at-regexp-p org-table-range-regexp))
10979 (setq match
10980 (save-match-data
10981 (org-table-convert-refs-to-rc (match-string 0))))
10982 'range)
10985 ((not local) nil)
10986 (t (error "No reference at point")))
10987 match (and what (or match (match-string 0))))
10988 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10989 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10990 'secondary-selection))
10991 (org-add-hook 'before-change-functions
10992 'org-table-remove-rectangle-highlight)
10993 (if (eq what 'name) (setq var (substring match 1)))
10994 (when (eq what 'range)
10995 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10996 (setq match (org-table-formula-substitute-names match)))
10997 (unless local
10998 (save-excursion
10999 (end-of-line 1)
11001 (beginning-of-line 1)
11003 (setq dest
11004 (save-match-data
11005 (org-table-convert-refs-to-rc (match-string 1))))
11006 (org-table-add-rectangle-overlay
11007 (match-beginning 1) (match-end 1) face2))))
11008 (if (and (markerp pos) (marker-buffer pos))
11009 (if (get-buffer-window (marker-buffer pos))
11010 (select-window (get-buffer-window (marker-buffer pos)))
11011 (org-switch-to-buffer-other-window (get-buffer-window
11012 (marker-buffer pos)))))
11013 (goto-char pos)
11014 (org-table-force-dataline)
11015 (when dest
11016 (setq name (substring dest 1))
11017 (cond
11019 (setq e (assoc name org-table-named-field-locations))
11020 (goto-line (nth 1 e))
11021 (org-table-goto-column (nth 2 e)))
11023 (let ((l (string-to-number (match-string 1 dest)))
11024 (c (string-to-number (match-string 2 dest))))
11025 (goto-line (aref org-table-dlines l))
11026 (org-table-goto-column c)))
11027 (t (org-table-goto-column (string-to-number name))))
11028 (move-marker pos (point))
11029 (org-table-highlight-rectangle nil nil face2))
11030 (cond
11031 ((equal dest match))
11032 ((not match))
11033 ((eq what 'range)
11034 (condition-case nil
11035 (save-excursion
11036 (org-table-get-range match nil nil 'highlight))
11037 (error nil)))
11038 ((setq e (assoc var org-table-named-field-locations))
11039 (goto-line (nth 1 e))
11040 (org-table-goto-column (nth 2 e))
11041 (org-table-highlight-rectangle (point) (point))
11042 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
11043 ((setq e (assoc var org-table-column-names))
11044 (org-table-goto-column (string-to-number (cdr e)))
11045 (org-table-highlight-rectangle (point) (point))
11046 (goto-char (org-table-begin))
11048 (org-table-end) t)
11049 (progn
11050 (goto-char (match-beginning 1))
11051 (org-table-highlight-rectangle)
11052 (message "Named column (column %s)" (cdr e)))
11053 (error "Column name not found")))
11054 ((eq what 'column)
11055 ;; column number
11056 (org-table-goto-column (string-to-number (substring match 1)))
11057 (org-table-highlight-rectangle (point) (point))
11058 (message "Column %s" (substring match 1)))
11059 ((setq e (assoc var org-table-local-parameters))
11060 (goto-char (org-table-begin))
11062 (progn
11063 (goto-char (match-beginning 1))
11064 (org-table-highlight-rectangle)
11065 (message "Local parameter."))
11066 (error "Parameter not found")))
11067 (t
11068 (cond
11069 ((not var) (error "No reference at point"))
11070 ((setq e (assoc var org-table-formula-constants-local))
11071 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11072 var (cdr e)))
11073 ((setq e (assoc var org-table-formula-constants))
11074 (message "Constant: $%s=%s in `org-table-formula-constants'."
11075 var (cdr e)))
11076 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11077 (message "Constant: $%s=%s, from `constants.el'%s."
11078 var e (format " (%s units)" constants-unit-system)))
11079 (t (error "Undefined name $%s" var)))))
11080 (goto-char pos)
11081 (when (and org-show-positions
11082 (not (memq this-command '(org-table-fedit-scroll
11083 org-table-fedit-scroll-down))))
11084 (push pos org-show-positions)
11085 (push org-table-current-begin-pos org-show-positions)
11086 (let ((min (apply 'min org-show-positions))
11087 (max (apply 'max org-show-positions)))
11088 (goto-char min) (recenter 0)
11089 (goto-char max)
11090 (or (pos-visible-in-window-p max) (recenter -1))))
11091 (select-window win))))
11093 (defun org-table-force-dataline ()
11094 "Make sure the cursor is in a dataline in a table."
11095 (unless (save-excursion
11096 (beginning-of-line 1)
11097 (looking-at org-table-dataline-regexp))
11098 (let* ((re org-table-dataline-regexp)
11099 (p1 (save-excursion (re-search-forward re nil 'move)))
11100 (p2 (save-excursion (re-search-backward re nil 'move))))
11101 (cond ((and p1 p2)
11102 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11103 p1 p2)))
11104 ((or p1 p2) (goto-char (or p1 p2)))
11105 (t (error "No table dataline around here"))))))
11107 (defun org-table-fedit-line-up ()
11108 "Move cursor one line up in the window showing the table."
11109 (interactive)
11110 (org-table-fedit-move 'previous-line))
11112 (defun org-table-fedit-line-down ()
11113 "Move cursor one line down in the window showing the table."
11114 (interactive)
11115 (org-table-fedit-move 'next-line))
11117 (defun org-table-fedit-move (command)
11118 "Move the cursor in the window shoinw the table.
11119 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11120 (let ((org-table-allow-automatic-line-recalculation nil)
11121 (pos org-pos) (win (selected-window)) p)
11122 (select-window (get-buffer-window (marker-buffer org-pos)))
11123 (setq p (point))
11124 (call-interactively command)
11125 (while (and (org-at-table-p)
11126 (org-at-table-hline-p))
11127 (call-interactively command))
11128 (or (org-at-table-p) (goto-char p))
11129 (move-marker pos (point))
11130 (select-window win)))
11132 (defun org-table-fedit-scroll (N)
11133 (interactive "p")
11134 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11135 (scroll-other-window N)))
11137 (defun org-table-fedit-scroll-down (N)
11138 (interactive "p")
11139 (org-table-fedit-scroll (- N)))
11141 (defvar org-table-rectangle-overlays nil)
11143 (defun org-table-add-rectangle-overlay (beg end &optional face)
11144 "Add a new overlay."
11145 (let ((ov (org-make-overlay beg end)))
11146 (org-overlay-put ov 'face (or face 'secondary-selection))
11147 (push ov org-table-rectangle-overlays)))
11149 (defun org-table-highlight-rectangle (&optional beg end face)
11150 "Highlight rectangular region in a table."
11151 (setq beg (or beg (point)) end (or end (point)))
11152 (let ((b (min beg end))
11153 (e (max beg end))
11154 l1 c1 l2 c2 tmp)
11155 (and (boundp 'org-show-positions)
11156 (setq org-show-positions (cons b (cons e org-show-positions))))
11157 (goto-char (min beg end))
11158 (setq l1 (org-current-line)
11159 c1 (org-table-current-column))
11160 (goto-char (max beg end))
11161 (setq l2 (org-current-line)
11162 c2 (org-table-current-column))
11163 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11164 (goto-line l1)
11165 (beginning-of-line 1)
11166 (loop for line from l1 to l2 do
11167 (when (looking-at org-table-dataline-regexp)
11168 (org-table-goto-column c1)
11170 (org-table-goto-column c2)
11172 (org-table-add-rectangle-overlay beg end face))
11173 (beginning-of-line 2))
11174 (goto-char b))
11175 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11177 (defun org-table-remove-rectangle-highlight (&rest ignore)
11178 "Remove the rectangle overlays."
11179 (unless org-inhibit-highlight-removal
11180 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11181 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11182 (setq org-table-rectangle-overlays nil)))
11184 (defvar org-table-coordinate-overlays nil
11185 "Collects the cooordinate grid overlays, so that they can be removed.")
11186 (make-variable-buffer-local 'org-table-coordinate-overlays)
11188 (defun org-table-overlay-coordinates ()
11189 "Add overlays to the table at point, to show row/column coordinates."
11190 (interactive)
11191 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11192 (setq org-table-coordinate-overlays nil)
11193 (save-excursion
11194 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11195 (goto-char (org-table-begin))
11196 (while (org-at-table-p)
11197 (setq eol (point-at-eol))
11198 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11199 (push ov org-table-coordinate-overlays)
11200 (setq hline (looking-at org-table-hline-regexp))
11201 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11202 (format "%4d" (setq id (1+ id)))))
11203 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11204 (when hline
11205 (setq ic 0)
11207 (setq beg (1+ (match-beginning 0))
11208 ic (1+ ic)
11209 s1 (concat "$" (int-to-string ic))
11210 s2 (org-number-to-letters ic)
11211 str (if (eq org-table-use-standard-references t) s2 s1))
11212 (setq ov (org-make-overlay beg (+ beg (length str))))
11213 (push ov org-table-coordinate-overlays)
11214 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11215 (beginning-of-line 2)))))
11217 (defun org-table-toggle-coordinate-overlays ()
11218 "Toggle the display of Row/Column numbers in tables."
11219 (interactive)
11220 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11221 (message "Row/Column number display turned %s"
11222 (if org-table-overlay-coordinates "on" "off"))
11223 (if (and (org-at-table-p) org-table-overlay-coordinates)
11224 (org-table-align))
11225 (unless org-table-overlay-coordinates
11226 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11227 (setq org-table-coordinate-overlays nil)))
11229 (defun org-table-toggle-formula-debugger ()
11230 "Toggle the formula debugger in tables."
11231 (interactive)
11232 (setq org-table-formula-debug (not org-table-formula-debug))
11233 (message "Formula debugging has been turned %s"
11234 (if org-table-formula-debug "on" "off")))
11236 ;;; The orgtbl minor mode
11238 ;; Define a minor mode which can be used in other modes in order to
11239 ;; integrate the org-mode table editor.
11241 ;; This is really a hack, because the org-mode table editor uses several
11242 ;; keys which normally belong to the major mode, for example the TAB and
11243 ;; RET keys. Here is how it works: The minor mode defines all the keys
11244 ;; necessary to operate the table editor, but wraps the commands into a
11245 ;; function which tests if the cursor is currently inside a table. If that
11246 ;; is the case, the table editor command is executed. However, when any of
11247 ;; those keys is used outside a table, the function uses `key-binding' to
11248 ;; look up if the key has an associated command in another currently active
11249 ;; keymap (minor modes, major mode, global), and executes that command.
11250 ;; There might be problems if any of the keys used by the table editor is
11251 ;; otherwise used as a prefix key.
11253 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11254 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11255 ;; addresses this by checking explicitly for both bindings.
11257 ;; The optimized version (see variable `orgtbl-optimized') takes over
11258 ;; all keys which are bound to `self-insert-command' in the *global map*.
11259 ;; Some modes bind other commands to simple characters, for example
11260 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11261 ;; active, this binding is ignored inside tables and replaced with a
11262 ;; modified self-insert.
11264 (defvar orgtbl-mode nil
11265 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11266 table editor in arbitrary modes.")
11267 (make-variable-buffer-local 'orgtbl-mode)
11269 (defvar orgtbl-mode-map (make-keymap)
11270 "Keymap for `orgtbl-mode'.")
11272 ;;;###autoload
11273 (defun turn-on-orgtbl ()
11274 "Unconditionally turn on `orgtbl-mode'."
11275 (orgtbl-mode 1))
11277 (defvar org-old-auto-fill-inhibit-regexp nil
11278 "Local variable used by `orgtbl-mode'")
11281 "Matches a line belonging to an orgtbl.")
11283 (defconst orgtbl-extra-font-lock-keywords
11284 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11285 0 (quote 'org-table) 'prepend))
11286 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11288 ;;;###autoload
11289 (defun orgtbl-mode (&optional arg)
11290 "The `org-mode' table editor as a minor mode for use in other modes."
11291 (interactive)
11292 (if (org-mode-p)
11293 ;; Exit without error, in case some hook functions calls this
11294 ;; by accident in org-mode.
11295 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11296 (setq orgtbl-mode
11297 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11298 (if orgtbl-mode
11299 (progn
11300 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11301 ;; Make sure we are first in minor-mode-map-alist
11302 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11303 (and c (setq minor-mode-map-alist
11304 (cons c (delq c minor-mode-map-alist)))))
11305 (org-set-local (quote org-table-may-need-update) t)
11306 (org-add-hook 'before-change-functions 'org-before-change-function
11307 nil 'local)
11308 (org-set-local 'org-old-auto-fill-inhibit-regexp
11309 auto-fill-inhibit-regexp)
11310 (org-set-local 'auto-fill-inhibit-regexp
11311 (if auto-fill-inhibit-regexp
11313 auto-fill-inhibit-regexp)
11314 orgtbl-line-start-regexp))
11315 (org-add-to-invisibility-spec '(org-cwidth))
11316 (when (fboundp 'font-lock-add-keywords)
11317 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11318 (org-restart-font-lock))
11319 (easy-menu-add orgtbl-mode-menu)
11320 (run-hooks 'orgtbl-mode-hook))
11321 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11322 (org-cleanup-narrow-column-properties)
11323 (org-remove-from-invisibility-spec '(org-cwidth))
11324 (remove-hook 'before-change-functions 'org-before-change-function t)
11325 (when (fboundp 'font-lock-remove-keywords)
11326 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11327 (org-restart-font-lock))
11328 (easy-menu-remove orgtbl-mode-menu)
11329 (force-mode-line-update 'all))))
11331 (defun org-cleanup-narrow-column-properties ()
11332 "Remove all properties related to narrow-column invisibility."
11333 (let ((s 1))
11334 (while (setq s (text-property-any s (point-max)
11335 'display org-narrow-column-arrow))
11336 (remove-text-properties s (1+ s) '(display t)))
11337 (setq s 1)
11338 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11339 (remove-text-properties s (1+ s) '(org-cwidth t)))
11340 (setq s 1)
11341 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11342 (remove-text-properties s (1+ s) '(invisible t)))))
11344 ;; Install it as a minor mode.
11345 (put 'orgtbl-mode :included t)
11346 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11347 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11349 (defun orgtbl-make-binding (fun n &rest keys)
11350 "Create a function for binding in the table minor mode.
11351 FUN is the command to call inside a table. N is used to create a unique
11352 command name. KEYS are keys that should be checked in for a command
11353 to execute outside of tables."
11354 (eval
11355 (list 'defun
11356 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11357 '(arg)
11359 "Outside of tables, run the binding of `"
11360 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11361 "'.")
11362 '(interactive "p")
11363 (list 'if
11364 '(org-at-table-p)
11365 (list 'call-interactively (list 'quote fun))
11366 (list 'let '(orgtbl-mode)
11367 (list 'call-interactively
11368 (append '(or)
11369 (mapcar (lambda (k)
11370 (list 'key-binding k))
11371 keys)
11372 '('orgtbl-error))))))))
11374 (defun orgtbl-error ()
11375 "Error when there is no default binding for a table key."
11376 (interactive)
11377 (error "This key has no function outside tables"))
11379 (defun orgtbl-setup ()
11380 "Setup orgtbl keymaps."
11381 (let ((nfunc 0)
11382 (bindings
11383 (list
11384 '([(meta shift left)] org-table-delete-column)
11385 '([(meta left)] org-table-move-column-left)
11386 '([(meta right)] org-table-move-column-right)
11387 '([(meta shift right)] org-table-insert-column)
11388 '([(meta shift up)] org-table-kill-row)
11389 '([(meta shift down)] org-table-insert-row)
11390 '([(meta up)] org-table-move-row-up)
11391 '([(meta down)] org-table-move-row-down)
11392 '("\C-c\C-w" org-table-cut-region)
11393 '("\C-c\M-w" org-table-copy-region)
11394 '("\C-c\C-y" org-table-paste-rectangle)
11395 '("\C-c-" org-table-insert-hline)
11396 '("\C-c}" org-table-toggle-coordinate-overlays)
11397 '("\C-c{" org-table-toggle-formula-debugger)
11398 '("\C-m" org-table-next-row)
11399 '([(shift return)] org-table-copy-down)
11400 '("\C-c\C-q" org-table-wrap-region)
11401 '("\C-c?" org-table-field-info)
11402 '("\C-c " org-table-blank-field)
11403 '("\C-c+" org-table-sum)
11404 '("\C-c=" org-table-eval-formula)
11405 '("\C-c'" org-table-edit-formulas)
11406 '("\C-c`" org-table-edit-field)
11407 '("\C-c*" org-table-recalculate)
11408 '("\C-c|" org-table-create-or-convert-from-region)
11409 '("\C-c^" org-table-sort-lines)
11410 '([(control ?#)] org-table-rotate-recalc-marks)))
11411 elt key fun cmd)
11412 (while (setq elt (pop bindings))
11413 (setq nfunc (1+ nfunc))
11414 (setq key (org-key (car elt))
11415 fun (nth 1 elt)
11416 cmd (orgtbl-make-binding fun nfunc key))
11417 (org-defkey orgtbl-mode-map key cmd))
11419 ;; Special treatment needed for TAB and RET
11420 (org-defkey orgtbl-mode-map [(return)]
11421 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11422 (org-defkey orgtbl-mode-map "\C-m"
11423 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11425 (org-defkey orgtbl-mode-map [(tab)]
11426 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11427 (org-defkey orgtbl-mode-map "\C-i"
11428 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11430 (org-defkey orgtbl-mode-map [(shift tab)]
11431 (orgtbl-make-binding 'org-table-previous-field 104
11432 [(shift tab)] [(tab)] "\C-i"))
11434 (org-defkey orgtbl-mode-map "\M-\C-m"
11435 (orgtbl-make-binding 'org-table-wrap-region 105
11436 "\M-\C-m" [(meta return)]))
11437 (org-defkey orgtbl-mode-map [(meta return)]
11438 (orgtbl-make-binding 'org-table-wrap-region 106
11439 [(meta return)] "\M-\C-m"))
11441 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11442 (when orgtbl-optimized
11443 ;; If the user wants maximum table support, we need to hijack
11444 ;; some standard editing functions
11445 (org-remap orgtbl-mode-map
11446 'self-insert-command 'orgtbl-self-insert-command
11447 'delete-char 'org-delete-char
11448 'delete-backward-char 'org-delete-backward-char)
11449 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11450 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11451 '("OrgTbl"
11452 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11453 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11454 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11455 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11456 "--"
11457 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11458 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11459 ["Copy Field from Above"
11460 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11461 "--"
11462 ("Column"
11463 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11464 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11465 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11466 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11467 ("Row"
11468 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11469 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11470 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11471 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11472 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11473 "--"
11474 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11475 ("Rectangle"
11476 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11477 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11478 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11479 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11480 "--"
11481 ("Radio tables"
11482 ["Insert table template" orgtbl-insert-radio-table
11483 (assq major-mode orgtbl-radio-table-templates)]
11484 ["Comment/uncomment table" orgtbl-toggle-comment t])
11485 "--"
11486 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11487 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11488 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11489 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11490 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11491 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11492 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11493 ["Sum Column/Rectangle" org-table-sum
11494 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11495 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11496 ["Debug Formulas"
11497 org-table-toggle-formula-debugger :active (org-at-table-p)
11498 :keys "C-c {"
11499 :style toggle :selected org-table-formula-debug]
11500 ["Show Col/Row Numbers"
11501 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11502 :keys "C-c }"
11503 :style toggle :selected org-table-overlay-coordinates]
11504 ))
11505 t))
11507 (defun orgtbl-ctrl-c-ctrl-c (arg)
11508 "If the cursor is inside a table, realign the table.
11509 It it is a table to be sent away to a receiver, do it.
11510 With prefix arg, also recompute table."
11511 (interactive "P")
11512 (let ((pos (point)) action)
11513 (save-excursion
11514 (beginning-of-line 1)
11518 (cond
11519 ((integerp action)
11520 (goto-char action)
11521 (org-table-maybe-eval-formula)
11522 (if arg
11523 (call-interactively 'org-table-recalculate)
11524 (org-table-maybe-recalculate-line))
11525 (call-interactively 'org-table-align)
11526 (orgtbl-send-table 'maybe))
11527 ((eq action 'recalc)
11528 (save-excursion
11529 (beginning-of-line 1)
11531 (if (org-at-table-p)
11532 (org-call-with-arg 'org-table-recalculate t))))
11533 (t (let (orgtbl-mode)
11534 (call-interactively (key-binding "\C-c\C-c")))))))
11536 (defun orgtbl-tab (arg)
11537 "Justification and field motion for `orgtbl-mode'."
11538 (interactive "P")
11539 (if arg (org-table-edit-field t)
11540 (org-table-justify-field-maybe)
11541 (org-table-next-field)))
11543 (defun orgtbl-ret ()
11544 "Justification and field motion for `orgtbl-mode'."
11545 (interactive)
11546 (org-table-justify-field-maybe)
11547 (org-table-next-row))
11549 (defun orgtbl-self-insert-command (N)
11550 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11551 If the cursor is in a table looking at whitespace, the whitespace is
11552 overwritten, and the table is not marked as requiring realignment."
11553 (interactive "p")
11554 (if (and (org-at-table-p)
11555 (or
11556 (and org-table-auto-blank-field
11557 (member last-command
11558 '(orgtbl-hijacker-command-100
11559 orgtbl-hijacker-command-101
11560 orgtbl-hijacker-command-102
11561 orgtbl-hijacker-command-103
11562 orgtbl-hijacker-command-104
11563 orgtbl-hijacker-command-105))
11564 (org-table-blank-field))
11565 t)
11566 (eq N 1)
11568 (let (org-table-may-need-update)
11569 (goto-char (1- (match-end 0)))
11570 (delete-backward-char 1)
11571 (goto-char (match-beginning 0))
11572 (self-insert-command N))
11573 (setq org-table-may-need-update t)
11574 (let (orgtbl-mode)
11575 (call-interactively (key-binding (vector last-input-event))))))
11577 (defun org-force-self-insert (N)
11578 "Needed to enforce self-insert under remapping."
11579 (interactive "p")
11580 (self-insert-command N))
11583 "Regula expression matching exponentials as produced by calc.")
11585 (defvar org-table-clean-did-remove-column nil)
11587 (defun orgtbl-export (table target)
11588 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11590 org-table-last-alignment org-table-last-column-widths
11591 maxcol column)
11592 (if (not (fboundp func))
11593 (error "Cannot export orgtbl table to %s" target))
11594 (setq lines (org-table-clean-before-export lines))
11595 (setq table
11596 (mapcar
11597 (lambda (x)
11598 (if (string-match org-table-hline-regexp x)
11599 'hline
11601 lines))
11602 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11603 table)))
11604 (loop for i from (1- maxcol) downto 0 do
11605 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11606 (setq column (delq nil column))
11607 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11608 (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))
11609 (funcall func table nil)))
11611 (defun orgtbl-send-table (&optional maybe)
11612 "Send a tranformed version of this table to the receiver position.
11613 With argument MAYBE, fail quietly if no transformation is defined for
11614 this table."
11615 (interactive)
11616 (catch 'exit
11617 (unless (org-at-table-p) (error "Not at a table"))
11618 ;; when non-interactive, we assume align has just happened.
11619 (when (interactive-p) (org-table-align))
11620 (save-excursion
11621 (goto-char (org-table-begin))
11622 (beginning-of-line 0)
11624 (if maybe
11625 (throw 'exit nil)
11626 (error "Don't know how to transform this table."))))
11627 (let* ((name (match-string 1))
11628 beg
11629 (transform (intern (match-string 2)))
11630 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11631 (skip (plist-get params :skip))
11632 (skipcols (plist-get params :skipcols))
11633 (txt (buffer-substring-no-properties
11634 (org-table-begin) (org-table-end)))
11636 (lines (org-table-clean-before-export lines))
11637 (i0 (if org-table-clean-did-remove-column 2 1))
11638 (table (mapcar
11639 (lambda (x)
11640 (if (string-match org-table-hline-regexp x)
11641 'hline
11642 (org-remove-by-index
11644 skipcols i0)))
11645 lines))
11646 (fun (if (= i0 2) 'cdr 'identity))
11647 (org-table-last-alignment
11648 (org-remove-by-index (funcall fun org-table-last-alignment)
11649 skipcols i0))
11650 (org-table-last-column-widths
11651 (org-remove-by-index (funcall fun org-table-last-column-widths)
11652 skipcols i0)))
11654 (unless (fboundp transform)
11655 (error "No such transformation function %s" transform))
11656 (setq txt (funcall transform table params))
11657 ;; Find the insertion place
11658 (save-excursion
11659 (goto-char (point-min))
11660 (unless (re-search-forward
11662 (error "Don't know where to insert translated table"))
11663 (goto-char (match-beginning 0))
11664 (beginning-of-line 2)
11665 (setq beg (point))
11666 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11667 (error "Cannot find end of insertion region"))
11668 (beginning-of-line 1)
11669 (delete-region beg (point))
11670 (goto-char beg)
11672 (message "Table converted and installed at receiver location"))))
11674 (defun org-remove-by-index (list indices &optional i0)
11675 "Remove the elements in LIST with indices in INDICES.
11676 First element has index 0, or I0 if given."
11677 (if (not indices)
11678 list
11679 (if (integerp indices) (setq indices (list indices)))
11680 (setq i0 (1- (or i0 0)))
11681 (delq :rm (mapcar (lambda (x)
11682 (setq i0 (1+ i0))
11683 (if (memq i0 indices) :rm x))
11684 list))))
11686 (defun orgtbl-toggle-comment ()
11687 "Comment or uncomment the orgtbl at point."
11688 (interactive)
11689 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11690 (re2 (concat "^" orgtbl-line-start-regexp))
11691 (commented (save-excursion (beginning-of-line 1)
11692 (cond ((looking-at re1) t)
11693 ((looking-at re2) nil)
11694 (t (error "Not at an org table")))))
11695 (re (if commented re1 re2))
11696 beg end)
11697 (save-excursion
11698 (beginning-of-line 1)
11699 (while (looking-at re) (beginning-of-line 0))
11700 (beginning-of-line 2)
11701 (setq beg (point))
11702 (while (looking-at re) (beginning-of-line 2))
11703 (setq end (point)))
11704 (comment-region beg end (if commented '(4) nil))))
11706 (defun orgtbl-insert-radio-table ()
11707 "Insert a radio table template appropriate for this major mode."
11708 (interactive)
11709 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11710 (txt (nth 1 e))
11711 name pos)
11712 (unless e (error "No radio table setup defined for %s" major-mode))
11713 (setq name (read-string "Table name: "))
11714 (while (string-match "%n" txt)
11715 (setq txt (replace-match name t t txt)))
11717 (setq pos (point))
11718 (insert txt)
11719 (goto-char pos)))
11721 (defun org-get-param (params header i sym &optional hsym)
11722 "Get parameter value for symbol SYM.
11723 If this is a header line, actually get the value for the symbol with an
11725 If the value is a protperty list, get the element for the current column.
11726 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11727 (let ((val (plist-get params sym)))
11728 (and hsym header (setq val (or (plist-get params hsym) val)))
11729 (if (consp val) (plist-get val i) val)))
11731 (defun orgtbl-to-generic (table params)
11732 "Convert the orgtbl-mode TABLE to some other format.
11733 This generic routine can be used for many standard cases.
11734 TABLE is a list, each entry either the symbol `hline' for a horizontal
11735 separator line, or a list of fields for that line.
11736 PARAMS is a property list of parameters that can influence the conversion.
11737 For the generic converter, some parameters are obligatory: You need to
11738 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11739 :splice, you must have :tstart and :tend.
11741 Valid parameters are
11743 :tstart String to start the table. Ignored when :splice is t.
11744 :tend String to end the table. Ignored when :splice is t.
11746 :splice When set to t, return only table body lines, don't wrap
11747 them into :tstart and :tend. Default is nil.
11749 :hline String to be inserted on horizontal separation lines.
11750 May be nil to ignore hlines.
11752 :lstart String to start a new table line.
11753 :lend String to end a table line
11754 :sep Separator between two fields
11755 :lfmt Format for entire line, with enough %s to capture all fields.
11756 If this is present, :lstart, :lend, and :sep are ignored.
11757 :fmt A format to be used to wrap the field, should contain
11758 %s for the original field value. For example, to wrap
11760 This may also be a property list with column numbers and
11763 :hlstart :hlend :hlsep :hlfmt :hfmt
11764 Same as above, specific for the header lines in the table.
11765 All lines before the first hline are treated as header.
11766 If any of these is not present, the data line value is used.
11768 :efmt Use this format to print numbers with exponentials.
11769 The format should have %s twice for inserting mantissa
11771 may also be a property list with column numbers and
11772 formats. :fmt will still be applied after :efmt.
11774 In addition to this, the parameters :skip and :skipcols are always handled
11775 directly by `orgtbl-send-table'. See manual."
11776 (interactive)
11777 (let* ((p params)
11778 (splicep (plist-get p :splice))
11779 (hline (plist-get p :hline))
11780 rtn line i fm efm lfmt h)
11782 ;; Do we have a header?
11783 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11784 (setq h t))
11786 ;; Put header
11787 (unless splicep
11788 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11790 ;; Now loop over all lines
11791 (while (setq line (pop table))
11792 (if (eq line 'hline)
11793 ;; A horizontal separator line
11794 (progn (if hline (push hline rtn))
11795 (setq h nil)) ; no longer in header
11796 ;; A normal line. Convert the fields, push line onto the result list
11797 (setq i 0)
11798 (setq line
11799 (mapcar
11800 (lambda (f)
11801 (setq i (1+ i)
11802 fm (org-get-param p h i :fmt :hfmt)
11803 efm (org-get-param p h i :efmt))
11804 (if (and efm (string-match orgtbl-exp-regexp f))
11805 (setq f (format
11806 efm (match-string 1 f) (match-string 2 f))))
11807 (if fm (setq f (format fm f)))
11808 f)
11809 line))
11810 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11811 (push (apply 'format lfmt line) rtn)
11812 (push (concat
11813 (org-get-param p h i :lstart :hlstart)
11814 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11815 (org-get-param p h i :lend :hlend))
11816 rtn))))
11818 (unless splicep
11819 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11823 (defun orgtbl-to-latex (table params)
11824 "Convert the orgtbl-mode TABLE to LaTeX.
11825 TABLE is a list, each entry either the symbol `hline' for a horizontal
11826 separator line, or a list of fields for that line.
11827 PARAMS is a property list of parameters that can influence the conversion.
11828 Supports all parameters from `orgtbl-to-generic'. Most important for
11829 LaTeX are:
11831 :splice When set to t, return only table body lines, don't wrap
11832 them into a tabular environment. Default is nil.
11834 :fmt A format to be used to wrap the field, should contain %s for the
11835 original field value. For example, to wrap everything in dollars,
11839 :efmt Format for transforming numbers with exponentials. The format
11840 should have %s twice for inserting mantissa and exponent, for
11842 This may also be a property list with column numbers and formats.
11844 The general parameters :skip and :skipcols have already been applied when
11845 this function is called."
11846 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11847 org-table-last-alignment ""))
11848 (params2
11849 (list
11854 (orgtbl-to-generic table (org-combine-plists params2 params))))
11856 (defun orgtbl-to-html (table params)
11857 "Convert the orgtbl-mode TABLE to LaTeX.
11858 TABLE is a list, each entry either the symbol `hline' for a horizontal
11859 separator line, or a list of fields for that line.
11860 PARAMS is a property list of parameters that can influence the conversion.
11861 Currently this function recognizes the following parameters:
11863 :splice When set to t, return only table body lines, don't wrap
11864 them into a <table> environment. Default is nil.
11866 The general parameters :skip and :skipcols have already been applied when
11867 this function is called. The function does *not* use `orgtbl-to-generic',
11868 so you cannot specify parameters for it."
11869 (let* ((splicep (plist-get params :splice))
11870 html)
11871 ;; Just call the formatter we already have
11872 ;; We need to make text lines for it, so put the fields back together.
11873 (setq html (org-format-org-table-html
11874 (mapcar
11875 (lambda (x)
11876 (if (eq x 'hline)
11877 "|----+----|"
11878 (concat "| " (mapconcat 'identity x " | ") " |")))
11879 table)
11880 splicep))
11882 (setq html (replace-match "" t t html)))
11883 html))
11885 (defun orgtbl-to-texinfo (table params)
11886 "Convert the orgtbl-mode TABLE to TeXInfo.
11887 TABLE is a list, each entry either the symbol `hline' for a horizontal
11888 separator line, or a list of fields for that line.
11889 PARAMS is a property list of parameters that can influence the conversion.
11890 Supports all parameters from `orgtbl-to-generic'. Most important for
11891 TeXInfo are:
11893 :splice nil/t When set to t, return only table body lines, don't wrap
11894 them into a multitable environment. Default is nil.
11896 :fmt fmt A format to be used to wrap the field, should contain
11897 %s for the original field value. For example, to wrap
11899 This may also be a property list with column numbers and
11903 are computed automatically from the width of the columns
11904 under org-mode.
11906 The general parameters :skip and :skipcols have already been applied when
11907 this function is called."
11908 (let* ((total (float (apply '+ org-table-last-column-widths)))
11909 (colfrac (or (plist-get params :cf)
11910 (mapconcat
11911 (lambda (x) (format "%.3f" (/ (float x) total)))
11912 org-table-last-column-widths " ")))
11913 (params2
11914 (list
11915 :tstart (concat "@multitable @columnfractions " colfrac)
11916 :tend "@end multitable"
11917 :lstart "@item " :lend "" :sep " @tab "
11918 :hlstart "@headitem ")))
11919 (orgtbl-to-generic table (org-combine-plists params2 params))))
11921 ;;;; Link Stuff
11923 ;;; Link abbreviations
11925 (defun org-link-expand-abbrev (link)
11926 "Apply replacements as defined in `org-link-abbrev-alist."
11928 (let* ((key (match-string 1 link))
11929 (as (or (assoc key org-link-abbrev-alist-local)
11930 (assoc key org-link-abbrev-alist)))
11931 (tag (and (match-end 2) (match-string 3 link)))
11932 rpl)
11933 (if (not as)
11934 link
11935 (setq rpl (cdr as))
11936 (cond
11937 ((symbolp rpl) (funcall rpl tag))
11938 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11939 (t (concat rpl tag)))))
11940 link))
11942 ;;; Storing and inserting links
11944 (defvar org-insert-link-history nil
11945 "Minibuffer history for links inserted with `org-insert-link'.")
11947 (defvar org-stored-links nil
11948 "Contains the links stored with `org-store-link'.")
11950 (defvar org-store-link-plist nil
11951 "Plist with info about the most recently link created with `org-store-link'.")
11953 (defvar org-link-protocols nil
11954 "Link protocols added to Org-mode using `org-add-link-type'.")
11956 (defvar org-store-link-functions nil
11957 "List of functions that are called to create and store a link.
11958 Each function will be called in turn until one returns a non-nil
11959 value. Each function should check if it is responsible for creating
11960 this link (for example by looking at the major mode).
11961 If not, it must exit and return nil.
11962 If yes, it should return a non-nil value after a calling
11963 `org-store-link-props' with a list of properties and values.
11964 Special properties are:
11968 This is obligatory as well.
11969 :description Optional default description for the second pair
11970 of brackets in an Org-mode link. The user can still change
11971 this when inserting this link into an Org-mode buffer.
11973 In addition to these, any additional properties can be specified
11974 and then used in remember templates.")
11976 (defun org-add-link-type (type &optional follow publish)
11977 "Add TYPE to the list of `org-link-types'.
11978 Re-compute all regular expressions depending on `org-link-types'
11979 FOLLOW and PUBLISH are two functions. Both take the link path as
11980 an argument.
11981 FOLLOW should do whatever is necessary to follow the link, for example
11982 to find a file or display a mail message.
11984 PUBLISH takes the path and retuns the string that should be used when
11985 this document is published. FIMXE: This is actually not yet implemented."
11986 (add-to-list 'org-link-types type t)
11987 (org-make-link-regexps)
11988 (add-to-list 'org-link-protocols
11989 (list type follow publish)))
11991 (defun org-add-agenda-custom-command (entry)
11992 "Replace or add a command in `org-agenda-custom-commands'.
11993 This is mostly for hacking and trying a new command - once the command
11994 works you probably want to add it to `org-agenda-custom-commands' for good."
11995 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11996 (if ass
11997 (setcdr ass (cdr entry))
11998 (push entry org-agenda-custom-commands))))
12000 ;;;###autoload
12001 (defun org-store-link (arg)
12003 This link is added to `org-stored-links' and can later be inserted
12006 For some link types, a prefix arg is interpreted:
12007 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
12008 For file links, arg negates `org-context-in-file-links'."
12009 (interactive "P")
12010 (setq org-store-link-plist nil) ; reset
12011 (require 'org-irc)
12012 (let (link cpltxt desc description search txt)
12013 (cond
12015 ((run-hook-with-args-until-success 'org-store-link-functions)
12016 (setq link (plist-get org-store-link-plist :link)
12017 desc (or (plist-get org-store-link-plist :description) link)))
12019 ((eq major-mode 'bbdb-mode)
12020 (let ((name (bbdb-record-name (bbdb-current-record)))
12021 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
12022 (setq cpltxt (concat "bbdb:" (or name company))
12023 link (org-make-link cpltxt))
12024 (org-store-link-props :type "bbdb" :name name :company company)))
12026 ((eq major-mode 'Info-mode)
12027 (setq link (org-make-link "info:"
12028 (file-name-nondirectory Info-current-file)
12029 ":" Info-current-node))
12030 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
12031 ":" Info-current-node))
12032 (org-store-link-props :type "info" :file Info-current-file
12033 :node Info-current-node))
12035 ((eq major-mode 'calendar-mode)
12036 (let ((cd (calendar-cursor-to-date)))
12037 (setq link
12038 (format-time-string
12039 (car org-time-stamp-formats)
12040 (apply 'encode-time
12041 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
12042 nil nil nil))))
12043 (org-store-link-props :type "calendar" :date cd)))
12045 ((or (eq major-mode 'vm-summary-mode)
12046 (eq major-mode 'vm-presentation-mode))
12047 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
12048 (vm-follow-summary-cursor)
12049 (save-excursion
12050 (vm-select-folder-buffer)
12051 (let* ((message (car vm-message-pointer))
12052 (folder buffer-file-name)
12053 (subject (vm-su-subject message))
12054 (to (vm-get-header-contents message "To"))
12055 (from (vm-get-header-contents message "From"))
12056 (message-id (vm-su-message-id message)))
12057 (org-store-link-props :type "vm" :from from :to to :subject subject
12058 :message-id message-id)
12059 (setq message-id (org-remove-angle-brackets message-id))
12060 (setq folder (abbreviate-file-name folder))
12061 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
12062 folder)
12063 (setq folder (replace-match "" t t folder)))
12064 (setq cpltxt (org-email-link-description))
12065 (setq link (org-make-link "vm:" folder "#" message-id)))))
12067 ((eq major-mode 'wl-summary-mode)
12068 (let* ((msgnum (wl-summary-message-number))
12069 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12070 msgnum 'message-id))
12071 (wl-message-entity
12072 (if (fboundp 'elmo-message-entity)
12073 (elmo-message-entity
12074 wl-summary-buffer-elmo-folder msgnum)
12075 (elmo-msgdb-overview-get-entity
12076 msgnum (wl-summary-buffer-msgdb))))
12077 (from (wl-summary-line-from))
12078 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12079 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12080 (wl-summary-line-subject))))
12081 (org-store-link-props :type "wl" :from from :to to
12082 :subject subject :message-id message-id)
12083 (setq message-id (org-remove-angle-brackets message-id))
12084 (setq cpltxt (org-email-link-description))
12085 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12086 "#" message-id))))
12088 ((or (equal major-mode 'mh-folder-mode)
12089 (equal major-mode 'mh-show-mode))
12090 (let ((from (org-mhe-get-header "From:"))
12091 (to (org-mhe-get-header "To:"))
12092 (message-id (org-mhe-get-header "Message-Id:"))
12093 (subject (org-mhe-get-header "Subject:")))
12094 (org-store-link-props :type "mh" :from from :to to
12095 :subject subject :message-id message-id)
12096 (setq cpltxt (org-email-link-description))
12097 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12098 (org-remove-angle-brackets message-id)))))
12100 ((or (eq major-mode 'rmail-mode)
12101 (eq major-mode 'rmail-summary-mode))
12102 (save-window-excursion
12103 (save-restriction
12104 (when (eq major-mode 'rmail-summary-mode)
12105 (rmail-show-message rmail-current-message))
12106 (rmail-narrow-to-non-pruned-header)
12107 (let ((folder buffer-file-name)
12108 (message-id (mail-fetch-field "message-id"))
12109 (from (mail-fetch-field "from"))
12110 (to (mail-fetch-field "to"))
12111 (subject (mail-fetch-field "subject")))
12112 (org-store-link-props
12113 :type "rmail" :from from :to to
12114 :subject subject :message-id message-id)
12115 (setq message-id (org-remove-angle-brackets message-id))
12116 (setq cpltxt (org-email-link-description))
12117 (setq link (org-make-link "rmail:" folder "#" message-id)))
12118 (rmail-show-message rmail-current-message))))
12120 ((eq major-mode 'gnus-group-mode)
12121 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12122 (gnus-group-group-name)) ; version
12123 ((fboundp 'gnus-group-name)
12124 (gnus-group-name))
12125 (t "???"))))
12126 (unless group (error "Not on a group"))
12127 (org-store-link-props :type "gnus" :group group)
12128 (setq cpltxt (concat
12129 (if (org-xor arg org-usenet-links-prefer-google)
12130 "http://groups.google.com/groups?group="
12131 "gnus:")
12132 group)
12133 link (org-make-link cpltxt))))
12135 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12136 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12137 (let* ((group gnus-newsgroup-name)
12138 (article (gnus-summary-article-number))
12139 (header (gnus-summary-article-header article))
12140 (from (mail-header-from header))
12141 (message-id (mail-header-id header))
12142 (date (mail-header-date header))
12143 (subject (gnus-summary-subject-string)))
12144 (org-store-link-props :type "gnus" :from from :subject subject
12145 :message-id message-id :group group)
12146 (setq cpltxt (org-email-link-description))
12147 (if (org-xor arg org-usenet-links-prefer-google)
12148 (setq link
12149 (concat
12151 (format "http://groups.google.com/groups?as_umsgid=%s"
12152 (org-fixup-message-id-for-http message-id))))
12153 (setq link (org-make-link "gnus:" group
12154 "#" (number-to-string article))))))
12156 ((eq major-mode 'w3-mode)
12157 (setq cpltxt (url-view-url t)
12158 link (org-make-link cpltxt))
12159 (org-store-link-props :type "w3" :url (url-view-url t)))
12161 ((eq major-mode 'w3m-mode)
12162 (setq cpltxt (or w3m-current-title w3m-current-url)
12163 link (org-make-link w3m-current-url))
12164 (org-store-link-props :type "w3m" :url (url-view-url t)))
12166 ((setq search (run-hook-with-args-until-success
12167 'org-create-file-search-functions))
12168 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12169 "::" search))
12170 (setq cpltxt (or description link)))
12172 ((eq major-mode 'image-mode)
12173 (setq cpltxt (concat "file:"
12174 (abbreviate-file-name buffer-file-name))
12175 link (org-make-link cpltxt))
12176 (org-store-link-props :type "image" :file buffer-file-name))
12178 ((eq major-mode 'dired-mode)
12179 ;; link to the file in the current line
12180 (setq cpltxt (concat "file:"
12181 (abbreviate-file-name
12182 (expand-file-name
12183 (dired-get-filename nil t))))
12184 link (org-make-link cpltxt)))
12186 ((and buffer-file-name (org-mode-p))
12187 ;; Just link to current headline
12188 (setq cpltxt (concat "file:"
12189 (abbreviate-file-name buffer-file-name)))
12190 ;; Add a context search string
12191 (when (org-xor org-context-in-file-links arg)
12192 ;; Check if we are on a target
12194 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12195 (setq txt (cond
12196 ((org-on-heading-p) nil)
12197 ((org-region-active-p)
12198 (buffer-substring (region-beginning) (region-end)))
12199 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12201 (setq cpltxt
12202 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12203 desc "NONE"))))
12205 (setq cpltxt (substring cpltxt 0 -2)))
12206 (setq link (org-make-link cpltxt)))
12208 ((buffer-file-name (buffer-base-buffer))
12209 ;; Just link to this file here.
12210 (setq cpltxt (concat "file:"
12211 (abbreviate-file-name
12212 (buffer-file-name (buffer-base-buffer)))))
12213 ;; Add a context string
12214 (when (org-xor org-context-in-file-links arg)
12215 (setq txt (if (org-region-active-p)
12216 (buffer-substring (region-beginning) (region-end))
12217 (buffer-substring (point-at-bol) (point-at-eol))))
12218 ;; Only use search option if there is some text.
12220 (setq cpltxt
12221 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12222 desc "NONE")))
12223 (setq link (org-make-link cpltxt)))
12225 ((interactive-p)
12226 (error "Cannot link to a buffer which is not visiting a file"))
12228 (t (setq link nil)))
12230 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12231 (setq link (or link cpltxt)
12232 desc (or desc cpltxt))
12233 (if (equal desc "NONE") (setq desc nil))
12235 (if (and (interactive-p) link)
12236 (progn
12237 (setq org-stored-links
12238 (cons (list link desc) org-stored-links))
12239 (message "Stored: %s" (or desc link)))
12240 (and link (org-make-link-string link desc)))))
12242 (defun org-store-link-props (&rest plist)
12243 "Store link properties, extract names and addresses."
12244 (let (x adr)
12245 (when (setq x (plist-get plist :from))
12246 (setq adr (mail-extract-address-components x))
12247 (plist-put plist :fromname (car adr))
12248 (plist-put plist :fromaddress (nth 1 adr)))
12249 (when (setq x (plist-get plist :to))
12250 (setq adr (mail-extract-address-components x))
12251 (plist-put plist :toname (car adr))
12252 (plist-put plist :toaddress (nth 1 adr))))
12253 (let ((from (plist-get plist :from))
12254 (to (plist-get plist :to)))
12255 (when (and from to org-from-is-user-regexp)
12256 (plist-put plist :fromto
12257 (if (string-match org-from-is-user-regexp from)
12258 (concat "to %t")
12259 (concat "from %f")))))
12260 (setq org-store-link-plist plist))
12262 (defun org-email-link-description (&optional fmt)
12263 "Return the description part of an email link.
12264 This takes information from `org-store-link-plist' and formats it
12265 according to FMT (default from `org-email-link-description-format')."
12266 (setq fmt (or fmt org-email-link-description-format))
12267 (let* ((p org-store-link-plist)
12268 (to (plist-get p :toaddress))
12269 (from (plist-get p :fromaddress))
12270 (table
12271 (list
12272 (cons "%c" (plist-get p :fromto))
12273 (cons "%F" (plist-get p :from))
12274 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12275 (cons "%T" (plist-get p :to))
12276 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12277 (cons "%s" (plist-get p :subject))
12278 (cons "%m" (plist-get p :message-id)))))
12279 (when (string-match "%c" fmt)
12280 ;; Check if the user wrote this message
12281 (if (and org-from-is-user-regexp from to
12282 (save-match-data (string-match org-from-is-user-regexp from)))
12283 (setq fmt (replace-match "to %t" t t fmt))
12284 (setq fmt (replace-match "from %f" t t fmt))))
12285 (org-replace-escapes fmt table)))
12287 (defun org-make-org-heading-search-string (&optional string heading)
12288 "Make search string for STRING or current headline."
12289 (interactive)
12290 (let ((s (or string (org-get-heading))))
12291 (unless (and string (not heading))
12292 ;; We are using a headline, clean up garbage in there.
12293 (if (string-match org-todo-regexp s)
12294 (setq s (replace-match "" t t s)))
12296 (setq s (replace-match "" t t s)))
12297 (setq s (org-trim s))
12300 (setq s (replace-match "" t t s)))
12301 (while (string-match org-ts-regexp s)
12302 (setq s (replace-match "" t t s))))
12304 (setq s (replace-match " " t t s)))
12305 (or string (setq s (concat "*" s))) ; Add * for headlines
12308 (defun org-make-link (&rest strings)
12309 "Concatenate STRINGS."
12310 (apply 'concat strings))
12312 (defun org-make-link-string (link &optional description)
12313 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12315 (error "Empty link"))
12316 (when (stringp description)
12317 ;; Remove brackets from the description, they are fatal.
12319 (setq description (replace-match "{" t t description)))
12321 (setq description (replace-match "}" t t description))))
12322 (when (equal (org-link-escape link) description)
12323 ;; No description needed, it is identical
12324 (setq description nil))
12325 (when (and (not description)
12326 (not (equal link (org-link-escape link))))
12327 (setq description link))
12328 (concat "[[" (org-link-escape link) "]"
12329 (if description (concat "[" description "]") "")
12330 "]"))
12332 (defconst org-link-escape-chars
12333 '((?\ . "%20")
12334 (?\[ . "%5B")
12335 (?\] . "%5D")
12346 (?\; . "%3B")
12347 (?? . "%3F")
12348 (?= . "%3D")
12349 (?+ . "%2B")
12350 )
12351 "Association list of escapes for some characters problematic in links.
12352 This is the list that is used for internal purposes.")
12354 (defconst org-link-escape-chars-browser
12355 '((?\ . "%20")) ; 32 for the SPC char
12356 "Association list of escapes for some characters problematic in links.
12357 This is the list that is used before handing over to the browser.")
12359 (defun org-link-escape (text &optional table)
12360 "Escape charaters in TEXT that are problematic for links."
12361 (setq table (or table org-link-escape-chars))
12362 (when text
12363 (let ((re (mapconcat (lambda (x) (regexp-quote
12364 (char-to-string (car x))))
12366 (while (string-match re text)
12367 (setq text
12368 (replace-match
12369 (cdr (assoc (string-to-char (match-string 0 text))
12370 table))
12371 t t text)))
12372 text)))
12374 (defun org-link-unescape (text &optional table)
12375 "Reverse the action of `org-link-escape'."
12376 (setq table (or table org-link-escape-chars))
12377 (when text
12378 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12380 (while (string-match re text)
12381 (setq text
12382 (replace-match
12383 (char-to-string (car (rassoc (match-string 0 text) table)))
12384 t t text)))
12385 text)))
12387 (defun org-xor (a b)
12388 "Exclusive or."
12389 (if a (not b) b))
12391 (defun org-get-header (header)
12392 "Find a header field in the current buffer."
12393 (save-excursion
12394 (goto-char (point-min))
12395 (let ((case-fold-search t) s)
12396 (cond
12397 ((eq header 'from)
12399 (setq s (match-string 1)))
12401 (setq s (replace-match "" t t s)))
12402 (if (string-match "[<(].*" s)
12403 (setq s (replace-match "" t t s))))
12404 ((eq header 'message-id)
12406 (setq s (match-string 1))))
12407 ((eq header 'subject)
12409 (setq s (match-string 1)))))
12412 s)))
12415 (defun org-fixup-message-id-for-http (s)
12416 "Replace special characters in a message id, so it can be used in an http query."
12417 (while (string-match "<" s)
12418 (setq s (replace-match "%3C" t t s)))
12419 (while (string-match ">" s)
12420 (setq s (replace-match "%3E" t t s)))
12421 (while (string-match "@" s)
12422 (setq s (replace-match "%40" t t s)))
12423 s)
12425 ;;;###autoload
12426 (defun org-insert-link-global ()
12427 "Insert a link like Org-mode does.
12428 This command can be called in any mode to insert a link in Org-mode syntax."
12429 (interactive)
12430 (org-run-like-in-org-mode 'org-insert-link))
12432 (defun org-insert-link (&optional complete-file)
12433 "Insert a link. At the prompt, enter the link.
12435 Completion can be used to select a link previously stored with
12436 `org-store-link'. When the empty string is entered (i.e. if you just
12437 press RET at the prompt), the link defaults to the most recently
12438 stored link. As SPC triggers completion in the minibuffer, you need to
12439 use M-SPC or C-q SPC to force the insertion of a space character.
12441 You will also be prompted for a description, and if one is given, it will
12442 be displayed in the buffer instead of the link.
12444 If there is already a link at point, this command will allow you to edit link
12445 and description parts.
12448 selected using completion. The path to the file will be relative to
12449 the current directory if the file is in the current directory or a
12450 subdirectory. Otherwise, the link will be the absolute path as
12451 completed in the minibuffer (i.e. normally ~/path/to/file).
12454 is in the current directory or below.
12456 `org-keep-stored-link-after-insertion'."
12457 (interactive "P")
12458 (let* ((wcf (current-window-configuration))
12459 (region (if (org-region-active-p)
12460 (buffer-substring (region-beginning) (region-end))))
12461 (remove (and region (list (region-beginning) (region-end))))
12462 (desc region)
12463 tmphist ; byte-compile incorrectly complains about this
12464 link entry file)
12465 (cond
12466 ((org-in-regexp org-bracket-link-regexp 1)
12467 ;; We do have a link at point, and we are going to edit it.
12468 (setq remove (list (match-beginning 0) (match-end 0)))
12469 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12470 (setq link (read-string "Link: "
12471 (org-link-unescape
12472 (org-match-string-no-properties 1)))))
12473 ((or (org-in-regexp org-angle-link-re)
12474 (org-in-regexp org-plain-link-re))
12475 ;; Convert to bracket link
12476 (setq remove (list (match-beginning 0) (match-end 0))
12477 link (read-string "Link: "
12478 (org-remove-angle-brackets (match-string 0)))))
12479 ((equal complete-file '(4))
12480 ;; Completing read for file names.
12481 (setq file (read-file-name "File: "))
12482 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12483 (pwd1 (file-name-as-directory (abbreviate-file-name
12484 (expand-file-name ".")))))
12485 (cond
12486 ((equal complete-file '(16))
12487 (setq link (org-make-link
12488 "file:"
12489 (abbreviate-file-name (expand-file-name file)))))
12491 (setq link (org-make-link "file:" (match-string 1 file))))
12493 (expand-file-name file))
12494 (setq link (org-make-link
12495 "file:" (match-string 1 (expand-file-name file)))))
12496 (t (setq link (org-make-link "file:" file))))))
12497 (t
12498 ;; Read link, with completion for stored links.
12499 (with-output-to-temp-buffer "*Org Links*"
12501 (when org-stored-links
12503 (princ (mapconcat
12504 (lambda (x)
12505 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12507 (let ((cw (selected-window)))
12508 (select-window (get-buffer-window "*Org Links*"))
12509 (shrink-window-if-larger-than-buffer)
12510 (setq truncate-lines t)
12511 (select-window cw))
12512 ;; Fake a link history, containing the stored links.
12513 (setq tmphist (append (mapcar 'car org-stored-links)
12514 org-insert-link-history))
12515 (unwind-protect
12516 (setq link (org-completing-read
12517 "Link: "
12518 (append
12519 (mapcar (lambda (x) (list (concat (car x) ":")))
12520 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12521 (mapcar (lambda (x) (list (concat x ":")))
12522 org-link-types))
12523 nil nil nil
12524 'tmphist
12525 (or (car (car org-stored-links)))))
12526 (set-window-configuration wcf)
12527 (kill-buffer "*Org Links*"))
12528 (setq entry (assoc link org-stored-links))
12529 (or entry (push link org-insert-link-history))
12530 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12531 (not org-keep-stored-link-after-insertion))
12532 (setq org-stored-links (delq (assoc link org-stored-links)
12533 org-stored-links)))
12534 (setq desc (or desc (nth 1 entry)))))
12536 (if (string-match org-plain-link-re link)
12537 ;; URL-like link, normalize the use of angular brackets.
12538 (setq link (org-make-link (org-remove-angle-brackets link))))
12540 ;; Check if we are linking to the current file with a search option
12541 ;; If yes, simplify the link by using only the search option.
12542 (when (and buffer-file-name
12544 (let* ((path (match-string 1 link))
12545 (case-fold-search nil)
12546 (search (match-string 2 link)))
12547 (save-match-data
12548 (if (equal (file-truename buffer-file-name) (file-truename path))
12549 ;; We are linking to this same file, with a search option
12550 (setq link search)))))
12552 ;; Check if we can/should use a relative path. If yes, simplify the link
12554 (let* ((path (match-string 1 link))
12555 (origpath path)
12556 (case-fold-search nil))
12557 (cond
12558 ((eq org-link-file-path-type 'absolute)
12559 (setq path (abbreviate-file-name (expand-file-name path))))
12560 ((eq org-link-file-path-type 'noabbrev)
12561 (setq path (expand-file-name path)))
12562 ((eq org-link-file-path-type 'relative)
12563 (setq path (file-relative-name path)))
12564 (t
12565 (save-match-data
12566 (if (string-match (concat "^" (regexp-quote
12567 (file-name-as-directory
12568 (expand-file-name "."))))
12569 (expand-file-name path))
12570 ;; We are linking a file with relative path name.
12571 (setq path (substring (expand-file-name path)
12572 (match-end 0)))))))
12573 (setq link (concat "file:" path))
12574 (if (equal desc origpath)
12575 (setq desc path))))
12577 (setq desc (read-string "Description: " desc))
12579 (if remove (apply 'delete-region remove))
12580 (insert (org-make-link-string link desc))))
12582 (defun org-completing-read (&rest args)
12583 (let ((minibuffer-local-completion-map
12584 (copy-keymap minibuffer-local-completion-map)))
12585 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12586 (apply 'completing-read args)))
12588 ;;; Opening/following a link
12589 (defvar org-link-search-failed nil)
12591 (defun org-next-link ()
12592 "Move forward to the next link.
12593 If the link is in hidden text, expose it."
12594 (interactive)
12595 (when (and org-link-search-failed (eq this-command last-command))
12596 (goto-char (point-min))
12597 (message "Link search wrapped back to beginning of buffer"))
12598 (setq org-link-search-failed nil)
12599 (let* ((pos (point))
12600 (ct (org-context))
12601 (a (assoc :link ct)))
12602 (if a (goto-char (nth 2 a)))
12603 (if (re-search-forward org-any-link-re nil t)
12604 (progn
12605 (goto-char (match-beginning 0))
12606 (if (org-invisible-p) (org-show-context)))
12607 (goto-char pos)
12608 (setq org-link-search-failed t)
12609 (error "No further link found"))))
12611 (defun org-previous-link ()
12612 "Move backward to the previous link.
12613 If the link is in hidden text, expose it."
12614 (interactive)
12615 (when (and org-link-search-failed (eq this-command last-command))
12616 (goto-char (point-max))
12617 (message "Link search wrapped back to end of buffer"))
12618 (setq org-link-search-failed nil)
12619 (let* ((pos (point))
12620 (ct (org-context))
12621 (a (assoc :link ct)))
12622 (if a (goto-char (nth 1 a)))
12623 (if (re-search-backward org-any-link-re nil t)
12624 (progn
12625 (goto-char (match-beginning 0))
12626 (if (org-invisible-p) (org-show-context)))
12627 (goto-char pos)
12628 (setq org-link-search-failed t)
12629 (error "No further link found"))))
12631 (defun org-find-file-at-mouse (ev)
12632 "Open file link or URL at mouse."
12633 (interactive "e")
12634 (mouse-set-point ev)
12635 (org-open-at-point 'in-emacs))
12637 (defun org-open-at-mouse (ev)
12638 "Open file link or URL at mouse."
12639 (interactive "e")
12640 (mouse-set-point ev)
12641 (org-open-at-point))
12643 (defvar org-window-config-before-follow-link nil
12644 "The window configuration before following a link.
12645 This is saved in case the need arises to restore it.")
12647 (defvar org-open-link-marker (make-marker)
12648 "Marker pointing to the location where `org-open-at-point; was called.")
12650 ;;;###autoload
12651 (defun org-open-at-point-global ()
12652 "Follow a link like Org-mode does.
12653 This command can be called in any mode to follow a link that has
12654 Org-mode syntax."
12655 (interactive)
12656 (org-run-like-in-org-mode 'org-open-at-point))
12658 (defun org-open-at-point (&optional in-emacs)
12659 "Open link at or after point.
12660 If there is no link at point, this function will search forward up to
12661 the end of the current subtree.
12662 Normally, files will be opened by an appropriate application. If the
12663 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12664 (interactive "P")
12665 (catch 'abort
12666 (move-marker org-open-link-marker (point))
12667 (setq org-window-config-before-follow-link (current-window-configuration))
12668 (org-remove-occur-highlights nil nil t)
12669 (if (org-at-timestamp-p t)
12670 (org-follow-timestamp-link)
12671 (let (type path link line search (pos (point)))
12672 (catch 'match
12673 (save-excursion
12675 (when (org-in-regexp org-bracket-link-regexp)
12676 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12678 (setq link (replace-match " " t t link)))
12679 (setq link (org-link-expand-abbrev link))
12680 (if (string-match org-link-re-with-space2 link)
12681 (setq type (match-string 1 link) path (match-string 2 link))
12682 (setq type "thisfile" path link))
12683 (throw 'match t)))
12685 (when (get-text-property (point) 'org-linked-text)
12686 (setq type "thisfile"
12687 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12688 (1+ (point)) (point))
12689 path (buffer-substring
12690 (previous-single-property-change pos 'org-linked-text)
12691 (next-single-property-change pos 'org-linked-text)))
12692 (throw 'match t))
12694 (save-excursion
12695 (when (or (org-in-regexp org-angle-link-re)
12696 (org-in-regexp org-plain-link-re))
12697 (setq type (match-string 1) path (match-string 2))
12698 (throw 'match t)))
12700 (setq type "tree-match"
12701 path (match-string 1))
12702 (throw 'match t))
12703 (save-excursion
12705 (setq type "tags"
12706 path (match-string 1))
12707 (while (string-match ":" path)
12708 (setq path (replace-match "+" t t path)))
12709 (throw 'match t))))
12710 (unless path
12711 (error "No link found"))
12712 ;; Remove any trailing spaces in path
12714 (setq path (replace-match "" t t path)))
12716 (cond
12718 ((assoc type org-link-protocols)
12719 (funcall (nth 1 (assoc type org-link-protocols)) path))
12721 ((equal type "mailto")
12722 (let ((cmd (car org-link-mailto-program))
12723 (args (cdr org-link-mailto-program)) args1
12724 (address path) (subject "") a)
12726 (setq address (match-string 1 path)
12727 subject (org-link-escape (match-string 2 path))))
12728 (while args
12729 (cond
12730 ((not (stringp (car args))) (push (pop args) args1))
12731 (t (setq a (pop args))
12732 (if (string-match "%a" a)
12733 (setq a (replace-match address t t a)))
12734 (if (string-match "%s" a)
12735 (setq a (replace-match subject t t a)))
12736 (push a args1))))
12737 (apply cmd (nreverse args1))))
12739 ((member type '("http" "https" "ftp" "news"))
12740 (browse-url (concat type ":" (org-link-escape
12741 path org-link-escape-chars-browser))))
12743 ((member type '("message"))
12744 (browse-url (concat type ":" path)))
12746 ((string= type "tags")
12747 (org-tags-view in-emacs path))
12748 ((string= type "thisfile")
12749 (if in-emacs
12750 (switch-to-buffer-other-window
12751 (org-get-buffer-for-internal-link (current-buffer)))
12752 (org-mark-ring-push))
12753 (let ((cmd `(org-link-search
12754 ,path
12755 ,(cond ((equal in-emacs '(4)) 'occur)
12756 ((equal in-emacs '(16)) 'org-occur)
12757 (t nil))
12758 ,pos)))
12759 (condition-case nil (eval cmd)
12760 (error (progn (widen) (eval cmd))))))
12762 ((string= type "tree-match")
12765 ((string= type "file")
12767 (setq line (string-to-number (match-string 1 path))
12768 path (substring path 0 (match-beginning 0)))
12770 (setq search (match-string 1 path)
12771 path (substring path 0 (match-beginning 0)))))
12772 (if (string-match "[*?{]" (file-name-nondirectory path))
12773 (dired path)
12774 (org-open-file path in-emacs line search)))
12776 ((string= type "news")
12777 (org-follow-gnus-link path))
12779 ((string= type "bbdb")
12780 (org-follow-bbdb-link path))
12782 ((string= type "info")
12783 (org-follow-info-link path))
12785 ((string= type "gnus")
12786 (let (group article)
12788 (error "Error in Gnus link"))
12789 (setq group (match-string 1 path)
12790 article (match-string 3 path))
12791 (org-follow-gnus-link group article)))
12793 ((string= type "vm")
12794 (let (folder article)
12796 (error "Error in VM link"))
12797 (setq folder (match-string 1 path)
12798 article (match-string 3 path))
12799 ;; in-emacs is the prefix arg, will be interpreted as read-only
12800 (org-follow-vm-link folder article in-emacs)))
12802 ((string= type "wl")
12803 (let (folder article)
12805 (error "Error in Wanderlust link"))
12806 (setq folder (match-string 1 path)
12807 article (match-string 3 path))
12808 (org-follow-wl-link folder article)))
12810 ((string= type "mhe")
12811 (let (folder article)
12813 (error "Error in MHE link"))
12814 (setq folder (match-string 1 path)
12815 article (match-string 3 path))
12816 (org-follow-mhe-link folder article)))
12818 ((string= type "rmail")
12819 (let (folder article)
12821 (error "Error in RMAIL link"))
12822 (setq folder (match-string 1 path)
12823 article (match-string 3 path))
12824 (org-follow-rmail-link folder article)))
12826 ((string= type "shell")
12827 (let ((cmd path))
12828 (if (or (not org-confirm-shell-link-function)
12829 (funcall org-confirm-shell-link-function
12831 (org-add-props cmd nil
12832 'face 'org-warning))))
12833 (progn
12834 (message "Executing %s" cmd)
12835 (shell-command cmd))
12836 (error "Abort"))))
12838 ((string= type "elisp")
12839 (let ((cmd path))
12840 (if (or (not org-confirm-elisp-link-function)
12841 (funcall org-confirm-elisp-link-function
12843 (org-add-props cmd nil
12844 'face 'org-warning))))
12845 (message "%s => %s" cmd (eval (read cmd)))
12846 (error "Abort"))))
12848 (t
12849 (browse-url-at-point)))))
12850 (move-marker org-open-link-marker nil)))
12852 ;;; File search
12854 (defvar org-create-file-search-functions nil
12855 "List of functions to construct the right search string for a file link.
12856 These functions are called in turn with point at the location to
12857 which the link should point.
12859 A function in the hook should first test if it would like to
12860 handle this file type, for example by checking the major-mode or
12861 the file extension. If it decides not to handle this file, it
12862 should just return nil to give other functions a chance. If it
12863 does handle the file, it must return the search string to be used
12864 when following the link. The search string will be part of the
12865 file link, given after a double colon, and `org-open-at-point'
12866 will automatically search for it. If special measures must be
12867 taken to make the search successful, another function should be
12868 added to the companion hook `org-execute-file-search-functions',
12869 which see.
12871 A function in this hook may also use `setq' to set the variable
12872 `description' to provide a suggestion for the descriptive text to
12873 be used for this link when it gets inserted into an Org-mode
12876 (defvar org-execute-file-search-functions nil
12877 "List of functions to execute a file search triggered by a link.
12879 Functions added to this hook must accept a single argument, the
12880 search string that was part of the file link, the part after the
12881 double colon. The function must first check if it would like to
12882 handle this search, for example by checking the major-mode or the
12883 file extension. If it decides not to handle this search, it
12884 should just return nil to give other functions a chance. If it
12885 does handle the search, it must return a non-nil value to keep
12886 other functions from trying.
12888 Each function can access the current prefix argument through the
12889 variable `current-prefix-argument'. Note that a single prefix is
12890 used to force opening a link in Emacs, so it may be good to only
12891 use a numeric or double prefix to guide the search function.
12893 In case this is needed, a function in this hook can also restore
12894 the window configuration before `org-open-at-point' was called using:
12896 (set-window-configuration org-window-config-before-follow-link)")
12898 (defun org-link-search (s &optional type avoid-pos)
12899 "Search for a link search option.
12900 If S is surrounded by forward slashes, it is interpreted as a
12901 regular expression. In org-mode files, this will create an `org-occur'
12902 sparse tree. In ordinary files, `occur' will be used to list matches.
12903 If the current buffer is in `dired-mode', grep will be used to search
12904 in all files. If AVOID-POS is given, ignore matches near that position."
12905 (let ((case-fold-search t)
12909 org-emphasis-alist)
12911 (pos (point))
12912 (pre "") (post "")
12913 words re0 re1 re2 re3 re4 re5 re2a reall)
12914 (cond
12915 ;; First check if there are any special
12916 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12917 ;; Now try the builtin stuff
12918 ((save-excursion
12919 (goto-char (point-min))
12920 (and
12921 (re-search-forward
12922 (concat "<<" (regexp-quote s0) ">>") nil t)
12923 (setq pos (match-beginning 0))))
12924 ;; There is an exact target for this
12925 (goto-char pos))
12927 ;; A regular expression
12928 (cond
12929 ((org-mode-p)
12930 (org-occur (match-string 1 s)))
12931 ;;((eq major-mode 'dired-mode)
12932 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12933 (t (org-do-occur (match-string 1 s)))))
12934 (t
12935 ;; A normal search strings
12936 (when (equal (string-to-char s) ?*)
12937 ;; Anchor on headlines, post may include tags.
12940 s (substring s 1)))
12941 (remove-text-properties
12942 0 (length s)
12943 '(face nil mouse-face nil keymap nil fontified nil) s)
12944 ;; Make a series of regular expressions to find a match
12951 re1 (concat pre re2 post)
12952 re3 (concat pre re4 post)
12953 re5 (concat pre ".*" re4)
12954 re2 (concat pre re2)
12955 re2a (concat pre re2a)
12956 re4 (concat pre re4)
12960 ))
12961 (cond
12962 ((eq type 'org-occur) (org-occur reall))
12963 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12964 (t (goto-char (point-min))
12965 (if (or (org-search-not-self 1 re0 nil t)
12966 (org-search-not-self 1 re1 nil t)
12967 (org-search-not-self 1 re2 nil t)
12968 (org-search-not-self 1 re2a nil t)
12969 (org-search-not-self 1 re3 nil t)
12970 (org-search-not-self 1 re4 nil t)
12971 (org-search-not-self 1 re5 nil t)
12972 )
12973 (goto-char (match-beginning 1))
12974 (goto-char pos)
12975 (error "No match")))))
12976 (t
12977 ;; Normal string-search
12978 (goto-char (point-min))
12979 (if (search-forward s nil t)
12980 (goto-char (match-beginning 0))
12981 (error "No match"))))
12982 (and (org-mode-p) (org-show-context 'link-search))))
12984 (defun org-search-not-self (group &rest args)
12985 "Execute `re-search-forward', but only accept matches that do not
12986 enclose the position of `org-open-link-marker'."
12987 (let ((m org-open-link-marker))
12988 (catch 'exit
12989 (while (apply 're-search-forward args)
12990 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12991 (goto-char (match-end group))
12992 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12993 (> (match-beginning 0) (marker-position m))
12994 (< (match-end 0) (marker-position m)))
12995 (save-match-data
12996 (or (not (org-in-regexp
12997 org-bracket-link-analytic-regexp 1))
12998 (not (match-end 4)) ; no description
12999 (and (<= (match-beginning 4) (point))
13000 (>= (match-end 4) (point))))))
13001 (throw 'exit (point))))))))
13003 (defun org-get-buffer-for-internal-link (buffer)
13004 "Return a buffer to be used for displaying the link target of internal links."
13005 (cond
13006 ((not org-display-internal-link-with-indirect-buffer)
13007 buffer)
13008 ((string-match "(Clone)$" (buffer-name buffer))
13009 (message "Buffer is already a clone, not making another one")
13010 ;; we also do not modify visibility in this case
13011 buffer)
13012 (t ; make a new indirect buffer for displaying the link
13013 (let* ((bn (buffer-name buffer))
13014 (ibn (concat bn "(Clone)"))
13015 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
13016 (with-current-buffer ib (org-overview))
13017 ib))))
13019 (defun org-do-occur (regexp &optional cleanup)
13020 "Call the Emacs command `occur'.
13021 If CLEANUP is non-nil, remove the printout of the regular expression
13022 in the *Occur* buffer. This is useful if the regex is long and not useful
13023 to read."
13024 (occur regexp)
13025 (when cleanup
13026 (let ((cwin (selected-window)) win beg end)
13027 (when (setq win (get-buffer-window "*Occur*"))
13028 (select-window win))
13029 (goto-char (point-min))
13030 (when (re-search-forward "match[a-z]+" nil t)
13031 (setq beg (match-end 0))
13033 (setq end (1- (match-beginning 0)))))
13034 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
13035 (goto-char (point-min))
13036 (select-window cwin))))
13038 ;;; The mark ring for links jumps
13040 (defvar org-mark-ring nil
13041 "Mark ring for positions before jumps in Org-mode.")
13042 (defvar org-mark-ring-last-goto nil
13043 "Last position in the mark ring used to go back.")
13044 ;; Fill and close the ring
13045 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
13046 (loop for i from 1 to org-mark-ring-length do
13047 (push (make-marker) org-mark-ring))
13048 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
13049 org-mark-ring)
13051 (defun org-mark-ring-push (&optional pos buffer)
13052 "Put the current position or POS into the mark ring and rotate it."
13053 (interactive)
13054 (setq pos (or pos (point)))
13055 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
13056 (move-marker (car org-mark-ring)
13057 (or pos (point))
13058 (or buffer (current-buffer)))
13059 (message "%s"
13060 (substitute-command-keys
13063 (defun org-mark-ring-goto (&optional n)
13064 "Jump to the previous position in the mark ring.
13065 With prefix arg N, jump back that many stored positions. When
13066 called several times in succession, walk through the entire ring.
13067 Org-mode commands jumping to a different position in the current file,
13068 or to another Org-mode file, automatically push the old position
13069 onto the ring."
13070 (interactive "p")
13071 (let (p m)
13072 (if (eq last-command this-command)
13073 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13074 (setq p org-mark-ring))
13075 (setq org-mark-ring-last-goto p)
13076 (setq m (car p))
13077 (switch-to-buffer (marker-buffer m))
13078 (goto-char m)
13079 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13081 (defun org-remove-angle-brackets (s)
13082 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13083 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13084 s)
13085 (defun org-add-angle-brackets (s)
13086 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13087 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13088 s)
13090 ;;; Following specific links
13092 (defun org-follow-timestamp-link ()
13093 (cond
13094 ((org-at-date-range-p t)
13095 (let ((org-agenda-start-on-weekday)
13096 (t1 (match-string 1))
13097 (t2 (match-string 2)))
13098 (setq t1 (time-to-days (org-time-string-to-time t1))
13099 t2 (time-to-days (org-time-string-to-time t2)))
13100 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13101 ((org-at-timestamp-p t)
13102 (org-agenda-list nil (time-to-days (org-time-string-to-time
13103 (substring (match-string 1) 0 10)))
13104 1))
13105 (t (error "This should not happen"))))
13108 (defun org-follow-bbdb-link (name)
13109 "Follow a BBDB link to NAME."
13110 (require 'bbdb)
13111 (let ((inhibit-redisplay (not debug-on-error))
13112 (bbdb-electric-p nil))
13113 (catch 'exit
13114 ;; Exact match on name
13116 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13117 ;; Exact match on name
13119 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13120 ;; Partial match on name
13121 (bbdb-name name nil)
13122 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13123 ;; Partial match on company
13124 (bbdb-company name nil)
13125 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13126 ;; General match including network address and notes
13127 (bbdb name nil)
13128 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13129 (delete-window (get-buffer-window "*BBDB*"))
13130 (error "No matching BBDB record")))))
13132 (defun org-follow-info-link (name)
13133 "Follow an info file & node link to NAME."
13136 (progn
13137 (require 'info)
13138 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13139 (Info-find-node (match-string 1 name) (match-string 2 name))
13140 (Info-find-node (match-string 1 name) "Top")))
13141 (message "Could not open: %s" name)))
13143 (defun org-follow-gnus-link (&optional group article)
13144 "Follow a Gnus link to GROUP and ARTICLE."
13145 (require 'gnus)
13146 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13147 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13148 (cond ((and group article)
13149 (gnus-group-read-group 1 nil group)
13150 (gnus-summary-goto-article (string-to-number article) nil t))
13151 (group (gnus-group-jump-to-group group))))
13153 (defun org-follow-vm-link (&optional folder article readonly)
13154 "Follow a VM link to FOLDER and ARTICLE."
13155 (require 'vm)
13156 (setq article (org-add-angle-brackets article))
13158 ;; ange-ftp or efs or tramp access
13159 (let ((user (or (match-string 1 folder) (user-login-name)))
13160 (host (match-string 2 folder))
13161 (file (match-string 3 folder)))
13162 (cond
13163 ((featurep 'tramp)
13164 ;; use tramp to access the file
13165 (if (featurep 'xemacs)
13166 (setq folder (format "[%s@%s]%s" user host file))
13167 (setq folder (format "/%s@%s:%s" user host file))))
13168 (t
13169 ;; use ange-ftp or efs
13170 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13171 (setq folder (format "/%s@%s:%s" user host file))))))
13172 (when folder
13173 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13174 (sit-for 0.1)
13175 (when article
13176 (vm-select-folder-buffer)
13177 (widen)
13178 (let ((case-fold-search t))
13179 (goto-char (point-min))
13180 (if (not (re-search-forward
13181 (concat "^" "message-id: *" (regexp-quote article))))
13182 (error "Could not find the specified message in this folder"))
13183 (vm-isearch-update)
13184 (vm-isearch-narrow)
13185 (vm-beginning-of-message)
13186 (vm-summarize)))))
13188 (defun org-follow-wl-link (folder article)
13189 "Follow a Wanderlust link to FOLDER and ARTICLE."
13190 (if (and (string= folder "%")
13191 article
13193 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13194 ;; Thus, we recompose folder and article ids.
13195 (setq folder (format "%s#%s" folder (match-string 1 article))
13196 article (match-string 3 article)))
13197 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13198 (error "No such folder: %s" folder))
13199 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13200 (and article
13201 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13202 (wl-summary-redisplay)))
13204 (defun org-follow-rmail-link (folder article)
13205 "Follow an RMAIL link to FOLDER and ARTICLE."
13206 (setq article (org-add-angle-brackets article))
13207 (let (message-number)
13208 (save-excursion
13209 (save-window-excursion
13210 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13211 (setq message-number
13212 (save-restriction
13213 (widen)
13214 (goto-char (point-max))
13215 (if (re-search-backward
13217 (or article "")))
13218 nil t)
13219 (rmail-what-message))))))
13220 (if message-number
13221 (progn
13222 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13223 (rmail-show-message message-number)
13224 message-number)
13225 (error "Message not found"))))
13227 ;;; mh-e integration based on planner-mode
13228 (defun org-mhe-get-message-real-folder ()
13229 "Return the name of the current message real folder, so if you use
13230 sequences, it will now work."
13231 (save-excursion
13232 (let* ((folder
13233 (if (equal major-mode 'mh-folder-mode)
13234 mh-current-folder
13235 ;; Refer to the show buffer
13236 mh-show-folder-buffer))
13237 (end-index
13238 (if (boundp 'mh-index-folder)
13239 (min (length mh-index-folder) (length folder))))
13240 )
13241 ;; a simple test on mh-index-data does not work, because
13242 ;; mh-index-data is always nil in a show buffer.
13243 (if (and (boundp 'mh-index-folder)
13244 (string= mh-index-folder (substring folder 0 end-index)))
13245 (if (equal major-mode 'mh-show-mode)
13246 (save-window-excursion
13247 (let (pop-up-frames)
13248 (when (buffer-live-p (get-buffer folder))
13249 (progn
13250 (pop-to-buffer folder)
13251 (org-mhe-get-message-folder-from-index)
13252 )
13253 )))
13254 (org-mhe-get-message-folder-from-index)
13255 )
13256 folder
13257 )
13258 )))
13260 (defun org-mhe-get-message-folder-from-index ()
13261 "Returns the name of the message folder in a index folder buffer."
13262 (save-excursion
13263 (mh-index-previous-folder)
13265 (message "%s" (match-string 1))))
13267 (defun org-mhe-get-message-folder ()
13268 "Return the name of the current message folder. Be careful if you
13269 use sequences."
13270 (save-excursion
13271 (if (equal major-mode 'mh-folder-mode)
13272 mh-current-folder
13273 ;; Refer to the show buffer
13274 mh-show-folder-buffer)))
13276 (defun org-mhe-get-message-num ()
13277 "Return the number of the current message. Be careful if you
13278 use sequences."
13279 (save-excursion
13280 (if (equal major-mode 'mh-folder-mode)
13281 (mh-get-msg-num nil)
13282 ;; Refer to the show buffer
13283 (mh-show-buffer-message-number))))
13285 (defun org-mhe-get-header (header)
13286 "Return a header of the message in folder mode. This will create a
13287 show buffer for the corresponding message. If you have a more clever
13288 idea..."
13289 (let* ((folder (org-mhe-get-message-folder))
13290 (num (org-mhe-get-message-num))
13291 (buffer (get-buffer-create (concat "show-" folder)))
13292 (header-field))
13293 (with-current-buffer buffer
13294 (mh-display-msg num folder)
13295 (if (equal major-mode 'mh-folder-mode)
13296 (mh-header-display)
13297 (mh-show-header-display))
13298 (set-buffer buffer)
13299 (setq header-field (mh-get-header-field header))
13300 (if (equal major-mode 'mh-folder-mode)
13301 (mh-show)
13302 (mh-show-show))
13303 header-field)))
13305 (defun org-follow-mhe-link (folder article)
13306 "Follow an MHE link to FOLDER and ARTICLE.
13307 If ARTICLE is nil FOLDER is shown. If the configuration variable
13308 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13309 ARTICLE is searched in all folders. Indexed searches (swish++,
13310 namazu, and others supported by MH-E) will always search in all
13311 folders."
13312 (require 'mh-e)
13313 (require 'mh-search)
13314 (require 'mh-utils)
13315 (mh-find-path)
13316 (if (not article)
13317 (mh-visit-folder (mh-normalize-folder-name folder))
13318 (setq article (org-add-angle-brackets article))
13319 (mh-search-choose)
13320 (if (equal mh-searcher 'pick)
13321 (progn
13322 (mh-search folder (list "--message-id" article))
13323 (when (and org-mhe-search-all-folders
13324 (not (org-mhe-get-message-real-folder)))
13325 (kill-this-buffer)
13326 (mh-search "+" (list "--message-id" article))))
13327 (mh-search "+" article))
13328 (if (org-mhe-get-message-real-folder)
13329 (mh-show-msg 1)
13330 (kill-this-buffer)
13331 (error "Message not found"))))
13333 ;;; BibTeX links
13335 ;; Use the custom search meachnism to construct and use search strings for
13336 ;; file links to BibTeX database entries.
13338 (defun org-create-file-search-in-bibtex ()
13339 "Create the search string and description for a BibTeX database entry."
13340 (when (eq major-mode 'bibtex-mode)
13341 ;; yes, we want to construct this search string.
13342 ;; Make a good description for this entry, using names, year and the title
13343 ;; Put it into the `description' variable which is dynamically scoped.
13344 (let ((bibtex-autokey-names 1)
13345 (bibtex-autokey-names-stretch 1)
13346 (bibtex-autokey-name-case-convert-function 'identity)
13347 (bibtex-autokey-name-separator " & ")
13348 (bibtex-autokey-additional-names " et al.")
13349 (bibtex-autokey-year-length 4)
13350 (bibtex-autokey-name-year-separator " ")
13351 (bibtex-autokey-titlewords 3)
13352 (bibtex-autokey-titleword-separator " ")
13353 (bibtex-autokey-titleword-case-convert-function 'identity)
13354 (bibtex-autokey-titleword-length 'infty)
13355 (bibtex-autokey-year-title-separator ": "))
13356 (setq description (bibtex-generate-autokey)))
13357 ;; Now parse the entry, get the key and return it.
13358 (save-excursion
13359 (bibtex-beginning-of-entry)
13360 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13362 (defun org-execute-file-search-in-bibtex (s)
13363 "Find the link search string S as a key for a database entry."
13364 (when (eq major-mode 'bibtex-mode)
13365 ;; Yes, we want to do the search in this file.
13366 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13367 (goto-char (point-min))
13370 (goto-char (match-beginning 0)))
13371 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13372 ;; Use double prefix to indicate that any web link should be browsed
13373 (let ((b (current-buffer)) (p (point)))
13374 ;; Restore the window configuration because we just use the web link
13375 (set-window-configuration org-window-config-before-follow-link)
13376 (save-excursion (set-buffer b) (goto-char p)
13377 (bibtex-url)))
13378 (recenter 0)) ; Move entry start to beginning of window
13379 ;; return t to indicate that the search is done.
13380 t))
13382 ;; Finally add the functions to the right hooks.
13383 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13384 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13386 ;; end of Bibtex link setup
13388 ;;; Following file links
13390 (defun org-open-file (path &optional in-emacs line search)
13391 "Open the file at PATH.
13392 First, this expands any special file name abbreviations. Then the
13393 configuration variable `org-file-apps' is checked if it contains an
13394 entry for this file type, and if yes, the corresponding command is launched.
13395 If no application is found, Emacs simply visits the file.
13396 With optional argument IN-EMACS, Emacs will visit the file.
13397 Optional LINE specifies a line to go to, optional SEARCH a string to
13398 search for. If LINE or SEARCH is given, the file will always be
13399 opened in Emacs.
13400 If the file does not exist, an error is thrown."
13401 (setq in-emacs (or in-emacs line search))
13402 (let* ((file (if (equal path "")
13403 buffer-file-name
13404 (substitute-in-file-name (expand-file-name path))))
13405 (apps (append org-file-apps (org-default-apps)))
13406 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13407 (dirp (if remp nil (file-directory-p file)))
13408 (dfile (downcase file))
13409 (old-buffer (current-buffer))
13410 (old-pos (point))
13411 (old-mode major-mode)
13412 ext cmd)
13414 (setq ext (match-string 1 dfile))
13416 (setq ext (match-string 1 dfile))))
13417 (if in-emacs
13418 (setq cmd 'emacs)
13419 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13420 (and dirp (cdr (assoc 'directory apps)))
13421 (cdr (assoc ext apps))
13422 (cdr (assoc t apps)))))
13423 (when (eq cmd 'mailcap)
13424 (require 'mailcap)
13425 (mailcap-parse-mailcaps)
13426 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13427 (command (mailcap-mime-info mime-type)))
13428 (if (stringp command)
13429 (setq cmd command)
13430 (setq cmd 'emacs))))
13431 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13432 (not (file-exists-p file))
13433 (not org-open-non-existing-files))
13434 (error "No such file: %s" file))
13435 (cond
13437 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13439 (setq cmd (replace-match "%s" t t cmd)))
13440 (while (string-match "%s" cmd)
13441 (setq cmd (replace-match
13442 (save-match-data (shell-quote-argument file))
13443 t t cmd)))
13444 (save-window-excursion
13445 (start-process-shell-command cmd nil cmd)))
13446 ((or (stringp cmd)
13447 (eq cmd 'emacs))
13448 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13449 (widen)
13450 (if line (goto-line line)
13451 (if search (org-link-search search))))
13452 ((consp cmd)
13453 (eval cmd))
13454 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13455 (and (org-mode-p) (eq old-mode 'org-mode)
13456 (or (not (equal old-buffer (current-buffer)))
13457 (not (equal old-pos (point))))
13458 (org-mark-ring-push old-pos old-buffer))))
13460 (defun org-default-apps ()
13461 "Return the default applications for this operating system."
13462 (cond
13463 ((eq system-type 'darwin)
13464 org-file-apps-defaults-macosx)
13465 ((eq system-type 'windows-nt)
13466 org-file-apps-defaults-windowsnt)
13467 (t org-file-apps-defaults-gnu)))
13469 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13470 (defun org-file-remote-p (file)
13471 "Test whether FILE specifies a location on a remote system.
13472 Return non-nil if the location is indeed remote.
13476 (cond ((fboundp 'file-remote-p)
13477 (file-remote-p file))
13478 ((fboundp 'tramp-handle-file-remote-p)
13479 (tramp-handle-file-remote-p file))
13480 ((and (boundp 'ange-ftp-name-format)
13481 (string-match (car ange-ftp-name-format) file))
13482 t)
13483 (t nil)))
13486 ;;;; Hooks for remember.el, and refiling
13488 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13489 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13491 ;;;###autoload
13492 (defun org-remember-insinuate ()
13493 "Setup remember.el for use wiht Org-mode."
13494 (require 'remember)
13495 (setq remember-annotation-functions '(org-remember-annotation))
13496 (setq remember-handler-functions '(org-remember-handler))
13497 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13499 ;;;###autoload
13500 (defun org-remember-annotation ()
13501 "Return a link to the current location as an annotation for remember.el.
13502 If you are using Org-mode files as target for data storage with
13503 remember.el, then the annotations should include a link compatible with the
13504 conventions in Org-mode. This function returns such a link."
13505 (org-store-link nil))
13507 (defconst org-remember-help
13508 "Select a destination location for the note.
13509 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13510 RET on headline -> Store as sublevel entry to current headline
13511 RET at beg-of-buf -> Append to file as level 2 headline
13512 <left>/<right> -> before/after current headline, same headings level")
13514 (defvar org-remember-previous-location nil)
13515 (defvar org-force-remember-template-char) ;; dynamically scoped
13517 (defun org-select-remember-template (&optional use-char)
13518 (when org-remember-templates
13519 (let* ((templates (mapcar (lambda (x)
13520 (if (stringp (car x))
13521 (append (list (nth 1 x) (car x)) (cddr x))
13522 (append (list (car x) "") (cdr x))))
13523 org-remember-templates))
13524 (char (or use-char
13525 (cond
13526 ((= (length templates) 1)
13527 (caar templates))
13528 ((and (boundp 'org-force-remember-template-char)
13529 org-force-remember-template-char)
13530 (if (stringp org-force-remember-template-char)
13531 (string-to-char org-force-remember-template-char)
13532 org-force-remember-template-char))
13533 (t
13534 (message "Select template: %s"
13535 (mapconcat
13536 (lambda (x)
13537 (cond
13539 (format "[%c]" (car x)))
13540 ((equal (downcase (car x))
13541 (downcase (aref (nth 1 x) 0)))
13542 (format "[%c]%s" (car x)
13543 (substring (nth 1 x) 1)))
13544 (t (format "[%c]%s" (car x) (nth 1 x)))))
13545 templates " "))
13546 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13547 (when (equal char0 ?\C-g)
13548 (jump-to-register remember-register)
13549 (kill-buffer remember-buffer))
13550 char0))))))
13551 (cddr (assoc char templates)))))
13553 (defvar x-last-selected-text)
13554 (defvar x-last-selected-text-primary)
13556 ;;;###autoload
13557 (defun org-remember-apply-template (&optional use-char skip-interactive)
13558 "Initialize *remember* buffer with template, invoke `org-mode'.
13559 This function should be placed into `remember-mode-hook' and in fact requires
13560 to be run from that hook to function properly."
13561 (if org-remember-templates
13562 (let* ((entry (org-select-remember-template use-char))
13563 (tpl (car entry))
13564 (plist-p (if org-store-link-plist t nil))
13565 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13567 (nth 1 entry)
13568 org-default-notes-file))
13569 (headline (nth 2 entry))
13570 (v-c (or (and (eq window-system 'x)
13571 (fboundp 'x-cut-buffer-or-selection-value)
13572 (x-cut-buffer-or-selection-value))
13573 (org-bound-and-true-p x-last-selected-text)
13574 (org-bound-and-true-p x-last-selected-text-primary)
13575 (and (> (length kill-ring) 0) (current-kill 0))))
13576 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13577 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13578 (v-u (concat "[" (substring v-t 1 -1) "]"))
13579 (v-U (concat "[" (substring v-T 1 -1) "]"))
13580 ;; `initial' and `annotation' are bound in `remember'
13581 (v-i (if (boundp 'initial) initial))
13582 (v-a (if (and (boundp 'annotation) annotation)
13583 (if (equal annotation "[[]]") "" annotation)
13584 ""))
13585 (v-A (if (and v-a
13588 v-a))
13589 (v-n user-full-name)
13590 (org-startup-folded nil)
13591 org-time-was-given org-end-time-was-given x
13592 prompt completions char time pos default histvar)
13593 (setq org-store-link-plist
13594 (append (list :annotation v-a :initial v-i)
13595 org-store-link-plist))
13596 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13597 (erase-buffer)
13598 (insert (substitute-command-keys
13599 (format
13600 "## Filing location: Select interactively, default, or last used:
13601 ## %s to select file and header location interactively.
13605 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13606 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13607 (abbreviate-file-name (or file org-default-notes-file))
13608 (or headline "")
13609 (or (car org-remember-previous-location) "???")
13610 (or (cdr org-remember-previous-location) "???"))))
13611 (insert tpl) (goto-char (point-min))
13612 ;; Simple %-escapes
13614 (when (and initial (equal (match-string 0) "%i"))
13615 (save-match-data
13616 (let* ((lead (buffer-substring
13617 (point-at-bol) (match-beginning 0))))
13618 (setq v-i (mapconcat 'identity
13621 (replace-match
13622 (or (eval (intern (concat "v-" (match-string 1)))) "")
13623 t t))
13625 ;; %[] Insert contents of a file.
13626 (goto-char (point-min))
13628 (let ((start (match-beginning 0))
13629 (end (match-end 0))
13630 (filename (expand-file-name (match-string 1))))
13631 (goto-char start)
13632 (delete-region start end)
13633 (condition-case error
13634 (insert-file-contents filename)
13635 (error (insert (format "%%![Couldn't insert %s: %s]"
13636 filename error))))))
13637 ;; %() embedded elisp
13638 (goto-char (point-min))
13640 (goto-char (match-beginning 0))
13641 (let ((template-start (point)))
13642 (forward-char 1)
13643 (let ((result
13644 (condition-case error
13645 (eval (read (current-buffer)))
13646 (error (format "%%![Error: %s]" error)))))
13647 (delete-region template-start (point))
13648 (insert result))))
13650 ;; From the property list
13651 (when plist-p
13652 (goto-char (point-min))
13654 (and (setq x (or (plist-get org-store-link-plist
13655 (intern (match-string 1))) ""))
13656 (replace-match x t t))))
13658 ;; Turn on org-mode in the remember buffer, set local variables
13659 (org-mode)
13660 (org-set-local 'org-finish-function 'org-remember-finalize)
13662 (org-set-local 'org-default-notes-file file))
13664 (org-set-local 'org-remember-default-headline headline))
13665 ;; Interactive template entries
13666 (goto-char (point-min))
13668 (setq char (if (match-end 3) (match-string 3))
13669 prompt (if (match-end 2) (match-string 2)))
13670 (goto-char (match-beginning 0))
13671 (replace-match "")
13672 (setq completions nil default nil)
13673 (when prompt
13674 (setq completions (org-split-string prompt "|")
13675 prompt (pop completions)
13676 default (car completions)
13677 histvar (intern (concat
13678 "org-remember-template-prompt-history::"
13679 (or prompt "")))
13680 completions (mapcar 'list completions)))
13681 (cond
13682 ((member char '("G" "g"))
13683 (let* ((org-last-tags-completion-table
13684 (org-global-tags-completion-table
13685 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13686 (org-add-colon-after-tag-completion t)
13687 (ins (completing-read
13688 (if prompt (concat prompt ": ") "Tags: ")
13689 'org-tags-completion-function nil nil nil
13690 'org-tags-history)))
13691 (setq ins (mapconcat 'identity
13692 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13693 ":"))
13695 (or (equal (char-before) ?:) (insert ":"))
13696 (insert ins)
13697 (or (equal (char-after) ?:) (insert ":")))))
13698 (char
13699 (setq org-time-was-given (equal (upcase char) char))
13700 (setq time (org-read-date (equal (upcase char) "U") t nil
13701 prompt))
13702 (org-insert-time-stamp time org-time-was-given
13703 (member char '("u" "U"))
13704 nil nil (list org-end-time-was-given)))
13705 (t
13706 (insert (org-completing-read
13707 (concat (if prompt prompt "Enter string")
13708 (if default (concat " [" default "]"))
13709 ": ")
13710 completions nil nil nil histvar default)))))
13711 (goto-char (point-min))
13713 (replace-match "")
13715 (org-mode)
13716 (org-set-local 'org-finish-function 'org-remember-finalize))
13717 (when (save-excursion
13718 (goto-char (point-min))
13719 (re-search-forward "%!" nil t))
13720 (replace-match "")
13721 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13723 (defun org-remember-finish-immediately ()
13724 "File remember note immediately.
13725 This should be run in `post-command-hook' and will remove itself
13726 from that hook."
13727 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13728 (when org-finish-function
13729 (funcall org-finish-function)))
13731 (defvar org-clock-marker) ; Defined below
13732 (defun org-remember-finalize ()
13733 "Finalize the remember process."
13734 (unless (fboundp 'remember-finalize)
13735 (defalias 'remember-finalize 'remember-buffer))
13736 (when (and org-clock-marker
13737 (equal (marker-buffer org-clock-marker) (current-buffer)))
13738 ;; FIXME: test this, this is w/o notetaking!
13739 (let (org-log-note-clock-out) (org-clock-out)))
13740 (when buffer-file-name
13741 (save-buffer)
13742 (setq buffer-file-name nil))
13743 (remember-finalize))
13745 ;;;###autoload
13746 (defun org-remember (&optional goto org-force-remember-template-char)
13747 "Call `remember'. If this is already a remember buffer, re-apply template.
13748 If there is an active region, make sure remember uses it as initial content
13749 of the remember buffer.
13751 When called interactively with a `C-u' prefix argument GOTO, don't remember
13752 anything, just go to the file/headline where the selected template usually
13753 stores its notes. With a double prefix arg `C-u C-u', go to the last
13754 note stored by remember.
13756 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13757 associated with a template in `org-remember-templates'."
13758 (interactive "P")
13759 (cond
13760 ((equal goto '(4)) (org-go-to-remember-target))
13761 ((equal goto '(16)) (org-remember-goto-last-stored))
13762 (t
13763 (if (memq org-finish-function '(remember-buffer remember-finalize))
13764 (progn
13765 (when (< (length org-remember-templates) 2)
13766 (error "No other template available"))
13767 (erase-buffer)
13768 (let ((annotation (plist-get org-store-link-plist :annotation))
13769 (initial (plist-get org-store-link-plist :initial)))
13770 (org-remember-apply-template))
13771 (message "Press C-c C-c to remember data"))
13772 (if (org-region-active-p)
13773 (remember (buffer-substring (point) (mark)))
13774 (call-interactively 'remember))))))
13776 (defun org-remember-goto-last-stored ()
13777 "Go to the location where the last remember note was stored."
13778 (interactive)
13779 (bookmark-jump "org-remember-last-stored")
13780 (message "This is the last note stored by remember"))
13782 (defun org-go-to-remember-target (&optional template-key)
13783 "Go to the target location of a remember template.
13784 The user is queried for the template."
13785 (interactive)
13786 (let* ((entry (org-select-remember-template template-key))
13787 (file (nth 1 entry))
13788 (heading (nth 2 entry))
13789 visiting)
13791 (setq file org-default-notes-file))
13793 (setq heading org-remember-default-headline))
13794 (setq visiting (org-find-base-buffer-visiting file))
13795 (if (not visiting) (find-file-noselect file))
13796 (switch-to-buffer (or visiting (get-file-buffer file)))
13797 (widen)
13798 (goto-char (point-min))
13799 (if (re-search-forward
13802 nil t)
13803 (goto-char (match-beginning 0))
13804 (error "Target headline not found: %s" heading))))
13806 (defvar org-note-abort nil) ; dynamically scoped
13808 ;;;###autoload
13809 (defun org-remember-handler ()
13810 "Store stuff from remember.el into an org file.
13811 First prompts for an org file. If the user just presses return, the value
13812 of `org-default-notes-file' is used.
13813 Then the command offers the headings tree of the selected file in order to
13814 file the text at a specific location.
13815 You can either immediately press RET to get the note appended to the
13816 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13817 find a better place. Then press RET or <left> or <right> in insert the note.
13819 Key Cursor position Note gets inserted
13820 -----------------------------------------------------------------------------
13821 RET buffer-start as level 1 heading at end of file
13822 RET on headline as sublevel of the heading at cursor
13823 RET no heading at cursor position, level taken from context.
13824 Or use prefix arg to specify level manually.
13825 <left> on headline as same level, before current heading
13826 <right> on headline as same level, after current heading
13828 So the fastest way to store the note is to press RET RET to append it to
13829 the default file. This way your current train of thought is not
13830 interrupted, in accordance with the principles of remember.el.
13831 You can also get the fast execution without prompting by using
13832 C-u C-c C-c to exit the remember buffer. See also the variable
13833 `org-remember-store-without-prompt'.
13835 Before being stored away, the function ensures that the text has a
13837 is constructed from the current date and some additional data.
13839 If the variable `org-adapt-indentation' is non-nil, the entire text is
13840 also indented so that it starts in the same column as the headline
13841 \(i.e. after the stars).
13843 See also the variable `org-reverse-note-order'."
13844 (goto-char (point-min))
13846 (replace-match ""))
13847 (goto-char (point-max))
13848 (beginning-of-line 1)
13850 (delete-region (1- (point)) (point-max))
13851 (beginning-of-line 1))
13852 (catch 'quit
13853 (if org-note-abort (throw 'quit nil))
13854 (let* ((txt (buffer-substring (point-min) (point-max)))
13855 (fastp (org-xor (equal current-prefix-arg '(4))
13856 org-remember-store-without-prompt))
13857 (file (cond
13858 (fastp org-default-notes-file)
13859 ((and (eq org-remember-interactive-interface 'refile)
13860 org-refile-targets)
13861 org-default-notes-file)
13862 ((not (and (equal current-prefix-arg '(16))
13863 org-remember-previous-location))
13864 (org-get-org-file))))
13865 (heading org-remember-default-headline)
13866 (visiting (and file (org-find-base-buffer-visiting file)))
13867 (org-startup-folded nil)
13868 (org-startup-align-all-tables nil)
13869 (org-goto-start-pos 1)
13870 spos exitcmd level indent reversed)
13871 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13872 (setq file (car org-remember-previous-location)
13873 heading (cdr org-remember-previous-location)
13874 fastp t))
13875 (setq current-prefix-arg nil)
13877 (setq txt (replace-match "" t t txt)))
13878 ;; Modify text so that it becomes a nice subtree which can be inserted
13879 ;; into an org tree.
13881 first)
13882 (setq first (car lines) lines (cdr lines))
13884 ;; Is already a headline
13885 (setq indent nil)
13886 ;; We need to add a headline: Use time and first buffer line
13887 (setq lines (cons first lines)
13888 first (concat "* " (current-time-string)
13889 " (" (remember-buffer-desc) ")")
13890 indent " "))
13891 (if (and org-adapt-indentation indent)
13892 (setq lines (mapcar
13893 (lambda (x)
13895 (concat indent x) x))
13896 lines)))
13903 ;; Put the modified text back into the remember buffer, for refile.
13904 (erase-buffer)
13905 (insert txt)
13906 (goto-char (point-min))
13907 (when (and (eq org-remember-interactive-interface 'refile)
13908 (not fastp))
13909 (org-refile nil (or visiting (find-file-noselect file)))
13910 (throw 'quit t))
13911 ;; Find the file
13912 (if (not visiting) (find-file-noselect file))
13913 (with-current-buffer (or visiting (get-file-buffer file))
13914 (unless (org-mode-p)
13915 (error "Target files for remember notes must be in Org-mode"))
13916 (save-excursion
13917 (save-restriction
13918 (widen)
13919 (and (goto-char (point-min))
13922 (setq reversed (org-notes-order-reversed-p))
13924 ;; Find the default location
13926 (goto-char (point-min))
13927 (if (re-search-forward
13930 nil t)
13931 (setq org-goto-start-pos (match-beginning 0))
13932 (when fastp
13933 (goto-char (point-max))
13934 (unless (bolp) (newline))
13936 (setq org-goto-start-pos (point-at-bol 0)))))
13938 ;; Ask the User for a location, using the appropriate interface
13939 (cond
13940 (fastp (setq spos org-goto-start-pos
13941 exitcmd 'return))
13942 ((eq org-remember-interactive-interface 'outline)
13943 (setq spos (org-get-location (current-buffer)
13944 org-remember-help)
13945 exitcmd (cdr spos)
13946 spos (car spos)))
13947 ((eq org-remember-interactive-interface 'outline-path-completion)
13948 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13949 (org-refile-use-outline-path t))
13950 (setq spos (org-refile-get-location "Heading: ")
13951 exitcmd 'return
13952 spos (nth 3 spos))))
13953 (t (error "this should not hapen")))
13954 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13955 ; not handle this note
13956 (goto-char spos)
13957 (cond ((org-on-heading-p t)
13958 (org-back-to-heading t)
13959 (setq level (funcall outline-level))
13960 (cond
13961 ((eq exitcmd 'return)
13962 ;; sublevel of current
13963 (setq org-remember-previous-location
13964 (cons (abbreviate-file-name file)
13965 (org-get-heading 'notags)))
13966 (if reversed
13967 (outline-next-heading)
13968 (org-end-of-subtree t)
13969 (if (not (bolp))
13971 (beginning-of-line 2)
13972 (end-of-line 1)
13974 (bookmark-set "org-remember-last-stored")
13975 (org-paste-subtree (org-get-legal-level level 1) txt))
13976 ((eq exitcmd 'left)
13977 ;; before current
13978 (bookmark-set "org-remember-last-stored")
13979 (org-paste-subtree level txt))
13980 ((eq exitcmd 'right)
13981 ;; after current
13982 (org-end-of-subtree t)
13983 (bookmark-set "org-remember-last-stored")
13984 (org-paste-subtree level txt))
13985 (t (error "This should not happen"))))
13987 ((and (bobp) (not reversed))
13988 ;; Put it at the end, one level below level 1
13989 (save-restriction
13990 (widen)
13991 (goto-char (point-max))
13992 (if (not (bolp)) (newline))
13993 (bookmark-set "org-remember-last-stored")
13994 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13996 ((and (bobp) reversed)
13997 ;; Put it at the start, as level 1
13998 (save-restriction
13999 (widen)
14000 (goto-char (point-min))
14002 (beginning-of-line 1)
14003 (bookmark-set "org-remember-last-stored")
14004 (org-paste-subtree 1 txt)))
14005 (t
14006 ;; Put it right there, with automatic level determined by
14007 ;; org-paste-subtree or from prefix arg
14008 (bookmark-set "org-remember-last-stored")
14009 (org-paste-subtree
14010 (if (numberp current-prefix-arg) current-prefix-arg)
14011 txt)))
14012 (when remember-save-after-remembering
14013 (save-buffer)
14014 (if (not visiting) (kill-buffer (current-buffer)))))))))
14016 t) ;; return t to indicate that we took care of this note.
14018 (defun org-get-org-file ()
14019 "Read a filename, with default directory `org-directory'."
14020 (let ((default (or org-default-notes-file remember-data-file)))
14021 (read-file-name (format "File name [%s]: " default)
14022 (file-name-as-directory org-directory)
14023 default)))
14025 (defun org-notes-order-reversed-p ()
14026 "Check if the current file should receive notes in reversed order."
14027 (cond
14028 ((not org-reverse-note-order) nil)
14029 ((eq t org-reverse-note-order) t)
14030 ((not (listp org-reverse-note-order)) nil)
14031 (t (catch 'exit
14032 (let ((all org-reverse-note-order)
14033 entry)
14034 (while (setq entry (pop all))
14035 (if (string-match (car entry) buffer-file-name)
14036 (throw 'exit (cdr entry))))
14037 nil)))))
14039 ;;; Refiling
14041 (defvar org-refile-target-table nil
14042 "The list of refile targets, created by `org-refile'.")
14044 (defvar org-agenda-new-buffers nil
14045 "Buffers created to visit agenda files.")
14047 (defun org-get-refile-targets (&optional default-buffer)
14048 "Produce a table with refile targets."
14049 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
14050 targets txt re files f desc descre)
14051 (with-current-buffer (or default-buffer (current-buffer))
14052 (while (setq entry (pop entries))
14053 (setq files (car entry) desc (cdr entry))
14054 (cond
14055 ((null files) (setq files (list (current-buffer))))
14056 ((eq files 'org-agenda-files)
14057 (setq files (org-agenda-files 'unrestricted)))
14058 ((and (symbolp files) (fboundp files))
14059 (setq files (funcall files)))
14060 ((and (symbolp files) (boundp files))
14061 (setq files (symbol-value files))))
14062 (if (stringp files) (setq files (list files)))
14063 (cond
14064 ((eq (car desc) :tag)
14066 ((eq (car desc) :todo)
14068 ((eq (car desc) :regexp)
14069 (setq descre (cdr desc)))
14070 ((eq (car desc) :level)
14072 (if org-odd-levels-only
14073 (1- (* 2 (cdr desc)))
14074 (cdr desc)))
14076 ((eq (car desc) :maxlevel)
14078 (if org-odd-levels-only
14079 (1- (* 2 (cdr desc)))
14080 (cdr desc)))
14082 (t (error "Bad refiling target description %s" desc)))
14083 (while (setq f (pop files))
14084 (save-excursion
14085 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14086 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14087 (save-excursion
14088 (save-restriction
14089 (widen)
14090 (goto-char (point-min))
14091 (while (re-search-forward descre nil t)
14092 (goto-char (point-at-bol))
14093 (when (looking-at org-complex-heading-regexp)
14094 (setq txt (match-string 4)
14095 re (concat "^" (regexp-quote
14096 (buffer-substring (match-beginning 1)
14097 (match-end 4)))))
14099 (regexp-quote
14100 (match-string 5)))))
14102 (when org-refile-use-outline-path
14103 (setq txt (mapconcat 'identity
14104 (append
14105 (if (eq org-refile-use-outline-path 'file)
14106 (list (file-name-nondirectory
14107 (buffer-file-name (buffer-base-buffer))))
14108 (if (eq org-refile-use-outline-path 'full-file-path)
14109 (list (buffer-file-name (buffer-base-buffer)))))
14110 (org-get-outline-path)
14111 (list txt))
14112 "/")))
14113 (push (list txt f re (point)) targets))
14114 (goto-char (point-at-eol))))))))
14115 (nreverse targets))))
14117 (defun org-get-outline-path ()
14118 "Return the outline path to the current entry, as a list."
14119 (let (rtn)
14120 (save-excursion
14121 (while (org-up-heading-safe)
14122 (when (looking-at org-complex-heading-regexp)
14123 (push (org-match-string-no-properties 4) rtn)))
14124 rtn)))
14126 (defvar org-refile-history nil
14127 "History for refiling operations.")
14129 (defun org-refile (&optional goto default-buffer)
14130 "Move the entry at point to another heading.
14131 The list of target headings is compiled using the information in
14132 `org-refile-targets', which see. This list is created upon first use, and
14133 you can update it by calling this command with a double prefix (`C-u C-u').
14134 FIXME: Can we find a better way of updating?
14136 At the target location, the entry is filed as a subitem of the target heading.
14137 Depending on `org-reverse-note-order', the new subitem will either be the
14138 first of the last subitem.
14140 With prefix arg GOTO, the command will only visit the target location,
14141 not actually move anything.
14142 With a double prefix `C-c C-c', go to the location where the last refiling
14143 operation has put the subtree.
14145 With a double prefix argument, the command can be used to jump to any
14146 heading in the current buffer."
14147 (interactive "P")
14148 (let* ((cbuf (current-buffer))
14149 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14150 pos it nbuf file re level reversed)
14151 (if (equal goto '(16))
14152 (org-refile-goto-last-stored)
14153 (when (setq it (org-refile-get-location
14154 (if goto "Goto: " "Refile to: ") default-buffer))
14155 (setq file (nth 1 it)
14156 re (nth 2 it)
14157 pos (nth 3 it))
14158 (setq nbuf (or (find-buffer-visiting file)
14159 (find-file-noselect file)))
14160 (if goto
14161 (progn
14162 (switch-to-buffer nbuf)
14163 (goto-char pos)
14164 (org-show-context 'org-goto))
14165 (org-copy-special)
14166 (save-excursion
14167 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14168 (find-file-noselect file))))
14169 (setq reversed (org-notes-order-reversed-p))
14170 (save-excursion
14171 (save-restriction
14172 (widen)
14173 (goto-char pos)
14174 (looking-at outline-regexp)
14175 (setq level (org-get-legal-level (funcall outline-level) 1))
14176 (goto-char
14177 (if reversed
14178 (outline-next-heading)
14179 (or (save-excursion (outline-get-next-sibling))
14180 (org-end-of-subtree t t)
14181 (point-max))))
14182 (bookmark-set "org-refile-last-stored")
14183 (org-paste-subtree level))))
14184 (org-cut-special)
14187 (defun org-refile-goto-last-stored ()
14188 "Go to the location where the last refile was stored."
14189 (interactive)
14190 (bookmark-jump "org-refile-last-stored")
14191 (message "This is the location of the last refile"))
14193 (defun org-refile-get-location (&optional prompt default-buffer)
14194 "Prompt the user for a refile location, using PROMPT."
14195 (let ((org-refile-targets org-refile-targets)
14196 (org-refile-use-outline-path org-refile-use-outline-path))
14197 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14198 (unless org-refile-target-table
14199 (error "No refile targets"))
14200 (let* ((cbuf (current-buffer))
14201 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14202 (fname (and filename (file-truename filename)))
14203 (tbl (mapcar
14204 (lambda (x)
14205 (if (not (equal fname (file-truename (nth 1 x))))
14206 (cons (concat (car x) " (" (file-name-nondirectory
14207 (nth 1 x)) ")")
14208 (cdr x))
14209 x))
14210 org-refile-target-table))
14211 (completion-ignore-case t))
14212 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14213 tbl)))
14215 ;;;; Dynamic blocks
14217 (defun org-find-dblock (name)
14218 "Find the first dynamic block with name NAME in the buffer.
14219 If not found, stay at current position and return nil."
14220 (let (pos)
14221 (save-excursion
14222 (goto-char (point-min))
14224 nil t)
14225 (match-beginning 0))))
14226 (if pos (goto-char pos))
14227 pos))
14229 (defconst org-dblock-start-re
14231 "Matches the startline of a dynamic block, with parameters.")
14234 "Matches the end of a dyhamic block.")
14236 (defun org-create-dblock (plist)
14237 "Create a dynamic block section, with parameters taken from PLIST.
14238 PLIST must containe a :name entry which is used as name of the block."
14239 (unless (bolp) (newline))
14240 (let ((name (plist-get plist :name)))
14241 (insert "#+BEGIN: " name)
14242 (while plist
14243 (if (eq (car plist) :name)
14244 (setq plist (cddr plist))
14245 (insert " " (prin1-to-string (pop plist)))))
14247 (beginning-of-line -2)))
14249 (defun org-prepare-dblock ()
14250 "Prepare dynamic block for refresh.
14251 This empties the block, puts the cursor at the insert position and returns
14252 the property list including an extra property :name with the block name."
14253 (unless (looking-at org-dblock-start-re)
14254 (error "Not at a dynamic block"))
14255 (let* ((begdel (1+ (match-end 0)))
14256 (name (org-no-properties (match-string 1)))
14257 (params (append (list :name name)
14258 (read (concat "(" (match-string 3) ")")))))
14259 (unless (re-search-forward org-dblock-end-re nil t)
14260 (error "Dynamic block not terminated"))
14261 (delete-region begdel (match-beginning 0))
14262 (goto-char begdel)
14263 (open-line 1)
14264 params))
14266 (defun org-map-dblocks (&optional command)
14267 "Apply COMMAND to all dynamic blocks in the current buffer.
14268 If COMMAND is not given, use `org-update-dblock'."
14269 (let ((cmd (or command 'org-update-dblock))
14270 pos)
14271 (save-excursion
14272 (goto-char (point-min))
14273 (while (re-search-forward org-dblock-start-re nil t)
14274 (goto-char (setq pos (match-beginning 0)))
14275 (condition-case nil
14276 (funcall cmd)
14277 (error (message "Error during update of dynamic block")))
14278 (goto-char pos)
14279 (unless (re-search-forward org-dblock-end-re nil t)
14280 (error "Dynamic block not terminated"))))))
14282 (defun org-dblock-update (&optional arg)
14283 "User command for updating dynamic blocks.
14284 Update the dynamic block at point. With prefix ARG, update all dynamic
14285 blocks in the buffer."
14286 (interactive "P")
14287 (if arg
14288 (org-update-all-dblocks)
14289 (or (looking-at org-dblock-start-re)
14290 (org-beginning-of-dblock))
14291 (org-update-dblock)))
14293 (defun org-update-dblock ()
14294 "Update the dynamic block at point
14295 This means to empty the block, parse for parameters and then call
14296 the correct writing function."
14297 (save-window-excursion
14298 (let* ((pos (point))
14299 (line (org-current-line))
14300 (params (org-prepare-dblock))
14301 (name (plist-get params :name))
14302 (cmd (intern (concat "org-dblock-write:" name))))
14303 (message "Updating dynamic block `%s' at line %d..." name line)
14304 (funcall cmd params)
14305 (message "Updating dynamic block `%s' at line %d...done" name line)
14306 (goto-char pos))))
14308 (defun org-beginning-of-dblock ()
14309 "Find the beginning of the dynamic block at point.
14310 Error if there is no scuh block at point."
14311 (let ((pos (point))
14312 beg)
14313 (end-of-line 1)
14314 (if (and (re-search-backward org-dblock-start-re nil t)
14315 (setq beg (match-beginning 0))
14316 (re-search-forward org-dblock-end-re nil t)
14317 (> (match-end 0) pos))
14318 (goto-char beg)
14319 (goto-char pos)
14320 (error "Not in a dynamic block"))))
14322 (defun org-update-all-dblocks ()
14323 "Update all dynamic blocks in the buffer.
14324 This function can be used in a hook."
14325 (when (org-mode-p)
14326 (org-map-dblocks 'org-update-dblock)))
14329 ;;;; Completion
14331 (defconst org-additional-option-like-keywords
14332 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14333 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14334 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14336 (defun org-complete (&optional arg)
14337 "Perform completion on word at point.
14338 At the beginning of a headline, this completes TODO keywords as given in
14339 `org-todo-keywords'.
14340 If the current word is preceded by a backslash, completes the TeX symbols
14341 that are supported for HTML support.
14343 setting file options.
14345 At all other locations, this simply calls the value of
14346 `org-completion-fallback-command'."
14347 (interactive "P")
14348 (org-without-partial-completion
14349 (catch 'exit
14350 (let* ((end (point))
14351 (beg1 (save-excursion
14352 (skip-chars-backward (org-re "[:alnum:]_@"))
14353 (point)))
14354 (beg (save-excursion
14355 (skip-chars-backward "a-zA-Z0-9_:$")
14356 (point)))
14357 (confirm (lambda (x) (stringp (car x))))
14358 (searchhead (equal (char-before beg) ?*))
14359 (tag (and (equal (char-before beg1) ?:)
14360 (equal (char-after (point-at-bol)) ?*)))
14361 (prop (and (equal (char-before beg1) ?:)
14362 (not (equal (char-after (point-at-bol)) ?*))))
14364 (link (equal (char-before beg) ?\[))
14365 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14366 beg)
14367 "#+"))
14369 (buffer-substring (point-at-bol) (point))))
14370 (completion-ignore-case opt)
14371 (type nil)
14372 (tbl nil)
14373 (table (cond
14374 (opt
14375 (setq type :opt)
14376 (append
14377 (mapcar
14378 (lambda (x)
14380 (cons (match-string 2 x) (match-string 1 x)))
14382 (mapcar 'list org-additional-option-like-keywords)))
14383 (startup
14384 (setq type :startup)
14385 org-startup-options)
14386 (link (append org-link-abbrev-alist-local
14387 org-link-abbrev-alist))
14388 (texp
14389 (setq type :tex)
14390 org-html-entities)
14392 (buffer-substring (point-at-bol) beg))
14393 (setq type :todo)
14394 (mapcar 'list org-todo-keywords-1))
14395 (searchhead
14396 (setq type :searchhead)
14397 (save-excursion
14398 (goto-char (point-min))
14399 (while (re-search-forward org-todo-line-regexp nil t)
14400 (push (list
14401 (org-make-org-heading-search-string
14402 (match-string 3) t))
14403 tbl)))
14404 tbl)
14405 (tag (setq type :tag beg beg1)
14406 (or org-tag-alist (org-get-buffer-tags)))
14407 (prop (setq type :prop beg beg1)
14408 (mapcar 'list (org-buffer-property-keys nil t t)))
14409 (t (progn
14410 (call-interactively org-completion-fallback-command)
14411 (throw 'exit nil)))))
14412 (pattern (buffer-substring-no-properties beg end))
14413 (completion (try-completion pattern table confirm)))
14414 (cond ((eq completion t)
14415 (if (not (assoc (upcase pattern) table))
14416 (message "Already complete")
14417 (if (equal type :opt)
14418 (insert (substring (cdr (assoc (upcase pattern) table))
14419 (length pattern)))
14420 (if (memq type '(:tag :prop)) (insert ":")))))
14421 ((null completion)
14423 (ding))
14424 ((not (string= pattern completion))
14425 (delete-region beg end)
14426 (if (string-match " +$" completion)
14427 (setq completion (replace-match "" t t completion)))
14428 (insert completion)
14429 (if (get-buffer-window "*Completions*")
14430 (delete-window (get-buffer-window "*Completions*")))
14431 (if (assoc completion table)
14432 (if (eq type :todo) (insert " ")
14433 (if (memq type '(:tag :prop)) (insert ":"))))
14434 (if (and (equal type :opt) (assoc completion table))
14435 (message "%s" (substitute-command-keys
14437 (t
14438 (message "Making completion list...")
14439 (let ((list (sort (all-completions pattern table confirm)
14440 'string<)))
14441 (with-output-to-temp-buffer "*Completions*"
14442 (condition-case nil
14443 ;; Protection needed for XEmacs and emacs 21
14444 (display-completion-list list pattern)
14445 (error (display-completion-list list)))))
14446 (message "Making completion list...%s" "done")))))))
14448 ;;;; TODO, DEADLINE, Comments
14450 (defun org-toggle-comment ()
14451 "Change the COMMENT state of an entry."
14452 (interactive)
14453 (save-excursion
14454 (org-back-to-heading)
14455 (let (case-fold-search)
14456 (if (looking-at (concat outline-regexp
14458 (replace-match "" t t nil 1)
14459 (if (looking-at outline-regexp)
14460 (progn
14461 (goto-char (match-end 0))
14462 (insert org-comment-string " ")))))))
14464 (defvar org-last-todo-state-is-todo nil
14465 "This is non-nil when the last TODO state change led to a TODO state.
14466 If the last change removed the TODO tag or switched to DONE, then
14467 this is nil.")
14469 (defvar org-setting-tags nil) ; dynamically skiped
14471 ;; FIXME: better place
14472 (defun org-property-or-variable-value (var &optional inherit)
14473 "Check if there is a property fixing the value of VAR.
14474 If yes, return this value. If not, return the current value of the variable."
14475 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14477 (read prop)
14478 (symbol-value var))))
14480 (defun org-parse-local-options (string var)
14481 "Parse STRING for startup setting relevant for variable VAR."
14482 (let ((rtn (symbol-value var))
14483 e opts)
14484 (save-match-data
14486 rtn
14487 (setq opts (delq nil (mapcar (lambda (x)
14488 (setq e (assoc x org-startup-options))
14489 (if (eq (nth 1 e) var) e nil))
14491 (if (not opts)
14492 rtn
14493 (setq rtn nil)
14494 (while (setq e (pop opts))
14495 (if (not (nth 3 e))
14496 (setq rtn (nth 2 e))
14497 (if (not (listp rtn)) (setq rtn nil))
14498 (push (nth 2 e) rtn)))
14499 rtn)))))
14501 (defvar org-blocker-hook nil
14502 "Hook for functions that are allowed to block a state change.
14504 Each function gets as its single argument a property list, see
14505 `org-trigger-hook' for more information about this list.
14507 If any of the functions in this hook returns nil, the state change
14508 is blocked.")
14510 (defvar org-trigger-hook nil
14511 "Hook for functions that are triggered by a state change.
14513 Each function gets as its single argument a property list with at least
14514 the following elements:
14516 (:type type-of-change :position pos-at-entry-start
14517 :from old-state :to new-state)
14519 Depending on the type, more properties may be present.
14521 This mechanism is currently implemented for:
14523 TODO state changes
14524 ------------------
14525 :type todo-state-change
14526 :from previous state (keyword as a string), or nil
14527 :to new state (keyword as a string), or nil")
14530 (defun org-todo (&optional arg)
14531 "Change the TODO state of an item.
14532 The state of an item is given by a keyword at the start of the heading,
14533 like
14534 *** TODO Write paper
14535 *** DONE Call mom
14537 The different keywords are specified in the variable `org-todo-keywords'.
14539 So for this example: when the item starts with TODO, it is changed to DONE.
14540 When it starts with DONE, the DONE is removed. And when neither TODO nor
14541 DONE are present, add TODO at the beginning of the heading.
14543 With C-u prefix arg, use completion to determine the new state.
14544 With numeric prefix arg, switch to that state.
14546 For calling through lisp, arg is also interpreted in the following way:
14547 'none -> empty state
14549 'done -> switch to DONE
14550 'nextset -> switch to the next set of keywords
14551 'previousset -> switch to the previous set of keywords
14553 really is a member of `org-todo-keywords'."
14554 (interactive "P")
14555 (save-excursion
14556 (catch 'exit
14557 (org-back-to-heading)
14558 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14559 (or (looking-at (concat " +" org-todo-regexp " *"))
14560 (looking-at " *"))
14561 (let* ((match-data (match-data))
14562 (startpos (point-at-bol))
14563 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14564 (org-log-done org-log-done)
14565 (org-log-repeat org-log-repeat)
14566 (org-todo-log-states org-todo-log-states)
14567 (this (match-string 1))
14568 (hl-pos (match-beginning 0))
14569 (head (org-get-todo-sequence-head this))
14570 (ass (assoc head org-todo-kwd-alist))
14571 (interpret (nth 1 ass))
14572 (done-word (nth 3 ass))
14573 (final-done-word (nth 4 ass))
14574 (last-state (or this ""))
14575 (completion-ignore-case t)
14576 (member (member this org-todo-keywords-1))
14577 (tail (cdr member))
14578 (state (cond
14579 ((and org-todo-key-trigger
14580 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14581 (and (not arg) org-use-fast-todo-selection
14582 (not (eq org-use-fast-todo-selection 'prefix)))))
14583 ;; Use fast selection
14584 (org-fast-todo-selection))
14585 ((and (equal arg '(4))
14586 (or (not org-use-fast-todo-selection)
14587 (not org-todo-key-trigger)))
14588 ;; Read a state with completion
14589 (completing-read "State: " (mapcar (lambda(x) (list x))
14590 org-todo-keywords-1)
14591 nil t))
14592 ((eq arg 'right)
14593 (if this
14594 (if tail (car tail) nil)
14595 (car org-todo-keywords-1)))
14596 ((eq arg 'left)
14597 (if (equal member org-todo-keywords-1)
14598 nil
14599 (if this
14600 (nth (- (length org-todo-keywords-1) (length tail) 2)
14601 org-todo-keywords-1)
14602 (org-last org-todo-keywords-1))))
14603 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14604 (setq arg nil))) ; hack to fall back to cycling
14605 (arg
14606 ;; user or caller requests a specific state
14607 (cond
14608 ((equal arg "") nil)
14609 ((eq arg 'none) nil)
14610 ((eq arg 'done) (or done-word (car org-done-keywords)))
14611 ((eq arg 'nextset)
14612 (or (car (cdr (member head org-todo-heads)))
14613 (car org-todo-heads)))
14614 ((eq arg 'previousset)
14615 (let ((org-todo-heads (reverse org-todo-heads)))
14616 (or (car (cdr (member head org-todo-heads)))
14617 (car org-todo-heads))))
14618 ((car (member arg org-todo-keywords-1)))
14619 ((nth (1- (prefix-numeric-value arg))
14620 org-todo-keywords-1))))
14621 ((null member) (or head (car org-todo-keywords-1)))
14622 ((equal this final-done-word) nil) ;; -> make empty
14623 ((null tail) nil) ;; -> first entry
14624 ((eq interpret 'sequence)
14625 (car tail))
14626 ((memq interpret '(type priority))
14627 (if (eq this-command last-command)
14628 (car tail)
14629 (if (> (length tail) 0)
14630 (or done-word (car org-done-keywords))
14631 nil)))
14632 (t nil)))
14633 (next (if state (concat " " state " ") " "))
14634 (change-plist (list :type 'todo-state-change :from this :to state
14635 :position startpos))
14636 dolog now-done-p)
14637 (when org-blocker-hook
14638 (unless (save-excursion
14639 (save-match-data
14640 (run-hook-with-args-until-failure
14641 'org-blocker-hook change-plist)))
14642 (if (interactive-p)
14643 (error "TODO state change from %s to %s blocked" this state)
14644 ;; fail silently
14645 (message "TODO state change from %s to %s blocked" this state)
14646 (throw 'exit nil))))
14647 (store-match-data match-data)
14648 (replace-match next t t)
14649 (unless (pos-visible-in-window-p hl-pos)
14650 (message "TODO state changed to %s" (org-trim next)))
14651 (unless head
14652 (setq head (org-get-todo-sequence-head state)
14653 ass (assoc head org-todo-kwd-alist)
14654 interpret (nth 1 ass)
14655 done-word (nth 3 ass)
14656 final-done-word (nth 4 ass)))
14657 (when (memq arg '(nextset previousset))
14658 (message "Keyword-Set %d/%d: %s"
14659 (- (length org-todo-sets) -1
14660 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14661 (length org-todo-sets)
14662 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14663 (setq org-last-todo-state-is-todo
14664 (not (member state org-done-keywords)))
14665 (setq now-done-p (and (member state org-done-keywords)
14666 (not (member this org-done-keywords))))
14667 (and logging (org-local-logging logging))
14668 (when (and (or org-todo-log-states org-log-done)
14669 (not (memq arg '(nextset previousset))))
14670 ;; we need to look at recording a time and note
14671 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14672 (nth 2 (assoc this org-todo-log-states))))
14673 (when (and state
14674 (member state org-not-done-keywords)
14675 (not (member this org-not-done-keywords)))
14676 ;; This is now a todo state and was not one before
14677 ;; If there was a CLOSED time stamp, get rid of it.
14678 (org-add-planning-info nil nil 'closed))
14679 (when (and now-done-p org-log-done)
14680 ;; It is now done, and it was not done before
14681 (org-add-planning-info 'closed (org-current-time))
14682 (if (and (not dolog) (eq 'note org-log-done))
14683 (org-add-log-maybe 'done state 'findpos 'note)))
14684 (when (and state dolog)
14685 ;; This is a non-nil state, and we need to log it
14686 (org-add-log-maybe 'state state 'findpos dolog)))
14687 ;; Fixup tag positioning
14688 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14689 (run-hooks 'org-after-todo-state-change-hook)
14690 (if (and arg (not (member state org-done-keywords)))
14691 (setq head (org-get-todo-sequence-head state)))
14692 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14693 ;; Do we need to trigger a repeat?
14694 (when now-done-p (org-auto-repeat-maybe state))
14695 ;; Fixup cursor location if close to the keyword
14696 (if (and (outline-on-heading-p)
14697 (not (bolp))
14698 (save-excursion (beginning-of-line 1)
14699 (looking-at org-todo-line-regexp))
14700 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14701 (progn
14702 (goto-char (or (match-end 2) (match-end 1)))
14703 (just-one-space)))
14704 (when org-trigger-hook
14705 (save-excursion
14706 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14708 (defun org-local-logging (value)
14709 "Get logging settings from a property VALUE."
14710 (let* (words w a)
14711 ;; directly set the variables, they are already local.
14712 (setq org-log-done nil
14713 org-log-repeat nil
14714 org-todo-log-states nil)
14715 (setq words (org-split-string value))
14716 (while (setq w (pop words))
14717 (cond
14718 ((setq a (assoc w org-startup-options))
14719 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14720 (set (nth 1 a) (nth 2 a))))
14721 ((setq a (org-extract-log-state-settings w))
14722 (and (member (car a) org-todo-keywords-1)
14723 (push a org-todo-log-states)))))))
14725 (defun org-get-todo-sequence-head (kwd)
14726 "Return the head of the TODO sequence to which KWD belongs.
14727 If KWD is not set, check if there is a text property remembering the
14728 right sequence."
14729 (let (p)
14730 (cond
14731 ((not kwd)
14732 (or (get-text-property (point-at-bol) 'org-todo-head)
14733 (progn
14734 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14735 nil (point-at-eol)))
14736 (get-text-property p 'org-todo-head))))
14737 ((not (member kwd org-todo-keywords-1))
14738 (car org-todo-keywords-1))
14739 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14741 (defun org-fast-todo-selection ()
14742 "Fast TODO keyword selection with single keys.
14743 Returns the new TODO keyword, or nil if no state change should occur."
14744 (let* ((fulltable org-todo-key-alist)
14745 (done-keywords org-done-keywords) ;; needed for the faces.
14746 (maxlen (apply 'max (mapcar
14747 (lambda (x)
14748 (if (stringp (car x)) (string-width (car x)) 0))
14749 fulltable)))
14750 (expert nil)
14751 (fwidth (+ maxlen 3 1 3))
14752 (ncol (/ (- (window-width) 4) fwidth))
14753 tg cnt e c tbl
14754 groups ingroup)
14755 (save-window-excursion
14756 (if expert
14757 (set-buffer (get-buffer-create " *Org todo*"))
14758 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14759 (erase-buffer)
14760 (org-set-local 'org-done-keywords done-keywords)
14761 (setq tbl fulltable cnt 0)
14762 (while (setq e (pop tbl))
14763 (cond
14764 ((equal e '(:startgroup))
14765 (push '() groups) (setq ingroup t)
14766 (when (not (= cnt 0))
14767 (setq cnt 0)
14769 (insert "{ "))
14770 ((equal e '(:endgroup))
14771 (setq ingroup nil cnt 0)
14773 (t
14774 (setq tg (car e) c (cdr e))
14775 (if ingroup (push tg (car groups)))
14776 (setq tg (org-add-props tg nil 'face
14777 (org-get-todo-face tg)))
14778 (if (and (= cnt 0) (not ingroup)) (insert " "))
14779 (insert "[" c "] " tg (make-string
14780 (- fwidth 4 (length tg)) ?\ ))
14781 (when (= (setq cnt (1+ cnt)) ncol)
14783 (if ingroup (insert " "))
14784 (setq cnt 0)))))
14786 (goto-char (point-min))
14787 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14788 (fit-window-to-buffer))
14789 (message "[a-z..]:Set [SPC]:clear")
14790 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14791 (cond
14792 ((or (= c ?\C-g)
14793 (and (= c ?q) (not (rassoc c fulltable))))
14794 (setq quit-flag t))
14795 ((= c ?\ ) nil)
14796 ((setq e (rassoc c fulltable) tg (car e))
14797 tg)
14798 (t (setq quit-flag t))))))
14800 (defun org-get-repeat ()
14801 "Check if tere is a deadline/schedule with repeater in this entry."
14802 (save-match-data
14803 (save-excursion
14804 (org-back-to-heading t)
14805 (if (re-search-forward
14806 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14807 (match-string 1)))))
14809 (defvar org-last-changed-timestamp)
14810 (defvar org-log-post-message)
14811 (defvar org-log-note-purpose)
14812 (defun org-auto-repeat-maybe (done-word)
14813 "Check if the current headline contains a repeated deadline/schedule.
14814 If yes, set TODO state back to what it was and change the base date
14815 of repeating deadline/scheduled time stamps to new date.
14816 This function should be run in the `org-after-todo-state-change-hook'."
14817 ;; last-state is dynamically scoped into this function
14818 (let* ((repeat (org-get-repeat))
14819 (aa (assoc last-state org-todo-kwd-alist))
14820 (interpret (nth 1 aa))
14821 (head (nth 2 aa))
14822 (whata '(("d" . day) ("m" . month) ("y" . year)))
14823 (msg "Entry repeats: ")
14824 (org-log-done nil)
14825 re type n what ts)
14826 (when repeat
14827 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
14828 (org-todo (if (eq interpret 'type) last-state head))
14829 (when (and org-log-repeat
14830 (or (not (memq 'org-add-log-note
14831 (default-value 'post-command-hook)))
14832 (eq org-log-note-purpose 'done)))
14833 ;; Make sure a note is taken;
14834 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
14835 'findpos org-log-repeat))
14836 (org-back-to-heading t)
14837 (org-add-planning-info nil nil 'closed)
14841 (while (re-search-forward
14842 re (save-excursion (outline-next-heading) (point)) t)
14843 (setq type (if (match-end 1) org-scheduled-string
14844 (if (match-end 3) org-deadline-string "Plain:"))
14845 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14847 (setq n (string-to-number (match-string 1 ts))
14848 what (match-string 2 ts))
14849 (if (equal what "w") (setq n (* n 7) what "d"))
14850 (org-timestamp-change n (cdr (assoc what whata)))
14851 (setq msg (concat msg type org-last-changed-timestamp " "))))
14852 (setq org-log-post-message msg)
14853 (message "%s" msg))))
14855 (defun org-show-todo-tree (arg)
14856 "Make a compact tree which shows all headlines marked with TODO.
14857 The tree will show the lines where the regexp matches, and all higher
14858 headlines above the match.
14860 With a numeric prefix N, construct a sparse tree for the Nth element
14861 of `org-todo-keywords-1'."
14862 (interactive "P")
14863 (let ((case-fold-search nil)
14864 (kwd-re
14865 (cond ((null arg) org-not-done-regexp)
14866 ((equal arg '(4))
14867 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14868 (mapcar 'list org-todo-keywords-1))))
14872 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14873 (regexp-quote (nth (1- (prefix-numeric-value arg))
14874 org-todo-keywords-1)))
14875 (t (error "Invalid prefix argument: %s" arg)))))
14876 (message "%d TODO entries found"
14877 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14879 (defun org-deadline (&optional remove)
14881 With argument REMOVE, remove any deadline from the item."
14882 (interactive "P")
14883 (if remove
14884 (progn
14885 (org-remove-timestamp-with-keyword org-deadline-string)
14886 (message "Item no longer has a deadline."))
14887 (org-add-planning-info 'deadline nil 'closed)))
14889 (defun org-schedule (&optional remove)
14890 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14891 With argument REMOVE, remove any scheduling date from the item."
14892 (interactive "P")
14893 (if remove
14894 (progn
14895 (org-remove-timestamp-with-keyword org-scheduled-string)
14896 (message "Item is no longer scheduled."))
14897 (org-add-planning-info 'scheduled nil 'closed)))
14899 (defun org-remove-timestamp-with-keyword (keyword)
14900 "Remove all time stamps with KEYWORD in the current entry."
14902 beg)
14903 (save-excursion
14904 (org-back-to-heading t)
14905 (setq beg (point))
14906 (org-end-of-subtree t t)
14907 (while (re-search-backward re beg t)
14908 (replace-match "")
14910 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14912 (defun org-add-planning-info (what &optional time &rest remove)
14913 "Insert new timestamp with keyword in the line directly after the headline.
14914 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14915 If non is given, the user is prompted for a date.
14916 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14917 be removed."
14918 (interactive)
14919 (let (org-time-was-given org-end-time-was-given)
14920 (when what (setq time (or time (org-read-date nil 'to-time))))
14921 (when (and org-insert-labeled-timestamps-at-point
14922 (member what '(scheduled deadline)))
14923 (insert
14924 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14925 (org-insert-time-stamp time org-time-was-given
14926 nil nil nil (list org-end-time-was-given))
14927 (setq what nil))
14928 (save-excursion
14929 (save-restriction
14930 (let (col list elt ts buffer-invisibility-spec)
14931 (org-back-to-heading t)
14933 (goto-char (match-end 1))
14934 (setq col (current-column))
14935 (goto-char (match-end 0))
14937 (if (and (not (looking-at outline-regexp))
14940 (not (equal (match-string 1) org-clock-string)))
14941 (narrow-to-region (match-beginning 0) (match-end 0))
14943 (backward-char 1)
14944 (narrow-to-region (point) (point))
14945 (indent-to-column col))
14946 ;; Check if we have to remove something.
14947 (setq list (cons what remove))
14948 (while list
14949 (setq elt (pop list))
14950 (goto-char (point-min))
14951 (when (or (and (eq elt 'scheduled)
14952 (re-search-forward org-scheduled-time-regexp nil t))
14953 (and (eq elt 'deadline)
14954 (re-search-forward org-deadline-time-regexp nil t))
14955 (and (eq elt 'closed)
14956 (re-search-forward org-closed-time-regexp nil t)))
14957 (replace-match "")
14958 (if (looking-at "--+<[^>]+>") (replace-match ""))
14959 (if (looking-at " +") (replace-match ""))))
14960 (goto-char (point-max))
14961 (when what
14962 (insert
14963 (if (not (equal (char-before) ?\ )) " " "")
14964 (cond ((eq what 'scheduled) org-scheduled-string)
14965 ((eq what 'deadline) org-deadline-string)
14966 ((eq what 'closed) org-closed-string))
14967 " ")
14968 (setq ts (org-insert-time-stamp
14969 time
14970 (or org-time-was-given
14971 (and (eq what 'closed) org-log-done-with-time))
14972 (eq what 'closed)
14973 nil nil (list org-end-time-was-given)))
14974 (end-of-line 1))
14975 (goto-char (point-min))
14976 (widen)
14978 (replace-match ""))
14979 ts)))))
14981 (defvar org-log-note-marker (make-marker))
14982 (defvar org-log-note-purpose nil)
14983 (defvar org-log-note-state nil)
14984 (defvar org-log-note-how nil)
14985 (defvar org-log-note-window-configuration nil)
14986 (defvar org-log-note-return-to (make-marker))
14987 (defvar org-log-post-message nil
14988 "Message to be displayed after a log note has been stored.
14989 The auto-repeater uses this.")
14991 (defun org-add-log-maybe (&optional purpose state findpos how)
14992 "Set up the post command hook to take a note.
14993 If this is about to TODO state change, the new state is expected in STATE.
14994 When FINDPOS is non-nil, find the correct position for the note in
14995 the current entry. If not, assume that it can be inserted at point."
14996 (save-excursion
14997 (when findpos
14998 (org-back-to-heading t)
15002 (goto-char (match-end 0))
15003 (unless org-log-states-order-reversed
15005 (org-skip-over-state-notes)
15007 (move-marker org-log-note-marker (point))
15008 (setq org-log-note-purpose purpose
15009 org-log-note-state state
15010 org-log-note-how how)
15011 (add-hook 'post-command-hook 'org-add-log-note 'append)))
15013 (defun org-skip-over-state-notes ()
15014 "Skip past the list of State notes in an entry."
15017 (condition-case nil
15018 (org-next-item)
15019 (error (org-end-of-item)))))
15021 (defun org-add-log-note (&optional purpose)
15022 "Pop up a window for taking a note, and add this note later at point."
15023 (remove-hook 'post-command-hook 'org-add-log-note)
15024 (setq org-log-note-window-configuration (current-window-configuration))
15025 (delete-other-windows)
15026 (move-marker org-log-note-return-to (point))
15027 (switch-to-buffer (marker-buffer org-log-note-marker))
15028 (goto-char org-log-note-marker)
15029 (org-switch-to-buffer-other-window "*Org Note*")
15030 (erase-buffer)
15031 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
15032 (org-store-log-note)
15033 (let ((org-inhibit-startup t)) (org-mode))
15034 (insert (format "# Insert note for %s.
15036 (cond
15037 ((eq org-log-note-purpose 'clock-out) "stopped clock")
15038 ((eq org-log-note-purpose 'done) "closed todo item")
15039 ((eq org-log-note-purpose 'state)
15041 (t (error "This should not happen")))))
15042 (org-set-local 'org-finish-function 'org-store-log-note)))
15044 (defun org-store-log-note ()
15045 "Finish taking a log note, and insert it to where it belongs."
15046 (let ((txt (buffer-string))
15047 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
15048 lines ind)
15049 (kill-buffer (current-buffer))
15051 (setq txt (replace-match "" t t txt)))
15053 (setq txt (replace-match "" t t txt)))
15056 (setq note
15057 (org-replace-escapes
15058 note
15059 (list (cons "%u" (user-login-name))
15060 (cons "%U" user-full-name)
15061 (cons "%t" (format-time-string
15062 (org-time-stamp-format 'long 'inactive)
15063 (current-time)))
15064 (cons "%s" (if org-log-note-state
15066 "")))))
15068 (push note lines))
15069 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15070 (when lines
15071 (save-excursion
15072 (set-buffer (marker-buffer org-log-note-marker))
15073 (save-excursion
15074 (goto-char org-log-note-marker)
15075 (move-marker org-log-note-marker nil)
15076 (end-of-line 1)
15078 (indent-relative nil)
15079 (insert "- " (pop lines))
15080 (org-indent-line-function)
15081 (beginning-of-line 1)
15083 (setq ind (concat (match-string 0) " "))
15084 (end-of-line 1)
15086 (set-window-configuration org-log-note-window-configuration)
15087 (with-current-buffer (marker-buffer org-log-note-return-to)
15088 (goto-char org-log-note-return-to))
15089 (move-marker org-log-note-return-to nil)
15090 (and org-log-post-message (message "%s" org-log-post-message)))
15092 ;; FIXME: what else would be useful?
15093 ;; - priority
15094 ;; - date
15096 (defun org-sparse-tree (&optional arg)
15097 "Create a sparse tree, prompt for the details.
15098 This command can create sparse trees. You first need to select the type
15099 of match used to create the tree:
15101 t Show entries with a specific TODO keyword.
15102 T Show entries selected by a tags match.
15103 p Enter a property name and its value (both with completion on existing
15104 names/values) and show entries with that property.
15105 r Show entries matching a regular expression
15106 d Show deadlines due within `org-deadline-warning-days'."
15107 (interactive "P")
15108 (let (ans kwd value)
15109 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15110 (setq ans (read-char-exclusive))
15111 (cond
15112 ((equal ans ?d)
15113 (call-interactively 'org-check-deadlines))
15114 ((equal ans ?b)
15115 (call-interactively 'org-check-before-date))
15116 ((equal ans ?t)
15117 (org-show-todo-tree '(4)))
15118 ((equal ans ?T)
15119 (call-interactively 'org-tags-sparse-tree))
15120 ((member ans '(?p ?P))
15121 (setq kwd (completing-read "Property: "
15122 (mapcar 'list (org-buffer-property-keys))))
15123 (setq value (completing-read "Value: "
15124 (mapcar 'list (org-property-values kwd))))
15127 (org-tags-sparse-tree arg (concat kwd "=" value)))
15128 ((member ans '(?r ?R ?/))
15129 (call-interactively 'org-occur))
15132 (defvar org-occur-highlights nil)
15133 (make-variable-buffer-local 'org-occur-highlights)
15135 (defun org-occur (regexp &optional keep-previous callback)
15136 "Make a compact tree which shows all matches of REGEXP.
15137 The tree will show the lines where the regexp matches, and all higher
15138 headlines above the match. It will also show the heading after the match,
15139 to make sure editing the matching entry is easy.
15140 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15141 call to `org-occur' will be kept, to allow stacking of calls to this
15142 command.
15143 If CALLBACK is non-nil, it is a function which is called to confirm
15144 that the match should indeed be shown."
15146 (or keep-previous (org-remove-occur-highlights nil nil t))
15147 (let ((cnt 0))
15148 (save-excursion
15149 (goto-char (point-min))
15150 (if (or (not keep-previous) ; do not want to keep
15151 (not org-occur-highlights)) ; no previous matches
15152 ;; hide everything
15153 (org-overview))
15154 (while (re-search-forward regexp nil t)
15155 (when (or (not callback)
15156 (save-match-data (funcall callback)))
15157 (setq cnt (1+ cnt))
15158 (when org-highlight-sparse-tree-matches
15159 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15160 (org-show-context 'occur-tree))))
15161 (when org-remove-highlights-with-change
15162 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15163 nil 'local))
15164 (unless org-sparse-tree-open-archived-trees
15165 (org-hide-archived-subtrees (point-min) (point-max)))
15166 (run-hooks 'org-occur-hook)
15167 (if (interactive-p)
15168 (message "%d match(es) for regexp %s" cnt regexp))
15169 cnt))
15171 (defun org-show-context (&optional key)
15172 "Make sure point and context and visible.
15173 How much context is shown depends upon the variables
15174 `org-show-hierarchy-above', `org-show-following-heading'. and
15175 `org-show-siblings'."
15176 (let ((heading-p (org-on-heading-p t))
15177 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15178 (following-p (org-get-alist-option org-show-following-heading key))
15179 (entry-p (org-get-alist-option org-show-entry-below key))
15180 (siblings-p (org-get-alist-option org-show-siblings key)))
15181 (catch 'exit
15182 ;; Show heading or entry text
15183 (if (and heading-p (not entry-p))
15184 (org-flag-heading nil) ; only show the heading
15185 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15186 (org-show-hidden-entry))) ; show entire entry
15187 (when following-p
15188 ;; Show next sibling, or heading below text
15189 (save-excursion
15190 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15191 (org-flag-heading nil))))
15192 (when siblings-p (org-show-siblings))
15193 (when hierarchy-p
15194 ;; show all higher headings, possibly with siblings
15195 (save-excursion
15196 (while (and (condition-case nil
15197 (progn (org-up-heading-all 1) t)
15198 (error nil))
15199 (not (bobp)))
15200 (org-flag-heading nil)
15201 (when siblings-p (org-show-siblings))))))))
15203 (defun org-reveal (&optional siblings)
15204 "Show current entry, hierarchy above it, and the following headline.
15205 This can be used to show a consistent set of context around locations
15206 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15207 not t for the search context.
15209 With optional argument SIBLINGS, on each level of the hierarchy all
15210 siblings are shown. This repairs the tree structure to what it would
15211 look like when opened with hierarchical calls to `org-cycle'."
15212 (interactive "P")
15213 (let ((org-show-hierarchy-above t)
15214 (org-show-following-heading t)
15215 (org-show-siblings (if siblings t org-show-siblings)))
15216 (org-show-context nil)))
15218 (defun org-highlight-new-match (beg end)
15219 "Highlight from BEG to END and mark the highlight is an occur headline."
15220 (let ((ov (org-make-overlay beg end)))
15221 (org-overlay-put ov 'face 'secondary-selection)
15222 (push ov org-occur-highlights)))
15224 (defun org-remove-occur-highlights (&optional beg end noremove)
15225 "Remove the occur highlights from the buffer.
15226 BEG and END are ignored. If NOREMOVE is nil, remove this function
15227 from the `before-change-functions' in the current buffer."
15228 (interactive)
15229 (unless org-inhibit-highlight-removal
15230 (mapc 'org-delete-overlay org-occur-highlights)
15231 (setq org-occur-highlights nil)
15232 (unless noremove
15233 (remove-hook 'before-change-functions
15234 'org-remove-occur-highlights 'local))))
15236 ;;;; Priorities
15239 "Regular expression matching the priority indicator.")
15241 (defvar org-remove-priority-next-time nil)
15243 (defun org-priority-up ()
15244 "Increase the priority of the current item."
15245 (interactive)
15246 (org-priority 'up))
15248 (defun org-priority-down ()
15249 "Decrease the priority of the current item."
15250 (interactive)
15251 (org-priority 'down))
15253 (defun org-priority (&optional action)
15254 "Change the priority of an item by ARG.
15255 ACTION can be `set', `up', `down', or a character."
15256 (interactive)
15257 (setq action (or action 'set))
15258 (let (current new news have remove)
15259 (save-excursion
15260 (org-back-to-heading)
15261 (if (looking-at org-priority-regexp)
15262 (setq current (string-to-char (match-string 2))
15263 have t)
15264 (setq current org-default-priority))
15265 (cond
15266 ((or (eq action 'set) (integerp action))
15267 (if (integerp action)
15268 (setq new action)
15269 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15270 (setq new (read-char-exclusive)))
15271 (if (and (= (upcase org-highest-priority) org-highest-priority)
15272 (= (upcase org-lowest-priority) org-lowest-priority))
15273 (setq new (upcase new)))
15274 (cond ((equal new ?\ ) (setq remove t))
15275 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15276 (error "Priority must be between `%c' and `%c'"
15277 org-highest-priority org-lowest-priority))))
15278 ((eq action 'up)
15279 (if (and (not have) (eq last-command this-command))
15280 (setq new org-lowest-priority)
15281 (setq new (if (and org-priority-start-cycle-with-default (not have))
15282 org-default-priority (1- current)))))
15283 ((eq action 'down)
15284 (if (and (not have) (eq last-command this-command))
15285 (setq new org-highest-priority)
15286 (setq new (if (and org-priority-start-cycle-with-default (not have))
15287 org-default-priority (1+ current)))))
15288 (t (error "Invalid action")))
15289 (if (or (< (upcase new) org-highest-priority)
15290 (> (upcase new) org-lowest-priority))
15291 (setq remove t))
15292 (setq news (format "%c" new))
15293 (if have
15294 (if remove
15295 (replace-match "" t t nil 1)
15296 (replace-match news t t nil 2))
15297 (if remove
15298 (error "No priority cookie found in line")
15299 (looking-at org-todo-line-regexp)
15300 (if (match-end 2)
15301 (progn
15302 (goto-char (match-end 2))
15303 (insert " [#" news "]"))
15304 (goto-char (match-beginning 3))
15305 (insert "[#" news "] ")))))
15306 (org-preserve-lc (org-set-tags nil 'align))
15307 (if remove
15308 (message "Priority removed")
15309 (message "Priority of current item set to %s" news))))
15312 (defun org-get-priority (s)
15313 "Find priority cookie and return priority."
15314 (save-match-data
15315 (if (not (string-match org-priority-regexp s))
15316 (* 1000 (- org-lowest-priority org-default-priority))
15317 (* 1000 (- org-lowest-priority
15318 (string-to-char (match-string 2 s)))))))
15320 ;;;; Tags
15322 (defun org-scan-tags (action matcher &optional todo-only)
15323 "Scan headline tags with inheritance and produce output ACTION.
15324 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15325 evaluated, testing if a given set of tags qualifies a headline for
15326 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15327 are included in the output."
15330 (org-re
15332 (props (list 'face nil
15333 'done-face 'org-done
15334 'undone-face nil
15335 'mouse-face 'highlight
15336 'org-not-done-regexp org-not-done-regexp
15337 'org-todo-regexp org-todo-regexp
15338 'keymap org-agenda-keymap
15339 'help-echo
15340 (format "mouse-2 or RET jump to org file %s"
15341 (abbreviate-file-name
15342 (or (buffer-file-name (buffer-base-buffer))
15343 (buffer-name (buffer-base-buffer)))))))
15344 (case-fold-search nil)
15345 lspos
15346 tags tags-list tags-alist (llast 0) rtn level category i txt
15347 todo marker entry priority)
15348 (save-excursion
15349 (goto-char (point-min))
15350 (when (eq action 'sparse-tree)
15351 (org-overview)
15352 (org-remove-occur-highlights))
15353 (while (re-search-forward re nil t)
15354 (catch :skip
15355 (setq todo (if (match-end 1) (match-string 2))
15356 tags (if (match-end 4) (match-string 4)))
15357 (goto-char (setq lspos (1+ (match-beginning 0))))
15358 (setq level (org-reduced-level (funcall outline-level))
15359 category (org-get-category))
15360 (setq i llast llast level)
15361 ;; remove tag lists from same and sublevels
15362 (while (>= i level)
15363 (when (setq entry (assoc i tags-alist))
15364 (setq tags-alist (delete entry tags-alist)))
15365 (setq i (1- i)))
15366 ;; add the nex tags
15367 (when tags
15368 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15369 tags-alist
15370 (cons (cons level tags) tags-alist)))
15371 ;; compile tags for current headline
15372 (setq tags-list
15373 (if org-use-tag-inheritance
15374 (apply 'append (mapcar 'cdr tags-alist))
15375 tags))
15376 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15377 (eval matcher)
15378 (or (not org-agenda-skip-archived-trees)
15379 (not (member org-archive-tag tags-list))))
15380 (and (eq action 'agenda) (org-agenda-skip))
15381 ;; list this headline
15383 (if (eq action 'sparse-tree)
15384 (progn
15385 (and org-highlight-sparse-tree-matches
15386 (org-get-heading) (match-end 0)
15387 (org-highlight-new-match
15388 (match-beginning 0) (match-beginning 1)))
15389 (org-show-context 'tags-tree))
15390 (setq txt (org-format-agenda-item
15391 ""
15392 (concat
15393 (if org-tags-match-list-sublevels
15394 (make-string (1- level) ?.) "")
15395 (org-get-heading))
15396 category tags-list)
15397 priority (org-get-priority txt))
15398 (goto-char lspos)
15399 (setq marker (org-agenda-new-marker))
15400 (org-add-props txt props
15401 'org-marker marker 'org-hd-marker marker 'org-category category
15402 'priority priority 'type "tagsmatch")
15403 (push txt rtn))
15404 ;; if we are to skip sublevels, jump to end of subtree
15405 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15406 (when (and (eq action 'sparse-tree)
15407 (not org-sparse-tree-open-archived-trees))
15408 (org-hide-archived-subtrees (point-min) (point-max)))
15409 (nreverse rtn)))
15411 (defvar todo-only) ;; dynamically scoped
15413 (defun org-tags-sparse-tree (&optional todo-only match)
15414 "Create a sparse tree according to tags string MATCH.
15415 MATCH can contain positive and negative selection of tags, like
15417 If optional argument TODO_ONLY is non-nil, only select lines that are
15418 also TODO lines."
15419 (interactive "P")
15420 (org-prepare-agenda-buffers (list (current-buffer)))
15421 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15423 (defvar org-cached-props nil)
15424 (defun org-cached-entry-get (pom property)
15425 (if (or (eq t org-use-property-inheritance)
15426 (member property org-use-property-inheritance))
15427 ;; Caching is not possible, check it directly
15428 (org-entry-get pom property 'inherit)
15429 ;; Get all properties, so that we can do complicated checks easily
15430 (cdr (assoc property (or org-cached-props
15431 (setq org-cached-props
15432 (org-entry-properties pom)))))))
15434 (defun org-global-tags-completion-table (&optional files)
15435 "Return the list of all tags in all agenda buffer/files."
15436 (save-excursion
15437 (org-uniquify
15438 (delq nil
15439 (apply 'append
15440 (mapcar
15441 (lambda (file)
15442 (set-buffer (find-file-noselect file))
15443 (append (org-get-buffer-tags)
15444 (mapcar (lambda (x) (if (stringp (car-safe x))
15445 (list (car-safe x)) nil))
15446 org-tag-alist)))
15447 (if (and files (car files))
15448 files
15449 (org-agenda-files))))))))
15451 (defun org-make-tags-matcher (match)
15452 "Create the TAGS//TODO matcher form for the selection string MATCH."
15453 ;; todo-only is scoped dynamically into this function, and the function
15454 ;; may change it it the matcher asksk for it.
15455 (unless match
15456 ;; Get a new match request, with completion
15457 (let ((org-last-tags-completion-table
15458 (org-global-tags-completion-table)))
15459 (setq match (completing-read
15460 "Match: " 'org-tags-completion-function nil nil nil
15461 'org-tags-history))))
15463 ;; Parse the string and create a lisp form
15464 (let ((match0 match)
15465 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15466 minus tag mm
15467 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15468 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15469 (if (string-match "/+" match)
15470 ;; match contains also a todo-matching request
15471 (progn
15472 (setq tagsmatch (substring match 0 (match-beginning 0))
15473 todomatch (substring match (match-end 0)))
15474 (if (string-match "^!" todomatch)
15475 (setq todo-only t todomatch (substring todomatch 1)))
15477 (setq todomatch nil)))
15478 ;; only matching tags
15479 (setq tagsmatch match todomatch nil))
15481 ;; Make the tags matcher
15483 (setq tagsmatcher t)
15484 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15485 (while (setq term (pop orterms))
15487 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15488 (while (string-match re term)
15489 (setq minus (and (match-end 1)
15490 (equal (match-string 1 term) "-"))
15491 tag (match-string 2 term)
15492 re-p (equal (string-to-char tag) ?{)
15493 level-p (match-end 3)
15494 prop-p (match-end 4)
15495 mm (cond
15496 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15497 (level-p `(= level ,(string-to-number
15498 (match-string 3 term))))
15499 (prop-p
15500 (setq pn (match-string 4 term)
15501 pv (match-string 5 term)
15502 cat-p (equal pn "CATEGORY")
15503 re-p (equal (string-to-char pv) ?{)
15504 pv (substring pv 1 -1))
15505 (if (equal pn "CATEGORY")
15506 (setq gv '(get-text-property (point) 'org-category))
15507 (setq gv `(org-cached-entry-get nil ,pn)))
15508 (if re-p
15509 `(string-match ,pv (or ,gv ""))
15510 `(equal ,pv (or ,gv ""))))
15511 (t `(member ,(downcase tag) tags-list)))
15512 mm (if minus (list 'not mm) mm)
15513 term (substring term (match-end 0)))
15514 (push mm tagsmatcher))
15515 (push (if (> (length tagsmatcher) 1)
15516 (cons 'and tagsmatcher)
15517 (car tagsmatcher))
15518 orlist)
15519 (setq tagsmatcher nil))
15520 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15521 (setq tagsmatcher
15522 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15524 ;; Make the todo matcher
15526 (setq todomatcher t)
15527 (setq orterms (org-split-string todomatch "|") orlist nil)
15528 (while (setq term (pop orterms))
15529 (while (string-match re term)
15530 (setq minus (and (match-end 1)
15531 (equal (match-string 1 term) "-"))
15532 kwd (match-string 2 term)
15533 re-p (equal (string-to-char kwd) ?{)
15534 term (substring term (match-end 0))
15535 mm (if re-p
15536 `(string-match ,(substring kwd 1 -1) todo)
15537 (list 'equal 'todo kwd))
15538 mm (if minus (list 'not mm) mm))
15539 (push mm todomatcher))
15540 (push (if (> (length todomatcher) 1)
15541 (cons 'and todomatcher)
15542 (car todomatcher))
15543 orlist)
15544 (setq todomatcher nil))
15545 (setq todomatcher (if (> (length orlist) 1)
15546 (cons 'or orlist) (car orlist))))
15548 ;; Return the string and lisp forms of the matcher
15549 (setq matcher (if todomatcher
15550 (list 'and tagsmatcher todomatcher)
15551 tagsmatcher))
15552 (cons match0 matcher)))
15554 (defun org-match-any-p (re list)
15555 "Does re match any element of list?"
15556 (setq list (mapcar (lambda (x) (string-match re x)) list))
15557 (delq nil list))
15559 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15560 (defvar org-tags-overlay (org-make-overlay 1 1))
15561 (org-detach-overlay org-tags-overlay)
15563 (defun org-align-tags-here (to-col)
15564 ;; Assumes that this is a headline
15565 (let ((pos (point)) (col (current-column)) tags)
15566 (beginning-of-line 1)
15568 (< pos (match-beginning 2)))
15569 (progn
15570 (setq tags (match-string 2))
15571 (goto-char (match-beginning 1))
15572 (insert " ")
15573 (delete-region (point) (1+ (match-end 0)))
15574 (backward-char 1)
15575 (move-to-column
15576 (max (1+ (current-column))
15577 (1+ col)
15578 (if (> to-col 0)
15579 to-col
15580 (- (abs to-col) (length tags))))
15581 t)
15582 (insert tags)
15583 (move-to-column (min (current-column) col) t))
15584 (goto-char pos))))
15586 (defun org-set-tags (&optional arg just-align)
15587 "Set the tags for the current headline.
15588 With prefix ARG, realign all tags in headings in the current buffer."
15589 (interactive "P")
15590 (let* ((re (concat "^" outline-regexp))
15591 (current (org-get-tags-string))
15592 (col (current-column))
15593 (org-setting-tags t)
15594 table current-tags inherited-tags ; computed below when needed
15595 tags p0 c0 c1 rpl)
15596 (if arg
15597 (save-excursion
15598 (goto-char (point-min))
15599 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15600 (while (re-search-forward re nil t)
15601 (org-set-tags nil t)
15602 (end-of-line 1)))
15603 (message "All tags realigned to column %d" org-tags-column))
15604 (if just-align
15605 (setq tags current)
15606 ;; Get a new set of tags from the user
15607 (save-excursion
15608 (setq table (or org-tag-alist (org-get-buffer-tags))
15609 org-last-tags-completion-table table
15610 current-tags (org-split-string current ":")
15611 inherited-tags (nreverse
15612 (nthcdr (length current-tags)
15613 (nreverse (org-get-tags-at))))
15614 tags
15615 (if (or (eq t org-use-fast-tag-selection)
15616 (and org-use-fast-tag-selection
15617 (delq nil (mapcar 'cdr table))))
15618 (org-fast-tag-selection
15619 current-tags inherited-tags table
15620 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15621 (let ((org-add-colon-after-tag-completion t))
15622 (org-trim
15623 (org-without-partial-completion
15624 (completing-read "Tags: " 'org-tags-completion-function
15625 nil nil current 'org-tags-history)))))))
15626 (while (string-match "[-+&]+" tags)
15627 ;; No boolean logic, just a list
15628 (setq tags (replace-match ":" t t tags))))
15631 (setq tags "")
15632 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15633 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15635 ;; Insert new tags at the correct column
15636 (beginning-of-line 1)
15637 (cond
15638 ((and (equal current "") (equal tags "")))
15639 ((re-search-forward
15641 (point-at-eol) t)
15642 (if (equal tags "")
15643 (setq rpl "")
15644 (goto-char (match-beginning 0))
15645 (setq c0 (current-column) p0 (point)
15646 c1 (max (1+ c0) (if (> org-tags-column 0)
15647 org-tags-column
15648 (- (- org-tags-column) (length tags))))
15649 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15650 (replace-match rpl t t)
15651 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15652 tags)
15653 (t (error "Tags alignment failed")))
15654 (move-to-column col)
15655 (unless just-align
15656 (run-hooks 'org-after-tags-change-hook)))))
15658 (defun org-change-tag-in-region (beg end tag off)
15659 "Add or remove TAG for each entry in the region.
15660 This works in the agenda, and also in an org-mode buffer."
15661 (interactive
15662 (list (region-beginning) (region-end)
15663 (let ((org-last-tags-completion-table
15664 (if (org-mode-p)
15665 (org-get-buffer-tags)
15666 (org-global-tags-completion-table))))
15667 (completing-read
15668 "Tag: " 'org-tags-completion-function nil nil nil
15669 'org-tags-history))
15670 (progn
15671 (message "[s]et or [r]emove? ")
15672 (equal (read-char-exclusive) ?r))))
15673 (if (fboundp 'deactivate-mark) (deactivate-mark))
15674 (let ((agendap (equal major-mode 'org-agenda-mode))
15675 l1 l2 m buf pos newhead (cnt 0))
15676 (goto-char end)
15677 (setq l2 (1- (org-current-line)))
15678 (goto-char beg)
15679 (setq l1 (org-current-line))
15680 (loop for l from l1 to l2 do
15681 (goto-line l)
15682 (setq m (get-text-property (point) 'org-hd-marker))
15683 (when (or (and (org-mode-p) (org-on-heading-p))
15684 (and agendap m))
15685 (setq buf (if agendap (marker-buffer m) (current-buffer))
15686 pos (if agendap m (point)))
15687 (with-current-buffer buf
15688 (save-excursion
15689 (save-restriction
15690 (goto-char pos)
15691 (setq cnt (1+ cnt))
15692 (org-toggle-tag tag (if off 'off 'on))
15693 (setq newhead (org-get-heading)))))
15694 (and agendap (org-agenda-change-all-lines newhead m))))
15695 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15697 (defun org-tags-completion-function (string predicate &optional flag)
15698 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15699 (confirm (lambda (x) (stringp (car x)))))
15701 (setq s1 (match-string 1 string)
15702 s2 (match-string 2 string))
15703 (setq s1 "" s2 string))
15704 (cond
15705 ((eq flag nil)
15706 ;; try completion
15707 (setq rtn (try-completion s2 ctable confirm))
15708 (if (stringp rtn)
15709 (setq rtn
15710 (concat s1 s2 (substring rtn (length s2))
15711 (if (and org-add-colon-after-tag-completion
15712 (assoc rtn ctable))
15713 ":" ""))))
15714 rtn)
15715 ((eq flag t)
15716 ;; all-completions
15717 (all-completions s2 ctable confirm)
15718 )
15719 ((eq flag 'lambda)
15720 ;; exact match?
15721 (assoc s2 ctable)))
15722 ))
15724 (defun org-fast-tag-insert (kwd tags face &optional end)
15725 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15726 (insert (format "%-12s" (concat kwd ":"))
15727 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15728 (or end "")))
15730 (defun org-fast-tag-show-exit (flag)
15731 (save-excursion
15732 (goto-line 3)
15734 (replace-match ""))
15735 (when flag
15736 (end-of-line 1)
15737 (move-to-column (- (window-width) 19) t)
15738 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15740 (defun org-set-current-tags-overlay (current prefix)
15741 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15742 (if (featurep 'xemacs)
15743 (org-overlay-display org-tags-overlay (concat prefix s)
15744 'secondary-selection)
15745 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15746 (org-overlay-display org-tags-overlay (concat prefix s)))))
15748 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15749 "Fast tag selection with single keys.
15750 CURRENT is the current list of tags in the headline, INHERITED is the
15751 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15752 possibly with grouping information. TODO-TABLE is a similar table with
15753 TODO keywords, should these have keys assigned to them.
15754 If the keys are nil, a-z are automatically assigned.
15755 Returns the new tags string, or nil to not change the current settings."
15756 (let* ((fulltable (append table todo-table))
15757 (maxlen (apply 'max (mapcar
15758 (lambda (x)
15759 (if (stringp (car x)) (string-width (car x)) 0))
15760 fulltable)))
15761 (buf (current-buffer))
15762 (expert (eq org-fast-tag-selection-single-key 'expert))
15763 (buffer-tags nil)
15764 (fwidth (+ maxlen 3 1 3))
15765 (ncol (/ (- (window-width) 4) fwidth))
15766 (i-face 'org-done)
15767 (c-face 'org-todo)
15768 tg cnt e c char c1 c2 ntable tbl rtn
15769 ov-start ov-end ov-prefix
15770 (exit-after-next org-fast-tag-selection-single-key)
15771 (done-keywords org-done-keywords)
15772 groups ingroup)
15773 (save-excursion
15774 (beginning-of-line 1)
15775 (if (looking-at
15777 (setq ov-start (match-beginning 1)
15778 ov-end (match-end 1)
15779 ov-prefix "")
15780 (setq ov-start (1- (point-at-eol))
15781 ov-end (1+ ov-start))
15783 (setq ov-prefix
15784 (concat
15785 (buffer-substring (1- (point)) (point))
15786 (if (> (current-column) org-tags-column)
15787 " "
15788 (make-string (- org-tags-column (current-column)) ?\ ))))))
15789 (org-move-overlay org-tags-overlay ov-start ov-end)
15790 (save-window-excursion
15791 (if expert
15792 (set-buffer (get-buffer-create " *Org tags*"))
15793 (delete-other-windows)
15794 (split-window-vertically)
15795 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15796 (erase-buffer)
15797 (org-set-local 'org-done-keywords done-keywords)
15800 (org-fast-tag-show-exit exit-after-next)
15801 (org-set-current-tags-overlay current ov-prefix)
15802 (setq tbl fulltable char ?a cnt 0)
15803 (while (setq e (pop tbl))
15804 (cond
15805 ((equal e '(:startgroup))
15806 (push '() groups) (setq ingroup t)
15807 (when (not (= cnt 0))
15808 (setq cnt 0)
15810 (insert "{ "))
15811 ((equal e '(:endgroup))
15812 (setq ingroup nil cnt 0)
15814 (t
15815 (setq tg (car e) c2 nil)
15816 (if (cdr e)
15817 (setq c (cdr e))
15818 ;; automatically assign a character.
15819 (setq c1 (string-to-char
15820 (downcase (substring
15821 tg (if (= (string-to-char tg) ?@) 1 0)))))
15822 (if (or (rassoc c1 ntable) (rassoc c1 table))
15823 (while (or (rassoc char ntable) (rassoc char table))
15824 (setq char (1+ char)))
15825 (setq c2 c1))
15826 (setq c (or c2 char)))
15827 (if ingroup (push tg (car groups)))
15828 (setq tg (org-add-props tg nil 'face
15829 (cond
15830 ((not (assoc tg table))
15831 (org-get-todo-face tg))
15832 ((member tg current) c-face)
15833 ((member tg inherited) i-face)
15834 (t nil))))
15835 (if (and (= cnt 0) (not ingroup)) (insert " "))
15836 (insert "[" c "] " tg (make-string
15837 (- fwidth 4 (length tg)) ?\ ))
15838 (push (cons tg c) ntable)
15839 (when (= (setq cnt (1+ cnt)) ncol)
15841 (if ingroup (insert " "))
15842 (setq cnt 0)))))
15843 (setq ntable (nreverse ntable))
15845 (goto-char (point-min))
15846 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15847 (fit-window-to-buffer))
15848 (setq rtn
15849 (catch 'exit
15850 (while t
15851 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15852 (if groups " [!] no groups" " [!]groups")
15853 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15854 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15855 (cond
15857 ((= c ?!)
15858 (setq groups (not groups))
15859 (goto-char (point-min))
15860 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15861 ((= c ?\C-c)
15862 (if (not expert)
15863 (org-fast-tag-show-exit
15864 (setq exit-after-next (not exit-after-next)))
15865 (setq expert nil)
15866 (delete-other-windows)
15867 (split-window-vertically)
15868 (org-switch-to-buffer-other-window " *Org tags*")
15869 (and (fboundp 'fit-window-to-buffer)
15870 (fit-window-to-buffer))))
15871 ((or (= c ?\C-g)
15872 (and (= c ?q) (not (rassoc c ntable))))
15873 (org-detach-overlay org-tags-overlay)
15874 (setq quit-flag t))
15875 ((= c ?\ )
15876 (setq current nil)
15877 (if exit-after-next (setq exit-after-next 'now)))
15879 (condition-case nil
15880 (setq tg (completing-read
15881 "Tag: "
15882 (or buffer-tags
15883 (with-current-buffer buf
15884 (org-get-buffer-tags)))))
15885 (quit (setq tg "")))
15887 (add-to-list 'buffer-tags (list tg))
15888 (if (member tg current)
15889 (setq current (delete tg current))
15890 (push tg current)))
15891 (if exit-after-next (setq exit-after-next 'now)))
15892 ((setq e (rassoc c todo-table) tg (car e))
15893 (with-current-buffer buf
15894 (save-excursion (org-todo tg)))
15895 (if exit-after-next (setq exit-after-next 'now)))
15896 ((setq e (rassoc c ntable) tg (car e))
15897 (if (member tg current)
15898 (setq current (delete tg current))
15899 (loop for g in groups do
15900 (if (member tg g)
15901 (mapc (lambda (x)
15902 (setq current (delete x current)))
15903 g)))
15904 (push tg current))
15905 (if exit-after-next (setq exit-after-next 'now))))
15907 ;; Create a sorted list
15908 (setq current
15909 (sort current
15910 (lambda (a b)
15911 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15912 (if (eq exit-after-next 'now) (throw 'exit t))
15913 (goto-char (point-min))
15914 (beginning-of-line 2)
15915 (delete-region (point) (point-at-eol))
15916 (org-fast-tag-insert "Current" current c-face)
15917 (org-set-current-tags-overlay current ov-prefix)
15918 (while (re-search-forward
15920 (setq tg (match-string 1))
15921 (add-text-properties
15922 (match-beginning 1) (match-end 1)
15923 (list 'face
15924 (cond
15925 ((member tg current) c-face)
15926 ((member tg inherited) i-face)
15927 (t (get-text-property (match-beginning 1) 'face))))))
15928 (goto-char (point-min)))))
15929 (org-detach-overlay org-tags-overlay)
15930 (if rtn
15931 (mapconcat 'identity current ":")
15932 nil))))
15934 (defun org-get-tags-string ()
15935 "Get the TAGS string in the current headline."
15936 (unless (org-on-heading-p t)
15937 (error "Not on a heading"))
15938 (save-excursion
15939 (beginning-of-line 1)
15941 (org-match-string-no-properties 1)
15942 "")))
15944 (defun org-get-tags ()
15945 "Get the list of tags specified in the current headline."
15946 (org-split-string (org-get-tags-string) ":"))
15948 (defun org-get-buffer-tags ()
15949 "Get a table of all tags used in the buffer, for completion."
15950 (let (tags)
15951 (save-excursion
15952 (goto-char (point-min))
15953 (while (re-search-forward
15955 (when (equal (char-after (point-at-bol 0)) ?*)
15956 (mapc (lambda (x) (add-to-list 'tags x))
15957 (org-split-string (org-match-string-no-properties 1) ":")))))
15958 (mapcar 'list tags)))
15961 ;;;; Properties
15963 ;;; Setting and retrieving properties
15965 (defconst org-special-properties
15966 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15967 "TIMESTAMP" "TIMESTAMP_IA")
15968 "The special properties valid in Org-mode.
15970 These are properties that are not defined in the property drawer,
15971 but in some other way.")
15973 (defconst org-default-properties
15974 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15975 "LOCATION" "LOGGING" "COLUMNS")
15976 "Some properties that are used by Org-mode for various purposes.
15977 Being in this list makes sure that they are offered for completion.")
15980 "Regular expression matching the first line of a property drawer.")
15983 "Regular expression matching the first line of a property drawer.")
15985 (defun org-property-action ()
15986 "Do an action on properties."
15987 (interactive)
15988 (let (c)
15989 (org-at-property-p)
15990 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15991 (setq c (read-char-exclusive))
15992 (cond
15993 ((equal c ?s)
15994 (call-interactively 'org-set-property))
15995 ((equal c ?d)
15996 (call-interactively 'org-delete-property))
15997 ((equal c ?D)
15998 (call-interactively 'org-delete-property-globally))
15999 ((equal c ?c)
16000 (call-interactively 'org-compute-property-at-point))
16001 (t (error "No such property action %c" c)))))
16003 (defun org-at-property-p ()
16004 "Is the cursor in a property line?"
16005 ;; FIXME: Does not check if we are actually in the drawer.
16006 ;; FIXME: also returns true on any drawers.....
16007 ;; This is used by C-c C-c for property action.
16008 (save-excursion
16009 (beginning-of-line 1)
16012 (defmacro org-with-point-at (pom &rest body)
16013 "Move to buffer and point of point-or-marker POM for the duration of BODY."
16014 (declare (indent 1) (debug t))
16015 `(save-excursion
16016 (if (markerp pom) (set-buffer (marker-buffer pom)))
16017 (save-excursion
16018 (goto-char (or pom (point)))
16019 ,@body)))
16021 (defun org-get-property-block (&optional beg end force)
16022 "Return the (beg . end) range of the body of the property drawer.
16023 BEG and END can be beginning and end of subtree, if not given
16024 they will be found.
16025 If the drawer does not exist and FORCE is non-nil, create the drawer."
16026 (catch 'exit
16027 (save-excursion
16028 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
16029 (end (or end (progn (outline-next-heading) (point)))))
16030 (goto-char beg)
16031 (if (re-search-forward org-property-start-re end t)
16032 (setq beg (1+ (match-end 0)))
16033 (if force
16034 (save-excursion
16035 (org-insert-property-drawer)
16036 (setq end (progn (outline-next-heading) (point))))
16037 (throw 'exit nil))
16038 (goto-char beg)
16039 (if (re-search-forward org-property-start-re end t)
16040 (setq beg (1+ (match-end 0)))))
16041 (if (re-search-forward org-property-end-re end t)
16042 (setq end (match-beginning 0))
16043 (or force (throw 'exit nil))
16044 (goto-char beg)
16045 (setq end beg)
16046 (org-indent-line-function)
16048 (cons beg end)))))
16050 (defun org-entry-properties (&optional pom which)
16051 "Get all properties of the entry at point-or-marker POM.
16052 This includes the TODO keyword, the tags, time strings for deadline,
16053 scheduled, and clocking, and any additional properties defined in the
16054 entry. The return value is an alist, keys may occur multiple times
16055 if the property key was used several times.
16056 POM may also be nil, in which case the current entry is used.
16057 If WHICH is nil or `all', get all properties. If WHICH is
16058 `special' or `standard', only get that subclass."
16059 (setq which (or which 'all))
16060 (org-with-point-at pom
16061 (let ((clockstr (substring org-clock-string 0 -1))
16062 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
16063 beg end range props sum-props key value string clocksum)
16064 (save-excursion
16065 (when (condition-case nil (org-back-to-heading t) (error nil))
16066 (setq beg (point))
16067 (setq sum-props (get-text-property (point) 'org-summaries))
16068 (setq clocksum (get-text-property (point) :org-clock-minutes))
16069 (outline-next-heading)
16070 (setq end (point))
16071 (when (memq which '(all special))
16072 ;; Get the special properties, like TODO and tags
16073 (goto-char beg)
16074 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16075 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16076 (when (looking-at org-priority-regexp)
16077 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16078 (when (and (setq value (org-get-tags-string))
16080 (push (cons "TAGS" value) props))
16081 (when (setq value (org-get-tags-at))
16082 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16083 props))
16084 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16085 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16086 string (if (equal key clockstr)
16087 (org-no-properties
16088 (org-trim
16089 (buffer-substring
16090 (match-beginning 3) (goto-char (point-at-eol)))))
16091 (substring (org-match-string-no-properties 3) 1 -1)))
16092 (unless key
16093 (if (= (char-after (match-beginning 3)) ?\[)
16094 (setq key "TIMESTAMP_IA")
16095 (setq key "TIMESTAMP")))
16096 (when (or (equal key clockstr) (not (assoc key props)))
16097 (push (cons key string) props)))
16099 )
16101 (when (memq which '(all standard))
16102 ;; Get the standard properties, like :PORP: ...
16103 (setq range (org-get-property-block beg end))
16104 (when range
16105 (goto-char (car range))
16106 (while (re-search-forward
16108 (cdr range) t)
16109 (setq key (org-match-string-no-properties 1)
16110 value (org-trim (or (org-match-string-no-properties 2) "")))
16111 (unless (member key excluded)
16112 (push (cons key (or value "")) props)))))
16113 (if clocksum
16114 (push (cons "CLOCKSUM"
16115 (org-column-number-to-string (/ (float clocksum) 60.)
16116 'add_times))
16117 props))
16118 (append sum-props (nreverse props)))))))
16120 (defun org-entry-get (pom property &optional inherit)
16121 "Get value of PROPERTY for entry at point-or-marker POM.
16122 If INHERIT is non-nil and the entry does not have the property,
16123 then also check higher levels of the hierarchy.
16124 If the property is present but empty, the return value is the empty string.
16125 If the property is not present at all, nil is returned."
16126 (org-with-point-at pom
16127 (if inherit
16128 (org-entry-get-with-inheritance property)
16129 (if (member property org-special-properties)
16130 ;; We need a special property. Use brute force, get all properties.
16131 (cdr (assoc property (org-entry-properties nil 'special)))
16132 (let ((range (org-get-property-block)))
16133 (if (and range
16134 (goto-char (car range))
16135 (re-search-forward
16137 (cdr range) t))
16138 ;; Found the property, return it.
16139 (if (match-end 1)
16140 (org-match-string-no-properties 1)
16141 "")))))))
16143 (defun org-entry-delete (pom property)
16144 "Delete the property PROPERTY from entry at point-or-marker POM."
16145 (org-with-point-at pom
16146 (if (member property org-special-properties)
16147 nil ; cannot delete these properties.
16148 (let ((range (org-get-property-block)))
16149 (if (and range
16150 (goto-char (car range))
16151 (re-search-forward
16153 (cdr range) t))
16154 (progn
16155 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16156 t)
16157 nil)))))
16159 ;; Multi-values properties are properties that contain multiple values
16160 ;; These values are assumed to be single words, separated by whitespace.
16161 (defun org-entry-add-to-multivalued-property (pom property value)
16162 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16163 (let* ((old (org-entry-get pom property))
16165 (unless (member value values)
16166 (setq values (cons value values))
16167 (org-entry-put pom property
16168 (mapconcat 'identity values " ")))))
16170 (defun org-entry-remove-from-multivalued-property (pom property value)
16171 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16172 (let* ((old (org-entry-get pom property))
16174 (when (member value values)
16175 (setq values (delete value values))
16176 (org-entry-put pom property
16177 (mapconcat 'identity values " ")))))
16179 (defun org-entry-member-in-multivalued-property (pom property value)
16180 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16181 (let* ((old (org-entry-get pom property))
16183 (member value values)))
16185 (defvar org-entry-property-inherited-from (make-marker))
16187 (defun org-entry-get-with-inheritance (property)
16188 "Get entry property, and search higher levels if not present."
16189 (let (tmp)
16190 (save-excursion
16191 (save-restriction
16192 (widen)
16193 (catch 'ex
16194 (while t
16195 (when (setq tmp (org-entry-get nil property))
16196 (org-back-to-heading t)
16197 (move-marker org-entry-property-inherited-from (point))
16198 (throw 'ex tmp))
16199 (or (org-up-heading-safe) (throw 'ex nil)))))
16200 (or tmp (cdr (assoc property org-local-properties))
16201 (cdr (assoc property org-global-properties))))))
16203 (defun org-entry-put (pom property value)
16204 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16205 (org-with-point-at pom
16206 (org-back-to-heading t)
16207 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16208 range)
16209 (cond
16210 ((equal property "TODO")
16212 (not (member value org-todo-keywords-1)))
16214 (if (or (not value)
16216 (setq value 'none))
16217 (org-todo value)
16218 (org-set-tags nil 'align))
16219 ((equal property "PRIORITY")
16221 (string-to-char value) ?\ ))
16222 (org-set-tags nil 'align))
16223 ((equal property "SCHEDULED")
16224 (if (re-search-forward org-scheduled-time-regexp end t)
16225 (cond
16226 ((eq value 'earlier) (org-timestamp-change -1 'day))
16227 ((eq value 'later) (org-timestamp-change 1 'day))
16228 (t (call-interactively 'org-schedule)))
16229 (call-interactively 'org-schedule)))
16230 ((equal property "DEADLINE")
16231 (if (re-search-forward org-deadline-time-regexp end t)
16232 (cond
16233 ((eq value 'earlier) (org-timestamp-change -1 'day))
16234 ((eq value 'later) (org-timestamp-change 1 'day))
16235 (t (call-interactively 'org-deadline)))
16236 (call-interactively 'org-deadline)))
16237 ((member property org-special-properties)
16238 (error "The %s property can not yet be set with `org-entry-put'"
16239 property))
16240 (t ; a non-special property
16241 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16242 (setq range (org-get-property-block beg end 'force))
16243 (goto-char (car range))
16244 (if (re-search-forward
16246 (progn
16247 (delete-region (match-beginning 1) (match-end 1))
16248 (goto-char (match-beginning 1)))
16249 (goto-char (cdr range))
16251 (backward-char 1)
16252 (org-indent-line-function)
16253 (insert ":" property ":"))
16254 (and value (insert " " value))
16255 (org-indent-line-function)))))))
16257 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16258 "Get all property keys in the current buffer.
16259 With INCLUDE-SPECIALS, also list the special properties that relect things
16260 like tags and TODO state.
16261 With INCLUDE-DEFAULTS, also include properties that has special meaning
16262 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16263 With INCLUDE-COLUMNS, also include property names given in COLUMN
16264 formats in the current buffer."
16265 (let (rtn range cfmt cols s p)
16266 (save-excursion
16267 (save-restriction
16268 (widen)
16269 (goto-char (point-min))
16270 (while (re-search-forward org-property-start-re nil t)
16271 (setq range (org-get-property-block))
16272 (goto-char (car range))
16273 (while (re-search-forward
16275 (cdr range) t)
16276 (add-to-list 'rtn (org-match-string-no-properties 1)))
16277 (outline-next-heading))))
16279 (when include-specials
16280 (setq rtn (append org-special-properties rtn)))
16282 (when include-defaults
16283 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16285 (when include-columns
16286 (save-excursion
16287 (save-restriction
16288 (widen)
16289 (goto-char (point-min))
16290 (while (re-search-forward
16292 nil t)
16293 (setq cfmt (match-string 2) s 0)
16295 cfmt s)
16296 (setq s (match-end 0)
16297 p (match-string 1 cfmt))
16298 (unless (or (equal p "ITEM")
16299 (member p org-special-properties))
16300 (add-to-list 'rtn (match-string 1 cfmt))))))))
16302 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16304 (defun org-property-values (key)
16305 "Return a list of all values of property KEY."
16306 (save-excursion
16307 (save-restriction
16308 (widen)
16309 (goto-char (point-min))
16311 values)
16312 (while (re-search-forward re nil t)
16313 (add-to-list 'values (org-trim (match-string 1))))
16314 (delete "" values)))))
16316 (defun org-insert-property-drawer ()
16317 "Insert a property drawer into the current entry."
16318 (interactive)
16319 (org-back-to-heading t)
16320 (looking-at outline-regexp)
16321 (let ((indent (- (match-end 0)(match-beginning 0)))
16322 (beg (point))
16324 end hiddenp)
16325 (outline-next-heading)
16326 (setq end (point))
16327 (goto-char beg)
16328 (while (re-search-forward re end t))
16329 (setq hiddenp (org-invisible-p))
16330 (end-of-line 1)
16332 (org-skip-over-state-notes)
16334 (if (eq (char-before) ?*) (forward-char 1))
16336 (beginning-of-line 0)
16337 (indent-to-column indent)
16338 (beginning-of-line 2)
16339 (indent-to-column indent)
16340 (beginning-of-line 0)
16341 (if hiddenp
16342 (save-excursion
16343 (org-back-to-heading t)
16344 (hide-entry))
16345 (org-flag-drawer t))))
16347 (defun org-set-property (property value)
16348 "In the current entry, set PROPERTY to VALUE.
16349 When called interactively, this will prompt for a property name, offering
16350 completion on existing and default properties. And then it will prompt
16351 for a value, offering competion either on allowed values (via an inherited
16352 xxx_ALL property) or on existing values in other instances of this property
16353 in the current file."
16354 (interactive
16355 (let* ((prop (completing-read
16356 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16357 (cur (org-entry-get nil prop))
16358 (allowed (org-property-get-allowed-values nil prop 'table))
16359 (existing (mapcar 'list (org-property-values prop)))
16360 (val (if allowed
16361 (completing-read "Value: " allowed nil 'req-match)
16362 (completing-read
16364 (concat "[" cur "]") "")
16365 ": ")
16366 existing nil nil "" nil cur))))
16367 (list prop (if (equal val "") cur val))))
16368 (unless (equal (org-entry-get nil property) value)
16369 (org-entry-put nil property value)))
16371 (defun org-delete-property (property)
16372 "In the current entry, delete PROPERTY."
16373 (interactive
16374 (let* ((prop (completing-read
16375 "Property: " (org-entry-properties nil 'standard))))
16376 (list prop)))
16377 (message "Property %s %s" property
16378 (if (org-entry-delete nil property)
16379 "deleted"
16380 "was not present in the entry")))
16382 (defun org-delete-property-globally (property)
16383 "Remove PROPERTY globally, from all entries."
16384 (interactive
16385 (let* ((prop (completing-read
16386 "Globally remove property: "
16387 (mapcar 'list (org-buffer-property-keys)))))
16388 (list prop)))
16389 (save-excursion
16390 (save-restriction
16391 (widen)
16392 (goto-char (point-min))
16393 (let ((cnt 0))
16394 (while (re-search-forward
16396 nil t)
16397 (setq cnt (1+ cnt))
16398 (replace-match ""))
16401 (defvar org-columns-current-fmt-compiled) ; defined below
16403 (defun org-compute-property-at-point ()
16404 "Compute the property at point.
16405 This looks for an enclosing column format, extracts the operator and
16406 then applies it to the proerty in the column format's scope."
16407 (interactive)
16408 (unless (org-at-property-p)
16409 (error "Not at a property"))
16410 (let ((prop (org-match-string-no-properties 2)))
16411 (org-columns-get-format-and-top-level)
16412 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16413 (error "No operator defined for property %s" prop))
16414 (org-columns-compute prop)))
16416 (defun org-property-get-allowed-values (pom property &optional table)
16417 "Get allowed values for the property PROPERTY.
16418 When TABLE is non-nil, return an alist that can directly be used for
16419 completion."
16420 (let (vals)
16421 (cond
16422 ((equal property "TODO")
16423 (setq vals (org-with-point-at pom
16424 (append org-todo-keywords-1 '("")))))
16425 ((equal property "PRIORITY")
16426 (let ((n org-lowest-priority))
16427 (while (>= n org-highest-priority)
16428 (push (char-to-string n) vals)
16429 (setq n (1- n)))))
16430 ((member property org-special-properties))
16431 (t
16432 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16435 (setq vals (car (read-from-string (concat "(" vals ")"))))
16436 (setq vals (mapcar (lambda (x)
16437 (cond ((stringp x) x)
16438 ((numberp x) (number-to-string x))
16439 ((symbolp x) (symbol-name x))
16440 (t "???")))
16441 vals)))))
16442 (if table (mapcar 'list vals) vals)))
16444 (defun org-property-previous-allowed-value (&optional previous)
16445 "Switch to the next allowed value for this property."
16446 (interactive)
16447 (org-property-next-allowed-value t))
16449 (defun org-property-next-allowed-value (&optional previous)
16450 "Switch to the next allowed value for this property."
16451 (interactive)
16452 (unless (org-at-property-p)
16453 (error "Not at a property"))
16454 (let* ((key (match-string 2))
16455 (value (match-string 3))
16456 (allowed (or (org-property-get-allowed-values (point) key)
16457 (and (member value '("[ ]" "[-]" "[X]"))
16458 '("[ ]" "[X]"))))
16459 nval)
16460 (unless allowed
16461 (error "Allowed values for this property have not been defined"))
16462 (if previous (setq allowed (reverse allowed)))
16463 (if (member value allowed)
16464 (setq nval (car (cdr (member value allowed)))))
16465 (setq nval (or nval (car allowed)))
16466 (if (equal nval value)
16467 (error "Only one allowed value for this property"))
16468 (org-at-property-p)
16469 (replace-match (concat " :" key ": " nval) t t)
16470 (org-indent-line-function)
16471 (beginning-of-line 1)
16474 (defun org-find-entry-with-id (ident)
16475 "Locate the entry that contains the ID property with exact value IDENT.
16476 IDENT can be a string, a symbol or a number, this function will search for
16477 the string representation of it.
16478 Return the position where this entry starts, or nil if there is no such entry."
16479 (let ((id (cond
16480 ((stringp ident) ident)
16481 ((symbol-name ident) (symbol-name ident))
16482 ((numberp ident) (number-to-string ident))
16483 (t (error "IDENT %s must be a string, symbol or number" ident))))
16484 (case-fold-search nil))
16485 (save-excursion
16486 (save-restriction
16487 (goto-char (point-min))
16488 (when (re-search-forward
16490 nil t)
16491 (org-back-to-heading)
16492 (point))))))
16494 ;;; Column View
16496 (defvar org-columns-overlays nil
16497 "Holds the list of current column overlays.")
16499 (defvar org-columns-current-fmt nil
16500 "Local variable, holds the currently active column format.")
16501 (defvar org-columns-current-fmt-compiled nil
16502 "Local variable, holds the currently active column format.
16503 This is the compiled version of the format.")
16504 (defvar org-columns-current-widths nil
16505 "Loval variable, holds the currently widths of fields.")
16506 (defvar org-columns-current-maxwidths nil
16507 "Loval variable, holds the currently active maximum column widths.")
16508 (defvar org-columns-begin-marker (make-marker)
16509 "Points to the position where last a column creation command was called.")
16510 (defvar org-columns-top-level-marker (make-marker)
16511 "Points to the position where current columns region starts.")
16513 (defvar org-columns-map (make-sparse-keymap)
16514 "The keymap valid in column display.")
16516 (defun org-columns-content ()
16517 "Switch to contents view while in columns view."
16518 (interactive)
16519 (org-overview)
16520 (org-content))
16522 (org-defkey org-columns-map "c" 'org-columns-content)
16523 (org-defkey org-columns-map "o" 'org-overview)
16524 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16525 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16526 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16527 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16528 (org-defkey org-columns-map "v" 'org-columns-show-value)
16529 (org-defkey org-columns-map "q" 'org-columns-quit)
16530 (org-defkey org-columns-map "r" 'org-columns-redo)
16531 (org-defkey org-columns-map "g" 'org-columns-redo)
16532 (org-defkey org-columns-map [left] 'backward-char)
16533 (org-defkey org-columns-map "\M-b" 'backward-char)
16534 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16535 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16536 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16537 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16538 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16539 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16540 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16541 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16542 (org-defkey org-columns-map "<" 'org-columns-narrow)
16543 (org-defkey org-columns-map ">" 'org-columns-widen)
16544 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16545 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16546 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16547 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16549 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16550 '("Column"
16551 ["Edit property" org-columns-edit-value t]
16552 ["Next allowed value" org-columns-next-allowed-value t]
16553 ["Previous allowed value" org-columns-previous-allowed-value t]
16554 ["Show full value" org-columns-show-value t]
16555 ["Edit allowed values" org-columns-edit-allowed t]
16556 "--"
16557 ["Edit column attributes" org-columns-edit-attributes t]
16558 ["Increase column width" org-columns-widen t]
16559 ["Decrease column width" org-columns-narrow t]
16560 "--"
16561 ["Move column right" org-columns-move-right t]
16562 ["Move column left" org-columns-move-left t]
16563 ["Add column" org-columns-new t]
16564 ["Delete column" org-columns-delete t]
16565 "--"
16566 ["CONTENTS" org-columns-content t]
16567 ["OVERVIEW" org-overview t]
16568 ["Refresh columns display" org-columns-redo t]
16569 "--"
16570 ["Open link" org-columns-open-link t]
16571 "--"
16572 ["Quit" org-columns-quit t]))
16574 (defun org-columns-new-overlay (beg end &optional string face)
16575 "Create a new column overlay and add it to the list."
16576 (let ((ov (org-make-overlay beg end)))
16577 (org-overlay-put ov 'face (or face 'secondary-selection))
16578 (org-overlay-display ov string face)
16579 (push ov org-columns-overlays)
16580 ov))
16582 (defun org-columns-display-here (&optional props)
16583 "Overlay the current line with column display."
16584 (interactive)
16585 (let* ((fmt org-columns-current-fmt-compiled)
16586 (beg (point-at-bol))
16587 (level-face (save-excursion
16588 (beginning-of-line 1)
16590 (org-get-level-face 2))))
16591 (color (list :foreground
16592 (face-attribute (or level-face 'default) :foreground)))
16593 props pom property ass width f string ov column val modval)
16594 ;; Check if the entry is in another buffer.
16595 (unless props
16596 (if (eq major-mode 'org-agenda-mode)
16597 (setq pom (or (get-text-property (point) 'org-hd-marker)
16598 (get-text-property (point) 'org-marker))
16599 props (if pom (org-entry-properties pom) nil))
16600 (setq props (org-entry-properties nil))))
16601 ;; Walk the format
16602 (while (setq column (pop fmt))
16603 (setq property (car column)
16604 ass (if (equal property "ITEM")
16605 (cons "ITEM"
16606 (save-match-data
16607 (org-no-properties
16608 (org-remove-tabs
16609 (buffer-substring-no-properties
16610 (point-at-bol) (point-at-eol))))))
16611 (assoc property props))
16612 width (or (cdr (assoc property org-columns-current-maxwidths))
16613 (nth 2 column)
16614 (length property))
16615 f (format "%%-%d.%ds | " width width)
16616 val (or (cdr ass) "")
16617 modval (if (equal property "ITEM")
16618 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16619 string (format f (or modval val)))
16620 ;; Create the overlay
16621 (org-unmodified
16622 (setq ov (org-columns-new-overlay
16623 beg (setq beg (1+ beg)) string
16624 (list color 'org-column)))
16625 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16626 (org-overlay-put ov 'keymap org-columns-map)
16627 (org-overlay-put ov 'org-columns-key property)
16628 (org-overlay-put ov 'org-columns-value (cdr ass))
16629 (org-overlay-put ov 'org-columns-value-modified modval)
16630 (org-overlay-put ov 'org-columns-pom pom)
16631 (org-overlay-put ov 'org-columns-format f))
16632 (if (or (not (char-after beg))
16634 (let ((inhibit-read-only t))
16635 (save-excursion
16636 (goto-char beg)
16637 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16638 ;; Make the rest of the line disappear.
16639 (org-unmodified
16640 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16641 (org-overlay-put ov 'invisible t)
16642 (org-overlay-put ov 'keymap org-columns-map)
16643 (org-overlay-put ov 'intangible t)
16644 (push ov org-columns-overlays)
16645 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16646 (org-overlay-put ov 'keymap org-columns-map)
16647 (push ov org-columns-overlays)
16648 (let ((inhibit-read-only t))
16649 (put-text-property (max (point-min) (1- (point-at-bol)))
16650 (min (point-max) (1+ (point-at-eol)))
16651 'read-only "Type `e' to edit property")))))
16653 (defvar org-previous-header-line-format nil
16654 "The header line format before column view was turned on.")
16655 (defvar org-columns-inhibit-recalculation nil
16656 "Inhibit recomputing of columns on column view startup.")
16659 (defvar header-line-format)
16660 (defun org-columns-display-here-title ()
16661 "Overlay the newline before the current line with the table title."
16662 (interactive)
16663 (let ((fmt org-columns-current-fmt-compiled)
16664 string (title "")
16665 property width f column str widths)
16666 (while (setq column (pop fmt))
16667 (setq property (car column)
16668 str (or (nth 1 column) property)
16669 width (or (cdr (assoc property org-columns-current-maxwidths))
16670 (nth 2 column)
16671 (length str))
16672 widths (push width widths)
16673 f (format "%%-%d.%ds | " width width)
16674 string (format f str)
16675 title (concat title string)))
16676 (setq title (concat
16677 (org-add-props " " nil 'display '(space :align-to 0))
16678 (org-add-props title nil 'face '(:weight bold :underline t))))
16679 (org-set-local 'org-previous-header-line-format header-line-format)
16680 (org-set-local 'org-columns-current-widths (nreverse widths))
16681 (setq header-line-format title)))
16683 (defun org-columns-remove-overlays ()
16684 "Remove all currently active column overlays."
16685 (interactive)
16686 (when (marker-buffer org-columns-begin-marker)
16687 (with-current-buffer (marker-buffer org-columns-begin-marker)
16688 (when (local-variable-p 'org-previous-header-line-format)
16689 (setq header-line-format org-previous-header-line-format)
16690 (kill-local-variable 'org-previous-header-line-format))
16691 (move-marker org-columns-begin-marker nil)
16692 (move-marker org-columns-top-level-marker nil)
16693 (org-unmodified
16694 (mapc 'org-delete-overlay org-columns-overlays)
16695 (setq org-columns-overlays nil)
16696 (let ((inhibit-read-only t))
16697 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16699 (defun org-columns-cleanup-item (item fmt)
16700 "Remove from ITEM what is a column in the format FMT."
16701 (if (not org-complex-heading-regexp)
16702 item
16703 (when (string-match org-complex-heading-regexp item)
16704 (concat
16705 (org-add-props (concat (match-string 1 item) " ") nil
16706 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16707 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16708 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16709 " " (match-string 4 item)
16710 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16712 (defun org-columns-show-value ()
16713 "Show the full value of the property."
16714 (interactive)
16715 (let ((value (get-char-property (point) 'org-columns-value)))
16716 (message "Value is: %s" (or value ""))))
16718 (defun org-columns-quit ()
16719 "Remove the column overlays and in this way exit column editing."
16720 (interactive)
16721 (org-unmodified
16722 (org-columns-remove-overlays)
16723 (let ((inhibit-read-only t))
16724 (remove-text-properties (point-min) (point-max) '(read-only t))))
16725 (when (eq major-mode 'org-agenda-mode)
16726 (message
16727 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16729 (defun org-columns-check-computed ()
16730 "Check if this column value is computed.
16731 If yes, throw an error indicating that changing it does not make sense."
16732 (let ((val (get-char-property (point) 'org-columns-value)))
16733 (when (and (stringp val)
16734 (get-char-property 0 'org-computed val))
16735 (error "This value is computed from the entry's children"))))
16737 (defun org-columns-todo (&optional arg)
16738 "Change the TODO state during column view."
16739 (interactive "P")
16740 (org-columns-edit-value "TODO"))
16742 (defun org-columns-set-tags-or-toggle (&optional arg)
16743 "Toggle checkbox at point, or set tags for current headline."
16744 (interactive "P")
16746 (get-char-property (point) 'org-columns-value))
16747 (org-columns-next-allowed-value)
16748 (org-columns-edit-value "TAGS")))
16750 (defun org-columns-edit-value (&optional key)
16751 "Edit the value of the property at point in column view.
16752 Where possible, use the standard interface for changing this line."
16753 (interactive)
16754 (org-columns-check-computed)
16755 (let* ((external-key key)
16756 (col (current-column))
16757 (key (or key (get-char-property (point) 'org-columns-key)))
16758 (value (get-char-property (point) 'org-columns-value))
16759 (bol (point-at-bol)) (eol (point-at-eol))
16760 (pom (or (get-text-property bol 'org-hd-marker)
16761 (point))) ; keep despite of compiler waring
16762 (line-overlays
16763 (delq nil (mapcar (lambda (x)
16764 (and (eq (overlay-buffer x) (current-buffer))
16765 (>= (overlay-start x) bol)
16766 (<= (overlay-start x) eol)
16767 x))
16768 org-columns-overlays)))
16769 nval eval allowed)
16770 (cond
16771 ((equal key "CLOCKSUM")
16772 (error "This special column cannot be edited"))
16773 ((equal key "ITEM")
16774 (setq eval '(org-with-point-at pom
16775 (org-edit-headline))))
16776 ((equal key "TODO")
16777 (setq eval '(org-with-point-at pom
16778 (let ((current-prefix-arg
16779 (if external-key current-prefix-arg '(4))))
16780 (call-interactively 'org-todo)))))
16781 ((equal key "PRIORITY")
16782 (setq eval '(org-with-point-at pom
16783 (call-interactively 'org-priority))))
16784 ((equal key "TAGS")
16785 (setq eval '(org-with-point-at pom
16786 (let ((org-fast-tag-selection-single-key
16787 (if (eq org-fast-tag-selection-single-key 'expert)
16788 t org-fast-tag-selection-single-key)))
16789 (call-interactively 'org-set-tags)))))
16790 ((equal key "DEADLINE")
16791 (setq eval '(org-with-point-at pom
16792 (call-interactively 'org-deadline))))
16793 ((equal key "SCHEDULED")
16794 (setq eval '(org-with-point-at pom
16795 (call-interactively 'org-schedule))))
16796 (t
16797 (setq allowed (org-property-get-allowed-values pom key 'table))
16798 (if allowed
16799 (setq nval (completing-read "Value: " allowed nil t))
16800 (setq nval (read-string "Edit: " value)))
16801 (setq nval (org-trim nval))
16802 (when (not (equal nval value))
16803 (setq eval '(org-entry-put pom key nval)))))
16804 (when eval
16805 (let ((inhibit-read-only t))
16806 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16807 (unwind-protect
16808 (progn
16809 (setq org-columns-overlays
16810 (org-delete-all line-overlays org-columns-overlays))
16811 (mapc 'org-delete-overlay line-overlays)
16812 (org-columns-eval eval))
16813 (org-columns-display-here))))
16814 (move-to-column col)
16815 (if (and (org-mode-p)
16816 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16817 (org-columns-update key))))
16819 (defun org-edit-headline () ; FIXME: this is not columns specific
16820 "Edit the current headline, the part without TODO keyword, TAGS."
16821 (org-back-to-heading)
16822 (when (looking-at org-todo-line-regexp)
16823 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16824 (txt (match-string 3))
16825 (post "")
16826 txt2)
16828 (setq post (match-string 0 txt)
16829 txt (substring txt 0 (match-beginning 0))))
16830 (setq txt2 (read-string "Edit: " txt))
16831 (when (not (equal txt txt2))
16832 (beginning-of-line 1)
16833 (insert pre txt2 post)
16834 (delete-region (point) (point-at-eol))
16835 (org-set-tags nil t)))))
16837 (defun org-columns-edit-allowed ()
16838 "Edit the list of allowed values for the current property."
16839 (interactive)
16840 (let* ((key (get-char-property (point) 'org-columns-key))
16841 (key1 (concat key "_ALL"))
16842 (allowed (org-entry-get (point) key1 t))
16843 nval)
16844 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16845 (setq nval (read-string "Allowed: " allowed))
16846 (org-entry-put
16847 (cond ((marker-position org-entry-property-inherited-from)
16848 org-entry-property-inherited-from)
16849 ((marker-position org-columns-top-level-marker)
16850 org-columns-top-level-marker))
16851 key1 nval)))
16853 (defmacro org-no-warnings (&rest body)
16854 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16856 (defun org-columns-eval (form)
16857 (let (hidep)
16858 (save-excursion
16859 (beginning-of-line 1)
16860 ;; `next-line' is needed here, because it skips invisible line.
16861 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16862 (setq hidep (org-on-heading-p 1)))
16863 (eval form)
16864 (and hidep (hide-entry))))
16866 (defun org-columns-previous-allowed-value ()
16867 "Switch to the previous allowed value for this column."
16868 (interactive)
16869 (org-columns-next-allowed-value t))
16871 (defun org-columns-next-allowed-value (&optional previous)
16872 "Switch to the next allowed value for this column."
16873 (interactive)
16874 (org-columns-check-computed)
16875 (let* ((col (current-column))
16876 (key (get-char-property (point) 'org-columns-key))
16877 (value (get-char-property (point) 'org-columns-value))
16878 (bol (point-at-bol)) (eol (point-at-eol))
16879 (pom (or (get-text-property bol 'org-hd-marker)
16880 (point))) ; keep despite of compiler waring
16881 (line-overlays
16882 (delq nil (mapcar (lambda (x)
16883 (and (eq (overlay-buffer x) (current-buffer))
16884 (>= (overlay-start x) bol)
16885 (<= (overlay-start x) eol)
16886 x))
16887 org-columns-overlays)))
16888 (allowed (or (org-property-get-allowed-values pom key)
16889 (and (memq
16890 (nth 4 (assoc key org-columns-current-fmt-compiled))
16891 '(checkbox checkbox-n-of-m checkbox-percent))
16892 '("[ ]" "[X]"))))
16893 nval)
16894 (when (equal key "ITEM")
16895 (error "Cannot edit item headline from here"))
16896 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16897 (error "Allowed values for this property have not been defined"))
16898 (if (member key '("SCHEDULED" "DEADLINE"))
16899 (setq nval (if previous 'earlier 'later))
16900 (if previous (setq allowed (reverse allowed)))
16901 (if (member value allowed)
16902 (setq nval (car (cdr (member value allowed)))))
16903 (setq nval (or nval (car allowed)))
16904 (if (equal nval value)
16905 (error "Only one allowed value for this property")))
16906 (let ((inhibit-read-only t))
16907 (remove-text-properties (1- bol) eol '(read-only t))
16908 (unwind-protect
16909 (progn
16910 (setq org-columns-overlays
16911 (org-delete-all line-overlays org-columns-overlays))
16912 (mapc 'org-delete-overlay line-overlays)
16913 (org-columns-eval '(org-entry-put pom key nval)))
16914 (org-columns-display-here)))
16915 (move-to-column col)
16916 (if (and (org-mode-p)
16917 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16918 (org-columns-update key))))
16920 (defun org-verify-version (task)
16921 (cond
16922 ((eq task 'columns)
16923 (if (or (featurep 'xemacs)
16924 (< emacs-major-version 22))
16925 (error "Emacs 22 is required for the columns feature")))))
16927 (defun org-columns-open-link (&optional arg)
16928 (interactive "P")
16929 (let ((value (get-char-property (point) 'org-columns-value)))
16930 (org-open-link-from-string value arg)))
16932 (defun org-open-link-from-string (s &optional arg)
16933 "Open a link in the string S, as if it was in Org-mode."
16934 (interactive)
16935 (with-temp-buffer
16936 (let ((org-inhibit-startup t))
16937 (org-mode)
16938 (insert s)
16939 (goto-char (point-min))
16940 (org-open-at-point arg))))
16942 (defun org-columns-get-format-and-top-level ()
16943 (let (fmt)
16944 (when (condition-case nil (org-back-to-heading) (error nil))
16945 (move-marker org-entry-property-inherited-from nil)
16946 (setq fmt (org-entry-get nil "COLUMNS" t)))
16947 (setq fmt (or fmt org-columns-default-format))
16948 (org-set-local 'org-columns-current-fmt fmt)
16949 (org-columns-compile-format fmt)
16950 (if (marker-position org-entry-property-inherited-from)
16951 (move-marker org-columns-top-level-marker
16952 org-entry-property-inherited-from)
16953 (move-marker org-columns-top-level-marker (point)))
16954 fmt))
16956 (defun org-columns ()
16957 "Turn on column view on an org-mode file."
16958 (interactive)
16959 (org-verify-version 'columns)
16960 (org-columns-remove-overlays)
16961 (move-marker org-columns-begin-marker (point))
16962 (let (beg end fmt cache maxwidths)
16963 (setq fmt (org-columns-get-format-and-top-level))
16964 (save-excursion
16965 (goto-char org-columns-top-level-marker)
16966 (setq beg (point))
16967 (unless org-columns-inhibit-recalculation
16968 (org-columns-compute-all))
16969 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16970 (point-max)))
16971 ;; Get and cache the properties
16972 (goto-char beg)
16973 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16974 (save-excursion
16975 (save-restriction
16976 (narrow-to-region beg end)
16977 (org-clock-sum))))
16978 (while (re-search-forward (concat "^" outline-regexp) end t)
16979 (push (cons (org-current-line) (org-entry-properties)) cache))
16980 (when cache
16981 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16982 (org-set-local 'org-columns-current-maxwidths maxwidths)
16983 (org-columns-display-here-title)
16984 (mapc (lambda (x)
16985 (goto-line (car x))
16986 (org-columns-display-here (cdr x)))
16987 cache)))))
16989 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16990 "Insert a new column, to the leeft o the current column."
16991 (interactive)
16992 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16993 cell)
16994 (setq prop (completing-read
16995 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
16996 nil nil prop))
16997 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16998 (setq width (read-string "Column width: " (if width (number-to-string width))))
17000 (setq width (string-to-number width))
17001 (setq width nil))
17002 (setq fmt (completing-read "Summary [none]: "
17003 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
17004 nil t))
17006 (setq fmt (intern fmt))
17007 (setq fmt nil))
17008 (if (eq fmt 'none) (setq fmt nil))
17009 (if editp
17010 (progn
17011 (setcar editp prop)
17012 (setcdr editp (list title width nil fmt)))
17013 (setq cell (nthcdr (1- (current-column))
17014 org-columns-current-fmt-compiled))
17015 (setcdr cell (cons (list prop title width nil fmt)
17016 (cdr cell))))
17017 (org-columns-store-format)
17018 (org-columns-redo)))
17020 (defun org-columns-delete ()
17021 "Delete the column at point from columns view."
17022 (interactive)
17023 (let* ((n (current-column))
17024 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
17025 (when (y-or-n-p
17027 (setq org-columns-current-fmt-compiled
17028 (delq (nth n org-columns-current-fmt-compiled)
17029 org-columns-current-fmt-compiled))
17030 (org-columns-store-format)
17031 (org-columns-redo)
17032 (if (>= (current-column) (length org-columns-current-fmt-compiled))
17033 (backward-char 1)))))
17035 (defun org-columns-edit-attributes ()
17036 "Edit the attributes of the current column."
17037 (interactive)
17038 (let* ((n (current-column))
17039 (info (nth n org-columns-current-fmt-compiled)))
17040 (apply 'org-columns-new info)))
17042 (defun org-columns-widen (arg)
17043 "Make the column wider by ARG characters."
17044 (interactive "p")
17045 (let* ((n (current-column))
17046 (entry (nth n org-columns-current-fmt-compiled))
17047 (width (or (nth 2 entry)
17048 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
17049 (setq width (max 1 (+ width arg)))
17050 (setcar (nthcdr 2 entry) width)
17051 (org-columns-store-format)
17052 (org-columns-redo)))
17054 (defun org-columns-narrow (arg)
17055 "Make the column nrrower by ARG characters."
17056 (interactive "p")
17057 (org-columns-widen (- arg)))
17059 (defun org-columns-move-right ()
17060 "Swap this column with the one to the right."
17061 (interactive)
17062 (let* ((n (current-column))
17063 (cell (nthcdr n org-columns-current-fmt-compiled))
17064 e)
17065 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17066 (error "Cannot shift this column further to the right"))
17067 (setq e (car cell))
17068 (setcar cell (car (cdr cell)))
17069 (setcdr cell (cons e (cdr (cdr cell))))
17070 (org-columns-store-format)
17071 (org-columns-redo)
17072 (forward-char 1)))
17074 (defun org-columns-move-left ()
17075 "Swap this column with the one to the left."
17076 (interactive)
17077 (let* ((n (current-column)))
17078 (when (= n 0)
17079 (error "Cannot shift this column further to the left"))
17080 (backward-char 1)
17081 (org-columns-move-right)
17082 (backward-char 1)))
17084 (defun org-columns-store-format ()
17085 "Store the text version of the current columns format in appropriate place.
17086 This is either in the COLUMNS property of the node starting the current column
17087 display, or in the #+COLUMNS line of the current buffer."
17088 (let (fmt (cnt 0))
17089 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17090 (org-set-local 'org-columns-current-fmt fmt)
17091 (if (marker-position org-columns-top-level-marker)
17092 (save-excursion
17093 (goto-char org-columns-top-level-marker)
17094 (if (and (org-at-heading-p)
17095 (org-entry-get nil "COLUMNS"))
17096 (org-entry-put nil "COLUMNS" fmt)
17097 (goto-char (point-min))
17098 ;; Overwrite all #+COLUMNS lines....
17100 (setq cnt (1+ cnt))
17101 (replace-match (concat "#+COLUMNS: " fmt) t t))
17102 (unless (> cnt 0)
17103 (goto-char (point-min))
17104 (or (org-on-heading-p t) (outline-next-heading))
17105 (let ((inhibit-read-only t))
17107 (org-set-local 'org-columns-default-format fmt))))))
17109 (defvar org-overriding-columns-format nil
17110 "When set, overrides any other definition.")
17111 (defvar org-agenda-view-columns-initially nil
17112 "When set, switch to columns view immediately after creating the agenda.")
17114 (defun org-agenda-columns ()
17115 "Turn on column view in the agenda."
17116 (interactive)
17117 (org-verify-version 'columns)
17118 (org-columns-remove-overlays)
17119 (move-marker org-columns-begin-marker (point))
17120 (let (fmt cache maxwidths m)
17121 (cond
17122 ((and (local-variable-p 'org-overriding-columns-format)
17123 org-overriding-columns-format)
17124 (setq fmt org-overriding-columns-format))
17125 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17126 (setq fmt (org-entry-get m "COLUMNS" t)))
17127 ((and (boundp 'org-columns-current-fmt)
17128 (local-variable-p 'org-columns-current-fmt)
17129 org-columns-current-fmt)
17130 (setq fmt org-columns-current-fmt))
17131 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17132 (setq m (get-text-property m 'org-hd-marker))
17133 (setq fmt (org-entry-get m "COLUMNS" t))))
17134 (setq fmt (or fmt org-columns-default-format))
17135 (org-set-local 'org-columns-current-fmt fmt)
17136 (org-columns-compile-format fmt)
17137 (save-excursion
17138 ;; Get and cache the properties
17139 (goto-char (point-min))
17140 (while (not (eobp))
17141 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17142 (get-text-property (point) 'org-marker)))
17143 (push (cons (org-current-line) (org-entry-properties m)) cache))
17144 (beginning-of-line 2))
17145 (when cache
17146 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17147 (org-set-local 'org-columns-current-maxwidths maxwidths)
17148 (org-columns-display-here-title)
17149 (mapc (lambda (x)
17150 (goto-line (car x))
17151 (org-columns-display-here (cdr x)))
17152 cache)))))
17154 (defun org-columns-get-autowidth-alist (s cache)
17155 "Derive the maximum column widths from the format and the cache."
17156 (let ((start 0) rtn)
17158 (push (cons (match-string 1 s) 1) rtn)
17159 (setq start (match-end 0)))
17160 (mapc (lambda (x)
17161 (setcdr x (apply 'max
17162 (mapcar
17163 (lambda (y)
17164 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17165 cache))))
17166 rtn)
17167 rtn))
17169 (defun org-columns-compute-all ()
17170 "Compute all columns that have operators defined."
17171 (org-unmodified
17172 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17173 (let ((columns org-columns-current-fmt-compiled) col)
17174 (while (setq col (pop columns))
17175 (when (nth 3 col)
17176 (save-excursion
17177 (org-columns-compute (car col)))))))
17179 (defun org-columns-update (property)
17180 "Recompute PROPERTY, and update the columns display for it."
17181 (org-columns-compute property)
17182 (let (fmt val pos)
17183 (save-excursion
17184 (mapc (lambda (ov)
17185 (when (equal (org-overlay-get ov 'org-columns-key) property)
17186 (setq pos (org-overlay-start ov))
17187 (goto-char pos)
17188 (when (setq val (cdr (assoc property
17189 (get-text-property
17190 (point-at-bol) 'org-summaries))))
17191 (setq fmt (org-overlay-get ov 'org-columns-format))
17192 (org-overlay-put ov 'org-columns-value val)
17193 (org-overlay-put ov 'display (format fmt val)))))
17194 org-columns-overlays))))
17196 (defun org-columns-compute (property)
17197 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17198 (interactive)
17199 (let* ((re (concat "^" outline-regexp))
17200 (lmax 30) ; Does anyone use deeper levels???
17201 (lsum (make-vector lmax 0))
17202 (lflag (make-vector lmax nil))
17203 (level 0)
17204 (ass (assoc property org-columns-current-fmt-compiled))
17205 (format (nth 4 ass))
17206 (printf (nth 5 ass))
17207 (beg org-columns-top-level-marker)
17208 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17209 (save-excursion
17210 ;; Find the region to compute
17211 (goto-char beg)
17212 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17213 (goto-char end)
17214 ;; Walk the tree from the back and do the computations
17215 (while (re-search-backward re beg t)
17216 (setq sumpos (match-beginning 0)
17217 last-level level
17218 level (org-outline-level)
17219 val (org-entry-get nil property)
17221 (cond
17222 ((< level last-level)
17223 ;; put the sum of lower levels here as a property
17224 (setq sum (aref lsum last-level) ; current sum
17225 flag (aref lflag last-level) ; any valid entries from children?
17226 str (org-column-number-to-string sum format printf)
17227 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17228 useval (if flag str1 (if valflag val ""))
17229 sum-alist (get-text-property sumpos 'org-summaries))
17230 (if (assoc property sum-alist)
17231 (setcdr (assoc property sum-alist) useval)
17232 (push (cons property useval) sum-alist)
17233 (org-unmodified
17234 (add-text-properties sumpos (1+ sumpos)
17235 (list 'org-summaries sum-alist))))
17236 (when val
17237 (org-entry-put nil property (if flag str val)))
17238 ;; add current to current level accumulator
17239 (when (or flag valflag)
17240 (aset lsum level (+ (aref lsum level)
17241 (if flag sum (org-column-string-to-number
17242 (if flag str val) format))))
17243 (aset lflag level t))
17244 ;; clear accumulators for deeper levels
17245 (loop for l from (1+ level) to (1- lmax) do
17246 (aset lsum l 0)
17247 (aset lflag l nil)))
17248 ((>= level last-level)
17249 ;; add what we have here to the accumulator for this level
17250 (aset lsum level (+ (aref lsum level)
17251 (org-column-string-to-number (or val "0") format)))
17252 (and valflag (aset lflag level t)))
17253 (t (error "This should not happen")))))))
17255 (defun org-columns-redo ()
17256 "Construct the column display again."
17257 (interactive)
17258 (message "Recomputing columns...")
17259 (save-excursion
17260 (if (marker-position org-columns-begin-marker)
17261 (goto-char org-columns-begin-marker))
17262 (org-columns-remove-overlays)
17263 (if (org-mode-p)
17264 (call-interactively 'org-columns)
17265 (call-interactively 'org-agenda-columns)))
17266 (message "Recomputing columns...done"))
17268 (defun org-columns-not-in-agenda ()
17269 (if (eq major-mode 'org-agenda-mode)
17270 (error "This command is only allowed in Org-mode buffers")))
17273 (defun org-string-to-number (s)
17274 "Convert string to number, and interpret hh:mm:ss."
17275 (if (not (string-match ":" s))
17276 (string-to-number s)
17277 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17278 (while l
17279 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17280 sum)))
17282 (defun org-column-number-to-string (n fmt &optional printf)
17283 "Convert a computed column number to a string value, according to FMT."
17284 (cond
17285 ((eq fmt 'add_times)
17286 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17287 (format "%d:%02d" h m)))
17288 ((eq fmt 'checkbox)
17289 (cond ((= n (floor n)) "[X]")
17290 ((> n 1.) "[-]")
17291 (t "[ ]")))
17292 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17293 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17294 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17295 (printf (format printf n))
17296 ((eq fmt 'currency)
17297 (format "%.2f" n))
17298 (t (number-to-string n))))
17300 (defun org-nofm-to-completion (n m &optional percent)
17301 (if (not percent)
17302 (format "[%d/%d]" n m)
17303 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17305 (defun org-column-string-to-number (s fmt)
17306 "Convert a column value to a number that can be used for column computing."
17307 (cond
17308 ((string-match ":" s)
17309 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17310 (while l
17311 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17312 sum))
17313 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17314 (if (equal s "[X]") 1. 0.000001))
17315 (t (string-to-number s))))
17317 (defun org-columns-uncompile-format (cfmt)
17318 "Turn the compiled columns format back into a string representation."
17319 (let ((rtn "") e s prop title op width fmt printf)
17320 (while (setq e (pop cfmt))
17321 (setq prop (car e)
17322 title (nth 1 e)
17323 width (nth 2 e)
17324 op (nth 3 e)
17325 fmt (nth 4 e)
17326 printf (nth 5 e))
17327 (cond
17328 ((eq fmt 'add_times) (setq op ":"))
17329 ((eq fmt 'checkbox) (setq op "X"))
17330 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17331 ((eq fmt 'checkbox-percent) (setq op "X%"))
17332 ((eq fmt 'add_numbers) (setq op "+"))
17333 ((eq fmt 'currency) (setq op "$")))
17334 (if (and op printf) (setq op (concat op ";" printf)))
17335 (if (equal title prop) (setq title nil))
17336 (setq s (concat "%" (if width (number-to-string width))
17337 prop
17338 (if title (concat "(" title ")"))
17339 (if op (concat "{" op "}"))))
17340 (setq rtn (concat rtn " " s)))
17341 (org-trim rtn)))
17343 (defun org-columns-compile-format (fmt)
17344 "Turn a column format string into an alist of specifications.
17345 The alist has one entry for each column in the format. The elements of
17346 that list are:
17347 property the property
17348 title the title field for the columns
17349 width the column width in characters, can be nil for automatic
17350 operator the operator if any
17351 format the output format for computed results, derived from operator
17352 printf a printf format for computed values"
17353 (let ((start 0) width prop title op f printf)
17354 (setq org-columns-current-fmt-compiled nil)
17355 (while (string-match
17356 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17357 fmt start)
17358 (setq start (match-end 0)
17359 width (match-string 1 fmt)
17360 prop (match-string 2 fmt)
17361 title (or (match-string 3 fmt) prop)
17362 op (match-string 4 fmt)
17363 f nil
17364 printf nil)
17365 (if width (setq width (string-to-number width)))
17366 (when (and op (string-match ";" op))
17367 (setq printf (substring op (match-end 0))
17368 op (substring op 0 (match-beginning 0))))
17369 (cond
17370 ((equal op "+") (setq f 'add_numbers))
17371 ((equal op "$") (setq f 'currency))
17372 ((equal op ":") (setq f 'add_times))
17373 ((equal op "X") (setq f 'checkbox))
17374 ((equal op "X/") (setq f 'checkbox-n-of-m))
17375 ((equal op "X%") (setq f 'checkbox-percent))
17376 )
17377 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17378 (setq org-columns-current-fmt-compiled
17379 (nreverse org-columns-current-fmt-compiled))))
17382 ;;; Dynamic block for Column view
17384 (defun org-columns-capture-view ()
17385 "Get the column view of the current buffer and return it as a list.
17386 The list will contains the title row and all other rows. Each row is
17387 a list of fields."
17388 (save-excursion
17389 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17390 (n (length title)) row tbl)
17391 (goto-char (point-min))
17393 (when (get-char-property (match-beginning 0) 'org-columns-key)
17394 (setq row nil)
17395 (loop for i from 0 to (1- n) do
17396 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17397 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17398 "")
17399 row))
17400 (setq row (nreverse row))
17401 (push row tbl)))
17402 (append (list title 'hline) (nreverse tbl)))))
17404 (defun org-dblock-write:columnview (params)
17405 "Write the column view table.
17406 PARAMS is a property list of parameters:
17408 :width enforce same column widths with <N> specifiers.
17409 :id the :ID: property of the entry where the columns view
17410 should be built, as a string. When `local', call locally.
17411 When `global' call column view with the cursor at the beginning
17412 of the buffer (usually this means that the whole buffer switches
17413 to column view).
17414 :hlines When t, insert a hline before each item. When a number, insert
17415 a hline before each level <= that number.
17416 :vlines When t, make each column a colgroup to enforce vertical lines."
17417 (let ((pos (move-marker (make-marker) (point)))
17418 (hlines (plist-get params :hlines))
17419 (vlines (plist-get params :vlines))
17420 tbl id idpos nfields tmp)
17421 (save-excursion
17422 (save-restriction
17423 (when (setq id (plist-get params :id))
17424 (cond ((not id) nil)
17425 ((eq id 'global) (goto-char (point-min)))
17426 ((eq id 'local) nil)
17427 ((setq idpos (org-find-entry-with-id id))
17428 (goto-char idpos))
17429 (t (error "Cannot find entry with :ID: %s" id))))
17430 (org-columns)
17431 (setq tbl (org-columns-capture-view))
17432 (setq nfields (length (car tbl)))
17433 (org-columns-quit)))
17434 (goto-char pos)
17435 (move-marker pos nil)
17436 (when tbl
17437 (when (plist-get params :hlines)
17438 (setq tmp nil)
17439 (while tbl
17440 (if (eq (car tbl) 'hline)
17441 (push (pop tbl) tmp)
17443 (if (and (not (eq (car tmp) 'hline))
17444 (or (eq hlines t)
17445 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17446 (push 'hline tmp)))
17447 (push (pop tbl) tmp)))
17448 (setq tbl (nreverse tmp)))
17449 (when vlines
17450 (setq tbl (mapcar (lambda (x)
17451 (if (eq 'hline x) x (cons "" x)))
17452 tbl))
17453 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17454 (setq pos (point))
17455 (insert (org-listtable-to-string tbl))
17456 (when (plist-get params :width)
17458 org-columns-current-widths "|")))
17459 (goto-char pos)
17460 (org-table-align))))
17462 (defun org-listtable-to-string (tbl)
17463 "Convert a listtable TBL to a string that contains the Org-mode table.
17464 The table still need to be alligned. The resulting string has no leading
17465 and tailing newline characters."
17466 (mapconcat
17467 (lambda (x)
17468 (cond
17469 ((listp x)
17470 (concat "|" (mapconcat 'identity x "|") "|"))
17471 ((eq x 'hline) "|-|")
17472 (t (error "Garbage in listtable: %s" x))))
17475 (defun org-insert-columns-dblock ()
17476 "Create a dynamic block capturing a column view table."
17477 (interactive)
17478 (let ((defaults '(:name "columnview" :hlines 1))
17479 (id (completing-read
17480 "Capture columns (local, global, entry with :ID: property) [local]: "
17481 (append '(("global") ("local"))
17482 (mapcar 'list (org-property-values "ID"))))))
17483 (if (equal id "") (setq id 'local))
17484 (if (equal id "global") (setq id 'global))
17485 (setq defaults (append defaults (list :id id)))
17486 (org-create-dblock defaults)
17487 (org-update-dblock)))
17489 ;;;; Timestamps
17491 (defvar org-last-changed-timestamp nil)
17492 (defvar org-time-was-given) ; dynamically scoped parameter
17493 (defvar org-end-time-was-given) ; dynamically scoped parameter
17494 (defvar org-ts-what) ; dynamically scoped parameter
17496 (defun org-time-stamp (arg)
17497 "Prompt for a date/time and insert a time stamp.
17498 If the user specifies a time like HH:MM, or if this command is called
17499 with a prefix argument, the time stamp will contain date and time.
17500 Otherwise, only the date will be included. All parts of a date not
17501 specified by the user will be filled in from the current date/time.
17502 So if you press just return without typing anything, the time stamp
17503 will represent the current date/time. If there is already a timestamp
17504 at the cursor, it will be modified."
17505 (interactive "P")
17506 (let* ((ts nil)
17507 (default-time
17508 ;; Default time is either today, or, when entering a range,
17509 ;; the range start.
17510 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17511 (save-excursion
17512 (re-search-backward
17514 (- (point) 20) t)))
17515 (apply 'encode-time (org-parse-time-string (match-string 1)))
17516 (current-time)))
17517 (default-input (and ts (org-get-compact-tod ts)))
17518 org-time-was-given org-end-time-was-given time)
17519 (cond
17520 ((and (org-at-timestamp-p)
17521 (eq last-command 'org-time-stamp)
17522 (eq this-command 'org-time-stamp))
17523 (insert "--")
17524 (setq time (let ((this-command this-command))
17525 (org-read-date arg 'totime nil nil default-time default-input)))
17526 (org-insert-time-stamp time (or org-time-was-given arg)))
17527 ((org-at-timestamp-p)
17528 (setq time (let ((this-command this-command))
17529 (org-read-date arg 'totime nil nil default-time default-input)))
17530 (when (org-at-timestamp-p) ; just to get the match data
17531 (replace-match "")
17532 (setq org-last-changed-timestamp
17533 (org-insert-time-stamp
17534 time (or org-time-was-given arg)
17535 nil nil nil (list org-end-time-was-given))))
17536 (message "Timestamp updated"))
17537 (t
17538 (setq time (let ((this-command this-command))
17539 (org-read-date arg 'totime nil nil default-time default-input)))
17540 (org-insert-time-stamp time (or org-time-was-given arg)
17541 nil nil nil (list org-end-time-was-given))))))
17543 ;; FIXME: can we use this for something else????
17544 ;; like computing time differences?????
17545 (defun org-get-compact-tod (s)
17546 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17547 (let* ((t1 (match-string 1 s))
17548 (h1 (string-to-number (match-string 2 s)))
17549 (m1 (string-to-number (match-string 3 s)))
17550 (t2 (and (match-end 4) (match-string 5 s)))
17551 (h2 (and t2 (string-to-number (match-string 6 s))))
17552 (m2 (and t2 (string-to-number (match-string 7 s))))
17553 dh dm)
17554 (if (not t2)
17555 t1
17556 (setq dh (- h2 h1) dm (- m2 m1))
17557 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17558 (concat t1 "+" (number-to-string dh)
17559 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17561 (defun org-time-stamp-inactive (&optional arg)
17562 "Insert an inactive time stamp.
17563 An inactive time stamp is enclosed in square brackets instead of angle
17564 brackets. It is inactive in the sense that it does not trigger agenda entries,
17565 does not link to the calendar and cannot be changed with the S-cursor keys.
17566 So these are more for recording a certain time/date."
17567 (interactive "P")
17568 (let (org-time-was-given org-end-time-was-given time)
17569 (setq time (org-read-date arg 'totime))
17570 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17571 nil nil (list org-end-time-was-given))))
17573 (defvar org-date-ovl (org-make-overlay 1 1))
17574 (org-overlay-put org-date-ovl 'face 'org-warning)
17575 (org-detach-overlay org-date-ovl)
17577 (defvar org-ans1) ; dynamically scoped parameter
17578 (defvar org-ans2) ; dynamically scoped parameter
17580 (defvar org-plain-time-of-day-regexp) ; defined below
17582 (defvar org-read-date-overlay nil)
17583 (defvar org-dcst nil) ; dynamically scoped
17585 (defun org-read-date (&optional with-time to-time from-string prompt
17586 default-time default-input)
17587 "Read a date, possibly a time, and make things smooth for the user.
17588 The prompt will suggest to enter an ISO date, but you can also enter anything
17589 which will at least partially be understood by `parse-time-string'.
17590 Unrecognized parts of the date will default to the current day, month, year,
17591 hour and minute. If this command is called to replace a timestamp at point,
17592 of to enter the second timestamp of a range, the default time is taken from the
17593 existing stamp. For example,
17594 3-2-5 --> 2003-02-05
17595 feb 15 --> currentyear-02-15
17596 sep 12 9 --> 2009-09-12
17597 12:45 --> today 12:45
17598 22 sept 0:34 --> currentyear-09-22 0:34
17599 12 --> currentyear-currentmonth-12
17600 Fri --> nearest Friday (today or later)
17601 etc.
17603 Furthermore you can specify a relative date by giving, as the *first* thing
17604 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17605 change in days weeks, months, years.
17606 With a single plus or minus, the date is relative to today. With a double
17607 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17608 +4d --> four days from today
17609 +4 --> same as above
17610 +2w --> two weeks from today
17611 ++5 --> five days from default date
17613 The function understands only English month and weekday abbreviations,
17614 but this can be configured with the variables `parse-time-months' and
17615 `parse-time-weekdays'.
17617 While prompting, a calendar is popped up - you can also select the
17618 date with the mouse (button 1). The calendar shows a period of three
17619 months. To scroll it to other months, use the keys `>' and `<'.
17620 If you don't like the calendar, turn it off with
17621 \(setq org-read-date-popup-calendar nil)
17623 With optional argument TO-TIME, the date will immediately be converted
17624 to an internal time.
17625 With an optional argument WITH-TIME, the prompt will suggest to also
17626 insert a time. Note that when WITH-TIME is not set, you can still
17627 enter a time, and this function will inform the calling routine about
17628 this change. The calling routine may then choose to change the format
17629 used to insert the time stamp into the buffer to include the time.
17630 With optional argument FROM-STRING, read from this string instead from
17631 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17632 the time/date that is used for everything that is not specified by the
17633 user."
17634 (require 'parse-time)
17635 (let* ((org-time-stamp-rounding-minutes
17636 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17637 (org-dcst org-display-custom-times)
17638 (ct (org-current-time))
17639 (def (or default-time ct))
17640 (defdecode (decode-time def))
17641 (dummy (progn
17642 (when (< (nth 2 defdecode) org-extend-today-until)
17643 (setcar (nthcdr 2 defdecode) -1)
17644 (setcar (nthcdr 1 defdecode) 59)
17645 (setq def (apply 'encode-time defdecode)
17646 defdecode (decode-time def)))))
17647 (calendar-move-hook nil)
17648 (view-diary-entries-initially nil)
17649 (view-calendar-holidays-initially nil)
17650 (timestr (format-time-string
17651 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17652 (prompt (concat (if prompt (concat prompt " ") "")
17653 (format "Date+time [%s]: " timestr)))
17654 ans (org-ans0 "") org-ans1 org-ans2 final)
17656 (cond
17657 (from-string (setq ans from-string))
17658 (org-read-date-popup-calendar
17659 (save-excursion
17660 (save-window-excursion
17661 (calendar)
17662 (calendar-forward-day (- (time-to-days def)
17663 (calendar-absolute-from-gregorian
17664 (calendar-current-date))))
17665 (org-eval-in-calendar nil t)
17666 (let* ((old-map (current-local-map))
17667 (map (copy-keymap calendar-mode-map))
17668 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17669 (org-defkey map (kbd "RET") 'org-calendar-select)
17670 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17671 'org-calendar-select-mouse)
17709 ;; org-ans0: from prompt
17710 ;; org-ans1: from mouse click
17711 ;; org-ans2: from calendar motion
17739 "Display the currrent date prompt interpretation in the minibuffer."
17755 org-time-stamp-custom-formats
17756 org-time-stamp-formats))
17765 org-end-time-was-given
17772 "Analyze the combined answer of the date prompt."
17773 ;; FIXME: cleanup and comment
17775 hour minute second wday pm h2 m2 tl wday1)
17783 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17793 t nil ans)))
17794 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17795 ;; If there is a time with am/pm, and *no* time without it, we convert
17796 ;; so that matching will be successful.
17810 t t ans))))
17812 ;; Check if a time range is given as a duration
17813 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17821 ;; Check if there is a time range
17855 ;; Weekday was given, but no day, so pick that day in the week
17856 ;; on or after the derived date.
17870 "Check string S for special relative date string.
17871 TODAY and DEFAULT are internal times, for today and for a default.
17872 Return shift list (N what def-flag)
17874 N is the number of WHATs to shift.
17875 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17876 the DEFAULT date rather than TODAY."
17885 ?+))
17892 delta)
17902 "Eval FORM in the calendar window and return to current window.
17903 Also, store the cursor date in variable org-ans2."
17914 ; ;; Update the prompt to show new default date
17915 ; (save-excursion
17916 ; (goto-char (point-min))
17917 ; (when (and org-ans2
17918 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17919 ; (get-text-property (match-end 0) 'field))
17920 ; (let ((inhibit-read-only t))
17921 ; (replace-match (concat "[" org-ans2 "]") t t)
17922 ; (add-text-properties (point-min) (1+ (match-end 0))
17923 ; (text-properties-at (1+ (point-min)))))))))
17926 "Return to `org-read-date' with the date currently selected.
17927 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17936 "Insert a date stamp for the date given by the internal TIME.
17937 WITH-HM means, use the stamp format that includes the time of the day.
17938 INACTIVE means use square brackets instead of angular ones, so that the
17939 stamp will not contribute to the agenda.
17940 PRE and POST are optional strings to be inserted before and after the
17941 stamp.
17942 The command returns the inserted time stamp."
17944 stamp)
17961 stamp))
17964 "Toggle the use of custom time stamp formats."
17985 "Overlay modified time stamp format over timestamp between BED and END."
18012 "Translate all timestamps in STRING to custom format.
18013 But do this only if the variable `org-display-custom-times' is set."
18018 t1 with-hm inactive tf time str beg end)
18027 org-time-stamp-custom-formats)
18036 string)
18039 "Set 0 instead of nil for the first 6 elements of time.
18040 Don't touch the rest."
18045 "Difference between TIMESTAMP-STRING and now in days."
18050 "Is the time in TIMESTAMP-STRING close to the current date?"
18056 "Get the deadline lead time appropriate for timestring TS."
18059 ;; 0 or negative, enforce this value no matter what
18062 ;; lead time is specified.
18067 ;; go for the default.
18071 "Return to `org-read-date' with the date currently selected.
18072 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18082 "Check if there are any deadlines due or past due.
18083 A deadline is considered due if it happens within `org-deadline-warning-days'
18084 days from today's date. If the deadline appears in an entry marked DONE,
18085 it is not shown. The prefix arg NDAYS can be used to test that many
18100 org-warn-days)))
18103 "Check if there are deadlines or scheduled entries before DATE."
18117 "Evaluate a time range by computing the difference between start and end.
18118 Normally the result is just printed in the echo area, but with prefix arg
18119 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18120 If the time range is actually in a table, the result is inserted into the
18121 next column.
18122 For time difference computation, a year is assumed to be exactly 365
18123 days in order to avoid rounding problems."
18143 ;; (ys (floor (* 365 24 60 60)))
18151 y d h m align)
18154 y 0
18159 y 0
18197 "Convert a time stamp to an absolute day number.
18198 If there is a specifyer for a cyclic time stamp, get the closest date to
18199 DAYNR."
18203 daynr
18208 prefer))
18212 "Return the time corresponding to date D.
18213 D may be an absolute day number, or a calendar-type list (month day year)."
18218 "List of holidays, for Diary display in Org-mode."
18226 "Process a SEXP diary ENTRY for DATE."
18246 "Get iCalendar entries from diary entries in buffer FROMBUF.
18247 This uses the icalendar.el library."
18250 temporary-file-directory))
18253 buf rtn b e)
18269 rtn))
18272 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18273 When PREFER is `past' return a date that is either CURRENT or past.
18274 When PREFER is `future', return a date that is either CURRENT or future."
18275 ;; Make the proper lists from the dates
18278 dn dw sday cday n1 n2
18279 d m y y1 y2 date1 date2 nmonths nm ny m2)
18284 current
18308 ;; approx number of month between the tow dates
18310 ;; How often does dn fit in there?
18339 "Turn any specification of DATE into a gregorian date for the calendar."
18349 "Parse the standard Org-mode time string.
18350 This should be a lot faster than the normal `parse-time-string'.
18351 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18352 hour and minute fields will be nil if not given."
18362 nil nil nil)
18366 "Increase the date item at the cursor by one.
18367 If the cursor is on the year, change the year. If it is on the month or
18368 the day, change that.
18369 With prefix ARG, change by that many units."
18374 "Decrease the date item at the cursor by one.
18375 If the cursor is on the year, change the year. If it is on the month or
18376 the day, change that.
18377 With prefix ARG, change by that many units."
18382 "Increase the date in the time stamp by one day.
18383 With prefix ARG, change that many days."
18391 "Decrease the date in the time stamp by one day.
18392 With prefix ARG, change that many days."
18405 "Determine if the cursor is in or at a timestamp."
18431 ans))
18434 ""
18446 "Change the date in the time stamp at point.
18447 The date will be changed by N times WHAT. WHAT can be `day', `month',
18448 `year', `minute', `second'. If WHAT is not given, the cursor position
18449 in the timestamp determines what will be changed."
18451 with-hm inactive
18452 org-ts-what
18453 extra
18454 ts time time0)
18460 org-display-custom-times
18470 ts)
18498 ;; Try to recenter the calendar window, if any
18504 ;; FIXME: does not yet work for lead times
18506 "Change the different parts of the lead-time and repeat fields in timestamp."
18508 ng h m new)
18509 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18530 new
18532 s))
18535 "If the calendar is visible, recenter it to DATE."
18546 "Go to the Emacs calendar at the current date.
18547 If there is a time stamp in the current line, go to that date.
18548 A prefix ARG can be used to force the current date."
18567 "Return a list (month day year) of date at point in calendar."
18573 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18574 If there is already a time stamp at the cursor position, update it."
18582 ;;;###autoload
18584 "Activate appointments found in `org-agenda-files'.
18585 When prefixed, prompt for a regular expression and use it as a
18586 filter: only add entries if they match this regular expression.
18588 FILTER can be a string. In this case, use this string as a
18589 regular expression to filter results.
18591 FILTER can also be an alist, with the car of each cell being
18592 either 'headline or 'category. For example:
18597 will only add headlines containing IMPORTANT or headlines
18611 ;; Get all entries which may contain an appt
18618 ;; Map thru entries and find if we should filter them out
18631 ;; FIXME: Shall we remove text-properties for the appt text?
18632 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18644 ;;; The clock for measuring work time.
18669 "Start the clock on the current item.
18670 If necessary, clock-out of the currently active clock."
18678 org-clock-in-switch-to-state
18705 "Find the location where the next clock line should be inserted."
18711 first last)
18715 ;; we seem to have a CLOCK drawer, so go there.
18718 ;; Lets count the CLOCK lines
18726 ;; Wrap current entries into a new drawer
18744 ;; Planning info, skip to after it
18756 "Stop the currently running clock.
18757 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18794 "Cancel the running clock be removing the start timestamp."
18808 "Go to the currently clocked-in entry."
18825 "Sum the times for each subtree.
18826 Puts the resulting times in minutes as a text property on each headline."
18830 org-clock-string
18836 ts te dt
18837 time)
18844 ;; Two time stamps
18856 ;; A naket time
18873 "Show subtree times in the entire buffer.
18874 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18875 in the echo area."
18892 ;; Arrange to remove the overlays upon next change.
18902 "Put an overlays on the current line, displaying TIME.
18903 If LEVEL is given, prefix time with a corresponding number of stars.
18904 This creates a new overlay and stores it in `org-clock-overlays', so that it
18905 will be easy to remove."
18909 ov tx)
18928 "Remove the occur highlights from the buffer.
18929 BEG and END are ignored. If NOREMOVE is nil, remove this function
18930 from the `before-change-functions' in the current buffer."
18940 "Clock out if the current entry contains the running clock.
18941 This is used to stop the clock after a TODO entry is marked DONE,
18942 and is only done if the variable `org-clock-out-when-done' is not nil."
18948 org-clock-marker))
18949 ;; Clock out, but don't accept a logging message for this.
18957 "Check if the current buffer contains the running clock.
18958 If yes, offer to stop it and to save the buffer with the changes."
18967 "Create a table containing a report about clocked time.
18968 If the cursor is inside an existing clocktable block, then the table
18969 will be updated. If not, a new clocktable will be inserted.
18970 When called with a prefix argument, move to the first clock table in the
18971 buffer and update it."
18984 "Check if the cursor is in a clocktable."
18992 start))))
18995 "If this is a CLOCK line, update it and return t.
18996 Otherwise, return nil."
19005 ts te h m s)
19007 nil
19021 t)))))
19024 "Return two times bordering a special time range.
19025 Key is a symbol specifying the range and can be one of `today', `yesterday',
19026 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
19027 A week starts Monday 0:00 and ends Sunday 24:00.
19028 The range is determined relative to TIME. TIME defaults to the current time.
19029 The return value is a cons cell with two internal times like the ones
19030 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
19031 the returned times will be formatted strings."
19036 s1 m1 h1 d1 month1 y1 diff ts te fm)
19066 "Write the standard clocktable."
19081 ipos time h m p level hlc hdl
19082 cc beg end pos tbl)
19096 ;; Get the right scope
19119 file)
19129 org-clock-file-total-minutes)))))))
19140 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19161 "Clock summary at ["
19165 "]."
19178 "|"
19179 "*Total time*| "
19201 cc)
19235 x))
19236 lines)
19239 ;; FIXME: I don't think anybody uses this, ask David
19241 "Return an internal list with clocking information.
19242 This list has one entry for each CLOCK interval.
19243 FIXME: describe the elements."
19247 rtn beg end next cont level title total closedp leafp
19248 clockpos titlepos h m donep)
19273 total title titlepos level leafp)
19274 rtn)
19278 ;;;; Agenda, and Diary Integration
19280 ;;; Define the Org-agenda-mode
19294 "Mode for time-sorted view on action items in Org-mode files.
19296 The following commands are available:
19302 org-agenda-pending-undo-list nil)
19304 ;; Keep global-font-lock-mode from turning on font-lock-mode
19312 ;; Make sure properties are removed when copying text
19317 buffer-substring-filters)))
19320 org-agenda-show-log nil))
19327 "Restricted to single file"
19339 org-agenda-mode-map global-map)
19437 "--"
19444 "--"
19448 "--"
19453 "--"
19458 "--"
19463 "--"
19480 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19484 "--"
19486 "--"
19496 "--"
19498 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19502 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19506 "--"
19508 "--"
19511 ))
19513 ;;; Agenda undo
19525 "Execute BODY if there is no `org-protected' text property at point."
19531 "Execute BODY while recording undo information in two buffers."
19539 _c1 _c2)
19540 ,@_body
19547 ;; make sure there are undo boundaries
19550 ;; remember which buffer to undo
19552 org-agenda-undo-list)))))
19555 "Undo a remote editing step in the agenda.
19556 This undoes changes both in the agenda buffer and in the remote buffer
19557 that have been changed along."
19563 org-agenda-pending-undo-list org-agenda-undo-list))
19567 buf line cmd rembuf)
19589 "Verify that a real change occurred between the undo lists L1 and L2."
19594 ;;; Agenda dispatch
19602 ;;;###autoload
19604 "Dispatch agenda commands to collect entries to the agenda buffer.
19605 Prompts for a command to execute. Any prefix arg will be passed
19606 on to the selected command. The default selections are:
19608 a Call `org-agenda-list' to display the agenda for current day or week.
19609 t Call `org-todo-list' to display the global todo list.
19610 T Call `org-todo-list' to display the global todo list, select only
19611 entries with a specific TODO keyword (the user gets a prompt).
19612 m Call `org-tags-view' to display headlines with tags matching
19613 a condition (the user is prompted for the condition).
19614 M Like `m', but select only TODO entries, no ordinary headlines.
19615 L Create a timeline for the current buffer.
19616 e Export views to associated files.
19618 More commands can be added by configuring the variable
19619 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19620 searches can be pre-defined in this way.
19622 If the current buffer is in Org-mode and visiting a file, you can also
19623 first press `<' once to indicate that the agenda should be temporarily
19625 Pressing `<' twice means to restrict to the current subtree or region
19626 \(if active)."
19632 ;; normalize different versions
19638 nil)
19642 org-agenda-custom-commands)))
19645 entry key type match lprops ans)
19646 ;; Turn off restriction unless there is an overriding one
19652 ;; Delete old local properties
19654 ;; Remember where this call originated
19660 ;; Estabish the restriction, if any
19677 ;; For example the todo list should not need it (but does...)
19691 current-prefix-arg)))
19743 cmds)))
19746 "The user interface for selecting an agenda command."
19753 restriction second-time
19754 c entry key type match prefixes rmheader header-end custom1 desc)
19761 "
19762 Press key for an agenda command: < Buffer,subtree/region restriction
19763 -------------------------------- > Remove restriction
19764 a Agenda for current week or day e Export agenda views
19765 t List of all TODO entries T Entries with special TODO kwd
19766 m Match a TAGS query M Like m, but only TODO entries
19767 L Timeline for current buffer # List stuck projects (!=configure)
19768 / Multi-occur C Configure custom agenda commands
19773 header start)
19777 header)))
19829 prefix-descriptions))
19831 prefixes))
19842 " (restriction lock active)"
19855 prefixes nil
19861 nil
19863 custom))))
19880 nil)
19900 match ;; The byte compiler incorrectly complains about this. Keep it!
19901 cmd type lprops)
19932 ;;;###autoload
19934 "Run an agenda command in batch mode and send the result to STDOUT.
19935 If CMD-KEY is a string of length 1, it is used as a key in
19936 `org-agenda-custom-commands' and triggers this command. If it is a
19937 longer string it is used as a tags/todo match string.
19938 Paramters are alternating variable names and values that will be bound
19939 before running the agenda command."
19953 string))
19957 ;;;###autoload
19959 "Run an agenda command in batch mode and send the result to STDOUT.
19960 If CMD-KEY is a string of length 1, it is used as a key in
19961 `org-agenda-custom-commands' and triggers this command. If it is a
19962 longer string it is used as a tags/todo match string.
19963 Paramters are alternating variable names and values that will be bound
19964 before running the agenda command.
19966 The output gives a line for each selected agenda item. Each
19967 item is a list of comma-separated values, like this:
19969 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19971 category The category of the item
19972 head The headline, without TODO kwd, TAGS and PRIORITY
19973 type The type of the agenda entry, can be
19974 todo selected in TODO match
19975 tagsmatch selected in tags match
19976 diary imported from diary
19977 deadline a deadline on given date
19978 scheduled scheduled on given date
19979 timestamp entry has timestamp on given date
19980 closed entry was closed on given date
19981 upcoming-deadline warning about deadline
19982 past-scheduled forwarded scheduled item
19983 block entry has date block including g. date
19984 todo The todo keyword, if any
19985 tags All tags including inherited ones, separated by colons
19986 date The relevant date, like 2007-2-14
19987 time The time, like 15:00-16:50
19988 extra Sting with extra planning info
19989 priority-l The priority letter if any was given
19990 priority-n The computed numerical priority
19991 agenda-day The day in the agenda where this is listed"
20003 line)
20013 priority-letter priority agenda-day)
20018 "Make sure all properties on an agenda item have a canonical form,
20019 so the export commands can easily use it."
20046 props)
20060 ;;;###autoload
20065 ;; FIXME, why is this a macro?????
20066 ;;;###autoload
20068 "Run all custom agenda commands that have a file argument."
20072 pars cmd thiscmdkey files opts)
20095 "Write the current buffer (an agenda view) as a file.
20096 Depending on the extension of the file name, plain text (.txt),
20097 HTML (.html or .htm) or Postscript (.ps) is produced.
20098 If NOSETTINGS is given, do not scope the settings of
20099 `org-agenda-exporter-settings' into the export commands. This is used when
20100 the settings have already been scoped and we do not wish to overrule other,
20101 higher priority settings."
20117 ;; replace <style> section with org-agenda-export-html-style
20138 "Inhibit read-only for BODY."
20142 "Make sure current buffer is in org-mode. Error if not."
20145 major-mode)))
20148 "Fit the window to the buffer size."
20152 nil
20156 ;;; Agenda file list
20159 "Get the list of agenda files.
20160 Optional UNRESTRICTED means return the full list even if a restriction
20161 is currently in place."
20172 org-agenda-file-regexp)
20174 files)))
20180 files))
20184 "Edit the list of agenda files.
20185 Depending on setup, this either uses customize to edit the variable
20186 `org-agenda-files', or it visits the file that is holding the list. In the
20187 latter case, the buffer is set up in a way that saving it automatically kills
20188 the buffer and restores the previous window configuration."
20207 "Set new value for the agenda file list and save it correcly."
20218 "Read the list of agenda files from a file."
20225 ;;;###autoload
20227 "Cycle through the files in `org-agenda-files'.
20228 If the current buffer visits an agenda file, find the next one in the list.
20229 If the current buffer does not, find the first agenda file."
20234 file)
20246 "Move/add the current file to the top of the agenda file list.
20247 If the file is not present in the list, it is added to the front. If it is
20248 present, it is moved there. With optional argument TO-END, add/move to the
20249 end of the list."
20256 x had)
20269 "Remove current file from the list of files in variable `org-agenda-files'.
20270 These are the files which are being checked for agenda entries.
20271 Optional argument FILE means, use this file instead of the current."
20281 nil x))
20294 "Make sure FILE exists. If not, ask user what to do."
20305 ;;; Agenda prepare and finalize
20350 "Finishing touch for the agenda buffer, called just before displaying it."
20362 org-overriding-columns-format)
20364 org-overriding-columns-format))
20366 org-agenda-view-columns-initially)
20372 )))
20375 "Make highest priority lines bold, and lowest italic."
20382 b e p ov h l)
20386 org-highest-priority)
20388 org-lowest-priority)
20393 ov 'face
20401 "Create buffers for all agenda files, protect archived trees and comments."
20408 bmp file re)
20438 "Function to be called at each match during agenda construction.
20439 If this function returns nil, the current match should not be skipped.
20440 Otherwise, the function must return a position from where the search
20441 should be continued.
20442 This may also be a Lisp form, it will be evaluated.
20443 Never set this variable using `setq' or so, because then it will apply
20444 to all future agenda commands. Instead, bind it with `let' to scope
20445 it dynamically into the agenda-constructing command. A good way to set
20449 "Throw to `:skip' in places that should be skipped.
20450 Also moves point to the end of the skipped region, so that search can
20451 continue from there."
20477 "Return a new agenda marker.
20478 Org-mode keeps a list of these markers and resets them when they are
20479 no longer in use."
20483 m))
20486 "Reset markers created by `org-agenda'."
20491 "Get a buffer visiting FILE. If the buffer needs to be created, add
20492 it to the list of buffers which might be released later."
20495 buf ; just return it
20496 ;; Make a new buffer and remember it
20499 buf)))
20502 "Release all buffers in list, asking the user for confirmation when needed.
20503 When a buffer is unmodified, it is just killed. When modified, it is saved
20504 \(if the user agrees) and then killed."
20509 file
20515 "Get the category applying to position POS."
20518 ;;; Agenda timeline
20523 "Show a time-sorted view of the entries in the current org file.
20524 Only entries with a time stamp of today or later will be listed. With
20526 under the current date.
20527 If the buffer contains an active region, only check the region for
20528 dates."
20541 t doclosed ; always include today
20542 org-timeline-show-empty-dates))
20547 args
20548 s e rtn d emptyp)
20554 ;; Remove past dates from the list of dates.
20557 day-numbers))))
20574 dopast
20575 past)
20583 date args)))
20606 "Return a list of all relevant day numbers from BEG to END buffer positions.
20607 If NO-RANGES is non-nil, include only the start and end dates of a range,
20608 not every single day in the range. If FORCE-TODAY is non-nil, make
20609 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20610 inactive time stamps (those in square brackets) are included.
20611 When EMPTY is non-nil, also include days without any entries."
20615 dates dates1 date day day1 day2 ts1 ts2)
20645 dates)))
20647 ;;; Agenda Daily/Weekly
20658 ;;;###autoload
20660 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20661 The view will be for the current day or week, but from the overview buffer
20662 you will be able to go to other days/weeks.
20665 all unfinished TODO items will also be shown, before the agenda.
20666 This feature is considered obsolete, please use the TODO list or a block
20667 agenda instead.
20669 With a numeric prefix argument in an interactive call, the agenda will
20670 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20671 the number of days. NDAYS defaults to `org-agenda-ndays'.
20673 START-DAY defaults to TODAY, or to the most recent match for the weekday
20674 given in `org-agenda-start-on-weekday'."
20685 ;; Convert to an absolute day number
20693 org-agenda-start-on-weekday nil))
20702 sd
20711 s e rtn rtnall file date d start-pos end-pos todayp nd)
20714 ;; Make the list of days
20716 nd ndays)
20729 rtnall nil)
20757 rtnall nil)
20763 file date
20766 file date
20790 rtnall nd todayp))
20813 ;;; Agenda TODO list
20818 ;;;###autoload
20820 "Show all TODO entries from all agenda file in a single list.
20821 The prefix arg can be used to select a specific TODO keyword and limit
20823 for a keyword. A numeric prefix directly selects the Nth keyword in
20824 `org-todo-keywords-1'."
20838 rtn rtnall files file pos)
20848 rtnall nil)
20872 kwds))
20883 ;;; Agenda tags match
20885 ;;;###autoload
20887 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20888 The prefix arg TODO-ONLY limits the search to TODO entries."
20895 rtn rtnall files file pos matcher
20896 buffer)
20904 rtnall nil)
20912 ;; If file does not exist, merror message to agenda
20923 org-agenda-restrict-end)
20948 ;;; Agenda Finding stuck projects
20951 "Regular expression used in skipping subtrees for the agenda.
20952 This is basically a temporary global variable that can be set and then
20959 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20960 If yes, it returns the end position of this tree, causing agenda commands
20961 to skip this subtree. This is a function that can be put into
20962 `org-agenda-skip-function' for the duration of a command."
20964 skip)
20970 "Skip entry if any of CONDITIONS is true.
20971 See `org-agenda-skip-if' for details."
20975 "Skip entry if any of CONDITIONS is true.
20976 See `org-agenda-skip-if' for details."
20980 "Checks current entity for CONDITIONS.
20981 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20982 the entry, i.e. the text before the next heading is checked.
20984 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20985 from different tests. Valid conditions are:
20987 scheduled Check if there is a scheduled cookie
20988 notscheduled Check if there is no scheduled cookie
20989 deadline Check if there is a deadline
20990 notdeadline Check if there is no deadline
20991 regexp Check if regexp matches
20992 notregexp Check if regexp does not match.
20994 The regexp is taken from the conditions list, it must come right after
20995 the `regexp' or `notregexp' element.
20997 If any of these conditions is met, this function returns the end point of
20998 the entity, causing the search to continue from there. This is a function
20999 that can be put into `org-agenda-skip-function' for the duration of a command."
21023 end)))
21025 ;;;###autoload
21027 "Create agenda view for projects that are stuck.
21028 Stuck projects are project that have no next actions. For the definitions
21029 of what a project is and how to check if it stuck, customize the variable
21030 `org-stuck-projects'.
21031 MATCH is being ignored."
21034 ;; FIXME: we could have used org-agenda-skip-if here.
21042 org-done-keywords-for-agenda
21044 todo))
21061 gen-re)))))
21072 ;;; Diary integration
21077 "Get the (Emacs Calendar) diary entries for DATE."
21085 entries
21097 ;; No entries
21099 ;; Omit the date and other unnecessary stuff
21101 ;; Add prefix to each line and extend the text properties
21113 ;; Extend the text properties to the beginning of the line
21116 entries)))))
21119 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21120 This gets rid of the date, the underline under the date, and
21121 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21122 date. It also removes lines that contain only whitespace."
21139 ;; Make sure entries from the diary have the right text properties.
21142 ;; We can rely on the hook, nothing to do
21143 nil
21144 ;; Hook not avaiable, must use advice to make this work
21146 "Make the position visible."
21149 buffer-file-name)
21153 "Add text properties to string, allowing org-mode to act on it."
21156 'keymap org-agenda-keymap
21161 'org-agenda-diary-link t
21165 "Add a dummy entry to the diary.
21166 Needed to avoid empty dates which mess up holiday display."
21167 ;; Catch the error if dealing with the new add-to-diary-alist
21174 ;;;###autoload
21176 "Return diary information from org-files.
21178 It accesses org files and extracts information from those files to be
21179 listed in the diary. The function accepts arguments specifying what
21180 items should be listed. The following arguments are allowed:
21182 :timestamp List the headlines of items containing a date stamp or
21183 date range matching the selected date. Deadlines will
21184 also be listed, on the expiration day.
21186 :sexp List entries resulting from diary-like sexps.
21188 :deadline List any deadlines past due, or due within
21189 `org-deadline-warning-days'. The listing occurs only
21190 in the diary for *today*, not at any other date. If
21191 an entry is marked DONE, it is no longer listed.
21193 :scheduled List all items which are scheduled for the given date.
21194 The diary for *today* also contains items which were
21195 scheduled earlier and are not yet marked DONE.
21197 :todo List all TODO items from the org-file. This may be a
21198 long list - so this is not turned on by default.
21199 Like deadlines, these entries only show up in the
21200 diary for *today*, not at any other date.
21202 The call in the diary file should look like this:
21204 &%%(org-diary) ~/path/to/some/orgfile.org
21206 Use a separate line for each org file to check. Or, if you omit the file name,
21207 all files listed in `org-agenda-files' will be checked automatically:
21209 &%%(org-diary)
21211 If you don't give any arguments (as in the example above), the default
21212 arguments (:deadline :scheduled :timestamp :sexp) are used.
21213 So the example above may also be written as
21215 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21217 The function expects the lisp variables `entry' and `date' to be provided
21218 by the caller, because this is how the calendar works. Don't use this
21219 function from a program - use `org-agenda-get-day-entries' instead."
21221 org-agenda-last-marker-time)
21230 file rtn results)
21232 ;; If this is called during org-agenda, don't return any entries to
21233 ;; the calendar. Org Agenda will list these entries itself.
21241 ;;; Agenda entry finders
21244 "Does the work for `org-diary' and `org-agenda'.
21245 FILE is the path to a file to be checked for entries. DATE is date like
21246 the one returned by `calendar-current-date'. ARGS are symbols indicating
21247 which kind of entries should be extracted. For details about these, see
21248 the documentation of `org-diary'."
21255 arg results rtn)
21257 ;; If file does not exist, make sure an error message ends up in diary
21267 org-agenda-restrict-end)
21269 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21293 results))))
21309 "Is the cursor inside a date range?"
21324 nil)))
21327 "Return the TODO information for agenda display."
21330 'org-not-done-regexp org-not-done-regexp
21331 'org-todo-regexp org-todo-regexp
21333 'keymap org-agenda-keymap
21334 'help-echo
21337 ;; FIXME: get rid of the \n at some point but watch out
21341 org-todo-regexp
21345 org-not-done-regexp)
21347 marker priority category tags
21348 ee txt beg end)
21387 "Return the date stamp information for agenda display."
21389 'org-not-done-regexp org-not-done-regexp
21390 'org-todo-regexp org-todo-regexp
21392 'keymap org-agenda-keymap
21393 'help-echo
21401 "<%Y-%m-%d"
21415 marker hdmarker deadlinep scheduledp donep tmp priority category
21416 ee txt timestr tags b0 b3 e3 head)
21434 b0)
21441 ;; substring should only run to end of time stamp
21453 nil head category tags timestr nil
21454 remove-re)))
21467 "Return the sexp information for agenda display."
21471 'keymap org-agenda-keymap
21472 'help-echo
21476 marker category ee txt tags entry result beg b sexp sexp-entry)
21508 "Return the logged TODO entries for agenda display."
21510 'org-not-done-regexp org-not-done-regexp
21511 'org-todo-regexp org-todo-regexp
21512 'keymap org-agenda-keymap
21513 'help-echo
21525 marker hdmarker priority category tags closedp
21526 ee txt timestr)
21535 ;; donep (org-entry-is-done-p)
21536 )
21538 ;; substring should only run to end of time stamp
21562 "Return the deadline information for agenda display."
21564 'org-not-done-regexp org-not-done-regexp
21565 'org-todo-regexp org-todo-regexp
21566 'keymap org-agenda-keymap
21567 'help-echo
21573 d2 diff dfrac wdays pos pos1 category tags
21574 ee txt head face s upcomingp donep timestr)
21586 ;; When to show a deadline in the calendar:
21587 ;; If the expiration is within wdays warning time.
21588 ;; Past-due deadlines are only shown on the current date
21616 diff))
21617 head category tags timestr))))
21626 'org-category category
21635 "Return the face to displaying a deadline item.
21636 FRACTION is what fraction of the head-warning time has passed."
21643 "Return the scheduled information for agenda display."
21645 'org-todo-regexp org-todo-regexp
21648 'keymap org-agenda-keymap
21649 'help-echo
21655 d2 diff pos pos1 category tags
21656 ee txt head pastschedp donep face timestr s)
21664 ;;; is this right?
21665 ;;; do we need to do this for deadleine too????
21666 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21669 ;; When to show a scheduled item in the calendar:
21670 ;; If it is on or past the date.
21698 head category tags timestr))))
21702 'org-scheduled-previously
21705 'undone-face face
21717 "Return the date-range information for agenda display."
21719 'org-not-done-regexp org-not-done-regexp
21720 'org-todo-regexp org-todo-regexp
21722 'keymap org-agenda-keymap
21723 'help-echo
21728 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21729 donep head)
21741 ;; Only allow days between the limits, because the normal
21742 ;; date stamps will catch the limits.
21759 head category tags
21768 ;; Sort the entries by expiration date.
21771 ;;; Agenda presentation and sorting
21781 "Regular expression to match a plain time or time range.
21782 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21783 groups carry important information:
21784 0 the full match
21785 1 the first time, range or not
21793 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21794 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21795 groups carry important information:
21796 0 the full match
21797 7 hours of duration
21806 "Regular expression to match a timestamp time or time range.
21807 After a match, the following groups carry important information:
21808 0 the full match
21809 1 date plus weekday, for backreferencing to make sure both times on same day
21810 2 the first time, range or not
21814 "A flag, set by `org-compile-prefix-format'.
21817 "A flag, set by `org-compile-prefix-format'.
21821 noprefix remove-re)
21822 "Format TXT to be inserted into the agenda buffer.
21823 In particular, it adds the prefix and corresponding text properties. EXTRA
21824 must be a string and replaces the `%s' specifier in the prefix format.
21825 CATEGORY (string, symbol or nil) may be used to overrule the default
21826 category taken from local variable or file name. It will replace the `%c'
21827 specifier in the format. DOTIME, when non-nil, indicates that a
21828 time-of-day should be extracted from TXT for sorting of this entry, and for
21829 the `%t' specifier in the format. When DOTIME is a string, this string is
21830 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21831 only the correctly processes TXT should be returned - this is used by
21832 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21833 Any match of REMOVE-RE will be removed from TXT."
21835 ;; Diary entries sometimes have extra whitespace at the beginning
21838 org-category
21844 time ; time and tag are needed for the eval of the prefix format
21847 stamp plain s0 s1 s2 rtn srp)
21849 ;; Extract starting and ending time and move them to prefix
21857 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21858 ;; them, we might want to remove them there to avoid duplication.
21859 ;; The user can turn this off with a variable.
21865 t))
21867 ;; Normalize the time(s) to 24 hour
21875 org-agenda-default-appointment-duration))
21876 h)
21881 txt)
21882 ;; Tags are in the string
21885 org-prefix-has-tag))
21890 t t txt))))
21896 ;; Create the final string
21899 ;; Prepare the variables needed in the eval of the compiled format
21905 ;; Evaluate the compiled format
21908 ;; And finally add the text properties
21911 'org-highest-priority org-highest-priority
21912 'org-lowest-priority org-lowest-priority
21914 'time-of-day time-of-day
21915 'txt txt
21916 'time time
21917 'extra extra
21932 list)))
21937 new time)
21939 ;; don't show empty grid
21945 nil string "" nil
21947 new)
21955 "Compile the prefix format into a Lisp form that can be evaluated.
21956 The resulting form is returned and stored in the variable
21957 `org-prefix-format-compiled'."
21961 org-agenda-prefix-format)
21966 varform vars var e c f opt)
21968 s start)
21981 ""
21991 ;; the old format
21999 "Check string S for a time of day.
22000 If found, return it as a military time number between 0 and 2400.
22001 If not found, return nil.
22002 The optional STRING argument forces conversion into a 5 character wide string
22003 HH:MM."
22025 "Sort and concatenate the agenda items."
22028 list
22053 x)
22057 " "
22059 x)))
22062 "Compare the priorities of string A and B."
22070 "Compare the string values of categories of strings A and B."
22078 "Compare the string values of categories of strings A and B."
22088 "Compare the time-of-day values of strings A and B."
22097 "Predicate for sorting agenda entries."
22098 ;; The following variables will be used when the form is evaluated.
22099 ;; So even though the compiler complains, keep them.
22113 ;;; Agenda restriction lock
22131 "Set restriction lock for agenda, to current subtree or file.
22132 Restriction will be the file if TYPE is `file', or if type is the
22133 universal prefix '(4), or if the cursor is before the first headline
22134 in the file. Otherwise, restriction will be to the current subtree."
22166 "Remove the agenda restriction lock."
22180 "If there is any window showing the agenda view, update it."
22189 org-agenda-overriding-restriction)
22192 ;;; Agenda commands
22195 "Check if agenda buffer is of allowed type.
22196 If ERROR is non-nil, throw an error, otherwise just return nil."
22198 t
22201 nil)))
22204 "Exit agenda by removing the window or the buffer."
22211 ;; Maybe restore the pre-agenda window configuration.
22214 org-pre-agenda-window-conf
22218 "Exit agenda by removing the window or the buffer.
22219 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22220 Org-mode buffers visited directly by the user will not be touched."
22234 "Save all Org-mode buffers without user confirmation."
22241 "Rebuild Agenda.
22242 When this is the global TODO list, a prefix argument will be interpreted."
22251 org-agenda-pending-undo-list nil)
22257 "Jump to DATE in agenda."
22262 "Go to today."
22288 "Go forward in time by thee current span.
22289 With prefix ARG, go forward that many times the current span."
22296 greg2 nd)
22318 "Go backward in time by the current span.
22319 With prefix ARG, go backward that many times the current span."
22324 "Switch to daily view for agenda."
22329 "Switch to daily view for agenda."
22334 "Switch to daily view for agenda."
22338 "Switch to daily view for agenda."
22345 "Change the agenda view to SPAN.
22346 SPAN may be `day', `week', `month', `year'."
22351 org-starting-day))
22362 "Compute starting date and number of days for agenda.
22363 SPAN may be `day', `week', `month', `year'. The return value
22364 is a cons cell with the starting date and the number of days,
22365 so that the date SD will be in that range."
22367 nd)
22384 sd)))
22390 sd))))
22393 ;; FIXME: does not work if user makes date format that starts with a blank
22395 "Jump to the next line indicating a date in agenda buffer."
22407 "Jump to the previous line indicating a date in agenda buffer."
22414 ;; Initialize the highlight
22419 "Highlight a region with overlay."
22424 "Detach overlay INDEX."
22427 ;; FIXME this is currently not used.
22436 "Toggle follow mode in an agenda buffer."
22444 "Toggle log mode in an agenda buffer."
22454 "Toggle diary inclusion in an agenda buffer."
22464 "Toggle time grid in an agenda buffer."
22474 "Set the mode name to indicate all the small mode settings."
22493 "Show the priority of the current item.
22494 This priority is composed of the main priority given with the [#A] cookies,
22495 and by additional input from the age of a schedules or deadline entry."
22501 "Show the tags applicable to the current item."
22510 "Go to the Org-mode file which contains the item at point."
22529 "Normal hook run after an item has been shown from the agenda.
22533 "Kill the entry or subtree belonging to the current agenda entry."
22566 "Kill the entry or subtree belonging to the current agenda entry."
22584 "Remove all lines in the agenda that correspond to a given subtree.
22585 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22586 If this information is not given, the function uses the tree at point."
22609 "Follow the link in the current line, if any."
22618 "Get a variable from a referenced buffer and install it here."
22625 "Go to the Org-mode file which contains the item at point."
22642 "Go to the Org-mode file which contains the item at the mouse click."
22648 "Display the Org-mode file which contains the item at point."
22655 "Display the Org-mode file which contains the item at point and recenter."
22663 "Display the Org-mode file which contains the item at the mouse click."
22669 "Check if the entry is a diary link and abort if yes."
22677 "Show the subtree corresponding to the current entry in an indirect buffer.
22678 This calls the command `org-tree-to-indirect-buffer' from the original
22679 Org-mode buffer.
22680 With numerical prefix arg ARG, go up to this level and then take that tree.
22681 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22682 dedicated frame)."
22695 "Marker pointing to the headline that last changed its TODO state
22699 "Switch TODO entry to next sequence."
22704 "Switch TODO entry to previous sequence."
22709 "Cycle TODO state of line at point, also in Org-mode file.
22710 This changes the line at point, all other lines in the agenda referring to
22711 the same tree node, and the headline of the tree node in the Org-mode file."
22721 newhead)
22742 "Change all lines in the agenda buffer which match HDMARKER.
22743 The new content of the line will be NEWHEAD (as modified by
22744 `org-format-agenda-item'). HDMARKER is checked with
22745 `equal' against all `org-hd-marker' text properties in the file.
22746 If FIXFACE is non-nil, the face of each item is modified acording to
22747 the new TODO state."
22749 props m pl undone-face done-face finish new dotime cat tags)
22779 undone-face done-face))))
22787 "Align all tags in agenda items to `org-agenda-tags-column'."
22800 org-agenda-tags-column))
22808 "Increase the priority of line at point, also in Org-mode file."
22813 "Decrease the priority of line at point, also in Org-mode file."
22818 "Set the priority of line at point, also in Org-mode file.
22819 This changes the line at point, all other lines in the agenda referring to
22820 the same tree node, and the headline of the tree node in the Org-mode file."
22829 newhead)
22845 "Get a list of all headline tags applicable at POS.
22846 POS defaults to point. If tags are inherited, the list contains
22847 the targets in the same sequence as the headlines appear, i.e.
22848 the tags of the current headline come last."
22863 tags)))
22867 tags)))
22869 ;; FIXME: should fix the tags property of the agenda line.
22871 "Set tags for the current headline."
22882 newhead)
22900 "Toggle the archive tag for the current entry."
22909 newhead)
22925 "Change the date of this item to one day later."
22944 "Change the date of this item to one day earlier."
22949 "Show new date stamp via text properties."
22950 ;; We use text properties to make this undoable
22959 ;; Use `duplicable' property to trigger undo recording
22974 "Change the date of this item. Date is prompted for, with default today.
22975 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22976 be used to request time specification in the time stamp."
22994 "Schedule the item at point."
23003 ts)
23015 "Schedule the item at point."
23024 ts)
23034 "Return the heading of the current entry, without the stars."
23044 "Start the clock on the currently selected item."
23057 "Stop the currently running clock."
23065 "Cancel the currently running clock."
23073 "Make a diary entry, like the `i' command from the calendar.
23074 All the standard commands work: block, weekly etc."
23090 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23099 ;; We implement this by hacking the `calendar-cursor-to-date' function
23100 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23116 "Execute a calendar command from the agenda, with the date associated to
23117 the cursor position."
23126 ;; the following 3 vars are needed in the calendar
23140 "Display the phases of the moon for the 3 months around the cursor date."
23145 "Display the holidays for the 3 months around the cursor date."
23150 "Display sunrise and sunset for the cursor date.
23151 Latitude and longitude can be specified with the variables
23152 `calendar-latitude' and `calendar-longitude'. When called with prefix
23153 argument, latitude and longitude will be prompted for."
23162 "Open the Emacs calendar with the date at the cursor."
23175 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23176 This is a command that has to be installed in `calendar-mode-map'."
23180 nil))
23186 date s)
23212 ;;;; Embedded LaTeX
23227 "Toggle the minor `org-cdlatex-mode'.
23228 This mode supports entering LaTeX environment and math in LaTeX fragments
23229 in Org-mode.
23231 nil " OCDL" nil
23236 "Always return t in org-mode buffers.
23237 This is because we want to insert math symbols without dollars even outside
23238 the LaTeX math segments. If Orgmode thinks that point is actually inside
23239 en embedded LaTeX fragement, let texmathp do its job.
23256 "Unconditionally turn on `org-cdlatex-mode'."
23260 "Test if point is inside a LaTeX fragment.
23262 sequence appearing also before point.
23263 Even though the matchers for math are configurable, this function assumes
23265 delimiters are skipped when they have been removed by customization.
23266 The return value is nil, or a cons cell with the delimiter and
23267 and the position of this delimiter.
23269 This function does a reasonably good job, but can locally be fooled by
23270 for example currency specifications. For example it will assume being in
23272 fragments that are properly closed, but during editing, we have to live
23273 with the uncertainty caused by missing closing delimiters. This function
23274 looks only before point, not after."
23293 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23297 ;; count $$
23305 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23306 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23307 - inside a LaTeX fragment, or
23308 - after the first word in a line, where an abbreviation expansion could
23309 insert a LaTeX environment."
23322 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23323 Revert to the normal definition outside of these fragments."
23331 "Execute `cdlatex-math-modify' in LaTeX fragments.
23332 Revert to the normal definition outside of these fragments."
23344 "Remove all overlays with LaTeX fragment images in current buffer."
23349 "Preview the LaTeX fragment at point, or all locally or globally.
23350 If the cursor is in a LaTeX fragment, create the image and overlay
23351 it over the source code. If there is no fragment at point, display
23352 all fragments in the current text, from one headline to the next. With
23353 prefix SUBTREE, display all fragments in the current subtree. With a
23354 double prefix `C-u C-u', or when the cursor is before the first headline,
23355 display all fragments in the buffer.
23385 buffer-file-name)))
23391 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23392 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23393 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23400 "Replace LaTeX fragments with links to an image, and produce images."
23409 m n block linkfile movefile ov)
23410 ;; Check if there are old images files with this prefix, and remove them
23414 todir 'full
23416 ;; Check the different regular expressions
23436 txt movefile opt forbuffer)
23444 ov 'end-glyph
23447 ov 'display
23454 ;; This function borrows from Ganesh Swami's latex2png.el
23458 temporary-file-directory))
23487 "-D" dpi
23488 ;;"-x" scale "-y" scale
23490 "-o" pngfile
23491 dvifile)
23494 ;; Use the requested file name and clean up
23498 pngfile))))
23501 "Return an rgb color specification for dvipng."
23507 "Return string to be used as color value for an RGB component."
23510 ;;;; Exporting
23512 ;;; Variables, constants, and parameter plists
23568 "Return the property list with default settings for the export variables."
23572 rtn))
23575 "Return the property list with file-local settings for export."
23582 p key val text options)
23615 o)
23619 options)
23623 p))))
23629 val)))
23630 dir))
23637 rtn line level)
23642 ;; Beginning of a COMMENT subtree. Skip it.
23648 ;; an ordinary comment line
23649 )
23655 ;; a special table line that should be removed
23656 )
23663 \[v] limit export to visible part of outline tree
23665 \[a] export as ASCII
23667 \[h] export as HTML
23668 \[H] export as HTML to temporary buffer
23669 \[R] export region as HTML
23670 \[b] export as HTML and browse immediately
23671 \[x] export as XOXO
23673 \[l] export as LaTeX
23674 \[L] export as LaTeX to temporary buffer
23676 \[i] export current file as iCalendar file
23677 \[I] export all agenda files as iCalendar files
23678 \[c] export agenda files into combined iCalendar file
23680 \[F] publish current file
23681 \[P] publish current project
23682 \[X] publish... (project will be prompted for)
23702 r1 r2 ass)
24005 )
24006 "Entities for TeX->HTML translation.
24010 The list contains HTML entities for Latin-1, Greek and other symbols.
24011 It is supplemented by a number of commonly used TeX macros with appropriate
24014 ;;; General functions for all backends
24017 "Cleanup a buffer STRING so that links can be created safely."
24035 a b xx
24036 rtn p)
24040 ;; Remove license-to-kill stuff
24048 ;; Get rid of drawers
24053 'identity
24061 ;; Get the correct stuff before the first headline
24072 ;; Get rid of archived trees
24084 ;; Find targets in comments and move them out of comments,
24085 ;; but mark them as targets that should be invisible
24090 ;; Protect backend specific stuff, throw away the others.
24095 fmt)
24126 ;; Protect quoted subtrees
24134 ;; Protect verbatim elements
24141 ;; Remove subtrees that are commented
24147 ;; Remove special table lines
24159 ;; Specific LaTeX stuff
24167 ;; Specific HTML stuff
24169 ;; Convert LaTeX fragments to images
24174 org-current-export-file)))
24178 ;; Remove or replace comments
24187 ;; Find matches for radio targets and turn them into internal links
24194 ;; Find all links that contain a newline and put them into a single line
24196 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24202 ;; Normalize links: Convert angle and plain links into bracket links
24203 ;; Expand link abbreviations
24210 ;; added 'org-link face to links
24226 "]"
24234 ;; Find multiline emphasis and put them into single line
24248 rtn))
24251 "Get a title for the current document, from looking at the buffer."
24257 ;; Mark the line so that it will not be exported as normal text.
24261 ;; Return the title string
24265 "Return subtree title and exclude it from export."
24271 ;; This is a subtree, we take the title from the first heading
24278 title))
24281 "Take link text and make a safe target out of it."
24285 'identity
24291 "Get the minimum level in LINES."
24299 ;; Variable holding the vector with section numbers
24303 "Initialize the vector for the section numbers."
24320 "Return a string with the current section number.
24321 When LEVEL is non-nil, increase section numbers on that level."
24343 string))
24345 ;;; ASCII export
24353 "Export the outline as a pretty ASCII file.
24354 If there is an active region, export only the region.
24355 The prefix ARG specifies how many levels of the outline should become
24356 underlined headlines. The default is 3."
24385 filename))
24401 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24410 region
24411 :for-ascii t
24412 :skip-before-1st-heading
24415 :verbatim-multiline t
24416 :archived-trees
24420 thetoc have-headings first-heading-pos
24421 table-open table-buffer)
24439 ;; create local variables for all options, to make sure all called
24440 ;; functions get the correct information
24444 org-export-plist-vars)
24447 org-export-headline-levels))
24450 umax))
24452 ;; File header
24456 org-export-author-info)
24478 line)
24479 ;; This is a headline
24485 todo
24489 org-done-keywords)))
24490 ; TODO, not DONE
24494 line lines level))))
24501 t t txt)))
24506 txt))
24521 thetoc)
24523 ))))
24524 lines)
24529 ;; Remove the quoted HTML tags.
24531 ;; Remove targets
24534 ;; Replace internal links
24538 t nil line)))
24543 ;; a Headline
24552 ;; New table starts
24554 ;; Accumulate lines
24575 ;; insert the table of contents
24587 ;; Convert whitespace place holders
24597 ;; remove display and invisible chars
24613 "Do extra work for ASCII export"
24623 "Search the subtree below LINE for any TODO entries."
24626 line lv todo)
24634 org-done-keywords))))
24635 ; TODO, not DONE
24640 "Handle quoted HTML for ASCII export."
24643 ;; We just remove the tags for now.
24645 line)
24648 "Insert the string S centered and underline it with character UNDERLINE."
24657 "Insert a new level in ASCII export."
24663 org-export-ascii-bullets))
24665 ;; find the indentation of the next non-empty line
24686 "Create a copy of the visible part of the current buffer, and export it.
24687 The copy is created in a temporary buffer and removed after use.
24688 TYPE is the final key (as a string) that also select the export command in
24689 the `C-c C-e' export dispatcher.
24690 As a special case, if the you type SPC at the prompt, the temporary
24691 org-mode file will not be removed but presented to you so that you can
24692 continue to use it. The prefix arg ARG is passed through to the exporting
24693 command."
24696 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24698 current-prefix-arg))
24713 s e)
24714 ;; Need to hack the drawers here.
24730 ;; Copy all comment lines to the end, to make sure #+ settings are
24731 ;; still available for the second export step. Kind of a hack, but
24732 ;; does do the trick.
24753 s))
24758 s))
24760 ;;; HTML export
24763 "Return a string with current options as keyword options.
24764 Does include HTML export options as well as TODO and CATEGORY stuff."
24766 "#+TITLE: %s
24767 #+AUTHOR: %s
24768 #+EMAIL: %s
24769 #+LANGUAGE: %s
24770 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24771 #+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
24772 #+CATEGORY: %s
24773 #+SEQ_TODO: %s
24774 #+TYP_TODO: %s
24775 #+PRIORITIES: %c %c %c
24776 #+DRAWERS: %s
24777 #+STARTUP: %s %s %s %s %s
24778 #+TAGS: %s
24779 #+ARCHIVE: %s
24780 #+LINK: %s
24781 "
24783 org-export-headline-levels
24784 org-export-with-section-numbers
24785 org-export-with-toc
24786 org-export-preserve-breaks
24787 org-export-html-expand
24788 org-export-with-fixed-width
24789 org-export-with-tables
24790 org-export-with-sub-superscripts
24791 org-export-with-special-strings
24792 org-export-with-footnotes
24793 org-export-with-emphasize
24794 org-export-with-TeX-macros
24795 org-export-with-LaTeX-fragments
24796 org-export-skip-text-before-1st-heading
24797 org-export-with-drawers
24798 org-export-with-tags
24800 "TODO FEEDBACK VERIFY DONE"
24801 "Me Jason Marie DONE"
24802 org-highest-priority org-lowest-priority org-default-priority
24819 org-archive-location
24820 "org file:~/org/%s.org"
24821 ))
24824 "Insert into the buffer a template with information for exporting."
24833 "Toggle the fixed-width export.
24834 If there is no active region, the QUOTE keyword at the current headline is
24835 inserted or removed. When present, it causes the text between this headline
24836 and the next to be exported as fixed-width text, and unmodified.
24837 If there is an active region, this command adds or removes a colon as the
24838 first character of this line. If the first character of a line is a colon,
24839 this line is also exported in fixed-width font."
24848 off)
24878 "Export the outline as HTML and immediately open it with a browser.
24879 If there is an active region, export only the region.
24880 The prefix ARG specifies how many levels of the outline should become
24881 headlines. The default is 3. Lower levels will become bulleted lists."
24887 "Call `org-export-as-html', may be used in batch processing as
24888 emacs --batch
24889 --load=$HOME/lib/emacs/org.el
24891 --visit=MyFile --funcall org-export-as-html-batch"
24895 "Call `org-exort-as-html` with output to a temporary buffer.
24896 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24902 "Assume the current region has org-mode syntax, and convert it to HTML.
24903 This can be used in any buffer. For example, you could write an
24904 itemized list in org-mode syntax in an HTML buffer and then use this
24905 command to convert it."
24925 "Convert region from BEG to END in org-mode buffer to HTML.
24926 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24927 contents, and only produce the region of converted text, useful for
24928 cut-and-paste operations.
24929 If BUFFER is a buffer or a string, use/create that buffer as a target
24930 of the converted HTML. If BUFFER is the symbol `string', return the
24931 produced HTML as a string and leave not buffer behind. For example,
24932 a Lisp program could call this function in the following way:
24934 (setq html (org-export-region-as-html beg end t 'string))
24936 When called interactively, the output buffer is selected, and shown
24937 in a window. A non-interactive call will only retunr the buffer."
24942 rtn)
24947 nil nil nil
24948 buffer body-only))
24952 rtn)))
24956 to-buffer body-only)
24957 "Export the outline as a pretty HTML file.
24958 If there is an active region, export only the region. The prefix
24959 ARG specifies how many levels of the outline should become
24960 headlines. The default is 3. Lower levels will become bulleted
24961 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24962 EXT-PLIST is a property list with external parameters overriding
24963 org-mode's default settings, but still inferior to file-local
24964 settings. When TO-BUFFER is non-nil, create a buffer with that
24965 name and export to that buffer. If TO-BUFFER is the symbol `string',
24966 don't leave any buffer behind but just return the resulting HTML as
24967 a string. When BODY-ONLY is set, don't produce the file header and footer,
24968 simply return the content of <body>...</body>, without even
24969 the body tags themselves."
24972 ;; Make sure we have a file name when we need it.
24978 buffer-file-name))
24987 ext-plist
24993 valid thetoc have-headings first-heading-pos
25002 ;; The following two are dynamically scoped into other
25003 ;; routines below.
25022 default-directory))
25056 buffer-file-coding-system))
25058 coding-system))
25060 coding-system))
25072 region
25073 :emph-multiline t
25074 :for-html t
25075 :skip-before-1st-heading
25078 :archived-trees
25080 :add-text
25082 :LaTeX-fragments
25085 table-open type
25086 table-buffer table-orig-buffer
25087 ind start-is-num starter didclose
25088 rpl path desc descp desc1 desc2 link
25089 )
25108 ;; Get the language-dependent settings
25112 ;; Switch to the output buffer
25122 ;; create local variables for all options, to make sure all called
25123 ;; functions get the correct information
25127 org-export-plist-vars)
25129 org-export-headline-levels))
25132 umax))
25134 ;; File header
25140 <head>
25141 <title>%s</title>
25146 %s
25147 </head><body>
25148 "
25161 org-export-html-toplevel-hlevel
25163 org-export-html-toplevel-hlevel)
25164 thetoc)
25169 ;; This is a headline
25178 todo
25182 org-done-keywords)))
25183 ; TODO, not DONE
25187 line lines level))))
25212 ;; Check for targets
25217 t t line))
25220 target-alist))
25231 )))
25232 line)
25233 lines))
25245 ;; end of quote section?
25249 ;; inside a quote section?
25254 ;; verbatim lines
25268 ;; Protected HTML
25283 ;; Horizontal line
25288 ;; make targets to anchors
25296 t t line)))
25300 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25301 t t line)))
25307 t t line)))))
25311 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25312 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25313 ;; Also handle sub_superscripts and checkboxes
25317 ;; Format the links
25327 ;; Make an image out of the description if that is so wanted
25333 ;; FIXME: do we need to unescape here somewhere?
25343 ;; standard URL, just check if we need to inline an image
25351 ;; standard URL
25355 ;; FILE link
25358 thefile file-is-image-p search)
25366 t))
25375 ;; make sure this is can be used as target search
25400 ;; TODO items
25408 org-done-keywords)
25413 ;; Does this contain a reference to a footnote?
25425 t t line))))))
25429 ;; This is a headline
25437 ;; Close any local lists before inserting a new header line
25443 in-local-list nil))
25447 head-count)
25448 ;; QUOTES
25456 ;; New table starts
25458 ;; Accumulate lines
25470 ;; Normal lines
25473 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25474 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25477 line)
25484 ;; empty line. Pretend indentation is large.
25486 0
25502 ;; Start new (level of) list
25509 ;; continue current list
25513 ;; we did close a list, normal text follows: need <p>
25519 "<b>[X]</b>"
25521 t t line))))
25523 ;; Empty lines start a new paragraph. If hand-formatted lists
25524 ;; are not fully interpreted, lines starting with "-", "+", "*"
25525 ;; also start a new paragraph.
25528 ;; Is this the start of a footnote?
25534 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25536 ;; Check if the line break needs to be conserved
25545 ;; Properly close all local lists and other lists
25548 ;; Close any local lists before inserting a new header line
25554 in-local-list nil))
25557 head-count)
25588 ;; insert the table of contents
25605 ;; remove empty paragraphs and lists
25615 ;; Convert whitespace place holders
25636 "Format a table for ascii export."
25640 ;; Table made by table.el - test for spanning
25641 lines
25643 ;; A normal org table
25644 ;; Get rid of hlines at beginning and end
25650 ;; Check if the table has a marking column. If yes remove the
25651 ;; column and the special lines
25653 ;; Get rid of the vertical lines except for grouping
25655 rtn line vl1 start)
25677 vl))
25680 "Find out which HTML converter to use and return the HTML code."
25684 ;; A normal org table
25686 ;; Table made by table.el - test for spanning
25690 nil))
25691 lines)))
25697 hlines))))
25700 ;; We can use my own converter with HTML conversions
25702 ;; Need to use the code generator in table.el, with the original text.
25706 "Format a table into HTML."
25707 ;; Get rid of hlines at beginning and end
25713 ;; Check if the table has a marking column. If yes remove the
25714 ;; column and the special lines
25722 tbopen line fields html gr colgropen)
25734 ;; ignore this line
25736 ;; Break the line into fields
25754 html)))
25759 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25775 html)
25781 "Check if the table has a marking column.
25782 If yes remove the column and the special lines."
25788 lines))
25803 nil)
25805 lines)))
25819 nil)
25824 ;; remove the first column
25826 lines))))
25829 "Format a table generated by table.el into HTML.
25830 This conversion does *not* use `table-generate-source' from table.el.
25831 This has the advantage that Org-mode's HTML conversions can be used.
25832 But it has the disadvantage, that no cell- or row-spanning is allowed."
25835 fields html empty)
25845 html
25847 html
25848 "<tr>"
25861 ;; Ignore this line
25863 ;; Break the line into fields and store the fields
25869 field-buffer))
25872 html))
25875 "Format a table into html, using `table-generate-source' from table.el.
25876 This has the advantage that cell- or row-spanning is allowed.
25877 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25892 "Format time stamps in string S, or remove them."
25897 ;; never export CLOCK
25912 ;; Line break if line started and ended with time stamp stuff
25914 s
25918 r))))
25921 ;; convert & to &, < to < and > to >
25930 s)
25933 "Remove tags and time staps from lines going into the toc."
25942 t t s)))
25943 s)
25946 "Prepare STRING for HTML export. Applies all active conversions.
25947 If there are links in the string, don't modify these."
25950 m s l res)
25961 "Apply all active conversions to translate special ASCII to HTML."
25982 t t s))
25984 s)
25987 "Create a regular expression which will match a balanced sexp.
25988 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25989 as single character strings.
25990 The regexp returned will match the entire expression including the
25991 delimiters. It will also define a single group which contains the
25992 match except for the outermost delimiters. The maximum depth of
25993 stacked delimiters is N. Escaping delimiters is not possible."
26029 "Convert special characters in STRING to HTML."
26031 e a re rpl start)
26038 string))
26041 "Convert sub- and superscripts in STRING to HTML."
26057 t t string)))))
26060 string))
26063 "Apply emphasis."
26070 rpl
26076 org-emphasis-alist))
26081 string))
26085 "Insert <p>, but first close previous paragraph if any."
26090 "Close paragraph if there is one open."
26095 "Close <li> if necessary."
26101 "Insert a new level in HTML export.
26102 When TITLE is nil, just close all open levels."
26112 ;; If title is nil, this means this function is called to close
26113 ;; all levels, so the rest is done only if title is given
26125 t t title)))
26141 level level head-count title level))
26146 "Terminate one level in HTML export."
26152 ;;; iCalendar export
26154 ;;;###autoload
26156 "Export current file as an iCalendar file.
26157 The iCalendar file will be located in the same directory as the Org-mode
26158 file, but with extension `.ics'."
26162 ;;;###autoload
26164 "Export all files in `org-agenda-files' to iCalendar .ics files.
26165 Each iCalendar file will be located in the same directory as the Org-mode
26166 file, but with extension `.ics'."
26170 ;;;###autoload
26172 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26173 The file is stored under the name `org-combined-agenda-icalendar-file'."
26178 "Create iCalendar files for all elements of FILES.
26179 If COMBINE is non-nil, combine all calendar entries into a single large
26180 file and store it under the name `org-combined-agenda-icalendar-file'."
26185 org-export-publishing-directory)))
26186 file ical-file ical-buffer category started org-agenda-new-buffers)
26192 org-combined-agenda-icalendar-file
26225 "Hook run after an iCalendar file has been saved.
26226 The iCalendar buffer is still current when this hook is run.
26227 A good way to use this is to tell a desktop calenndar application to re-read
26231 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26232 When COMBINE is non nil, add the category to each line."
26239 scheduledp deadlinep tmp pri category entry location summary desc
26249 inc t
26256 t org-icalendar-include-body)
26266 pos)
26271 ts)
26274 ;; donep (org-entry-is-done-p)
26275 ))
26294 t t summary)))
26301 %s
26302 %s%s
26303 SUMMARY:%s%s%s
26304 CATEGORIES:%s
26308 rrule summary
26313 category)))))
26318 ;; Get all the literal sexps
26344 )
26351 t org-icalendar-include-body)
26357 t t hd)))
26367 %s
26368 SUMMARY:%s%s%s
26369 CATEGORIES:%s
26370 SEQUENCE:1
26371 PRIORITY:%d
26372 STATUS:%s
26374 dts
26380 category pri status)))))))))
26383 "Take out stuff and quote what needs to be quoted.
26384 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26385 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26386 characters."
26388 nil
26407 s))
26410 "Clean-up description string."
26416 "Start an iCalendar file by inserting the header."
26422 VERSION:2.0
26423 X-WR-CALNAME:%s
26424 PRODID:-//%s//Emacs with Org-mode//EN
26425 X-WR-TIMEZONE:%s
26429 "Finish an iCalendar file by inserting the END statement."
26433 "Take a time string S and convert it to iCalendar format.
26434 KEYWORD is added in front, to make a complete line like DTSTART....
26435 When INC is non-nil, increase the hour by two (if time string contains
26436 a time), or the day by one (if it does not contain a time)."
26438 t2 fmt have-time time)
26454 ;;; XOXO export
26462 "Export the org buffer as XOXO.
26463 The XOXO buffer is named *xoxo-<source buffer name>*"
26465 ;; A quickie abstraction
26467 ;; Output everything as XOXO
26481 ;; Check the output buffer is empty.
26483 ;; Kick off the output
26500 ;; Handle level rendering
26517 )
26521 ;; And output the new li
26527 ;; Finally finish off the ol
26534 ;; Finish the buffer off and clean it up.
26539 )))
26542 ;;;; Key bindings
26544 ;; Make `C-c C-x' a prefix key
26547 ;; TAB key with modifiers
26554 ;; The following line is necessary under Suse GNU/Linux
26560 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26561 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26562 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26564 ;; Cursor keys with modifiers
26565 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26566 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26567 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26568 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26570 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26571 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26572 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26573 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26575 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26576 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26577 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26578 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26580 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26581 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26583 ;;; Extra keys for tty access.
26584 ;; We only set them when really needed because otherwise the
26585 ;; menus don't show the simple keys
26587 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26588 (not window-system))
26589 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26590 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26591 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26592 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26593 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26594 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26595 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26596 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26597 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26598 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26599 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26600 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26601 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26602 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26603 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26604 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26605 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26606 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26607 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26608 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26609 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26610 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26612 ;; All the other keys
26614 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26615 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26616 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26617 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26618 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26619 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26620 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26621 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26622 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26623 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26624 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26625 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26626 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26627 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26628 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26630 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26631 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26632 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26633 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26634 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26635 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26636 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26637 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26638 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26639 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26640 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26641 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26642 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26643 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26644 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26645 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26646 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26648 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26649 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26650 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26651 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26652 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26653 (org-defkey org-mode-map "\C-c^" 'org-sort)
26654 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26655 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26656 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26657 (org-defkey org-mode-map "\C-m" 'org-return)
26658 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26659 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26660 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26661 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26662 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26663 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26664 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26665 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26666 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26667 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26668 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26669 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26670 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26671 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26672 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26673 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26674 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26676 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26677 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26678 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26679 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26681 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26682 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26683 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26684 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26685 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26686 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26687 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26688 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26689 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26690 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26691 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26692 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26694 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26696 (when (featurep 'xemacs)
26697 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26699 (defsubst org-table-p () (org-at-table-p))
26701 (defun org-self-insert-command (N)
26702 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26703 If the cursor is in a table looking at whitespace, the whitespace is
26704 overwritten, and the table is not marked as requiring realignment."
26705 (interactive "p")
26706 (if (and (org-table-p)
26707 (progn
26708 ;; check if we blank the field, and if that triggers align
26709 (and org-table-auto-blank-field
26710 (member last-command
26711 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26713 ;; got extra space, this field does not determine column width
26714 (let (org-table-may-need-update) (org-table-blank-field))
26715 ;; no extra space, this field may determine column width
26716 (org-table-blank-field)))
26717 t)
26718 (eq N 1)
26720 (let (org-table-may-need-update)
26721 (goto-char (1- (match-end 0)))
26722 (delete-backward-char 1)
26723 (goto-char (match-beginning 0))
26724 (self-insert-command N))
26725 (setq org-table-may-need-update t)
26726 (self-insert-command N)
26727 (org-fix-tags-on-the-fly)))
26729 (defun org-fix-tags-on-the-fly ()
26730 (when (and (equal (char-after (point-at-bol)) ?*)
26731 (org-on-heading-p))
26732 (org-align-tags-here org-tags-column)))
26734 (defun org-delete-backward-char (N)
26735 "Like `delete-backward-char', insert whitespace at field end in tables.
26736 When deleting backwards, in tables this function will insert whitespace in
26738 still be marked for re-alignment if the field did fill the entire column,
26739 because, in this case the deletion might narrow the column."
26740 (interactive "p")
26741 (if (and (org-table-p)
26742 (eq N 1)
26743 (string-match "|" (buffer-substring (point-at-bol) (point)))
26744 (looking-at ".*?|"))
26745 (let ((pos (point))
26747 (c org-table-may-need-update))
26748 (backward-delete-char N)
26749 (skip-chars-forward "^|")
26750 (insert " ")
26751 (goto-char (1- pos))
26752 ;; noalign: if there were two spaces at the end, this field
26753 ;; does not determine the width of the column.
26754 (if noalign (setq org-table-may-need-update c)))
26755 (backward-delete-char N)
26756 (org-fix-tags-on-the-fly)))
26758 (defun org-delete-char (N)
26759 "Like `delete-char', but insert whitespace at field end in tables.
26760 When deleting characters, in tables this function will insert whitespace in
26762 still be marked for re-alignment if the field did fill the entire column,
26763 because, in this case the deletion might narrow the column."
26764 (interactive "p")
26765 (if (and (org-table-p)
26766 (not (bolp))
26767 (not (= (char-after) ?|))
26768 (eq N 1))
26769 (if (looking-at ".*?|")
26770 (let ((pos (point))
26772 (c org-table-may-need-update))
26773 (replace-match (concat
26774 (substring (match-string 0) 1 -1)
26775 " |"))
26776 (goto-char pos)
26777 ;; noalign: if there were two spaces at the end, this field
26778 ;; does not determine the width of the column.
26779 (if noalign (setq org-table-may-need-update c)))
26780 (delete-char N))
26781 (delete-char N)
26782 (org-fix-tags-on-the-fly)))
26784 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26785 (put 'org-self-insert-command 'delete-selection t)
26786 (put 'orgtbl-self-insert-command 'delete-selection t)
26787 (put 'org-delete-char 'delete-selection 'supersede)
26788 (put 'org-delete-backward-char 'delete-selection 'supersede)
26790 ;; Make `flyspell-mode' delay after some commands
26791 (put 'org-self-insert-command 'flyspell-delayed t)
26792 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26793 (put 'org-delete-char 'flyspell-delayed t)
26794 (put 'org-delete-backward-char 'flyspell-delayed t)
26796 ;; Make pabbrev-mode expand after org-mode commands
26797 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26798 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26800 ;; How to do this: Measure non-white length of current string
26801 ;; If equal to column width, we should realign.
26803 (defun org-remap (map &rest commands)
26804 "In MAP, remap the functions given in COMMANDS.
26805 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26806 (let (new old)
26807 (while commands
26808 (setq old (pop commands) new (pop commands))
26809 (if (fboundp 'command-remapping)
26810 (org-defkey map (vector 'remap old) new)
26811 (substitute-key-definition old new map global-map)))))
26813 (when (eq org-enable-table-editor 'optimized)
26814 ;; If the user wants maximum table support, we need to hijack
26815 ;; some standard editing functions
26816 (org-remap org-mode-map
26817 'self-insert-command 'org-self-insert-command
26818 'delete-char 'org-delete-char
26819 'delete-backward-char 'org-delete-backward-char)
26820 (org-defkey org-mode-map "|" 'org-force-self-insert))
26822 (defun org-shiftcursor-error ()
26823 "Throw an error because Shift-Cursor command was applied in wrong context."
26824 (error "This command is active in special context like tables, headlines or timestamps"))
26826 (defun org-shifttab (&optional arg)
26827 "Global visibility cycling or move to previous table field.
26828 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26829 on context.
26830 See the individual commands for more information."
26831 (interactive "P")
26832 (cond
26833 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26834 (arg (message "Content view to level: ")
26835 (org-content (prefix-numeric-value arg))
26836 (setq org-cycle-global-status 'overview))
26837 (t (call-interactively 'org-global-cycle))))
26839 (defun org-shiftmetaleft ()
26840 "Promote subtree or delete table column.
26841 Calls `org-promote-subtree', `org-outdent-item',
26842 or `org-table-delete-column', depending on context.
26843 See the individual commands for more information."
26844 (interactive)
26845 (cond
26846 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26847 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26848 ((org-at-item-p) (call-interactively 'org-outdent-item))
26849 (t (org-shiftcursor-error))))
26851 (defun org-shiftmetaright ()
26852 "Demote subtree or insert table column.
26853 Calls `org-demote-subtree', `org-indent-item',
26854 or `org-table-insert-column', depending on context.
26855 See the individual commands for more information."
26856 (interactive)
26857 (cond
26858 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26859 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26860 ((org-at-item-p) (call-interactively 'org-indent-item))
26861 (t (org-shiftcursor-error))))
26863 (defun org-shiftmetaup (&optional arg)
26864 "Move subtree up or kill table row.
26865 Calls `org-move-subtree-up' or `org-table-kill-row' or
26866 `org-move-item-up' depending on context. See the individual commands
26867 for more information."
26868 (interactive "P")
26869 (cond
26870 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26871 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26872 ((org-at-item-p) (call-interactively 'org-move-item-up))
26873 (t (org-shiftcursor-error))))
26874 (defun org-shiftmetadown (&optional arg)
26875 "Move subtree down or insert table row.
26876 Calls `org-move-subtree-down' or `org-table-insert-row' or
26877 `org-move-item-down', depending on context. See the individual
26878 commands for more information."
26879 (interactive "P")
26880 (cond
26881 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26882 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26883 ((org-at-item-p) (call-interactively 'org-move-item-down))
26884 (t (org-shiftcursor-error))))
26886 (defun org-metaleft (&optional arg)
26887 "Promote heading or move table column to left.
26888 Calls `org-do-promote' or `org-table-move-column', depending on context.
26889 With no specific context, calls the Emacs default `backward-word'.
26890 See the individual commands for more information."
26891 (interactive "P")
26892 (cond
26893 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26894 ((or (org-on-heading-p) (org-region-active-p))
26895 (call-interactively 'org-do-promote))
26896 ((org-at-item-p) (call-interactively 'org-outdent-item))
26897 (t (call-interactively 'backward-word))))
26899 (defun org-metaright (&optional arg)
26900 "Demote subtree or move table column to right.
26901 Calls `org-do-demote' or `org-table-move-column', depending on context.
26902 With no specific context, calls the Emacs default `forward-word'.
26903 See the individual commands for more information."
26904 (interactive "P")
26905 (cond
26906 ((org-at-table-p) (call-interactively 'org-table-move-column))
26907 ((or (org-on-heading-p) (org-region-active-p))
26908 (call-interactively 'org-do-demote))
26909 ((org-at-item-p) (call-interactively 'org-indent-item))
26910 (t (call-interactively 'forward-word))))
26912 (defun org-metaup (&optional arg)
26913 "Move subtree up or move table row up.
26914 Calls `org-move-subtree-up' or `org-table-move-row' or
26915 `org-move-item-up', depending on context. See the individual commands
26916 for more information."
26917 (interactive "P")
26918 (cond
26919 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26920 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26921 ((org-at-item-p) (call-interactively 'org-move-item-up))
26922 (t (transpose-lines 1) (beginning-of-line -1))))
26924 (defun org-metadown (&optional arg)
26925 "Move subtree down or move table row down.
26926 Calls `org-move-subtree-down' or `org-table-move-row' or
26927 `org-move-item-down', depending on context. See the individual
26928 commands for more information."
26929 (interactive "P")
26930 (cond
26931 ((org-at-table-p) (call-interactively 'org-table-move-row))
26932 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26933 ((org-at-item-p) (call-interactively 'org-move-item-down))
26934 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26936 (defun org-shiftup (&optional arg)
26937 "Increase item in timestamp or increase priority of current headline.
26938 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26939 depending on context. See the individual commands for more information."
26940 (interactive "P")
26941 (cond
26942 ((org-at-timestamp-p t)
26943 (call-interactively (if org-edit-timestamp-down-means-later
26944 'org-timestamp-down 'org-timestamp-up)))
26945 ((org-on-heading-p) (call-interactively 'org-priority-up))
26946 ((org-at-item-p) (call-interactively 'org-previous-item))
26947 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26949 (defun org-shiftdown (&optional arg)
26950 "Decrease item in timestamp or decrease priority of current headline.
26951 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26952 depending on context. See the individual commands for more information."
26953 (interactive "P")
26954 (cond
26955 ((org-at-timestamp-p t)
26956 (call-interactively (if org-edit-timestamp-down-means-later
26957 'org-timestamp-up 'org-timestamp-down)))
26958 ((org-on-heading-p) (call-interactively 'org-priority-down))
26959 (t (call-interactively 'org-next-item))))
26961 (defun org-shiftright ()
26962 "Next TODO keyword or timestamp one day later, depending on context."
26963 (interactive)
26964 (cond
26965 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26966 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26967 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26968 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26969 (t (org-shiftcursor-error))))
26971 (defun org-shiftleft ()
26972 "Previous TODO keyword or timestamp one day earlier, depending on context."
26973 (interactive)
26974 (cond
26975 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26976 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26977 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26978 ((org-at-property-p)
26979 (call-interactively 'org-property-previous-allowed-value))
26980 (t (org-shiftcursor-error))))
26982 (defun org-shiftcontrolright ()
26983 "Switch to next TODO set."
26984 (interactive)
26985 (cond
26986 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26987 (t (org-shiftcursor-error))))
26989 (defun org-shiftcontrolleft ()
26990 "Switch to previous TODO set."
26991 (interactive)
26992 (cond
26993 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26994 (t (org-shiftcursor-error))))
26996 (defun org-ctrl-c-ret ()
26997 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26998 (interactive)
26999 (cond
27000 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
27001 (t (call-interactively 'org-insert-heading))))
27003 (defun org-copy-special ()
27004 "Copy region in table or copy current subtree.
27005 Calls `org-table-copy' or `org-copy-subtree', depending on context.
27006 See the individual commands for more information."
27007 (interactive)
27008 (call-interactively
27009 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
27011 (defun org-cut-special ()
27012 "Cut region in table or cut current subtree.
27013 Calls `org-table-copy' or `org-cut-subtree', depending on context.
27014 See the individual commands for more information."
27015 (interactive)
27016 (call-interactively
27017 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
27019 (defun org-paste-special (arg)
27020 "Paste rectangular region into table, or past subtree relative to level.
27021 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
27022 See the individual commands for more information."
27023 (interactive "P")
27024 (if (org-at-table-p)
27025 (org-table-paste-rectangle)
27026 (org-paste-subtree arg)))
27028 (defun org-ctrl-c-ctrl-c (&optional arg)
27029 "Set tags in headline, or update according to changed information at point.
27031 This command does many different things, depending on context:
27033 - If the cursor is in a headline, prompt for tags and insert them
27034 into the current line, aligned to `org-tags-column'. When called
27035 with prefix arg, realign all tags in the current buffer.
27037 - If the cursor is in one of the special #+KEYWORD lines, this
27038 triggers scanning the buffer for these lines and updating the
27039 information.
27041 - If the cursor is inside a table, realign the table. This command
27042 works even if the automatic table editor has been turned off.
27044 - If the cursor is on a #+TBLFM line, re-apply the formulas to
27045 the entire table.
27047 - If the cursor is a the beginning of a dynamic block, update it.
27049 - If the cursor is inside a table created by the table.el package,
27050 activate that table.
27052 - If the current buffer is a remember buffer, close note and file it.
27053 with a prefix argument, file it without further interaction to the default
27054 location.
27056 - If the cursor is on a <<<target>>>, update radio targets and corresponding
27057 links in this buffer.
27059 - If the cursor is on a numbered item in a plain list, renumber the
27060 ordered list.
27062 - If the cursor is on a checkbox, toggle it."
27063 (interactive "P")
27064 (let ((org-enable-table-editor t))
27065 (cond
27066 ((or org-clock-overlays
27067 org-occur-highlights
27068 org-latex-fragment-image-overlays)
27069 (org-remove-clock-overlays)
27070 (org-remove-occur-highlights)
27071 (org-remove-latex-fragment-image-overlays)
27072 (message "Temporary highlights/overlays removed from current buffer"))
27073 ((and (local-variable-p 'org-finish-function (current-buffer))
27074 (fboundp org-finish-function))
27075 (funcall org-finish-function))
27076 ((org-at-property-p)
27077 (call-interactively 'org-property-action))
27078 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27079 ((org-on-heading-p) (call-interactively 'org-set-tags))
27080 ((org-at-table.el-p)
27081 (require 'table)
27082 (beginning-of-line 1)
27083 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27084 (call-interactively 'table-recognize-table))
27085 ((org-at-table-p)
27086 (org-table-maybe-eval-formula)
27087 (if arg
27088 (call-interactively 'org-table-recalculate)
27089 (org-table-maybe-recalculate-line))
27090 (call-interactively 'org-table-align))
27091 ((org-at-item-checkbox-p)
27092 (call-interactively 'org-toggle-checkbox))
27093 ((org-at-item-p)
27094 (call-interactively 'org-maybe-renumber-ordered-list))
27096 ;; Dynamic block
27097 (beginning-of-line 1)
27098 (org-update-dblock))
27100 (cond
27101 ((equal (match-string 1) "TBLFM")
27102 ;; Recalculate the table before this line
27103 (save-excursion
27104 (beginning-of-line 1)
27106 (if (org-at-table-p)
27107 (org-call-with-arg 'org-table-recalculate t))))
27108 (t
27109 (call-interactively 'org-mode-restart))))
27110 (t (error "C-c C-c can do nothing useful at this location.")))))
27112 (defun org-mode-restart ()
27113 "Restart Org-mode, to scan again for special lines.
27114 Also updates the keyword regular expressions."
27115 (interactive)
27116 (let ((org-inhibit-startup t)) (org-mode))
27117 (message "Org-mode restarted to refresh keyword and special line setup"))
27119 (defun org-kill-note-or-show-branches ()
27120 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27121 (interactive)
27122 (if (not org-finish-function)
27123 (call-interactively 'show-branches)
27124 (let ((org-note-abort t))
27125 (funcall org-finish-function))))
27127 (defun org-return (&optional indent)
27128 "Goto next table row or insert a newline.
27129 Calls `org-table-next-row' or `newline', depending on context.
27130 See the individual commands for more information."
27131 (interactive)
27132 (cond
27133 ((bobp) (if indent (newline-and-indent) (newline)))
27134 ((and (org-at-heading-p)
27135 (looking-at
27137 (org-show-entry)
27138 (end-of-line 1)
27139 (newline))
27140 ((org-at-table-p)
27141 (org-table-justify-field-maybe)
27142 (call-interactively 'org-table-next-row))
27143 (t (if indent (newline-and-indent) (newline)))))
27145 (defun org-return-indent ()
27146 (interactive)
27147 "Goto next table row or insert a newline and indent.
27148 Calls `org-table-next-row' or `newline-and-indent', depending on
27149 context. See the individual commands for more information."
27150 (org-return t))
27152 (defun org-ctrl-c-minus ()
27153 "Insert separator line in table or modify bullet type in list.
27154 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
27155 depending on context."
27156 (interactive)
27157 (cond
27158 ((org-at-table-p)
27159 (call-interactively 'org-table-insert-hline))
27160 ((org-on-heading-p)
27161 ;; Convert to item
27162 (save-excursion
27163 (beginning-of-line 1)
27165 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27166 ((org-in-item-p)
27167 (call-interactively 'org-cycle-list-bullet))
27168 (t (error "`C-c -' does have no function here."))))
27170 (defun org-meta-return (&optional arg)
27171 "Insert a new heading or wrap a region in a table.
27172 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27173 See the individual commands for more information."
27174 (interactive "P")
27175 (cond
27176 ((org-at-table-p)
27177 (call-interactively 'org-table-wrap-region))
27178 (t (call-interactively 'org-insert-heading))))
27180 ;;; Menu entries
27182 ;; Define the Org-mode menus
27183 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27184 '("Tbl"
27185 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27186 ["Next Field" org-cycle (org-at-table-p)]
27187 ["Previous Field" org-shifttab (org-at-table-p)]
27188 ["Next Row" org-return (org-at-table-p)]
27189 "--"
27190 ["Blank Field" org-table-blank-field (org-at-table-p)]
27191 ["Edit Field" org-table-edit-field (org-at-table-p)]
27192 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27193 "--"
27194 ("Column"
27195 ["Move Column Left" org-metaleft (org-at-table-p)]
27196 ["Move Column Right" org-metaright (org-at-table-p)]
27197 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27198 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27199 ("Row"
27200 ["Move Row Up" org-metaup (org-at-table-p)]
27201 ["Move Row Down" org-metadown (org-at-table-p)]
27202 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27203 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27204 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27205 "--"
27206 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27207 ("Rectangle"
27208 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27209 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27210 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27211 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27212 "--"
27213 ("Calculate"
27214 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27215 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27216 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27217 "--"
27218 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27219 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27220 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27221 "--"
27222 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27223 "--"
27224 ["Sum Column/Rectangle" org-table-sum
27225 (or (org-at-table-p) (org-region-active-p))]
27226 ["Which Column?" org-table-current-column (org-at-table-p)])
27227 ["Debug Formulas"
27228 org-table-toggle-formula-debugger
27229 :style toggle :selected org-table-formula-debug]
27230 ["Show Col/Row Numbers"
27231 org-table-toggle-coordinate-overlays
27232 :style toggle :selected org-table-overlay-coordinates]
27233 "--"
27234 ["Create" org-table-create (and (not (org-at-table-p))
27235 org-enable-table-editor)]
27236 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27237 ["Import from File" org-table-import (not (org-at-table-p))]
27238 ["Export to File" org-table-export (org-at-table-p)]
27239 "--"
27240 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27242 (easy-menu-define org-org-menu org-mode-map "Org menu"
27243 '("Org"
27244 ("Show/Hide"
27245 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27246 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27247 ["Sparse Tree" org-occur t]
27248 ["Reveal Context" org-reveal t]
27249 ["Show All" show-all t]
27250 "--"
27251 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27252 "--"
27253 ["New Heading" org-insert-heading t]
27254 ("Navigate Headings"
27255 ["Up" outline-up-heading t]
27256 ["Next" outline-next-visible-heading t]
27257 ["Previous" outline-previous-visible-heading t]
27258 ["Next Same Level" outline-forward-same-level t]
27259 ["Previous Same Level" outline-backward-same-level t]
27260 "--"
27261 ["Jump" org-goto t])
27262 ("Edit Structure"
27263 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27264 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27265 "--"
27266 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27267 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27268 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27269 "--"
27270 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27271 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27272 ["Demote Heading" org-metaright (not (org-at-table-p))]
27273 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27274 "--"
27275 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27276 "--"
27277 ["Convert to odd levels" org-convert-to-odd-levels t]
27278 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27279 ("Editing"
27280 ["Emphasis..." org-emphasize t])
27281 ("Archive"
27282 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27283 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27284 ; :active t :keys "C-u C-c C-x C-a"]
27285 ["Sparse trees open ARCHIVE trees"
27286 (setq org-sparse-tree-open-archived-trees
27287 (not org-sparse-tree-open-archived-trees))
27288 :style toggle :selected org-sparse-tree-open-archived-trees]
27289 ["Cycling opens ARCHIVE trees"
27290 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27291 :style toggle :selected org-cycle-open-archived-trees]
27292 ["Agenda includes ARCHIVE trees"
27293 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27294 :style toggle :selected (not org-agenda-skip-archived-trees)]
27295 "--"
27296 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27297 ; ["Check and Move Children" (org-archive-subtree '(4))
27298 ; :active t :keys "C-u C-c C-x C-s"]
27299 )
27300 "--"
27301 ("TODO Lists"
27302 ["TODO/DONE/-" org-todo t]
27303 ("Select keyword"
27304 ["Next keyword" org-shiftright (org-on-heading-p)]
27305 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27306 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27307 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27308 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27309 ["Show TODO Tree" org-show-todo-tree t]
27310 ["Global TODO list" org-todo-list t]
27311 "--"
27312 ["Set Priority" org-priority t]
27313 ["Priority Up" org-shiftup t]
27314 ["Priority Down" org-shiftdown t])
27315 ("TAGS and Properties"
27316 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27317 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27318 "--"
27319 ["Set property" 'org-set-property t]
27320 ["Column view of properties" org-columns t]
27321 ["Insert Column View DBlock" org-insert-columns-dblock t])
27322 ("Dates and Scheduling"
27323 ["Timestamp" org-time-stamp t]
27324 ["Timestamp (inactive)" org-time-stamp-inactive t]
27325 ("Change Date"
27326 ["1 Day Later" org-shiftright t]
27327 ["1 Day Earlier" org-shiftleft t]
27328 ["1 ... Later" org-shiftup t]
27329 ["1 ... Earlier" org-shiftdown t])
27330 ["Compute Time Range" org-evaluate-time-range t]
27331 ["Schedule Item" org-schedule t]
27332 ["Deadline" org-deadline t]
27333 "--"
27334 ["Custom time format" org-toggle-time-stamp-overlays
27335 :style radio :selected org-display-custom-times]
27336 "--"
27337 ["Goto Calendar" org-goto-calendar t]
27338 ["Date from Calendar" org-date-from-calendar t])
27339 ("Logging work"
27340 ["Clock in" org-clock-in t]
27341 ["Clock out" org-clock-out t]
27342 ["Clock cancel" org-clock-cancel t]
27343 ["Goto running clock" org-clock-goto t]
27344 ["Display times" org-clock-display t]
27345 ["Create clock table" org-clock-report t]
27346 "--"
27347 ["Record DONE time"
27348 (progn (setq org-log-done (not org-log-done))
27349 (message "Switching to %s will %s record a timestamp"
27350 (car org-done-keywords)
27351 (if org-log-done "automatically" "not")))
27352 :style toggle :selected org-log-done])
27353 "--"
27354 ["Agenda Command..." org-agenda t]
27355 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27356 ("File List for Agenda")
27357 ("Special views current file"
27358 ["TODO Tree" org-show-todo-tree t]
27359 ["Check Deadlines" org-check-deadlines t]
27360 ["Timeline" org-timeline t]
27361 ["Tags Tree" org-tags-sparse-tree t])
27362 "--"
27363 ("Hyperlinks"
27364 ["Store Link (Global)" org-store-link t]
27365 ["Insert Link" org-insert-link t]
27366 ["Follow Link" org-open-at-point t]
27367 "--"
27368 ["Next link" org-next-link t]
27369 ["Previous link" org-previous-link t]
27370 "--"
27371 ["Descriptive Links"
27372 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27373 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27374 ["Literal Links"
27375 (progn
27376 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27377 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27378 "--"
27379 ["Export/Publish..." org-export t]
27380 ("LaTeX"
27381 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27382 :selected org-cdlatex-mode]
27383 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27384 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27385 ["Modify math symbol" org-cdlatex-math-modify
27386 (org-inside-LaTeX-fragment-p)]
27387 ["Export LaTeX fragments as images"
27388 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27389 :style toggle :selected org-export-with-LaTeX-fragments])
27390 "--"
27391 ("Documentation"
27392 ["Show Version" org-version t]
27393 ["Info Documentation" org-info t])
27394 ("Customize"
27395 ["Browse Org Group" org-customize t]
27396 "--"
27397 ["Expand This Menu" org-create-customize-menu
27398 (fboundp 'customize-menu-create)])
27399 "--"
27400 ["Refresh setup" org-mode-restart t]
27401 ))
27403 (defun org-info (&optional node)
27404 "Read documentation for Org-mode in the info system.
27405 With optional NODE, go directly to that node."
27406 (interactive)
27407 (require 'info)
27408 (Info-goto-node (format "(org)%s" (or node ""))))
27410 (defun org-install-agenda-files-menu ()
27411 (let ((bl (buffer-list)))
27412 (save-excursion
27413 (while bl
27414 (set-buffer (pop bl))
27415 (if (org-mode-p) (setq bl nil)))
27416 (when (org-mode-p)
27417 (easy-menu-change
27418 '("Org") "File List for Agenda"
27419 (append
27420 (list
27421 ["Edit File List" (org-edit-agenda-file-list) t]
27422 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27423 ["Remove Current File from List" org-remove-file t]
27424 ["Cycle through agenda files" org-cycle-agenda-files t]
27425 ["Occur in all agenda files" org-occur-in-agenda-files t]
27426 "--")
27427 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27429 ;;;; Documentation
27431 (defun org-customize ()
27432 "Call the customize function with org as argument."
27433 (interactive)
27434 (customize-browse 'org))
27436 (defun org-create-customize-menu ()
27437 "Create a full customization menu for Org-mode, insert it into the menu."
27438 (interactive)
27439 (if (fboundp 'customize-menu-create)
27440 (progn
27441 (easy-menu-change
27442 '("Org") "Customize"
27443 `(["Browse Org group" org-customize t]
27444 "--"
27445 ,(customize-menu-create 'org)
27446 ["Set" Custom-set t]
27447 ["Save" Custom-save t]
27448 ["Reset to Current" Custom-reset-current t]
27449 ["Reset to Saved" Custom-reset-saved t]
27450 ["Reset to Standard Settings" Custom-reset-standard t]))
27452 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27454 ;;;; Miscellaneous stuff
27457 ;;; Generally useful functions
27459 (defun org-context ()
27460 "Return a list of contexts of the current cursor position.
27461 If several contexts apply, all are returned.
27462 Each context entry is a list with a symbol naming the context, and
27463 two positions indicating start and end of the context. Possible
27464 contexts are:
27466 :headline anywhere in a headline
27467 :headline-stars on the leading stars in a headline
27468 :todo-keyword on a TODO keyword (including DONE) in a headline
27469 :tags on the TAGS in a headline
27470 :priority on the priority cookie in a headline
27471 :item on the first line of a plain list item
27472 :item-bullet on the bullet/number of a plain list item
27473 :checkbox on the checkbox in a plain list item
27474 :table in an org-mode table
27475 :table-special on a special filed in a table
27476 :table-table in a table.el table
27477 :link on a hyperlink
27478 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27479 :target on a <<target>>
27480 :radio-target on a <<<radio-target>>>
27481 :latex-fragment on a LaTeX fragment
27482 :latex-preview on a LaTeX fragment with overlayed preview image
27484 This function expects the position to be visible because it uses font-lock
27485 faces as a help to recognize the following contexts: :table-special, :link,
27486 and :keyword."
27487 (let* ((f (get-text-property (point) 'face))
27488 (faces (if (listp f) f (list f)))
27489 (p (point)) clist o)
27490 ;; First the large context
27491 (cond
27492 ((org-on-heading-p t)
27493 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27494 (when (progn
27495 (beginning-of-line 1)
27496 (looking-at org-todo-line-tags-regexp))
27497 (push (org-point-in-group p 1 :headline-stars) clist)
27498 (push (org-point-in-group p 2 :todo-keyword) clist)
27499 (push (org-point-in-group p 4 :tags) clist))
27500 (goto-char p)
27503 (push (org-point-in-group p 0 :priority) clist)))
27505 ((org-at-item-p)
27506 (push (org-point-in-group p 2 :item-bullet) clist)
27507 (push (list :item (point-at-bol)
27508 (save-excursion (org-end-of-item) (point)))
27509 clist)
27510 (and (org-at-item-checkbox-p)
27511 (push (org-point-in-group p 0 :checkbox) clist)))
27513 ((org-at-table-p)
27514 (push (list :table (org-table-begin) (org-table-end)) clist)
27515 (if (memq 'org-formula faces)
27516 (push (list :table-special
27517 (previous-single-property-change p 'face)
27518 (next-single-property-change p 'face)) clist)))
27519 ((org-at-table-p 'any)
27520 (push (list :table-table) clist)))
27521 (goto-char p)
27523 ;; Now the small context
27524 (cond
27525 ((org-at-timestamp-p)
27526 (push (org-point-in-group p 0 :timestamp) clist))
27527 ((memq 'org-link faces)
27528 (push (list :link
27529 (previous-single-property-change p 'face)
27530 (next-single-property-change p 'face)) clist))
27531 ((memq 'org-special-keyword faces)
27532 (push (list :keyword
27533 (previous-single-property-change p 'face)
27534 (next-single-property-change p 'face)) clist))
27535 ((org-on-target-p)
27536 (push (org-point-in-group p 0 :target) clist)
27537 (goto-char (1- (match-beginning 0)))
27538 (if (looking-at org-radio-target-regexp)
27539 (push (org-point-in-group p 0 :radio-target) clist))
27540 (goto-char p))
27541 ((setq o (car (delq nil
27542 (mapcar
27543 (lambda (x)
27544 (if (memq x org-latex-fragment-image-overlays) x))
27545 (org-overlays-at (point))))))
27546 (push (list :latex-fragment
27547 (org-overlay-start o) (org-overlay-end o)) clist)
27548 (push (list :latex-preview
27549 (org-overlay-start o) (org-overlay-end o)) clist))
27550 ((org-inside-LaTeX-fragment-p)
27551 ;; FIXME: positions wrong.
27552 (push (list :latex-fragment (point) (point)) clist)))
27554 (setq clist (nreverse (delq nil clist)))
27555 clist))
27557 ;; FIXME: Compare with at-regexp-p Do we need both?
27558 (defun org-in-regexp (re &optional nlines visually)
27559 "Check if point is inside a match of regexp.
27560 Normally only the current line is checked, but you can include NLINES extra
27561 lines both before and after point into the search.
27562 If VISUALLY is set, require that the cursor is not after the match but
27563 really on, so that the block visually is on the match."
27564 (catch 'exit
27565 (let ((pos (point))
27566 (eol (point-at-eol (+ 1 (or nlines 0))))
27567 (inc (if visually 1 0)))
27568 (save-excursion
27569 (beginning-of-line (- 1 (or nlines 0)))
27570 (while (re-search-forward re eol t)
27571 (if (and (<= (match-beginning 0) pos)
27572 (>= (+ inc (match-end 0)) pos))
27573 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27575 (defun org-at-regexp-p (regexp)
27576 "Is point inside a match of REGEXP in the current line?"
27577 (catch 'exit
27578 (save-excursion
27579 (let ((pos (point)) (end (point-at-eol)))
27580 (beginning-of-line 1)
27581 (while (re-search-forward regexp end t)
27582 (if (and (<= (match-beginning 0) pos)
27583 (>= (match-end 0) pos))
27584 (throw 'exit t)))
27585 nil))))
27587 (defun org-occur-in-agenda-files (regexp &optional nlines)
27588 "Call `multi-occur' with buffers for all agenda files."
27590 (let* ((files (org-agenda-files))
27591 (tnames (mapcar 'file-truename files))
27592 (extra org-agenda-multi-occur-extra-files)
27593 f)
27594 (while (setq f (pop extra))
27595 (unless (member (file-truename f) tnames)
27596 (add-to-list 'files f 'append)
27597 (add-to-list 'tnames (file-truename f) 'append)))
27598 (multi-occur
27599 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27600 regexp)))
27602 (if (boundp 'occur-mode-find-occurrence-hook)
27603 ;; Emacs 23
27604 (add-hook 'occur-mode-find-occurrence-hook
27605 (lambda ()
27606 (when (org-mode-p)
27607 (org-reveal))))
27608 ;; Emacs 22
27609 (defadvice occur-mode-goto-occurrence
27610 (after org-occur-reveal activate)
27611 (and (org-mode-p) (org-reveal)))
27612 (defadvice occur-mode-goto-occurrence-other-window
27613 (after org-occur-reveal activate)
27614 (and (org-mode-p) (org-reveal)))
27615 (defadvice occur-mode-display-occurrence
27616 (after org-occur-reveal activate)
27617 (when (org-mode-p)
27618 (let ((pos (occur-mode-find-occurrence)))
27619 (with-current-buffer (marker-buffer pos)
27620 (save-excursion
27621 (goto-char pos)
27622 (org-reveal)))))))
27624 (defun org-uniquify (list)
27625 "Remove duplicate elements from LIST."
27626 (let (res)
27627 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27628 res))
27630 (defun org-delete-all (elts list)
27631 "Remove all elements in ELTS from LIST."
27632 (while elts
27633 (setq list (delete (pop elts) list)))
27634 list)
27636 (defun org-back-over-empty-lines ()
27637 "Move backwards over witespace, to the beginning of the first empty line.
27638 Returns the number o empty lines passed."
27639 (let ((pos (point)))
27641 (beginning-of-line 2)
27642 (goto-char (min (point) pos))
27643 (count-lines (point) pos)))
27645 (defun org-skip-whitespace ()
27648 (defun org-point-in-group (point group &optional context)
27649 "Check if POINT is in match-group GROUP.
27650 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27651 match. If the match group does ot exist or point is not inside it,
27652 return nil."
27653 (and (match-beginning group)
27654 (>= point (match-beginning group))
27655 (<= point (match-end group))
27656 (if context
27657 (list context (match-beginning group) (match-end group))
27658 t)))
27660 (defun org-switch-to-buffer-other-window (&rest args)
27661 "Switch to buffer in a second window on the current frame.
27662 In particular, do not allow pop-up frames."
27663 (let (pop-up-frames special-display-buffer-names special-display-regexps
27664 special-display-function)
27665 (apply 'switch-to-buffer-other-window args)))
27667 (defun org-combine-plists (&rest plists)
27668 "Create a single property list from all plists in PLISTS.
27669 The process starts by copying the first list, and then setting properties
27670 from the other lists. Settings in the last list are the most significant
27671 ones and overrule settings in the other lists."
27672 (let ((rtn (copy-sequence (pop plists)))
27673 p v ls)
27674 (while plists
27675 (setq ls (pop plists))
27676 (while ls
27677 (setq p (pop ls) v (pop ls))
27678 (setq rtn (plist-put rtn p v))))
27679 rtn))
27681 (defun org-move-line-down (arg)
27682 "Move the current line down. With prefix argument, move it past ARG lines."
27683 (interactive "p")
27684 (let ((col (current-column))
27685 beg end pos)
27686 (beginning-of-line 1) (setq beg (point))
27687 (beginning-of-line 2) (setq end (point))
27688 (beginning-of-line (+ 1 arg))
27689 (setq pos (move-marker (make-marker) (point)))
27690 (insert (delete-and-extract-region beg end))
27691 (goto-char pos)
27692 (move-to-column col)))
27694 (defun org-move-line-up (arg)
27695 "Move the current line up. With prefix argument, move it past ARG lines."
27696 (interactive "p")
27697 (let ((col (current-column))
27698 beg end pos)
27699 (beginning-of-line 1) (setq beg (point))
27700 (beginning-of-line 2) (setq end (point))
27701 (beginning-of-line (- arg))
27702 (setq pos (move-marker (make-marker) (point)))
27703 (insert (delete-and-extract-region beg end))
27704 (goto-char pos)
27705 (move-to-column col)))
27707 (defun org-replace-escapes (string table)
27708 "Replace %-escapes in STRING with values in TABLE.
27710 The sequences in STRING may contain normal field width and padding information,
27712 so values can contain further %-escapes if they are define later in TABLE."
27713 (let ((case-fold-search nil)
27714 e re rpl)
27715 (while (setq e (pop table))
27716 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27717 (while (string-match re string)
27718 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27719 (cdr e)))
27720 (setq string (replace-match rpl t t string))))
27721 string))
27724 (defun org-sublist (list start end)
27725 "Return a section of LIST, from START to END.
27726 Counting starts at 1."
27727 (let (rtn (c start))
27728 (setq list (nthcdr (1- start) list))
27729 (while (and list (<= c end))
27730 (push (pop list) rtn)
27731 (setq c (1+ c)))
27732 (nreverse rtn)))
27734 (defun org-find-base-buffer-visiting (file)
27735 "Like `find-buffer-visiting' but alway return the base buffer and
27736 not an indirect buffer"
27737 (let ((buf (find-buffer-visiting file)))
27738 (if buf
27739 (or (buffer-base-buffer buf) buf)
27740 nil)))
27742 (defun org-image-file-name-regexp ()
27743 "Return regexp matching the file names of images."
27744 (if (fboundp 'image-file-name-regexp)
27745 (image-file-name-regexp)
27746 (let ((image-file-name-extensions
27747 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27748 "xbm" "xpm" "pbm" "pgm" "ppm")))
27750 (regexp-opt (nconc (mapcar 'upcase
27751 image-file-name-extensions)
27752 image-file-name-extensions)
27753 t)
27756 (defun org-file-image-p (file)
27757 "Return non-nil if FILE is an image."
27758 (save-match-data
27759 (string-match (org-image-file-name-regexp) file)))
27761 ;;; Paragraph filling stuff.
27762 ;; We want this to be just right, so use the full arsenal.
27764 (defun org-indent-line-function ()
27765 "Indent line like previous, but further if previous was headline or item."
27766 (interactive)
27767 (let* ((pos (point))
27768 (itemp (org-at-item-p))
27769 column bpos bcol tpos tcol bullet btype bullet-type)
27770 ;; Find the previous relevant line
27771 (beginning-of-line 1)
27772 (cond
27773 ((looking-at "#") (setq column 0))
27775 (t
27776 (beginning-of-line 0)
27778 (beginning-of-line 0))
27779 (cond
27781 (goto-char (match-end 0))
27782 (setq column (current-column)))
27783 ((org-in-item-p)
27784 (org-beginning-of-item)
27787 (setq bpos (match-beginning 1) tpos (match-end 0)
27788 bcol (progn (goto-char bpos) (current-column))
27789 tcol (progn (goto-char tpos) (current-column))
27790 bullet (match-string 1)
27791 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27792 (if (not itemp)
27793 (setq column tcol)
27794 (goto-char pos)
27795 (beginning-of-line 1)
27797 (progn
27799 (setq bullet (match-string 1)
27800 btype (if (string-match "[0-9]" bullet) "n" bullet))
27801 (setq column (if (equal btype bullet-type) bcol tcol)))
27802 (setq column (org-get-indentation)))))
27803 (t (setq column (org-get-indentation))))))
27804 (goto-char pos)
27805 (if (<= (current-column) (current-indentation))
27806 (indent-line-to column)
27807 (save-excursion (indent-line-to column)))
27808 (setq column (current-column))
27809 (beginning-of-line 1)
27810 (if (looking-at
27813 (match-string 2) (match-string 3)))
27814 t nil))
27815 (move-to-column column)))
27817 (defun org-set-autofill-regexps ()
27818 (interactive)
27819 ;; In the paragraph separator we include headlines, because filling
27820 ;; text in a line directly attached to a headline would otherwise
27821 ;; fill the headline as well.
27824 ;; The paragraph starter includes hand-formatted lists.
27825 (org-set-local 'paragraph-start
27827 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27828 ;; But only if the user has not turned off tables or fixed-width regions
27829 (org-set-local
27830 'auto-fill-inhibit-regexp
27833 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27834 (concat
27836 (if org-enable-table-editor "|" "")
27837 (if org-enable-fixed-width-editor ":" "")
27838 "]"))))
27839 ;; We use our own fill-paragraph function, to make sure that tables
27840 ;; and fixed-width regions are not wrapped. That function will pass
27841 ;; through to `fill-paragraph' when appropriate.
27842 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27843 ; Adaptive filling: To get full control, first make sure that
27844 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27846 (org-set-local 'adaptive-fill-function
27847 'org-adaptive-fill-function)
27848 (org-set-local
27849 'align-mode-rules-list
27850 '((org-in-buffer-settings
27852 (modes . '(org-mode))))))
27854 (defun org-fill-paragraph (&optional justify)
27855 "Re-align a table, pass through to fill-paragraph if no table."
27856 (let ((table-p (org-at-table-p))
27857 (table.el-p (org-at-table.el-p)))
27858 (cond ((and (equal (char-after (point-at-bol)) ?*)
27859 (save-excursion (goto-char (point-at-bol))
27860 (looking-at outline-regexp)))
27861 t) ; skip headlines
27862 (table.el-p t) ; skip table.el tables
27863 (table-p (org-table-align) t) ; align org-mode tables
27864 (t nil)))) ; call paragraph-fill
27866 ;; For reference, this is the default value of adaptive-fill-regexp
27869 (defun org-adaptive-fill-function ()
27870 "Return a fill prefix for org-mode files.
27871 In particular, this makes sure hanging paragraphs for hand-formatted lists
27872 work correctly."
27874 (match-string 0))
27876 (save-excursion
27877 (goto-char (match-end 0))
27878 (make-string (current-column) ?\ )))
27879 (t nil)))
27881 ;;;; Functions extending outline functionality
27884 (defun org-beginning-of-line (&optional arg)
27885 "Go to the beginning of the current line. If that is invisible, continue
27886 to a visible line beginning. This makes the function of C-a more intuitive.
27887 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27888 first attempt, and only move to after the tags when the cursor is already
27889 beyond the end of the headline."
27890 (interactive "P")
27891 (let ((pos (point)))
27892 (beginning-of-line 1)
27893 (if (bobp)
27894 nil
27895 (backward-char 1)
27896 (if (org-invisible-p)
27897 (while (and (not (bobp)) (org-invisible-p))
27898 (backward-char 1)
27899 (beginning-of-line 1))
27900 (forward-char 1)))
27901 (when org-special-ctrl-a/e
27902 (cond
27903 ((and (looking-at org-todo-line-regexp)
27904 (= (char-after (match-end 1)) ?\ ))
27905 (goto-char
27906 (if (eq org-special-ctrl-a/e t)
27907 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27908 ((= pos (point)) (match-beginning 3))
27909 (t (point)))
27910 (cond ((> pos (point)) (point))
27911 ((not (eq last-command this-command)) (point))
27912 (t (match-beginning 3))))))
27913 ((org-at-item-p)
27914 (goto-char
27915 (if (eq org-special-ctrl-a/e t)
27916 (cond ((> pos (match-end 4)) (match-end 4))
27917 ((= pos (point)) (match-end 4))
27918 (t (point)))
27919 (cond ((> pos (point)) (point))
27920 ((not (eq last-command this-command)) (point))
27921 (t (match-end 4))))))))))
27923 (defun org-end-of-line (&optional arg)
27924 "Go to the end of the line.
27925 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27926 first attempt, and only move to after the tags when the cursor is already
27927 beyond the end of the headline."
27928 (interactive "P")
27929 (if (or (not org-special-ctrl-a/e)
27930 (not (org-on-heading-p)))
27931 (end-of-line arg)
27932 (let ((pos (point)))
27933 (beginning-of-line 1)
27935 (if (eq org-special-ctrl-a/e t)
27936 (if (or (< pos (match-beginning 1))
27937 (= pos (match-end 0)))
27938 (goto-char (match-beginning 1))
27939 (goto-char (match-end 0)))
27940 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27941 (goto-char (match-end 0))
27942 (goto-char (match-beginning 1))))
27943 (end-of-line arg)))))
27945 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27946 (define-key org-mode-map "\C-e" 'org-end-of-line)
27948 (defun org-kill-line (&optional arg)
27949 "Kill line, to tags or end of line."
27950 (interactive "P")
27951 (cond
27952 ((or (not org-special-ctrl-k)
27953 (bolp)
27954 (not (org-on-heading-p)))
27955 (call-interactively 'kill-line))
27957 (kill-region (point) (match-beginning 1))
27958 (org-set-tags nil t))
27959 (t (kill-region (point) (point-at-eol)))))
27961 (define-key org-mode-map "\C-k" 'org-kill-line)
27963 (defun org-invisible-p ()
27964 "Check if point is at a character currently not visible."
27965 ;; Early versions of noutline don't have `outline-invisible-p'.
27966 (if (fboundp 'outline-invisible-p)
27967 (outline-invisible-p)
27968 (get-char-property (point) 'invisible)))
27970 (defun org-invisible-p2 ()
27971 "Check if point is at a character currently not visible."
27972 (save-excursion
27973 (if (and (eolp) (not (bobp))) (backward-char 1))
27974 ;; Early versions of noutline don't have `outline-invisible-p'.
27975 (if (fboundp 'outline-invisible-p)
27976 (outline-invisible-p)
27977 (get-char-property (point) 'invisible))))
27979 (defalias 'org-back-to-heading 'outline-back-to-heading)
27980 (defalias 'org-on-heading-p 'outline-on-heading-p)
27981 (defalias 'org-at-heading-p 'outline-on-heading-p)
27982 (defun org-at-heading-or-item-p ()
27983 (or (org-on-heading-p) (org-at-item-p)))
27985 (defun org-on-target-p ()
27986 (or (org-in-regexp org-radio-target-regexp)
27987 (org-in-regexp org-target-regexp)))
27989 (defun org-up-heading-all (arg)
27990 "Move to the heading line of which the present line is a subheading.
27991 This function considers both visible and invisible heading lines.
27992 With argument, move up ARG levels."
27993 (if (fboundp 'outline-up-heading-all)
27994 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27995 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27997 (defun org-up-heading-safe ()
27998 "Move to the heading line of which the present line is a subheading.
27999 This version will not throw an error. It will return the level of the
28000 headline found, or nil if no higher level is found."
28001 (let ((pos (point)) start-level level
28002 (re (concat "^" outline-regexp)))
28003 (catch 'exit
28004 (outline-back-to-heading t)
28005 (setq start-level (funcall outline-level))
28006 (if (equal start-level 1) (throw 'exit nil))
28007 (while (re-search-backward re nil t)
28008 (setq level (funcall outline-level))
28009 (if (< level start-level) (throw 'exit level)))
28010 nil)))
28012 (defun org-first-sibling-p ()
28013 "Is this heading the first child of its parents?"
28014 (interactive)
28015 (let ((re (concat "^" outline-regexp))
28016 level l)
28017 (unless (org-at-heading-p t)
28018 (error "Not at a heading"))
28019 (setq level (funcall outline-level))
28020 (save-excursion
28021 (if (not (re-search-backward re nil t))
28022 t
28023 (setq l (funcall outline-level))
28024 (< l level)))))
28026 (defun org-goto-sibling (&optional previous)
28027 "Goto the next sibling, even if it is invisible.
28028 When PREVIOUS is set, go to the previous sibling instead. Returns t
28029 when a sibling was found. When none is found, return nil and don't
28030 move point."
28031 (let ((fun (if previous 're-search-backward 're-search-forward))
28032 (pos (point))
28033 (re (concat "^" outline-regexp))
28034 level l)
28035 (when (condition-case nil (org-back-to-heading t) (error nil))
28036 (setq level (funcall outline-level))
28037 (catch 'exit
28038 (or previous (forward-char 1))
28039 (while (funcall fun re nil t)
28040 (setq l (funcall outline-level))
28041 (when (< l level) (goto-char pos) (throw 'exit nil))
28042 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
28043 (goto-char pos)
28044 nil))))
28046 (defun org-show-siblings ()
28047 "Show all siblings of the current headline."
28048 (save-excursion
28049 (while (org-goto-sibling) (org-flag-heading nil)))
28050 (save-excursion
28051 (while (org-goto-sibling 'previous)
28052 (org-flag-heading nil))))
28054 (defun org-show-hidden-entry ()
28055 "Show an entry where even the heading is hidden."
28056 (save-excursion
28057 (org-show-entry)))
28059 (defun org-flag-heading (flag &optional entry)
28060 "Flag the current heading. FLAG non-nil means make invisible.
28061 When ENTRY is non-nil, show the entire entry."
28062 (save-excursion
28063 (org-back-to-heading t)
28064 ;; Check if we should show the entire entry
28065 (if entry
28066 (progn
28067 (org-show-entry)
28068 (save-excursion
28069 (and (outline-next-heading)
28070 (org-flag-heading nil))))
28071 (outline-flag-region (max (point-min) (1- (point)))
28072 (save-excursion (outline-end-of-heading) (point))
28073 flag))))
28075 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28076 ;; This is an exact copy of the original function, but it uses
28077 ;; `org-back-to-heading', to make it work also in invisible
28078 ;; trees. And is uses an invisible-OK argument.
28079 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28080 (org-back-to-heading invisible-OK)
28081 (let ((first t)
28082 (level (funcall outline-level)))
28083 (while (and (not (eobp))
28084 (or first (> (funcall outline-level) level)))
28085 (setq first nil)
28086 (outline-next-heading))
28087 (unless to-heading
28089 (progn
28090 ;; Go to end of line before heading
28091 (forward-char -1)
28093 ;; leave blank line before heading
28094 (forward-char -1))))))
28095 (point))
28097 (defun org-show-subtree ()
28098 "Show everything after this heading at deeper levels."
28099 (outline-flag-region
28100 (point)
28101 (save-excursion
28102 (outline-end-of-subtree) (outline-next-heading) (point))
28103 nil))
28105 (defun org-show-entry ()
28106 "Show the body directly following this heading.
28107 Show the heading too, if it is currently invisible."
28108 (interactive)
28109 (save-excursion
28110 (condition-case nil
28111 (progn
28112 (org-back-to-heading t)
28113 (outline-flag-region
28114 (max (point-min) (1- (point)))
28115 (save-excursion
28116 (re-search-forward
28118 (or (match-beginning 1) (point-max)))
28119 nil))
28120 (error nil))))
28122 (defun org-make-options-regexp (kwds)
28123 "Make a regular expression for keyword lines."
28124 (concat
28125 "^"
28131 ;; Make isearch reveal the necessary context
28132 (defun org-isearch-end ()
28133 "Reveal context after isearch exits."
28134 (when isearch-success ; only if search was successful
28135 (if (featurep 'xemacs)
28136 ;; Under XEmacs, the hook is run in the correct place,
28137 ;; we directly show the context.
28138 (org-show-context 'isearch)
28139 ;; In Emacs the hook runs *before* restoring the overlays.
28140 ;; So we have to use a one-time post-command-hook to do this.
28141 ;; (Emacs 22 has a special variable, see function `org-mode')
28142 (unless (and (boundp 'isearch-mode-end-hook-quit)
28143 isearch-mode-end-hook-quit)
28144 ;; Only when the isearch was not quitted.
28145 (org-add-hook 'post-command-hook 'org-isearch-post-command
28146 'append 'local)))))
28148 (defun org-isearch-post-command ()
28149 "Remove self from hook, and show context."
28150 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28151 (org-show-context 'isearch))
28154 ;;;; Integration with and fixes for other packages
28156 ;;; Imenu support
28158 (defvar org-imenu-markers nil
28159 "All markers currently used by Imenu.")
28160 (make-variable-buffer-local 'org-imenu-markers)
28162 (defun org-imenu-new-marker (&optional pos)
28163 "Return a new marker for use by Imenu, and remember the marker."
28164 (let ((m (make-marker)))
28165 (move-marker m (or pos (point)))
28166 (push m org-imenu-markers)
28167 m))
28169 (defun org-imenu-get-tree ()
28170 "Produce the index for Imenu."
28171 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28172 (setq org-imenu-markers nil)
28173 (let* ((n org-imenu-depth)
28174 (re (concat "^" outline-regexp))
28175 (subs (make-vector (1+ n) nil))
28176 (last-level 0)
28177 m tree level head)
28178 (save-excursion
28179 (save-restriction
28180 (widen)
28181 (goto-char (point-max))
28182 (while (re-search-backward re nil t)
28183 (setq level (org-reduced-level (funcall outline-level)))
28184 (when (<= level n)
28185 (looking-at org-complex-heading-regexp)
28186 (setq head (org-match-string-no-properties 4)
28187 m (org-imenu-new-marker))
28188 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28189 (if (>= level last-level)
28190 (push (cons head m) (aref subs level))
28191 (push (cons head (aref subs (1+ level))) (aref subs level))
28192 (loop for i from (1+ level) to n do (aset subs i nil)))
28193 (setq last-level level)))))
28194 (aref subs 1)))
28196 (eval-after-load "imenu"
28197 '(progn
28198 (add-hook 'imenu-after-jump-hook
28199 (lambda () (org-show-context 'org-goto)))))
28201 ;; Speedbar support
28203 (defun org-speedbar-set-agenda-restriction ()
28204 "Restrict future agenda commands to the location at point in speedbar.
28206 (interactive)
28207 (let (p m tp np dir txt w)
28208 (cond
28209 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28210 'org-imenu t))
28211 (setq m (get-text-property p 'org-imenu-marker))
28212 (save-excursion
28213 (save-restriction
28214 (set-buffer (marker-buffer m))
28215 (goto-char m)
28216 (org-agenda-set-restriction-lock 'subtree))))
28217 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28218 'speedbar-function 'speedbar-find-file))
28219 (setq tp (previous-single-property-change
28220 (1+ p) 'speedbar-function)
28221 np (next-single-property-change
28222 tp 'speedbar-function)
28223 dir (speedbar-line-directory)
28224 txt (buffer-substring-no-properties (or tp (point-min))
28225 (or np (point-max))))
28226 (save-excursion
28227 (save-restriction
28228 (set-buffer (find-file-noselect
28229 (let ((default-directory dir))
28230 (expand-file-name txt))))
28231 (unless (org-mode-p)
28232 (error "Cannot restrict to non-Org-mode file"))
28233 (org-agenda-set-restriction-lock 'file))))
28234 (t (error "Don't know how to restrict Org-mode's agenda")))
28235 (org-move-overlay org-speedbar-restriction-lock-overlay
28236 (point-at-bol) (point-at-eol))
28237 (setq current-prefix-arg nil)
28238 (org-agenda-maybe-redo)))
28240 (eval-after-load "speedbar"
28241 '(progn
28242 (speedbar-add-supported-extension ".org")
28243 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28244 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28245 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28246 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28247 (add-hook 'speedbar-visiting-tag-hook
28248 (lambda () (org-show-context 'org-goto)))))
28251 ;;; Fixes and Hacks
28253 ;; Make flyspell not check words in links, to not mess up our keymap
28254 (defun org-mode-flyspell-verify ()
28255 "Don't let flyspell put overlays at active buttons."
28256 (not (get-text-property (point) 'keymap)))
28258 ;; Make `bookmark-jump' show the jump location if it was hidden.
28259 (eval-after-load "bookmark"
28260 '(if (boundp 'bookmark-after-jump-hook)
28261 ;; We can use the hook
28262 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28263 ;; Hook not available, use advice
28264 (defadvice bookmark-jump (after org-make-visible activate)
28265 "Make the position visible."
28266 (org-bookmark-jump-unhide))))
28268 (defun org-bookmark-jump-unhide ()
28269 "Unhide the current position, to show the bookmark location."
28270 (and (org-mode-p)
28271 (or (org-invisible-p)
28272 (save-excursion (goto-char (max (point-min) (1- (point))))
28273 (org-invisible-p)))
28274 (org-show-context 'bookmark-jump)))
28276 ;; Fix a bug in htmlize where there are text properties (face nil)
28277 (eval-after-load "htmlize"
28278 '(progn
28279 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28280 "Make sure there are no nil faces"
28281 (setq ad-return-value (delq nil ad-return-value)))))
28283 ;; Make session.el ignore our circular variable
28284 (eval-after-load "session"
28285 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28287 ;;;; Experimental code
28289 (defun org-closed-in-range ()
28290 "Sparse tree of items closed in a certain time range.
28291 Still experimental, may disappear in the future."
28292 (interactive)
28293 ;; Get the time interval from the user.
28294 (let* ((time1 (time-to-seconds
28295 (org-read-date nil 'to-time nil "Starting date: ")))
28296 (time2 (time-to-seconds
28297 (org-read-date nil 'to-time nil "End date:")))
28298 ;; callback function
28299 (callback (lambda ()
28300 (let ((time
28301 (time-to-seconds
28302 (apply 'encode-time
28303 (org-parse-time-string
28304 (match-string 1))))))
28305 ;; check if time in interval
28306 (and (>= time time1) (<= time time2))))))
28307 ;; make tree, check each match with the callback
28310 ;;;; Finish up
28312 (provide 'org)
28314 (run-hooks 'org-load-hook)
28316 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28317 ;;; org.el ends here